Source/CBContactLastSeenPlugin.m

   1 /*
   2  * Adium is the legal property of its developers, whose names are listed in the copyright file included
   3  * with this source distribution.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the License,
   7  * or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  11  * Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  15  */
  16
  17 #import <Adium/AIInterfaceControllerProtocol.h>
  18 #import <Adium/AIPreferenceControllerProtocol.h>
  19 #import "CBContactLastSeenPlugin.h"
  20 #import <AIUtilities/AIDateFormatterAdditions.h>
  21 #import <Adium/AIListObject.h>
  22
  23 #define PREF_GROUP_LAST_SEEN    @"Last Seen"
  24 #define KEY_LAST_SEEN_STATUS    @"Last Seen Status"
  25 #define KEY_LAST_SEEN_DATE              @"Last Seen Date"
  26
  27 @interface CBContactLastSeenPlugin(PRIVATE)
  28 - (void)update:(NSNotification *)notification;
  29 @end
  30
  31 /*!
  32  * @class CBContactLastSeenPlugin
  33  * @brief Component to track and display as a tooltip the last time contacts were seen online
  34  */
  35 @implementation CBContactLastSeenPlugin
  36
  37 /*!
  38  * @brief Install
  39  */
  40 - (void)installPlugin
  41 {
  42     //Install our tooltip entry
  43     [[adium interfaceController] registerContactListTooltipEntry:self secondaryEntry:NO];
  44
  45         //Install our observers
  46         [[adium notificationCenter] addObserver:self
  47                                                                    selector:@selector(statusUpdate:)
  48                                                                            name:CONTACT_SEEN_ONLINE_YES
  49                                                                          object:nil];
  50
  51         [[adium notificationCenter] addObserver:self
  52                                                                    selector:@selector(statusUpdate:)
  53                                                                            name:CONTACT_STATUS_ONLINE_NO
  54                                                                          object:nil];
  55
  56         [[adium notificationCenter] addObserver:self
  57                                                                    selector:@selector(statusUpdate:)
  58                                                                            name:CONTACT_SEEN_ONLINE_NO
  59                                                                          object:nil];
  60
  61
  62
  63 }
  64
  65 /*!
  66  * @brief Contact status change notification
  67  *
  68  * @param notification A notificaiton with an AIListObject object and an eventID name
  69  */
  70 - (void)statusUpdate:(NSNotification *)notification
  71 {
  72         AIListObject    *inObject = [notification object];
  73
  74         //Either they are online, or we've come online. Either way, update both their status and the time
  75         if ([[notification name] isEqualToString:CONTACT_SEEN_ONLINE_YES]) {
  76
  77                 [[adium preferenceController] setPreference:AILocalizedString(@"Online",nil)
  78                                                                                          forKey:KEY_LAST_SEEN_STATUS
  79                                                                                           group:PREF_GROUP_LAST_SEEN
  80                                                                                          object:inObject];
  81
  82                 [[adium preferenceController] setPreference:[NSDate date]
  83                                                                                          forKey:KEY_LAST_SEEN_DATE
  84                                                                                           group:PREF_GROUP_LAST_SEEN
  85                                                                                          object:inObject];
  86
  87         //They've signed off, update their status and the time
  88         } else if ([[notification name] isEqualToString:CONTACT_STATUS_ONLINE_NO]) {
  89
  90                 [[adium preferenceController] setPreference:AILocalizedString(@"Signing off",nil)
  91                                                                                          forKey:KEY_LAST_SEEN_STATUS
  92                                                                                           group:PREF_GROUP_LAST_SEEN
  93                                                                                          object:inObject];
  94
  95
  96                 [[adium preferenceController] setPreference:[NSDate date]
  97                                                                                          forKey:KEY_LAST_SEEN_DATE
  98                                                                                           group:PREF_GROUP_LAST_SEEN
  99                                                                                          object:inObject];
 100
 101         //Don't update the status, just the date
 102         } else if ([[notification name] isEqualToString:CONTACT_SEEN_ONLINE_NO]) {
 103
 104                 [[adium preferenceController] setPreference:[NSDate date]
 105                                                                                          forKey:KEY_LAST_SEEN_DATE
 106                                                                                           group:PREF_GROUP_LAST_SEEN
 107                                                                                          object:inObject];
 108         }
 109 }
 110
 111 #pragma mark Tooltip entry
 112 //Tooltip entry ---------------------------------------------------------------------------------------
 113
 114 /*!
 115  * @brief Tooltip label
 116  *
 117  * @result A label, or nil if no tooltip entry should be shown
 118  */
 119 - (NSString *)labelForObject:(AIListObject *)inObject
 120 {
 121     return AILocalizedString(@"Last Seen","A time interval such as '4 days ago' will be shown after this tooltip identifier");
 122 }
 123
 124 /*!
 125  * @brief Tooltip entry
 126  *
 127  * @result The tooltip entry, or nil if no tooltip should be shown
 128  */
 129 - (NSAttributedString *)entryForObject:(AIListObject *)inObject
 130 {
 131         NSString                        *lastSeenStatus;
 132         NSDate                          *lastSeenDate;
 133         NSDateFormatter         *sinceDateFormatter;
 134         NSAttributedString      *entry = nil;
 135
 136         //Only display for offline contacts
 137         if (![inObject online]) {
 138
 139                 lastSeenStatus = [[adium preferenceController] preferenceForKey:KEY_LAST_SEEN_STATUS
 140                                                                                                                                   group:PREF_GROUP_LAST_SEEN
 141                                                                                                                                  object:inObject];
 142
 143                 lastSeenDate = [[adium preferenceController] preferenceForKey:KEY_LAST_SEEN_DATE
 144                                                                                                                                 group:PREF_GROUP_LAST_SEEN
 145                                                                                                                            object:inObject];
 146                 if (lastSeenStatus && lastSeenDate) {
 147                         NSString        *timeElapsed;
 148                         NSString        *timeElapsedWithDesignation;
 149
 150                         sinceDateFormatter = [[[NSDateFormatter alloc] initWithDateFormat:[NSString stringWithFormat:@"%@, %@",
 151                                                                                                                                                                 [[NSDateFormatter localizedShortDateFormatter] dateFormat],
 152                                                                                                                                                                 [NSDateFormatter localizedDateFormatStringShowingSeconds:NO showingAMorPM:YES]]
 153                                                                                                                  allowNaturalLanguage:YES] autorelease];
 154
 155                         //stringForTimeIntervalSinceDate may return @"" if it's too short of an interval.
 156                         timeElapsed = [NSDateFormatter stringForTimeIntervalSinceDate:lastSeenDate showingSeconds:NO abbreviated:NO];
 157                         if (timeElapsed && [timeElapsed length]) {
 158                                 timeElapsedWithDesignation = [NSString stringWithFormat:@"%@ %@\n",
 159                                         timeElapsed,
 160                                         [[[NSUserDefaults standardUserDefaults] objectForKey:NSEarlierTimeDesignations] lastObject]];
 161                         } else {
 162                                 timeElapsedWithDesignation = @"";
 163                         }
 164
 165                         entry = [[NSAttributedString alloc]
 166                                                 initWithString:[NSString stringWithFormat:
 167                                                         @"%@\n%@%@",
 168                                                         lastSeenStatus,
 169                                                         timeElapsedWithDesignation,
 170                                                         [sinceDateFormatter stringForObjectValue:lastSeenDate]]];
 171                 }
 172         }
 173
 174         return [entry autorelease];
 175 }
 176
 177 @end