LupusNobilis
/
sogo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Monotone-Parent: 480d39a8c4def3358ca87a844e455c2ffe987f5f 

Monotone-Revision: 653a47a63f4f9fb59c7e85515dd7937dbaa2b23e

Monotone-Author: wsourdeau@inverse.ca
Monotone-Date: 2009-06-02T16:23:32
Monotone-Branch: ca.inverse.sogo
maint-2.0.2
Wolfgang Sourdeau 2009-06-02 16:23:32 +00:00
parent f7ce31f7cb
commit 1f0b289ef7
5 changed files with 712 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ChangeLog
View File

@ -1,3 +1,11 @@
2009-06-02 Wolfgang Sourdeau <wsourdeau@inverse.ca>
* Tools/sogo-contacts-removedoubles.m: new maintenance utility
that removes double records in specified addressbooks.
* Tools/sogo-contacts-checkdoubles.m: new maintenance utility that
helps determine which contact folders need cleanup.
2009-06-02 Cyril Robert <crobert@inverse.ca>
* SoObjects/Appointments/SOGoAppointmentFolder.m (_enforceTimeLimitOnFilter):

21
Tools/GNUmakefile 100644
View File

@ -0,0 +1,21 @@
# GNUstep makefile
include ../config.make
include $(GNUSTEP_MAKEFILES)/common.make
include ../Version
SOGO_CHECKDOUBLES = sogo-contacts-checkdoubles
$(SOGO_CHECKDOUBLES)_INSTALL_DIR = $(SOGO_ADMIN_TOOLS)
$(SOGO_CHECKDOUBLES)_OBJC_FILES += \
sogo-contacts-checkdoubles.m
SOGO_REMOVEDOUBLES = sogo-contacts-removedoubles
$(SOGO_REMOVEDOUBLES)_INSTALL_DIR = $(SOGO_ADMIN_TOOLS)
$(SOGO_REMOVEDOUBLES)_OBJC_FILES += \
sogo-contacts-removedoubles.m
TOOL_NAME = $(SOGO_CHECKDOUBLES) $(SOGO_REMOVEDOUBLES)
-include GNUmakefile.preamble
include $(GNUSTEP_MAKEFILES)/tool.make
-include GNUmakefile.postamble

20
Tools/GNUmakefile.preamble 100644
View File

@ -0,0 +1,20 @@
# compile settings
ADDITIONAL_CPPFLAGS += \
-DSOGO_MAJOR_VERSION=$(MAJOR_VERSION) \
-DSOGO_MINOR_VERSION=$(MINOR_VERSION) \
-DSOGO_SUBMINOR_VERSION=$(SUBMINOR_VERSION) \
-DSOGO_LIBDIR="\"$(SOGO_LIBDIR)\""
ADDITIONAL_INCLUDE_DIRS += \
-I../SOPE/ -D_GNU_SOURCE
ADDITIONAL_LIB_DIRS += \
-L../SOPE/GDLContentStore/$(GNUSTEP_OBJ_DIR)/ -lGDLContentStore
SYSTEM_LIB_DIR += -L/usr/local/lib -L/usr/lib
$(SOGOD)_TOOL_LIBS += \
-lGDLContentStore \
-lGDLAccess \
-lNGExtensions

187
Tools/sogo-contacts-checkdoubles.m 100644
View File

@ -0,0 +1,187 @@
/* sogo-ab-checkdoubles.m - this file is part of SOGo
*
* Copyright (C) 2009 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 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.
*/
/* TODO:
- NSUserDefaults bootstrapping for using different backends
- make sure we don't end up using 3000 different channels because of the
amount of tables we need to wander */
#import <Foundation/NSAutoreleasePool.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSException.h>
#import <Foundation/NSObject.h>
#import <Foundation/NSString.h>
#import <Foundation/NSUserDefaults.h>
#import <Foundation/NSValue.h>
#import <GDLAccess/EOAdaptorChannel.h>
#import <GDLContentStore/GCSChannelManager.h>
#import <GDLContentStore/GCSFolderManager.h>
#import <GDLContentStore/GCSFolder.h>
typedef void (*NSUserDefaultsInitFunction) ();
static unsigned int ContactsCountWarningLimit = 1000;
static void
NSLogInhibitor (NSString *message)
{
}
@interface SOGoDoublesChecker : NSObject
- (BOOL) run;
@end
@implementation SOGoDoublesChecker
+ (void) initialize
{
NSUserDefaults *ud;
NSNumber *warningLimit;
_NSLog_printf_handler = NSLogInhibitor;
ud = [NSUserDefaults standardUserDefaults];
[ud addSuiteNamed: @"sogod"];
warningLimit = [ud objectForKey: @"SOGoContactsCountWarningLimit"];
if (warningLimit)
ContactsCountWarningLimit = [warningLimit unsignedIntValue];
fprintf (stderr, "The warning limit for folder records is set at %u\n",
ContactsCountWarningLimit);
}
- (void) processIndexResults: (EOAdaptorChannel *) channel
withFoM: (GCSFolderManager *) fom
{
NSArray *attrs;
NSDictionary *folderRow;
GCSFolder *currentFolder;
NSString *folderPath;
unsigned int recordsCount;
attrs = [channel describeResults: NO];
while ((folderRow = [channel fetchAttributes: attrs withZone: NULL]))
{
folderPath = [folderRow objectForKey: @"c_path"];
currentFolder = [fom folderAtPath: folderPath];
if (currentFolder)
{
recordsCount = [currentFolder recordsCountByExcludingDeleted: YES];
if (recordsCount > ContactsCountWarningLimit)
{
fprintf (stderr, "'%s' (id: '%s'), of '%s': %u entries\n",
[[folderRow objectForKey: @"c_foldername"]
cStringUsingEncoding: NSUTF8StringEncoding],
[[currentFolder folderName]
cStringUsingEncoding: NSUTF8StringEncoding],
[[folderRow objectForKey: @"c_path2"]
cStringUsingEncoding: NSUTF8StringEncoding],
recordsCount);
}
}
else
fprintf (stderr, "folder at path '%s' could not be opened\n",
[folderPath cStringUsingEncoding: NSUTF8StringEncoding]);
}
}
- (BOOL) processWithFoM: (GCSFolderManager *) fom
{
BOOL rc;
NSString *sqlString;
GCSChannelManager *cm;
EOAdaptorChannel *channel;
NSException *ex;
cm = [GCSChannelManager defaultChannelManager];
channel = [cm acquireOpenChannelForURL: [fom folderInfoLocation]];
if (channel)
{
sqlString = [NSString stringWithFormat: @"SELECT c_path, c_path2, c_foldername"
@" FROM %@"
@" WHERE c_folder_type = 'Contact'",
[fom folderInfoTableName]];
ex = [channel evaluateExpressionX: sqlString];
if (ex)
{
fprintf (stderr, "an exception occured during the fetching of folder names");
[ex raise];
rc = NO;
}
else
{
rc = YES;
[self processIndexResults: channel withFoM: fom];
}
[cm releaseChannel: channel];
}
else
{
fprintf (stderr, "could not open channel");
rc = NO;
}
return rc;
}
- (BOOL) run
{
GCSFolderManager *fom;
BOOL rc;
fom = [GCSFolderManager defaultFolderManager];
if (fom)
rc = [self processWithFoM: fom];
else
rc = NO;
return rc;
}
@end
int
main (int argc, char **argv, char **env)
{
NSAutoreleasePool *pool;
SOGoDoublesChecker *checker;
int rc;
rc = 0;
pool = [NSAutoreleasePool new];
checker = [SOGoDoublesChecker new];
if ([checker run])
rc = 0;
else
rc = -1;
[checker release];
[pool release];
return rc;
}

476
Tools/sogo-contacts-removedoubles.m 100644
View File

@ -0,0 +1,476 @@
/* sogo-ab-removedoubles.m - this file is part of SOGo
*
* Copyright (C) 2009 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 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.
*/
/* TODO: NSUserDefaults bootstrapping for using different backends */
#include <stdio.h>
#import <Foundation/NSArray.h>
#import <Foundation/NSAutoreleasePool.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSEnumerator.h>
#import <Foundation/NSException.h>
#import <Foundation/NSObject.h>
#import <Foundation/NSString.h>
#import <Foundation/NSUserDefaults.h>
#import <Foundation/NSValue.h>
#import <GDLAccess/EOAdaptorChannel.h>
#import <GDLAccess/EOAdaptorContext.h>
#import <GDLContentStore/GCSChannelManager.h>
#import <GDLContentStore/GCSFolderManager.h>
#import <GDLContentStore/GCSFolder.h>
typedef void (*NSUserDefaultsInitFunction) ();
static unsigned int ContactsCountWarningLimit = 1000;
@interface SOGoDoublesRemover : NSObject
@end
@implementation SOGoDoublesRemover
+ (void) initialize
{
NSUserDefaults *ud;
NSNumber *warningLimit;
ud = [NSUserDefaults standardUserDefaults];
[ud addSuiteNamed: @"sogod"];
warningLimit = [ud objectForKey: @"SOGoContactsCountWarningLimit"];
if (warningLimit)
ContactsCountWarningLimit = [warningLimit unsignedIntValue];
NSLog (@"The warning limit for folder records is set at %u",
ContactsCountWarningLimit);
}
- (void) feedDoubleEmails: (NSMutableDictionary *) doubleEmails
withRecord: (NSDictionary *) record
{
NSString *recordEmail;
NSMutableArray *recordList;
/* we want to match c_mail case-insensitively */
recordEmail = [[record objectForKey: @"c_mail"] uppercaseString];
if ([recordEmail length])
{
recordList = [doubleEmails objectForKey: recordEmail];
if (!recordList)
{
recordList = [NSMutableArray arrayWithCapacity: 5];
[doubleEmails setObject: recordList forKey: recordEmail];
}
[recordList addObject: record];
}
}
- (void) cleanupSingleRecords: (NSMutableDictionary *) doubleEmails
{
NSEnumerator *keys;
NSString *currentKey;
keys = [[doubleEmails allKeys] objectEnumerator];
while ((currentKey = [keys nextObject]))
{
if ([[doubleEmails objectForKey: currentKey] count] < 2)
[doubleEmails removeObjectForKey: currentKey];
}
}
- (NSDictionary *) detectDoubleEmailsFromRecords: (NSArray *) records
{
NSMutableDictionary *doubleEmails;
unsigned int count, max;
doubleEmails = [NSMutableDictionary dictionaryWithCapacity: [records count]];
max = [records count];
for (count = 0; count < max; count++)
[self feedDoubleEmails: doubleEmails
withRecord: [records objectAtIndex: count]];
[self cleanupSingleRecords: doubleEmails];
return doubleEmails;
}
- (void) removeRecord: (NSString *) recordName
fromTable: (NSString *) tableName
andQuickTable: (NSString *) quickTableName
usingChannel: (EOAdaptorChannel *) channel
{
NSString *delSql;
/* We remove the records without regards to c_deleted because we really want
to recover table space. */
delSql = [NSString stringWithFormat: @"DELETE FROM %@"
@" WHERE c_name = '%@'",
tableName, recordName];
[channel evaluateExpressionX: delSql];
delSql = [NSString stringWithFormat: @"DELETE FROM %@"
@" WHERE c_name = '%@'",
quickTableName, recordName];
[channel evaluateExpressionX: delSql];
}
- (void) removeRecords: (NSArray *) recordNames
fromFolder: (GCSFolder *) folder
{
EOAdaptorChannel *channel;
EOAdaptorContext *context;
NSString *tableName, *quickTableName, *currentRecordName;
NSEnumerator *recordsEnum;
channel = [folder acquireStoreChannel];
context = [channel adaptorContext];
[context beginTransaction];
tableName = [folder storeTableName];
quickTableName = [folder quickTableName];
recordsEnum = [recordNames objectEnumerator];
while ((currentRecordName = [recordsEnum nextObject]))
[self removeRecord: currentRecordName
fromTable: tableName andQuickTable: quickTableName
usingChannel: channel];
fprintf (stderr, "Removing %d records...\n", [recordNames count]);
[context commitTransaction];
[folder releaseChannel: channel];
}
- (NSArray *) namesOfRecords: (NSArray *) records
differentFrom: (unsigned int) keptRecord
count: (unsigned int) max
{
NSMutableArray *recordsToRemove;
NSDictionary *currentRecord;
unsigned int count;
recordsToRemove = [NSMutableArray arrayWithCapacity: (max - 1)];
for (count = 0; count < max; count++)
{
if (count != keptRecord)
{
currentRecord = [records objectAtIndex: count];
[recordsToRemove
addObject: [currentRecord objectForKey: @"c_name"]];
}
}
return recordsToRemove;
}
- (NSArray *) records: (NSArray *) records
withLowestScores: (unsigned int *) scores
count: (unsigned int) max
{
unsigned int count, highestScore;
int highestScoreRecord;
highestScore = 0;
highestScoreRecord = -1;
for (count = 0; count < max; count++)
{
if (scores[count] > highestScore)
{
highestScore = scores[count];
highestScoreRecord = count;
}
}
if (highestScoreRecord == -1)
highestScoreRecord = 0;
return [self namesOfRecords: records
differentFrom: highestScoreRecord
count: max];
}
- (unsigned int) mostModifiedRecord: (NSArray *) records
count: (unsigned int) max
{
unsigned int mostModified, count, highestVersion, version;
NSNumber *currentVersion;
mostModified = 0;
highestVersion = 0;
for (count = 0; count < max; count++)
{
currentVersion
= [[records objectAtIndex: count] objectForKey: @"c_version"];
version = [currentVersion intValue];
if (version > highestVersion)
{
mostModified = count;
highestVersion = version;
}
}
return mostModified;
}
- (unsigned int) amountOfFilledQuickFields: (NSDictionary *) record
{
static NSArray *quickFields = nil;
id value;
unsigned int amount, count, max;
amount = 0;
if (!quickFields)
{
quickFields = [NSArray arrayWithObjects: @"c_givenname", @"c_cn",
@"c_sn", @"c_screenname", @"c_l", @"c_mail",
@"c_o", @"c_ou", @"c_telephoneNumber", nil];
[quickFields retain];
}
max = [quickFields count];
for (count = 0; count < max; count++)
{
value = [record objectForKey: [quickFields objectAtIndex: count]];
if ([value isKindOfClass: [NSString class]])
{
if ([value length])
amount++;
}
else if ([value isKindOfClass: [NSNumber class]])
amount++;
}
return amount;
}
- (unsigned int) recordWithTheMostQuickFields: (NSArray *) records
count: (unsigned int) max
{
unsigned int mostQuickFields, count, highestQFields, currentQFields;
mostQuickFields = 0;
highestQFields = 0;
for (count = 0; count < max; count++)
{
currentQFields
= [self amountOfFilledQuickFields: [records objectAtIndex: count]];
if (currentQFields > highestQFields)
{
mostQuickFields = count;
highestQFields = currentQFields;
}
}
return mostQuickFields;
}
- (unsigned int) linesInContent: (NSString *) content
{
unsigned int nbrLines;
NSArray *lines;
lines = [content componentsSeparatedByString: @"\n"];
nbrLines = [lines count];
/* sometimes the end line will finish with a CRLF, we fix this */
if (![[lines objectAtIndex: nbrLines - 1] length])
nbrLines--;
return nbrLines;
}
- (unsigned int) mostCompleteRecord: (NSArray *) records
count: (unsigned int) max
{
unsigned int mostComplete, count, highestLines, lines;
NSString *content;
mostComplete = 0;
highestLines = 0;
for (count = 0; count < max; count++)
{
content = [[records objectAtIndex: count] objectForKey: @"c_content"];
lines = [self linesInContent: content];
if (lines > highestLines)
{
mostComplete = count;
highestLines = lines;
}
}
return mostComplete;
}
- (void) assignScores: (unsigned int *) scores
toRecords: (NSArray *) records
count: (unsigned int) max
{
unsigned int recordIndex;
recordIndex = [self mostModifiedRecord: records count: max];
(*(scores + recordIndex))++;
recordIndex = [self mostCompleteRecord: records count: max];
(*(scores + recordIndex)) += 2;
recordIndex = [self recordWithTheMostQuickFields: records count: max];
(*(scores + recordIndex)) += 3;
}
- (NSArray *) detectRecordsToRemove: (NSDictionary *) records
{
NSMutableArray *recordsToRemove;
NSEnumerator *recordsEnum;
NSArray *currentRecords;
unsigned int *scores, max;
recordsToRemove = [NSMutableArray arrayWithCapacity: [records count] * 4];
recordsEnum = [[records allValues] objectEnumerator];
while ((currentRecords = [recordsEnum nextObject]))
{
max = [currentRecords count];
scores = NSZoneCalloc (NULL, max, sizeof (unsigned int));
[self assignScores: scores toRecords: currentRecords count: max];
[recordsToRemove addObjectsFromArray: [self records: currentRecords
withLowestScores: scores
count: max]];
NSZoneFree (NULL, scores);
}
return recordsToRemove;
}
- (BOOL) removeDoublesFromFolder: (GCSFolder *) folder
{
NSArray *fields, *records, *recordsToRemove;
BOOL rc;
fields = [NSArray arrayWithObjects: @"c_name", @"c_givenname", @"c_cn",
@"c_sn", @"c_screenname", @"c_l", @"c_mail", @"c_o",
@"c_ou", @"c_telephoneNumber", @"c_content", @"c_version",
@"c_creationdate", @"c_lastmodified", nil];
records = [folder fetchFields: fields fetchSpecification: nil];
if (records)
{
rc = YES;
recordsToRemove
= [self detectRecordsToRemove:
[self detectDoubleEmailsFromRecords: records]];
[self removeRecords: recordsToRemove fromFolder: folder];
fprintf (stderr, "Removed %d records from %d.\n",
[recordsToRemove count], [records count]);
}
else
{
fprintf (stderr, "Unable to fetch required fields from folder.\n");
rc = NO;
}
return NO;
}
- (BOOL) processFolder: (NSString *) folderId
ofUser: (NSString *) username
withFoM: (GCSFolderManager *) fom
{
NSString *folderPath;
GCSFolder *folder;
BOOL rc;
folderPath = [NSString stringWithFormat: @"/Users/%@/Contacts/%@",
username, folderId];
folder = [fom folderAtPath: folderPath];
if (folder)
{
rc = [self removeDoublesFromFolder: folder];
}
else
{
fprintf (stderr, "Folder '%s' not found.\n",
[folderId cStringUsingEncoding: NSUTF8StringEncoding]);
rc = NO;
}
return rc;
}
- (BOOL) runWithFolder: (NSString *) folder
andUser: (NSString *) username
{
GCSFolderManager *fom;
BOOL rc;
fom = [GCSFolderManager defaultFolderManager];
if (fom)
rc = [self processFolder: folder ofUser: username
withFoM: fom];
else
rc = NO;
return rc;
}
@end
static void
Usage (const char *name)
{
const char *slash, *start;
slash = strrchr (name, '/');
if (slash)
start = slash + 1;
else
start = name;
fprintf (stderr, "Usage: %s USER FOLDER\n\n"
" USER the owner of the contact folder\n"
" FOLDER the id of the folder to clean up\n",
start);
}
int
main (int argc, char **argv, char **env)
{
NSAutoreleasePool *pool;
SOGoDoublesRemover *remover;
int rc;
rc = -1;
pool = [NSAutoreleasePool new];
if (argc > 2)
{
remover = [SOGoDoublesRemover new];
if ([remover runWithFolder: [NSString stringWithFormat: @"%s", argv[2]]
andUser: [NSString stringWithFormat: @"%s", argv[1]]])
rc = 0;
[remover release];
}
else
Usage (argv[0]);
[pool release];
return rc;
}