]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/distribqueuehandler.php
fix notices in dumpschema
[quix0rs-gnu-social.git] / lib / distribqueuehandler.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, StatusNet, Inc.
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Affero General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Affero General Public License for more details.
15  *
16  * You should have received a copy of the GNU Affero General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
21
22 /**
23  * Base class for queue handlers.
24  *
25  * As extensions of the Daemon class, each queue handler has the ability
26  * to launch itself in the background, at which point it'll pass control
27  * to the configured QueueManager class to poll for updates.
28  *
29  * Subclasses must override at least the following methods:
30  * - transport
31  * - handle_notice
32  */
33
34 class DistribQueueHandler
35 {
36     /**
37      * Return transport keyword which identifies items this queue handler
38      * services; must be defined for all subclasses.
39      *
40      * Must be 8 characters or less to fit in the queue_item database.
41      * ex "email", "jabber", "sms", "irc", ...
42      *
43      * @return string
44      */
45
46     function transport()
47     {
48         return 'distrib';
49     }
50
51     /**
52      * Handle distribution of a notice after we've saved it:
53      * @li add to local recipient inboxes
54      * @li send email notifications to local @-reply targets
55      * @li run final EndNoticeSave plugin events
56      * @li put any remaining post-processing into the queues
57      *
58      * If this function indicates failure, a warning will be logged
59      * and the item is placed back in the queue to be re-run.
60      *
61      * @fixme addToInboxes is known to fail sometimes with large recipient sets
62      *
63      * @param Notice $notice
64      * @return boolean true on success, false on failure
65      */
66     function handle($notice)
67     {
68         try {
69             $notice->addToInboxes();
70         } catch (Exception $e) {
71             $this->logit($notice, $e);
72         }
73
74         try {
75             $notice->sendReplyNotifications();
76         } catch (Exception $e) {
77             $this->logit($notice, $e);
78         }
79
80         try {
81             Event::handle('EndNoticeDistribute', array($notice));
82         } catch (Exception $e) {
83             $this->logit($notice, $e);
84         }
85
86         try {
87             Event::handle('EndNoticeSave', array($notice));
88         } catch (Exception $e) {
89             $this->logit($notice, $e);
90         }
91
92         try {
93             // Enqueue for other handlers
94             common_enqueue_notice($notice);
95         } catch (Exception $e) {
96             $this->logit($notice, $e);
97         }
98
99         return true;
100     }
101
102     protected function logit($notice, $e)
103     {
104         common_log(LOG_ERR, "Distrib queue exception saving notice $notice->id: " .
105             $e->getMessage() . ' ' .
106             str_replace("\n", " ", $e->getTraceAsString()));
107
108         // We'll still return true so we don't get stuck in a loop
109         // trying to run a bad insert over and over...
110     }
111 }
112