plugins/Poll/actions/newpoll.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 NewPollAction extends Action
  47 {
  48     protected $user        = null;
  49     protected $error       = null;
  50     protected $complete    = null;
  51
  52     protected $question    = null;
  53     protected $options     = array();
  54
  55     /**
  56      * Returns the title of the action
  57      *
  58      * @return string Action title
  59      */
  60     function title()
  61     {
  62         // TRANS: Title for poll page.
  63         return _m('New poll');
  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
  78         $this->user = common_current_user();
  79
  80         if (empty($this->user)) {
  81             // TRANS: Client exception thrown trying to create a poll while not logged in.
  82             throw new ClientException(_m('You must be logged in to post a poll.'),
  83                                       403);
  84         }
  85
  86         if ($this->isPost()) {
  87             $this->checkSessionToken();
  88         }
  89
  90         $this->question = $this->trimmed('question');
  91         for ($i = 1; $i < 20; $i++) {
  92             $opt = $this->trimmed('option' . $i);
  93             if ($opt != '') {
  94                 $this->options[] = $opt;
  95             }
  96         }
  97
  98         return true;
  99     }
 100
 101     /**
 102      * Handler method
 103      *
 104      * @return void
 105      */
 106     function handle()
 107     {
 108         parent::handle();
 109
 110         if ($this->isPost()) {
 111             $this->newPoll();
 112         } else {
 113             $this->showPage();
 114         }
 115
 116         return;
 117     }
 118
 119     /**
 120      * Add a new Poll
 121      *
 122      * @return void
 123      */
 124     function newPoll()
 125     {
 126         if ($this->boolean('ajax')) {
 127             GNUsocial::setApi(true);
 128         }
 129         try {
 130             if (empty($this->question)) {
 131             // TRANS: Client exception thrown trying to create a poll without a question.
 132                 throw new ClientException(_m('Poll must have a question.'));
 133             }
 134
 135             if (count($this->options) < 2) {
 136                 // TRANS: Client exception thrown trying to create a poll with fewer than two options.
 137                 throw new ClientException(_m('Poll must have at least two options.'));
 138             }
 139
 140             // Notice options; distinct from choices for the poll
 141
 142             $options = array();
 143
 144             // Does the heavy-lifting for getting "To:" information
 145
 146             ToSelector::fillOptions($this, $options);
 147
 148             $saved = Poll::saveNew($this->user->getProfile(),
 149                                    $this->question,
 150                                    $this->options,
 151                                    $options);
 152
 153         } catch (ClientException $ce) {
 154             $this->error = $ce->getMessage();
 155             $this->showPage();
 156             return;
 157         }
 158
 159         if ($this->boolean('ajax')) {
 160             $this->startHTML('text/xml;charset=utf-8');
 161             $this->elementStart('head');
 162             // TRANS: Page title after sending a notice.
 163             $this->element('title', null, _m('Notice posted'));
 164             $this->elementEnd('head');
 165             $this->elementStart('body');
 166             $this->showNotice($saved);
 167             $this->elementEnd('body');
 168             $this->endHTML();
 169         } else {
 170             common_redirect($saved->getUrl(), 303);
 171         }
 172     }
 173
 174     /**
 175      * Output a notice
 176      *
 177      * Used to generate the notice code for Ajax results.
 178      *
 179      * @param Notice $notice Notice that was saved
 180      *
 181      * @return void
 182      */
 183     function showNotice(Notice $notice)
 184     {
 185         class_exists('NoticeList'); // @fixme hack for autoloader
 186         $nli = new NoticeListItem($notice, $this);
 187         $nli->show();
 188     }
 189
 190     /**
 191      * Show the Poll form
 192      *
 193      * @return void
 194      */
 195     function showContent()
 196     {
 197         if (!empty($this->error)) {
 198             $this->element('p', 'error', $this->error);
 199         }
 200
 201         $form = new NewPollForm($this,
 202                                  $this->question,
 203                                  $this->options);
 204
 205         $form->show();
 206
 207         return;
 208     }
 209
 210     /**
 211      * Return true if read only.
 212      *
 213      * MAY override
 214      *
 215      * @param array $args other arguments
 216      *
 217      * @return boolean is read only action?
 218      */
 219     function isReadOnly($args)
 220     {
 221         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
 222             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
 223             return true;
 224         } else {
 225             return false;
 226         }
 227     }
 228 }