DBFileWriter.m

/* -*- mode: objc -*-
 Project: DataBasin
 
 Copyright (C) 2009-2021 Free Software Foundation
 
 Author: Riccardo Mottola
 
 Created: 2017-09-20 Riccardo Mottola
 
 This library 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 of the License, or (at your option) any later version.
 
 This library 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
 Library General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free
 Software Foundation, Inc., 31 Milk Street #960789 Boston, MA 02196 USA.
*/

#import "DBFileWriter.h"
#import "DBSObject.h"
#import "DBLoggerProtocol.h"
#import "DBSFTypeWrappers.h"

#import <WebServices/GWSConstants.h>

@implementation DBFileWriter

- (id)initWithHandle:(NSFileHandle *)fileHandle
{
  if ((self = [super init]))
    {
      file = fileHandle;
      writeOrdered = NO;
      fieldNames = nil;
    }
  return self;
}


- (void)dealloc
{
  [fieldNames release];
  [super dealloc];
}

- (void)setFileFormat:(NSString *)f
{
}


- (void)setLogger:(id<DBLoggerProtocol>)l
{
  logger = l;
}


- (void)setStringEncoding: (NSStringEncoding) enc
{
  NSData *tempData;

  encoding = enc;
  bomLength = 0;

  /* BOM heuristics */
  tempData = [@"" dataUsingEncoding: encoding];
  bomLength = [tempData length];

  NSLog(@"bom length: %u", bomLength);
}

- (void)setWriteFieldsOrdered:(BOOL)flag
{
  writeOrdered = flag;
}


- (BOOL)writeFieldsOrdered
{
  return writeOrdered;
}

/*
 This methods sets the internal field names for the header when using ordered object writeout.
 */
- (void)setFieldNames:(id)obj andWriteThem:(BOOL)flag
{
  NSArray *array;
  
  [logger log: LogDebug :@"[DBFileWriter setFieldNames] for Object: %@:\n", obj];
  
  /* if we have no data, we return */
  if (obj == nil)
    return;
  
  /* if we have just a single object, we fake an array */
  if([obj isKindOfClass: [NSArray class]])
    array = obj;
  else
    array = [NSArray arrayWithObject: obj];
  
  if ([array count] == 0)
    return;
  
  if (fieldNames != array)
    {
      [fieldNames release];
      fieldNames = array;
      [array retain];
    }
  
  [logger log: LogDebug :@"[DBFileWriter setFieldNames] Names: %@:\n", array];
  
  /* if we write the header, fine, else we write at least the BOM */
  if (flag == YES)
    {
      NSString *theLine;
    
      theLine = [self formatOneLine:array forHeader:YES];
      [file writeData: [theLine dataUsingEncoding: encoding]];
    }
  else
    {
      NSData *tempData;
    
      tempData = [@" "dataUsingEncoding: encoding];
      tempData = [tempData subdataWithRange: NSMakeRange(0, bomLength)];
      [file writeData: tempData];
    }
}

- (void)writeStart
{

}

- (void)writeEnd
{

}

- (void)writeDataSet:(NSArray *)array
{
  NSUInteger i;
  NSUInteger setCount;
  NSAutoreleasePool *arp;
  
  if (array == nil)
    return;
  
  arp = [[NSAutoreleasePool alloc] init];
  setCount = [array count];
  for (i = 0; i < setCount; i++)
    {
      NSString *oneLine;
      NSData *data;
      NSData *data2;
      id o;

      o = [array objectAtIndex:i];
      if ([o isKindOfClass: [DBSObject class]])
	o = [NSArray  arrayWithObject: o];
      oneLine = [self formatOneLine:o forHeader:NO];
      data = [oneLine dataUsingEncoding: encoding];
      if (bomLength > 0)
	data2 = [NSData dataWithBytesNoCopy: (void *)[data bytes]+bomLength length: [data length]-bomLength freeWhenDone: NO];
      else
	data2 = data;
      [file writeData: data2];
    }
  [arp release];
}


- (void)formatComplexObject:(NSMutableDictionary *)d withRoot:(NSString *)root inDict:(NSMutableDictionary *)dict inOrder:(NSMutableArray *)order
{
  NSMutableArray  *keys;
  NSUInteger i;

  if (!d)
    return;

  keys = [NSMutableArray arrayWithArray:[d allKeys]];
  [keys removeObject:GWSOrderKey];

  if ([root hasSuffix:@"Address"])
    {
      NSMutableString *str;

      str = [[NSMutableString alloc] init];
      for (i = 0; i < [keys count]; i++)
	{
	  NSString *s;

	  s = [d objectForKey:[keys objectAtIndex:i]];
	  if (s && [s length])
	    {
	      if ([str length])
		[str appendString: @" - "];
	      [str appendString:s];
	    }
	}
      [dict setObject:str forKey:root];
      [order addObject:root];
      [str release];
    }
  
  /* remove some fields which get added automatically by salesforce even if not asked for */
  [keys removeObject:@"type"];
  
  for (i = 0; i < [keys count]; i++)
    {
      id obj;
      NSString *key;
      NSMutableString *extendedFieldName;
      
      key = [keys objectAtIndex: i];
      obj = [d objectForKey: key];
      if ([key isEqualToString:@"Id"])
	{
	  if ([obj isKindOfClass: [NSArray class]])
	    obj = [obj objectAtIndex: 0];
	  else if ([obj isKindOfClass: [NSString class]] && [obj length] == 0)
	    continue;
	}
      if (root)
        {
          extendedFieldName  = [NSMutableString stringWithString:root];
          [extendedFieldName appendString:@"."];
          [extendedFieldName appendString:key];
        }
      else
        {
          extendedFieldName  = [NSMutableString stringWithString:key];
        }
      
      if ([obj isKindOfClass: [NSDictionary class]])
        {
          [self formatComplexObject: obj withRoot:extendedFieldName inDict:dict inOrder:order];
        }
      else if ([obj isKindOfClass: [DBSFDataType class]])
	{
          [dict setObject:obj forKey:extendedFieldName];
          [order addObject:extendedFieldName];
	}
      else if ([obj isKindOfClass: [NSString class]] || [obj isKindOfClass: [NSNumber class]])
        {
          [dict setObject:obj forKey:extendedFieldName];
          [order addObject:extendedFieldName];
	}
      else
	NSLog(@"[DBFileWriter formatComplexObject] unknown class of value: %@, object: %@", [obj class], obj);
      
    }
}

- (void)formatSObject:(DBSObject *)so withRoot:(NSString *)root inDict:(NSMutableDictionary *)dict inOrder:(NSMutableArray *)order
{
  NSArray  *fields;
  NSUInteger i;

  if (!so)
    return;

  fields = [so fieldNames];
  
  for (i = 0; i < [fields count]; i++)
    {
      id obj;
      NSString *field;
      NSMutableString *extendedFieldName;
      
      field = [fields objectAtIndex: i];
      obj = [so valueForField: field];

      if (root)
        {
          extendedFieldName  = [NSMutableString stringWithString:root];
          [extendedFieldName appendString:@"."];
          [extendedFieldName appendString:field];
        }
      else
        {
          extendedFieldName  = [NSMutableString stringWithString:field];
        }
      
      if ([obj isKindOfClass: [DBSFDataType class]])
	{
          [dict setObject:obj forKey:extendedFieldName];
          [order addObject:extendedFieldName];
	}
      else if ([obj isKindOfClass: [NSString class]] || [obj isKindOfClass: [NSNumber class]])
        {
          [dict setObject:obj forKey:extendedFieldName];
          [order addObject:extendedFieldName];
	}
      else if ([obj isKindOfClass: [NSDictionary class]])
        {
          [self formatComplexObject: obj withRoot:extendedFieldName inDict:dict inOrder:order];
        }
      else
	{
	  NSLog(@"[DBFileWriter formatSObject] unknown class of value: %@, object: %@", [obj class], obj);
	}
      
    }
}


- (NSString *)formatOneLine:(id)data forHeader:(BOOL) headerFlag
{
  NSLog(@"DBFileWriter - formatOneLine: forHeader: - method should be subclassed");
  return nil;
}

@end