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

PollPlugin.php 15.2 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
    var $oldSaveNew = true;

56 57 58 59 60 61 62 63 64 65 66 67 68
    /**
     * 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());
69
        $schema->ensureTable('user_poll_prefs', User_poll_prefs::schemaDef());
70 71 72 73 74 75 76 77 78 79 80 81
        return true;
    }

    /**
     * Show the CSS necessary for this plugin
     *
     * @param Action $action the action being run
     *
     * @return boolean hook value
     */
    function onEndShowStyles($action)
    {
82
        $action->cssLink($this->path('css/poll.css'));
83 84 85 86 87 88 89 90 91 92 93 94 95
        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',
96 97 98 99 100
                    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}'));
101

102 103 104 105
        $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}'));

106 107 108 109
        $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}'));

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

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
        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
130
                            // TRANS: Plugin description.
131 132 133 134 135 136
                            _m('Simple extension for supporting basic polls.'));
        return true;
    }

    function types()
    {
137
        return array(self::POLL_OBJECT, self::POLL_RESPONSE_OBJECT);
138 139
    }

140 141 142 143 144

    function adaptNoticeListItem($nli) {
        return new PollListItem($nli);
    }

145 146 147 148 149 150 151
    /**
     * When a notice is deleted, delete the related Poll
     *
     * @param Notice $notice Notice being deleted
     *
     * @return boolean hook value
     */
152
    function deleteRelated(Notice $notice)
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
    {
        $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
     */
172
    function saveNoticeFromActivity(Activity $activity, Profile $profile, array $options=array())
173 174
    {
        // @fixme
175
        common_log(LOG_DEBUG, "XXX activity: " . var_export($activity, true));
176
        common_log(LOG_DEBUG, "XXX profile: " . var_export($profile, true));
177 178 179 180 181
        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) {
182 183
            $pollElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'poll');
            $responseElements = $activity->entry->getElementsByTagNameNS(self::POLL_OBJECT, 'response');
Brion Vibber's avatar
fix  
Brion Vibber committed
184
            if ($pollElements->length) {
Brion Vibber's avatar
Brion Vibber committed
185
                $question = '';
186
                $opts = array();
Brion Vibber's avatar
Brion Vibber committed
187 188 189

                $data = $pollElements->item(0);
                foreach ($data->getElementsByTagNameNS(self::POLL_OBJECT, 'question') as $node) {
Brion Vibber's avatar
Brion Vibber committed
190
                    $question = $node->textContent;
Brion Vibber's avatar
Brion Vibber committed
191 192
                }
                foreach ($data->getElementsByTagNameNS(self::POLL_OBJECT, 'option') as $node) {
Brion Vibber's avatar
Brion Vibber committed
193
                    $opts[] = $node->textContent;
194
                }
195 196
                try {
                    $notice = Poll::saveNew($profile, $question, $opts, $options);
Brion Vibber's avatar
Brion Vibber committed
197
                    common_log(LOG_DEBUG, "Saved Poll from ActivityStream data ok: notice id " . $notice->id);
198 199
                    return $notice;
                } catch (Exception $e) {
Brion Vibber's avatar
Brion Vibber committed
200
                    common_log(LOG_DEBUG, "Poll save from ActivityStream data failed: " . $e->getMessage());
201
                }
202 203 204 205 206 207
            } 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
208
                    // TRANS: Exception thrown trying to respond to a poll without a poll reference.
209
                    throw new Exception(_m('Invalid poll response: No poll reference.'));
210
                }
211
                $poll = Poll::getKV('uri', $pollUri);
212
                if (!$poll) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
213
                    // TRANS: Exception thrown trying to respond to a non-existing poll.
214
                    throw new Exception(_m('Invalid poll response: Poll is unknown.'));
215 216 217
                }
                try {
                    $notice = Poll_response::saveNew($profile, $poll, $selection, $options);
Brion Vibber's avatar
Brion Vibber committed
218
                    common_log(LOG_DEBUG, "Saved Poll_response ok, notice id: " . $notice->id);
219 220
                    return $notice;
                } catch (Exception $e) {
Brion Vibber's avatar
Brion Vibber committed
221
                    common_log(LOG_DEBUG, "Poll response  save fail: " . $e->getMessage());
222
                }
223 224 225 226
            } else {
                common_log(LOG_DEBUG, "YYY no poll data");
            }
        }
227 228
    }

229
    function activityObjectFromNotice(Notice $notice)
230 231 232
    {
        assert($this->isMyNotice($notice));

233 234 235 236 237 238
        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
239
            // TRANS: Exception thrown when performing an unexpected action on a poll.
240
            // TRANS: %s is the unexpected object type.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
241
            throw new Exception(sprintf(_m('Unexpected type for poll plugin: %s.'), $notice->object_type));
242 243 244
        }
    }

245
    function activityObjectFromNoticePollResponse(Notice $notice)
246
    {
247 248
        $object = new ActivityObject();
        $object->id      = $notice->uri;
249
        $object->type    = self::POLL_RESPONSE_OBJECT;
250 251
        $object->title   = $notice->content;
        $object->summary = $notice->content;
252
        $object->link    = $notice->getUrl();
253

254
        $response = Poll_response::getByNotice($notice);
255
        if ($response) {
256
            $poll = $response->getPoll();
257 258 259 260 261 262 263
            if ($poll) {
                // Stash data to be formatted later by
                // $this->activityObjectOutputAtom() or
                // $this->activityObjectOutputJson()...
                $object->pollSelection = intval($response->selection);
                $object->pollUri = $poll->uri;
            }
264
        }
265 266 267
        return $object;
    }

268
    function activityObjectFromNoticePoll(Notice $notice)
269 270 271
    {
        $object = new ActivityObject();
        $object->id      = $notice->uri;
272
        $object->type    = self::POLL_OBJECT;
273 274
        $object->title   = $notice->content;
        $object->summary = $notice->content;
275
        $object->link    = $notice->getUrl();
276 277

        $poll = Poll::getByNotice($notice);
278 279 280 281 282 283
        if ($poll) {
            // Stash data to be formatted later by
            // $this->activityObjectOutputAtom() or
            // $this->activityObjectOutputJson()...
            $object->pollQuestion = $poll->question;
            $object->pollOptions = $poll->getOptions();
284
        }
285

286 287 288
        return $object;
    }

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 377 378 379 380 381 382
    /**
     * 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;
        }
    }

383 384 385 386 387 388 389 390 391 392 393 394 395
    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
396 397
        // TRANS: Application title.
        return _m('APPTITLE','Poll');
398
    }
399

Evan Prodromou's avatar
Evan Prodromou committed
400
    function onStartAddNoticeReply($nli, $parent, $child)
401 402
    {
        // Filter out any poll responses
Evan Prodromou's avatar
Evan Prodromou committed
403 404 405
        if ($parent->object_type == self::POLL_OBJECT &&
            $child->object_type == self::POLL_RESPONSE_OBJECT) {
            return false;
406 407 408
        }
        return true;
    }
409 410 411 412 413 414

    // Hide poll responses for @chuck

    function onEndNoticeWhoGets($notice, &$ni) {
        if ($notice->object_type == self::POLL_RESPONSE_OBJECT) {
            foreach ($ni as $id => $source) {
415
                $user = User::getKV('id', $id);
416
                if (!empty($user)) {
417
                    $pollPrefs = User_poll_prefs::getKV('user_id', $user->id);
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
                    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;
    }
448
}