3 * StatusNet, the distributed open-source microblogging tool
5 * Show the newest groups
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.
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.
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/>.
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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
37 require_once INSTALLDIR . '/lib/apiprivateauth.php';
40 * Returns of the lastest 20 groups for the site
44 * @author Craig Andrews <candrews@integralblue.com>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Jeffery To <jeffery.to@gmail.com>
47 * @author Zach Copley <zach@status.net>
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/
52 class ApiGroupListAllAction extends ApiPrivateAuthAction
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
65 function prepare($args)
67 parent::prepare($args);
69 $this->user = $this->getTargetUser(null);
70 $this->groups = $this->getGroups();
78 * Show the user's groups
80 * @param array $args $_REQUEST data (unused)
85 function handle($args)
87 parent::handle($args);
89 $sitename = common_config('site', 'name');
90 // TRANS: Message is used as a title. %s is a site name.
91 $title = sprintf(_("%s groups"), $sitename);
92 $taguribase = TagURI::base();
93 $id = "tag:$taguribase:Groups";
94 $link = common_local_url('groups');
95 $subtitle = sprintf(_("groups on %s"), $sitename);
97 switch($this->format) {
99 $this->showXmlGroups($this->groups);
102 $this->showRssGroups($this->groups, $title, $link, $subtitle);
105 $selfuri = common_root_url() .
106 'api/statusnet/groups/list_all.atom';
107 $this->showAtomGroups(
117 $this->showJsonGroups($this->groups);
121 _('API method not found.'),
133 * @return array groups
138 $qry = 'SELECT user_group.* '.
139 'from user_group join local_group on user_group.id = local_group.group_id '.
140 'order by created desc ';
141 $offset = intval($this->page - 1) * intval($this->count);
142 $limit = intval($this->count);
143 if (common_config('db', 'type') == 'pgsql') {
144 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
146 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
148 $group = new User_group();
153 while ($group->fetch()) {
154 $groups[] = clone($group);
161 * Is this action read only?
163 * @param array $args other arguments
165 * @return boolean true
168 function isReadOnly($args)
174 * When was this feed last modified?
176 * @return string datestamp of the site's latest group
179 function lastModified()
181 if (!empty($this->groups) && (count($this->groups) > 0)) {
182 return strtotime($this->groups[0]->created);
189 * An entity tag for this list of groups
191 * Returns an Etag based on the action name, language, and
192 * timestamps of the first and last group the user has joined
194 * @return string etag
199 if (!empty($this->groups) && (count($this->groups) > 0)) {
201 $last = count($this->groups) - 1;
203 return '"' . implode(
205 array($this->arg('action'),
207 strtotime($this->groups[0]->created),
208 strtotime($this->groups[$last]->created))