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('GNUSOCIAL')) { exit(1); }
  33
  34 /**
  35  * Tests for the existence of friendship between two users. Will return true if
  36  * user_a follows user_b, otherwise will return false.
  37  *
  38  * @category API
  39  * @package  StatusNet
  40  * @author   Dan Moore <dan@moore.cx>
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
  47 {
  48     var $profile_a = null;
  49     var $profile_b = null;
  50
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      */
  58     protected function prepare(array $args=array())
  59     {
  60         parent::prepare($args);
  61
  62         $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
  63         $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
  64
  65         return true;
  66     }
  67
  68     /**
  69      * Handle the request
  70      *
  71      * Check the format and show the user info
  72      *
  73      * @return void
  74      */
  75     protected function handle()
  76     {
  77         parent::handle();
  78
  79         if (empty($this->profile_a) || empty($this->profile_b)) {
  80             $this->clientError(
  81                 // TRANS: Client error displayed when supplying invalid parameters to an API call checking if a friendship exists.
  82                 _('Two valid IDs or nick names must be supplied.'),
  83                 400
  84             );
  85         }
  86
  87         $result = Subscription::exists($this->profile_a, $this->profile_b);
  88
  89         switch ($this->format) {
  90         case 'xml':
  91             $this->initDocument('xml');
  92             $this->element('friends', null, $result);
  93             $this->endDocument('xml');
  94             break;
  95         case 'json':
  96             $this->initDocument('json');
  97             print json_encode($result);
  98             $this->endDocument('json');
  99             break;
 100         default:
 101             break;
 102         }
 103     }
 104
 105     /**
 106      * Return true if read only.
 107      *
 108      * MAY override
 109      *
 110      * @param array $args other arguments
 111      *
 112      * @return boolean is read only action?
 113      */
 114     function isReadOnly($args)
 115     {
 116         return true;
 117     }
 118 }