/*

File: TrainingWindowController.m

Abstract: Controller for training window.

Version: 1.0

Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple,

Inc. ("Apple") in consideration of your agreement to the

following terms, and your use, installation, modification or

redistribution of this Apple software constitutes acceptance of these

terms.  If you do not agree with these terms, please do not use,

install, modify or redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and

subject to these terms, Apple grants you a personal, non-exclusive

license, under Apple's copyrights in this original Apple software (the

"Apple Software"), to use, reproduce, modify and redistribute the Apple

Software, with or without modifications, in source and/or binary forms;

provided that if you redistribute the Apple Software in its entirety and

without modifications, you must retain this notice and the following

text and disclaimers in all such redistributions of the Apple Software. 

Neither the name, trademarks, service marks or logos of Apple,

Inc. may be used to endorse or promote products derived from the Apple

Software without specific prior written permission from Apple.  Except

as expressly stated in this notice, no other rights or licenses, express

or implied, are granted by Apple herein, including but not limited to

any patent rights that may be infringed by your derivative works or by

other works in which the Apple Software may be incorporated.

The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

Copyright © 2007 Apple Inc., All Rights Reserved

*/ 

#import "TrainingWindowController.h"

#import "DataInfo.h"

#import "URLLoader.h"

#import <PubSub/PubSub.h>

#import <LSMClassifier.h>

/*!

 * @abstract Private routines.

 */

@interface TrainingWindowController(Private)

/*!

 * @abstract Recursively find all files in a directory and its sub directories.

 *           And add those file URLs to _tmpURLDataInfo and start loading.

 */

- (void) readDataPathsAt:(NSString*) topDataPath;

/*!

 * @abstract Read training data URL plist.

 *           And add those file URLs to _tmpURLDataInfo and start loading.

 */

- (void) readDataSpecifiedByPlist:(NSString*)plistPath;

@end

@implementation TrainingWindowController

- (void) awakeFromNib {

    topLevelDataInfo =  [[CategoryDataInfo alloc] initWithTitle:@"Training categories"];

    _tmpURLDataInfo = [CategoryDataInfo new];

    _urlLoader = [[URLLoader alloc] initWithDelegate:self];

    [outlineView expandItem:topLevelDataInfo];

}

- (void)dealloc

{               

    if (topLevelDataInfo)

        [topLevelDataInfo release];

    if (_tmpURLDataInfo)

        [_tmpURLDataInfo release];

    if (_urlLoader)

        [_urlLoader release];

    [super dealloc];

}

- (IBAction)doLoadLocalTrainingData:(id)sender {

    NSOpenPanel* panel = [NSOpenPanel openPanel];

    [panel setCanChooseFiles:NO];

    [panel setCanChooseDirectories:YES];

    if ([panel runModalForDirectory:@"~" file:nil types:nil] == NSOKButton)

    {

        NSString* topDataPath = [[panel filenames] objectAtIndex:0];

        [self log:[NSString stringWithFormat:@"Loading data from %@\n", topDataPath]];

        //start loading data from specified directory.

        [self readDataPathsAt:topDataPath];

    }

}

- (IBAction)doLoadFeedPlist:(id)sender {

    //default plist is the one shipped with the app bundle.

    NSString* resourcesPath =

            [[NSBundle mainBundle] pathForResource:@"training_rss_categories" ofType:@"plist"]; 

    NSString* startupPath;

    NSString* filename;

    if (resourcesPath) {

        filename = [resourcesPath lastPathComponent];

        startupPath = [resourcesPath stringByDeletingLastPathComponent];

    }

    else {

        filename = nil;

        startupPath = @"~";

    }

    NSOpenPanel* panel = [NSOpenPanel openPanel];

    [panel setCanChooseFiles:YES];

    [panel setCanChooseDirectories:NO];

    if ([panel runModalForDirectory:startupPath file:filename types:nil] == NSOKButton) {

        NSString* plistPath = [[panel filenames] objectAtIndex:0];

        //start loading from URLs specified by the plist.

        [self readDataSpecifiedByPlist:plistPath];

    }

}

- (IBAction)doTrainAndSave:(id)sender {

    [self setUIAllBusy:@"Training map ..."];

    //Sanity check on each category.

    //A category need to contain at least one feed in order to train

    NSEnumerator* catEnum = [topLevelDataInfo childEnumerator];

    CategoryDataInfo* catInfo;

    while(catInfo = [catEnum nextObject]) {

        if ([catInfo numberOfChildren] == 0) {

            [self log:[NSString stringWithFormat:@"ERROR: Category \"%@\" is empty. Training cancelled.\n"]];

            return;

        }

    }

    //create a new classifer and set it to training mode.

    LSMClassifier* classifier = [LSMClassifier new];

    [classifier setModeTo:kLSMCTraining];

    catEnum = [topLevelDataInfo childEnumerator];

    //add each category in training data.

    while(catInfo = [catEnum nextObject]) {

        NSString* catName = [catInfo title];

        [classifier addCategory:catName];

        NSEnumerator* feedEnum = [catInfo childEnumerator];

        FeedDataInfo* feedInfo;

        //for each category, add each feed data.

        while (feedInfo = [feedEnum nextObject]) {

            NSString* feedString = [feedInfo plainText];

            [classifier addTrainingText:feedString toCategory:catName with:0];

        }

    }

    //save the map

    NSSavePanel* savePanel = [NSSavePanel savePanel];

    [savePanel setTitle:@"Save LSM map"];

    [savePanel setCanSelectHiddenExtension:NO];

    [savePanel setRequiredFileType:@"lsm"];

    if ([savePanel runModalForDirectory:@"~" file:@"map.lsm"] == NSFileHandlingPanelOKButton) {

        NSString* filename = [savePanel filename];

        //train and save the map.

        if ([classifier writeToFile:filename] == noErr)

            [self log:[NSString stringWithFormat:@"Saved map to %@\n", filename]];

        else

            [self log:[NSString stringWithFormat:@"Failed to save map to %@\n", filename]];

    }

    //release the classifier.

    [classifier release];

    [self setUIIdle];

}

- (IBAction)doCancel:(id)sender {

    [_urlLoader cancel];

    [_tmpURLDataInfo removeAllChildren];

    [self log:@"Loading cancelled by user.\n"];

    [self setUIIdle];

}

- (IBAction)doShowHelp:(id)sender {

    if (![helpTextView string] || [[helpTextView string] length] <= 0) {

        NSString* helpTextPath =

            [[NSBundle mainBundle] pathForResource:@"AppHelp" ofType:@"txt"];   

        NSString* helpText = [NSString stringWithContentsOfFile:helpTextPath

                                encoding:NSMacOSRomanStringEncoding error:nil];

        [helpTextView insertText:helpText];

        [helpTextView scrollRangeToVisible:NSMakeRange(0,0)];

        [helpTextView setEditable:NO];

    }

    [helpWindow makeKeyAndOrderFront:self];

}

////////////////// URLoader delegate //////////////////

- (void)URLLoader:(URLLoader*)theURLLoader didBeginURL:(NSURL*)aURL {

    [self log:[NSString stringWithFormat:@"Began loading %@\n", aURL]];

}

- (void)URLLoader:(URLLoader*)theURLLoader didFinishURL:(NSURL*)aURL {

    [self log:[NSString stringWithFormat:@"Finished loading %@\n", aURL]];

}

- (void)URLLoaderDidFinishAll:(URLLoader*)theURLLoader {

    [self log:@"Finished loading from all URLs\n"];

    [self setUIAllBusy:@"Parsing data ..."];

    //reset outline view data source.

    [topLevelDataInfo removeAllChildren];

    //we have done fetching all URI, now parse them.

    NSEnumerator* catEnum = [_tmpURLDataInfo childEnumerator];

    CategoryDataInfo* category;

    //move each category from _tmpURLDataInfo to topLevelDataInfo.

    while(category = [catEnum nextObject]) {

        NSEnumerator* urlInfoEnum = [category childEnumerator];

        URLDataInfo* urlInfo;

        //create a new category

        CategoryDataInfo* feedCatInfo = [[CategoryDataInfo alloc] initWithTitle:[category title]];

        //for each category, use PSFeed to parse data from each feed URL.

        while (urlInfo = [urlInfoEnum nextObject]) {

            NSData* data = [_urlLoader dataForURL:[urlInfo url]];

            if (data == nil) {

                [self log:[NSString stringWithFormat:@"Failed to load from %@\n", [urlInfo url]]];

                continue;

            }

            PSFeed* feed = [[PSFeed alloc] initWithData:data URL:[urlInfo url]];

            if (feed == nil || [feed title] == nil) {

                [self log:[NSString stringWithFormat:@"Failed to parse data from %@\n", [urlInfo url]]];

            }

            else {

                FeedDataInfo* feedDataInfo = [[FeedDataInfo alloc] initWithFeed:feed];

                [feedCatInfo addChild:feedDataInfo];

                [feedDataInfo release];

            }

            if (feed) [feed release];

        }

        //add the newly created category into topLevelDataInfo.

        [topLevelDataInfo addChild:feedCatInfo];

        [feedCatInfo release];

    }

    [self reloadOutlineView];

    [_tmpURLDataInfo removeAllChildren];

    [_urlLoader reset];

    [self setUIIdle];

}

//////////////////// Private //////////////////////

- (void) readDataPathsAt:(NSString*) topDataPath

{

    [self setUIAllBusy:@"Fetching data ..."];

    [_tmpURLDataInfo removeAllChildren];

    NSMutableArray* pendingURLs = [NSMutableArray new];

    NSFileManager* fileManager = [NSFileManager defaultManager];

    BOOL isDir;

    //each sub folder of topDataPath is treated as a category.

    NSArray* categories = [fileManager directoryContentsAtPath:topDataPath];

    NSEnumerator* catEnumerator = [categories objectEnumerator];

    NSString* catName;

    while (catName = [catEnumerator nextObject])

    {

        //discard hidden file, i.e. file whose name starts with '.'.

        if ([catName hasPrefix:@"."]) continue;

        NSString* catPath = [NSString stringWithFormat:@"%@/%@", topDataPath, catName];

        [fileManager fileExistsAtPath:catPath isDirectory:&isDir];

        //discard it if its not a directory

        if (!isDir) continue;

        [self log:[NSString stringWithFormat:@"Found category: %@\n", catName]];

        CategoryDataInfo* catDataInfo = [[CategoryDataInfo alloc] initWithTitle:catName];

        //each file is a piece of training data belongs to that category.

        NSArray* data = [fileManager directoryContentsAtPath:catPath];

        NSEnumerator* datumEnumerator = [data objectEnumerator];

        NSString* datumName;

        while (datumName = [datumEnumerator nextObject])

        {

            //discard hidden file, i.e. file whose name starts with '.'.

            if ([datumName hasPrefix:@"."]) continue;

            NSString* datumPath = [NSString stringWithFormat:@"%@/%@", catPath, datumName];

            [fileManager fileExistsAtPath:datumPath isDirectory:&isDir];

            //discard it if it is a directory

            if (isDir) continue;

            URLDataInfo* urlDataInfo = [[URLDataInfo alloc] 

                initWithURL:[NSURL fileURLWithPath:datumPath] andTitle:datumName];

            [pendingURLs addObject:[NSURL fileURLWithPath:datumPath]];

            [catDataInfo addChild:urlDataInfo];

            [urlDataInfo release];

        }

        [_tmpURLDataInfo addChild:catDataInfo];

        [catDataInfo release];

    }

    //start loading.

    [_urlLoader load:pendingURLs];

    [pendingURLs release];

    [self setUICancellableBusy:@"Fetching data ... "];

}

- (void) readDataSpecifiedByPlist:(NSString*)plistPath {

    [self setUIAllBusy:@"Fetching data ..."];

    NSDictionary* catDict = [NSDictionary dictionaryWithContentsOfFile:plistPath];

    if (catDict == nil) {

        [self log:[NSString stringWithFormat:@"Failed to load plist %@", plistPath]];

        return;

    }

    [_tmpURLDataInfo removeAllChildren];

    NSMutableArray* pendingURLs = [NSMutableArray new];

    //top level of the plist contains all the categories.

    NSEnumerator* catEnum = [catDict keyEnumerator];

    NSString* catName;

    while (catName = [catEnum nextObject]) {

        [self log:[NSString stringWithFormat:@"found category \"%@\"", catName]];

        CategoryDataInfo* catDataInfo = [[CategoryDataInfo alloc] initWithTitle:catName];

        NSArray* feedArray = [catDict objectForKey:catName];

        //each category contains a list of URLs.

        NSEnumerator* feedEnum = [feedArray objectEnumerator];

        NSString* feedURLStr;

        while (feedURLStr = [feedEnum nextObject]) {

            NSURL* feedURL = [NSURL URLWithString:feedURLStr];

            URLDataInfo* urlDataInfo = [[URLDataInfo alloc] 

                initWithURL:feedURL andTitle:@""];

            [pendingURLs addObject:feedURL];

            [catDataInfo addChild:urlDataInfo];

            [urlDataInfo release];

        }

        [_tmpURLDataInfo addChild:catDataInfo];

        [catDataInfo release];

    }

    //start loading.

    [_urlLoader load:pendingURLs];

    [pendingURLs release];

    [self setUICancellableBusy:@"Fetching data ... "];

}

@end