summaryrefslogtreecommitdiff
path: root/lib/queuehandler.php
blob: 045432ae52b6f61c970a6f8632687c834d02de43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?php
/*
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, 2009, Control Yourself, Inc.
 *
 * 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/>.
 */

if (!defined('LACONICA')) { exit(1); }

require_once(INSTALLDIR.'/lib/daemon.php');
require_once(INSTALLDIR.'/classes/Queue_item.php');
require_once(INSTALLDIR.'/classes/Notice.php');

define('CLAIM_TIMEOUT', 1200);
define('QUEUE_HANDLER_MISS_IDLE', 10);
define('QUEUE_HANDLER_HIT_IDLE', 10);

class QueueHandler extends Daemon
{
    var $_id = 'generic';

    function QueueHandler($id=null)
    {
        if ($id) {
            $this->set_id($id);
        }
    }

    function timeout()
    {
        return null;
    }

    function class_name()
    {
        return ucfirst($this->transport()) . 'Handler';
    }

    function name()
    {
        return strtolower($this->class_name().'.'.$this->get_id());
    }

    function get_id()
    {
        return $this->_id;
    }

    function set_id($id)
    {
        $this->_id = $id;
    }

    function transport()
    {
        return null;
    }

    function start()
    {
    }

    function finish()
    {
    }

    function handle_notice($notice)
    {
        return true;
    }

    function run()
    {
        if (!$this->start()) {
            return false;
        }

        $this->log(LOG_INFO, 'checking for queued notices');

        $queue   = $this->transport();
        $timeout = $this->timeout();

        $qm = QueueManager::get();

        while (true) {
            $this->log(LOG_DEBUG, 'Checking for notices...');
            $notice = $qm->nextItem($queue, $timeout);
            if (empty($notice)) {
                $this->log(LOG_DEBUG, 'No notices waiting; idling.');
                // Nothing in the queue. Do you
                // have other tasks, like servicing your
                // XMPP connection, to do?
                $this->idle(QUEUE_HANDLER_MISS_IDLE);
            } else {
                $this->log(LOG_INFO, 'Got notice '. $notice->id);
                // Yay! Got one!
                if ($this->handle_notice($notice)) {
                    $this->log(LOG_INFO, 'Successfully handled notice '. $notice->id);
                    $qm->done($notice, $queue);
                } else {
                    $this->log(LOG_INFO, 'Failed to handle notice '. $notice->id);
                    $qm->fail($notice, $queue);
                }
                // Chance to e.g. service your XMPP connection
                $this->log(LOG_DEBUG, 'Idling after success.');
                $this->idle(QUEUE_HANDLER_HIT_IDLE);
            }
            // XXX: when do we give up?
        }

        if (!$this->finish()) {
            return false;
        }
        return true;
    }

    function idle($timeout=0)
    {
        if ($timeout > 0) {
            sleep($timeout);
        }
    }

    function log($level, $msg)
    {
        common_log($level, $this->class_name() . ' ('. $this->get_id() .'): '.$msg);
    }
}