classes/Notice.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * @category Notices
  20  * @package  StatusNet
  21  * @author   Brenda Wallace <shiny@cpan.org>
  22  * @author   Christopher Vollick <psycotica0@gmail.com>
  23  * @author   CiaranG <ciaran@ciarang.com>
  24  * @author   Craig Andrews <candrews@integralblue.com>
  25  * @author   Evan Prodromou <evan@controlezvous.ca>
  26  * @author   Gina Haeussge <osd@foosel.net>
  27  * @author   Jeffery To <jeffery.to@gmail.com>
  28  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author   Robin Millette <millette@controlyourself.ca>
  30  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  31  * @author   Tom Adams <tom@holizz.com>
  32  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  33  * @license  GNU Affero General Public License http://www.gnu.org/licenses/
  34  */
  35
  36 if (!defined('STATUSNET') && !defined('LACONICA')) {
  37     exit(1);
  38 }
  39
  40 /**
  41  * Table Definition for notice
  42  */
  43 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  44
  45 /* We keep 200 notices, the max number of notices available per API request,
  46  * in the memcached cache. */
  47
  48 define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
  49
  50 define('MAX_BOXCARS', 128);
  51
  52 class Notice extends Memcached_DataObject
  53 {
  54     ###START_AUTOCODE
  55     /* the code below is auto generated do not remove the above tag */
  56
  57     public $__table = 'notice';                          // table name
  58     public $id;                              // int(4)  primary_key not_null
  59     public $profile_id;                      // int(4)  multiple_key not_null
  60     public $uri;                             // varchar(255)  unique_key
  61     public $content;                         // text
  62     public $rendered;                        // text
  63     public $url;                             // varchar(255)
  64     public $created;                         // datetime  multiple_key not_null default_0000-00-00%2000%3A00%3A00
  65     public $modified;                        // timestamp   not_null default_CURRENT_TIMESTAMP
  66     public $reply_to;                        // int(4)
  67     public $is_local;                        // int(4)
  68     public $source;                          // varchar(32)
  69     public $conversation;                    // int(4)
  70     public $lat;                             // decimal(10,7)
  71     public $lon;                             // decimal(10,7)
  72     public $location_id;                     // int(4)
  73     public $location_ns;                     // int(4)
  74     public $repeat_of;                       // int(4)
  75     public $object_type;                     // varchar(255)
  76
  77     /* Static get */
  78     function staticGet($k,$v=NULL)
  79     {
  80         return Memcached_DataObject::staticGet('Notice',$k,$v);
  81     }
  82
  83     /* the code above is auto generated do not remove the tag below */
  84     ###END_AUTOCODE
  85
  86     /* Notice types */
  87     const LOCAL_PUBLIC    =  1;
  88     const REMOTE_OMB      =  0;
  89     const LOCAL_NONPUBLIC = -1;
  90     const GATEWAY         = -2;
  91
  92     function getProfile()
  93     {
  94         $profile = Profile::staticGet('id', $this->profile_id);
  95
  96         if (empty($profile)) {
  97             // TRANS: Server exception thrown when a user profile for a notice cannot be found.
  98             // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
  99             throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
 100         }
 101
 102         return $profile;
 103     }
 104
 105     function delete()
 106     {
 107         // For auditing purposes, save a record that the notice
 108         // was deleted.
 109
 110         // @fixme we have some cases where things get re-run and so the
 111         // insert fails.
 112         $deleted = Deleted_notice::staticGet('id', $this->id);
 113
 114         if (!$deleted) {
 115             $deleted = Deleted_notice::staticGet('uri', $this->uri);
 116         }
 117
 118         if (!$deleted) {
 119             $deleted = new Deleted_notice();
 120
 121             $deleted->id         = $this->id;
 122             $deleted->profile_id = $this->profile_id;
 123             $deleted->uri        = $this->uri;
 124             $deleted->created    = $this->created;
 125             $deleted->deleted    = common_sql_now();
 126
 127             $deleted->insert();
 128         }
 129
 130         if (Event::handle('NoticeDeleteRelated', array($this))) {
 131
 132             // Clear related records
 133
 134             $this->clearReplies();
 135             $this->clearRepeats();
 136             $this->clearFaves();
 137             $this->clearTags();
 138             $this->clearGroupInboxes();
 139             $this->clearFiles();
 140
 141             // NOTE: we don't clear inboxes
 142             // NOTE: we don't clear queue items
 143         }
 144
 145         $result = parent::delete();
 146
 147         $this->blowOnDelete();
 148         return $result;
 149     }
 150
 151     /**
 152      * Extract #hashtags from this notice's content and save them to the database.
 153      */
 154     function saveTags()
 155     {
 156         /* extract all #hastags */
 157         $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
 158         if (!$count) {
 159             return true;
 160         }
 161
 162         /* Add them to the database */
 163         return $this->saveKnownTags($match[1]);
 164     }
 165
 166     /**
 167      * Record the given set of hash tags in the db for this notice.
 168      * Given tag strings will be normalized and checked for dupes.
 169      */
 170     function saveKnownTags($hashtags)
 171     {
 172         //turn each into their canonical tag
 173         //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
 174         for($i=0; $i<count($hashtags); $i++) {
 175             /* elide characters we don't want in the tag */
 176             $hashtags[$i] = common_canonical_tag($hashtags[$i]);
 177         }
 178
 179         foreach(array_unique($hashtags) as $hashtag) {
 180             $this->saveTag($hashtag);
 181             self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
 182         }
 183         return true;
 184     }
 185
 186     /**
 187      * Record a single hash tag as associated with this notice.
 188      * Tag format and uniqueness must be validated by caller.
 189      */
 190     function saveTag($hashtag)
 191     {
 192         $tag = new Notice_tag();
 193         $tag->notice_id = $this->id;
 194         $tag->tag = $hashtag;
 195         $tag->created = $this->created;
 196         $id = $tag->insert();
 197
 198         if (!$id) {
 199             // TRANS: Server exception. %s are the error details.
 200             throw new ServerException(sprintf(_('Database error inserting hashtag: %s'),
 201                                               $last_error->message));
 202             return;
 203         }
 204
 205         // if it's saved, blow its cache
 206         $tag->blowCache(false);
 207     }
 208
 209     /**
 210      * Save a new notice and push it out to subscribers' inboxes.
 211      * Poster's permissions are checked before sending.
 212      *
 213      * @param int $profile_id Profile ID of the poster
 214      * @param string $content source message text; links may be shortened
 215      *                        per current user's preference
 216      * @param string $source source key ('web', 'api', etc)
 217      * @param array $options Associative array of optional properties:
 218      *              string 'created' timestamp of notice; defaults to now
 219      *              int 'is_local' source/gateway ID, one of:
 220      *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
 221      *                  Notice::REMOTE_OMB      - Sent from a remote OMB service;
 222      *                                            hide from public timeline but show in
 223      *                                            local "and friends" timelines
 224      *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
 225      *                  Notice::GATEWAY         - From another non-OMB service;
 226      *                                            will not appear in public views
 227      *              float 'lat' decimal latitude for geolocation
 228      *              float 'lon' decimal longitude for geolocation
 229      *              int 'location_id' geoname identifier
 230      *              int 'location_ns' geoname namespace to interpret location_id
 231      *              int 'reply_to'; notice ID this is a reply to
 232      *              int 'repeat_of'; notice ID this is a repeat of
 233      *              string 'uri' unique ID for notice; defaults to local notice URL
 234      *              string 'url' permalink to notice; defaults to local notice URL
 235      *              string 'rendered' rendered HTML version of content
 236      *              array 'replies' list of profile URIs for reply delivery in
 237      *                              place of extracting @-replies from content.
 238      *              array 'groups' list of group IDs to deliver to, in place of
 239      *                              extracting ! tags from content
 240      *              array 'tags' list of hashtag strings to save with the notice
 241      *                           in place of extracting # tags from content
 242      *              array 'urls' list of attached/referred URLs to save with the
 243      *                           notice in place of extracting links from content
 244      *              boolean 'distribute' whether to distribute the notice, default true
 245      *              string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
 246      *
 247      * @fixme tag override
 248      *
 249      * @return Notice
 250      * @throws ClientException
 251      */
 252     static function saveNew($profile_id, $content, $source, $options=null) {
 253         $defaults = array('uri' => null,
 254                           'url' => null,
 255                           'reply_to' => null,
 256                           'repeat_of' => null,
 257                           'distribute' => true);
 258
 259         if (!empty($options)) {
 260             $options = $options + $defaults;
 261             extract($options);
 262         } else {
 263             extract($defaults);
 264         }
 265
 266         if (!isset($is_local)) {
 267             $is_local = Notice::LOCAL_PUBLIC;
 268         }
 269
 270         $profile = Profile::staticGet('id', $profile_id);
 271         $user = User::staticGet('id', $profile_id);
 272         if ($user) {
 273             // Use the local user's shortening preferences, if applicable.
 274             $final = $user->shortenLinks($content);
 275         } else {
 276             $final = common_shorten_links($content);
 277         }
 278
 279         if (Notice::contentTooLong($final)) {
 280             // TRANS: Client exception thrown if a notice contains too many characters.
 281             throw new ClientException(_('Problem saving notice. Too long.'));
 282         }
 283
 284         if (empty($profile)) {
 285             // TRANS: Client exception thrown when trying to save a notice for an unknown user.
 286             throw new ClientException(_('Problem saving notice. Unknown user.'));
 287         }
 288
 289         if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
 290             common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
 291             // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
 292             throw new ClientException(_('Too many notices too fast; take a breather '.
 293                                         'and post again in a few minutes.'));
 294         }
 295
 296         if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
 297             common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
 298             // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
 299             throw new ClientException(_('Too many duplicate messages too quickly;'.
 300                                         ' take a breather and post again in a few minutes.'));
 301         }
 302
 303         if (!$profile->hasRight(Right::NEWNOTICE)) {
 304             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
 305
 306             // TRANS: Client exception thrown when a user tries to post while being banned.
 307             throw new ClientException(_('You are banned from posting notices on this site.'), 403);
 308         }
 309
 310         $notice = new Notice();
 311         $notice->profile_id = $profile_id;
 312
 313         $autosource = common_config('public', 'autosource');
 314
 315         // Sandboxed are non-false, but not 1, either
 316
 317         if (!$profile->hasRight(Right::PUBLICNOTICE) ||
 318             ($source && $autosource && in_array($source, $autosource))) {
 319             $notice->is_local = Notice::LOCAL_NONPUBLIC;
 320         } else {
 321             $notice->is_local = $is_local;
 322         }
 323
 324         if (!empty($created)) {
 325             $notice->created = $created;
 326         } else {
 327             $notice->created = common_sql_now();
 328         }
 329
 330         $notice->content = $final;
 331
 332         $notice->source = $source;
 333         $notice->uri = $uri;
 334         $notice->url = $url;
 335
 336         // Handle repeat case
 337
 338         if (isset($repeat_of)) {
 339             $notice->repeat_of = $repeat_of;
 340         } else {
 341             $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
 342         }
 343
 344         if (!empty($notice->reply_to)) {
 345             $reply = Notice::staticGet('id', $notice->reply_to);
 346             $notice->conversation = $reply->conversation;
 347         }
 348
 349         if (!empty($lat) && !empty($lon)) {
 350             $notice->lat = $lat;
 351             $notice->lon = $lon;
 352         }
 353
 354         if (!empty($location_ns) && !empty($location_id)) {
 355             $notice->location_id = $location_id;
 356             $notice->location_ns = $location_ns;
 357         }
 358
 359         if (!empty($rendered)) {
 360             $notice->rendered = $rendered;
 361         } else {
 362             $notice->rendered = common_render_content($final, $notice);
 363         }
 364
 365         if (empty($object_type)) {
 366             $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
 367         } else {
 368             $notice->object_type = $object_type;
 369         }
 370
 371         if (Event::handle('StartNoticeSave', array(&$notice))) {
 372
 373             // XXX: some of these functions write to the DB
 374
 375             $id = $notice->insert();
 376
 377             if (!$id) {
 378                 common_log_db_error($notice, 'INSERT', __FILE__);
 379                 // TRANS: Server exception thrown when a notice cannot be saved.
 380                 throw new ServerException(_('Problem saving notice.'));
 381             }
 382
 383             // Update ID-dependent columns: URI, conversation
 384
 385             $orig = clone($notice);
 386
 387             $changed = false;
 388
 389             if (empty($uri)) {
 390                 $notice->uri = common_notice_uri($notice);
 391                 $changed = true;
 392             }
 393
 394             // If it's not part of a conversation, it's
 395             // the beginning of a new conversation.
 396
 397             if (empty($notice->conversation)) {
 398                 $conv = Conversation::create();
 399                 $notice->conversation = $conv->id;
 400                 $changed = true;
 401             }
 402
 403             if ($changed) {
 404                 if (!$notice->update($orig)) {
 405                     common_log_db_error($notice, 'UPDATE', __FILE__);
 406                     // TRANS: Server exception thrown when a notice cannot be updated.
 407                     throw new ServerException(_('Problem saving notice.'));
 408                 }
 409             }
 410
 411         }
 412
 413         // Clear the cache for subscribed users, so they'll update at next request
 414         // XXX: someone clever could prepend instead of clearing the cache
 415
 416         $notice->blowOnInsert();
 417
 418         // Save per-notice metadata...
 419
 420         if (isset($replies)) {
 421             $notice->saveKnownReplies($replies);
 422         } else {
 423             $notice->saveReplies();
 424         }
 425
 426         if (isset($tags)) {
 427             $notice->saveKnownTags($tags);
 428         } else {
 429             $notice->saveTags();
 430         }
 431
 432         // Note: groups may save tags, so must be run after tags are saved
 433         // to avoid errors on duplicates.
 434         if (isset($groups)) {
 435             $notice->saveKnownGroups($groups);
 436         } else {
 437             $notice->saveGroups();
 438         }
 439
 440         if (isset($urls)) {
 441             $notice->saveKnownUrls($urls);
 442         } else {
 443             $notice->saveUrls();
 444         }
 445
 446         if ($distribute) {
 447             // Prepare inbox delivery, may be queued to background.
 448             $notice->distribute();
 449         }
 450
 451         return $notice;
 452     }
 453
 454     function blowOnInsert($conversation = false)
 455     {
 456         self::blow('profile:notice_ids:%d', $this->profile_id);
 457
 458         if ($this->isPublic()) {
 459             self::blow('public');
 460         }
 461
 462         // XXX: Before we were blowing the casche only if the notice id
 463         // was not the root of the conversation.  What to do now?
 464
 465         self::blow('notice:conversation_ids:%d', $this->conversation);
 466
 467         if (!empty($this->repeat_of)) {
 468             self::blow('notice:repeats:%d', $this->repeat_of);
 469         }
 470
 471         $original = Notice::staticGet('id', $this->repeat_of);
 472
 473         if (!empty($original)) {
 474             $originalUser = User::staticGet('id', $original->profile_id);
 475             if (!empty($originalUser)) {
 476                 self::blow('user:repeats_of_me:%d', $originalUser->id);
 477             }
 478         }
 479
 480         $profile = Profile::staticGet($this->profile_id);
 481         if (!empty($profile)) {
 482             $profile->blowNoticeCount();
 483         }
 484     }
 485
 486     /**
 487      * Clear cache entries related to this notice at delete time.
 488      * Necessary to avoid breaking paging on public, profile timelines.
 489      */
 490     function blowOnDelete()
 491     {
 492         $this->blowOnInsert();
 493
 494         self::blow('profile:notice_ids:%d;last', $this->profile_id);
 495
 496         if ($this->isPublic()) {
 497             self::blow('public;last');
 498         }
 499
 500         self::blow('fave:by_notice', $this->id);
 501
 502         if ($this->conversation) {
 503             // In case we're the first, will need to calc a new root.
 504             self::blow('notice:conversation_root:%d', $this->conversation);
 505         }
 506     }
 507
 508     /** save all urls in the notice to the db
 509      *
 510      * follow redirects and save all available file information
 511      * (mimetype, date, size, oembed, etc.)
 512      *
 513      * @return void
 514      */
 515     function saveUrls() {
 516         if (common_config('attachments', 'process_links')) {
 517             common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
 518         }
 519     }
 520
 521     /**
 522      * Save the given URLs as related links/attachments to the db
 523      *
 524      * follow redirects and save all available file information
 525      * (mimetype, date, size, oembed, etc.)
 526      *
 527      * @return void
 528      */
 529     function saveKnownUrls($urls)
 530     {
 531         if (common_config('attachments', 'process_links')) {
 532             // @fixme validation?
 533             foreach (array_unique($urls) as $url) {
 534                 File::processNew($url, $this->id);
 535             }
 536         }
 537     }
 538
 539     /**
 540      * @private callback
 541      */
 542     function saveUrl($url, $notice_id) {
 543         File::processNew($url, $notice_id);
 544     }
 545
 546     static function checkDupes($profile_id, $content) {
 547         $profile = Profile::staticGet($profile_id);
 548         if (empty($profile)) {
 549             return false;
 550         }
 551         $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
 552         if (!empty($notice)) {
 553             $last = 0;
 554             while ($notice->fetch()) {
 555                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
 556                     return true;
 557                 } else if ($notice->content == $content) {
 558                     return false;
 559                 }
 560             }
 561         }
 562         // If we get here, oldest item in cache window is not
 563         // old enough for dupe limit; do direct check against DB
 564         $notice = new Notice();
 565         $notice->profile_id = $profile_id;
 566         $notice->content = $content;
 567         $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
 568         $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
 569
 570         $cnt = $notice->count();
 571         return ($cnt == 0);
 572     }
 573
 574     static function checkEditThrottle($profile_id) {
 575         $profile = Profile::staticGet($profile_id);
 576         if (empty($profile)) {
 577             return false;
 578         }
 579         // Get the Nth notice
 580         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
 581         if ($notice && $notice->fetch()) {
 582             // If the Nth notice was posted less than timespan seconds ago
 583             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
 584                 // Then we throttle
 585                 return false;
 586             }
 587         }
 588         // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
 589         return true;
 590     }
 591
 592     function getUploadedAttachment() {
 593         $post = clone $this;
 594         $query = 'select file.url as up, file.id as i from file join file_to_post on file.id = file_id where post_id=' . $post->escape($post->id) . ' and url like "%/notice/%/file"';
 595         $post->query($query);
 596         $post->fetch();
 597         if (empty($post->up) || empty($post->i)) {
 598             $ret = false;
 599         } else {
 600             $ret = array($post->up, $post->i);
 601         }
 602         $post->free();
 603         return $ret;
 604     }
 605
 606     function hasAttachments() {
 607         $post = clone $this;
 608         $query = "select count(file_id) as n_attachments from file join file_to_post on (file_id = file.id) join notice on (post_id = notice.id) where post_id = " . $post->escape($post->id);
 609         $post->query($query);
 610         $post->fetch();
 611         $n_attachments = intval($post->n_attachments);
 612         $post->free();
 613         return $n_attachments;
 614     }
 615
 616     function attachments() {
 617         // XXX: cache this
 618         $att = array();
 619         $f2p = new File_to_post;
 620         $f2p->post_id = $this->id;
 621         if ($f2p->find()) {
 622             while ($f2p->fetch()) {
 623                 $f = File::staticGet($f2p->file_id);
 624                 if ($f) {
 625                     $att[] = clone($f);
 626                 }
 627             }
 628         }
 629         return $att;
 630     }
 631
 632
 633     function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
 634     {
 635         $stream = new PublicNoticeStream();
 636         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 637     }
 638
 639
 640     function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
 641     {
 642         $stream = new ConversationNoticeStream($id);
 643
 644         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 645     }
 646
 647     /**
 648      * Is this notice part of an active conversation?
 649      *
 650      * @return boolean true if other messages exist in the same
 651      *                 conversation, false if this is the only one
 652      */
 653     function hasConversation()
 654     {
 655         if (!empty($this->conversation)) {
 656             $conversation = Notice::conversationStream(
 657                 $this->conversation,
 658                 1,
 659                 1
 660             );
 661
 662             if ($conversation->N > 0) {
 663                 return true;
 664             }
 665         }
 666         return false;
 667     }
 668
 669     /**
 670      * Grab the earliest notice from this conversation.
 671      *
 672      * @return Notice or null
 673      */
 674     function conversationRoot()
 675     {
 676         if (!empty($this->conversation)) {
 677             $c = self::memcache();
 678
 679             $key = Cache::key('notice:conversation_root:' . $this->conversation);
 680             $notice = $c->get($key);
 681             if ($notice) {
 682                 return $notice;
 683             }
 684
 685             $notice = new Notice();
 686             $notice->conversation = $this->conversation;
 687             $notice->orderBy('CREATED');
 688             $notice->limit(1);
 689             $notice->find(true);
 690
 691             if ($notice->N) {
 692                 $c->set($key, $notice);
 693                 return $notice;
 694             }
 695         }
 696         return null;
 697     }
 698     /**
 699      * Pull up a full list of local recipients who will be getting
 700      * this notice in their inbox. Results will be cached, so don't
 701      * change the input data wily-nilly!
 702      *
 703      * @param array $groups optional list of Group objects;
 704      *              if left empty, will be loaded from group_inbox records
 705      * @param array $recipient optional list of reply profile ids
 706      *              if left empty, will be loaded from reply records
 707      * @return array associating recipient user IDs with an inbox source constant
 708      */
 709     function whoGets($groups=null, $recipients=null)
 710     {
 711         $c = self::memcache();
 712
 713         if (!empty($c)) {
 714             $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
 715             if ($ni !== false) {
 716                 return $ni;
 717             }
 718         }
 719
 720         if (is_null($groups)) {
 721             $groups = $this->getGroups();
 722         }
 723
 724         if (is_null($recipients)) {
 725             $recipients = $this->getReplies();
 726         }
 727
 728         $users = $this->getSubscribedUsers();
 729
 730         // FIXME: kind of ignoring 'transitional'...
 731         // we'll probably stop supporting inboxless mode
 732         // in 0.9.x
 733
 734         $ni = array();
 735
 736         // Give plugins a chance to add folks in at start...
 737         if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
 738
 739             foreach ($users as $id) {
 740                 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
 741             }
 742
 743             foreach ($groups as $group) {
 744                 $users = $group->getUserMembers();
 745                 foreach ($users as $id) {
 746                     if (!array_key_exists($id, $ni)) {
 747                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
 748                     }
 749                 }
 750             }
 751
 752             foreach ($recipients as $recipient) {
 753                 if (!array_key_exists($recipient, $ni)) {
 754                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
 755                 }
 756             }
 757
 758             // Exclude any deleted, non-local, or blocking recipients.
 759             $profile = $this->getProfile();
 760             $originalProfile = null;
 761             if ($this->repeat_of) {
 762                 // Check blocks against the original notice's poster as well.
 763                 $original = Notice::staticGet('id', $this->repeat_of);
 764                 if ($original) {
 765                     $originalProfile = $original->getProfile();
 766                 }
 767             }
 768             foreach ($ni as $id => $source) {
 769                 $user = User::staticGet('id', $id);
 770                 if (empty($user) || $user->hasBlocked($profile) ||
 771                     ($originalProfile && $user->hasBlocked($originalProfile))) {
 772                     unset($ni[$id]);
 773                 }
 774             }
 775
 776             // Give plugins a chance to filter out...
 777             Event::handle('EndNoticeWhoGets', array($this, &$ni));
 778         }
 779
 780         if (!empty($c)) {
 781             // XXX: pack this data better
 782             $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
 783         }
 784
 785         return $ni;
 786     }
 787
 788     /**
 789      * Adds this notice to the inboxes of each local user who should receive
 790      * it, based on author subscriptions, group memberships, and @-replies.
 791      *
 792      * Warning: running a second time currently will make items appear
 793      * multiple times in users' inboxes.
 794      *
 795      * @fixme make more robust against errors
 796      * @fixme break up massive deliveries to smaller background tasks
 797      *
 798      * @param array $groups optional list of Group objects;
 799      *              if left empty, will be loaded from group_inbox records
 800      * @param array $recipient optional list of reply profile ids
 801      *              if left empty, will be loaded from reply records
 802      */
 803     function addToInboxes($groups=null, $recipients=null)
 804     {
 805         $ni = $this->whoGets($groups, $recipients);
 806
 807         $ids = array_keys($ni);
 808
 809         // We remove the author (if they're a local user),
 810         // since we'll have already done this in distribute()
 811
 812         $i = array_search($this->profile_id, $ids);
 813
 814         if ($i !== false) {
 815             unset($ids[$i]);
 816         }
 817
 818         // Bulk insert
 819
 820         Inbox::bulkInsert($this->id, $ids);
 821
 822         return;
 823     }
 824
 825     function getSubscribedUsers()
 826     {
 827         $user = new User();
 828
 829         if(common_config('db','quote_identifiers'))
 830           $user_table = '"user"';
 831         else $user_table = 'user';
 832
 833         $qry =
 834           'SELECT id ' .
 835           'FROM '. $user_table .' JOIN subscription '.
 836           'ON '. $user_table .'.id = subscription.subscriber ' .
 837           'WHERE subscription.subscribed = %d ';
 838
 839         $user->query(sprintf($qry, $this->profile_id));
 840
 841         $ids = array();
 842
 843         while ($user->fetch()) {
 844             $ids[] = $user->id;
 845         }
 846
 847         $user->free();
 848
 849         return $ids;
 850     }
 851
 852     /**
 853      * Record this notice to the given group inboxes for delivery.
 854      * Overrides the regular parsing of !group markup.
 855      *
 856      * @param string $group_ids
 857      * @fixme might prefer URIs as identifiers, as for replies?
 858      *        best with generalizations on user_group to support
 859      *        remote groups better.
 860      */
 861     function saveKnownGroups($group_ids)
 862     {
 863         if (!is_array($group_ids)) {
 864             // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
 865             throw new ServerException(_('Bad type provided to saveKnownGroups.'));
 866         }
 867
 868         $groups = array();
 869         foreach (array_unique($group_ids) as $id) {
 870             $group = User_group::staticGet('id', $id);
 871             if ($group) {
 872                 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
 873                 $result = $this->addToGroupInbox($group);
 874                 if (!$result) {
 875                     common_log_db_error($gi, 'INSERT', __FILE__);
 876                 }
 877
 878                 // @fixme should we save the tags here or not?
 879                 $groups[] = clone($group);
 880             } else {
 881                 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
 882             }
 883         }
 884
 885         return $groups;
 886     }
 887
 888     /**
 889      * Parse !group delivery and record targets into group_inbox.
 890      * @return array of Group objects
 891      */
 892     function saveGroups()
 893     {
 894         // Don't save groups for repeats
 895
 896         if (!empty($this->repeat_of)) {
 897             return array();
 898         }
 899
 900         $groups = array();
 901
 902         /* extract all !group */
 903         $count = preg_match_all('/(?:^|\s)!(' . Nickname::DISPLAY_FMT . ')/',
 904                                 strtolower($this->content),
 905                                 $match);
 906         if (!$count) {
 907             return $groups;
 908         }
 909
 910         $profile = $this->getProfile();
 911
 912         /* Add them to the database */
 913
 914         foreach (array_unique($match[1]) as $nickname) {
 915             /* XXX: remote groups. */
 916             $group = User_group::getForNickname($nickname, $profile);
 917
 918             if (empty($group)) {
 919                 continue;
 920             }
 921
 922             // we automatically add a tag for every group name, too
 923
 924             $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
 925                                              'notice_id' => $this->id));
 926
 927             if (is_null($tag)) {
 928                 $this->saveTag($nickname);
 929             }
 930
 931             if ($profile->isMember($group)) {
 932
 933                 $result = $this->addToGroupInbox($group);
 934
 935                 if (!$result) {
 936                     common_log_db_error($gi, 'INSERT', __FILE__);
 937                 }
 938
 939                 $groups[] = clone($group);
 940             }
 941         }
 942
 943         return $groups;
 944     }
 945
 946     function addToGroupInbox($group)
 947     {
 948         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
 949                                          'notice_id' => $this->id));
 950
 951         if (empty($gi)) {
 952
 953             $gi = new Group_inbox();
 954
 955             $gi->group_id  = $group->id;
 956             $gi->notice_id = $this->id;
 957             $gi->created   = $this->created;
 958
 959             $result = $gi->insert();
 960
 961             if (!$result) {
 962                 common_log_db_error($gi, 'INSERT', __FILE__);
 963                 // TRANS: Server exception thrown when an update for a group inbox fails.
 964                 throw new ServerException(_('Problem saving group inbox.'));
 965             }
 966
 967             self::blow('user_group:notice_ids:%d', $gi->group_id);
 968         }
 969
 970         return true;
 971     }
 972
 973     /**
 974      * Save reply records indicating that this notice needs to be
 975      * delivered to the local users with the given URIs.
 976      *
 977      * Since this is expected to be used when saving foreign-sourced
 978      * messages, we won't deliver to any remote targets as that's the
 979      * source service's responsibility.
 980      *
 981      * Mail notifications etc will be handled later.
 982      *
 983      * @param array of unique identifier URIs for recipients
 984      */
 985     function saveKnownReplies($uris)
 986     {
 987         if (empty($uris)) {
 988             return;
 989         }
 990
 991         $sender = Profile::staticGet($this->profile_id);
 992
 993         foreach (array_unique($uris) as $uri) {
 994
 995             $profile = Profile::fromURI($uri);
 996
 997             if (empty($profile)) {
 998                 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
 999                 continue;
1000             }
1001
1002             if ($profile->hasBlocked($sender)) {
1003                 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1004                 continue;
1005             }
1006
1007             $reply = new Reply();
1008
1009             $reply->notice_id  = $this->id;
1010             $reply->profile_id = $profile->id;
1011             $reply->modified   = $this->created;
1012
1013             common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
1014
1015             $id = $reply->insert();
1016         }
1017
1018         return;
1019     }
1020
1021     /**
1022      * Pull @-replies from this message's content in StatusNet markup format
1023      * and save reply records indicating that this message needs to be
1024      * delivered to those users.
1025      *
1026      * Mail notifications to local profiles will be sent later.
1027      *
1028      * @return array of integer profile IDs
1029      */
1030
1031     function saveReplies()
1032     {
1033         // Don't save reply data for repeats
1034
1035         if (!empty($this->repeat_of)) {
1036             return array();
1037         }
1038
1039         $sender = Profile::staticGet($this->profile_id);
1040
1041         // @todo ideally this parser information would only
1042         // be calculated once.
1043
1044         $mentions = common_find_mentions($this->content, $this);
1045
1046         $replied = array();
1047
1048         // store replied only for first @ (what user/notice what the reply directed,
1049         // we assume first @ is it)
1050
1051         foreach ($mentions as $mention) {
1052
1053             foreach ($mention['mentioned'] as $mentioned) {
1054
1055                 // skip if they're already covered
1056
1057                 if (!empty($replied[$mentioned->id])) {
1058                     continue;
1059                 }
1060
1061                 // Don't save replies from blocked profile to local user
1062
1063                 $mentioned_user = User::staticGet('id', $mentioned->id);
1064                 if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
1065                     continue;
1066                 }
1067
1068                 $reply = new Reply();
1069
1070                 $reply->notice_id  = $this->id;
1071                 $reply->profile_id = $mentioned->id;
1072                 $reply->modified   = $this->created;
1073
1074                 $id = $reply->insert();
1075
1076                 if (!$id) {
1077                     common_log_db_error($reply, 'INSERT', __FILE__);
1078                     // TRANS: Server exception thrown when a reply cannot be saved.
1079                     // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
1080                     throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
1081                 } else {
1082                     $replied[$mentioned->id] = 1;
1083                     self::blow('reply:stream:%d', $mentioned->id);
1084                 }
1085             }
1086         }
1087
1088         $recipientIds = array_keys($replied);
1089
1090         return $recipientIds;
1091     }
1092
1093     /**
1094      * Pull the complete list of @-reply targets for this notice.
1095      *
1096      * @return array of integer profile ids
1097      */
1098     function getReplies()
1099     {
1100         // XXX: cache me
1101
1102         $ids = array();
1103
1104         $reply = new Reply();
1105         $reply->selectAdd();
1106         $reply->selectAdd('profile_id');
1107         $reply->notice_id = $this->id;
1108
1109         if ($reply->find()) {
1110             while($reply->fetch()) {
1111                 $ids[] = $reply->profile_id;
1112             }
1113         }
1114
1115         $reply->free();
1116
1117         return $ids;
1118     }
1119
1120     /**
1121      * Send e-mail notifications to local @-reply targets.
1122      *
1123      * Replies must already have been saved; this is expected to be run
1124      * from the distrib queue handler.
1125      */
1126     function sendReplyNotifications()
1127     {
1128         // Don't send reply notifications for repeats
1129
1130         if (!empty($this->repeat_of)) {
1131             return array();
1132         }
1133
1134         $recipientIds = $this->getReplies();
1135
1136         foreach ($recipientIds as $recipientId) {
1137             $user = User::staticGet('id', $recipientId);
1138             if (!empty($user)) {
1139                 mail_notify_attn($user, $this);
1140             }
1141         }
1142     }
1143
1144     /**
1145      * Pull list of groups this notice needs to be delivered to,
1146      * as previously recorded by saveGroups() or saveKnownGroups().
1147      *
1148      * @return array of Group objects
1149      */
1150     function getGroups()
1151     {
1152         // Don't save groups for repeats
1153
1154         if (!empty($this->repeat_of)) {
1155             return array();
1156         }
1157
1158         // XXX: cache me
1159
1160         $groups = array();
1161
1162         $gi = new Group_inbox();
1163
1164         $gi->selectAdd();
1165         $gi->selectAdd('group_id');
1166
1167         $gi->notice_id = $this->id;
1168
1169         if ($gi->find()) {
1170             while ($gi->fetch()) {
1171                 $group = User_group::staticGet('id', $gi->group_id);
1172                 if ($group) {
1173                     $groups[] = $group;
1174                 }
1175             }
1176         }
1177
1178         $gi->free();
1179
1180         return $groups;
1181     }
1182
1183     /**
1184      * Convert a notice into an activity for export.
1185      *
1186      * @param User $cur Current user
1187      *
1188      * @return Activity activity object representing this Notice.
1189      */
1190
1191     function asActivity($cur)
1192     {
1193         $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1194
1195         if (!empty($act)) {
1196             return $act;
1197         }
1198         $act = new Activity();
1199
1200         if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1201
1202             $profile = $this->getProfile();
1203
1204             $act->actor            = ActivityObject::fromProfile($profile);
1205             $act->actor->extra[]   = $profile->profileInfo($cur);
1206             $act->verb             = ActivityVerb::POST;
1207             $act->objects[]        = ActivityObject::fromNotice($this);
1208
1209             // XXX: should this be handled by default processing for object entry?
1210
1211             $act->time    = strtotime($this->created);
1212             $act->link    = $this->bestUrl();
1213
1214             $act->content = common_xml_safe_str($this->rendered);
1215             $act->id      = $this->uri;
1216             $act->title   = common_xml_safe_str($this->content);
1217
1218             // Categories
1219
1220             $tags = $this->getTags();
1221
1222             foreach ($tags as $tag) {
1223                 $cat       = new AtomCategory();
1224                 $cat->term = $tag;
1225
1226                 $act->categories[] = $cat;
1227             }
1228
1229             // Enclosures
1230             // XXX: use Atom Media and/or File activity objects instead
1231
1232             $attachments = $this->attachments();
1233
1234             foreach ($attachments as $attachment) {
1235                 $enclosure = $attachment->getEnclosure();
1236                 if ($enclosure) {
1237                     $act->enclosures[] = $enclosure;
1238                 }
1239             }
1240
1241             $ctx = new ActivityContext();
1242
1243             if (!empty($this->reply_to)) {
1244                 $reply = Notice::staticGet('id', $this->reply_to);
1245                 if (!empty($reply)) {
1246                     $ctx->replyToID  = $reply->uri;
1247                     $ctx->replyToUrl = $reply->bestUrl();
1248                 }
1249             }
1250
1251             $ctx->location = $this->getLocation();
1252
1253             $conv = null;
1254
1255             if (!empty($this->conversation)) {
1256                 $conv = Conversation::staticGet('id', $this->conversation);
1257                 if (!empty($conv)) {
1258                     $ctx->conversation = $conv->uri;
1259                 }
1260             }
1261
1262             $reply_ids = $this->getReplies();
1263
1264             foreach ($reply_ids as $id) {
1265                 $profile = Profile::staticGet('id', $id);
1266                 if (!empty($profile)) {
1267                     $ctx->attention[] = $profile->getUri();
1268                 }
1269             }
1270
1271             $groups = $this->getGroups();
1272
1273             foreach ($groups as $group) {
1274                 $ctx->attention[] = $group->getUri();
1275             }
1276
1277             // XXX: deprecated; use ActivityVerb::SHARE instead
1278
1279             $repeat = null;
1280
1281             if (!empty($this->repeat_of)) {
1282                 $repeat = Notice::staticGet('id', $this->repeat_of);
1283                 $ctx->forwardID  = $repeat->uri;
1284                 $ctx->forwardUrl = $repeat->bestUrl();
1285             }
1286
1287             $act->context = $ctx;
1288
1289             // Source
1290
1291             $atom_feed = $profile->getAtomFeed();
1292
1293             if (!empty($atom_feed)) {
1294
1295                 $act->source = new ActivitySource();
1296
1297                 // XXX: we should store the actual feed ID
1298
1299                 $act->source->id = $atom_feed;
1300
1301                 // XXX: we should store the actual feed title
1302
1303                 $act->source->title = $profile->getBestName();
1304
1305                 $act->source->links['alternate'] = $profile->profileurl;
1306                 $act->source->links['self']      = $atom_feed;
1307
1308                 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1309
1310                 $notice = $profile->getCurrentNotice();
1311
1312                 if (!empty($notice)) {
1313                     $act->source->updated = self::utcDate($notice->created);
1314                 }
1315
1316                 $user = User::staticGet('id', $profile->id);
1317
1318                 if (!empty($user)) {
1319                     $act->source->links['license'] = common_config('license', 'url');
1320                 }
1321             }
1322
1323             if ($this->isLocal()) {
1324                 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1325                                                                            'format' => 'atom'));
1326                 $act->editLink = $act->selfLink;
1327             }
1328
1329             Event::handle('EndNoticeAsActivity', array($this, &$act));
1330         }
1331
1332         self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1333
1334         return $act;
1335     }
1336
1337     // This has gotten way too long. Needs to be sliced up into functional bits
1338     // or ideally exported to a utility class.
1339
1340     function asAtomEntry($namespace=false,
1341                          $source=false,
1342                          $author=true,
1343                          $cur=null)
1344     {
1345         $act = $this->asActivity($cur);
1346         $act->extra[] = $this->noticeInfo($cur);
1347         return $act->asString($namespace, $author, $source);
1348     }
1349
1350     /**
1351      * Extra notice info for atom entries
1352      *
1353      * Clients use some extra notice info in the atom stream.
1354      * This gives it to them.
1355      *
1356      * @param User $cur Current user
1357      *
1358      * @return array representation of <statusnet:notice_info> element
1359      */
1360
1361     function noticeInfo($cur)
1362     {
1363         // local notice ID (useful to clients for ordering)
1364
1365         $noticeInfoAttr = array('local_id' => $this->id);
1366
1367         // notice source
1368
1369         $ns = $this->getSource();
1370
1371         if (!empty($ns)) {
1372             $noticeInfoAttr['source'] =  $ns->code;
1373             if (!empty($ns->url)) {
1374                 $noticeInfoAttr['source_link'] = $ns->url;
1375                 if (!empty($ns->name)) {
1376                     $noticeInfoAttr['source'] =  '<a href="'
1377                         . htmlspecialchars($ns->url)
1378                         . '" rel="nofollow">'
1379                         . htmlspecialchars($ns->name)
1380                         . '</a>';
1381                 }
1382             }
1383         }
1384
1385         // favorite and repeated
1386
1387         if (!empty($cur)) {
1388             $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
1389             $cp = $cur->getProfile();
1390             $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this->id)) ? "true" : "false";
1391         }
1392
1393         if (!empty($this->repeat_of)) {
1394             $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1395         }
1396
1397         return array('statusnet:notice_info', $noticeInfoAttr, null);
1398     }
1399
1400     /**
1401      * Returns an XML string fragment with a reference to a notice as an
1402      * Activity Streams noun object with the given element type.
1403      *
1404      * Assumes that 'activity' namespace has been previously defined.
1405      *
1406      * @param string $element one of 'subject', 'object', 'target'
1407      * @return string
1408      */
1409
1410     function asActivityNoun($element)
1411     {
1412         $noun = ActivityObject::fromNotice($this);
1413         return $noun->asString('activity:' . $element);
1414     }
1415
1416     function bestUrl()
1417     {
1418         if (!empty($this->url)) {
1419             return $this->url;
1420         } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1421             return $this->uri;
1422         } else {
1423             return common_local_url('shownotice',
1424                                     array('notice' => $this->id));
1425         }
1426     }
1427
1428
1429     /**
1430      * Determine which notice, if any, a new notice is in reply to.
1431      *
1432      * For conversation tracking, we try to see where this notice fits
1433      * in the tree. Rough algorithm is:
1434      *
1435      * if (reply_to is set and valid) {
1436      *     return reply_to;
1437      * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1438      *     return ID of last notice by initial @name in content;
1439      * }
1440      *
1441      * Note that all @nickname instances will still be used to save "reply" records,
1442      * so the notice shows up in the mentioned users' "replies" tab.
1443      *
1444      * @param integer $reply_to   ID passed in by Web or API
1445      * @param integer $profile_id ID of author
1446      * @param string  $source     Source tag, like 'web' or 'gwibber'
1447      * @param string  $content    Final notice content
1448      *
1449      * @return integer ID of replied-to notice, or null for not a reply.
1450      */
1451
1452     static function getReplyTo($reply_to, $profile_id, $source, $content)
1453     {
1454         static $lb = array('xmpp', 'mail', 'sms', 'omb');
1455
1456         // If $reply_to is specified, we check that it exists, and then
1457         // return it if it does
1458
1459         if (!empty($reply_to)) {
1460             $reply_notice = Notice::staticGet('id', $reply_to);
1461             if (!empty($reply_notice)) {
1462                 return $reply_to;
1463             }
1464         }
1465
1466         // If it's not a "low bandwidth" source (one where you can't set
1467         // a reply_to argument), we return. This is mostly web and API
1468         // clients.
1469
1470         if (!in_array($source, $lb)) {
1471             return null;
1472         }
1473
1474         // Is there an initial @ or T?
1475
1476         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1477             preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1478             $nickname = common_canonical_nickname($match[1]);
1479         } else {
1480             return null;
1481         }
1482
1483         // Figure out who that is.
1484
1485         $sender = Profile::staticGet('id', $profile_id);
1486         if (empty($sender)) {
1487             return null;
1488         }
1489
1490         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1491
1492         if (empty($recipient)) {
1493             return null;
1494         }
1495
1496         // Get their last notice
1497
1498         $last = $recipient->getCurrentNotice();
1499
1500         if (!empty($last)) {
1501             return $last->id;
1502         }
1503     }
1504
1505     static function maxContent()
1506     {
1507         $contentlimit = common_config('notice', 'contentlimit');
1508         // null => use global limit (distinct from 0!)
1509         if (is_null($contentlimit)) {
1510             $contentlimit = common_config('site', 'textlimit');
1511         }
1512         return $contentlimit;
1513     }
1514
1515     static function contentTooLong($content)
1516     {
1517         $contentlimit = self::maxContent();
1518         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1519     }
1520
1521     function getLocation()
1522     {
1523         $location = null;
1524
1525         if (!empty($this->location_id) && !empty($this->location_ns)) {
1526             $location = Location::fromId($this->location_id, $this->location_ns);
1527         }
1528
1529         if (is_null($location)) { // no ID, or Location::fromId() failed
1530             if (!empty($this->lat) && !empty($this->lon)) {
1531                 $location = Location::fromLatLon($this->lat, $this->lon);
1532             }
1533         }
1534
1535         return $location;
1536     }
1537
1538     function repeat($repeater_id, $source)
1539     {
1540         $author = Profile::staticGet('id', $this->profile_id);
1541
1542         // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1543         // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1544         $content = sprintf(_('RT @%1$s %2$s'),
1545                            $author->nickname,
1546                            $this->content);
1547
1548         $maxlen = common_config('site', 'textlimit');
1549         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1550             // Web interface and current Twitter API clients will
1551             // pull the original notice's text, but some older
1552             // clients and RSS/Atom feeds will see this trimmed text.
1553             //
1554             // Unfortunately this is likely to lose tags or URLs
1555             // at the end of long notices.
1556             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1557         }
1558
1559         return self::saveNew($repeater_id, $content, $source,
1560                              array('repeat_of' => $this->id));
1561     }
1562
1563     // These are supposed to be in chron order!
1564
1565     function repeatStream($limit=100)
1566     {
1567         $cache = Cache::instance();
1568
1569         if (empty($cache)) {
1570             $ids = $this->_repeatStreamDirect($limit);
1571         } else {
1572             $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1573             if ($idstr !== false) {
1574                 $ids = explode(',', $idstr);
1575             } else {
1576                 $ids = $this->_repeatStreamDirect(100);
1577                 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1578             }
1579             if ($limit < 100) {
1580                 // We do a max of 100, so slice down to limit
1581                 $ids = array_slice($ids, 0, $limit);
1582             }
1583         }
1584
1585         return NoticeStream::getStreamByIds($ids);
1586     }
1587
1588     function _repeatStreamDirect($limit)
1589     {
1590         $notice = new Notice();
1591
1592         $notice->selectAdd(); // clears it
1593         $notice->selectAdd('id');
1594
1595         $notice->repeat_of = $this->id;
1596
1597         $notice->orderBy('created, id'); // NB: asc!
1598
1599         if (!is_null($limit)) {
1600             $notice->limit(0, $limit);
1601         }
1602
1603         $ids = array();
1604
1605         if ($notice->find()) {
1606             while ($notice->fetch()) {
1607                 $ids[] = $notice->id;
1608             }
1609         }
1610
1611         $notice->free();
1612         $notice = NULL;
1613
1614         return $ids;
1615     }
1616
1617     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1618     {
1619         $options = array();
1620
1621         if (!empty($location_id) && !empty($location_ns)) {
1622             $options['location_id'] = $location_id;
1623             $options['location_ns'] = $location_ns;
1624
1625             $location = Location::fromId($location_id, $location_ns);
1626
1627             if (!empty($location)) {
1628                 $options['lat'] = $location->lat;
1629                 $options['lon'] = $location->lon;
1630             }
1631
1632         } else if (!empty($lat) && !empty($lon)) {
1633             $options['lat'] = $lat;
1634             $options['lon'] = $lon;
1635
1636             $location = Location::fromLatLon($lat, $lon);
1637
1638             if (!empty($location)) {
1639                 $options['location_id'] = $location->location_id;
1640                 $options['location_ns'] = $location->location_ns;
1641             }
1642         } else if (!empty($profile)) {
1643             if (isset($profile->lat) && isset($profile->lon)) {
1644                 $options['lat'] = $profile->lat;
1645                 $options['lon'] = $profile->lon;
1646             }
1647
1648             if (isset($profile->location_id) && isset($profile->location_ns)) {
1649                 $options['location_id'] = $profile->location_id;
1650                 $options['location_ns'] = $profile->location_ns;
1651             }
1652         }
1653
1654         return $options;
1655     }
1656
1657     function clearReplies()
1658     {
1659         $replyNotice = new Notice();
1660         $replyNotice->reply_to = $this->id;
1661
1662         //Null any notices that are replies to this notice
1663
1664         if ($replyNotice->find()) {
1665             while ($replyNotice->fetch()) {
1666                 $orig = clone($replyNotice);
1667                 $replyNotice->reply_to = null;
1668                 $replyNotice->update($orig);
1669             }
1670         }
1671
1672         // Reply records
1673
1674         $reply = new Reply();
1675         $reply->notice_id = $this->id;
1676
1677         if ($reply->find()) {
1678             while($reply->fetch()) {
1679                 self::blow('reply:stream:%d', $reply->profile_id);
1680                 $reply->delete();
1681             }
1682         }
1683
1684         $reply->free();
1685     }
1686
1687     function clearFiles()
1688     {
1689         $f2p = new File_to_post();
1690
1691         $f2p->post_id = $this->id;
1692
1693         if ($f2p->find()) {
1694             while ($f2p->fetch()) {
1695                 $f2p->delete();
1696             }
1697         }
1698         // FIXME: decide whether to delete File objects
1699         // ...and related (actual) files
1700     }
1701
1702     function clearRepeats()
1703     {
1704         $repeatNotice = new Notice();
1705         $repeatNotice->repeat_of = $this->id;
1706
1707         //Null any notices that are repeats of this notice
1708
1709         if ($repeatNotice->find()) {
1710             while ($repeatNotice->fetch()) {
1711                 $orig = clone($repeatNotice);
1712                 $repeatNotice->repeat_of = null;
1713                 $repeatNotice->update($orig);
1714             }
1715         }
1716     }
1717
1718     function clearFaves()
1719     {
1720         $fave = new Fave();
1721         $fave->notice_id = $this->id;
1722
1723         if ($fave->find()) {
1724             while ($fave->fetch()) {
1725                 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1726                 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1727                 self::blow('fave:ids_by_user:%d', $fave->user_id);
1728                 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1729                 $fave->delete();
1730             }
1731         }
1732
1733         $fave->free();
1734     }
1735
1736     function clearTags()
1737     {
1738         $tag = new Notice_tag();
1739         $tag->notice_id = $this->id;
1740
1741         if ($tag->find()) {
1742             while ($tag->fetch()) {
1743                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
1744                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
1745                 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
1746                 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
1747                 $tag->delete();
1748             }
1749         }
1750
1751         $tag->free();
1752     }
1753
1754     function clearGroupInboxes()
1755     {
1756         $gi = new Group_inbox();
1757
1758         $gi->notice_id = $this->id;
1759
1760         if ($gi->find()) {
1761             while ($gi->fetch()) {
1762                 self::blow('user_group:notice_ids:%d', $gi->group_id);
1763                 $gi->delete();
1764             }
1765         }
1766
1767         $gi->free();
1768     }
1769
1770     function distribute()
1771     {
1772         // We always insert for the author so they don't
1773         // have to wait
1774         Event::handle('StartNoticeDistribute', array($this));
1775
1776         $user = User::staticGet('id', $this->profile_id);
1777         if (!empty($user)) {
1778             Inbox::insertNotice($user->id, $this->id);
1779         }
1780
1781         if (common_config('queue', 'inboxes')) {
1782             // If there's a failure, we want to _force_
1783             // distribution at this point.
1784             try {
1785                 $qm = QueueManager::get();
1786                 $qm->enqueue($this, 'distrib');
1787             } catch (Exception $e) {
1788                 // If the exception isn't transient, this
1789                 // may throw more exceptions as DQH does
1790                 // its own enqueueing. So, we ignore them!
1791                 try {
1792                     $handler = new DistribQueueHandler();
1793                     $handler->handle($this);
1794                 } catch (Exception $e) {
1795                     common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1796                 }
1797                 // Re-throw so somebody smarter can handle it.
1798                 throw $e;
1799             }
1800         } else {
1801             $handler = new DistribQueueHandler();
1802             $handler->handle($this);
1803         }
1804     }
1805
1806     function insert()
1807     {
1808         $result = parent::insert();
1809
1810         if ($result) {
1811             // Profile::hasRepeated() abuses pkeyGet(), so we
1812             // have to clear manually
1813             if (!empty($this->repeat_of)) {
1814                 $c = self::memcache();
1815                 if (!empty($c)) {
1816                     $ck = self::multicacheKey('Notice',
1817                                               array('profile_id' => $this->profile_id,
1818                                                     'repeat_of' => $this->repeat_of));
1819                     $c->delete($ck);
1820                 }
1821             }
1822         }
1823
1824         return $result;
1825     }
1826
1827     /**
1828      * Get the source of the notice
1829      *
1830      * @return Notice_source $ns A notice source object. 'code' is the only attribute
1831      *                           guaranteed to be populated.
1832      */
1833     function getSource()
1834     {
1835         $ns = new Notice_source();
1836         if (!empty($this->source)) {
1837             switch ($this->source) {
1838             case 'web':
1839             case 'xmpp':
1840             case 'mail':
1841             case 'omb':
1842             case 'system':
1843             case 'api':
1844                 $ns->code = $this->source;
1845                 break;
1846             default:
1847                 $ns = Notice_source::staticGet($this->source);
1848                 if (!$ns) {
1849                     $ns = new Notice_source();
1850                     $ns->code = $this->source;
1851                     $app = Oauth_application::staticGet('name', $this->source);
1852                     if ($app) {
1853                         $ns->name = $app->name;
1854                         $ns->url  = $app->source_url;
1855                     }
1856                 }
1857                 break;
1858             }
1859         }
1860         return $ns;
1861     }
1862
1863     /**
1864      * Determine whether the notice was locally created
1865      *
1866      * @return boolean locality
1867      */
1868
1869     public function isLocal()
1870     {
1871         return ($this->is_local == Notice::LOCAL_PUBLIC ||
1872                 $this->is_local == Notice::LOCAL_NONPUBLIC);
1873     }
1874
1875     /**
1876      * Get the list of hash tags saved with this notice.
1877      *
1878      * @return array of strings
1879      */
1880     public function getTags()
1881     {
1882         $tags = array();
1883         $tag = new Notice_tag();
1884         $tag->notice_id = $this->id;
1885         if ($tag->find()) {
1886             while ($tag->fetch()) {
1887                 $tags[] = $tag->tag;
1888             }
1889         }
1890         $tag->free();
1891         return $tags;
1892     }
1893
1894     static private function utcDate($dt)
1895     {
1896         $dateStr = date('d F Y H:i:s', strtotime($dt));
1897         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1898         return $d->format(DATE_W3C);
1899     }
1900
1901     /**
1902      * Look up the creation timestamp for a given notice ID, even
1903      * if it's been deleted.
1904      *
1905      * @param int $id
1906      * @return mixed string recorded creation timestamp, or false if can't be found
1907      */
1908     public static function getAsTimestamp($id)
1909     {
1910         if (!$id) {
1911             return false;
1912         }
1913
1914         $notice = Notice::staticGet('id', $id);
1915         if ($notice) {
1916             return $notice->created;
1917         }
1918
1919         $deleted = Deleted_notice::staticGet('id', $id);
1920         if ($deleted) {
1921             return $deleted->created;
1922         }
1923
1924         return false;
1925     }
1926
1927     /**
1928      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
1929      * parameter, matching notices posted after the given one (exclusive).
1930      *
1931      * If the referenced notice can't be found, will return false.
1932      *
1933      * @param int $id
1934      * @param string $idField
1935      * @param string $createdField
1936      * @return mixed string or false if no match
1937      */
1938     public static function whereSinceId($id, $idField='id', $createdField='created')
1939     {
1940         $since = Notice::getAsTimestamp($id);
1941         if ($since) {
1942             return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
1943         }
1944         return false;
1945     }
1946
1947     /**
1948      * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
1949      * parameter, matching notices posted after the given one (exclusive), and
1950      * if necessary add it to the data object's query.
1951      *
1952      * @param DB_DataObject $obj
1953      * @param int $id
1954      * @param string $idField
1955      * @param string $createdField
1956      * @return mixed string or false if no match
1957      */
1958     public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
1959     {
1960         $since = self::whereSinceId($id, $idField, $createdField);
1961         if ($since) {
1962             $obj->whereAdd($since);
1963         }
1964     }
1965
1966     /**
1967      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
1968      * parameter, matching notices posted before the given one (inclusive).
1969      *
1970      * If the referenced notice can't be found, will return false.
1971      *
1972      * @param int $id
1973      * @param string $idField
1974      * @param string $createdField
1975      * @return mixed string or false if no match
1976      */
1977     public static function whereMaxId($id, $idField='id', $createdField='created')
1978     {
1979         $max = Notice::getAsTimestamp($id);
1980         if ($max) {
1981             return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
1982         }
1983         return false;
1984     }
1985
1986     /**
1987      * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
1988      * parameter, matching notices posted before the given one (inclusive), and
1989      * if necessary add it to the data object's query.
1990      *
1991      * @param DB_DataObject $obj
1992      * @param int $id
1993      * @param string $idField
1994      * @param string $createdField
1995      * @return mixed string or false if no match
1996      */
1997     public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
1998     {
1999         $max = self::whereMaxId($id, $idField, $createdField);
2000         if ($max) {
2001             $obj->whereAdd($max);
2002         }
2003     }
2004
2005     function isPublic()
2006     {
2007         if (common_config('public', 'localonly')) {
2008             return ($this->is_local == Notice::LOCAL_PUBLIC);
2009         } else {
2010             return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2011                     ($this->is_local != Notice::GATEWAY));
2012         }
2013     }
2014 }