apiblockcreate.php 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <?php
  2. /**
  3. * StatusNet, the distributed open-source microblogging tool
  4. *
  5. * Block a user 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 Evan Prodromou <evan@status.net>
  25. * @author Zach Copley <zach@status.net>
  26. * @copyright 2009-2010 StatusNet, Inc.
  27. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28. * @link http://status.net/
  29. */
  30. if (!defined('STATUSNET')) {
  31. exit(1);
  32. }
  33. /**
  34. * Blocks the user specified in the ID parameter as the authenticating user.
  35. * Destroys a friendship to the blocked user if it exists. Returns the
  36. * blocked user in the requested format when successful.
  37. *
  38. * @category API
  39. * @package StatusNet
  40. * @author Evan Prodromou <evan@status.net>
  41. * @author Zach Copley <zach@status.net>
  42. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43. * @link http://status.net/
  44. */
  45. class ApiBlockCreateAction extends ApiAuthAction
  46. {
  47. protected $needPost = true;
  48. var $other = null;
  49. /**
  50. * Take arguments for running
  51. *
  52. * @param array $args $_REQUEST args
  53. *
  54. * @return boolean success flag
  55. *
  56. */
  57. protected function prepare(array $args=array())
  58. {
  59. parent::prepare($args);
  60. $this->other = $this->getTargetProfile($this->arg('id'));
  61. return true;
  62. }
  63. /**
  64. * Handle the request
  65. *
  66. * Save the new message
  67. *
  68. * @param array $args $_REQUEST data (unused)
  69. *
  70. * @return void
  71. */
  72. protected function handle()
  73. {
  74. parent::handle();
  75. if (empty($this->user) || empty($this->other)) {
  76. // TRANS: Client error displayed when trying to block a non-existing user or a user from another site.
  77. $this->clientError(_('No such user.'), 404);
  78. }
  79. // Don't allow blocking yourself!
  80. if ($this->user->id == $this->other->id) {
  81. // TRANS: Client error displayed when users try to block themselves.
  82. $this->clientError(_("You cannot block yourself!"), 403);
  83. }
  84. if (!$this->user->hasBlocked($this->other)) {
  85. if (Event::handle('StartBlockProfile', array($this->user, $this->other))) {
  86. $result = $this->user->block($this->other);
  87. if ($result) {
  88. Event::handle('EndBlockProfile', array($this->user, $this->other));
  89. }
  90. }
  91. }
  92. if ($this->user->hasBlocked($this->other)) {
  93. $this->initDocument($this->format);
  94. $this->showProfile($this->other, $this->format);
  95. $this->endDocument($this->format);
  96. } else {
  97. // TRANS: Server error displayed when blocking a user has failed.
  98. $this->serverError(_('Block user failed.'), 500);
  99. }
  100. }
  101. }