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