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