3 * GNU Social - a federating social network
4 * Copyright (C) 2014, Free Software Foundation, 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('GNUSOCIAL')) { exit(1); }
24 * @maintainer Mikael Nordfeldth <mmn@hethane.se>
26 class SharePlugin extends ActivityVerbHandlerPlugin
33 public function types()
38 public function verbs()
40 return array(ActivityVerb::SHARE);
43 public function onRouterInitialized(URLMapper $m)
46 $m->connect('main/repeat', array('action' => 'repeat'));
48 // Share for Twitter API ("Retweet")
49 $m->connect('api/statuses/retweeted_by_me.:format',
50 array('action' => 'ApiTimelineRetweetedByMe',
51 'format' => '(xml|json|atom|as)'));
53 $m->connect('api/statuses/retweeted_to_me.:format',
54 array('action' => 'ApiTimelineRetweetedToMe',
55 'format' => '(xml|json|atom|as)'));
57 $m->connect('api/statuses/retweets_of_me.:format',
58 array('action' => 'ApiTimelineRetweetsOfMe',
59 'format' => '(xml|json|atom|as)'));
61 $m->connect('api/statuses/retweet/:id.:format',
62 array('action' => 'ApiStatusesRetweet',
64 'format' => '(xml|json)'));
66 $m->connect('api/statuses/retweets/:id.:format',
67 array('action' => 'ApiStatusesRetweets',
69 'format' => '(xml|json)'));
72 // FIXME: Set this to abstract public in lib/activityhandlerplugin.php when all plugins have migrated!
73 protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
75 assert($this->isMyActivity($act));
77 // The below algorithm is mainly copied from the previous Ostatus_profile->processShare()
79 if (count($act->objects) !== 1) {
80 // TRANS: Client exception thrown when trying to share multiple activities at once.
81 throw new ClientException(_m('Can only handle share activities with exactly one object.'));
84 $shared = $act->objects[0];
85 if (!$shared instanceof Activity) {
86 // TRANS: Client exception thrown when trying to share a non-activity object.
87 throw new ClientException(_m('Can only handle shared activities.'));
90 $sharedUri = $shared->id;
91 if (!empty($shared->objects[0]->id)) {
92 // Because StatusNet since commit 8cc4660 sets $shared->id to a TagURI which
93 // fucks up federation, because the URI is no longer recognised by the origin.
94 // So we set it to the object ID if it exists, otherwise we trust $shared->id
95 $sharedUri = $shared->objects[0]->id;
97 if (empty($sharedUri)) {
98 throw new ClientException(_m('Shared activity does not have an id'));
102 // First check if we have the shared activity. This has to be done first, because
103 // we can't use these functions to "ensureActivityObjectProfile" of a local user,
104 // who might be the creator of the shared activity in question.
105 $sharedNotice = Notice::getByUri($sharedUri);
106 } catch (NoResultException $e) {
107 // If no locally stored notice is found, process it!
108 // TODO: Remember to check Deleted_notice!
109 // TODO: If a post is shared that we can't retrieve - what to do?
110 $other = Ostatus_profile::ensureActivityObjectProfile($shared->actor);
111 $sharedNotice = $other->processActivity($shared, 'push'); // FIXME: push/salmon/what?
112 if (!$sharedNotice instanceof Notice) {
113 // And if we apparently can't get the shared notice, we'll abort the whole thing.
114 // TRANS: Client exception thrown when saving an activity share fails.
115 // TRANS: %s is a share ID.
116 throw new ClientException(sprintf(_m('Failed to save activity %s.'), $sharedUri));
118 } catch (FeedSubException $e) {
119 // Remote feed could not be found or verified, should we
120 // transform this into an "RT @user Blah, blah, blah..."?
121 common_log(LOG_INFO, __METHOD__ . ' got a ' . get_class($e) . ': ' . $e->getMessage());
125 // We don't have to save a repeat in a separate table, we can
126 // find repeats by just looking at the notice.repeat_of field.
128 // By returning true here instead of something that evaluates
129 // to false, we show that we have processed everything properly.
133 // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
134 // with the other microapps/activityhandlers as well.
135 // Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
136 public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
138 if (!$this->isMyNotice($stored)) {
142 common_debug('Extending activity '.$stored->id.' with '.get_called_class());
143 $this->extendActivity($stored, $act, $scoped);
147 public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
149 // TODO: How to handle repeats of deleted notices?
150 $target = Notice::getById($stored->repeat_of);
151 // TRANS: A repeat activity's title. %1$s is repeater's nickname
152 // and %2$s is the repeated user's nickname.
153 $act->title = sprintf(_('%1$s repeated a notice by %2$s'),
154 $stored->getProfile()->getNickname(),
155 $target->getProfile()->getNickname());
156 $act->objects[] = $target->asActivity($scoped);
159 public function activityObjectFromNotice(Notice $notice)
161 // Repeat is a little bit special. As it's an activity, our
162 // ActivityObject is instead turned into an Activity
163 $object = new Activity();
164 $object->verb = ActivityVerb::SHARE;
165 $object->content = $notice->rendered;
166 $this->extendActivity($stored, $act);
171 public function deleteRelated(Notice $notice)
173 // No action needed as we don't have a separate table for share objects.
179 public function onEndShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
181 if ($nli instanceof ThreadedNoticeListSubItem) {
182 // The sub-items are replies to a conversation, thus we use different HTML elements etc.
183 $item = new ThreadedNoticeListInlineRepeatsItem($notice, $nli->out);
185 $item = new ThreadedNoticeListRepeatsItem($notice, $nli->out);
187 $threadActive = $item->show() || $threadActive;
192 * show the "repeat" form in the notice options element
193 * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
197 public function onEndShowNoticeOptionItems($nli)
199 // FIXME: Use bitmasks (but be aware that PUBLIC_SCOPE is 0!)
200 if ($nli->notice->scope == Notice::PUBLIC_SCOPE ||
201 $nli->notice->scope == Notice::SITE_SCOPE) {
202 $scoped = Profile::current();
203 if ($scoped instanceof Profile &&
204 $scoped->getID() !== $nli->notice->getProfile()->getID()) {
206 if ($scoped->hasRepeated($nli->notice)) {
207 $nli->out->element('span', array('class' => 'repeated',
208 // TRANS: Title for repeat form status in notice list when a notice has been repeated.
209 'title' => _('Notice repeated.')),
210 // TRANS: Repeat form status in notice list when a notice has been repeated.
213 $repeat = new RepeatForm($nli->out, $nli->notice);
220 public function showNoticeListItem(NoticeListItem $nli)
224 public function openNoticeListItemElement(NoticeListItem $nli)
228 public function closeNoticeListItemElement(NoticeListItem $nli)
234 * EndInterpretCommand for RepeatPlugin will handle the 'repeat' command
235 * using the class RepeatCommand.
237 * @param string $cmd Command being run
238 * @param string $arg Rest of the message (including address)
239 * @param User $user User sending the message
240 * @param Command &$result The resulting command object to be run.
242 * @return boolean hook value
244 public function onStartInterpretCommand($cmd, $arg, $user, &$result)
246 if ($result === false && in_array($cmd, array('repeat', 'rp', 'rt', 'rd'))) {
250 list($other, $extra) = CommandInterpreter::split_arg($arg);
251 if (!empty($extra)) {
254 $result = new RepeatCommand($user, $other);
262 public function onHelpCommandMessages(HelpCommand $help, array &$commands)
264 // TRANS: Help message for IM/SMS command "repeat #<notice_id>".
265 $commands['repeat #<notice_id>'] = _m('COMMANDHELP', "repeat a notice with a given id");
266 // TRANS: Help message for IM/SMS command "repeat <nickname>".
267 $commands['repeat <nickname>'] = _m('COMMANDHELP', "repeat the last notice from user");
271 * Are we allowed to perform a certain command over the API?
273 public function onCommandSupportedAPI(Command $cmd, &$supported)
275 $supported = $supported || $cmd instanceof RepeatCommand;
278 protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
283 protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
288 protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
290 // handle repeat POST
293 protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
295 return new RepeatForm($action, $target);
298 public function onPluginVersion(array &$versions)
300 $versions[] = array('name' => 'Share verb',
301 'version' => GNUSOCIAL_VERSION,
302 'author' => 'Mikael Nordfeldth',
303 'homepage' => 'https://gnu.io/',
305 // TRANS: Plugin description.
306 _m('Shares (repeats) using ActivityStreams.'));