apigroupshow.php 4.72 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Show information about a group
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  API
 * @package   StatusNet
Zach Copley's avatar
Zach Copley committed
24 25 26
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
27 28
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
29
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30 31 32 33 34 35 36 37
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

38
require_once INSTALLDIR . '/lib/apiprivateauth.php';
39 40 41 42 43 44

/**
 * Outputs detailed information about the group specified by ID
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
45 46 47
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
48
 * @author   Zach Copley <zach@status.net>
49
 * @author   Michele <macno@macno.org>
50 51 52
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
53
class ApiGroupShowAction extends ApiPrivateAuthAction
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
{
    var $group = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);

        $this->group = $this->getTargetGroup($this->arg('id'));

70 71 72 73 74 75 76 77 78 79
        if (empty($this->group)) {
            $alias = Group_alias::staticGet(
                'alias',
                common_canonical_nickname($this->arg('id'))
            );
            if (!empty($alias)) {
                $args = array('id' => $alias->group_id, 'format' => $this->format);
                common_redirect(common_local_url('ApiGroupShow', $args), 301);
            } else {
                $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
80
                    // TRANS: Client error displayed when trying to show a group that could not be found.
81
                    _('Group not found.'),
82 83 84 85 86 87 88
                    404,
                    $this->format
                );
            }
            return;
        }

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        return true;
    }

    /**
     * Handle the request
     *
     * Check the format and show the user info
     *
     * @param array $args $_REQUEST data (unused)
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

        switch($this->format) {
        case 'xml':
Zach Copley's avatar
Zach Copley committed
107
            $this->showSingleXmlGroup($this->group);
108 109
            break;
        case 'json':
110
            $this->showSingleJsonGroup($this->group);
111 112
            break;
        default:
Siebrand Mazeland's avatar
Siebrand Mazeland committed
113
            // TRANS: Client error displayed trying to execute an unknown API method showing a group.
114
            $this->clientError(_('API method not found.'), 404, $this->format);
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
            break;
        }
    }

    /**
     * When was this group last modified?
     *
     * @return string datestamp of the latest notice in the stream
     */
    function lastModified()
    {
        if (!empty($this->group)) {
            return strtotime($this->group->modified);
        }

        return null;
    }

    /**
     * An entity tag for this group
     *
     * Returns an Etag based on the action name, language, and
     * timestamps of the notice
     *
     * @return string etag
     */
    function etag()
    {
        if (!empty($this->group)) {

            return '"' . implode(
                ':',
                array($this->arg('action'),
148
                      common_user_cache_hash($this->auth_user),
149 150 151 152 153 154 155 156 157 158
                      common_language(),
                      $this->group->id,
                      strtotime($this->group->modified))
            )
            . '"';
        }

        return null;
    }

159 160 161 162 163 164 165 166 167 168 169 170 171
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return true;
    }
172
}