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 $response;            // 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                 'response' => array('type' => 'char',
 123                                   'length' => '1',
 124                                   'description' => 'Y, N, or ? for three-state yes, no, maybe'),
 125                 'created' => array('type' => 'datetime',
 126                                    'not null' => true),
 127             ),
 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'),
 132             ),
 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')),
 136         );
 137     }
 138
 139     function saveNew($profile, $event, $verb, $options=array())
 140     {
 141         common_debug("RSVP::saveNew({$profile->id}, {$event->id}, '$verb', 'some options');");
 142
 143         if (array_key_exists('uri', $options)) {
 144             $other = RSVP::staticGet('uri', $options['uri']);
 145             if (!empty($other)) {
 146                 throw new ClientException(_('RSVP already exists.'));
 147             }
 148         }
 149
 150         $other = RSVP::pkeyGet(array('profile_id' => $profile->id,
 151                                      'event_id' => $event->id));
 152
 153         if (!empty($other)) {
 154             throw new ClientException(_('RSVP already exists.'));
 155         }
 156
 157         $rsvp = new RSVP();
 158
 159         $rsvp->id          = UUID::gen();
 160         $rsvp->profile_id  = $profile->id;
 161         $rsvp->event_id    = $event->id;
 162         $rsvp->response      = self::codeFor($verb);
 163
 164         if (array_key_exists('created', $options)) {
 165             $rsvp->created = $options['created'];
 166         } else {
 167             $rsvp->created = common_sql_now();
 168         }
 169
 170         if (array_key_exists('uri', $options)) {
 171             $rsvp->uri = $options['uri'];
 172         } else {
 173             $rsvp->uri = common_local_url('showrsvp',
 174                                         array('id' => $rsvp->id));
 175         }
 176
 177         $rsvp->insert();
 178
 179         // XXX: come up with something sexier
 180
 181         $content = sprintf(_('RSVPed %s for an event.'),
 182                            ($verb == RSVP::POSITIVE) ? _('positively') :
 183                            ($verb == RSVP::NEGATIVE) ? _('negatively') :
 184                            _('possibly'));
 185
 186         $rendered = $content;
 187
 188         $options = array_merge(array('object_type' => $verb),
 189                                $options);
 190
 191         if (!array_key_exists('uri', $options)) {
 192             $options['uri'] = $rsvp->uri;
 193         }
 194
 195         $eventNotice = $event->getNotice();
 196
 197         if (!empty($eventNotice)) {
 198             $options['reply_to'] = $eventNotice->id;
 199         }
 200
 201         $saved = Notice::saveNew($profile->id,
 202                                  $content,
 203                                  array_key_exists('source', $options) ?
 204                                  $options['source'] : 'web',
 205                                  $options);
 206
 207         return $saved;
 208     }
 209
 210     function codeFor($verb)
 211     {
 212         return ($verb == RSVP::POSITIVE) ? 'Y' :
 213             ($verb == RSVP::NEGATIVE) ? 'N' :
 214             ($verb == RSVP::POSSIBLE) ? '?' : null;
 215     }
 216
 217     static function verbFor($code)
 218     {
 219         return ($code == 'Y') ? RSVP::POSITIVE :
 220             ($code == 'N') ? RSVP::NEGATIVE :
 221             ($code == '?') ? RSVP::POSSIBLE : null;
 222     }
 223
 224     function getNotice()
 225     {
 226         $notice = Notice::staticGet('uri', $this->uri);
 227         if (empty($notice)) {
 228             throw new ServerException("RSVP {$this->id} does not correspond to a notice in the DB.");
 229         }
 230         return $notice;
 231     }
 232
 233     static function fromNotice($notice)
 234     {
 235         return RSVP::staticGet('uri', $notice->uri);
 236     }
 237
 238     static function forEvent($event)
 239     {
 240         $rsvps = array(RSVP::POSITIVE => array(),
 241                        RSVP::NEGATIVE => array(),
 242                        RSVP::POSSIBLE => array());
 243
 244         $rsvp = new RSVP();
 245
 246         $rsvp->event_id = $event->id;
 247
 248         if ($rsvp->find()) {
 249             while ($rsvp->fetch()) {
 250                 $verb = self::verbFor($rsvp->response);
 251                 $rsvps[$verb][] = clone($rsvp);
 252             }
 253         }
 254
 255         return $rsvps;
 256     }
 257 }