]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - scripts/xmppdaemon.php
add an inbox blob table
[quix0rs-gnu-social.git] / scripts / xmppdaemon.php
1 #!/usr/bin/env php
2 <?php
3 /*
4  * StatusNet - the distributed open-source microblogging tool
5  * Copyright (C) 2008, 2009, StatusNet, Inc.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20
21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
22
23 $shortoptions = 'fi::';
24 $longoptions = array('id::', 'foreground');
25
26 $helptext = <<<END_OF_XMPP_HELP
27 Daemon script for receiving new notices from Jabber users.
28
29     -i --id           Identity (default none)
30     -f --foreground   Stay in the foreground (default background)
31
32 END_OF_XMPP_HELP;
33
34 require_once INSTALLDIR.'/scripts/commandline.inc';
35
36 require_once INSTALLDIR . '/lib/common.php';
37 require_once INSTALLDIR . '/lib/jabber.php';
38 require_once INSTALLDIR . '/lib/daemon.php';
39
40 # This is kind of clunky; we create a class to call the global functions
41 # in jabber.php, which create a new XMPP class. A more elegant (?) solution
42 # might be to use make this a subclass of XMPP.
43
44 class XMPPDaemon extends Daemon
45 {
46     function __construct($resource=null, $daemonize=true)
47     {
48         parent::__construct($daemonize);
49
50         static $attrs = array('server', 'port', 'user', 'password', 'host');
51
52         foreach ($attrs as $attr)
53         {
54             $this->$attr = common_config('xmpp', $attr);
55         }
56
57         if ($resource) {
58             $this->resource = $resource . 'daemon';
59         } else {
60             $this->resource = common_config('xmpp', 'resource') . 'daemon';
61         }
62
63         $this->jid = $this->user.'@'.$this->server.'/'.$this->resource;
64
65         $this->log(LOG_INFO, "INITIALIZE XMPPDaemon {$this->jid}");
66     }
67
68     function connect()
69     {
70         $connect_to = ($this->host) ? $this->host : $this->server;
71
72         $this->log(LOG_INFO, "Connecting to $connect_to on port $this->port");
73
74         $this->conn = jabber_connect($this->resource);
75
76         if (!$this->conn) {
77             return false;
78         }
79
80         $this->log(LOG_INFO, "Connected");
81
82         $this->conn->setReconnectTimeout(600);
83
84         $this->log(LOG_INFO, "Sending initial presence.");
85
86         jabber_send_presence("Send me a message to post a notice", 'available',
87                              null, 'available', 100);
88
89         $this->log(LOG_INFO, "Done connecting.");
90
91         return !$this->conn->isDisconnected();
92     }
93
94     function name()
95     {
96         return strtolower('xmppdaemon.'.$this->resource);
97     }
98
99     function run()
100     {
101         if ($this->connect()) {
102
103             $this->log(LOG_DEBUG, "Initializing stanza handlers.");
104
105             $this->conn->addEventHandler('message', 'handle_message', $this);
106             $this->conn->addEventHandler('presence', 'handle_presence', $this);
107             $this->conn->addEventHandler('reconnect', 'handle_reconnect', $this);
108
109             $this->log(LOG_DEBUG, "Beginning processing loop.");
110
111             while ($this->conn->processTime(60)) {
112                 $this->sendPing();
113             }
114         }
115     }
116
117     function sendPing()
118     {
119         if (!isset($this->pingid)) {
120             $this->pingid = 0;
121         } else {
122             $this->pingid++;
123         }
124
125         $this->log(LOG_DEBUG, "Sending ping #{$this->pingid}");
126
127                 $this->conn->send("<iq from='{$this->jid}' to='{$this->server}' id='ping_{$this->pingid}' type='get'><ping xmlns='urn:xmpp:ping'/></iq>");
128     }
129
130     function handle_reconnect(&$pl)
131     {
132         $this->log(LOG_DEBUG, "Got reconnection callback.");
133         $this->conn->processUntil('session_start');
134         $this->log(LOG_DEBUG, "Sending reconnection presence.");
135         $this->conn->presence('Send me a message to post a notice', 'available', null, 'available', 100);
136         unset($pl['xml']);
137         $pl['xml'] = null;
138
139         $pl = null;
140         unset($pl);
141     }
142
143     function get_user($from)
144     {
145         $user = User::staticGet('jabber', jabber_normalize_jid($from));
146         return $user;
147     }
148
149     function handle_message(&$pl)
150     {
151         $from = jabber_normalize_jid($pl['from']);
152
153         if ($pl['type'] != 'chat') {
154             $this->log(LOG_WARNING, "Ignoring message of type ".$pl['type']." from $from.");
155             return;
156         }
157
158         if (mb_strlen($pl['body']) == 0) {
159             $this->log(LOG_WARNING, "Ignoring message with empty body from $from.");
160             return;
161         }
162
163         # Forwarded from another daemon (probably a broadcaster) for
164         # us to handle
165
166         if ($this->is_self($from)) {
167             $this->log(LOG_INFO, "Got forwarded notice from self ($from).");
168             $from = $this->get_ofrom($pl);
169             $this->log(LOG_INFO, "Originally sent by $from.");
170             if (is_null($from) || $this->is_self($from)) {
171                 $this->log(LOG_INFO, "Ignoring notice originally sent by $from.");
172                 return;
173             }
174         }
175
176         $user = $this->get_user($from);
177
178         // For common_current_user to work
179         global $_cur;
180         $_cur = $user;
181
182         if (!$user) {
183             $this->from_site($from, 'Unknown user; go to ' .
184                              common_local_url('imsettings') .
185                              ' to add your address to your account');
186             $this->log(LOG_WARNING, 'Message from unknown user ' . $from);
187             return;
188         }
189         if ($this->handle_command($user, $pl['body'])) {
190             $this->log(LOG_INFO, "Command message by $from handled.");
191             return;
192         } else if ($this->is_autoreply($pl['body'])) {
193             $this->log(LOG_INFO, 'Ignoring auto reply from ' . $from);
194             return;
195         } else if ($this->is_otr($pl['body'])) {
196             $this->log(LOG_INFO, 'Ignoring OTR from ' . $from);
197             return;
198         } else {
199
200             $this->log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
201
202             $this->add_notice($user, $pl);
203         }
204
205         $user->free();
206         unset($user);
207         unset($_cur);
208
209         unset($pl['xml']);
210         $pl['xml'] = null;
211
212         $pl = null;
213         unset($pl);
214     }
215
216     function is_self($from)
217     {
218         return preg_match('/^'.strtolower(jabber_daemon_address()).'/', strtolower($from));
219     }
220
221     function get_ofrom($pl)
222     {
223         $xml = $pl['xml'];
224         $addresses = $xml->sub('addresses');
225         if (!$addresses) {
226             $this->log(LOG_WARNING, 'Forwarded message without addresses');
227             return null;
228         }
229         $address = $addresses->sub('address');
230         if (!$address) {
231             $this->log(LOG_WARNING, 'Forwarded message without address');
232             return null;
233         }
234         if (!array_key_exists('type', $address->attrs)) {
235             $this->log(LOG_WARNING, 'No type for forwarded message');
236             return null;
237         }
238         $type = $address->attrs['type'];
239         if ($type != 'ofrom') {
240             $this->log(LOG_WARNING, 'Type of forwarded message is not ofrom');
241             return null;
242         }
243         if (!array_key_exists('jid', $address->attrs)) {
244             $this->log(LOG_WARNING, 'No jid for forwarded message');
245             return null;
246         }
247         $jid = $address->attrs['jid'];
248         if (!$jid) {
249             $this->log(LOG_WARNING, 'Could not get jid from address');
250             return null;
251         }
252         $this->log(LOG_DEBUG, 'Got message forwarded from jid ' . $jid);
253         return $jid;
254     }
255
256     function is_autoreply($txt)
257     {
258         if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
259             return true;
260         } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
261             return true;
262         } else {
263             return false;
264         }
265     }
266
267     function is_otr($txt)
268     {
269         if (preg_match('/^\?OTR/', $txt)) {
270             return true;
271         } else {
272             return false;
273         }
274     }
275
276     function from_site($address, $msg)
277     {
278         $text = '['.common_config('site', 'name') . '] ' . $msg;
279         jabber_send_message($address, $text);
280     }
281
282     function handle_command($user, $body)
283     {
284         $inter = new CommandInterpreter();
285         $cmd = $inter->handle_command($user, $body);
286         if ($cmd) {
287             $chan = new XMPPChannel($this->conn);
288             $cmd->execute($chan);
289             return true;
290         } else {
291             return false;
292         }
293     }
294
295     function add_notice(&$user, &$pl)
296     {
297         $body = trim($pl['body']);
298         $content_shortened = common_shorten_links($body);
299         if (Notice::contentTooLong($content_shortened)) {
300           $from = jabber_normalize_jid($pl['from']);
301           $this->from_site($from, sprintf(_("Message too long - maximum is %d characters, you sent %d"),
302                                           Notice::maxContent(),
303                                           mb_strlen($content_shortened)));
304           return;
305         }
306
307         try {
308             $notice = Notice::saveNew($user->id, $content_shortened, 'xmpp');
309         } catch (Exception $e) {
310             $this->log(LOG_ERR, $e->getMessage());
311             $this->from_site($user->jabber, $e->getMessage());
312             return;
313         }
314
315         common_broadcast_notice($notice);
316         $this->log(LOG_INFO,
317                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
318         $notice->free();
319         unset($notice);
320     }
321
322     function handle_presence(&$pl)
323     {
324         $from = jabber_normalize_jid($pl['from']);
325         switch ($pl['type']) {
326          case 'subscribe':
327             # We let anyone subscribe
328             $this->subscribed($from);
329             $this->log(LOG_INFO,
330                        'Accepted subscription from ' . $from);
331             break;
332          case 'subscribed':
333          case 'unsubscribed':
334          case 'unsubscribe':
335             $this->log(LOG_INFO,
336                        'Ignoring  "' . $pl['type'] . '" from ' . $from);
337             break;
338          default:
339             if (!$pl['type']) {
340                 $user = User::staticGet('jabber', $from);
341                 if (!$user) {
342                     $this->log(LOG_WARNING, 'Presence from unknown user ' . $from);
343                     return;
344                 }
345                 if ($user->updatefrompresence) {
346                     $this->log(LOG_INFO, 'Updating ' . $user->nickname .
347                                ' status from presence.');
348                     $this->add_notice($user, $pl);
349                 }
350                 $user->free();
351                 unset($user);
352             }
353             break;
354         }
355         unset($pl['xml']);
356         $pl['xml'] = null;
357
358         $pl = null;
359         unset($pl);
360     }
361
362     function log($level, $msg)
363     {
364         $text = 'XMPPDaemon('.$this->resource.'): '.$msg;
365         common_log($level, $text);
366         if (!$this->daemonize)
367         {
368             $line = common_log_line($level, $text);
369             echo $line;
370             echo "\n";
371         }
372     }
373
374     function subscribed($to)
375     {
376         jabber_special_presence('subscribed', $to);
377     }
378 }
379
380 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
381 // lots of CPU trying to connect to unconfigured servers
382 if (common_config('xmpp','enabled')==false) {
383     print "Aborting daemon - xmpp is disabled\n";
384     exit();
385 }
386
387 if (have_option('i', 'id')) {
388     $id = get_option_value('i', 'id');
389 } else if (count($args) > 0) {
390     $id = $args[0];
391 } else {
392     $id = null;
393 }
394
395 $foreground = have_option('f', 'foreground');
396
397 $daemon = new XMPPDaemon($id, !$foreground);
398
399 $daemon->runOnce();