classes/Notice.php

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