lib/queuehandler.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, Control Yourself, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/lib/daemon.php');
  23 require_once(INSTALLDIR.'/classes/Queue_item.php');
  24 require_once(INSTALLDIR.'/classes/Notice.php');
  25
  26 define('CLAIM_TIMEOUT', 1200);
  27 define('QUEUE_HANDLER_MISS_IDLE', 10);
  28 define('QUEUE_HANDLER_HIT_IDLE', 10);
  29
  30 class QueueHandler extends Daemon
  31 {
  32     var $_id = 'generic';
  33
  34     function __construct($id=null, $daemonize=true)
  35     {
  36         parent::__construct($daemonize);
  37
  38         if ($id) {
  39             $this->set_id($id);
  40         }
  41     }
  42
  43     function timeout()
  44     {
  45         return null;
  46     }
  47
  48     function class_name()
  49     {
  50         return ucfirst($this->transport()) . 'Handler';
  51     }
  52
  53     function name()
  54     {
  55         return strtolower($this->class_name().'.'.$this->get_id());
  56     }
  57
  58     function get_id()
  59     {
  60         return $this->_id;
  61     }
  62
  63     function set_id($id)
  64     {
  65         $this->_id = $id;
  66     }
  67
  68     function transport()
  69     {
  70         return null;
  71     }
  72
  73     function start()
  74     {
  75     }
  76
  77     function finish()
  78     {
  79     }
  80
  81     function handle_notice($notice)
  82     {
  83         return true;
  84     }
  85
  86     function run()
  87     {
  88         if (!$this->start()) {
  89             return false;
  90         }
  91
  92         $this->log(LOG_INFO, 'checking for queued notices');
  93
  94         $queue   = $this->transport();
  95         $timeout = $this->timeout();
  96
  97         $qm = QueueManager::get();
  98
  99         while (true) {
 100             $this->log(LOG_DEBUG, 'Checking for notices...');
 101             $notice = $qm->nextItem($queue, $timeout);
 102             if (empty($notice)) {
 103                 $this->log(LOG_DEBUG, 'No notices waiting; idling.');
 104                 // Nothing in the queue. Do you
 105                 // have other tasks, like servicing your
 106                 // XMPP connection, to do?
 107                 $this->idle(QUEUE_HANDLER_MISS_IDLE);
 108             } else {
 109                 $this->log(LOG_INFO, 'Got notice '. $notice->id);
 110                 // Yay! Got one!
 111                 if ($this->handle_notice($notice)) {
 112                     $this->log(LOG_INFO, 'Successfully handled notice '. $notice->id);
 113                     $qm->done($notice, $queue);
 114                 } else {
 115                     $this->log(LOG_INFO, 'Failed to handle notice '. $notice->id);
 116                     $qm->fail($notice, $queue);
 117                 }
 118                 // Chance to e.g. service your XMPP connection
 119                 $this->log(LOG_DEBUG, 'Idling after success.');
 120                 $this->idle(QUEUE_HANDLER_HIT_IDLE);
 121             }
 122             // XXX: when do we give up?
 123         }
 124
 125         if (!$this->finish()) {
 126             return false;
 127         }
 128         return true;
 129     }
 130
 131     function idle($timeout=0)
 132     {
 133         if ($timeout > 0) {
 134             sleep($timeout);
 135         }
 136     }
 137
 138     function log($level, $msg)
 139     {
 140         common_log($level, $this->class_name() . ' ('. $this->get_id() .'): '.$msg);
 141     }
 142 }
 143