plugins/Event/classes/RSVP.php

   1 <?php
   2 /**
   3  * Data class for event RSVPs
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2011, StatusNet, Inc.
  15  *
  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.
  20  *
  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.
  25  *
  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/>.
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * Data class for event RSVPs
  34  *
  35  * @category Event
  36  * @package  StatusNet
  37  * @author   Evan Prodromou <evan@status.net>
  38  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  39  * @link     http://status.net/
  40  *
  41  * @see      Managed_DataObject
  42  */
  43 class RSVP extends Managed_DataObject
  44 {
  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';
  48
  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
  56
  57     /**
  58      * The One True Thingy that must be defined and declared.
  59      */
  60     public static function schemaDef()
  61     {
  62         return array(
  63             'description' => 'Plan to attend event',
  64             'fields' => array(
  65                 'id' => array('type' => 'char',
  66                               'length' => 36,
  67                               'not null' => true,
  68                               'description' => 'UUID'),
  69                 'uri' => array('type' => 'varchar',
  70                                'length' => 191,
  71                                'not null' => true),
  72                 'profile_id' => array('type' => 'int'),
  73                 'event_uri' => array('type' => 'varchar',
  74                               'length' => 191,
  75                               'not null' => true,
  76                               'description' => 'Event URI'),
  77                 'response' => array('type' => 'char',
  78                                   'length' => '1',
  79                                   'description' => 'Y, N, or ? for three-state yes, no, maybe'),
  80                 'created' => array('type' => 'datetime',
  81                                    'not null' => true),
  82             ),
  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'),
  87             ),
  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')),
  91         );
  92     }
  93
  94     static public function beforeSchemaUpdate()
  95     {
  96         $table = strtolower(get_called_class());
  97         $schema = Schema::get();
  98         $schemadef = $schema->getTableDef($table);
  99
 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!
 103             return;
 104         }
 105
 106         // this is a "normal" upgrade from StatusNet for example
 107         echo "\nFound old $table table, upgrading it to add 'event_uri' field...";
 108
 109         $schemadef['fields']['event_uri'] = array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'Event URI');
 110         $schema->ensureTable($table, $schemadef);
 111
 112         $rsvp = new RSVP();
 113         $rsvp->find();
 114         while ($rsvp->fetch()) {
 115             $event = Happening::getKV('id', $rsvp->event_id);
 116             if (!$event instanceof Happening) {
 117                 $rsvp->delete();
 118                 continue;
 119             }
 120             $orig = clone($rsvp);
 121             $rsvp->event_uri = $event->uri;
 122             $rsvp->updateWithKeys($orig);
 123         }
 124         print "DONE.\n";
 125         print "Resuming core schema upgrade...";
 126     }
 127
 128     static function saveActivityObject(Activity $act, Notice $stored)
 129     {
 130         $target = Notice::getByKeys(array('uri'=>$act->target->id));
 131         if (!ActivityUtils::compareTypes($target->getObjectType(), [ Happening::OBJECT_TYPE ])) {
 132             throw new ClientException('RSVP not aimed at a Happening');
 133         }
 134
 135         // FIXME: Maybe we need some permission handling here, though I think it's taken care of in saveActivity?
 136
 137         try {
 138             $other = RSVP::getByKeys( [ 'profile_id' => $stored->getProfile()->getID(),
 139                                         'event_uri' => $target->getUri(),
 140                                       ] );
 141             // TRANS: Client exception thrown when trying to save an already existing RSVP ("please respond").
 142             throw new AlreadyFulfilledException(_m('RSVP already exists.'));
 143         } catch (NoResultException $e) {
 144             // No previous RSVP, so go ahead and add.
 145         }
 146
 147         $rsvp = new RSVP();
 148         $rsvp->id          = UUID::gen();   // remove this
 149         $rsvp->uri         = $stored->getUri();
 150         $rsvp->profile_id  = $stored->getProfile()->getID();
 151         $rsvp->event_uri   = $target->getUri();
 152         $rsvp->response    = self::codeFor($stored->getVerb());
 153         $rsvp->created     = $stored->getCreated();
 154
 155         $rsvp->insert();
 156
 157         self::blow('rsvp:for-event:%s', $target->getUri());
 158
 159         return $rsvp;
 160     }
 161
 162     static function codeFor($verb)
 163     {
 164         switch (true) {
 165         case ActivityUtils::compareVerbs($verb, [RSVP::POSITIVE]):
 166             return 'Y';
 167             break;
 168         case ActivityUtils::compareVerbs($verb, [RSVP::NEGATIVE]):
 169             return 'N';
 170             break;
 171         case ActivityUtils::compareVerbs($verb, [RSVP::POSSIBLE]):
 172             return '?';
 173             break;
 174         default:
 175             // TRANS: Exception thrown when requesting an undefined verb for RSVP.
 176             throw new Exception(sprintf(_m('Unknown verb "%s".'),$verb));
 177         }
 178     }
 179
 180     static function verbFor($code)
 181     {
 182         switch ($code) {
 183         case 'Y':
 184         case 'yes':
 185             return RSVP::POSITIVE;
 186             break;
 187         case 'N':
 188         case 'no':
 189             return RSVP::NEGATIVE;
 190             break;
 191         case '?':
 192         case 'maybe':
 193             return RSVP::POSSIBLE;
 194             break;
 195         default:
 196             // TRANS: Exception thrown when requesting an undefined code for RSVP.
 197             throw new ClientException(sprintf(_m('Unknown code "%s".'), $code));
 198         }
 199     }
 200
 201     public function getUri()
 202     {
 203         return $this->uri;
 204     }
 205
 206     public function getEventUri()
 207     {
 208         return $this->event_uri;
 209     }
 210
 211     public function getStored()
 212     {
 213         return Notice::getByKeys(['uri' => $this->getUri()]);
 214     }
 215
 216     static function fromStored(Notice $stored)
 217     {
 218         return self::getByKeys(['uri' => $stored->getUri()]);
 219     }
 220
 221     static function byEventAndActor(Happening $event, Profile $actor)
 222     {
 223         return self::getByKeys(['event_uri' => $event->getUri(),
 224                                 'profile_id' => $actor->getID()]);
 225     }
 226
 227     static function forEvent(Happening $event)
 228     {
 229         $keypart = sprintf('rsvp:for-event:%s', $event->getUri());
 230
 231         $idstr = self::cacheGet($keypart);
 232
 233         if ($idstr !== false) {
 234             $ids = explode(',', $idstr);
 235         } else {
 236             $ids = array();
 237
 238             $rsvp = new RSVP();
 239
 240             $rsvp->selectAdd();
 241             $rsvp->selectAdd('id');
 242
 243             $rsvp->event_uri = $event->getUri();
 244
 245             if ($rsvp->find()) {
 246                 while ($rsvp->fetch()) {
 247                     $ids[] = $rsvp->id;
 248                 }
 249             }
 250             self::cacheSet($keypart, implode(',', $ids));
 251         }
 252
 253         $rsvps = array(RSVP::POSITIVE => array(),
 254                        RSVP::NEGATIVE => array(),
 255                        RSVP::POSSIBLE => array());
 256
 257         foreach ($ids as $id) {
 258             $rsvp = RSVP::getKV('id', $id);
 259             if (!empty($rsvp)) {
 260                 $verb = self::verbFor($rsvp->response);
 261                 $rsvps[$verb][] = $rsvp;
 262             }
 263         }
 264
 265         return $rsvps;
 266     }
 267
 268     function getProfile()
 269     {
 270         return Profile::getByID($this->profile_id);
 271     }
 272
 273     function getEvent()
 274     {
 275         return Happening::getByKeys(['uri' => $this->getEventUri()]);
 276     }
 277
 278     function asHTML()
 279     {
 280         return self::toHTML($this->getProfile(),
 281                             $this->getEvent(),
 282                             $this->response);
 283     }
 284
 285     function asString()
 286     {
 287         return self::toString($this->getProfile(),
 288                               $this->getEvent(),
 289                               $this->response);
 290     }
 291
 292     static function toHTML(Profile $profile, Happening $event, $response)
 293     {
 294         $fmt = null;
 295
 296         switch ($response) {
 297         case 'Y':
 298             // TRANS: HTML version of an RSVP ("please respond") status for a user.
 299             // TRANS: %1$s is a profile URL, %2$s a profile name,
 300             // TRANS: %3$s is an event URL, %4$s an event title.
 301             $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> is attending <a href='%3\$s'>%4\$s</a>.</span>");
 302             break;
 303         case 'N':
 304             // TRANS: HTML version of an RSVP ("please respond") status for a user.
 305             // TRANS: %1$s is a profile URL, %2$s a profile name,
 306             // TRANS: %3$s is an event URL, %4$s an event title.
 307             $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>");
 308             break;
 309         case '?':
 310             // TRANS: HTML version of an RSVP ("please respond") status for a user.
 311             // TRANS: %1$s is a profile URL, %2$s a profile name,
 312             // TRANS: %3$s is an event URL, %4$s an event title.
 313             $fmt = _m("<span class='automatic event-rsvp'><a href='%1\$s'>%2\$s</a> might attend <a href='%3\$s'>%4\$s</a>.</span>");
 314             break;
 315         default:
 316             // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
 317             // TRANS: %s is the non-existing response code.
 318             throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
 319         }
 320
 321         if (empty($event)) {
 322             $eventUrl = '#';
 323             // TRANS: Used as event title when not event title is available.
 324             // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
 325             $eventTitle = _m('an unknown event');
 326         } else {
 327             $eventUrl = $event->getStored()->getUrl();
 328             $eventTitle = $event->title;
 329         }
 330
 331         return sprintf($fmt,
 332                        htmlspecialchars($profile->getUrl()),
 333                        htmlspecialchars($profile->getBestName()),
 334                        htmlspecialchars($eventUrl),
 335                        htmlspecialchars($eventTitle));
 336     }
 337
 338     static function toString($profile, $event, $response)
 339     {
 340         $fmt = null;
 341
 342         switch ($response) {
 343         case 'Y':
 344             // TRANS: Plain text version of an RSVP ("please respond") status for a user.
 345             // TRANS: %1$s is a profile name, %2$s is an event title.
 346             $fmt = _m('%1$s is attending %2$s.');
 347             break;
 348         case 'N':
 349             // TRANS: Plain text version of an RSVP ("please respond") status for a user.
 350             // TRANS: %1$s is a profile name, %2$s is an event title.
 351             $fmt = _m('%1$s is not attending %2$s.');
 352             break;
 353         case '?':
 354             // TRANS: Plain text version of an RSVP ("please respond") status for a user.
 355             // TRANS: %1$s is a profile name, %2$s is an event title.
 356             $fmt = _m('%1$s might attend %2$s.');
 357             break;
 358         default:
 359             // TRANS: Exception thrown when requesting a user's RSVP status for a non-existing response code.
 360             // TRANS: %s is the non-existing response code.
 361             throw new Exception(sprintf(_m('Unknown response code %s.'),$response));
 362             break;
 363         }
 364
 365         if (empty($event)) {
 366             // TRANS: Used as event title when not event title is available.
 367             // TRANS: Used as: Username [is [not ] attending|might attend] an unknown event.
 368             $eventTitle = _m('an unknown event');
 369         } else {
 370             $eventTitle = $event->title;
 371         }
 372
 373         return sprintf($fmt,
 374                        $profile->getBestName(),
 375                        $eventTitle);
 376     }
 377
 378     public function delete($useWhere=false)
 379     {
 380         self::blow('rsvp:for-event:%s', $this->id);
 381         return parent::delete($useWhere);
 382     }
 383
 384     public function insert()
 385     {
 386         $result = parent::insert();
 387         if ($result === false) {
 388             common_log_db_error($this, 'INSERT', __FILE__);
 389             throw new ServerException(_('Failed to insert '._ve(get_called_class()).' into database'));
 390         }
 391         return $result;
 392     }
 393 }