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
 124     function saveTags()
 125     {
 126         /* extract all #hastags */
 127         $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/', strtolower($this->content), $match);
 128         if (!$count) {
 129             return true;
 130         }
 131
 132         //turn each into their canonical tag
 133         //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
 134         $hashtags = array();
 135         for($i=0; $i<count($match[1]); $i++) {
 136             $hashtags[] = common_canonical_tag($match[1][$i]);
 137         }
 138
 139         /* Add them to the database */
 140         foreach(array_unique($hashtags) as $hashtag) {
 141             /* elide characters we don't want in the tag */
 142             $this->saveTag($hashtag);
 143             self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
 144         }
 145         return true;
 146     }
 147
 148     function saveTag($hashtag)
 149     {
 150         $tag = new Notice_tag();
 151         $tag->notice_id = $this->id;
 152         $tag->tag = $hashtag;
 153         $tag->created = $this->created;
 154         $id = $tag->insert();
 155
 156         if (!$id) {
 157             throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
 158                                               $last_error->message));
 159             return;
 160         }
 161
 162         // if it's saved, blow its cache
 163         $tag->blowCache(false);
 164     }
 165
 166     /**
 167      * Save a new notice and push it out to subscribers' inboxes.
 168      * Poster's permissions are checked before sending.
 169      *
 170      * @param int $profile_id Profile ID of the poster
 171      * @param string $content source message text; links may be shortened
 172      *                        per current user's preference
 173      * @param string $source source key ('web', 'api', etc)
 174      * @param array $options Associative array of optional properties:
 175      *              string 'created' timestamp of notice; defaults to now
 176      *              int 'is_local' source/gateway ID, one of:
 177      *                  Notice::LOCAL_PUBLIC    - Local, ok to appear in public timeline
 178      *                  Notice::REMOTE_OMB      - Sent from a remote OMB service;
 179      *                                            hide from public timeline but show in
 180      *                                            local "and friends" timelines
 181      *                  Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
 182      *                  Notice::GATEWAY         - From another non-OMB service;
 183      *                                            will not appear in public views
 184      *              float 'lat' decimal latitude for geolocation
 185      *              float 'lon' decimal longitude for geolocation
 186      *              int 'location_id' geoname identifier
 187      *              int 'location_ns' geoname namespace to interpret location_id
 188      *              int 'reply_to'; notice ID this is a reply to
 189      *              int 'repeat_of'; notice ID this is a repeat of
 190      *              string 'uri' permalink to notice; defaults to local notice URL
 191      *
 192      * @return Notice
 193      * @throws ClientException
 194      */
 195     static function saveNew($profile_id, $content, $source, $options=null) {
 196         $defaults = array('uri' => null,
 197                           'reply_to' => null,
 198                           'repeat_of' => null);
 199
 200         if (!empty($options)) {
 201             $options = $options + $defaults;
 202             extract($options);
 203         }
 204
 205         if (!isset($is_local)) {
 206             $is_local = Notice::LOCAL_PUBLIC;
 207         }
 208
 209         $profile = Profile::staticGet($profile_id);
 210
 211         $final = common_shorten_links($content);
 212
 213         if (Notice::contentTooLong($final)) {
 214             throw new ClientException(_('Problem saving notice. Too long.'));
 215         }
 216
 217         if (empty($profile)) {
 218             throw new ClientException(_('Problem saving notice. Unknown user.'));
 219         }
 220
 221         if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
 222             common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
 223             throw new ClientException(_('Too many notices too fast; take a breather '.
 224                                         'and post again in a few minutes.'));
 225         }
 226
 227         if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
 228             common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
 229             throw new ClientException(_('Too many duplicate messages too quickly;'.
 230                                         ' take a breather and post again in a few minutes.'));
 231         }
 232
 233         if (!$profile->hasRight(Right::NEWNOTICE)) {
 234             common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
 235             throw new ClientException(_('You are banned from posting notices on this site.'));
 236         }
 237
 238         $notice = new Notice();
 239         $notice->profile_id = $profile_id;
 240
 241         $autosource = common_config('public', 'autosource');
 242
 243         # Sandboxed are non-false, but not 1, either
 244
 245         if (!$profile->hasRight(Right::PUBLICNOTICE) ||
 246             ($source && $autosource && in_array($source, $autosource))) {
 247             $notice->is_local = Notice::LOCAL_NONPUBLIC;
 248         } else {
 249             $notice->is_local = $is_local;
 250         }
 251
 252         if (!empty($created)) {
 253             $notice->created = $created;
 254         } else {
 255             $notice->created = common_sql_now();
 256         }
 257
 258         $notice->content = $final;
 259         $notice->rendered = common_render_content($final, $notice);
 260         $notice->source = $source;
 261         $notice->uri = $uri;
 262
 263         // Handle repeat case
 264
 265         if (isset($repeat_of)) {
 266             $notice->repeat_of = $repeat_of;
 267         } else {
 268             $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
 269         }
 270
 271         if (!empty($notice->reply_to)) {
 272             $reply = Notice::staticGet('id', $notice->reply_to);
 273             $notice->conversation = $reply->conversation;
 274         }
 275
 276         if (!empty($lat) && !empty($lon)) {
 277             $notice->lat = $lat;
 278             $notice->lon = $lon;
 279         }
 280
 281         if (!empty($location_ns) && !empty($location_id)) {
 282             $notice->location_id = $location_id;
 283             $notice->location_ns = $location_ns;
 284         }
 285
 286         if (Event::handle('StartNoticeSave', array(&$notice))) {
 287
 288             // XXX: some of these functions write to the DB
 289
 290             $id = $notice->insert();
 291
 292             if (!$id) {
 293                 common_log_db_error($notice, 'INSERT', __FILE__);
 294                 throw new ServerException(_('Problem saving notice.'));
 295             }
 296
 297             // Update ID-dependent columns: URI, conversation
 298
 299             $orig = clone($notice);
 300
 301             $changed = false;
 302
 303             if (empty($uri)) {
 304                 $notice->uri = common_notice_uri($notice);
 305                 $changed = true;
 306             }
 307
 308             // If it's not part of a conversation, it's
 309             // the beginning of a new conversation.
 310
 311             if (empty($notice->conversation)) {
 312                 $notice->conversation = $notice->id;
 313                 $changed = true;
 314             }
 315
 316             if ($changed) {
 317                 if (!$notice->update($orig)) {
 318                     common_log_db_error($notice, 'UPDATE', __FILE__);
 319                     throw new ServerException(_('Problem saving notice.'));
 320                 }
 321             }
 322
 323         }
 324
 325         # Clear the cache for subscribed users, so they'll update at next request
 326         # XXX: someone clever could prepend instead of clearing the cache
 327         $notice->blowOnInsert();
 328
 329         $notice->distribute();
 330
 331         return $notice;
 332     }
 333
 334     function blowOnInsert()
 335     {
 336         self::blow('profile:notice_ids:%d', $this->profile_id);
 337         self::blow('public');
 338
 339         if ($this->conversation != $this->id) {
 340             self::blow('notice:conversation_ids:%d', $this->conversation);
 341         }
 342
 343         if (!empty($this->repeat_of)) {
 344             self::blow('notice:repeats:%d', $this->repeat_of);
 345         }
 346
 347         $original = Notice::staticGet('id', $this->repeat_of);
 348
 349         if (!empty($original)) {
 350             $originalUser = User::staticGet('id', $original->profile_id);
 351             if (!empty($originalUser)) {
 352                 self::blow('user:repeats_of_me:%d', $originalUser->id);
 353             }
 354         }
 355
 356         $profile = Profile::staticGet($this->profile_id);
 357         $profile->blowNoticeCount();
 358     }
 359
 360     /** save all urls in the notice to the db
 361      *
 362      * follow redirects and save all available file information
 363      * (mimetype, date, size, oembed, etc.)
 364      *
 365      * @return void
 366      */
 367     function saveUrls() {
 368         common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
 369     }
 370
 371     function saveUrl($data) {
 372         list($url, $notice_id) = $data;
 373         File::processNew($url, $notice_id);
 374     }
 375
 376     static function checkDupes($profile_id, $content) {
 377         $profile = Profile::staticGet($profile_id);
 378         if (empty($profile)) {
 379             return false;
 380         }
 381         $notice = $profile->getNotices(0, NOTICE_CACHE_WINDOW);
 382         if (!empty($notice)) {
 383             $last = 0;
 384             while ($notice->fetch()) {
 385                 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
 386                     return true;
 387                 } else if ($notice->content == $content) {
 388                     return false;
 389                 }
 390             }
 391         }
 392         # If we get here, oldest item in cache window is not
 393         # old enough for dupe limit; do direct check against DB
 394         $notice = new Notice();
 395         $notice->profile_id = $profile_id;
 396         $notice->content = $content;
 397         if (common_config('db','type') == 'pgsql')
 398           $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
 399         else
 400           $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
 401
 402         $cnt = $notice->count();
 403         return ($cnt == 0);
 404     }
 405
 406     static function checkEditThrottle($profile_id) {
 407         $profile = Profile::staticGet($profile_id);
 408         if (empty($profile)) {
 409             return false;
 410         }
 411         # Get the Nth notice
 412         $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
 413         if ($notice && $notice->fetch()) {
 414             # If the Nth notice was posted less than timespan seconds ago
 415             if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
 416                 # Then we throttle
 417                 return false;
 418             }
 419         }
 420         # Either not N notices in the stream, OR the Nth was not posted within timespan seconds
 421         return true;
 422     }
 423
 424     function getUploadedAttachment() {
 425         $post = clone $this;
 426         $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"';
 427         $post->query($query);
 428         $post->fetch();
 429         if (empty($post->up) || empty($post->i)) {
 430             $ret = false;
 431         } else {
 432             $ret = array($post->up, $post->i);
 433         }
 434         $post->free();
 435         return $ret;
 436     }
 437
 438     function hasAttachments() {
 439         $post = clone $this;
 440         $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);
 441         $post->query($query);
 442         $post->fetch();
 443         $n_attachments = intval($post->n_attachments);
 444         $post->free();
 445         return $n_attachments;
 446     }
 447
 448     function attachments() {
 449         // XXX: cache this
 450         $att = array();
 451         $f2p = new File_to_post;
 452         $f2p->post_id = $this->id;
 453         if ($f2p->find()) {
 454             while ($f2p->fetch()) {
 455                 $f = File::staticGet($f2p->file_id);
 456                 $att[] = clone($f);
 457             }
 458         }
 459         return $att;
 460     }
 461
 462     function getStreamByIds($ids)
 463     {
 464         $cache = common_memcache();
 465
 466         if (!empty($cache)) {
 467             $notices = array();
 468             foreach ($ids as $id) {
 469                 $n = Notice::staticGet('id', $id);
 470                 if (!empty($n)) {
 471                     $notices[] = $n;
 472                 }
 473             }
 474             return new ArrayWrapper($notices);
 475         } else {
 476             $notice = new Notice();
 477             if (empty($ids)) {
 478                 //if no IDs requested, just return the notice object
 479                 return $notice;
 480             }
 481             $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
 482
 483             $notice->find();
 484
 485             $temp = array();
 486
 487             while ($notice->fetch()) {
 488                 $temp[$notice->id] = clone($notice);
 489             }
 490
 491             $wrapped = array();
 492
 493             foreach ($ids as $id) {
 494                 if (array_key_exists($id, $temp)) {
 495                     $wrapped[] = $temp[$id];
 496                 }
 497             }
 498
 499             return new ArrayWrapper($wrapped);
 500         }
 501     }
 502
 503     function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 504     {
 505         $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
 506                               array(),
 507                               'public',
 508                               $offset, $limit, $since_id, $max_id, $since);
 509
 510         return Notice::getStreamByIds($ids);
 511     }
 512
 513     function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 514     {
 515         $notice = new Notice();
 516
 517         $notice->selectAdd(); // clears it
 518         $notice->selectAdd('id');
 519
 520         $notice->orderBy('id DESC');
 521
 522         if (!is_null($offset)) {
 523             $notice->limit($offset, $limit);
 524         }
 525
 526         if (common_config('public', 'localonly')) {
 527             $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
 528         } else {
 529             # -1 == blacklisted, -2 == gateway (i.e. Twitter)
 530             $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
 531             $notice->whereAdd('is_local !='. Notice::GATEWAY);
 532         }
 533
 534         if ($since_id != 0) {
 535             $notice->whereAdd('id > ' . $since_id);
 536         }
 537
 538         if ($max_id != 0) {
 539             $notice->whereAdd('id <= ' . $max_id);
 540         }
 541
 542         if (!is_null($since)) {
 543             $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
 544         }
 545
 546         $ids = array();
 547
 548         if ($notice->find()) {
 549             while ($notice->fetch()) {
 550                 $ids[] = $notice->id;
 551             }
 552         }
 553
 554         $notice->free();
 555         $notice = NULL;
 556
 557         return $ids;
 558     }
 559
 560     function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 561     {
 562         $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
 563                               array($id),
 564                               'notice:conversation_ids:'.$id,
 565                               $offset, $limit, $since_id, $max_id, $since);
 566
 567         return Notice::getStreamByIds($ids);
 568     }
 569
 570     function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
 571     {
 572         $notice = new Notice();
 573
 574         $notice->selectAdd(); // clears it
 575         $notice->selectAdd('id');
 576
 577         $notice->conversation = $id;
 578
 579         $notice->orderBy('id DESC');
 580
 581         if (!is_null($offset)) {
 582             $notice->limit($offset, $limit);
 583         }
 584
 585         if ($since_id != 0) {
 586             $notice->whereAdd('id > ' . $since_id);
 587         }
 588
 589         if ($max_id != 0) {
 590             $notice->whereAdd('id <= ' . $max_id);
 591         }
 592
 593         if (!is_null($since)) {
 594             $notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
 595         }
 596
 597         $ids = array();
 598
 599         if ($notice->find()) {
 600             while ($notice->fetch()) {
 601                 $ids[] = $notice->id;
 602             }
 603         }
 604
 605         $notice->free();
 606         $notice = NULL;
 607
 608         return $ids;
 609     }
 610
 611     /**
 612      * @param $groups array of Group *objects*
 613      * @param $recipients array of profile *ids*
 614      */
 615     function whoGets($groups=null, $recipients=null)
 616     {
 617         $c = self::memcache();
 618
 619         if (!empty($c)) {
 620             $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
 621             if ($ni !== false) {
 622                 return $ni;
 623             }
 624         }
 625
 626         if (is_null($groups)) {
 627             $groups = $this->getGroups();
 628         }
 629
 630         if (is_null($recipients)) {
 631             $recipients = $this->getReplies();
 632         }
 633
 634         $users = $this->getSubscribedUsers();
 635
 636         // FIXME: kind of ignoring 'transitional'...
 637         // we'll probably stop supporting inboxless mode
 638         // in 0.9.x
 639
 640         $ni = array();
 641
 642         foreach ($users as $id) {
 643             $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
 644         }
 645
 646         $profile = $this->getProfile();
 647
 648         foreach ($groups as $group) {
 649             $users = $group->getUserMembers();
 650             foreach ($users as $id) {
 651                 if (!array_key_exists($id, $ni)) {
 652                     $user = User::staticGet('id', $id);
 653                     if (!$user->hasBlocked($profile)) {
 654                         $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
 655                     }
 656                 }
 657             }
 658         }
 659
 660         foreach ($recipients as $recipient) {
 661
 662             if (!array_key_exists($recipient, $ni)) {
 663                 $recipientUser = User::staticGet('id', $recipient);
 664                 if (!empty($recipientUser)) {
 665                     $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
 666                 }
 667             }
 668         }
 669
 670         if (!empty($c)) {
 671             // XXX: pack this data better
 672             $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
 673         }
 674
 675         return $ni;
 676     }
 677
 678     function addToInboxes($groups, $recipients)
 679     {
 680         $ni = $this->whoGets($groups, $recipients);
 681
 682         Inbox::bulkInsert($this->id, array_keys($ni));
 683
 684         return;
 685     }
 686
 687     function getSubscribedUsers()
 688     {
 689         $user = new User();
 690
 691         if(common_config('db','quote_identifiers'))
 692           $user_table = '"user"';
 693         else $user_table = 'user';
 694
 695         $qry =
 696           'SELECT id ' .
 697           'FROM '. $user_table .' JOIN subscription '.
 698           'ON '. $user_table .'.id = subscription.subscriber ' .
 699           'WHERE subscription.subscribed = %d ';
 700
 701         $user->query(sprintf($qry, $this->profile_id));
 702
 703         $ids = array();
 704
 705         while ($user->fetch()) {
 706             $ids[] = $user->id;
 707         }
 708
 709         $user->free();
 710
 711         return $ids;
 712     }
 713
 714     /**
 715      * @return array of Group objects
 716      */
 717     function saveGroups()
 718     {
 719         // Don't save groups for repeats
 720
 721         if (!empty($this->repeat_of)) {
 722             return array();
 723         }
 724
 725         $groups = array();
 726
 727         /* extract all !group */
 728         $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
 729                                 strtolower($this->content),
 730                                 $match);
 731         if (!$count) {
 732             return $groups;
 733         }
 734
 735         $profile = $this->getProfile();
 736
 737         /* Add them to the database */
 738
 739         foreach (array_unique($match[1]) as $nickname) {
 740             /* XXX: remote groups. */
 741             $group = User_group::getForNickname($nickname);
 742
 743             if (empty($group)) {
 744                 continue;
 745             }
 746
 747             // we automatically add a tag for every group name, too
 748
 749             $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
 750                                              'notice_id' => $this->id));
 751
 752             if (is_null($tag)) {
 753                 $this->saveTag($nickname);
 754             }
 755
 756             if ($profile->isMember($group)) {
 757
 758                 $result = $this->addToGroupInbox($group);
 759
 760                 if (!$result) {
 761                     common_log_db_error($gi, 'INSERT', __FILE__);
 762                 }
 763
 764                 $groups[] = clone($group);
 765             }
 766         }
 767
 768         return $groups;
 769     }
 770
 771     function addToGroupInbox($group)
 772     {
 773         $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
 774                                          'notice_id' => $this->id));
 775
 776         if (empty($gi)) {
 777
 778             $gi = new Group_inbox();
 779
 780             $gi->group_id  = $group->id;
 781             $gi->notice_id = $this->id;
 782             $gi->created   = $this->created;
 783
 784             $result = $gi->insert();
 785
 786             if (!result) {
 787                 common_log_db_error($gi, 'INSERT', __FILE__);
 788                 throw new ServerException(_('Problem saving group inbox.'));
 789             }
 790
 791             self::blow('user_group:notice_ids:%d', $gi->group_id);
 792         }
 793
 794         return true;
 795     }
 796
 797     /**
 798      * @return array of integer profile IDs
 799      */
 800     function saveReplies()
 801     {
 802         // Don't save reply data for repeats
 803
 804         if (!empty($this->repeat_of)) {
 805             return array();
 806         }
 807
 808         // Alternative reply format
 809         $tname = false;
 810         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $this->content, $match)) {
 811             $tname = $match[1];
 812         }
 813         // extract all @messages
 814         $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
 815
 816         $names = array();
 817
 818         if ($cnt || $tname) {
 819             // XXX: is there another way to make an array copy?
 820             $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
 821         }
 822
 823         $sender = Profile::staticGet($this->profile_id);
 824
 825         $replied = array();
 826
 827         // store replied only for first @ (what user/notice what the reply directed,
 828         // we assume first @ is it)
 829
 830         for ($i=0; $i<count($names); $i++) {
 831             $nickname = $names[$i];
 832             $recipient = common_relative_profile($sender, $nickname, $this->created);
 833             if (empty($recipient)) {
 834                 continue;
 835             }
 836             // Don't save replies from blocked profile to local user
 837             $recipient_user = User::staticGet('id', $recipient->id);
 838             if (!empty($recipient_user) && $recipient_user->hasBlocked($sender)) {
 839                 continue;
 840             }
 841             $reply = new Reply();
 842             $reply->notice_id = $this->id;
 843             $reply->profile_id = $recipient->id;
 844             $id = $reply->insert();
 845             if (!$id) {
 846                 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 847                 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
 848                 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
 849                 return array();
 850             } else {
 851                 $replied[$recipient->id] = 1;
 852             }
 853         }
 854
 855         // Hash format replies, too
 856         $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
 857         if ($cnt) {
 858             foreach ($match[1] as $tag) {
 859                 $tagged = Profile_tag::getTagged($sender->id, $tag);
 860                 foreach ($tagged as $t) {
 861                     if (!$replied[$t->id]) {
 862                         // Don't save replies from blocked profile to local user
 863                         $t_user = User::staticGet('id', $t->id);
 864                         if ($t_user && $t_user->hasBlocked($sender)) {
 865                             continue;
 866                         }
 867                         $reply = new Reply();
 868                         $reply->notice_id = $this->id;
 869                         $reply->profile_id = $t->id;
 870                         $id = $reply->insert();
 871                         if (!$id) {
 872                             common_log_db_error($reply, 'INSERT', __FILE__);
 873                             return array();
 874                         } else {
 875                             $replied[$recipient->id] = 1;
 876                         }
 877                     }
 878                 }
 879             }
 880         }
 881
 882         $recipientIds = array_keys($replied);
 883
 884         foreach ($recipientIds as $recipientId) {
 885             $user = User::staticGet('id', $recipientId);
 886             if (!empty($user)) {
 887                 self::blow('reply:stream:%d', $reply->profile_id);
 888                 mail_notify_attn($user, $this);
 889             }
 890         }
 891
 892         return $recipientIds;
 893     }
 894
 895     function getReplies()
 896     {
 897         // XXX: cache me
 898
 899         $ids = array();
 900
 901         $reply = new Reply();
 902         $reply->selectAdd();
 903         $reply->selectAdd('profile_id');
 904         $reply->notice_id = $this->id;
 905
 906         if ($reply->find()) {
 907             while($reply->fetch()) {
 908                 $ids[] = $reply->profile_id;
 909             }
 910         }
 911
 912         $reply->free();
 913
 914         return $ids;
 915     }
 916
 917     /**
 918      * Same calculation as saveGroups but without the saving
 919      * @fixme merge the functions
 920      * @return array of Group objects
 921      */
 922     function getGroups()
 923     {
 924         // Don't save groups for repeats
 925
 926         if (!empty($this->repeat_of)) {
 927             return array();
 928         }
 929
 930         // XXX: cache me
 931
 932         $groups = array();
 933
 934         $gi = new Group_inbox();
 935
 936         $gi->selectAdd();
 937         $gi->selectAdd('group_id');
 938
 939         $gi->notice_id = $this->id;
 940
 941         if ($gi->find()) {
 942             while ($gi->fetch()) {
 943                 $groups[] = clone($gi);
 944             }
 945         }
 946
 947         $gi->free();
 948
 949         return $groups;
 950     }
 951
 952     function asAtomEntry($namespace=false, $source=false)
 953     {
 954         $profile = $this->getProfile();
 955
 956         $xs = new XMLStringer(true);
 957
 958         if ($namespace) {
 959             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
 960                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0');
 961         } else {
 962             $attrs = array();
 963         }
 964
 965         $xs->elementStart('entry', $attrs);
 966
 967         if ($source) {
 968             $xs->elementStart('source');
 969             $xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
 970             $xs->element('link', array('href' => $profile->profileurl));
 971             $user = User::staticGet('id', $profile->id);
 972             if (!empty($user)) {
 973                 $atom_feed = common_local_url('ApiTimelineUser',
 974                                               array('format' => 'atom',
 975                                                     'id' => $profile->nickname));
 976                 $xs->element('link', array('rel' => 'self',
 977                                            'type' => 'application/atom+xml',
 978                                            'href' => $profile->profileurl));
 979                 $xs->element('link', array('rel' => 'license',
 980                                            'href' => common_config('license', 'url')));
 981             }
 982
 983             $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
 984         }
 985
 986         $xs->elementStart('author');
 987         $xs->element('name', null, $profile->nickname);
 988         $xs->element('uri', null, $profile->profileurl);
 989         $xs->elementEnd('author');
 990
 991         if ($source) {
 992             $xs->elementEnd('source');
 993         }
 994
 995         $xs->element('title', null, $this->content);
 996         $xs->element('summary', null, $this->content);
 997
 998         $xs->element('link', array('rel' => 'alternate',
 999                                    'href' => $this->bestUrl()));
1000
1001         $xs->element('id', null, $this->uri);
1002
1003         $xs->element('published', null, common_date_w3dtf($this->created));
1004         $xs->element('updated', null, common_date_w3dtf($this->created));
1005
1006         if ($this->reply_to) {
1007             $reply_notice = Notice::staticGet('id', $this->reply_to);
1008             if (!empty($reply_notice)) {
1009                 $xs->element('link', array('rel' => 'related',
1010                                            'href' => $reply_notice->bestUrl()));
1011                 $xs->element('thr:in-reply-to',
1012                              array('ref' => $reply_notice->uri,
1013                                    'href' => $reply_notice->bestUrl()));
1014             }
1015         }
1016
1017         $xs->element('content', array('type' => 'html'), $this->rendered);
1018
1019         $tag = new Notice_tag();
1020         $tag->notice_id = $this->id;
1021         if ($tag->find()) {
1022             while ($tag->fetch()) {
1023                 $xs->element('category', array('term' => $tag->tag));
1024             }
1025         }
1026         $tag->free();
1027
1028         # Enclosures
1029         $attachments = $this->attachments();
1030         if($attachments){
1031             foreach($attachments as $attachment){
1032                 $enclosure=$attachment->getEnclosure();
1033                 if ($enclosure) {
1034                     $attributes = array('rel'=>'enclosure','href'=>$enclosure->url,'type'=>$enclosure->mimetype,'length'=>$enclosure->size);
1035                     if($enclosure->title){
1036                         $attributes['title']=$enclosure->title;
1037                     }
1038                     $xs->element('link', $attributes, null);
1039                 }
1040             }
1041         }
1042
1043         if (!empty($this->lat) && !empty($this->lon)) {
1044             $xs->elementStart('geo', array('xmlns:georss' => 'http://www.georss.org/georss'));
1045             $xs->element('georss:point', null, $this->lat . ' ' . $this->lon);
1046             $xs->elementEnd('geo');
1047         }
1048
1049         $xs->elementEnd('entry');
1050
1051         return $xs->getString();
1052     }
1053
1054     function bestUrl()
1055     {
1056         if (!empty($this->url)) {
1057             return $this->url;
1058         } else if (!empty($this->uri) && preg_match('/^https?:/', $this->uri)) {
1059             return $this->uri;
1060         } else {
1061             return common_local_url('shownotice',
1062                                     array('notice' => $this->id));
1063         }
1064     }
1065
1066     function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
1067     {
1068         $cache = common_memcache();
1069
1070         if (empty($cache) ||
1071             $since_id != 0 || $max_id != 0 || (!is_null($since) && $since > 0) ||
1072             is_null($limit) ||
1073             ($offset + $limit) > NOTICE_CACHE_WINDOW) {
1074             return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
1075                                                                       $max_id, $since)));
1076         }
1077
1078         $idkey = common_cache_key($cachekey);
1079
1080         $idstr = $cache->get($idkey);
1081
1082         if ($idstr !== false) {
1083             // Cache hit! Woohoo!
1084             $window = explode(',', $idstr);
1085             $ids = array_slice($window, $offset, $limit);
1086             return $ids;
1087         }
1088
1089         $laststr = $cache->get($idkey.';last');
1090
1091         if ($laststr !== false) {
1092             $window = explode(',', $laststr);
1093             $last_id = $window[0];
1094             $new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1095                                                                           $last_id, 0, null)));
1096
1097             $new_window = array_merge($new_ids, $window);
1098
1099             $new_windowstr = implode(',', $new_window);
1100
1101             $result = $cache->set($idkey, $new_windowstr);
1102             $result = $cache->set($idkey . ';last', $new_windowstr);
1103
1104             $ids = array_slice($new_window, $offset, $limit);
1105
1106             return $ids;
1107         }
1108
1109         $window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
1110                                                                      0, 0, null)));
1111
1112         $windowstr = implode(',', $window);
1113
1114         $result = $cache->set($idkey, $windowstr);
1115         $result = $cache->set($idkey . ';last', $windowstr);
1116
1117         $ids = array_slice($window, $offset, $limit);
1118
1119         return $ids;
1120     }
1121
1122     /**
1123      * Determine which notice, if any, a new notice is in reply to.
1124      *
1125      * For conversation tracking, we try to see where this notice fits
1126      * in the tree. Rough algorithm is:
1127      *
1128      * if (reply_to is set and valid) {
1129      *     return reply_to;
1130      * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1131      *     return ID of last notice by initial @name in content;
1132      * }
1133      *
1134      * Note that all @nickname instances will still be used to save "reply" records,
1135      * so the notice shows up in the mentioned users' "replies" tab.
1136      *
1137      * @param integer $reply_to   ID passed in by Web or API
1138      * @param integer $profile_id ID of author
1139      * @param string  $source     Source tag, like 'web' or 'gwibber'
1140      * @param string  $content    Final notice content
1141      *
1142      * @return integer ID of replied-to notice, or null for not a reply.
1143      */
1144
1145     static function getReplyTo($reply_to, $profile_id, $source, $content)
1146     {
1147         static $lb = array('xmpp', 'mail', 'sms', 'omb');
1148
1149         // If $reply_to is specified, we check that it exists, and then
1150         // return it if it does
1151
1152         if (!empty($reply_to)) {
1153             $reply_notice = Notice::staticGet('id', $reply_to);
1154             if (!empty($reply_notice)) {
1155                 return $reply_to;
1156             }
1157         }
1158
1159         // If it's not a "low bandwidth" source (one where you can't set
1160         // a reply_to argument), we return. This is mostly web and API
1161         // clients.
1162
1163         if (!in_array($source, $lb)) {
1164             return null;
1165         }
1166
1167         // Is there an initial @ or T?
1168
1169         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1170             preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1171             $nickname = common_canonical_nickname($match[1]);
1172         } else {
1173             return null;
1174         }
1175
1176         // Figure out who that is.
1177
1178         $sender = Profile::staticGet('id', $profile_id);
1179         $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1180
1181         if (empty($recipient)) {
1182             return null;
1183         }
1184
1185         // Get their last notice
1186
1187         $last = $recipient->getCurrentNotice();
1188
1189         if (!empty($last)) {
1190             return $last->id;
1191         }
1192     }
1193
1194     static function maxContent()
1195     {
1196         $contentlimit = common_config('notice', 'contentlimit');
1197         // null => use global limit (distinct from 0!)
1198         if (is_null($contentlimit)) {
1199             $contentlimit = common_config('site', 'textlimit');
1200         }
1201         return $contentlimit;
1202     }
1203
1204     static function contentTooLong($content)
1205     {
1206         $contentlimit = self::maxContent();
1207         return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1208     }
1209
1210     function getLocation()
1211     {
1212         $location = null;
1213
1214         if (!empty($this->location_id) && !empty($this->location_ns)) {
1215             $location = Location::fromId($this->location_id, $this->location_ns);
1216         }
1217
1218         if (is_null($location)) { // no ID, or Location::fromId() failed
1219             if (!empty($this->lat) && !empty($this->lon)) {
1220                 $location = Location::fromLatLon($this->lat, $this->lon);
1221             }
1222         }
1223
1224         return $location;
1225     }
1226
1227     function repeat($repeater_id, $source)
1228     {
1229         $author = Profile::staticGet('id', $this->profile_id);
1230
1231         $content = sprintf(_('RT @%1$s %2$s'),
1232                            $author->nickname,
1233                            $this->content);
1234
1235         $maxlen = common_config('site', 'textlimit');
1236         if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1237             // Web interface and current Twitter API clients will
1238             // pull the original notice's text, but some older
1239             // clients and RSS/Atom feeds will see this trimmed text.
1240             //
1241             // Unfortunately this is likely to lose tags or URLs
1242             // at the end of long notices.
1243             $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1244         }
1245
1246         return self::saveNew($repeater_id, $content, $source,
1247                              array('repeat_of' => $this->id));
1248     }
1249
1250     // These are supposed to be in chron order!
1251
1252     function repeatStream($limit=100)
1253     {
1254         $cache = common_memcache();
1255
1256         if (empty($cache)) {
1257             $ids = $this->_repeatStreamDirect($limit);
1258         } else {
1259             $idstr = $cache->get(common_cache_key('notice:repeats:'.$this->id));
1260             if ($idstr !== false) {
1261                 $ids = explode(',', $idstr);
1262             } else {
1263                 $ids = $this->_repeatStreamDirect(100);
1264                 $cache->set(common_cache_key('notice:repeats:'.$this->id), implode(',', $ids));
1265             }
1266             if ($limit < 100) {
1267                 // We do a max of 100, so slice down to limit
1268                 $ids = array_slice($ids, 0, $limit);
1269             }
1270         }
1271
1272         return Notice::getStreamByIds($ids);
1273     }
1274
1275     function _repeatStreamDirect($limit)
1276     {
1277         $notice = new Notice();
1278
1279         $notice->selectAdd(); // clears it
1280         $notice->selectAdd('id');
1281
1282         $notice->repeat_of = $this->id;
1283
1284         $notice->orderBy('created'); // NB: asc!
1285
1286         if (!is_null($offset)) {
1287             $notice->limit($offset, $limit);
1288         }
1289
1290         $ids = array();
1291
1292         if ($notice->find()) {
1293             while ($notice->fetch()) {
1294                 $ids[] = $notice->id;
1295             }
1296         }
1297
1298         $notice->free();
1299         $notice = NULL;
1300
1301         return $ids;
1302     }
1303
1304     function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1305     {
1306         $options = array();
1307
1308         if (!empty($location_id) && !empty($location_ns)) {
1309
1310             $options['location_id'] = $location_id;
1311             $options['location_ns'] = $location_ns;
1312
1313             $location = Location::fromId($location_id, $location_ns);
1314
1315             if (!empty($location)) {
1316                 $options['lat'] = $location->lat;
1317                 $options['lon'] = $location->lon;
1318             }
1319
1320         } else if (!empty($lat) && !empty($lon)) {
1321
1322             $options['lat'] = $lat;
1323             $options['lon'] = $lon;
1324
1325             $location = Location::fromLatLon($lat, $lon);
1326
1327             if (!empty($location)) {
1328                 $options['location_id'] = $location->location_id;
1329                 $options['location_ns'] = $location->location_ns;
1330             }
1331         } else if (!empty($profile)) {
1332
1333             if (isset($profile->lat) && isset($profile->lon)) {
1334                 $options['lat'] = $profile->lat;
1335                 $options['lon'] = $profile->lon;
1336             }
1337
1338             if (isset($profile->location_id) && isset($profile->location_ns)) {
1339                 $options['location_id'] = $profile->location_id;
1340                 $options['location_ns'] = $profile->location_ns;
1341             }
1342         }
1343
1344         return $options;
1345     }
1346
1347     function clearReplies()
1348     {
1349         $replyNotice = new Notice();
1350         $replyNotice->reply_to = $this->id;
1351
1352         //Null any notices that are replies to this notice
1353
1354         if ($replyNotice->find()) {
1355             while ($replyNotice->fetch()) {
1356                 $orig = clone($replyNotice);
1357                 $replyNotice->reply_to = null;
1358                 $replyNotice->update($orig);
1359             }
1360         }
1361
1362         // Reply records
1363
1364         $reply = new Reply();
1365         $reply->notice_id = $this->id;
1366
1367         if ($reply->find()) {
1368             while($reply->fetch()) {
1369                 self::blow('reply:stream:%d', $reply->profile_id);
1370                 $reply->delete();
1371             }
1372         }
1373
1374         $reply->free();
1375     }
1376
1377     function clearRepeats()
1378     {
1379         $repeatNotice = new Notice();
1380         $repeatNotice->repeat_of = $this->id;
1381
1382         //Null any notices that are repeats of this notice
1383
1384         if ($repeatNotice->find()) {
1385             while ($repeatNotice->fetch()) {
1386                 $orig = clone($repeatNotice);
1387                 $repeatNotice->repeat_of = null;
1388                 $repeatNotice->update($orig);
1389             }
1390         }
1391     }
1392
1393     function clearFaves()
1394     {
1395         $fave = new Fave();
1396         $fave->notice_id = $this->id;
1397
1398         if ($fave->find()) {
1399             while ($fave->fetch()) {
1400                 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
1401                 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
1402                 self::blow('fave:ids_by_user:%d', $fave->user_id);
1403                 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
1404                 $fave->delete();
1405             }
1406         }
1407
1408         $fave->free();
1409     }
1410
1411     function clearTags()
1412     {
1413         $tag = new Notice_tag();
1414         $tag->notice_id = $this->id;
1415
1416         if ($tag->find()) {
1417             while ($tag->fetch()) {
1418                 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, common_keyize($tag->tag));
1419                 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, common_keyize($tag->tag));
1420                 self::blow('notice_tag:notice_ids:%s', common_keyize($tag->tag));
1421                 self::blow('notice_tag:notice_ids:%s;last', common_keyize($tag->tag));
1422                 $tag->delete();
1423             }
1424         }
1425
1426         $tag->free();
1427     }
1428
1429     function clearGroupInboxes()
1430     {
1431         $gi = new Group_inbox();
1432
1433         $gi->notice_id = $this->id;
1434
1435         if ($gi->find()) {
1436             while ($gi->fetch()) {
1437                 self::blow('user_group:notice_ids:%d', $gi->group_id);
1438                 $gi->delete();
1439             }
1440         }
1441
1442         $gi->free();
1443     }
1444
1445     function distribute()
1446     {
1447         if (common_config('queue', 'inboxes')) {
1448             // If there's a failure, we want to _force_
1449             // distribution at this point.
1450             try {
1451                 $qm = QueueManager::get();
1452                 $qm->enqueue($this, 'distrib');
1453             } catch (Exception $e) {
1454                 // If the exception isn't transient, this
1455                 // may throw more exceptions as DQH does
1456                 // its own enqueueing. So, we ignore them!
1457                 try {
1458                     $handler = new DistribQueueHandler();
1459                     $handler->handle($this);
1460                 } catch (Exception $e) {
1461                     common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
1462                 }
1463                 // Re-throw so somebody smarter can handle it.
1464                 throw $e;
1465             }
1466         } else {
1467             $handler = new DistribQueueHandler();
1468             $handler->handle($this);
1469         }
1470     }
1471
1472     function insert()
1473     {
1474         $result = parent::insert();
1475
1476         if ($result) {
1477             // Profile::hasRepeated() abuses pkeyGet(), so we
1478             // have to clear manually
1479             if (!empty($this->repeat_of)) {
1480                 $c = self::memcache();
1481                 if (!empty($c)) {
1482                     $ck = self::multicacheKey('Notice',
1483                                               array('profile_id' => $this->profile_id,
1484                                                     'repeat_of' => $this->repeat_of));
1485                     $c->delete($ck);
1486                 }
1487             }
1488         }
1489
1490         return $result;
1491     }
1492 }