apiblockdestroy.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. <?php
  2. /**
  3. * StatusNet, the distributed open-source microblogging tool
  4. *
  5. * Un-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. * Un-blocks the user specified in the ID parameter for the authenticating user.
  35. * Returns the un-blocked user in the requested format when successful.
  36. *
  37. * @category API
  38. * @package StatusNet
  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 ApiBlockDestroyAction extends ApiAuthAction
  45. {
  46. protected $needPost = true;
  47. var $other = 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->other = $this->getTargetProfile($this->arg('id'));
  59. return true;
  60. }
  61. /**
  62. * Handle the request
  63. *
  64. * Save the new message
  65. *
  66. * @return void
  67. */
  68. protected function handle()
  69. {
  70. parent::handle();
  71. if (empty($this->user) || empty($this->other)) {
  72. // TRANS: Client error when user not found for an API action to remove a block for a user.
  73. $this->clientError(_('No such user.'), 404);
  74. }
  75. if ($this->user->hasBlocked($this->other)) {
  76. if (Event::handle('StartUnblockProfile', array($this->user, $this->other))) {
  77. $result = $this->user->unblock($this->other);
  78. if ($result) {
  79. Event::handle('EndUnblockProfile', array($this->user, $this->other));
  80. }
  81. }
  82. }
  83. if (!$this->user->hasBlocked($this->other)) {
  84. $this->initDocument($this->format);
  85. $this->showProfile($this->other, $this->format);
  86. $this->endDocument($this->format);
  87. } else {
  88. // TRANS: Server error displayed when unblocking a user has failed.
  89. $this->serverError(_('Unblock user failed.'));
  90. }
  91. }
  92. }