plugins/Poll/actions/respondpoll.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Respond to a Poll
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Poll
  24  * @package   StatusNet
  25  * @author    Brion Vibber <brion@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30 if (!defined('STATUSNET')) {
  31     // This check helps protect against security problems;
  32     // your code file can't be executed directly from the web.
  33     exit(1);
  34 }
  35
  36 /**
  37  * Respond to a Poll
  38  *
  39  * @category  Poll
  40  * @package   StatusNet
  41  * @author    Evan Prodromou <evan@status.net>
  42  * @copyright 2010 StatusNet, Inc.
  43  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  44  * @link      http://status.net/
  45  */
  46 class RespondPollAction extends Action
  47 {
  48     protected $user = null;
  49     protected $error = null;
  50     protected $complete = null;
  51
  52     protected $poll = null;
  53     protected $selection = null;
  54
  55     /**
  56      * Returns the title of the action
  57      *
  58      * @return string Action title
  59      */
  60     function title()
  61     {
  62         // TRANS: Page title for poll response.
  63         return _m('Poll response');
  64     }
  65
  66     /**
  67      * For initializing members of the class.
  68      *
  69      * @param array $args misc. arguments
  70      *
  71      * @return boolean true
  72      * @throws ClientException
  73      */
  74     function prepare(array $args = [])
  75     {
  76         parent::prepare($args);
  77         if ($this->boolean('ajax')) {
  78             GNUsocial::setApi(true);
  79         }
  80
  81         $this->user = common_current_user();
  82
  83         if (empty($this->user)) {
  84             // TRANS: Client exception thrown trying to respond to a poll while not logged in.
  85             throw new ClientException(_m('You must be logged in to respond to a poll.'),
  86                 403);
  87         }
  88
  89         if ($this->isPost()) {
  90             $this->checkSessionToken();
  91         }
  92
  93         $id = $this->trimmed('id');
  94         $this->poll = Poll::getKV('id', $id);
  95         if (empty($this->poll)) {
  96             // TRANS: Client exception thrown trying to respond to a non-existing poll.
  97             throw new ClientException(_m('Invalid or missing poll.'), 404);
  98         }
  99
 100         $selection = intval($this->trimmed('pollselection'));
 101         if ($selection < 1 || $selection > count($this->poll->getOptions())) {
 102             // TRANS: Client exception thrown responding to a poll with an invalid answer.
 103             throw new ClientException(_m('Invalid poll selection.'));
 104         }
 105         $this->selection = $selection;
 106
 107         return true;
 108     }
 109
 110     /**
 111      * Handler method
 112      *
 113      * @return void
 114      */
 115     function handle()
 116     {
 117         parent::handle();
 118
 119         if ($this->isPost()) {
 120             $this->respondPoll();
 121         } else {
 122             $this->showPage();
 123         }
 124
 125         return;
 126     }
 127
 128     /**
 129      * Add a new Poll
 130      *
 131      * @return void
 132      */
 133     function respondPoll()
 134     {
 135         try {
 136             $notice = Poll_response::saveNew($this->user->getProfile(),
 137                 $this->poll,
 138                 $this->selection);
 139         } catch (ClientException $ce) {
 140             $this->error = $ce->getMessage();
 141             $this->showPage();
 142             return;
 143         }
 144
 145         if ($this->boolean('ajax')) {
 146             $this->startHTML('text/xml;charset=utf-8');
 147             $this->elementStart('head');
 148             // TRANS: Page title after sending a poll response.
 149             $this->element('title', null, _m('Poll results'));
 150             $this->elementEnd('head');
 151             $this->elementStart('body');
 152             $form = new PollResultForm($this->poll, $this);
 153             $form->show();
 154             $this->elementEnd('body');
 155             $this->endHTML();
 156         } else {
 157             common_redirect($this->poll->getUrl(), 303);
 158         }
 159     }
 160
 161     /**
 162      * Show the Poll form
 163      *
 164      * @return void
 165      */
 166     function showContent()
 167     {
 168         if (!empty($this->error)) {
 169             $this->element('p', 'error', $this->error);
 170         }
 171
 172         $form = new PollResponseForm($this->poll, $this);
 173
 174         $form->show();
 175
 176         return;
 177     }
 178
 179     /**
 180      * Return true if read only.
 181      *
 182      * MAY override
 183      *
 184      * @param array $args other arguments
 185      *
 186      * @return boolean is read only action?
 187      */
 188     function isReadOnly($args)
 189     {
 190         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 191             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 192             return true;
 193         } else {
 194             return false;
 195         }
 196     }
 197 }