3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * Superclass for microapp plugin
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Evan Prodromou <evan@status.net>
26 * @copyright 2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Superclass for microapp plugins
40 * This class lets you define micro-applications with different kinds of activities.
42 * The applications work more-or-less like other
46 * @author Evan Prodromou <evan@status.net>
47 * @copyright 2011 StatusNet, Inc.
48 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
49 * @link http://status.net/
52 abstract class MicroAppPlugin extends Plugin
54 abstract function appTitle();
55 abstract function tag();
56 abstract function types();
57 abstract function saveNoticeFromActivity($activity, $actor);
58 abstract function activityObjectFromNotice($notice);
59 abstract function showNotice($notice, $out);
60 abstract function entryForm($out);
61 abstract function deleteRelated($notice);
63 function isMyNotice($notice) {
64 $types = $this->types();
65 return in_array($notice->object_type, $types);
68 function isMyActivity($activity) {
69 $types = $this->types();
70 return (count($activity->objects) == 1 &&
71 in_array($activity->objects[0]->type, $types));
75 * When a notice is deleted, delete the related objects
77 * @param Notice $notice Notice being deleted
79 * @return boolean hook value
82 function onNoticeDeleteRelated($notice)
84 if ($this->isMyNotice($notice)) {
85 $this->deleteRelated($notice);
92 * Output the HTML for this kind of object in a list
94 * @param NoticeListItem $nli The list item being shown.
96 * @return boolean hook value
99 function onStartShowNoticeItem($nli)
101 if (!$this->isMyNotice($nli->notice)) {
107 $this->showNotice($notice, $out);
109 $nli->showNoticeLink();
110 $nli->showNoticeSource();
111 $nli->showNoticeLocation();
115 $out->elementEnd('div');
117 $nli->showNoticeOptions();
123 * Render a notice as one of our objects
125 * @param Notice $notice Notice to render
126 * @param ActivityObject &$object Empty object to fill
128 * @return boolean hook value
131 function onStartActivityObjectFromNotice($notice, &$object)
133 if ($this->isMyNotice($notice)) {
134 $object = $this->activityObjectFromNotice($notice);
142 * Handle a posted object from PuSH
144 * @param Activity $activity activity to handle
145 * @param Ostatus_profile $oprofile Profile for the feed
147 * @return boolean hook value
150 function onStartHandleFeedEntryWithProfile($activity, $oprofile)
152 if ($this->isMyActivity($activity)) {
154 $actor = $oprofile->checkAuthorship($activity);
157 throw new ClientException(_('Can\'t get author for activity.'));
160 $this->saveNoticeFromActivity($activity, $actor);
169 * Handle a posted object from Salmon
171 * @param Activity $activity activity to handle
172 * @param mixed $target user or group targeted
174 * @return boolean hook value
177 function onStartHandleSalmonTarget($activity, $target)
179 if ($this->isMyActivity($activity)) {
181 $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
183 if ($target instanceof User_group) {
184 $uri = $target->getUri();
185 if (!in_array($uri, $activity->context->attention)) {
186 throw new ClientException(_("Bookmark not posted ".
189 } else if ($target instanceof User) {
192 if (!empty($activity->context->replyToID)) {
193 $original = Notice::staticGet('uri',
194 $activity->context->replyToID);
196 if (!in_array($uri, $activity->context->attention) &&
198 $original->profile_id != $target->id)) {
199 throw new ClientException(_("Bookmark not posted ".
203 throw new ServerException(_("Don't know how to handle ".
204 "this kind of target."));
207 $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
209 $this->saveNoticeFromActivity($activity, $actor);
218 * Handle object posted via AtomPub
220 * @param Activity &$activity Activity that was posted
221 * @param User $user User that posted it
222 * @param Notice &$notice Resulting notice
224 * @return boolean hook value
227 function onStartAtomPubNewActivity(&$activity, $user, &$notice)
229 if ($this->isMyActivity($activity)) {
231 $options = array('source' => 'atompub');
233 $this->saveNoticeFromActivity($activity,
244 * Handle object imported from a backup file
246 * @param User $user User to import for
247 * @param ActivityObject $author Original author per import file
248 * @param Activity $activity Activity to import
249 * @param boolean $trusted Is this a trusted user?
250 * @param boolean &$done Is this done (success or unrecoverable error)
252 * @return boolean hook value
255 function onStartImportActivity($user, $author, $activity, $trusted, &$done)
257 if ($this->isMyActivity($activity)) {
259 $obj = $activity->objects[0];
261 $options = array('uri' => $bookmark->id,
262 'url' => $bookmark->link,
263 'source' => 'restore');
265 $saved = $this->saveNoticeFromActivity($activity,
269 if (!empty($saved)) {