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             $notice = $this->_nextItem($queue, null);
  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         do {
  89             $qi = Queue_item::top($queue);
  90             if (!empty($qi)) {
  91                 $notice = Notice::staticGet('id', $qi->notice_id);
  92                 if (!empty($notice)) {
  93                     $result = $notice;
  94                 } else {
  95                     $this->_log(LOG_INFO, 'dequeued non-existent notice ' . $notice->id);
  96                     $qi->delete();
  97                     $qi->free();
  98                     $qi = null;
  99                 }
 100             }
 101         } while (empty($result) && (is_null($timeout) || (time() - $start) < $timeout));
 102
 103         return $result;
 104     }
 105
 106     function _done($object, $queue)
 107     {
 108         // XXX: right now, we only handle notices
 109
 110         $notice = $object;
 111
 112         $qi = Queue_item::pkeyGet(array('notice_id' => $notice->id,
 113                                         'transport' => $queue));
 114
 115         if (empty($qi)) {
 116             $this->_log(LOG_INFO, 'Cannot find queue item for notice '.$notice->id.', queue '.$queue);
 117         } else {
 118             if (empty($qi->claimed)) {
 119                 $this->_log(LOG_WARNING, 'Reluctantly releasing unclaimed queue item '.
 120                            'for '.$notice->id.', queue '.$queue);
 121             }
 122             $qi->delete();
 123             $qi->free();
 124             $qi = null;
 125         }
 126
 127         $this->_log(LOG_INFO, 'done with notice ID = ' . $notice->id);
 128
 129         $notice->free();
 130         $notice = null;
 131     }
 132
 133     function _fail($object, $queue)
 134     {
 135         // XXX: right now, we only handle notices
 136
 137         $notice = $object;
 138
 139         $qi = Queue_item::pkeyGet(array('notice_id' => $notice->id,
 140                                         'transport' => $queue));
 141
 142         if (empty($qi)) {
 143             $this->_log(LOG_INFO, 'Cannot find queue item for notice '.$notice->id.', queue '.$queue);
 144         } else {
 145             if (empty($qi->claimed)) {
 146                 $this->_log(LOG_WARNING, 'Ignoring failure for unclaimed queue item '.
 147                            'for '.$notice->id.', queue '.$queue);
 148             } else {
 149                 $orig = clone($qi);
 150                 $qi->claimed = null;
 151                 $qi->update($orig);
 152                 $qi = null;
 153             }
 154         }
 155
 156         $this->_log(LOG_INFO, 'done with notice ID = ' . $notice->id);
 157
 158         $notice->free();
 159         $notice = null;
 160     }
 161
 162     function _log($level, $msg)
 163     {
 164         common_log($level, 'DBQueueManager: '.$msg);
 165     }
 166 }