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