summaryrefslogtreecommitdiff
path: root/plugins/Comet/CometPlugin.php
blob: 10f8c198c30176c9e4cfbdd029db78ff623dbb66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?php
/**
 * Laconica, the distributed open-source microblogging tool
 *
 * Plugin to do "real time" updates using Comet/Bayeux
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * 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.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://laconi.ca/
 */

if (!defined('LACONICA')) {
    exit(1);
}

/**
 * Plugin to do realtime updates using Comet
 *
 * @category Plugin
 * @package  Laconica
 * @author   Evan Prodromou <evan@controlyourself.ca>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://laconi.ca/
 */

class CometPlugin extends Plugin
{
    var $server = null;

    function __construct($server=null)
    {
        $this->server = $server;

        parent::__construct();
    }

    function onEndShowScripts($action)
    {
        $timeline = null;

        switch ($action->trimmed('action')) {
         case 'public':
            $timeline = '/timelines/public';
            break;
         default:
            return true;
        }

        $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;
    }

    function onEndNoticeSave($notice)
    {
        $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;
    }

    function noticeAsJson($notice)
    {
        // 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');

        $act = new TwitterApiAction('/dev/null');

        $arr = $act->twitter_status_array($notice, true);
        return $arr;
    }

    // Push this up to Plugin

    function log($level, $msg)
    {
        common_log($level, get_class($this) . ': '.$msg);
    }
}