Changeset 15210

Timestamp:

02/12/2006 01:33:17 PM (3 years ago)

Author:

evands

Message:

Patch from Kiel Gillard which implements a "blocked" status icon. There is a default blocked icon which will be used if the status icon set does not supply one, which it can do with a "Blocked" key. Fixes #344. Good work! :)

The patch also improves the the blocking API a bit, allowing contacts to block themselves.

Files:

• trunk/Frameworks/Adium Framework/AIListContact.h (modified) (1 diff)
• trunk/Frameworks/Adium Framework/AIListContact.m (modified) (1 diff)
• trunk/Frameworks/Adium Framework/AIListObject.h (modified) (2 diffs)
• trunk/Frameworks/Adium Framework/AIListObject.m (modified) (1 diff)
• trunk/Frameworks/Adium Framework/AIMetaContact.m (modified) (2 diffs)
• trunk/Frameworks/Adium Framework/AIStatusIcons.m (modified) (2 diffs)
• trunk/Frameworks/Adium Framework/DefaultBlockedStatusIcon.png (added)
• trunk/Source/AITabStatusIconsPlugin.m (modified) (1 diff)
• trunk/Source/ESBlockingPlugin.m (modified) (5 diffs)

trunk/Frameworks/Adium Framework/AIListContact.h

@@ -46 +46 @@
-- (void)setSignonDate:(NSDate *)signonDate notify:(NotifyTiming)notify;
-- (NSDate *)signonDate;
+- (void)setIsBlocked:(BOOL)yesOrNo updateList:(BOOL)addToPrivacyLists;
-
-- (void)setIdle:(BOOL)isIdle sinceDate:(NSDate *)idleSinceDate notify:(NotifyTiming)notify;

trunk/Frameworks/Adium Framework/AIListContact.m

@@ -468 +468 @@
-}
-
+/*!
+ * @brief Is this contact blocked?
+ *
+ * @result A boolean indicating if the contact is blocked or not
+ */
+- (BOOL)isBlocked
+{
+        return [self integerStatusObjectForKey:KEY_IS_BLOCKED];
+}
+
+/*!
+ * @brief Set if this contact is blocked
+ */
+- (void)setIsBlocked:(BOOL)yesOrNo updateList:(BOOL)addToPrivacyLists
+{
+        if (addToPrivacyLists) {
+                //caller of this method wants to block the contact
+                AIAccount       *contactAccount = [self account];
+                
+                if ([contactAccount conformsToProtocol:@protocol(AIAccount_Privacy)]) {
+                        BOOL    result = NO;
+                        NSArray *privacyList = [(AIAccount <AIAccount_Privacy> *)contactAccount listObjectIDsOnPrivacyList:PRIVACY_DENY];
+                        
+                        if (yesOrNo == YES) {
+                                //we want to block the contact
+                                if (![privacyList containsObject:[self UID]]) {
+                                        result = [(AIAccount <AIAccount_Privacy> *)contactAccount addListObject:self toPrivacyList:PRIVACY_DENY];
+                                }
+                        } else {
+                                //unblock contact
+                                if ([privacyList containsObject:[self UID]]) {
+                                        result = [(AIAccount <AIAccount_Privacy> *)contactAccount removeListObject:self fromPrivacyList:PRIVACY_DENY];
+                                }
+                        }
+                        
+                        //update status object
+                        if (result) {
+                                [self setStatusObject:(yesOrNo ? [NSNumber numberWithBool:YES] : nil)
+                                                           forKey:KEY_IS_BLOCKED 
+                                                           notify:NotifyNow];
+                        }
+                } else {
+                        NSLog(@"Privacy is not supported on contacts for the account: %@", contactAccount);
+                }
+        } else {
+                //caller of this method just wants to update the status object
+                [self setStatusObject:(yesOrNo ? [NSNumber numberWithBool:YES] : nil)
+                                           forKey:KEY_IS_BLOCKED 
+                                           notify:NotifyNow];
+        }
+}
+
-#pragma mark Status
-

trunk/Frameworks/Adium Framework/AIListObject.h

@@ -20 +20 @@
-@class AIListObject, AIService, AIMutableOwnerArray, AIListGroup;
-
-
+
+
-
-typedef enum {
@@ -127 +128 @@
-- (BOOL)isStranger;
-- (BOOL)isMobile;
+- (BOOL)isBlocked;
-
-- (NSString *)displayName;

trunk/Frameworks/Adium Framework/AIListObject.m

@@ -597 +597 @@
- */
-- (BOOL)isMobile
+{
+        return NO;
+}
+
+/*!
+ * @brief Is this contact blocked?
+ *
+ * @result A boolean indicating if the object is blocked
+ */
+- (BOOL)isBlocked
-{
-        return NO;

trunk/Frameworks/Adium Framework/AIMetaContact.m

@@ -54 +54 @@
-
-        [super initWithUID:[objectID stringValue] service:nil];
-
+
-        containedObjects = [[NSMutableArray alloc] init];
-        
@@ -186 +186 @@
-{
-        return NO;
+}
+
+/*!
+ * @brief Are all the contacts in this meta blocked?
+ *
+ * @result Boolean flag indicating if all the listContacts are blocked
+ */
+- (BOOL)isBlocked
+{
+        BOOL                    allContactsBlocked = ([[self listContacts] count] ? YES : NO);
+        NSEnumerator    *enumerator = [[self listContacts] objectEnumerator];
+        AIListContact   *currentContact = nil;
+        
+        while ((currentContact = [enumerator nextObject])) {
+                //find any unblocked contacts
+                if (![currentContact isBlocked]) {
+                        allContactsBlocked = NO;
+                        break;
+                }
+        }
+        
+        return allContactsBlocked;
+}
+
+/*!
+ * @brief Block each contact contained in the meta
+ */
+- (void)setIsBlocked:(BOOL)yesOrNo updateList:(BOOL)addToPrivacyLists
+{
+        NSEnumerator    *contactEnumerator = [[self listContacts] objectEnumerator];
+        AIListContact   *currentContact = nil;
+        
+        //attempt to block entire meta
+        while ((currentContact = [contactEnumerator nextObject])) {
+                [currentContact setIsBlocked:yesOrNo updateList:addToPrivacyLists];
+        }
+        
+        //update status object if we are completely blocked
+        [self setStatusObject:([self isBlocked] ? [NSNumber numberWithBool:YES] : nil)
+                                   forKey:KEY_IS_BLOCKED 
+                                   notify:NotifyNow];
-}
-

trunk/Frameworks/Adium Framework/AIStatusIcons.m

@@ -136 +136 @@
-                        }
-                } else {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-                                        [statusIcons[iconType][iconDirection] setObject:statusIcon forKey:statusName];
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-                                                [statusIcons[iconType][iconDirection] setObject:statusIcon forKey:statusName];
-                                        }
-                                        
-                                } else {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                        }
-                }
@@ -263 +275 @@
-        if ([listObject isMobile]) {
-                statusName = @"Mobile";
-
+
+
-        } else {
-                AIStatusSummary statusSummary = [listObject statusSummary];

trunk/Source/AITabStatusIconsPlugin.m

@@ -87 +87 @@
-           [inModifiedKeys containsObject:@"IsIdle"] ||
-           [inModifiedKeys containsObject:@"NotAStranger"] ||
+           [inModifiedKeys containsObject:KEY_IS_BLOCKED] ||
-           [inModifiedKeys containsObject:@"IsMobile"]) {
-                

trunk/Source/ESBlockingPlugin.m

@@ -30 +30 @@
-- (void)_blockContact:(AIListContact *)contact unblock:(BOOL)unblock;
-- (BOOL)_searchPrivacyListsForListContact:(AIListContact *)contact withDesiredResult:(BOOL)desiredResult;
+- (void)accountConnected:(NSNotification *)notification;
-@end
-
@@ -49 +50 @@
-                                                                                                                 keyEquivalent:@""];
-    [[adium menuController] addContextualMenuItem:blockContactContextualMenuItem toLocation:Context_Contact_NegativeAction];
+        
+        //we want to know when an account connects
+        [[adium notificationCenter] addObserver:self
+                                                                   selector:@selector(accountConnected:)
+                                                                           name:ACCOUNT_CONNECTED
+                                                                         object:nil];
-}
-
-- (void)uninstallPlugin
-{
+        [[adium notificationCenter] removeObserver:self];
-        [blockContactMenuItem release];
-        [blockContactContextualMenuItem release];
@@ -79 +87 @@
-                if (NSRunAlertPanel([NSString stringWithFormat:format, [contact displayName]],
-                                                   @"",
-AILocalizedString(@"OK", nil)
+[sender title]
-                                                   AILocalizedString(@"Cancel", nil),
-                                                   nil) == NSAlertDefaultReturn) {
@@ -191 +199 @@
-{
-        //We want to block on all accounts with the same service class. If you want someone gone, you want 'em GONE.
-
-
-
+
+
+
+
-        while ((account = [enumerator nextObject])) {
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-                }
-        }
@@ -228 +230 @@
-}
-
+/*!
+ * @brief Inform AIListContact instances of the user's intended privacy towards the people they represent
+ */
+- (void)accountConnected:(NSNotification *)notification
+{
+        //NSLog(@"account connected: %@", notification);
+        
+        AIAccount               *accountConnected = [notification object];
+        NSEnumerator    *contactEnumerator = nil;
+        AIListContact   *currentContact = nil;
+        
+        if ([accountConnected conformsToProtocol:@protocol(AIAccount_Privacy)]) {
+                
+                //check if each contact is on the account's deny list
+                contactEnumerator = [[accountConnected contacts] objectEnumerator];
+                while ((currentContact = [contactEnumerator nextObject])) {
+                        //NSLog(@"The current contact is: %@", currentContact);
+                        
+                        if ([[(AIAccount <AIAccount_Privacy> *)accountConnected listObjectIDsOnPrivacyList:PRIVACY_DENY] containsObject:[currentContact UID]]) {
+                                //inform the contact that they're blocked
+                                [currentContact setIsBlocked:YES updateList:NO];
+                                //NSLog(@"** %@ is blocked **", [currentContact formattedUID]);
+                        } else {
+                                [currentContact setIsBlocked:NO updateList:NO];
+                        }
+                }
+        }
+}
+
-@end