3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
23 * @package SubMirrorPlugin
24 * @maintainer Brion Vibber <brion@status.net>
26 class SubMirrorPlugin extends Plugin
29 * Hook for RouterInitialized event.
31 * @param Net_URL_Mapper $m path-to-action mapper
32 * @return boolean hook return
34 function onRouterInitialized($m)
36 $m->connect('settings/mirror',
37 array('action' => 'mirrorsettings'));
38 $m->connect('settings/mirror/add/:provider',
39 array('action' => 'mirrorsettings'),
40 array('provider' => '[A-Za-z0-9_-]+'));
41 $m->connect('settings/mirror/add',
42 array('action' => 'addmirror'));
43 $m->connect('settings/mirror/edit',
44 array('action' => 'editmirror'));
49 * Automatically load the actions and libraries used by the plugin
51 * @param Class $cls the class
53 * @return boolean hook return
56 function onAutoload($cls)
58 $base = dirname(__FILE__);
59 $lower = strtolower($cls);
60 $files = array("$base/lib/$lower.php",
61 "$base/classes/$cls.php");
62 if (substr($lower, -6) == 'action') {
63 $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
65 foreach ($files as $file) {
66 if (file_exists($file)) {
74 function handle($notice)
76 // Is anybody mirroring?
77 $mirror = new SubMirror();
78 $mirror->subscribed = $notice->profile_id;
79 if ($mirror->find()) {
80 while ($mirror->fetch()) {
81 $mirror->repeat($notice);
86 function onPluginVersion(&$versions)
88 $versions[] = array('name' => 'SubMirror',
89 'version' => STATUSNET_VERSION,
90 'author' => 'Brion Vibber',
91 'homepage' => 'http://status.net/wiki/Plugin:SubMirror',
93 _m('Pull feeds into your timeline!'));
99 * Menu item for personal subscriptions/groups area
101 * @param Widget $widget Widget being executed
103 * @return boolean hook return
106 function onEndSubGroupNav($widget)
108 $action = $widget->out;
109 $action_name = $action->trimmed('action');
111 $action->menuItem(common_local_url('mirrorsettings'),
112 // TRANS: SubMirror plugin menu item on user settings page.
113 _m('MENU', 'Mirroring'),
114 // TRANS: SubMirror plugin tooltip for user settings menu item.
115 _m('Configure mirroring of posts from other feeds'),
116 $action_name === 'mirrorsettings');
121 function onCheckSchema()
123 $schema = Schema::get();
124 $schema->ensureTable('submirror', SubMirror::schemaDef());
126 // @hack until key definition support is merged
127 SubMirror::fixIndexes($schema);
132 * Set up queue handlers for outgoing hub pushes
133 * @param QueueManager $qm
134 * @return boolean hook return
136 function onEndInitializeQueueManager(QueueManager $qm)
138 // After each notice save, check if there's any repeat mirrors.
139 $qm->connect('mirror', 'MirrorQueueHandler');
143 function onStartEnqueueNotice($notice, &$transports)
145 $transports[] = 'mirror';
149 * Let the OStatus subscription garbage collection know if we're
150 * making use of a remote feed, so it doesn't get dropped out
153 * @param Ostatus_profile $oprofile
154 * @param int $count in/out
155 * @return mixed hook return value
157 function onOstatus_profileSubscriberCount($oprofile, &$count)
159 if ($oprofile->profile_id) {
160 $mirror = new SubMirror();
161 $mirror->subscribed = $oprofile->profile_id;
162 if ($mirror->find()) {
163 while ($mirror->fetch()) {
172 * Add a count of mirrored feeds into a user's profile sidebar stats.
174 * @param Profile $profile
175 * @param array $stats
176 * @return boolean hook return value
178 function onProfileStats($profile, &$stats)
180 $cur = common_current_user();
181 if (!empty($cur) && $cur->id == $profile->id) {
182 $mirror = new SubMirror();
183 $mirror->subscriber = $profile->id;
186 'label' => _m('Mirrored feeds'),
187 'link' => common_local_url('mirrorsettings'),
188 'value' => $mirror->count(),
191 $insertAt = count($stats);
192 foreach ($stats as $i => $row) {
193 if ($row['id'] == 'groups') {
194 // Slip us in after them.
199 array_splice($stats, $insertAt, 0, array($entry));