/* MAPIStoreMailMessageTable.m - this file is part of SOGo * * Copyright (C) 2010 Inverse inc * * Author: Wolfgang Sourdeau * * 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 #import #import #import #import #import #import #import #import #import #import #import "MAPIStoreContext.h" #import "MAPIStoreTypes.h" #import "NSData+MAPIStore.h" #import "NSCalendarDate+MAPIStore.h" #import "NSString+MAPIStore.h" #import "MAPIStoreMailMessageTable.h" #undef DEBUG #include #include @interface NSString (MAPIStoreMIME) - (NSString *) _strippedBodyKey; @end @implementation NSString (MAPIStoreMIME) - (NSString *) _strippedBodyKey { NSRange bodyRange; NSString *strippedKey; bodyRange = [self rangeOfString: @"body["]; if (bodyRange.length > 0) { strippedKey = [self substringFromIndex: NSMaxRange (bodyRange)]; strippedKey = [strippedKey substringToIndex: [strippedKey length] - 1]; } else strippedKey = nil; return strippedKey; } @end @implementation MAPIStoreMailMessageTable static Class NSDataK, NSStringK; + (void) initialize { NSDataK = [NSData class]; NSStringK = [NSString class]; } - (id) init { if ((self = [super init])) { sortOrdering = @"ARRIVAL"; } return self; } - (void) dealloc { [sortOrdering release]; [super dealloc]; } - (NSArray *) childKeys { return [[folder fetchUIDsMatchingQualifier: nil sortOrdering: sortOrdering] stringsWithFormat: @"%@.eml"]; } - (NSArray *) restrictedChildKeys { NSArray *keys; if (restrictionState == MAPIRestrictionStateAlwaysTrue) keys = [self cachedChildKeys]; else if (restrictionState == MAPIRestrictionStateAlwaysFalse) keys = [NSArray array]; else { keys = [[folder fetchUIDsMatchingQualifier: restriction sortOrdering: sortOrdering] stringsWithFormat: @"%@.eml"]; [self logWithFormat: @" restricted keys: %@", keys]; } return keys; } - (enum MAPISTATUS) getChildProperty: (void **) data forKey: (NSString *) childKey withTag: (enum MAPITAGS) propTag { SOGoMailObject *child; NSString *subject, *stringValue; NSInteger colIdx; uint32_t intValue; enum MAPISTATUS rc; rc = MAPI_E_SUCCESS; switch (propTag) { case PR_ICON_INDEX: /* see http://msdn.microsoft.com/en-us/library/cc815472.aspx */ child = [self lookupChild: childKey]; if ([child isNewMail]) intValue = 0xffffffff; else if ([child replied]) intValue = 0x105; else if ([child forwarded]) intValue = 0x106; else if ([child read]) intValue = 0x100; else intValue = 0x101; *data = MAPILongValue (memCtx, intValue); break; case PidLidImapDeleted: child = [self lookupChild: childKey]; if ([child deleted]) intValue = 1; else intValue = 0; *data = MAPILongValue (memCtx, intValue); break; case PR_SUBJECT_UNICODE: child = [self lookupChild: childKey]; stringValue = [child decodedSubject]; if (!stringValue) stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PR_SUBJECT_PREFIX_UNICODE: child = [self lookupChild: childKey]; subject = [child decodedSubject]; colIdx = [subject rangeOfString: @":"].location; if (colIdx != NSNotFound && colIdx < 4) stringValue = [NSString stringWithFormat: @"%@: ", [subject substringToIndex: colIdx]]; else stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PR_NORMALIZED_SUBJECT_UNICODE: child = [self lookupChild: childKey]; subject = [child decodedSubject]; colIdx = [subject rangeOfString: @":"].location; if (colIdx != NSNotFound && colIdx < 4) stringValue = [[subject substringFromIndex: colIdx + 1] stringByTrimmingLeadSpaces]; else stringValue = subject; if (!stringValue) stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PR_MESSAGE_CLASS_UNICODE: case PR_ORIG_MESSAGE_CLASS_UNICODE: *data = talloc_strdup (memCtx, "IPM.Note"); break; case PidLidRemoteAttachment: // TODO case PR_HASATTACH: // TODO case PR_REPLY_REQUESTED: // TODO case PR_RESPONSE_REQUESTED: // TODO *data = MAPIBoolValue (memCtx, NO); break; // case PidLidHeaderItem: // *data = MAPILongValue (memCtx, 0x00000001); // break; // case PidLidRemoteTransferSize: // rc = [self getChildProperty: data // forKey: childKey // withTag: PR_MESSAGE_SIZE]; // break; case PR_CREATION_TIME: // DOUBT case PR_LAST_MODIFICATION_TIME: // DOUBT case PR_LATEST_DELIVERY_TIME: // DOUBT case PR_ORIGINAL_SUBMIT_TIME: case PR_CLIENT_SUBMIT_TIME: case PR_MESSAGE_DELIVERY_TIME: child = [self lookupChild: childKey]; // offsetDate = [[child date] addYear: -1 month: 0 day: 0 // hour: 0 minute: 0 second: 0]; // *data = [offsetDate asFileTimeInMemCtx: memCtx]; *data = [[child date] asFileTimeInMemCtx: memCtx]; break; case PR_MESSAGE_FLAGS: // TODO { NSDictionary *coreInfos; NSArray *flags; unsigned int v; child = [self lookupChild: childKey]; coreInfos = [child fetchCoreInfos]; flags = [coreInfos objectForKey: @"flags"]; v = MSGFLAG_FROMME; if ([flags containsObject: @"seen"]) v |= MSGFLAG_READ; *data = MAPILongValue (memCtx, v); } break; case PR_FLAG_STATUS: { NSDictionary *coreInfos; NSArray *flags; unsigned int v; child = [self lookupChild: childKey]; coreInfos = [child fetchCoreInfos]; flags = [coreInfos objectForKey: @"flags"]; if ([flags containsObject: @"flagged"]) v = 2; else v = 0; *data = MAPILongValue (memCtx, v); } break; case PR_FOLLOWUP_ICON: { NSDictionary *coreInfos; NSArray *flags; unsigned int v; child = [self lookupChild: childKey]; coreInfos = [child fetchCoreInfos]; flags = [coreInfos objectForKey: @"flags"]; if ([flags containsObject: @"flagged"]) v = 6; else v = 0; *data = MAPILongValue (memCtx, v); } break; case PR_SENSITIVITY: // TODO case PR_ORIGINAL_SENSITIVITY: // TODO *data = MAPILongValue (memCtx, 0); break; case PR_EXPIRY_TIME: // TODO case PR_REPLY_TIME: *data = [[NSCalendarDate date] asFileTimeInMemCtx: memCtx]; break; case PR_SENT_REPRESENTING_ADDRTYPE_UNICODE: case PR_RCVD_REPRESENTING_ADDRTYPE_UNICODE: case PR_RECEIVED_BY_ADDRTYPE_UNICODE: case PR_SENDER_ADDRTYPE_UNICODE: *data = [@"SMTP" asUnicodeInMemCtx: memCtx]; break; case PR_ORIGINAL_AUTHOR_NAME_UNICODE: case PR_SENDER_NAME_UNICODE: case PR_SENDER_EMAIL_ADDRESS_UNICODE: case PR_SENT_REPRESENTING_EMAIL_ADDRESS_UNICODE: case PR_SENT_REPRESENTING_NAME_UNICODE: child = [self lookupChild: childKey]; *data = [[child from] asUnicodeInMemCtx: memCtx]; break; /* TODO: some of the following are supposed to be display names, separated by a semicolumn */ case PR_RECEIVED_BY_NAME_UNICODE: case PR_RECEIVED_BY_EMAIL_ADDRESS_UNICODE: case PR_RCVD_REPRESENTING_NAME_UNICODE: case PR_RCVD_REPRESENTING_EMAIL_ADDRESS_UNICODE: case PR_DISPLAY_TO_UNICODE: case PR_ORIGINAL_DISPLAY_TO_UNICODE: child = [self lookupChild: childKey]; stringValue = [child to]; if (!stringValue) stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PR_DISPLAY_CC_UNICODE: case PR_ORIGINAL_DISPLAY_CC_UNICODE: child = [self lookupChild: childKey]; stringValue = [child cc]; if (!stringValue) stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PR_DISPLAY_BCC_UNICODE: case PR_ORIGINAL_DISPLAY_BCC_UNICODE: stringValue = @""; *data = [stringValue asUnicodeInMemCtx: memCtx]; break; case PidNameContentType: *data = [@"message/rfc822" asUnicodeInMemCtx: memCtx]; break; // // TODO: Merge with the code in UI/MailerUI/UIxMailListActions.m: -messagePriority // to avoid the duplication of the logic // case PR_IMPORTANCE: { unsigned int v; NSString *s; child = [self lookupChild: childKey]; s = [[child mailHeaders] objectForKey: @"x-priority"]; v = 0x1; if ([s hasPrefix: @"1"]) v = 0x2; else if ([s hasPrefix: @"2"]) v = 0x2; else if ([s hasPrefix: @"4"]) v = 0x0; else if ([s hasPrefix: @"5"]) v = 0x0; *data = MAPILongValue (memCtx, v); } break; case PR_BODY_UNICODE: { NSMutableArray *keys; child = [self lookupChild: childKey]; keys = [NSMutableArray array]; [child addRequiredKeysOfStructure: [child bodyStructure] path: @"" toArray: keys acceptedTypes: [NSArray arrayWithObject: @"text/html"]]; if ([keys count] > 0) { *data = NULL; rc = MAPI_E_NOT_FOUND; } else { [keys removeAllObjects]; [child addRequiredKeysOfStructure: [child bodyStructure] path: @"" toArray: keys acceptedTypes: [NSArray arrayWithObject: @"text/plain"]]; if ([keys count] > 0) { id result; NSData *content; NSDictionary *partHeaderData; NSString *key, *encoding, *charset; result = [child fetchParts: [keys objectsForKey: @"key" notFoundMarker: nil]]; result = [[result valueForKey: @"RawResponse"] objectForKey: @"fetch"]; key = [[keys objectAtIndex: 0] objectForKey: @"key"]; content = [[result objectForKey: key] objectForKey: @"data"]; partHeaderData = [child lookupInfoForBodyPart: [key _strippedBodyKey]]; encoding = [partHeaderData objectForKey: @"encoding"]; charset = [[partHeaderData objectForKey: @"parameterList"] objectForKey: @"charset"]; stringValue = [[content bodyDataFromEncoding: encoding] bodyStringFromCharset: charset]; *data = [stringValue asUnicodeInMemCtx: memCtx]; if (strlen (*data) > 16384) { [context registerValue: stringValue asProperty: propTag forURL: [NSString stringWithFormat: @"%@%@", folderURL, childKey]]; *data = NULL; rc = MAPI_E_NOT_ENOUGH_MEMORY; [self logWithFormat: @"PR_BODY data too wide"]; } } else rc = MAPI_E_NOT_FOUND; } } break; case PR_INTERNET_CPID: /* ref: http://msdn.microsoft.com/en-us/library/dd317756%28v=vs.85%29.aspx minimal list that should be handled: us-ascii: 20127 iso-8859-1: 28591 iso-8859-15: 28605 utf-8: 65001 */ *data = MAPILongValue(memCtx, 65001); break; case PR_HTML: { NSMutableArray *keys; NSArray *acceptedTypes; child = [self lookupChild: childKey]; acceptedTypes = [NSArray arrayWithObject: @"text/html"]; keys = [NSMutableArray array]; [child addRequiredKeysOfStructure: [child bodyStructure] path: @"" toArray: keys acceptedTypes: acceptedTypes]; if ([keys count] > 0) { id result; NSData *content; NSDictionary *partHeaderData; NSString *key, *encoding; result = [child fetchParts: [keys objectsForKey: @"key" notFoundMarker: nil]]; result = [[result valueForKey: @"RawResponse"] objectForKey: @"fetch"]; key = [[keys objectAtIndex: 0] objectForKey: @"key"]; content = [[result objectForKey: key] objectForKey: @"data"]; partHeaderData = [child lookupInfoForBodyPart: [key _strippedBodyKey]]; encoding = [partHeaderData objectForKey: @"encoding"]; content = [content bodyDataFromEncoding: encoding]; if ([content length] > 16384) { [context registerValue: content asProperty: propTag forURL: [NSString stringWithFormat: @"%@%@", folderURL, childKey]]; *data = NULL; rc = MAPI_E_NOT_ENOUGH_MEMORY; [self logWithFormat: @"PR_HTML data too wide"]; } else *data = [content asBinaryInMemCtx: memCtx]; } else { *data = NULL; rc = MAPI_E_NOT_FOUND; } } break; /* We don't handle any RTF content. */ case PR_RTF_COMPRESSED: *data = NULL; rc = MAPI_E_NOT_FOUND; break; case PR_RTF_IN_SYNC: *data = MAPIBoolValue (memCtx, NO); break; case PR_INTERNET_MESSAGE_ID_UNICODE: child = [self lookupChild: childKey]; *data = [[child messageId] asUnicodeInMemCtx: memCtx]; break; case PR_READ_RECEIPT_REQUESTED: // TODO case PR_DELETE_AFTER_SUBMIT: // TODO *data = MAPIBoolValue (memCtx, NO); break; case PidLidPrivate: *data = MAPIBoolValue (memCtx, NO); break; case PR_MSG_EDITOR_FORMAT: { NSMutableArray *keys; NSArray *acceptedTypes; uint32_t format; child = [self lookupChild: childKey]; format = 0; /* EDITOR_FORMAT_DONTKNOW */ acceptedTypes = [NSArray arrayWithObject: @"text/plain"]; keys = [NSMutableArray array]; [child addRequiredKeysOfStructure: [child bodyStructure] path: @"" toArray: keys acceptedTypes: acceptedTypes]; if ([keys count] == 1) format = EDITOR_FORMAT_PLAINTEXT; acceptedTypes = [NSArray arrayWithObject: @"text/html"]; [keys removeAllObjects]; [child addRequiredKeysOfStructure: [child bodyStructure] path: @"" toArray: keys acceptedTypes: acceptedTypes]; if ([keys count] == 1) format = EDITOR_FORMAT_HTML; *data = MAPILongValue (memCtx, format); } break; case PidLidReminderSet: // TODO case PidLidUseTnef: // TODO *data = MAPIBoolValue (memCtx, NO); break; case PidLidRemoteStatus: // TODO *data = MAPILongValue (memCtx, 0); break; case PidLidSmartNoAttach: // TODO case PidLidAgingDontAgeMe: // TODO *data = MAPIBoolValue (memCtx, YES); break; // PidLidFlagRequest // PidLidBillingInformation // PidLidMileage // PidLidCommonEnd // PidLidCommonStart // PidLidNonSendableBcc // PidLidNonSendableCc // PidLidNonSendtableTo // PidLidNonSendBccTrackStatus // PidLidNonSendCcTrackStatus // PidLidNonSendToTrackStatus // PidLidReminderDelta // PidLidReminderFileParameter // PidLidReminderSignalTime // PidLidReminderOverride // PidLidReminderPlaySound // PidLidReminderTime // PidLidReminderType // PidLidSmartNoAttach // PidLidTaskGlobalId // PidLidTaskMode // PidLidVerbResponse // PidLidVerbStream // PidLidInternetAccountName // PidLidInternetAccountStamp // PidLidContactLinkName // PidLidContactLinkEntry // PidLidContactLinkSearchKey // PidLidSpamOriginalFolder default: rc = [super getChildProperty: data forKey: childKey withTag: propTag]; } return rc; } - (NSString *) backendIdentifierForProperty: (enum MAPITAGS) property { static NSMutableDictionary *knownProperties = nil; if (!knownProperties) { knownProperties = [NSMutableDictionary new]; [knownProperties setObject: @"DATE" forKey: MAPIPropertyKey (PR_CLIENT_SUBMIT_TIME)]; [knownProperties setObject: @"DATE" forKey: MAPIPropertyKey (PR_MESSAGE_DELIVERY_TIME)]; [knownProperties setObject: @"MESSAGE-ID" forKey: MAPIPropertyKey (PR_INTERNET_MESSAGE_ID_UNICODE)]; } return [knownProperties objectForKey: MAPIPropertyKey (property)]; } /* restrictions */ - (void) setRestrictions: (const struct mapi_SRestriction *) res { [super setRestrictions: res]; } - (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 isEqualToString: @"IPM.Note"]) rc = MAPIRestrictionStateAlwaysTrue; else rc = MAPIRestrictionStateAlwaysFalse; break; case PidLidAppointmentStartWhole: case PidLidAppointmentEndWhole: case PidLidRecurring: [self logWithFormat: @"apt restriction on mail folder?"]; rc = MAPIRestrictionStateAlwaysFalse; break; case PidLidAutoProcessState: if ([value intValue] == 0) rc = MAPIRestrictionStateAlwaysTrue; else rc = MAPIRestrictionStateAlwaysFalse; break; case PR_SEARCH_KEY: rc = MAPIRestrictionStateAlwaysFalse; break; case 0x0fff00fb: /* PR_ENTRY_ID in PtyServerId form */ case 0x0ff600fb: /* resProperty: struct mapi_SPropertyRestriction relop : 0x04 (4) ulPropTag : UNKNOWN_ENUM_VALUE (0xFF600FB) lpProp: struct mapi_SPropValue ulPropTag : UNKNOWN_ENUM_VALUE (0xFF600FB) value : union mapi_SPropValue_CTR(case 251) bin : SBinary_short cb=21 [0000] 01 01 00 1A 00 00 00 00 00 9C 83 E8 0F 00 00 00 ........ ........ [0010] 00 00 00 00 00 ..... */ rc = MAPIRestrictionStateAlwaysFalse; break; case PR_CONVERSATION_KEY: rc = MAPIRestrictionStateAlwaysFalse; break; default: rc = [super evaluatePropertyRestriction: res intoQualifier: qualifier]; } return rc; } - (MAPIRestrictionState) evaluateContentRestriction: (struct mapi_SContentRestriction *) res intoQualifier: (EOQualifier **) qualifier { MAPIRestrictionState rc; id value; value = NSObjectFromMAPISPropValue (&res->lpProp); if ([value isKindOfClass: NSDataK]) { value = [[NSString alloc] initWithData: value encoding: NSUTF8StringEncoding]; [value autorelease]; } else if (![value isKindOfClass: NSStringK]) [NSException raise: @"MAPIStoreTypeConversionException" format: @"unhandled content restriction for class '%@'", NSStringFromClass ([value class])]; switch (res->ulPropTag) { case PR_MESSAGE_CLASS_UNICODE: if ([value isEqualToString: @"IPM.Note"]) rc = MAPIRestrictionStateAlwaysTrue; else rc = MAPIRestrictionStateAlwaysFalse; break; case PR_CONVERSATION_KEY: rc = MAPIRestrictionStateAlwaysFalse; break; default: rc = [super evaluateContentRestriction: res intoQualifier: qualifier]; } return rc; } - (MAPIRestrictionState) evaluateExistRestriction: (struct mapi_SExistRestriction *) res intoQualifier: (EOQualifier **) qualifier { MAPIRestrictionState rc; switch (res->ulPropTag) { case PR_MESSAGE_CLASS_UNICODE: rc = MAPIRestrictionStateAlwaysFalse; break; case PR_MESSAGE_DELIVERY_TIME: rc = MAPIRestrictionStateAlwaysTrue; break; case PR_PROCESSED: rc = MAPIRestrictionStateAlwaysFalse; break; default: rc = [super evaluateExistRestriction: res intoQualifier: qualifier]; } return rc; } /* sorting */ - (NSString *) _sortIdentifierForProperty: (enum MAPITAGS) property { static NSMutableDictionary *knownProperties = nil; if (!knownProperties) { knownProperties = [NSMutableDictionary new]; /* ARRIVAL, CC */ [knownProperties setObject: @"DATE" forKey: MAPIPropertyKey (PR_CLIENT_SUBMIT_TIME)]; [knownProperties setObject: @"DATE" forKey: MAPIPropertyKey (PR_MESSAGE_DELIVERY_TIME)]; [knownProperties setObject: @"FROM" forKey: MAPIPropertyKey (PR_SENT_REPRESENTING_NAME_UNICODE)]; [knownProperties setObject: @"SIZE" forKey: MAPIPropertyKey (PR_MESSAGE_SIZE)]; [knownProperties setObject: @"SIZE" forKey: MAPIPropertyKey (PidLidRemoteTransferSize)]; [knownProperties setObject: @"SUBJECT" forKey: MAPIPropertyKey (PR_NORMALIZED_SUBJECT_UNICODE)]; [knownProperties setObject: @"TO" forKey: MAPIPropertyKey (PR_DISPLAY_TO_UNICODE)]; } return [knownProperties objectForKey: MAPIPropertyKey (property)]; } - (void) setSortOrder: (const struct SSortOrderSet *) set { NSMutableString *newSortOrdering; struct SSortOrder *sortOrder; NSString *sortIdentifier; const char *propName; uint16_t count; if (set) { /* TODO: */ if (set->cCategories > 0) [self errorWithFormat: @"we don't handle sort categories yet"]; newSortOrdering = [NSMutableString string]; for (count = 0; count < set->cSorts; count++) { sortOrder = set->aSort + count; sortIdentifier = [self _sortIdentifierForProperty: sortOrder->ulPropTag]; if (sortIdentifier) { if (sortOrder->ulOrder == TABLE_SORT_DESCEND) [newSortOrdering appendString: @" REVERSE"]; else if (sortOrder->ulOrder == TABLE_SORT_MAXIMUM_CATEGORY) [self errorWithFormat: @"TABLE_SORT_MAXIMUM_CATEGORY is not handled"]; [newSortOrdering appendFormat: @" %@", sortIdentifier]; } else { propName = get_proptag_name (sortOrder->ulPropTag); if (!propName) propName = ""; [self errorWithFormat: @"sort unhandled for property: %s (0x%.8x)", propName, sortOrder->ulPropTag]; } } if ([newSortOrdering length] > 0) ASSIGN (sortOrdering, [newSortOrdering substringFromIndex: 1]); else ASSIGN (sortOrdering, @"ARRIVAL"); [self cleanupCaches]; [self logWithFormat: @"new sort ordering: '%@'", sortOrdering]; } else ASSIGN (sortOrdering, @"ARRIVAL"); } @end