/* SwordManager.mm - Sword API wrapper for Modules. Copyright 2008 Manfred Bergmann Based on code by Will Thimbleby 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 version 2. 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. (http://www.gnu.org/licenses/gpl.html) */ #import #import "Notifications.h" #import "FilterProviderFactory.h" #import "DefaultFilterProvider.h" #include "encfiltmgr.h" #import "SwordFilter.h" using std::string; using std::list; @interface SwordManager (PrivateAPI) - (void)refreshModules; - (void)addFiltersToModule:(SwordModule *)mod; @end @implementation SwordManager (PrivateAPI) - (void)refreshModules { NSMutableDictionary *dict = [NSMutableDictionary dictionary]; // loop over modules sword::SWModule *mod; for(sword::ModMap::iterator it = swManager->Modules.begin(); it != swManager->Modules.end(); it++) { mod = it->second; if(mod) { // temporary instance SwordModule *swMod = [SwordModule moduleForSWModule:mod]; NSString *type = [swMod typeString]; ModuleType aType = [SwordModule moduleTypeForModuleTypeString:type]; SwordModule *sm = [SwordModule moduleForType:aType swModule:mod swordManager:self]; [dict setObject:sm forKey:[[sm name] lowercaseString]]; [self addFiltersToModule:sm]; } } // set modules self.modules = dict; } - (void)addFiltersToModule:(SwordModule *)mod { // prepare display filters id filterProvider = [[FilterProviderFactory providerFactory] get]; switch([mod swModule]->Markup()) { case sword::FMT_GBF: if(!gbfFilter) { gbfFilter = [filterProvider newGbfRenderFilter]; } if(!gbfStripFilter) { gbfStripFilter = [filterProvider newGbfPlainFilter]; } [mod addRenderFilter:gbfFilter]; [mod addStripFilter:gbfStripFilter]; break; case sword::FMT_THML: if(!thmlFilter) { thmlFilter = [filterProvider newThmlRenderFilter]; } if(!thmlStripFilter) { thmlStripFilter = [filterProvider newThmlPlainFilter]; } [mod addRenderFilter:thmlFilter]; [mod addStripFilter:thmlStripFilter]; break; case sword::FMT_OSIS: if(!osisFilter) { osisFilter = [filterProvider newOsisRenderFilter]; } if(!osisStripFilter) { osisStripFilter = [filterProvider newOsisPlainFilter]; } [mod addRenderFilter:osisFilter]; [mod addStripFilter:osisStripFilter]; break; case sword::FMT_TEI: if(!teiFilter) { teiFilter = [filterProvider newTeiRenderFilter]; } if(!teiStripFilter) { teiStripFilter = [filterProvider newTeiPlainFilter]; } [mod addRenderFilter:teiFilter]; [mod addStripFilter:teiStripFilter]; break; case sword::FMT_PLAIN: default: if(!plainFilter) { plainFilter = [filterProvider newHtmlPlainFilter]; } [mod addRenderFilter:plainFilter]; break; } } @end @implementation SwordManager @synthesize modules; @synthesize modulesPath; @synthesize managerLock; @synthesize temporaryManager; # pragma mark - class methods + (NSArray *)moduleTypes { return [NSArray arrayWithObjects: SWMOD_TYPES_BIBLES, SWMOD_TYPES_COMMENTARIES, SWMOD_TYPES_DICTIONARIES, SWMOD_TYPES_GENBOOKS, nil]; } + (SwordManager *)managerWithPath:(NSString *)path { SwordManager *manager = [[[SwordManager alloc] initWithPath:path] autorelease]; return manager; } + (SwordManager *)defaultManager { static SwordManager *instance = nil; if(instance == nil) { // use default path instance = [[SwordManager alloc] initWithPath:[[Configuration config] defaultModulePath]]; } return instance; } - (id)initWithPath:(NSString *)path { if((self = [super init])) { // this is our main swManager temporaryManager = NO; self.modulesPath = path; self.modules = [NSDictionary dictionary]; self.managerLock = (NSLock *)[[[NSRecursiveLock alloc] init] autorelease]; [self reInit]; sword::StringList options = swManager->getGlobalOptions(); sword::StringList::iterator it; for(it = options.begin(); it != options.end(); it++) { [self setGlobalOption:[NSString stringWithCString:it->c_str() encoding:NSUTF8StringEncoding] value:SW_OFF]; } } return self; } - (id)initWithSWMgr:(sword::SWMgr *)aSWMgr { self = [super init]; if(self) { swManager = aSWMgr; // this is a temporary swManager temporaryManager = YES; self.modules = [NSDictionary dictionary]; self.managerLock = [(NSLock *)[[NSRecursiveLock alloc] init] autorelease]; [self refreshModules]; } return self; } - (void)finalize { if(!temporaryManager) { delete swManager; } [super finalize]; } - (void)dealloc { if(!temporaryManager) { delete swManager; } [self setModules:nil]; [self setModulesPath:nil]; [self setManagerLock:nil]; [gbfFilter release]; [gbfStripFilter release]; [thmlFilter release]; [thmlStripFilter release]; [osisFilter release]; [osisStripFilter release]; [teiFilter release]; [teiStripFilter release]; [plainFilter release]; [super dealloc]; } - (void)reInit { [managerLock lock]; if(modulesPath && [modulesPath length] > 0) { // modulePath is the main sw manager swManager = new sword::SWMgr([modulesPath UTF8String], true, new sword::EncodingFilterMgr(sword::ENC_UTF8)); if(!swManager) { ALog(@"Cannot create SWMgr instance for default module path!"); } else { NSFileManager *fm = [NSFileManager defaultManager]; NSArray *subDirs = [fm contentsOfDirectoryAtPath:modulesPath error:NULL]; // for all sub directories add module BOOL directory; NSString *fullSubDir; NSString *subDir; for(subDir in subDirs) { // as long as it's not hidden if(![subDir hasPrefix:@"."] && ![subDir isEqualToString:@"InstallMgr"] && ![subDir isEqualToString:@"mods.d"] && ![subDir isEqualToString:@"modules"]) { fullSubDir = [modulesPath stringByAppendingPathComponent:subDir]; fullSubDir = [fullSubDir stringByStandardizingPath]; //if its a directory if([fm fileExistsAtPath:fullSubDir isDirectory:&directory]) { if(directory) { DLog(@"Augmenting folder: %@", fullSubDir); swManager->augmentModules([fullSubDir UTF8String]); DLog(@"Augmenting folder done"); } } } } // clear some data [self refreshModules]; SendNotifyModulesChanged(NULL); } } [managerLock unlock]; } - (void)addModulesPath:(NSString *)path { [managerLock lock]; if(swManager == nil) { swManager = new sword::SWMgr([path UTF8String], true, new sword::EncodingFilterMgr(sword::ENC_UTF8)); } else { swManager->augmentModules([path UTF8String]); } [self refreshModules]; [managerLock unlock]; SendNotifyModulesChanged(NULL); } - (SwordModule *)moduleWithName:(NSString *)name { SwordModule *ret = [modules objectForKey:[name lowercaseString]]; if(ret == nil) { sword::SWModule *mod = [self getSWModuleWithName:name]; if(mod == NULL) { ALog(@"No module by that name: %@!", name); } else { // temporary instance SwordModule *swMod = [SwordModule moduleForSWModule:mod]; NSString *type = [swMod typeString]; ModuleType aType = [SwordModule moduleTypeForModuleTypeString:type]; ret = [SwordModule moduleForType:aType swModule:mod swordManager:self]; if(ret != nil) { NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithDictionary:modules]; [dict setObject:ret forKey:[name lowercaseString]]; self.modules = dict; } } } return ret; } - (void)setCipherKey:(NSString *)key forModuleNamed:(NSString *)name { [managerLock lock]; swManager->setCipherKey([name UTF8String], [key UTF8String]); [managerLock unlock]; } #pragma mark - module access - (void)setGlobalOption:(NSString *)option value:(NSString *)value { [managerLock lock]; swManager->setGlobalOption([option UTF8String], [value UTF8String]); [managerLock unlock]; } - (BOOL)globalOption:(NSString *)option { return [[NSString stringWithUTF8String:swManager->getGlobalOption([option UTF8String])] isEqualToString:SW_ON]; } - (NSArray *)listModules { return [modules allValues]; } - (NSArray *)moduleNames { return [modules allKeys]; } - (NSArray *)sortedModuleNames { return [[self moduleNames] sortedArrayUsingSelector:@selector(compare:)]; } - (NSArray *)modulesForFeature:(NSString *)feature { NSMutableArray *ret = [NSMutableArray array]; for(SwordModule *mod in [modules allValues]) { if([mod hasFeature:feature]) { [ret addObject:mod]; } } // sort NSArray *sortDescriptors = [NSArray arrayWithObject:[[[NSSortDescriptor alloc] initWithKey:@"name" ascending:YES] autorelease]]; [ret sortUsingDescriptors:sortDescriptors]; return [NSArray arrayWithArray:ret]; } - (NSArray *)modulesForType:(ModuleType)type { NSMutableArray *ret = [NSMutableArray array]; for(SwordModule *mod in [modules allValues]) { if([mod type] == type || type == All) { [ret addObject:mod]; } } // sort NSArray *sortDescriptors = [NSArray arrayWithObject:[[[NSSortDescriptor alloc] initWithKey:@"name" ascending:YES] autorelease]]; [ret sortUsingDescriptors:sortDescriptors]; return [NSArray arrayWithArray:ret]; } - (NSArray *)modulesForCategory:(ModuleCategory)cat { NSMutableArray *ret = [NSMutableArray array]; for(SwordModule *mod in [modules allValues]) { if([mod category] == cat) { [ret addObject:mod]; } } // sort NSArray *sortDescriptors = [NSArray arrayWithObject:[[[NSSortDescriptor alloc] initWithKey:@"name" ascending:YES] autorelease]]; [ret sortUsingDescriptors:sortDescriptors]; return [NSArray arrayWithArray:ret]; } #pragma mark - lowLevel methods - (sword::SWMgr *)swManager { return swManager; } - (sword::SWModule *)getSWModuleWithName:(NSString *)moduleName { sword::SWModule *module; [managerLock lock]; module = swManager->Modules[[moduleName UTF8String]]; [managerLock unlock]; return module; } @end