NSFileManagerOOExtensions.m

Go to the documentation of this file.

/*
 
NSFileManagerOOExtensions.m
 
This extends NSFileManager and adds some methods to insulate the
main oolite code from the gory details of creating/chdiring to the
commander save directory.
 
Oolite
Copyright (C) 2004-2013 Giles C Williams and contributors
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.
 
*/
 
#include <stdlib.h>
#include <SDL.h>
#import "ResourceManager.h"
#import "OOPListParsing.h"
#import "GameController.h"
#import "NSFileManagerOOExtensions.h"
#import "unzip.h"
 
@implementation NSFileManager (OOExtensions)
 
- (NSArray *) commanderContentsOfPath:(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;
    }
}
 
 
- (NSString *) defaultCommanderPath
{
    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;
}
 
 
#if OOLITE_MAC_OS_X
 
- (NSArray *) oo_directoryContentsAtPath:(NSString *)path
{
    return [self contentsOfDirectoryAtPath:path error:NULL];
}
 
 
- (BOOL) oo_createDirectoryAtPath:(NSString *)path attributes:(NSDictionary *)attributes
{
    return [self createDirectoryAtPath:path withIntermediateDirectories:YES attributes:attributes error:NULL];
}
 
 
- (NSDictionary *) oo_fileAttributesAtPath:(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];
}
 
 
- (NSDictionary *) oo_fileSystemAttributesAtPath:(NSString *)path
{
    return [self attributesOfFileSystemForPath:path error:NULL];
}
 
 
- (BOOL) oo_removeItemAtPath:(NSString *)path
{
    return [self removeItemAtPath:path error:NULL];
}
 
 
- (BOOL) oo_moveItemAtPath:(NSString *)src toPath:(NSString *)dest
{
    return [self moveItemAtPath:src toPath:dest error:NULL];
}
 
#else
 
- (NSArray *) oo_directoryContentsAtPath:(NSString *)path
{
    return [self directoryContentsAtPath:path];
}
 
 
- (BOOL) oo_createDirectoryAtPath:(NSString *)path attributes:(NSDictionary *)attributes
{
 #if OOLITE_WINDOWS && !OOLITE_MODERN_BUILD
    return [self createDirectoryAtPath:path attributes:attributes];
 #else
    // has been in GNUStep since 2008, so it's probably safe to use now.
    // .... why do I say things like that, of course it's not safe - CIM
    return [self createDirectoryAtPath:path withIntermediateDirectories:YES attributes:attributes error:NULL];
 #endif
}
 
 
- (NSDictionary *) oo_fileAttributesAtPath:(NSString *)path traverseLink:(BOOL)yorn
{
    return [self fileAttributesAtPath:path traverseLink:yorn];
}
 
 
- (NSDictionary *) oo_fileSystemAttributesAtPath:(NSString *)path
{
    return [self fileSystemAttributesAtPath:path];
}
 
 
- (BOOL) oo_removeItemAtPath:(NSString *)path
{
    return [self removeFileAtPath:path handler:nil];
}
 
 
- (BOOL) oo_moveItemAtPath:(NSString *)src toPath:(NSString *)dest
{
    return [self movePath:src toPath:dest handler:nil];
}
 
#endif
 
 
#if OOLITE_SDL
- (BOOL) chdirToSnapshotPath
{
    const char *snapshotEnv = SDL_getenv("OO_SNAPSHOTSDIR");
    NSString *savedir;
 
    if (snapshotEnv)
    {
        savedir = [NSString stringWithUTF8String:snapshotEnv];
    }
    else
    {
        // SDL: the default path for snapshots is oolite.app/oolite-saves/snapshots
        savedir = [[NSHomeDirectory() stringByAppendingPathComponent:@SAVEDIR] stringByAppendingPathComponent:@SNAPSHOTDIR];
    }
 
    if (![self changeCurrentDirectoryPath: savedir])
    {
       // it probably doesn't exist.
        if (![self oo_createDirectoryAtPath: savedir attributes: nil])
        {
            OOLog(@"savedSnapshot.defaultPath.create.failed", @"Unable to create directory %@", savedir);
            return NO;
        }
        if (![self changeCurrentDirectoryPath: savedir])
        {
            OOLog(@"savedSnapshot.defaultPath.chdir.failed", @"Created %@ but couldn't make it the current directory.", savedir);
            return NO;
        }
    }
    
    return YES;
}
#endif
 
- (BOOL) oo_oxzFileExistsAtPath:(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;
}
 
 
 
 
@end