sogo/SoObjects/SOGo/SOGoUserFolder.m

/*
  Copyright (C) 2004-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.
*/

#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>
#import <Foundation/NSURL.h>

#import <NGObjWeb/NSException+HTTP.h>
#import <NGObjWeb/SoClassSecurityInfo.h>
#import <NGObjWeb/SoSecurityManager.h>
#import <NGObjWeb/WOContext+SoObjects.h>
#import <NGObjWeb/WOResponse.h>

#import <NGExtensions/NSObject+Logs.h>
#import <NGExtensions/NSString+misc.h>
#import <DOM/DOMDocument.h>
#import <DOM/DOMNode.h>
#import <DOM/DOMProtocols.h>
#import <SaxObjC/SaxObjC.h>
#import <SaxObjC/XMLNamespaces.h>

#import <Appointments/SOGoAppointmentFolders.h>
#import <Appointments/SOGoFreeBusyObject.h>
#import <Contacts/SOGoContactFolders.h>
#import <Mailer/SOGoMailAccounts.h>

#import "NSArray+Utilities.h"
#import "NSDictionary+Utilities.h"
#import "LDAPUserManager.h"
#import "SOGoPermissions.h"
#import "SOGoUser.h"

#import "SOGoUserFolder.h"

@implementation SOGoUserFolder

// + (void) initialize
// {
//   SoClassSecurityInfo *sInfo;
//   NSArray *basicRoles;

//   sInfo = [self soClassSecurityInfo];
//   [sInfo declareObjectProtected: SoPerm_View];

//   basicRoles = [NSArray arrayWithObject: SoRole_Authenticated];

//   /* require Authenticated role for View and WebDAV */
//   [sInfo declareRoles: basicRoles asDefaultForPermission: SoPerm_View];
//   [sInfo declareRoles: basicRoles asDefaultForPermission: SoPerm_WebDAVAccess];
// }

/* hierarchy */

- (NSArray *) toManyRelationshipKeys
{
  NSMutableArray *children;
  SOGoUser *currentUser;

  children = [NSMutableArray arrayWithCapacity: 4];

  currentUser = [context activeUser];
  if ([currentUser canAccessModule: @"Calendar"])
    [children addObject: @"Calendar"];
  [children addObject: @"Contacts"];
  if ([currentUser canAccessModule: @"Mail"])
    [children addObject: @"Mail"];
  [children addObject: @"Preferences"];

  return children;
}

/* ownership */

- (NSString *) ownerInContext: (WOContext *) _ctx
{
  SOGoUser *ownerUser;

  if (!owner)
    {
      ownerUser = [SOGoUser userWithLogin: nameInContainer roles: nil];
      owner = [ownerUser login];
    }

  return owner;
}

/* looking up shared objects */

- (SOGoUserFolder *) lookupUserFolder
{
  return self;
}

- (NSDictionary *) _parseCollectionFilters: (id <DOMDocument>) parentNode
{
  NSEnumerator *children;
  NGDOMNode *node;
  NSMutableDictionary *filter;
  NSString *componentName;

  filter = [NSMutableDictionary dictionaryWithCapacity: 2];
  children = [[parentNode getElementsByTagName: @"prop-match"]
	       objectEnumerator];
  while ((node = [children nextObject]))
    {
      componentName = [[node attribute: @"name"] lowercaseString];
      [filter setObject: [node textValue] forKey: componentName];
    }

  return filter;
}

- (NSArray *) _subFoldersFromFolder: (SOGoParentFolder *) parentFolder
{
  NSMutableArray *folders;
  NSEnumerator *subfolders;
  SOGoFolder *currentFolder;
  NSString *folderName, *folderOwner;
  NSMutableDictionary *currentDictionary;
  SoSecurityManager *securityManager;

  folderOwner = [parentFolder ownerInContext: context];
  securityManager = [SoSecurityManager sharedSecurityManager];

  folders = [NSMutableArray array];

  subfolders = [[parentFolder subFolders] objectEnumerator];
  while ((currentFolder = [subfolders nextObject]))
    {
      if (![securityManager validatePermission: SOGoPerm_AccessObject
			    onObject: currentFolder inContext: context]
	  && [[currentFolder ownerInContext: context]
	       isEqualToString: folderOwner])
	{
	  folderName = [NSString stringWithFormat: @"/%@/%@",
				 [parentFolder nameInContainer],
				 [currentFolder nameInContainer]];
	  currentDictionary
	    = [NSMutableDictionary dictionaryWithCapacity: 3];
	  [currentDictionary setObject: [currentFolder displayName]
			     forKey: @"displayName"];
	  [currentDictionary setObject: folderName forKey: @"name"];
	  [currentDictionary setObject: [currentFolder folderType]
			     forKey: @"type"];
	  [folders addObject: currentDictionary];
	}
    }

  return folders;
}

- (NSArray *) foldersOfType: (NSString *) folderType
		     forUID: (NSString *) uid
{
  NSObject *userFolder;
  SOGoParentFolder *parentFolder;
  NSMutableArray *folders;

  folders = [NSMutableArray array];

  userFolder = [container lookupName: uid inContext: context acquire: NO];

  /* FIXME: should be moved in the SOGo* classes. Maybe by having a SOGoFolderManager. */
  if ([folderType length] == 0 || [folderType isEqualToString: @"calendar"])
    {
      parentFolder = [userFolder lookupName: @"Calendar"
				 inContext: context acquire: NO];
      [folders
	addObjectsFromArray: [self _subFoldersFromFolder: parentFolder]];
    }
  if ([folderType length] == 0 || [folderType isEqualToString: @"contact"])
    {
      parentFolder = [userFolder lookupName: @"Contacts"
				 inContext: context acquire: NO];
      [folders
	addObjectsFromArray: [self _subFoldersFromFolder: parentFolder]];
    }

  return folders;
}

- (NSDictionary *) foldersOfType: (NSString *) type
		     matchingUID: (NSString *) uid
{
  NSArray *contacts, *folders;
  NSEnumerator *enumerator;
  NSDictionary *contact;
  NSMutableDictionary *results;

  results = [NSMutableDictionary dictionary];

  contacts
    = [[LDAPUserManager sharedUserManager] fetchContactsMatching: uid];
  enumerator = [contacts objectEnumerator];
  while ((contact = [enumerator nextObject]))
    {
      uid = [contact objectForKey: @"c_uid"];
      folders = [self foldersOfType: type
		      forUID: [contact objectForKey: @"c_uid"]];
      [results setObject: folders forKey: contact];
    }

  return results;
}

- (NSArray *) davResourceType
{
  NSMutableArray *rType;

  rType = [NSMutableArray arrayWithArray: [super davResourceType]];
  [rType addObject: @"principal"];

  return rType;
}

- (NSString *) _baseDAVURLWithSuffix: (NSString *) suffix
{
  NSURL *prefixURL;

  prefixURL = [NSURL URLWithString: [NSString stringWithFormat: @"../%@", suffix]
		     relativeToURL: [self davURL]];

  return [[prefixURL standardizedURL] absoluteString];
}

- (void) _appendFolders: (NSDictionary *) users
	     toResponse: (WOResponse *) r
{
  NSDictionary *currentContact, *currentFolder;
  NSEnumerator *keys, *folders;
  NSString *baseHREF, *data;

  baseHREF = [self _baseDAVURLWithSuffix: @"./"];

  keys = [[users allKeys] objectEnumerator];
  while ((currentContact = [keys nextObject]))
    {
      folders = [[users objectForKey: currentContact] objectEnumerator];
      while ((currentFolder = [folders nextObject]))
	{
	  [r appendContentString: @"<D:response><D:href>"];
	  data = [NSString stringWithFormat: @"%@%@%@", baseHREF,
			   [currentContact objectForKey: @"c_uid"],
			   [currentFolder objectForKey: @"name"]];
	  [r appendContentString: data];
	  [r appendContentString: @"</D:href><D:propstat>"];
	  [r appendContentString: @"<D:status>HTTP/1.1 200 OK</D:status>"];
	  [r appendContentString: @"</D:propstat><D:owner>"];
	  data = [NSString stringWithFormat: @"%@users/%@", baseHREF,
			   [currentContact objectForKey: @"c_uid"]];
	  [r appendContentString: data];
	  [r appendContentString: @"</D:owner><ownerdisplayname>"];
	  data = [currentContact keysWithFormat: @"%{cn} <%{c_email}>"];
	  [r appendContentString: [data stringByEscapingXMLString]];
	  [r appendContentString: @"</ownerdisplayname><D:displayname>"];
	  data = [currentFolder objectForKey: @"displayName"];
	  [r appendContentString: [data stringByEscapingXMLString]];
	  [r appendContentString: @"</D:displayname></D:response>\r\n"];
	}
    }
}

- (void) _appendCollectionsMatchingFilter: (NSDictionary *) filter
			       toResponse: (WOResponse *) r
{
  NSString *prefix, *queryOwner, *uid;
  NSDictionary *folders;

  prefix = [self _baseDAVURLWithSuffix: @"users/"];
  queryOwner = [filter objectForKey: @"owner"];
  if ([queryOwner hasPrefix: prefix])
    {
      uid = [queryOwner substringFromIndex: [prefix length]];
      folders = [self foldersOfType: [filter objectForKey: @"resource-type"]
		      matchingUID: uid];
      [self _appendFolders: folders toResponse: r];
    }
}

- (id) davCollectionQuery: (WOContext *) queryContext
{
  WOResponse *r;
  NSDictionary *filter;
  id <DOMDocument> document;

  r = [context response];
  [r setStatus: 207];
  [r setContentEncoding: NSUTF8StringEncoding];
  [r setHeader: @"text/xml; charset=\"utf-8\"" forKey: @"content-type"];
  [r setHeader: @"no-cache" forKey: @"pragma"];
  [r setHeader: @"no-cache" forKey: @"cache-control"];
  [r appendContentString:@"<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n"];
  [r appendContentString: @"<D:multistatus xmlns:D=\"DAV:\""
     @" xmlns=\"urn:ietf:params:xml:ns:inverse-dav\">\r\n"];

  document = [[context request] contentAsDOMDocument];
  filter = [self _parseCollectionFilters: document];
  [self _appendCollectionsMatchingFilter: filter toResponse: r];

  [r appendContentString:@"</D:multistatus>\r\n"];

  return r;
}

- (NSString *) _davFetchUsersMatching: (NSString *) user
{
  LDAPUserManager *um;
  NSEnumerator *users;
  NSMutableString *fetch;
  NSDictionary *currentUser;
  NSString *field;

  fetch = [NSMutableString string];
  um = [LDAPUserManager sharedUserManager];
  users = [[um fetchContactsMatching: user] objectEnumerator];
  while ((currentUser = [users nextObject]))
    {
      [fetch appendString: @"<user>"];
      field = [currentUser objectForKey: @"c_uid"];
      [fetch appendFormat: @"<id>%@</id>",
	     [field stringByEscapingXMLString]];
      field = [currentUser objectForKey: @"cn"];
      [fetch appendFormat: @"<displayName>%@</displayName>",
	     [field stringByEscapingXMLString]];
      field = [currentUser objectForKey: @"c_email"];
      [fetch appendFormat: @"<email>%@</email>",
	     [field stringByEscapingXMLString]];
      [fetch appendString: @"</user>"];
    }

  return fetch;
}

- (NSString *) _davUsersFromQuery: (id <DOMDocument>) document
{
  id <DOMNode> node, userAttr;
  id <DOMNamedNodeMap> attrs;
  NSString *nodeName, *result, *response, *user;

  node = [[document documentElement] firstChild];
  nodeName = [node nodeName];
  if ([nodeName isEqualToString: @"users"])
    {
      attrs = [node attributes];
      userAttr = [attrs namedItem: @"match-name"];
      user = [userAttr nodeValue];
      if ([user length])
	result = [self _davFetchUsersMatching: user];
      else
	result = nil;
    }
  else
    result = nil;

  if (result)
    {
      if ([result length])
	response = [NSString stringWithFormat: @"<%@>%@</%@>",
			     nodeName, result, nodeName];
      else
	response = @"";
    }
  else
    response = nil;

  return response;
}

- (id) davUserQuery: (WOContext *) queryContext
{
  WOResponse *r;
  id <DOMDocument> document;
  NSString *content;

  r = [queryContext response];
  [r setContentEncoding: NSUTF8StringEncoding];
  [r setHeader: @"text/xml; charset=\"utf-8\"" forKey: @"content-type"];
  [r setHeader: @"no-cache" forKey: @"pragma"];
  [r setHeader: @"no-cache" forKey: @"cache-control"];

  document = [[context request] contentAsDOMDocument];
  content = [self _davUsersFromQuery: document];
  if (content)
    {
      [r setStatus: 207];
      if ([content length])
	{
	  [r appendContentString: @"<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n"];
	  [r appendContentString: content];
	}
    }
  else
    [r setStatus: 400];

  return r;
}

// - (SOGoGroupsFolder *) lookupGroupsFolder
// {
//   return [self lookupName: @"Groups" inContext: nil acquire: NO];
// }

/* name lookup */

// - (NSString *) permissionForKey: (NSString *) key
// {
//   return ([key isEqualToString: @"freebusy.ifb"]
//           ? SoPerm_WebDAVAccess
//           : [super permissionForKey: key]);
// }

- (SOGoAppointmentFolders *) privateCalendars: (NSString *) key
				    inContext: (WOContext *) localContext
{
  SOGoAppointmentFolders *calendars;
  NSString *baseOCSPath;

  calendars = [$(@"SOGoAppointmentFolders") objectWithName: key
		inContainer: self];
  baseOCSPath = [NSString stringWithFormat: @"/Users/%@/Calendar",
			  [self ownerInContext: nil]];
  [calendars setBaseOCSPath: baseOCSPath];

  return calendars;
}

- (SOGoContactFolders *) privateContacts: (NSString *) _key
                               inContext: (WOContext *) _ctx
{
  SOGoContactFolders *contacts;
  NSString *baseOCSPath;

  contacts = [$(@"SOGoContactFolders") objectWithName:_key inContainer: self];
  baseOCSPath = [NSString stringWithFormat: @"/Users/%@/Contacts",
			  [self ownerInContext: nil]];
  [contacts setBaseOCSPath: baseOCSPath];

  return contacts;
}

// - (id) groupsFolder: (NSString *) _key
//           inContext: (WOContext *) _ctx
// {
//   return [$(@"SOGoGroupsFolder") objectWithName: _key inContainer: self];
// }

- (id) mailAccountsFolder: (NSString *) _key
                inContext: (WOContext *) _ctx
{
  return [$(@"SOGoMailAccounts") objectWithName: _key inContainer: self];
}

- (id) freeBusyObject: (NSString *) _key
            inContext: (WOContext *) _ctx
{
  return [$(@"SOGoFreeBusyObject") objectWithName: _key inContainer: self];
}

- (id) lookupName: (NSString *) _key
        inContext: (WOContext *) _ctx
          acquire: (BOOL) _flag
{
  id obj;
  SOGoUser *currentUser;
  
  /* first check attributes directly bound to the application */
  obj = [super lookupName: _key inContext: _ctx acquire: NO];
  if (!obj)
    {
      currentUser = [_ctx activeUser];
      if ([_key isEqualToString: @"Calendar"]
	  && [currentUser canAccessModule: _key])
	obj = [self privateCalendars: @"Calendar" inContext: _ctx];
//           if (![_key isEqualToString: @"Calendar"])
//             obj = [obj lookupName: [_key pathExtension] 
//                        inContext: _ctx acquire: NO];
      else if ([_key isEqualToString: @"Contacts"])
        obj = [self privateContacts: _key inContext: _ctx];
//       else if ([_key isEqualToString: @"Groups"])
//         obj = [self groupsFolder: _key inContext: _ctx];
      else if ([_key isEqualToString: @"Mail"]
	       && [currentUser canAccessModule: _key])
        obj = [self mailAccountsFolder: _key inContext: _ctx];
      else if ([_key isEqualToString: @"Preferences"])
        obj = [$(@"SOGoPreferencesFolder") objectWithName: _key
		inContainer: self];
      else if ([_key isEqualToString: @"freebusy.ifb"])
        obj = [self freeBusyObject:_key inContext: _ctx];
      else
        obj = [NSException exceptionWithHTTPStatus: 404 /* Not Found */];
    }

  return obj;
}

// /* FIXME: here is a vault of hackish ways to gain access to subobjects by
//    granting ro access to the homepage depending on the subobject in question.
//    This is wrong and dangerous. */
// - (NSString *) roleOfUser: (NSString *) uid
//                 inContext: (WOContext *) context
// {
//   NSArray *roles, *traversalPath;
//   NSString *objectName, *role;

//   role = nil;
//   traversalPath = [context objectForKey: @"SoRequestTraversalPath"];
//   if ([traversalPath count] > 1)
//     {
//       objectName = [traversalPath objectAtIndex: 1];
//       if ([objectName isEqualToString: @"Calendar"]
//           || [objectName isEqualToString: @"Contacts"])
//         {
//           roles = [[context activeUser]
//                     rolesForObject: [self lookupName: objectName
//                                           inContext: context
//                                           acquire: NO]
//                     inContext: context];
//           if ([roles containsObject: SOGoRole_Assistant]
//               || [roles containsObject: SOGoRole_Delegate])
//             role = SOGoRole_Assistant;
//         }
//       else if ([objectName isEqualToString: @"freebusy.ifb"])
//         role = SOGoRole_Assistant;
//     }

//   return role;
// }

/* WebDAV */

- (NSArray *) fetchContentObjectNames
{
  static NSArray *cos = nil;
  
  if (!cos)
    cos = [[NSArray alloc] initWithObjects: @"freebusy.ifb", nil];

  return cos;
}

- (BOOL) davIsCollection
{
  return YES;
}

// /* CalDAV support */
// - (NSArray *) davCalendarHomeSet
// {
//   /*
//     <C:calendar-home-set xmlns:D="DAV:"
//         xmlns:C="urn:ietf:params:xml:ns:caldav">
//       <D:href>http://cal.example.com/home/bernard/calendars/</D:href>
//     </C:calendar-home-set>

//     Note: this is the *container* for calendar collections, not the
//           collections itself. So for use its the home folder, the
// 	  public folder and the groups folder.
//   */
//   NSArray *tag;
//   SOGoAppointmentFolders *parent;

//   parent = [self privateCalendars: @"Calendar" inContext: context];
//   tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
//                  [parent davURL], nil];

//   return [NSArray arrayWithObject: tag];
// }

// - (NSArray *) davCalendarUserAddressSet
// {
//   NSArray *tag, *allEmails;
//   NSMutableArray *addresses;
//   NSEnumerator *emails;
//   NSString *currentEmail;

//   addresses = [NSMutableArray array];

//   allEmails = [[context activeUser] allEmails];
//   emails = [allEmails objectEnumerator];
//   while ((currentEmail = [emails nextObject]))
//     {
//       tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
// 		     [NSString stringWithFormat: @"MAILTO:%@", currentEmail],
// 		     nil];
//       [addresses addObject: tag];
//     }

//   return addresses;
// }

// - (NSArray *) davCalendarScheduleInboxURL
// {
//   NSArray *tag;
//   SOGoAppointmentFolders *parent;

//   parent = [self privateCalendars: @"Calendar" inContext: context];
//   tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
//                  [NSString stringWithFormat: @"%@personal/", [parent davURL]],
// 		 nil];

//   return [NSArray arrayWithObject: tag];
// }

// - (NSString *) davCalendarScheduleOutboxURL
// {
//   NSArray *tag;
//   SOGoAppointmentFolders *parent;

//   parent = [self privateCalendars: @"Calendar" inContext: context];
//   tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
//                  [NSString stringWithFormat: @"%@personal/", [parent davURL]],
// 		 nil];

//   return [NSArray arrayWithObject: tag];
// }

// - (NSString *) davDropboxHomeURL
// {
//   NSArray *tag;
//   SOGoAppointmentFolders *parent;

//   parent = [self privateCalendars: @"Calendar" inContext: context];
//   tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
//                  [NSString stringWithFormat: @"%@personal/", [parent davURL]],
// 		 nil];

//   return [NSArray arrayWithObject: tag];
// }

// - (NSString *) davNotificationsURL
// {
//   NSArray *tag;
//   SOGoAppointmentFolders *parent;

//   parent = [self privateCalendars: @"Calendar" inContext: context];
//   tag = [NSArray arrayWithObjects: @"href", @"DAV:", @"D",
//                  [NSString stringWithFormat: @"%@personal/", [parent davURL]],
// 		 nil];

//   return [NSArray arrayWithObject: tag];
// }

@end /* SOGoUserFolder */