managedaction.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. <?php
  2. /**
  3. * StatusNet, the distributed open-source microblogging tool
  4. *
  5. * Base class for all actions with automatic showPage() call in handle()
  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 Action
  23. * @package StatusNet
  24. * @author Evan Prodromou <evan@status.net>
  25. * @author Sarven Capadisli <csarven@status.net>
  26. * @copyright 2008 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('GNUSOCIAL')) { exit(1); }
  31. class ManagedAction extends Action
  32. {
  33. protected function prepare(array $args=array())
  34. {
  35. if (!parent::prepare($args)) {
  36. return false;
  37. }
  38. $this->doPreparation();
  39. return true;
  40. }
  41. protected function doPreparation()
  42. {
  43. // pass by default
  44. }
  45. /**
  46. * Handler method
  47. */
  48. protected function handle()
  49. {
  50. parent::handle();
  51. if ($this->canPost && $this->isPost()) {
  52. try {
  53. $this->msg = $this->handlePost();
  54. } catch (Exception $e) {
  55. $this->error = $e->getMessage();
  56. }
  57. }
  58. $this->showPage();
  59. }
  60. /**
  61. * If this is extended in child classes, they should
  62. * end with 'return parent::handlePost();' - and they
  63. * should only extend this function if what they do
  64. * cannot be handled in ->doPost()
  65. */
  66. protected function handlePost()
  67. {
  68. // This will only be run if the Action has the property canPost==true
  69. assert($this->canPost);
  70. // check for this before token since all POST and FILES data
  71. // is losts when size is exceeded
  72. if (empty($_POST) && $_SERVER['CONTENT_LENGTH']>0) {
  73. // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
  74. // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
  75. $msg = sprintf(_m('The server was unable to handle that much POST data (%s MiB) due to its current configuration.'),
  76. round($_SERVER['CONTENT_LENGTH']/1024/1024,2));
  77. throw new ClientException($msg);
  78. }
  79. $this->checkSessionToken();
  80. return $this->doPost();
  81. }
  82. /**
  83. * Do Post stuff. Return a string if successful,
  84. * describing what has been done. Always throw an
  85. * exception on failure, with a descriptive message.
  86. */
  87. protected function doPost() {
  88. return false;
  89. }
  90. }