*/
abstract class ActivityHandlerPlugin extends Plugin
{
+ /**
+ * Returns a key string which represents this activity in HTML classes,
+ * ids etc, as when offering selection of what type of post to make.
+ * In MicroAppPlugin, this is paired with the user-visible localizable appTitle().
+ *
+ * @return string (compatible with HTML classes)
+ */
+ abstract function tag();
+
/**
* Return a list of ActivityStreams object type IRIs
* which this micro-app handles. Default implementations
*
* An empty list means any type is ok. (Favorite verb etc.)
*
- * All micro-app classes must override this method.
- *
* @return array of strings
*/
abstract function types();
*
* @return array of strings
*/
- function verbs() {
+ public function verbs() {
return array(ActivityVerb::POST);
}
*/
abstract function deleteRelated(Notice $notice);
+ protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
+ {
+ // pass through silently by default
+ }
+
/**
* Called when generating Atom XML ActivityStreams output from an
* ActivityObject belonging to this plugin. Gives the plugin
*/
function onNoticeDeleteRelated(Notice $notice)
{
- if (!$this->isMyNotice($notice)) {
+ if ($this->isMyNotice($notice)) {
+ $this->deleteRelated($notice);
+ }
+
+ // Always continue this event in our activity handling plugins.
+ return true;
+ }
+
+ /**
+ * @param Notice $stored The notice being distributed
+ * @param array &$mentioned_ids List of profiles (from $stored->getReplies())
+ */
+ public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
+ {
+ if (!$this->isMyNotice($stored)) {
return true;
}
- $this->deleteRelated($notice);
+ $this->notifyMentioned($stored, $mentioned_ids);
+
+ // If it was _our_ notice, only we should do anything with the mentions.
+ return false;
}
/**
* Handle object posted via AtomPub
*
* @param Activity &$activity Activity that was posted
- * @param User $user User that posted it
+ * @param Profile $scoped Profile of user posting
* @param Notice &$notice Resulting notice
*
* @return boolean hook value
*/
- function onStartAtomPubNewActivity(Activity &$activity, $user, &$notice)
+ // FIXME: Make sure we can really do strong Notice typing with a $notice===null without having =null here
+ public function onStartAtomPubNewActivity(Activity &$activity, Profile $scoped, Notice &$notice)
{
if (!$this->isMyActivity($activity)) {
return true;
$options = array('source' => 'atompub');
- // $user->getProfile() is a Profile
- $notice = $this->saveNoticeFromActivity($activity,
- $user->getProfile(),
- $options);
+ $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
+
+ Event::handle('EndAtomPubNewActivity', array($activity, $scoped, $notice));
return false;
}
}
return true;
}
+
+ public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
+ {
+ if (!$this->isMyNotice($nli->notice)) {
+ return true;
+ }
+
+ $this->openNoticeListItemElement($nli);
+
+ Event::handle('EndOpenNoticeListItemElement', array($nli));
+ return false;
+ }
+
+ public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
+ {
+ if (!$this->isMyNotice($nli->notice)) {
+ return true;
+ }
+
+ $this->closeNoticeListItemElement($nli);
+
+ Event::handle('EndCloseNoticeListItemElement', array($nli));
+ return false;
+ }
+
+ protected function openNoticeListItemElement(NoticeListItem $nli)
+ {
+ $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
+ $class = 'h-entry notice ' . $this->tag();
+ if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
+ $class .= ' limited-scope';
+ }
+ $nli->out->elementStart('li', array('class' => $class,
+ 'id' => 'notice-' . $id));
+ }
+
+ protected function closeNoticeListItemElement(NoticeListItem $nli)
+ {
+ $nli->out->elementEnd('li');
+ }
+
+
+ // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
+ public function onStartShowNoticeItem(NoticeListItem $nli)
+ {
+ if (!$this->isMyNotice($nli->notice)) {
+ return true;
+ }
+
+ try {
+ $this->showNoticeListItem($nli);
+ } catch (Exception $e) {
+ $nli->out->element('p', 'error', 'Error showing notice: '.htmlspecialchars($e->getMessage()));
+ }
+
+ Event::handle('EndShowNoticeItem', array($nli));
+ return false;
+ }
+
+ protected function showNoticeListItem(NoticeListItem $nli)
+ {
+ $nli->showNotice();
+ $nli->showNoticeAttachments();
+ $nli->showNoticeInfo();
+ $nli->showNoticeOptions();
+
+ $nli->showNoticeLink();
+ $nli->showNoticeSource();
+ $nli->showNoticeLocation();
+ $nli->showPermalink();
+ $nli->showRepeat();
+
+ $nli->showNoticeOptions();
+ }
+
+ public function onStartShowNoticeItemNotice(NoticeListItem $nli)
+ {
+ if (!$this->isMyNotice($nli->notice)) {
+ return true;
+ }
+
+ $this->showNoticeItemNotice($nli);
+
+ Event::handle('EndShowNoticeItemNotice', array($nli));
+ return false;
+ }
+
+ protected function showNoticeItemNotice(NoticeListItem $nli)
+ {
+ $nli->showNoticeTitle();
+ $nli->showAuthor();
+ $nli->showAddressees();
+ $nli->showContent();
+ }
+
+ public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ if (!$this->isMyNotice($stored)) {
+ return true;
+ }
+
+ $this->showNoticeContent($stored, $out, $scoped);
+ return false;
+ }
+
+ protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ $out->text($stored->getContent());
+ }
}