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('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     protected $_socket    = null;
  54
  55     function __construct($webserver=null, $webport=4670, $controlport=4671, $controlserver=null, $channelbase='')
  56     {
  57         global $config;
  58
  59         $this->webserver     = (empty($webserver)) ? $config['site']['server'] : $webserver;
  60         $this->webport       = $webport;
  61         $this->controlport   = $controlport;
  62         $this->controlserver = (empty($controlserver)) ? $webserver : $controlserver;
  63         $this->channelbase   = $channelbase;
  64
  65         parent::__construct();
  66     }
  67
  68     function _getScripts()
  69     {
  70         $scripts = parent::_getScripts();
  71         $scripts[] = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport).'/meteor.js';
  72         $scripts[] = common_path('plugins/Meteor/meteorupdater.js');
  73         return $scripts;
  74     }
  75
  76     function _updateInitialize($timeline, $user_id)
  77     {
  78         $script = parent::_updateInitialize($timeline, $user_id);
  79         return $script." MeteorUpdater.init(\"$this->webserver\", $this->webport, \"{$timeline}\");";
  80     }
  81
  82     function _connect()
  83     {
  84         $controlserver = (empty($this->controlserver)) ? $this->webserver : $this->controlserver;
  85         // May throw an exception.
  86         $this->_socket = stream_socket_client("tcp://{$controlserver}:{$this->controlport}");
  87         if (!$this->_socket) {
  88             throw new Exception("Couldn't connect to {$controlserver} on {$this->controlport}");
  89         }
  90     }
  91
  92     function _publish($channel, $message)
  93     {
  94         $message = json_encode($message);
  95         $message = addslashes($message);
  96         $cmd = "ADDMESSAGE $channel $message\n";
  97         $cnt = fwrite($this->_socket, $cmd);
  98         $result = fgets($this->_socket);
  99         if (preg_match('/^ERR (.*)$/', $result, $matches)) {
 100             throw new Exception('Error adding meteor message "'.$matches[1].'"');
 101         }
 102         // TODO: parse and deal with result
 103     }
 104
 105     function _disconnect()
 106     {
 107         $cnt = fwrite($this->_socket, "QUIT\n");
 108         @fclose($this->_socket);
 109     }
 110
 111     // Meteord flips out with default '/' separator
 112
 113     function _pathToChannel($path)
 114     {
 115         if (!empty($this->channelbase)) {
 116             array_unshift($path, $this->channelbase);
 117         }
 118         return implode('-', $path);
 119     }
 120 }