root/apps/iphone/superbook/trunk/Classes/FriendsData.m @ 442

//
//  FriendsData.m
//  LocateThem
//
//  Created by Henri Asseily on 8/15/08.
/*
 Copyright (c) 2008-2009, Telnic Ltd. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
 Redistributions of source code must retain the above copyright notice, this list of conditions
 and the following disclaimer. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the documentation and/or other
 materials provided with the distribution.
 Neither the name of the Telnic Ltd. nor the names of its contributors may be used to endorse or
 promote products derived from this software without specific prior written permission.
 THIS DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
//

#import "FriendsData.h"

static FriendsData *sharedFriendsData = nil;

@interface FriendsData (PrivateMethods)

void abChanged (ABAddressBookRef addressBook,
                                CFDictionaryRef info,
                                void *context);

@end

@implementation FriendsData

@synthesize delegate;
@synthesize sectionNames;
@synthesize prefsUnitKm;
@synthesize prefsSorting;
@synthesize lastFriendsUpdate;
@synthesize peopleCurrentList;
@synthesize peopleNewList;
@synthesize sortedPeopleArray;

- (id) init {
        self = [super init];
        noLoc = [[[CLLocation alloc] initWithLatitude:0 longitude:0] retain];
        self.sectionNames = [NSArray arrayWithObjects:@"Friends with .tel", nil];
        self.peopleCurrentList = [NSMutableDictionary dictionary];
        self.peopleNewList = [NSMutableDictionary dictionary];
        [self refreshPreferences];
        book = ABAddressBookCreate();
        ABAddressBookRegisterExternalChangeCallback(book, abChanged, self);
        return self;
}

- (void)refreshPreferences {
        // get user preferences
        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
        self.prefsUnitKm = [defaults integerForKey:@"unitsPreference"];
        self.prefsSorting = [defaults integerForKey:@"sortingPreference"];
}

- (void)loadFriendsDataFromAB:(ABAddressBookRef)aBook {
        ABAddressBookRef theBook = ABAddressBookCreate();       // Override the incoming ab because it's not thread safe
        if (self != nil) {
                if (!theBook) {
                        NSLog(@"Error opening address book");
                        if (self.delegate)
                                [self.delegate friendsDataDidLoad];
                        return;
                }
                ABRecordRef *selectedGroup = NULL;

                // The below code allows to filter people by a selected chosen group
                // We disable it for now, and maybe enable it when we allow the user to
                // choose which group he wants to filter by
                // TODO: allow filter by group, managed in preferences
//              CFArrayRef allGroups = ABAddressBookCopyArrayOfAllGroups(theBook);
//              CFIndex nGroups = ABAddressBookGetGroupCount(theBook);
//              ABRecordRef *aGroup;
//              for (int i=0;i < nGroups;i++) {
//                      aGroup = (ABRecordRef *)CFArrayGetValueAtIndex(allGroups,i);
//                      NSString* gName = (NSString *)ABRecordCopyValue(aGroup, kABGroupNameProperty);
//                      if ([gName isEqualToString:@"TelFriends"]) {
//                              [gName release];
//                              selectedGroup = aGroup;
//                              break;
//                      }
//                      [gName release];
//              }
                
                // Find everyone with a .tel and add them to peopleCurrentList
                CFArrayRef allPeople;
                CFIndex nPeople = 0;
                if (selectedGroup != NULL) {
                        allPeople = ABGroupCopyArrayOfAllMembers(selectedGroup);
                        if (allPeople)
                                nPeople = CFArrayGetCount(allPeople);
                } else {
                        allPeople = ABAddressBookCopyArrayOfAllPeople(theBook);
                        if (allPeople)
                                nPeople = ABAddressBookGetPersonCount(theBook);
                }
                ABRecordRef *aPerson;
                
                for (int i=0;i < nPeople;i++) {
                        aPerson = (ABRecordRef *)CFArrayGetValueAtIndex(allPeople,i);
                        
                        NSNumber *aPersonId = [NSNumber numberWithInt:(int)ABRecordGetRecordID(aPerson)];
                        NSString *theTel = [self getTelForABRecordId:aPersonId withABRecordRef:aPerson];
                        if (theTel) {
                                // the people list has for each personid: name, type of status, location, location timestamp, distance from user and telname
                                NSString *compName = [(NSString *)ABRecordCopyCompositeName(aPerson) autorelease];
                                if (!compName) {
                                        compName = theTel;
                                }
                                NSArray *personInfoRow = [NSArray arrayWithObjects:compName,
                                                                                  [NSNumber numberWithInt:FriendsDataSectionStatusUnknown],
                                                                                  noLoc, 
                                                                                  [NSDate date], 
                                                                                  [NSNumber numberWithInt:0], 
                                                                                  theTel,
                                                                                  nil];
                                
                                [peopleCurrentList setObject:personInfoRow forKey:aPersonId];
                        };
                        CFRelease(aPerson);
                }
                
                if (allPeople)
                        CFRelease(allPeople);
//              if (allGroups)
//                      CFRelease(allGroups);
                
                if (prefsSorting == 0) {        // alpha sorting on composite name
                        self.sortedPeopleArray = [peopleCurrentList keysSortedByValueUsingSelector:@selector(compositeNameSortAlgorithm:)];
                } else if (prefsSorting == 1) { // distance sorting
                        self.sortedPeopleArray = [peopleCurrentList keysSortedByValueUsingSelector:@selector(distanceSortAlgorithm:)];
                }
        }
        if (self.delegate)
                [self.delegate friendsDataDidLoad];

        return;
}

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView {

        return [self.sectionNames count];
}

- (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section {
        return nil;             // No title
        //return ([NSString stringWithString:[sectionNames objectAtIndex:section]]);
}

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {

        return [peopleCurrentList count];
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {

        
        static NSString *MyIdentifier = @"FriendsTableViewCellIdentifier";
        
        FriendsTableViewCell *cell = (FriendsTableViewCell *)[tableView dequeueReusableCellWithIdentifier:MyIdentifier];
        if (cell == nil) {
                NSArray *friendsTableViewCellNib = [[NSBundle mainBundle] loadNibNamed:@"FriendsTableViewCell" owner:self options:nil];
                cell = (FriendsTableViewCell *)[friendsTableViewCellNib objectAtIndex:0];
        }
        // Configure the cell
        
        NSNumber *thePersonId = [sortedPeopleArray objectAtIndex:indexPath.row];
//      ABRecordRef thePerson = ABAddressBookGetPersonWithRecordID(book, (ABRecordID)[thePersonId intValue]);
        NSArray *thePersonInfo = [peopleCurrentList objectForKey:thePersonId];
        
        NSString *labelCellDistanceTitle;

        if (self.prefsUnitKm == 1) {
                cell.labelCellUnit.text = LocStr(@"km");
        } else {
                cell.labelCellUnit.text = LocStr(@"mi");
        }               
        
        if ([[thePersonInfo objectAtIndex:1] intValue] == 2) { // unknown if there's a LOC (not yet queried)
                labelCellDistanceTitle = @"";
                cell.labelCellUnit.text = @"";
        } else if ([[thePersonInfo objectAtIndex:1] intValue] == 1) { // there is no LOC
                labelCellDistanceTitle = [NSString stringWithString:@"-"];
        } else { // there's a location
//              CLLocation *personLoc = [thePersonInfo objectAtIndex:2];
//              NSLog(@"Person location: %@", [personLoc description]);
                
                NSInteger distanceInUnits;
                if (self.prefsUnitKm == 1) {
                        distanceInUnits = [[thePersonInfo objectAtIndex:4] intValue] / 1000;
                } else {
                        distanceInUnits = [[thePersonInfo objectAtIndex:4] intValue] / 1609;
                }
                labelCellDistanceTitle = [NSString stringWithFormat:@"%d", distanceInUnits];
        }
        
        cell.labelCellName.text = [thePersonInfo objectAtIndex:0];
//      cell.labelCellName.text = [NSString stringWithFormat:@"%@ %@", (NSString *)ABRecordCopyValue(thePerson, kABPersonFirstNameProperty),
//                                                         (NSString *)ABRecordCopyValue(thePerson, kABPersonLastNameProperty)];
        cell.labelCellTel.text = [thePersonInfo objectAtIndex:5];
        cell.labelCellDistance.text = labelCellDistanceTitle;

        return cell;
}


// Method that flips the current data set with the newly gotten dataset
// Synchronize to tell everyone it's being updated
- (void)updateDataSet {

        [peopleCurrentList setDictionary:peopleNewList];
        [peopleNewList removeAllObjects];
        if (prefsSorting == 0) {        // alpha sorting on composite name
                self.sortedPeopleArray = [peopleCurrentList keysSortedByValueUsingSelector:@selector(compositeNameSortAlgorithm:)];
        } else if (prefsSorting == 1) { // distance sorting
                self.sortedPeopleArray = [peopleCurrentList keysSortedByValueUsingSelector:@selector(distanceSortAlgorithm:)];
        }
        return;
}

- (NSString *)makeKmlFromData {

        NSString *kmlLineFormat =       @"<Placemark>"
                                                                @"<name>%@</name>"
                                                                @"<Point><coordinates>%f,%f,0</coordinates></Point>"
                                                                @"</Placemark>";
        NSMutableString *kml = [[[NSMutableString alloc] initWithString:
                                                        @"<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
                                                         @"<kml xmlns=\"http://earth.google.com/kml/2.2\">"
                                                         @"<Document>"
                                                         @"<name>Testing Stuff.kml</name>"
                                                        ] autorelease];

        // the people list has for each personid: name, type of status, location, location timestamp, distance from user and telname
        // the sorted people array just has personids
        
        NSNumber *theId;
        NSArray *thePersonInfo;
        for (theId in sortedPeopleArray) {
                thePersonInfo = [peopleCurrentList objectForKey:theId];
                if ([(NSNumber *)[thePersonInfo objectAtIndex:1] intValue] != FriendsDataSectionWithLoc)
                        continue;
                [kml appendFormat:kmlLineFormat,
                                                                                [thePersonInfo objectAtIndex:0],
                                                                                [(CLLocation *)[thePersonInfo objectAtIndex:2] coordinate].longitude,
                                                                                [(CLLocation *)[thePersonInfo objectAtIndex:2] coordinate].latitude
                 ];
        }
        [kml appendString:@"</Document></kml>"];
        return kml;
}

#pragma mark ---- AddressBook change callback method ----

void abChanged (ABAddressBookRef addressBook,
                                CFDictionaryRef info,
                                void *context) {
        if (ABAddressBookHasUnsavedChanges(addressBook)) {
                // Not done saving changes, let's wait
                return;
        }
        // Something changed in the address book
        // Let's get the latest changes and reload
        FriendsData *fd = context;
        [fd loadFriendsDataFromAB:addressBook];
//      [fd performSelectorOnMainThread:@selector(loadFriendsDataFromAB:) withObject:(id)addressBook waitUntilDone:NO];
}


#pragma mark ---- utility methods ----

// Get AddressBook
- (ABAddressBookRef) getAddressBookRef {
        return book;
}

- (NSString *)getNameForABRecordId:(NSNumber *)theId {
        // WARNING: Only exists if person has been retrieved
        NSArray *personInfoRow = [peopleCurrentList objectForKey:theId];
        if (personInfoRow) {
                return [personInfoRow objectAtIndex:0];
        }
        return nil;
}
        
// Get ABRecordId for an Index Path
- (NSNumber *) getABRecordIdForIndexPath:(NSIndexPath *)indexPath {

        NSNumber *thePersonId = [sortedPeopleArray objectAtIndex:indexPath.row];
        return thePersonId;
}

// Get ABRecordId for a specific .tel
- (NSNumber *) getABRecordIdForTel:(NSString *)telname {
        if (telname == NULL)
                return [NSNumber numberWithInt:kABRecordInvalidID];
        // the people list has for each personid: name, type of status, location, location timestamp, distance from user and telname
        // the sorted people array just has personids
        
        NSNumber *theId;
        NSArray *thePersonInfo;
        for (theId in sortedPeopleArray) {
                thePersonInfo = [peopleCurrentList objectForKey:theId];
                if ([(NSString *)[thePersonInfo objectAtIndex:5] isEqualToString:telname]) {
                        return theId;
                }
        }
        // Couldn't find a match
        return [NSNumber numberWithInt:kABRecordInvalidID];
}

// Get ABRecordRef for an ID
- (ABRecordRef) getABRecordRefForABRecordId:(NSNumber *)theId withAddressBook:(ABRecordRef)theBook {

        ABRecordRef recordRef;
        recordRef = ABAddressBookGetPersonWithRecordID(theBook, (ABRecordID)[theId intValue]);
        return recordRef;
}

// Get .tel value for a record: the first url that ends with .tel
- (NSString *) getTelForABRecordId:(NSNumber *)theId withABRecordRef:(ABRecordRef)recordRef {

        // First see if we've already cached the info
        NSArray *personInfoRow = [peopleCurrentList objectForKey:theId];
        if (personInfoRow != nil)
                return [personInfoRow objectAtIndex:5];

        BOOL shouldRelease = NO;
        if (!recordRef) {
                shouldRelease = YES;
                recordRef = ABAddressBookGetPersonWithRecordID(book, (ABRecordID)[theId intValue]);
        }
        CFStringRef telUrl;
        BOOL foundUrl = NO;
        
        ABMultiValueRef allUrls = ABRecordCopyValue(recordRef, kABPersonURLProperty);
        
        for (CFIndex j = 0; j < ABMultiValueGetCount(allUrls); j++) {
                telUrl = ABMultiValueCopyValueAtIndex(allUrls, j);
                if ([(NSString *)telUrl hasSuffix:@".tel"]) {
                        foundUrl = YES;
                        break;
                }
                if ([(NSString *)telUrl hasSuffix:@".tel/"]) {
                        foundUrl = YES;
                        break;
                }
                CFRelease(telUrl);
        }
//      for (CFIndex j = 0; j < ABMultiValueGetCount(allUrls); j++) {
//              ABMultiValueRemoveValueAndLabelAtIndex(allUrls, j);
//      }
        CFRelease(allUrls);

        
        if (shouldRelease) {
                CFRelease(recordRef);
        }
        if (foundUrl) {
                NSString *returnedTelUrl = [NSString stringWithString:(NSString *)telUrl];
                CFRelease(telUrl);
                return returnedTelUrl;
        }
        
        return nil;
}

// Get .tel ABMultiValue index for a record
// given any url that ends with .tel
- (NSInteger) getTelIndexForABRecordId:(NSNumber *)theId withABRecordRef:(ABRecordRef)recordRef {
        
        
        BOOL shouldRelease = NO;
        if (!recordRef) {
                shouldRelease = YES;
                recordRef = ABAddressBookGetPersonWithRecordID(book, (ABRecordID)[theId intValue]);
        }
        CFStringRef telUrlValue;
        ABMultiValueRef allUrls = ABRecordCopyValue(recordRef, kABPersonURLProperty);
        NSInteger telIndex = -1; //  Return value for nonexistent
        
        for (CFIndex j = 0; j < ABMultiValueGetCount(allUrls); j++) {
                telUrlValue = ABMultiValueCopyValueAtIndex(allUrls, j);
                if ([(NSString *)telUrlValue hasSuffix:@".tel"] || [(NSString *)telUrlValue hasSuffix:@".tel/"]) {
                        CFRelease(telUrlValue);
                        telIndex = (NSInteger)j;
                        break;
                }
                CFRelease(telUrlValue);
        }
        CFRelease(allUrls);
        if (shouldRelease) {
                CFRelease(recordRef);
        }
        return telIndex;
}

#pragma mark ---- singleton object methods ----

// See "Creating a Singleton Instance" in the Cocoa Fundamentals Guide for more info

+ (FriendsData *)sharedInstance {
    @synchronized(self) {
        if (sharedFriendsData == nil) {
            [[self alloc] init]; // assignment not done here
        }
    }
    return sharedFriendsData;
}

+ (id)allocWithZone:(NSZone *)zone {
    @synchronized(self) {
        if (sharedFriendsData == nil) {
            sharedFriendsData = [super allocWithZone:zone];
            return sharedFriendsData;  // assignment and return on first allocation
        }
    }
    return nil; // on subsequent allocation attempts return nil
}

- (id)copyWithZone:(NSZone *)zone
{
    return self;
}

- (id)retain {
    return self;
}

- (unsigned)retainCount {
    return UINT_MAX;  // denotes an object that cannot be released
}

- (void)release {
    // do nothing
}

- (id)autorelease {
    return self;
}

- (void)dealloc {
        CFRelease(book);
        [super dealloc];
}

@end