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('STATUSNET')) {
35 * Data class for event RSVPs
39 * @author Evan Prodromou <evan@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41 * @link http://status.net/
43 * @see Managed_DataObject
46 class RSVP extends Managed_DataObject
48 const POSITIVE = 'http://activitystrea.ms/schema/1.0/rsvp-yes';
49 const POSSIBLE = 'http://activitystrea.ms/schema/1.0/rsvp-maybe';
50 const NEGATIVE = 'http://activitystrea.ms/schema/1.0/rsvp-no';
52 public $__table = 'rsvp'; // table name
53 public $id; // varchar(36) UUID
54 public $uri; // varchar(255)
55 public $profile_id; // int
56 public $event_id; // varchar(36) UUID
57 public $response; // tinyint
58 public $created; // datetime
61 * Get an instance by key
63 * @param string $k Key to use to lookup (usually 'id' for this class)
64 * @param mixed $v Value to lookup
66 * @return RSVP object found, or null for no hits
69 function staticGet($k, $v=null)
71 return Memcached_DataObject::staticGet('RSVP', $k, $v);
75 * Get an instance by compound key
77 * @param array $kv array of key-value mappings
79 * @return Bookmark object found, or null for no hits
85 return Memcached_DataObject::pkeyGet('RSVP', $kv);
89 * Add the compound profile_id/event_id index to our cache keys
90 * since the DB_DataObject stuff doesn't understand compound keys
91 * except for the primary.
95 function _allCacheKeys() {
96 $keys = parent::_allCacheKeys();
97 $keys[] = self::multicacheKey('RSVP', array('profile_id' => $this->profile_id,
98 'event_id' => $this->event_id));
103 * The One True Thingy that must be defined and declared.
105 public static function schemaDef()
108 'description' => 'Plan to attend event',
110 'id' => array('type' => 'char',
113 'description' => 'UUID'),
114 'uri' => array('type' => 'varchar',
117 'profile_id' => array('type' => 'int'),
118 'event_id' => array('type' => 'char',
121 'description' => 'UUID'),
122 'response' => array('type' => 'char',
124 'description' => 'Y, N, or ? for three-state yes, no, maybe'),
125 'created' => array('type' => 'datetime',
128 'primary key' => array('id'),
129 'unique keys' => array(
130 'rsvp_uri_key' => array('uri'),
131 'rsvp_profile_event_key' => array('profile_id', 'event_id'),
133 'foreign keys' => array('rsvp_event_id_key' => array('event', array('event_id' => 'id')),
134 'rsvp_profile_id__key' => array('profile', array('profile_id' => 'id'))),
135 'indexes' => array('rsvp_created_idx' => array('created')),
139 function saveNew($profile, $event, $verb, $options=array())
141 common_debug("RSVP::saveNew({$profile->id}, {$event->id}, '$verb', 'some options');");
143 if (array_key_exists('uri', $options)) {
144 $other = RSVP::staticGet('uri', $options['uri']);
145 if (!empty($other)) {
146 throw new ClientException(_m('RSVP already exists.'));
150 $other = RSVP::pkeyGet(array('profile_id' => $profile->id,
151 'event_id' => $event->id));
153 if (!empty($other)) {
154 throw new ClientException(_m('RSVP already exists.'));
159 $rsvp->id = UUID::gen();
160 $rsvp->profile_id = $profile->id;
161 $rsvp->event_id = $event->id;
162 $rsvp->response = self::codeFor($verb);
164 common_debug("Got value {$rsvp->response} for verb {$verb}");
166 if (array_key_exists('created', $options)) {
167 $rsvp->created = $options['created'];
169 $rsvp->created = common_sql_now();
172 if (array_key_exists('uri', $options)) {
173 $rsvp->uri = $options['uri'];
175 $rsvp->uri = common_local_url('showrsvp',
176 array('id' => $rsvp->id));
181 // XXX: come up with something sexier
183 $content = $rsvp->asString();
185 $rendered = $rsvp->asHTML();
187 $options = array_merge(array('object_type' => $verb),
190 if (!array_key_exists('uri', $options)) {
191 $options['uri'] = $rsvp->uri;
194 $eventNotice = $event->getNotice();
196 if (!empty($eventNotice)) {
197 $options['reply_to'] = $eventNotice->id;
200 $saved = Notice::saveNew($profile->id,
202 array_key_exists('source', $options) ?
203 $options['source'] : 'web',
209 function codeFor($verb)
222 throw new Exception("Unknown verb {$verb}");
226 static function verbFor($code)
230 return RSVP::POSITIVE;
233 return RSVP::NEGATIVE;
236 return RSVP::POSSIBLE;
239 throw new Exception("Unknown code {$code}");
245 $notice = Notice::staticGet('uri', $this->uri);
246 if (empty($notice)) {
247 throw new ServerException("RSVP {$this->id} does not correspond to a notice in the DB.");
252 static function fromNotice($notice)
254 return RSVP::staticGet('uri', $notice->uri);
257 static function forEvent($event)
259 $rsvps = array(RSVP::POSITIVE => array(),
260 RSVP::NEGATIVE => array(),
261 RSVP::POSSIBLE => array());
265 $rsvp->event_id = $event->id;
268 while ($rsvp->fetch()) {
269 $verb = self::verbFor($rsvp->response);
270 $rsvps[$verb][] = clone($rsvp);
277 function getProfile()
279 $profile = Profile::staticGet('id', $this->profile_id);
280 if (empty($profile)) {
281 throw new Exception("No profile with ID {$this->profile_id}");
288 $event = Happening::staticGet('id', $this->event_id);
290 throw new Exception("No event with ID {$this->event_id}");
297 $event = Happening::staticGet('id', $this->event_id);
299 return self::toHTML($this->getProfile(),
306 $event = Happening::staticGet('id', $this->event_id);
308 return self::toString($this->getProfile(),
313 static function toHTML($profile, $event, $response)
319 $fmt = _m("<span class='automatic event-rsvp'><a href='%1s'>%2s</a> is attending <a href='%3s'>%4s</a>.</span>");
322 $fmt = _m("<span class='automatic event-rsvp'><a href='%1s'>%2s</a> is not attending <a href='%3s'>%4s</a>.</span>");
325 $fmt = _m("<span class='automatic event-rsvp'><a href='%1s'>%2s</a> might attend <a href='%3s'>%4s</a>.</span>");
328 throw new Exception("Unknown response code {$response}");
334 $eventTitle = _m('an unknown event');
336 $notice = $event->getNotice();
337 $eventUrl = $notice->bestUrl();
338 $eventTitle = $event->title;
342 htmlspecialchars($profile->profileurl),
343 htmlspecialchars($profile->getBestName()),
344 htmlspecialchars($eventUrl),
345 htmlspecialchars($eventTitle));
348 static function toString($profile, $event, $response)
354 $fmt = _m("%1s is attending %2s.");
357 $fmt = _m("%1s is not attending %2s.");
360 $fmt = _m("%1s might attend %2s.>");
363 throw new Exception("Unknown response code {$response}");
368 $eventTitle = _m('an unknown event');
370 $notice = $event->getNotice();
371 $eventTitle = $event->title;
375 $profile->getBestName(),