3 * Data class for event RSVPs
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 event RSVPs
37 * @author Evan Prodromou <evan@status.net>
38 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
39 * @link http://status.net/
41 * @see Managed_DataObject
43 class RSVP extends Managed_DataObject
45 const POSITIVE = 'http://activitystrea.ms/schema/1.0/rsvp-yes';
46 const POSSIBLE = 'http://activitystrea.ms/schema/1.0/rsvp-maybe';
47 const NEGATIVE = 'http://activitystrea.ms/schema/1.0/rsvp-no';
49 public $__table = 'rsvp'; // table name
50 public $id; // varchar(36) UUID
51 public $uri; // varchar(191) not 255 because utf8mb4 takes more space
52 public $profile_id; // int
53 public $event_uri; // varchar(191) not 255 because utf8mb4 takes more space
54 public $response; // tinyint
55 public $created; // datetime
58 * The One True Thingy that must be defined and declared.
60 public static function schemaDef()
63 'description' => 'Plan to attend event',
65 'id' => array('type' => 'char',
68 'description' => 'UUID'),
69 'uri' => array('type' => 'varchar',
72 'profile_id' => array('type' => 'int'),
73 'event_uri' => array('type' => 'varchar',
76 'description' => 'Event URI'),
77 'response' => array('type' => 'char',
79 'description' => 'Y, N, or ? for three-state yes, no, maybe'),
80 'created' => array('type' => 'datetime',
83 'primary key' => array('id'),
84 'unique keys' => array(
85 'rsvp_uri_key' => array('uri'),
86 'rsvp_profile_event_key' => array('profile_id', 'event_uri'),
88 'foreign keys' => array('rsvp_event_uri_key' => array('happening', array('event_uri' => 'uri')),
89 'rsvp_profile_id__key' => array('profile', array('profile_id' => 'id'))),
90 'indexes' => array('rsvp_created_idx' => array('created')),
94 static public function beforeSchemaUpdate()
96 $table = strtolower(get_called_class());
97 $schema = Schema::get();
98 $schemadef = $schema->getTableDef($table);
100 // 2015-12-31 RSVPs refer to Happening by event_uri now, not event_id. Let's migrate!
101 if (isset($schemadef['fields']['event_uri'])) {
102 // We seem to have already migrated, good!
106 // this is a "normal" upgrade from StatusNet for example
107 echo "\nFound old $table table, upgrading it to add 'event_uri' field...";
109 $schemadef['fields']['event_uri'] = array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'Event URI');
110 $schema->ensureTable($table, $schemadef);
114 while ($rsvp->fetch()) {
115 $event = Happening::getKV('id', $rsvp->event_id);
116 if (!$event instanceof Happening) {
120 $orig = clone($rsvp);
121 $rsvp->event_uri = $event->uri;
122 $rsvp->updateWithKeys($orig);
125 print "Resuming core schema upgrade...";
128 function saveNew($profile, $event, $verb, $options=array())
130 $eventNotice = $event->getNotice();
131 $options = array_merge(array('source' => 'web'), $options);
133 $act = new Activity();
134 $act->type = ActivityObject::ACTIVITY;
136 $act->time = $options['created'] ? strtotime($options['created']) : time();
137 $act->title = _m("RSVP");
138 $act->actor = $profile->asActivityObject();
139 $act->target = $eventNotice->asActivityObject();
140 $act->objects = array(clone($act->target));
141 $act->content = RSVP::toHTML($profile, $event, self::codeFor($verb));
143 $act->id = common_local_url('showrsvp', array('id' => UUID::gen()));
144 $act->link = $act->id;
146 $saved = Notice::saveActivity($act, $profile, $options);
151 function saveNewFromNotice($notice, $event, $verb)
153 $other = RSVP::getKV('uri', $notice->uri);
154 if (!empty($other)) {
155 // TRANS: Client exception thrown when trying to save an already existing RSVP ("please respond").
156 throw new ClientException(_m('RSVP already exists.'));
159 $profile = $notice->getProfile();
162 $other = RSVP::getByKeys( [ 'profile_id' => $profile->getID(),
163 'event_uri' => $event->getUri(),
165 // TRANS: Client exception thrown when trying to save an already existing RSVP ("please respond").
166 throw new AlreadyFulfilledException(_m('RSVP already exists.'));
167 } catch (NoResultException $e) {
168 // No previous RSVP, so go ahead and add.
173 preg_match('/\/([^\/]+)\/*/', $notice->uri, $match);
174 $rsvp->id = $match[1] ? $match[1] : UUID::gen();
175 $rsvp->profile_id = $profile->id;
176 $rsvp->event_id = $event->id;
177 $rsvp->response = self::codeFor($verb);
178 $rsvp->created = $notice->created;
179 $rsvp->uri = $notice->uri;
183 self::blow('rsvp:for-event:%s', $event->getUri());
188 function codeFor($verb)
201 // TRANS: Exception thrown when requesting an undefined verb for RSVP.
202 throw new Exception(sprintf(_m('Unknown verb "%s".'),$verb));
206 static function verbFor($code)
210 return RSVP::POSITIVE;
213 return RSVP::NEGATIVE;
216 return RSVP::POSSIBLE;
219 // TRANS: Exception thrown when requesting an undefined code for RSVP.
220 throw new Exception(sprintf(_m('Unknown code "%s".'),$code));
226 $notice = Notice::getKV('uri', $this->uri);
227 if (empty($notice)) {
228 // TRANS: Server exception thrown when requesting a non-exsting notice for an RSVP ("please respond").
229 // TRANS: %s is the RSVP with the missing notice.
230 throw new ServerException(sprintf(_m('RSVP %s does not correspond to a notice in the database.'),$this->id));
235 static function fromNotice(Notice $notice)
238 $rsvp->uri = $notice->uri;
239 if (!$rsvp->find(true)) {
240 throw new NoResultException($rsvp);
245 static function forEvent(Happening $event)
247 $keypart = sprintf('rsvp:for-event:%s', $event->getUri());
249 $idstr = self::cacheGet($keypart);
251 if ($idstr !== false) {
252 $ids = explode(',', $idstr);
259 $rsvp->selectAdd('id');
261 $rsvp->event_uri = $event->getUri();
264 while ($rsvp->fetch()) {
268 self::cacheSet($keypart, implode(',', $ids));
271 $rsvps = array(RSVP::POSITIVE => array(),
272 RSVP::NEGATIVE => array(),
273 RSVP::POSSIBLE => array());
275 foreach ($ids as $id) {
276 $rsvp = RSVP::getKV('id', $id);
278 $verb = self::verbFor($rsvp->response);
279 $rsvps[$verb][] = $rsvp;
286 function getProfile()
288 $profile = Profile::getKV('id', $this->profile_id);
289 if (empty($profile)) {
290 // TRANS: Exception thrown when requesting a non-existing profile.
291 // TRANS: %s is the ID of the non-existing profile.
292 throw new Exception(sprintf(_m('No profile with ID %s.'),$this->profile_id));
299 $event = Happening::getKV('uri', $this->event_uri);
301 // TRANS: Exception thrown when requesting a non-existing event.
302 // TRANS: %s is the ID of the non-existing event.
303 throw new Exception(sprintf(_m('No event with URI %s.'),$this->event_uri));
310 return self::toHTML($this->getProfile(),
317 return self::toString($this->getProfile(),
322 static function toHTML($profile, $event, $response)
328 // TRANS: HTML version of an RSVP ("please respond") status for a user.
329 // TRANS: %1$s is a profile URL, %2$s a profile name,
330 // TRANS: %3$s is an event URL, %4$s an event title.
331 $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> is attending <a href='%3\$s'>%4\$s</a>.</span>");
334 // TRANS: HTML version of an RSVP ("please respond") status for a user.
335 // TRANS: %1$s is a profile URL, %2$s a profile name,
336 // TRANS: %3$s is an event URL, %4$s an event title.
337 $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> is not attending <a href='%3\$s'>%4\$s</a>.</span>");
340 // TRANS: HTML version of an RSVP ("please respond") status for a user.
341 // TRANS: %1$s is a profile URL, %2$s a profile name,
342 // TRANS: %3$s is an event URL, %4$s an event title.
343 $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> might attend <a href='%3\$s'>%4\$s</a>.</span>");
346 // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
347 // TRANS: %s is the non-existing response code.
348 throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
353 // TRANS: Used as event title when not event title is available.
354 // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
355 $eventTitle = _m('an unknown event');
357 $notice = $event->getNotice();
358 $eventUrl = $notice->getUrl();
359 $eventTitle = $event->title;
363 htmlspecialchars($profile->profileurl),
364 htmlspecialchars($profile->getBestName()),
365 htmlspecialchars($eventUrl),
366 htmlspecialchars($eventTitle));
369 static function toString($profile, $event, $response)
375 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
376 // TRANS: %1$s is a profile name, %2$s is an event title.
377 $fmt = _m('%1$s is attending %2$s.');
380 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
381 // TRANS: %1$s is a profile name, %2$s is an event title.
382 $fmt = _m('%1$s is not attending %2$s.');
385 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
386 // TRANS: %1$s is a profile name, %2$s is an event title.
387 $fmt = _m('%1$s might attend %2$s.');
390 // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
391 // TRANS: %s is the non-existing response code.
392 throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
397 // TRANS: Used as event title when not event title is available.
398 // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
399 $eventTitle = _m('an unknown event');
401 $notice = $event->getNotice();
402 $eventTitle = $event->title;
406 $profile->getBestName(),
410 function delete($useWhere=false)
412 self::blow('rsvp:for-event:%s', $this->id);
413 return parent::delete($useWhere);