forked from GNUsocial/gnu-social
286 lines
11 KiB
PHP
286 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Data class for happenings
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category Data
|
|
* @package StatusNet
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2011, StatusNet, Inc.
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
if (!defined('GNUSOCIAL')) { exit(1); }
|
|
|
|
/**
|
|
* Data class for happenings
|
|
*
|
|
* There's already an Event class in lib/event.php, so we couldn't
|
|
* call this an Event without causing a hole in space-time.
|
|
*
|
|
* "Happening" seemed good enough.
|
|
*
|
|
* @category Event
|
|
* @package StatusNet
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* @see Managed_DataObject
|
|
*/
|
|
class Happening extends Managed_DataObject
|
|
{
|
|
const OBJECT_TYPE = 'http://activitystrea.ms/schema/1.0/event';
|
|
|
|
public $__table = 'happening'; // table name
|
|
public $id; // varchar(36) UUID
|
|
public $uri; // varchar(191) not 255 because utf8mb4 takes more space
|
|
public $profile_id; // int
|
|
public $start_time; // datetime
|
|
public $end_time; // datetime
|
|
public $title; // varchar(191) not 255 because utf8mb4 takes more space
|
|
public $location; // varchar(191) not 255 because utf8mb4 takes more space
|
|
public $url; // varchar(191) not 255 because utf8mb4 takes more space
|
|
public $description; // text
|
|
public $created; // datetime
|
|
|
|
/**
|
|
* The One True Thingy that must be defined and declared.
|
|
*/
|
|
public static function schemaDef()
|
|
{
|
|
return array(
|
|
'description' => 'A real-world happening',
|
|
'fields' => array(
|
|
'id' => array('type' => 'char',
|
|
'length' => 36,
|
|
'not null' => true,
|
|
'description' => 'UUID'),
|
|
'uri' => array('type' => 'varchar',
|
|
'length' => 191,
|
|
'not null' => true),
|
|
'profile_id' => array('type' => 'int', 'not null' => true),
|
|
'start_time' => array('type' => 'datetime', 'not null' => true),
|
|
'end_time' => array('type' => 'datetime', 'not null' => true),
|
|
'title' => array('type' => 'varchar',
|
|
'length' => 191,
|
|
'not null' => true),
|
|
'location' => array('type' => 'varchar',
|
|
'length' => 191),
|
|
'url' => array('type' => 'varchar',
|
|
'length' => 191),
|
|
'description' => array('type' => 'text'),
|
|
'created' => array('type' => 'datetime',
|
|
'not null' => true),
|
|
),
|
|
'primary key' => array('id'),
|
|
'unique keys' => array(
|
|
'happening_uri_key' => array('uri'),
|
|
),
|
|
'foreign keys' => array('happening_profile_id__key' => array('profile', array('profile_id' => 'id'))),
|
|
'indexes' => array('happening_created_idx' => array('created'),
|
|
'happening_start_end_idx' => array('start_time', 'end_time')),
|
|
);
|
|
}
|
|
|
|
static function saveNew(Profile $profile, $start_time, $end_time, $title, $location, $description, $url, $options=array())
|
|
{
|
|
if (array_key_exists('uri', $options)) {
|
|
$other = Happening::getKV('uri', $options['uri']);
|
|
if ($other instanceof Happening) {
|
|
// TRANS: Client exception thrown when trying to create an event that already exists.
|
|
throw new ClientException(_m('Event already exists.'));
|
|
}
|
|
}
|
|
|
|
$ev = new Happening();
|
|
|
|
$ev->id = UUID::gen();
|
|
$ev->profile_id = $profile->getID();
|
|
$ev->start_time = $start_time;
|
|
$ev->end_time = $end_time;
|
|
$ev->title = $title;
|
|
$ev->location = $location;
|
|
$ev->description = $description;
|
|
$ev->url = $url;
|
|
|
|
if (array_key_exists('created', $options)) {
|
|
$ev->created = $options['created'];
|
|
} else {
|
|
$ev->created = common_sql_now();
|
|
}
|
|
|
|
if (array_key_exists('uri', $options)) {
|
|
$ev->uri = $options['uri'];
|
|
} else {
|
|
$ev->uri = common_local_url('showevent',
|
|
array('id' => $ev->id));
|
|
}
|
|
|
|
$ev->insert();
|
|
|
|
// XXX: does this get truncated?
|
|
|
|
// TRANS: Event description. %1$s is a title, %2$s is start time, %3$s is end time,
|
|
// TRANS: %4$s is location, %5$s is a description.
|
|
$content = sprintf(_m('"%1$s" %2$s - %3$s (%4$s): %5$s'),
|
|
$title,
|
|
common_exact_date($ev->start_time),
|
|
common_exact_date($ev->end_time),
|
|
$location,
|
|
$description);
|
|
|
|
// TRANS: Rendered microformats2 tagged event description.
|
|
// TRANS: %1$s is a title, %2$s is start time, %3$s is start time,
|
|
// TRANS: %4$s is end time, %5$s is end time, %6$s is location, %7$s is description.
|
|
// TRANS: Class names should not be translated.
|
|
$rendered = sprintf(_m('<div class="h-event">'.
|
|
'<p class="p-name p-summary">%1$s</p> '.
|
|
'<time class="dt-start" datetime="%2$s">%3$s</time> - '.
|
|
'<time class="dt-end" datetime="%4$s">%5$s</time> '.
|
|
'(<span class="p-location">%6$s</span>): '.
|
|
'<div class="p-description">%7$s</div> '.
|
|
'</div>'),
|
|
htmlspecialchars($title),
|
|
htmlspecialchars(common_date_iso8601($ev->start_time)),
|
|
htmlspecialchars(common_exact_date($ev->start_time)),
|
|
htmlspecialchars(common_date_iso8601($ev->end_time)),
|
|
htmlspecialchars(common_exact_date($ev->end_time)),
|
|
htmlspecialchars($location),
|
|
htmlspecialchars($description));
|
|
|
|
$options = array_merge(array('object_type' => Happening::OBJECT_TYPE),
|
|
$options);
|
|
|
|
if (!array_key_exists('uri', $options)) {
|
|
$options['uri'] = $ev->getUri();
|
|
}
|
|
|
|
if (!empty($url)) {
|
|
$options['urls'] = array($url);
|
|
}
|
|
|
|
$saved = Notice::saveNew($profile->getID(),
|
|
$content,
|
|
array_key_exists('source', $options) ?
|
|
$options['source'] : 'web',
|
|
$options);
|
|
|
|
return $saved;
|
|
}
|
|
|
|
public function saveActivityObject(ActivityObject $actobj, Profile $stored)
|
|
{
|
|
$other = Happening::getKV('uri', $actobj->id);
|
|
if ($other instanceof Happening) {
|
|
// TRANS: Client exception thrown when trying to create an event that already exists.
|
|
throw new ClientException(_m('Event already exists.'));
|
|
}
|
|
|
|
$dtstart = $actobj->element->getElementsByTagName('dtstart');
|
|
if($dtstart->length == 0) {
|
|
// TRANS: Exception thrown when has no start date
|
|
throw new Exception(_m('No start date for event.'));
|
|
}
|
|
$dtend = $actobj->element->getElementsByTagName('dtend');
|
|
if($dtend->length == 0) {
|
|
// TRANS: Exception thrown when has no end date
|
|
throw new Exception(_m('No end date for event.'));
|
|
}
|
|
|
|
// 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;
|
|
}
|
|
|
|
// url is optional
|
|
$url = null;
|
|
$url_object = $happeningObj->element->getElementsByTagName('url');
|
|
if($url_object->length > 0) {
|
|
$url = $url_object->item(0)->nodeValue;
|
|
}
|
|
|
|
$ev = new Happening();
|
|
|
|
$ev->id = UUID::gen();
|
|
$ev->uri = $actobj->uri;
|
|
$ev->profile_id = $stored->getProfile()->getID();
|
|
$ev->start_time = $start_time;
|
|
$ev->end_time = $end_time;
|
|
$ev->title = $actobj->title;
|
|
$ev->location = $location;
|
|
$ev->description = $actobj->summary;
|
|
$ev->url = $url;
|
|
$ev->created = $stored->getCreated();
|
|
|
|
$ev->insert();
|
|
}
|
|
|
|
/**
|
|
* Returns the profile's canonical url, not necessarily a uri/unique id
|
|
*
|
|
* @return string $url
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
if (empty($this->url) ||
|
|
!filter_var($this->url, FILTER_VALIDATE_URL)) {
|
|
throw new InvalidUrlException($this->url);
|
|
}
|
|
return $this->url;
|
|
}
|
|
|
|
public function getUri()
|
|
{
|
|
return $this->uri;
|
|
}
|
|
|
|
function getNotice()
|
|
{
|
|
return Notice::getKV('uri', $this->getUri());
|
|
}
|
|
|
|
static function fromNotice($notice)
|
|
{
|
|
return Happening::getKV('uri', $notice->getUri());
|
|
}
|
|
|
|
function getRSVPs()
|
|
{
|
|
return RSVP::forEvent($this);
|
|
}
|
|
|
|
function getRSVP($profile)
|
|
{
|
|
return RSVP::pkeyGet(array('profile_id' => $profile->getID(),
|
|
'event_uri' => $this->getUri()));
|
|
}
|
|
}
|