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