New actions for managing subscriptions (friendships)

1 files changed, 175 insertions, 0 deletions

diff --git a/actions/apifriendshipsshow.php b/actions/apifriendshipsshow.php
new file mode 100644
index 000000000..d35825a43
--- /dev/null
+++ b/actions/apifriendshipsshow.php
@@ -0,0 +1,175 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Show information about the relationship between two users
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  API
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2009 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/apibareauth.php';
+
+/**
+ * Outputs detailed information about the relationship between two users
+ *
+ * @category API
+ * @package  StatusNet
+ * @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 ApiFriendshipsShowAction extends ApiBareAuthAction
+{
+
+    var $format = null;
+    var $user   = null;
+    var $source = null;
+    var $target = null;
+
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     *
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        if ($this->requiresAuth()) {
+            if ($this->checkBasicAuthUser() == false) {
+                return;
+            }
+        }
+
+        $this->format = $this->arg('format');
+
+        $source_id          = (int)$this->trimmed('source_id');
+        $source_screen_name = $this->trimmed('source_screen_name');
+        $target_id          = (int)$this->trimmed('target_id');
+        $target_screen_name = $this->trimmed('target_screen_name');
+    
+        if (!empty($source_id)) {
+            $this->source = User::staticGet($source_id);
+        } elseif (!empty($source_screen_name)) {
+            $this->source = User::staticGet('nickname', $source_screen_name);
+        } else {
+            $this->source = $this->auth_user;
+        }
+
+        if (!empty($target_id)) {
+            $this->target = User::staticGet($target_id);
+        } elseif (!empty($target_screen_name)) {
+            $this->target = User::staticGet('nickname', $target_screen_name);
+        }
+
+        return true;
+    }
+
+
+    /**
+     * Determines whether this API resource requires auth.  Overloaded to look
+     * return true in case source_id and source_screen_name are both empty
+     *
+     * @return boolean true or false
+     */
+       
+    function requiresAuth()
+    {
+        if (common_config('site', 'private')) {
+            return true;
+        }
+
+        $source_id          = $this->trimmed('source_id');
+        $source_screen_name = $this->trimmed('source_screen_name');
+
+        if (empty($source_id) && empty($source_screen_name)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Handle the request
+     *
+     * Check the format and show the user info
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+
+        if (!in_array($this->format, array('xml', 'json'))) {
+            $this->clientError(_('API method not found!'), 404);
+            return;
+        }
+        
+        if (empty($this->source)) {
+            $this->clientError(
+                _('Could not determine source user.'),
+                404
+             );
+            return;
+        }
+              
+        if (empty($this->target)) {
+            $this->clientError(
+                _('Could not find target user.'),
+                404
+            );
+            return;
+        }
+        
+        $result = $this->twitter_relationship_array($this->source, $this->target);
+
+        switch ($this->format) {
+        case 'xml':
+            $this->init_document('xml');
+            $this->show_twitter_xml_relationship($result[relationship]);
+            $this->end_document('xml');
+            break;
+        case 'json':
+            $this->init_document('json');
+            print json_encode($result);
+            $this->end_document('json');
+            break;
+        default:
+            break;
+        }
+        
+    }
+
+}