We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

dbqueuemanager.php 4.29 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
Evan Prodromou's avatar
Evan Prodromou committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * Simple-minded queue manager for storing items in the database
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  QueueManager
23
 * @package   StatusNet
24
 * @author    Evan Prodromou <evan@status.net>
25 26
 * @author    Brion Vibber <brion@status.net>
 * @copyright 2009-2010 StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
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/
Evan Prodromou's avatar
Evan Prodromou committed
29 30 31 32
 */

class DBQueueManager extends QueueManager
{
33
    /**
34
     * Saves an object reference into the queue item table.
35 36 37 38
     * @return boolean true on success
     * @throws ServerException on failure
     */
    public function enqueue($object, $queue)
Evan Prodromou's avatar
Evan Prodromou committed
39 40 41
    {
        $qi = new Queue_item();

42
        $qi->frame     = $this->encode($object);
Evan Prodromou's avatar
Evan Prodromou committed
43
        $qi->transport = $queue;
44
        $qi->created   = common_sql_now();
Evan Prodromou's avatar
Evan Prodromou committed
45 46
        $result        = $qi->insert();

47
        if ($result === false) {
Evan Prodromou's avatar
Evan Prodromou committed
48 49 50 51
            common_log_db_error($qi, 'INSERT', __FILE__);
            throw new ServerException('DB error inserting queue item');
        }

52 53
        $this->stats('enqueued', $queue);

Evan Prodromou's avatar
Evan Prodromou committed
54 55 56
        return true;
    }

57
    /**
58
     * Poll every 10 seconds for new events during idle periods.
59 60 61 62 63 64
     * We'll look in more often when there's data available.
     *
     * @return int seconds
     */
    public function pollInterval()
    {
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 79 80
            return false;
        }

81
        $queue = $qi->transport;
82 83 84 85 86 87 88
        try {
            $item = $this->decode($qi->frame);
        } catch (Exception $e) {
            $this->_log(LOG_INFO, "[$queue] Discarding: ".$e->getMessage());
            $this->_done($qi);
            return true;
        }
89

90 91 92 93 94 95 96
        $rep = $this->logrep($item);
        $this->_log(LOG_DEBUG, "Got $rep for transport $queue");
        
        $handler = $this->getHandler($queue);
        if ($handler) {
            if ($handler->handle($item)) {
                $this->_log(LOG_INFO, "[$queue:$rep] Successfully handled item");
97
                $this->_done($qi);
98 99 100
            } else {
                $this->_log(LOG_INFO, "[$queue:$rep] Failed to handle item");
                $this->_fail($qi);
101
            }
102
        } else {
103
            $this->_log(LOG_INFO, "[$queue:$rep] No handler for queue $queue; discarding.");
104
            $this->_done($qi);
105
        }
106
        return true;
107 108
    }

109 110 111
    /**
     * Delete our claimed item from the queue after successful processing.
     *
112
     * @param QueueItem $qi
113
     */
114
    protected function _done($qi)
Evan Prodromou's avatar
Evan Prodromou committed
115
    {
116
        $queue = $qi->transport;
Evan Prodromou's avatar
Evan Prodromou committed
117

118 119
        if (empty($qi->claimed)) {
            $this->_log(LOG_WARNING, "Reluctantly releasing unclaimed queue item $qi->id from $qi->queue");
Evan Prodromou's avatar
Evan Prodromou committed
120
        }
121
        $qi->delete();
Evan Prodromou's avatar
Evan Prodromou committed
122

123
        $this->stats('handled', $queue);
124 125
    }

126 127 128 129
    /**
     * Free our claimed queue item for later reprocessing in case of
     * temporary failure.
     *
130
     * @param QueueItem $qi
131
     */
132
    protected function _fail($qi)
133
    {
134
        $queue = $qi->transport;
135

136 137
        if (empty($qi->claimed)) {
            $this->_log(LOG_WARNING, "[$queue:item $qi->id] Ignoring failure for unclaimed queue item");
138
        } else {
139
            $qi->releaseClaim();
140 141
        }

142
        $this->stats('error', $queue);
Evan Prodromou's avatar
Evan Prodromou committed
143 144
    }
}