plugins/Meteor/MeteorPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to do "real time" updates using Comet/Bayeux
   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  Plugin
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
  35
  36 /**
  37  * Plugin to do realtime updates using Meteor
  38  *
  39  * @category Plugin
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class MeteorPlugin extends RealtimePlugin
  47 {
  48     public $webserver     = null;
  49     public $webport       = null;
  50     public $controlport   = null;
  51     public $controlserver = null;
  52     public $channelbase   = null;
  53     public $persistent    = true;
  54     protected $_socket    = null;
  55
  56     function __construct($webserver=null, $webport=4670, $controlport=4671, $controlserver=null, $channelbase='')
  57     {
  58         global $config;
  59
  60         $this->webserver     = (empty($webserver)) ? $config['site']['server'] : $webserver;
  61         $this->webport       = $webport;
  62         $this->controlport   = $controlport;
  63         $this->controlserver = (empty($controlserver)) ? $webserver : $controlserver;
  64         $this->channelbase   = $channelbase;
  65
  66         parent::__construct();
  67     }
  68
  69     /**
  70      * Pull settings from config file/database if set.
  71      */
  72     function initialize()
  73     {
  74         $settings = array('webserver',
  75                           'webport',
  76                           'controlport',
  77                           'controlserver',
  78                           'channelbase');
  79         foreach ($settings as $name) {
  80             $val = common_config('meteor', $name);
  81             if ($val !== false) {
  82                 $this->$name = $val;
  83             }
  84         }
  85
  86         return parent::initialize();
  87     }
  88
  89     function _getScripts()
  90     {
  91         $scripts = parent::_getScripts();
  92         $scripts[] = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport).'/meteor.js';
  93         $scripts[] = common_path('plugins/Meteor/meteorupdater.js');
  94         return $scripts;
  95     }
  96
  97     function _updateInitialize($timeline, $user_id)
  98     {
  99         $script = parent::_updateInitialize($timeline, $user_id);
 100         return $script." MeteorUpdater.init(\"$this->webserver\", $this->webport, \"{$timeline}\");";
 101     }
 102
 103     function _connect()
 104     {
 105         $controlserver = (empty($this->controlserver)) ? $this->webserver : $this->controlserver;
 106
 107         $errno = $errstr = null;
 108         $timeout = 5;
 109         $flags = STREAM_CLIENT_CONNECT;
 110         if ($this->persistent) $flags |= STREAM_CLIENT_PERSISTENT;
 111
 112         // May throw an exception.
 113         $this->_socket = stream_socket_client("tcp://{$controlserver}:{$this->controlport}", $errno, $errstr, $timeout, $flags);
 114         if (!$this->_socket) {
 115             throw new Exception("Couldn't connect to {$controlserver} on {$this->controlport}");
 116         }
 117     }
 118
 119     function _publish($channel, $message)
 120     {
 121         $message = json_encode($message);
 122         $message = addslashes($message);
 123         $cmd = "ADDMESSAGE $channel $message\n";
 124         $cnt = fwrite($this->_socket, $cmd);
 125         $result = fgets($this->_socket);
 126         if (preg_match('/^ERR (.*)$/', $result, $matches)) {
 127             throw new Exception('Error adding meteor message "'.$matches[1].'"');
 128         }
 129         // TODO: parse and deal with result
 130     }
 131
 132     function _disconnect()
 133     {
 134         if (!$this->persistent) {
 135             $cnt = fwrite($this->_socket, "QUIT\n");
 136             @fclose($this->_socket);
 137         }
 138     }
 139
 140     // Meteord flips out with default '/' separator
 141
 142     function _pathToChannel($path)
 143     {
 144         if (!empty($this->channelbase)) {
 145             array_unshift($path, $this->channelbase);
 146         }
 147         return implode('-', $path);
 148     }
 149 }