actions/apifriendshipsexists.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show whether there is a friendship between two users
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Dan Moore <dan@moore.cx>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Zach Copley <zach@status.net>
  27  * @copyright 2009-2010 StatusNet, Inc.
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR . '/lib/apiprivateauth.php';
  37
  38 /**
  39  * Tests for the existence of friendship between two users. Will return true if
  40  * user_a follows user_b, otherwise will return false.
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Dan Moore <dan@moore.cx>
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  50
  51 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
  52 {
  53     var $profile_a = null;
  54     var $profile_b = null;
  55
  56     /**
  57      * Take arguments for running
  58      *
  59      * @param array $args $_REQUEST args
  60      *
  61      * @return boolean success flag
  62      *
  63      */
  64
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
  70         $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
  71
  72         return true;
  73     }
  74
  75     /**
  76      * Handle the request
  77      *
  78      * Check the format and show the user info
  79      *
  80      * @param array $args $_REQUEST data (unused)
  81      *
  82      * @return void
  83      */
  84
  85     function handle($args)
  86     {
  87         parent::handle($args);
  88
  89         if (empty($this->profile_a) || empty($this->profile_b)) {
  90             $this->clientError(
  91                 _('Two valid IDs or screen_names must be supplied.'),
  92                 400,
  93                 $this->format
  94             );
  95             return;
  96         }
  97
  98         $result = Subscription::exists($this->profile_a, $this->profile_b);
  99
 100         switch ($this->format) {
 101         case 'xml':
 102             $this->initDocument('xml');
 103             $this->element('friends', null, $result);
 104             $this->endDocument('xml');
 105             break;
 106         case 'json':
 107             $this->initDocument('json');
 108             print json_encode($result);
 109             $this->endDocument('json');
 110             break;
 111         default:
 112             break;
 113         }
 114     }
 115
 116     /**
 117      * Return true if read only.
 118      *
 119      * MAY override
 120      *
 121      * @param array $args other arguments
 122      *
 123      * @return boolean is read only action?
 124      */
 125
 126     function isReadOnly($args)
 127     {
 128         return true;
 129     }
 130
 131 }