apigroupjoin.php 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. <?php
  2. /**
  3. * StatusNet, the distributed open-source microblogging tool
  4. *
  5. * Join a group via the API
  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 Craig Andrews <candrews@integralblue.com>
  25. * @author Evan Prodromou <evan@status.net>
  26. * @author Jeffery To <jeffery.to@gmail.com>
  27. * @author Zach Copley <zach@status.net>
  28. * @copyright 2009 StatusNet, Inc.
  29. * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31. * @link http://status.net/
  32. */
  33. if (!defined('STATUSNET')) {
  34. exit(1);
  35. }
  36. /**
  37. * Joins the authenticated user to the group speicified by ID
  38. *
  39. * @category API
  40. * @package StatusNet
  41. * @author Craig Andrews <candrews@integralblue.com>
  42. * @author Evan Prodromou <evan@status.net>
  43. * @author Jeffery To <jeffery.to@gmail.com>
  44. * @author Zach Copley <zach@status.net>
  45. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46. * @link http://status.net/
  47. */
  48. class ApiGroupJoinAction extends ApiAuthAction
  49. {
  50. protected $needPost = true;
  51. var $group = null;
  52. /**
  53. * Take arguments for running
  54. *
  55. * @param array $args $_REQUEST args
  56. *
  57. * @return boolean success flag
  58. */
  59. protected function prepare(array $args=array())
  60. {
  61. parent::prepare($args);
  62. $this->group = $this->getTargetGroup($this->arg('id'));
  63. return true;
  64. }
  65. /**
  66. * Handle the request
  67. *
  68. * Join the authenticated user to the group
  69. *
  70. * @return void
  71. */
  72. protected function handle()
  73. {
  74. parent::handle();
  75. if (empty($this->scoped)) {
  76. // TRANS: Client error displayed when trying to have a non-existing user join a group.
  77. $this->clientError(_('No such user.'), 404);
  78. }
  79. if (empty($this->group)) {
  80. // TRANS: Client error displayed when trying to join a group that does not exist.
  81. $this->clientError(_('Group not found.'), 404);
  82. }
  83. if ($this->scoped->isMember($this->group)) {
  84. // TRANS: Server error displayed when trying to join a group the user is already a member of.
  85. $this->clientError(_('You are already a member of that group.'), 403);
  86. }
  87. if (Group_block::isBlocked($this->group, $this->scoped)) {
  88. // TRANS: Server error displayed when trying to join a group the user is blocked from joining.
  89. $this->clientError(_('You have been blocked from that group by the admin.'), 403);
  90. }
  91. try {
  92. $this->scoped->joinGroup($this->group);
  93. } catch (Exception $e) {
  94. // TRANS: Server error displayed when joining a group failed in the database.
  95. // TRANS: %1$s is the joining user's nickname, $2$s is the group nickname for which the join failed.
  96. $this->serverError(sprintf(_('Could not join user %1$s to group %2$s.'),
  97. $this->scoped->nickname, $this->group->nickname));
  98. }
  99. switch($this->format) {
  100. case 'xml':
  101. $this->showSingleXmlGroup($this->group);
  102. break;
  103. case 'json':
  104. $this->showSingleJsonGroup($this->group);
  105. break;
  106. default:
  107. // TRANS: Client error displayed when coming across a non-supported API method.
  108. $this->clientError(_('API method not found.'), 404);
  109. }
  110. }
  111. }