plugins/Poll/respondpoll.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Add a new 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  * Add a new 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
  47 class RespondPollAction extends Action
  48 {
  49     protected $user        = null;
  50     protected $error       = null;
  51     protected $complete    = null;
  52
  53     protected $poll        = null;
  54     protected $selection   = null;
  55
  56     /**
  57      * Returns the title of the action
  58      *
  59      * @return string Action title
  60      */
  61
  62     function title()
  63     {
  64         return _m('Poll response');
  65     }
  66
  67     /**
  68      * For initializing members of the class.
  69      *
  70      * @param array $argarray misc. arguments
  71      *
  72      * @return boolean true
  73      */
  74
  75     function prepare($argarray)
  76     {
  77         parent::prepare($argarray);
  78         if ($this->boolean('ajax')) {
  79             StatusNet::setApi(true);
  80         }
  81
  82         $this->user = common_current_user();
  83
  84         if (empty($this->user)) {
  85             throw new ClientException(_m("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::staticGet('id', $id);
  95         if (empty($this->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             throw new ClientException(_m('Invalid poll selection.'));
 102         }
 103         $this->selection = $selection;
 104
 105         return true;
 106     }
 107
 108     /**
 109      * Handler method
 110      *
 111      * @param array $argarray is ignored since it's now passed in in prepare()
 112      *
 113      * @return void
 114      */
 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
 135     function respondPoll()
 136     {
 137         try {
 138             $notice = Poll_response::saveNew($this->user->getProfile(),
 139                                              $this->poll,
 140                                              $this->selection);
 141         } catch (ClientException $ce) {
 142             $this->error = $ce->getMessage();
 143             $this->showPage();
 144             return;
 145         }
 146
 147         if ($this->boolean('ajax')) {
 148             header('Content-Type: text/xml;charset=utf-8');
 149             $this->xw->startDocument('1.0', 'UTF-8');
 150             $this->elementStart('html');
 151             $this->elementStart('head');
 152             // TRANS: Page title after sending a poll response.
 153             $this->element('title', null, _m('Poll results'));
 154             $this->elementEnd('head');
 155             $this->elementStart('body');
 156             $form = new PollResultForm($this->poll, $this);
 157             $form->show();
 158             $this->elementEnd('body');
 159             $this->elementEnd('html');
 160         } else {
 161             common_redirect($this->poll->bestUrl(), 303);
 162         }
 163     }
 164
 165     /**
 166      * Show the Poll form
 167      *
 168      * @return void
 169      */
 170
 171     function showContent()
 172     {
 173         if (!empty($this->error)) {
 174             $this->element('p', 'error', $this->error);
 175         }
 176
 177         $form = new PollResponseForm($this->poll, $this);
 178
 179         $form->show();
 180
 181         return;
 182     }
 183
 184     /**
 185      * Return true if read only.
 186      *
 187      * MAY override
 188      *
 189      * @param array $args other arguments
 190      *
 191      * @return boolean is read only action?
 192      */
 193
 194     function isReadOnly($args)
 195     {
 196         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 197             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 198             return true;
 199         } else {
 200             return false;
 201         }
 202     }
 203 }