OOFileScannerVerifierStage Class Reference

#include <OOFileScannerVerifierStage.h>

Inheritance diagram for OOFileScannerVerifierStage:

Collaboration diagram for OOFileScannerVerifierStage:

Instance Methods
(BOOL)	- fileExists:inFolder:referencedFrom:checkBuiltIn:
(NSString *)	- pathForFile:inFolder:referencedFrom:checkBuiltIn:
(NSData *)	- dataForFile:inFolder:referencedFrom:checkBuiltIn:
(id)	- plistNamed:inFolder:referencedFrom:checkBuiltIn:
(id)	- displayNameForFile:andFolder:
(NSArray *)	- filesInFolder:
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(void)	- run [implementation]
(void)	- scanForFiles [implementation]
(void)	- checkRootFolders [implementation]
(void)	- checkKnownFiles [implementation]
(NSDictionary *)	- lowercaseMap: [implementation]
(NSDictionary *)	- scanDirectory: [implementation]
(void)	- checkPListFormat:file:folder: [implementation]
(NSSet *)	- constructReadMeNames [implementation]
(void)	- checkConfigFiles [implementation]
Instance Methods inherited from OOOXPVerifierStage
(OOOXPVerifier *)	- verifier
(BOOL)	- completed
(NSSet *)	- dependencies
(NSSet *)	- dependents
(BOOL)	- shouldRun
(id)	- init [implementation]
(id)	- description [implementation]
(void)	- setVerifier: [implementation]
(BOOL)	- isDependentOf: [implementation]
(void)	- registerDependency: [implementation]
(void)	- dependencyRegistrationComplete [implementation]
(BOOL)	- canRun [implementation]
(void)	- performRun [implementation]
(void)	- noteSkipped [implementation]
(NSSet *)	- resolvedDependencies [implementation]
(NSSet *)	- resolvedDependents [implementation]
(void)	- registerDepedent: [implementation]
(void)	- dependencyCompleted: [implementation]

Class Methods
(NSString *)	+ nameForDependencyForVerifier:

Private Attributes
NSString *	_basePath
NSMutableSet *	_usedFiles
NSMutableSet *	_caseWarnings
NSDictionary *	_directoryListings
NSDictionary *	_directoryCases
NSMutableSet *	_badPLists
NSSet *	_junkFileNames
NSSet *	_skipDirectoryNames

Detailed Description

Definition at line 36 of file OOFileScannerVerifierStage.h.

Method Documentation

checkConfigFiles

- (void) checkConfigFiles

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 444 of file OOFileScannerVerifierStage.m.

{
    NSArray                 *knownNames = nil;
    NSEnumerator            *nameEnum = nil;
    NSString                *name = nil,
        *lcName = nil,
        *realFileName = nil;
    BOOL                    inConfigDir;
    
    knownNames = [[self verifier] configurationArrayForKey:@"knownConfigFiles"];
    for (nameEnum = [knownNames objectEnumerator]; (name = [nameEnum nextObject]); )
    {
        if (![name isKindOfClass:[NSString class]])  continue;
        
        /*  In theory, we could use -fileExists:inFolder:referencedFrom:checkBuiltIn:
        here, but we want a different error message.
        */
        
        lcName = [name lowercaseString];
        realFileName = [[_directoryListings oo_dictionaryForKey:@"config"] objectForKey:lcName];
        inConfigDir = realFileName != nil;
        if (!inConfigDir)  realFileName = [[_directoryListings oo_dictionaryForKey:@""] objectForKey:lcName];
        if (realFileName == nil)  continue;
        
        if (![realFileName isEqualToString:name])
        {
            if (inConfigDir)  realFileName = [@"Config" stringByAppendingPathComponent:realFileName];
            OOLog(@"verifyOXP.files.caseMismatch", @"***** ERROR: case mismatch: configuration file '%@' should be called '%@'.", realFileName, name);
        }
    }
}

checkKnownFiles

- (void) checkKnownFiles

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 477 of file OOFileScannerVerifierStage.m.

{
    NSDictionary            *directories = nil;
    NSEnumerator            *directoryEnum = nil;
    NSString                *directory = nil,
                            *lcDirectory = nil;
    NSArray                 *fileList = nil;
    NSEnumerator            *nameEnum = nil;
    NSString                *name = nil,
                            *lcName = nil,
                            *realFileName = nil;
    BOOL                    inDirectory;
    
    directories = [[self verifier] configurationDictionaryForKey:@"knownFiles"];
    for (directoryEnum = [directories keyEnumerator]; (directory = [directoryEnum nextObject]); )
    {
        fileList = [directories objectForKey:directory];
        lcDirectory = [directory lowercaseString];
        for (nameEnum = [fileList objectEnumerator]; (name = [nameEnum nextObject]); )
        {
            if (![name isKindOfClass:[NSString class]])  continue;
            
            /*  In theory, we could use -fileExists:inFolder:referencedFrom:checkBuiltIn:
                here, but we want a different error message.
            */
            
            lcName = [name lowercaseString];
            realFileName = [[_directoryListings oo_dictionaryForKey:lcDirectory] objectForKey:lcName];
            inDirectory = (realFileName != nil);
            if (!inDirectory)
            {
                // Allow for files in root directory of OXP
                realFileName = [[_directoryListings oo_dictionaryForKey:@""] objectForKey:lcName];
            }
            if (realFileName == nil)  continue;
            
            if (![realFileName isEqualToString:name])
            {
                if (inDirectory)  realFileName = [directory stringByAppendingPathComponent:realFileName];
                OOLog(@"verifyOXP.files.caseMismatch", @"***** ERROR: case mismatch: file '%@' should be called '%@'.", realFileName, name);
            }
        }
    }
}

Referenced by run.

Here is the caller graph for this function:

checkPListFormat:file:folder:

- (void) checkPListFormat: (NSPropertyListFormat) format file: (NSString *) file folder: (NSString *) folder

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 616 of file OOFileScannerVerifierStage.m.

                        :(NSPropertyListFormat)format file:(NSString *)file folder:(NSString *)folder
{
    NSString                *weirdnessKey = nil;
    NSString                *formatDesc = nil;
    NSString                *displayPath = nil;
    
    if (format != NSPropertyListOpenStepFormat && format != NSPropertyListXMLFormat_v1_0)
    {
        displayPath = [self displayNameForFile:file andFolder:folder];
        weirdnessKey = [displayPath lowercaseString];
        
        if (![_badPLists containsObject:weirdnessKey])
        {
            // Warn about "non-standard" format
            [_badPLists addObject:weirdnessKey];
            
            switch (format)
            {
                case NSPropertyListBinaryFormat_v1_0:
                    formatDesc = @"Apple binary format";
                    break;
                
#if OOLITE_GNUSTEP
                case NSPropertyListGNUstepFormat:
                    formatDesc = @"GNUstep text format";
                    break;
                
                case NSPropertyListGNUstepBinaryFormat:
                    formatDesc = @"GNUstep binary format";
                    break;
#endif
                
                default:
                    formatDesc = [NSString stringWithFormat:@"unknown format (%i)", (int)format];
            }
            
            OOLog(@"verifyOXP.plist.weirdFormat", @"----- WARNING: Property list %@ is in %@; OpenStep text format and XML format are the recommended formats for Oolite.", displayPath, formatDesc);
        }
    }
}

Referenced by plistNamed:inFolder:referencedFrom:checkBuiltIn:.

Here is the caller graph for this function:

checkRootFolders

- (void) checkRootFolders

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 418 of file OOFileScannerVerifierStage.m.

{
    NSArray                 *knownNames = nil;
    NSEnumerator            *nameEnum = nil;
    NSString                *name = nil;
    NSString                *lcName = nil;
    NSString                *actual = nil;
    
    knownNames = [[self verifier] configurationArrayForKey:@"knownRootDirectories"];
    for (nameEnum = [knownNames objectEnumerator]; (name = [nameEnum nextObject]); )
    {
        if (![name isKindOfClass:[NSString class]])  continue;
        
        lcName = [name lowercaseString];
        actual = [_directoryCases objectForKey:lcName];
        if (actual == nil)  continue;
        
        if (![actual isEqualToString:name])
        {
            OOLog(@"verifyOXP.files.caseMismatch", @"***** ERROR: case mismatch: directory '%@' should be called '%@'.", actual, name);
        }
        [_caseWarnings addObject:lcName];
    }
}

Referenced by run.

Here is the caller graph for this function:

constructReadMeNames

- (NSSet *) constructReadMeNames

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 658 of file OOFileScannerVerifierStage.m.

{
    NSDictionary            *dict = nil;
    NSArray                 *stems = nil,
                            *extensions = nil;
    NSMutableSet            *result = nil;
    NSUInteger              i, j, stemCount, extCount;
    NSString                *stem = nil,
                            *extension = nil;
    
    dict = [[self verifier] configurationDictionaryForKey:@"readMeNames"];
    stems = [dict oo_arrayForKey:@"stems"];
    extensions = [dict oo_arrayForKey:@"extensions"];
    stemCount = [stems count];
    extCount = [extensions count];
    if (stemCount * extCount == 0)  return nil;
    
    // Construct all stem+extension permutations
    result = [NSMutableSet setWithCapacity:stemCount * extCount];
    for (i = 0; i != stemCount; ++i)
    {
        stem = [[stems oo_stringAtIndex:i] lowercaseString];
        if (stem != nil)
        {
            for (j = 0; j != extCount; ++j)
            {
                extension = [[extensions oo_stringAtIndex:j] lowercaseString];
                if (extension != nil)
                {
                    [result addObject:[stem stringByAppendingString:extension]];
                }
            }
        }
    }
    
    return result;
}

Referenced by OOFileScannerVerifierStage(OOPrivate)::scanForFiles.

Here is the caller graph for this function:

dataForFile:inFolder:referencedFrom:checkBuiltIn:

- (NSData *) dataForFile:		(NSString *)	file
inFolder:		(NSString *)	folder
referencedFrom:		(NSString *)	context
checkBuiltIn:		(BOOL)	checkBuiltIn

Definition at line 225 of file OOFileScannerVerifierStage.m.

                       :(NSString *)file
               inFolder:(NSString *)folder
         referencedFrom:(NSString *)context
           checkBuiltIn:(BOOL)checkBuiltIn
{
    NSString                *path = nil;
    
    path = [self pathForFile:file inFolder:folder referencedFrom:context checkBuiltIn:checkBuiltIn];
    if (path == nil)  return nil;
    
    return [NSData dataWithContentsOfMappedFile:path];
}

References nil, and pathForFile:inFolder:referencedFrom:checkBuiltIn:.

Referenced by plistNamed:inFolder:referencedFrom:checkBuiltIn:.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 87 of file OOFileScannerVerifierStage.m.

{
    [_basePath release];
    [_usedFiles release];
    [_caseWarnings release];
    [_directoryListings release];
    [_directoryCases release];
    [_badPLists release];
    
    [super dealloc];
}

References dealloc, and OOOXPVerifierStage::dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

displayNameForFile:andFolder:

- (id) displayNameForFile:		(NSString *)	file
andFolder:		(NSString *)	folder

Definition at line 306 of file OOFileScannerVerifierStage.m.

                        :(NSString *)file andFolder:(NSString *)folder
{
    if (file != nil && folder != nil)  return [folder stringByAppendingPathComponent:file];
    return file;
}

References nil.

Referenced by OOFileScannerVerifierStage(OOPrivate)::checkPListFormat:file:folder:, OOTextureVerifierStage(OOPrivate)::checkTextureNamed:inFolder:, pathForFile:inFolder:referencedFrom:checkBuiltIn:, and plistNamed:inFolder:referencedFrom:checkBuiltIn:.

Here is the caller graph for this function:

fileExists:inFolder:referencedFrom:checkBuiltIn:

- (BOOL) fileExists:		(NSString *)	file
inFolder:		(NSString *)	folder
referencedFrom:		(NSString *)	context
checkBuiltIn:		(BOOL)	checkBuiltIn

Definition at line 139 of file OOFileScannerVerifierStage.m.

                  :(NSString *)file
          inFolder:(NSString *)folder
    referencedFrom:(NSString *)context
      checkBuiltIn:(BOOL)checkBuiltIn
{
    return [self pathForFile:file inFolder:folder referencedFrom:context checkBuiltIn:checkBuiltIn] != nil;
}

References nil, and pathForFile:inFolder:referencedFrom:checkBuiltIn:.

Referenced by OOCheckDemoShipsPListVerifierStage::shouldRun, OOCheckEquipmentPListVerifierStage::shouldRun, OOCheckRequiresPListVerifierStage::shouldRun, and OOCheckShipDataPListVerifierStage::shouldRun.

Here is the call graph for this function:

Here is the caller graph for this function:

filesInFolder:

- (NSArray *) filesInFolder:

(NSString *)

folder

Definition at line 313 of file OOFileScannerVerifierStage.m.

                          :(NSString *)folder
{
    if (folder == nil)  return nil;
    return [[_directoryListings objectForKey:[folder lowercaseString]] allValues];
}

References nil.

Referenced by OOCheckJSSyntaxVerifierStage::run, OOTextureVerifierStage::run, and OOTextureVerifierStage::shouldRun.

Here is the caller graph for this function:

lowercaseMap:

- (NSDictionary *) lowercaseMap: (NSArray *) array

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 523 of file OOFileScannerVerifierStage.m.

                              :(NSArray *)array
{
    NSUInteger              i, count;
    NSString                *canonical = nil,
                            *lowercase = nil;
    NSMutableDictionary     *result = nil;
    
    count = [array count];
    if (count == 0)  return [NSDictionary dictionary];
    result = [NSMutableDictionary dictionaryWithCapacity:count];
    
    for (i = 0; i != count; ++i)
    {
        canonical = [array oo_stringAtIndex:i];
        if (canonical != nil)
        {
            lowercase = [canonical lowercaseString];
            [result setObject:canonical forKey:lowercase];
        }
    }
    
    return result;
}

name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 100 of file OOFileScannerVerifierStage.m.

{
    return kFileScannerStageName;
}

References kFileScannerStageName, and name.

Referenced by name.

Here is the call graph for this function:

Here is the caller graph for this function:

nameForDependencyForVerifier:

+ (NSString *) nameForDependencyForVerifier:

(OOOXPVerifier *)

verifier

Definition at line 125 of file OOFileScannerVerifierStage.m.

                                          :(OOOXPVerifier *)verifier
{
    OOFileScannerVerifierStage *stage = [verifier stageWithName:kFileScannerStageName];
    if (stage == nil)
    {
        stage = [[OOFileScannerVerifierStage alloc] init];
        [verifier registerStage:stage];
        [stage release];
    }
    
    return kFileScannerStageName;
}

References kFileScannerStageName, nil, OOOXPVerifier::registerStage:, and OOOXPVerifier::stageWithName:.

Referenced by OOFileHandlingVerifierStage::dependencies.

Here is the call graph for this function:

Here is the caller graph for this function:

pathForFile:inFolder:referencedFrom:checkBuiltIn:

- (NSString *) pathForFile:		(NSString *)	file
inFolder:		(NSString *)	folder
referencedFrom:		(NSString *)	context
checkBuiltIn:		(BOOL)	checkBuiltIn

Definition at line 148 of file OOFileScannerVerifierStage.m.

                         :(NSString *)file
                 inFolder:(NSString *)folder
           referencedFrom:(NSString *)context
             checkBuiltIn:(BOOL)checkBuiltIn
{
    NSString                *lcName = nil,
                            *lcDirName = nil,
                            *realDirName = nil,
                            *realFileName = nil,
                            *path = nil,
                            *expectedPath = nil;
    
    if (file == nil)  return nil;
    lcName = [file lowercaseString];
    
    if (folder != nil)
    {
        lcDirName = [folder lowercaseString];
        realFileName = [[_directoryListings oo_dictionaryForKey:lcDirName] objectForKey:lcName];
        
        if (realFileName != nil)
        {
            realDirName = [_directoryCases objectForKey:lcDirName];
            path = [realDirName stringByAppendingPathComponent:realFileName];
        }
    }
    
    if (path == nil)
    {
        realFileName = [[_directoryListings oo_dictionaryForKey:@""] objectForKey:lcName];
        
        if (realFileName != nil)
        {
            path = realFileName;
        }
    }
    
    if (path != nil)
    {
        [_usedFiles addObject:path];
        if (realDirName != nil && ![realDirName isEqual:folder])
        {
            // Case mismatch for folder name
            if (![_caseWarnings containsObject:lcDirName])
            {
                [_caseWarnings addObject:lcDirName];
                OOLog(@"verifyOXP.files.caseMismatch", @"***** ERROR: case mismatch: directory '%@' should be called '%@'.", realDirName, folder);
            }
        }
        
        if (![realFileName isEqual:file])
        {
            // Case mismatch for file name
            if (![_caseWarnings containsObject:lcName])
            {
                [_caseWarnings addObject:lcName];
                
                expectedPath = [self displayNameForFile:file andFolder:folder];
                
                if (context != nil)  context = [@" referenced in " stringByAppendingString:context];
                else  context = @"";
                
                OOLog(@"verifyOXP.files.caseMismatch", @"***** ERROR: case mismatch: request for file '%@'%@ resolved to '%@'.", expectedPath, context, path);
            }
        }
        
        return [_basePath stringByAppendingPathComponent:path];
    }
    
    // If we get here, the file wasn't found in the OXP.
    // FIXME: should check case for built-in files.
    if (checkBuiltIn)  return [ResourceManager pathForFileNamed:file inFolder:folder];
    
    return nil;
}

References _caseWarnings, displayNameForFile:andFolder:, nil, OOLog, and ResourceManager::pathForFileNamed:inFolder:.

Referenced by OOTextureVerifierStage(OOPrivate)::checkTextureNamed:inFolder:, dataForFile:inFolder:referencedFrom:checkBuiltIn:, fileExists:inFolder:referencedFrom:checkBuiltIn:, OOCheckJSSyntaxVerifierStage::run, and OOAIStateMachineVerifierStage(Private)::validateAI:.

Here is the call graph for this function:

Here is the caller graph for this function:

plistNamed:inFolder:referencedFrom:checkBuiltIn:

- (id) plistNamed:		(NSString *)	file
inFolder:		(NSString *)	folder
referencedFrom:		(NSString *)	context
checkBuiltIn:		(BOOL)	checkBuiltIn

Definition at line 239 of file OOFileScannerVerifierStage.m.

                :(NSString *)file
        inFolder:(NSString *)folder
  referencedFrom:(NSString *)context
    checkBuiltIn:(BOOL)checkBuiltIn
{
    NSData                  *data = nil;
    NSString                *errorString = nil;
    NSPropertyListFormat    format;
    id                      plist = nil;
    NSArray                 *errorLines = nil;
    NSEnumerator            *errLineEnum = nil;
    NSString                *displayName = nil,
                            *errorKey = nil;
    NSAutoreleasePool       *pool = nil;
    
    data = [self dataForFile:file inFolder:folder referencedFrom:context checkBuiltIn:checkBuiltIn];
    if (data == nil)  return nil;
    
    pool = [[NSAutoreleasePool alloc] init];
    
    plist = [NSPropertyListSerialization propertyListFromData:data
                                             mutabilityOption:NSPropertyListImmutable
                                                       format:&format
                                             errorDescription:&errorString];
    
#if OOLITE_RELEASE_PLIST_ERROR_STRINGS
    [errorString autorelease];
#endif
    
    if (plist != nil)
    {
        // PList is readable; check that it's in an official Oolite format.
        [self checkPListFormat:format file:file folder:folder];
    }
    else
    {
        /*  Couldn't parse plist; report problem.
            This is complicated somewhat by the need to present a possibly
            multi-line error description while maintaining our indentation.
        */
        displayName = [self displayNameForFile:file andFolder:folder];
        errorKey = [displayName lowercaseString];
        if (![_badPLists containsObject:errorKey])
        {
            [_badPLists addObject:errorKey];
            OOLog(@"verifyOXP.plist.parseError", @"Could not interpret property list %@.", displayName);
            OOLogIndent();
            errorLines = [errorString componentsSeparatedByString:@"\n"];
            for (errLineEnum = [errorLines objectEnumerator]; (errorString = [errLineEnum nextObject]); )
            {
                while ([errorString hasPrefix:@"\t"])
                {
                    errorString = [@"    " stringByAppendingString:[errorString substringFromIndex:1]];
                }
                OOLog(@"verifyOXP.plist.parseError", @"%@", errorString);
            }
            OOLogOutdent();
        }
    }
    
    [plist retain];
    [pool release];
    
    return [plist autorelease];
}

References _badPLists, checkPListFormat:file:folder:, dataForFile:inFolder:referencedFrom:checkBuiltIn:, displayNameForFile:andFolder:, nil, OOLog, OOLogIndent(), and OOLogOutdent().

Referenced by OOCheckDemoShipsPListVerifierStage::run, OOCheckEquipmentPListVerifierStage::run, OOCheckPListSyntaxVerifierStage::run, OOCheckRequiresPListVerifierStage::run, and OOCheckShipDataPListVerifierStage::run.

Here is the call graph for this function:

Here is the caller graph for this function:

run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 106 of file OOFileScannerVerifierStage.m.

{
    NSAutoreleasePool           *pool = nil;
    
    _usedFiles = [[NSMutableSet alloc] init];
    _caseWarnings = [[NSMutableSet alloc] init];
    _badPLists = [[NSMutableSet alloc] init];
    
    pool = [[NSAutoreleasePool alloc] init];
    [self scanForFiles];
    [pool release];
    
    pool = [[NSAutoreleasePool alloc] init];
    [self checkRootFolders];
    [self checkKnownFiles];
    [pool release];
}

References _badPLists, _caseWarnings, _usedFiles, checkKnownFiles, checkRootFolders, nil, run, and scanForFiles.

Referenced by run.

Here is the call graph for this function:

Here is the caller graph for this function:

scanDirectory:

- (NSDictionary *) scanDirectory: (NSString *) path

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 548 of file OOFileScannerVerifierStage.m.

                               :(NSString *)path
{
    NSDirectoryEnumerator   *dirEnum = nil;
    NSMutableDictionary     *result = nil;
    NSString                *name = nil,
                            *lcName = nil,
                            *type = nil,
                            *dirName = nil,
                            *relativeName = nil,
                            *existing = nil;
    
    result = [NSMutableDictionary dictionary];
    dirName = [path lastPathComponent];
    
    dirEnum = [[NSFileManager defaultManager] enumeratorAtPath:path];
    while ((name = [dirEnum nextObject]))
    {
        type = [[dirEnum fileAttributes] fileType];
        relativeName = [dirName stringByAppendingPathComponent:name];
        
        if ([_junkFileNames containsObject:name])
        {
            OOLog(@"verifyOXP.scanFiles.skipJunk", @"NOTE: skipping junk file %@/%@.", dirName, name);
        }
        else if ([type isEqualToString:NSFileTypeRegular])
        {
            lcName = [name lowercaseString];
            existing = [result objectForKey:lcName];
            
            if (existing == nil)
            {
                OOLog(@"verifyOXP.verbose.listFiles", @"- %@", name);
                [result setObject:name forKey:lcName];
            }
            else
            {
                OOLog(@"verifyOXP.scanFiles.overloadedName", @"***** ERROR: %@ '%@' conflicts with %@ named '%@', ignoring. (OXPs must work on case-insensitive file systems!)", @"file", relativeName, @"file", [dirName stringByAppendingPathComponent:existing]);
            }
        }
        else
        {
            if ([type isEqualToString:NSFileTypeDirectory])
            {
                [dirEnum skipDescendents];
                if (![_skipDirectoryNames containsObject:name])
                {
                    OOLog(@"verifyOXP.scanFiles.directory", @"----- WARNING: \"%@\" is a nested directory, ignoring.", relativeName);
                }
                else
                {
                    OOLog(@"verifyOXP.verbose.listFiles", @"- Skipping %@/%@/", dirName, name);
                }
            }
            else if ([type isEqualToString:NSFileTypeSymbolicLink])
            {
                OOLog(@"verifyOXP.scanFiles.symLink", @"----- WARNING: \"%@\" is a symbolic link, ignoring.", relativeName);
            }
            else
            {
                OOLog(@"verifyOXP.scanFiles.nonStandardFile", @"----- WARNING: \"%@\" is a non-standard file (%@), ignoring.", relativeName, type);
            }
        }
    }
    
    return result;
}

Referenced by OOFileScannerVerifierStage(OOPrivate)::scanForFiles.

Here is the caller graph for this function:

scanForFiles

- (void) scanForFiles

implementation

Provided by category OOFileScannerVerifierStage(OOPrivate).

Definition at line 324 of file OOFileScannerVerifierStage.m.

{
    NSDirectoryEnumerator   *dirEnum = nil;
    NSString                *name = nil,
                            *path = nil,
                            *type = nil,
                            *lcName = nil,
                            *existing = nil,
                            *existingType = nil;
    NSMutableDictionary     *directoryListings = nil,
                            *directoryCases = nil,
                            *rootFiles = nil;
    NSDictionary            *dirFiles = nil;
    NSSet                   *readMeNames = nil;
    
    _basePath = [[[self verifier] oxpPath] copy];
    
    _junkFileNames = [[self verifier] configurationSetForKey:@"junkFiles"];
    _skipDirectoryNames = [[self verifier] configurationSetForKey:@"skipDirectories"];
    
    directoryCases = [NSMutableDictionary dictionary];
    directoryListings = [NSMutableDictionary dictionary];
    rootFiles = [NSMutableDictionary dictionary];
    readMeNames = [self constructReadMeNames];
    
    dirEnum = [[NSFileManager defaultManager] enumeratorAtPath:_basePath];
    while ((name = [dirEnum nextObject]))
    {
        path = [_basePath stringByAppendingPathComponent:name];
        type = [[dirEnum fileAttributes] fileType];
        lcName = [name lowercaseString];
        
        if ([type isEqualToString:NSFileTypeDirectory])
        {
            [dirEnum skipDescendents];
            
            if ([_skipDirectoryNames containsObject:name])
            {
                // Silently skip .svn and CVS
                OOLog(@"verifyOXP.verbose.listFiles", @"- Skipping %@/", name);
            }
            else if (!CheckNameConflict(lcName, directoryCases, rootFiles, &existing, &existingType))
            {
                OOLog(@"verifyOXP.verbose.listFiles", @"- %@/", name);
                OOLogIndentIf(@"verifyOXP.verbose.listFiles");
                dirFiles = [self scanDirectory:path];
                [directoryListings setObject:dirFiles forKey:lcName];
                [directoryCases setObject:name forKey:lcName];
                OOLogOutdentIf(@"verifyOXP.verbose.listFiles");
            }
            else
            {
                OOLog(@"verifyOXP.scanFiles.overloadedName", @"***** ERROR: %@ '%@' conflicts with %@ named '%@', ignoring. (OXPs must work on case-insensitive file systems!)", @"directory", name, existingType, existing);
            }
        }
        else if ([type isEqualToString:NSFileTypeRegular])
        {
            if ([_junkFileNames containsObject:name])
            {
                OOLog(@"verifyOXP.scanFiles.skipJunk", @"NOTE: skipping junk file %@.", name);
            }
            else if ([readMeNames containsObject:lcName])
            {
                OOLog(@"verifyOXP.scanFiles.readMe", @"----- WARNING: apparent Read Me file (\"%@\") inside OXP. This is the wrong place for a Read Me file, because it will not be read.", name);
            }
            else if (!CheckNameConflict(lcName, directoryCases, rootFiles, &existing, &existingType))
            {
                OOLog(@"verifyOXP.verbose.listFiles", @"- %@", name);
                [rootFiles setObject:name forKey:lcName];
            }
            else
            {
                OOLog(@"verifyOXP.scanFiles.overloadedName", @"***** ERROR: %@ '%@' conflicts with %@ named '%@', ignoring. (OXPs must work on case-insensitive file systems!)", @"file", name, existingType, existing);
            }
        }
        else if ([type isEqualToString:NSFileTypeSymbolicLink])
        {
            OOLog(@"verifyOXP.scanFiles.symLink", @"----- WARNING: \"%@\" is a symbolic link, ignoring.", name);
        }
        else
        {
            OOLog(@"verifyOXP.scanFiles.nonStandardFile", @"----- WARNING: \"%@\" is a non-standard file (%@), ignoring.", name, type);
        }
    }
    
    _junkFileNames = nil;
    _skipDirectoryNames = nil;
    
    [directoryListings setObject:rootFiles forKey:@""];
    _directoryListings = [directoryListings copy];
    _directoryCases = [directoryCases copy];
}

Referenced by run.

Here is the caller graph for this function:

Member Data Documentation

_badPLists

- (NSMutableSet*) _badPLists

private

Definition at line 44 of file OOFileScannerVerifierStage.h.

Referenced by plistNamed:inFolder:referencedFrom:checkBuiltIn:, and run.

_basePath

- (NSString*) _basePath

private

Definition at line 39 of file OOFileScannerVerifierStage.h.

_caseWarnings

- (NSMutableSet*) _caseWarnings

private

Definition at line 41 of file OOFileScannerVerifierStage.h.

Referenced by pathForFile:inFolder:referencedFrom:checkBuiltIn:, and run.

_directoryCases

- (NSDictionary*) _directoryCases

private

Definition at line 43 of file OOFileScannerVerifierStage.h.

_directoryListings

- (NSDictionary*) _directoryListings

private

Definition at line 42 of file OOFileScannerVerifierStage.h.

_junkFileNames

- (NSSet*) _junkFileNames

private

Definition at line 45 of file OOFileScannerVerifierStage.h.

_skipDirectoryNames

- (NSSet*) _skipDirectoryNames

private

Definition at line 46 of file OOFileScannerVerifierStage.h.

_usedFiles

- (NSMutableSet*) _usedFiles

private

Definition at line 40 of file OOFileScannerVerifierStage.h.

Referenced by run.

---

The documentation for this class was generated from the following files:

• src/Core/OXPVerifier/OOFileScannerVerifierStage.h
• src/Core/OXPVerifier/OOFileScannerVerifierStage.m