sogo/OpenChange/MAPIStoreTasksMessageTable.m

/* MAPIStoreTasksMessageTable.m - this file is part of SOGo
 *
 * Copyright (C) 2010 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 3, 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/NSDictionary.h>

#import <EOControl/EOQualifier.h>

#import <NGCards/iCalToDo.h>

#import <Appointments/SOGoTaskObject.h>

#import "MAPIStoreTypes.h"
#import "NSCalendarDate+MAPIStore.h"
#import "NSString+MAPIStore.h"

#import "MAPIStoreTasksMessageTable.h"

#include <mapistore/mapistore_nameid.h>

@implementation MAPIStoreTasksMessageTable

- (enum MAPISTATUS) getChildProperty: (void **) data
			      forKey: (NSString *) childKey
			     withTag: (enum MAPITAGS) propTag
{
  NSString *status;
  // id child;
  iCalToDo *task;
  int32_t statusValue;
  NSCalendarDate *dateValue;
  int rc;
  double doubleValue;

  rc = MAPI_E_SUCCESS;
  switch (propTag)
    {
    case PR_ICON_INDEX: // TODO
      /* see http://msdn.microsoft.com/en-us/library/cc815472.aspx */
      // Unassigned recurring task 0x00000501
      // Assignee's task 0x00000502
      // Assigner's task 0x00000503
      // Task request 0x00000504
      // Task acceptance 0x00000505
      // Task rejection 0x00000506
      *data = MAPILongValue (memCtx, 0x00000500);
      break;
    case PR_MESSAGE_CLASS_UNICODE:
      *data = talloc_strdup(memCtx, "IPM.Task");
      break;
    case PR_SUBJECT_UNICODE: // SUMMARY
    case PR_NORMALIZED_SUBJECT_UNICODE:
    case PR_CONVERSATION_TOPIC_UNICODE:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      *data = [[task summary] asUnicodeInMemCtx: memCtx];
      break;
    case PidLidTaskComplete:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      *data = MAPIBoolValue (memCtx,
                             [[task status] isEqualToString: @"COMPLETED"]);
      break;
    case PidLidPercentComplete:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      doubleValue = ((double) [[task percentComplete] intValue] / 100);
      *data = MAPIDoubleValue (memCtx, doubleValue);
      break;
    case PidLidTaskDateCompleted:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      dateValue = [task completed];
      if (dateValue)
	*data = [dateValue asFileTimeInMemCtx: memCtx];
      else
	rc = MAPI_E_NOT_FOUND;
      break;
    case PidLidTaskState: // TODO (check)
      *data = MAPILongValue (memCtx, 0x02 | 0x03);
      break;
    case PidLidTaskMode: // TODO
      *data = MAPILongValue (memCtx, 0x0);
      break;
    case PidLidTaskFRecurring:
    case PidLidTaskAccepted: // TODO
      *data = MAPIBoolValue (memCtx, NO);
      break;
    case PidLidTaskActualEffort: // TODO
    case PidLidTaskEstimatedEffort: // TODO
      *data = MAPILongValue (memCtx, 0);
      break;
    case PR_HASATTACH:
      *data = MAPIBoolValue (memCtx, NO);
      break;

    case PidLidTaskDueDate:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      dateValue = [task due];
      if (dateValue)
	*data = [dateValue asFileTimeInMemCtx: memCtx];
      else
	rc = MAPI_E_NOT_FOUND;
      break;

    case PR_CREATION_TIME:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      *data = [[task created] asFileTimeInMemCtx: memCtx];
      break;
    case PR_MESSAGE_DELIVERY_TIME:
    case PR_CLIENT_SUBMIT_TIME:
    case PR_LOCAL_COMMIT_TIME:
    case PR_LAST_MODIFICATION_TIME:
      task = [[self lookupChild: childKey] component: NO secure: NO];
      *data = [[task lastModified] asFileTimeInMemCtx: memCtx];
      break;
    case PidLidTaskStatus: // status
      task = [[self lookupChild: childKey] component: NO secure: NO];
      status = [task status];
      if (![status length]
          || [status isEqualToString: @"NEEDS-ACTION"])
        statusValue = 0;
      else if ([status isEqualToString: @"IN-PROCESS"])
        statusValue = 1;
      else if ([status isEqualToString: @"COMPLETED"])
        statusValue = 2;
      else
        statusValue = 0xff;
      *data = MAPILongValue (memCtx, statusValue);
      break;
      /* Completed */
      // -	0x81380003 = -2000
      // +	0x81380003 = -4000
      
      // 68330048
      // 68420102
    case 0x68340003:
    case 0x683a0003:
    case 0x68410003:
      *data = MAPILongValue (memCtx, 0);
      break;

// #define PidLidFlagRequest                                   0x9027001f
// #define PidNameContentType                                  0x905a001f
// #define PidLidBillingInformation                            0x908b001f
// #define PidLidTaskStartDate                                 0x911e0040
// #define PidLidTaskOwner                                     0x9122001f
// #define PidLidTaskDeadOccurrence                            0x9127000b
// #define PidLidTaskMultipleRecipients                        0x912a0003
// #define PidLidTaskHistory                                   0x912b0003
// #define PidLidAcceptanceState                               0x912c0003
// #define PidLidTaskLastUser                                  0x912d001f
// #define PidLidTaskLastUpdate                                0x912e0040
// #define PidLidTaskOwnership                                 0x912f0003
// #define PidLidTaskNoCompute                                 0x9130000b
// #define PidLidTaskFFixOffline                               0x9131000b
// #define PidLidTaskRole                                      0x9132001f
// #define PidLidTaskVersion                                   0x91330003
// #define PidLidTaskAssigner                                  0x9134001f
// #define PidLidTeamTask                                      0x9135000b
// #define PidLidTaskRecurrence                                0x91360102
// #define PidLidTaskResetReminder                             0x9137000b
// #define PidLidTaskOrdinal                                   0x91380003
// #define PidLidMileage                                       0x914a001f
// #define PidLidAgingDontAgeMe                                0x9185000b
// #define PidLidCommonEnd                                     0x91980040
// #define PidLidCommonStart                                   0x91990040
// #define PidLidNonSendableBcc                                0x91d7001f
// #define PidLidNonSendableCc                                 0x91d8001f
// #define PidLidNonSendtableTo                                0x91d9001f
// #define PidLidNonSendBccTrackStatus                         0x91da1003
// #define PidLidNonSendCcTrackStatus                          0x91db1003
// #define PidLidNonSendToTrackStatus                          0x91dc1003
// #define PidLidReminderDelta                                 0x91e90003
// #define PidLidReminderFileParameter                         0x91ea001f
// #define PidLidReminderSignalTime                            0x91eb0040
// #define PidLidReminderOverride                              0x91ec000b
// #define PidLidReminderPlaySound                             0x91ed000b
// #define PidLidReminderSet                                   0x91ee000b
// #define PidLidReminderTime                                  0x91ef0040
// #define PidLidReminderType                                  0x91f20003
// #define PidLidRemoteStatus                                  0x91f30003
// #define PidLidSmartNoAttach                                 0x91fa000b
// #define PidLidTaskGlobalId                                  0x91fe0102
// #define PidLidVerbResponse                                  0x9203001f
// #define PidLidVerbStream                                    0x92040102
// #define PidLidPrivate                                       0x9224000b
// #define PidLidInternetAccountName                           0x9225001f
// #define PidLidInternetAccountStamp                          0x9226001f
// #define PidLidUseTnef                                       0x9227000b
// #define PidLidContactLinkName                               0x9229001f
// #define PidLidContactLinkEntry                              0x922a0102
// #define PidLidContactLinkSearchKey                          0x922b0102
// #define PidLidSpamOriginalFolder                            0x92370102
// #define PidLidTaskUpdates                                   0x9345000b
// #define PidLidTaskStatusOnComplete                          0x9346000b
// #define PidLidTaskLastDelegate                              0x9347001f
// #define PidLidTaskAssigners                                 0x934a0102
// #define PidLidTaskFCreator                                  0x934c000b
// #define PidLidImapDeleted                                   0x94e50003
// #define PidLidHeaderItem                                    0x94e60003

    default:
      rc = [super getChildProperty: data
			    forKey: childKey
			   withTag: propTag];
    }

  return rc;
}

- (EOQualifier *) componentQualifier
{
  static EOQualifier *componentQualifier = nil;

  /* TODO: we need to support vlist as well */
  if (!componentQualifier)
    componentQualifier
      = [[EOKeyValueQualifier alloc] initWithKey: @"c_component"
				operatorSelector: EOQualifierOperatorEqual
					   value: @"vtodo"];

  return componentQualifier;
}

- (NSString *) backendIdentifierForProperty: (enum MAPITAGS) property
{
  static NSMutableDictionary *knownProperties = nil;

  if (!knownProperties)
    {
      knownProperties = [NSMutableDictionary new];
      [knownProperties setObject: @"c_enddate"
			  forKey: MAPIPropertyKey (PidLidTaskDueDate)];
    }

  return [knownProperties objectForKey: MAPIPropertyKey (property)];
}

/* restrictions */

- (MAPIRestrictionState) evaluatePropertyRestriction: (struct mapi_SPropertyRestriction *) res
				       intoQualifier: (EOQualifier **) qualifier
{
  MAPIRestrictionState rc;
  id value;

  value = NSObjectFromMAPISPropValue (&res->lpProp);
  switch (res->ulPropTag)
    {
    case PR_MESSAGE_CLASS_UNICODE:
      if ([value isKindOfClass: [NSString class]]
	  && [value isEqualToString: @"IPM.Task"])
	rc = MAPIRestrictionStateAlwaysTrue;
      else
	rc = MAPIRestrictionStateAlwaysFalse;
      break;
    case PR_RULE_PROVIDER_UNICODE: // TODO: what's this?
      rc = MAPIRestrictionStateAlwaysTrue;
      break;
    case PidLidTaskOwnership:
      rc = MAPIRestrictionStateAlwaysTrue;
      break;
    case PidLidTaskStatus:
      rc = MAPIRestrictionStateAlwaysTrue;
      break;

    case PidLidTaskComplete:
      *qualifier = [[EOKeyValueQualifier alloc]
		     initWithKey: @"c_status"
		     operatorSelector: EOQualifierOperatorEqual
			   value: [NSNumber numberWithInt: 1]];
      [*qualifier autorelease];
      rc = MAPIRestrictionStateNeedsEval;
      break;

    case PidLidTaskDateCompleted:
      rc = MAPIRestrictionStateAlwaysTrue;
      break;

    default:
      rc = [super evaluatePropertyRestriction: res intoQualifier: qualifier];
    }

  return rc;
}

- (MAPIRestrictionState) evaluateExistRestriction: (struct mapi_SExistRestriction *) res
				    intoQualifier: (EOQualifier **) qualifier
{
  MAPIRestrictionState rc;

  switch (res->ulPropTag)
    {
    case PidLidTaskDateCompleted:
      /* since we don't store the completion date in the quick table, we only
	 checks whether the task has been completed */
      *qualifier = [[EOKeyValueQualifier alloc]
		     initWithKey: @"c_status"
		     operatorSelector: EOQualifierOperatorEqual
			   value: [NSNumber numberWithInt: 1]];
      [*qualifier autorelease];
      rc = MAPIRestrictionStateNeedsEval;
      break;

    default:
      rc = [super evaluateExistRestriction: res intoQualifier: qualifier];
    }

  return rc;
}

@end