Switching variable access in ApiTimelineUser to GNUsocial improvements

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

diff --git a/actions/apifriendshipsexists.php b/actions/apifriendshipsexists.php
index 1ebfc9e8fd31858fcf29485a82149e9e9163e547..4bb771292d61ab964fab7fef40954bf494ad7323 100644 (file)
--- a/actions/apifriendshipsexists.php
+++ b/actions/apifriendshipsexists.php
@@ -21,33 +21,32 @@
  *
  * @category  API
  * @package   StatusNet
+ * @author    Dan Moore <dan@moore.cx>
+ * @author    Evan Prodromou <evan@status.net>
  * @author    Zach Copley <zach@status.net>
- * @copyright 2009 StatusNet, Inc.
+ * @copyright 2009-2010 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    exit(1);
-}
-
-require_once INSTALLDIR.'/lib/api.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
- * Tests for the existence of friendship between two users. Will return true if 
+ * Tests for the existence of friendship between two users. Will return true if
  * user_a follows user_b, otherwise will return false.
  *
  * @category API
  * @package  StatusNet
+ * @author   Dan Moore <dan@moore.cx>
+ * @author   Evan Prodromou <evan@status.net>
  * @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 ApiFriendshipsExistsAction extends TwitterApiAction
+class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
 {
-    var $user_a = null;
-    var $user_b = null;
+    var $profile_a = null;
+    var $profile_b = null;
 
     /**
      * Take arguments for running
@@ -55,27 +54,13 @@ class ApiFriendshipsExistsAction extends TwitterApiAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
-    function prepare($args)
+    protected function prepare(array $args=array())
     {
         parent::prepare($args);
 
-        $user_a_id = $this->trimmed('user_a');
-        $user_b_id = $this->trimmed('user_b');
-
-        common_debug("user_a = " . $user_a_id);
-        common_debug("user_b = " . $user_b_id);
-
-
-        $this->user_a = $this->getTargetUser($user_a_id);
-
-        if (empty($this->user_a)) {
-            common_debug('gargargra');
-        }
-
-        $this->user_b = $this->getTargetUser($user_b_id);
+        $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
+        $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
 
         return true;
     }
@@ -85,40 +70,49 @@ class ApiFriendshipsExistsAction extends TwitterApiAction
      *
      * Check the format and show the user info
      *
-     * @param array $args $_REQUEST data (unused)
-     *
      * @return void
      */
-
-    function handle($args)
+    protected function handle()
     {
-        parent::handle($args);
+        parent::handle();
 
-        if (empty($this->user_a) || empty($this->user_b)) {
+        if (empty($this->profile_a) || empty($this->profile_b)) {
             $this->clientError(
-                _('Two user ids or screen_names must be supplied.'),
-                400,
-                $this->format
+                // TRANS: Client error displayed when supplying invalid parameters to an API call checking if a friendship exists.
+                _('Two valid IDs or nick names must be supplied.'),
+                400
             );
-            return;
         }
 
-        $result = $this->user_a->isSubscribed($this->user_b);
+        $result = Subscription::exists($this->profile_a, $this->profile_b);
 
         switch ($this->format) {
         case 'xml':
-            $this->init_document('xml');
+            $this->initDocument('xml');
             $this->element('friends', null, $result);
-            $this->end_document('xml');
+            $this->endDocument('xml');
             break;
         case 'json':
-            $this->init_document('json');
+            $this->initDocument('json');
             print json_encode($result);
-            $this->end_document('json');
+            $this->endDocument('json');
             break;
         default:
             break;
         }
     }
 
+    /**
+     * Return true if read only.
+     *
+     * MAY override
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean is read only action?
+     */
+    function isReadOnly($args)
+    {
+        return true;
+    }
 }