Monotone-Parent: 2fdf0ead0781ef2362dd389811d5db44ca4cc84a

Monotone-Revision: c91eef7edcfd08d414664c25a590b6268a7e58e2 Monotone-Author: wsourdeau@inverse.ca Monotone-Date: 2009-11-29T04:19:32 Monotone-Branch: ca.inverse.sogo
2026-05-16 00:45:26 +00:00 · 2009-11-29 04:19:32 +00:00
parent 3821d1aa7f
commit b79a7e5a00
129 changed files with 4402 additions and 3316 deletions
@@ -0,0 +1,248 @@
+/* SOGoDefaultsSource.m - this file is part of SOGo
+ *
+ * Copyright (C) 2009 Inverse inc.
+ *
+ * Author: Wolfgang Sourdeau <wsourdeau@inverse.ca>
+ *
+ * This file 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, or (at your option)
+ * any later version.
+ *
+ * This file 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; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#import <Foundation/NSArray.h>
+#import <Foundation/NSDictionary.h>
+#import <Foundation/NSException.h>
+#import <Foundation/NSString.h>
+#import <Foundation/NSValue.h>
+
+#import <NGExtensions/NSObject+Logs.h>
+
+#define NEEDS_DEFAULTS_SOURCE_INTERNAL 1
+#import "SOGoDefaultsSource.h"
+
+NSString *SOGoDefaultsSourceInvalidSource = @"SOGoDefaultsSourceInvalidSource";
+NSString *SOGoDefaultsSourceUnmutableSource = @"SOGoDefaultsSourceUnmutableSource";
+
+@implementation SOGoDefaultsSource
+
+ (id) defaultsSourceWithSource: (id) newSource
+                andParentSource: (SOGoDefaultsSource *) newParentSource
+{
+  SOGoDefaultsSource *sogoDefaultsSource;
+
+  sogoDefaultsSource = [self new];
+  [sogoDefaultsSource autorelease];
+  [sogoDefaultsSource setSource: newSource];
+  [sogoDefaultsSource setParentSource: newParentSource];
+
+  if ([sogoDefaultsSource migrate])
+    [sogoDefaultsSource synchronize];
+
+  return sogoDefaultsSource;
+}
+
+- (id) init
+{
+  if ((self = [super init]))
+    {
+      source = nil;
+      parentSource = nil;
+      isMutable = NO;
+    }
+
+  return self;
+}
+
+- (void) dealloc
+{
+  [source release];
+  [parentSource release];
+  [super dealloc];
+}
+
+- (void) setSource: (id) newSource
+{
+  if ([newSource respondsToSelector: @selector (objectForKey:)])
+    {
+      ASSIGN (source, newSource);
+      isMutable = [source respondsToSelector: @selector (setObject:forKey:)];
+    }
+  else
+    [NSException raise: SOGoDefaultsSourceInvalidSource
+                format: @"UserDefaults source '%@'"
+                 @" does not respond to 'object:forKey:'", newSource];
+}
+
+- (id) source
+{
+  return source;
+}
+
+- (void) setParentSource: (SOGoDefaultsSource *) newParentSource
+{
+  ASSIGN (parentSource, newParentSource);
+}
+
+- (void) setObject: (id) value
+	    forKey: (NSString *) key
+{ 
+  if (isMutable)
+    [source setObject: value forKey: key];
+  else
+    [NSException raise: SOGoDefaultsSourceUnmutableSource
+                format: @"UserDefaults source '%@' is not mutable", source];
+}
+
+- (id) objectForKey: (NSString *) objectKey
+{
+  id objectForKey;
+
+  objectForKey = [source objectForKey: objectKey];
+  if (!objectForKey)
+    objectForKey = [parentSource objectForKey: objectKey];
+
+  return objectForKey;
+}
+
+- (void) removeObjectForKey: (NSString *) key
+{
+  [source removeObjectForKey: key];
+}
+
+- (void) setBool: (BOOL) value
+	  forKey: (NSString *) key
+{
+  [self setObject: [NSNumber numberWithBool: value]
+	forKey: key];
+}
+
+- (BOOL) boolForKey: (NSString *) key
+{
+  return [[self objectForKey: key] boolValue];
+}
+
+- (void) setFloat: (float) value
+	   forKey: (NSString *) key
+{
+  [self setObject: [NSNumber numberWithFloat: value]
+	forKey: key];
+}
+
+- (float) floatForKey: (NSString *) key
+{
+  return [[self objectForKey: key] floatValue];
+}
+
+- (void) setInteger: (int) value
+	     forKey: (NSString *) key
+{
+  [self setObject: [NSString stringWithFormat: @"%d", value]
+	forKey: key];
+}
+
+- (int) integerForKey: (NSString *) key
+{
+  return [[self objectForKey: key] intValue];
+}
+
+#warning TODO: type checking
+- (NSArray *) arrayForKey: (NSString *) key
+{
+  return [self objectForKey: key];
+}
+
+- (NSArray *) stringArrayForKey: (NSString *) key
+{
+  return [self objectForKey: key];
+}
+
+- (NSData *) dataForKey: (NSString *) key
+{
+  return [self objectForKey: key];
+}
+
+- (NSString *) stringForKey: (NSString *) key
+{
+  return [self objectForKey: key];
+}
+
+/* Dictionaries are a special case for which we don't allow searches in the
+   parent source. Each level can thus have its own set of dictionary values. */
+- (id) dictionaryForKey: (NSString *) objectKey
+{
+  id objectForKey;
+
+  objectForKey = [source objectForKey: objectKey];
+
+  return objectForKey;
+}
+
+- (BOOL) migrate
+{
+  return NO;
+}
+
+- (BOOL) migrateOldDefaultsWithDictionary: (NSDictionary *) migratedKeys
+{
+  NSArray *allKeys;
+  id currentValue, existingValue;
+  NSString *oldName, *newName;
+  int count, max;
+  BOOL requireSync;
+
+  requireSync = NO;
+
+  allKeys = [migratedKeys allKeys];
+  max = [allKeys count];
+  for (count = 0; count < max; count++)
+    {
+      oldName = [allKeys objectAtIndex: count];
+      currentValue = [source objectForKey: oldName];
+      if (currentValue)
+        {
+          newName = [migratedKeys objectForKey: oldName];
+          existingValue = [source objectForKey: newName];
+          if (existingValue)
+            [self errorWithFormat: @"both old and new defaults key"
+                  @" '%@' '%@' exist. Migration skipped.", oldName, newName];
+          else
+            {
+              requireSync = YES;
+              [source setObject: currentValue forKey: newName];
+              [source removeObjectForKey: oldName];
+              [self warnWithFormat: @"defaults key '%@' was renamed to '%@'",
+                    oldName, newName];
+            }
+        }
+    }
+
+  return requireSync;
+}
+
+- (BOOL) synchronize
+{
+  BOOL rc;
+
+  if ([source respondsToSelector: @selector (synchronize)])
+    rc = [source synchronize];
+  else
+    {
+      [self errorWithFormat: @"current source cannot synchronize defaults"];
+      rc = NO;
+    }
+
+  return rc;
+}
+
+@end