3 * Laconica, the distributed open-source microblogging tool
5 * Plugin to do "real time" updates using Comet/Bayeux
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.
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.
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/>.
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/
30 if (!defined('LACONICA')) {
35 * Plugin to do realtime updates using Comet
39 * @author Evan Prodromou <evan@controlyourself.ca>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://laconi.ca/
44 class CometPlugin extends Plugin
48 function __construct($server=null)
50 $this->server = $server;
52 parent::__construct();
55 function onEndShowScripts($action)
59 $this->log(LOG_DEBUG, 'got action ' . $action->trimmed('action'));
61 switch ($action->trimmed('action')) {
63 $timeline = '/timelines/public';
66 $tag = $action->trimmed('tag');
68 $timeline = '/timelines/tag/'.$tag;
77 $scripts = array('jquery.comet.js', 'json2.js', 'updatetimeline.js');
79 foreach ($scripts as $script) {
80 $action->element('script', array('type' => 'text/javascript',
81 'src' => common_path('plugins/Comet/'.$script)),
85 $action->elementStart('script', array('type' => 'text/javascript'));
86 $action->raw("$(document).ready(function() { updater.init(\"$this->server\", \"$timeline\");});");
87 $action->elementEnd('script');
92 function onEndNoticeSave($notice)
94 $this->log(LOG_INFO, "Called for save notice.");
98 // XXX: Add other timelines; this is just for the public one
100 if ($notice->is_local ||
101 ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
102 $timelines[] = '/timelines/public';
105 $tags = $this->getNoticeTags($notice);
108 foreach ($tags as $tag) {
109 $timelines[] = '/timelines/tag/' . $tag;
113 if (count($timelines) > 0) {
114 // Require this, since we need it
115 require_once(INSTALLDIR.'/plugins/Comet/bayeux.class.inc.php');
117 $json = $this->noticeAsJson($notice);
119 // Bayeux? Comet? Huh? These terms confuse me
120 $bay = new Bayeux($this->server);
122 foreach ($timelines as $timeline) {
123 $this->log(LOG_INFO, "Posting notice $notice->id to '$timeline'.");
124 $bay->publish($timeline, $json);
133 function noticeAsJson($notice)
135 // FIXME: this code should be abstracted to a neutral third
136 // party, like Notice::asJson(). I'm not sure of the ethics
137 // of refactoring from within a plugin, so I'm just abusing
138 // the TwitterApiAction method. Don't do this unless you're me!
140 require_once(INSTALLDIR.'/lib/twitterapi.php');
142 $act = new TwitterApiAction('/dev/null');
144 $arr = $act->twitter_status_array($notice, true);
145 $arr['url'] = $notice->bestUrl();
146 $arr['html'] = htmlspecialchars($notice->rendered);
148 $profile = $notice->getProfile();
149 $arr['user']['profile_url'] = $profile->profileurl;
154 function getNoticeTags($notice)
158 $nt = new Notice_tag();
159 $nt->notice_id = $notice->id;
163 while ($nt->fetch()) {
174 // Push this up to Plugin
176 function log($level, $msg)
178 common_log($level, get_class($this) . ': '.$msg);