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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/api.php';
  35
  36 /**
  37  * Tests for the existence of friendship between two users. Will return true if
  38  * user_a follows user_b, otherwise will return false.
  39  *
  40  * @category API
  41  * @package  StatusNet
  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
  47 class ApiFriendshipsExistsAction extends TwitterApiAction
  48 {
  49     var $user_a = null;
  50     var $user_b = null;
  51
  52     /**
  53      * Take arguments for running
  54      *
  55      * @param array $args $_REQUEST args
  56      *
  57      * @return boolean success flag
  58      *
  59      */
  60
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         $user_a_id = $this->trimmed('user_a');
  66         $user_b_id = $this->trimmed('user_b');
  67
  68         common_debug("user_a = " . $user_a_id);
  69         common_debug("user_b = " . $user_b_id);
  70
  71
  72         $this->user_a = $this->getTargetUser($user_a_id);
  73
  74         if (empty($this->user_a)) {
  75             common_debug('gargargra');
  76         }
  77
  78         $this->user_b = $this->getTargetUser($user_b_id);
  79
  80         return true;
  81     }
  82
  83     /**
  84      * Handle the request
  85      *
  86      * Check the format and show the user info
  87      *
  88      * @param array $args $_REQUEST data (unused)
  89      *
  90      * @return void
  91      */
  92
  93     function handle($args)
  94     {
  95         parent::handle($args);
  96
  97         if (empty($this->user_a) || empty($this->user_b)) {
  98             $this->clientError(
  99                 _('Two user ids or screen_names must be supplied.'),
 100                 400,
 101                 $this->format
 102             );
 103             return;
 104         }
 105
 106         $result = $this->user_a->isSubscribed($this->user_b);
 107
 108         switch ($this->format) {
 109         case 'xml':
 110             $this->init_document('xml');
 111             $this->element('friends', null, $result);
 112             $this->end_document('xml');
 113             break;
 114         case 'json':
 115             $this->init_document('json');
 116             print json_encode($result);
 117             $this->end_document('json');
 118             break;
 119         default:
 120             break;
 121         }
 122     }
 123
 124 }