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 static function saveActivityObject(Activity $act, Notice $stored)
130 $target = Notice::getByKeys(array('uri'=>$act->target->id));
131 common_debug('TARGET:'._ve($target));
132 if (!ActivityUtils::compareTypes($target->getObjectType(), [ Happening::OBJECT_TYPE ])) {
133 throw new ClientException('RSVP not aimed at a Happening');
136 // FIXME: Maybe we need some permission handling here, though I think it's taken care of in saveActivity?
139 $other = RSVP::getByKeys( [ 'profile_id' => $stored->getProfile()->getID(),
140 'event_uri' => $target->getUri(),
142 // TRANS: Client exception thrown when trying to save an already existing RSVP ("please respond").
143 throw new AlreadyFulfilledException(_m('RSVP already exists.'));
144 } catch (NoResultException $e) {
145 // No previous RSVP, so go ahead and add.
149 $rsvp->id = UUID::gen(); // remove this
150 $rsvp->uri = $stored->getUri();
151 $rsvp->profile_id = $stored->getProfile()->getID();
152 $rsvp->event_uri = $target->getUri();
153 $rsvp->response = self::codeFor($stored->getVerb());
154 $rsvp->created = $stored->getCreated();
158 self::blow('rsvp:for-event:%s', $target->getUri());
163 static public function getObjectType()
165 return ActivityObject::ACTIVITY;
168 public function asActivityObject()
170 $happening = $this->getEvent();
172 $actobj = new ActivityObject();
173 $actobj->id = $this->getUri();
174 $actobj->type = self::getObjectType();
175 $actobj->title = $this->asString();
176 $actobj->content = $this->asString();
177 $actobj->target = array($happening->asActivityObject());
182 static function codeFor($verb)
185 case ActivityUtils::compareVerbs($verb, [RSVP::POSITIVE]):
188 case ActivityUtils::compareVerbs($verb, [RSVP::NEGATIVE]):
191 case ActivityUtils::compareVerbs($verb, [RSVP::POSSIBLE]):
195 // TRANS: Exception thrown when requesting an undefined verb for RSVP.
196 throw new Exception(sprintf(_m('Unknown verb "%s".'),$verb));
200 static function verbFor($code)
205 return RSVP::POSITIVE;
209 return RSVP::NEGATIVE;
213 return RSVP::POSSIBLE;
216 // TRANS: Exception thrown when requesting an undefined code for RSVP.
217 throw new ClientException(sprintf(_m('Unknown code "%s".'), $code));
221 public function getUri()
226 public function getEventUri()
228 return $this->event_uri;
231 public function getStored()
233 return Notice::getByKeys(['uri' => $this->getUri()]);
236 static function fromStored(Notice $stored)
238 return self::getByKeys(['uri' => $stored->getUri()]);
241 static function byEventAndActor(Happening $event, Profile $actor)
243 return self::getByKeys(['event_uri' => $event->getUri(),
244 'profile_id' => $actor->getID()]);
247 static function forEvent(Happening $event)
249 $keypart = sprintf('rsvp:for-event:%s', $event->getUri());
251 $idstr = self::cacheGet($keypart);
253 if ($idstr !== false) {
254 $ids = explode(',', $idstr);
261 $rsvp->selectAdd('id');
263 $rsvp->event_uri = $event->getUri();
266 while ($rsvp->fetch()) {
270 self::cacheSet($keypart, implode(',', $ids));
273 $rsvps = array(RSVP::POSITIVE => array(),
274 RSVP::NEGATIVE => array(),
275 RSVP::POSSIBLE => array());
277 foreach ($ids as $id) {
278 $rsvp = RSVP::getKV('id', $id);
280 $verb = self::verbFor($rsvp->response);
281 $rsvps[$verb][] = $rsvp;
288 function getProfile()
290 return Profile::getByID($this->profile_id);
295 return Happening::getByKeys(['uri' => $this->getEventUri()]);
300 return self::toHTML($this->getProfile(),
307 return self::toString($this->getProfile(),
312 static function toHTML(Profile $profile, Happening $event, $response)
318 // TRANS: HTML version of an RSVP ("please respond") status for a user.
319 // TRANS: %1$s is a profile URL, %2$s a profile name,
320 // TRANS: %3$s is an event URL, %4$s an event title.
321 $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> is attending <a href='%3\$s'>%4\$s</a>.</span>");
324 // TRANS: HTML version of an RSVP ("please respond") status for a user.
325 // TRANS: %1$s is a profile URL, %2$s a profile name,
326 // TRANS: %3$s is an event URL, %4$s an event title.
327 $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>");
330 // TRANS: HTML version of an RSVP ("please respond") status for a user.
331 // TRANS: %1$s is a profile URL, %2$s a profile name,
332 // TRANS: %3$s is an event URL, %4$s an event title.
333 $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> might attend <a href='%3\$s'>%4\$s</a>.</span>");
336 // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
337 // TRANS: %s is the non-existing response code.
338 throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
343 // TRANS: Used as event title when not event title is available.
344 // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
345 $eventTitle = _m('an unknown event');
347 $eventUrl = $event->getStored()->getUrl();
348 $eventTitle = $event->title;
352 htmlspecialchars($profile->getUrl()),
353 htmlspecialchars($profile->getBestName()),
354 htmlspecialchars($eventUrl),
355 htmlspecialchars($eventTitle));
358 static function toString($profile, $event, $response)
364 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
365 // TRANS: %1$s is a profile name, %2$s is an event title.
366 $fmt = _m('%1$s is attending %2$s.');
369 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
370 // TRANS: %1$s is a profile name, %2$s is an event title.
371 $fmt = _m('%1$s is not attending %2$s.');
374 // TRANS: Plain text version of an RSVP ("please respond") status for a user.
375 // TRANS: %1$s is a profile name, %2$s is an event title.
376 $fmt = _m('%1$s might attend %2$s.');
379 // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
380 // TRANS: %s is the non-existing response code.
381 throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
386 // TRANS: Used as event title when not event title is available.
387 // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
388 $eventTitle = _m('an unknown event');
390 $eventTitle = $event->title;
394 $profile->getBestName(),
398 public function delete($useWhere=false)
400 self::blow('rsvp:for-event:%s', $this->id);
401 return parent::delete($useWhere);
404 public function insert()
406 $result = parent::insert();
407 if ($result === false) {
408 common_log_db_error($this, 'INSERT', __FILE__);
409 throw new ServerException(_('Failed to insert '._ve(get_called_class()).' into database'));