lib/queuehandler.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, 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('STATUSNET') && !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', 0);
  29
  30 class QueueHandler extends Daemon
  31 {
  32
  33     function __construct($id=null, $daemonize=true)
  34     {
  35         parent::__construct($daemonize);
  36
  37         if ($id) {
  38             $this->set_id($id);
  39         }
  40     }
  41
  42     function timeout()
  43     {
  44         return 60;
  45     }
  46
  47     function class_name()
  48     {
  49         return ucfirst($this->transport()) . 'Handler';
  50     }
  51
  52     function name()
  53     {
  54         return strtolower($this->class_name().'.'.$this->get_id());
  55     }
  56
  57     function transport()
  58     {
  59         return null;
  60     }
  61
  62     function start()
  63     {
  64     }
  65
  66     function finish()
  67     {
  68     }
  69
  70     function handle_notice($notice)
  71     {
  72         return true;
  73     }
  74
  75     function run()
  76     {
  77         if (!$this->start()) {
  78             $this->log(LOG_WARNING, 'failed to start');
  79             return false;
  80         }
  81
  82         $this->log(LOG_INFO, 'checking for queued notices');
  83
  84         $queue   = $this->transport();
  85         $timeout = $this->timeout();
  86
  87         $qm = QueueManager::get();
  88
  89         $qm->service($queue, $this);
  90
  91         $this->log(LOG_INFO, 'finished servicing the queue');
  92
  93         if (!$this->finish()) {
  94             $this->log(LOG_WARNING, 'failed to clean up');
  95             return false;
  96         }
  97
  98         $this->log(LOG_INFO, 'terminating normally');
  99
 100         return true;
 101     }
 102
 103     function idle($timeout=0)
 104     {
 105         if ($timeout > 0) {
 106             sleep($timeout);
 107         }
 108     }
 109
 110     function log($level, $msg)
 111     {
 112         common_log($level, $this->class_name() . ' ('. $this->get_id() .'): '.$msg);
 113     }
 114
 115     function getSockets()
 116     {
 117         return array();
 118     }
 119 }
 120