OOFileScannerVerifierStage.m

Go to the documentation of this file.

/*
 
OOFileScannerVerifierStage.m
 
 
Copyright (C) 2007-2013 Jens Ayton
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
 
/*  Design notes:
    In order to be able to look files up case-insenstively, but warn about
    case mismatches, the OOFileScannerVerifierStage builds its own
    representation of the file hierarchy. Dictionaries are used heavily: the
    _directoryListings is keyed by folder names mapped to lower case, and its
    entries map lowercase file names to actual case, that is, the case found
    in the file system. The companion dictionary _directoryCases maps
    lowercase directory names to actual case.
    
    The class design is based on the knowledge that Oolite uses a two-level
    namespace for files. Each file type has an appropriate folder, and files
    may either be in the appropriate folder or "bare". For instance, a texture
    file in an OXP may be either in the Textures subdirectory or in the root
    directory of the OXP. The root directory's contents are listed in
    _directoryListings with the empty string as key. This architecture means
    the OOFileScannerVerifierStage doesn't need to take full file system
    hierarchy into account.
*/
 
#import "OOFileScannerVerifierStage.h"
 
#if OO_OXP_VERIFIER_ENABLED
 
#import "OOCollectionExtractors.h"
#import "ResourceManager.h"
 
static NSString * const kFileScannerStageName   = @"Scanning files";
static NSString * const kUnusedListerStageName  = @"Checking for unused files";
 
 
static BOOL CheckNameConflict(NSString *lcName, NSDictionary *directoryCases, NSDictionary *rootFiles, NSString **outExisting, NSString **outExistingType);
 
 
@interface OOFileScannerVerifierStage (OOPrivate)
 
- (void)scanForFiles;
 
- (void)checkRootFolders;
- (void)checkKnownFiles;
 
/*  Given an array of strings, return a dictionary mapping lowercase strings
    to the canonicial case given in the array. For instance, given
        (Foo, BAR)
    
    it will return
        { foo = Foo; bar = BAR }
*/
- (NSDictionary *)lowercaseMap:(NSArray *)array;
 
- (NSDictionary *)scanDirectory:(NSString *)path;
- (void)checkPListFormat:(NSPropertyListFormat)format file:(NSString *)file folder:(NSString *)folder;
- (NSSet *)constructReadMeNames;
 
@end
 
 
@implementation OOFileScannerVerifierStage
 
- (void)dealloc
{
    [_basePath release];
    [_usedFiles release];
    [_caseWarnings release];
    [_directoryListings release];
    [_directoryCases release];
    [_badPLists release];
    
    [super dealloc];
}
 
 
- (NSString *)name
{
    return kFileScannerStageName;
}
 
 
- (void)run
{
    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];
}
 
 
+ (NSString *)nameForDependencyForVerifier:(OOOXPVerifier *)verifier
{
    OOFileScannerVerifierStage *stage = [verifier stageWithName:kFileScannerStageName];
    if (stage == nil)
    {
        stage = [[OOFileScannerVerifierStage alloc] init];
        [verifier registerStage:stage];
        [stage release];
    }
    
    return kFileScannerStageName;
}
 
 
- (BOOL)fileExists:(NSString *)file
          inFolder:(NSString *)folder
    referencedFrom:(NSString *)context
      checkBuiltIn:(BOOL)checkBuiltIn
{
    return [self pathForFile:file inFolder:folder referencedFrom:context checkBuiltIn:checkBuiltIn] != nil;
}
 
 
- (NSString *)pathForFile:(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;
}
 
 
- (NSData *)dataForFile:(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];
}
 
 
- (id)plistNamed:(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;
    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"];
            foreach (errorString, errorLines)
            {
                while ([errorString hasPrefix:@"\t"])
                {
                    errorString = [@"    " stringByAppendingString:[errorString substringFromIndex:1]];
                }
                OOLog(@"verifyOXP.plist.parseError", @"%@", errorString);
            }
            OOLogOutdent();
        }
    }
    
    [plist retain];
    [pool release];
    
    return [plist autorelease];
}
 
 
- (id)displayNameForFile:(NSString *)file andFolder:(NSString *)folder
{
    if (file != nil && folder != nil)  return [folder stringByAppendingPathComponent:file];
    return file;
}
 
 
- (NSArray *)filesInFolder:(NSString *)folder
{
    if (folder == nil)  return nil;
    return [[_directoryListings objectForKey:[folder lowercaseString]] allValues];
}
 
@end
 
 
@implementation OOFileScannerVerifierStage (OOPrivate)
 
- (void)scanForFiles
{
    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];
}
 
 
- (void)checkRootFolders
{
    NSArray                 *knownNames = nil;
    NSString                *name = nil;
    NSString                *lcName = nil;
    NSString                *actual = nil;
    
    knownNames = [[self verifier] configurationArrayForKey:@"knownRootDirectories"];
    foreach (name, knownNames)
    {
        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];
    }
}
 
 
- (void)checkConfigFiles
{
    NSArray                 *knownNames = nil;
    NSString                *name = nil,
        *lcName = nil,
        *realFileName = nil;
    BOOL                    inConfigDir;
    
    knownNames = [[self verifier] configurationArrayForKey:@"knownConfigFiles"];
    foreach (name, knownNames)
    {
        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);
        }
    }
}
 
 
- (void)checkKnownFiles
{
    NSDictionary            *directories = nil;
    NSString                *directory = nil,
                            *lcDirectory = nil;
    NSArray                 *fileList = nil;
    NSString                *name = nil,
                            *lcName = nil,
                            *realFileName = nil;
    BOOL                    inDirectory;
    
    directories = [[self verifier] configurationDictionaryForKey:@"knownFiles"];
    foreachkey (directory, directories)
    {
        fileList = [directories objectForKey:directory];
        lcDirectory = [directory lowercaseString];
        foreach (name, fileList)
        {
            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);
            }
        }
    }
}
 
 
- (NSDictionary *)lowercaseMap:(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;
}
 
 
- (NSDictionary *)scanDirectory:(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;
}
 
 
- (void)checkPListFormat:(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);
        }
    }
}
 
 
- (NSSet *)constructReadMeNames
{
    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;
}
 
@end
 
 
@implementation OOListUnusedFilesStage: OOOXPVerifierStage
 
- (NSString *)name
{
    return kUnusedListerStageName;
}
 
 
- (NSSet *)dependencies
{
    return [NSSet setWithObject:kFileScannerStageName];
}
 
 
- (void)run
{
    OOLog(@"verifyOXP.unusedFiles.unimplemented", @"%@", @"TODO: implement unused files check.");
}
 
 
+ (NSString *)nameForReverseDependencyForVerifier:(OOOXPVerifier *)verifier
{
    OOListUnusedFilesStage *stage = [verifier stageWithName:kUnusedListerStageName];
    if (stage == nil)
    {
        stage = [[OOListUnusedFilesStage alloc] init];
        [verifier registerStage:stage];
        [stage release];
    }
    
    return kUnusedListerStageName;
}
 
@end
 
 
@implementation OOOXPVerifier(OOFileScannerVerifierStage)
 
- (OOFileScannerVerifierStage *)fileScannerStage
{
    return [self stageWithName:kFileScannerStageName];
}
 
@end
 
 
@implementation OOFileHandlingVerifierStage
 
- (NSSet *)dependencies
{
    return [NSSet setWithObject:[OOFileScannerVerifierStage nameForDependencyForVerifier:[self verifier]]];
}
 
 
- (NSSet *)dependents
{
    return [NSSet setWithObject:[OOListUnusedFilesStage nameForReverseDependencyForVerifier:[self verifier]]];
}
 
@end
 
 
static BOOL CheckNameConflict(NSString *lcName, NSDictionary *directoryCases, NSDictionary *rootFiles, NSString **outExisting, NSString **outExistingType)
{
    NSString                *existing = nil;
    
    existing = [directoryCases objectForKey:lcName];
    if (existing != nil)
    {
        if (outExisting != NULL)  *outExisting = existing;
        if (outExistingType != NULL)  *outExistingType = @"directory";
        return YES;
    }
    
    existing = [rootFiles objectForKey:lcName];
    if (existing != nil)
    {
        if (outExisting != NULL)  *outExisting = existing;
        if (outExistingType != NULL)  *outExistingType = @"file";
        return YES;
    }
    
    return NO;
}
 
#endif