3 * Data class for happenings
9 * @author Evan Prodromou <evan@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2011, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('GNUSOCIAL')) { exit(1); }
33 * Data class for happenings
35 * There's already an Event class in lib/event.php, so we couldn't
36 * call this an Event without causing a hole in space-time.
38 * "Happening" seemed good enough.
42 * @author Evan Prodromou <evan@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
44 * @link http://status.net/
46 * @see Managed_DataObject
48 class Happening extends Managed_DataObject
50 const OBJECT_TYPE = 'http://activitystrea.ms/schema/1.0/event';
52 public $__table = 'happening'; // table name
53 public $id; // varchar(36) UUID
54 public $uri; // varchar(191) not 255 because utf8mb4 takes more space
55 public $profile_id; // int
56 public $start_time; // datetime
57 public $end_time; // datetime
58 public $title; // varchar(191) not 255 because utf8mb4 takes more space
59 public $location; // varchar(191) not 255 because utf8mb4 takes more space
60 public $url; // varchar(191) not 255 because utf8mb4 takes more space
61 public $description; // text
62 public $created; // datetime
65 * The One True Thingy that must be defined and declared.
67 public static function schemaDef()
70 'description' => 'A real-world happening',
72 'id' => array('type' => 'char',
75 'description' => 'UUID'),
76 'uri' => array('type' => 'varchar',
79 'profile_id' => array('type' => 'int', 'not null' => true),
80 'start_time' => array('type' => 'datetime', 'not null' => true),
81 'end_time' => array('type' => 'datetime', 'not null' => true),
82 'title' => array('type' => 'varchar',
85 'location' => array('type' => 'varchar',
87 'url' => array('type' => 'varchar',
89 'description' => array('type' => 'text'),
90 'created' => array('type' => 'datetime',
93 'primary key' => array('id'),
94 'unique keys' => array(
95 'happening_uri_key' => array('uri'),
97 'foreign keys' => array('happening_profile_id__key' => array('profile', array('profile_id' => 'id')),
98 'happening_uri__key' => array('notice', array('uri' => 'uri'))),
99 'indexes' => array('happening_created_idx' => array('created'),
100 'happening_start_end_idx' => array('start_time', 'end_time')),
104 public static function saveActivityObject(Activity $act, Notice $stored)
106 if (count($act->objects) !== 1) {
107 // TRANS: Exception thrown when there are too many activity objects.
108 throw new Exception(_m('Too many activity objects.'));
110 $actobj = $act->objects[0];
111 if (!ActivityUtils::compareTypes($actobj->type, [Happening::OBJECT_TYPE])) {
112 // TRANS: Exception thrown when event plugin comes across a non-event type object.
113 throw new Exception(_m('Wrong type for object.'));
117 $other = Happening::getByKeys(['uri' => $actobj->id]);
118 throw AlreadyFulfilledException('Happening already exists.');
119 } catch (NoResultException $e) {
120 // alright, let's save this
128 foreach ($actobj->extra as $extra) {
131 $dtstart = $extra[2];
136 // location is optional
137 $location = $extra[2];
144 if(empty($dtstart)) {
145 // TRANS: Exception thrown when has no start date
146 throw new Exception(_m('No start date for event.'));
149 // TRANS: Exception thrown when has no end date
150 throw new Exception(_m('No end date for event.'));
153 // convert RFC3339 dates delivered in Activity Stream to MySQL DATETIME date format
154 $start_time = new DateTime($dtstart);
155 $start_time->setTimezone(new DateTimeZone('UTC'));
156 $start_time = $start_time->format('Y-m-d H:i:s');
157 $end_time = new DateTime($dtend);
158 $end_time->setTimezone(new DateTimeZone('UTC'));
159 $end_time = $end_time->format('Y-m-d H:i:s');
161 $ev = new Happening();
163 $ev->id = UUID::gen();
164 $ev->uri = $actobj->id;
165 $ev->profile_id = $stored->getProfile()->getID();
166 $ev->start_time = $start_time;
167 $ev->end_time = $end_time;
168 $ev->title = $actobj->title;
169 $ev->location = $location;
170 $ev->description = $stored->getContent();
172 $ev->created = $stored->getCreated();
178 public function insert()
180 $result = parent::insert();
181 if ($result === false) {
182 common_log_db_error($this, 'INSERT', __FILE__);
183 throw new ServerException(_('Failed to insert '._ve(get_called_class()).' into database'));
189 * Returns the profile's canonical url, not necessarily a uri/unique id
191 * @return string $url
193 public function getUrl()
195 if (empty($this->url) ||
196 !filter_var($this->url, FILTER_VALIDATE_URL)) {
197 throw new InvalidUrlException($this->url);
202 public function getUri()
207 public function getStored()
209 return Notice::getByKeys(array('uri'=>$this->getUri()));
212 static function fromStored(Notice $stored)
214 return self::getByKeys(array('uri'=>$stored->getUri()));
219 return RSVP::forEvent($this);
222 function getRSVP($profile)
224 return RSVP::pkeyGet(array('profile_id' => $profile->getID(),
225 'event_uri' => $this->getUri()));