amorfo77/sogo
1
0
Fork 0
mirror of https://github.com/inverse-inc/sogo.git synced 2026-07-07 01:15:09 +00:00
Code Issues Projects Releases Wiki Activity

Monotone-Parent: c9b03486e1069d95450f29c6305829cf7d4c2002

Browse Source 
Monotone-Revision: 2c4f13d872f9d09ee3cf1e91a8823779fbc5d923

Monotone-Author: wsourdeau@inverse.ca
Monotone-Date: 2007-05-09T19:06:15
Monotone-Branch: ca.inverse.sogo
This commit is contained in:
Wolfgang Sourdeau
2007-05-09 19:06:15 +00:00
parent bfab3e3a0a
commit 5f52910ce7
3 changed files with 496 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ChangeLog
+7
View File
@@ -1,5 +1,12 @@
2007-05-09 Wolfgang Sourdeau <wsourdeau@inverse.ca>
* SoObjects/SOGo/LDAPSource.[hm]: new class module implementing
the concept of "ldap source", to be used by all the classes
needing access to LDAP-provided information: addressbooks and the
user manager. Most the method thereing are transcriptions of
methods previously found in SOGoContactLDAPFolder. It also contain
utility methods for user matching and authentification.
* SoObjects/Appointments/iCalEntityObject+Agenor.[hm]: removed
module, rendered useless by code refactoring.
SoObjects/SOGo/LDAPSource.h
+71
View File
@@ -0,0 +1,71 @@
/* LDAPSource.h - this file is part of SOGo
*
* Copyright (C) 2007 Inverse groupe conseil
*
* 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 2, 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.
*/
#ifndef LDAPSOURCE_H
#define LDAPSOURCE_H
#import <Foundation/NSObject.h>
@class NSDictionary;
@class NSString;
@class NGLdapConnection;
@interface LDAPSource : NSObject
{
NSString *bindDN;
NSString *hostname;
unsigned int port;
NSString *password;
NSString *baseDN;
NSString *IDField; /* the first part of a user DN */
NSString *CNField;
NSString *UIDField;
NGLdapConnection *ldapConnection;
NSMutableArray *searchAttributes;
}
+ (id) sourceFromUDSource: (NSDictionary *) udSource;
- (id) initFromUDSource: (NSDictionary *) udSource;
- (void) setBindDN: (NSString *) newBindDN
hostname: (NSString *) newBindHostname
port: (NSString *) newBindPort
andPassword: (NSString *) newBindPassword;
- (void) setBaseDN: (NSString *) newBaseDN
IDField: (NSString *) newIDField
CNField: (NSString *) newCNField
andUIDField: (NSString *) newUIDField;
- (BOOL) checkLogin: (NSString *) login
andPassword: (NSString *) password;
- (NSDictionary *) lookupContactEntry: (NSString *) entryID;
- (NSDictionary *) lookupContactEntryWithUIDorEmail: (NSString *) entryID;
- (NSArray *) allEntryIDs;
- (NSArray *) fetchContactsMatching: (NSString *) filter;
@end
#endif /* LDAPSOURCE_H */
SoObjects/SOGo/LDAPSource.m
+418
View File
@@ -0,0 +1,418 @@
/* LDAPSource.m - this file is part of SOGo
*
* Copyright (C) 2007 Inverse groupe conseil
*
* 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 2, 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/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSString.h>
#import <EOControl/EOControl.h>
#import <NGLdap/NGLdapConnection.h>
#import <NGLdap/NGLdapAttribute.h>
#import <NGLdap/NGLdapEntry.h>
#import "LDAPSource.h"
static NSArray *commonSearchFields;
@implementation LDAPSource
+ (void) initialize
{
if (!commonSearchFields)
{
commonSearchFields = [NSArray arrayWithObjects:
@"title",
@"company",
@"o",
@"displayName",
@"modifytimestamp",
@"mozillaHomeState",
@"mozillaHomeUrl",
@"homeurl",
@"st",
@"region",
@"mozillaCustom2",
@"custom2",
@"mozillaHomeCountryName",
@"description",
@"notes",
@"department",
@"departmentnumber",
@"ou",
@"orgunit",
@"mobile",
@"cellphone",
@"carphone",
@"mozillaCustom1",
@"custom1",
@"mozillaNickname",
@"xmozillanickname",
@"mozillaWorkUrl",
@"workurl",
@"fax",
@"facsimileTelephoneNumber",
@"telephoneNumber",
@"mozillaHomeStreet",
@"mozillaSecondEmail",
@"xmozillasecondemail",
@"mozillaCustom4",
@"custom4",
@"nsAIMid",
@"nscpaimscreenname",
@"street",
@"streetAddress",
@"postOfficeBox",
@"homePhone",
@"cn",
@"commonname",
@"givenName",
@"mozillaHomePostalCode",
@"mozillaHomeLocalityName",
@"mozillaWorkStreet2",
@"mozillaUseHtmlMail",
@"xmozillausehtmlmail",
@"mozillaHomeStreet2",
@"postalCode",
@"zip",
@"c",
@"countryname",
@"pager",
@"pagerphone",
@"mail",
@"sn",
@"surname",
@"mozillaCustom3",
@"custom3",
@"l",
@"locality",
@"birthyear",
@"serialNumber",
@"calFBURL",
nil];
[commonSearchFields retain];
}
}
+ (id) sourceFromUDSource: (NSDictionary *) udSource
{
id newSource;
newSource = [[self alloc] initFromUDSource: udSource];
[newSource autorelease];
return newSource;
}
- (id) init
{
if ((self = [super init]))
{
bindDN = nil;
hostname = nil;
port = 389;
password = nil;
baseDN = nil;
IDField = @"cn"; /* the first part of a user DN */
CNField = @"cn";
UIDField = @"uid";
ldapConnection = nil;
searchAttributes = nil;
}
return self;
}
- (void) dealloc
{
[bindDN release];
[hostname release];
[password release];
[baseDN release];
[IDField release];
[CNField release];
[UIDField release];
[ldapConnection release];
[super dealloc];
}
- (id) initFromUDSource: (NSDictionary *) udSource
{
self = [self init];
[self setBindDN: [udSource objectForKey: @"bindDN"]
hostname: [udSource objectForKey: @"hostname"]
port: [udSource objectForKey: @"port"]
andPassword: [udSource objectForKey: @"bindPassword"]];
[self setBaseDN: [udSource objectForKey: @"baseDN"]
IDField: [udSource objectForKey: @"IDFieldName"]
CNField: [udSource objectForKey: @"CNFieldName"]
andUIDField: [udSource objectForKey: @"UIDFieldName"]];
return self;
}
- (void) setBindDN: (NSString *) newBindDN
hostname: (NSString *) newBindHostname
port: (NSString *) newBindPort
andPassword: (NSString *) newBindPassword
{
ASSIGN (bindDN, newBindDN);
ASSIGN (hostname, newBindHostname);
if (newBindPort)
port = [newBindPort intValue];
ASSIGN (password, newBindPassword);
}
- (void) setBaseDN: (NSString *) newBaseDN
IDField: (NSString *) newIDField
CNField: (NSString *) newCNField
andUIDField: (NSString *) newUIDField
{
ASSIGN (baseDN, newBaseDN);
if (newIDField)
ASSIGN (IDField, newIDField);
if (CNField)
ASSIGN (CNField, newCNField);
if (UIDField)
ASSIGN (UIDField, newUIDField);
}
- (void) _initLDAPConnection
{
ldapConnection = [[NGLdapConnection alloc] initWithHostName: hostname
port: port];
[ldapConnection bindWithMethod: @"simple"
binddn: bindDN
credentials: password];
}
/* user management */
- (BOOL) checkLogin: (NSString *) loginToCheck
andPassword: (NSString *) passwordToCheck
{
BOOL didBind;
NSString *userDN;
NGLdapConnection *bindConnection;
bindConnection = [[NGLdapConnection alloc] initWithHostName: hostname
port: port];
userDN = [NSString stringWithFormat: @"%@=%@,%@",
IDField, loginToCheck, baseDN];
NS_DURING
didBind = [bindConnection bindWithMethod: @"simple" binddn: userDN
credentials: passwordToCheck];
NS_HANDLER
didBind = NO;
NS_ENDHANDLER
[bindConnection release];
return didBind;
}
/* contact management */
- (EOQualifier *) _qualifierForFilter: (NSString *) filter
{
NSString *qs;
EOQualifier *qualifier;
if (filter && [filter length] > 0)
{
if ([filter isEqualToString: @"."])
qs = @"(cn='*')";
else
qs = [NSString stringWithFormat:
@"(cn='%@*')"
@"OR (sn='%@*')"
@"OR (displayName='%@*')"
@"OR (mail='%@*')"
@"OR (telephoneNumber='*%@*')",
filter, filter, filter, filter, filter];
qualifier = [EOQualifier qualifierWithQualifierFormat: qs];
}
else
qualifier = nil;
return qualifier;
}
- (EOQualifier *) _qualifierForUIDFilter: (NSString *) uid
{
NSString *qs;
qs = [NSString stringWithFormat: (@"(%@='%@') OR (mail='%@')"
@" OR (mozillaSecondEmail='%@')"
@" OR (xmozillasecondemail='%@')"),
UIDField, uid, uid, uid, uid];
return [EOQualifier qualifierWithQualifierFormat: qs];
}
- (NSArray *) _searchAttributes
{
if (!searchAttributes)
{
searchAttributes = [NSMutableArray new];
if (CNField)
[searchAttributes addObject: CNField];
if (UIDField)
[searchAttributes addObject: UIDField];
[searchAttributes addObjectsFromArray: commonSearchFields];
}
return searchAttributes;
}
- (NSArray *) allEntryIDs
{
NSMutableArray *ids;
NSEnumerator *entries;
NGLdapEntry *currentEntry;
NSString *value;
ids = [NSMutableArray array];
if (!ldapConnection)
[self _initLDAPConnection];
entries = [ldapConnection deepSearchAtBaseDN: baseDN
qualifier: nil
attributes: [NSArray arrayWithObject: IDField]];
if (entries)
{
currentEntry = [entries nextObject];
while (currentEntry)
{
value = [[currentEntry attributeWithName: IDField]
stringValueAtIndex: 0];
if ([value length] > 0)
[ids addObject: value];
currentEntry = [entries nextObject];
}
}
return ids;
}
- (NSDictionary *) _convertLDAPEntryToContact: (NGLdapEntry *) ldapEntry
{
NSMutableDictionary *contactEntry;
NSEnumerator *attributes;
NSString *currentAttribute, *value;
contactEntry = [NSMutableDictionary dictionary];
attributes = [[self _searchAttributes] objectEnumerator];
currentAttribute = [attributes nextObject];
while (currentAttribute)
{
value = [[ldapEntry attributeWithName: currentAttribute]
stringValueAtIndex: 0];
if (value)
[contactEntry setObject: value forKey: currentAttribute];
currentAttribute = [attributes nextObject];
}
value = [[ldapEntry attributeWithName: IDField] stringValueAtIndex: 0];
if (!value)
value = @"";
[contactEntry setObject: value forKey: @"c_name"];
value = [[ldapEntry attributeWithName: UIDField] stringValueAtIndex: 0];
if (!value)
value = @"";
[contactEntry setObject: value forKey: @"c_uid"];
value = [[ldapEntry attributeWithName: CNField] stringValueAtIndex: 0];
if (!value)
value = @"";
[contactEntry setObject: value forKey: @"c_cn"];
return contactEntry;
}
- (NSArray *) fetchContactsMatching: (NSString *) match
{
NSMutableArray *contacts;
NGLdapEntry *currentEntry;
NSEnumerator *entries;
contacts = [NSMutableArray array];
if (!ldapConnection)
[self _initLDAPConnection];
entries = [ldapConnection deepSearchAtBaseDN: baseDN
qualifier: [self _qualifierForFilter: match]
attributes: [self _searchAttributes]];
if (entries)
{
currentEntry = [entries nextObject];
while (currentEntry)
{
[contacts addObject:
[self _convertLDAPEntryToContact: currentEntry]];
currentEntry = [entries nextObject];
}
}
return contacts;
}
- (NSDictionary *) lookupContactEntry: (NSString *) entryID;
{
NSDictionary *contactEntry;
NGLdapEntry *ldapEntry;
if (!ldapConnection)
[self _initLDAPConnection];
ldapEntry
= [ldapConnection entryAtDN: [NSString stringWithFormat: @"%@=%@,%@",
IDField, entryID, baseDN]
attributes: [self _searchAttributes]];
if (ldapEntry)
contactEntry = [self _convertLDAPEntryToContact: ldapEntry];
else
contactEntry = nil;
return contactEntry;
}
- (NSDictionary *) lookupContactEntryWithUIDorEmail: (NSString *) uid;
{
NSDictionary *contactEntry;
NGLdapEntry *ldapEntry;
NSEnumerator *entries;
EOQualifier *qualifier;
if (!ldapConnection)
[self _initLDAPConnection];
qualifier = [self _qualifierForUIDFilter: uid];
entries = [ldapConnection deepSearchAtBaseDN: baseDN
qualifier: qualifier
attributes: [self _searchAttributes]];
ldapEntry = [entries nextObject];
if (ldapEntry)
contactEntry = [self _convertLDAPEntryToContact: ldapEntry];
else
contactEntry = nil;
return contactEntry;
}
@end