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 $argarray misc. arguments
  70      *
  71      * @return boolean true
  72      */
  73     function prepare($argarray)
  74     {
  75         parent::prepare($argarray);
  76         if ($this->boolean('ajax')) {
  77             GNUsocial::setApi(true);
  78         }
  79
  80         $this->user = common_current_user();
  81
  82         if (empty($this->user)) {
  83             // TRANS: Client exception thrown trying to respond to a poll while not logged in.
  84             throw new ClientException(_m('You must be logged in to respond to a poll.'),
  85                                       403);
  86         }
  87
  88         if ($this->isPost()) {
  89             $this->checkSessionToken();
  90         }
  91
  92         $id = $this->trimmed('id');
  93         $this->poll = Poll::getKV('id', $id);
  94         if (empty($this->poll)) {
  95             // TRANS: Client exception thrown trying to respond to a non-existing poll.
  96             throw new ClientException(_m('Invalid or missing poll.'), 404);
  97         }
  98
  99         $selection = intval($this->trimmed('pollselection'));
 100         if ($selection < 1 || $selection > count($this->poll->getOptions())) {
 101             // TRANS: Client exception thrown responding to a poll with an invalid answer.
 102             throw new ClientException(_m('Invalid poll selection.'));
 103         }
 104         $this->selection = $selection;
 105
 106         return true;
 107     }
 108
 109     /**
 110      * Handler method
 111      *
 112      * @param array $argarray is ignored since it's now passed in in prepare()
 113      *
 114      * @return void
 115      */
 116     function handle($argarray=null)
 117     {
 118         parent::handle($argarray);
 119
 120         if ($this->isPost()) {
 121             $this->respondPoll();
 122         } else {
 123             $this->showPage();
 124         }
 125
 126         return;
 127     }
 128
 129     /**
 130      * Add a new Poll
 131      *
 132      * @return void
 133      */
 134     function respondPoll()
 135     {
 136         try {
 137             $notice = Poll_response::saveNew($this->user->getProfile(),
 138                                              $this->poll,
 139                                              $this->selection);
 140         } catch (ClientException $ce) {
 141             $this->error = $ce->getMessage();
 142             $this->showPage();
 143             return;
 144         }
 145
 146         if ($this->boolean('ajax')) {
 147             $this->startHTML('text/xml;charset=utf-8');
 148             $this->elementStart('head');
 149             // TRANS: Page title after sending a poll response.
 150             $this->element('title', null, _m('Poll results'));
 151             $this->elementEnd('head');
 152             $this->elementStart('body');
 153             $form = new PollResultForm($this->poll, $this);
 154             $form->show();
 155             $this->elementEnd('body');
 156             $this->endHTML();
 157         } else {
 158             common_redirect($this->poll->getUrl(), 303);
 159         }
 160     }
 161
 162     /**
 163      * Show the Poll form
 164      *
 165      * @return void
 166      */
 167     function showContent()
 168     {
 169         if (!empty($this->error)) {
 170             $this->element('p', 'error', $this->error);
 171         }
 172
 173         $form = new PollResponseForm($this->poll, $this);
 174
 175         $form->show();
 176
 177         return;
 178     }
 179
 180     /**
 181      * Return true if read only.
 182      *
 183      * MAY override
 184      *
 185      * @param array $args other arguments
 186      *
 187      * @return boolean is read only action?
 188      */
 189     function isReadOnly(array $args=array())
 190     {
 191         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 192             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 193             return true;
 194         } else {
 195             return false;
 196         }
 197     }
 198 }