plugins/OStatus/actions/ostatusinit.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /**
  21  * @package OStatusPlugin
  22  * @maintainer James Walker <james@status.net>
  23  */
  24
  25 if (!defined('STATUSNET')) {
  26     exit(1);
  27 }
  28
  29 class OStatusInitAction extends Action
  30 {
  31     var $nickname;
  32     var $group;
  33     var $profile;
  34     var $err;
  35
  36     function prepare($args)
  37     {
  38         parent::prepare($args);
  39
  40         if (common_logged_in()) {
  41             // TRANS: Client error.
  42             $this->clientError(_m('You can use the local subscription!'));
  43             return false;
  44         }
  45
  46         // Local user or group the remote wants to subscribe to
  47         $this->nickname = $this->trimmed('nickname');
  48         $this->group = $this->trimmed('group');
  49
  50         // Webfinger or profile URL of the remote user
  51         $this->profile = $this->trimmed('profile');
  52
  53         return true;
  54     }
  55
  56     function handle($args)
  57     {
  58         parent::handle($args);
  59
  60         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  61             /* Use a session token for CSRF protection. */
  62             $token = $this->trimmed('token');
  63             if (!$token || $token != common_session_token()) {
  64                 $this->showForm(_m('There was a problem with your session token. '.
  65                                   'Try again, please.'));
  66                 return;
  67             }
  68             $this->ostatusConnect();
  69         } else {
  70             $this->showForm();
  71         }
  72     }
  73
  74     function showForm($err = null)
  75     {
  76         $this->err = $err;
  77         if ($this->boolean('ajax')) {
  78             header('Content-Type: text/xml;charset=utf-8');
  79             $this->xw->startDocument('1.0', 'UTF-8');
  80             $this->elementStart('html');
  81             $this->elementStart('head');
  82             // TRANS: Form title.
  83             $this->element('title', null, _m('Subscribe to user'));
  84             $this->elementEnd('head');
  85             $this->elementStart('body');
  86             $this->showContent();
  87             $this->elementEnd('body');
  88             $this->elementEnd('html');
  89         } else {
  90             $this->showPage();
  91         }
  92     }
  93
  94     function showContent()
  95     {
  96         if ($this->group) {
  97             // TRANS: Form legend.
  98             $header = sprintf(_m('Join group %s'), $this->group);
  99             // TRANS: Button text.
 100             $submit = _m('BUTTON','Join');
 101         } else {
 102             // TRANS: Form legend.
 103             $header = sprintf(_m('Subscribe to %s'), $this->nickname);
 104             // TRANS: Button text.
 105             $submit = _m('BUTTON','Subscribe');
 106         }
 107         $this->elementStart('form', array('id' => 'form_ostatus_connect',
 108                                           'method' => 'post',
 109                                           'class' => 'form_settings',
 110                                           'action' => common_local_url('ostatusinit')));
 111         $this->elementStart('fieldset');
 112         $this->element('legend', null,  $header);
 113         $this->hidden('token', common_session_token());
 114
 115         $this->elementStart('ul', 'form_data');
 116         $this->elementStart('li', array('id' => 'ostatus_nickname'));
 117         // TRANS: Field label.
 118         $this->input('nickname', _m('User nickname'), $this->nickname,
 119                      _m('Nickname of the user you want to follow.'));
 120         $this->hidden('group', $this->group); // pass-through for magic links
 121         $this->elementEnd('li');
 122         $this->elementStart('li', array('id' => 'ostatus_profile'));
 123         // TRANS: Field label.
 124         $this->input('profile', _m('Profile Account'), $this->profile,
 125                       // TRANS: Tooltip for field label "Profile Account".
 126                      _m('Your account id (e.g. user@identi.ca).'));
 127         $this->elementEnd('li');
 128         $this->elementEnd('ul');
 129         $this->submit('submit', $submit);
 130         $this->elementEnd('fieldset');
 131         $this->elementEnd('form');
 132     }
 133
 134     function ostatusConnect()
 135     {
 136         $opts = array('allowed_schemes' => array('http', 'https', 'acct'));
 137         if (Validate::uri($this->profile, $opts)) {
 138             $bits = parse_url($this->profile);
 139             if ($bits['scheme'] == 'acct') {
 140                 $this->connectWebfinger($bits['path']);
 141             } else {
 142                 $this->connectProfile($this->profile);
 143             }
 144         } elseif (strpos($this->profile, '@') !== false) {
 145             $this->connectWebfinger($this->profile);
 146         } else {
 147             // TRANS: Client error.
 148             $this->clientError(_m("Must provide a remote profile."));
 149         }
 150     }
 151
 152     function connectWebfinger($acct)
 153     {
 154         $target_profile = $this->targetProfile();
 155
 156         $disco = new Discovery;
 157         $result = $disco->lookup($acct);
 158         if (!$result) {
 159             // TRANS: Client error.
 160             $this->clientError(_m("Couldn't look up OStatus account profile."));
 161         }
 162
 163         foreach ($result->links as $link) {
 164             if ($link['rel'] == 'http://ostatus.org/schema/1.0/subscribe') {
 165                 // We found a URL - let's redirect!
 166                 $url = Discovery::applyTemplate($link['template'], $target_profile);
 167                 common_log(LOG_INFO, "Sending remote subscriber $acct to $url");
 168                 common_redirect($url, 303);
 169             }
 170
 171         }
 172         // TRANS: Client error.
 173         $this->clientError(_m("Couldn't confirm remote profile address."));
 174     }
 175
 176     function connectProfile($subscriber_profile)
 177     {
 178         $target_profile = $this->targetProfile();
 179
 180         // @fixme hack hack! We should look up the remote sub URL from XRDS
 181         $suburl = preg_replace('!^(.*)/(.*?)$!', '$1/main/ostatussub', $subscriber_profile);
 182         $suburl .= '?profile=' . urlencode($target_profile);
 183
 184         common_log(LOG_INFO, "Sending remote subscriber $subscriber_profile to $suburl");
 185         common_redirect($suburl, 303);
 186     }
 187
 188     /**
 189      * Build the canonical profile URI+URL of the requested user or group
 190      */
 191     function targetProfile()
 192     {
 193         if ($this->nickname) {
 194             $user = User::staticGet('nickname', $this->nickname);
 195             if ($user) {
 196                 return common_local_url('userbyid', array('id' => $user->id));
 197             } else {
 198                 // TRANS: Client error.
 199                 $this->clientError("No such user.");
 200             }
 201         } else if ($this->group) {
 202             $group = Local_group::staticGet('nickname', $this->group);
 203             if ($group) {
 204                 return common_local_url('groupbyid', array('id' => $group->group_id));
 205             } else {
 206                 // TRANS: Client error.
 207                 $this->clientError("No such group.");
 208             }
 209         } else {
 210             // TRANS: Client error.
 211             $this->clientError("No local user or group nickname provided.");
 212         }
 213     }
 214
 215     function title()
 216     {
 217       // TRANS: Page title.
 218       return _m('OStatus Connect');
 219     }
 220 }