actions/subscribe.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2011, StatusNet, Inc.
   5  *
   6  * Subscription action.
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU Affero General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU Affero General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * PHP version 5
  22  *
  23  * @category  Action
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2008-2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Subscription action
  37  *
  38  * Subscribing to a profile. Likely to work for OStatus profiles.
  39  *
  40  * Takes parameters:
  41  *
  42  *    - subscribeto: a profile ID
  43  *    - token: session token to prevent CSRF attacks
  44  *    - ajax: boolean; whether to return Ajax or full-browser results
  45  *
  46  * Only works if the current user is logged in.
  47  *
  48  * @category  Action
  49  * @package   StatusNet
  50  * @author    Evan Prodromou <evan@status.net>
  51  * @copyright 2008-2010 StatusNet, Inc.
  52  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  53  * @link      http://status.net/
  54  */
  55 class SubscribeAction extends Action
  56 {
  57     var $user;
  58     var $other;
  59
  60     /**
  61      * Check pre-requisites and instantiate attributes
  62      *
  63      * @param Array $args array of arguments (URL, GET, POST)
  64      *
  65      * @return boolean success flag
  66      */
  67     function prepare(array $args=array())
  68     {
  69         parent::prepare($args);
  70
  71         // Only allow POST requests
  72
  73         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  74             // TRANS: Client error displayed trying to perform any request method other than POST.
  75             // TRANS: Do not translate POST.
  76             $this->clientError(_('This action only accepts POST requests.'));
  77         }
  78
  79         // CSRF protection
  80
  81         $token = $this->trimmed('token');
  82
  83         if (!$token || $token != common_session_token()) {
  84             // TRANS: Client error displayed when the session token is not okay.
  85             $this->clientError(_('There was a problem with your session token.'.
  86                                  ' Try again, please.'));
  87         }
  88
  89         // Only for logged-in users
  90
  91         $this->user = common_current_user();
  92
  93         if (empty($this->user)) {
  94             // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
  95             $this->clientError(_('Not logged in.'));
  96         }
  97
  98         // Profile to subscribe to
  99
 100         $other_id = $this->arg('subscribeto');
 101
 102         $this->other = Profile::getKV('id', $other_id);
 103
 104         if (empty($this->other)) {
 105             // TRANS: Client error displayed trying to subscribe to a non-existing profile.
 106             $this->clientError(_('No such profile.'));
 107         }
 108
 109         return true;
 110     }
 111
 112     /**
 113      * Handle request
 114      *
 115      * Does the subscription and returns results.
 116      *
 117      * @param Array $args unused.
 118      *
 119      * @return void
 120      */
 121     function handle(array $args=array())
 122     {
 123         // Throws exception on error
 124
 125         $sub = Subscription::ensureStart($this->user->getProfile(),
 126                                    $this->other);
 127
 128         if ($this->boolean('ajax')) {
 129             $this->startHTML('text/xml;charset=utf-8');
 130             $this->elementStart('head');
 131             // TRANS: Page title when subscription succeeded.
 132             $this->element('title', null, _('Subscribed'));
 133             $this->elementEnd('head');
 134             $this->elementStart('body');
 135             if ($sub instanceof Subscription) {
 136                 $form = new UnsubscribeForm($this, $this->other);
 137             } else {
 138                 $form = new CancelSubscriptionForm($this, $this->other);
 139             }
 140             $form->show();
 141             $this->elementEnd('body');
 142             $this->endHTML();
 143         } else {
 144             $url = common_local_url('subscriptions',
 145                                     array('nickname' => $this->user->nickname));
 146             common_redirect($url, 303);
 147         }
 148     }
 149 }