plugins/Event/EventPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Microapp plugin for event invitations and RSVPs
   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  Event
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@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     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Event plugin
  39  *
  40  * @category  Sample
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class EventPlugin extends MicroappPlugin
  48 {
  49     /**
  50      * Set up our tables (event and rsvp)
  51      *
  52      * @see Schema
  53      * @see ColumnDef
  54      *
  55      * @return boolean hook value; true means continue processing, false means stop.
  56      */
  57     function onCheckSchema()
  58     {
  59         $schema = Schema::get();
  60
  61         $schema->ensureTable('happening', Happening::schemaDef());
  62         $schema->ensureTable('rsvp', RSVP::schemaDef());
  63
  64         return true;
  65     }
  66
  67     /**
  68      * Load related modules when needed
  69      *
  70      * @param string $cls Name of the class to be loaded
  71      *
  72      * @return boolean hook value; true means continue processing, false means stop.
  73      */
  74     function onAutoload($cls)
  75     {
  76         $dir = dirname(__FILE__);
  77
  78         switch ($cls)
  79         {
  80         case 'NeweventAction':
  81         case 'NewrsvpAction':
  82         case 'CancelrsvpAction':
  83         case 'ShoweventAction':
  84         case 'ShowrsvpAction':
  85             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  86             return false;
  87         case 'EventListItem':
  88         case 'RSVPListItem':
  89         case 'EventForm':
  90         case 'RSVPForm':
  91         case 'CancelRSVPForm':
  92             include_once $dir . '/'.strtolower($cls).'.php';
  93             break;
  94         case 'Happening':
  95         case 'RSVP':
  96             include_once $dir . '/'.$cls.'.php';
  97             return false;
  98         default:
  99             return true;
 100         }
 101     }
 102
 103     /**
 104      * Map URLs to actions
 105      *
 106      * @param Net_URL_Mapper $m path-to-action mapper
 107      *
 108      * @return boolean hook value; true means continue processing, false means stop.
 109      */
 110     function onRouterInitialized($m)
 111     {
 112         $m->connect('main/event/new',
 113                     array('action' => 'newevent'));
 114         $m->connect('main/event/rsvp',
 115                     array('action' => 'newrsvp'));
 116         $m->connect('main/event/rsvp/cancel',
 117                     array('action' => 'cancelrsvp'));
 118         $m->connect('event/:id',
 119                     array('action' => 'showevent'),
 120                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 121         $m->connect('rsvp/:id',
 122                     array('action' => 'showrsvp'),
 123                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
 124         return true;
 125     }
 126
 127     function onPluginVersion(&$versions)
 128     {
 129         $versions[] = array('name' => 'Event',
 130                             'version' => STATUSNET_VERSION,
 131                             'author' => 'Evan Prodromou',
 132                             'homepage' => 'http://status.net/wiki/Plugin:Event',
 133                             'description' =>
 134                             // TRANS: Plugin description.
 135                             _m('Event invitations and RSVPs.'));
 136         return true;
 137     }
 138
 139     function appTitle() {
 140         // TRANS: Title for event application.
 141         return _m('TITLE','Event');
 142     }
 143
 144     function tag() {
 145         return 'event';
 146     }
 147
 148     function types() {
 149         return array(Happening::OBJECT_TYPE,
 150                      RSVP::POSITIVE,
 151                      RSVP::NEGATIVE,
 152                      RSVP::POSSIBLE);
 153     }
 154
 155     /**
 156      * Given a parsed ActivityStreams activity, save it into a notice
 157      * and other data structures.
 158      *
 159      * @param Activity $activity
 160      * @param Profile $actor
 161      * @param array $options=array()
 162      *
 163      * @return Notice the resulting notice
 164      */
 165     function saveNoticeFromActivity($activity, $actor, $options=array())
 166     {
 167         if (count($activity->objects) != 1) {
 168             throw new Exception(_('Too many activity objects.'));
 169         }
 170
 171         $happeningObj = $activity->objects[0];
 172
 173         if ($happeningObj->type != Happening::OBJECT_TYPE) {
 174             // TRANS: Exception thrown when event plugin comes across a non-event type object.
 175             throw new Exception(_m('Wrong type for object.'));
 176         }
 177
 178         $notice = null;
 179
 180         switch ($activity->verb) {
 181         case ActivityVerb::POST:
 182             $notice = Happening::saveNew($actor,
 183                                      $start_time,
 184                                      $end_time,
 185                                      $happeningObj->title,
 186                                      null,
 187                                      $happeningObj->summary,
 188                                      $options);
 189             break;
 190         case RSVP::POSITIVE:
 191         case RSVP::NEGATIVE:
 192         case RSVP::POSSIBLE:
 193             $happening = Happening::staticGet('uri', $happeningObj->id);
 194             if (empty($happening)) {
 195                 // FIXME: save the event
 196                 // TRANS: Exception thrown when trying to RSVP for an unknown event.
 197                 throw new Exception(_m('RSVP for unknown event.'));
 198             }
 199             $notice = RSVP::saveNew($actor, $happening, $activity->verb, $options);
 200             break;
 201         default:
 202             // TRANS: Exception thrown when event plugin comes across a undefined verb.
 203             throw new Exception(_m('Unknown verb for events.'));
 204         }
 205
 206         return $notice;
 207     }
 208
 209     /**
 210      * Turn a Notice into an activity object
 211      *
 212      * @param Notice $notice
 213      *
 214      * @return ActivityObject
 215      */
 216     function activityObjectFromNotice($notice)
 217     {
 218         $happening = null;
 219
 220         switch ($notice->object_type) {
 221         case Happening::OBJECT_TYPE:
 222             $happening = Happening::fromNotice($notice);
 223             break;
 224         case RSVP::POSITIVE:
 225         case RSVP::NEGATIVE:
 226         case RSVP::POSSIBLE:
 227             $rsvp  = RSVP::fromNotice($notice);
 228             $happening = $rsvp->getEvent();
 229             break;
 230         }
 231
 232         if (empty($happening)) {
 233             // TRANS: Exception thrown when event plugin comes across a unknown object type.
 234             throw new Exception(_m('Unknown object type.'));
 235         }
 236
 237         $notice = $happening->getNotice();
 238
 239         if (empty($notice)) {
 240             // TRANS: Exception thrown when referring to a notice that is not an event an in event context.
 241             throw new Exception(_m('Unknown event notice.'));
 242         }
 243
 244         $obj = new ActivityObject();
 245
 246         $obj->id      = $happening->uri;
 247         $obj->type    = Happening::OBJECT_TYPE;
 248         $obj->title   = $happening->title;
 249         $obj->summary = $happening->description;
 250         $obj->link    = $notice->bestUrl();
 251
 252         // XXX: how to get this stuff into JSON?!
 253
 254         $obj->extra[] = array('dtstart',
 255                               array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
 256                               common_date_iso8601($happening->start_time));
 257
 258         $obj->extra[] = array('dtend',
 259                               array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
 260                               common_date_iso8601($happening->end_time));
 261
 262         // XXX: probably need other stuff here
 263
 264         return $obj;
 265     }
 266
 267     /**
 268      * Change the verb on RSVP notices
 269      *
 270      * @param Notice $notice
 271      *
 272      * @return ActivityObject
 273      */
 274     function onEndNoticeAsActivity($notice, &$act) {
 275         switch ($notice->object_type) {
 276         case RSVP::POSITIVE:
 277         case RSVP::NEGATIVE:
 278         case RSVP::POSSIBLE:
 279             $act->verb = $notice->object_type;
 280             break;
 281         }
 282         return true;
 283     }
 284
 285     function adaptNoticeListItem($nli)
 286     {
 287         $notice = $nli->notice;
 288
 289         switch ($notice->object_type) {
 290         case Happening::OBJECT_TYPE:
 291             return new EventListItem($nli);
 292             break;
 293         case RSVP::POSITIVE:
 294         case RSVP::NEGATIVE:
 295         case RSVP::POSSIBLE:
 296             return new RSVPListItem($nli);
 297             break;
 298         }
 299     }
 300
 301
 302     /**
 303      * Form for our app
 304      *
 305      * @param HTMLOutputter $out
 306      * @return Widget
 307      */
 308     function entryForm($out)
 309     {
 310         return new EventForm($out);
 311     }
 312
 313     /**
 314      * When a notice is deleted, clean up related tables.
 315      *
 316      * @param Notice $notice
 317      */
 318     function deleteRelated($notice)
 319     {
 320         switch ($notice->object_type) {
 321         case Happening::OBJECT_TYPE:
 322             common_log(LOG_DEBUG, "Deleting event from notice...");
 323             $happening = Happening::fromNotice($notice);
 324             $happening->delete();
 325             break;
 326         case RSVP::POSITIVE:
 327         case RSVP::NEGATIVE:
 328         case RSVP::POSSIBLE:
 329             common_log(LOG_DEBUG, "Deleting rsvp from notice...");
 330             $rsvp = RSVP::fromNotice($notice);
 331             common_log(LOG_DEBUG, "to delete: $rsvp->id");
 332             $rsvp->delete();
 333             break;
 334         default:
 335             common_log(LOG_DEBUG, "Not deleting related, wtf...");
 336         }
 337     }
 338
 339     function onEndShowScripts($action)
 340     {
 341         $action->inlineScript('$(document).ready(function() { $("#event-startdate").datepicker(); $("#event-enddate").datepicker(); });');
 342     }
 343
 344     function onEndShowStyles($action)
 345     {
 346         $action->cssLink($this->path('event.css'));
 347         return true;
 348     }
 349
 350     function onStartShowThreadedNoticeTail($nli, $notice, &$children)
 351     {
 352         // Filter out any poll responses
 353         if ($notice->object_type == Happening::OBJECT_TYPE) {
 354             $children = array_filter($children, array($this, 'isNotRSVP'));
 355         }
 356         return true;
 357     }
 358
 359     function isNotRSVP($notice)
 360     {
 361         return (!in_array($notice->object_type, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE)));
 362     }
 363 }