]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Event/EventPlugin.php
Change status.net/wiki URLs to git.gnu.io
[quix0rs-gnu-social.git] / plugins / Event / EventPlugin.php
index 5c4abc41d0200918cf9d6ea01480502ce014e7f4..ed6a01e9b48a5c88f5e02cff11c7418c09444b6f 100644 (file)
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    // This check helps protect against security problems;
-    // your code file can't be executed directly from the web.
-    exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * Event plugin
@@ -44,11 +40,8 @@ if (!defined('STATUSNET')) {
  * @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 ActivityVerbHandlerPlugin
 {
-
-    var $oldSaveNew = true;
-
     /**
      * Set up our tables (event and rsvp)
      *
@@ -85,9 +78,10 @@ class EventPlugin extends MicroAppPlugin
         $m->connect('main/event/new',
                     array('action' => 'newevent'));
         $m->connect('main/event/rsvp',
-                    array('action' => 'newrsvp'));
-        $m->connect('main/event/rsvp/cancel',
-                    array('action' => 'cancelrsvp'));
+                    array('action' => 'rsvp'));
+        $m->connect('main/event/rsvp/:rsvp',    // this will probably change to include event notice id
+                    array('action' => 'rsvp'),
+                    array('rsvp'   => '[a-z]+'));
         $m->connect('event/:id',
                     array('action' => 'showevent'),
                     array('id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'));
@@ -108,7 +102,7 @@ class EventPlugin extends MicroAppPlugin
         $versions[] = array('name' => 'Event',
                             'version' => GNUSOCIAL_VERSION,
                             'author' => 'Evan Prodromou',
-                            'homepage' => 'http://status.net/wiki/Plugin:Event',
+                            'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Event',
                             'description' =>
                             // TRANS: Plugin description.
                             _m('Event invitations and RSVPs.'));
@@ -125,182 +119,101 @@ class EventPlugin extends MicroAppPlugin
     }
 
     function types() {
-        return array(Happening::OBJECT_TYPE,
+        return array(Happening::OBJECT_TYPE);
+    }
+
+    function verbs() {
+        return array(ActivityVerb::POST,
                      RSVP::POSITIVE,
                      RSVP::NEGATIVE,
                      RSVP::POSSIBLE);
     }
 
-    /**
-     * Given a parsed ActivityStreams activity, save it into a notice
-     * and other data structures.
-     *
-     * @param Activity $activity
-     * @param Profile $actor
-     * @param array $options=array()
-     *
-     * @return Notice the resulting notice
-     */
-    function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
-    {
-        if (count($activity->objects) != 1) {
-            // TRANS: Exception thrown when there are too many activity objects.
-            throw new Exception(_m('Too many activity objects.'));
+    function isMyNotice(Notice $notice) {
+        if (!empty($notice->object_type)) {
+            return parent::isMyNotice($notice);
         }
+        return $this->isMyVerb($notice->verb);
+    }
 
-        $happeningObj = $activity->objects[0];
+    public function newFormAction() {
+        // such as 'newbookmark' or 'newevent' route
+        return 'new'.$this->tag();
+    }
 
-        if ($happeningObj->type != Happening::OBJECT_TYPE) {
-            // TRANS: Exception thrown when event plugin comes across a non-event type object.
-            throw new Exception(_m('Wrong type for object.'));
-        }
+    function onStartShowEntryForms(&$tabs)
+    {
+        $tabs[$this->tag()] = array('title' => $this->appTitle(),
+                                    'href'  => common_local_url($this->newFormAction()),
+                                   );
+        return true;
+    }
 
-        $dtstart = $happeningObj->element->getElementsByTagName('dtstart');
-        if($dtstart->length == 0) {
-            // TRANS: Exception thrown when has no start date
-            throw new Exception(_m('No start date for event.'));
+    function onStartMakeEntryForm($tag, $out, &$form)
+    {
+        if ($tag == $this->tag()) {
+            $form = $this->entryForm($out);
+            return false;
         }
 
-        $dtend = $happeningObj->element->getElementsByTagName('dtend');
-        if($dtend->length == 0) {
-            // TRANS: Exception thrown when has no end date
-            throw new Exception(_m('No end date for event.'));
-        }
+        return true;
+    }
 
-        // convert RFC3339 dates delivered in Activity Stream to MySQL DATETIME date format
-        $start_time = new DateTime($dtstart->item(0)->nodeValue);
-        $start_time->setTimezone(new DateTimeZone('UTC'));
-        $start_time = $start_time->format('Y-m-d H:i:s');
-        $end_time = new DateTime($dtend->item(0)->nodeValue);
-        $end_time->setTimezone(new DateTimeZone('UTC'));
-        $end_time = $end_time->format('Y-m-d H:i:s');
-
-        // location is optional
-        $location = null;
-        $location_object = $happeningObj->element->getElementsByTagName('location');
-        if($location_object->length > 0) {
-            $location = $location_object->item(0)->nodeValue;
-        }
+    protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+    {
+        return $verb;
+    }
 
-        // url is optional
-        $url = null;
-        $url_object = $happeningObj->element->getElementsByTagName('url');
-        if($url_object->length > 0) {
-            $url = $url_object->item(0)->nodeValue;
-        }
+    protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+    {
+        return true;
+    }
 
-        $notice = null;
-
-        switch ($activity->verb) {
-        case ActivityVerb::POST:
-               // FIXME: get startTime, endTime, location and URL
-            $notice = Happening::saveNew($actor,
-                                         $start_time,
-                                         $end_time,
-                                         $happeningObj->title,
-                                         $location,
-                                         $happeningObj->summary,
-                                         $url,
-                                         $options);
+    protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+    {
+        throw new ServerException('Event does not handle doActionPost yet', 501);
+    }
+
+    protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+    {
+        return new RSVPForm(Happening::fromStored($target), $action);
+    }
+
+    protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
+    {
+        switch (true) {
+        case ActivityUtils::compareVerbs($stored->getVerb(), [ActivityVerb::POST]):
+            return Happening::saveActivityObject($act, $stored);
             break;
-        case RSVP::POSITIVE:
-        case RSVP::NEGATIVE:
-        case RSVP::POSSIBLE:
-            $happening = Happening::getKV('uri', $happeningObj->id);
-            if (empty($happening)) {
-                // FIXME: save the 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);
+
+        case ActivityUtils::compareVerbs($stored->getVerb(), [RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
+            return RSVP::saveActivityObject($act, $stored);
             break;
-        default:
-            // TRANS: Exception thrown when event plugin comes across a undefined verb.
-            throw new Exception(_m('Unknown verb for events.'));
         }
-
-        return $notice;
+        return null;
     }
 
-    /**
-     * Turn a Notice into an activity object
-     *
-     * @param Notice $notice
-     *
-     * @return ActivityObject
-     */
-    function activityObjectFromNotice(Notice $notice)
+    function activityObjectFromNotice(Notice $stored)
     {
         $happening = null;
 
-        switch ($notice->object_type) {
-        case Happening::OBJECT_TYPE:
-            $happening = Happening::fromNotice($notice);
+        switch (true) {
+        case $stored->isVerb([ActivityVerb::POST]) && $stored->isObjectType([Happening::OBJECT_TYPE]):
+            $obj = Happening::fromStored($stored)->asActivityObject();
             break;
-        case RSVP::POSITIVE:
-        case RSVP::NEGATIVE:
-        case RSVP::POSSIBLE:
-            $rsvp  = RSVP::fromNotice($notice);
-            $happening = $rsvp->getEvent();
+        // isObjectType here is because we had the verb stored in object_type previously for unknown reasons
+        case $stored->isObjectType([RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
+        case $stored->isVerb([RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
+            $obj = RSVP::fromStored($stored)->asActivityObject();
             break;
-        }
-
-        if (empty($happening)) {
+        default:
             // 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)) {
-            // 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();
-
-        $obj->id      = $happening->uri;
-        $obj->type    = Happening::OBJECT_TYPE;
-        $obj->title   = $happening->title;
-        $obj->summary = $happening->description;
-        $obj->link    = $notice->getUrl();
-
-        // XXX: how to get this stuff into JSON?!
-
-        $obj->extra[] = array('dtstart',
-                              array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
-                              common_date_iso8601($happening->start_time));
-
-        $obj->extra[] = array('dtend',
-                              array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
-                              common_date_iso8601($happening->end_time));
-
-        $obj->extra[] = array('location', false, $happening->location);
-        $obj->extra[] = array('url', false, $happening->url);
-
-        // XXX: probably need other stuff here
-
         return $obj;
     }
 
-    /**
-     * Change the verb on RSVP notices
-     *
-     * @param Notice $notice
-     *
-     * @return ActivityObject
-     */
-    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 = $stored->object_type;
-            break;
-        }
-        return true;
-    }
-
     /**
      * Form for our app
      *
@@ -312,29 +225,29 @@ class EventPlugin extends MicroAppPlugin
         return new EventForm($out);
     }
 
-    /**
-     * When a notice is deleted, clean up related tables.
-     *
-     * @param Notice $notice
-     */
-    function deleteRelated(Notice $notice)
+    function deleteRelated(Notice $stored)
     {
-        switch ($notice->object_type) {
-        case Happening::OBJECT_TYPE:
+        switch (true) {
+        case $stored->isObjectType([Happening::OBJECT_TYPE]):
             common_log(LOG_DEBUG, "Deleting event from notice...");
-            $happening = Happening::fromNotice($notice);
-            $happening->delete();
+            try {
+                $happening = Happening::fromStored($stored);
+                $happening->delete();
+            } catch (NoResultException $e) {
+                // already gone
+            }
             break;
-        case RSVP::POSITIVE:
-        case RSVP::NEGATIVE:
-        case RSVP::POSSIBLE:
+        // isObjectType here is because we had the verb stored in object_type previously for unknown reasons
+        case $stored->isObjectType([RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
+        case $stored->isVerb([RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
             common_log(LOG_DEBUG, "Deleting rsvp from notice...");
-            $rsvp = RSVP::fromNotice($notice);
-            common_log(LOG_DEBUG, "to delete: $rsvp->id");
-            $rsvp->delete();
+            try {
+                $rsvp = RSVP::fromStored($stored);
+                $rsvp->delete();
+            } catch (NoResultException $e) {
+                // already gone
+            }
             break;
-        default:
-            common_log(LOG_DEBUG, "Not deleting related, wtf...");
         }
     }
 
@@ -351,7 +264,6 @@ class EventPlugin extends MicroAppPlugin
 
     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;
@@ -359,36 +271,26 @@ class EventPlugin extends MicroAppPlugin
         return true;
     }
 
-    protected function showNoticeItemNotice(NoticeListItem $nli)
-    {
-        $nli->showAuthor();
-        $nli->showContent();
-    }
-
     protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
     {
-        switch ($stored->object_type) {
-        case Happening::OBJECT_TYPE:
+        switch (true) {
+        case ActivityUtils::compareTypes($stored->verb, array(ActivityVerb::POST)) &&
+                ActivityUtils::compareTypes($stored->object_type, array(Happening::OBJECT_TYPE)):
             $this->showEvent($stored, $out, $scoped);
             break;
-        case RSVP::POSITIVE:
-        case RSVP::NEGATIVE:
-        case RSVP::POSSIBLE:
+        case ActivityUtils::compareVerbs($stored->verb, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE)):
             $this->showRSVP($stored, $out, $scoped);
             break;
+        default:
+            throw new ServerException('This is not an Event notice');
         }
+        return true;
     }
 
     protected function showEvent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
     {
         $profile = $stored->getProfile();
-        $event   = Happening::fromNotice($stored);
-
-        if (!$event instanceof Happening) {
-            // TRANS: Content for a deleted RSVP list item (RSVP stands for "please respond").
-            $out->element('p', null, _m('Deleted.'));
-            return;
-        }
+        $event   = Happening::fromStored($stored);
 
         $out->elementStart('div', 'h-event');
 
@@ -499,14 +401,7 @@ class EventPlugin extends MicroAppPlugin
         $out->elementEnd('div');
 
         if ($scoped instanceof Profile) {
-            $rsvp = $event->getRSVP($scoped);
-
-            if (empty($rsvp)) {
-                $form = new RSVPForm($event, $out);
-            } else {
-                $form = new CancelRSVPForm($rsvp, $out);
-            }
-
+            $form = new RSVPForm($out, array('event'=>$event, 'scoped'=>$scoped));
             $form->show();
         }
         $out->elementEnd('div');
@@ -514,9 +409,9 @@ class EventPlugin extends MicroAppPlugin
 
     protected function showRSVP(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
     {
-        $rsvp = RSVP::fromNotice($stored);
-
-        if (empty($rsvp)) {
+        try {
+            $rsvp = RSVP::fromStored($stored);
+        } catch (NoResultException $e) {
             // TRANS: Content for a deleted RSVP list item (RSVP stands for "please respond").
             $out->element('p', null, _m('Deleted.'));
             return;