gnu-social/plugins/Event/EventPlugin.php

437 lines
14 KiB
PHP
Raw Permalink Normal View History

2011-03-08 16:15:17 +00:00
<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2011, StatusNet, Inc.
2011-03-08 16:15:17 +00:00
*
* Microapp plugin for event invitations and RSVPs
2011-03-08 16:15:17 +00:00
*
* PHP version 5
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Event
2011-03-08 16:15:17 +00:00
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2011 StatusNet, Inc.
2011-03-08 16:15:17 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
2011-03-08 16:15:17 +00:00
/**
* Event plugin
2011-03-08 16:15:17 +00:00
*
* @category Event
2011-03-08 16:15:17 +00:00
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2011 StatusNet, Inc.
2011-03-08 16:15:17 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class EventPlugin extends ActivityVerbHandlerPlugin
2011-03-08 16:15:17 +00:00
{
const PLUGIN_VERSION = '2.0.0';
2011-03-08 16:15:17 +00:00
/**
* Set up our tables (event and rsvp)
2011-03-08 16:15:17 +00:00
*
* @see Schema
* @see ColumnDef
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onCheckSchema()
{
$schema = Schema::get();
2011-03-09 07:48:14 +00:00
$schema->ensureTable('happening', Happening::schemaDef());
$schema->ensureTable('rsvp', RSVP::schemaDef());
2011-03-08 16:15:17 +00:00
return true;
}
public function onBeforePluginCheckSchema()
{
RSVP::beforeSchemaUpdate();
return true;
}
2011-03-08 16:15:17 +00:00
/**
* Map URLs to actions
*
* @param URLMapper $m path-to-action mapper
2011-03-08 16:15:17 +00:00
*
* @return boolean hook value; true means continue processing, false means stop.
*/
public function onRouterInitialized(URLMapper $m)
2011-03-08 16:15:17 +00:00
{
$m->connect('main/event/new',
['action' => 'newevent']);
$m->connect('main/event/rsvp',
['action' => 'rsvp']);
2016-01-20 15:10:10 +00:00
$m->connect('main/event/rsvp/:rsvp', // this will probably change to include event notice id
['action' => 'rsvp'],
['rsvp' => '[a-z]+']);
$m->connect('event/:id',
['action' => 'showevent'],
['id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}']);
$m->connect('rsvp/:id',
['action' => 'showrsvp'],
['id' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}']);
Work improving the interface of the Event micro-app Squashed commit of the following: commit da50b6b0223fcbc42cf45d01a138f08930917e71 Author: Zach Copley <zach@status.net> Date: Tue Aug 2 00:35:36 2011 -0700 If end time < start time reset the end time selection commit 6dfc35579e8e4bd0af9d85fc46799bcc462c68b1 Author: Zach Copley <zach@status.net> Date: Mon Aug 1 23:55:10 2011 -0700 Populate event dates with sensible defaults commit 0bc8d726706cfdc0830687e7f40e941e61691191 Author: Zach Copley <zach@status.net> Date: Mon Aug 1 23:29:46 2011 -0700 Recalculate times if user changes start or end date commit 6a92a31429b4eb6f442eaf850d59dcc5b121e57f Author: Zach Copley <zach@status.net> Date: Mon Aug 1 23:03:46 2011 -0700 * Better date/time display * Localize date and time display for user commit 2bf344068a0eb6e3ed90efacbf33c85e7ee5edf7 Author: Zach Copley <zach@status.net> Date: Mon Aug 1 15:56:21 2011 -0700 Reselect the end time after timelist update commit 62fd0620eb5fcc94c240c0fc0b304aa17509de8d Author: Zach Copley <zach@status.net> Date: Mon Aug 1 14:40:14 2011 -0700 Fix bug in which end time was not properly in sync with start time + 30mins commit 3c6bcfb2d962f3677082c468a29480d2a1813d73 Author: Zach Copley <zach@status.net> Date: Mon Aug 1 12:37:00 2011 -0700 Pass exact URL of the timelist action to event.js commit efc74841c5b588cdae686630a1b4c1448e5d742b Author: Zach Copley <zach@status.net> Date: Mon Aug 1 11:20:45 2011 -0700 Add Ajax error handling to new event action commit 3085f4b3ed93bb930bff1bc475309b4d473ffc83 Author: Zach Copley <zach@status.net> Date: Fri Jul 22 01:18:13 2011 -0700 Ajaxify event end-time selector commit 8025c1d368d8f862b666702bfab08daf633a34ea Author: Zach Copley <zach@status.net> Date: Thu Jul 21 21:58:43 2011 -0700 Remove dead code commit 5fbfff47297dea609a07d67a81d430f97f6698ef Merge: bcd845d 3c926af Author: Zach Copley <zach@status.net> Date: Thu Jul 21 15:21:58 2011 -0700 Merge branch 'eventjs' of gitorious.org:~zcopley/statusnet/zcopleys-clone into eventjs * 'eventjs' of gitorious.org:~zcopley/statusnet/zcopleys-clone: Populate timei selection dropdowns and better CSS (thanks Sammy!) Event start/end as dropdowns Nothing to see here move along Don't allow user to set crazy start and end dates New event dates shouldn't ever be in the past, eh? Move event microapp JavaScript into included .js file Conflicts: plugins/Event/event.js plugins/Event/eventform.php commit bcd845dc56c147c4ba10eedd43cc7aa799bc6a9a Author: Zach Copley <zach@status.net> Date: Thu Jul 21 15:11:19 2011 -0700 Move the helper functions for filling the start/end times to their own class commit d246d39c4afbffb1e76cd561ab61f15dafd8a988 Author: Zach Copley <zach@status.net> Date: Wed Jul 20 18:50:38 2011 -0700 Populate time selection dropdowns and better CSS (thanks Sammy!) commit 0778533fef5500db79e40664c5b56aa7d9cc8357 Author: Zach Copley <zach@status.net> Date: Wed Jul 20 15:54:27 2011 -0700 Event start/end as dropdowns commit e800053fdf2cb12fc1f2eac72762d07571647aa8 Author: Zach Copley <zach@status.net> Date: Tue Jul 19 14:12:01 2011 -0700 Nothing to see here move along commit a85949b9cc4f3b5bb387785d4b7a717e9d952752 Author: Zach Copley <zach@status.net> Date: Mon Jul 18 17:48:30 2011 -0700 Don't allow user to set crazy start and end dates commit 87d1301ce8aa8877e753440dd52166bf857b29f3 Author: Zach Copley <zach@status.net> Date: Sun Jul 17 22:31:24 2011 -0700 New event dates shouldn't ever be in the past, eh? commit 7e05aa5fdc02bfec6107bcf8c748627216d51405 Author: Zach Copley <zach@status.net> Date: Fri Jul 15 15:36:17 2011 -0700 Move event microapp JavaScript into included .js file commit 3c926af287f80ee389b5bc8a4c1dcc5e0904a14c Author: Zach Copley <zach@status.net> Date: Wed Jul 20 18:50:38 2011 -0700 Populate time selection dropdowns and better CSS (thanks Sammy!) commit af09c57d5132dba2a6a3e76974e38fdde6422c45 Author: Zach Copley <zach@status.net> Date: Wed Jul 20 15:54:27 2011 -0700 Event start/end as dropdowns commit b585215ed7deb4dc9d4bbc065d36b6e3f819d710 Author: Zach Copley <zach@status.net> Date: Tue Jul 19 14:12:01 2011 -0700 Nothing to see here move along commit e1d30ae9b80eded4ed7ef6bdd7515da64ae344de Author: Zach Copley <zach@status.net> Date: Mon Jul 18 17:48:30 2011 -0700 Don't allow user to set crazy start and end dates commit ad7c99f021980b867f369066b4413bdb1e882986 Author: Zach Copley <zach@status.net> Date: Sun Jul 17 22:31:24 2011 -0700 New event dates shouldn't ever be in the past, eh? commit 4741f0a327e10e67fc04e2b816ed56351e38b4fa Author: Zach Copley <zach@status.net> Date: Fri Jul 15 15:36:17 2011 -0700 Move event microapp JavaScript into included .js file
2011-08-02 09:17:56 +01:00
$m->connect('main/event/updatetimes',
['action' => 'timelist']);
$m->connect(':nickname/events',
['action' => 'events'],
['nickname' => Nickname::DISPLAY_FMT]);
2011-03-08 16:15:17 +00:00
return true;
}
public function onPluginVersion(array &$versions): bool
2011-03-08 16:15:17 +00:00
{
$versions[] = array('name' => 'Event',
'version' => self::PLUGIN_VERSION,
'author' => 'Evan Prodromou',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/Event',
'description' =>
// TRANS: Plugin description.
_m('Event invitations and RSVPs.'));
2011-03-08 16:15:17 +00:00
return true;
}
function appTitle() {
// TRANS: Title for event application.
return _m('TITLE','Event');
}
function tag() {
return 'event';
}
function types() {
return array(Happening::OBJECT_TYPE);
}
function verbs() {
return array(ActivityVerb::POST,
RSVP::POSITIVE,
RSVP::NEGATIVE,
RSVP::POSSIBLE);
}
2016-01-21 01:10:34 +00:00
function isMyNotice(Notice $notice) {
if (!empty($notice->object_type)) {
return parent::isMyNotice($notice);
}
return $this->isMyVerb($notice->verb);
}
public function newFormAction() {
// such as 'newbookmark' or 'newevent' route
return 'new'.$this->tag();
}
function onStartShowEntryForms(&$tabs)
{
$tabs[$this->tag()] = array('title' => $this->appTitle(),
'href' => common_local_url($this->newFormAction()),
);
return true;
}
function onStartMakeEntryForm($tag, $out, &$form)
{
if ($tag == $this->tag()) {
$form = $this->entryForm($out);
return false;
}
return true;
}
protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
{
return $verb;
}
protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
{
return true;
}
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)
{
2016-01-18 22:58:32 +00:00
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 ActivityUtils::compareVerbs($stored->getVerb(), [RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE]):
return RSVP::saveActivityObject($act, $stored);
break;
}
return null;
}
function activityObjectFromNotice(Notice $stored)
{
$happening = null;
2016-01-18 22:58:32 +00:00
switch (true) {
2016-01-21 01:10:34 +00:00
case $stored->isVerb([ActivityVerb::POST]) && $stored->isObjectType([Happening::OBJECT_TYPE]):
$obj = Happening::fromStored($stored)->asActivityObject();
break;
2016-01-21 01:10:34 +00:00
// 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;
2016-01-18 22:58:32 +00:00
default:
// TRANS: Exception thrown when event plugin comes across a unknown object type.
2011-04-01 21:08:38 +01:00
throw new Exception(_m('Unknown object type.'));
}
return $obj;
}
/**
* Form for our app
*
* @param HTMLOutputter $out
* @return Widget
*/
function entryForm($out)
{
return new EventForm($out);
}
2016-01-21 01:10:34 +00:00
function deleteRelated(Notice $stored)
{
2016-01-21 01:10:34 +00:00
switch (true) {
case $stored->isObjectType([Happening::OBJECT_TYPE]):
common_log(LOG_DEBUG, "Deleting event from notice...");
try {
2016-01-21 01:10:34 +00:00
$happening = Happening::fromStored($stored);
$happening->delete();
} catch (NoResultException $e) {
// already gone
}
break;
2016-01-21 01:10:34 +00:00
// 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...");
2016-01-21 01:10:34 +00:00
try {
$rsvp = RSVP::fromStored($stored);
$rsvp->delete();
} catch (NoResultException $e) {
// already gone
}
break;
}
}
2011-03-10 17:25:34 +00:00
function onEndShowScripts($action)
{
2014-06-23 13:18:59 +01:00
$action->script($this->path('js/event.js'));
2011-03-10 17:25:34 +00:00
}
2011-03-16 21:13:34 +00:00
function onEndShowStyles($action)
{
$action->cssLink($this->path('css/event.css'));
2011-03-16 21:13:34 +00:00
return true;
}
2011-04-09 22:11:38 +01:00
2011-04-21 18:37:05 +01:00
function onStartAddNoticeReply($nli, $parent, $child)
2011-04-09 22:11:38 +01:00
{
2011-04-21 18:37:05 +01:00
if (($parent->object_type == Happening::OBJECT_TYPE) &&
in_array($child->object_type, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE))) {
return false;
2011-04-09 22:11:38 +01:00
}
return true;
}
protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
{
2016-01-18 22:58:32 +00:00
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;
2016-01-18 22:58:32 +00:00
case ActivityUtils::compareVerbs($stored->verb, array(RSVP::POSITIVE, RSVP::NEGATIVE, RSVP::POSSIBLE)):
$this->showRSVP($stored, $out, $scoped);
break;
2016-01-18 22:58:32 +00:00
default:
throw new ServerException('This is not an Event notice');
}
2016-01-18 22:58:32 +00:00
return true;
}
protected function showEvent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
{
$profile = $stored->getProfile();
2016-01-18 22:58:32 +00:00
$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) {
2016-01-20 15:10:10 +00:00
$form = new RSVPForm($out, array('event'=>$event, 'scoped'=>$scoped));
$form->show();
}
$out->elementEnd('div');
}
protected function showRSVP(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
{
2016-01-21 01:10:34 +00:00
try {
$rsvp = RSVP::fromStored($stored)->asHTML();
2016-01-21 01:10:34 +00:00
} 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);
$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;
}
2011-03-08 16:15:17 +00:00
}