summaryrefslogtreecommitdiff
path: root/plugins/Msn/msnmanager.php
blob: a8996ecafadf5eb80d8b45ccfabba0238d4fca6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2008, 2009, StatusNet, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }

/**
 * MSN background connection manager for MSN-using queue handlers,
 * allowing them to send outgoing messages on the right connection.
 *
 * Input is handled during socket select loop, keepalive pings during idle.
 * Any incoming messages will be handled.
 *
 * In a multi-site queuedaemon.php run, one connection will be instantiated
 * for each site being handled by the current process that has MSN enabled.
 */

class MsnManager extends ImManager {
    public $conn = null;
    protected $lastPing = null;
    protected $pingInterval;

    /**
     * Initialise connection to server.
     *
     * @return boolean true on success
     */
    public function start($master) {
        if (parent::start($master)) {
            $this->requeue_waiting_messages();
            $this->connect();
            return true;
        } else {
            return false;
        }
    }

    /**
    * Return any open sockets that the run loop should listen
    * for input on.
    *
    * @return array Array of socket resources
    */
    public function getSockets() {
        $this->connect();
        if ($this->conn) {
            return $this->conn->getSockets();
        } else {
            return array();
        }
    }

    /**
     * Idle processing for io manager's execution loop.
     * Send keepalive pings to server.
     *
     * @return void
     */
    public function idle($timeout = 0) {
        if (empty($this->lastPing) || time() - $this->lastPing > $this->pingInterval) {
            $this->send_ping();
        }
    }

    /**
     * Message pump is triggered on socket input, so we only need an idle()
     * call often enough to trigger our outgoing pings.
     */
    public function timeout() {
        return $this->pingInterval;
    }

    /**
     * Process MSN events that have come in over the wire.
     *
     * @param resource $socket Socket ready
     * @return void
     */
    public function handleInput($socket) {
        common_log(LOG_DEBUG, 'Servicing the MSN queue.');
        $this->stats('msn_process');
        $this->conn->receive();
    }

    /**
    * Initiate connection
    *
    * @return void
    */
    public function connect() {
        if (!$this->conn) {
            $this->conn = new MSN(
                array(
                    'user' => $this->plugin->user,
                    'password' => $this->plugin->password,
                    'alias' => $this->plugin->nickname,
                    'psm' => 'Send me a message to post a notice',
                    'debug' => false
                )
            );
            $this->conn->registerHandler('IMin', array($this, 'handle_msn_message'));
            $this->conn->registerHandler('SessionReady', array($this, 'handle_session_ready'));
            $this->conn->registerHandler('Pong', array($this, 'update_ping_time'));
            $this->conn->registerHandler('ConnectFailed', array($this, 'handle_connect_failed'));
            $this->conn->registerHandler('Reconnect', array($this, 'handle_reconnect'));
            $this->conn->signon();
            $this->lastPing = time();
        }
        return $this->conn;
    }

    /**
    * Called by the idle process to send a ping
    * when necessary
    *
    * @return void
    */
    protected function send_ping() {
        $this->connect();
        if (!$this->conn) {
            return false;
        }

        $this->conn->sendPing();
        $this->lastPing = time();
        $this->pingInterval = 50;
        return true;
    }

    /**
     * Update the time till the next ping
     *
     * @param $data Time till next ping
     * @return void
     */
    public function update_ping_time($data) {
        $this->pingInterval = $data;
    }

    /**
    * Called via a callback when a message is received
    *
    * Passes it back to the queuing system
    *
    * @param array $data Data
    * @return boolean
    */
    public function handle_msn_message($data) {
        $this->plugin->enqueueIncomingRaw($data);
        return true;
    }

    /**
    * Called via a callback when a session becomes ready
    *
    * @param array $data Data
    */
    public function handle_session_ready($data) {
        $sessionFailed = false;
        $wm = Msn_waiting_message::top($data['to']);
        while ($wm != NULL) {
            if ($sessionFailed) {
                $this->plugin->sendMessage($wm->screenname, $wm->message);
                $sessionFailed = true;
            } elseif (!$this->conn->sendMessage($wm->screenname, $wm->message, $ignore)) {
                $this->plugin->sendMessage($wm->screenname, $wm->message);
            }

            $wm->delete();
            $wm = Msn_waiting_message::top($data['to']);
        }
    }

    /**
    * Requeue messages from the waiting table so we try
    * to send them again
    *
    * @return void
    */
    protected function requeue_waiting_messages() {
        $wm = Msn_waiting_message::top();
        while ($wm != NULL) {
            $this->plugin->sendMessage($wm->screenname, $wm->message);
            $wm->delete();
            $wm = Msn_waiting_message::top();
        }
    }

    /**
    * Called by callback to log failure during connect
    *
    * @param string $message error message reported
    * @return void
    */
    public function handle_connect_failed($message) {
        common_log(LOG_NOTICE, 'MSN connect failed, retrying: ' . $message);
    }

    /**
    * Called by callback to log reconnection
    *
    * @param void $data Not used (there to keep callback happy)
    * @return void
    */
    public function handle_reconnect($data) {
        common_log(LOG_NOTICE, 'MSN reconnecting');
        // Requeue messages waiting in the DB
        $this->requeue_waiting_messages();
    }

    /**
    * Enters a message into the database for sending via a callback
    * when the session is established
    *
    * @param string $to Intended recipient
    * @param string $message Message
    */
    protected function enqueue_waiting_message($to, $message) {
        $wm = new Msn_waiting_message();

        $wm->screenname = $to;
        $wm->message    = $message;
        $wm->created    = common_sql_now();
        $result         = $wm->insert();

        if (!$result) {
            common_log_db_error($wm, 'INSERT', __FILE__);
            throw new ServerException('DB error inserting queue item');
        }

        return true;
    }

    /**
     * Send a message using the daemon
     *
     * @param $data Message data
     * @return boolean true on success
     */
    public function send_raw_message($data) {
        $this->connect();
        if (!$this->conn) {
            return false;
        }

        $waitForSession = false;
        if (!$this->conn->sendMessage($data['to'], $data['message'], $waitForSession)) {
            if ($waitForSession) {
                $this->enqueue_waiting_message($data['to'], $data['message']);
            } else {
                return false;
            }
        }

        // Sending a command updates the time till next ping
        $this->lastPing = time();
        $this->pingInterval = 50;
        return true;
    }
}