classes/Notice.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008-2011 StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * @category Notices
  20  * @package  StatusNet
  21  * @author   Brenda Wallace <shiny@cpan.org>
  22  * @author   Christopher Vollick <psycotica0@gmail.com>
  23  * @author   CiaranG <ciaran@ciarang.com>
  24  * @author   Craig Andrews <candrews@integralblue.com>
  25  * @author   Evan Prodromou <evan@controlezvous.ca>
  26  * @author   Gina Haeussge <osd@foosel.net>
  27  * @author   Jeffery To <jeffery.to@gmail.com>
  28  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author   Robin Millette <millette@controlyourself.ca>
  30  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  31  * @author   Tom Adams <tom@holizz.com>
  32  * @author   Mikael Nordfeldth <mmn@hethane.se>
  33  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  34  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  35  */
  36
  37 if (!defined('GNUSOCIAL')) { exit(1); }
  38
  39 /**
  40  * Table Definition for notice
  41  */
  42
  43 /* We keep 200 notices, the max number of notices available per API request,
  44  * in the memcached cache. */
  45
  46 define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
  47
  48 define('MAX_BOXCARS', 128);
  49
  50 class Notice extends Managed_DataObject
  51 {
  52     ###START_AUTOCODE
  53     /* the code below is auto generated do not remove the above tag */
  54
  55     public $__table = 'notice';                          // table name
  56     public $id;                              // int(4)  primary_key not_null
  57     public $profile_id;                      // int(4)  multiple_key not_null
  58     public $uri;                             // varchar(255)  unique_key
  59     public $content;                         // text
  60     public $rendered;                        // text
  61     public $url;                             // varchar(255)
  62     public $created;                         // datetime  multiple_key not_null default_0000-00-00%2000%3A00%3A00
  63     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  64     public $reply_to;                        // int(4)
  65     public $is_local;                        // int(4)
  66     public $source;                          // varchar(32)
  67     public $conversation;                    // int(4)
  68     public $lat;                             // decimal(10,7)
  69     public $lon;                             // decimal(10,7)
  70     public $location_id;                     // int(4)
  71     public $location_ns;                     // int(4)
  72     public $repeat_of;                       // int(4)
  73     public $verb;                            // varchar(255)
  74     public $object_type;                     // varchar(255)
  75     public $scope;                           // int(4)
  76
  77     /* the code above is auto generated do not remove the tag below */
  78     ###END_AUTOCODE
  79
  80     public static function schemaDef()
  81     {
  82         $def = array(
  83             'fields' => array(
  84                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
  85                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
  86                 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
  87                 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8_general_ci'),
  88                 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
  89                 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
  90                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  91                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  92                 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
  93                 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
  94                 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
  95                 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'),
  96                 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
  97                 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
  98                 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
  99                 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
 100                 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
 101                 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'),
 102                 'verb' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
 103                 'scope' => array('type' => 'int',
 104                                  'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'),
 105             ),
 106             'primary key' => array('id'),
 107             'unique keys' => array(
 108                 'notice_uri_key' => array('uri'),
 109             ),
 110             'foreign keys' => array(
 111                 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
 112                 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
 113                 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
 114                 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
 115             ),
 116             'indexes' => array(
 117                 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'),
 118                 'notice_profile_id_idx' => array('profile_id', 'created', 'id'),
 119                 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
 120                 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
 121                 'notice_replyto_idx' => array('reply_to')
 122             )
 123         );
 124
 125         if (common_config('search', 'type') == 'fulltext') {
 126             $def['fulltext indexes'] = array('content' => array('content'));
 127         }
 128
 129         return $def;
 130     }
 131
 132     /* Notice types */
 133     const LOCAL_PUBLIC    =  1;
 134     const REMOTE          =  0;
 135     const LOCAL_NONPUBLIC = -1;
 136     const GATEWAY         = -2;
 137
 138     const PUBLIC_SCOPE    = 0; // Useful fake constant
 139     const SITE_SCOPE      = 1;
 140     const ADDRESSEE_SCOPE = 2;
 141     const GROUP_SCOPE     = 4;
 142     const FOLLOWER_SCOPE  = 8;
 143
 144     protected $_profile = array();
 145
 146     /**
 147      * Will always return a profile, if anything fails it will
 148      * (through _setProfile) throw a NoProfileException.
 149      */
 150     public function getProfile()
 151     {
 152         if (!isset($this->_profile[$this->profile_id])) {
 153             // We could've sent getKV directly to _setProfile, but occasionally we get
 154             // a "false" (instead of null), likely because it indicates a cache miss.
 155             $profile = Profile::getKV('id', $this->profile_id);
 156             $this->_setProfile($profile instanceof Profile ? $profile : null);
 157         }
 158         return $this->_profile[$this->profile_id];
 159     }
 160
 161     public function _setProfile(Profile $profile=null)
 162     {
 163         if (!$profile instanceof Profile) {
 164             throw new NoProfileException($this->profile_id);
 165         }
 166         $this->_profile[$this->profile_id] = $profile;
 167     }
 168
 169     function delete($useWhere=false)
 170     {
 171         // For auditing purposes, save a record that the notice
 172         // was deleted.
 173
 174         // @fixme we have some cases where things get re-run and so the
 175         // insert fails.
 176         $deleted = Deleted_notice::getKV('id', $this->id);
 177
 178         if (!$deleted instanceof Deleted_notice) {
 179             $deleted = Deleted_notice::getKV('uri', $this->uri);
 180         }
 181
 182         if (!$deleted instanceof Deleted_notice) {
 183             $deleted = new Deleted_notice();
 184
 185             $deleted->id         = $this->id;
 186             $deleted->profile_id = $this->profile_id;
 187             $deleted->uri        = $this->uri;
 188             $deleted->created    = $this->created;
 189             $deleted->deleted    = common_sql_now();
 190
 191             $deleted->insert();
 192         }
 193
 194         if (Event::handle('NoticeDeleteRelated', array($this))) {
 195
 196             // Clear related records
 197
 198             $this->clearReplies();
 199             $this->clearRepeats();
 200             $this->clearTags();
 201             $this->clearGroupInboxes();
 202             $this->clearFiles();
 203             $this->clearAttentions();
 204
 205             // NOTE: we don't clear queue items
 206         }
 207
 208         $result = parent::delete($useWhere);
 209
 210         $this->blowOnDelete();
 211         return $result;
 212     }
 213
 214     public function getUri()
 215     {
 216         return $this->uri;
 217     }
 218
 219     /*
 220      * Get a Notice object by URI. Will call external plugins for help
 221      * using the event StartGetNoticeFromURI.
 222      *
 223      * @param string $uri A unique identifier for a resource (notice in this case)
 224      */
 225     static function fromUri($uri)
 226     {
 227         $notice = null;
 228
 229         if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
 230             $notice = Notice::getKV('uri', $uri);
 231             Event::handle('EndGetNoticeFromUri', array($uri, $notice));
 232         }
 233
 234         if (!$notice instanceof Notice) {
 235             throw new UnknownUriException($uri);
 236         }
 237
 238         return $notice;
 239     }
 240
 241     /*
 242      * @param $root boolean If true, link to just the conversation root.
 243      *
 244      * @return URL to conversation
 245      */
 246     public function getConversationUrl($anchor=true)
 247     {
 248         return Conversation::getUrlFromNotice($this, $anchor);
 249     }
 250
 251     /*
 252      * Get the local representation URL of this notice.
 253      */
 254     public function getLocalUrl()
 255     {
 256         return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
 257     }
 258
 259     public function getTitle()
 260     {
 261         $title = null;
 262         if (Event::handle('GetNoticeTitle', array($this, &$title))) {
 263             // TRANS: Title of a notice posted without a title value.
 264             // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
 265             $title = sprintf(_('%1$s\'s status on %2$s'),
 266                              $this->getProfile()->getFancyName(),
 267                              common_exact_date($this->created));
 268         }
 269         return $title;
 270     }
 271
 272     public function getContent()
 273     {
 274         return $this->content;
 275     }
 276
 277     /*
 278      * Get the original representation URL of this notice.
 279      */
 280     public function getUrl()
 281     {
 282         // The risk is we start having empty urls and non-http uris...
 283         // and we can't really handle any other protocol right now.
 284         switch (true) {
 285         case common_valid_http_url($this->url): // should we allow non-http/https URLs?
 286             return $this->url;
 287         case $this->isLocal():
 288             // let's generate a valid link to our locally available notice on demand
 289             return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
 290         case common_valid_http_url($this->uri):
 291             return $this->uri;
 292         default:
 293             common_debug('No URL available for notice: id='.$this->id);
 294             throw new InvalidUrlException($this->url);
 295         }
 296     }
 297
 298     public function get_object_type($canonical=false) {
 299         return $canonical
 300                 ? ActivityObject::canonicalType($this->object_type)
 301                 : $this->object_type;
 302     }
 303
 304     public static function getByUri($uri)
 305     {
 306         $notice = new Notice();
 307         $notice->uri = $uri;
 308         if (!$notice->find(true)) {
 309             throw new NoResultException($notice);
 310         }
 311         return $notice;
 312     }
 313
 314     /**
 315      * Extract #hashtags from this notice's content and save them to the database.
 316      */
 317     function saveTags()
 318     {
 319         /* extract all #hastags */
 320         $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
 321         if (!$count) {
 322             return true;
 323         }
 324
 325         /* Add them to the database */
 326         return $this->saveKnownTags($match[1]);
 327     }
 328
 329     /**
 330      * Record the given set of hash tags in the db for this notice.
 331      * Given tag strings will be normalized and checked for dupes.
 332      */
 333     function saveKnownTags($hashtags)
 334     {
 335         //turn each into their canonical tag
 336         //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
 337         for($i=0; $i<count($hashtags); $i++) {
 338             /* elide characters we don't want in the tag */
 339             $hashtags[$i] = common_canonical_tag($hashtags[$i]);
 340         }
 341
 342         foreach(array_unique($hashtags) as $hashtag) {
 343             $this->saveTag($hashtag);
 344             self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
 345         }
 346         return true;
 347     }
 348
 349     /**
 350      * Record a single hash tag as associated with this notice.
 351      * Tag format and uniqueness must be validated by caller.
 352      */
 353     function saveTag($hashtag)
 354     {
 355         $tag = new Notice_tag();
 356         $tag->notice_id = $this->id;
 357         $tag->tag = $hashtag;
 358         $tag->created = $this->created;
 359         $id = $tag->insert();
 360
 361         if (!$id) {
 362             // TRANS: Server exception. %s are the error details.
 363             throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
 364                                               $last_error->message));
 365             return;
 366         }
 367
 368         // if it's saved, blow its cache
 369         $tag->blowCache(false);
 370     }
 371
 372     /**
 373      * Save a new notice and push it out to subscribers' inboxes.
 374      * Poster's permissions are checked before sending.
 375      *
 376      * @param int $profile_id Profile ID of the poster
 377      * @param string $content source message text; links may be shortened
 378      *                        per current user's preference
 379      * @param string $source source key ('web', 'api', etc)
 380      * @param array $options Associative array of optional properties:
 381      *              string 'created' timestamp of notice; defaults to now
 382      *              int 'is_local' source/gateway ID, one of:
 383      *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
 384      *                  Notice::REMOTE          - Sent from a remote service;
 385      *                                            hide from public timeline but show in
 386      *                                            local "and friends" timelines
 387      *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
 388      *                  Notice::GATEWAY         - From another non-OStatus service;
 389      *                                            will not appear in public views
 390      *              float 'lat' decimal latitude for geolocation
 391      *              float 'lon' decimal longitude for geolocation
 392      *              int 'location_id' geoname identifier
 393      *              int 'location_ns' geoname namespace to interpret location_id
 394      *              int 'reply_to'; notice ID this is a reply to
 395      *              int 'repeat_of'; notice ID this is a repeat of
 396      *              string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
 397      *              string 'url' permalink to notice; defaults to local notice URL
 398      *              string 'rendered' rendered HTML version of content
 399      *              array 'replies' list of profile URIs for reply delivery in
 400      *                              place of extracting @-replies from content.
 401      *              array 'groups' list of group IDs to deliver to, in place of
 402      *                              extracting ! tags from content
 403      *              array 'tags' list of hashtag strings to save with the notice
 404      *                           in place of extracting # tags from content
 405      *              array 'urls' list of attached/referred URLs to save with the
 406      *                           notice in place of extracting links from content
 407      *              boolean 'distribute' whether to distribute the notice, default true
 408      *              string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
 409      *              string 'verb' URL of the associated verb (default ActivityVerb::POST)
 410      *              int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
 411      *
 412      * @fixme tag override
 413      *
 414      * @return Notice
 415      * @throws ClientException
 416      */
 417     static function saveNew($profile_id, $content, $source, array $options=null) {
 418         $defaults = array('uri' => null,
 419                           'url' => null,
 420                           'reply_to' => null,
 421                           'repeat_of' => null,
 422                           'scope' => null,
 423                           'distribute' => true,
 424                           'object_type' => null,
 425                           'verb' => null);
 426
 427         if (!empty($options) && is_array($options)) {
 428             $options = array_merge($defaults, $options);
 429             extract($options);
 430         } else {
 431             extract($defaults);
 432         }
 433
 434         if (!isset($is_local)) {
 435             $is_local = Notice::LOCAL_PUBLIC;
 436         }
 437
 438         $profile = Profile::getKV('id', $profile_id);
 439         if (!$profile instanceof Profile) {
 440             // TRANS: Client exception thrown when trying to save a notice for an unknown user.
 441             throw new ClientException(_('Problem saving notice. Unknown user.'));
 442         }
 443
 444         $user = User::getKV('id', $profile_id);
 445         if ($user instanceof User) {
 446             // Use the local user's shortening preferences, if applicable.
 447             $final = $user->shortenLinks($content);
 448         } else {
 449             $final = common_shorten_links($content);
 450         }
 451
 452         if (Notice::contentTooLong($final)) {
 453             // TRANS: Client exception thrown if a notice contains too many characters.
 454             throw new ClientException(_('Problem saving notice. Too long.'));
 455         }
 456
 457         if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
 458             common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
 459             // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
 460             throw new ClientException(_('Too many notices too fast; take a breather '.
 461                                         'and post again in a few minutes.'));
 462         }
 463
 464         if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
 465             common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
 466             // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
 467             throw new ClientException(_('Too many duplicate messages too quickly;'.
 468                                         ' take a breather and post again in a few minutes.'));
 469         }
 470
 471         if (!$profile->hasRight(Right::NEWNOTICE)) {
 472             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
 473
 474             // TRANS: Client exception thrown when a user tries to post while being banned.
 475             throw new ClientException(_('You are banned from posting notices on this site.'), 403);
 476         }
 477
 478         $notice = new Notice();
 479         $notice->profile_id = $profile_id;
 480
 481         $autosource = common_config('public', 'autosource');
 482
 483         // Sandboxed are non-false, but not 1, either
 484
 485         if (!$profile->hasRight(Right::PUBLICNOTICE) ||
 486             ($source && $autosource && in_array($source, $autosource))) {
 487             $notice->is_local = Notice::LOCAL_NONPUBLIC;
 488         } else {
 489             $notice->is_local = $is_local;
 490         }
 491
 492         if (!empty($created)) {
 493             $notice->created = $created;
 494         } else {
 495             $notice->created = common_sql_now();
 496         }
 497
 498         if (!$notice->isLocal()) {
 499             // Only do these checks for non-local notices. Local notices will generate these values later.
 500             if (!common_valid_http_url($url)) {
 501                 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
 502             }
 503             if (empty($uri)) {
 504                 throw new ServerException('No URI for remote notice. Cannot accept that.');
 505             }
 506         }
 507
 508         $notice->content = $final;
 509
 510         $notice->source = $source;
 511         $notice->uri = $uri;
 512         $notice->url = $url;
 513
 514         // Get the groups here so we can figure out replies and such
 515         if (!isset($groups)) {
 516             $groups = User_group::idsFromText($notice->content, $profile);
 517         }
 518
 519         $reply = null;
 520
 521         // Handle repeat case
 522
 523         if (isset($repeat_of)) {
 524
 525             // Check for a private one
 526
 527             $repeat = Notice::getKV('id', $repeat_of);
 528
 529             if (!($repeat instanceof Notice)) {
 530                 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
 531                 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
 532             }
 533
 534             if ($profile->id == $repeat->profile_id) {
 535                 // TRANS: Client error displayed when trying to repeat an own notice.
 536                 throw new ClientException(_('You cannot repeat your own notice.'));
 537             }
 538
 539             if ($repeat->scope != Notice::SITE_SCOPE &&
 540                 $repeat->scope != Notice::PUBLIC_SCOPE) {
 541                 // TRANS: Client error displayed when trying to repeat a non-public notice.
 542                 throw new ClientException(_('Cannot repeat a private notice.'), 403);
 543             }
 544
 545             if (!$repeat->inScope($profile)) {
 546                 // The generic checks above should cover this, but let's be sure!
 547                 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
 548                 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
 549             }
 550
 551             if ($profile->hasRepeated($repeat)) {
 552                 // TRANS: Client error displayed when trying to repeat an already repeated notice.
 553                 throw new ClientException(_('You already repeated that notice.'));
 554             }
 555
 556             $notice->repeat_of = $repeat->id;
 557             $notice->conversation = $repeat->conversation;
 558         } else {
 559             $reply = null;
 560
 561             // If $reply_to is specified, we check that it exists, and then
 562             // return it if it does
 563             if (!empty($reply_to)) {
 564                 $reply = Notice::getKV('id', $reply_to);
 565             } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
 566                 // If the source lacks capability of sending the "reply_to"
 567                 // metadata, let's try to find an inline replyto-reference.
 568                 $reply = self::getInlineReplyTo($profile, $final);
 569             }
 570
 571             if ($reply instanceof Notice) {
 572                 if (!$reply->inScope($profile)) {
 573                     // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
 574                     // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
 575                     throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
 576                                                       $profile->nickname, $reply->id), 403);
 577                 }
 578
 579                 // If it's a repeat, the reply_to should be to the original
 580                 if ($reply->isRepeat()) {
 581                     $notice->reply_to = $reply->repeat_of;
 582                 } else {
 583                     $notice->reply_to = $reply->id;
 584                 }
 585                 // But the conversation ought to be the same :)
 586                 $notice->conversation = $reply->conversation;
 587
 588                 // If the original is private to a group, and notice has
 589                 // no group specified, make it to the same group(s)
 590
 591                 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
 592                     $groups = array();
 593                     $replyGroups = $reply->getGroups();
 594                     foreach ($replyGroups as $group) {
 595                         if ($profile->isMember($group)) {
 596                             $groups[] = $group->id;
 597                         }
 598                     }
 599                 }
 600
 601                 // Scope set below
 602             }
 603         }
 604
 605         if (!empty($lat) && !empty($lon)) {
 606             $notice->lat = $lat;
 607             $notice->lon = $lon;
 608         }
 609
 610         if (!empty($location_ns) && !empty($location_id)) {
 611             $notice->location_id = $location_id;
 612             $notice->location_ns = $location_ns;
 613         }
 614
 615         if (!empty($rendered)) {
 616             $notice->rendered = $rendered;
 617         } else {
 618             $notice->rendered = common_render_content($final, $notice);
 619         }
 620
 621         if (empty($verb)) {
 622             if ($notice->isRepeat()) {
 623                 $notice->verb        = ActivityVerb::SHARE;
 624                 $notice->object_type = ActivityObject::ACTIVITY;
 625             } else {
 626                 $notice->verb        = ActivityVerb::POST;
 627             }
 628         } else {
 629             $notice->verb = $verb;
 630         }
 631
 632         if (empty($object_type)) {
 633             $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
 634         } else {
 635             $notice->object_type = $object_type;
 636         }
 637
 638         if (is_null($scope) && $reply instanceof Notice) {
 639             $notice->scope = $reply->scope;
 640         } else {
 641             $notice->scope = $scope;
 642         }
 643
 644         $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
 645
 646         if (Event::handle('StartNoticeSave', array(&$notice))) {
 647
 648             // XXX: some of these functions write to the DB
 649
 650             try {
 651                 $notice->insert();  // throws exception on failure
 652             } catch (Exception $e) {
 653                 // Let's test if we managed initial insert, which would imply
 654                 // failing on some update-part (check 'insert()'). Delete if
 655                 // something had been stored to the database.
 656                 if (!empty($notice->id)) {
 657                     $notice->delete();
 658                 }
 659             }
 660         }
 661
 662         // Clear the cache for subscribed users, so they'll update at next request
 663         // XXX: someone clever could prepend instead of clearing the cache
 664
 665         // Save per-notice metadata...
 666
 667         if (isset($replies)) {
 668             $notice->saveKnownReplies($replies);
 669         } else {
 670             $notice->saveReplies();
 671         }
 672
 673         if (isset($tags)) {
 674             $notice->saveKnownTags($tags);
 675         } else {
 676             $notice->saveTags();
 677         }
 678
 679         // Note: groups may save tags, so must be run after tags are saved
 680         // to avoid errors on duplicates.
 681         // Note: groups should always be set.
 682
 683         $notice->saveKnownGroups($groups);
 684
 685         if (isset($urls)) {
 686             $notice->saveKnownUrls($urls);
 687         } else {
 688             $notice->saveUrls();
 689         }
 690
 691         if ($distribute) {
 692             // Prepare inbox delivery, may be queued to background.
 693             $notice->distribute();
 694         }
 695
 696         return $notice;
 697     }
 698
 699     static function saveActivity(Activity $act, Profile $actor, array $options=array())
 700     {
 701         // First check if we're going to let this Activity through from the specific actor
 702         if (!$actor->hasRight(Right::NEWNOTICE)) {
 703             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
 704
 705             // TRANS: Client exception thrown when a user tries to post while being banned.
 706             throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
 707         }
 708         if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
 709             common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
 710             // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
 711             throw new ClientException(_m('Too many notices too fast; take a breather '.
 712                                         'and post again in a few minutes.'));
 713         }
 714
 715 /* This interferes with stuff like Favorites from old StatusNet installations (first object in objects is the favored notice)
 716         // Get ActivityObject properties
 717         $actobj = count($act->objects)==1 ? $act->objects[0] : null;
 718         if (!is_null($actobj) && $actobj->id) {
 719             $options['uri'] = $actobj->id;
 720             if ($actobj->link) {
 721                 $options['url'] = $actobj->link;
 722             } elseif ($act->link) {
 723                 $options['url'] = $act->link;
 724             } elseif (preg_match('!^https?://!', $actobj->id)) {
 725                 $options['url'] = $actobj->id;
 726             }
 727         } else {
 728             // implied object
 729             $options['uri'] = $act->id;
 730             $options['url'] = $act->link;
 731         }
 732 */
 733
 734         $defaults = array(
 735                           'groups'   => array(),
 736                           'is_local' => self::LOCAL_PUBLIC,
 737                           'mentions' => array(),
 738                           'reply_to' => null,
 739                           'repeat_of' => null,
 740                           'scope' => null,
 741                           'source' => 'unknown',
 742                           'tags' => array(),
 743                           'uri' => null,
 744                           'url' => null,
 745                           'urls' => array(),
 746                           'distribute' => true);
 747
 748         // options will have default values when nothing has been supplied
 749         $options = array_merge($defaults, $options);
 750         foreach (array_keys($defaults) as $key) {
 751             // Only convert the keynames we specify ourselves from 'defaults' array into variables
 752             $$key = $options[$key];
 753         }
 754         extract($options, EXTR_SKIP);
 755
 756         $stored = new Notice();
 757         if (!empty($uri)) {
 758             $stored->uri = $uri;
 759             if ($stored->find()) {
 760                 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
 761                 throw new Exception('Notice URI already exists');
 762             }
 763         }
 764
 765         $stored->profile_id = $actor->id;
 766         $stored->source = $source;
 767         $stored->uri = $uri;
 768         $stored->url = $url;
 769         $stored->verb = $act->verb;
 770
 771         // Use the local user's shortening preferences, if applicable.
 772         $stored->content = $actor->isLocal()
 773                                 ? $actor->shortenLinks($act->content)
 774                                 : $act->content;
 775
 776         $autosource = common_config('public', 'autosource');
 777
 778         // Sandboxed are non-false, but not 1, either
 779         if (!$actor->hasRight(Right::PUBLICNOTICE) ||
 780             ($source && $autosource && in_array($source, $autosource))) {
 781             $stored->is_local = Notice::LOCAL_NONPUBLIC;
 782         }
 783
 784         // Maybe a missing act-time should be fatal if the actor is not local?
 785         if (!empty($act->time)) {
 786             $stored->created = common_sql_date($act->time);
 787         } else {
 788             $stored->created = common_sql_now();
 789         }
 790
 791         $reply = null;
 792         if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
 793             $reply = self::getKV('uri', $act->context->replyToID);
 794         }
 795         if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
 796             $reply = self::getKV('uri', $act->target->id);
 797         }
 798
 799         if ($reply instanceof Notice) {
 800             if (!$reply->inScope($actor)) {
 801                 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
 802                 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
 803                 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
 804             }
 805
 806             $stored->reply_to     = $reply->id;
 807             $stored->conversation = $reply->conversation;
 808
 809             // If the original is private to a group, and notice has no group specified,
 810             // make it to the same group(s)
 811             if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
 812                 $groups = array();
 813                 $replyGroups = $reply->getGroups();
 814                 foreach ($replyGroups as $group) {
 815                     if ($actor->isMember($group)) {
 816                         $groups[] = $group->id;
 817                     }
 818                 }
 819             }
 820
 821             if (is_null($scope)) {
 822                 $scope = $reply->scope;
 823             }
 824         }
 825
 826         if ($act->context instanceof ActivityContext) {
 827             $location = $act->context->location;
 828             if ($location) {
 829                 $stored->lat = $location->lat;
 830                 $stored->lon = $location->lon;
 831                 if ($location->location_id) {
 832                     $stored->location_ns = $location->location_ns;
 833                     $stored->location_id = $location->location_id;
 834                 }
 835             }
 836         } else {
 837             $act->context = new ActivityContext();
 838         }
 839
 840         $stored->scope = self::figureOutScope($actor, $groups, $scope);
 841
 842         foreach ($act->categories as $cat) {
 843             if ($cat->term) {
 844                 $term = common_canonical_tag($cat->term);
 845                 if (!empty($term)) {
 846                     $tags[] = $term;
 847                 }
 848             }
 849         }
 850
 851         foreach ($act->enclosures as $href) {
 852             // @todo FIXME: Save these locally or....?
 853             $urls[] = $href;
 854         }
 855
 856         if (Event::handle('StartNoticeSave', array(&$stored))) {
 857             // XXX: some of these functions write to the DB
 858
 859             try {
 860                 $stored->insert();    // throws exception on error
 861
 862                 $object = null;
 863                 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
 864                 if (empty($object)) {
 865                     throw new ServerException('No object from StoreActivityObject '.$stored->uri . ': '.$act->asString());
 866                 }
 867                 $orig = clone($stored);
 868                 $stored->object_type = ActivityUtils::resolveUri($object->getObjectType(), true);
 869                 $stored->update($orig);
 870             } catch (Exception $e) {
 871                 if (empty($stored->id)) {
 872                     common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
 873                 } else {
 874                     common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
 875                     $stored->delete();
 876                 }
 877                 throw $e;
 878             }
 879         }
 880         if (!$stored instanceof Notice) {
 881             throw new ServerException('StartNoticeSave did not give back a Notice');
 882         }
 883
 884         // Save per-notice metadata...
 885         $mentions = array();
 886         $groups   = array();
 887
 888         // This event lets plugins filter out non-local recipients (attentions we don't care about)
 889         // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway)
 890         Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups));
 891
 892         if (!empty($mentions)) {
 893             $stored->saveKnownReplies($mentions);
 894         } else {
 895             $stored->saveReplies();
 896         }
 897
 898         if (!empty($tags)) {
 899             $stored->saveKnownTags($tags);
 900         } else {
 901             $stored->saveTags();
 902         }
 903
 904         // Note: groups may save tags, so must be run after tags are saved
 905         // to avoid errors on duplicates.
 906         // Note: groups should always be set.
 907
 908         $stored->saveKnownGroups($groups);
 909
 910         if (!empty($urls)) {
 911             $stored->saveKnownUrls($urls);
 912         } else {
 913             $stored->saveUrls();
 914         }
 915
 916         if ($distribute) {
 917             // Prepare inbox delivery, may be queued to background.
 918             $stored->distribute();
 919         }
 920
 921         return $stored;
 922     }
 923
 924     static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
 925         if (is_null($scope)) {
 926             $scope = self::defaultScope();
 927         }
 928
 929         // For private streams
 930         try {
 931             $user = $actor->getUser();
 932             // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
 933             if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) {
 934                 $scope |= Notice::FOLLOWER_SCOPE;
 935             }
 936         } catch (NoSuchUserException $e) {
 937             // TODO: Not a local user, so we don't know about scope preferences... yet!
 938         }
 939
 940         // Force the scope for private groups
 941         foreach ($groups as $group_id) {
 942             $group = User_group::staticGet('id', $group_id);
 943             if ($group instanceof User_group) {
 944                 if ($group->force_scope) {
 945                     $scope |= Notice::GROUP_SCOPE;
 946                     break;
 947                 }
 948             }
 949         }
 950
 951         return $scope;
 952     }
 953
 954     function blowOnInsert($conversation = false)
 955     {
 956         $this->blowStream('profile:notice_ids:%d', $this->profile_id);
 957
 958         if ($this->isPublic()) {
 959             $this->blowStream('public');
 960         }
 961
 962         self::blow('notice:list-ids:conversation:%s', $this->conversation);
 963         self::blow('conversation:notice_count:%d', $this->conversation);
 964
 965         if ($this->isRepeat()) {
 966             // XXX: we should probably only use one of these
 967             $this->blowStream('notice:repeats:%d', $this->repeat_of);
 968             self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
 969         }
 970
 971         $original = Notice::getKV('id', $this->repeat_of);
 972
 973         if ($original instanceof Notice) {
 974             $originalUser = User::getKV('id', $original->profile_id);
 975             if ($originalUser instanceof User) {
 976                 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
 977             }
 978         }
 979
 980         $profile = Profile::getKV($this->profile_id);
 981
 982         if ($profile instanceof Profile) {
 983             $profile->blowNoticeCount();
 984         }
 985
 986         $ptags = $this->getProfileTags();
 987         foreach ($ptags as $ptag) {
 988             $ptag->blowNoticeStreamCache();
 989         }
 990     }
 991
 992     /**
 993      * Clear cache entries related to this notice at delete time.
 994      * Necessary to avoid breaking paging on public, profile timelines.
 995      */
 996     function blowOnDelete()
 997     {
 998         $this->blowOnInsert();
 999
1000         self::blow('profile:notice_ids:%d;last', $this->profile_id);
1001
1002         if ($this->isPublic()) {
1003             self::blow('public;last');
1004         }
1005
1006         self::blow('fave:by_notice', $this->id);
1007
1008         if ($this->conversation) {
1009             // In case we're the first, will need to calc a new root.
1010             self::blow('notice:conversation_root:%d', $this->conversation);
1011         }
1012
1013         $ptags = $this->getProfileTags();
1014         foreach ($ptags as $ptag) {
1015             $ptag->blowNoticeStreamCache(true);
1016         }
1017     }
1018
1019     function blowStream()
1020     {
1021         $c = self::memcache();
1022
1023         if (empty($c)) {
1024             return false;
1025         }
1026
1027         $args = func_get_args();
1028
1029         $format = array_shift($args);
1030
1031         $keyPart = vsprintf($format, $args);
1032
1033         $cacheKey = Cache::key($keyPart);
1034
1035         $c->delete($cacheKey);
1036
1037         // delete the "last" stream, too, if this notice is
1038         // older than the top of that stream
1039
1040         $lastKey = $cacheKey.';last';
1041
1042         $lastStr = $c->get($lastKey);
1043
1044         if ($lastStr !== false) {
1045             $window     = explode(',', $lastStr);
1046             $lastID     = $window[0];
1047             $lastNotice = Notice::getKV('id', $lastID);
1048             if (!$lastNotice instanceof Notice // just weird
1049                 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1050                 $c->delete($lastKey);
1051             }
1052         }
1053     }
1054
1055     /** save all urls in the notice to the db
1056      *
1057      * follow redirects and save all available file information
1058      * (mimetype, date, size, oembed, etc.)
1059      *
1060      * @return void
1061      */
1062     function saveUrls() {
1063         if (common_config('attachments', 'process_links')) {
1064             common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
1065         }
1066     }
1067
1068     /**
1069      * Save the given URLs as related links/attachments to the db
1070      *
1071      * follow redirects and save all available file information
1072      * (mimetype, date, size, oembed, etc.)
1073      *
1074      * @return void
1075      */
1076     function saveKnownUrls($urls)
1077     {
1078         if (common_config('attachments', 'process_links')) {
1079             // @fixme validation?
1080             foreach (array_unique($urls) as $url) {
1081                 try {
1082                     File::processNew($url, $this->id);
1083                 } catch (ServerException $e) {
1084                     // Could not save URL. Log it?
1085                 }
1086             }
1087         }
1088     }
1089
1090     /**
1091      * @private callback
1092      */
1093     function saveUrl($url, $notice_id) {
1094         try {
1095             File::processNew($url, $notice_id);
1096         } catch (ServerException $e) {
1097             // Could not save URL. Log it?
1098         }
1099     }
1100
1101     static function checkDupes($profile_id, $content) {
1102         $profile = Profile::getKV($profile_id);
1103         if (!$profile instanceof Profile) {
1104             return false;
1105         }
1106         $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1107         if (!empty($notice)) {
1108             $last = 0;
1109             while ($notice->fetch()) {
1110                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1111                     return true;
1112                 } else if ($notice->content == $content) {
1113                     return false;
1114                 }
1115             }
1116         }
1117         // If we get here, oldest item in cache window is not
1118         // old enough for dupe limit; do direct check against DB
1119         $notice = new Notice();
1120         $notice->profile_id = $profile_id;
1121         $notice->content = $content;
1122         $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1123         $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1124
1125         $cnt = $notice->count();
1126         return ($cnt == 0);
1127     }
1128
1129     static function checkEditThrottle($profile_id) {
1130         $profile = Profile::getKV($profile_id);
1131         if (!$profile instanceof Profile) {
1132             return false;
1133         }
1134         // Get the Nth notice
1135         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1136         if ($notice && $notice->fetch()) {
1137             // If the Nth notice was posted less than timespan seconds ago
1138             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1139                 // Then we throttle
1140                 return false;
1141             }
1142         }
1143         // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1144         return true;
1145     }
1146
1147         protected $_attachments = array();
1148
1149     function attachments() {
1150                 if (isset($this->_attachments[$this->id])) {
1151             return $this->_attachments[$this->id];
1152         }
1153
1154         $f2ps = File_to_post::listGet('post_id', array($this->id));
1155
1156                 $ids = array();
1157
1158                 foreach ($f2ps[$this->id] as $f2p) {
1159             $ids[] = $f2p->file_id;
1160         }
1161
1162                 $files = File::multiGet('id', $ids);
1163
1164                 $this->_attachments[$this->id] = $files->fetchAll();
1165
1166         return $this->_attachments[$this->id];
1167     }
1168
1169         function _setAttachments($attachments)
1170         {
1171             $this->_attachments[$this->id] = $attachments;
1172         }
1173
1174     function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
1175     {
1176         $stream = new PublicNoticeStream();
1177         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1178     }
1179
1180
1181     function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
1182     {
1183         $stream = new ConversationNoticeStream($id);
1184
1185         return $stream->getNotices($offset, $limit, $since_id, $max_id);
1186     }
1187
1188     /**
1189      * Is this notice part of an active conversation?
1190      *
1191      * @return boolean true if other messages exist in the same
1192      *                 conversation, false if this is the only one
1193      */
1194     function hasConversation()
1195     {
1196         if (!empty($this->conversation)) {
1197             $conversation = Notice::conversationStream(
1198                 $this->conversation,
1199                 1,
1200                 1
1201             );
1202
1203             if ($conversation->N > 0) {
1204                 return true;
1205             }
1206         }
1207         return false;
1208     }
1209
1210     /**
1211      * Grab the earliest notice from this conversation.
1212      *
1213      * @return Notice or null
1214      */
1215     function conversationRoot($profile=-1)
1216     {
1217         // XXX: can this happen?
1218
1219         if (empty($this->conversation)) {
1220             return null;
1221         }
1222
1223         // Get the current profile if not specified
1224
1225         if (is_int($profile) && $profile == -1) {
1226             $profile = Profile::current();
1227         }
1228
1229         // If this notice is out of scope, no root for you!
1230
1231         if (!$this->inScope($profile)) {
1232             return null;
1233         }
1234
1235         // If this isn't a reply to anything, then it's its own
1236         // root.
1237
1238         if (empty($this->reply_to)) {
1239             return $this;
1240         }
1241
1242         if (is_null($profile)) {
1243             $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1244         } else {
1245             $keypart = sprintf('notice:conversation_root:%d:%d',
1246                                $this->id,
1247                                $profile->id);
1248         }
1249
1250         $root = self::cacheGet($keypart);
1251
1252         if ($root !== false && $root->inScope($profile)) {
1253             return $root;
1254         }
1255
1256         $last = $this;
1257         while (true) {
1258             try {
1259                 $parent = $last->getParent();
1260                 if ($parent->inScope($profile)) {
1261                     $last = $parent;
1262                     continue;
1263                 }
1264             } catch (Exception $e) {
1265                 // Latest notice has no parent
1266             }
1267             // No parent, or parent out of scope
1268             $root = $last;
1269             break;
1270         }
1271
1272         self::cacheSet($keypart, $root);
1273
1274         return $root;
1275     }
1276
1277     /**
1278      * Pull up a full list of local recipients who will be getting
1279      * this notice in their inbox. Results will be cached, so don't
1280      * change the input data wily-nilly!
1281      *
1282      * @param array $groups optional list of Group objects;
1283      *              if left empty, will be loaded from group_inbox records
1284      * @param array $recipient optional list of reply profile ids
1285      *              if left empty, will be loaded from reply records
1286      * @return array associating recipient user IDs with an inbox source constant
1287      */
1288     function whoGets(array $groups=null, array $recipients=null)
1289     {
1290         $c = self::memcache();
1291
1292         if (!empty($c)) {
1293             $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1294             if ($ni !== false) {
1295                 return $ni;
1296             }
1297         }
1298
1299         if (is_null($recipients)) {
1300             $recipients = $this->getReplies();
1301         }
1302
1303         $ni = array();
1304
1305         // Give plugins a chance to add folks in at start...
1306         if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1307
1308             $users = $this->getSubscribedUsers();
1309             foreach ($users as $id) {
1310                 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1311             }
1312
1313             if (is_null($groups)) {
1314                 $groups = $this->getGroups();
1315             }
1316             foreach ($groups as $group) {
1317                 $users = $group->getUserMembers();
1318                 foreach ($users as $id) {
1319                     if (!array_key_exists($id, $ni)) {
1320                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1321                     }
1322                 }
1323             }
1324
1325             $ptAtts = $this->getAttentionsFromProfileTags();
1326             foreach ($ptAtts as $key=>$val) {
1327                 if (!array_key_exists($key, $ni)) {
1328                     $ni[$key] = $val;
1329                 }
1330             }
1331
1332             foreach ($recipients as $recipient) {
1333                 if (!array_key_exists($recipient, $ni)) {
1334                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1335                 }
1336             }
1337
1338             // Exclude any deleted, non-local, or blocking recipients.
1339             $profile = $this->getProfile();
1340             $originalProfile = null;
1341             if ($this->isRepeat()) {
1342                 // Check blocks against the original notice's poster as well.
1343                 $original = Notice::getKV('id', $this->repeat_of);
1344                 if ($original instanceof Notice) {
1345                     $originalProfile = $original->getProfile();
1346                 }
1347             }
1348
1349             foreach ($ni as $id => $source) {
1350                 try {
1351                     $user = User::getKV('id', $id);
1352                     if (!$user instanceof User ||
1353                         $user->hasBlocked($profile) ||
1354                         ($originalProfile && $user->hasBlocked($originalProfile))) {
1355                         unset($ni[$id]);
1356                     }
1357                 } catch (UserNoProfileException $e) {
1358                     // User doesn't have a profile; invalid; skip them.
1359                     unset($ni[$id]);
1360                 }
1361             }
1362
1363             // Give plugins a chance to filter out...
1364             Event::handle('EndNoticeWhoGets', array($this, &$ni));
1365         }
1366
1367         if (!empty($c)) {
1368             // XXX: pack this data better
1369             $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1370         }
1371
1372         return $ni;
1373     }
1374
1375     function getSubscribedUsers()
1376     {
1377         $user = new User();
1378
1379         if(common_config('db','quote_identifiers'))
1380           $user_table = '"user"';
1381         else $user_table = 'user';
1382
1383         $qry =
1384           'SELECT id ' .
1385           'FROM '. $user_table .' JOIN subscription '.
1386           'ON '. $user_table .'.id = subscription.subscriber ' .
1387           'WHERE subscription.subscribed = %d ';
1388
1389         $user->query(sprintf($qry, $this->profile_id));
1390
1391         $ids = array();
1392
1393         while ($user->fetch()) {
1394             $ids[] = $user->id;
1395         }
1396
1397         $user->free();
1398
1399         return $ids;
1400     }
1401
1402     function getProfileTags()
1403     {
1404         $profile = $this->getProfile();
1405         $list    = $profile->getOtherTags($profile);
1406         $ptags   = array();
1407
1408         while($list->fetch()) {
1409             $ptags[] = clone($list);
1410         }
1411
1412         return $ptags;
1413     }
1414
1415     public function getAttentionsFromProfileTags()
1416     {
1417         $ni = array();
1418         $ptags = $this->getProfileTags();
1419         foreach ($ptags as $ptag) {
1420             $users = $ptag->getUserSubscribers();
1421             foreach ($users as $id) {
1422                 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1423             }
1424         }
1425         return $ni;
1426     }
1427
1428     /**
1429      * Record this notice to the given group inboxes for delivery.
1430      * Overrides the regular parsing of !group markup.
1431      *
1432      * @param string $group_ids
1433      * @fixme might prefer URIs as identifiers, as for replies?
1434      *        best with generalizations on user_group to support
1435      *        remote groups better.
1436      */
1437     function saveKnownGroups($group_ids)
1438     {
1439         if (!is_array($group_ids)) {
1440             // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1441             throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1442         }
1443
1444         $groups = array();
1445         foreach (array_unique($group_ids) as $id) {
1446             $group = User_group::getKV('id', $id);
1447             if ($group instanceof User_group) {
1448                 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
1449                 $result = $this->addToGroupInbox($group);
1450                 if (!$result) {
1451                     common_log_db_error($gi, 'INSERT', __FILE__);
1452                 }
1453
1454                 if (common_config('group', 'addtag')) {
1455                     // we automatically add a tag for every group name, too
1456
1457                     $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1458                                                      'notice_id' => $this->id));
1459
1460                     if (is_null($tag)) {
1461                         $this->saveTag($group->nickname);
1462                     }
1463                 }
1464
1465                 $groups[] = clone($group);
1466             } else {
1467                 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1468             }
1469         }
1470
1471         return $groups;
1472     }
1473
1474     function addToGroupInbox(User_group $group)
1475     {
1476         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1477                                          'notice_id' => $this->id));
1478
1479         if (!$gi instanceof Group_inbox) {
1480
1481             $gi = new Group_inbox();
1482
1483             $gi->group_id  = $group->id;
1484             $gi->notice_id = $this->id;
1485             $gi->created   = $this->created;
1486
1487             $result = $gi->insert();
1488
1489             if (!$result) {
1490                 common_log_db_error($gi, 'INSERT', __FILE__);
1491                 // TRANS: Server exception thrown when an update for a group inbox fails.
1492                 throw new ServerException(_('Problem saving group inbox.'));
1493             }
1494
1495             self::blow('user_group:notice_ids:%d', $gi->group_id);
1496         }
1497
1498         return true;
1499     }
1500
1501     /**
1502      * Save reply records indicating that this notice needs to be
1503      * delivered to the local users with the given URIs.
1504      *
1505      * Since this is expected to be used when saving foreign-sourced
1506      * messages, we won't deliver to any remote targets as that's the
1507      * source service's responsibility.
1508      *
1509      * Mail notifications etc will be handled later.
1510      *
1511      * @param array  $uris   Array of unique identifier URIs for recipients
1512      */
1513     function saveKnownReplies(array $uris)
1514     {
1515         if (empty($uris)) {
1516             return;
1517         }
1518
1519         $sender = Profile::getKV($this->profile_id);
1520
1521         foreach (array_unique($uris) as $uri) {
1522             try {
1523                 $profile = Profile::fromUri($uri);
1524             } catch (UnknownUriException $e) {
1525                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1526                 continue;
1527             }
1528
1529             if ($profile->hasBlocked($sender)) {
1530                 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1531                 continue;
1532             }
1533
1534             $this->saveReply($profile->id);
1535             self::blow('reply:stream:%d', $profile->id);
1536         }
1537
1538         return;
1539     }
1540
1541     /**
1542      * Pull @-replies from this message's content in StatusNet markup format
1543      * and save reply records indicating that this message needs to be
1544      * delivered to those users.
1545      *
1546      * Mail notifications to local profiles will be sent later.
1547      *
1548      * @return array of integer profile IDs
1549      */
1550
1551     function saveReplies()
1552     {
1553         // Don't save reply data for repeats
1554
1555         if ($this->isRepeat()) {
1556             return array();
1557         }
1558
1559         $sender = $this->getProfile();
1560
1561         $replied = array();
1562
1563         // If it's a reply, save for the replied-to author
1564         try {
1565             $parent = $this->getParent();
1566             $parentauthor = $parent->getProfile();
1567             $this->saveReply($parentauthor->id);
1568             $replied[$parentauthor->id] = 1;
1569             self::blow('reply:stream:%d', $parentauthor->id);
1570         } catch (Exception $e) {
1571             // Not a reply, since it has no parent!
1572         }
1573
1574         // @todo ideally this parser information would only
1575         // be calculated once.
1576
1577         $mentions = common_find_mentions($this->content, $this);
1578
1579         // store replied only for first @ (what user/notice what the reply directed,
1580         // we assume first @ is it)
1581
1582         foreach ($mentions as $mention) {
1583
1584             foreach ($mention['mentioned'] as $mentioned) {
1585
1586                 // skip if they're already covered
1587
1588                 if (!empty($replied[$mentioned->id])) {
1589                     continue;
1590                 }
1591
1592                 // Don't save replies from blocked profile to local user
1593
1594                 $mentioned_user = User::getKV('id', $mentioned->id);
1595                 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1596                     continue;
1597                 }
1598
1599                 $this->saveReply($mentioned->id);
1600                 $replied[$mentioned->id] = 1;
1601                 self::blow('reply:stream:%d', $mentioned->id);
1602             }
1603         }
1604
1605         $recipientIds = array_keys($replied);
1606
1607         return $recipientIds;
1608     }
1609
1610     function saveReply($profileId)
1611     {
1612         $reply = new Reply();
1613
1614         $reply->notice_id  = $this->id;
1615         $reply->profile_id = $profileId;
1616         $reply->modified   = $this->created;
1617
1618         $reply->insert();
1619
1620         return $reply;
1621     }
1622
1623     protected $_replies = array();
1624
1625     /**
1626      * Pull the complete list of @-reply targets for this notice.
1627      *
1628      * @return array of integer profile ids
1629      */
1630     function getReplies()
1631     {
1632         if (isset($this->_replies[$this->id])) {
1633             return $this->_replies[$this->id];
1634         }
1635
1636         $replyMap = Reply::listGet('notice_id', array($this->id));
1637
1638         $ids = array();
1639
1640         foreach ($replyMap[$this->id] as $reply) {
1641             $ids[] = $reply->profile_id;
1642         }
1643
1644         $this->_replies[$this->id] = $ids;
1645
1646         return $ids;
1647     }
1648
1649     function _setReplies($replies)
1650     {
1651         $this->_replies[$this->id] = $replies;
1652     }
1653
1654     /**
1655      * Pull the complete list of @-reply targets for this notice.
1656      *
1657      * @return array of Profiles
1658      */
1659     function getReplyProfiles()
1660     {
1661         $ids = $this->getReplies();
1662
1663         $profiles = Profile::multiGet('id', $ids);
1664
1665         return $profiles->fetchAll();
1666     }
1667
1668     /**
1669      * Send e-mail notifications to local @-reply targets.
1670      *
1671      * Replies must already have been saved; this is expected to be run
1672      * from the distrib queue handler.
1673      */
1674     function sendReplyNotifications()
1675     {
1676         // Don't send reply notifications for repeats
1677
1678         if ($this->isRepeat()) {
1679             return array();
1680         }
1681
1682         $recipientIds = $this->getReplies();
1683         if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1684             require_once INSTALLDIR.'/lib/mail.php';
1685
1686             foreach ($recipientIds as $recipientId) {
1687                 $user = User::getKV('id', $recipientId);
1688                 if ($user instanceof User) {
1689                     mail_notify_attn($user, $this);
1690                 }
1691             }
1692             Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1693         }
1694     }
1695
1696     /**
1697      * Pull list of groups this notice needs to be delivered to,
1698      * as previously recorded by saveKnownGroups().
1699      *
1700      * @return array of Group objects
1701      */
1702
1703     protected $_groups = array();
1704
1705     function getGroups()
1706     {
1707         // Don't save groups for repeats
1708
1709         if (!empty($this->repeat_of)) {
1710             return array();
1711         }
1712
1713         if (isset($this->_groups[$this->id])) {
1714             return $this->_groups[$this->id];
1715         }
1716
1717         $gis = Group_inbox::listGet('notice_id', array($this->id));
1718
1719         $ids = array();
1720
1721                 foreach ($gis[$this->id] as $gi)
1722                 {
1723                     $ids[] = $gi->group_id;
1724                 }
1725
1726                 $groups = User_group::multiGet('id', $ids);
1727
1728                 $this->_groups[$this->id] = $groups->fetchAll();
1729
1730                 return $this->_groups[$this->id];
1731     }
1732
1733     function _setGroups($groups)
1734     {
1735         $this->_groups[$this->id] = $groups;
1736     }
1737
1738     /**
1739      * Convert a notice into an activity for export.
1740      *
1741      * @param User $cur Current user
1742      *
1743      * @return Activity activity object representing this Notice.
1744      */
1745
1746     function asActivity($cur=null)
1747     {
1748         $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1749
1750         if ($act instanceof Activity) {
1751             return $act;
1752         }
1753         $act = new Activity();
1754
1755         if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1756
1757             $act->id      = $this->uri;
1758             $act->time    = strtotime($this->created);
1759             try {
1760                 $act->link    = $this->getUrl();
1761             } catch (InvalidUrlException $e) {
1762                 // The notice is probably a share or similar, which don't
1763                 // have a representational URL of their own.
1764             }
1765             $act->content = common_xml_safe_str($this->rendered);
1766
1767             $profile = $this->getProfile();
1768
1769             $act->actor            = $profile->asActivityObject();
1770             $act->actor->extra[]   = $profile->profileInfo($cur);
1771
1772             $act->verb = $this->verb;
1773
1774             if ($this->repeat_of) {
1775                 $repeated = Notice::getKV('id', $this->repeat_of);
1776                 if ($repeated instanceof Notice) {
1777                     $act->objects[] = $repeated->asActivity($cur);
1778                 }
1779             } else {
1780                 $act->objects[] = $this->asActivityObject();
1781             }
1782
1783             // XXX: should this be handled by default processing for object entry?
1784
1785             // Categories
1786
1787             $tags = $this->getTags();
1788
1789             foreach ($tags as $tag) {
1790                 $cat       = new AtomCategory();
1791                 $cat->term = $tag;
1792
1793                 $act->categories[] = $cat;
1794             }
1795
1796             // Enclosures
1797             // XXX: use Atom Media and/or File activity objects instead
1798
1799             $attachments = $this->attachments();
1800
1801             foreach ($attachments as $attachment) {
1802                 // Save local attachments
1803                 if (!empty($attachment->filename)) {
1804                     $act->attachments[] = ActivityObject::fromFile($attachment);
1805                 }
1806             }
1807
1808             $ctx = new ActivityContext();
1809
1810             try {
1811                 $reply = $this->getParent();
1812                 $ctx->replyToID  = $reply->getUri();
1813                 $ctx->replyToUrl = $reply->getUrl();
1814             } catch (Exception $e) {
1815                 // This is not a reply to something
1816             }
1817
1818             $ctx->location = $this->getLocation();
1819
1820             $conv = null;
1821
1822             if (!empty($this->conversation)) {
1823                 $conv = Conversation::getKV('id', $this->conversation);
1824                 if ($conv instanceof Conversation) {
1825                     $ctx->conversation = $conv->uri;
1826                 }
1827             }
1828
1829             $reply_ids = $this->getReplies();
1830
1831             foreach ($reply_ids as $id) {
1832                 $rprofile = Profile::getKV('id', $id);
1833                 if ($rprofile instanceof Profile) {
1834                     $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1835                 }
1836             }
1837
1838             $groups = $this->getGroups();
1839
1840             foreach ($groups as $group) {
1841                 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1842             }
1843
1844             switch ($this->scope) {
1845             case Notice::PUBLIC_SCOPE:
1846                 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1847                 break;
1848             case Notice::FOLLOWER_SCOPE:
1849                 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1850                 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1851                 break;
1852             }
1853
1854             $act->context = $ctx;
1855
1856             $source = $this->getSource();
1857
1858             if ($source instanceof Notice_source) {
1859                 $act->generator = ActivityObject::fromNoticeSource($source);
1860             }
1861
1862             // Source
1863
1864             $atom_feed = $profile->getAtomFeed();
1865
1866             if (!empty($atom_feed)) {
1867
1868                 $act->source = new ActivitySource();
1869
1870                 // XXX: we should store the actual feed ID
1871
1872                 $act->source->id = $atom_feed;
1873
1874                 // XXX: we should store the actual feed title
1875
1876                 $act->source->title = $profile->getBestName();
1877
1878                 $act->source->links['alternate'] = $profile->profileurl;
1879                 $act->source->links['self']      = $atom_feed;
1880
1881                 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1882
1883                 $notice = $profile->getCurrentNotice();
1884
1885                 if ($notice instanceof Notice) {
1886                     $act->source->updated = self::utcDate($notice->created);
1887                 }
1888
1889                 $user = User::getKV('id', $profile->id);
1890
1891                 if ($user instanceof User) {
1892                     $act->source->links['license'] = common_config('license', 'url');
1893                 }
1894             }
1895
1896             if ($this->isLocal()) {
1897                 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1898                                                                            'format' => 'atom'));
1899                 $act->editLink = $act->selfLink;
1900             }
1901
1902             Event::handle('EndNoticeAsActivity', array($this, &$act));
1903         }
1904
1905         self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1906
1907         return $act;
1908     }
1909
1910     // This has gotten way too long. Needs to be sliced up into functional bits
1911     // or ideally exported to a utility class.
1912
1913     function asAtomEntry($namespace=false,
1914                          $source=false,
1915                          $author=true,
1916                          $cur=null)
1917     {
1918         $act = $this->asActivity($cur);
1919         $act->extra[] = $this->noticeInfo($cur);
1920         return $act->asString($namespace, $author, $source);
1921     }
1922
1923     /**
1924      * Extra notice info for atom entries
1925      *
1926      * Clients use some extra notice info in the atom stream.
1927      * This gives it to them.
1928      *
1929      * @param User $cur Current user
1930      *
1931      * @return array representation of <statusnet:notice_info> element
1932      */
1933
1934     function noticeInfo($cur)
1935     {
1936         // local notice ID (useful to clients for ordering)
1937
1938         $noticeInfoAttr = array('local_id' => $this->id);
1939
1940         // notice source
1941
1942         $ns = $this->getSource();
1943
1944         if ($ns instanceof Notice_source) {
1945             $noticeInfoAttr['source'] =  $ns->code;
1946             if (!empty($ns->url)) {
1947                 $noticeInfoAttr['source_link'] = $ns->url;
1948                 if (!empty($ns->name)) {
1949                     $noticeInfoAttr['source'] =  '<a href="'
1950                         . htmlspecialchars($ns->url)
1951                         . '" rel="nofollow">'
1952                         . htmlspecialchars($ns->name)
1953                         . '</a>';
1954                 }
1955             }
1956         }
1957
1958         // favorite and repeated
1959
1960         $scoped = null;
1961         if (!empty($cur)) {
1962             $scoped = $cur->getProfile();
1963             $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
1964         }
1965
1966         if (!empty($this->repeat_of)) {
1967             $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1968         }
1969
1970         Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
1971
1972         return array('statusnet:notice_info', $noticeInfoAttr, null);
1973     }
1974
1975     /**
1976      * Returns an XML string fragment with a reference to a notice as an
1977      * Activity Streams noun object with the given element type.
1978      *
1979      * Assumes that 'activity' namespace has been previously defined.
1980      *
1981      * @param string $element one of 'subject', 'object', 'target'
1982      * @return string
1983      */
1984
1985     function asActivityNoun($element)
1986     {
1987         $noun = $this->asActivityObject();
1988         return $noun->asString('activity:' . $element);
1989     }
1990
1991     public function asActivityObject()
1992     {
1993         $object = new ActivityObject();
1994
1995         if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
1996             $object->type    = $this->object_type ?: ActivityObject::NOTE;
1997             $object->id      = $this->getUri();
1998             $object->title   = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
1999             $object->content = $this->rendered;
2000             $object->link    = $this->getUrl();
2001
2002             $object->extra[] = array('status_net', array('notice_id' => $this->id));
2003
2004             Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2005         }
2006
2007         return $object;
2008     }
2009
2010     /**
2011      * Determine which notice, if any, a new notice is in reply to.
2012      *
2013      * For conversation tracking, we try to see where this notice fits
2014      * in the tree. Beware that this may very well give false positives
2015      * and add replies to wrong threads (if there have been newer posts
2016      * by the same user as we're replying to).
2017      *
2018      * @param Profile $sender     Author profile
2019      * @param string  $content    Final notice content
2020      *
2021      * @return integer ID of replied-to notice, or null for not a reply.
2022      */
2023
2024     static function getInlineReplyTo(Profile $sender, $content)
2025     {
2026         // Is there an initial @ or T?
2027         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2028                 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2029             $nickname = common_canonical_nickname($match[1]);
2030         } else {
2031             return null;
2032         }
2033
2034         // Figure out who that is.
2035         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2036
2037         if ($recipient instanceof Profile) {
2038             // Get their last notice
2039             $last = $recipient->getCurrentNotice();
2040             if ($last instanceof Notice) {
2041                 return $last;
2042             }
2043             // Maybe in the future we want to handle something else below
2044             // so don't return getCurrentNotice() immediately.
2045         }
2046
2047         return null;
2048     }
2049
2050     static function maxContent()
2051     {
2052         $contentlimit = common_config('notice', 'contentlimit');
2053         // null => use global limit (distinct from 0!)
2054         if (is_null($contentlimit)) {
2055             $contentlimit = common_config('site', 'textlimit');
2056         }
2057         return $contentlimit;
2058     }
2059
2060     static function contentTooLong($content)
2061     {
2062         $contentlimit = self::maxContent();
2063         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2064     }
2065
2066     function getLocation()
2067     {
2068         $location = null;
2069
2070         if (!empty($this->location_id) && !empty($this->location_ns)) {
2071             $location = Location::fromId($this->location_id, $this->location_ns);
2072         }
2073
2074         if (is_null($location)) { // no ID, or Location::fromId() failed
2075             if (!empty($this->lat) && !empty($this->lon)) {
2076                 $location = Location::fromLatLon($this->lat, $this->lon);
2077             }
2078         }
2079
2080         return $location;
2081     }
2082
2083     /**
2084      * Convenience function for posting a repeat of an existing message.
2085      *
2086      * @param Profile $repeater Profile which is doing the repeat
2087      * @param string $source: posting source key, eg 'web', 'api', etc
2088      * @return Notice
2089      *
2090      * @throws Exception on failure or permission problems
2091      */
2092     function repeat(Profile $repeater, $source)
2093     {
2094         $author = $this->getProfile();
2095
2096         // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2097         // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2098         $content = sprintf(_('RT @%1$s %2$s'),
2099                            $author->getNickname(),
2100                            $this->content);
2101
2102         // Scope is same as this one's
2103         return self::saveNew($repeater->id,
2104                              $content,
2105                              $source,
2106                              array('repeat_of' => $this->id,
2107                                    'scope' => $this->scope));
2108     }
2109
2110     // These are supposed to be in chron order!
2111
2112     function repeatStream($limit=100)
2113     {
2114         $cache = Cache::instance();
2115
2116         if (empty($cache)) {
2117             $ids = $this->_repeatStreamDirect($limit);
2118         } else {
2119             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2120             if ($idstr !== false) {
2121                 if (empty($idstr)) {
2122                         $ids = array();
2123                 } else {
2124                         $ids = explode(',', $idstr);
2125                 }
2126             } else {
2127                 $ids = $this->_repeatStreamDirect(100);
2128                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2129             }
2130             if ($limit < 100) {
2131                 // We do a max of 100, so slice down to limit
2132                 $ids = array_slice($ids, 0, $limit);
2133             }
2134         }
2135
2136         return NoticeStream::getStreamByIds($ids);
2137     }
2138
2139     function _repeatStreamDirect($limit)
2140     {
2141         $notice = new Notice();
2142
2143         $notice->selectAdd(); // clears it
2144         $notice->selectAdd('id');
2145
2146         $notice->repeat_of = $this->id;
2147
2148         $notice->orderBy('created, id'); // NB: asc!
2149
2150         if (!is_null($limit)) {
2151             $notice->limit(0, $limit);
2152         }
2153
2154         return $notice->fetchAll('id');
2155     }
2156
2157     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2158     {
2159         $options = array();
2160
2161         if (!empty($location_id) && !empty($location_ns)) {
2162             $options['location_id'] = $location_id;
2163             $options['location_ns'] = $location_ns;
2164
2165             $location = Location::fromId($location_id, $location_ns);
2166
2167             if ($location instanceof Location) {
2168                 $options['lat'] = $location->lat;
2169                 $options['lon'] = $location->lon;
2170             }
2171
2172         } else if (!empty($lat) && !empty($lon)) {
2173             $options['lat'] = $lat;
2174             $options['lon'] = $lon;
2175
2176             $location = Location::fromLatLon($lat, $lon);
2177
2178             if ($location instanceof Location) {
2179                 $options['location_id'] = $location->location_id;
2180                 $options['location_ns'] = $location->location_ns;
2181             }
2182         } else if (!empty($profile)) {
2183             if (isset($profile->lat) && isset($profile->lon)) {
2184                 $options['lat'] = $profile->lat;
2185                 $options['lon'] = $profile->lon;
2186             }
2187
2188             if (isset($profile->location_id) && isset($profile->location_ns)) {
2189                 $options['location_id'] = $profile->location_id;
2190                 $options['location_ns'] = $profile->location_ns;
2191             }
2192         }
2193
2194         return $options;
2195     }
2196
2197     function clearAttentions()
2198     {
2199         $att = new Attention();
2200         $att->notice_id = $this->getID();
2201
2202         if ($att->find()) {
2203             while ($att->fetch()) {
2204                 // Can't do delete() on the object directly since it won't remove all of it
2205                 $other = clone($att);
2206                 $other->delete();
2207             }
2208         }
2209     }
2210
2211     function clearReplies()
2212     {
2213         $replyNotice = new Notice();
2214         $replyNotice->reply_to = $this->id;
2215
2216         //Null any notices that are replies to this notice
2217
2218         if ($replyNotice->find()) {
2219             while ($replyNotice->fetch()) {
2220                 $orig = clone($replyNotice);
2221                 $replyNotice->reply_to = null;
2222                 $replyNotice->update($orig);
2223             }
2224         }
2225
2226         // Reply records
2227
2228         $reply = new Reply();
2229         $reply->notice_id = $this->id;
2230
2231         if ($reply->find()) {
2232             while($reply->fetch()) {
2233                 self::blow('reply:stream:%d', $reply->profile_id);
2234                 $reply->delete();
2235             }
2236         }
2237
2238         $reply->free();
2239     }
2240
2241     function clearFiles()
2242     {
2243         $f2p = new File_to_post();
2244
2245         $f2p->post_id = $this->id;
2246
2247         if ($f2p->find()) {
2248             while ($f2p->fetch()) {
2249                 $f2p->delete();
2250             }
2251         }
2252         // FIXME: decide whether to delete File objects
2253         // ...and related (actual) files
2254     }
2255
2256     function clearRepeats()
2257     {
2258         $repeatNotice = new Notice();
2259         $repeatNotice->repeat_of = $this->id;
2260
2261         //Null any notices that are repeats of this notice
2262
2263         if ($repeatNotice->find()) {
2264             while ($repeatNotice->fetch()) {
2265                 $orig = clone($repeatNotice);
2266                 $repeatNotice->repeat_of = null;
2267                 $repeatNotice->update($orig);
2268             }
2269         }
2270     }
2271
2272     function clearTags()
2273     {
2274         $tag = new Notice_tag();
2275         $tag->notice_id = $this->id;
2276
2277         if ($tag->find()) {
2278             while ($tag->fetch()) {
2279                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2280                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2281                 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2282                 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2283                 $tag->delete();
2284             }
2285         }
2286
2287         $tag->free();
2288     }
2289
2290     function clearGroupInboxes()
2291     {
2292         $gi = new Group_inbox();
2293
2294         $gi->notice_id = $this->id;
2295
2296         if ($gi->find()) {
2297             while ($gi->fetch()) {
2298                 self::blow('user_group:notice_ids:%d', $gi->group_id);
2299                 $gi->delete();
2300             }
2301         }
2302
2303         $gi->free();
2304     }
2305
2306     function distribute()
2307     {
2308         // We always insert for the author so they don't
2309         // have to wait
2310         Event::handle('StartNoticeDistribute', array($this));
2311
2312         // If there's a failure, we want to _force_
2313         // distribution at this point.
2314         try {
2315             $qm = QueueManager::get();
2316             $qm->enqueue($this, 'distrib');
2317         } catch (Exception $e) {
2318             // If the exception isn't transient, this
2319             // may throw more exceptions as DQH does
2320             // its own enqueueing. So, we ignore them!
2321             try {
2322                 $handler = new DistribQueueHandler();
2323                 $handler->handle($this);
2324             } catch (Exception $e) {
2325                 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2326             }
2327             // Re-throw so somebody smarter can handle it.
2328             throw $e;
2329         }
2330     }
2331
2332     function insert()
2333     {
2334         $result = parent::insert();
2335
2336         if ($result === false) {
2337             common_log_db_error($this, 'INSERT', __FILE__);
2338             // TRANS: Server exception thrown when a stored object entry cannot be saved.
2339             throw new ServerException('Could not save Notice');
2340         }
2341
2342         // Profile::hasRepeated() abuses pkeyGet(), so we
2343         // have to clear manually
2344         if (!empty($this->repeat_of)) {
2345             $c = self::memcache();
2346             if (!empty($c)) {
2347                 $ck = self::multicacheKey('Notice',
2348                                           array('profile_id' => $this->profile_id,
2349                                                 'repeat_of' => $this->repeat_of));
2350                 $c->delete($ck);
2351             }
2352         }
2353
2354         // Update possibly ID-dependent columns: URI, conversation
2355         // (now that INSERT has added the notice's local id)
2356         $orig = clone($this);
2357         $changed = false;
2358
2359         // We can only get here if it's a local notice, since remote notices
2360         // should've bailed out earlier due to lacking a URI.
2361         if (empty($this->uri)) {
2362             $this->uri = sprintf('%s%s=%d:%s=%s',
2363                                 TagURI::mint(),
2364                                 'noticeId', $this->id,
2365                                 'objectType', $this->get_object_type(true));
2366             $changed = true;
2367         }
2368
2369         // If it's not part of a conversation, it's
2370         // the beginning of a new conversation.
2371         if (empty($this->conversation)) {
2372             $conv = Conversation::create($this);
2373             $this->conversation = $conv->id;
2374             $changed = true;
2375         }
2376
2377         if ($changed && $this->update($orig) === false) {
2378             common_log_db_error($notice, 'UPDATE', __FILE__);
2379             // TRANS: Server exception thrown when a notice cannot be updated.
2380             throw new ServerException(_('Problem saving notice.'));
2381         }
2382
2383         $this->blowOnInsert();
2384
2385         return $result;
2386     }
2387
2388     /**
2389      * Get the source of the notice
2390      *
2391      * @return Notice_source $ns A notice source object. 'code' is the only attribute
2392      *                           guaranteed to be populated.
2393      */
2394     function getSource()
2395     {
2396         $ns = new Notice_source();
2397         if (!empty($this->source)) {
2398             switch ($this->source) {
2399             case 'web':
2400             case 'xmpp':
2401             case 'mail':
2402             case 'omb':
2403             case 'system':
2404             case 'api':
2405                 $ns->code = $this->source;
2406                 break;
2407             default:
2408                 $ns = Notice_source::getKV($this->source);
2409                 if (!$ns) {
2410                     $ns = new Notice_source();
2411                     $ns->code = $this->source;
2412                     $app = Oauth_application::getKV('name', $this->source);
2413                     if ($app) {
2414                         $ns->name = $app->name;
2415                         $ns->url  = $app->source_url;
2416                     }
2417                 }
2418                 break;
2419             }
2420         }
2421         return $ns;
2422     }
2423
2424     /**
2425      * Determine whether the notice was locally created
2426      *
2427      * @return boolean locality
2428      */
2429
2430     public function isLocal()
2431     {
2432         return ($this->is_local == Notice::LOCAL_PUBLIC ||
2433                 $this->is_local == Notice::LOCAL_NONPUBLIC);
2434     }
2435
2436     public function isRepeat()
2437     {
2438         return !empty($this->repeat_of);
2439     }
2440
2441     /**
2442      * Get the list of hash tags saved with this notice.
2443      *
2444      * @return array of strings
2445      */
2446     public function getTags()
2447     {
2448         $tags = array();
2449
2450         $keypart = sprintf('notice:tags:%d', $this->id);
2451
2452         $tagstr = self::cacheGet($keypart);
2453
2454         if ($tagstr !== false) {
2455             $tags = explode(',', $tagstr);
2456         } else {
2457             $tag = new Notice_tag();
2458             $tag->notice_id = $this->id;
2459             if ($tag->find()) {
2460                 while ($tag->fetch()) {
2461                     $tags[] = $tag->tag;
2462                 }
2463             }
2464             self::cacheSet($keypart, implode(',', $tags));
2465         }
2466
2467         return $tags;
2468     }
2469
2470     static private function utcDate($dt)
2471     {
2472         $dateStr = date('d F Y H:i:s', strtotime($dt));
2473         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2474         return $d->format(DATE_W3C);
2475     }
2476
2477     /**
2478      * Look up the creation timestamp for a given notice ID, even
2479      * if it's been deleted.
2480      *
2481      * @param int $id
2482      * @return mixed string recorded creation timestamp, or false if can't be found
2483      */
2484     public static function getAsTimestamp($id)
2485     {
2486         if (!$id) {
2487             return false;
2488         }
2489
2490         $notice = Notice::getKV('id', $id);
2491         if ($notice) {
2492             return $notice->created;
2493         }
2494
2495         $deleted = Deleted_notice::getKV('id', $id);
2496         if ($deleted) {
2497             return $deleted->created;
2498         }
2499
2500         return false;
2501     }
2502
2503     /**
2504      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2505      * parameter, matching notices posted after the given one (exclusive).
2506      *
2507      * If the referenced notice can't be found, will return false.
2508      *
2509      * @param int $id
2510      * @param string $idField
2511      * @param string $createdField
2512      * @return mixed string or false if no match
2513      */
2514     public static function whereSinceId($id, $idField='id', $createdField='created')
2515     {
2516         $since = Notice::getAsTimestamp($id);
2517         if ($since) {
2518             return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2519         }
2520         return false;
2521     }
2522
2523     /**
2524      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2525      * parameter, matching notices posted after the given one (exclusive), and
2526      * if necessary add it to the data object's query.
2527      *
2528      * @param DB_DataObject $obj
2529      * @param int $id
2530      * @param string $idField
2531      * @param string $createdField
2532      * @return mixed string or false if no match
2533      */
2534     public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2535     {
2536         $since = self::whereSinceId($id, $idField, $createdField);
2537         if ($since) {
2538             $obj->whereAdd($since);
2539         }
2540     }
2541
2542     /**
2543      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2544      * parameter, matching notices posted before the given one (inclusive).
2545      *
2546      * If the referenced notice can't be found, will return false.
2547      *
2548      * @param int $id
2549      * @param string $idField
2550      * @param string $createdField
2551      * @return mixed string or false if no match
2552      */
2553     public static function whereMaxId($id, $idField='id', $createdField='created')
2554     {
2555         $max = Notice::getAsTimestamp($id);
2556         if ($max) {
2557             return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2558         }
2559         return false;
2560     }
2561
2562     /**
2563      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2564      * parameter, matching notices posted before the given one (inclusive), and
2565      * if necessary add it to the data object's query.
2566      *
2567      * @param DB_DataObject $obj
2568      * @param int $id
2569      * @param string $idField
2570      * @param string $createdField
2571      * @return mixed string or false if no match
2572      */
2573     public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2574     {
2575         $max = self::whereMaxId($id, $idField, $createdField);
2576         if ($max) {
2577             $obj->whereAdd($max);
2578         }
2579     }
2580
2581     function isPublic()
2582     {
2583         if (common_config('public', 'localonly')) {
2584             return ($this->is_local == Notice::LOCAL_PUBLIC);
2585         } else {
2586             return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2587                     ($this->is_local != Notice::GATEWAY));
2588         }
2589     }
2590
2591     /**
2592      * Check that the given profile is allowed to read, respond to, or otherwise
2593      * act on this notice.
2594      *
2595      * The $scope member is a bitmask of scopes, representing a logical AND of the
2596      * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2597      * "only visible to people who are mentioned in the notice AND are users on this site."
2598      * Users on the site who are not mentioned in the notice will not be able to see the
2599      * notice.
2600      *
2601      * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2602      *
2603      * @return boolean whether the profile is in the notice's scope
2604      */
2605     function inScope($profile)
2606     {
2607         if (is_null($profile)) {
2608             $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2609         } else {
2610             $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2611         }
2612
2613         $result = self::cacheGet($keypart);
2614
2615         if ($result === false) {
2616             $bResult = false;
2617             if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2618                 $bResult = $this->_inScope($profile);
2619                 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2620             }
2621             $result = ($bResult) ? 1 : 0;
2622             self::cacheSet($keypart, $result, 0, 300);
2623         }
2624
2625         return ($result == 1) ? true : false;
2626     }
2627
2628     protected function _inScope($profile)
2629     {
2630         if (!is_null($this->scope)) {
2631             $scope = $this->scope;
2632         } else {
2633             $scope = self::defaultScope();
2634         }
2635
2636         // If there's no scope, anyone (even anon) is in scope.
2637
2638         if ($scope == 0) { // Not private
2639
2640             return !$this->isHiddenSpam($profile);
2641
2642         } else { // Private, somehow
2643
2644             // If there's scope, anon cannot be in scope
2645
2646             if (empty($profile)) {
2647                 return false;
2648             }
2649
2650             // Author is always in scope
2651
2652             if ($this->profile_id == $profile->id) {
2653                 return true;
2654             }
2655
2656             // Only for users on this site
2657
2658             if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2659                 return false;
2660             }
2661
2662             // Only for users mentioned in the notice
2663
2664             if ($scope & Notice::ADDRESSEE_SCOPE) {
2665
2666                 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2667                                              'profile_id' => $profile->id));
2668
2669                 if (!$reply instanceof Reply) {
2670                     return false;
2671                 }
2672             }
2673
2674             // Only for members of the given group
2675
2676             if ($scope & Notice::GROUP_SCOPE) {
2677
2678                 // XXX: just query for the single membership
2679
2680                 $groups = $this->getGroups();
2681
2682                 $foundOne = false;
2683
2684                 foreach ($groups as $group) {
2685                     if ($profile->isMember($group)) {
2686                         $foundOne = true;
2687                         break;
2688                     }
2689                 }
2690
2691                 if (!$foundOne) {
2692                     return false;
2693                 }
2694             }
2695
2696             // Only for followers of the author
2697
2698             $author = null;
2699
2700             if ($scope & Notice::FOLLOWER_SCOPE) {
2701
2702                 try {
2703                     $author = $this->getProfile();
2704                 } catch (Exception $e) {
2705                     return false;
2706                 }
2707
2708                 if (!Subscription::exists($profile, $author)) {
2709                     return false;
2710                 }
2711             }
2712
2713             return !$this->isHiddenSpam($profile);
2714         }
2715     }
2716
2717     function isHiddenSpam($profile) {
2718
2719         // Hide posts by silenced users from everyone but moderators.
2720
2721         if (common_config('notice', 'hidespam')) {
2722
2723             try {
2724                 $author = $this->getProfile();
2725             } catch(Exception $e) {
2726                 // If we can't get an author, keep it hidden.
2727                 // XXX: technically not spam, but, whatever.
2728                 return true;
2729             }
2730
2731             if ($author->hasRole(Profile_role::SILENCED)) {
2732                 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2733                     return true;
2734                 }
2735             }
2736         }
2737
2738         return false;
2739     }
2740
2741     public function getParent()
2742     {
2743         $parent = Notice::getKV('id', $this->reply_to);
2744
2745         if (!$parent instanceof Notice) {
2746             throw new ServerException('Notice has no parent');
2747         }
2748
2749         return $parent;
2750     }
2751
2752     /**
2753      * Magic function called at serialize() time.
2754      *
2755      * We use this to drop a couple process-specific references
2756      * from DB_DataObject which can cause trouble in future
2757      * processes.
2758      *
2759      * @return array of variable names to include in serialization.
2760      */
2761
2762     function __sleep()
2763     {
2764         $vars = parent::__sleep();
2765         $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2766         return array_diff($vars, $skip);
2767     }
2768
2769     static function defaultScope()
2770     {
2771         $scope = common_config('notice', 'defaultscope');
2772         if (is_null($scope)) {
2773                 if (common_config('site', 'private')) {
2774                         $scope = 1;
2775                 } else {
2776                         $scope = 0;
2777                 }
2778         }
2779         return $scope;
2780     }
2781
2782         static function fillProfiles($notices)
2783         {
2784                 $map = self::getProfiles($notices);
2785
2786                 foreach ($notices as $entry=>$notice) {
2787             try {
2788                         if (array_key_exists($notice->profile_id, $map)) {
2789                                 $notice->_setProfile($map[$notice->profile_id]);
2790                         }
2791             } catch (NoProfileException $e) {
2792                 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2793                 unset($notices[$entry]);
2794             }
2795                 }
2796
2797                 return array_values($map);
2798         }
2799
2800         static function getProfiles(&$notices)
2801         {
2802                 $ids = array();
2803                 foreach ($notices as $notice) {
2804                         $ids[] = $notice->profile_id;
2805                 }
2806
2807                 $ids = array_unique($ids);
2808
2809                 return Profile::pivotGet('id', $ids);
2810         }
2811
2812         static function fillGroups(&$notices)
2813         {
2814         $ids = self::_idsOf($notices);
2815
2816         $gis = Group_inbox::listGet('notice_id', $ids);
2817
2818         $gids = array();
2819
2820                 foreach ($gis as $id => $gi)
2821                 {
2822                     foreach ($gi as $g)
2823                     {
2824                         $gids[] = $g->group_id;
2825                     }
2826                 }
2827
2828                 $gids = array_unique($gids);
2829
2830                 $group = User_group::pivotGet('id', $gids);
2831
2832                 foreach ($notices as $notice)
2833                 {
2834                         $grps = array();
2835                         $gi = $gis[$notice->id];
2836                         foreach ($gi as $g) {
2837                             $grps[] = $group[$g->group_id];
2838                         }
2839                     $notice->_setGroups($grps);
2840                 }
2841         }
2842
2843     static function _idsOf(array &$notices)
2844     {
2845                 $ids = array();
2846                 foreach ($notices as $notice) {
2847                         $ids[$notice->id] = true;
2848                 }
2849                 return array_keys($ids);
2850     }
2851
2852     static function fillAttachments(&$notices)
2853     {
2854         $ids = self::_idsOf($notices);
2855
2856         $f2pMap = File_to_post::listGet('post_id', $ids);
2857
2858                 $fileIds = array();
2859
2860                 foreach ($f2pMap as $noticeId => $f2ps) {
2861             foreach ($f2ps as $f2p) {
2862                 $fileIds[] = $f2p->file_id;
2863             }
2864         }
2865
2866         $fileIds = array_unique($fileIds);
2867
2868                 $fileMap = File::pivotGet('id', $fileIds);
2869
2870                 foreach ($notices as $notice)
2871                 {
2872                         $files = array();
2873                         $f2ps = $f2pMap[$notice->id];
2874                         foreach ($f2ps as $f2p) {
2875                             $files[] = $fileMap[$f2p->file_id];
2876                         }
2877                     $notice->_setAttachments($files);
2878                 }
2879     }
2880
2881     static function fillReplies(&$notices)
2882     {
2883         $ids = self::_idsOf($notices);
2884         $replyMap = Reply::listGet('notice_id', $ids);
2885         foreach ($notices as $notice) {
2886             $replies = $replyMap[$notice->id];
2887             $ids = array();
2888             foreach ($replies as $reply) {
2889                 $ids[] = $reply->profile_id;
2890             }
2891             $notice->_setReplies($ids);
2892         }
2893     }
2894
2895     protected $_repeats = array();
2896
2897     function getRepeats()
2898     {
2899         if (isset($this->_repeats[$this->id])) {
2900             return $this->_repeats[$this->id];
2901         }
2902         $repeatMap = Notice::listGet('repeat_of', array($this->id));
2903         $this->_repeats[$this->id] = $repeatMap[$this->id];
2904         return $this->_repeats[$this->id];
2905     }
2906
2907     function _setRepeats($repeats)
2908     {
2909         $this->_repeats[$this->id] = $repeats;
2910     }
2911
2912     static function fillRepeats(&$notices)
2913     {
2914         $ids = self::_idsOf($notices);
2915         $repeatMap = Notice::listGet('repeat_of', $ids);
2916         foreach ($notices as $notice) {
2917                 $repeats = $repeatMap[$notice->id];
2918             $notice->_setRepeats($repeats);
2919         }
2920     }
2921 }