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
  51 class Happening extends Managed_DataObject
  52 {
  53     const OBJECT_TYPE = 'http://activitystrea.ms/schema/1.0/event';
  54
  55     public $__table = 'happening'; // table name
  56     public $id;                    // varchar(36) UUID
  57     public $uri;                   // varchar(255)
  58     public $profile_id;            // int
  59     public $start_time;            // datetime
  60     public $end_time;              // datetime
  61     public $title;                 // varchar(255)
  62     public $location;              // varchar(255)
  63     public $url;                   // varchar(255)
  64     public $description;           // text
  65     public $created;               // datetime
  66
  67     /**
  68      * Get an instance by key
  69      *
  70      * @param string $k Key to use to lookup (usually 'id' for this class)
  71      * @param mixed  $v Value to lookup
  72      *
  73      * @return Happening object found, or null for no hits
  74      *
  75      */
  76     function staticGet($k, $v=null)
  77     {
  78         return Memcached_DataObject::staticGet('Happening', $k, $v);
  79     }
  80
  81     /**
  82      * The One True Thingy that must be defined and declared.
  83      */
  84     public static function schemaDef()
  85     {
  86         return array(
  87             'description' => 'A real-world happening',
  88             'fields' => array(
  89                 'id' => array('type' => 'char',
  90                               'length' => 36,
  91                               'not null' => true,
  92                               'description' => 'UUID'),
  93                 'uri' => array('type' => 'varchar',
  94                                'length' => 255,
  95                                'not null' => true),
  96                 'profile_id' => array('type' => 'int', 'not null' => true),
  97                 'start_time' => array('type' => 'datetime', 'not null' => true),
  98                 'end_time' => array('type' => 'datetime', 'not null' => true),
  99                 'title' => array('type' => 'varchar',
 100                                  'length' => 255,
 101                                  'not null' => true),
 102                 'location' => array('type' => 'varchar',
 103                                     'length' => 255),
 104                 'url' => array('type' => 'varchar',
 105                                'length' => 255),
 106                 'description' => array('type' => 'text'),
 107                 'created' => array('type' => 'datetime',
 108                                    'not null' => true),
 109             ),
 110             'primary key' => array('id'),
 111             'unique keys' => array(
 112                 'happening_uri_key' => array('uri'),
 113             ),
 114             'foreign keys' => array('happening_profile_id__key' => array('profile', array('profile_id' => 'id'))),
 115             'indexes' => array('happening_created_idx' => array('created'),
 116                                'happening_start_end_idx' => array('start_time', 'end_time')),
 117         );
 118     }
 119
 120     function saveNew($profile, $start_time, $end_time, $title, $location, $description, $url, $options=array())
 121     {
 122         if (array_key_exists('uri', $options)) {
 123             $other = Happening::staticGet('uri', $options['uri']);
 124             if (!empty($other)) {
 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         $rendered = sprintf(_m('<span class="vevent">'.
 167                               '<span class="summary">%1$s</span> '.
 168                               '<abbr class="dtstart" title="%2$s">%3$s</a> - '.
 169                               '<abbr class="dtend" title="%4$s">%5$s</a> '.
 170                               '(<span class="location">%6$s</span>): '.
 171                               '<span class="description">%7$s</span> '.
 172                               '</span>'),
 173                             htmlspecialchars($title),
 174                             htmlspecialchars(common_date_iso8601($ev->start_time)),
 175                             htmlspecialchars(common_exact_date($ev->start_time)),
 176                             htmlspecialchars(common_date_iso8601($ev->end_time)),
 177                             htmlspecialchars(common_exact_date($ev->end_time)),
 178                             htmlspecialchars($location),
 179                             htmlspecialchars($description));
 180
 181         $options = array_merge(array('object_type' => Happening::OBJECT_TYPE),
 182                                $options);
 183
 184         if (!array_key_exists('uri', $options)) {
 185             $options['uri'] = $ev->uri;
 186         }
 187
 188         if (!empty($url)) {
 189             $options['urls'] = array($url);
 190         }
 191
 192         $saved = Notice::saveNew($profile->id,
 193                                  $content,
 194                                  array_key_exists('source', $options) ?
 195                                  $options['source'] : 'web',
 196                                  $options);
 197
 198         return $saved;
 199     }
 200
 201     function getNotice()
 202     {
 203         return Notice::staticGet('uri', $this->uri);
 204     }
 205
 206     static function fromNotice($notice)
 207     {
 208         return Happening::staticGet('uri', $notice->uri);
 209     }
 210
 211     function getRSVPs()
 212     {
 213         return RSVP::forEvent($this);
 214     }
 215
 216     function getRSVP($profile)
 217     {
 218         common_log(LOG_DEBUG, "Finding RSVP for " . $profile->id . ', ' . $this->id);
 219         return RSVP::pkeyGet(array('profile_id' => $profile->id,
 220                                    'event_id' => $this->id));
 221     }
 222 }