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

PollPlugin.php 15.1 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 51 52

    // @fixme which domain should we use for these namespaces?
    const POLL_OBJECT          = 'http://apinamespace.org/activitystreams/object/poll';
    const POLL_RESPONSE_OBJECT = 'http://apinamespace.org/activitystreams/object/poll-response';
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

    /**
     * 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());
        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;
    }

    /**
     * Load related modules when needed
     *
     * @param string $cls Name of the class to be loaded
     *
     * @return boolean hook value; true means continue processing, false means stop.
     */
    function onAutoload($cls)
    {
        $dir = dirname(__FILE__);

        switch ($cls)
        {
        case 'ShowpollAction':
        case 'NewpollAction':
        case 'RespondpollAction':
            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
            return false;
        case 'Poll':
        case 'Poll_response':
            include_once $dir.'/'.$cls.'.php';
            return false;
        case 'NewPollForm':
        case 'PollResponseForm':
        case 'PollResultForm':
            include_once $dir.'/'.strtolower($cls).'.php';
            return false;
        default:
            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',
125 126 127 128 129
                    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}'));
130

131 132 133 134
        $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}'));

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
        $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}'));

        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
156
                            // TRANS: Plugin description.
157 158 159 160 161 162
                            _m('Simple extension for supporting basic polls.'));
        return true;
    }

    function types()
    {
163
        return array(self::POLL_OBJECT, self::POLL_RESPONSE_OBJECT);
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    }

    /**
     * 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
196
        common_log(LOG_DEBUG, "XXX activity: " . var_export($activity, true));
197
        common_log(LOG_DEBUG, "XXX profile: " . var_export($profile, true));
198 199 200 201 202
        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) {
203 204
            $pollElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'poll');
            $responseElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'response');
Brion Vibber's avatar
fix  
Brion Vibber committed
205 206
            if ($pollElements->length) {
                $data = $pollElements->item(0);
207 208 209 210 211 212 213 214 215 216 217 218 219
                $question = $data->getAttribute('question');
                $opts = array();
                foreach ($data->attributes as $node) {
                    $name = $node->nodeName;
                    if (substr($name, 0, 6) == 'option') {
                        $n = intval(substr($name, 6));
                        if ($n > 0) {
                            $opts[$n - 1] = $node->nodeValue;
                        }
                    }
                }
                common_log(LOG_DEBUG, "YYY question: $question");
                common_log(LOG_DEBUG, "YYY opts: " . var_export($opts, true));
220 221 222 223 224 225 226
                try {
                    $notice = Poll::saveNew($profile, $question, $opts, $options);
                    common_log(LOG_DEBUG, "YYY ok: " . $notice->id);
                    return $notice;
                } catch (Exception $e) {
                    common_log(LOG_DEBUG, "YYY fail: " . $e->getMessage());
                }
227 228 229 230 231 232
            } 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
233 234
                    // TRANS: Exception thrown trying to respond to a poll without a poll reference.
                    throw new Exception(_m('Invalid poll response: no poll reference.'));
235 236 237
                }
                $poll = Poll::staticGet('uri', $pollUri);
                if (!$poll) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
238 239
                    // TRANS: Exception thrown trying to respond to a non-existing poll.
                    throw new Exception(_m('Invalid poll response: poll is unknown.'));
240 241 242 243 244 245 246 247
                }
                try {
                    $notice = Poll_response::saveNew($profile, $poll, $selection, $options);
                    common_log(LOG_DEBUG, "YYY response ok: " . $notice->id);
                    return $notice;
                } catch (Exception $e) {
                    common_log(LOG_DEBUG, "YYY response fail: " . $e->getMessage());
                }
248 249 250 251
            } else {
                common_log(LOG_DEBUG, "YYY no poll data");
            }
        }
252 253 254 255 256 257
    }

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

258 259 260 261 262 263
        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
264 265 266
            // TRANS: Exception thrown when performing an unexpected action on a poll.
            // TRANS: %s is the unpexpected object type.
            throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
267 268 269
        }
    }

Brion Vibber's avatar
Brion Vibber committed
270
    function activityObjectFromNoticePollResponse($notice)
271
    {
272 273 274
        $object = new ActivityObject();
        $object->id      = $notice->uri;
        $object->type    = self::POLL_OBJECT;
275 276 277 278
        $object->title   = $notice->content;
        $object->summary = $notice->content;
        $object->link    = $notice->bestUrl();

279
        $response = Poll_response::getByNotice($notice);
280 281 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
        if (!$response) {
            common_log(LOG_DEBUG, "QQQ notice uri: $notice->uri");
        } else {
            $poll = $response->getPoll();
            /**
             * For the moment, using a kind of icky-looking schema that happens to
             * work with out code for generating both Atom and JSON forms, though
             * I don't like it:
             *
             * <poll:response xmlns:poll="http://apinamespace.org/activitystreams/object/poll"
             *                poll="http://..../poll/...."
             *                selection="3" />
             *
             * "poll:response": {
             *     "xmlns:poll": http://apinamespace.org/activitystreams/object/poll
             *     "uri": "http://..../poll/...."
             *     "selection": 3
             * }
             *
             */
            // @fixme there's no way to specify an XML node tree here, like <poll><option/><option/></poll>
            // @fixme there's no way to specify a JSON array or multi-level tree unless you break the XML attribs
            // @fixme XML node contents don't get shown in JSON
            $data = array('xmlns:poll' => self::POLL_OBJECT,
                          'poll'       => $poll->uri,
                          'selection'  => intval($response->selection));
            $object->extra[] = array('poll:response', $data, '');
        }
308 309 310
        return $object;
    }

Brion Vibber's avatar
Brion Vibber committed
311
    function activityObjectFromNoticePoll($notice)
312 313 314 315 316 317
    {
        $object = new ActivityObject();
        $object->id      = $notice->uri;
        $object->type    = self::POLL_RESPONSE_OBJECT;
        $object->title   = $notice->content;
        $object->summary = $notice->content;
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
        $object->link    = $notice->bestUrl();

        $poll = Poll::getByNotice($notice);
        /**
         * Adding the poll-specific data. There's no standard in AS for polls,
         * so we're making stuff up.
         *
         * For the moment, using a kind of icky-looking schema that happens to
         * work with out code for generating both Atom and JSON forms, though
         * I don't like it:
         *
         * <poll:data xmlns:poll="http://apinamespace.org/activitystreams/object/poll"
         *            question="Who wants a poll question?"
         *            option1="Option one"
         *            option2="Option two"
         *            option3="Option three"></poll:data>
         *
335
         * "poll:response": {
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
         *     "xmlns:poll": http://apinamespace.org/activitystreams/object/poll
         *     "question": "Who wants a poll question?"
         *     "option1": "Option one"
         *     "option2": "Option two"
         *     "option3": "Option three"
         * }
         *
         */
        // @fixme there's no way to specify an XML node tree here, like <poll><option/><option/></poll>
        // @fixme there's no way to specify a JSON array or multi-level tree unless you break the XML attribs
        // @fixme XML node contents don't get shown in JSON
        $data = array('xmlns:poll' => self::POLL_OBJECT,
                      'question'   => $poll->question);
        foreach ($poll->getOptions() as $i => $opt) {
            $data['option' . ($i + 1)] = $opt;
        }
352
        $object->extra[] = array('poll:poll', $data, '');
353 354 355 356 357 358 359 360 361
        return $object;
    }

    /**
     * @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)
362 363 364 365 366 367 368
    {
        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
369 370 371
            // TRANS: Exception thrown when performing an unexpected action on a poll.
            // TRANS: %s is the unpexpected object type.
            throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
372 373 374 375
        }
    }

    function showNoticePoll($notice, $out)
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    {
        $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 {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
398
            $out->text(_('Poll data is missing'));
399 400 401 402 403 404 405
        }
        $out->elementEnd('div');

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

406 407 408 409 410 411 412 413 414 415 416 417
    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'));
    }

418 419 420 421 422 423 424 425 426 427 428 429 430
    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
431 432
        // TRANS: Application title.
        return _m('APPTITLE','Poll');
433 434
    }
}