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