apifriendshipsexists.php 3.4 KB

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