plugins/Comet/CometPlugin.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  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 Comet
  38  *
  39  * @category Plugin
  40  * @package  Laconica
  41  * @author   Evan Prodromou <evan@controlyourself.ca>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://laconi.ca/
  44  */
  45
  46 class CometPlugin extends RealtimePlugin
  47 {
  48     public $server   = null;
  49     public $username = null;
  50     public $password = null;
  51     protected $bay   = null;
  52
  53     function __construct($server=null, $username=null, $password=null)
  54     {
  55         $this->server   = $server;
  56         $this->username = $username;
  57         $this->password = $password;
  58
  59         parent::__construct();
  60     }
  61
  62     function _getScripts()
  63     {
  64         $scripts = parent::_getScripts();
  65
  66         $ours = array('jquery.comet.js', 'cometupdate.js');
  67
  68         foreach ($ours as $script) {
  69             $scripts[] = common_path('plugins/Comet/'.$script);
  70         }
  71
  72         return $scripts;
  73     }
  74
  75     function _updateInitialize($timeline, $user_id)
  76     {
  77         return "CometUpdate.init(\"$this->server\", \"$timeline\", $user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\");";
  78     }
  79
  80     function _connect()
  81     {
  82         // Bayeux? Comet? Huh? These terms confuse me
  83         $this->bay = new Bayeux($this->server, $this->user, $this->password);
  84     }
  85
  86     function _publish($timeline, $json)
  87     {
  88         $this->bay->publish($timeline, $json);
  89     }
  90
  91     function _disconnect()
  92     {
  93         unset($this->bay);
  94     }
  95 }