*/
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);
}
function isMyVerb($verb) {
$verb = $verb ?: ActivityVerb::POST; // post is the default verb
- return ActivityUtils::compareTypes($verb, $this->verbs());
+ return ActivityUtils::compareVerbs($verb, $this->verbs());
}
function isMyType($type) {
* @fixme are there any standard options?
*
* @param Activity $activity
- * @param Profile $actor
+ * @param Notice $stored The notice in our database for this certain object
* @param array $options=array()
*
- * @return Notice the resulting notice
+ * @return object If the verb handling plugin creates an object, it can be returned here (otherwise true)
+ * @throws exception On any error.
*/
protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
{
* This usually gets called from Notice::saveActivity after a Notice object has been created,
* so it contains a proper id and a uri for the object to be saved.
*/
- public function onStoreActivityObject(Activity $act, Notice $stored, array $options=array(), &$object) {
+ public function onStoreActivityObject(Activity $act, Notice $stored, array $options, &$object) {
// $this->oldSaveNew is there during a migration period of plugins, to start using
// Notice::saveActivity instead of Notice::saveNew
if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
}
$object = $this->saveObjectFromActivity($act, $stored, $options);
try {
- $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
+ // In the future we probably want to use something like ActivityVerb_DataObject for the kind
+ // of objects which are returned from saveObjectFromActivity.
+ if ($object instanceof Managed_DataObject) {
+ // If the verb handling plugin figured out some more attention URIs, add them here to the
+ // original activity. This is only done if a separate object is actually needed to be saved.
+ $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
+ }
} catch (Exception $e) {
common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
}
*/
abstract function deleteRelated(Notice $notice);
+ protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
+ {
+ // pass through silently by default
+
+ // If we want to stop any other plugin from notifying based on this activity, return false instead.
+ return true;
+ }
+
/**
* Called when generating Atom XML ActivityStreams output from an
* ActivityObject belonging to this plugin. Gives the plugin
*
* @return boolean hook value
*/
- function onNoticeDeleteRelated(Notice $notice)
+ public function onNoticeDeleteRelated(Notice $notice)
{
- if (!$this->isMyNotice($notice)) {
+ if ($this->isMyNotice($notice)) {
+ try {
+ $this->deleteRelated($notice);
+ } catch (AlreadyFulfilledException $e) {
+ // Nothing to see here, it's obviously already gone...
+ }
+ }
+
+ // 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);
+ return $this->notifyMentioned($stored, $mentioned_ids);
}
/**
throw new ClientException(_('Object not posted to this group.'));
}
} elseif ($target instanceof Profile && $target->isLocal()) {
- common_debug(get_called_class() . ' got a salmon slap against target profile ID: '.$target->id);
$original = null;
// FIXME: Shouldn't favorites show up with a 'target' activityobject?
- if (!ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
+ if (!ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
// If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
if (!empty($activity->objects[0]->id)) {
$activity->context->replyToID = $activity->objects[0]->id;
throw new ServerException(_('Do not know how to handle this kind of target.'));
}
- common_debug(get_called_class() . ' ensuring ActivityObject profile for '.$activity->actor->id);
- $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
+ $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
+ $actor = $oactor->localProfile();
// FIXME: will this work in all cases? I made it work for Favorite...
- if (ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST))) {
+ if (ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST))) {
$object = $activity->objects[0];
} else {
$object = $activity;
'is_local' => Notice::REMOTE,
'source' => 'ostatus');
- // $actor is an ostatus_profile
- common_debug(get_called_class() . ' going to save notice from activity!');
if (!isset($this->oldSaveNew)) {
- $notice = Notice::saveActivity($activity, $target, $options);
+ $notice = Notice::saveActivity($activity, $actor, $options);
} else {
- $notice = $this->saveNoticeFromActivity($activity, $target, $options);
+ $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
}
return false;
/**
* Handle object posted via AtomPub
*
- * @param Activity &$activity Activity that was posted
- * @param User $user User that posted it
+ * @param Activity $activity Activity that was posted
+ * @param Profile $scoped Profile of user posting
* @param Notice &$notice Resulting notice
*
* @return boolean hook value
*/
- function onStartAtomPubNewActivity(Activity &$activity, $user, &$notice)
+ public function onStartAtomPubNewActivity(Activity $activity, Profile $scoped, Notice &$notice=null)
{
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);
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) {
+ common_log(LOG_ERR, 'Error showing notice: ' . $e->getMessage());
+ $nli->out->element('p', 'error', sprintf(_('Error showing notice: %s'), $e->getMessage()));
+ }
+
+ Event::handle('EndShowNoticeItem', array($nli));
+ return false;
+ }
+
+ protected function showNoticeListItem(NoticeListItem $nli)
+ {
+ $nli->showNoticeHeaders();
+ $nli->showContent();
+ $nli->showNoticeFooter();
+ }
+
+ 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;
+ }
+
+ try {
+ $this->showNoticeContent($stored, $out, $scoped);
+ } catch (Exception $e) {
+ $out->element('div', 'error', $e->getMessage());
+ }
+ return false;
+ }
+
+ protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ $out->text($stored->getContent());
+ }
}
projects / quix0rs-gnu-social.git / blobdiff