/Users/awniemel/Notepad-SVN/svn/trunk/CatNiP/CatNiP/IMSLPQueryHelper.m

Go to the documentation of this file.

#import "IMSLPQueryHelper.h"


@implementation IMSLPQueryHelper
@synthesize categoryName;
@synthesize composerName;
@synthesize targetArray; 
@synthesize working;
@synthesize targetMethod;
@synthesize targetObject;
@synthesize stopRequested;
@synthesize pageTitle;
@synthesize thisComposition;
@synthesize queryStatus;

static NSMutableDictionary* imslpQueries;
static NSString* imslpAPIURL;
static NSString* imslpFetchURL;
static NSString* imslpFileURL;


+ (void)initialize {
    if (self == [IMSLPQueryHelper class]) {
        imslpQueries = [[NSMutableDictionary alloc] init];
        [imslpQueries retain];
        imslpAPIURL = @"http://www.imslp.org/api.php";
        imslpFetchURL = @"http://www.imslp.org/index.php";
        imslpFileURL = @"http://imslp.org/index.php?title=Special:Filepath&file=";
        /*   
         
         This code tried to create a cookie to handle the imslpdisclaimeraccepted
         cookie thing IMSLP requires to actually SERVE the file instead of a "hey accept
         the disclaimer" html page.
         
         It is saved here for posterity ++ avjn
         
         NSHTTPCookie *imslpCookie;
         NSMutableDictionary *cookieHeaders = [[NSMutableDictionary alloc] init];
         [cookieHeaders setObject:@"yes" forKey:NSHTTPCookieValue];
         [cookieHeaders setObject:@"imslpdisclaimeraccepted" forKey:NSHTTPCookieName];
         [cookieHeaders setObject:@"imslp.org" forKey:NSHTTPCookieDomain];
         imslpCookie = [NSHTTPCookie cookieWithProperties: cookieHeaders];
         [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:imslpCookie];
         */        
    }
    
}

#pragma mark - Static variable accessor methods

+(NSString *)imslpAPIURL {
    return imslpAPIURL;
}
+(void)setImslpAPIURL:(NSString *)newUrl {
    imslpAPIURL = [NSString stringWithString:newUrl];
}

+(NSString *)imslpFetchURL {
    return imslpFetchURL;
}

+(void)setImslpFetchURL:(NSString *)newUrl {
    imslpFetchURL = [NSString stringWithString:newUrl];
}

+(NSString *)imslpFileURL {
    return imslpFileURL;
}

+(void)setImslpFileURL:(NSString *)newUrl {
    imslpFileURL = [NSString stringWithString:newUrl];
}

#pragma mark - IMSLP Read Operation Request Methods

+(BOOL)readIMSLPCategory:(NSString *)categoryName reportTo:(id)targetObj withMethod:(SEL)targetMethod {
//FIXME: This is copypastecoding, ugh
    if(!imslpQueries) {
        imslpQueries = [[NSMutableDictionary alloc] init];
        //[imslpQueries retain];
    }
    if([imslpQueries objectForKey:categoryName]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:categoryName];
        if(workerObj.working && !workerObj.stopRequested) {
            return NO;
        }
        else {
            [imslpQueries removeObjectForKey:categoryName];
        }
    }
    NSMutableArray* mutableArray = [[NSMutableArray alloc] init];
    //[mutableArray retain];
    IMSLPQueryHelper* workerObj = [[[IMSLPQueryHelper alloc] initWithCategory:categoryName intoArray:mutableArray] autorelease];
    //[workerObj retain];
    [imslpQueries setObject:workerObj forKey:categoryName];
    workerObj.targetMethod = targetMethod;
    workerObj.targetObject = targetObj;
    workerObj.queryStatus = MWQueryStarting;
    [workerObj startCategoryFetch];
    
    return YES;
    
    
}

+(BOOL)readIMSLPPage:(NSString *)pageName composerName:(NSString*)cName reportTo:(id)targetObj withMethod:(SEL)targetMethod {
    //FIXME: This is copypastecoding, ugh
    if(!imslpQueries) {
        imslpQueries = [[NSMutableDictionary alloc] init];
        //[imslpQueries retain];
    }
    if([imslpQueries objectForKey:pageName]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:pageName];
        if(workerObj.working && !workerObj.stopRequested) {
            return NO;
        }
        else {
            [imslpQueries removeObjectForKey:pageName];
        }
    }
    IMSLPQueryHelper* workerObj = [[[IMSLPQueryHelper alloc] initWithTitle:pageName] autorelease];
    //        [workerObj retain];
    [imslpQueries setObject:workerObj forKey:pageName];
    workerObj.composerName = cName;
    workerObj.targetMethod = targetMethod;
    workerObj.targetObject = targetObj;
    workerObj.queryStatus = MWQueryStarting;
    [workerObj startPageFetch];
    
    return YES;
    
    
}
+(BOOL)readIMSLPFile:(NSString *)fileName ofComposition:(CompositionData*)theCompo reportTo:(id)targetObj withMethod:(SEL)targetMethod {
    //FIXME: This is copypastecoding, ugh
    if(!imslpQueries) {
        imslpQueries = [[NSMutableDictionary alloc] init];
        //[imslpQueries retain];
    }
    if(!fileName || [fileName length] < 1) {
        return NO;
    }
    if([imslpQueries objectForKey:fileName]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:fileName];
        if(workerObj.working && !workerObj.stopRequested) {
            return NO;
        }
        else {
            [imslpQueries removeObjectForKey:fileName];
        }
    }
    IMSLPQueryHelper* workerObj = [[[IMSLPQueryHelper alloc] initWithTitle:fileName] autorelease];
    //[workerObj retain];
    [imslpQueries setObject:workerObj forKey:fileName];
    workerObj.thisComposition = theCompo;
    workerObj.targetMethod = targetMethod;
    workerObj.targetObject = targetObj;
    workerObj.queryStatus = MWQueryStarting;
    [workerObj startDownload];
    
    return YES;
}

#pragma mark - Read operation progress report methods

+(BOOL)readInProgressFor:(NSString*)destination {
    if(!imslpQueries) {
        return NO;
    }
    if([imslpQueries objectForKey:destination]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:destination];
        if(workerObj.working && !workerObj.stopRequested) {
            return YES;
        }
    }
    return NO;
    
}
+(int)queryStatusFor:(NSString *)destination {
    if(!imslpQueries) {
        return MWQueryNoStatus;
    }
    if([imslpQueries objectForKey:destination]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:destination];
        return workerObj.queryStatus;
    }
    return MWQueryNoStatus;
}

+(float)downloadProgressFor:(NSString *)fileName {
    if(!imslpQueries) {
        return -1.0;
    }
    if([imslpQueries objectForKey:fileName]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:fileName];
        return [workerObj getDownloadProgress];
    }
    return MWQueryNoStatus;
    
}

#pragma mark - Read operation cancellation methods

+(BOOL)abortRead:(NSString *)destination {
    if(!imslpQueries) {
        return NO;
    }
    if([imslpQueries objectForKey:destination]) {
        IMSLPQueryHelper* workerObj = (IMSLPQueryHelper*)[imslpQueries objectForKey:destination];
        workerObj.stopRequested = YES;
        workerObj.queryStatus = MWQueryCancelled;
        return YES;
    }
    return NO;
    
}

+(BOOL)abortAllReads {
    id key;
    NSEnumerator* enumer = [imslpQueries keyEnumerator];
    while((key = [enumer nextObject])) {
        IMSLPQueryHelper *workerObj = [imslpQueries objectForKey:key];
        workerObj.stopRequested = YES;
        workerObj.queryStatus = MWQueryCancelled;
    }
    return YES;
}

#pragma mark - IMSLPQueryHelper worker object initialization methods

-initWithCategory:(NSString*)category intoArray:(NSMutableArray *)mutableArray {
    if(!category || !mutableArray) {
        return nil;
    }
    if((self = [super init])) {
        // whee we're an object now
        self.categoryName = category;
        self.targetArray = mutableArray;
        
        self.stopRequested = NO;
        self.working = NO;
        self.queryStatus = MWQueryNoStatus;
        
        return self;
    }
    return nil;
    
}

-(id)initWithTitle:(NSString *)pTitle {
    if(!pTitle) {
        return nil;
    }
    if((self = [super init])) {
        // whee we're an object now
        self.pageTitle = pTitle;
        self.stopRequested = NO;
        self.working = NO;
        self.queryStatus = MWQueryNoStatus;
        
        return self;
    }
    return nil;
}

#pragma mark - Read operation starter methods

-(void)startCategoryFetch {
    if(!myCategoryQuery) {
        myCategoryQuery = [MediaWikiCategoryQuery newCategoryQuery:[IMSLPQueryHelper imslpAPIURL] delegate:self];
    }
    myCategoryQuery.categoryName = self.categoryName;
    myCategoryQuery.chunkSize = @"500";
    [myCategoryQuery addProgressListener:self];
    self.working = YES;
    self.queryStatus = MWQueryInProgress;
    [myCategoryQuery startQuery];
        

}

-(void)startPageFetch {
    if(!myPageQuery) {
        myPageQuery = [MediaWikiPageQuery newPageQuery:[IMSLPQueryHelper imslpFetchURL] delegate:self];
    }
    myPageQuery.wikiTitle = self.pageTitle;
    myPageQuery.wikiAction = @"raw";
    myPageQuery.composerName = self.composerName;
    [myPageQuery addProgressListener:self];
    self.working = YES;
    self.queryStatus = MWQueryInProgress;
    [myPageQuery startQuery];
    
}

-(void)startDownload {
    
    myDownload = [[MediaWikiDownload alloc] initWithDelegate:self mediaWikiURL:imslpFileURL];
    myDownload.mediaWikiFilename = self.pageTitle;
    [myDownload addProgressListener:self];
    self.working = YES;
    self.queryStatus = MWQueryInProgress;
    [myDownload startQuery];
    
}

#pragma mark - MediaWiki... delegate method implementations

-(void)didReceiveCategoryArray:(NSArray *)categoryArray {
    //NSLog(@"got %d data and cmcontinue was %@",[categoryArray count],myCategoryQuery.continueFrom);
    if(self.stopRequested) {
        [myCategoryQuery release];
        self.working = NO;
        self.stopRequested = NO;
        self.queryStatus = MWQueryCancelled;
        return;
    }
    NSEnumerator *e = [categoryArray objectEnumerator];
    NSString* catname;
    while((catname = (NSString*)[e nextObject])) {
        catname = [catname stringByReplacingOccurrencesOfString:@"Category:" withString:@""];
        [self.targetArray addObject:catname];
        
    }
    //[self.targetArray addObjectsFromArray:categoryArray];
    if(myCategoryQuery.continueFrom) {
        [self.targetObject performSelector:self.targetMethod withObject:nil];
         [myCategoryQuery startQuery];
    }
    else {
        self.working = NO;
        self.queryStatus = MWQueryCompleted;
        if(targetObject) {
            [self.targetObject performSelector:self.targetMethod withObject:[NSArray arrayWithArray:self.targetArray]];
        }

    }
}
-(void)categoryParseFailed:(NSError *)error {
    //FIXME: This should probably do something!
    self.working = NO;
    self.queryStatus = MWQueryFailed;
    [[CatNiPErrorManager sharedManager] reportError:error];
    //NSLog(@"IMSLPQueryHelper received XML parse/validate error: %@",error);
}

-(void)didReceiveCompositionData:(id)compData {
    self.working = NO;
    self.queryStatus = MWQueryCompleted;
    if(targetObject) {
        [self.targetObject performSelector:self.targetMethod withObject:compData];
    }
}
-(void)didFinishDownload:(NSString *)loadedFilePath {
    self.working = NO;
    if(loadedFilePath) {
        self.queryStatus = MWQueryCompleted;
    }
    else {
        self.queryStatus = MWQueryFailed;
    }
    NSArray* fileNameParams = [NSArray arrayWithObjects:self.pageTitle, loadedFilePath, nil];
    if(targetObject) {
        [self.targetObject performSelector:self.targetMethod withObject:fileNameParams withObject:self.thisComposition];
    }
    
}

-(void)progressUpdate:(id)from {
// id is either a MediaWikiDownload or MediaWikiQuery
    
    if(self.stopRequested) {
        if([from isKindOfClass:[MediaWikiDownload class]]) {
            self.working = NO;
            self.queryStatus = MWQueryCancelled;
            self.stopRequested = NO;
            MediaWikiDownload* dl = from;
            [dl abortRead];
            [dl removeProgressListener:self];
        }
    }
    if(self.queryStatus != MWQueryCancelled) {
//        NSInteger current = [from currentBytes];
//        NSInteger expected = [from expectedSize];
//        NSString* title = (pageTitle ? pageTitle : categoryName);
//        float status = [IMSLPQueryHelper downloadProgressFor:title];
        //NSLog(@"Read progress for %@ (%f): %d bytes out of %d.",title,status,current,expected);
    }
}

-(float)getDownloadProgress {
    if(myDownload) {
        float expected = (float)[myDownload expectedSize];
        float received = (float)[myDownload currentBytes];
        float ratio = received / expected;
        return ratio;
                          
    }
    return -1.0;
}

#pragma mark - IMSLPQueryHelper worker object dealloc method

-(void)dealloc {
    if(targetObject) {
        [targetArray release];    
    }
    [myDownload release];
    [myCategoryQuery release];
    [myPageQuery release];
    [super dealloc];
}
@end