sogo/UI/MailerUI/UIxMailEditor.m

/*
  Copyright (C) 2008-2015 Inverse inc.

  This file is part of SOGo.

  SOGo 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.

  SOGo 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 SOGo; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/


#import <NGHttp/NGHttpRequest.h>
#import <NGObjWeb/NSException+HTTP.h>
#define COMPILING_NGOBJWEB 1 /* we want httpRequest for parsing multi-part
                                form data */
#import <NGObjWeb/WORequest.h>
#undef COMPILING_NGOBJWEB
#import <NGExtensions/NSNull+misc.h>
#import <NGExtensions/NSObject+Logs.h>
#import <NGExtensions/NSString+misc.h>
#import <NGExtensions/NSException+misc.h>
#import <NGMime/NGMimeBodyPart.h>
#import <NGMime/NGMimeHeaderFields.h>
#import <NGMime/NGMimeMultipartBody.h>
#import <NGMime/NGMimeType.h>

#import <SOGo/SOGoCache.h>
#import <SOGo/SOGoSystemDefaults.h>
#import <SOGo/SOGoUser.h>
#import <SOGo/NSArray+Utilities.h>
#import <SOGo/NSDictionary+Utilities.h>
#import <SOGo/NSString+Utilities.h>
#import <SOGo/WOResourceManager+SOGo.h>
#import <SOGoUI/UIxComponent.h>
#import <Mailer/SOGoDraftObject.h>
#import <Mailer/SOGoMailObject+Draft.h>
#import <Mailer/SOGoMailFolder.h>
#import <Mailer/SOGoMailAccount.h>

#import <UI/MailPartViewers/UIxMailSizeFormatter.h>

/*
  UIxMailEditor
  
  A mail editor component which works on SOGoDraftObject's.
*/

@interface UIxMailEditor : UIxComponent
{
  NSArray  *to;
  NSArray  *cc;
  NSArray  *bcc;
  NSString *subject;
  NSString *sourceUID;
  NSString *sourceFolder;
  NSString *text;
  NSString *from;
  SOGoMailFolder *sentFolder;
  BOOL isHTML;
  BOOL sign;
  BOOL encrypt;

  NSString *priority;
  NSString *receipt;
  id item;
  id currentFolder;

  /* these are for the inline attachment list */
  NSDictionary *attachment;
  NSArray  *attachmentAttrs;
  NSString *currentAttachment;
  NSMutableArray *attachedFiles;
}

@end

@implementation UIxMailEditor

static NSArray *infoKeys = nil;

+ (void) initialize
{
  if (!infoKeys)
    infoKeys = [[NSArray alloc] initWithObjects:
                                  @"subject", @"to", @"cc", @"bcc", 
                                @"from", @"inReplyTo",
                                @"replyTo",
                                @"priority", @"receipt", @"isHTML",
                                @"text", @"sign", @"encrypt", nil];
}

- (id) init
{
  if ((self = [super init]))
    {
      priority = @"NORMAL";
      receipt = nil;
      currentFolder = nil;
      currentAttachment = nil;
      attachmentAttrs = nil;
      attachedFiles = nil;
    }
  
  return self;
}

- (void) dealloc
{
  [item release];
  [priority release];
  [receipt release];
  [sentFolder release];
  [from release];
  [text release];
  [subject release];
  [to release];
  [cc release];
  [bcc release];
  [sourceUID release];
  [sourceFolder release];
  [attachment release];
  [currentAttachment release];
  [attachmentAttrs release];
  [attachedFiles release];
  [currentFolder release];
  [super dealloc];
}

/* accessors */
- (void) setItem: (id) _item
{
  ASSIGN (item, _item);
}

- (id) item
{
  return item;
}

- (NSString *) uid
{
  return [[self clientObject] nameInContainer];
}

- (NSArray *) priorityClasses
{
  static NSArray *priorities = nil;
  
  if (!priorities)
    {
      priorities = [NSArray arrayWithObjects: @"HIGHEST", @"HIGH",
                            @"NORMAL", @"LOW", @"LOWEST", nil];
      [priorities retain];
    }

  return priorities;
}

- (void) setPriority: (NSString *) _priority
{
  ASSIGN (priority, _priority);
}

- (NSString *) priority
{
  return priority;
}

- (void) setReceipt: (NSString *) newReceipt
{
  ASSIGN (receipt, newReceipt);
}

- (NSString *) receipt
{
  return receipt;
}

- (void) setIsHTML: (BOOL) aBool
{
  isHTML = aBool;
}

- (BOOL) isHTML
{
  SOGoUserDefaults *ud;

  ud = [[context activeUser] userDefaults];

  return [[ud mailComposeMessageType] isEqualToString: @"html"];
}

- (NSString *) itemPriorityText
{
  return [self labelForKey: [NSString stringWithFormat: @"%@", [item lowercaseString]]];
}

- (NSString *) isMailReply
{
  return ([to count] > 0 ? @"true" : @"false");
}

- (NSString *) localeCode
{
  // WARNING : NSLocaleCode is not defined in <Foundation/NSUserDefaults.h>
  // Region subtag must be separated by a dash
  NSMutableString *s = [NSMutableString stringWithString: [locale objectForKey: @"NSLocaleCode"]];

  [s replaceOccurrencesOfString: @"_"
                     withString: @"-"
                        options: 0
                          range: NSMakeRange(0, [s length])];
  
  return s;
}

- (void) setFrom: (NSString *) newFrom
{
  ASSIGN (from, newFrom);
}

- (NSString *) _emailFromIdentity: (NSDictionary *) identity
{
  NSString *fullName, *format;

  fullName = [identity objectForKey: @"fullName"];
  if ([fullName length])
    format = @"%{fullName} <%{email}>";
  else
    format = @"%{email}";

  return [identity keysWithFormat: format];
}

- (NSString *) from
{
  NSArray *identities;
  NSEnumerator *allIdentities;
  NSDictionary *identity;
  NSRange r;
  BOOL valid;

  if ([from length])
    {
      identities = [[[self clientObject] mailAccountFolder] identities];
      if ([identities count])
        {
          allIdentities = [identities objectEnumerator];
          valid = NO;
          while ((identity = [allIdentities nextObject]) && !valid)
             {
               // from ivar must contain a valid email address surrounded by pointy brackets
               r = [[from lowercaseString] rangeOfString: [[identity objectForKey: @"email"] lowercaseString]];
               if (r.length > 0)
                 {
                   valid = YES;
                   [from release];
                   from = [self _emailFromIdentity: identity];
                   [from retain];
                 }
             }
          if (!valid)
            {
              [from release];
              from = nil;
            }
        }
    }

  return from;
}

- (NSString *) replyTo
{
  NSString *value;
  
  value = nil;

  //
  // We add the correct replyTo here. That is, the one specified in the defaults
  // for the main "SOGo mail account" versus the one specified in the auxiliary
  // IMAP accounts.
  //
  if ([[[[self clientObject] mailAccountFolder] nameInContainer] intValue] == 0)
    {
      value = [[[context activeUser] defaultIdentity] objectForKey: @"replyTo"];
    }
  else
    {
      value = [[[[self clientObject] mailAccountFolder] defaultIdentity] objectForKey: @"replyTo"];
    }

  return value;
}

- (void) setSubject: (NSString *) newSubject
{
  ASSIGN (subject, newSubject);
}

- (NSString *) subject
{
  return subject;
}

- (void) setText: (NSString *) newText
{
  ASSIGN (text, newText);
}

- (NSString *) text
{
  return text;
}

- (void) setSourceUID: (int) newSourceUID
{
  NSString *s;

  s = [NSString stringWithFormat: @"%i", newSourceUID];
  ASSIGN (sourceUID, s);
}

- (NSString *) sourceUID
{
  return sourceUID;
}

- (void) setSourceFolder: (NSString *) newSourceFolder
{
  ASSIGN (sourceFolder, newSourceFolder);
}

- (NSString *) sourceFolder
{
  return sourceFolder;
}

- (void) setTo: (NSArray *) newTo
{
  if ([newTo isKindOfClass: [NSNull class]])
    newTo = nil;

  ASSIGN (to, [newTo uniqueObjects]);
}

- (NSArray *) to
{
  return to;
}

- (void) setCc: (NSArray *) newCc
{
  if ([newCc isKindOfClass: [NSNull class]])
    newCc = nil;

  ASSIGN (cc, [newCc uniqueObjects]);
}

- (NSArray *) cc
{
  return cc;
}

- (void) setBcc: (NSArray *) newBcc
{
  if ([newBcc isKindOfClass: [NSNull class]])
    newBcc = nil;

  ASSIGN (bcc, [newBcc uniqueObjects]);
}

- (NSArray *) bcc
{
  return bcc;
}

- (BOOL) hasOneOrMoreRecipients
{
  return (([to count] + [cc count] + [bcc count]) > 0);
}

- (void) setAttachment: (NSDictionary *) newAttachment
{
  ASSIGN (attachment, newAttachment);
}

- (NSDictionary *) attachment
{
  return attachment;
}

- (NSFormatter *) sizeFormatter
{
  return [UIxMailSizeFormatter sharedMailSizeFormatter];
}

/* info loading */

- (void) loadInfo: (NSDictionary *) _info
{
  if (![_info isNotNull]) return;
  [self debugWithFormat:@"loading info ..."];
  [self setValuesForKeysWithDictionary: _info];
}

- (NSDictionary *) infoFromRequest
{
  WORequest *request;
  NSDictionary *params, *filteredParams;

  request = [context request];
  params = [[request contentAsString] objectFromJSONString];
  filteredParams = [NSDictionary dictionaryWithObjects: [params objectsForKeys: infoKeys notFoundMarker: [NSNull null]]
                                               forKeys: infoKeys];

  [self setFrom: [filteredParams objectForKey: @"from"]];
  [self setTo: [filteredParams objectForKey: @"to"]];
  [self setCc: [filteredParams objectForKey: @"cc"]];
  [self setBcc: [filteredParams objectForKey: @"bcc"]];
  [self setIsHTML: [[filteredParams objectForKey: @"isHTML"] boolValue]];
  [self setText: [filteredParams objectForKey: @"text"]];

  // S/MIME parameters
  sign = [[filteredParams objectForKey: @"sign"] boolValue];
  encrypt = [[filteredParams objectForKey: @"encrypt"] boolValue];

  return filteredParams;
}

/* contacts search */
// - (NSArray *) contactFolders
// {
//   SOGoContactFolders *folderContainer;

//   folderContainer = (SOGoContactFolders *) [[[self clientObject] lookupUserFolder] privateContacts: @"Contacts"
//                                                                                         inContext: nil];
  
//   return [folderContainer subFolders];
// }

// - (NSArray *) personalContactInfos
// {
//   SOGoContactFolders *folderContainer;
//   id <SOGoContactFolder> folder;
//   NSArray *contactInfos;

//   folderContainer = (SOGoContactFolders *) [[[self clientObject] lookupUserFolder] privateContacts: @"Contacts"
//                                                                                            inContext: nil];
  
//   folder = [folderContainer lookupPersonalFolder: @"personal" ignoringRights: YES];

//   // If the folder doesn't exist anymore or if the database is down, we
//   // return an empty array.
//   if ([folder isKindOfClass: [NSException class]])
//       return [NSArray array];

//   contactInfos = [folder lookupContactsWithFilter: nil
// 				       onCriteria: nil
// 					   sortBy: @"c_cn"
// 					 ordering: NSOrderedAscending
//                                          inDomain: nil];
  
//   return contactInfos;
// }

// - (void) setCurrentFolder: (id) _currentFolder
// {
//   ASSIGN (currentFolder, _currentFolder);
// }

// - (NSString *) currentContactFolderId
// {
//   return [NSString stringWithFormat: @"/%@", [currentFolder nameInContainer]];
// }

// - (NSString *) currentContactFolderName
// {
//   return [currentFolder displayName];
// }

// - (NSString *) currentContactFolderOwner
// {
//   return [currentFolder ownerInContext: context];
// }

// - (NSString *) currentContactFolderClass
// {
//   return ([currentFolder isKindOfClass: [SOGoContactSourceFolder class]]
//           ? @"remote" : @"local");
// }

/* actions */
- (NSString *) _fixedFilename: (NSString *) filename
{
  NSString *newFilename, *baseFilename, *extension;
  unsigned int variation;

  if (!attachedFiles)
    attachedFiles = [NSMutableArray new];

  newFilename = [filename stringByReplacingOccurrencesOfString:@"\\\"" withString:@"\""]; /* to real filename */
  baseFilename = [newFilename stringByDeletingPathExtension];
  extension = [newFilename pathExtension];
  variation = 0;
  while ([attachedFiles containsObject: newFilename])
    {
      variation++;
      newFilename = [NSString stringWithFormat: @"%@-%d.%@", baseFilename,
			      variation, extension];
    }
  [attachedFiles addObject: newFilename];

  return newFilename;
}

- (NSMutableDictionary *) _scanAttachmentFilenamesInRequest: (id) httpBody
{
  NSMutableDictionary *files, *file;
  NSArray *parts;
  unsigned int count, max;
  NGMimeBodyPart *part;
  NGMimeContentDispositionHeaderField *header;
  NSString *mimeType, *filename;

  parts = [httpBody parts];
  max = [parts count];
  files = [NSMutableDictionary dictionaryWithCapacity: max];

  for (count = 0; count < max; count++)
    {
      part = [parts objectAtIndex: count];
      header = (NGMimeContentDispositionHeaderField *)[part headerForKey: @"content-disposition"];
      if ([[header name] hasPrefix: @"attachments"])
        {
          mimeType = [(NGMimeType *)[part headerForKey: @"content-type"] stringValue];
          filename = [self _fixedFilename: [header filename]];
          file = [NSMutableDictionary dictionaryWithObjectsAndKeys:
                                      filename, @"filename",
                                      mimeType, @"mimetype",
                                      [part body], @"body",
                                      nil];
          [files setObject: file forKey: [NSString stringWithFormat: @"%@_%@", [header name], filename]];
        }
    }

  return files;
}

- (NSException *) _saveAttachments
{
  NSException *error;
  WORequest *request;
  NSEnumerator *allAttachments;
  NSMutableDictionary *attrs;
  NSDictionary *filenames;
  id httpBody;
  SOGoDraftObject *co;

  error = nil;
  request = [context request];

  httpBody = [[request httpRequest] body];

  // We got an exception from SOPE - most likely due to
  // WOMaxUploadSize being reached.
  if ([httpBody isKindOfClass: [NSException class]])
    return httpBody;

  filenames = [self _scanAttachmentFilenamesInRequest: httpBody];

  co = [self clientObject];
  allAttachments = [filenames objectEnumerator];
  while ((attrs = [allAttachments nextObject]) && !error)
    {
      error = [co saveAttachment: (NSData *) [attrs objectForKey: @"body"]
                    withMetadata: attrs];
      // Keep the name of the last attachment saved
      ASSIGN(currentAttachment, [attrs objectForKey: @"filename"]);
    }

  return error;
}

/**
 * Save received data to the filesystem, either the attached files or the message itself.
 */
- (NSException *) _saveRequestInfo
{
  NSDictionary *info;
  NSException *error;
  NSString *fontSize, *content;
  NGMimeType *mimeType;
  WORequest *request;
  SOGoDraftObject *co;
  SOGoUserDefaults *ud;

  error = nil;
  request = [context request];
  mimeType = [[request httpRequest] contentType];

  co = [self clientObject];
  [co fetchInfo];

  if ([[mimeType type] isEqualToString: @"multipart"])
    {
      error = [self _saveAttachments];
    }
  else if ([[mimeType subType] isEqualToString: @"json"])
    {
      info = [self infoFromRequest];
      [co setHeaders: info];
      [co setIsHTML: isHTML];
      [co setSign: sign];
      [co setEncrypt: encrypt];
      if (isHTML)
        {
          // Set a base font size if mail is HTML and user has set a default font-size
          ud = [[context activeUser] userDefaults];
          fontSize = [ud mailComposeFontSize];
          if ([fontSize intValue] > 0)
            content = [NSString stringWithFormat: @"<html><span style=\"font-size: %@px;\">%@</span></html>",
                                fontSize, text];
          else
            content = [NSString stringWithFormat: @"<html>%@</html>", text];
        }
      else
        {
          content = text;
        }
      [co setText: content];
      error = [co storeInfo];
    }

  return error;
}

- (id) failedToSaveFormResponse: (NSString *) msg
{
  NSDictionary *d;

  d = [NSDictionary dictionaryWithObjectsAndKeys: msg, @"message", nil];

  return [self responseWithStatus: 500 andJSONRepresentation: d];
}

/* attachment helper */

- (NSArray *) attachmentAttrs
{
  SOGoDraftObject *co;
  SOGoMailObject *mail;
  NSArray *a;

  co = [self clientObject];
  if (!attachmentAttrs || ![co imap4URL])
  {
      [co fetchInfo];
      if ((![co inReplyTo] || currentAttachment) && [co IMAP4ID] > -1)
        {
          // When currentAttachment is defined, it means we just attached a new file to the mail
          mail = [[[SOGoMailObject alloc] initWithImap4URL: [co imap4URL] inContainer: [co container]] autorelease];
          a = [mail fetchFileAttachmentKeys];
          ASSIGN (attachmentAttrs, a);
        }
  }

  if (currentAttachment)
    {
      // When currentAttachment is defined, only return the attributes of the last
      // attachment saved
      NSEnumerator *allAttachments;
      NSDictionary* attrs;

      allAttachments = [attachmentAttrs objectEnumerator];
      while ((attrs = [allAttachments nextObject]))
        {
          if ([[attrs objectForKey: @"filename"] isEqualToString: currentAttachment])
            {
              return [NSArray arrayWithObject: attrs];
            }
        }
    }

  return attachmentAttrs;
}

- (BOOL) hasAttachments
{
  return [[self attachmentAttrs] count] > 0 ? YES : NO;
}

- (id <WOActionResults>) editAction
{
  id <WOActionResults> response;
  SOGoDraftObject *co;
  NSMutableDictionary *data;
  id value;

  co = [self clientObject];
  [co fetchInfo];
  [self loadInfo: [co headers]];
  [self setIsHTML: [co isHTML]];
  [self setText: [co text]];
  [self setSourceUID: [co IMAP4ID]];
  [self setSourceFolder: [co sourceFolder]];

  data = [NSMutableDictionary dictionaryWithObjectsAndKeys:
                              [self localeCode], @"locale",
                              [NSNumber numberWithBool: [self isHTML]], @"isHTML",
                              text, @"text",
                              nil];
  if ((value = [self from]))
    [data setObject: value forKey: @"from"];
  if ((value = [self replyTo]))
    [data setObject: value forKey: @"replyTo"];
  if ((value = [self to]))
    [data setObject: value forKey: @"to"];
  if ((value = [self cc]))
    [data setObject: value forKey: @"cc"];
  if ((value = [self bcc]))
    [data setObject: value forKey: @"bcc"];
  if ((value = [self subject]))
    [data setObject: value forKey: @"subject"];
  if ((value = [self attachmentAttrs]))
    [data setObject: value forKey: @"attachmentAttrs"];

  response = [self responseWithStatus: 200
                            andString: [data jsonRepresentation]];

  return response;
}

- (WOResponse *) saveAction
{
  id result;
  NSArray *attrs;
  NSDictionary *data;
  SOGoDraftObject *co;

  co = [self clientObject];
  [co setIsHTML: isHTML];

  result = [self _saveRequestInfo];
  if (!result)
    {
      // Save message to IMAP server
      result = [co save];
    }
  if (!result)
    {
      // Save new UID to plist
      [self setSourceUID: [co IMAP4ID]];
      [co setIsHTML: isHTML];
      [co storeInfo];

      // Prepare response
      attachmentAttrs = nil;
      attrs = [self attachmentAttrs];
      data = [NSDictionary dictionaryWithObjectsAndKeys:
                             [self sourceUID], @"uid",
                           attrs, @"lastAttachmentAttrs",
                           nil];
      result = [self responseWithStatus: 200
                              andString: [data jsonRepresentation]];
    }
  else
    result = [self failedToSaveFormResponse: [result reason]];

  return result;
}

- (NSException *) validateForSend
{
  NSException *error;

  if (![self hasOneOrMoreRecipients])
    error = [NSException exceptionWithHTTPStatus: 400 /* Bad Request */
                                          reason: [self labelForKey: @"error_missingrecipients"]];
  else
    error = nil;
  
  return error;
}

//
//
//
- (WOResponse *) sendAction
{
  SOGoDraftObject *co;
  NSDictionary *jsonResponse;
  NSException *error;
  NSMutableArray *errorMsg;
  NSDictionary *messageSubmissions;
  SOGoSystemDefaults *dd;
  id <WOActionResults> response;

  NSUInteger messages_count, recipients_count;

  messageSubmissions = [[SOGoCache sharedCache] messageSubmissionsCountForLogin: [[context activeUser] login]];
  dd = [SOGoSystemDefaults sharedSystemDefaults];
  messages_count = recipients_count = 0;

  if (messageSubmissions)
    {
      unsigned int current_time, start_time, delta, block_time;

      current_time = [[NSCalendarDate date] timeIntervalSince1970];
      start_time = [[messageSubmissions objectForKey: @"InitialDate"] unsignedIntValue];
      delta = current_time - start_time;

      block_time = [dd messageSubmissionBlockInterval];
      messages_count = [[messageSubmissions objectForKey: @"MessagesCount"] intValue];
      recipients_count =  [[messageSubmissions objectForKey: @"RecipientsCount"] intValue];
      
      if ((messages_count >= [dd maximumMessageSubmissionCount] || recipients_count >= [dd maximumRecipientCount]) &&
          delta <= block_time)
        {
          jsonResponse = [NSDictionary dictionaryWithObjectsAndKeys:
                                         @"failure", @"status",
                                                  [self labelForKey: @"Tried to send too many mails. Please wait."],
                                       @"message",
                                       nil];
          return [self responseWithStatus: 200
                                andString: [jsonResponse jsonRepresentation]];
        }
      
      if (delta > block_time ||
          (delta >= [dd maximumSubmissionInterval] && messages_count < [dd maximumMessageSubmissionCount] && recipients_count < [dd maximumRecipientCount]))
        {
          [[SOGoCache sharedCache] setMessageSubmissionsCount: 0
                                              recipientsCount: 0
                                                     forLogin: [[context activeUser] login]];
        }
    }

  co = [self clientObject];

  // First, save form data to filesystem
  error = [self _saveRequestInfo];
  if (!error)
    {
      error = [self validateForSend];
      if (!error)
        error = [co sendMail];
      else
	error = [self failedToSaveFormResponse: [error reason]];
    }

  if (error)
    {
      // Only the first line is translated
      errorMsg = [NSMutableArray arrayWithArray: [[error reason] componentsSeparatedByString: @"\n"]];
      [errorMsg replaceObjectAtIndex: 0
			  withObject: [self labelForKey: [errorMsg objectAtIndex: 0]]];
      jsonResponse = [NSDictionary dictionaryWithObjectsAndKeys:
				     @"failure", @"status",
			           [errorMsg componentsJoinedByString: @"\n"],
				   @"message",
				   nil];
      response = [self responseWithStatus: 405
                    andJSONRepresentation: jsonResponse];
    }
  else
    {
      jsonResponse = [NSDictionary dictionaryWithObjectsAndKeys:
                                     @"success", @"status",
                                   [co sourceFolder], @"sourceFolder",
                                        [NSNumber numberWithInt: [co sourceIMAP4ID]], @"sourceMessageID",
                                   nil];
      response = [self responseWithStatus: 200
                    andJSONRepresentation: jsonResponse];
     
      recipients_count += [[co allRecipients] count];
      messages_count += 1;
      
      if ([dd maximumMessageSubmissionCount] > 0 || [dd maximumRecipientCount] > 0)
        {
          [[SOGoCache sharedCache] setMessageSubmissionsCount: messages_count
                                              recipientsCount: recipients_count
                                                     forLogin: [[context activeUser] login]];
        }
    }

  return response;
}

@end /* UIxMailEditor */