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
  79         $this->user = common_current_user();
  80
  81         if (empty($this->user)) {
  82             throw new ClientException(_m("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
 113     function handle($argarray=null)
 114     {
 115         parent::handle($argarray);
 116
 117         if ($this->isPost()) {
 118             $this->respondPoll();
 119         } else {
 120             $this->showPage();
 121         }
 122
 123         return;
 124     }
 125
 126     /**
 127      * Add a new Poll
 128      *
 129      * @return void
 130      */
 131
 132     function respondPoll()
 133     {
 134         try {
 135             $response = new Poll_response();
 136             $response->poll_id = $this->poll->id;
 137             $response->profile_id = $this->user->id;
 138             $response->selection = $this->selection;
 139             $response->created = common_sql_now();
 140             $response->insert();
 141
 142         } catch (ClientException $ce) {
 143             $this->error = $ce->getMessage();
 144             $this->showPage();
 145             return;
 146         }
 147
 148         if ($this->arg('ajax')) {
 149             header('Content-Type: text/xml;charset=utf-8');
 150             $this->xw->startDocument('1.0', 'UTF-8');
 151             $this->elementStart('html');
 152             $this->elementStart('head');
 153             // TRANS: Page title after sending a poll response.
 154             $this->element('title', null, _m('Poll results'));
 155             $this->elementEnd('head');
 156             $this->elementStart('body');
 157             $form = new PollResultForm($this->poll, $this);
 158             $form->show();
 159             $this->elementEnd('body');
 160             $this->elementEnd('html');
 161         } else {
 162             common_redirect($this->poll->bestUrl(), 303);
 163         }
 164     }
 165
 166     /**
 167      * Show the Poll form
 168      *
 169      * @return void
 170      */
 171
 172     function showContent()
 173     {
 174         if (!empty($this->error)) {
 175             $this->element('p', 'error', $this->error);
 176         }
 177
 178         $form = new PollResponseForm($this->poll, $this);
 179
 180         $form->show();
 181
 182         return;
 183     }
 184
 185     /**
 186      * Return true if read only.
 187      *
 188      * MAY override
 189      *
 190      * @param array $args other arguments
 191      *
 192      * @return boolean is read only action?
 193      */
 194
 195     function isReadOnly($args)
 196     {
 197         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 198             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 199             return true;
 200         } else {
 201             return false;
 202         }
 203     }
 204 }