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