lib/dbqueuemanager.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Simple-minded queue manager for storing items in the database
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  QueueManager
  23  * @package   StatusNet
  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/
  29  */
  30
  31 class DBQueueManager extends QueueManager
  32 {
  33     /**
  34      * Saves an object reference into the queue item table.
  35      * @return boolean true on success
  36      * @throws ServerException on failure
  37      */
  38     public function enqueue($object, $queue)
  39     {
  40         $qi = new Queue_item();
  41
  42         $qi->frame     = $this->encode($object);
  43         $qi->transport = $queue;
  44         $qi->created   = common_sql_now();
  45         $result        = $qi->insert();
  46
  47         if (!$result) {
  48             common_log_db_error($qi, 'INSERT', __FILE__);
  49             throw new ServerException('DB error inserting queue item');
  50         }
  51
  52         $this->stats('enqueued', $queue);
  53
  54         return true;
  55     }
  56
  57     /**
  58      * Poll every 10 seconds for new events during idle periods.
  59      * We'll look in more often when there's data available.
  60      *
  61      * @return int seconds
  62      */
  63     public function pollInterval()
  64     {
  65         return 10;
  66     }
  67
  68     /**
  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
  71      */
  72     public function poll()
  73     {
  74         $this->_log(LOG_DEBUG, 'Checking for notices...');
  75         $qi = Queue_item::top($this->activeQueues());
  76         if (empty($qi)) {
  77             $this->_log(LOG_DEBUG, 'No notices waiting; idling.');
  78             return false;
  79         }
  80
  81         $queue = $qi->transport;
  82         $item = $this->decode($qi->frame);
  83
  84         if ($item) {
  85             $rep = $this->logrep($item);
  86             $this->_log(LOG_INFO, "Got $rep for transport $queue");
  87
  88             $handler = $this->getHandler($queue);
  89             if ($handler) {
  90                 if ($handler->handle($item)) {
  91                     $this->_log(LOG_INFO, "[$queue:$rep] Successfully handled item");
  92                     $this->_done($qi);
  93                 } else {
  94                     $this->_log(LOG_INFO, "[$queue:$rep] Failed to handle item");
  95                     $this->_fail($qi);
  96                 }
  97             } else {
  98                 $this->_log(LOG_INFO, "[$queue:$rep] No handler for queue $queue; discarding.");
  99                 $this->_done($qi);
 100             }
 101         } else {
 102             $this->_log(LOG_INFO, "[$queue] Got empty/deleted item, discarding");
 103             $this->_fail($qi);
 104         }
 105         return true;
 106     }
 107
 108     /**
 109      * Delete our claimed item from the queue after successful processing.
 110      *
 111      * @param QueueItem $qi
 112      */
 113     protected function _done($qi)
 114     {
 115         $queue = $qi->transport;
 116
 117         if (empty($qi->claimed)) {
 118             $this->_log(LOG_WARNING, "Reluctantly releasing unclaimed queue item $qi->id from $qi->queue");
 119         }
 120         $qi->delete();
 121
 122         $this->stats('handled', $queue);
 123     }
 124
 125     /**
 126      * Free our claimed queue item for later reprocessing in case of
 127      * temporary failure.
 128      *
 129      * @param QueueItem $qi
 130      */
 131     protected function _fail($qi)
 132     {
 133         $queue = $qi->transport;
 134
 135         if (empty($qi->claimed)) {
 136             $this->_log(LOG_WARNING, "[$queue:item $qi->id] Ignoring failure for unclaimed queue item");
 137         } else {
 138             $orig = clone($qi);
 139             $qi->claimed = null;
 140             $qi->update($orig);
 141         }
 142
 143         $this->stats('error', $queue);
 144     }
 145 }