We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

PollPlugin.php 17.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2011, StatusNet, Inc.
 *
 * A plugin to enable social-bookmarking functionality
 *
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  PollPlugin
 * @package   StatusNet
 * @author    Brion Vibber <brion@status.net>
 * @copyright 2011 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Poll plugin main class
 *
 * @category  PollPlugin
 * @package   StatusNet
 * @author    Brion Vibber <brionv@status.net>
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2011 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class PollPlugin extends MicroAppPlugin
{
    const VERSION         = '0.1';
49 50

    // @fixme which domain should we use for these namespaces?
51 52
    const POLL_OBJECT          = 'http://activityschema.org/object/poll';
    const POLL_RESPONSE_OBJECT = 'http://activityschema.org/object/poll-response';
53 54 55 56 57 58 59 60 61 62 63 64 65 66

    /**
     * Database schema setup
     *
     * @see Schema
     * @see ColumnDef
     *
     * @return boolean hook value; true means continue processing, false means stop.
     */
    function onCheckSchema()
    {
        $schema = Schema::get();
        $schema->ensureTable('poll', Poll::schemaDef());
        $schema->ensureTable('poll_response', Poll_response::schemaDef());
67
        $schema->ensureTable('user_poll_prefs', User_poll_prefs::schemaDef());
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
        return true;
    }

    /**
     * Show the CSS necessary for this plugin
     *
     * @param Action $action the action being run
     *
     * @return boolean hook value
     */
    function onEndShowStyles($action)
    {
        $action->cssLink($this->path('poll.css'));
        return true;
    }

    /**
     * Map URLs to actions
     *
     * @param Net_URL_Mapper $m path-to-action mapper
     *
     * @return boolean hook value; true means continue processing, false means stop.
     */
    function onRouterInitialized($m)
    {
        $m->connect('main/poll/new',
94 95 96 97 98
                    array('action' => 'newpoll'));

        $m->connect('main/poll/:id',
                    array('action' => 'showpoll'),
                    array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
99

100 101 102 103
        $m->connect('main/poll/response/:id',
                    array('action' => 'showpollresponse'),
                    array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));

104 105 106 107
        $m->connect('main/poll/:id/respond',
                    array('action' => 'respondpoll'),
                    array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));

108 109 110
        $m->connect('settings/poll',
                    array('action' => 'pollsettings'));

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
        return true;
    }

    /**
     * Plugin version data
     *
     * @param array &$versions array of version data
     *
     * @return value
     */
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'Poll',
                            'version' => self::VERSION,
                            'author' => 'Brion Vibber',
                            'homepage' => 'http://status.net/wiki/Plugin:Poll',
                            'rawdescription' =>
Siebrand Mazeland's avatar
Siebrand Mazeland committed
128
                            // TRANS: Plugin description.
129 130 131 132 133 134
                            _m('Simple extension for supporting basic polls.'));
        return true;
    }

    function types()
    {
135
        return array(self::POLL_OBJECT, self::POLL_RESPONSE_OBJECT);
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    }

    /**
     * When a notice is deleted, delete the related Poll
     *
     * @param Notice $notice Notice being deleted
     *
     * @return boolean hook value
     */
    function deleteRelated($notice)
    {
        $p = Poll::getByNotice($notice);

        if (!empty($p)) {
            $p->delete();
        }

        return true;
    }

    /**
     * Save a poll from an activity
     *
     * @param Profile  $profile  Profile to use as author
     * @param Activity $activity Activity to save
     * @param array    $options  Options to pass to bookmark-saving code
     *
     * @return Notice resulting notice
     */
    function saveNoticeFromActivity($activity, $profile, $options=array())
    {
        // @fixme
168
        common_log(LOG_DEBUG, "XXX activity: " . var_export($activity, true));
169
        common_log(LOG_DEBUG, "XXX profile: " . var_export($profile, true));
170 171 172 173 174
        common_log(LOG_DEBUG, "XXX options: " . var_export($options, true));

        // Ok for now, we can grab stuff from the XML entry directly.
        // This won't work when reading from JSON source
        if ($activity->entry) {
175 176
            $pollElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'poll');
            $responseElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'response');
Brion Vibber's avatar
fix  
Brion Vibber committed
177
            if ($pollElements->length) {
Brion Vibber's avatar
Brion Vibber committed
178
                $question = '';
179
                $opts = array();
Brion Vibber's avatar
Brion Vibber committed
180 181 182

                $data = $pollElements->item(0);
                foreach ($data->getElementsByTagNameNS(self::POLL_OBJECT, 'question') as $node) {
Brion Vibber's avatar
Brion Vibber committed
183
                    $question = $node->textContent;
Brion Vibber's avatar
Brion Vibber committed
184 185
                }
                foreach ($data->getElementsByTagNameNS(self::POLL_OBJECT, 'option') as $node) {
Brion Vibber's avatar
Brion Vibber committed
186
                    $opts[] = $node->textContent;
187
                }
188 189
                try {
                    $notice = Poll::saveNew($profile, $question, $opts, $options);
Brion Vibber's avatar
Brion Vibber committed
190
                    common_log(LOG_DEBUG, "Saved Poll from ActivityStream data ok: notice id " . $notice->id);
191 192
                    return $notice;
                } catch (Exception $e) {
Brion Vibber's avatar
Brion Vibber committed
193
                    common_log(LOG_DEBUG, "Poll save from ActivityStream data failed: " . $e->getMessage());
194
                }
195 196 197 198 199 200
            } else if ($responseElements->length) {
                $data = $responseElements->item(0);
                $pollUri = $data->getAttribute('poll');
                $selection = intval($data->getAttribute('selection'));

                if (!$pollUri) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
201
                    // TRANS: Exception thrown trying to respond to a poll without a poll reference.
202
                    throw new Exception(_m('Invalid poll response: No poll reference.'));
203
                }
204
                $poll = Poll::getKV('uri', $pollUri);
205
                if (!$poll) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
206
                    // TRANS: Exception thrown trying to respond to a non-existing poll.
207
                    throw new Exception(_m('Invalid poll response: Poll is unknown.'));
208 209 210
                }
                try {
                    $notice = Poll_response::saveNew($profile, $poll, $selection, $options);
Brion Vibber's avatar
Brion Vibber committed
211
                    common_log(LOG_DEBUG, "Saved Poll_response ok, notice id: " . $notice->id);
212 213
                    return $notice;
                } catch (Exception $e) {
Brion Vibber's avatar
Brion Vibber committed
214
                    common_log(LOG_DEBUG, "Poll response  save fail: " . $e->getMessage());
215
                }
216 217 218 219
            } else {
                common_log(LOG_DEBUG, "YYY no poll data");
            }
        }
220 221 222 223 224 225
    }

    function activityObjectFromNotice($notice)
    {
        assert($this->isMyNotice($notice));

226 227 228 229 230 231
        switch ($notice->object_type) {
        case self::POLL_OBJECT:
            return $this->activityObjectFromNoticePoll($notice);
        case self::POLL_RESPONSE_OBJECT:
            return $this->activityObjectFromNoticePollResponse($notice);
        default:
Siebrand Mazeland's avatar
Siebrand Mazeland committed
232
            // TRANS: Exception thrown when performing an unexpected action on a poll.
233
            // TRANS: %s is the unexpected object type.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
234
            throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
235 236 237
        }
    }

Brion Vibber's avatar
Brion Vibber committed
238
    function activityObjectFromNoticePollResponse($notice)
239
    {
240 241
        $object = new ActivityObject();
        $object->id      = $notice->uri;
242
        $object->type    = self::POLL_RESPONSE_OBJECT;
243 244 245 246
        $object->title   = $notice->content;
        $object->summary = $notice->content;
        $object->link    = $notice->bestUrl();

247
        $response = Poll_response::getByNotice($notice);
248
        if ($response) {
249
            $poll = $response->getPoll();
250 251 252 253 254 255 256
            if ($poll) {
                // Stash data to be formatted later by
                // $this->activityObjectOutputAtom() or
                // $this->activityObjectOutputJson()...
                $object->pollSelection = intval($response->selection);
                $object->pollUri = $poll->uri;
            }
257
        }
258 259 260
        return $object;
    }

Brion Vibber's avatar
Brion Vibber committed
261
    function activityObjectFromNoticePoll($notice)
262 263 264
    {
        $object = new ActivityObject();
        $object->id      = $notice->uri;
265
        $object->type    = self::POLL_OBJECT;
266 267
        $object->title   = $notice->content;
        $object->summary = $notice->content;
268 269 270
        $object->link    = $notice->bestUrl();

        $poll = Poll::getByNotice($notice);
271 272 273 274 275 276
        if ($poll) {
            // Stash data to be formatted later by
            // $this->activityObjectOutputAtom() or
            // $this->activityObjectOutputJson()...
            $object->pollQuestion = $poll->question;
            $object->pollOptions = $poll->getOptions();
277
        }
278

279 280 281
        return $object;
    }

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
    /**
     * Called when generating Atom XML ActivityStreams output from an
     * ActivityObject belonging to this plugin. Gives the plugin
     * a chance to add custom output.
     *
     * Note that you can only add output of additional XML elements,
     * not change existing stuff here.
     *
     * If output is already handled by the base Activity classes,
     * you can leave this base implementation as a no-op.
     *
     * @param ActivityObject $obj
     * @param XMLOutputter $out to add elements at end of object
     */
    function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
    {
        if (isset($obj->pollQuestion)) {
            /**
             * <poll:poll xmlns:poll="http://apinamespace.org/activitystreams/object/poll">
             *   <poll:question>Who wants a poll question?</poll:question>
             *   <poll:option>Option one</poll:option>
             *   <poll:option>Option two</poll:option>
             *   <poll:option>Option three</poll:option>
             * </poll:poll>
             */
            $data = array('xmlns:poll' => self::POLL_OBJECT);
            $out->elementStart('poll:poll', $data);
            $out->element('poll:question', array(), $obj->pollQuestion);
            foreach ($obj->pollOptions as $opt) {
                $out->element('poll:option', array(), $opt);
            }
            $out->elementEnd('poll:poll');
        }
        if (isset($obj->pollSelection)) {
            /**
             * <poll:response xmlns:poll="http://apinamespace.org/activitystreams/object/poll">
             *                poll="http://..../poll/...."
             *                selection="3" />
             */
            $data = array('xmlns:poll' => self::POLL_OBJECT,
                          'poll'       => $obj->pollUri,
                          'selection'  => $obj->pollSelection);
            $out->element('poll:response', $data, '');
        }
    }

    /**
     * Called when generating JSON ActivityStreams output from an
     * ActivityObject belonging to this plugin. Gives the plugin
     * a chance to add custom output.
     *
     * Modify the array contents to your heart's content, and it'll
     * all get serialized out as JSON.
     *
     * If output is already handled by the base Activity classes,
     * you can leave this base implementation as a no-op.
     *
     * @param ActivityObject $obj
     * @param array &$out JSON-targeted array which can be modified
     */
    public function activityObjectOutputJson(ActivityObject $obj, array &$out)
    {
        common_log(LOG_DEBUG, 'QQQ: ' . var_export($obj, true));
        if (isset($obj->pollQuestion)) {
            /**
             * "poll": {
             *   "question": "Who wants a poll question?",
             *   "options": [
             *     "Option 1",
             *     "Option 2",
             *     "Option 3"
             *   ]
             * }
             */
            $data = array('question' => $obj->pollQuestion,
                          'options' => array());
            foreach ($obj->pollOptions as $opt) {
                $data['options'][] = $opt;
            }
            $out['poll'] = $data;
        }
        if (isset($obj->pollSelection)) {
            /**
             * "pollResponse": {
             *   "poll": "http://..../poll/....",
             *   "selection": 3
             * }
             */
            $data = array('poll'       => $obj->pollUri,
                          'selection'  => $obj->pollSelection);
            $out['pollResponse'] = $data;
        }
    }


377 378 379 380 381 382
    /**
     * @fixme WARNING WARNING WARNING parent class closes the final div that we
     * open here, but we probably shouldn't open it here. Check parent class
     * and Bookmark plugin for if that's right.
     */
    function showNotice($notice, $out)
383 384 385 386 387 388 389
    {
        switch ($notice->object_type) {
        case self::POLL_OBJECT:
            return $this->showNoticePoll($notice, $out);
        case self::POLL_RESPONSE_OBJECT:
            return $this->showNoticePollResponse($notice, $out);
        default:
Siebrand Mazeland's avatar
Siebrand Mazeland committed
390
            // TRANS: Exception thrown when performing an unexpected action on a poll.
391
            // TRANS: %s is the unexpected object type.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
392
            throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
393 394 395 396
        }
    }

    function showNoticePoll($notice, $out)
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
    {
        $user = common_current_user();

        // @hack we want regular rendering, then just add stuff after that
        $nli = new NoticeListItem($notice, $out);
        $nli->showNotice();

        $out->elementStart('div', array('class' => 'entry-content poll-content'));
        $poll = Poll::getByNotice($notice);
        if ($poll) {
            if ($user) {
                $profile = $user->getProfile();
                $response = $poll->getResponse($profile);
                if ($response) {
                    // User has already responded; show the results.
                    $form = new PollResultForm($poll, $out);
                } else {
                    $form = new PollResponseForm($poll, $out);
                }
                $form->show();
            }
        } else {
419
            // TRANS: Error text displayed if no poll data could be found.
420
            $out->text(_m('Poll data is missing'));
421 422 423 424 425 426 427
        }
        $out->elementEnd('div');

        // @fixme
        $out->elementStart('div', array('class' => 'entry-content'));
    }

428 429 430 431 432 433 434 435 436 437 438 439
    function showNoticePollResponse($notice, $out)
    {
        $user = common_current_user();

        // @hack we want regular rendering, then just add stuff after that
        $nli = new NoticeListItem($notice, $out);
        $nli->showNotice();

        // @fixme
        $out->elementStart('div', array('class' => 'entry-content'));
    }

440 441 442 443 444 445 446 447 448 449 450 451 452
    function entryForm($out)
    {
        return new NewPollForm($out);
    }

    // @fixme is this from parent?
    function tag()
    {
        return 'poll';
    }

    function appTitle()
    {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
453 454
        // TRANS: Application title.
        return _m('APPTITLE','Poll');
455
    }
456

Evan Prodromou's avatar
Evan Prodromou committed
457
    function onStartAddNoticeReply($nli, $parent, $child)
458 459
    {
        // Filter out any poll responses
Evan Prodromou's avatar
Evan Prodromou committed
460 461 462
        if ($parent->object_type == self::POLL_OBJECT &&
            $child->object_type == self::POLL_RESPONSE_OBJECT) {
            return false;
463 464 465
        }
        return true;
    }
466 467 468 469 470 471

    // Hide poll responses for @chuck

    function onEndNoticeWhoGets($notice, &$ni) {
        if ($notice->object_type == self::POLL_RESPONSE_OBJECT) {
            foreach ($ni as $id => $source) {
472
                $user = User::getKV('id', $id);
473
                if (!empty($user)) {
474
                    $pollPrefs = User_poll_prefs::getKV('user_id', $user->id);
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
                    if (!empty($pollPrefs) && ($pollPrefs->hide_responses)) {
                        unset($ni[$id]);
                    }
                }
            }
        }
        return true;
    }

    /**
     * Menu item for personal subscriptions/groups area
     *
     * @param Action $action action being executed
     *
     * @return boolean hook return
     */

    function onEndAccountSettingsNav($action)
    {
        $action_name = $action->trimmed('action');

        $action->menuItem(common_local_url('pollsettings'),
                          // TRANS: Poll plugin menu item on user settings page.
                          _m('MENU', 'Polls'),
                          // TRANS: Poll plugin tooltip for user settings menu item.
                          _m('Configure poll behavior'),
                          $action_name === 'pollsettings');

        return true;
    }
505
}