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 * @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/
34 if (!defined('STATUSNET')) {
39 * Returns of the lastest 20 groups for the site
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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
50 class ApiGroupListAllAction extends ApiPrivateAuthAction
55 * Take arguments for running
57 * @param array $args $_REQUEST args
59 * @return boolean success flag
61 function prepare(array $args = array())
63 parent::prepare($args);
65 $this->user = $this->getTargetUser(null);
66 $this->groups = $this->getGroups();
74 * Show the user's groups
76 * @param array $args $_REQUEST data (unused)
84 $sitename = common_config('site', 'name');
85 // TRANS: Message is used as a title when listing the lastest 20 groups. %s is a site name.
86 $title = sprintf(_("%s groups"), $sitename);
87 $taguribase = TagURI::base();
88 $id = "tag:$taguribase:Groups";
89 $link = common_local_url('groups');
90 // TRANS: Message is used as a subtitle when listing the latest 20 groups. %s is a site name.
91 $subtitle = sprintf(_("groups on %s"), $sitename);
93 switch($this->format) {
95 $this->showXmlGroups($this->groups);
98 $this->showRssGroups($this->groups, $title, $link, $subtitle);
101 $selfuri = common_root_url() .
102 'api/statusnet/groups/list_all.atom';
103 $this->showAtomGroups(
113 $this->showJsonGroups($this->groups);
117 // TRANS: Client error displayed when coming across a non-supported API method.
118 _('API method not found.'),
129 * @return array groups
133 $qry = 'SELECT user_group.* '.
134 'from user_group join local_group on user_group.id = local_group.group_id '.
135 'order by created desc ';
136 $offset = intval($this->page - 1) * intval($this->count);
137 $limit = intval($this->count);
138 if (common_config('db', 'type') == 'pgsql') {
139 $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
141 $qry .= ' LIMIT ' . $offset . ', ' . $limit;
143 $group = new User_group();
148 while ($group->fetch()) {
149 $groups[] = clone($group);
156 * Is this action read only?
158 * @param array $args other arguments
160 * @return boolean true
162 function isReadOnly($args)
168 * When was this feed last modified?
170 * @return string datestamp of the site's latest group
172 function lastModified()
174 if (!empty($this->groups) && (count($this->groups) > 0)) {
175 return strtotime($this->groups[0]->created);
182 * An entity tag for this list of groups
184 * Returns an Etag based on the action name, language, and
185 * timestamps of the first and last group the user has joined
187 * @return string etag
191 if (!empty($this->groups) && (count($this->groups) > 0)) {
193 $last = count($this->groups) - 1;
195 return '"' . implode(
197 array($this->arg('action'),
198 common_user_cache_hash($this->auth_user),
200 strtotime($this->groups[0]->created),
201 strtotime($this->groups[$last]->created))