lib/dbqueuemanager.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 class DBQueueManager extends QueueManager
  31 {
  32     var $qis = array();
  33
  34     function enqueue($object, $queue)
  35     {
  36         $notice = $object;
  37
  38         $qi = new Queue_item();
  39
  40         $qi->notice_id = $notice->id;
  41         $qi->transport = $queue;
  42         $qi->created   = $notice->created;
  43         $result        = $qi->insert();
  44
  45         if (!$result) {
  46             common_log_db_error($qi, 'INSERT', __FILE__);
  47             throw new ServerException('DB error inserting queue item');
  48         }
  49
  50         return true;
  51     }
  52
  53     function service($queue, $handler)
  54     {
  55         while (true) {
  56             $this->_log(LOG_DEBUG, 'Checking for notices...');
  57             $timeout = $handler->timeout();
  58             $notice = $this->_nextItem($queue, $timeout);
  59             if (empty($notice)) {
  60                 $this->_log(LOG_DEBUG, 'No notices waiting; idling.');
  61                 // Nothing in the queue. Do you
  62                 // have other tasks, like servicing your
  63                 // XMPP connection, to do?
  64                 $handler->idle(QUEUE_HANDLER_MISS_IDLE);
  65             } else {
  66                 $this->_log(LOG_INFO, 'Got notice '. $notice->id);
  67                 // Yay! Got one!
  68                 if ($handler->handle_notice($notice)) {
  69                     $this->_log(LOG_INFO, 'Successfully handled notice '. $notice->id);
  70                     $this->_done($notice, $queue);
  71                 } else {
  72                     $this->_log(LOG_INFO, 'Failed to handle notice '. $notice->id);
  73                     $this->_fail($notice, $queue);
  74                 }
  75                 // Chance to e.g. service your XMPP connection
  76                 $this->_log(LOG_DEBUG, 'Idling after success.');
  77                 $handler->idle(QUEUE_HANDLER_HIT_IDLE);
  78             }
  79             // XXX: when do we give up?
  80         }
  81     }
  82
  83     function _nextItem($queue, $timeout=null)
  84     {
  85         $start = time();
  86         $result = null;
  87
  88         $sleeptime = 1;
  89
  90         do {
  91             $qi = Queue_item::top($queue);
  92             if (empty($qi)) {
  93                 $this->_log(LOG_DEBUG, "No new queue items, sleeping $sleeptime seconds.");
  94                 sleep($sleeptime);
  95                 $sleeptime *= 2;
  96             } else {
  97                 $notice = Notice::staticGet('id', $qi->notice_id);
  98                 if (!empty($notice)) {
  99                     $result = $notice;
 100                 } else {
 101                     $this->_log(LOG_INFO, 'dequeued non-existent notice ' . $notice->id);
 102                     $qi->delete();
 103                     $qi->free();
 104                     $qi = null;
 105                 }
 106                 $sleeptime = 1;
 107             }
 108         } while (empty($result) && (is_null($timeout) || (time() - $start) < $timeout));
 109
 110         return $result;
 111     }
 112
 113     function _done($object, $queue)
 114     {
 115         // XXX: right now, we only handle notices
 116
 117         $notice = $object;
 118
 119         $qi = Queue_item::pkeyGet(array('notice_id' => $notice->id,
 120                                         'transport' => $queue));
 121
 122         if (empty($qi)) {
 123             $this->_log(LOG_INFO, 'Cannot find queue item for notice '.$notice->id.', queue '.$queue);
 124         } else {
 125             if (empty($qi->claimed)) {
 126                 $this->_log(LOG_WARNING, 'Reluctantly releasing unclaimed queue item '.
 127                             'for '.$notice->id.', queue '.$queue);
 128             }
 129             $qi->delete();
 130             $qi->free();
 131             $qi = null;
 132         }
 133
 134         $this->_log(LOG_INFO, 'done with notice ID = ' . $notice->id);
 135
 136         $notice->free();
 137         $notice = null;
 138     }
 139
 140     function _fail($object, $queue)
 141     {
 142         // XXX: right now, we only handle notices
 143
 144         $notice = $object;
 145
 146         $qi = Queue_item::pkeyGet(array('notice_id' => $notice->id,
 147                                         'transport' => $queue));
 148
 149         if (empty($qi)) {
 150             $this->_log(LOG_INFO, 'Cannot find queue item for notice '.$notice->id.', queue '.$queue);
 151         } else {
 152             if (empty($qi->claimed)) {
 153                 $this->_log(LOG_WARNING, 'Ignoring failure for unclaimed queue item '.
 154                             'for '.$notice->id.', queue '.$queue);
 155             } else {
 156                 $orig = clone($qi);
 157                 $qi->claimed = null;
 158                 $qi->update($orig);
 159                 $qi = null;
 160             }
 161         }
 162
 163         $this->_log(LOG_INFO, 'done with notice ID = ' . $notice->id);
 164
 165         $notice->free();
 166         $notice = null;
 167     }
 168
 169     function _log($level, $msg)
 170     {
 171         common_log($level, 'DBQueueManager: '.$msg);
 172     }
 173 }