3 * StatusNet, the distributed open-source microblogging tool
5 * Simple-minded queue manager for storing items in the database
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @category QueueManager
24 * @author Evan Prodromou <evan@status.net>
25 * @author Brion Vibber <brion@status.net>
26 * @copyright 2009-2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 class DBQueueManager extends QueueManager
34 * Saves an object reference into the queue item table.
35 * @return boolean true on success
36 * @throws ServerException on failure
38 public function enqueue($object, $queue)
40 $qi = new Queue_item();
42 $qi->frame = $this->encode($object);
43 $qi->transport = $queue;
44 $qi->created = common_sql_now();
45 $result = $qi->insert();
47 if ($result === false) {
48 common_log_db_error($qi, 'INSERT', __FILE__);
49 throw new ServerException('DB error inserting queue item');
52 $this->stats('enqueued', $queue);
58 * Poll every 10 seconds for new events during idle periods.
59 * We'll look in more often when there's data available.
63 public function pollInterval()
69 * Run a polling cycle during idle processing in the input loop.
70 * @return boolean true if we should poll again for more data immediately
72 public function poll()
74 //$this->_log(LOG_DEBUG, 'Checking for notices...');
75 $qi = Queue_item::top($this->activeQueues(), $this->getIgnoredTransports());
76 if (!$qi instanceof Queue_item) {
77 //$this->_log(LOG_DEBUG, 'No notices waiting; idling.');
82 $item = $this->decode($qi->frame);
83 } catch (Exception $e) {
84 $this->_log(LOG_INFO, "[{$qi->transport}] Discarding: ".$e->getMessage());
89 $rep = $this->logrep($item);
90 $this->_log(LOG_DEBUG, "Got {$rep} for transport {$qi->transport}");
93 $handler = $this->getHandler($qi->transport);
94 $result = $handler->handle($item);
95 } catch (NoQueueHandlerException $e) {
96 $this->noHandlerFound($qi, $rep);
98 } catch (AlreadyFulfilledException $e) {
99 $this->_log(LOG_ERR, "[{$qi->transport}:$rep] AlreadyFulfilledException thrown: {$e->getMessage()}");
101 } catch (Exception $e) {
102 $this->_log(LOG_ERR, "[{$qi->transport}:$rep] Exception thrown: {$e->getMessage()}");
107 $this->_log(LOG_INFO, "[{$qi->transport}:$rep] Successfully handled item");
110 $this->_log(LOG_INFO, "[{$qi->transport}:$rep] Failed to handle item");
116 // What to do if no handler was found. For example, the OpportunisticQM
117 // should avoid deleting items just because it can't reach XMPP queues etc.
118 protected function noHandlerFound(Queue_item $qi, $rep=null) {
119 $this->_log(LOG_INFO, "[{$qi->transport}:{$rep}] No handler for queue {$qi->transport}; discarding.");
124 * Delete our claimed item from the queue after successful processing.
126 * @param QueueItem $qi
128 protected function _done(Queue_item $qi)
130 if (empty($qi->claimed)) {
131 $this->_log(LOG_WARNING, "Reluctantly releasing unclaimed queue item {$qi->id} from {$qi->transport}");
135 $this->stats('handled', $qi->transport);
139 * Free our claimed queue item for later reprocessing in case of
142 * @param QueueItem $qi
144 protected function _fail(Queue_item $qi, $releaseOnly=false)
146 if (empty($qi->claimed)) {
147 $this->_log(LOG_WARNING, "[{$qi->transport}:item {$qi->id}] Ignoring failure for unclaimed queue item");
153 $this->stats('error', $qi->transport);