3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2011 StatusNet, Inc.
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.
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.
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/>.
21 * @author Brenda Wallace <shiny@cpan.org>
22 * @author Christopher Vollick <psycotica0@gmail.com>
23 * @author CiaranG <ciaran@ciarang.com>
24 * @author Craig Andrews <candrews@integralblue.com>
25 * @author Evan Prodromou <evan@controlezvous.ca>
26 * @author Gina Haeussge <osd@foosel.net>
27 * @author Jeffery To <jeffery.to@gmail.com>
28 * @author Mike Cochrane <mikec@mikenz.geek.nz>
29 * @author Robin Millette <millette@controlyourself.ca>
30 * @author Sarven Capadisli <csarven@controlyourself.ca>
31 * @author Tom Adams <tom@holizz.com>
32 * @author Mikael Nordfeldth <mmn@hethane.se>
33 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
34 * @license GNU Affero General Public License http://www.gnu.org/licenses/
37 if (!defined('GNUSOCIAL')) { exit(1); }
40 * Table Definition for notice
43 /* We keep 200 notices, the max number of notices available per API request,
44 * in the memcached cache. */
46 define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
48 define('MAX_BOXCARS', 128);
50 class Notice extends Managed_DataObject
53 /* the code below is auto generated do not remove the above tag */
55 public $__table = 'notice'; // table name
56 public $id; // int(4) primary_key not_null
57 public $profile_id; // int(4) multiple_key not_null
58 public $uri; // varchar(255) unique_key
59 public $content; // text
60 public $rendered; // text
61 public $url; // varchar(255)
62 public $created; // datetime multiple_key not_null default_0000-00-00%2000%3A00%3A00
63 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP
64 public $reply_to; // int(4)
65 public $is_local; // int(4)
66 public $source; // varchar(32)
67 public $conversation; // int(4)
68 public $lat; // decimal(10,7)
69 public $lon; // decimal(10,7)
70 public $location_id; // int(4)
71 public $location_ns; // int(4)
72 public $repeat_of; // int(4)
73 public $verb; // varchar(255)
74 public $object_type; // varchar(255)
75 public $scope; // int(4)
77 /* the code above is auto generated do not remove the tag below */
80 public static function schemaDef()
84 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
85 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
86 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
87 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8_general_ci'),
88 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
89 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
90 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
91 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
92 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
93 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
94 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
95 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'),
96 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
97 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
98 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
99 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
100 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
101 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'),
102 'verb' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
103 'scope' => array('type' => 'int',
104 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'),
106 'primary key' => array('id'),
107 'unique keys' => array(
108 'notice_uri_key' => array('uri'),
110 'foreign keys' => array(
111 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
112 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
113 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
114 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
117 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'),
118 'notice_profile_id_idx' => array('profile_id', 'created', 'id'),
119 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
120 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
121 'notice_replyto_idx' => array('reply_to')
125 if (common_config('search', 'type') == 'fulltext') {
126 $def['fulltext indexes'] = array('content' => array('content'));
133 const LOCAL_PUBLIC = 1;
135 const LOCAL_NONPUBLIC = -1;
138 const PUBLIC_SCOPE = 0; // Useful fake constant
139 const SITE_SCOPE = 1;
140 const ADDRESSEE_SCOPE = 2;
141 const GROUP_SCOPE = 4;
142 const FOLLOWER_SCOPE = 8;
144 protected $_profile = array();
147 * Will always return a profile, if anything fails it will
148 * (through _setProfile) throw a NoProfileException.
150 public function getProfile()
152 if (!isset($this->_profile[$this->profile_id])) {
153 // We could've sent getKV directly to _setProfile, but occasionally we get
154 // a "false" (instead of null), likely because it indicates a cache miss.
155 $profile = Profile::getKV('id', $this->profile_id);
156 $this->_setProfile($profile instanceof Profile ? $profile : null);
158 return $this->_profile[$this->profile_id];
161 public function _setProfile(Profile $profile=null)
163 if (!$profile instanceof Profile) {
164 throw new NoProfileException($this->profile_id);
166 $this->_profile[$this->profile_id] = $profile;
169 function delete($useWhere=false)
171 // For auditing purposes, save a record that the notice
174 // @fixme we have some cases where things get re-run and so the
176 $deleted = Deleted_notice::getKV('id', $this->id);
178 if (!$deleted instanceof Deleted_notice) {
179 $deleted = Deleted_notice::getKV('uri', $this->uri);
182 if (!$deleted instanceof Deleted_notice) {
183 $deleted = new Deleted_notice();
185 $deleted->id = $this->id;
186 $deleted->profile_id = $this->profile_id;
187 $deleted->uri = $this->uri;
188 $deleted->created = $this->created;
189 $deleted->deleted = common_sql_now();
194 if (Event::handle('NoticeDeleteRelated', array($this))) {
196 // Clear related records
198 $this->clearReplies();
199 $this->clearRepeats();
201 $this->clearGroupInboxes();
203 $this->clearAttentions();
205 // NOTE: we don't clear queue items
208 $result = parent::delete($useWhere);
210 $this->blowOnDelete();
214 public function getUri()
220 * Get a Notice object by URI. Will call external plugins for help
221 * using the event StartGetNoticeFromURI.
223 * @param string $uri A unique identifier for a resource (notice in this case)
225 static function fromUri($uri)
229 if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
230 $notice = Notice::getKV('uri', $uri);
231 Event::handle('EndGetNoticeFromUri', array($uri, $notice));
234 if (!$notice instanceof Notice) {
235 throw new UnknownUriException($uri);
242 * @param $root boolean If true, link to just the conversation root.
244 * @return URL to conversation
246 public function getConversationUrl($anchor=true)
248 return Conversation::getUrlFromNotice($this, $anchor);
252 * Get the local representation URL of this notice.
254 public function getLocalUrl()
256 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
259 public function getTitle()
262 if (Event::handle('GetNoticeTitle', array($this, &$title))) {
263 // TRANS: Title of a notice posted without a title value.
264 // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
265 $title = sprintf(_('%1$s\'s status on %2$s'),
266 $this->getProfile()->getFancyName(),
267 common_exact_date($this->created));
272 public function getContent()
274 return $this->content;
278 * Get the original representation URL of this notice.
280 * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
282 public function getUrl($fallback=false)
284 // The risk is we start having empty urls and non-http uris...
285 // and we can't really handle any other protocol right now.
287 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
289 case !$this->isLocal() && common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
291 case $this->isLocal() || $fallback:
292 // let's generate a valid link to our locally available notice on demand
293 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
295 common_debug('No URL available for notice: id='.$this->id);
296 throw new InvalidUrlException($this->url);
300 public function get_object_type($canonical=false) {
302 ? ActivityObject::canonicalType($this->object_type)
303 : $this->object_type;
306 public static function getByUri($uri)
308 $notice = new Notice();
310 if (!$notice->find(true)) {
311 throw new NoResultException($notice);
317 * Extract #hashtags from this notice's content and save them to the database.
321 /* extract all #hastags */
322 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
327 /* Add them to the database */
328 return $this->saveKnownTags($match[1]);
332 * Record the given set of hash tags in the db for this notice.
333 * Given tag strings will be normalized and checked for dupes.
335 function saveKnownTags(array $hashtags)
337 //turn each into their canonical tag
338 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
339 for($i=0; $i<count($hashtags); $i++) {
340 /* elide characters we don't want in the tag */
341 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
344 foreach(array_unique($hashtags) as $hashtag) {
345 $this->saveTag($hashtag);
346 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
352 * Record a single hash tag as associated with this notice.
353 * Tag format and uniqueness must be validated by caller.
355 function saveTag($hashtag)
357 $tag = new Notice_tag();
358 $tag->notice_id = $this->id;
359 $tag->tag = $hashtag;
360 $tag->created = $this->created;
361 $id = $tag->insert();
364 // TRANS: Server exception. %s are the error details.
365 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
366 $last_error->message));
370 // if it's saved, blow its cache
371 $tag->blowCache(false);
375 * Save a new notice and push it out to subscribers' inboxes.
376 * Poster's permissions are checked before sending.
378 * @param int $profile_id Profile ID of the poster
379 * @param string $content source message text; links may be shortened
380 * per current user's preference
381 * @param string $source source key ('web', 'api', etc)
382 * @param array $options Associative array of optional properties:
383 * string 'created' timestamp of notice; defaults to now
384 * int 'is_local' source/gateway ID, one of:
385 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
386 * Notice::REMOTE - Sent from a remote service;
387 * hide from public timeline but show in
388 * local "and friends" timelines
389 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
390 * Notice::GATEWAY - From another non-OStatus service;
391 * will not appear in public views
392 * float 'lat' decimal latitude for geolocation
393 * float 'lon' decimal longitude for geolocation
394 * int 'location_id' geoname identifier
395 * int 'location_ns' geoname namespace to interpret location_id
396 * int 'reply_to'; notice ID this is a reply to
397 * int 'repeat_of'; notice ID this is a repeat of
398 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
399 * string 'url' permalink to notice; defaults to local notice URL
400 * string 'rendered' rendered HTML version of content
401 * array 'replies' list of profile URIs for reply delivery in
402 * place of extracting @-replies from content.
403 * array 'groups' list of group IDs to deliver to, in place of
404 * extracting ! tags from content
405 * array 'tags' list of hashtag strings to save with the notice
406 * in place of extracting # tags from content
407 * array 'urls' list of attached/referred URLs to save with the
408 * notice in place of extracting links from content
409 * boolean 'distribute' whether to distribute the notice, default true
410 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
411 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
412 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
414 * @fixme tag override
417 * @throws ClientException
419 static function saveNew($profile_id, $content, $source, array $options=array()) {
420 $defaults = array('uri' => null,
422 'conversation' => null, // URI of conversation
423 'reply_to' => null, // This will override convo URI if the parent is known
424 'repeat_of' => null, // This will override convo URI if the repeated notice is known
426 'distribute' => true,
427 'object_type' => null,
431 * Above type-hint is already array, so simply count it, this saves
434 if (count($options) > 0) {
435 $options = array_merge($defaults, $options);
440 if (!isset($is_local)) {
441 $is_local = Notice::LOCAL_PUBLIC;
444 $profile = Profile::getKV('id', $profile_id);
445 if (!$profile instanceof Profile) {
446 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
447 throw new ClientException(_('Problem saving notice. Unknown user.'));
450 $user = User::getKV('id', $profile_id);
451 if ($user instanceof User) {
452 // Use the local user's shortening preferences, if applicable.
453 $final = $user->shortenLinks($content);
455 $final = common_shorten_links($content);
458 if (Notice::contentTooLong($final)) {
459 // TRANS: Client exception thrown if a notice contains too many characters.
460 throw new ClientException(_('Problem saving notice. Too long.'));
463 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
464 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
465 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
466 throw new ClientException(_('Too many notices too fast; take a breather '.
467 'and post again in a few minutes.'));
470 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
471 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
472 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
473 throw new ClientException(_('Too many duplicate messages too quickly;'.
474 ' take a breather and post again in a few minutes.'));
477 if (!$profile->hasRight(Right::NEWNOTICE)) {
478 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
480 // TRANS: Client exception thrown when a user tries to post while being banned.
481 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
484 $notice = new Notice();
485 $notice->profile_id = $profile_id;
487 $autosource = common_config('public', 'autosource');
489 // Sandboxed are non-false, but not 1, either
491 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
492 ($source && $autosource && in_array($source, $autosource))) {
493 $notice->is_local = Notice::LOCAL_NONPUBLIC;
495 $notice->is_local = $is_local;
498 if (!empty($created)) {
499 $notice->created = $created;
501 $notice->created = common_sql_now();
504 if (!$notice->isLocal()) {
505 // Only do these checks for non-local notices. Local notices will generate these values later.
506 if (!common_valid_http_url($url)) {
507 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
510 throw new ServerException('No URI for remote notice. Cannot accept that.');
514 $notice->content = $final;
516 $notice->source = $source;
520 // Get the groups here so we can figure out replies and such
521 if (!isset($groups)) {
522 $groups = User_group::idsFromText($notice->content, $profile);
527 // Handle repeat case
529 if (isset($repeat_of)) {
531 // Check for a private one
533 $repeat = Notice::getKV('id', $repeat_of);
535 if (!($repeat instanceof Notice)) {
536 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
537 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
540 if ($profile->id == $repeat->profile_id) {
541 // TRANS: Client error displayed when trying to repeat an own notice.
542 throw new ClientException(_('You cannot repeat your own notice.'));
545 if ($repeat->scope != Notice::SITE_SCOPE &&
546 $repeat->scope != Notice::PUBLIC_SCOPE) {
547 // TRANS: Client error displayed when trying to repeat a non-public notice.
548 throw new ClientException(_('Cannot repeat a private notice.'), 403);
551 if (!$repeat->inScope($profile)) {
552 // The generic checks above should cover this, but let's be sure!
553 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
554 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
557 if ($profile->hasRepeated($repeat)) {
558 // TRANS: Client error displayed when trying to repeat an already repeated notice.
559 throw new ClientException(_('You already repeated that notice.'));
562 $notice->repeat_of = $repeat->id;
563 $notice->conversation = $repeat->conversation;
567 // If $reply_to is specified, we check that it exists, and then
568 // return it if it does
569 if (!empty($reply_to)) {
570 $reply = Notice::getKV('id', $reply_to);
571 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
572 // If the source lacks capability of sending the "reply_to"
573 // metadata, let's try to find an inline replyto-reference.
574 $reply = self::getInlineReplyTo($profile, $final);
577 if ($reply instanceof Notice) {
578 if (!$reply->inScope($profile)) {
579 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
580 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
581 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
582 $profile->nickname, $reply->id), 403);
585 // If it's a repeat, the reply_to should be to the original
586 if ($reply->isRepeat()) {
587 $notice->reply_to = $reply->repeat_of;
589 $notice->reply_to = $reply->id;
591 // But the conversation ought to be the same :)
592 $notice->conversation = $reply->conversation;
594 // If the original is private to a group, and notice has
595 // no group specified, make it to the same group(s)
597 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
599 $replyGroups = $reply->getGroups();
600 foreach ($replyGroups as $group) {
601 if ($profile->isMember($group)) {
602 $groups[] = $group->id;
610 // If we don't know the reply, we might know the conversation!
611 // This will happen if a known remote user replies to an
612 // unknown remote user - within a known conversation.
613 if (empty($notice->conversation) and !empty($options['conversation'])) {
614 $conv = Conversation::getKV('uri', $options['conversation']);
615 if ($conv instanceof Conversation) {
616 common_debug('Conversation stitched together from (probably) reply to unknown remote user. Activity creation time ('.$notice->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
617 $notice->conversation = $conv->id;
619 // Conversation URI was not found, so we must create it. But we can't create it
620 // until we have a Notice ID because of the database layout...
621 $notice->tmp_conv_uri = $options['conversation'];
624 // If we're not using the attached conversation URI let's remove it
625 // so we don't mistake ourselves later, when creating our own Conversation.
626 // This implies that the notice knows which conversation it belongs to.
627 $options['conversation'] = null;
631 if (!empty($lat) && !empty($lon)) {
636 if (!empty($location_ns) && !empty($location_id)) {
637 $notice->location_id = $location_id;
638 $notice->location_ns = $location_ns;
641 if (!empty($rendered)) {
642 $notice->rendered = $rendered;
644 $notice->rendered = common_render_content($final, $notice);
648 if ($notice->isRepeat()) {
649 $notice->verb = ActivityVerb::SHARE;
650 $notice->object_type = ActivityObject::ACTIVITY;
652 $notice->verb = ActivityVerb::POST;
655 $notice->verb = $verb;
658 if (empty($object_type)) {
659 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
661 $notice->object_type = $object_type;
664 if (is_null($scope) && $reply instanceof Notice) {
665 $notice->scope = $reply->scope;
667 $notice->scope = $scope;
670 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
672 if (Event::handle('StartNoticeSave', array(&$notice))) {
674 // XXX: some of these functions write to the DB
677 $notice->insert(); // throws exception on failure
678 // If it's not part of a conversation, it's
679 // the beginning of a new conversation.
680 if (empty($notice->conversation)) {
681 $orig = clone($notice);
682 // $act->context->conversation will be null if it was not provided
683 $conv = Conversation::create($notice, $options['conversation']);
684 $notice->conversation = $conv->id;
685 $notice->update($orig);
687 } catch (Exception $e) {
688 // Let's test if we managed initial insert, which would imply
689 // failing on some update-part (check 'insert()'). Delete if
690 // something had been stored to the database.
691 if (!empty($notice->id)) {
698 // Clear the cache for subscribed users, so they'll update at next request
699 // XXX: someone clever could prepend instead of clearing the cache
701 // Save per-notice metadata...
703 if (isset($replies)) {
704 $notice->saveKnownReplies($replies);
706 $notice->saveReplies();
710 $notice->saveKnownTags($tags);
715 // Note: groups may save tags, so must be run after tags are saved
716 // to avoid errors on duplicates.
717 // Note: groups should always be set.
719 $notice->saveKnownGroups($groups);
722 $notice->saveKnownUrls($urls);
728 // Prepare inbox delivery, may be queued to background.
729 $notice->distribute();
735 static function saveActivity(Activity $act, Profile $actor, array $options=array())
737 // First check if we're going to let this Activity through from the specific actor
738 if (!$actor->hasRight(Right::NEWNOTICE)) {
739 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
741 // TRANS: Client exception thrown when a user tries to post while being banned.
742 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
744 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
745 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
746 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
747 throw new ClientException(_m('Too many notices too fast; take a breather '.
748 'and post again in a few minutes.'));
751 // Get ActivityObject properties
752 if (!empty($act->id)) {
754 $options['uri'] = $act->id;
755 $options['url'] = $act->link;
757 $actobj = count($act->objects)==1 ? $act->objects[0] : null;
758 if (!is_null($actobj) && !empty($actobj->id)) {
759 $options['uri'] = $actobj->id;
761 $options['url'] = $actobj->link;
762 } elseif (preg_match('!^https?://!', $actobj->id)) {
763 $options['url'] = $actobj->id;
770 'is_local' => self::LOCAL_PUBLIC,
771 'mentions' => array(),
775 'source' => 'unknown',
780 'distribute' => true);
782 // options will have default values when nothing has been supplied
783 $options = array_merge($defaults, $options);
784 foreach (array_keys($defaults) as $key) {
785 // Only convert the keynames we specify ourselves from 'defaults' array into variables
786 $$key = $options[$key];
788 extract($options, EXTR_SKIP);
790 $stored = new Notice();
793 if ($stored->find()) {
794 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
795 throw new Exception('Notice URI already exists');
799 $stored->profile_id = $actor->id;
800 $stored->source = $source;
803 $stored->verb = $act->verb;
805 // Use the local user's shortening preferences, if applicable.
806 $stored->rendered = $actor->isLocal()
807 ? $actor->shortenLinks($act->content)
809 $stored->content = common_strip_html($stored->rendered);
811 $autosource = common_config('public', 'autosource');
813 // Sandboxed are non-false, but not 1, either
814 if (!$actor->hasRight(Right::PUBLICNOTICE) ||
815 ($source && $autosource && in_array($source, $autosource))) {
816 $stored->is_local = Notice::LOCAL_NONPUBLIC;
819 // Maybe a missing act-time should be fatal if the actor is not local?
820 if (!empty($act->time)) {
821 $stored->created = common_sql_date($act->time);
823 $stored->created = common_sql_now();
827 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
828 $reply = self::getKV('uri', $act->context->replyToID);
830 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
831 $reply = self::getKV('uri', $act->target->id);
834 if ($reply instanceof Notice) {
835 if (!$reply->inScope($actor)) {
836 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
837 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
838 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
841 $stored->reply_to = $reply->id;
842 $stored->conversation = $reply->conversation;
844 // If the original is private to a group, and notice has no group specified,
845 // make it to the same group(s)
846 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
848 $replyGroups = $reply->getGroups();
849 foreach ($replyGroups as $group) {
850 if ($actor->isMember($group)) {
851 $groups[] = $group->id;
856 if (is_null($scope)) {
857 $scope = $reply->scope;
861 if ($act->context instanceof ActivityContext) {
862 $location = $act->context->location;
864 $stored->lat = $location->lat;
865 $stored->lon = $location->lon;
866 if ($location->location_id) {
867 $stored->location_ns = $location->location_ns;
868 $stored->location_id = $location->location_id;
872 $act->context = new ActivityContext();
875 $stored->scope = self::figureOutScope($actor, $groups, $scope);
877 foreach ($act->categories as $cat) {
879 $term = common_canonical_tag($cat->term);
886 foreach ($act->enclosures as $href) {
887 // @todo FIXME: Save these locally or....?
891 if (Event::handle('StartNoticeSave', array(&$stored))) {
892 // XXX: some of these functions write to the DB
895 $stored->insert(); // throws exception on error
896 $orig = clone($stored); // for updating later in this try clause
898 // If it's not part of a conversation, it's
899 // the beginning of a new conversation.
900 if (empty($stored->conversation)) {
901 // $act->context->conversation will be null if it was not provided
902 $conv = Conversation::create($stored, $act->context->conversation);
903 $stored->conversation = $conv->id;
907 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
908 if (empty($object)) {
909 throw new ServerException('No object from StoreActivityObject '.$stored->uri . ': '.$act->asString());
911 $stored->object_type = ActivityUtils::resolveUri($object->getObjectType(), true);
912 $stored->update($orig);
913 } catch (Exception $e) {
914 if (empty($stored->id)) {
915 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
917 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
923 if (!$stored instanceof Notice) {
924 throw new ServerException('StartNoticeSave did not give back a Notice');
927 // Save per-notice metadata...
931 // This event lets plugins filter out non-local recipients (attentions we don't care about)
932 // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway)
933 Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups));
935 if (!empty($mentions)) {
936 $stored->saveKnownReplies($mentions);
938 $stored->saveReplies();
942 $stored->saveKnownTags($tags);
947 // Note: groups may save tags, so must be run after tags are saved
948 // to avoid errors on duplicates.
949 // Note: groups should always be set.
951 $stored->saveKnownGroups($groups);
954 $stored->saveKnownUrls($urls);
960 // Prepare inbox delivery, may be queued to background.
961 $stored->distribute();
967 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
968 if (is_null($scope)) {
969 $scope = self::defaultScope();
972 // For private streams
974 $user = $actor->getUser();
975 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
976 if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) {
977 $scope |= Notice::FOLLOWER_SCOPE;
979 } catch (NoSuchUserException $e) {
980 // TODO: Not a local user, so we don't know about scope preferences... yet!
983 // Force the scope for private groups
984 foreach ($groups as $group_id) {
985 $group = User_group::staticGet('id', $group_id);
986 if ($group instanceof User_group) {
987 if ($group->force_scope) {
988 $scope |= Notice::GROUP_SCOPE;
997 function blowOnInsert($conversation = false)
999 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1001 if ($this->isPublic()) {
1002 $this->blowStream('public');
1003 $this->blowStream('networkpublic');
1006 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1007 self::blow('conversation:notice_count:%d', $this->conversation);
1009 if ($this->isRepeat()) {
1010 // XXX: we should probably only use one of these
1011 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1012 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1015 $original = Notice::getKV('id', $this->repeat_of);
1017 if ($original instanceof Notice) {
1018 $originalUser = User::getKV('id', $original->profile_id);
1019 if ($originalUser instanceof User) {
1020 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1024 $profile = Profile::getKV($this->profile_id);
1026 if ($profile instanceof Profile) {
1027 $profile->blowNoticeCount();
1030 $ptags = $this->getProfileTags();
1031 foreach ($ptags as $ptag) {
1032 $ptag->blowNoticeStreamCache();
1037 * Clear cache entries related to this notice at delete time.
1038 * Necessary to avoid breaking paging on public, profile timelines.
1040 function blowOnDelete()
1042 $this->blowOnInsert();
1044 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1046 if ($this->isPublic()) {
1047 self::blow('public;last');
1048 self::blow('networkpublic;last');
1051 self::blow('fave:by_notice', $this->id);
1053 if ($this->conversation) {
1054 // In case we're the first, will need to calc a new root.
1055 self::blow('notice:conversation_root:%d', $this->conversation);
1058 $ptags = $this->getProfileTags();
1059 foreach ($ptags as $ptag) {
1060 $ptag->blowNoticeStreamCache(true);
1064 function blowStream()
1066 $c = self::memcache();
1072 $args = func_get_args();
1074 $format = array_shift($args);
1076 $keyPart = vsprintf($format, $args);
1078 $cacheKey = Cache::key($keyPart);
1080 $c->delete($cacheKey);
1082 // delete the "last" stream, too, if this notice is
1083 // older than the top of that stream
1085 $lastKey = $cacheKey.';last';
1087 $lastStr = $c->get($lastKey);
1089 if ($lastStr !== false) {
1090 $window = explode(',', $lastStr);
1091 $lastID = $window[0];
1092 $lastNotice = Notice::getKV('id', $lastID);
1093 if (!$lastNotice instanceof Notice // just weird
1094 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1095 $c->delete($lastKey);
1100 /** save all urls in the notice to the db
1102 * follow redirects and save all available file information
1103 * (mimetype, date, size, oembed, etc.)
1107 function saveUrls() {
1108 if (common_config('attachments', 'process_links')) {
1109 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
1114 * Save the given URLs as related links/attachments to the db
1116 * follow redirects and save all available file information
1117 * (mimetype, date, size, oembed, etc.)
1121 function saveKnownUrls($urls)
1123 if (common_config('attachments', 'process_links')) {
1124 // @fixme validation?
1125 foreach (array_unique($urls) as $url) {
1127 File::processNew($url, $this->id);
1128 } catch (ServerException $e) {
1129 // Could not save URL. Log it?
1138 function saveUrl($url, $notice_id) {
1140 File::processNew($url, $notice_id);
1141 } catch (ServerException $e) {
1142 // Could not save URL. Log it?
1146 static function checkDupes($profile_id, $content) {
1147 $profile = Profile::getKV($profile_id);
1148 if (!$profile instanceof Profile) {
1151 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1152 if (!empty($notice)) {
1154 while ($notice->fetch()) {
1155 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1157 } else if ($notice->content == $content) {
1162 // If we get here, oldest item in cache window is not
1163 // old enough for dupe limit; do direct check against DB
1164 $notice = new Notice();
1165 $notice->profile_id = $profile_id;
1166 $notice->content = $content;
1167 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1168 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1170 $cnt = $notice->count();
1174 static function checkEditThrottle($profile_id) {
1175 $profile = Profile::getKV($profile_id);
1176 if (!$profile instanceof Profile) {
1179 // Get the Nth notice
1180 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1181 if ($notice && $notice->fetch()) {
1182 // If the Nth notice was posted less than timespan seconds ago
1183 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1188 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1192 protected $_attachments = array();
1194 function attachments() {
1195 if (isset($this->_attachments[$this->id])) {
1196 return $this->_attachments[$this->id];
1199 $f2ps = File_to_post::listGet('post_id', array($this->id));
1203 foreach ($f2ps[$this->id] as $f2p) {
1204 $ids[] = $f2p->file_id;
1207 $files = File::multiGet('id', $ids);
1209 $this->_attachments[$this->id] = $files->fetchAll();
1211 return $this->_attachments[$this->id];
1214 function _setAttachments($attachments)
1216 $this->_attachments[$this->id] = $attachments;
1219 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
1221 $stream = new PublicNoticeStream();
1222 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1226 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
1228 $stream = new ConversationNoticeStream($id);
1230 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1234 * Is this notice part of an active conversation?
1236 * @return boolean true if other messages exist in the same
1237 * conversation, false if this is the only one
1239 function hasConversation()
1241 if (!empty($this->conversation)) {
1242 $conversation = Notice::conversationStream(
1243 $this->conversation,
1248 if ($conversation->N > 0) {
1256 * Grab the earliest notice from this conversation.
1258 * @return Notice or null
1260 function conversationRoot($profile=-1)
1262 // XXX: can this happen?
1264 if (empty($this->conversation)) {
1268 // Get the current profile if not specified
1270 if (is_int($profile) && $profile == -1) {
1271 $profile = Profile::current();
1274 // If this notice is out of scope, no root for you!
1276 if (!$this->inScope($profile)) {
1280 // If this isn't a reply to anything, then it's its own
1281 // root if it's the earliest notice in the conversation:
1283 if (empty($this->reply_to)) {
1285 $root->conversation = $this->conversation;
1286 $root->orderBy('notice.created ASC');
1293 if (is_null($profile)) {
1294 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1296 $keypart = sprintf('notice:conversation_root:%d:%d',
1301 $root = self::cacheGet($keypart);
1303 if ($root !== false && $root->inScope($profile)) {
1310 $parent = $last->getParent();
1311 if ($parent->inScope($profile)) {
1315 } catch (Exception $e) {
1316 // Latest notice has no parent
1318 // No parent, or parent out of scope
1323 self::cacheSet($keypart, $root);
1329 * Pull up a full list of local recipients who will be getting
1330 * this notice in their inbox. Results will be cached, so don't
1331 * change the input data wily-nilly!
1333 * @param array $groups optional list of Group objects;
1334 * if left empty, will be loaded from group_inbox records
1335 * @param array $recipient optional list of reply profile ids
1336 * if left empty, will be loaded from reply records
1337 * @return array associating recipient user IDs with an inbox source constant
1339 function whoGets(array $groups=null, array $recipients=null)
1341 $c = self::memcache();
1344 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1345 if ($ni !== false) {
1350 if (is_null($recipients)) {
1351 $recipients = $this->getReplies();
1356 // Give plugins a chance to add folks in at start...
1357 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1359 $users = $this->getSubscribedUsers();
1360 foreach ($users as $id) {
1361 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1364 if (is_null($groups)) {
1365 $groups = $this->getGroups();
1367 foreach ($groups as $group) {
1368 $users = $group->getUserMembers();
1369 foreach ($users as $id) {
1370 if (!array_key_exists($id, $ni)) {
1371 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1376 $ptAtts = $this->getAttentionsFromProfileTags();
1377 foreach ($ptAtts as $key=>$val) {
1378 if (!array_key_exists($key, $ni)) {
1383 foreach ($recipients as $recipient) {
1384 if (!array_key_exists($recipient, $ni)) {
1385 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1389 // Exclude any deleted, non-local, or blocking recipients.
1390 $profile = $this->getProfile();
1391 $originalProfile = null;
1392 if ($this->isRepeat()) {
1393 // Check blocks against the original notice's poster as well.
1394 $original = Notice::getKV('id', $this->repeat_of);
1395 if ($original instanceof Notice) {
1396 $originalProfile = $original->getProfile();
1400 foreach ($ni as $id => $source) {
1402 $user = User::getKV('id', $id);
1403 if (!$user instanceof User ||
1404 $user->hasBlocked($profile) ||
1405 ($originalProfile && $user->hasBlocked($originalProfile))) {
1408 } catch (UserNoProfileException $e) {
1409 // User doesn't have a profile; invalid; skip them.
1414 // Give plugins a chance to filter out...
1415 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1419 // XXX: pack this data better
1420 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1426 function getSubscribedUsers()
1430 if(common_config('db','quote_identifiers'))
1431 $user_table = '"user"';
1432 else $user_table = 'user';
1436 'FROM '. $user_table .' JOIN subscription '.
1437 'ON '. $user_table .'.id = subscription.subscriber ' .
1438 'WHERE subscription.subscribed = %d ';
1440 $user->query(sprintf($qry, $this->profile_id));
1444 while ($user->fetch()) {
1453 function getProfileTags()
1455 $profile = $this->getProfile();
1456 $list = $profile->getOtherTags($profile);
1459 while($list->fetch()) {
1460 $ptags[] = clone($list);
1466 public function getAttentionsFromProfileTags()
1469 $ptags = $this->getProfileTags();
1470 foreach ($ptags as $ptag) {
1471 $users = $ptag->getUserSubscribers();
1472 foreach ($users as $id) {
1473 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1480 * Record this notice to the given group inboxes for delivery.
1481 * Overrides the regular parsing of !group markup.
1483 * @param string $group_ids
1484 * @fixme might prefer URIs as identifiers, as for replies?
1485 * best with generalizations on user_group to support
1486 * remote groups better.
1488 function saveKnownGroups($group_ids)
1490 if (!is_array($group_ids)) {
1491 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1492 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1496 foreach (array_unique($group_ids) as $id) {
1497 $group = User_group::getKV('id', $id);
1498 if ($group instanceof User_group) {
1499 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1500 $result = $this->addToGroupInbox($group);
1502 common_log_db_error($gi, 'INSERT', __FILE__);
1505 if (common_config('group', 'addtag')) {
1506 // we automatically add a tag for every group name, too
1508 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1509 'notice_id' => $this->id));
1511 if (is_null($tag)) {
1512 $this->saveTag($group->nickname);
1516 $groups[] = clone($group);
1518 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1525 function addToGroupInbox(User_group $group)
1527 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1528 'notice_id' => $this->id));
1530 if (!$gi instanceof Group_inbox) {
1532 $gi = new Group_inbox();
1534 $gi->group_id = $group->id;
1535 $gi->notice_id = $this->id;
1536 $gi->created = $this->created;
1538 $result = $gi->insert();
1541 common_log_db_error($gi, 'INSERT', __FILE__);
1542 // TRANS: Server exception thrown when an update for a group inbox fails.
1543 throw new ServerException(_('Problem saving group inbox.'));
1546 self::blow('user_group:notice_ids:%d', $gi->group_id);
1553 * Save reply records indicating that this notice needs to be
1554 * delivered to the local users with the given URIs.
1556 * Since this is expected to be used when saving foreign-sourced
1557 * messages, we won't deliver to any remote targets as that's the
1558 * source service's responsibility.
1560 * Mail notifications etc will be handled later.
1562 * @param array $uris Array of unique identifier URIs for recipients
1564 function saveKnownReplies(array $uris)
1570 $sender = Profile::getKV($this->profile_id);
1572 foreach (array_unique($uris) as $uri) {
1574 $profile = Profile::fromUri($uri);
1575 } catch (UnknownUriException $e) {
1576 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1580 if ($profile->hasBlocked($sender)) {
1581 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1585 $this->saveReply($profile->id);
1586 self::blow('reply:stream:%d', $profile->id);
1593 * Pull @-replies from this message's content in StatusNet markup format
1594 * and save reply records indicating that this message needs to be
1595 * delivered to those users.
1597 * Mail notifications to local profiles will be sent later.
1599 * @return array of integer profile IDs
1602 function saveReplies()
1604 // Don't save reply data for repeats
1606 if ($this->isRepeat()) {
1610 $sender = $this->getProfile();
1614 // If it's a reply, save for the replied-to author
1616 $parent = $this->getParent();
1617 $parentauthor = $parent->getProfile();
1618 $this->saveReply($parentauthor->id);
1619 $replied[$parentauthor->id] = 1;
1620 self::blow('reply:stream:%d', $parentauthor->id);
1621 } catch (Exception $e) {
1622 // Not a reply, since it has no parent!
1625 // @todo ideally this parser information would only
1626 // be calculated once.
1628 $mentions = common_find_mentions($this->content, $this);
1630 // store replied only for first @ (what user/notice what the reply directed,
1631 // we assume first @ is it)
1633 foreach ($mentions as $mention) {
1635 foreach ($mention['mentioned'] as $mentioned) {
1637 // skip if they're already covered
1639 if (!empty($replied[$mentioned->id])) {
1643 // Don't save replies from blocked profile to local user
1645 $mentioned_user = User::getKV('id', $mentioned->id);
1646 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1650 $this->saveReply($mentioned->id);
1651 $replied[$mentioned->id] = 1;
1652 self::blow('reply:stream:%d', $mentioned->id);
1656 $recipientIds = array_keys($replied);
1658 return $recipientIds;
1661 function saveReply($profileId)
1663 $reply = new Reply();
1665 $reply->notice_id = $this->id;
1666 $reply->profile_id = $profileId;
1667 $reply->modified = $this->created;
1674 protected $_replies = array();
1677 * Pull the complete list of @-reply targets for this notice.
1679 * @return array of integer profile ids
1681 function getReplies()
1683 if (isset($this->_replies[$this->id])) {
1684 return $this->_replies[$this->id];
1687 $replyMap = Reply::listGet('notice_id', array($this->id));
1691 foreach ($replyMap[$this->id] as $reply) {
1692 $ids[] = $reply->profile_id;
1695 $this->_replies[$this->id] = $ids;
1700 function _setReplies($replies)
1702 $this->_replies[$this->id] = $replies;
1706 * Pull the complete list of @-reply targets for this notice.
1708 * @return array of Profiles
1710 function getReplyProfiles()
1712 $ids = $this->getReplies();
1714 $profiles = Profile::multiGet('id', $ids);
1716 return $profiles->fetchAll();
1720 * Send e-mail notifications to local @-reply targets.
1722 * Replies must already have been saved; this is expected to be run
1723 * from the distrib queue handler.
1725 function sendReplyNotifications()
1727 // Don't send reply notifications for repeats
1729 if ($this->isRepeat()) {
1733 $recipientIds = $this->getReplies();
1734 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1735 require_once INSTALLDIR.'/lib/mail.php';
1737 foreach ($recipientIds as $recipientId) {
1738 $user = User::getKV('id', $recipientId);
1739 if ($user instanceof User) {
1740 mail_notify_attn($user, $this);
1743 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1748 * Pull list of groups this notice needs to be delivered to,
1749 * as previously recorded by saveKnownGroups().
1751 * @return array of Group objects
1754 protected $_groups = array();
1756 function getGroups()
1758 // Don't save groups for repeats
1760 if (!empty($this->repeat_of)) {
1764 if (isset($this->_groups[$this->id])) {
1765 return $this->_groups[$this->id];
1768 $gis = Group_inbox::listGet('notice_id', array($this->id));
1772 foreach ($gis[$this->id] as $gi)
1774 $ids[] = $gi->group_id;
1777 $groups = User_group::multiGet('id', $ids);
1779 $this->_groups[$this->id] = $groups->fetchAll();
1781 return $this->_groups[$this->id];
1784 function _setGroups($groups)
1786 $this->_groups[$this->id] = $groups;
1790 * Convert a notice into an activity for export.
1792 * @param Profile $scoped The currently logged in/scoped profile
1794 * @return Activity activity object representing this Notice.
1797 function asActivity(Profile $scoped=null)
1799 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1801 if ($act instanceof Activity) {
1804 $act = new Activity();
1806 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1808 $act->id = $this->uri;
1809 $act->time = strtotime($this->created);
1811 $act->link = $this->getUrl();
1812 } catch (InvalidUrlException $e) {
1813 // The notice is probably a share or similar, which don't
1814 // have a representational URL of their own.
1816 $act->content = common_xml_safe_str($this->rendered);
1818 $profile = $this->getProfile();
1820 $act->actor = $profile->asActivityObject();
1821 $act->actor->extra[] = $profile->profileInfo($scoped);
1823 $act->verb = $this->verb;
1825 if ($this->repeat_of) {
1826 $repeated = Notice::getKV('id', $this->repeat_of);
1827 if ($repeated instanceof Notice) {
1828 // TRANS: A repeat activity's title. %1$s is repeater's nickname
1829 // and %2$s is the repeated user's nickname.
1830 $act->title = sprintf(_('%1$s repeated a notice by %2$s'),
1831 $this->getProfile()->getNickname(),
1832 $repeated->getProfile()->getNickname());
1833 $act->objects[] = $repeated->asActivity($scoped);
1836 $act->objects[] = $this->asActivityObject();
1839 // XXX: should this be handled by default processing for object entry?
1843 $tags = $this->getTags();
1845 foreach ($tags as $tag) {
1846 $cat = new AtomCategory();
1849 $act->categories[] = $cat;
1853 // XXX: use Atom Media and/or File activity objects instead
1855 $attachments = $this->attachments();
1857 foreach ($attachments as $attachment) {
1858 // Save local attachments
1859 if (!empty($attachment->filename)) {
1860 $act->attachments[] = ActivityObject::fromFile($attachment);
1864 $ctx = new ActivityContext();
1867 $reply = $this->getParent();
1868 $ctx->replyToID = $reply->getUri();
1869 $ctx->replyToUrl = $reply->getUrl();
1870 } catch (Exception $e) {
1871 // This is not a reply to something
1874 $ctx->location = $this->getLocation();
1878 if (!empty($this->conversation)) {
1879 $conv = Conversation::getKV('id', $this->conversation);
1880 if ($conv instanceof Conversation) {
1881 $ctx->conversation = $conv->uri;
1885 $reply_ids = $this->getReplies();
1887 foreach ($reply_ids as $id) {
1888 $rprofile = Profile::getKV('id', $id);
1889 if ($rprofile instanceof Profile) {
1890 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1894 $groups = $this->getGroups();
1896 foreach ($groups as $group) {
1897 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1900 switch ($this->scope) {
1901 case Notice::PUBLIC_SCOPE:
1902 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1904 case Notice::FOLLOWER_SCOPE:
1905 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1906 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1910 $act->context = $ctx;
1912 $source = $this->getSource();
1914 if ($source instanceof Notice_source) {
1915 $act->generator = ActivityObject::fromNoticeSource($source);
1920 $atom_feed = $profile->getAtomFeed();
1922 if (!empty($atom_feed)) {
1924 $act->source = new ActivitySource();
1926 // XXX: we should store the actual feed ID
1928 $act->source->id = $atom_feed;
1930 // XXX: we should store the actual feed title
1932 $act->source->title = $profile->getBestName();
1934 $act->source->links['alternate'] = $profile->profileurl;
1935 $act->source->links['self'] = $atom_feed;
1937 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1939 $notice = $profile->getCurrentNotice();
1941 if ($notice instanceof Notice) {
1942 $act->source->updated = self::utcDate($notice->created);
1945 $user = User::getKV('id', $profile->id);
1947 if ($user instanceof User) {
1948 $act->source->links['license'] = common_config('license', 'url');
1952 if ($this->isLocal()) {
1953 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1954 'format' => 'atom'));
1955 $act->editLink = $act->selfLink;
1958 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
1961 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1966 // This has gotten way too long. Needs to be sliced up into functional bits
1967 // or ideally exported to a utility class.
1969 function asAtomEntry($namespace=false,
1972 Profile $scoped=null)
1974 $act = $this->asActivity($scoped);
1975 $act->extra[] = $this->noticeInfo($scoped);
1976 return $act->asString($namespace, $author, $source);
1980 * Extra notice info for atom entries
1982 * Clients use some extra notice info in the atom stream.
1983 * This gives it to them.
1985 * @param Profile $scoped The currently logged in/scoped profile
1987 * @return array representation of <statusnet:notice_info> element
1990 function noticeInfo(Profile $scoped=null)
1992 // local notice ID (useful to clients for ordering)
1994 $noticeInfoAttr = array('local_id' => $this->id);
1998 $ns = $this->getSource();
2000 if ($ns instanceof Notice_source) {
2001 $noticeInfoAttr['source'] = $ns->code;
2002 if (!empty($ns->url)) {
2003 $noticeInfoAttr['source_link'] = $ns->url;
2004 if (!empty($ns->name)) {
2005 $noticeInfoAttr['source'] = '<a href="'
2006 . htmlspecialchars($ns->url)
2007 . '" rel="nofollow">'
2008 . htmlspecialchars($ns->name)
2014 // favorite and repeated
2016 if ($scoped instanceof Profile) {
2017 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2020 if (!empty($this->repeat_of)) {
2021 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2024 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2026 return array('statusnet:notice_info', $noticeInfoAttr, null);
2030 * Returns an XML string fragment with a reference to a notice as an
2031 * Activity Streams noun object with the given element type.
2033 * Assumes that 'activity' namespace has been previously defined.
2035 * @param string $element one of 'subject', 'object', 'target'
2039 function asActivityNoun($element)
2041 $noun = $this->asActivityObject();
2042 return $noun->asString('activity:' . $element);
2045 public function asActivityObject()
2047 $object = new ActivityObject();
2049 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2050 $object->type = $this->object_type ?: ActivityObject::NOTE;
2051 $object->id = $this->getUri();
2052 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2053 $object->content = $this->rendered;
2054 $object->link = $this->getUrl();
2056 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2058 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2065 * Determine which notice, if any, a new notice is in reply to.
2067 * For conversation tracking, we try to see where this notice fits
2068 * in the tree. Beware that this may very well give false positives
2069 * and add replies to wrong threads (if there have been newer posts
2070 * by the same user as we're replying to).
2072 * @param Profile $sender Author profile
2073 * @param string $content Final notice content
2075 * @return integer ID of replied-to notice, or null for not a reply.
2078 static function getInlineReplyTo(Profile $sender, $content)
2080 // Is there an initial @ or T?
2081 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2082 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2083 $nickname = common_canonical_nickname($match[1]);
2088 // Figure out who that is.
2089 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2091 if ($recipient instanceof Profile) {
2092 // Get their last notice
2093 $last = $recipient->getCurrentNotice();
2094 if ($last instanceof Notice) {
2097 // Maybe in the future we want to handle something else below
2098 // so don't return getCurrentNotice() immediately.
2104 static function maxContent()
2106 $contentlimit = common_config('notice', 'contentlimit');
2107 // null => use global limit (distinct from 0!)
2108 if (is_null($contentlimit)) {
2109 $contentlimit = common_config('site', 'textlimit');
2111 return $contentlimit;
2114 static function contentTooLong($content)
2116 $contentlimit = self::maxContent();
2117 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2120 function getLocation()
2124 if (!empty($this->location_id) && !empty($this->location_ns)) {
2125 $location = Location::fromId($this->location_id, $this->location_ns);
2128 if (is_null($location)) { // no ID, or Location::fromId() failed
2129 if (!empty($this->lat) && !empty($this->lon)) {
2130 $location = Location::fromLatLon($this->lat, $this->lon);
2138 * Convenience function for posting a repeat of an existing message.
2140 * @param Profile $repeater Profile which is doing the repeat
2141 * @param string $source: posting source key, eg 'web', 'api', etc
2144 * @throws Exception on failure or permission problems
2146 function repeat(Profile $repeater, $source)
2148 $author = $this->getProfile();
2150 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2151 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2152 $content = sprintf(_('RT @%1$s %2$s'),
2153 $author->getNickname(),
2156 $maxlen = self::maxContent();
2157 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2158 // Web interface and current Twitter API clients will
2159 // pull the original notice's text, but some older
2160 // clients and RSS/Atom feeds will see this trimmed text.
2162 // Unfortunately this is likely to lose tags or URLs
2163 // at the end of long notices.
2164 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2168 // Scope is same as this one's
2169 return self::saveNew($repeater->id,
2172 array('repeat_of' => $this->id,
2173 'scope' => $this->scope));
2176 // These are supposed to be in chron order!
2178 function repeatStream($limit=100)
2180 $cache = Cache::instance();
2182 if (empty($cache)) {
2183 $ids = $this->_repeatStreamDirect($limit);
2185 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2186 if ($idstr !== false) {
2187 if (empty($idstr)) {
2190 $ids = explode(',', $idstr);
2193 $ids = $this->_repeatStreamDirect(100);
2194 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2197 // We do a max of 100, so slice down to limit
2198 $ids = array_slice($ids, 0, $limit);
2202 return NoticeStream::getStreamByIds($ids);
2205 function _repeatStreamDirect($limit)
2207 $notice = new Notice();
2209 $notice->selectAdd(); // clears it
2210 $notice->selectAdd('id');
2212 $notice->repeat_of = $this->id;
2214 $notice->orderBy('created, id'); // NB: asc!
2216 if (!is_null($limit)) {
2217 $notice->limit(0, $limit);
2220 return $notice->fetchAll('id');
2223 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2227 if (!empty($location_id) && !empty($location_ns)) {
2228 $options['location_id'] = $location_id;
2229 $options['location_ns'] = $location_ns;
2231 $location = Location::fromId($location_id, $location_ns);
2233 if ($location instanceof Location) {
2234 $options['lat'] = $location->lat;
2235 $options['lon'] = $location->lon;
2238 } else if (!empty($lat) && !empty($lon)) {
2239 $options['lat'] = $lat;
2240 $options['lon'] = $lon;
2242 $location = Location::fromLatLon($lat, $lon);
2244 if ($location instanceof Location) {
2245 $options['location_id'] = $location->location_id;
2246 $options['location_ns'] = $location->location_ns;
2248 } else if (!empty($profile)) {
2249 if (isset($profile->lat) && isset($profile->lon)) {
2250 $options['lat'] = $profile->lat;
2251 $options['lon'] = $profile->lon;
2254 if (isset($profile->location_id) && isset($profile->location_ns)) {
2255 $options['location_id'] = $profile->location_id;
2256 $options['location_ns'] = $profile->location_ns;
2263 function clearAttentions()
2265 $att = new Attention();
2266 $att->notice_id = $this->getID();
2269 while ($att->fetch()) {
2270 // Can't do delete() on the object directly since it won't remove all of it
2271 $other = clone($att);
2277 function clearReplies()
2279 $replyNotice = new Notice();
2280 $replyNotice->reply_to = $this->id;
2282 //Null any notices that are replies to this notice
2284 if ($replyNotice->find()) {
2285 while ($replyNotice->fetch()) {
2286 $orig = clone($replyNotice);
2287 $replyNotice->reply_to = null;
2288 $replyNotice->update($orig);
2294 $reply = new Reply();
2295 $reply->notice_id = $this->id;
2297 if ($reply->find()) {
2298 while($reply->fetch()) {
2299 self::blow('reply:stream:%d', $reply->profile_id);
2307 function clearFiles()
2309 $f2p = new File_to_post();
2311 $f2p->post_id = $this->id;
2314 while ($f2p->fetch()) {
2318 // FIXME: decide whether to delete File objects
2319 // ...and related (actual) files
2322 function clearRepeats()
2324 $repeatNotice = new Notice();
2325 $repeatNotice->repeat_of = $this->id;
2327 //Null any notices that are repeats of this notice
2329 if ($repeatNotice->find()) {
2330 while ($repeatNotice->fetch()) {
2331 $orig = clone($repeatNotice);
2332 $repeatNotice->repeat_of = null;
2333 $repeatNotice->update($orig);
2338 function clearTags()
2340 $tag = new Notice_tag();
2341 $tag->notice_id = $this->id;
2344 while ($tag->fetch()) {
2345 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2346 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2347 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2348 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2356 function clearGroupInboxes()
2358 $gi = new Group_inbox();
2360 $gi->notice_id = $this->id;
2363 while ($gi->fetch()) {
2364 self::blow('user_group:notice_ids:%d', $gi->group_id);
2372 function distribute()
2374 // We always insert for the author so they don't
2376 Event::handle('StartNoticeDistribute', array($this));
2378 // If there's a failure, we want to _force_
2379 // distribution at this point.
2381 $qm = QueueManager::get();
2382 $qm->enqueue($this, 'distrib');
2383 } catch (Exception $e) {
2384 // If the exception isn't transient, this
2385 // may throw more exceptions as DQH does
2386 // its own enqueueing. So, we ignore them!
2388 $handler = new DistribQueueHandler();
2389 $handler->handle($this);
2390 } catch (Exception $e) {
2391 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2393 // Re-throw so somebody smarter can handle it.
2400 $result = parent::insert();
2402 if ($result === false) {
2403 common_log_db_error($this, 'INSERT', __FILE__);
2404 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2405 throw new ServerException('Could not save Notice');
2408 // Profile::hasRepeated() abuses pkeyGet(), so we
2409 // have to clear manually
2410 if (!empty($this->repeat_of)) {
2411 $c = self::memcache();
2413 $ck = self::multicacheKey('Notice',
2414 array('profile_id' => $this->profile_id,
2415 'repeat_of' => $this->repeat_of));
2420 // Update possibly ID-dependent columns: URI, conversation
2421 // (now that INSERT has added the notice's local id)
2422 $orig = clone($this);
2425 // We can only get here if it's a local notice, since remote notices
2426 // should've bailed out earlier due to lacking a URI.
2427 if (empty($this->uri)) {
2428 $this->uri = sprintf('%s%s=%d:%s=%s',
2430 'noticeId', $this->id,
2431 'objectType', $this->get_object_type(true));
2435 if ($changed && $this->update($orig) === false) {
2436 common_log_db_error($notice, 'UPDATE', __FILE__);
2437 // TRANS: Server exception thrown when a notice cannot be updated.
2438 throw new ServerException(_('Problem saving notice.'));
2441 $this->blowOnInsert();
2447 * Get the source of the notice
2449 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2450 * guaranteed to be populated.
2452 function getSource()
2454 if (empty($this->source)) {
2458 $ns = new Notice_source();
2459 switch ($this->source) {
2466 $ns->code = $this->source;
2469 $ns = Notice_source::getKV($this->source);
2471 $ns = new Notice_source();
2472 $ns->code = $this->source;
2473 $app = Oauth_application::getKV('name', $this->source);
2475 $ns->name = $app->name;
2476 $ns->url = $app->source_url;
2486 * Determine whether the notice was locally created
2488 * @return boolean locality
2491 public function isLocal()
2493 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2494 $this->is_local == Notice::LOCAL_NONPUBLIC);
2497 public function isRepeat()
2499 return !empty($this->repeat_of);
2503 * Get the list of hash tags saved with this notice.
2505 * @return array of strings
2507 public function getTags()
2511 $keypart = sprintf('notice:tags:%d', $this->id);
2513 $tagstr = self::cacheGet($keypart);
2515 if ($tagstr !== false) {
2516 $tags = explode(',', $tagstr);
2518 $tag = new Notice_tag();
2519 $tag->notice_id = $this->id;
2521 while ($tag->fetch()) {
2522 $tags[] = $tag->tag;
2525 self::cacheSet($keypart, implode(',', $tags));
2531 static private function utcDate($dt)
2533 $dateStr = date('d F Y H:i:s', strtotime($dt));
2534 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2535 return $d->format(DATE_W3C);
2539 * Look up the creation timestamp for a given notice ID, even
2540 * if it's been deleted.
2543 * @return mixed string recorded creation timestamp, or false if can't be found
2545 public static function getAsTimestamp($id)
2551 $notice = Notice::getKV('id', $id);
2553 return $notice->created;
2556 $deleted = Deleted_notice::getKV('id', $id);
2558 return $deleted->created;
2565 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2566 * parameter, matching notices posted after the given one (exclusive).
2568 * If the referenced notice can't be found, will return false.
2571 * @param string $idField
2572 * @param string $createdField
2573 * @return mixed string or false if no match
2575 public static function whereSinceId($id, $idField='id', $createdField='created')
2577 $since = Notice::getAsTimestamp($id);
2579 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2585 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2586 * parameter, matching notices posted after the given one (exclusive), and
2587 * if necessary add it to the data object's query.
2589 * @param DB_DataObject $obj
2591 * @param string $idField
2592 * @param string $createdField
2593 * @return mixed string or false if no match
2595 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2597 $since = self::whereSinceId($id, $idField, $createdField);
2599 $obj->whereAdd($since);
2604 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2605 * parameter, matching notices posted before the given one (inclusive).
2607 * If the referenced notice can't be found, will return false.
2610 * @param string $idField
2611 * @param string $createdField
2612 * @return mixed string or false if no match
2614 public static function whereMaxId($id, $idField='id', $createdField='created')
2616 $max = Notice::getAsTimestamp($id);
2618 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2624 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2625 * parameter, matching notices posted before the given one (inclusive), and
2626 * if necessary add it to the data object's query.
2628 * @param DB_DataObject $obj
2630 * @param string $idField
2631 * @param string $createdField
2632 * @return mixed string or false if no match
2634 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2636 $max = self::whereMaxId($id, $idField, $createdField);
2638 $obj->whereAdd($max);
2644 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2645 ($this->is_local != Notice::GATEWAY));
2649 * Check that the given profile is allowed to read, respond to, or otherwise
2650 * act on this notice.
2652 * The $scope member is a bitmask of scopes, representing a logical AND of the
2653 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2654 * "only visible to people who are mentioned in the notice AND are users on this site."
2655 * Users on the site who are not mentioned in the notice will not be able to see the
2658 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2660 * @return boolean whether the profile is in the notice's scope
2662 function inScope($profile)
2664 if (is_null($profile)) {
2665 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2667 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2670 $result = self::cacheGet($keypart);
2672 if ($result === false) {
2674 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2675 $bResult = $this->_inScope($profile);
2676 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2678 $result = ($bResult) ? 1 : 0;
2679 self::cacheSet($keypart, $result, 0, 300);
2682 return ($result == 1) ? true : false;
2685 protected function _inScope($profile)
2687 if (!is_null($this->scope)) {
2688 $scope = $this->scope;
2690 $scope = self::defaultScope();
2693 // If there's no scope, anyone (even anon) is in scope.
2695 if ($scope == 0) { // Not private
2697 return !$this->isHiddenSpam($profile);
2699 } else { // Private, somehow
2701 // If there's scope, anon cannot be in scope
2703 if (empty($profile)) {
2707 // Author is always in scope
2709 if ($this->profile_id == $profile->id) {
2713 // Only for users on this site
2715 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2719 // Only for users mentioned in the notice
2721 if ($scope & Notice::ADDRESSEE_SCOPE) {
2723 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2724 'profile_id' => $profile->id));
2726 if (!$reply instanceof Reply) {
2731 // Only for members of the given group
2733 if ($scope & Notice::GROUP_SCOPE) {
2735 // XXX: just query for the single membership
2737 $groups = $this->getGroups();
2741 foreach ($groups as $group) {
2742 if ($profile->isMember($group)) {
2753 // Only for followers of the author
2757 if ($scope & Notice::FOLLOWER_SCOPE) {
2760 $author = $this->getProfile();
2761 } catch (Exception $e) {
2765 if (!Subscription::exists($profile, $author)) {
2770 return !$this->isHiddenSpam($profile);
2774 function isHiddenSpam($profile) {
2776 // Hide posts by silenced users from everyone but moderators.
2778 if (common_config('notice', 'hidespam')) {
2781 $author = $this->getProfile();
2782 } catch(Exception $e) {
2783 // If we can't get an author, keep it hidden.
2784 // XXX: technically not spam, but, whatever.
2788 if ($author->hasRole(Profile_role::SILENCED)) {
2789 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2798 public function getParent()
2800 $parent = Notice::getKV('id', $this->reply_to);
2802 if (!$parent instanceof Notice) {
2803 throw new ServerException('Notice has no parent');
2810 * Magic function called at serialize() time.
2812 * We use this to drop a couple process-specific references
2813 * from DB_DataObject which can cause trouble in future
2816 * @return array of variable names to include in serialization.
2821 $vars = parent::__sleep();
2822 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2823 return array_diff($vars, $skip);
2826 static function defaultScope()
2828 $scope = common_config('notice', 'defaultscope');
2829 if (is_null($scope)) {
2830 if (common_config('site', 'private')) {
2839 static function fillProfiles($notices)
2841 $map = self::getProfiles($notices);
2843 foreach ($notices as $entry=>$notice) {
2845 if (array_key_exists($notice->profile_id, $map)) {
2846 $notice->_setProfile($map[$notice->profile_id]);
2848 } catch (NoProfileException $e) {
2849 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2850 unset($notices[$entry]);
2854 return array_values($map);
2857 static function getProfiles(&$notices)
2860 foreach ($notices as $notice) {
2861 $ids[] = $notice->profile_id;
2864 $ids = array_unique($ids);
2866 return Profile::pivotGet('id', $ids);
2869 static function fillGroups(&$notices)
2871 $ids = self::_idsOf($notices);
2873 $gis = Group_inbox::listGet('notice_id', $ids);
2877 foreach ($gis as $id => $gi)
2881 $gids[] = $g->group_id;
2885 $gids = array_unique($gids);
2887 $group = User_group::pivotGet('id', $gids);
2889 foreach ($notices as $notice)
2892 $gi = $gis[$notice->id];
2893 foreach ($gi as $g) {
2894 $grps[] = $group[$g->group_id];
2896 $notice->_setGroups($grps);
2900 static function _idsOf(array &$notices)
2903 foreach ($notices as $notice) {
2904 $ids[$notice->id] = true;
2906 return array_keys($ids);
2909 static function fillAttachments(&$notices)
2911 $ids = self::_idsOf($notices);
2913 $f2pMap = File_to_post::listGet('post_id', $ids);
2917 foreach ($f2pMap as $noticeId => $f2ps) {
2918 foreach ($f2ps as $f2p) {
2919 $fileIds[] = $f2p->file_id;
2923 $fileIds = array_unique($fileIds);
2925 $fileMap = File::pivotGet('id', $fileIds);
2927 foreach ($notices as $notice)
2930 $f2ps = $f2pMap[$notice->id];
2931 foreach ($f2ps as $f2p) {
2932 $files[] = $fileMap[$f2p->file_id];
2934 $notice->_setAttachments($files);
2938 static function fillReplies(&$notices)
2940 $ids = self::_idsOf($notices);
2941 $replyMap = Reply::listGet('notice_id', $ids);
2942 foreach ($notices as $notice) {
2943 $replies = $replyMap[$notice->id];
2945 foreach ($replies as $reply) {
2946 $ids[] = $reply->profile_id;
2948 $notice->_setReplies($ids);
2952 protected $_repeats = array();
2954 function getRepeats()
2956 if (isset($this->_repeats[$this->id])) {
2957 return $this->_repeats[$this->id];
2959 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2960 $this->_repeats[$this->id] = $repeatMap[$this->id];
2961 return $this->_repeats[$this->id];
2964 function _setRepeats($repeats)
2966 $this->_repeats[$this->id] = $repeats;
2969 static function fillRepeats(&$notices)
2971 $ids = self::_idsOf($notices);
2972 $repeatMap = Notice::listGet('repeat_of', $ids);
2973 foreach ($notices as $notice) {
2974 $repeats = $repeatMap[$notice->id];
2975 $notice->_setRepeats($repeats);