plugins/Event/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('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Data class for event RSVPs
  36  *
  37  * @category Event
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  *
  43  * @see      Managed_DataObject
  44  */
  45
  46 class RSVP extends Managed_DataObject
  47 {
  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';
  51
  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 $result;            // tinyint
  58     public $created;           // datetime
  59
  60     /**
  61      * Get an instance by key
  62      *
  63      * @param string $k Key to use to lookup (usually 'id' for this class)
  64      * @param mixed  $v Value to lookup
  65      *
  66      * @return RSVP object found, or null for no hits
  67      *
  68      */
  69     function staticGet($k, $v=null)
  70     {
  71         return Memcached_DataObject::staticGet('RSVP', $k, $v);
  72     }
  73
  74     /**
  75      * Get an instance by compound key
  76      *
  77      * @param array $kv array of key-value mappings
  78      *
  79      * @return Bookmark object found, or null for no hits
  80      *
  81      */
  82
  83     function pkeyGet($kv)
  84     {
  85         return Memcached_DataObject::pkeyGet('RSVP', $kv);
  86     }
  87
  88     /**
  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.
  92      *
  93      * @return array
  94      */
  95     function _allCacheKeys() {
  96         $keys = parent::_allCacheKeys();
  97         $keys[] = self::multicacheKey('RSVP', array('profile_id' => $this->profile_id,
  98                                                     'event_id' => $this->event_id));
  99         return $keys;
 100     }
 101
 102     /**
 103      * The One True Thingy that must be defined and declared.
 104      */
 105     public static function schemaDef()
 106     {
 107         return array(
 108             'description' => 'Plan to attend event',
 109             'fields' => array(
 110                 'id' => array('type' => 'char',
 111                               'length' => 36,
 112                               'not null' => true,
 113                               'description' => 'UUID'),
 114                 'uri' => array('type' => 'varchar',
 115                                'length' => 255,
 116                                'not null' => true),
 117                 'profile_id' => array('type' => 'int'),
 118                 'event_id' => array('type' => 'char',
 119                               'length' => 36,
 120                               'not null' => true,
 121                               'description' => 'UUID'),
 122                 'result' => array('type' => 'tinyint',
 123                                   'description' => '1, 0, or null for three-state yes, no, maybe'),
 124                 'created' => array('type' => 'datetime',
 125                                    'not null' => true),
 126             ),
 127             'primary key' => array('id'),
 128             'unique keys' => array(
 129                 'rsvp_uri_key' => array('uri'),
 130                 'rsvp_profile_event_key' => array('profile_id', 'event_id'),
 131             ),
 132             'foreign keys' => array('rsvp_event_id_key' => array('event', array('event_id' => 'id')),
 133                                     'rsvp_profile_id__key' => array('profile', array('profile_id' => 'id'))),
 134             'indexes' => array('rsvp_created_idx' => array('created')),
 135         );
 136     }
 137
 138     function saveNew($profile, $event, $result, $options=array())
 139     {
 140         if (array_key_exists('uri', $options)) {
 141             $other = RSVP::staticGet('uri', $options['uri']);
 142             if (!empty($other)) {
 143                 throw new ClientException(_('RSVP already exists.'));
 144             }
 145         }
 146
 147         $other = RSVP::pkeyGet(array('profile_id' => $profile->id,
 148                                      'event_id' => $event->id));
 149
 150         if (!empty($other)) {
 151             throw new ClientException(_('RSVP already exists.'));
 152         }
 153
 154         $rsvp = new RSVP();
 155
 156         $rsvp->id          = UUID::gen();
 157         $rsvp->profile_id  = $profile->id;
 158         $rsvp->event_id    = $event->id;
 159         $rsvp->result      = self::codeFor($result);
 160
 161         if (array_key_exists('created', $options)) {
 162             $rsvp->created = $options['created'];
 163         } else {
 164             $rsvp->created = common_sql_now();
 165         }
 166
 167         if (array_key_exists('uri', $options)) {
 168             $rsvp->uri = $options['uri'];
 169         } else {
 170             $rsvp->uri = common_local_url('showrsvp',
 171                                         array('id' => $rsvp->id));
 172         }
 173
 174         $rsvp->insert();
 175
 176         // XXX: come up with something sexier
 177
 178         $content = sprintf(_('RSVPed %s for an event.'),
 179                            ($result == RSVP::POSITIVE) ? _('positively') :
 180                            ($result == RSVP::NEGATIVE) ? _('negatively') :
 181                            _('possibly'));
 182
 183         $rendered = $content;
 184
 185         $options = array_merge(array('object_type' => $result),
 186                                $options);
 187
 188         if (!array_key_exists('uri', $options)) {
 189             $options['uri'] = $rsvp->uri;
 190         }
 191
 192         $eventNotice = $event->getNotice();
 193
 194         if (!empty($eventNotice)) {
 195             $options['reply_to'] = $eventNotice->id;
 196         }
 197
 198         $saved = Notice::saveNew($profile->id,
 199                                  $content,
 200                                  array_key_exists('source', $options) ?
 201                                  $options['source'] : 'web',
 202                                  $options);
 203
 204         return $saved;
 205     }
 206
 207     function codeFor($verb)
 208     {
 209         return ($verb == RSVP::POSITIVE) ? 1 :
 210             ($verb == RSVP::NEGATIVE) ? 0 : null;
 211     }
 212
 213     static function verbFor($code)
 214     {
 215         return ($code == 1) ? RSVP::POSITIVE :
 216             ($code == 0) ? RSVP::NEGATIVE : null;
 217     }
 218
 219     function getNotice()
 220     {
 221         $notice = Notice::staticGet('uri', $this->uri);
 222         if (empty($notice)) {
 223             throw new ServerException("RSVP {$this->id} does not correspond to a notice in the DB.");
 224         }
 225         return $notice;
 226     }
 227
 228     static function fromNotice($notice)
 229     {
 230         return RSVP::staticGet('uri', $notice->uri);
 231     }
 232
 233     static function forEvent($event)
 234     {
 235         $rsvps = array(RSVP::POSITIVE => array(),
 236                        RSVP::NEGATIVE => array(),
 237                        RSVP::POSSIBLE => array());
 238
 239         $rsvp = new RSVP();
 240
 241         $rsvp->event_id = $event->id;
 242
 243         if ($rsvp->find()) {
 244             while ($rsvp->fetch()) {
 245                 $verb = self::verbFor($rsvp->result);
 246                 $rsvps[$verb][] = clone($rsvp);
 247             }
 248         }
 249
 250         return $rsvps;
 251     }
 252 }