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);
316 public static function getById($id)
318 $notice = new Notice();
320 if (!$notice->find(true)) {
321 throw new NoResultException($notice);
327 * Extract #hashtags from this notice's content and save them to the database.
331 /* extract all #hastags */
332 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
337 /* Add them to the database */
338 return $this->saveKnownTags($match[1]);
342 * Record the given set of hash tags in the db for this notice.
343 * Given tag strings will be normalized and checked for dupes.
345 function saveKnownTags($hashtags)
347 //turn each into their canonical tag
348 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
349 for($i=0; $i<count($hashtags); $i++) {
350 /* elide characters we don't want in the tag */
351 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
354 foreach(array_unique($hashtags) as $hashtag) {
355 $this->saveTag($hashtag);
356 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
362 * Record a single hash tag as associated with this notice.
363 * Tag format and uniqueness must be validated by caller.
365 function saveTag($hashtag)
367 $tag = new Notice_tag();
368 $tag->notice_id = $this->id;
369 $tag->tag = $hashtag;
370 $tag->created = $this->created;
371 $id = $tag->insert();
374 // TRANS: Server exception. %s are the error details.
375 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
376 $last_error->message));
380 // if it's saved, blow its cache
381 $tag->blowCache(false);
385 * Save a new notice and push it out to subscribers' inboxes.
386 * Poster's permissions are checked before sending.
388 * @param int $profile_id Profile ID of the poster
389 * @param string $content source message text; links may be shortened
390 * per current user's preference
391 * @param string $source source key ('web', 'api', etc)
392 * @param array $options Associative array of optional properties:
393 * string 'created' timestamp of notice; defaults to now
394 * int 'is_local' source/gateway ID, one of:
395 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
396 * Notice::REMOTE - Sent from a remote service;
397 * hide from public timeline but show in
398 * local "and friends" timelines
399 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
400 * Notice::GATEWAY - From another non-OStatus service;
401 * will not appear in public views
402 * float 'lat' decimal latitude for geolocation
403 * float 'lon' decimal longitude for geolocation
404 * int 'location_id' geoname identifier
405 * int 'location_ns' geoname namespace to interpret location_id
406 * int 'reply_to'; notice ID this is a reply to
407 * int 'repeat_of'; notice ID this is a repeat of
408 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
409 * string 'url' permalink to notice; defaults to local notice URL
410 * string 'rendered' rendered HTML version of content
411 * array 'replies' list of profile URIs for reply delivery in
412 * place of extracting @-replies from content.
413 * array 'groups' list of group IDs to deliver to, in place of
414 * extracting ! tags from content
415 * array 'tags' list of hashtag strings to save with the notice
416 * in place of extracting # tags from content
417 * array 'urls' list of attached/referred URLs to save with the
418 * notice in place of extracting links from content
419 * boolean 'distribute' whether to distribute the notice, default true
420 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
421 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
422 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
424 * @fixme tag override
427 * @throws ClientException
429 static function saveNew($profile_id, $content, $source, array $options=null) {
430 $defaults = array('uri' => null,
432 'conversation' => null, // URI of conversation
433 'reply_to' => null, // This will override convo URI if the parent is known
434 'repeat_of' => null, // This will override convo URI if the repeated notice is known
436 'distribute' => true,
437 'object_type' => null,
440 if (!empty($options) && is_array($options)) {
441 $options = array_merge($defaults, $options);
447 if (!isset($is_local)) {
448 $is_local = Notice::LOCAL_PUBLIC;
451 $profile = Profile::getKV('id', $profile_id);
452 if (!$profile instanceof Profile) {
453 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
454 throw new ClientException(_('Problem saving notice. Unknown user.'));
457 $user = User::getKV('id', $profile_id);
458 if ($user instanceof User) {
459 // Use the local user's shortening preferences, if applicable.
460 $final = $user->shortenLinks($content);
462 $final = common_shorten_links($content);
465 if (Notice::contentTooLong($final)) {
466 // TRANS: Client exception thrown if a notice contains too many characters.
467 throw new ClientException(_('Problem saving notice. Too long.'));
470 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
471 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
472 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
473 throw new ClientException(_('Too many notices too fast; take a breather '.
474 'and post again in a few minutes.'));
477 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
478 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
479 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
480 throw new ClientException(_('Too many duplicate messages too quickly;'.
481 ' take a breather and post again in a few minutes.'));
484 if (!$profile->hasRight(Right::NEWNOTICE)) {
485 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
487 // TRANS: Client exception thrown when a user tries to post while being banned.
488 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
491 $notice = new Notice();
492 $notice->profile_id = $profile_id;
494 $autosource = common_config('public', 'autosource');
496 // Sandboxed are non-false, but not 1, either
498 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
499 ($source && $autosource && in_array($source, $autosource))) {
500 $notice->is_local = Notice::LOCAL_NONPUBLIC;
502 $notice->is_local = $is_local;
505 if (!empty($created)) {
506 $notice->created = $created;
508 $notice->created = common_sql_now();
511 if (!$notice->isLocal()) {
512 // Only do these checks for non-local notices. Local notices will generate these values later.
513 if (!common_valid_http_url($url)) {
514 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
517 throw new ServerException('No URI for remote notice. Cannot accept that.');
521 $notice->content = $final;
523 $notice->source = $source;
527 // Get the groups here so we can figure out replies and such
528 if (!isset($groups)) {
529 $groups = User_group::idsFromText($notice->content, $profile);
534 // Handle repeat case
536 if (isset($repeat_of)) {
538 // Check for a private one
540 $repeat = Notice::getKV('id', $repeat_of);
542 if (!($repeat instanceof Notice)) {
543 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
544 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
547 if ($profile->id == $repeat->profile_id) {
548 // TRANS: Client error displayed when trying to repeat an own notice.
549 throw new ClientException(_('You cannot repeat your own notice.'));
552 if ($repeat->scope != Notice::SITE_SCOPE &&
553 $repeat->scope != Notice::PUBLIC_SCOPE) {
554 // TRANS: Client error displayed when trying to repeat a non-public notice.
555 throw new ClientException(_('Cannot repeat a private notice.'), 403);
558 if (!$repeat->inScope($profile)) {
559 // The generic checks above should cover this, but let's be sure!
560 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
561 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
564 if ($profile->hasRepeated($repeat)) {
565 // TRANS: Client error displayed when trying to repeat an already repeated notice.
566 throw new ClientException(_('You already repeated that notice.'));
569 $notice->repeat_of = $repeat->id;
570 $notice->conversation = $repeat->conversation;
574 // If $reply_to is specified, we check that it exists, and then
575 // return it if it does
576 if (!empty($reply_to)) {
577 $reply = Notice::getKV('id', $reply_to);
578 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
579 // If the source lacks capability of sending the "reply_to"
580 // metadata, let's try to find an inline replyto-reference.
581 $reply = self::getInlineReplyTo($profile, $final);
584 if ($reply instanceof Notice) {
585 if (!$reply->inScope($profile)) {
586 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
587 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
588 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
589 $profile->nickname, $reply->id), 403);
592 // If it's a repeat, the reply_to should be to the original
593 if ($reply->isRepeat()) {
594 $notice->reply_to = $reply->repeat_of;
596 $notice->reply_to = $reply->id;
598 // But the conversation ought to be the same :)
599 $notice->conversation = $reply->conversation;
601 // If the original is private to a group, and notice has
602 // no group specified, make it to the same group(s)
604 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
606 $replyGroups = $reply->getGroups();
607 foreach ($replyGroups as $group) {
608 if ($profile->isMember($group)) {
609 $groups[] = $group->id;
617 // If we don't know the reply, we might know the conversation!
618 // This will happen if a known remote user replies to an
619 // unknown remote user - within a known conversation.
620 if (empty($notice->conversation) and !empty($options['conversation'])) {
621 $conv = Conversation::getKV('uri', $options['conversation']);
622 if ($conv instanceof Conversation) {
623 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.').');
624 $notice->conversation = $conv->id;
626 // Conversation URI was not found, so we must create it. But we can't create it
627 // until we have a Notice ID because of the database layout...
628 $notice->tmp_conv_uri = $options['conversation'];
631 // If we're not using the attached conversation URI let's remove it
632 // so we don't mistake ourselves later, when creating our own Conversation.
633 // This implies that the notice knows which conversation it belongs to.
634 $options['conversation'] = null;
638 if (!empty($lat) && !empty($lon)) {
643 if (!empty($location_ns) && !empty($location_id)) {
644 $notice->location_id = $location_id;
645 $notice->location_ns = $location_ns;
648 if (!empty($rendered)) {
649 $notice->rendered = $rendered;
651 $notice->rendered = common_render_content($final, $notice);
655 if ($notice->isRepeat()) {
656 $notice->verb = ActivityVerb::SHARE;
657 $notice->object_type = ActivityObject::ACTIVITY;
659 $notice->verb = ActivityVerb::POST;
662 $notice->verb = $verb;
665 if (empty($object_type)) {
666 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
668 $notice->object_type = $object_type;
671 if (is_null($scope) && $reply instanceof Notice) {
672 $notice->scope = $reply->scope;
674 $notice->scope = $scope;
677 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
679 if (Event::handle('StartNoticeSave', array(&$notice))) {
681 // XXX: some of these functions write to the DB
684 $notice->insert(); // throws exception on failure
685 // If it's not part of a conversation, it's
686 // the beginning of a new conversation.
687 if (empty($notice->conversation)) {
688 $orig = clone($notice);
689 // $act->context->conversation will be null if it was not provided
690 $conv = Conversation::create($notice, $options['conversation']);
691 $notice->conversation = $conv->id;
692 $notice->update($orig);
694 } catch (Exception $e) {
695 // Let's test if we managed initial insert, which would imply
696 // failing on some update-part (check 'insert()'). Delete if
697 // something had been stored to the database.
698 if (!empty($notice->id)) {
705 // Clear the cache for subscribed users, so they'll update at next request
706 // XXX: someone clever could prepend instead of clearing the cache
708 // Save per-notice metadata...
710 if (isset($replies)) {
711 $notice->saveKnownReplies($replies);
713 $notice->saveReplies();
717 $notice->saveKnownTags($tags);
722 // Note: groups may save tags, so must be run after tags are saved
723 // to avoid errors on duplicates.
724 // Note: groups should always be set.
726 $notice->saveKnownGroups($groups);
729 $notice->saveKnownUrls($urls);
735 // Prepare inbox delivery, may be queued to background.
736 $notice->distribute();
742 static function saveActivity(Activity $act, Profile $actor, array $options=array())
744 // First check if we're going to let this Activity through from the specific actor
745 if (!$actor->hasRight(Right::NEWNOTICE)) {
746 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
748 // TRANS: Client exception thrown when a user tries to post while being banned.
749 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
751 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
752 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
753 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
754 throw new ClientException(_m('Too many notices too fast; take a breather '.
755 'and post again in a few minutes.'));
758 // Get ActivityObject properties
759 if (!empty($act->id)) {
761 $options['uri'] = $act->id;
762 $options['url'] = $act->link;
764 $actobj = count($act->objects)==1 ? $act->objects[0] : null;
765 if (!is_null($actobj) && !empty($actobj->id)) {
766 $options['uri'] = $actobj->id;
768 $options['url'] = $actobj->link;
769 } elseif (preg_match('!^https?://!', $actobj->id)) {
770 $options['url'] = $actobj->id;
777 'is_local' => self::LOCAL_PUBLIC,
778 'mentions' => array(),
782 'source' => 'unknown',
787 'distribute' => true);
789 // options will have default values when nothing has been supplied
790 $options = array_merge($defaults, $options);
791 foreach (array_keys($defaults) as $key) {
792 // Only convert the keynames we specify ourselves from 'defaults' array into variables
793 $$key = $options[$key];
795 extract($options, EXTR_SKIP);
797 $stored = new Notice();
800 if ($stored->find()) {
801 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
802 throw new Exception('Notice URI already exists');
806 $stored->profile_id = $actor->id;
807 $stored->source = $source;
810 $stored->verb = $act->verb;
812 // Use the local user's shortening preferences, if applicable.
813 $stored->rendered = $actor->isLocal()
814 ? $actor->shortenLinks($act->content)
816 $stored->content = common_strip_html($stored->rendered);
818 $autosource = common_config('public', 'autosource');
820 // Sandboxed are non-false, but not 1, either
821 if (!$actor->hasRight(Right::PUBLICNOTICE) ||
822 ($source && $autosource && in_array($source, $autosource))) {
823 $stored->is_local = Notice::LOCAL_NONPUBLIC;
826 // Maybe a missing act-time should be fatal if the actor is not local?
827 if (!empty($act->time)) {
828 $stored->created = common_sql_date($act->time);
830 $stored->created = common_sql_now();
834 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
835 $reply = self::getKV('uri', $act->context->replyToID);
837 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
838 $reply = self::getKV('uri', $act->target->id);
841 if ($reply instanceof Notice) {
842 if (!$reply->inScope($actor)) {
843 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
844 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
845 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
848 $stored->reply_to = $reply->id;
849 $stored->conversation = $reply->conversation;
851 // If the original is private to a group, and notice has no group specified,
852 // make it to the same group(s)
853 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
855 $replyGroups = $reply->getGroups();
856 foreach ($replyGroups as $group) {
857 if ($actor->isMember($group)) {
858 $groups[] = $group->id;
863 if (is_null($scope)) {
864 $scope = $reply->scope;
868 if ($act->context instanceof ActivityContext) {
869 $location = $act->context->location;
871 $stored->lat = $location->lat;
872 $stored->lon = $location->lon;
873 if ($location->location_id) {
874 $stored->location_ns = $location->location_ns;
875 $stored->location_id = $location->location_id;
879 $act->context = new ActivityContext();
882 $stored->scope = self::figureOutScope($actor, $groups, $scope);
884 foreach ($act->categories as $cat) {
886 $term = common_canonical_tag($cat->term);
893 foreach ($act->enclosures as $href) {
894 // @todo FIXME: Save these locally or....?
898 if (Event::handle('StartNoticeSave', array(&$stored))) {
899 // XXX: some of these functions write to the DB
902 $stored->insert(); // throws exception on error
903 $orig = clone($stored); // for updating later in this try clause
905 // If it's not part of a conversation, it's
906 // the beginning of a new conversation.
907 if (empty($stored->conversation)) {
908 // $act->context->conversation will be null if it was not provided
909 $conv = Conversation::create($stored, $act->context->conversation);
910 $stored->conversation = $conv->id;
914 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
915 if (empty($object)) {
916 throw new ServerException('No object from StoreActivityObject '.$stored->uri . ': '.$act->asString());
918 $stored->object_type = ActivityUtils::resolveUri($object->getObjectType(), true);
919 $stored->update($orig);
920 } catch (Exception $e) {
921 if (empty($stored->id)) {
922 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
924 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
930 if (!$stored instanceof Notice) {
931 throw new ServerException('StartNoticeSave did not give back a Notice');
934 // Save per-notice metadata...
938 // This event lets plugins filter out non-local recipients (attentions we don't care about)
939 // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway)
940 Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups));
942 if (!empty($mentions)) {
943 $stored->saveKnownReplies($mentions);
945 $stored->saveReplies();
949 $stored->saveKnownTags($tags);
954 // Note: groups may save tags, so must be run after tags are saved
955 // to avoid errors on duplicates.
956 // Note: groups should always be set.
958 $stored->saveKnownGroups($groups);
961 $stored->saveKnownUrls($urls);
967 // Prepare inbox delivery, may be queued to background.
968 $stored->distribute();
974 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
975 if (is_null($scope)) {
976 $scope = self::defaultScope();
979 // For private streams
981 $user = $actor->getUser();
982 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
983 if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) {
984 $scope |= Notice::FOLLOWER_SCOPE;
986 } catch (NoSuchUserException $e) {
987 // TODO: Not a local user, so we don't know about scope preferences... yet!
990 // Force the scope for private groups
991 foreach ($groups as $group_id) {
992 $group = User_group::staticGet('id', $group_id);
993 if ($group instanceof User_group) {
994 if ($group->force_scope) {
995 $scope |= Notice::GROUP_SCOPE;
1004 function blowOnInsert($conversation = false)
1006 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1008 if ($this->isPublic()) {
1009 $this->blowStream('public');
1010 $this->blowStream('networkpublic');
1013 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1014 self::blow('conversation:notice_count:%d', $this->conversation);
1016 if ($this->isRepeat()) {
1017 // XXX: we should probably only use one of these
1018 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1019 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1022 $original = Notice::getKV('id', $this->repeat_of);
1024 if ($original instanceof Notice) {
1025 $originalUser = User::getKV('id', $original->profile_id);
1026 if ($originalUser instanceof User) {
1027 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1031 $profile = Profile::getKV($this->profile_id);
1033 if ($profile instanceof Profile) {
1034 $profile->blowNoticeCount();
1037 $ptags = $this->getProfileTags();
1038 foreach ($ptags as $ptag) {
1039 $ptag->blowNoticeStreamCache();
1044 * Clear cache entries related to this notice at delete time.
1045 * Necessary to avoid breaking paging on public, profile timelines.
1047 function blowOnDelete()
1049 $this->blowOnInsert();
1051 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1053 if ($this->isPublic()) {
1054 self::blow('public;last');
1055 self::blow('networkpublic;last');
1058 self::blow('fave:by_notice', $this->id);
1060 if ($this->conversation) {
1061 // In case we're the first, will need to calc a new root.
1062 self::blow('notice:conversation_root:%d', $this->conversation);
1065 $ptags = $this->getProfileTags();
1066 foreach ($ptags as $ptag) {
1067 $ptag->blowNoticeStreamCache(true);
1071 function blowStream()
1073 $c = self::memcache();
1079 $args = func_get_args();
1080 $format = array_shift($args);
1081 $keyPart = vsprintf($format, $args);
1082 $cacheKey = Cache::key($keyPart);
1083 $c->delete($cacheKey);
1085 // delete the "last" stream, too, if this notice is
1086 // older than the top of that stream
1088 $lastKey = $cacheKey.';last';
1090 $lastStr = $c->get($lastKey);
1092 if ($lastStr !== false) {
1093 $window = explode(',', $lastStr);
1094 $lastID = $window[0];
1095 $lastNotice = Notice::getKV('id', $lastID);
1096 if (!$lastNotice instanceof Notice // just weird
1097 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1098 $c->delete($lastKey);
1103 /** save all urls in the notice to the db
1105 * follow redirects and save all available file information
1106 * (mimetype, date, size, oembed, etc.)
1110 function saveUrls() {
1111 if (common_config('attachments', 'process_links')) {
1112 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
1117 * Save the given URLs as related links/attachments to the db
1119 * follow redirects and save all available file information
1120 * (mimetype, date, size, oembed, etc.)
1124 function saveKnownUrls($urls)
1126 if (common_config('attachments', 'process_links')) {
1127 // @fixme validation?
1128 foreach (array_unique($urls) as $url) {
1130 File::processNew($url, $this->id);
1131 } catch (ServerException $e) {
1132 // Could not save URL. Log it?
1141 function saveUrl($url, $notice_id) {
1143 File::processNew($url, $notice_id);
1144 } catch (ServerException $e) {
1145 // Could not save URL. Log it?
1149 static function checkDupes($profile_id, $content) {
1150 $profile = Profile::getKV($profile_id);
1151 if (!$profile instanceof Profile) {
1154 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1155 if (!empty($notice)) {
1157 while ($notice->fetch()) {
1158 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1160 } else if ($notice->content == $content) {
1165 // If we get here, oldest item in cache window is not
1166 // old enough for dupe limit; do direct check against DB
1167 $notice = new Notice();
1168 $notice->profile_id = $profile_id;
1169 $notice->content = $content;
1170 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1171 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1173 $cnt = $notice->count();
1177 static function checkEditThrottle($profile_id) {
1178 $profile = Profile::getKV($profile_id);
1179 if (!$profile instanceof Profile) {
1182 // Get the Nth notice
1183 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1184 if ($notice && $notice->fetch()) {
1185 // If the Nth notice was posted less than timespan seconds ago
1186 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1191 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1195 protected $_attachments = array();
1197 function attachments() {
1198 if (isset($this->_attachments[$this->id])) {
1199 return $this->_attachments[$this->id];
1202 $f2ps = File_to_post::listGet('post_id', array($this->id));
1204 foreach ($f2ps[$this->id] as $f2p) {
1205 $ids[] = $f2p->file_id;
1208 $files = File::multiGet('id', $ids);
1209 $this->_attachments[$this->id] = $files->fetchAll();
1210 return $this->_attachments[$this->id];
1213 function _setAttachments($attachments)
1215 $this->_attachments[$this->id] = $attachments;
1218 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
1220 $stream = new PublicNoticeStream();
1221 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1225 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
1227 $stream = new ConversationNoticeStream($id);
1229 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1233 * Is this notice part of an active conversation?
1235 * @return boolean true if other messages exist in the same
1236 * conversation, false if this is the only one
1238 function hasConversation()
1240 if (!empty($this->conversation)) {
1241 $conversation = Notice::conversationStream(
1242 $this->conversation,
1247 if ($conversation->N > 0) {
1255 * Grab the earliest notice from this conversation.
1257 * @return Notice or null
1259 function conversationRoot($profile=-1)
1261 // XXX: can this happen?
1263 if (empty($this->conversation)) {
1267 // Get the current profile if not specified
1269 if (is_int($profile) && $profile == -1) {
1270 $profile = Profile::current();
1273 // If this notice is out of scope, no root for you!
1275 if (!$this->inScope($profile)) {
1279 // If this isn't a reply to anything, then it's its own
1280 // root if it's the earliest notice in the conversation:
1282 if (empty($this->reply_to)) {
1284 $root->conversation = $this->conversation;
1285 $root->orderBy('notice.created ASC');
1292 if (is_null($profile)) {
1293 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1295 $keypart = sprintf('notice:conversation_root:%d:%d',
1300 $root = self::cacheGet($keypart);
1302 if ($root !== false && $root->inScope($profile)) {
1309 $parent = $last->getParent();
1310 if ($parent->inScope($profile)) {
1314 } catch (Exception $e) {
1315 // Latest notice has no parent
1317 // No parent, or parent out of scope
1322 self::cacheSet($keypart, $root);
1328 * Pull up a full list of local recipients who will be getting
1329 * this notice in their inbox. Results will be cached, so don't
1330 * change the input data wily-nilly!
1332 * @param array $groups optional list of Group objects;
1333 * if left empty, will be loaded from group_inbox records
1334 * @param array $recipient optional list of reply profile ids
1335 * if left empty, will be loaded from reply records
1336 * @return array associating recipient user IDs with an inbox source constant
1338 function whoGets(array $groups=null, array $recipients=null)
1340 $c = self::memcache();
1343 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1344 if ($ni !== false) {
1349 if (is_null($recipients)) {
1350 $recipients = $this->getReplies();
1355 // Give plugins a chance to add folks in at start...
1356 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1358 $users = $this->getSubscribedUsers();
1359 foreach ($users as $id) {
1360 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1363 if (is_null($groups)) {
1364 $groups = $this->getGroups();
1366 foreach ($groups as $group) {
1367 $users = $group->getUserMembers();
1368 foreach ($users as $id) {
1369 if (!array_key_exists($id, $ni)) {
1370 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1375 $ptAtts = $this->getAttentionsFromProfileTags();
1376 foreach ($ptAtts as $key=>$val) {
1377 if (!array_key_exists($key, $ni)) {
1382 foreach ($recipients as $recipient) {
1383 if (!array_key_exists($recipient, $ni)) {
1384 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1388 // Exclude any deleted, non-local, or blocking recipients.
1389 $profile = $this->getProfile();
1390 $originalProfile = null;
1391 if ($this->isRepeat()) {
1392 // Check blocks against the original notice's poster as well.
1393 $original = Notice::getKV('id', $this->repeat_of);
1394 if ($original instanceof Notice) {
1395 $originalProfile = $original->getProfile();
1399 foreach ($ni as $id => $source) {
1401 $user = User::getKV('id', $id);
1402 if (!$user instanceof User ||
1403 $user->hasBlocked($profile) ||
1404 ($originalProfile && $user->hasBlocked($originalProfile))) {
1407 } catch (UserNoProfileException $e) {
1408 // User doesn't have a profile; invalid; skip them.
1413 // Give plugins a chance to filter out...
1414 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1418 // XXX: pack this data better
1419 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1425 function getSubscribedUsers()
1429 if(common_config('db','quote_identifiers'))
1430 $user_table = '"user"';
1431 else $user_table = 'user';
1435 'FROM '. $user_table .' JOIN subscription '.
1436 'ON '. $user_table .'.id = subscription.subscriber ' .
1437 'WHERE subscription.subscribed = %d ';
1439 $user->query(sprintf($qry, $this->profile_id));
1443 while ($user->fetch()) {
1452 function getProfileTags()
1454 $profile = $this->getProfile();
1455 $list = $profile->getOtherTags($profile);
1458 while($list->fetch()) {
1459 $ptags[] = clone($list);
1465 public function getAttentionsFromProfileTags()
1468 $ptags = $this->getProfileTags();
1469 foreach ($ptags as $ptag) {
1470 $users = $ptag->getUserSubscribers();
1471 foreach ($users as $id) {
1472 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1479 * Record this notice to the given group inboxes for delivery.
1480 * Overrides the regular parsing of !group markup.
1482 * @param string $group_ids
1483 * @fixme might prefer URIs as identifiers, as for replies?
1484 * best with generalizations on user_group to support
1485 * remote groups better.
1487 function saveKnownGroups($group_ids)
1489 if (!is_array($group_ids)) {
1490 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1491 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1495 foreach (array_unique($group_ids) as $id) {
1496 $group = User_group::getKV('id', $id);
1497 if ($group instanceof User_group) {
1498 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1499 $result = $this->addToGroupInbox($group);
1501 common_log_db_error($gi, 'INSERT', __FILE__);
1504 if (common_config('group', 'addtag')) {
1505 // we automatically add a tag for every group name, too
1507 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1508 'notice_id' => $this->id));
1510 if (is_null($tag)) {
1511 $this->saveTag($group->nickname);
1515 $groups[] = clone($group);
1517 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1524 function addToGroupInbox(User_group $group)
1526 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1527 'notice_id' => $this->id));
1529 if (!$gi instanceof Group_inbox) {
1531 $gi = new Group_inbox();
1533 $gi->group_id = $group->id;
1534 $gi->notice_id = $this->id;
1535 $gi->created = $this->created;
1537 $result = $gi->insert();
1540 common_log_db_error($gi, 'INSERT', __FILE__);
1541 // TRANS: Server exception thrown when an update for a group inbox fails.
1542 throw new ServerException(_('Problem saving group inbox.'));
1545 self::blow('user_group:notice_ids:%d', $gi->group_id);
1552 * Save reply records indicating that this notice needs to be
1553 * delivered to the local users with the given URIs.
1555 * Since this is expected to be used when saving foreign-sourced
1556 * messages, we won't deliver to any remote targets as that's the
1557 * source service's responsibility.
1559 * Mail notifications etc will be handled later.
1561 * @param array $uris Array of unique identifier URIs for recipients
1563 function saveKnownReplies(array $uris)
1569 $sender = Profile::getKV($this->profile_id);
1571 foreach (array_unique($uris) as $uri) {
1573 $profile = Profile::fromUri($uri);
1574 } catch (UnknownUriException $e) {
1575 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1579 if ($profile->hasBlocked($sender)) {
1580 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1584 $this->saveReply($profile->id);
1585 self::blow('reply:stream:%d', $profile->id);
1592 * Pull @-replies from this message's content in StatusNet markup format
1593 * and save reply records indicating that this message needs to be
1594 * delivered to those users.
1596 * Mail notifications to local profiles will be sent later.
1598 * @return array of integer profile IDs
1601 function saveReplies()
1603 // Don't save reply data for repeats
1605 if ($this->isRepeat()) {
1609 $sender = $this->getProfile();
1613 // If it's a reply, save for the replied-to author
1615 $parent = $this->getParent();
1616 $parentauthor = $parent->getProfile();
1617 $this->saveReply($parentauthor->id);
1618 $replied[$parentauthor->id] = 1;
1619 self::blow('reply:stream:%d', $parentauthor->id);
1620 } catch (Exception $e) {
1621 // Not a reply, since it has no parent!
1624 // @todo ideally this parser information would only
1625 // be calculated once.
1627 $mentions = common_find_mentions($this->content, $this);
1629 // store replied only for first @ (what user/notice what the reply directed,
1630 // we assume first @ is it)
1632 foreach ($mentions as $mention) {
1634 foreach ($mention['mentioned'] as $mentioned) {
1636 // skip if they're already covered
1638 if (!empty($replied[$mentioned->id])) {
1642 // Don't save replies from blocked profile to local user
1644 $mentioned_user = User::getKV('id', $mentioned->id);
1645 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1649 $this->saveReply($mentioned->id);
1650 $replied[$mentioned->id] = 1;
1651 self::blow('reply:stream:%d', $mentioned->id);
1655 $recipientIds = array_keys($replied);
1657 return $recipientIds;
1660 function saveReply($profileId)
1662 $reply = new Reply();
1664 $reply->notice_id = $this->id;
1665 $reply->profile_id = $profileId;
1666 $reply->modified = $this->created;
1673 protected $_replies = array();
1676 * Pull the complete list of @-reply targets for this notice.
1678 * @return array of integer profile ids
1680 function getReplies()
1682 if (isset($this->_replies[$this->id])) {
1683 return $this->_replies[$this->id];
1686 $replyMap = Reply::listGet('notice_id', array($this->id));
1690 foreach ($replyMap[$this->id] as $reply) {
1691 $ids[] = $reply->profile_id;
1694 $this->_replies[$this->id] = $ids;
1699 function _setReplies($replies)
1701 $this->_replies[$this->id] = $replies;
1705 * Pull the complete list of @-reply targets for this notice.
1707 * @return array of Profiles
1709 function getReplyProfiles()
1711 $ids = $this->getReplies();
1713 $profiles = Profile::multiGet('id', $ids);
1715 return $profiles->fetchAll();
1719 * Send e-mail notifications to local @-reply targets.
1721 * Replies must already have been saved; this is expected to be run
1722 * from the distrib queue handler.
1724 function sendReplyNotifications()
1726 // Don't send reply notifications for repeats
1728 if ($this->isRepeat()) {
1732 $recipientIds = $this->getReplies();
1733 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1734 require_once INSTALLDIR.'/lib/mail.php';
1736 foreach ($recipientIds as $recipientId) {
1737 $user = User::getKV('id', $recipientId);
1738 if ($user instanceof User) {
1739 mail_notify_attn($user, $this);
1742 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1747 * Pull list of groups this notice needs to be delivered to,
1748 * as previously recorded by saveKnownGroups().
1750 * @return array of Group objects
1753 protected $_groups = array();
1755 function getGroups()
1757 // Don't save groups for repeats
1759 if (!empty($this->repeat_of)) {
1763 if (isset($this->_groups[$this->id])) {
1764 return $this->_groups[$this->id];
1767 $gis = Group_inbox::listGet('notice_id', array($this->id));
1771 foreach ($gis[$this->id] as $gi) {
1772 $ids[] = $gi->group_id;
1775 $groups = User_group::multiGet('id', $ids);
1776 $this->_groups[$this->id] = $groups->fetchAll();
1777 return $this->_groups[$this->id];
1780 function _setGroups($groups)
1782 $this->_groups[$this->id] = $groups;
1786 * Convert a notice into an activity for export.
1788 * @param Profile $scoped The currently logged in/scoped profile
1790 * @return Activity activity object representing this Notice.
1793 function asActivity(Profile $scoped=null)
1795 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1797 if ($act instanceof Activity) {
1800 $act = new Activity();
1802 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1804 $act->id = $this->uri;
1805 $act->time = strtotime($this->created);
1807 $act->link = $this->getUrl();
1808 } catch (InvalidUrlException $e) {
1809 // The notice is probably a share or similar, which don't
1810 // have a representational URL of their own.
1812 $act->content = common_xml_safe_str($this->rendered);
1814 $profile = $this->getProfile();
1816 $act->actor = $profile->asActivityObject();
1817 $act->actor->extra[] = $profile->profileInfo($scoped);
1819 $act->verb = $this->verb;
1821 if ($this->repeat_of) {
1822 $repeated = Notice::getKV('id', $this->repeat_of);
1823 if ($repeated instanceof Notice) {
1824 // TRANS: A repeat activity's title. %1$s is repeater's nickname
1825 // and %2$s is the repeated user's nickname.
1826 $act->title = sprintf(_('%1$s repeated a notice by %2$s'),
1827 $this->getProfile()->getNickname(),
1828 $repeated->getProfile()->getNickname());
1829 $act->objects[] = $repeated->asActivity($scoped);
1832 $act->objects[] = $this->asActivityObject();
1835 // XXX: should this be handled by default processing for object entry?
1839 $tags = $this->getTags();
1841 foreach ($tags as $tag) {
1842 $cat = new AtomCategory();
1845 $act->categories[] = $cat;
1849 // XXX: use Atom Media and/or File activity objects instead
1851 $attachments = $this->attachments();
1853 foreach ($attachments as $attachment) {
1854 // Save local attachments
1855 if (!empty($attachment->filename)) {
1856 $act->attachments[] = ActivityObject::fromFile($attachment);
1860 $ctx = new ActivityContext();
1863 $reply = $this->getParent();
1864 $ctx->replyToID = $reply->getUri();
1865 $ctx->replyToUrl = $reply->getUrl();
1866 } catch (Exception $e) {
1867 // This is not a reply to something
1870 $ctx->location = $this->getLocation();
1874 if (!empty($this->conversation)) {
1875 $conv = Conversation::getKV('id', $this->conversation);
1876 if ($conv instanceof Conversation) {
1877 $ctx->conversation = $conv->uri;
1881 $reply_ids = $this->getReplies();
1883 foreach ($reply_ids as $id) {
1884 $rprofile = Profile::getKV('id', $id);
1885 if ($rprofile instanceof Profile) {
1886 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1890 $groups = $this->getGroups();
1892 foreach ($groups as $group) {
1893 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1896 switch ($this->scope) {
1897 case Notice::PUBLIC_SCOPE:
1898 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1900 case Notice::FOLLOWER_SCOPE:
1901 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1902 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1906 $act->context = $ctx;
1908 $source = $this->getSource();
1910 if ($source instanceof Notice_source) {
1911 $act->generator = ActivityObject::fromNoticeSource($source);
1916 $atom_feed = $profile->getAtomFeed();
1918 if (!empty($atom_feed)) {
1920 $act->source = new ActivitySource();
1922 // XXX: we should store the actual feed ID
1924 $act->source->id = $atom_feed;
1926 // XXX: we should store the actual feed title
1928 $act->source->title = $profile->getBestName();
1930 $act->source->links['alternate'] = $profile->profileurl;
1931 $act->source->links['self'] = $atom_feed;
1933 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1935 $notice = $profile->getCurrentNotice();
1937 if ($notice instanceof Notice) {
1938 $act->source->updated = self::utcDate($notice->created);
1941 $user = User::getKV('id', $profile->id);
1943 if ($user instanceof User) {
1944 $act->source->links['license'] = common_config('license', 'url');
1948 if ($this->isLocal()) {
1949 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1950 'format' => 'atom'));
1951 $act->editLink = $act->selfLink;
1954 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
1957 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1962 // This has gotten way too long. Needs to be sliced up into functional bits
1963 // or ideally exported to a utility class.
1965 function asAtomEntry($namespace=false,
1968 Profile $scoped=null)
1970 $act = $this->asActivity($scoped);
1971 $act->extra[] = $this->noticeInfo($scoped);
1972 return $act->asString($namespace, $author, $source);
1976 * Extra notice info for atom entries
1978 * Clients use some extra notice info in the atom stream.
1979 * This gives it to them.
1981 * @param Profile $scoped The currently logged in/scoped profile
1983 * @return array representation of <statusnet:notice_info> element
1986 function noticeInfo(Profile $scoped=null)
1988 // local notice ID (useful to clients for ordering)
1990 $noticeInfoAttr = array('local_id' => $this->id);
1994 $ns = $this->getSource();
1996 if ($ns instanceof Notice_source) {
1997 $noticeInfoAttr['source'] = $ns->code;
1998 if (!empty($ns->url)) {
1999 $noticeInfoAttr['source_link'] = $ns->url;
2000 if (!empty($ns->name)) {
2001 $noticeInfoAttr['source'] = '<a href="'
2002 . htmlspecialchars($ns->url)
2003 . '" rel="nofollow">'
2004 . htmlspecialchars($ns->name)
2010 // favorite and repeated
2012 if ($scoped instanceof Profile) {
2013 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2016 if (!empty($this->repeat_of)) {
2017 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2020 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2022 return array('statusnet:notice_info', $noticeInfoAttr, null);
2026 * Returns an XML string fragment with a reference to a notice as an
2027 * Activity Streams noun object with the given element type.
2029 * Assumes that 'activity' namespace has been previously defined.
2031 * @param string $element one of 'subject', 'object', 'target'
2035 function asActivityNoun($element)
2037 $noun = $this->asActivityObject();
2038 return $noun->asString('activity:' . $element);
2041 public function asActivityObject()
2043 $object = new ActivityObject();
2045 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2046 $object->type = $this->object_type ?: ActivityObject::NOTE;
2047 $object->id = $this->getUri();
2048 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2049 $object->content = $this->rendered;
2050 $object->link = $this->getUrl();
2052 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2054 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2061 * Determine which notice, if any, a new notice is in reply to.
2063 * For conversation tracking, we try to see where this notice fits
2064 * in the tree. Beware that this may very well give false positives
2065 * and add replies to wrong threads (if there have been newer posts
2066 * by the same user as we're replying to).
2068 * @param Profile $sender Author profile
2069 * @param string $content Final notice content
2071 * @return integer ID of replied-to notice, or null for not a reply.
2074 static function getInlineReplyTo(Profile $sender, $content)
2076 // Is there an initial @ or T?
2077 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2078 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2079 $nickname = common_canonical_nickname($match[1]);
2084 // Figure out who that is.
2085 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2087 if ($recipient instanceof Profile) {
2088 // Get their last notice
2089 $last = $recipient->getCurrentNotice();
2090 if ($last instanceof Notice) {
2093 // Maybe in the future we want to handle something else below
2094 // so don't return getCurrentNotice() immediately.
2100 static function maxContent()
2102 $contentlimit = common_config('notice', 'contentlimit');
2103 // null => use global limit (distinct from 0!)
2104 if (is_null($contentlimit)) {
2105 $contentlimit = common_config('site', 'textlimit');
2107 return $contentlimit;
2110 static function contentTooLong($content)
2112 $contentlimit = self::maxContent();
2113 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2116 function getLocation()
2120 if (!empty($this->location_id) && !empty($this->location_ns)) {
2121 $location = Location::fromId($this->location_id, $this->location_ns);
2124 if (is_null($location)) { // no ID, or Location::fromId() failed
2125 if (!empty($this->lat) && !empty($this->lon)) {
2126 $location = Location::fromLatLon($this->lat, $this->lon);
2134 * Convenience function for posting a repeat of an existing message.
2136 * @param Profile $repeater Profile which is doing the repeat
2137 * @param string $source: posting source key, eg 'web', 'api', etc
2140 * @throws Exception on failure or permission problems
2142 function repeat(Profile $repeater, $source)
2144 $author = $this->getProfile();
2146 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2147 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2148 $content = sprintf(_('RT @%1$s %2$s'),
2149 $author->getNickname(),
2152 $maxlen = self::maxContent();
2153 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2154 // Web interface and current Twitter API clients will
2155 // pull the original notice's text, but some older
2156 // clients and RSS/Atom feeds will see this trimmed text.
2158 // Unfortunately this is likely to lose tags or URLs
2159 // at the end of long notices.
2160 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2164 // Scope is same as this one's
2165 return self::saveNew($repeater->id,
2168 array('repeat_of' => $this->id,
2169 'scope' => $this->scope));
2172 // These are supposed to be in chron order!
2174 function repeatStream($limit=100)
2176 $cache = Cache::instance();
2178 if (empty($cache)) {
2179 $ids = $this->_repeatStreamDirect($limit);
2181 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2182 if ($idstr !== false) {
2183 if (empty($idstr)) {
2186 $ids = explode(',', $idstr);
2189 $ids = $this->_repeatStreamDirect(100);
2190 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2193 // We do a max of 100, so slice down to limit
2194 $ids = array_slice($ids, 0, $limit);
2198 return NoticeStream::getStreamByIds($ids);
2201 function _repeatStreamDirect($limit)
2203 $notice = new Notice();
2205 $notice->selectAdd(); // clears it
2206 $notice->selectAdd('id');
2208 $notice->repeat_of = $this->id;
2210 $notice->orderBy('created, id'); // NB: asc!
2212 if (!is_null($limit)) {
2213 $notice->limit(0, $limit);
2216 return $notice->fetchAll('id');
2219 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2223 if (!empty($location_id) && !empty($location_ns)) {
2224 $options['location_id'] = $location_id;
2225 $options['location_ns'] = $location_ns;
2227 $location = Location::fromId($location_id, $location_ns);
2229 if ($location instanceof Location) {
2230 $options['lat'] = $location->lat;
2231 $options['lon'] = $location->lon;
2234 } else if (!empty($lat) && !empty($lon)) {
2235 $options['lat'] = $lat;
2236 $options['lon'] = $lon;
2238 $location = Location::fromLatLon($lat, $lon);
2240 if ($location instanceof Location) {
2241 $options['location_id'] = $location->location_id;
2242 $options['location_ns'] = $location->location_ns;
2244 } else if (!empty($profile)) {
2245 if (isset($profile->lat) && isset($profile->lon)) {
2246 $options['lat'] = $profile->lat;
2247 $options['lon'] = $profile->lon;
2250 if (isset($profile->location_id) && isset($profile->location_ns)) {
2251 $options['location_id'] = $profile->location_id;
2252 $options['location_ns'] = $profile->location_ns;
2259 function clearAttentions()
2261 $att = new Attention();
2262 $att->notice_id = $this->getID();
2265 while ($att->fetch()) {
2266 // Can't do delete() on the object directly since it won't remove all of it
2267 $other = clone($att);
2273 function clearReplies()
2275 $replyNotice = new Notice();
2276 $replyNotice->reply_to = $this->id;
2278 //Null any notices that are replies to this notice
2280 if ($replyNotice->find()) {
2281 while ($replyNotice->fetch()) {
2282 $orig = clone($replyNotice);
2283 $replyNotice->reply_to = null;
2284 $replyNotice->update($orig);
2290 $reply = new Reply();
2291 $reply->notice_id = $this->id;
2293 if ($reply->find()) {
2294 while($reply->fetch()) {
2295 self::blow('reply:stream:%d', $reply->profile_id);
2303 function clearFiles()
2305 $f2p = new File_to_post();
2307 $f2p->post_id = $this->id;
2310 while ($f2p->fetch()) {
2314 // FIXME: decide whether to delete File objects
2315 // ...and related (actual) files
2318 function clearRepeats()
2320 $repeatNotice = new Notice();
2321 $repeatNotice->repeat_of = $this->id;
2323 //Null any notices that are repeats of this notice
2325 if ($repeatNotice->find()) {
2326 while ($repeatNotice->fetch()) {
2327 $orig = clone($repeatNotice);
2328 $repeatNotice->repeat_of = null;
2329 $repeatNotice->update($orig);
2334 function clearTags()
2336 $tag = new Notice_tag();
2337 $tag->notice_id = $this->id;
2340 while ($tag->fetch()) {
2341 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2342 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2343 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2344 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2352 function clearGroupInboxes()
2354 $gi = new Group_inbox();
2356 $gi->notice_id = $this->id;
2359 while ($gi->fetch()) {
2360 self::blow('user_group:notice_ids:%d', $gi->group_id);
2368 function distribute()
2370 // We always insert for the author so they don't
2372 Event::handle('StartNoticeDistribute', array($this));
2374 // If there's a failure, we want to _force_
2375 // distribution at this point.
2377 $qm = QueueManager::get();
2378 $qm->enqueue($this, 'distrib');
2379 } catch (Exception $e) {
2380 // If the exception isn't transient, this
2381 // may throw more exceptions as DQH does
2382 // its own enqueueing. So, we ignore them!
2384 $handler = new DistribQueueHandler();
2385 $handler->handle($this);
2386 } catch (Exception $e) {
2387 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2389 // Re-throw so somebody smarter can handle it.
2396 $result = parent::insert();
2398 if ($result === false) {
2399 common_log_db_error($this, 'INSERT', __FILE__);
2400 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2401 throw new ServerException('Could not save Notice');
2404 // Profile::hasRepeated() abuses pkeyGet(), so we
2405 // have to clear manually
2406 if (!empty($this->repeat_of)) {
2407 $c = self::memcache();
2409 $ck = self::multicacheKey('Notice',
2410 array('profile_id' => $this->profile_id,
2411 'repeat_of' => $this->repeat_of));
2416 // Update possibly ID-dependent columns: URI, conversation
2417 // (now that INSERT has added the notice's local id)
2418 $orig = clone($this);
2421 // We can only get here if it's a local notice, since remote notices
2422 // should've bailed out earlier due to lacking a URI.
2423 if (empty($this->uri)) {
2424 $this->uri = sprintf('%s%s=%d:%s=%s',
2426 'noticeId', $this->id,
2427 'objectType', $this->get_object_type(true));
2431 if ($changed && $this->update($orig) === false) {
2432 common_log_db_error($notice, 'UPDATE', __FILE__);
2433 // TRANS: Server exception thrown when a notice cannot be updated.
2434 throw new ServerException(_('Problem saving notice.'));
2437 $this->blowOnInsert();
2443 * Get the source of the notice
2445 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2446 * guaranteed to be populated.
2448 function getSource()
2450 if (empty($this->source)) {
2454 $ns = new Notice_source();
2455 switch ($this->source) {
2462 $ns->code = $this->source;
2465 $ns = Notice_source::getKV($this->source);
2467 $ns = new Notice_source();
2468 $ns->code = $this->source;
2469 $app = Oauth_application::getKV('name', $this->source);
2471 $ns->name = $app->name;
2472 $ns->url = $app->source_url;
2482 * Determine whether the notice was locally created
2484 * @return boolean locality
2487 public function isLocal()
2489 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2490 $this->is_local == Notice::LOCAL_NONPUBLIC);
2493 public function isRepeat()
2495 return !empty($this->repeat_of);
2499 * Get the list of hash tags saved with this notice.
2501 * @return array of strings
2503 public function getTags()
2507 $keypart = sprintf('notice:tags:%d', $this->id);
2509 $tagstr = self::cacheGet($keypart);
2511 if ($tagstr !== false) {
2512 $tags = explode(',', $tagstr);
2514 $tag = new Notice_tag();
2515 $tag->notice_id = $this->id;
2517 while ($tag->fetch()) {
2518 $tags[] = $tag->tag;
2521 self::cacheSet($keypart, implode(',', $tags));
2527 static private function utcDate($dt)
2529 $dateStr = date('d F Y H:i:s', strtotime($dt));
2530 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2531 return $d->format(DATE_W3C);
2535 * Look up the creation timestamp for a given notice ID, even
2536 * if it's been deleted.
2539 * @return mixed string recorded creation timestamp, or false if can't be found
2541 public static function getAsTimestamp($id)
2547 $notice = Notice::getKV('id', $id);
2549 return $notice->created;
2552 $deleted = Deleted_notice::getKV('id', $id);
2554 return $deleted->created;
2561 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2562 * parameter, matching notices posted after the given one (exclusive).
2564 * If the referenced notice can't be found, will return false.
2567 * @param string $idField
2568 * @param string $createdField
2569 * @return mixed string or false if no match
2571 public static function whereSinceId($id, $idField='id', $createdField='created')
2573 $since = Notice::getAsTimestamp($id);
2575 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2581 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2582 * parameter, matching notices posted after the given one (exclusive), and
2583 * if necessary add it to the data object's query.
2585 * @param DB_DataObject $obj
2587 * @param string $idField
2588 * @param string $createdField
2589 * @return mixed string or false if no match
2591 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2593 $since = self::whereSinceId($id, $idField, $createdField);
2595 $obj->whereAdd($since);
2600 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2601 * parameter, matching notices posted before the given one (inclusive).
2603 * If the referenced notice can't be found, will return false.
2606 * @param string $idField
2607 * @param string $createdField
2608 * @return mixed string or false if no match
2610 public static function whereMaxId($id, $idField='id', $createdField='created')
2612 $max = Notice::getAsTimestamp($id);
2614 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2620 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2621 * parameter, matching notices posted before the given one (inclusive), and
2622 * if necessary add it to the data object's query.
2624 * @param DB_DataObject $obj
2626 * @param string $idField
2627 * @param string $createdField
2628 * @return mixed string or false if no match
2630 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2632 $max = self::whereMaxId($id, $idField, $createdField);
2634 $obj->whereAdd($max);
2640 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2641 ($this->is_local != Notice::GATEWAY));
2645 * Check that the given profile is allowed to read, respond to, or otherwise
2646 * act on this notice.
2648 * The $scope member is a bitmask of scopes, representing a logical AND of the
2649 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2650 * "only visible to people who are mentioned in the notice AND are users on this site."
2651 * Users on the site who are not mentioned in the notice will not be able to see the
2654 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2656 * @return boolean whether the profile is in the notice's scope
2658 function inScope($profile)
2660 if (is_null($profile)) {
2661 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2663 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2666 $result = self::cacheGet($keypart);
2668 if ($result === false) {
2670 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2671 $bResult = $this->_inScope($profile);
2672 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2674 $result = ($bResult) ? 1 : 0;
2675 self::cacheSet($keypart, $result, 0, 300);
2678 return ($result == 1) ? true : false;
2681 protected function _inScope($profile)
2683 if (!is_null($this->scope)) {
2684 $scope = $this->scope;
2686 $scope = self::defaultScope();
2689 if ($scope == 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2690 return !$this->isHiddenSpam($profile);
2693 // If there's scope, anon cannot be in scope
2694 if (empty($profile)) {
2698 // Author is always in scope
2699 if ($this->profile_id == $profile->id) {
2703 // Only for users on this site
2704 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2708 // Only for users mentioned in the notice
2709 if ($scope & Notice::ADDRESSEE_SCOPE) {
2711 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2712 'profile_id' => $profile->id));
2714 if (!$reply instanceof Reply) {
2719 // Only for members of the given group
2720 if ($scope & Notice::GROUP_SCOPE) {
2722 // XXX: just query for the single membership
2724 $groups = $this->getGroups();
2728 foreach ($groups as $group) {
2729 if ($profile->isMember($group)) {
2740 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2742 if (!Subscription::exists($profile, $this->getProfile())) {
2747 return !$this->isHiddenSpam($profile);
2750 function isHiddenSpam($profile) {
2752 // Hide posts by silenced users from everyone but moderators.
2754 if (common_config('notice', 'hidespam')) {
2757 $author = $this->getProfile();
2758 } catch(Exception $e) {
2759 // If we can't get an author, keep it hidden.
2760 // XXX: technically not spam, but, whatever.
2764 if ($author->hasRole(Profile_role::SILENCED)) {
2765 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2774 public function getParent()
2776 $parent = Notice::getKV('id', $this->reply_to);
2778 if (!$parent instanceof Notice) {
2779 throw new ServerException('Notice has no parent');
2786 * Magic function called at serialize() time.
2788 * We use this to drop a couple process-specific references
2789 * from DB_DataObject which can cause trouble in future
2792 * @return array of variable names to include in serialization.
2797 $vars = parent::__sleep();
2798 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2799 return array_diff($vars, $skip);
2802 static function defaultScope()
2804 $scope = common_config('notice', 'defaultscope');
2805 if (is_null($scope)) {
2806 if (common_config('site', 'private')) {
2815 static function fillProfiles($notices)
2817 $map = self::getProfiles($notices);
2818 foreach ($notices as $entry=>$notice) {
2820 if (array_key_exists($notice->profile_id, $map)) {
2821 $notice->_setProfile($map[$notice->profile_id]);
2823 } catch (NoProfileException $e) {
2824 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2825 unset($notices[$entry]);
2829 return array_values($map);
2832 static function getProfiles(&$notices)
2835 foreach ($notices as $notice) {
2836 $ids[] = $notice->profile_id;
2838 $ids = array_unique($ids);
2839 return Profile::pivotGet('id', $ids);
2842 static function fillGroups(&$notices)
2844 $ids = self::_idsOf($notices);
2845 $gis = Group_inbox::listGet('notice_id', $ids);
2848 foreach ($gis as $id => $gi) {
2851 $gids[] = $g->group_id;
2855 $gids = array_unique($gids);
2856 $group = User_group::pivotGet('id', $gids);
2857 foreach ($notices as $notice)
2860 $gi = $gis[$notice->id];
2861 foreach ($gi as $g) {
2862 $grps[] = $group[$g->group_id];
2864 $notice->_setGroups($grps);
2868 static function _idsOf(array &$notices)
2871 foreach ($notices as $notice) {
2872 $ids[$notice->id] = true;
2874 return array_keys($ids);
2877 static function fillAttachments(&$notices)
2879 $ids = self::_idsOf($notices);
2880 $f2pMap = File_to_post::listGet('post_id', $ids);
2882 foreach ($f2pMap as $noticeId => $f2ps) {
2883 foreach ($f2ps as $f2p) {
2884 $fileIds[] = $f2p->file_id;
2888 $fileIds = array_unique($fileIds);
2889 $fileMap = File::pivotGet('id', $fileIds);
2890 foreach ($notices as $notice)
2893 $f2ps = $f2pMap[$notice->id];
2894 foreach ($f2ps as $f2p) {
2895 $files[] = $fileMap[$f2p->file_id];
2897 $notice->_setAttachments($files);
2901 static function fillReplies(&$notices)
2903 $ids = self::_idsOf($notices);
2904 $replyMap = Reply::listGet('notice_id', $ids);
2905 foreach ($notices as $notice) {
2906 $replies = $replyMap[$notice->id];
2908 foreach ($replies as $reply) {
2909 $ids[] = $reply->profile_id;
2911 $notice->_setReplies($ids);
2915 protected $_repeats = array();
2917 function getRepeats()
2919 if (isset($this->_repeats[$this->id])) {
2920 return $this->_repeats[$this->id];
2922 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2923 $this->_repeats[$this->id] = $repeatMap[$this->id];
2924 return $this->_repeats[$this->id];
2927 function _setRepeats($repeats)
2929 $this->_repeats[$this->id] = $repeats;
2932 static function fillRepeats(&$notices)
2934 $ids = self::_idsOf($notices);
2935 $repeatMap = Notice::listGet('repeat_of', $ids);
2936 foreach ($notices as $notice) {
2937 $repeats = $repeatMap[$notice->id];
2938 $notice->_setRepeats($repeats);