<?php
/*
* StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2010, StatusNet, Inc.
+ * Copyright (C) 2009-2010, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
/**
* @package OStatusPlugin
- * @maintainer James Walker <james@status.net>
+ * @maintainer Brion Vibber <brion@status.net>
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
+/**
+ * Key UI methods:
+ *
+ * showInputForm() - form asking for a remote profile account or URL
+ * We end up back here on errors
+ *
+ * showPreviewForm() - surrounding form for preview-and-confirm
+ * preview() - display profile for a remote user
+ *
+ * success() - redirects to subscriptions page on subscribe
+ */
class OStatusSubAction extends Action
{
+ protected $profile_uri; // provided acct: or URI of remote entity
+ protected $oprofile; // Ostatus_profile of remote entity, if valid
- protected $feedurl;
-
- function title()
+ protected function prepare(array $args=array())
{
- return _m("OStatus Subscribe");
- }
+ parent::prepare($args);
- function handle($args)
- {
- if ($this->validateFeed()) {
- $this->showForm();
+ if (!common_logged_in()) {
+ // XXX: selfURL() didn't work. :<
+ common_set_returnto($_SERVER['REQUEST_URI']);
+ if (Event::handle('RedirectToLogin', array($this, null))) {
+ common_redirect(common_local_url('login'), 303);
+ }
+ return false;
}
+ if ($this->pullRemoteProfile()) {
+ $this->validateRemoteProfile();
+ }
return true;
-
}
- function showForm($err = null)
+ /**
+ * Handle the submission.
+ */
+ protected function handle()
{
- $this->err = $err;
- $this->showPage();
+ parent::handle();
+ if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+ $this->handlePost();
+ } else {
+ $this->showForm();
+ }
}
-
- function showContent()
+ /**
+ * Show the initial form, when we haven't yet been given a valid
+ * remote profile.
+ */
+ function showInputForm()
{
- $user = common_current_user();
-
- $profile = $user->getProfile();
-
- $fuser = null;
-
- $flink = Foreign_link::getByUserID($user->id, FEEDSUB_SERVICE);
-
- if (!empty($flink)) {
- $fuser = $flink->getForeignUser();
- }
-
$this->elementStart('form', array('method' => 'post',
- 'id' => 'form_settings_feedsub',
+ 'id' => 'form_ostatus_sub',
'class' => 'form_settings',
- 'action' =>
- common_local_url('feedsubsettings')));
+ 'action' => $this->selfLink()));
$this->hidden('token', common_session_token());
$this->elementStart('fieldset', array('id' => 'settings_feeds'));
$this->elementStart('ul', 'form_data');
- $this->elementStart('li', array('id' => 'settings_twitter_login_button'));
- $this->input('feedurl', _('Feed URL'), $this->feedurl, _('Enter the URL of a PubSubHubbub-enabled feed'));
+ $this->elementStart('li');
+ $this->input('profile',
+ // TRANS: Field label for a field that takes an OStatus user address.
+ _m('Subscribe to'),
+ $this->profile_uri,
+ // TRANS: Tooltip for field label "Subscribe to".
+ _m('OStatus user\'s address, like nickname@example.com or http://example.net/nickname.'));
$this->elementEnd('li');
$this->elementEnd('ul');
-
- $this->submit('subscribe', _m('Subscribe'));
+ // TRANS: Button text.
+ $this->submit('validate', _m('BUTTON','Continue'));
$this->elementEnd('fieldset');
$this->elementEnd('form');
-
- $this->previewFeed();
}
/**
- * Handle posts to this form
- *
- * Based on the button that was pressed, muxes out to other functions
- * to do the actual task requested.
- *
- * All sub-functions reload the form with a message -- success or failure.
+ * Show the preview-and-confirm form. We've got a valid remote
+ * profile and are ready to poke it!
*
- * @return void
+ * This controls the wrapper form; actual profile display will
+ * be in previewUser() or previewGroup() depending on the type.
*/
-
- function handlePost()
+ function showPreviewForm()
{
- // CSRF protection
- $token = $this->trimmed('token');
- if (!$token || $token != common_session_token()) {
- $this->showForm(_('There was a problem with your session token. '.
- 'Try again, please.'));
+ $ok = $this->preview();
+ if (!$ok) {
+ // @todo FIXME maybe provide a cancel button or link back?
return;
}
- if ($this->arg('subscribe')) {
- $this->saveFeed();
+ $this->elementStart('div', 'entity_actions');
+ $this->elementStart('ul');
+ $this->elementStart('li', 'entity_subscribe');
+ $this->elementStart('form', array('method' => 'post',
+ 'id' => 'form_ostatus_sub',
+ 'class' => 'form_remote_authorize',
+ 'action' =>
+ $this->selfLink()));
+ $this->elementStart('fieldset');
+ $this->hidden('token', common_session_token());
+ $this->hidden('profile', $this->profile_uri);
+ if ($this->oprofile->isGroup()) {
+ // TRANS: Button text.
+ $this->submit('submit', _m('Join'), 'submit', null,
+ // TRANS: Tooltip for button "Join".
+ _m('BUTTON','Join this group'));
} else {
- $this->showForm(_('Unexpected form submission.'));
+ // TRANS: Button text.
+ $this->submit('submit', _m('BUTTON','Confirm'), 'submit', null,
+ // TRANS: Tooltip for button "Confirm".
+ _m('Subscribe to this user'));
}
+ $this->elementEnd('fieldset');
+ $this->elementEnd('form');
+ $this->elementEnd('li');
+ $this->elementEnd('ul');
+ $this->elementEnd('div');
}
-
/**
- * Set up and add a feed
- *
- * @return boolean true if feed successfully read
- * Sends you back to input form if not.
+ * Show a preview for a remote user's profile
+ * @return boolean true if we're ok to try subscribing
*/
- function validateFeed()
+ function preview()
{
- $feedurl = $this->trimmed('feed');
-
- if ($feedurl == '') {
- $this->showForm(_m('Empty feed URL!'));
- return;
+ // Throws NoProfileException on localProfile when remote user's Profile not found
+ $profile = $this->oprofile->localProfile();
+
+ if ($this->scoped->isSubscribed($profile)) {
+ $this->element('div', array('class' => 'error'),
+ // TRANS: Extra paragraph in remote profile view when already subscribed.
+ _m('You are already subscribed to this user.'));
+ $ok = false;
+ } else {
+ $ok = true;
+ }
+
+ $avatarUrl = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
+
+ $this->showEntity($profile,
+ $profile->profileurl,
+ $avatarUrl,
+ $profile->bio);
+ return $ok;
+ }
+
+ function showEntity($entity, $profile, $avatar, $note)
+ {
+ $nickname = $entity->nickname;
+ $fullname = $entity->fullname;
+ $homepage = $entity->homepage;
+ $location = $entity->location;
+
+ $this->elementStart('div', 'entity_profile vcard');
+ $this->element('img', array('src' => $avatar,
+ 'class' => 'photo avatar entity_depiction',
+ 'width' => AVATAR_PROFILE_SIZE,
+ 'height' => AVATAR_PROFILE_SIZE,
+ 'alt' => $nickname));
+
+ $hasFN = ($fullname !== '') ? 'nickname' : 'fn nickname entity_nickname';
+ $this->elementStart('a', array('href' => $profile,
+ 'class' => 'url '.$hasFN));
+ $this->raw($nickname);
+ $this->elementEnd('a');
+
+ if (!is_null($fullname)) {
+ $this->elementStart('div', 'fn entity_fn');
+ $this->raw($fullname);
+ $this->elementEnd('div');
}
- $this->feedurl = $feedurl;
-
- // Get the canonical feed URI and check it
+
+ if (!is_null($location)) {
+ $this->elementStart('div', 'label entity_location');
+ $this->raw($location);
+ $this->elementEnd('div');
+ }
+
+ if (!is_null($homepage)) {
+ $this->elementStart('a', array('href' => $homepage,
+ 'class' => 'url entity_url'));
+ $this->raw($homepage);
+ $this->elementEnd('a');
+ }
+
+ if (!is_null($note)) {
+ $this->elementStart('div', 'note entity_note');
+ $this->raw($note);
+ $this->elementEnd('div');
+ }
+ $this->elementEnd('div');
+ }
+
+ /**
+ * Redirect on successful remote user subscription
+ */
+ function success()
+ {
+ $url = common_local_url('subscriptions', array('nickname' => $this->scoped->nickname));
+ common_redirect($url, 303);
+ }
+
+ /**
+ * Pull data for a remote profile and check if it's valid.
+ * Fills out error UI string in $this->error
+ * Fills out $this->oprofile on success.
+ *
+ * @return boolean
+ */
+ function pullRemoteProfile()
+ {
+ $this->profile_uri = $this->trimmed('profile');
try {
- $discover = new FeedDiscovery();
- $uri = $discover->discoverFromURL($feedurl);
+ if (Validate::email($this->profile_uri)) {
+ $this->oprofile = Ostatus_profile::ensureWebfinger($this->profile_uri);
+ } else if (Validate::uri($this->profile_uri)) {
+ $this->oprofile = Ostatus_profile::ensureProfileURL($this->profile_uri);
+ } else {
+ // 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.
+ $this->error = _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.");
+ common_debug('Invalid address format.', __FILE__);
+ return false;
+ }
+ return true;
} catch (FeedSubBadURLException $e) {
- $this->showForm(_m('Invalid URL or could not reach server.'));
- return false;
+ // 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.
+ $this->error = _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.');
+ common_debug('Invalid URL or could not reach server.', __FILE__);
} catch (FeedSubBadResponseException $e) {
- $this->showForm(_m('Cannot read feed; server returned error.'));
- return false;
+ // TRANS: Error text.
+ $this->error = _m('Sorry, we could not reach that feed. Please try that OStatus address again later.');
+ common_debug('Cannot read feed; server returned error.', __FILE__);
} catch (FeedSubEmptyException $e) {
- $this->showForm(_m('Cannot read feed; server returned an empty page.'));
- return false;
+ // TRANS: Error text.
+ $this->error = _m('Sorry, we could not reach that feed. Please try that OStatus address again later.');
+ common_debug('Cannot read feed; server returned an empty page.', __FILE__);
} catch (FeedSubBadHTMLException $e) {
- $this->showForm(_m('Bad HTML, could not find feed link.'));
- return false;
+ // TRANS: Error text.
+ $this->error = _m('Sorry, we could not reach that feed. Please try that OStatus address again later.');
+ common_debug('Bad HTML, could not find feed link.', __FILE__);
} catch (FeedSubNoFeedException $e) {
- $this->showForm(_m('Could not find a feed linked from this URL.'));
- return false;
+ // TRANS: Error text.
+ $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
+ common_debug('Could not find a feed linked from this URL.', __FILE__);
} catch (FeedSubUnrecognizedTypeException $e) {
- $this->showForm(_m('Not a recognized feed type.'));
- return false;
- } catch (FeedSubException $e) {
+ // TRANS: Error text.
+ $this->error = _m("Sorry, we could not reach that feed. Please try that OStatus address again later.");
+ common_debug('Not a recognized feed type.', __FILE__);
+ } catch (Exception $e) {
// Any new ones we forgot about
- $this->showForm(_m('Bad feed URL.'));
- return false;
+ // 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.
+ $this->error = _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.");
+ common_debug(sprintf('Bad feed URL: %s %s', get_class($e), $e->getMessage()), __FILE__);
}
-
- $this->munger = $discover->feedMunger();
- $this->feedinfo = $this->munger->feedInfo();
- if ($this->feedinfo->huburi == '') {
- $this->showForm(_m('Feed is not PuSH-enabled; cannot subscribe.'));
- return false;
+ return false;
+ }
+
+ function validateRemoteProfile()
+ {
+ // Send us to the respective subscription form for conf
+ if ($this->oprofile->isGroup()) {
+ $target = common_local_url('ostatusgroup', array(), array('profile' => $this->profile_uri));
+ common_redirect($target, 303);
+ } else if ($this->oprofile->isPeopletag()) {
+ $target = common_local_url('ostatuspeopletag', array(), array('profile' => $this->profile_uri));
+ common_redirect($target, 303);
}
-
- return true;
}
+ /**
+ * Attempt to finalize subscription.
+ * validateFeed must have been run first.
+ *
+ * Calls showForm on failure or success on success.
+ */
function saveFeed()
{
- if ($this->validateFeed()) {
- $this->preview = true;
- $this->feedinfo = Feedinfo::ensureProfile($this->munger);
+ // And subscribe the current user to the local profile
+ $local = $this->oprofile->localProfile();
+ if ($this->scoped->isSubscribed($local)) {
+ // TRANS: OStatus remote subscription dialog error.
+ $this->showForm(_m('Already subscribed!'));
+ } elseif (Subscription::start($this->scoped, $local)) {
+ $this->success();
+ } else {
+ // TRANS: OStatus remote subscription dialog error.
+ $this->showForm(_m('Remote subscription failed!'));
+ }
+ }
- // If not already in use, subscribe to updates via the hub
- if ($this->feedinfo->sub_start) {
- common_log(LOG_INFO, __METHOD__ . ": double the fun! new sub for {$this->feedinfo->feeduri} last subbed {$this->feedinfo->sub_start}");
- } else {
- $ok = $this->feedinfo->subscribe();
- common_log(LOG_INFO, __METHOD__ . ": sub was $ok");
- if (!$ok) {
- $this->showForm(_m('Feed subscription failed! Bad response from hub.'));
- return;
- }
- }
-
- // And subscribe the current user to the local profile
- $user = common_current_user();
- $profile = $this->feedinfo->getProfile();
-
- if ($user->isSubscribed($profile)) {
- $this->showForm(_m('Already subscribed!'));
- } elseif ($user->subscribeTo($profile)) {
- $this->showForm(_m('Feed subscribed!'));
- } else {
- $this->showForm(_m('Feed subscription failed!'));
+ /**
+ * Handle posts to this form
+ *
+ * @return void
+ */
+
+ function handlePost()
+ {
+ // CSRF protection
+ $token = $this->trimmed('token');
+ if (!$token || $token != common_session_token()) {
+ // TRANS: Client error displayed when the session token does not match or is not given.
+ $this->showForm(_m('There was a problem with your session token. '.
+ 'Try again, please.'));
+ return;
+ }
+
+ if ($this->oprofile) {
+ if ($this->arg('submit')) {
+ $this->saveFeed();
+ return;
}
}
+ $this->showForm();
+ }
+
+ /**
+ * Show the appropriate form based on our input state.
+ */
+ function showForm($err=null)
+ {
+ if ($err) {
+ $this->error = $err;
+ }
+ if ($this->boolean('ajax')) {
+ $this->startHTML('text/xml;charset=utf-8');
+ $this->elementStart('head');
+ // TRANS: Form title.
+ $this->element('title', null, _m('Subscribe to user'));
+ $this->elementEnd('head');
+ $this->elementStart('body');
+ $this->showContent();
+ $this->elementEnd('body');
+ $this->endHTML();
+ } else {
+ $this->showPage();
+ }
}
-
- function previewFeed()
+ /**
+ * Title of the page
+ *
+ * @return string Title of the page
+ */
+
+ function title()
{
- $feedinfo = $this->munger->feedinfo();
- $notice = $this->munger->notice(0, true); // preview
+ // TRANS: Page title for OStatus remote subscription form.
+ return _m('Confirm');
+ }
+
+ /**
+ * Instructions for use
+ *
+ * @return instructions for use
+ */
+
+ function getInstructions()
+ {
+ // TRANS: Instructions.
+ return _m('You can subscribe to users from other supported sites. Paste their address or profile URI below:');
+ }
- if ($notice) {
- $this->element('b', null, 'Preview of latest post from this feed:');
+ function showPageNotice()
+ {
+ if (!empty($this->error)) {
+ $this->element('p', 'error', $this->error);
+ }
+ }
- $item = new NoticeList($notice, $this);
- $item->show();
+ /**
+ * Content area of the page
+ *
+ * Shows a form for associating a remote OStatus account with this
+ * StatusNet account.
+ *
+ * @return void
+ */
+ function showContent()
+ {
+ if ($this->oprofile) {
+ $this->showPreviewForm();
} else {
- $this->element('b', null, 'No posts in this feed yet.');
+ $this->showInputForm();
}
}
+ function showScripts()
+ {
+ parent::showScripts();
+ $this->autofocus('feedurl');
+ }
+
+ function selfLink()
+ {
+ return common_local_url('ostatussub');
+ }
-}
\ No newline at end of file
+ /**
+ * Disable the send-notice form at the top of the page.
+ * This is really just a hack for the broken CSS in the Cloudy theme,
+ * I think; copying from other non-notice-navigation pages that do this
+ * as well. There will be plenty of others also broken.
+ *
+ * @fixme fix the cloudy theme
+ * @fixme do this in a more general way
+ */
+ function showNoticeForm() {
+ // nop
+ }
+}