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