classes/Message.php

   1 <?php
   2 /**
   3  * Table Definition for message
   4  */
   5 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
   6
   7 class Message extends Managed_DataObject
   8 {
   9     ###START_AUTOCODE
  10     /* the code below is auto generated do not remove the above tag */
  11
  12     public $__table = 'message';                         // table name
  13     public $id;                              // int(4)  primary_key not_null
  14     public $uri;                             // varchar(255)  unique_key
  15     public $from_profile;                    // int(4)   not_null
  16     public $to_profile;                      // int(4)   not_null
  17     public $content;                         // text()
  18     public $rendered;                        // text()
  19     public $url;                             // varchar(255)
  20     public $created;                         // datetime()   not_null
  21     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  22     public $source;                          // varchar(32)
  23
  24     /* the code above is auto generated do not remove the tag below */
  25     ###END_AUTOCODE
  26
  27     public static function schemaDef()
  28     {
  29         return array(
  30             'fields' => array(
  31                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
  32                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier'),
  33                 'from_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is from'),
  34                 'to_profile' => array('type' => 'int', 'not null' => true, 'description' => 'who the message is to'),
  35                 'content' => array('type' => 'text', 'description' => 'message content'),
  36                 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
  37                 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
  38                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  39                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  40                 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
  41             ),
  42             'primary key' => array('id'),
  43             'unique keys' => array(
  44                 'message_uri_key' => array('uri'),
  45             ),
  46             'foreign keys' => array(
  47                 'message_from_profile_fkey' => array('profile', array('from_profile' => 'id')),
  48                 'message_to_profile_fkey' => array('profile', array('to_profile' => 'id')),
  49             ),
  50             'indexes' => array(
  51                 // @fixme these are really terrible indexes, since you can only sort on one of them at a time.
  52                 // looks like we really need a (to_profile, created) for inbox and a (from_profile, created) for outbox
  53                 'message_from_idx' => array('from_profile'),
  54                 'message_to_idx' => array('to_profile'),
  55                 'message_created_idx' => array('created'),
  56             ),
  57         );
  58     }
  59
  60     function getFrom()
  61     {
  62         return Profile::getKV('id', $this->from_profile);
  63     }
  64
  65     function getTo()
  66     {
  67         return Profile::getKV('id', $this->to_profile);
  68     }
  69
  70     static function saveNew($from, $to, $content, $source) {
  71         $sender = Profile::getKV('id', $from);
  72
  73         if (!$sender->hasRight(Right::NEWMESSAGE)) {
  74             // TRANS: Client exception thrown when a user tries to send a direct message while being banned from sending them.
  75             throw new ClientException(_('You are banned from sending direct messages.'));
  76         }
  77
  78         $user = User::getKV('id', $sender->id);
  79
  80         $msg = new Message();
  81
  82         $msg->from_profile = $from;
  83         $msg->to_profile = $to;
  84
  85         if ($user instanceof User) {
  86             // Use the sender's URL shortening options.
  87             $msg->content = $user->shortenLinks($content);
  88         } else {
  89             $msg->content = common_shorten_links($content);
  90         }
  91
  92         $msg->rendered = common_render_text($msg->content);
  93         $msg->created = common_sql_now();
  94         $msg->source = $source;
  95
  96         $result = $msg->insert();
  97
  98         if (!$result) {
  99             common_log_db_error($msg, 'INSERT', __FILE__);
 100             // TRANS: Message given when a message could not be stored on the server.
 101             throw new ServerException(_('Could not insert message.'));
 102         }
 103
 104         $orig = clone($msg);
 105         $msg->uri = common_local_url('showmessage', array('message' => $msg->id));
 106
 107         $result = $msg->update($orig);
 108
 109         if (!$result) {
 110             common_log_db_error($msg, 'UPDATE', __FILE__);
 111             // TRANS: Message given when a message could not be updated on the server.
 112             throw new ServerException(_('Could not update message with new URI.'));
 113         }
 114
 115         return $msg;
 116     }
 117
 118     static function maxContent()
 119     {
 120         $desclimit = common_config('message', 'contentlimit');
 121         // null => use global limit (distinct from 0!)
 122         if (is_null($desclimit)) {
 123             $desclimit = common_config('site', 'textlimit');
 124         }
 125         return $desclimit;
 126     }
 127
 128     static function contentTooLong($content)
 129     {
 130         $contentlimit = self::maxContent();
 131         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
 132     }
 133
 134     function notify()
 135     {
 136         $from = User::getKV('id', $this->from_profile);
 137         $to   = User::getKV('id', $this->to_profile);
 138
 139         mail_notify_message($this, $from, $to);
 140     }
 141
 142     function getSource()
 143     {
 144         $ns = new Notice_source();
 145         if (!empty($this->source)) {
 146             switch ($this->source) {
 147             case 'web':
 148             case 'xmpp':
 149             case 'mail':
 150             case 'omb':
 151             case 'system':
 152             case 'api':
 153                 $ns->code = $this->source;
 154                 break;
 155             default:
 156                 $ns = Notice_source::getKV($this->source);
 157                 if (!$ns) {
 158                     $ns = new Notice_source();
 159                     $ns->code = $this->source;
 160                     $app = Oauth_application::getKV('name', $this->source);
 161                     if ($app) {
 162                         $ns->name = $app->name;
 163                         $ns->url  = $app->source_url;
 164                     }
 165                 }
 166                 break;
 167             }
 168         }
 169         return $ns;
 170     }
 171
 172     function asActivity()
 173     {
 174         $act = new Activity();
 175
 176         if (Event::handle('StartMessageAsActivity', array($this, &$act))) {
 177
 178             $act->id      = TagURI::mint(sprintf('activity:message:%d', $this->id));
 179             $act->time    = strtotime($this->created);
 180             $act->link    = $this->url;
 181
 182             $profile = Profile::getKV('id', $this->from_profile);
 183
 184             if (empty($profile)) {
 185                 throw new Exception(sprintf("Sender profile not found: %d", $this->from_profile));
 186             }
 187
 188             $act->actor            = $profile->asActivityObject();
 189             $act->actor->extra[]   = $profile->profileInfo();
 190
 191             $act->verb = ActivityVerb::POST;
 192
 193             $act->objects[] = ActivityObject::fromMessage($this);
 194
 195             $ctx = new ActivityContext();
 196
 197             $rprofile = Profile::getKV('id', $this->to_profile);
 198
 199             if (empty($rprofile)) {
 200                 throw new Exception(sprintf("Receiver profile not found: %d", $this->to_profile));
 201             }
 202
 203             $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
 204
 205             $act->context = $ctx;
 206
 207             $source = $this->getSource();
 208
 209             if ($source) {
 210                 $act->generator = ActivityObject::fromNoticeSource($source);
 211             }
 212
 213             Event::handle('EndMessageAsActivity', array($this, &$act));
 214         }
 215
 216         return $act;
 217     }
 218 }