]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/atompubmembershipfeed.php
Type-hint is array here.
[quix0rs-gnu-social.git] / actions / atompubmembershipfeed.php
index 3002576c15eb2c38b0b2b89dd7a5a1c6548a535e..1a77e60ff5e9c5c2bed0129196f6c736d29ca503 100644 (file)
@@ -4,7 +4,7 @@
  * Copyright (C) 2010, StatusNet, Inc.
  *
  * Feed of group memberships for a user, in ActivityStreams format
- * 
+ *
  * PHP version 5
  *
  * This program is free software: you can redistribute it and/or modify
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    // This check helps protect against security problems;
-    // your code file can't be executed directly from the web.
-    exit(1);
-}
-
-require_once INSTALLDIR . '/lib/apiauth.php';
+if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
 
 /**
  * Feed of group memberships for a user, in ActivityStreams format
@@ -46,68 +40,34 @@ require_once INSTALLDIR . '/lib/apiauth.php';
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  * @link      http://status.net/
  */
-
-class AtompubmembershipfeedAction extends ApiAuthAction
+class AtompubmembershipfeedAction extends AtompubAction
 {
     private $_profile     = null;
     private $_memberships = null;
 
-    /**
-     * For initializing members of the class.
-     *
-     * @param array $argarray misc. arguments
-     *
-     * @return boolean true
-     */
-
-    function prepare($argarray)
+    protected function atompubPrepare()
     {
-        parent::prepare($argarray);
-
-        $profileId = $this->trimmed('profile');
+        $this->_profile = Profile::getKV('id', $this->trimmed('profile'));
 
-        $this->_profile = Profile::staticGet('id', $profileId);
-        
-        if (empty($this->_profile)) {
+        if (!$this->_profile instanceof Profile) {
+            // TRANS: Client exception.
             throw new ClientException(_('No such profile.'), 404);
         }
 
-        $offset = ($this->page-1) * $this->count;
-        $limit  = $this->count + 1;
-
         $this->_memberships = Group_member::byMember($this->_profile->id,
-                                                     $offset,
-                                                     $limit);
-        
+                                                     $this->offset,
+                                                     $this->limit);
         return true;
     }
 
-    /**
-     * Handler method
-     *
-     * @param array $argarray is ignored since it's now passed in in prepare()
-     *
-     * @return void
-     */
-
-    function handle($argarray=null)
+    protected function handleGet()
     {
-        parent::handle($argarray);
-
-        switch ($_SERVER['REQUEST_METHOD']) {
-        case 'HEAD':
-        case 'GET':
-            $this->showFeed();
-            break;
-        case 'POST':
-            $this->addMembership();
-            break;
-        default:
-            throw new ClientException(_('HTTP method not supported.'), 405);
-            return;
-        }
+        return $this->showFeed();
+    }
 
-        return;
+    protected function handlePost()
+    {
+        return $this->addMembership();
     }
 
     /**
@@ -115,7 +75,6 @@ class AtompubmembershipfeedAction extends ApiAuthAction
      *
      * @return void
      */
-
     function showFeed()
     {
         header('Content-Type: application/atom+xml; charset=utf-8');
@@ -141,21 +100,25 @@ class AtompubmembershipfeedAction extends ApiAuthAction
         $feed->addAuthor($this->_profile->getBestName(),
                          $this->_profile->getURI());
 
-        $feed->setTitle(sprintf(_("%s group memberships"),
+        // TRANS: Title for group membership feed.
+        // TRANS: %s is a username.
+        $feed->setTitle(sprintf(_('Group memberships of %s'),
                                 $this->_profile->getBestName()));
 
-        $feed->setSubtitle(sprintf(_("Groups %s is a member of on %s"),
+        // TRANS: Subtitle for group membership feed.
+        // TRANS: %1$s is a username, %2$s is the StatusNet sitename.
+        $feed->setSubtitle(sprintf(_('Groups %1$s is a member of on %2$s'),
                                    $this->_profile->getBestName(),
                                    common_config('site', 'name')));
 
         $feed->addLink(common_local_url('usergroups',
-                                        array('nickname' => 
+                                        array('nickname' =>
                                               $this->_profile->nickname)));
 
         $feed->addLink($url,
                        array('rel' => 'self',
                              'type' => 'application/atom+xml'));
-                                        
+
         // If there's more...
 
         if ($this->page > 1) {
@@ -164,9 +127,9 @@ class AtompubmembershipfeedAction extends ApiAuthAction
                                  'type' => 'application/atom+xml'));
 
             $feed->addLink(common_local_url('AtomPubMembershipFeed',
-                                            array('profile' => 
+                                            array('profile' =>
                                                   $this->_profile->id),
-                                            array('page' => 
+                                            array('page' =>
                                                   $this->page - 1)),
                            array('rel' => 'prev',
                                  'type' => 'application/atom+xml'));
@@ -207,17 +170,17 @@ class AtompubmembershipfeedAction extends ApiAuthAction
      *
      * @return void
      */
-
     function addMembership()
     {
         // XXX: Refactor this; all the same for atompub
 
         if (empty($this->auth_user) ||
             $this->auth_user->id != $this->_profile->id) {
-            throw new ClientException(_("Can't add someone else's".
-                                        " membership"), 403);
+            // TRANS: Client exception thrown when trying subscribe someone else to a group.
+            throw new ClientException(_("Cannot add someone else's".
+                                        " membership."), 403);
         }
-        
+
         $xml = file_get_contents('php://input');
 
         $dom = DOMDocument::loadXML($xml);
@@ -234,25 +197,23 @@ class AtompubmembershipfeedAction extends ApiAuthAction
         $membership = null;
 
         if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
-
             if ($activity->verb != ActivityVerb::JOIN) {
-                // TRANS: Client error displayed when not using the POST verb.
-                // TRANS: Do not translate POST.
-                throw new ClientException(_('Can only handle Join activities.'));
-                return;
+                // TRANS: Client error displayed when not using the join verb.
+                throw new ClientException(_('Can only handle join activities.'));
             }
 
             $groupObj = $activity->objects[0];
 
             if ($groupObj->type != ActivityObject::GROUP) {
-                throw new ClientException(_('Can only fave notices.'));
-                return;
+                // TRANS: Client exception thrown when trying to join something which is not a group
+                throw new ClientException(_('Can only join groups.'));
             }
 
-            $group = User_group::staticGet('uri', $groupObj->id);
-            
+            $group = User_group::getKV('uri', $groupObj->id);
+
             if (empty($group)) {
                 // XXX: import from listed URL or something
+                // TRANS: Client exception thrown when trying to subscribe to a non-existing group.
                 throw new ClientException(_('Unknown group.'));
             }
 
@@ -260,6 +221,7 @@ class AtompubmembershipfeedAction extends ApiAuthAction
                                                'group_id' => $group->id));
 
             if (!empty($old)) {
+                // TRANS: Client exception thrown when trying to subscribe to an already subscribed group.
                 throw new ClientException(_('Already a member.'));
             }
 
@@ -267,13 +229,11 @@ class AtompubmembershipfeedAction extends ApiAuthAction
 
             if (Group_block::isBlocked($group, $profile)) {
                 // XXX: import from listed URL or something
+                // TRANS: Client exception thrown when trying to subscribe to group while blocked from that group.
                 throw new ClientException(_('Blocked by admin.'));
             }
 
-            if (Event::handle('StartJoinGroup', array($group, $this->auth_user))) {
-                $membership = Group_member::join($group->id, $this->auth_user->id);
-                Event::handle('EndJoinGroup', array($group, $this->auth_user));
-            }
+            $this->auth_user->joinGroup($group);
 
             Event::handle('EndAtomPubNewActivity', array($activity, $membership));
         }
@@ -290,26 +250,6 @@ class AtompubmembershipfeedAction extends ApiAuthAction
         }
     }
 
-    /**
-     * Return true if read only.
-     *
-     * MAY override
-     *
-     * @param array $args other arguments
-     *
-     * @return boolean is read only action?
-     */
-
-    function isReadOnly($args)
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
-            $_SERVER['REQUEST_METHOD'] == 'HEAD') {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
     /**
      * Return last modified, if applicable.
      *
@@ -331,25 +271,8 @@ class AtompubmembershipfeedAction extends ApiAuthAction
      *
      * @return string etag http header
      */
-
     function etag()
     {
         return null;
     }
-
-    /**
-     * Does this require authentication?
-     *
-     * @return boolean true if delete, else false
-     */
-
-    function requiresAuth()
-    {
-        if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
-            $_SERVER['REQUEST_METHOD'] == 'HEAD') {
-            return false;
-        } else {
-            return true;
-        }
-    }
 }