plugins/Event/classes/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('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * Data class for happenings
  34  *
  35  * There's already an Event class in lib/event.php, so we couldn't
  36  * call this an Event without causing a hole in space-time.
  37  *
  38  * "Happening" seemed good enough.
  39  *
  40  * @category Event
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  44  * @link     http://status.net/
  45  *
  46  * @see      Managed_DataObject
  47  */
  48 class Happening extends Managed_DataObject
  49 {
  50     const OBJECT_TYPE = 'http://activitystrea.ms/schema/1.0/event';
  51
  52     public $__table = 'happening'; // table name
  53     public $id;                    // varchar(36) UUID
  54     public $uri;                   // varchar(191)   not 255 because utf8mb4 takes more space
  55     public $profile_id;            // int
  56     public $start_time;            // datetime
  57     public $end_time;              // datetime
  58     public $title;                 // varchar(191)   not 255 because utf8mb4 takes more space
  59     public $location;              // varchar(191)   not 255 because utf8mb4 takes more space
  60     public $url;                   // varchar(191)   not 255 because utf8mb4 takes more space
  61     public $description;           // text
  62     public $created;               // datetime
  63
  64     /**
  65      * The One True Thingy that must be defined and declared.
  66      */
  67     public static function schemaDef()
  68     {
  69         return array(
  70             'description' => 'A real-world happening',
  71             'fields' => array(
  72                 'id' => array('type' => 'char',
  73                               'length' => 36,
  74                               'not null' => true,
  75                               'description' => 'UUID'),
  76                 'uri' => array('type' => 'varchar',
  77                                'length' => 191,
  78                                'not null' => true),
  79                 'profile_id' => array('type' => 'int', 'not null' => true),
  80                 'start_time' => array('type' => 'datetime', 'not null' => true),
  81                 'end_time' => array('type' => 'datetime', 'not null' => true),
  82                 'title' => array('type' => 'varchar',
  83                                  'length' => 191,
  84                                  'not null' => true),
  85                 'location' => array('type' => 'varchar',
  86                                     'length' => 191),
  87                 'url' => array('type' => 'varchar',
  88                                'length' => 191),
  89                 'description' => array('type' => 'text'),
  90                 'created' => array('type' => 'datetime',
  91                                    'not null' => true),
  92             ),
  93             'primary key' => array('id'),
  94             'unique keys' => array(
  95                 'happening_uri_key' => array('uri'),
  96             ),
  97             'foreign keys' => array('happening_profile_id__key' => array('profile', array('profile_id' => 'id')),
  98                                     'happening_uri__key' => array('notice', array('uri' => 'uri'))),
  99             'indexes' => array('happening_created_idx' => array('created'),
 100                                'happening_start_end_idx' => array('start_time', 'end_time')),
 101         );
 102     }
 103
 104     public static function saveActivityObject(ActivityObject $actobj, Notice $stored)
 105     {
 106         $other = Happening::getKV('uri', $actobj->id);
 107         if ($other instanceof Happening) {
 108             // TRANS: Client exception thrown when trying to create an event that already exists.
 109             throw new ClientException(_m('Event already exists.'));
 110         }
 111
 112         $dtstart = null;
 113         $dtend = null;
 114         $location = null;
 115         $url = null;
 116
 117         foreach ($actobj->extra as $extra) {
 118             switch ($extra[0]) {
 119             case 'dtstart':
 120                 $dtstart = $extra[2];
 121             case 'dtend':
 122                 $dtend = $extra[2];
 123                 break;
 124             case 'location':
 125                 // location is optional
 126                 $location = $extra[2];
 127                 break;
 128             case 'url':
 129                 // url is optional
 130                 $url = $extra[2];
 131             }
 132         }
 133         if(empty($dtstart)) {
 134             // TRANS: Exception thrown when has no start date
 135             throw new Exception(_m('No start date for event.'));
 136         }
 137         if(empty($dtend)) {
 138             // TRANS: Exception thrown when has no end date
 139             throw new Exception(_m('No end date for event.'));
 140         }
 141
 142         // convert RFC3339 dates delivered in Activity Stream to MySQL DATETIME date format
 143         $start_time = new DateTime($dtstart);
 144         $start_time->setTimezone(new DateTimeZone('UTC'));
 145         $start_time = $start_time->format('Y-m-d H:i:s');
 146         $end_time = new DateTime($dtend);
 147         $end_time->setTimezone(new DateTimeZone('UTC'));
 148         $end_time = $end_time->format('Y-m-d H:i:s');
 149
 150         $ev = new Happening();
 151
 152         $ev->id          = UUID::gen();
 153         $ev->uri         = $actobj->id;
 154         $ev->profile_id  = $stored->getProfile()->getID();
 155         $ev->start_time  = $start_time;
 156         $ev->end_time    = $end_time;
 157         $ev->title       = $actobj->title;
 158         $ev->location    = $location;
 159         $ev->description = $stored->getContent();
 160         $ev->url         = $url;
 161         $ev->created     = $stored->getCreated();
 162
 163         $ev->insert();
 164         return $ev;
 165     }
 166
 167     public function insert()
 168     {
 169         $result = parent::insert();
 170         if ($result === false) {
 171             common_log_db_error($this, 'INSERT', __FILE__);
 172             throw new ServerException(_('Failed to insert '._ve(get_called_class()).' into database'));
 173         }
 174         return $result;
 175     }
 176
 177     /**
 178      * Returns the profile's canonical url, not necessarily a uri/unique id
 179      *
 180      * @return string $url
 181      */
 182     public function getUrl()
 183     {
 184         if (empty($this->url) ||
 185                 !filter_var($this->url, FILTER_VALIDATE_URL)) {
 186             throw new InvalidUrlException($this->url);
 187         }
 188         return $this->url;
 189     }
 190
 191     public function getUri()
 192     {
 193         return $this->uri;
 194     }
 195
 196     public function getNotice()
 197     {
 198         return Notice::getByKeys(array('uri'=>$this->getUri()));
 199     }
 200
 201     static function fromStored(Notice $stored)
 202     {
 203         return self::getByKeys(array('uri'=>$stored->getUri()));
 204     }
 205
 206     function getRSVPs()
 207     {
 208         return RSVP::forEvent($this);
 209     }
 210
 211     function getRSVP($profile)
 212     {
 213         return RSVP::pkeyGet(array('profile_id' => $profile->getID(),
 214                                    'event_uri' => $this->getUri()));
 215     }
 216 }