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     protected function prepare(array $args=array())
  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                 // TRANS: Client error displayed when trying to show a group that could not be found.
  78                 $this->clientError(_('Group not found.'), 404);
  79             }
  80             return;
  81         }
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Handle the request
  88      *
  89      * Check the format and show the user info
  90      *
  91      * @return void
  92      */
  93     protected function handle()
  94     {
  95         parent::handle();
  96
  97         switch($this->format) {
  98         case 'xml':
  99             $this->showSingleXmlGroup($this->group);
 100             break;
 101         case 'json':
 102             $this->showSingleJsonGroup($this->group);
 103             break;
 104         default:
 105             // TRANS: Client error displayed when coming across a non-supported API method.
 106             $this->clientError(_('API method not found.'), 404);
 107         }
 108     }
 109
 110     /**
 111      * When was this group last modified?
 112      *
 113      * @return string datestamp of the latest notice in the stream
 114      */
 115     function lastModified()
 116     {
 117         if (!empty($this->group)) {
 118             return strtotime($this->group->modified);
 119         }
 120
 121         return null;
 122     }
 123
 124     /**
 125      * An entity tag for this group
 126      *
 127      * Returns an Etag based on the action name, language, and
 128      * timestamps of the notice
 129      *
 130      * @return string etag
 131      */
 132     function etag()
 133     {
 134         if (!empty($this->group)) {
 135
 136             return '"' . implode(
 137                 ':',
 138                 array($this->arg('action'),
 139                       common_user_cache_hash($this->auth_user),
 140                       common_language(),
 141                       $this->group->id,
 142                       strtotime($this->group->modified))
 143             )
 144             . '"';
 145         }
 146
 147         return null;
 148     }
 149
 150     /**
 151      * Return true if read only.
 152      *
 153      * MAY override
 154      *
 155      * @param array $args other arguments
 156      *
 157      * @return boolean is read only action?
 158      */
 159     function isReadOnly(array $args=array())
 160     {
 161         return true;
 162     }
 163 }