Merge remote-tracking branch 'upstream/master' into social-master

[quix0rs-gnu-social.git] / actions / apigrouplist.php

diff --git a/actions/apigrouplist.php b/actions/apigrouplist.php
index 84b7fc1c8c072da17873e477f2a0f272fcb60ee0..2f288bf04fe0d3d8fe674fdc2754cc13b2d922a2 100644 (file)
--- a/actions/apigrouplist.php
+++ b/actions/apigrouplist.php
@@ -21,8 +21,12 @@
  *
  * @category  API
  * @package   StatusNet
+ * @author    Craig Andrews <candrews@integralblue.com>
+ * @author    Evan Prodromou <evan@status.net>
+ * @author    Jeffery To <jeffery.to@gmail.com>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009 StatusNet, Inc.
+ * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
@@ -31,27 +35,20 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once INSTALLDIR . '/lib/apibareauth.php';
-
 /**
  * Returns whether a user is a member of a specified group.
  *
  * @category API
  * @package  StatusNet
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Jeffery To <jeffery.to@gmail.com>
  * @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 $format   = null;
-    var $user     = null;
-    var $page     = null;
-    var $count    = null;
-    var $max_id   = null;
-    var $since_id = null;
-    var $since    = null;
     var $groups   = null;
 
     /**
@@ -60,27 +57,19 @@ class ApiGroupListAction extends ApiBareAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
-    function prepare($args)
+    protected function prepare(array $args=array())
     {
         parent::prepare($args);
 
-        if ($this->requiresAuth()) {
-            if ($this->checkBasicAuthUser() == false) {
-                return;
-            }
+        //TODO: Make sure this doesn't leak unwantedly for federated users
+        $this->target = $this->getTargetProfile(null);
+
+        if (!($this->target instanceof Profile)) {
+            // TRANS: Client error displayed when user not found for an action.
+            $this->clientError(_('No such user.'), 404);
         }
 
-        $this->page     = (int)$this->arg('page', 1);
-        $this->count    = (int)$this->arg('count', 20);
-        $this->max_id   = (int)$this->arg('max_id', 0);
-        $this->since_id = (int)$this->arg('since_id', 0);
-        $this->since    = $this->arg('since');
-        
-        $this->user   = $this->getTargetUser($id);
-        $this->format = $this->arg('format');
         $this->groups = $this->getGroups();
 
         return true;
@@ -91,45 +80,39 @@ class ApiGroupListAction extends ApiBareAuthAction
      *
      * Show the user's groups
      *
-     * @param array $args $_REQUEST data (unused)
-     *
      * @return void
      */
-
-    function handle($args)
+    protected function handle()
     {
-        parent::handle($args);
-
-        if (empty($this->user)) {
-            $this->clientError(_('No such user!'), 404, $this->format);
-            return;
-        }
+        parent::handle();
 
         $sitename   = common_config('site', 'name');
-        $title      = sprintf(_("%s's groups"), $this->user->nickname);
-        $taguribase = common_config('integration', 'taguri');
+        // TRANS: Used as title in check for group membership. %s is a user name.
+        $title      = sprintf(_("%s's groups"), $this->target->nickname);
+        $taguribase = TagURI::base();
         $id         = "tag:$taguribase:Groups";
         $link       = common_local_url(
             'usergroups',
-            array('nickname' => $this->user->nickname)
+            array('nickname' => $this->target->nickname)
         );
+
         $subtitle   = sprintf(
-            _("Groups %s is a member of on %s."),
-            $this->user->nickname,
-            $sitename
+            // TRANS: Used as subtitle in check for group membership. %1$s is the site name, %2$s is a user name.
+            _('%1$s groups %2$s is a member of.'),
+            $sitename,
+            $this->target->nickname
         );
 
         switch($this->format) {
         case 'xml':
-            $this->show_xml_groups($this->groups);
+            $this->showXmlGroups($this->groups);
             break;
         case 'rss':
-            $this->show_rss_groups($this->groups, $title, $link, $subtitle);
+            $this->showRssGroups($this->groups, $title, $link, $subtitle);
             break;
         case 'atom':
-            $selfuri = common_root_url() . 'api/statusnet/groups/list/' .
-                $this->user->id . '.atom';
-            $this->show_atom_groups(
+            $selfuri = common_local_url('ApiGroupList', array('id'=>$this->target->id, 'format'=>'atom'));
+            $this->showAtomGroups(
                 $this->groups,
                 $title,
                 $id,
@@ -139,17 +122,12 @@ class ApiGroupListAction extends ApiBareAuthAction
             );
             break;
         case 'json':
-            $this->show_json_groups($this->groups);
+            $this->showJsonGroups($this->groups);
             break;
         default:
-            $this->clientError(
-                _('API method not found!'),
-                404,
-                $this->format
-            );
-            break;
+            // TRANS: Client error displayed when coming across a non-supported API method.
+            $this->clientError(_('API method not found.'), 404);
         }
-
     }
 
     /**
@@ -157,17 +135,15 @@ class ApiGroupListAction extends ApiBareAuthAction
      *
      * @return array groups
      */
-
     function getGroups()
     {
         $groups = array();
 
-        $group = $this->user->getGroups(
+        $group = $this->target->getGroups(
             ($this->page - 1) * $this->count,
             $this->count,
             $this->since_id,
-            $this->max_id,
-            $this->since
+            $this->max_id
         );
 
         while ($group->fetch()) {
@@ -184,8 +160,7 @@ class ApiGroupListAction extends ApiBareAuthAction
      *
      * @return boolean true
      */
-
-    function isReadOnly($args)
+    function isReadOnly(array $args=array())
     {
         return true;
     }
@@ -213,7 +188,6 @@ class ApiGroupListAction extends ApiBareAuthAction
      *
      * @return string etag
      */
-
     function etag()
     {
         if (!empty($this->groups) && (count($this->groups) > 0)) {
@@ -223,8 +197,9 @@ class ApiGroupListAction extends ApiBareAuthAction
             return '"' . implode(
                 ':',
                 array($this->arg('action'),
+                      common_user_cache_hash($this->auth_user),
                       common_language(),
-                      $this->user->id,
+                      $this->target->id,
                       strtotime($this->groups[0]->created),
                       strtotime($this->groups[$last]->created))
             )
@@ -233,5 +208,4 @@ class ApiGroupListAction extends ApiBareAuthAction
 
         return null;
     }
-
 }