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