We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

apifriendshipsshow.php 5.13 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?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
Zach Copley's avatar
Zach Copley committed
24 25
 * @author    Dan Moore <dan@moore.cx>
 * @author    Evan Prodromou <evan@status.net>
26 27 28 29 30 31 32 33 34 35
 * @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);
}

Zach Copley's avatar
Zach Copley committed
36
require_once INSTALLDIR . '/lib/apibareauth.php';
37 38 39 40 41 42

/**
 * Outputs detailed information about the relationship between two users
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
43 44
 * @author   Dan Moore <dan@moore.cx>
 * @author   Evan Prodromou <evan@status.net>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * @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 $source = null;
    var $target = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */
    function prepare($args)
    {
        parent::prepare($args);

        $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');
Zach Copley's avatar
Zach Copley committed
69

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
        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'))) {
123
            // TRANS: Client error displayed when coming across a non-supported API method.
124
            $this->clientError(_('API method not found.'), 404);
125 126
            return;
        }
Zach Copley's avatar
Zach Copley committed
127

128 129
        if (empty($this->source)) {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
130
                // TRANS: Client error displayed when a source user could not be determined showing friendship.
131 132 133 134 135
                _('Could not determine source user.'),
                404
             );
            return;
        }
Zach Copley's avatar
Zach Copley committed
136

137 138
        if (empty($this->target)) {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
139
                // TRANS: Client error displayed when a target user could not be determined showing friendship.
140 141 142 143 144
                _('Could not find target user.'),
                404
            );
            return;
        }
Zach Copley's avatar
Zach Copley committed
145

146
        $result = $this->twitterRelationshipArray($this->source, $this->target);
147 148 149

        switch ($this->format) {
        case 'xml':
150 151 152
            $this->initDocument('xml');
            $this->showTwitterXmlRelationship($result[relationship]);
            $this->endDocument('xml');
153 154
            break;
        case 'json':
155
            $this->initDocument('json');
156
            print json_encode($result);
157
            $this->endDocument('json');
158 159 160 161 162 163
            break;
        default:
            break;
        }
    }

164 165 166 167 168 169 170 171 172 173 174 175 176 177
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */

    function isReadOnly($args)
    {
        return true;
    }
178
}