X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=plugins%2FOStatus%2FOStatusPlugin.php;h=9fce923c25458724973d07b492c935732c965814;hb=f9ddb0e20919b1b22b1a78463ffb227a009c5614;hp=86d5bd733749f70abf4192ef1c0b6e37d6a24166;hpb=636d5141e994297749a78190a19b62a94f41884f;p=quix0rs-gnu-social.git diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php index 86d5bd7337..9fce923c25 100644 --- a/plugins/OStatus/OStatusPlugin.php +++ b/plugins/OStatus/OStatusPlugin.php @@ -30,19 +30,6 @@ if (!defined('GNUSOCIAL')) { exit(1); } set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpseclib'); -class FeedSubException extends Exception -{ - function __construct($msg=null) - { - $type = get_class($this); - if ($msg) { - parent::__construct("$type: $msg"); - } else { - parent::__construct($type); - } - } -} - class OStatusPlugin extends Plugin { /** @@ -96,6 +83,20 @@ class OStatusPlugin extends Plugin return true; } + public function onAutoload($cls) + { + switch ($cls) { + case 'Crypt_AES': + case 'Crypt_RSA': + // Crypt_AES becomes Crypt/AES.php which is found in extlib/phpseclib/ + // which has been added to our include_path before + require_once str_replace('_', '/', $cls) . '.php'; + return false; + } + + return parent::onAutoload($cls); + } + /** * Set up queue handlers for outgoing hub pushes * @param QueueManager $qm @@ -117,13 +118,16 @@ class OStatusPlugin extends Plugin // Incoming from a foreign PuSH hub $qm->connect('pushin', 'PushInQueueHandler'); + + // Re-subscribe feeds that need renewal + $qm->connect('pushrenew', 'PushRenewQueueHandler'); return true; } /** * Put saved notices into the queue for pubsub distribution. */ - function onStartEnqueueNotice($notice, &$transports) + function onStartEnqueueNotice(Notice $notice, array &$transports) { if ($notice->inScope(null)) { // put our transport first, in case there's any conflict (like OMB) @@ -233,51 +237,22 @@ class OStatusPlugin extends Plugin return true; } - 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 { - // TRANS: Exception in OStatus when invalid URI was entered. - throw new Exception(_m('Invalid URI.')); - } - - // redirect to the new profile. - common_redirect(common_local_url('tagprofile', array('id' => $oprofile->profile_id)), 303); - - } catch (Exception $e) { - // TRANS: Error message in OStatus plugin. Do not translate the domain names example.com - // TRANS: and example.net, as these are official standard domain names for use in examples. - $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) { + public function onStartProfileCompletionSearch(Action $action, Profile $profile, $search_engine) { if ($action->field == 'uri') { $profile->joinAdd(array('id', 'user:id')); $profile->whereAdd('uri LIKE "%' . $profile->escape($q) . '%"'); $profile->query(); + $validate = new Validate(); + if ($profile->N == 0) { try { - if (Validate::email($q)) { + if ($validate->email($q)) { $oprofile = Ostatus_profile::ensureWebfinger($q); - } else if (Validate::uri($q)) { + } else if ($validate->uri($q)) { $oprofile = Ostatus_profile::ensureProfileURL($q); } else { // TRANS: Exception in OStatus when invalid URI was entered. @@ -306,7 +281,7 @@ class OStatusPlugin extends Plugin * @param array &$mention in/out param: set of found mentions * @return boolean hook return value */ - function onEndFindMentions(Profile $sender, $text, &$mentions) + function onEndFindMentions(Profile $sender, $text, array &$mentions) { $matches = array(); @@ -389,7 +364,7 @@ class OStatusPlugin extends Plugin * @param Profile &$profile * @return hook return code */ - function onStartCommandGetProfile($command, $arg, &$profile) + public function onStartCommandGetProfile(Command $command, $arg, Profile &$profile = null) { $oprofile = $this->pullRemoteProfile($arg); if ($oprofile instanceof Ostatus_profile && !$oprofile->isGroup()) { @@ -416,7 +391,7 @@ class OStatusPlugin extends Plugin * @param User_group &$group * @return hook return code */ - function onStartCommandGetGroup($command, $arg, &$group) + function onStartCommandGetGroup(Command $command, $arg, User_group &$group = null) { $oprofile = $this->pullRemoteProfile($arg); if ($oprofile instanceof Ostatus_profile && $oprofile->isGroup()) { @@ -481,7 +456,7 @@ class OStatusPlugin extends Plugin return true; } - function onEndShowStatusNetScripts($action) { + public function onEndShowStatusNetScripts(Action $action) { $action->script($this->path('js/ostatus.js')); return true; } @@ -499,7 +474,7 @@ class OStatusPlugin extends Plugin function onStartNoticeSourceLink($notice, &$name, &$url, &$title) { // If we don't handle this, keep the event handler going - if ($notice->source != 'ostatus') { + if (!in_array($notice->source, array('ostatus', 'share'))) { return true; } @@ -539,7 +514,7 @@ class OStatusPlugin extends Plugin if ($oprofile instanceof Ostatus_profile) { $oprofile->processFeed($feed, 'push'); } else { - common_log(LOG_DEBUG, "No ostatus profile for incoming feed $feedsub->uri"); + common_debug("No ostatus profile for incoming feed $feedsub->uri"); } } @@ -867,6 +842,42 @@ class OStatusPlugin extends Plugin $oprofile->notifyActivity($act, $user); } + /** + * Notify remote users when their notices get favorited. + * + * @param Profile or User $profile of local user doing the faving + * @param Notice $notice being favored + * @return hook return value + */ + function onEndFavorNotice(Profile $profile, Notice $notice) + { + // Only distribute local users' favor actions, remote users + // will have already distributed theirs. + if (!$profile->isLocal()) { + return true; + } + + $oprofile = Ostatus_profile::getKV('profile_id', $notice->profile_id); + if (!$oprofile instanceof Ostatus_profile) { + return true; + } + + $fav = Fave::pkeyGet(array('user_id' => $profile->id, + 'notice_id' => $notice->id)); + + if (!$fav instanceof Fave) { + // That's weird. + // TODO: Make pkeyGet throw exception, since this is a critical failure. + return true; + } + + $act = $fav->asActivity(); + + $oprofile->notifyActivity($act, $profile); + + return true; + } + /** * Notify remote user it has got a new people tag * - tag verb is queued @@ -1071,8 +1082,12 @@ class OStatusPlugin extends Plugin function showEntityRemoteSubscribe($action, $target='ostatussub') { - $user = common_current_user(); - if ($user && ($user->id == $action->profile->id)) { + if (!$action->getScoped() instanceof Profile) { + // early return if we're not logged in + return true; + } + + if ($action->getScoped()->sameAs($action->getTarget())) { $action->elementStart('div', 'entity_actions'); $action->elementStart('p', array('id' => 'entity_remote_subscribe', 'class' => 'entity_subscribe')); @@ -1107,7 +1122,7 @@ class OStatusPlugin extends Plugin $oprofile->query(sprintf($sql, $profile->id, $profile->id)); if ($oprofile->N == 0) { - common_log(LOG_DEBUG, "No OStatus remote subscribees for $profile->nickname"); + common_debug("No OStatus remote subscribees for $profile->nickname"); return true; } @@ -1135,46 +1150,49 @@ class OStatusPlugin extends Plugin return true; } - function onStartProfileListItemActionElements($item, $profile=null) + // FIXME: This one can accept both an Action and a Widget. Confusing! Refactor to (HTMLOutputter $out, Profile $target)! + function onStartProfileListItemActionElements($item) { - if (!common_logged_in()) { - - $profileUser = User::getKV('id', $item->profile->id); - - if (!empty($profileUser)) { - - if ($item instanceof Action) { - $output = $item; - $profile = $item->profile; - } else { - $output = $item->out; - } + if (common_logged_in()) { + // only non-logged in users get to see the "remote subscribe" form + return true; + } elseif (!$item->getTarget()->isLocal()) { + // we can (for now) only provide remote subscribe forms for local users + return true; + } - // Add an OStatus subscribe - $output->elementStart('li', 'entity_subscribe'); - $url = common_local_url('ostatusinit', - 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'), - // TRANS: Link text for a user to list an OStatus user. - _m('List')); - $output->elementEnd('li'); - } + if ($item instanceof ProfileAction) { + $output = $item; + } elseif ($item instanceof Widget) { + $output = $item->out; + } else { + // Bad $item class, don't know how to use this for outputting! + throw new ServerException('Bad item type for onStartProfileListItemActionElements'); } + // Add an OStatus subscribe + $output->elementStart('li', 'entity_subscribe'); + $url = common_local_url('ostatusinit', + array('nickname' => $item->getTarget()->getNickname())); + $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' => $item->getTarget()->getNickname())); + $output->element('a', array('href' => $url, + 'class' => 'entity_remote_tag'), + // TRANS: Link text for a user to list an OStatus user. + _m('List')); + $output->elementEnd('li'); + return true; } - function onPluginVersion(&$versions) + function onPluginVersion(array &$versions) { $versions[] = array('name' => 'OStatus', 'version' => GNUSOCIAL_VERSION, @@ -1310,17 +1328,20 @@ class OStatusPlugin extends Plugin $magicsig = Magicsig::generate($target->getUser()); } - if ($magicsig instanceof Magicsig) { + if (!$magicsig instanceof Magicsig) { + return false; // value doesn't mean anything, just figured I'd indicate this function didn't do anything + } + if (Event::handle('StartAttachPubkeyToUserXRD', array($magicsig, $xrd, $target))) { $xrd->links[] = new XML_XRD_Element_Link(Magicsig::PUBLICKEYREL, 'data:application/magic-public-key,'. $magicsig->toString()); - $xrd->links[] = new XML_XRD_Element_Link(Magicsig::DIASPORA_PUBLICKEYREL, - base64_encode($magicsig->exportPublicKey())); + // The following event handles plugins like Diaspora which add their own version of the Magicsig pubkey + Event::handle('EndAttachPubkeyToUserXRD', array($magicsig, $xrd, $target)); } } public function onGetLocalAttentions(Profile $actor, array $attention_uris, array &$mentions, array &$groups) { - list($mentions, $groups) = Ostatus_profile::filterAttention($actor, $attention_uris); + list($groups, $mentions) = Ostatus_profile::filterAttention($actor, $attention_uris); } // FIXME: Maybe this shouldn't be so authoritative that it breaks other remote profile lookups? @@ -1337,7 +1358,7 @@ class OStatusPlugin extends Plugin return true; } - public function onProfileDeleteRelated($profile, &$related) + public function onProfileDeleteRelated(Profile $profile, array &$related) { // Ostatus_profile has a 'profile_id' property, which will be used to find the object $related[] = 'Ostatus_profile'; @@ -1349,4 +1370,51 @@ class OStatusPlugin extends Plugin } return true; } + + public function onSalmonSlap($endpoint_uri, MagicEnvelope $magic_env, Profile $target=null) + { + $envxml = $magic_env->toXML($target); + + $headers = array('Content-Type: application/magic-envelope+xml'); + + try { + $client = new HTTPClient(); + $client->setBody($envxml); + $response = $client->post($endpoint_uri, $headers); + } catch (HTTP_Request2_Exception $e) { + common_log(LOG_ERR, "Salmon post to $endpoint_uri failed: " . $e->getMessage()); + return false; + } + if ($response->getStatus() === 422) { + common_debug(sprintf('Salmon (from profile %d) endpoint %s returned status %s. We assume it is a Diaspora seed; will adapt and try again if that plugin is enabled!', $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus())); + return true; + } + + // 200 OK is the best response + // 202 Accepted is what we get from Diaspora for example + if (!in_array($response->getStatus(), array(200, 202))) { + common_log(LOG_ERR, sprintf('Salmon (from profile %d) endpoint %s returned status %s: %s', + $magic_env->getActor()->getID(), $endpoint_uri, $response->getStatus(), $response->getBody())); + return true; + } + + // Since we completed the salmon slap, we discontinue the event + return false; + } + + public function onCronDaily() + { + try { + $sub = FeedSub::renewalCheck(); + } catch (NoResultException $e) { + common_log(LOG_INFO, "There were no expiring feeds."); + return; + } + + $qm = QueueManager::get(); + while ($sub->fetch()) { + $item = array('feedsub_id' => $sub->id); + $qm->enqueue($item, 'pushrenew'); + } + } }