actions/apiaccountupdatedeliverydevice.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Update the authenticating user notification channels
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Siebrand Mazeland <s.mazeland@xs4all.nl>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR . '/lib/apiauth.php';
  36
  37 /**
  38  * Sets which channel (device) StatusNet delivers updates to for
  39  * the authenticating user. Sending none as the device parameter
  40  * will disable IM and/or SMS updates.
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Zach Copley <zach@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  */
  48
  49 class ApiAccountUpdateDeliveryDeviceAction extends ApiAuthAction
  50 {
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      *
  58      */
  59
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->user   = $this->auth_user;
  65         $this->device = $this->trimmed('device');
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * See which request params have been set, and update the user settings
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  85             $this->clientError(
  86                 _('This method requires a POST.'),
  87                 400, $this->format
  88             );
  89             return;
  90         }
  91
  92         if (!in_array($this->format, array('xml', 'json'))) {
  93             $this->clientError(
  94                 _('API method not found.'),
  95                 404,
  96                 $this->format
  97             );
  98             return;
  99         }
 100
 101         // Note: Twitter no longer supports IM
 102
 103         if (!in_array(strtolower($this->device), array('sms', 'im', 'none'))) {
 104             $this->clientError(
 105                 _(
 106                     'You must specify a parameter named ' .
 107                     '\'device\' with a value of one of: sms, im, none.'
 108                 )
 109             );
 110             return;
 111         }
 112
 113         if (empty($this->user)) {
 114             $this->clientError(_('No such user.'), 404, $this->format);
 115             return;
 116         }
 117
 118         $original = clone($this->user);
 119
 120         if (strtolower($this->device) == 'sms') {
 121             $this->user->smsnotify = true;
 122         } elseif (strtolower($this->device) == 'im') {
 123             $this->user->jabbernotify = true;
 124         } elseif (strtolower($this->device == 'none')) {
 125             $this->user->smsnotify    = false;
 126             $this->user->jabbernotify = false;
 127         }
 128
 129         $result = $this->user->update($original);
 130
 131         if ($result === false) {
 132             common_log_db_error($this->user, 'UPDATE', __FILE__);
 133             $this->serverError(_('Could not update user.'));
 134             return;
 135         }
 136
 137         $profile = $this->user->getProfile();
 138
 139         $twitter_user = $this->twitterUserArray($profile, true);
 140
 141         // Note: this Twitter API method is retarded because it doesn't give
 142         // any success/failure information. Twitter's docs claim that the
 143         // notification field will change to reflect notification choice,
 144         // but that's not true; notification> is used to indicate
 145         // whether the auth user is following the user in question.
 146
 147         if ($this->format == 'xml') {
 148             $this->initDocument('xml');
 149             $this->showTwitterXmlUser($twitter_user);
 150             $this->endDocument('xml');
 151         } elseif ($this->format == 'json') {
 152             $this->initDocument('json');
 153             $this->showJsonObjects($twitter_user);
 154             $this->endDocument('json');
 155         }
 156     }
 157
 158 }