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

Go to the documentation of this file.

#import "MediaWikiPageQuery.h"


@implementation MediaWikiPageQuery
@synthesize parameters;
@synthesize pageDelegate;
@synthesize composerName;

-(void)setWikiAction:(NSString *)wikiAction {
    [self.parameters setValue:[NSString stringWithString:wikiAction] forKey:@"action"];
}
-(NSString *)wikiAction {
    return [self.parameters valueForKey:@"action"];
}
-(void)setWikiTitle:(NSString *)wikiTitle {
    [self.parameters setValue:[NSString stringWithString:wikiTitle] forKey:@"title"];
}
-(NSString *)wikiTitle {
    return [self.parameters valueForKey:@"title"];
}
+ (MediaWikiPageQuery*) newPageQuery:(NSString*)URL delegate:(id <MediaWikiPageQueryDelegate>)qDelegate {
    
    if(qDelegate == nil) {
        return nil;
    }
    MediaWikiPageQuery* cQuery = [MediaWikiPageQuery alloc];
    cQuery = [cQuery initWithDelegate:cQuery mediaWikiURL:URL];
    cQuery.pageDelegate = qDelegate;
    return cQuery;
}

-init {
    if((self = [super init])) {
        self.parameters = [[[NSMutableDictionary alloc] init] autorelease];

        return self;
    }
    return nil;
}
- (NSString*) buildQueryURL {
    return [NSString stringWithFormat: @"%@?%@", self.mediaWikiURLString, [self _buildGetParams]];
}

-(void)didReceiveMediaWikiData:(NSData *)data {
    //data contains the whole raw page in wikitext format
    NSString* fullString = [[NSString alloc] initWithBytes:[data bytes] length:[data length] encoding:NSUTF8StringEncoding];
    CompositionData* comp = [[CompositionData alloc] init];
    /*NSLog(@"received data, size is %d and string length is %d",[data length],
      [fullString length]); */

    /* We could theoretically parse this from the wikiTitle, but it's better
       to use the one passed to us. */
    comp.composerName = self.composerName;
    comp.compositionName = self.wikiTitle;
    /* An array for all the score files we find in the wiki page */
    NSMutableArray* scores = [[NSMutableArray alloc] init];
    ScoreData* score; 
    
    /* An error object for catching regexp errors. If we were smart we'd
       actually check this... Oh well, ACTION POINT!*/
    NSError* error = NULL;
    /* Finds every imslpfile template block in the wikitext */
    NSRegularExpression* imslpFileRegexp = [NSRegularExpression regularExpressionWithPattern:@"(\\n=+([^=]*?)=+\\n)?\\{\\{#fte:imslpfile(.*?)^\\}\\}$" options:(NSRegularExpressionCaseInsensitive | NSRegularExpressionDotMatchesLineSeparators | NSRegularExpressionAnchorsMatchLines) error:&error];
    if(error) {
        [[CatNiPErrorManager sharedManager] reportError:error];
    }
    /* Checks whether a string contains a wikitext header */
    NSRegularExpression* imslpFileHeaderRegexp = [NSRegularExpression regularExpressionWithPattern:@"\\n?=+(.*?)=+\\n" options:0 error:&error];
    if(error) {
        [[CatNiPErrorManager sharedManager] reportError:error];
    }
    /* Reads every name=value pair found in a imslp file template block. */
    NSRegularExpression* imslpPropertiesRegexp = 
    [NSRegularExpression regularExpressionWithPattern:@"^\\|+(.*)=(.*)$" options:(NSRegularExpressionAnchorsMatchLines) error:&error];
    if(error) {
        [[CatNiPErrorManager sharedManager] reportError:error];
    }
    /* Checks whether the name of a property contains a discrete number as the last character(s) */
    NSRegularExpression* imslpPropNameRegexp = 
    [NSRegularExpression regularExpressionWithPattern:@"(\\D+)\\s(\\d+)" options:0 error:&error];
    if(error) {
        [[CatNiPErrorManager sharedManager] reportError:error];
    }


    NSString* propName;
    NSString* propValue;
//    NSUInteger numMatches = [imslpFileRegexp numberOfMatchesInString:fullString options:0 range:NSMakeRange(0, [fullString length])];
    //NSLog(@"number of file template matches in full string is %d",numMatches);
    
    NSArray* fileMatches = [imslpFileRegexp matchesInString:fullString options:0 range:NSMakeRange(0, [fullString length])];
    for(NSTextCheckingResult *match in fileMatches) {
      /* We're going to start by creating a new string which represents
         the single file template block we're currently looking at */
        NSString* fileEntry = [fullString substringWithRange:[match range]]; 
        /* Each file block should contain at least one File Name #=something
           name/value pair, where the # is a number (eg. File Name 1=what.pdf)
           and we're interested in these; each one defines one score file. */
        NSMutableDictionary* fileData = [[NSMutableDictionary alloc] init ];
        NSMutableDictionary* commonData = [[NSMutableDictionary alloc] init];
        /* First though, we check if we caught a header for this template. */
        NSTextCheckingResult* headerResult = [imslpFileHeaderRegexp firstMatchInString:fileEntry options:0 range:NSMakeRange(0, [fileEntry length])];
        NSString* fileHeader = @"";
        if(headerResult) {
            fileHeader = [fileEntry substringWithRange:[headerResult rangeAtIndex:1]];
        }
        NSLog(@"File header: %@",fileHeader);
        
//        numMatches = [imslpPropertiesRegexp numberOfMatchesInString:fileEntry options:0 range:NSMakeRange(0, [fileEntry length])];
        //        NSLog(@" + number of property row matches in file string (len %d) is %d",[fileEntry length], numMatches);
        NSArray* propMatches = [imslpPropertiesRegexp matchesInString:fileEntry options:0 range:NSMakeRange(0, [fileEntry length])];

        /* We now check each property found in the block */
        for(NSTextCheckingResult *propMatch in propMatches) {
          /* The propName is the first parenthesized value in the 
             imslPropertiesRegexp expression, propName the second, and
             we get them with rangeAtIndex. rangeAtIndex:0 would give us
             the whole "|Ladedah=Whatever" string.
          */
            propName = [fileEntry substringWithRange:[propMatch rangeAtIndex:1]];
            propValue = [fileEntry substringWithRange:[propMatch rangeAtIndex:2]];
            /* We now see if this property is one of the "number indexed" ones
               ie. basically one of the multifile properties. Note that
               even if there is only one file in the block it will have a
               number index, and all it's properties (eg. page count) will
               be indexed to it as well
            */
            NSTextCheckingResult* indexResult = [imslpPropNameRegexp firstMatchInString:propName options:0 range:NSMakeRange(0, [propName length])];
            if(indexResult) {
                // We have a Blah blah 5=Somethingsomething result
                // Blah blah is in rangeAtIndex:1 and the number is in
                // rangeAtIndex:2
//                NSInteger idx = [[propName substringWithRange:[indexResult rangeAtIndex:2]] integerValue];
                NSString* idxString = [propName substringWithRange:[indexResult rangeAtIndex:2]];
                NSString* nameString = [propName substringWithRange:[indexResult rangeAtIndex:1]]; 
                /* All properties with a number index of x are for the file
                   defined by File Name x=whatever.pdf so we save them
                   all in a nice little dictionary for later. */
                if(![fileData objectForKey:idxString]) {
                    NSMutableDictionary* specificFileData = [[[NSMutableDictionary alloc] init] autorelease];
                    [fileData setObject:specificFileData forKey:idxString];

                }
                [[fileData objectForKey:idxString] setObject:propValue forKey:nameString];
                
//                NSLog(@"  - indexed match found, [%d] %@",idx,propName);                
                
            } 
            else {
              /* non-indexed properties are for every file found in the block */
                [commonData setObject:propValue forKey:propName];
            }
            //            NSLog(@"  - match found as %@ is %@",propName, propValue);
        }
        
        /* We've read all the properties in the block. Now we need to create
           a score data object for every file in the block and apply the common
           data to each one */
        NSEnumerator* fileEntriesEnumerator = [fileData keyEnumerator];
        id key;
        while((key = [fileEntriesEnumerator nextObject])) {
            score = [[ScoreData alloc] init];
            NSMutableDictionary* combinedDictionary = [[NSMutableDictionary alloc] initWithDictionary:[fileData objectForKey:key]];
            [combinedDictionary addEntriesFromDictionary:commonData];
            NSEnumerator* dataEnumerator = [combinedDictionary keyEnumerator];
            id dataKey;
            NSMutableString* metaDataString = [[NSMutableString alloc] init];
            NSMutableDictionary* resultDictionary = [[NSMutableDictionary alloc] init];
            // Default description if no other is read
            score.description = @"(No description)";
            while((dataKey = [dataEnumerator nextObject])) {
                if([dataKey caseInsensitiveCompare:@"File Name"] == NSOrderedSame) {
                    score.pdf = [combinedDictionary objectForKey:dataKey];
                }
                else if([dataKey caseInsensitiveCompare:@"File Description"] == NSOrderedSame) {
                    score.description = [NSString stringWithFormat:@"%@ %@", [combinedDictionary objectForKey:dataKey], fileHeader];
                }
                
                else {
                    [metaDataString appendFormat:@"%@ = %@\n",dataKey,[combinedDictionary objectForKey:dataKey]];
                    [resultDictionary setObject:[combinedDictionary objectForKey:dataKey] forKey:dataKey];
                }
            }
            
        
            score.fullMetaData = [NSString stringWithString:metaDataString];
            score.metaDataDict = resultDictionary;
            /* Release some objects ... */
            [combinedDictionary removeAllObjects];
            [combinedDictionary release];
            [resultDictionary release]; //not emptying it because we gave it away to score
            [metaDataString release];


            /* finally add the build scoredata object into the list of all
               scores found on this page */
            if (score.pdf) [scores addObject:score];
            [score release];
        }
        [fileData removeAllObjects];
        [commonData removeAllObjects];
        [fileData release];
        [commonData release];
        
        //NSLog(@"result range: %@", match);
    }
    comp.musicScores = [[[NSArray alloc] initWithArray:scores] autorelease];
    [scores removeAllObjects];
    [scores release];
    [fullString release];
    /* Tell the delegate that we've read all the scores from the page */
    [self.pageDelegate didReceiveCompositionData:[comp autorelease]];
}
@end

@implementation MediaWikiPageQuery(Private)

- (NSString*)_buildGetParams {
    NSMutableString* qString=[[[NSMutableString alloc] init] autorelease];
    NSEnumerator *enumerator = [self.parameters keyEnumerator];
    id key;
    
    while ((key = [enumerator nextObject])) {
        [qString appendString: key];
        [qString appendString:@"="];
        [qString appendString: [self.parameters valueForKey:key]];
        [qString appendString:@"&"];
    }
    
    return [[[NSString alloc] initWithString:qString] autorelease];
}

@end