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