actions/apisubscriptions.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for showing subscription information in the API
   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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apibareauth.php';
  35
  36 /**
  37  * This class outputs a list of profiles as Twitter-style user and status objects.
  38  * It is used by the API methods /api/statuses/(friends|followers). To support the
  39  * social graph methods it also can output a simple list of IDs.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ApiSubscriptionsAction extends ApiBareAuthAction
  49 {
  50     var $profiles = null;
  51     var $tag      = null;
  52     var $lite     = null;
  53     var $ids_only = null;
  54
  55     /**
  56      * Take arguments for running
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      *
  62      */
  63
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $this->tag      = $this->arg('tag');
  69
  70         // Note: Twitter no longer supports 'lite'
  71         $this->lite     = $this->arg('lite');
  72
  73         $this->ids_only = $this->arg('ids_only');
  74
  75         // If called as a social graph method, show 5000 per page, otherwise 100
  76
  77         $this->count    = isset($this->ids_only) ?
  78             5000 : (int)$this->arg('count', 100);
  79
  80         $this->user = $this->getTargetUser($this->arg('id'));
  81
  82         if (empty($this->user)) {
  83             $this->clientError(_('No such user!'), 404, $this->format);
  84             return false;
  85         }
  86
  87         $this->profiles = $this->getProfiles();
  88
  89         return true;
  90     }
  91
  92     /**
  93      * Handle the request
  94      *
  95      * Show the profiles
  96      *
  97      * @param array $args $_REQUEST data (unused)
  98      *
  99      * @return void
 100      */
 101
 102     function handle($args)
 103     {
 104         parent::handle($args);
 105
 106         if (!in_array($this->format, array('xml', 'json'))) {
 107             $this->clientError(_('API method not found!'), $code = 404);
 108             return;
 109         }
 110
 111         $this->initDocument($this->format);
 112
 113         if (isset($this->ids_only)) {
 114             $this->showIds();
 115         } else {
 116             $this->showProfiles(isset($this->lite) ? false : true);
 117         }
 118
 119         $this->endDocument($this->format);
 120     }
 121
 122     /**
 123      * Get profiles - should get overrrided
 124      *
 125      * @return array Profiles
 126      */
 127
 128     function getProfiles()
 129     {
 130     }
 131
 132     /**
 133      * Is this action read only?
 134      *
 135      * @param array $args other arguments
 136      *
 137      * @return boolean true
 138      */
 139
 140     function isReadOnly($args)
 141     {
 142         return true;
 143     }
 144
 145     /**
 146      * When was this feed last modified?
 147      *
 148      * @return string datestamp of the latest profile in the stream
 149      */
 150
 151     function lastModified()
 152     {
 153         if (!empty($this->profiles) && (count($this->profiles) > 0)) {
 154             return strtotime($this->profiles[0]->created);
 155         }
 156
 157         return null;
 158     }
 159
 160     /**
 161      * An entity tag for this action
 162      *
 163      * Returns an Etag based on the action name, language, user ID, and
 164      * timestamps of the first and last profiles in the subscriptions list
 165      * There's also an indicator to show whether this action is being called
 166      * as /api/statuses/(friends|followers) or /api/(friends|followers)/ids
 167      *
 168      * @return string etag
 169      */
 170
 171     function etag()
 172     {
 173         if (!empty($this->profiles) && (count($this->profiles) > 0)) {
 174
 175             $last = count($this->profiles) - 1;
 176
 177             return '"' . implode(
 178                 ':',
 179                 array($this->arg('action'),
 180                       common_language(),
 181                       $this->user->id,
 182                       isset($this->ids_only) ? 'IDs' : 'Profiles',
 183                       strtotime($this->profiles[0]->created),
 184                       strtotime($this->profiles[$last]->created))
 185             )
 186             . '"';
 187         }
 188
 189         return null;
 190     }
 191
 192     /**
 193      * Show the profiles as Twitter-style useres and statuses
 194      *
 195      * @param boolean $include_statuses Whether to include the latest status
 196      *                                  with each user. Default true.
 197      *
 198      * @return void
 199      */
 200
 201     function showProfiles($include_statuses = true)
 202     {
 203         switch ($this->format) {
 204         case 'xml':
 205             $this->elementStart('users', array('type' => 'array'));
 206             foreach ($this->profiles as $profile) {
 207                 $this->showProfile(
 208                     $profile,
 209                     $this->format,
 210                     null,
 211                     $include_statuses
 212                 );
 213             }
 214             $this->elementEnd('users');
 215             break;
 216         case 'json':
 217             $arrays = array();
 218             foreach ($this->profiles as $profile) {
 219                 $arrays[] = $this->twitterUserArray(
 220                     $profile,
 221                     $include_statuses
 222                 );
 223             }
 224             print json_encode($arrays);
 225             break;
 226         default:
 227             $this->clientError(_('Unsupported format.'));
 228             break;
 229         }
 230     }
 231
 232     /**
 233      * Show the IDs of the profiles only. 5000 per page. To support
 234      * the 'social graph' methods: /api/(friends|followers)/ids
 235      *
 236      * @return void
 237      */
 238
 239     function showIds()
 240     {
 241         switch ($this->format) {
 242         case 'xml':
 243             $this->elementStart('ids');
 244             foreach ($this->profiles as $profile) {
 245                 $this->element('id', null, $profile->id);
 246             }
 247             $this->elementEnd('ids');
 248             break;
 249         case 'json':
 250             $ids = array();
 251             foreach ($this->profiles as $profile) {
 252                 $ids[] = (int)$profile->id;
 253             }
 254             print json_encode($ids);
 255             break;
 256         default:
 257             $this->clientError(_('Unsupported format.'));
 258             break;
 259         }
 260     }
 261
 262 }