gnu-social/plugins/Event/EventPlugin.php
Zach Copley 60a574ef28 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 01:17:56 -07:00

371 lines
11 KiB
PHP

<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2011, StatusNet, Inc.
*
* Microapp plugin for event invitations and RSVPs
*
* 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
* @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/
*/
if (!defined('STATUSNET')) {
// This check helps protect against security problems;
// your code file can't be executed directly from the web.
exit(1);
}
/**
* Event plugin
*
* @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
{
/**
* Set up our tables (event and rsvp)
*
* @see Schema
* @see ColumnDef
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('happening', Happening::schemaDef());
$schema->ensureTable('rsvp', RSVP::schemaDef());
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':
case 'TimelistAction':
include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
return false;
case 'EventListItem':
case 'RSVPListItem':
case 'EventForm':
case 'RSVPForm':
case 'CancelRSVPForm':
case 'EventTimeList':
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
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onRouterInitialized($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'));
$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}'));
$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)
{
$versions[] = array('name' => 'Event',
'version' => STATUSNET_VERSION,
'author' => 'Evan Prodromou',
'homepage' => 'http://status.net/wiki/Plugin:Event',
'description' =>
// TRANS: Plugin description.
_m('Event invitations and RSVPs.'));
return true;
}
function appTitle() {
// TRANS: Title for event application.
return _m('TITLE','Event');
}
function tag() {
return 'event';
}
function types() {
return array(Happening::OBJECT_TYPE,
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, $actor, $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::staticGet('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.'));
}
return $notice;
}
/**
* Turn a Notice into an activity object
*
* @param Notice $notice
*
* @return ActivityObject
*/
function activityObjectFromNotice($notice)
{
$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();
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->bestUrl();
// 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));
// FIXME: add location
// FIXME: add URL
// XXX: probably need other stuff here
return $obj;
}
/**
* 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;
break;
}
return true;
}
function adaptNoticeListItem($nli)
{
$notice = $nli->notice;
switch ($notice->object_type) {
case Happening::OBJECT_TYPE:
return new EventListItem($nli);
break;
case RSVP::POSITIVE:
case RSVP::NEGATIVE:
case RSVP::POSSIBLE:
return new RSVPListItem($nli);
break;
}
return null;
}
/**
* Form for our app
*
* @param HTMLOutputter $out
* @return Widget
*/
function entryForm($out)
{
return new EventForm($out);
}
/**
* 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...");
}
}
function onEndShowScripts($action)
{
$action->script($this->path('event.js'));
}
function onEndShowStyles($action)
{
$action->cssLink($this->path('event.css'));
return true;
}
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;
}
}