apigrouplist.php 5.89 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
 *
 * Check to see whether a user a member of 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 38 39 40 41 42
 * @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);
}

/**
 * Returns whether a user is a member of a specified group.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
43 44 45
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class ApiGroupListAction extends ApiBareAuthAction
{
    var $groups   = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
61
    protected function prepare(array $args=array())
62 63
    {
        parent::prepare($args);
Zach Copley's avatar
Zach Copley committed
64

65 66
        //TODO: Make sure this doesn't leak unwantedly for federated users
        $this->target = $this->getTargetProfile(null);
67

68
        if (!($this->target instanceof Profile)) {
69
            // TRANS: Client error displayed when user not found for an action.
70
            $this->clientError(_('No such user.'), 404);
71 72
        }

73 74 75 76 77 78 79 80 81 82 83 84
        $this->groups = $this->getGroups();

        return true;
    }

    /**
     * Handle the request
     *
     * Show the user's groups
     *
     * @return void
     */
85
    protected function handle()
86
    {
87
        parent::handle();
88 89

        $sitename   = common_config('site', 'name');
Siebrand Mazeland's avatar
Siebrand Mazeland committed
90
        // TRANS: Used as title in check for group membership. %s is a user name.
91
        $title      = sprintf(_("%s's groups"), $this->target->nickname);
92
        $taguribase = TagURI::base();
93 94 95
        $id         = "tag:$taguribase:Groups";
        $link       = common_local_url(
            'usergroups',
96
            array('nickname' => $this->target->nickname)
97
        );
98

99
        $subtitle   = sprintf(
100
            // TRANS: Used as subtitle in check for group membership. %1$s is the site name, %2$s is a user name.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
101
            _('%1$s groups %2$s is a member of.'),
102
            $sitename,
103
            $this->target->nickname
104 105 106 107
        );

        switch($this->format) {
        case 'xml':
108
            $this->showXmlGroups($this->groups);
109 110
            break;
        case 'rss':
111
            $this->showRssGroups($this->groups, $title, $link, $subtitle);
112 113
            break;
        case 'atom':
114
            $selfuri = common_local_url('ApiGroupList', array('id'=>$this->target->id, 'format'=>'atom'));
115
            $this->showAtomGroups(
116 117 118 119 120 121 122 123 124
                $this->groups,
                $title,
                $id,
                $link,
                $subtitle,
                $selfuri
            );
            break;
        case 'json':
125
            $this->showJsonGroups($this->groups);
126 127
            break;
        default:
128 129
            // TRANS: Client error displayed when coming across a non-supported API method.
            $this->clientError(_('API method not found.'), 404);
130 131 132 133 134 135 136 137 138 139 140 141
        }
    }

    /**
     * Get groups
     *
     * @return array groups
     */
    function getGroups()
    {
        $groups = array();

142
        $group = $this->target->getGroups(
143 144 145
            ($this->page - 1) * $this->count,
            $this->count,
            $this->since_id,
146
            $this->max_id
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
        );

        while ($group->fetch()) {
            $groups[] = clone($group);
        }

        return $groups;
    }

    /**
     * Is this action read only?
     *
     * @param array $args other arguments
     *
     * @return boolean true
     */
    function isReadOnly($args)
    {
        return true;
    }

    /**
     * When was this feed last modified?
     *
     * @return string datestamp of the latest group the user has joined
     */

    function lastModified()
    {
        if (!empty($this->groups) && (count($this->groups) > 0)) {
            return strtotime($this->groups[0]->created);
        }

        return null;
    }

    /**
     * An entity tag for this list of groups
     *
     * Returns an Etag based on the action name, language, user ID and
     * timestamps of the first and last group the user has joined
     *
     * @return string etag
     */
    function etag()
    {
        if (!empty($this->groups) && (count($this->groups) > 0)) {

            $last = count($this->groups) - 1;

            return '"' . implode(
                ':',
                array($this->arg('action'),
200
                      common_user_cache_hash($this->auth_user),
201
                      common_language(),
202
                      $this->target->id,
203 204 205 206 207 208 209 210 211
                      strtotime($this->groups[0]->created),
                      strtotime($this->groups[$last]->created))
            )
            . '"';
        }

        return null;
    }
}