NSFileManager(OOExtensions) Category Reference

#include <NSFileManagerOOExtensions.h>

Instance Methods
(NSArray *)	- commanderContentsOfPath:
(NSString *)	- defaultCommanderPath
(NSArray *)	- oo_directoryContentsAtPath:
(BOOL)	- oo_createDirectoryAtPath:attributes:
(NSDictionary *)	- oo_fileAttributesAtPath:traverseLink:
(NSDictionary *)	- oo_fileSystemAttributesAtPath:
(BOOL)	- oo_removeItemAtPath:
(BOOL)	- oo_moveItemAtPath:toPath:
(BOOL)	- oo_oxzFileExistsAtPath:

Detailed Description

Definition at line 37 of file NSFileManagerOOExtensions.h.

Method Documentation

commanderContentsOfPath:

- (NSArray *) commanderContentsOfPath:

(NSString*)

savePath

Definition at line 39 of file NSFileManagerOOExtensions.m.

                                     :(NSString *)savePath
{
    BOOL pathIsDirectory = NO;
    if ([[NSFileManager defaultManager] fileExistsAtPath:savePath isDirectory:&pathIsDirectory] && pathIsDirectory)
    {
        NSMutableArray *contents = [NSMutableArray arrayWithArray:[self oo_directoryContentsAtPath:savePath]];
        
        // at this point we should strip out any files not loadable as Oolite saved games
        unsigned i;
        for (i = 0; i < [contents count]; i++)
        {
            NSString* path = [savePath stringByAppendingPathComponent: (NSString*)[contents objectAtIndex:i]];
            
            // ensure it's not a directory
            if (![[NSFileManager defaultManager] fileExistsAtPath:path isDirectory:&pathIsDirectory] && pathIsDirectory)
            {
                
                // check file extension
                if (![[path pathExtension] isEqual:@"oolite-save"])
                {
                    [contents removeObjectAtIndex: i--];
                    continue;
                }
                
                // check to see if we can parse the file okay
                NSDictionary *cdr = OODictionaryFromFile(path); 
                if (!cdr)
                {
                    OOLog(@"savedGame.read.fail.notDictionary", @">>>> %@ could not be parsed as a saved game.", path);
                    [contents removeObjectAtIndex: i--];
                    continue;
                }
            }
            
            // all okay - we can use this path!
            [contents replaceObjectAtIndex: i withObject: path];
            
        }
        
        return contents;
    }
    else
    {
        OOLogERR(@"savedGame.read.fail.fileNotFound", @"File at path '%@' could not be found.", savePath);
        return nil;
    }
}

References nil, oo_directoryContentsAtPath:, OODictionaryFromFile(), OOLog, and OOLogERR.

Here is the call graph for this function:

defaultCommanderPath

- (NSString *) defaultCommanderPath

Definition at line 88 of file NSFileManagerOOExtensions.m.

{
    const char *savedirEnv = SDL_getenv("OO_SAVEDIR");
    NSString *savedir;
 
    if (savedirEnv)
    {
        savedir = [NSString stringWithUTF8String:savedirEnv];
    }
    else
    {
        savedir = [NSHomeDirectory() stringByAppendingPathComponent:@SAVEDIR];
    }
    BOOL pathIsDirectory = NO;
    
    // does it exist?
    if (![[NSFileManager defaultManager] fileExistsAtPath:savedir isDirectory:&pathIsDirectory])
    {
        // it doesn't exist.
        if([self oo_createDirectoryAtPath:savedir attributes:nil])
        {
            return savedir;
        }
        else
        {
            OOLogERR(@"savedGame.defaultPath.create.failed", @"Unable to create '%@'. Saved games will go to the home directory.", savedir);
            return NSHomeDirectory();
        }
    }
    
    // is it a directory?
    if (!pathIsDirectory)
    {
        OOLogERR(@"savedGame.defaultPath.notDirectory", @"'%@' is not a directory, saved games will go to the home directory.", savedir);
        return NSHomeDirectory();
    }
    
    return savedir;
}

References defaultCommanderPath, nil, and OOLogERR.

Referenced by defaultCommanderPath.

Here is the call graph for this function:

Here is the caller graph for this function:

oo_createDirectoryAtPath:attributes:

- (BOOL) oo_createDirectoryAtPath:		(NSString *)	path
attributes:		(NSDictionary *)	attributes

Definition at line 137 of file NSFileManagerOOExtensions.m.

                                 :(NSString *)path attributes:(NSDictionary *)attributes
{
    return [self createDirectoryAtPath:path withIntermediateDirectories:YES attributes:attributes error:NULL];
}

oo_directoryContentsAtPath:

- (NSArray *) oo_directoryContentsAtPath:

(NSString *)

path

Definition at line 131 of file NSFileManagerOOExtensions.m.

                                        :(NSString *)path
{
    return [self contentsOfDirectoryAtPath:path error:NULL];
}

Referenced by commanderContentsOfPath:.

Here is the caller graph for this function:

oo_fileAttributesAtPath:traverseLink:

- (NSDictionary *) oo_fileAttributesAtPath:		(NSString *)	path
traverseLink:		(BOOL)	yorn

Definition at line 143 of file NSFileManagerOOExtensions.m.

                                          :(NSString *)path traverseLink:(BOOL)traverseLink
{
    if (traverseLink)
    {
        NSString *linkDest = nil;
        do
        {
            linkDest = [self destinationOfSymbolicLinkAtPath:path error:NULL];
            if (linkDest != nil)  path = linkDest;
        } while (linkDest != nil);
    }
    
    return [self attributesOfItemAtPath:path error:NULL];
}

References nil.

oo_fileSystemAttributesAtPath:

- (NSDictionary *) oo_fileSystemAttributesAtPath:

(NSString *)

path

Definition at line 159 of file NSFileManagerOOExtensions.m.

                                                :(NSString *)path
{
    return [self attributesOfFileSystemForPath:path error:NULL];
}

oo_moveItemAtPath:toPath:

- (BOOL) oo_moveItemAtPath:		(NSString *)	src
toPath:		(NSString *)	dest

Definition at line 171 of file NSFileManagerOOExtensions.m.

                          :(NSString *)src toPath:(NSString *)dest
{
    return [self moveItemAtPath:src toPath:dest error:NULL];
}

oo_oxzFileExistsAtPath:

- (BOOL) oo_oxzFileExistsAtPath:

(NSString *)

path

Definition at line 257 of file NSFileManagerOOExtensions.m.

                               :(NSString *)path
{
    NSUInteger i, cl;
    NSArray *components = [path pathComponents];
    cl = [components count];
    for (i = 0 ; i < cl ; i++)
    {
        NSString *component = [components objectAtIndex:i];
        if ([[[component pathExtension] lowercaseString] isEqualToString:@"oxz"])
        {
            break;
        }
    }
    // if i == cl then the path is entirely uncompressed
    if (i == cl)
    {
        BOOL directory = NO;
        BOOL result = [self fileExistsAtPath:path isDirectory:&directory];
        if (directory)
        {
            return NO;
        }
        return result;
    }
    
    NSRange range;
    range.location = 0; range.length = i+1;
    NSString *zipFile = [NSString pathWithComponents:[components subarrayWithRange:range]];
    range.location = i+1; range.length = cl-(i+1);
    NSString *containedFile = [NSString pathWithComponents:[components subarrayWithRange:range]];
 
    unzFile uf = NULL;
    const char* zipname = [zipFile cStringUsingEncoding:NSUTF8StringEncoding];
    if (zipname != NULL)
    {
        uf = unzOpen64(zipname);
    }
    if (uf == NULL)
    {
        // no such zip file
        return NO;
    }
    const char* filename = [containedFile cStringUsingEncoding:NSUTF8StringEncoding];
    // unzLocateFile(*, *, 1) = case-sensitive extract
    BOOL result = YES;
    if (unzLocateFile(uf, filename, 1) != UNZ_OK)
    {
        result = NO;
    }
    else
    {
        int err = UNZ_OK;
        unz_file_info64 file_info = {0};
        err = unzGetCurrentFileInfo64(uf, &file_info, NULL, 0, NULL, 0, NULL, 0);
        if (err != UNZ_OK)
        {
            result = NO;
        }
        else
        {
            
 
        }
    }
    unzClose(uf);
    return result;
}

References UNZ_OK, unzClose(), unzGetCurrentFileInfo64(), unzLocateFile(), and unzOpen64().

Here is the call graph for this function:

oo_removeItemAtPath:

- (BOOL) oo_removeItemAtPath:

(NSString *)

path

Definition at line 165 of file NSFileManagerOOExtensions.m.

                            :(NSString *)path
{
    return [self removeItemAtPath:path error:NULL];
}

---

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

• src/Core/NSFileManagerOOExtensions.h
• src/Core/NSFileManagerOOExtensions.m