actions/apigrouplistall.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show the newest groups
   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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  30  * @link      http://status.net/
  31  */
  32
  33 if (!defined('STATUSNET')) {
  34     exit(1);
  35 }
  36
  37 require_once INSTALLDIR . '/lib/apiprivateauth.php';
  38
  39 /**
  40  * Returns of the lastest 20 groups for the site
  41  *
  42  * @category API
  43  * @package  StatusNet
  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/
  50  */
  51
  52 class ApiGroupListAllAction extends ApiPrivateAuthAction
  53 {
  54     var $groups   = null;
  55
  56     /**
  57      * Take arguments for running
  58      *
  59      * @param array $args $_REQUEST args
  60      *
  61      * @return boolean success flag
  62      *
  63      */
  64
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $this->user   = $this->getTargetUser(null);
  70         $this->groups = $this->getGroups();
  71
  72         return true;
  73     }
  74
  75     /**
  76      * Handle the request
  77      *
  78      * Show the user's groups
  79      *
  80      * @param array $args $_REQUEST data (unused)
  81      *
  82      * @return void
  83      */
  84
  85     function handle($args)
  86     {
  87         parent::handle($args);
  88
  89         $sitename   = common_config('site', 'name');
  90         $title      = sprintf(_("%s groups"), $sitename);
  91         $taguribase = TagURI::base();
  92         $id         = "tag:$taguribase:Groups";
  93         $link       = common_local_url('groups');
  94         $subtitle   = sprintf(_("groups on %s"), $sitename);
  95
  96         switch($this->format) {
  97         case 'xml':
  98             $this->showXmlGroups($this->groups);
  99             break;
 100         case 'rss':
 101             $this->showRssGroups($this->groups, $title, $link, $subtitle);
 102             break;
 103         case 'atom':
 104             $selfuri = common_root_url() .
 105                 'api/statusnet/groups/list_all.atom';
 106             $this->showAtomGroups(
 107                 $this->groups,
 108                 $title,
 109                 $id,
 110                 $link,
 111                 $subtitle,
 112                 $selfuri
 113             );
 114             break;
 115         case 'json':
 116             $this->showJsonGroups($this->groups);
 117             break;
 118         default:
 119             $this->clientError(
 120                 _('API method not found.'),
 121                 404,
 122                 $this->format
 123             );
 124             break;
 125         }
 126
 127     }
 128
 129     /**
 130      * Get groups
 131      *
 132      * @return array groups
 133      */
 134
 135     function getGroups()
 136     {
 137         $qry = 'SELECT user_group.* '.
 138           'from user_group join local_group on user_group.id = local_group.group_id '.
 139           'order by created desc ';
 140         $offset = intval($this->page - 1) * intval($this->count);
 141         $limit = intval($this->count);
 142         if (common_config('db', 'type') == 'pgsql') {
 143             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 144         } else {
 145             $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 146         }
 147         $group = new User_group();
 148
 149         $group->query($qry);
 150
 151         $groups = array();
 152         while ($group->fetch()) {
 153             $groups[] = clone($group);
 154         }
 155
 156         return $groups;
 157     }
 158
 159     /**
 160      * Is this action read only?
 161      *
 162      * @param array $args other arguments
 163      *
 164      * @return boolean true
 165      */
 166
 167     function isReadOnly($args)
 168     {
 169         return true;
 170     }
 171
 172     /**
 173      * When was this feed last modified?
 174      *
 175      * @return string datestamp of the site's latest group
 176      */
 177
 178     function lastModified()
 179     {
 180         if (!empty($this->groups) && (count($this->groups) > 0)) {
 181             return strtotime($this->groups[0]->created);
 182         }
 183
 184         return null;
 185     }
 186
 187     /**
 188      * An entity tag for this list of groups
 189      *
 190      * Returns an Etag based on the action name, language, and
 191      * timestamps of the first and last group the user has joined
 192      *
 193      * @return string etag
 194      */
 195
 196     function etag()
 197     {
 198         if (!empty($this->groups) && (count($this->groups) > 0)) {
 199
 200             $last = count($this->groups) - 1;
 201
 202             return '"' . implode(
 203                 ':',
 204                 array($this->arg('action'),
 205                       common_language(),
 206                       strtotime($this->groups[0]->created),
 207                       strtotime($this->groups[$last]->created))
 208             )
 209             . '"';
 210         }
 211
 212         return null;
 213     }
 214
 215 }