plugins/Poll/PollPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A plugin to enable social-bookmarking functionality
   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  PollPlugin
  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
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Poll plugin main class
  37  *
  38  * @category  PollPlugin
  39  * @package   StatusNet
  40  * @author    Brion Vibber <brionv@status.net>
  41  * @author    Evan Prodromou <evan@status.net>
  42  * @copyright 2011 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 PollPlugin extends MicroAppPlugin
  47 {
  48     const VERSION         = '0.1';
  49
  50     // @fixme which domain should we use for these namespaces?
  51     const POLL_OBJECT          = 'http://activityschema.org/object/poll';
  52     const POLL_RESPONSE_OBJECT = 'http://activityschema.org/object/poll-response';
  53
  54     /**
  55      * Database schema setup
  56      *
  57      * @see Schema
  58      * @see ColumnDef
  59      *
  60      * @return boolean hook value; true means continue processing, false means stop.
  61      */
  62     function onCheckSchema()
  63     {
  64         $schema = Schema::get();
  65         $schema->ensureTable('poll', Poll::schemaDef());
  66         $schema->ensureTable('poll_response', Poll_response::schemaDef());
  67         return true;
  68     }
  69
  70     /**
  71      * Show the CSS necessary for this plugin
  72      *
  73      * @param Action $action the action being run
  74      *
  75      * @return boolean hook value
  76      */
  77     function onEndShowStyles($action)
  78     {
  79         $action->cssLink($this->path('poll.css'));
  80         return true;
  81     }
  82
  83     /**
  84      * Load related modules when needed
  85      *
  86      * @param string $cls Name of the class to be loaded
  87      *
  88      * @return boolean hook value; true means continue processing, false means stop.
  89      */
  90     function onAutoload($cls)
  91     {
  92         $dir = dirname(__FILE__);
  93
  94         switch ($cls)
  95         {
  96         case 'ShowpollAction':
  97         case 'NewpollAction':
  98         case 'RespondpollAction':
  99             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
 100             return false;
 101         case 'Poll':
 102         case 'Poll_response':
 103             include_once $dir.'/'.$cls.'.php';
 104             return false;
 105         case 'NewPollForm':
 106         case 'PollResponseForm':
 107         case 'PollResultForm':
 108             include_once $dir.'/'.strtolower($cls).'.php';
 109             return false;
 110         default:
 111             return true;
 112         }
 113     }
 114
 115     /**
 116      * Map URLs to actions
 117      *
 118      * @param Net_URL_Mapper $m path-to-action mapper
 119      *
 120      * @return boolean hook value; true means continue processing, false means stop.
 121      */
 122     function onRouterInitialized($m)
 123     {
 124         $m->connect('main/poll/new',
 125                     array('action' => 'newpoll'));
 126
 127         $m->connect('main/poll/:id',
 128                     array('action' => 'showpoll'),
 129                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 130
 131         $m->connect('main/poll/response/:id',
 132                     array('action' => 'showpollresponse'),
 133                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 134
 135         $m->connect('main/poll/:id/respond',
 136                     array('action' => 'respondpoll'),
 137                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 138
 139         return true;
 140     }
 141
 142     /**
 143      * Plugin version data
 144      *
 145      * @param array &$versions array of version data
 146      *
 147      * @return value
 148      */
 149     function onPluginVersion(&$versions)
 150     {
 151         $versions[] = array('name' => 'Poll',
 152                             'version' => self::VERSION,
 153                             'author' => 'Brion Vibber',
 154                             'homepage' => 'http://status.net/wiki/Plugin:Poll',
 155                             'rawdescription' =>
 156                             // TRANS: Plugin description.
 157                             _m('Simple extension for supporting basic polls.'));
 158         return true;
 159     }
 160
 161     function types()
 162     {
 163         return array(self::POLL_OBJECT, self::POLL_RESPONSE_OBJECT);
 164     }
 165
 166     /**
 167      * When a notice is deleted, delete the related Poll
 168      *
 169      * @param Notice $notice Notice being deleted
 170      *
 171      * @return boolean hook value
 172      */
 173     function deleteRelated($notice)
 174     {
 175         $p = Poll::getByNotice($notice);
 176
 177         if (!empty($p)) {
 178             $p->delete();
 179         }
 180
 181         return true;
 182     }
 183
 184     /**
 185      * Save a poll from an activity
 186      *
 187      * @param Profile  $profile  Profile to use as author
 188      * @param Activity $activity Activity to save
 189      * @param array    $options  Options to pass to bookmark-saving code
 190      *
 191      * @return Notice resulting notice
 192      */
 193     function saveNoticeFromActivity($activity, $profile, $options=array())
 194     {
 195         // @fixme
 196         common_log(LOG_DEBUG, "XXX activity: " . var_export($activity, true));
 197         common_log(LOG_DEBUG, "XXX profile: " . var_export($profile, true));
 198         common_log(LOG_DEBUG, "XXX options: " . var_export($options, true));
 199
 200         // Ok for now, we can grab stuff from the XML entry directly.
 201         // This won't work when reading from JSON source
 202         if ($activity->entry) {
 203             $pollElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'poll');
 204             $responseElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'response');
 205             if ($pollElements->length) {
 206                 $data = $pollElements->item(0);
 207                 $question = $data->getAttribute('question');
 208                 $opts = array();
 209                 foreach ($data->attributes as $node) {
 210                     $name = $node->nodeName;
 211                     if (substr($name, 0, 6) == 'option') {
 212                         $n = intval(substr($name, 6));
 213                         if ($n > 0) {
 214                             $opts[$n - 1] = $node->nodeValue;
 215                         }
 216                     }
 217                 }
 218                 common_log(LOG_DEBUG, "YYY question: $question");
 219                 common_log(LOG_DEBUG, "YYY opts: " . var_export($opts, true));
 220                 try {
 221                     $notice = Poll::saveNew($profile, $question, $opts, $options);
 222                     common_log(LOG_DEBUG, "YYY ok: " . $notice->id);
 223                     return $notice;
 224                 } catch (Exception $e) {
 225                     common_log(LOG_DEBUG, "YYY fail: " . $e->getMessage());
 226                 }
 227             } else if ($responseElements->length) {
 228                 $data = $responseElements->item(0);
 229                 $pollUri = $data->getAttribute('poll');
 230                 $selection = intval($data->getAttribute('selection'));
 231
 232                 if (!$pollUri) {
 233                     // TRANS: Exception thrown trying to respond to a poll without a poll reference.
 234                     throw new Exception(_m('Invalid poll response: no poll reference.'));
 235                 }
 236                 $poll = Poll::staticGet('uri', $pollUri);
 237                 if (!$poll) {
 238                     // TRANS: Exception thrown trying to respond to a non-existing poll.
 239                     throw new Exception(_m('Invalid poll response: poll is unknown.'));
 240                 }
 241                 try {
 242                     $notice = Poll_response::saveNew($profile, $poll, $selection, $options);
 243                     common_log(LOG_DEBUG, "YYY response ok: " . $notice->id);
 244                     return $notice;
 245                 } catch (Exception $e) {
 246                     common_log(LOG_DEBUG, "YYY response fail: " . $e->getMessage());
 247                 }
 248             } else {
 249                 common_log(LOG_DEBUG, "YYY no poll data");
 250             }
 251         }
 252     }
 253
 254     function activityObjectFromNotice($notice)
 255     {
 256         assert($this->isMyNotice($notice));
 257
 258         switch ($notice->object_type) {
 259         case self::POLL_OBJECT:
 260             return $this->activityObjectFromNoticePoll($notice);
 261         case self::POLL_RESPONSE_OBJECT:
 262             return $this->activityObjectFromNoticePollResponse($notice);
 263         default:
 264             // TRANS: Exception thrown when performing an unexpected action on a poll.
 265             // TRANS: %s is the unpexpected object type.
 266             throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
 267         }
 268     }
 269
 270     function activityObjectFromNoticePollResponse($notice)
 271     {
 272         $object = new ActivityObject();
 273         $object->id      = $notice->uri;
 274         $object->type    = self::POLL_OBJECT;
 275         $object->title   = $notice->content;
 276         $object->summary = $notice->content;
 277         $object->link    = $notice->bestUrl();
 278
 279         $response = Poll_response::getByNotice($notice);
 280         if ($response) {
 281             $poll = $response->getPoll();
 282             if ($poll) {
 283                 // Stash data to be formatted later by
 284                 // $this->activityObjectOutputAtom() or
 285                 // $this->activityObjectOutputJson()...
 286                 $object->pollSelection = intval($response->selection);
 287                 $object->pollUri = $poll->uri;
 288             }
 289         }
 290         return $object;
 291     }
 292
 293     function activityObjectFromNoticePoll($notice)
 294     {
 295         $object = new ActivityObject();
 296         $object->id      = $notice->uri;
 297         $object->type    = self::POLL_RESPONSE_OBJECT;
 298         $object->title   = $notice->content;
 299         $object->summary = $notice->content;
 300         $object->link    = $notice->bestUrl();
 301
 302         $poll = Poll::getByNotice($notice);
 303         if ($poll) {
 304             // Stash data to be formatted later by
 305             // $this->activityObjectOutputAtom() or
 306             // $this->activityObjectOutputJson()...
 307             $object->pollQuestion = $poll->question;
 308             $object->pollOptions = $poll->getOptions();
 309         }
 310
 311         return $object;
 312     }
 313
 314     /**
 315      * Called when generating Atom XML ActivityStreams output from an
 316      * ActivityObject belonging to this plugin. Gives the plugin
 317      * a chance to add custom output.
 318      *
 319      * Note that you can only add output of additional XML elements,
 320      * not change existing stuff here.
 321      *
 322      * If output is already handled by the base Activity classes,
 323      * you can leave this base implementation as a no-op.
 324      *
 325      * @param ActivityObject $obj
 326      * @param XMLOutputter $out to add elements at end of object
 327      */
 328     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 329     {
 330         if (isset($obj->pollQuestion)) {
 331             /**
 332              * <poll:poll xmlns:poll="http://apinamespace.org/activitystreams/object/poll">
 333              *   <poll:question>Who wants a poll question?</poll:question>
 334              *   <poll:option>Option one</poll:option>
 335              *   <poll:option>Option two</poll:option>
 336              *   <poll:option>Option three</poll:option>
 337              * </poll:poll>
 338              */
 339             $data = array('xmlns:poll' => self::POLL_OBJECT);
 340             $out->elementStart('poll:poll', $data);
 341             $out->element('poll:question', array(), $obj->pollQuestion);
 342             foreach ($obj->pollOptions as $opt) {
 343                 $out->element('poll:option', array(), $opt);
 344             }
 345             $out->elementEnd('poll:poll');
 346         }
 347         if (isset($obj->pollSelection)) {
 348             /**
 349              * <poll:response xmlns:poll="http://apinamespace.org/activitystreams/object/poll">
 350              *                poll="http://..../poll/...."
 351              *                selection="3" />
 352              */
 353             $data = array('xmlns:poll' => self::POLL_OBJECT,
 354                           'poll'       => $obj->pollUri,
 355                           'selection'  => $obj->pollSelection);
 356             $out->element('poll:response', $data, '');
 357         }
 358     }
 359
 360     /**
 361      * Called when generating JSON ActivityStreams output from an
 362      * ActivityObject belonging to this plugin. Gives the plugin
 363      * a chance to add custom output.
 364      *
 365      * Modify the array contents to your heart's content, and it'll
 366      * all get serialized out as JSON.
 367      *
 368      * If output is already handled by the base Activity classes,
 369      * you can leave this base implementation as a no-op.
 370      *
 371      * @param ActivityObject $obj
 372      * @param array &$out JSON-targeted array which can be modified
 373      */
 374     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 375     {
 376         common_log(LOG_DEBUG, 'QQQ: ' . var_export($obj, true));
 377         if (isset($obj->pollQuestion)) {
 378             /**
 379              * "poll": {
 380              *   "question": "Who wants a poll question?",
 381              *   "options": [
 382              *     "Option 1",
 383              *     "Option 2",
 384              *     "Option 3"
 385              *   ]
 386              * }
 387              */
 388             $data = array('question' => $obj->pollQuestion,
 389                           'options' => array());
 390             foreach ($obj->pollOptions as $opt) {
 391                 $data['options'][] = $opt;
 392             }
 393             $out['poll'] = $data;
 394         }
 395         if (isset($obj->pollSelection)) {
 396             /**
 397              * "pollResponse": {
 398              *   "poll": "http://..../poll/....",
 399              *   "selection": 3
 400              * }
 401              */
 402             $data = array('poll'       => $obj->pollUri,
 403                           'selection'  => $obj->pollSelection);
 404             $out['pollResponse'] = $data;
 405         }
 406     }
 407
 408
 409     /**
 410      * @fixme WARNING WARNING WARNING parent class closes the final div that we
 411      * open here, but we probably shouldn't open it here. Check parent class
 412      * and Bookmark plugin for if that's right.
 413      */
 414     function showNotice($notice, $out)
 415     {
 416         switch ($notice->object_type) {
 417         case self::POLL_OBJECT:
 418             return $this->showNoticePoll($notice, $out);
 419         case self::POLL_RESPONSE_OBJECT:
 420             return $this->showNoticePollResponse($notice, $out);
 421         default:
 422             // TRANS: Exception thrown when performing an unexpected action on a poll.
 423             // TRANS: %s is the unpexpected object type.
 424             throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
 425         }
 426     }
 427
 428     function showNoticePoll($notice, $out)
 429     {
 430         $user = common_current_user();
 431
 432         // @hack we want regular rendering, then just add stuff after that
 433         $nli = new NoticeListItem($notice, $out);
 434         $nli->showNotice();
 435
 436         $out->elementStart('div', array('class' => 'entry-content poll-content'));
 437         $poll = Poll::getByNotice($notice);
 438         if ($poll) {
 439             if ($user) {
 440                 $profile = $user->getProfile();
 441                 $response = $poll->getResponse($profile);
 442                 if ($response) {
 443                     // User has already responded; show the results.
 444                     $form = new PollResultForm($poll, $out);
 445                 } else {
 446                     $form = new PollResponseForm($poll, $out);
 447                 }
 448                 $form->show();
 449             }
 450         } else {
 451             $out->text(_('Poll data is missing'));
 452         }
 453         $out->elementEnd('div');
 454
 455         // @fixme
 456         $out->elementStart('div', array('class' => 'entry-content'));
 457     }
 458
 459     function showNoticePollResponse($notice, $out)
 460     {
 461         $user = common_current_user();
 462
 463         // @hack we want regular rendering, then just add stuff after that
 464         $nli = new NoticeListItem($notice, $out);
 465         $nli->showNotice();
 466
 467         // @fixme
 468         $out->elementStart('div', array('class' => 'entry-content'));
 469     }
 470
 471     function entryForm($out)
 472     {
 473         return new NewPollForm($out);
 474     }
 475
 476     // @fixme is this from parent?
 477     function tag()
 478     {
 479         return 'poll';
 480     }
 481
 482     function appTitle()
 483     {
 484         // TRANS: Application title.
 485         return _m('APPTITLE','Poll');
 486     }
 487 }