X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FOStatus%2FOStatusPlugin.php;h=dd150995420717d891189490607cd1e9e33bcc3f;hb=bf121a695a13c2b30abf57ea86afbe1e6c2420a7;hp=6fef20d6f59172a085d345445ced56adce66a8ca;hpb=41dfea163460bb216483e8e12fff7a8afefbb4fb;p=quix0rs-gnu-social.git diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php index 6fef20d6f5..39a1619104 100644 --- a/plugins/OStatus/OStatusPlugin.php +++ b/plugins/OStatus/OStatusPlugin.php @@ -22,7 +22,9 @@ * @maintainer Brion Vibber */ -if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } +if (!defined('STATUSNET')) { + exit(1); +} set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/'); @@ -50,22 +52,29 @@ class OStatusPlugin extends Plugin function onRouterInitialized($m) { // Discovery actions - $m->connect('.well-known/host-meta', - array('action' => 'hostmeta')); - $m->connect('main/xrd', - array('action' => 'userxrd')); $m->connect('main/ownerxrd', array('action' => 'ownerxrd')); $m->connect('main/ostatus', array('action' => 'ostatusinit')); + $m->connect('main/ostatustag', + array('action' => 'ostatustag')); + $m->connect('main/ostatustag?nickname=:nickname', + array('action' => 'ostatustag'), array('nickname' => '[A-Za-z0-9_-]+')); $m->connect('main/ostatus?nickname=:nickname', array('action' => 'ostatusinit'), array('nickname' => '[A-Za-z0-9_-]+')); $m->connect('main/ostatus?group=:group', array('action' => 'ostatusinit'), array('group' => '[A-Za-z0-9_-]+')); + $m->connect('main/ostatus?peopletag=:peopletag&tagger=:tagger', + array('action' => 'ostatusinit'), array('tagger' => '[A-Za-z0-9_-]+', + 'peopletag' => '[A-Za-z0-9_-]+')); + + // Remote subscription actions $m->connect('main/ostatussub', array('action' => 'ostatussub')); $m->connect('main/ostatusgroup', array('action' => 'ostatusgroup')); + $m->connect('main/ostatuspeopletag', + array('action' => 'ostatuspeopletag')); // PuSH actions $m->connect('main/push/hub', array('action' => 'pushhub')); @@ -81,6 +90,9 @@ class OStatusPlugin extends Plugin $m->connect('main/salmon/group/:id', array('action' => 'groupsalmon'), array('id' => '[0-9]+')); + $m->connect('main/salmon/peopletag/:id', + array('action' => 'peopletagsalmon'), + array('id' => '[0-9]+')); return true; } @@ -147,12 +159,14 @@ class OStatusPlugin extends Plugin $user = $feed->getUser(); $id = $user->id; $profile = $user->getProfile(); - $feed->setActivitySubject($profile->asActivityNoun('subject')); } else if ($feed instanceof AtomGroupNoticeFeed) { $salmonAction = 'groupsalmon'; $group = $feed->getGroup(); $id = $group->id; - $feed->setActivitySubject($group->asActivitySubject()); + } else if ($feed instanceof AtomListNoticeFeed) { + $salmonAction = 'peopletagsalmon'; + $peopletag = $feed->getList(); + $id = $peopletag->id; } else { return true; } @@ -213,49 +227,135 @@ class OStatusPlugin extends Plugin * Add in an OStatus subscribe button */ function onStartProfileRemoteSubscribe($output, $profile) + { + $this->onStartProfileListItemActionElements($output, $profile); + return false; + } + + function onStartGroupSubscribe($widget, $group) { $cur = common_current_user(); if (empty($cur)) { - // Add an OStatus subscribe $output->elementStart('li', 'entity_subscribe'); + $profile = $peopletag->getTagger(); $url = common_local_url('ostatusinit', - array('nickname' => $profile->nickname)); - $output->element('a', array('href' => $url, + array('group' => $group->nickname)); + $widget->out->element('a', array('href' => $url, 'class' => 'entity_remote_subscribe'), _m('Subscribe')); $output->elementEnd('li'); + return false; } - return false; + return true; } - function onStartGroupSubscribe($output, $group) + function onStartSubscribePeopletagForm($output, $peopletag) { $cur = common_current_user(); if (empty($cur)) { - // Add an OStatus subscribe + $output->elementStart('li', 'entity_subscribe'); + $profile = $peopletag->getTagger(); $url = common_local_url('ostatusinit', - array('group' => $group->nickname)); + array('tagger' => $profile->nickname, 'peopletag' => $peopletag->tag)); $output->element('a', array('href' => $url, 'class' => 'entity_remote_subscribe'), - _m('Join')); + _m('Subscribe')); + + $output->elementEnd('li'); + return false; } return true; } - /** - * Check if we've got remote replies to send via Salmon. - * - * @fixme push webfinger lookup & sending to a background queue - * @fixme also detect short-form name for remote subscribees where not ambiguous - */ + function onStartShowTagProfileForm($action, $profile) + { + $action->elementStart('form', array('method' => 'post', + 'id' => 'form_tag_user', + 'class' => 'form_settings', + 'name' => 'tagprofile', + 'action' => common_local_url('tagprofile', array('id' => @$profile->id)))); + + $action->elementStart('fieldset'); + $action->element('legend', null, _('Tag remote profile')); + $action->hidden('token', common_session_token()); + + $user = common_current_user(); + + $action->elementStart('ul', 'form_data'); + $action->elementStart('li'); - function onEndNoticeSave($notice) + $action->input('uri', _('Remote profile'), $action->trimmed('uri'), + _('OStatus user\'s address, like nickname@example.com or http://example.net/nickname')); + $action->elementEnd('li'); + $action->elementEnd('ul'); + $action->submit('fetch', _('Fetch')); + $action->elementEnd('fieldset'); + $action->elementEnd('form'); + } + + function onStartTagProfileAction($action, $profile) { + $err = null; + $uri = $action->trimmed('uri'); + + if (!$profile && $uri) { + try { + if (Validate::email($uri)) { + $oprofile = Ostatus_profile::ensureWebfinger($uri); + } else if (Validate::uri($uri)) { + $oprofile = Ostatus_profile::ensureProfileURL($uri); + } else { + throw new Exception('Invalid URI'); + } + + // redirect to the new profile. + common_redirect(common_local_url('tagprofile', array('id' => $oprofile->profile_id)), 303); + return false; + + } catch (Exception $e) { + $err = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname"); + } + + $action->showForm($err); + return false; + } + return true; + } + + /* + * If the field being looked for is URI look for the profile + */ + function onStartProfileCompletionSearch($action, $profile, $search_engine) { + if ($action->field == 'uri') { + $user = new User(); + $profile->joinAdd($user); + $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"'); + $profile->query(); + + if ($profile->N == 0) { + try { + if (Validate::email($q)) { + $oprofile = Ostatus_profile::ensureWebfinger($q); + } else if (Validate::uri($q)) { + $oprofile = Ostatus_profile::ensureProfileURL($q); + } else { + throw new Exception('Invalid URI'); + } + return $this->filter(array($oprofile->localProfile())); + + } catch (Exception $e) { + $this->msg = _m("Sorry, we could not reach that address. Please make sure that the OStatus address is like nickname@example.com or http://example.net/nickname"); + return array(); + } + } + return false; + } + return true; } /** @@ -432,12 +532,12 @@ class OStatusPlugin extends Plugin } function onEndShowStatusNetStyles($action) { - $action->cssLink('plugins/OStatus/theme/base/css/ostatus.css'); + $action->cssLink($this->path('theme/base/css/ostatus.css')); return true; } function onEndShowStatusNetScripts($action) { - $action->script('plugins/OStatus/js/ostatus.js'); + $action->script($this->path('js/ostatus.js')); return true; } @@ -464,6 +564,7 @@ class OStatusPlugin extends Plugin } $url = $notice->url; + // TRANSLATE: %s is a domain. $title = sprintf(_m("Sent from %s via OStatus"), $domain); return false; } @@ -492,7 +593,7 @@ class OStatusPlugin extends Plugin * Tell the FeedSub infrastructure whether we have any active OStatus * usage for the feed; if not it'll be able to garbage-collect the * feed subscription. - * + * * @param FeedSub $feedsub * @param integer $count in/out * @return mixed hook return code @@ -535,6 +636,7 @@ class OStatusPlugin extends Plugin } if (!$oprofile->subscribe()) { + // TRANS: Exception. throw new Exception(_m('Could not set up remote subscription.')); } } @@ -564,23 +666,10 @@ class OStatusPlugin extends Plugin return true; } - $act = new Activity(); + $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id, + 'subscribed' => $other->id)); - $act->verb = ActivityVerb::FOLLOW; - - $act->id = TagURI::mint('follow:%d:%d:%s', - $subscriber->id, - $other->id, - common_date_iso8601(time())); - - $act->time = time(); - $act->title = _("Follow"); - $act->content = sprintf(_("%s is now following %s."), - $subscriber->getBestName(), - $other->getBestName()); - - $act->actor = ActivityObject::fromProfile($subscriber); - $act->object = ActivityObject::fromProfile($other); + $act = $sub->asActivity(); $oprofile->notifyActivity($act, $subscriber); @@ -622,8 +711,10 @@ class OStatusPlugin extends Plugin common_date_iso8601(time())); $act->time = time(); - $act->title = _("Unfollow"); - $act->content = sprintf(_("%s stopped following %s."), + $act->title = _m('Unfollow'); + // TRANS: Success message for unsubscribe from user attempt through OStatus. + // TRANS: %1$s is the unsubscriber's name, %2$s is the unsubscribed user's name. + $act->content = sprintf(_m('%1$s stopped following %2$s.'), $profile->getBestName(), $other->getBestName()); @@ -654,6 +745,9 @@ class OStatusPlugin extends Plugin throw new Exception(_m('Could not set up remote group membership.')); } + // NOTE: we don't use Group_member::asActivity() since that record + // has not yet been created. + $member = Profile::staticGet($user->id); $act = new Activity(); @@ -668,7 +762,9 @@ class OStatusPlugin extends Plugin $act->time = time(); $act->title = _m("Join"); - $act->content = sprintf(_m("%s has joined group %s."), + // TRANS: Success message for subscribe to group attempt through OStatus. + // TRANS: %1$s is the member name, %2$s is the subscribed group's name. + $act->content = sprintf(_m('%1$s has joined group %2$s.'), $member->getBestName(), $oprofile->getBestName()); @@ -676,6 +772,7 @@ class OStatusPlugin extends Plugin return true; } else { $oprofile->garbageCollect(); + // TRANS: Exception. throw new Exception(_m("Failed joining remote group.")); } } @@ -691,7 +788,7 @@ class OStatusPlugin extends Plugin * it'll be left with a stray membership record. * * @param User_group $group - * @param User $user + * @param Profile $user * * @return mixed hook return value */ @@ -717,7 +814,9 @@ class OStatusPlugin extends Plugin $act->time = time(); $act->title = _m("Leave"); - $act->content = sprintf(_m("%s has left group %s."), + // TRANS: Success message for unsubscribe from group attempt through OStatus. + // TRANS: %1$s is the member name, %2$s is the unsubscribed group's name. + $act->content = sprintf(_m('%1$s has left group %2$s.'), $member->getBestName(), $oprofile->getBestName()); @@ -725,6 +824,95 @@ class OStatusPlugin extends Plugin } } + /** + * When one of our local users tries to subscribe to a remote peopletag, + * notify the remote server. If the notification is rejected, + * deny the subscription. + * + * @param Profile_list $peopletag + * @param User $user + * + * @return mixed hook return value + */ + + function onStartSubscribePeopletag($peopletag, $user) + { + $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->id); + if ($oprofile) { + if (!$oprofile->subscribe()) { + throw new Exception(_m('Could not set up remote peopletag subscription.')); + } + + $sub = $user->getProfile(); + $tagger = Profile::staticGet($peopletag->tagger); + + $act = new Activity(); + $act->id = TagURI::mint('subscribe_peopletag:%d:%d:%s', + $sub->id, + $peopletag->id, + common_date_iso8601(time())); + + $act->actor = ActivityObject::fromProfile($sub); + $act->verb = ActivityVerb::FOLLOW; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + $act->title = _m("Follow list"); + $act->content = sprintf(_m("%s is now following people tagged %s by %s."), + $sub->getBestName(), + $oprofile->getBestName(), + $tagger->getBestName()); + + if ($oprofile->notifyActivity($act, $sub)) { + return true; + } else { + $oprofile->garbageCollect(); + throw new Exception(_m("Failed subscribing to remote peopletag.")); + } + } + } + + /** + * When one of our local users unsubscribes to a remote peopletag, notify the remote + * server. + * + * @param Profile_list $peopletag + * @param User $user + * + * @return mixed hook return value + */ + + function onEndUnsubscribePeopletag($peopletag, $user) + { + $oprofile = Ostatus_profile::staticGet('peopletag_id', $peopletag->id); + if ($oprofile) { + // Drop the PuSH subscription if there are no other subscribers. + $oprofile->garbageCollect(); + + $sub = Profile::staticGet($user->id); + $tagger = Profile::staticGet($peopletag->tagger); + + $act = new Activity(); + $act->id = TagURI::mint('unsubscribe_peopletag:%d:%d:%s', + $sub->id, + $peopletag->id, + common_date_iso8601(time())); + + $act->actor = ActivityObject::fromProfile($member); + $act->verb = ActivityVerb::UNFOLLOW; + $act->object = $oprofile->asActivityObject(); + + $act->time = time(); + $act->title = _m("Unfollow peopletag"); + $act->content = sprintf(_m("%s stopped following the list %s by %s."), + $sub->getBestName(), + $oprofile->getBestName(), + $tagger->getBestName()); + + $oprofile->notifyActivity($act, $user); + } + } + /** * Notify remote users when their notices get favorited. * @@ -732,7 +920,6 @@ class OStatusPlugin extends Plugin * @param Notice $notice being favored * @return hook return value */ - function onEndFavorNotice(Profile $profile, Notice $notice) { $user = User::staticGet('id', $profile->id); @@ -747,24 +934,102 @@ class OStatusPlugin extends Plugin return true; } + $fav = Fave::pkeyGet(array('user_id' => $user->id, + 'notice_id' => $notice->id)); + + if (empty($fav)) { + // That's weird. + return true; + } + + $act = $fav->asActivity(); + + $oprofile->notifyActivity($act, $profile); + + return true; + } + + function onEndTagProfile($ptag) + { + $oprofile = Ostatus_profile::staticGet('profile_id', $ptag->tagged); + + if (empty($oprofile)) { + return true; + } + + $plist = $ptag->getMeta(); + if ($plist->private) { + return true; + } + $act = new Activity(); - $act->verb = ActivityVerb::FAVORITE; - $act->id = TagURI::mint('favor:%d:%d:%s', - $profile->id, - $notice->id, + $tagger = $plist->getTagger(); + $tagged = Profile::staticGet('id', $ptag->tagged); + + $act->verb = ActivityVerb::TAG; + $act->id = TagURI::mint('tag_profile:%d:%d:%s', + $plist->tagger, $plist->id, common_date_iso8601(time())); + $act->time = time(); + $act->title = _("Tag"); + $act->content = sprintf(_("%s tagged %s in the list %s"), + $tagger->getBestName(), + $tagged->getBestName(), + $plist->getBestName()); - $act->time = time(); - $act->title = _("Favor"); - $act->content = sprintf(_("%s marked notice %s as a favorite."), - $profile->getBestName(), - $notice->uri); + $act->actor = ActivityObject::fromProfile($tagger); + $act->objects = array(ActivityObject::fromProfile($tagged)); + $act->target = ActivityObject::fromPeopletag($plist); - $act->actor = ActivityObject::fromProfile($profile); - $act->object = ActivityObject::fromNotice($notice); + $oprofile->notifyActivity($act, $tagger); - $oprofile->notifyActivity($act, $profile); + // initiate a PuSH subscription for the person being tagged + if (!$oprofile->subscribe()) { + throw new Exception(sprintf(_('Could not complete subscription to remote '. + 'profile\'s feed. Tag %s could not be saved.'), $ptag->tag)); + return false; + } + return true; + } + + function onEndUntagProfile($ptag) + { + $oprofile = Ostatus_profile::staticGet('profile_id', $ptag->tagged); + + if (empty($oprofile)) { + return true; + } + + $plist = $ptag->getMeta(); + if ($plist->private) { + return true; + } + + $act = new Activity(); + + $tagger = $plist->getTagger(); + $tagged = Profile::staticGet('id', $ptag->tagged); + + $act->verb = ActivityVerb::UNTAG; + $act->id = TagURI::mint('untag_profile:%d:%d:%s', + $plist->tagger, $plist->id, + common_date_iso8601(time())); + $act->time = time(); + $act->title = _("Untag"); + $act->content = sprintf(_("%s untagged %s from the list %s"), + $tagger->getBestName(), + $tagged->getBestName(), + $plist->getBestName()); + + $act->actor = ActivityObject::fromProfile($tagger); + $act->objects = array(ActivityObject::fromProfile($tagged)); + $act->target = ActivityObject::fromPeopletag($plist); + + $oprofile->notifyActivity($act, $tagger); + + // unsubscribe to PuSH feed if no more required + $oprofile->garbageCollect(); return true; } @@ -800,8 +1065,10 @@ class OStatusPlugin extends Plugin $notice->id, common_date_iso8601(time())); $act->time = time(); - $act->title = _("Disfavor"); - $act->content = sprintf(_("%s marked notice %s as no longer a favorite."), + $act->title = _m('Disfavor'); + // TRANS: Success message for remove a favorite notice through OStatus. + // TRANS: %1$s is the unfavoring user's name, %2$s is URI to the no longer favored notice. + $act->content = sprintf(_m('%1$s marked notice %2$s as no longer a favorite.'), $profile->getBestName(), $notice->uri); @@ -875,8 +1142,9 @@ class OStatusPlugin extends Plugin $action->elementStart('p', array('id' => 'entity_remote_subscribe', 'class' => 'entity_subscribe')); $action->element('a', array('href' => common_local_url($target), - 'class' => 'entity_remote_subscribe') - , _m('Remote')); + 'class' => 'entity_remote_subscribe'), + // TRANS: Link text for link to remote subscribe. + _m('Remote')); $action->elementEnd('p'); $action->elementEnd('div'); } @@ -915,7 +1183,10 @@ class OStatusPlugin extends Plugin $profile->id, common_date_iso8601(time())); $act->time = time(); + // TRANS: Title for activity. $act->title = _m("Profile update"); + // TRANS: Ping text for remote profile update through OStatus. + // TRANS: %s is user that updated their profile. $act->content = sprintf(_m("%s has updated their profile page."), $profile->getBestName()); @@ -929,7 +1200,7 @@ class OStatusPlugin extends Plugin return true; } - function onStartProfileListItemActionElements($item) + function onStartProfileListItemActionElements($item, $profile=null) { if (!common_logged_in()) { @@ -937,7 +1208,12 @@ class OStatusPlugin extends Plugin if (!empty($profileUser)) { - $output = $item->out; + if ($item instanceof Action) { + $output = $item; + $profile = $item->profile; + } else { + $output = $item->out; + } // Add an OStatus subscribe $output->elementStart('li', 'entity_subscribe'); @@ -945,8 +1221,17 @@ class OStatusPlugin extends Plugin array('nickname' => $profileUser->nickname)); $output->element('a', array('href' => $url, 'class' => 'entity_remote_subscribe'), + // TRANS: Link text for a user to subscribe to an OStatus user. _m('Subscribe')); $output->elementEnd('li'); + + $output->elementStart('li', 'entity_tag'); + $url = common_local_url('ostatustag', + array('nickname' => $profileUser->nickname)); + $output->element('a', array('href' => $url, + 'class' => 'entity_remote_tag'), + _m('Tag')); + $output->elementEnd('li'); } } @@ -959,15 +1244,15 @@ class OStatusPlugin extends Plugin 'version' => STATUSNET_VERSION, 'author' => 'Evan Prodromou, James Walker, Brion Vibber, Zach Copley', 'homepage' => 'http://status.net/wiki/Plugin:OStatus', - 'rawdescription' => - _m('Follow people across social networks that implement '. + // TRANS: Plugin description. + 'rawdescription' => _m('Follow people across social networks that implement '. 'OStatus.')); return true; } /** - * Utility function to check if the given URL is a canonical group profile + * Utility function to check if the given URI is a canonical group profile * page, and if so return the ID number. * * @param string $url @@ -975,11 +1260,22 @@ class OStatusPlugin extends Plugin */ public static function localGroupFromUrl($url) { - $template = common_local_url('groupbyid', array('id' => '31337')); - $template = preg_quote($template, '/'); - $template = str_replace('31337', '(\d+)', $template); - if (preg_match("/$template/", $url, $matches)) { - return intval($matches[1]); + $group = User_group::staticGet('uri', $url); + if ($group) { + $local = Local_group::staticGet('group_id', $group->id); + if ($local) { + return $group->id; + } + } else { + // To find local groups which haven't had their uri fields filled out... + // If the domain has changed since a subscriber got the URI, it'll + // be broken. + $template = common_local_url('groupbyid', array('id' => '31337')); + $template = preg_quote($template, '/'); + $template = str_replace('31337', '(\d+)', $template); + if (preg_match("/$template/", $url, $matches)) { + return intval($matches[1]); + } } return false; } @@ -995,4 +1291,70 @@ class OStatusPlugin extends Plugin $feed = $oprofile->feeduri; return false; } + + function onStartGetProfileFromURI($uri, &$profile) + { + // Don't want to do Web-based discovery on our own server, + // so we check locally first. + + $user = User::staticGet('uri', $uri); + + if (!empty($user)) { + $profile = $user->getProfile(); + return false; + } + + // Now, check remotely + + $oprofile = Ostatus_profile::ensureProfileURI($uri); + + if (!empty($oprofile)) { + $profile = $oprofile->localProfile(); + return false; + } + + // Still not a hit, so give up. + + return true; + } + + function onEndXrdActionLinks(&$xrd, $user) + { + $xrd->links[] = array('rel' => Discovery::UPDATESFROM, + 'href' => common_local_url('ApiTimelineUser', + array('id' => $user->id, + 'format' => 'atom')), + 'type' => 'application/atom+xml'); + + // Salmon + $salmon_url = common_local_url('usersalmon', + array('id' => $user->id)); + + $xrd->links[] = array('rel' => Salmon::REL_SALMON, + 'href' => $salmon_url); + // XXX : Deprecated - to be removed. + $xrd->links[] = array('rel' => Salmon::NS_REPLIES, + 'href' => $salmon_url); + + $xrd->links[] = array('rel' => Salmon::NS_MENTIONS, + 'href' => $salmon_url); + + // Get this user's keypair + $magickey = Magicsig::staticGet('user_id', $user->id); + if (!$magickey) { + // No keypair yet, let's generate one. + $magickey = new Magicsig(); + $magickey->generate($user->id); + } + + $xrd->links[] = array('rel' => Magicsig::PUBLICKEYREL, + 'href' => 'data:application/magic-public-key,'. $magickey->toString(false)); + + // TODO - finalize where the redirect should go on the publisher + $url = common_local_url('ostatussub') . '?profile={uri}'; + $xrd->links[] = array('rel' => 'http://ostatus.org/schema/1.0/subscribe', + 'template' => $url ); + + return true; + } }