plugins/Event/Happening.php

   1 <?php
   2 /**
   3  * Data class for happenings
   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 happenings
  36  *
  37  * There's already an Event class in lib/event.php, so we couldn't
  38  * call this an Event without causing a hole in space-time.
  39  *
  40  * "Happening" seemed good enough.
  41  *
  42  * @category Event
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  46  * @link     http://status.net/
  47  *
  48  * @see      Managed_DataObject
  49  */
  50 class Happening extends Managed_DataObject
  51 {
  52     const OBJECT_TYPE = 'http://activitystrea.ms/schema/1.0/event';
  53
  54     public $__table = 'happening'; // table name
  55     public $id;                    // varchar(36) UUID
  56     public $uri;                   // varchar(255)
  57     public $profile_id;            // int
  58     public $start_time;            // datetime
  59     public $end_time;              // datetime
  60     public $title;                 // varchar(255)
  61     public $location;              // varchar(255)
  62     public $url;                   // varchar(255)
  63     public $description;           // text
  64     public $created;               // datetime
  65
  66     /**
  67      * Get an instance by key
  68      *
  69      * @param string $k Key to use to lookup (usually 'id' for this class)
  70      * @param mixed  $v Value to lookup
  71      *
  72      * @return Happening object found, or null for no hits
  73      *
  74      */
  75     function staticGet($k, $v=null)
  76     {
  77         return Memcached_DataObject::staticGet('Happening', $k, $v);
  78     }
  79
  80     /**
  81      * The One True Thingy that must be defined and declared.
  82      */
  83     public static function schemaDef()
  84     {
  85         return array(
  86             'description' => 'A real-world happening',
  87             'fields' => array(
  88                 'id' => array('type' => 'char',
  89                               'length' => 36,
  90                               'not null' => true,
  91                               'description' => 'UUID'),
  92                 'uri' => array('type' => 'varchar',
  93                                'length' => 255,
  94                                'not null' => true),
  95                 'profile_id' => array('type' => 'int', 'not null' => true),
  96                 'start_time' => array('type' => 'datetime', 'not null' => true),
  97                 'end_time' => array('type' => 'datetime', 'not null' => true),
  98                 'title' => array('type' => 'varchar',
  99                                  'length' => 255,
 100                                  'not null' => true),
 101                 'location' => array('type' => 'varchar',
 102                                     'length' => 255),
 103                 'url' => array('type' => 'varchar',
 104                                'length' => 255),
 105                 'description' => array('type' => 'text'),
 106                 'created' => array('type' => 'datetime',
 107                                    'not null' => true),
 108             ),
 109             'primary key' => array('id'),
 110             'unique keys' => array(
 111                 'happening_uri_key' => array('uri'),
 112             ),
 113             'foreign keys' => array('happening_profile_id__key' => array('profile', array('profile_id' => 'id'))),
 114             'indexes' => array('happening_created_idx' => array('created'),
 115                                'happening_start_end_idx' => array('start_time', 'end_time')),
 116         );
 117     }
 118
 119     function saveNew($profile, $start_time, $end_time, $title, $location, $description, $url, $options=array())
 120     {
 121         if (array_key_exists('uri', $options)) {
 122             $other = Happening::staticGet('uri', $options['uri']);
 123             if (!empty($other)) {
 124                 // TRANS: Client exception thrown when trying to create an event that already exists.
 125                 throw new ClientException(_m('Event already exists.'));
 126             }
 127         }
 128
 129         $ev = new Happening();
 130
 131         $ev->id          = UUID::gen();
 132         $ev->profile_id  = $profile->id;
 133         $ev->start_time  = common_sql_date($start_time);
 134         $ev->end_time    = common_sql_date($end_time);
 135         $ev->title       = $title;
 136         $ev->location    = $location;
 137         $ev->description = $description;
 138         $ev->url         = $url;
 139
 140         if (array_key_exists('created', $options)) {
 141             $ev->created = $options['created'];
 142         } else {
 143             $ev->created = common_sql_now();
 144         }
 145
 146         if (array_key_exists('uri', $options)) {
 147             $ev->uri = $options['uri'];
 148         } else {
 149             $ev->uri = common_local_url('showevent',
 150                                         array('id' => $ev->id));
 151         }
 152
 153         $ev->insert();
 154
 155         // XXX: does this get truncated?
 156
 157         // TRANS: Event description. %1$s is a title, %2$s is start time, %3$s is end time,
 158         // TRANS: %4$s is location, %5$s is a description.
 159         $content = sprintf(_m('"%1$s" %2$s - %3$s (%4$s): %5$s'),
 160                            $title,
 161                            common_exact_date($ev->start_time),
 162                            common_exact_date($ev->end_time),
 163                            $location,
 164                            $description);
 165
 166         // TRANS: Rendered event description. %1$s is a title, %2$s is start time, %3$s is start time,
 167         // TRANS: %4$s is end time, %5$s is end time, %6$s is location, %7$s is description.
 168         // TRANS: Class names should not be translated.
 169         $rendered = sprintf(_m('<span class="vevent">'.
 170                               '<span class="summary">%1$s</span> '.
 171                               '<abbr class="dtstart" title="%2$s">%3$s</a> - '.
 172                               '<abbr class="dtend" title="%4$s">%5$s</a> '.
 173                               '(<span class="location">%6$s</span>): '.
 174                               '<span class="description">%7$s</span> '.
 175                               '</span>'),
 176                             htmlspecialchars($title),
 177                             htmlspecialchars(common_date_iso8601($ev->start_time)),
 178                             htmlspecialchars(common_exact_date($ev->start_time)),
 179                             htmlspecialchars(common_date_iso8601($ev->end_time)),
 180                             htmlspecialchars(common_exact_date($ev->end_time)),
 181                             htmlspecialchars($location),
 182                             htmlspecialchars($description));
 183
 184         $options = array_merge(array('object_type' => Happening::OBJECT_TYPE),
 185                                $options);
 186
 187         if (!array_key_exists('uri', $options)) {
 188             $options['uri'] = $ev->uri;
 189         }
 190
 191         if (!empty($url)) {
 192             $options['urls'] = array($url);
 193         }
 194
 195         $saved = Notice::saveNew($profile->id,
 196                                  $content,
 197                                  array_key_exists('source', $options) ?
 198                                  $options['source'] : 'web',
 199                                  $options);
 200
 201         return $saved;
 202     }
 203
 204     function getNotice()
 205     {
 206         return Notice::staticGet('uri', $this->uri);
 207     }
 208
 209     static function fromNotice($notice)
 210     {
 211         return Happening::staticGet('uri', $notice->uri);
 212     }
 213
 214     function getRSVPs()
 215     {
 216         return RSVP::forEvent($this);
 217     }
 218
 219     function getRSVP($profile)
 220     {
 221         return RSVP::pkeyGet(array('profile_id' => $profile->id,
 222                                    'event_id' => $this->id));
 223     }
 224 }