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(191) unique_key not 255 because utf8mb4 takes more space
59 public $content; // text
60 public $rendered; // text
61 public $url; // varchar(191) not 255 because utf8mb4 takes more space
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(191) not 255 because utf8mb4 takes more space
74 public $object_type; // varchar(191) not 255 because utf8mb4 takes more space
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' => 191, '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' => 191, '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' => 191, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'),
102 'verb' => array('type' => 'varchar', 'length' => 191, '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();
1073 $format = array_shift($args);
1074 $keyPart = vsprintf($format, $args);
1075 $cacheKey = Cache::key($keyPart);
1076 $c->delete($cacheKey);
1078 // delete the "last" stream, too, if this notice is
1079 // older than the top of that stream
1081 $lastKey = $cacheKey.';last';
1083 $lastStr = $c->get($lastKey);
1085 if ($lastStr !== false) {
1086 $window = explode(',', $lastStr);
1087 $lastID = $window[0];
1088 $lastNotice = Notice::getKV('id', $lastID);
1089 if (!$lastNotice instanceof Notice // just weird
1090 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1091 $c->delete($lastKey);
1096 /** save all urls in the notice to the db
1098 * follow redirects and save all available file information
1099 * (mimetype, date, size, oembed, etc.)
1103 function saveUrls() {
1104 if (common_config('attachments', 'process_links')) {
1105 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
1110 * Save the given URLs as related links/attachments to the db
1112 * follow redirects and save all available file information
1113 * (mimetype, date, size, oembed, etc.)
1117 function saveKnownUrls($urls)
1119 if (common_config('attachments', 'process_links')) {
1120 // @fixme validation?
1121 foreach (array_unique($urls) as $url) {
1123 File::processNew($url, $this->id);
1124 } catch (ServerException $e) {
1125 // Could not save URL. Log it?
1134 function saveUrl($url, $notice_id) {
1136 File::processNew($url, $notice_id);
1137 } catch (ServerException $e) {
1138 // Could not save URL. Log it?
1142 static function checkDupes($profile_id, $content) {
1143 $profile = Profile::getKV($profile_id);
1144 if (!$profile instanceof Profile) {
1147 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1148 if (!empty($notice)) {
1150 while ($notice->fetch()) {
1151 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1153 } else if ($notice->content == $content) {
1158 // If we get here, oldest item in cache window is not
1159 // old enough for dupe limit; do direct check against DB
1160 $notice = new Notice();
1161 $notice->profile_id = $profile_id;
1162 $notice->content = $content;
1163 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1164 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1166 $cnt = $notice->count();
1170 static function checkEditThrottle($profile_id) {
1171 $profile = Profile::getKV($profile_id);
1172 if (!$profile instanceof Profile) {
1175 // Get the Nth notice
1176 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1177 if ($notice && $notice->fetch()) {
1178 // If the Nth notice was posted less than timespan seconds ago
1179 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1184 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1188 protected $_attachments = array();
1190 function attachments() {
1191 if (isset($this->_attachments[$this->id])) {
1192 return $this->_attachments[$this->id];
1195 $f2ps = File_to_post::listGet('post_id', array($this->id));
1197 foreach ($f2ps[$this->id] as $f2p) {
1198 $ids[] = $f2p->file_id;
1201 $files = File::multiGet('id', $ids);
1202 $this->_attachments[$this->id] = $files->fetchAll();
1203 return $this->_attachments[$this->id];
1206 function _setAttachments($attachments)
1208 $this->_attachments[$this->id] = $attachments;
1211 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
1213 $stream = new PublicNoticeStream();
1214 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1218 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
1220 $stream = new ConversationNoticeStream($id);
1222 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1226 * Is this notice part of an active conversation?
1228 * @return boolean true if other messages exist in the same
1229 * conversation, false if this is the only one
1231 function hasConversation()
1233 if (!empty($this->conversation)) {
1234 $conversation = Notice::conversationStream(
1235 $this->conversation,
1240 if ($conversation->N > 0) {
1248 * Grab the earliest notice from this conversation.
1250 * @return Notice or null
1252 function conversationRoot($profile=-1)
1254 // XXX: can this happen?
1256 if (empty($this->conversation)) {
1260 // Get the current profile if not specified
1262 if (is_int($profile) && $profile == -1) {
1263 $profile = Profile::current();
1266 // If this notice is out of scope, no root for you!
1268 if (!$this->inScope($profile)) {
1272 // If this isn't a reply to anything, then it's its own
1273 // root if it's the earliest notice in the conversation:
1275 if (empty($this->reply_to)) {
1277 $root->conversation = $this->conversation;
1278 $root->orderBy('notice.created ASC');
1285 if (is_null($profile)) {
1286 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1288 $keypart = sprintf('notice:conversation_root:%d:%d',
1293 $root = self::cacheGet($keypart);
1295 if ($root !== false && $root->inScope($profile)) {
1302 $parent = $last->getParent();
1303 if ($parent->inScope($profile)) {
1307 } catch (Exception $e) {
1308 // Latest notice has no parent
1310 // No parent, or parent out of scope
1315 self::cacheSet($keypart, $root);
1321 * Pull up a full list of local recipients who will be getting
1322 * this notice in their inbox. Results will be cached, so don't
1323 * change the input data wily-nilly!
1325 * @param array $groups optional list of Group objects;
1326 * if left empty, will be loaded from group_inbox records
1327 * @param array $recipient optional list of reply profile ids
1328 * if left empty, will be loaded from reply records
1329 * @return array associating recipient user IDs with an inbox source constant
1331 function whoGets(array $groups=null, array $recipients=null)
1333 $c = self::memcache();
1336 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1337 if ($ni !== false) {
1342 if (is_null($recipients)) {
1343 $recipients = $this->getReplies();
1348 // Give plugins a chance to add folks in at start...
1349 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1351 $users = $this->getSubscribedUsers();
1352 foreach ($users as $id) {
1353 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1356 if (is_null($groups)) {
1357 $groups = $this->getGroups();
1359 foreach ($groups as $group) {
1360 $users = $group->getUserMembers();
1361 foreach ($users as $id) {
1362 if (!array_key_exists($id, $ni)) {
1363 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1368 $ptAtts = $this->getAttentionsFromProfileTags();
1369 foreach ($ptAtts as $key=>$val) {
1370 if (!array_key_exists($key, $ni)) {
1375 foreach ($recipients as $recipient) {
1376 if (!array_key_exists($recipient, $ni)) {
1377 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1381 // Exclude any deleted, non-local, or blocking recipients.
1382 $profile = $this->getProfile();
1383 $originalProfile = null;
1384 if ($this->isRepeat()) {
1385 // Check blocks against the original notice's poster as well.
1386 $original = Notice::getKV('id', $this->repeat_of);
1387 if ($original instanceof Notice) {
1388 $originalProfile = $original->getProfile();
1392 foreach ($ni as $id => $source) {
1394 $user = User::getKV('id', $id);
1395 if (!$user instanceof User ||
1396 $user->hasBlocked($profile) ||
1397 ($originalProfile && $user->hasBlocked($originalProfile))) {
1400 } catch (UserNoProfileException $e) {
1401 // User doesn't have a profile; invalid; skip them.
1406 // Give plugins a chance to filter out...
1407 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1411 // XXX: pack this data better
1412 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1418 function getSubscribedUsers()
1422 if(common_config('db','quote_identifiers'))
1423 $user_table = '"user"';
1424 else $user_table = 'user';
1428 'FROM '. $user_table .' JOIN subscription '.
1429 'ON '. $user_table .'.id = subscription.subscriber ' .
1430 'WHERE subscription.subscribed = %d ';
1432 $user->query(sprintf($qry, $this->profile_id));
1436 while ($user->fetch()) {
1445 function getProfileTags()
1447 $profile = $this->getProfile();
1448 $list = $profile->getOtherTags($profile);
1451 while($list->fetch()) {
1452 $ptags[] = clone($list);
1458 public function getAttentionsFromProfileTags()
1461 $ptags = $this->getProfileTags();
1462 foreach ($ptags as $ptag) {
1463 $users = $ptag->getUserSubscribers();
1464 foreach ($users as $id) {
1465 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1472 * Record this notice to the given group inboxes for delivery.
1473 * Overrides the regular parsing of !group markup.
1475 * @param string $group_ids
1476 * @fixme might prefer URIs as identifiers, as for replies?
1477 * best with generalizations on user_group to support
1478 * remote groups better.
1480 function saveKnownGroups($group_ids)
1482 if (!is_array($group_ids)) {
1483 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1484 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1488 foreach (array_unique($group_ids) as $id) {
1489 $group = User_group::getKV('id', $id);
1490 if ($group instanceof User_group) {
1491 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1492 $result = $this->addToGroupInbox($group);
1494 common_log_db_error($gi, 'INSERT', __FILE__);
1497 if (common_config('group', 'addtag')) {
1498 // we automatically add a tag for every group name, too
1500 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1501 'notice_id' => $this->id));
1503 if (is_null($tag)) {
1504 $this->saveTag($group->nickname);
1508 $groups[] = clone($group);
1510 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1517 function addToGroupInbox(User_group $group)
1519 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1520 'notice_id' => $this->id));
1522 if (!$gi instanceof Group_inbox) {
1524 $gi = new Group_inbox();
1526 $gi->group_id = $group->id;
1527 $gi->notice_id = $this->id;
1528 $gi->created = $this->created;
1530 $result = $gi->insert();
1533 common_log_db_error($gi, 'INSERT', __FILE__);
1534 // TRANS: Server exception thrown when an update for a group inbox fails.
1535 throw new ServerException(_('Problem saving group inbox.'));
1538 self::blow('user_group:notice_ids:%d', $gi->group_id);
1545 * Save reply records indicating that this notice needs to be
1546 * delivered to the local users with the given URIs.
1548 * Since this is expected to be used when saving foreign-sourced
1549 * messages, we won't deliver to any remote targets as that's the
1550 * source service's responsibility.
1552 * Mail notifications etc will be handled later.
1554 * @param array $uris Array of unique identifier URIs for recipients
1556 function saveKnownReplies(array $uris)
1562 $sender = Profile::getKV($this->profile_id);
1564 foreach (array_unique($uris) as $uri) {
1566 $profile = Profile::fromUri($uri);
1567 } catch (UnknownUriException $e) {
1568 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1572 if ($profile->hasBlocked($sender)) {
1573 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1577 $this->saveReply($profile->id);
1578 self::blow('reply:stream:%d', $profile->id);
1585 * Pull @-replies from this message's content in StatusNet markup format
1586 * and save reply records indicating that this message needs to be
1587 * delivered to those users.
1589 * Mail notifications to local profiles will be sent later.
1591 * @return array of integer profile IDs
1594 function saveReplies()
1596 // Don't save reply data for repeats
1598 if ($this->isRepeat()) {
1602 $sender = $this->getProfile();
1606 // If it's a reply, save for the replied-to author
1608 $parent = $this->getParent();
1609 $parentauthor = $parent->getProfile();
1610 $this->saveReply($parentauthor->id);
1611 $replied[$parentauthor->id] = 1;
1612 self::blow('reply:stream:%d', $parentauthor->id);
1613 } catch (Exception $e) {
1614 // Not a reply, since it has no parent!
1617 // @todo ideally this parser information would only
1618 // be calculated once.
1620 $mentions = common_find_mentions($this->content, $this);
1622 // store replied only for first @ (what user/notice what the reply directed,
1623 // we assume first @ is it)
1625 foreach ($mentions as $mention) {
1627 foreach ($mention['mentioned'] as $mentioned) {
1629 // skip if they're already covered
1631 if (!empty($replied[$mentioned->id])) {
1635 // Don't save replies from blocked profile to local user
1637 $mentioned_user = User::getKV('id', $mentioned->id);
1638 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1642 $this->saveReply($mentioned->id);
1643 $replied[$mentioned->id] = 1;
1644 self::blow('reply:stream:%d', $mentioned->id);
1648 $recipientIds = array_keys($replied);
1650 return $recipientIds;
1653 function saveReply($profileId)
1655 $reply = new Reply();
1657 $reply->notice_id = $this->id;
1658 $reply->profile_id = $profileId;
1659 $reply->modified = $this->created;
1666 protected $_replies = array();
1669 * Pull the complete list of @-reply targets for this notice.
1671 * @return array of integer profile ids
1673 function getReplies()
1675 if (isset($this->_replies[$this->id])) {
1676 return $this->_replies[$this->id];
1679 $replyMap = Reply::listGet('notice_id', array($this->id));
1683 foreach ($replyMap[$this->id] as $reply) {
1684 $ids[] = $reply->profile_id;
1687 $this->_replies[$this->id] = $ids;
1692 function _setReplies($replies)
1694 $this->_replies[$this->id] = $replies;
1698 * Pull the complete list of @-reply targets for this notice.
1700 * @return array of Profiles
1702 function getReplyProfiles()
1704 $ids = $this->getReplies();
1706 $profiles = Profile::multiGet('id', $ids);
1708 return $profiles->fetchAll();
1712 * Send e-mail notifications to local @-reply targets.
1714 * Replies must already have been saved; this is expected to be run
1715 * from the distrib queue handler.
1717 function sendReplyNotifications()
1719 // Don't send reply notifications for repeats
1721 if ($this->isRepeat()) {
1725 $recipientIds = $this->getReplies();
1726 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1727 require_once INSTALLDIR.'/lib/mail.php';
1729 foreach ($recipientIds as $recipientId) {
1730 $user = User::getKV('id', $recipientId);
1731 if ($user instanceof User) {
1732 mail_notify_attn($user, $this);
1735 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1740 * Pull list of groups this notice needs to be delivered to,
1741 * as previously recorded by saveKnownGroups().
1743 * @return array of Group objects
1746 protected $_groups = array();
1748 function getGroups()
1750 // Don't save groups for repeats
1752 if (!empty($this->repeat_of)) {
1756 if (isset($this->_groups[$this->id])) {
1757 return $this->_groups[$this->id];
1760 $gis = Group_inbox::listGet('notice_id', array($this->id));
1764 foreach ($gis[$this->id] as $gi) {
1765 $ids[] = $gi->group_id;
1768 $groups = User_group::multiGet('id', $ids);
1769 $this->_groups[$this->id] = $groups->fetchAll();
1770 return $this->_groups[$this->id];
1773 function _setGroups($groups)
1775 $this->_groups[$this->id] = $groups;
1779 * Convert a notice into an activity for export.
1781 * @param Profile $scoped The currently logged in/scoped profile
1783 * @return Activity activity object representing this Notice.
1786 function asActivity(Profile $scoped=null)
1788 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1790 if ($act instanceof Activity) {
1793 $act = new Activity();
1795 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1797 $act->id = $this->uri;
1798 $act->time = strtotime($this->created);
1800 $act->link = $this->getUrl();
1801 } catch (InvalidUrlException $e) {
1802 // The notice is probably a share or similar, which don't
1803 // have a representational URL of their own.
1805 $act->content = common_xml_safe_str($this->rendered);
1807 $profile = $this->getProfile();
1809 $act->actor = $profile->asActivityObject();
1810 $act->actor->extra[] = $profile->profileInfo($scoped);
1812 $act->verb = $this->verb;
1814 if ($this->repeat_of) {
1815 $repeated = Notice::getKV('id', $this->repeat_of);
1816 if ($repeated instanceof Notice) {
1817 // TRANS: A repeat activity's title. %1$s is repeater's nickname
1818 // and %2$s is the repeated user's nickname.
1819 $act->title = sprintf(_('%1$s repeated a notice by %2$s'),
1820 $this->getProfile()->getNickname(),
1821 $repeated->getProfile()->getNickname());
1822 $act->objects[] = $repeated->asActivity($scoped);
1825 $act->objects[] = $this->asActivityObject();
1828 // XXX: should this be handled by default processing for object entry?
1832 $tags = $this->getTags();
1834 foreach ($tags as $tag) {
1835 $cat = new AtomCategory();
1838 $act->categories[] = $cat;
1842 // XXX: use Atom Media and/or File activity objects instead
1844 $attachments = $this->attachments();
1846 foreach ($attachments as $attachment) {
1847 // Save local attachments
1848 if (!empty($attachment->filename)) {
1849 $act->attachments[] = ActivityObject::fromFile($attachment);
1853 $ctx = new ActivityContext();
1856 $reply = $this->getParent();
1857 $ctx->replyToID = $reply->getUri();
1858 $ctx->replyToUrl = $reply->getUrl();
1859 } catch (Exception $e) {
1860 // This is not a reply to something
1863 $ctx->location = $this->getLocation();
1867 if (!empty($this->conversation)) {
1868 $conv = Conversation::getKV('id', $this->conversation);
1869 if ($conv instanceof Conversation) {
1870 $ctx->conversation = $conv->uri;
1874 $reply_ids = $this->getReplies();
1876 foreach ($reply_ids as $id) {
1877 $rprofile = Profile::getKV('id', $id);
1878 if ($rprofile instanceof Profile) {
1879 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1883 $groups = $this->getGroups();
1885 foreach ($groups as $group) {
1886 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1889 switch ($this->scope) {
1890 case Notice::PUBLIC_SCOPE:
1891 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1893 case Notice::FOLLOWER_SCOPE:
1894 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1895 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1899 $act->context = $ctx;
1901 $source = $this->getSource();
1903 if ($source instanceof Notice_source) {
1904 $act->generator = ActivityObject::fromNoticeSource($source);
1909 $atom_feed = $profile->getAtomFeed();
1911 if (!empty($atom_feed)) {
1913 $act->source = new ActivitySource();
1915 // XXX: we should store the actual feed ID
1917 $act->source->id = $atom_feed;
1919 // XXX: we should store the actual feed title
1921 $act->source->title = $profile->getBestName();
1923 $act->source->links['alternate'] = $profile->profileurl;
1924 $act->source->links['self'] = $atom_feed;
1926 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1928 $notice = $profile->getCurrentNotice();
1930 if ($notice instanceof Notice) {
1931 $act->source->updated = self::utcDate($notice->created);
1934 $user = User::getKV('id', $profile->id);
1936 if ($user instanceof User) {
1937 $act->source->links['license'] = common_config('license', 'url');
1941 if ($this->isLocal()) {
1942 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1943 'format' => 'atom'));
1944 $act->editLink = $act->selfLink;
1947 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
1950 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1955 // This has gotten way too long. Needs to be sliced up into functional bits
1956 // or ideally exported to a utility class.
1958 function asAtomEntry($namespace=false,
1961 Profile $scoped=null)
1963 $act = $this->asActivity($scoped);
1964 $act->extra[] = $this->noticeInfo($scoped);
1965 return $act->asString($namespace, $author, $source);
1969 * Extra notice info for atom entries
1971 * Clients use some extra notice info in the atom stream.
1972 * This gives it to them.
1974 * @param Profile $scoped The currently logged in/scoped profile
1976 * @return array representation of <statusnet:notice_info> element
1979 function noticeInfo(Profile $scoped=null)
1981 // local notice ID (useful to clients for ordering)
1983 $noticeInfoAttr = array('local_id' => $this->id);
1987 $ns = $this->getSource();
1989 if ($ns instanceof Notice_source) {
1990 $noticeInfoAttr['source'] = $ns->code;
1991 if (!empty($ns->url)) {
1992 $noticeInfoAttr['source_link'] = $ns->url;
1993 if (!empty($ns->name)) {
1994 $noticeInfoAttr['source'] = '<a href="'
1995 . htmlspecialchars($ns->url)
1996 . '" rel="nofollow">'
1997 . htmlspecialchars($ns->name)
2003 // favorite and repeated
2005 if ($scoped instanceof Profile) {
2006 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2009 if (!empty($this->repeat_of)) {
2010 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2013 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2015 return array('statusnet:notice_info', $noticeInfoAttr, null);
2019 * Returns an XML string fragment with a reference to a notice as an
2020 * Activity Streams noun object with the given element type.
2022 * Assumes that 'activity' namespace has been previously defined.
2024 * @param string $element one of 'subject', 'object', 'target'
2028 function asActivityNoun($element)
2030 $noun = $this->asActivityObject();
2031 return $noun->asString('activity:' . $element);
2034 public function asActivityObject()
2036 $object = new ActivityObject();
2038 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2039 $object->type = $this->object_type ?: ActivityObject::NOTE;
2040 $object->id = $this->getUri();
2041 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2042 $object->content = $this->rendered;
2043 $object->link = $this->getUrl();
2045 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2047 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2054 * Determine which notice, if any, a new notice is in reply to.
2056 * For conversation tracking, we try to see where this notice fits
2057 * in the tree. Beware that this may very well give false positives
2058 * and add replies to wrong threads (if there have been newer posts
2059 * by the same user as we're replying to).
2061 * @param Profile $sender Author profile
2062 * @param string $content Final notice content
2064 * @return integer ID of replied-to notice, or null for not a reply.
2067 static function getInlineReplyTo(Profile $sender, $content)
2069 // Is there an initial @ or T?
2070 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2071 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2072 $nickname = common_canonical_nickname($match[1]);
2077 // Figure out who that is.
2078 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2080 if ($recipient instanceof Profile) {
2081 // Get their last notice
2082 $last = $recipient->getCurrentNotice();
2083 if ($last instanceof Notice) {
2086 // Maybe in the future we want to handle something else below
2087 // so don't return getCurrentNotice() immediately.
2093 static function maxContent()
2095 $contentlimit = common_config('notice', 'contentlimit');
2096 // null => use global limit (distinct from 0!)
2097 if (is_null($contentlimit)) {
2098 $contentlimit = common_config('site', 'textlimit');
2100 return $contentlimit;
2103 static function contentTooLong($content)
2105 $contentlimit = self::maxContent();
2106 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2109 function getLocation()
2113 if (!empty($this->location_id) && !empty($this->location_ns)) {
2114 $location = Location::fromId($this->location_id, $this->location_ns);
2117 if (is_null($location)) { // no ID, or Location::fromId() failed
2118 if (!empty($this->lat) && !empty($this->lon)) {
2119 $location = Location::fromLatLon($this->lat, $this->lon);
2127 * Convenience function for posting a repeat of an existing message.
2129 * @param Profile $repeater Profile which is doing the repeat
2130 * @param string $source: posting source key, eg 'web', 'api', etc
2133 * @throws Exception on failure or permission problems
2135 function repeat(Profile $repeater, $source)
2137 $author = $this->getProfile();
2139 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2140 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2141 $content = sprintf(_('RT @%1$s %2$s'),
2142 $author->getNickname(),
2145 $maxlen = self::maxContent();
2146 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2147 // Web interface and current Twitter API clients will
2148 // pull the original notice's text, but some older
2149 // clients and RSS/Atom feeds will see this trimmed text.
2151 // Unfortunately this is likely to lose tags or URLs
2152 // at the end of long notices.
2153 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2157 // Scope is same as this one's
2158 return self::saveNew($repeater->id,
2161 array('repeat_of' => $this->id,
2162 'scope' => $this->scope));
2165 // These are supposed to be in chron order!
2167 function repeatStream($limit=100)
2169 $cache = Cache::instance();
2171 if (empty($cache)) {
2172 $ids = $this->_repeatStreamDirect($limit);
2174 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2175 if ($idstr !== false) {
2176 if (empty($idstr)) {
2179 $ids = explode(',', $idstr);
2182 $ids = $this->_repeatStreamDirect(100);
2183 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2186 // We do a max of 100, so slice down to limit
2187 $ids = array_slice($ids, 0, $limit);
2191 return NoticeStream::getStreamByIds($ids);
2194 function _repeatStreamDirect($limit)
2196 $notice = new Notice();
2198 $notice->selectAdd(); // clears it
2199 $notice->selectAdd('id');
2201 $notice->repeat_of = $this->id;
2203 $notice->orderBy('created, id'); // NB: asc!
2205 if (!is_null($limit)) {
2206 $notice->limit(0, $limit);
2209 return $notice->fetchAll('id');
2212 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2216 if (!empty($location_id) && !empty($location_ns)) {
2217 $options['location_id'] = $location_id;
2218 $options['location_ns'] = $location_ns;
2220 $location = Location::fromId($location_id, $location_ns);
2222 if ($location instanceof Location) {
2223 $options['lat'] = $location->lat;
2224 $options['lon'] = $location->lon;
2227 } else if (!empty($lat) && !empty($lon)) {
2228 $options['lat'] = $lat;
2229 $options['lon'] = $lon;
2231 $location = Location::fromLatLon($lat, $lon);
2233 if ($location instanceof Location) {
2234 $options['location_id'] = $location->location_id;
2235 $options['location_ns'] = $location->location_ns;
2237 } else if (!empty($profile)) {
2238 if (isset($profile->lat) && isset($profile->lon)) {
2239 $options['lat'] = $profile->lat;
2240 $options['lon'] = $profile->lon;
2243 if (isset($profile->location_id) && isset($profile->location_ns)) {
2244 $options['location_id'] = $profile->location_id;
2245 $options['location_ns'] = $profile->location_ns;
2252 function clearAttentions()
2254 $att = new Attention();
2255 $att->notice_id = $this->getID();
2258 while ($att->fetch()) {
2259 // Can't do delete() on the object directly since it won't remove all of it
2260 $other = clone($att);
2266 function clearReplies()
2268 $replyNotice = new Notice();
2269 $replyNotice->reply_to = $this->id;
2271 //Null any notices that are replies to this notice
2273 if ($replyNotice->find()) {
2274 while ($replyNotice->fetch()) {
2275 $orig = clone($replyNotice);
2276 $replyNotice->reply_to = null;
2277 $replyNotice->update($orig);
2283 $reply = new Reply();
2284 $reply->notice_id = $this->id;
2286 if ($reply->find()) {
2287 while($reply->fetch()) {
2288 self::blow('reply:stream:%d', $reply->profile_id);
2296 function clearFiles()
2298 $f2p = new File_to_post();
2300 $f2p->post_id = $this->id;
2303 while ($f2p->fetch()) {
2307 // FIXME: decide whether to delete File objects
2308 // ...and related (actual) files
2311 function clearRepeats()
2313 $repeatNotice = new Notice();
2314 $repeatNotice->repeat_of = $this->id;
2316 //Null any notices that are repeats of this notice
2318 if ($repeatNotice->find()) {
2319 while ($repeatNotice->fetch()) {
2320 $orig = clone($repeatNotice);
2321 $repeatNotice->repeat_of = null;
2322 $repeatNotice->update($orig);
2327 function clearTags()
2329 $tag = new Notice_tag();
2330 $tag->notice_id = $this->id;
2333 while ($tag->fetch()) {
2334 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2335 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2336 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2337 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2345 function clearGroupInboxes()
2347 $gi = new Group_inbox();
2349 $gi->notice_id = $this->id;
2352 while ($gi->fetch()) {
2353 self::blow('user_group:notice_ids:%d', $gi->group_id);
2361 function distribute()
2363 // We always insert for the author so they don't
2365 Event::handle('StartNoticeDistribute', array($this));
2367 // If there's a failure, we want to _force_
2368 // distribution at this point.
2370 $qm = QueueManager::get();
2371 $qm->enqueue($this, 'distrib');
2372 } catch (Exception $e) {
2373 // If the exception isn't transient, this
2374 // may throw more exceptions as DQH does
2375 // its own enqueueing. So, we ignore them!
2377 $handler = new DistribQueueHandler();
2378 $handler->handle($this);
2379 } catch (Exception $e) {
2380 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2382 // Re-throw so somebody smarter can handle it.
2389 $result = parent::insert();
2391 if ($result === false) {
2392 common_log_db_error($this, 'INSERT', __FILE__);
2393 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2394 throw new ServerException('Could not save Notice');
2397 // Profile::hasRepeated() abuses pkeyGet(), so we
2398 // have to clear manually
2399 if (!empty($this->repeat_of)) {
2400 $c = self::memcache();
2402 $ck = self::multicacheKey('Notice',
2403 array('profile_id' => $this->profile_id,
2404 'repeat_of' => $this->repeat_of));
2409 // Update possibly ID-dependent columns: URI, conversation
2410 // (now that INSERT has added the notice's local id)
2411 $orig = clone($this);
2414 // We can only get here if it's a local notice, since remote notices
2415 // should've bailed out earlier due to lacking a URI.
2416 if (empty($this->uri)) {
2417 $this->uri = sprintf('%s%s=%d:%s=%s',
2419 'noticeId', $this->id,
2420 'objectType', $this->get_object_type(true));
2424 if ($changed && $this->update($orig) === false) {
2425 common_log_db_error($notice, 'UPDATE', __FILE__);
2426 // TRANS: Server exception thrown when a notice cannot be updated.
2427 throw new ServerException(_('Problem saving notice.'));
2430 $this->blowOnInsert();
2436 * Get the source of the notice
2438 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2439 * guaranteed to be populated.
2441 function getSource()
2443 if (empty($this->source)) {
2447 $ns = new Notice_source();
2448 switch ($this->source) {
2455 $ns->code = $this->source;
2458 $ns = Notice_source::getKV($this->source);
2460 $ns = new Notice_source();
2461 $ns->code = $this->source;
2462 $app = Oauth_application::getKV('name', $this->source);
2464 $ns->name = $app->name;
2465 $ns->url = $app->source_url;
2475 * Determine whether the notice was locally created
2477 * @return boolean locality
2480 public function isLocal()
2482 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2483 $this->is_local == Notice::LOCAL_NONPUBLIC);
2486 public function isRepeat()
2488 return !empty($this->repeat_of);
2492 * Get the list of hash tags saved with this notice.
2494 * @return array of strings
2496 public function getTags()
2500 $keypart = sprintf('notice:tags:%d', $this->id);
2502 $tagstr = self::cacheGet($keypart);
2504 if ($tagstr !== false) {
2505 $tags = explode(',', $tagstr);
2507 $tag = new Notice_tag();
2508 $tag->notice_id = $this->id;
2510 while ($tag->fetch()) {
2511 $tags[] = $tag->tag;
2514 self::cacheSet($keypart, implode(',', $tags));
2520 static private function utcDate($dt)
2522 $dateStr = date('d F Y H:i:s', strtotime($dt));
2523 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2524 return $d->format(DATE_W3C);
2528 * Look up the creation timestamp for a given notice ID, even
2529 * if it's been deleted.
2532 * @return mixed string recorded creation timestamp, or false if can't be found
2534 public static function getAsTimestamp($id)
2540 $notice = Notice::getKV('id', $id);
2542 return $notice->created;
2545 $deleted = Deleted_notice::getKV('id', $id);
2547 return $deleted->created;
2554 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2555 * parameter, matching notices posted after the given one (exclusive).
2557 * If the referenced notice can't be found, will return false.
2560 * @param string $idField
2561 * @param string $createdField
2562 * @return mixed string or false if no match
2564 public static function whereSinceId($id, $idField='id', $createdField='created')
2566 $since = Notice::getAsTimestamp($id);
2568 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2574 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2575 * parameter, matching notices posted after the given one (exclusive), and
2576 * if necessary add it to the data object's query.
2578 * @param DB_DataObject $obj
2580 * @param string $idField
2581 * @param string $createdField
2582 * @return mixed string or false if no match
2584 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2586 $since = self::whereSinceId($id, $idField, $createdField);
2588 $obj->whereAdd($since);
2593 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2594 * parameter, matching notices posted before the given one (inclusive).
2596 * If the referenced notice can't be found, will return false.
2599 * @param string $idField
2600 * @param string $createdField
2601 * @return mixed string or false if no match
2603 public static function whereMaxId($id, $idField='id', $createdField='created')
2605 $max = Notice::getAsTimestamp($id);
2607 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2613 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2614 * parameter, matching notices posted before the given one (inclusive), and
2615 * if necessary add it to the data object's query.
2617 * @param DB_DataObject $obj
2619 * @param string $idField
2620 * @param string $createdField
2621 * @return mixed string or false if no match
2623 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2625 $max = self::whereMaxId($id, $idField, $createdField);
2627 $obj->whereAdd($max);
2633 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2634 ($this->is_local != Notice::GATEWAY));
2638 * Check that the given profile is allowed to read, respond to, or otherwise
2639 * act on this notice.
2641 * The $scope member is a bitmask of scopes, representing a logical AND of the
2642 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2643 * "only visible to people who are mentioned in the notice AND are users on this site."
2644 * Users on the site who are not mentioned in the notice will not be able to see the
2647 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2649 * @return boolean whether the profile is in the notice's scope
2651 function inScope($profile)
2653 if (is_null($profile)) {
2654 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2656 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2659 $result = self::cacheGet($keypart);
2661 if ($result === false) {
2663 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2664 $bResult = $this->_inScope($profile);
2665 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2667 $result = ($bResult) ? 1 : 0;
2668 self::cacheSet($keypart, $result, 0, 300);
2671 return ($result == 1) ? true : false;
2674 protected function _inScope($profile)
2676 if (!is_null($this->scope)) {
2677 $scope = $this->scope;
2679 $scope = self::defaultScope();
2682 if ($scope == 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2683 return !$this->isHiddenSpam($profile);
2686 // If there's scope, anon cannot be in scope
2687 if (empty($profile)) {
2691 // Author is always in scope
2692 if ($this->profile_id == $profile->id) {
2696 // Only for users on this site
2697 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2701 // Only for users mentioned in the notice
2702 if ($scope & Notice::ADDRESSEE_SCOPE) {
2704 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2705 'profile_id' => $profile->id));
2707 if (!$reply instanceof Reply) {
2712 // Only for members of the given group
2713 if ($scope & Notice::GROUP_SCOPE) {
2715 // XXX: just query for the single membership
2717 $groups = $this->getGroups();
2721 foreach ($groups as $group) {
2722 if ($profile->isMember($group)) {
2733 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2735 if (!Subscription::exists($profile, $this->getProfile())) {
2740 return !$this->isHiddenSpam($profile);
2743 function isHiddenSpam($profile) {
2745 // Hide posts by silenced users from everyone but moderators.
2747 if (common_config('notice', 'hidespam')) {
2750 $author = $this->getProfile();
2751 } catch(Exception $e) {
2752 // If we can't get an author, keep it hidden.
2753 // XXX: technically not spam, but, whatever.
2757 if ($author->hasRole(Profile_role::SILENCED)) {
2758 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2767 public function getParent()
2769 $parent = Notice::getKV('id', $this->reply_to);
2771 if (!$parent instanceof Notice) {
2772 throw new ServerException('Notice has no parent');
2779 * Magic function called at serialize() time.
2781 * We use this to drop a couple process-specific references
2782 * from DB_DataObject which can cause trouble in future
2785 * @return array of variable names to include in serialization.
2790 $vars = parent::__sleep();
2791 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2792 return array_diff($vars, $skip);
2795 static function defaultScope()
2797 $scope = common_config('notice', 'defaultscope');
2798 if (is_null($scope)) {
2799 if (common_config('site', 'private')) {
2808 static function fillProfiles($notices)
2810 $map = self::getProfiles($notices);
2811 foreach ($notices as $entry=>$notice) {
2813 if (array_key_exists($notice->profile_id, $map)) {
2814 $notice->_setProfile($map[$notice->profile_id]);
2816 } catch (NoProfileException $e) {
2817 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2818 unset($notices[$entry]);
2822 return array_values($map);
2825 static function getProfiles(&$notices)
2828 foreach ($notices as $notice) {
2829 $ids[] = $notice->profile_id;
2831 $ids = array_unique($ids);
2832 return Profile::pivotGet('id', $ids);
2835 static function fillGroups(&$notices)
2837 $ids = self::_idsOf($notices);
2838 $gis = Group_inbox::listGet('notice_id', $ids);
2841 foreach ($gis as $id => $gi) {
2844 $gids[] = $g->group_id;
2848 $gids = array_unique($gids);
2849 $group = User_group::pivotGet('id', $gids);
2850 foreach ($notices as $notice)
2853 $gi = $gis[$notice->id];
2854 foreach ($gi as $g) {
2855 $grps[] = $group[$g->group_id];
2857 $notice->_setGroups($grps);
2861 static function _idsOf(array &$notices)
2864 foreach ($notices as $notice) {
2865 $ids[$notice->id] = true;
2867 return array_keys($ids);
2870 static function fillAttachments(&$notices)
2872 $ids = self::_idsOf($notices);
2873 $f2pMap = File_to_post::listGet('post_id', $ids);
2875 foreach ($f2pMap as $noticeId => $f2ps) {
2876 foreach ($f2ps as $f2p) {
2877 $fileIds[] = $f2p->file_id;
2881 $fileIds = array_unique($fileIds);
2882 $fileMap = File::pivotGet('id', $fileIds);
2883 foreach ($notices as $notice)
2886 $f2ps = $f2pMap[$notice->id];
2887 foreach ($f2ps as $f2p) {
2888 $files[] = $fileMap[$f2p->file_id];
2890 $notice->_setAttachments($files);
2894 static function fillReplies(&$notices)
2896 $ids = self::_idsOf($notices);
2897 $replyMap = Reply::listGet('notice_id', $ids);
2898 foreach ($notices as $notice) {
2899 $replies = $replyMap[$notice->id];
2901 foreach ($replies as $reply) {
2902 $ids[] = $reply->profile_id;
2904 $notice->_setReplies($ids);
2908 protected $_repeats = array();
2910 function getRepeats()
2912 if (isset($this->_repeats[$this->id])) {
2913 return $this->_repeats[$this->id];
2915 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2916 $this->_repeats[$this->id] = $repeatMap[$this->id];
2917 return $this->_repeats[$this->id];
2920 function _setRepeats($repeats)
2922 $this->_repeats[$this->id] = $repeats;
2925 static function fillRepeats(&$notices)
2927 $ids = self::_idsOf($notices);
2928 $repeatMap = Notice::listGet('repeat_of', $ids);
2929 foreach ($notices as $notice) {
2930 $repeats = $repeatMap[$notice->id];
2931 $notice->_setRepeats($repeats);