OOCheckRequiresPListVerifierStage Class Reference

#include <OOCheckRequiresPListVerifierStage.h>

Inheritance diagram for OOCheckRequiresPListVerifierStage:

Collaboration diagram for OOCheckRequiresPListVerifierStage:

Instance Methods
(NSString *)	- name [implementation]
(BOOL)	- shouldRun [implementation]
(void)	- run [implementation]
Instance Methods inherited from OOFileHandlingVerifierStage
(NSSet *)	- dependencies [implementation]
(NSSet *)	- dependents [implementation]
Instance Methods inherited from OOOXPVerifierStage
(OOOXPVerifier *)	- verifier
(BOOL)	- completed
(id)	- init [implementation]
(void)	- dealloc [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]

Detailed Description

Definition at line 33 of file OOCheckRequiresPListVerifierStage.h.

Method Documentation

name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 33 of file OOCheckRequiresPListVerifierStage.m.

{
    return kStageName;
}

References kStageName.

run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 33 of file OOCheckRequiresPListVerifierStage.m.

{
    OOFileScannerVerifierStage  *fileScanner = nil;
    NSDictionary                *requiresPList = nil;
    NSSet                       *knownKeys = nil;
    NSMutableSet                *actualKeys = nil;
    NSString                    *version = nil,
                                *maxVersion = nil;
    NSArray                     *ooVersionComponents = nil,
                                *versionComponents = nil,
                                *maxVersionComponents = nil;
    
    fileScanner = [[self verifier] fileScannerStage];
    requiresPList = [fileScanner plistNamed:@"requires.plist"
                                   inFolder:@"Config"
                             referencedFrom:nil
                               checkBuiltIn:NO];
    
    if (requiresPList == nil)  return;
    
    // Check that it's a dictionary
    if (![requiresPList isKindOfClass:[NSDictionary class]])
    {
        OOLog(@"verifyOXP.requiresPList.notDict", @"%@", @"***** ERROR: requires.plist is not a dictionary.");
        return;
    }
    
    // Check that all the keys are known.
    knownKeys = [[self verifier] configurationSetForKey:@"requiresPListSupportedKeys"];
    actualKeys = [NSMutableSet setWithArray:[requiresPList allKeys]];
    [actualKeys minusSet:knownKeys];
    
    if ([actualKeys count] != 0)
    {
        
        OOLog(@"verifyOXP.requiresPList.unknownKeys", @"----- WARNING: requires.plist contains unknown keys. This OXP will not be loaded by this version of Oolite. Unknown keys are: %@.", [[actualKeys allObjects] componentsJoinedByString:@", "]);
    }
    
    // Sanity check the known keys.
    version = [requiresPList objectForKey:@"version"];
    if (version != nil)
    {
        if (![version isKindOfClass:[NSString class]])
        {
            OOLog(@"verifyOXP.requiresPList.badValue", @"%@", @"***** ERROR: Value for 'version' is not a string.");
            version = nil;
        }
    }
    
    maxVersion = [requiresPList objectForKey:@"max_version"];
    if (maxVersion != nil)
    {
        if (![maxVersion isKindOfClass:[NSString class]])
        {
            OOLog(@"verifyOXP.requiresPList.badValue", @"%@", @"***** ERROR: Value for 'max_version' is not a string.");
            maxVersion = nil;
        }
    }
    
    if (version != nil || maxVersion != nil)
    {
        ooVersionComponents = ComponentsFromVersionString([[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleVersion"]);
        if (ooVersionComponents == nil)
        {
            OOLog(@"verifyOXP.requiresPList.cantFindOoliteVersion", @"%@", @"----- WARNING: could not find Oolite's version for requires.plist sanity check.");
        }
        if (version != nil)
        {
            versionComponents = ComponentsFromVersionString(version);
            if (versionComponents == nil)
            {
                OOLog(@"verifyOXP.requiresPList.badValue", @"***** ERROR: could not interpret version string \"%@\" as version number.", version);
            }
            else if (ooVersionComponents != nil)
            {
                if (CompareVersions(ooVersionComponents, versionComponents) == NSOrderedAscending)
                {
                    OOLog(@"verifyOXP.requiresPList.oxpRequiresNewerOolite", @"----- WARNING: this OXP requires a newer version of Oolite (%@) to work.", version);
                }
            }
        }
        if (maxVersion != nil)
        {
            maxVersionComponents = ComponentsFromVersionString(maxVersion);
            if (maxVersionComponents == nil)
            {
                OOLog(@"verifyOXP.requiresPList.badValue", @"***** ERROR: could not interpret max_version string \"%@\" as version number.", maxVersion);
            }
            else if (ooVersionComponents != nil)
            {
                if (CompareVersions(ooVersionComponents, maxVersionComponents) == NSOrderedDescending)
                {
                    OOLog(@"verifyOXP.requiresPList.oxpRequiresOlderOolite", @"----- WARNING: this OXP requires an older version of Oolite (%@) to work.", maxVersion);
                }
            }
        }
        
        if (versionComponents != nil && maxVersionComponents != nil)
        {
            if (CompareVersions(versionComponents, maxVersionComponents) == NSOrderedDescending)
            {
                OOLog(@"verifyOXP.requiresPList.noVersionsInRange", @"***** ERROR: this OXP's maximum version (%@) is less than its minimum version (%@).", maxVersion, version);
            }
        }
    }
}

shouldRun

- (BOOL) shouldRun

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 33 of file OOCheckRequiresPListVerifierStage.m.

{
    OOFileScannerVerifierStage  *fileScanner = nil;
    
    fileScanner = [[self verifier] fileScannerStage];
    return [fileScanner fileExists:@"requires.plist"
                          inFolder:@"Config"
                    referencedFrom:nil
                      checkBuiltIn:NO];
}

---

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

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