actions/apilistsubscriptions.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Get a list of lists a user is subscribed to.
   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  * @copyright 2009 StatusNet, Inc.
  25  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  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 class ApiListSubscriptionsAction extends ApiBareAuthAction
  35 {
  36     var $lists = array();
  37     var $cursor = -1;
  38     var $next_cursor = 0;
  39     var $prev_cursor = 0;
  40
  41     /**
  42      * Take arguments for running
  43      *
  44      * @param array $args $_REQUEST args
  45      *
  46      * @return boolean success flag
  47      *
  48      */
  49     function prepare($args)
  50     {
  51         parent::prepare($args);
  52
  53         $this->cursor = (int) $this->arg('cursor', -1);
  54         $this->user = $this->getTargetUser($this->arg('user'));
  55         $this->getLists();
  56
  57         return true;
  58     }
  59
  60     /**
  61      * Handle the request
  62      *
  63      * Show the lists
  64      *
  65      * @param array $args $_REQUEST data (unused)
  66      *
  67      * @return void
  68      */
  69     function handle($args)
  70     {
  71         parent::handle($args);
  72
  73         if (empty($this->user)) {
  74             // TRANS: Client error displayed trying to perform an action related to a non-existing user.
  75             $this->clientError(_('No such user.'), 404, $this->format);
  76             return;
  77         }
  78
  79         switch($this->format) {
  80         case 'xml':
  81             $this->showXmlLists($this->lists, $this->next_cursor, $this->prev_cursor);
  82             break;
  83         case 'json':
  84             $this->showJsonLists($this->lists, $this->next_cursor, $this->prev_cursor);
  85             break;
  86         default:
  87             $this->clientError(
  88                 // TRANS: Client error displayed when coming across a non-supported API method.
  89                 _('API method not found.'),
  90                 400,
  91                 $this->format
  92             );
  93             break;
  94         }
  95     }
  96
  97     /**
  98      * Return true if read only.
  99      *
 100      * MAY override
 101      *
 102      * @param array $args other arguments
 103      *
 104      * @return boolean is read only action?
 105      */
 106     function isReadOnly($args)
 107     {
 108         return true;
 109     }
 110
 111     function getLists()
 112     {
 113         if(empty($this->user)) {
 114             return;
 115         }
 116
 117         $profile = $this->user->getProfile();
 118         $fn = array($profile, 'getTagSubscriptions');
 119         # 20 lists
 120         list($this->lists, $this->next_cursor, $this->prev_cursor) =
 121                 Profile_list::getAtCursor($fn, array(), $this->cursor, 20);
 122     }
 123 }