/*
  Copyright (C) 2000-2005 SKYRIX Software AG

  This file is part of OpenGroupware.org.

  OGo is free software; you can redistribute it and/or modify it under
  the terms of the GNU Lesser General Public License as published by the
  Free Software Foundation; either version 2, or (at your option) any
  later version.

  OGo 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 Lesser General Public
  License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with OGo; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "SkyAttributeDataSource.h"
#include "common.h"
#include <LSFoundation/LSFoundation.h>

@interface NSObject(Private)
- (id)globalID;
@end

@interface SkyAttributeDataSource(Internals)
- (BOOL)_hasOnlyDBKeys:(EOQualifier *)_qual;
- (BOOL)_hasOnlyAttrKeys:(EOQualifier *)_qual;
- (BOOL)_hasAttributeKey:(EOQualifier *)_qual;
- (NSSet *)_getGidsFromArray:(NSArray *)_array objectsAreDics:(BOOL)_isDict;
- (NSSet *)_handleQualifier:(EOQualifier *)_qual;
- (NSSet *)_evaluateQualifier:(EOQualifier *)_qual;
- (EOGlobalID *)_gidForObj:(id)_obj;
- (NSArray *)_buildObjects:(NSArray *)_gids;
- (void)_freeCaches;
@end


@implementation SkyAttributeDataSource

static BOOL debugOn = NO;

+ (void)initialize {
  NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
  
  if ((debugOn = [ud boolForKey:@"SkyAttributeDataSourceDebugEnabled"]))
    NSLog(@"SkyAttributeDataSourceDebugEnabled debugging is enabled.");
}

- (id)init {
  [self errorWithFormat:@"Wrong initializer, use 'initWithContext:'"];
  [self release];
  return nil;
}

- (id)initWithDataSource:(EODataSource *)_ds context:(id)_context {
  if ((self = [super init])) {
    if (![_ds isKindOfClass:[EODataSource class]]) {
      [self errorWithFormat:@"%s: expected datasource as parameter: %@", 
	    __PRETTY_FUNCTION__, _ds];
      [self release];
      return nil;
    }

    self->context = [_context retain];
    self->source  = [_ds retain];
  }
  return self;
}

- (void)dealloc {
  [self->context            release];
  [self->fetchSpecification release];
  [self->source             release];
  [self->namespaces         release];
  [self->_gid2ObjCache      release];
  [self->globalIdKey        release];
  [self->dbKeys             release];
  [self->defaultNamespace   release];
  [self->_evaluateAttributeQualifierCache release];
  [self->_evaluateDBQualifierCache        release];
  [self->_evaluateQualifierCache          release];
  [super dealloc];
}

/* accessors */

- (void)setFetchSpecification:(EOFetchSpecification *)_fspec {
  if ([self->fetchSpecification isEqual:_fspec])
    return;
  
  ASSIGNCOPY(self->fetchSpecification, _fspec);
  [self postDataSourceChangedNotification];
}
- (EOFetchSpecification *)fetchSpecification {
  return [[self->fetchSpecification copy] autorelease];
}

- (NSSet *)namespaces {
  [self warnWithFormat:
	  @"%s: use of deprecated method, set namespace in hints",
	  __PRETTY_FUNCTION__];
  return self->namespaces;
}
- (void)setNamespaces:(NSSet *)_ns {
  [self warnWithFormat:
	  @"%s: use of deprecated method, set namespace in hints",
          __PRETTY_FUNCTION__];
  ASSIGN(self->namespaces, _ns);
}

- (EOModel *)model {
  static EOModel *model = nil;
  
  if (model != nil)
    return model;
  
  model = [[[[self->context valueForKey:LSDatabaseKey] adaptor] model] retain];
  return model;
}
- (EOAttribute *)primaryKeyOfEntityNamed:(NSString *)entityName {
  return [[[[self model] entityNamed:entityName] 
	    primaryKeyAttributes] lastObject];
}

- (void)setGlobalIDKey:(NSString *)_gidName {
  ASSIGNCOPY(self->globalIdKey, _gidName);
}
- (NSString *)globalIDKey {
  NSString *entityName = nil;
  
  if (self->globalIdKey == nil &&
      (entityName = [self->fetchSpecification entityName]) != nil) {
    NSString *key;
    
    key = [[self primaryKeyOfEntityNamed:entityName] columnName];
    self->globalIdKey = [key copy];
  }
  return self->globalIdKey;
}

/* verifies Ids from PropertyManager agains source */

- (void)setVerifyIds:(BOOL)_bool {
  self->verifyIds = _bool;
}
- (BOOL)verifyIds {
  return self->verifyIds;
}

/* fetch method */

- (BOOL)isNamespaceOrDbKeysValid {
  if (self->defaultNamespace == nil && self->dbKeys != nil)
    return NO;
  if (self->defaultNamespace != nil && self->dbKeys == nil)
    return NO;
  return YES;
}

- (void)_fetchPropertiesInNamespaces:(NSSet *)ns
  forObjects:(NSArray *)objects withGIDs:(NSArray *)gids
{
  SkyObjectPropertyManager *objPropMan;
  NSEnumerator *nsEnum;
  NSString     *namesp;
  
  objPropMan = [self->context propertyManager];
  nsEnum     = [ns objectEnumerator];
  while ((namesp = [nsEnum nextObject]) != nil) {
    NSDictionary *props   = nil;
    NSEnumerator *objEnum = nil;
    id           obj      = nil;
    
    props   = [objPropMan propertiesForGlobalIDs:gids namespace:namesp];
    objEnum = [objects objectEnumerator];
    
    while ((obj = [objEnum nextObject]) != nil) {
      NSDictionary *p = nil;
      
      if ((p = [props objectForKey:[self _gidForObj:obj]]) != nil)
        [obj takeValue:p forKey:namesp];
      else {
        [obj takeValue:[NSMutableDictionary dictionaryWithCapacity:8] 
	     forKey:namesp];
      }
    }
  }
}

- (NSArray *)fetchObjects {
  NSArray     *objects = nil;
  NSArray     *gids    = nil;
  EOQualifier *qualifier;
  NSSet       *ns;
  
  ns = (self->namespaces != nil)
    ? self->namespaces
    : [[self->fetchSpecification hints] objectForKey:@"namespaces"];
  
  if (debugOn) {
    [self debugWithFormat:@"fetch namespaces (default=%@): %@",
          self->defaultNamespace,
          [[ns allObjects] componentsJoinedByString:@","]];
  }
  
  /* check preconditions */
  
  if ((qualifier = [self->fetchSpecification qualifier]) == nil) {
    [self warnWithFormat:@"%s: missing qualifier", 
	    __PRETTY_FUNCTION__];
    return nil;
  }
  if (debugOn) [self debugWithFormat:@"  qualifier: %@", qualifier];
  
  if (![self isNamespaceOrDbKeysValid]) {
    [self errorWithFormat:
	    @"%s: either defaultNamespace and dbKeys has to be nil "
            @"or values", __PRETTY_FUNCTION__];
    return nil;
  }
  
  /* setup cache */
  
  [self->_gid2ObjCache release]; self->_gid2ObjCache = nil;
  self->_gid2ObjCache = [[NSMutableDictionary alloc] initWithCapacity:128];

  /* fetch GIDs and objects */
  
  if ([self _hasAttributeKey:qualifier]) { // TODO: what does that mean?
    if (debugOn) [self debugWithFormat:@"    has attribute key"];
    gids = [[self _evaluateQualifier:qualifier] allObjects];
    if (debugOn) [self debugWithFormat:@"    got %i gids.", [gids count]];
    [self _freeCaches];
    objects = self->verifyIds ? [self _buildObjects:gids] : gids;
  }
  else {
    id           *objs       = NULL;
    int          objCnt      = 0;
    NSEnumerator *enumerator = nil;
    id           obj         = nil;

    if (debugOn) 
      [self debugWithFormat:@"    fetch source: %@", self->source];
    
    [self->source setFetchSpecification:self->fetchSpecification];
    objects    = [self->source fetchObjects];
    if (debugOn) 
      [self debugWithFormat:@"    fetched %i objects.", [objects count]];
    
    objs       = calloc([objects count] + 2, sizeof(id));
    enumerator = [objects objectEnumerator];
    while ((obj = [enumerator nextObject]) != nil) {
      objs[objCnt] = [self _gidForObj:obj];
      objCnt++;
    }
    gids = [NSArray arrayWithObjects:objs count:objCnt];
    if (debugOn) 
      [self debugWithFormat:@"    made %i gids.", [gids count]];
    free(objs); objs = NULL;
  }
  
  if (debugOn)
    [self debugWithFormat:@"  fetched %d gids", [gids count]];
  
  /* fetch properties */
  
  [self _fetchPropertiesInNamespaces:ns forObjects:objects withGIDs:gids];
  
  [self->_gid2ObjCache release]; self->_gid2ObjCache = nil;
  
  if (debugOn)
    [self debugWithFormat:@"fetched %d objects.", [objects count]];
  
  return objects;
}

/* operations */

- (id)createObject {
  return [self->source createObject];
}

- (void)insertObject:(id)_obj {
  [self->source insertObject:_obj];
}

- (void)deleteObject:(id)_obj {
  [self->source deleteObject:_obj];
}

- (void)updateObject:(id)_obj {
  [self->source updateObject:_obj];
}

/* accessors */

- (void)setDbKeys:(NSArray *)_keys {
  ASSIGN(self->dbKeys, _keys);
}
- (NSArray *)dbKeys {
  return self->dbKeys;
}

- (void)setDefaultNamespace:(NSString *)_ns {
  ASSIGNCOPY(self->defaultNamespace, _ns);
}
- (NSString *)defaultNamespace {
  return self->defaultNamespace;
}

/* debugging */

- (BOOL)isDebuggingEnabled {
  return debugOn;
}

/* description */

- (void)appendAttributesToDescription:(NSMutableString *)ms {
  if (self->context)   [ms appendFormat:@" ctx=0x%08X", self->context];
  if (self->source)    [ms appendFormat:@" source=%@",  self->source];
  if (self->verifyIds) [ms appendString:@" verify-ids"];
  
  if (self->fetchSpecification == nil)
    [ms appendString:@" NO-FSPEC"];
  else if ([self->fetchSpecification qualifier] == nil)
    [ms appendString:@" NO-QUAL"];
  else
    [ms appendFormat:@" qualifier=%@", [self->fetchSpecification qualifier]];
}
- (NSString *)description {
  NSMutableString *ms;
  
  ms = [NSMutableString stringWithCapacity:128];
  [ms appendFormat:@"<0x%08X[%@]:", self, NSStringFromClass([self class])];
  [self appendAttributesToDescription:ms];
  [ms appendString:@">"];
  return ms;
}

@end /* SkyAttributeDataSource */