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