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  Event
  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             // TRANS: Exception thrown when there are too many activity objects.
 169             throw new Exception(_m('Too many activity objects.'));
 170         }
 171
 172         $happeningObj = $activity->objects[0];
 173
 174         if ($happeningObj->type != Happening::OBJECT_TYPE) {
 175             // TRANS: Exception thrown when event plugin comes across a non-event type object.
 176             throw new Exception(_m('Wrong type for object.'));
 177         }
 178
 179         $notice = null;
 180
 181         switch ($activity->verb) {
 182         case ActivityVerb::POST:
 183             $notice = Happening::saveNew($actor,
 184                                          $start_time,
 185                                          $end_time,
 186                                          $happeningObj->title,
 187                                          null,
 188                                          $happeningObj->summary,
 189                                          null,
 190                                          $options);
 191             break;
 192         case RSVP::POSITIVE:
 193         case RSVP::NEGATIVE:
 194         case RSVP::POSSIBLE:
 195             $happening = Happening::staticGet('uri', $happeningObj->id);
 196             if (empty($happening)) {
 197                 // FIXME: save the event
 198                 // TRANS: Exception thrown when trying to RSVP for an unknown event.
 199                 throw new Exception(_m('RSVP for unknown event.'));
 200             }
 201             $notice = RSVP::saveNew($actor, $happening, $activity->verb, $options);
 202             break;
 203         default:
 204             // TRANS: Exception thrown when event plugin comes across a undefined verb.
 205             throw new Exception(_m('Unknown verb for events.'));
 206         }
 207
 208         return $notice;
 209     }
 210
 211     /**
 212      * Turn a Notice into an activity object
 213      *
 214      * @param Notice $notice
 215      *
 216      * @return ActivityObject
 217      */
 218     function activityObjectFromNotice($notice)
 219     {
 220         $happening = null;
 221
 222         switch ($notice->object_type) {
 223         case Happening::OBJECT_TYPE:
 224             $happening = Happening::fromNotice($notice);
 225             break;
 226         case RSVP::POSITIVE:
 227         case RSVP::NEGATIVE:
 228         case RSVP::POSSIBLE:
 229             $rsvp  = RSVP::fromNotice($notice);
 230             $happening = $rsvp->getEvent();
 231             break;
 232         }
 233
 234         if (empty($happening)) {
 235             // TRANS: Exception thrown when event plugin comes across a unknown object type.
 236             throw new Exception(_m('Unknown object type.'));
 237         }
 238
 239         $notice = $happening->getNotice();
 240
 241         if (empty($notice)) {
 242             // TRANS: Exception thrown when referring to a notice that is not an event an in event context.
 243             throw new Exception(_m('Unknown event notice.'));
 244         }
 245
 246         $obj = new ActivityObject();
 247
 248         $obj->id      = $happening->uri;
 249         $obj->type    = Happening::OBJECT_TYPE;
 250         $obj->title   = $happening->title;
 251         $obj->summary = $happening->description;
 252         $obj->link    = $notice->bestUrl();
 253
 254         // XXX: how to get this stuff into JSON?!
 255
 256         $obj->extra[] = array('dtstart',
 257                               array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
 258                               common_date_iso8601($happening->start_time));
 259
 260         $obj->extra[] = array('dtend',
 261                               array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
 262                               common_date_iso8601($happening->end_time));
 263
 264         // XXX: probably need other stuff here
 265
 266         return $obj;
 267     }
 268
 269     /**
 270      * Change the verb on RSVP notices
 271      *
 272      * @param Notice $notice
 273      *
 274      * @return ActivityObject
 275      */
 276     function onEndNoticeAsActivity($notice, &$act) {
 277         switch ($notice->object_type) {
 278         case RSVP::POSITIVE:
 279         case RSVP::NEGATIVE:
 280         case RSVP::POSSIBLE:
 281             $act->verb = $notice->object_type;
 282             break;
 283         }
 284         return true;
 285     }
 286
 287     function adaptNoticeListItem($nli)
 288     {
 289         $notice = $nli->notice;
 290
 291         switch ($notice->object_type) {
 292         case Happening::OBJECT_TYPE:
 293             return new EventListItem($nli);
 294             break;
 295         case RSVP::POSITIVE:
 296         case RSVP::NEGATIVE:
 297         case RSVP::POSSIBLE:
 298             return new RSVPListItem($nli);
 299             break;
 300         }
 301         return null;
 302     }
 303
 304
 305     /**
 306      * Form for our app
 307      *
 308      * @param HTMLOutputter $out
 309      * @return Widget
 310      */
 311     function entryForm($out)
 312     {
 313         return new EventForm($out);
 314     }
 315
 316     /**
 317      * When a notice is deleted, clean up related tables.
 318      *
 319      * @param Notice $notice
 320      */
 321     function deleteRelated($notice)
 322     {
 323         switch ($notice->object_type) {
 324         case Happening::OBJECT_TYPE:
 325             common_log(LOG_DEBUG, "Deleting event from notice...");
 326             $happening = Happening::fromNotice($notice);
 327             $happening->delete();
 328             break;
 329         case RSVP::POSITIVE:
 330         case RSVP::NEGATIVE:
 331         case RSVP::POSSIBLE:
 332             common_log(LOG_DEBUG, "Deleting rsvp from notice...");
 333             $rsvp = RSVP::fromNotice($notice);
 334             common_log(LOG_DEBUG, "to delete: $rsvp->id");
 335             $rsvp->delete();
 336             break;
 337         default:
 338             common_log(LOG_DEBUG, "Not deleting related, wtf...");
 339         }
 340     }
 341
 342     function onEndShowScripts($action)
 343     {
 344         $action->inlineScript('$(document).ready(function() { $("#event-startdate").datepicker(); $("#event-enddate").datepicker(); });');
 345     }
 346
 347     function onEndShowStyles($action)
 348     {
 349         $action->cssLink($this->path('event.css'));
 350         return true;
 351     }
 352
 353     function onStartAddNoticeReply($nli, $parent, $child)
 354     {
 355         // Filter out any poll responses
 356         if (($parent->object_type == Happening::OBJECT_TYPE) &&
 357             in_array($child->object_type, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE))) {
 358             return false;
 359         }
 360         return true;
 361     }
 362 }