]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Event/EventPlugin.php
Fixed more type-hints for safety.
[quix0rs-gnu-social.git] / plugins / Event / EventPlugin.php
index 1ee6ef4309a1033ba46e8a537e7859a7063e4c9b..3afab5f13b1afaf0c2e34bc32dd71eedd88dfe3b 100644 (file)
@@ -37,14 +37,14 @@ if (!defined('STATUSNET')) {
 /**
  * Event plugin
  *
- * @category  Sample
+ * @category  Event
  * @package   StatusNet
  * @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 EventPlugin extends MicroappPlugin
+class EventPlugin extends MicroAppPlugin
 {
     /**
      * Set up our tables (event and rsvp)
@@ -64,49 +64,14 @@ class EventPlugin extends MicroappPlugin
         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 'NeweventAction':
-        case 'NewrsvpAction':
-        case 'CancelrsvpAction':
-        case 'ShoweventAction':
-        case 'ShowrsvpAction':
-            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
-            return false;
-        case 'EventForm':
-        case 'RSVPForm':
-        case 'CancelRSVPForm':
-            include_once $dir . '/'.strtolower($cls).'.php';
-            break;
-        case 'Happening':
-        case 'RSVP':
-            include_once $dir . '/'.$cls.'.php';
-            return false;
-        default:
-            return true;
-        }
-    }
-
     /**
      * Map URLs to actions
      *
-     * @param Net_URL_Mapper $m path-to-action mapper
+     * @param URLMapper $m path-to-action mapper
      *
      * @return boolean hook value; true means continue processing, false means stop.
      */
-
-    function onRouterInitialized($m)
+    public function onRouterInitialized(URLMapper $m)
     {
         $m->connect('main/event/new',
                     array('action' => 'newevent'));
@@ -120,22 +85,26 @@ class EventPlugin extends MicroappPlugin
         $m->connect('rsvp/:id',
                     array('action' => 'showrsvp'),
                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
+        $m->connect('main/event/updatetimes',
+                    array('action' => 'timelist'));
         return true;
     }
 
-    function onPluginVersion(&$versions)
+    function onPluginVersion(array &$versions)
     {
         $versions[] = array('name' => 'Event',
-                            'version' => STATUSNET_VERSION,
+                            'version' => GNUSOCIAL_VERSION,
                             'author' => 'Evan Prodromou',
                             'homepage' => 'http://status.net/wiki/Plugin:Event',
                             'description' =>
+                            // TRANS: Plugin description.
                             _m('Event invitations and RSVPs.'));
         return true;
     }
 
     function appTitle() {
-        return _m('Event');
+        // TRANS: Title for event application.
+        return _m('TITLE','Event');
     }
 
     function tag() {
@@ -159,42 +128,48 @@ class EventPlugin extends MicroappPlugin
      *
      * @return Notice the resulting notice
      */
-    function saveNoticeFromActivity($activity, $actor, $options=array())
+    function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
     {
         if (count($activity->objects) != 1) {
-            throw new Exception('Too many activity objects.');
+            // TRANS: Exception thrown when there are too many activity objects.
+            throw new Exception(_m('Too many activity objects.'));
         }
 
         $happeningObj = $activity->objects[0];
 
         if ($happeningObj->type != Happening::OBJECT_TYPE) {
-            throw new Exception('Wrong type for object.');
+            // TRANS: Exception thrown when event plugin comes across a non-event type object.
+            throw new Exception(_m('Wrong type for object.'));
         }
 
         $notice = null;
 
         switch ($activity->verb) {
         case ActivityVerb::POST:
-            $notice = Happening::saveNew($actor, 
-                                     $start_time, 
-                                     $end_time,
-                                     $happeningObj->title,
-                                     null,
-                                     $happeningObj->summary,
-                                     $options);
+               // FIXME: get startTime, endTime, location and URL
+            $notice = Happening::saveNew($actor,
+                                         $start_time,
+                                         $end_time,
+                                         $happeningObj->title,
+                                         null,
+                                         $happeningObj->summary,
+                                         null,
+                                         $options);
             break;
         case RSVP::POSITIVE:
         case RSVP::NEGATIVE:
         case RSVP::POSSIBLE:
-            $happening = Happening::staticGet('uri', $happeningObj->id);
+            $happening = Happening::getKV('uri', $happeningObj->id);
             if (empty($happening)) {
                 // FIXME: save the event
-                throw new Exception("RSVP for unknown event.");
+                // TRANS: Exception thrown when trying to RSVP for an unknown event.
+                throw new Exception(_m('RSVP for unknown event.'));
             }
             $notice = RSVP::saveNew($actor, $happening, $activity->verb, $options);
             break;
         default:
-            throw new Exception("Unknown verb for events");
+            // TRANS: Exception thrown when event plugin comes across a undefined verb.
+            throw new Exception(_m('Unknown verb for events.'));
         }
 
         return $notice;
@@ -207,8 +182,7 @@ class EventPlugin extends MicroappPlugin
      *
      * @return ActivityObject
      */
-
-    function activityObjectFromNotice($notice)
+    function activityObjectFromNotice(Notice $notice)
     {
         $happening = null;
 
@@ -225,13 +199,15 @@ class EventPlugin extends MicroappPlugin
         }
 
         if (empty($happening)) {
-            throw new Exception("Unknown object type.");
+            // TRANS: Exception thrown when event plugin comes across a unknown object type.
+            throw new Exception(_m('Unknown object type.'));
         }
 
         $notice = $happening->getNotice();
 
         if (empty($notice)) {
-            throw new Exception("Unknown event notice.");
+            // TRANS: Exception thrown when referring to a notice that is not an event an in event context.
+            throw new Exception(_m('Unknown event notice.'));
         }
 
         $obj = new ActivityObject();
@@ -240,7 +216,7 @@ class EventPlugin extends MicroappPlugin
         $obj->type    = Happening::OBJECT_TYPE;
         $obj->title   = $happening->title;
         $obj->summary = $happening->description;
-        $obj->link    = $notice->bestUrl();
+        $obj->link    = $notice->getUrl();
 
         // XXX: how to get this stuff into JSON?!
 
@@ -252,6 +228,9 @@ class EventPlugin extends MicroappPlugin
                               array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
                               common_date_iso8601($happening->end_time));
 
+               // FIXME: add location
+               // FIXME: add URL
+               
         // XXX: probably need other stuff here
 
         return $obj;
@@ -264,154 +243,216 @@ class EventPlugin extends MicroappPlugin
      *
      * @return ActivityObject
      */
-
-    function onEndNoticeAsActivity($notice, &$act) {
-        switch ($notice->object_type) {
+    protected function extendActivity(Notice $stored, Activity $act, Profile $scoped=null) {
+        switch ($stored->object_type) {
         case RSVP::POSITIVE:
         case RSVP::NEGATIVE:
         case RSVP::POSSIBLE:
-            $act->verb = $notice->object_type;
+            $act->verb = $stored->object_type;
             break;
         }
         return true;
     }
 
     /**
-     * Custom HTML output for our notices
+     * Form for our app
      *
-     * @param Notice $notice
      * @param HTMLOutputter $out
+     * @return Widget
      */
+    function entryForm($out)
+    {
+        return new EventForm($out);
+    }
 
-    function showNotice($notice, $out)
+    /**
+     * When a notice is deleted, clean up related tables.
+     *
+     * @param Notice $notice
+     */
+    function deleteRelated(Notice $notice)
     {
         switch ($notice->object_type) {
         case Happening::OBJECT_TYPE:
-            $this->showEventNotice($notice, $out);
+            common_debug("Deleting event from notice...");
+            $happening = Happening::fromNotice($notice);
+            $happening->delete();
             break;
         case RSVP::POSITIVE:
         case RSVP::NEGATIVE:
         case RSVP::POSSIBLE:
-            $this->showRSVPNotice($notice, $out);
+            common_debug("Deleting rsvp from notice...");
+            $rsvp = RSVP::fromNotice($notice);
+            common_debug("to delete: $rsvp->id");
+            $rsvp->delete();
             break;
+        default:
+            common_debug("Not deleting related, wtf...");
         }
+    }
 
-        // @fixme we have to start the name/avatar and open this div
-        $out->elementStart('div', array('class' => 'event-info entry-content')); // EVENT-INFO.ENTRY-CONTENT IN
-
-        $profile = $notice->getProfile();
-        $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
-
-        $out->element('img',
-                      array('src' => ($avatar) ?
-                            $avatar->displayUrl() :
-                            Avatar::defaultImage(AVATAR_MINI_SIZE),
-                            'class' => 'avatar photo bookmark-avatar',
-                            'width' => AVATAR_MINI_SIZE,
-                            'height' => AVATAR_MINI_SIZE,
-                            'alt' => $profile->getBestName()));
-
-        $out->raw('&#160;'); // avoid &nbsp; for AJAX XML compatibility
-
-        $out->elementStart('span', 'vcard author'); // hack for belongsOnTimeline; JS needs to be able to find the author
-        $out->element('a',
-                      array('class' => 'url',
-                            'href' => $profile->profileurl,
-                            'title' => $profile->getBestName()),
-                      $profile->nickname);
-        $out->elementEnd('span');
+    function onEndShowScripts(Action $action)
+    {
+        $action->script($this->path('js/event.js'));
     }
 
-    function showRSVPNotice($notice, $out)
+    function onEndShowStyles(Action $action)
     {
-        $rsvp = RSVP::fromNotice($notice);
+        $action->cssLink($this->path('css/event.css'));
+        return true;
+    }
 
-        $out->elementStart('div', 'rsvp');
-        $out->raw($rsvp->asHTML());
-        $out->elementEnd('div');
-        return;
+    function onStartAddNoticeReply($nli, $parent, $child)
+    {
+        // Filter out any poll responses
+        if (($parent->object_type == Happening::OBJECT_TYPE) &&
+            in_array($child->object_type, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE))) {
+            return false;
+        }
+        return true;
     }
 
-    function showEventNotice($notice, $out)
+    protected function showNoticeItemNotice(NoticeListItem $nli)
     {
-        $profile = $notice->getProfile();
-        $event   = Happening::fromNotice($notice);
+        $nli->showAuthor();
+        $nli->showContent();
+    }
 
-        assert(!empty($event));
-        assert(!empty($profile));
+    protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+    {
+        switch ($stored->object_type) {
+        case Happening::OBJECT_TYPE:
+            $this->showEvent($stored, $out, $scoped);
+            break;
+        case RSVP::POSITIVE:
+        case RSVP::NEGATIVE:
+        case RSVP::POSSIBLE:
+            $this->showRSVP($stored, $out, $scoped);
+            break;
+        }
+    }
 
-        $out->elementStart('div', 'vevent event'); // VEVENT IN
+    protected function showEvent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+    {
+        $profile = $stored->getProfile();
+        $event   = Happening::fromNotice($stored);
 
-        $out->elementStart('h3');  // VEVENT/H3 IN
+        if (!$event instanceof Happening) {
+            // TRANS: Content for a deleted RSVP list item (RSVP stands for "please respond").
+            $out->element('p', null, _m('Deleted.'));
+            return;
+        }
 
-        if (!empty($event->url)) {
-            $out->element('a',
-                          array('href' => $event->url,
-                                'class' => 'event-title entry-title summary'),
-                          $event->title);
-        } else {
+        $out->elementStart('div', 'h-event');
+
+        $out->elementStart('h3', 'p-summary p-name');
+
+        try {
+            $out->element('a', array('href' => $event->getUrl()), $event->title);
+        } catch (InvalidUrlException $e) {
             $out->text($event->title);
         }
 
-        $out->elementEnd('h3'); // VEVENT/H3 OUT
+        $out->elementEnd('h3');
 
-        $startDate = strftime("%x", strtotime($event->start_time));
-        $startTime = strftime("%R", strtotime($event->start_time));
+        $now       = new DateTime();
+        $startDate = new DateTime($event->start_time);
+        $endDate   = new DateTime($event->end_time);
+        $userTz    = new DateTimeZone(common_timezone());
 
-        $endDate = strftime("%x", strtotime($event->end_time));
-        $endTime = strftime("%R", strtotime($event->end_time));
+        // Localize the time for the observer
+        $now->setTimeZone($userTz);
+        $startDate->setTimezone($userTz);
+        $endDate->setTimezone($userTz);
 
-        // FIXME: better dates
+        $thisYear  = $now->format('Y');
+        $startYear = $startDate->format('Y');
+        $endYear   = $endDate->format('Y');
 
-        $out->elementStart('div', 'event-times'); // VEVENT/EVENT-TIMES IN
+        $dateFmt = 'D, F j, '; // e.g.: Mon, Aug 31
 
-        $out->element('strong', null, _('Time:'));
-
-        $out->element('abbr', array('class' => 'dtstart',
-                                    'title' => common_date_iso8601($event->start_time)),
-                      $startDate . ' ' . $startTime);
-        $out->text(' - ');
-        if ($startDate == $endDate) {
-            $out->element('span', array('class' => 'dtend',
-                                        'title' => common_date_iso8601($event->end_time)),
-                          $endTime);
-        } else {
-            $out->element('span', array('class' => 'dtend',
-                                        'title' => common_date_iso8601($event->end_time)),
-                          $endDate . ' ' . $endTime);
+        if ($startYear != $thisYear || $endYear != $thisYear) {
+            $dateFmt .= 'Y,'; // append year if we need to think about years
         }
 
+        $startDateStr = $startDate->format($dateFmt);
+        $endDateStr = $endDate->format($dateFmt);
+
+        $timeFmt = 'g:ia';
+
+        $startTimeStr = $startDate->format($timeFmt);
+        $endTimeStr = $endDate->format("{$timeFmt} (T)");
+
+        $out->elementStart('div', 'event-times'); // VEVENT/EVENT-TIMES IN
+
+        // TRANS: Field label for event description.
+        $out->element('strong', null, _m('Time:'));
+
+        $out->element('time', array('class' => 'dt-start',
+                                    'datetime' => common_date_iso8601($event->start_time)),
+                      $startDateStr . ' ' . $startTimeStr);
+        $out->text(' – ');
+        $out->element('time', array('class' => 'dt-end',
+                                    'datetime' => common_date_iso8601($event->end_time)),
+                      $startDateStr != $endDateStr
+                                    ? "$endDateStr $endTimeStr"
+                                    :  $endTimeStr);
+
         $out->elementEnd('div'); // VEVENT/EVENT-TIMES OUT
 
         if (!empty($event->location)) {
             $out->elementStart('div', 'event-location');
-            $out->element('strong', null, _('Location: '));
-            $out->element('span', 'location', $event->location);
+            // TRANS: Field label for event description.
+            $out->element('strong', null, _m('Location:'));
+            $out->element('span', 'p-location', $event->location);
             $out->elementEnd('div');
         }
 
         if (!empty($event->description)) {
             $out->elementStart('div', 'event-description');
-            $out->element('strong', null, _('Description: '));
-            $out->element('span', 'description', $event->description);
+            // TRANS: Field label for event description.
+            $out->element('strong', null, _m('Description:'));
+            $out->element('div', 'p-description', $event->description);
             $out->elementEnd('div');
         }
 
         $rsvps = $event->getRSVPs();
 
         $out->elementStart('div', 'event-rsvps');
-        $out->element('strong', null, _('Attending: '));
-        $out->element('span', 'event-rsvps',
-                      sprintf(_('Yes: %d No: %d Maybe: %d'),
-                              count($rsvps[RSVP::POSITIVE]),
-                              count($rsvps[RSVP::NEGATIVE]),
-                              count($rsvps[RSVP::POSSIBLE])));
-        $out->elementEnd('div');
 
-        $user = common_current_user();
+        // TRANS: Field label for event description.
+        $out->element('strong', null, _m('Attending:'));
+        $out->elementStart('ul', 'attending-list');
+
+        foreach ($rsvps as $verb => $responses) {
+            $out->elementStart('li', 'rsvp-list');
+            switch ($verb) {
+            case RSVP::POSITIVE:
+                $out->text(_('Yes:'));
+                break;
+            case RSVP::NEGATIVE:
+                $out->text(_('No:'));
+                break;
+            case RSVP::POSSIBLE:
+                $out->text(_('Maybe:'));
+                break;
+            }
+            $ids = array();
+            foreach ($responses as $response) {
+                $ids[] = $response->profile_id;
+            }
+            $ids = array_slice($ids, 0, ProfileMiniList::MAX_PROFILES + 1);
+            $minilist = new ProfileMiniList(Profile::multiGet('id', $ids), $out);
+            $minilist->show();
 
-        if (!empty($user)) {
-            $rsvp = $event->getRSVP($user->getProfile());
+            $out->elementEnd('li');
+        }
+
+        $out->elementEnd('ul');
+        $out->elementEnd('div');
+
+        if ($scoped instanceof Profile) {
+            $rsvp = $event->getRSVP($scoped);
 
             if (empty($rsvp)) {
                 $form = new RSVPForm($event, $out);
@@ -421,57 +462,21 @@ class EventPlugin extends MicroappPlugin
 
             $form->show();
         }
-
-        $out->elementEnd('div'); // vevent out
+        $out->elementEnd('div');
     }
 
-    /**
-     * Form for our app
-     *
-     * @param HTMLOutputter $out
-     * @return Widget
-     */
-
-    function entryForm($out)
+    protected function showRSVP(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
     {
-        return new EventForm($out);
-    }
+        $rsvp = RSVP::fromNotice($stored);
 
-    /**
-     * When a notice is deleted, clean up related tables.
-     *
-     * @param Notice $notice
-     */
-
-    function deleteRelated($notice)
-    {
-        switch ($notice->object_type) {
-        case Happening::OBJECT_TYPE:
-            common_log(LOG_DEBUG, "Deleting event from notice...");
-            $happening = Happening::fromNotice($notice);
-            $happening->delete();
-            break;
-        case RSVP::POSITIVE:
-        case RSVP::NEGATIVE:
-        case RSVP::POSSIBLE:
-            common_log(LOG_DEBUG, "Deleting rsvp from notice...");
-            $rsvp = RSVP::fromNotice($notice);
-            common_log(LOG_DEBUG, "to delete: $rsvp->id");
-            $rsvp->delete();
-            break;
-        default:
-            common_log(LOG_DEBUG, "Not deleting related, wtf...");
+        if (empty($rsvp)) {
+            // TRANS: Content for a deleted RSVP list item (RSVP stands for "please respond").
+            $out->element('p', null, _m('Deleted.'));
+            return;
         }
-    }
-
-    function onEndShowScripts($action)
-    {
-        $action->inlineScript('$(document).ready(function() { $("#startdate").datepicker(); $("#enddate").datepicker(); });');
-    }
 
-    function onEndShowStyles($action)
-    {
-        $action->cssLink($this->path('event.css'));
-        return true;
+        $out->elementStart('div', 'rsvp');
+        $out->raw($rsvp->asHTML());
+        $out->elementEnd('div');
     }
 }