actions/apigroupshow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show information about a group
   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    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Jeffery To <jeffery.to@gmail.com>
  27  * @author    Zach Copley <zach@status.net>
  28  * @copyright 2009 StatusNet, Inc.
  29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31  * @link      http://status.net/
  32  */
  33
  34 if (!defined('STATUSNET')) {
  35     exit(1);
  36 }
  37
  38 /**
  39  * Outputs detailed information about the group specified by ID
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Craig Andrews <candrews@integralblue.com>
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Jeffery To <jeffery.to@gmail.com>
  46  * @author   Zach Copley <zach@status.net>
  47  * @author   Michele <macno@macno.org>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  51 class ApiGroupShowAction extends ApiPrivateAuthAction
  52 {
  53     var $group = null;
  54
  55     /**
  56      * Take arguments for running
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      */
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65
  66         $this->group = $this->getTargetGroup($this->arg('id'));
  67
  68         if (empty($this->group)) {
  69             $alias = Group_alias::getKV(
  70                 'alias',
  71                 common_canonical_nickname($this->arg('id'))
  72             );
  73             if (!empty($alias)) {
  74                 $args = array('id' => $alias->group_id, 'format' => $this->format);
  75                 common_redirect(common_local_url('ApiGroupShow', $args), 301);
  76             } else {
  77                 $this->clientError(
  78                     // TRANS: Client error displayed when trying to show a group that could not be found.
  79                     _('Group not found.'),
  80                     404,
  81                     $this->format
  82                 );
  83             }
  84             return;
  85         }
  86
  87         return true;
  88     }
  89
  90     /**
  91      * Handle the request
  92      *
  93      * Check the format and show the user info
  94      *
  95      * @param array $args $_REQUEST data (unused)
  96      *
  97      * @return void
  98      */
  99     function handle($args)
 100     {
 101         parent::handle($args);
 102
 103         switch($this->format) {
 104         case 'xml':
 105             $this->showSingleXmlGroup($this->group);
 106             break;
 107         case 'json':
 108             $this->showSingleJsonGroup($this->group);
 109             break;
 110         default:
 111             // TRANS: Client error displayed when coming across a non-supported API method.
 112             $this->clientError(_('API method not found.'), 404, $this->format);
 113             break;
 114         }
 115     }
 116
 117     /**
 118      * When was this group last modified?
 119      *
 120      * @return string datestamp of the latest notice in the stream
 121      */
 122     function lastModified()
 123     {
 124         if (!empty($this->group)) {
 125             return strtotime($this->group->modified);
 126         }
 127
 128         return null;
 129     }
 130
 131     /**
 132      * An entity tag for this group
 133      *
 134      * Returns an Etag based on the action name, language, and
 135      * timestamps of the notice
 136      *
 137      * @return string etag
 138      */
 139     function etag()
 140     {
 141         if (!empty($this->group)) {
 142
 143             return '"' . implode(
 144                 ':',
 145                 array($this->arg('action'),
 146                       common_user_cache_hash($this->auth_user),
 147                       common_language(),
 148                       $this->group->id,
 149                       strtotime($this->group->modified))
 150             )
 151             . '"';
 152         }
 153
 154         return null;
 155     }
 156
 157     /**
 158      * Return true if read only.
 159      *
 160      * MAY override
 161      *
 162      * @param array $args other arguments
 163      *
 164      * @return boolean is read only action?
 165      */
 166     function isReadOnly($args)
 167     {
 168         return true;
 169     }
 170 }