Source/AIAutoReplyPlugin.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 "AIAutoReplyPlugin.h"
  18 #import <Adium/AIContactControllerProtocol.h>
  19 #import <Adium/AIContentControllerProtocol.h>
  20 #import <Adium/AIPreferenceControllerProtocol.h>
  21 #import "AIStatusController.h"
  22 #import <AIUtilities/AIArrayAdditions.h>
  23 #import <Adium/AIAccount.h>
  24 #import <Adium/AIChat.h>
  25 #import <Adium/AIContentMessage.h>
  26 #import <Adium/AIContentObject.h>
  27
  28 /*!
  29  * @class AIAutoReplyPlugin
  30  * @brief Provides AutoReply functionality for the state system
  31  *
  32  * This class implements the state system behavior for auto-reply.  If auto-reply status is active on an account,
  33  * initial messages recieved on that account will be replied to automatically.  Subsequent messages will not receive
  34  * a reply unless the chat window is closed.
  35  *
  36  * This is the expected behavior on certain protocols such as AIM, and considered a convenience on other protocols.
  37  */
  38 @implementation AIAutoReplyPlugin
  39
  40 /*!
  41  * @brief Initialize the auto-reply system
  42  *
  43  * Initialize the auto-reply system to monitor account status.  When an account auto-reply flag is set we begin to
  44  * monitor chat messaging and auto-reply as necessary.
  45  */
  46 - (void)installPlugin
  47 {
  48         //Init
  49         receivedAutoReply = [[NSMutableSet alloc] init];
  50
  51         //Add observers
  52         [[adium notificationCenter] addObserver:self
  53                                                                    selector:@selector(didReceiveContent:)
  54                                                                            name:CONTENT_MESSAGE_RECEIVED object:nil];
  55         [[adium notificationCenter] addObserver:self
  56                                                                    selector:@selector(didSendContent:)
  57                                                                            name:CONTENT_MESSAGE_SENT object:nil];
  58         [[adium notificationCenter] addObserver:self
  59                                                                    selector:@selector(chatWillClose:)
  60                                                                            name:Chat_WillClose object:nil];
  61
  62         [[adium contactController] registerListObjectObserver:self];
  63 }
  64
  65 /*!
  66  * Deallocate
  67  */
  68 - (void)dealloc
  69 {
  70         [[adium contactController] unregisterListObjectObserver:self];
  71         [receivedAutoReply release];
  72
  73         [super dealloc];
  74 }
  75
  76 /*!
  77  * @brief Account status changed.
  78  *
  79  * Update our chat monitoring in response to account status changes.
  80  *
  81  * TODO: If there are no accounts with an auto-reply flag set we SHOULD stop monitoring messages for optimal performance.
  82  */
  83 - (NSSet *)updateListObject:(AIListObject *)inObject keys:(NSSet *)inModifiedKeys silent:(BOOL)silent
  84 {
  85         if ([inObject isKindOfClass:[AIAccount class]] &&
  86            [inModifiedKeys containsObject:@"StatusState"]) {
  87
  88                 //Reset our list of contacts who have already received an auto-reply
  89                 [receivedAutoReply release]; receivedAutoReply = [[NSMutableSet alloc] init];
  90
  91                 //Don't want to remove from the new set any chats which previously closed and are pending removal
  92                 [NSObject cancelPreviousPerformRequestsWithTarget:self];
  93         }
  94
  95     return nil;
  96 }
  97
  98 /*!
  99  * @brief Respond to a received message
 100  *
 101  * Respond to a received message by sending out the current auto-reply.  We only send the auto-reply once to each
 102  * contact, and then their name is added to a list and additional received messages are ignored.
 103  */
 104 - (void)didReceiveContent:(NSNotification *)notification
 105 {
 106     AIContentObject     *contentObject = [[notification userInfo] objectForKey:@"AIContentObject"];
 107     AIChat                              *chat = [contentObject chat];
 108
 109         /* We will not respond to the received message if it is an auto-reply, over a chat where we have already responded,
 110          * or over a group chat.
 111          * Additionally, it's not sensible to send autoreplies if the arriving message
 112          * was an offline message we're getting as we connect and it's older than 5 minutes
 113          * (or the person sending it is no longer online) -RAF
 114          */
 115         if ([[contentObject type] isEqualToString:CONTENT_MESSAGE_TYPE] &&
 116            ![(AIContentMessage *)contentObject isAutoreply] &&
 117            ![receivedAutoReply containsObject:[chat uniqueChatID]] &&
 118            ![chat isGroupChat] &&
 119                 (abs([[contentObject date] timeIntervalSinceNow]) < 300)  ) {
 120                 //300 is 5 minutes in seconds
 121
 122                 [self sendAutoReplyFromAccount:[contentObject destination]
 123                                                          toContact:[contentObject source]
 124                                                                 onChat:chat];
 125
 126                 [receivedAutoReply addObject:[chat uniqueChatID]];
 127         }
 128 }
 129
 130 /*!
 131  * @brief Send an auto-reply
 132  *
 133  * Sends our current auto-reply to the specified contact.
 134  * @param source Account sending the object
 135  * @param destination Contact receiving the object
 136  * @param chat Chat the communication is occuring over
 137  */
 138 - (void)sendAutoReplyFromAccount:(id)source toContact:(id)destination onChat:(AIChat *)chat
 139 {
 140         AIContentMessage        *responseContent = nil;
 141         NSAttributedString      *autoReply = [[[chat account] statusState] autoReply];
 142         BOOL                            supportsAutoreply = [source supportsAutoReplies];
 143
 144         if (autoReply) {
 145                 if (!supportsAutoreply) {
 146                         //Tthe service isn't natively expecting an autoresponse, so make it a bit clearer what's going on
 147                         NSMutableAttributedString *mutableAutoReply = [[autoReply mutableCopy] autorelease];
 148                         [mutableAutoReply replaceCharactersInRange:NSMakeRange(0, 0)
 149                                                                                         withString:AILocalizedString(@"(Autoreply) ",
 150                                                                                                 "Prefix to place before autoreplies on services which do not natively support them")];
 151                         autoReply = mutableAutoReply;
 152                 }
 153
 154                 responseContent = [AIContentMessage messageInChat:chat
 155                                                                                            withSource:source
 156                                                                                           destination:destination
 157                                                                                                          date:nil
 158                                                                                                   message:autoReply
 159                                                                                                 autoreply:supportsAutoreply];
 160
 161                 [[adium contentController] sendContentObject:responseContent];
 162         }
 163 }
 164
 165 /*!
 166  * @brief Respond to our user sending messages
 167  *
 168  * For convenience, when our user messages a contact while away we exclude that contact from receiving our auto-away
 169  * on future messages.
 170  */
 171 - (void)didSendContent:(NSNotification *)notification
 172 {
 173     AIContentObject     *contentObject = [[notification userInfo] objectForKey:@"AIContentObject"];
 174         AIChat                  *chat = [contentObject chat];
 175
 176     if ([[contentObject type] isEqualToString:CONTENT_MESSAGE_TYPE]) {
 177                 [receivedAutoReply addObject:[chat uniqueChatID]];
 178     }
 179 }
 180
 181 - (void)removeChatIDFromReceivedAutoReply:(id)uniqueChatID
 182 {
 183         [receivedAutoReply removeObject:uniqueChatID];
 184 }
 185
 186 /*!
 187  * @brief Respond to a chat closing
 188  *
 189  * Once a chat is closed we forget about whether it has received an auto-response.  If the chat is re-opened, it will
 190  * receive our auto-response again.  This behavior is not necessarily desired, but is a side effect of basing our
 191  * already-received list on chats and not contacts.  However, many users have come to expect this behavior and it's
 192  * presence is neither strongly negative or positive.
 193  */
 194 - (void)chatWillClose:(NSNotification *)notification
 195 {
 196         /* Don't remove the chat until 30 seconds from now to prevent the classic situation in which you close the window,
 197          * the contact messages you one last message, and a needless autoreply is sent
 198          */
 199         [NSObject cancelPreviousPerformRequestsWithTarget:self
 200                                                                                          selector:@selector(removeChatIDFromReceivedAutoReply:)
 201                                                                                            object:[[notification object] uniqueChatID]];
 202         [self performSelector:@selector(removeChatIDFromReceivedAutoReply:)
 203                            withObject:[[notification object] uniqueChatID]
 204                            afterDelay:30.0];
 205 }
 206
 207 @end