Merge branch 'master' of gitorious.org:statusnet/mainline into 0.9.x

[quix0rs-gnu-social.git] / plugins / Comet / CometPlugin.php

diff --git a/plugins/Comet/CometPlugin.php b/plugins/Comet/CometPlugin.php
index 10f8c198c30176c9e4cfbdd029db78ff623dbb66..70b324b5c20d225683d0d6cc98079941e6b7c1c7 100644 (file)
--- a/plugins/Comet/CometPlugin.php
+++ b/plugins/Comet/CometPlugin.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * Plugin to do "real time" updates using Comet/Bayeux
  *
@@ -20,119 +20,98 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Plugin
- * @package   Laconica
- * @author    Evan Prodromou <evan@controlyourself.ca>
- * @copyright 2009 Control Yourself, Inc.
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2009 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link      http://laconi.ca/
+ * @link      http://status.net/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
+require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
+
 /**
  * Plugin to do realtime updates using Comet
  *
  * @category Plugin
- * @package  Laconica
- * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link     http://laconi.ca/
+ * @link     http://status.net/
  */
-
-class CometPlugin extends Plugin
+class CometPlugin extends RealtimePlugin
 {
-    var $server = null;
+    public $server   = null;
+    public $username = null;
+    public $password = null;
+    public $prefix   = null;
+    protected $bay   = null;
 
-    function __construct($server=null)
+    function __construct($server=null, $username=null, $password=null, $prefix=null)
     {
-        $this->server = $server;
+        $this->server   = $server;
+        $this->username = $username;
+        $this->password = $password;
+        $this->prefix   = $prefix;
 
         parent::__construct();
     }
 
-    function onEndShowScripts($action)
+    function _getScripts()
     {
-        $timeline = null;
+        $scripts = parent::_getScripts();
 
-        switch ($action->trimmed('action')) {
-         case 'public':
-            $timeline = '/timelines/public';
-            break;
-         default:
-            return true;
+        $ours = array('jquery.comet.js', 'cometupdate.js');
+
+        foreach ($ours as $script) {
+            $scripts[] = 'plugins/Comet/'.$script;
         }
 
-        $action->element('script', array('type' => 'text/javascript',
-                                         'src' => common_path('plugins/Comet/jquery.comet.js')),
-                         ' ');
-        $action->elementStart('script', array('type' => 'text/javascript'));
-        $action->raw("var _timelineServer = \"$this->server\"; ".
-                     "var _timeline = \"$timeline\";");
-        $action->elementEnd('script');
-        $action->element('script', array('type' => 'text/javascript',
-                                         'src' => common_path('plugins/Comet/updatetimeline.js')),
-                         ' ');
-        return true;
+        return $scripts;
     }
 
-    function onEndNoticeSave($notice)
+    function _updateInitialize($timeline, $user_id)
     {
-        $this->log(LOG_INFO, "Called for save notice.");
-
-        $timelines = array();
-
-        // XXX: Add other timelines; this is just for the public one
-
-        if ($notice->is_local ||
-            ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
-            $timelines[] = '/timelines/public';
-        }
-
-        if (count($timelines) > 0) {
-            // Require this, since we need it
-            require_once(INSTALLDIR.'/plugins/Comet/bayeux.class.inc.php');
-
-            $json = $this->noticeAsJson($notice);
-
-            $this->log(LOG_DEBUG, "JSON = '$json'");
-
-            // Bayeux? Comet? Huh? These terms confuse me
-            $bay = new Bayeux($this->server);
-
-            foreach ($timelines as $timeline) {
-                $this->log(LOG_INFO, "Posting notice $notice->id to '$timeline'.");
-                $bay->publish($timeline, $json);
-                $this->log(LOG_DEBUG, "Done posting notice $notice->id to '$timeline'.");
-            }
-
-            $bay = NULL;
-        }
-
-        $this->log(LOG_DEBUG, "All done.");
-        return true;
+        $script = parent::_updateInitialize($timeline, $user_id);
+        return $script." CometUpdate.init(\"$this->server\", \"$timeline\", $user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\");";
     }
 
-    function noticeAsJson($notice)
+    function _connect()
     {
-        // FIXME: this code should be abstracted to a neutral third
-        // party, like Notice::asJson(). I'm not sure of the ethics
-        // of refactoring from within a plugin, so I'm just abusing
-        // the TwitterApiAction method. Don't do this unless you're me!
-
-        require_once(INSTALLDIR.'/lib/twitterapi.php');
+        require_once INSTALLDIR.'/plugins/Comet/bayeux.class.inc.php';
+        // Bayeux? Comet? Huh? These terms confuse me
+        $this->bay = new Bayeux($this->server, $this->user, $this->password);
+    }
 
-        $act = new TwitterApiAction('/dev/null');
+    function _publish($timeline, $json)
+    {
+        $this->bay->publish($timeline, $json);
+    }
 
-        $arr = $act->twitter_status_array($notice, true);
-        return $arr;
+    function _disconnect()
+    {
+        unset($this->bay);
     }
 
-    // Push this up to Plugin
+    function _pathToChannel($path)
+    {
+        if (!empty($this->prefix)) {
+            array_unshift($path, $this->prefix);
+        }
+        return '/' . implode('/', $path);
+    }
 
-    function log($level, $msg)
+    function onPluginVersion(&$versions)
     {
-        common_log($level, get_class($this) . ': '.$msg);
+        $versions[] = array('name' => 'Comet',
+                            'version' => STATUSNET_VERSION,
+                            'author' => 'Evan Prodromou',
+                            'homepage' => 'http://status.net/wiki/Plugin:Comet',
+                            'rawdescription' =>
+                            _m('Plugin to do "real time" updates using Comet/Bayeux.'));
+        return true;
     }
 }