* @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
* @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
{
/**
* Set up our tables (event and rsvp)
return true;
}
+ public function onBeforePluginCheckSchema()
+ {
+ RSVP::beforeSchemaUpdate();
+ 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'));
$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}'));
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'));
+
+ $m->connect(':nickname/events',
+ array('action' => 'events'),
+ array('nickname' => Nickname::DISPLAY_FMT));
return true;
}
- function onPluginVersion(&$versions)
+ function onPluginVersion(array &$versions)
{
$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.'));
}
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.'));
- }
-
- $happeningObj = $activity->objects[0];
-
- 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.'));
- }
-
- $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,
- null,
- $happeningObj->summary,
- null,
- $options);
- 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);
- break;
- default:
- // TRANS: Exception thrown when event plugin comes across a undefined verb.
- throw new Exception(_m('Unknown verb for events.'));
+ function isMyNotice(Notice $notice) {
+ if (!empty($notice->object_type)) {
+ return parent::isMyNotice($notice);
}
+ return $this->isMyVerb($notice->verb);
+ }
- return $notice;
+ public function newFormAction() {
+ // such as 'newbookmark' or 'newevent' route
+ return 'new'.$this->tag();
}
- /**
- * Turn a Notice into an activity object
- *
- * @param Notice $notice
- *
- * @return ActivityObject
- */
- function activityObjectFromNotice(Notice $notice)
+ function onStartShowEntryForms(&$tabs)
{
- $happening = null;
-
- switch ($notice->object_type) {
- case Happening::OBJECT_TYPE:
- $happening = Happening::fromNotice($notice);
- break;
- case RSVP::POSITIVE:
- case RSVP::NEGATIVE:
- case RSVP::POSSIBLE:
- $rsvp = RSVP::fromNotice($notice);
- $happening = $rsvp->getEvent();
- break;
- }
-
- if (empty($happening)) {
- // TRANS: Exception thrown when event plugin comes across a unknown object type.
- throw new Exception(_m('Unknown object type.'));
- }
-
- $notice = $happening->getNotice();
+ $tabs[$this->tag()] = array('title' => $this->appTitle(),
+ 'href' => common_local_url($this->newFormAction()),
+ );
+ return true;
+ }
- 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.'));
+ function onStartMakeEntryForm($tag, $out, &$form)
+ {
+ if ($tag == $this->tag()) {
+ $form = $this->entryForm($out);
+ return false;
}
- $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?!
+ return true;
+ }
- $obj->extra[] = array('dtstart',
- array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
- common_date_iso8601($happening->start_time));
+ protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+ {
+ return $verb;
+ }
- $obj->extra[] = array('dtend',
- array('xmlns' => 'urn:ietf:params:xml:ns:xcal'),
- common_date_iso8601($happening->end_time));
+ protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+ {
+ return true;
+ }
- // FIXME: add location
- // FIXME: add URL
-
- // XXX: probably need other stuff here
+ protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+ {
+ throw new ServerException('Event does not handle doActionPost yet', 501);
+ }
- return $obj;
+ protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
+ {
+ return new RSVPForm(Happening::fromStored($target), $action);
}
- /**
- * Change the verb on RSVP notices
- *
- * @param Notice $notice
- *
- * @return ActivityObject
- */
- function onEndNoticeAsActivity($notice, &$act) {
- switch ($notice->object_type) {
- case RSVP::POSITIVE:
- case RSVP::NEGATIVE:
- case RSVP::POSSIBLE:
- $act->verb = $notice->object_type;
+ 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 ActivityUtils::compareVerbs($stored->getVerb(), [RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
+ return RSVP::saveActivityObject($act, $stored);
break;
}
- return true;
+ return null;
}
- function adaptNoticeListItem($nli)
+ function activityObjectFromNotice(Notice $stored)
{
- $notice = $nli->notice;
+ $happening = null;
- switch ($notice->object_type) {
- case Happening::OBJECT_TYPE:
- return new EventListItem($nli);
+ 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:
- return new RSVPListItem($nli);
+ // 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;
+ default:
+ // TRANS: Exception thrown when event plugin comes across a unknown object type.
+ throw new Exception(_m('Unknown object type.'));
}
- return null;
- }
+ return $obj;
+ }
/**
* Form for our app
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...");
}
}
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;
}
+
+ protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ 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 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::fromStored($stored);
+
+ $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');
+
+ $now = new DateTime();
+ $startDate = new DateTime($event->start_time);
+ $endDate = new DateTime($event->end_time);
+ $userTz = new DateTimeZone(common_timezone());
+
+ // Localize the time for the observer
+ $now->setTimeZone($userTz);
+ $startDate->setTimezone($userTz);
+ $endDate->setTimezone($userTz);
+
+ $thisYear = $now->format('Y');
+ $startYear = $startDate->format('Y');
+ $endYear = $endDate->format('Y');
+
+ $dateFmt = 'D, F j, '; // e.g.: Mon, Aug 31
+
+ 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');
+ // 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');
+ // 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');
+
+ // 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();
+
+ $out->elementEnd('li');
+ }
+
+ $out->elementEnd('ul');
+ $out->elementEnd('div');
+
+ if ($scoped instanceof Profile) {
+ $form = new RSVPForm($out, array('event'=>$event, 'scoped'=>$scoped));
+ $form->show();
+ }
+ $out->elementEnd('div');
+ }
+
+ protected function showRSVP(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
+ {
+ 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;
+ }
+
+ $out->elementStart('div', 'rsvp');
+ $out->raw($rsvp->asHTML());
+ $out->elementEnd('div');
+ }
+
+ function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
+ {
+ $menu->menuItem(common_local_url('events', array('nickname' => $target->getNickname())),
+ // TRANS: Menu item in sample plugin.
+ _m('Happenings'),
+ // TRANS: Menu item title in sample plugin.
+ _m('A list of your events'), false, 'nav_timeline_events');
+ return true;
+ }
}