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