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 $repeat_of; // int(4)
69 public $verb; // varchar(191) not 255 because utf8mb4 takes more space
70 public $object_type; // varchar(191) not 255 because utf8mb4 takes more space
71 public $scope; // int(4)
73 /* the code above is auto generated do not remove the tag below */
76 public static function schemaDef()
80 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
81 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
82 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'),
83 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8mb4_general_ci'),
84 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
85 'url' => array('type' => 'varchar', 'length' => 191, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
86 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
87 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
88 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
89 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
90 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
91 'conversation' => array('type' => 'int', 'description' => 'the local numerical conversation id'),
92 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
93 'object_type' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams object type', 'default' => null),
94 'verb' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
95 'scope' => array('type' => 'int',
96 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'),
98 'primary key' => array('id'),
99 'unique keys' => array(
100 'notice_uri_key' => array('uri'),
102 'foreign keys' => array(
103 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
104 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
105 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
106 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
109 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'),
110 'notice_profile_id_idx' => array('profile_id', 'created', 'id'),
111 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
112 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
113 'notice_object_type_idx' => array('object_type'),
114 'notice_verb_idx' => array('verb'),
115 'notice_profile_id_verb_idx' => array('profile_id', 'verb'),
116 'notice_url_idx' => array('url'), // Qvitter wants this
117 'notice_replyto_idx' => array('reply_to')
121 if (common_config('search', 'type') == 'fulltext') {
122 $def['fulltext indexes'] = array('content' => array('content'));
129 const LOCAL_PUBLIC = 1;
131 const LOCAL_NONPUBLIC = -1;
134 const PUBLIC_SCOPE = 0; // Useful fake constant
135 const SITE_SCOPE = 1;
136 const ADDRESSEE_SCOPE = 2;
137 const GROUP_SCOPE = 4;
138 const FOLLOWER_SCOPE = 8;
140 protected $_profile = array();
143 * Will always return a profile, if anything fails it will
144 * (through _setProfile) throw a NoProfileException.
146 public function getProfile()
148 if (!isset($this->_profile[$this->profile_id])) {
149 // We could've sent getKV directly to _setProfile, but occasionally we get
150 // a "false" (instead of null), likely because it indicates a cache miss.
151 $profile = Profile::getKV('id', $this->profile_id);
152 $this->_setProfile($profile instanceof Profile ? $profile : null);
154 return $this->_profile[$this->profile_id];
157 public function _setProfile(Profile $profile=null)
159 if (!$profile instanceof Profile) {
160 throw new NoProfileException($this->profile_id);
162 $this->_profile[$this->profile_id] = $profile;
165 public function deleteAs(Profile $actor, $delete_event=true)
167 if (!$this->getProfile()->sameAs($actor) && !$actor->hasRight(Right::DELETEOTHERSNOTICE)) {
168 throw new AuthorizationException(_('You are not allowed to delete another user\'s notice.'));
172 if (!$delete_event || Event::handle('DeleteNoticeAsProfile', array($this, $actor, &$result))) {
173 // If $delete_event is true, we run the event. If the Event then
174 // returns false it is assumed everything was handled properly
175 // and the notice was deleted.
176 $result = $this->delete();
181 protected function deleteRelated()
183 if (Event::handle('NoticeDeleteRelated', array($this))) {
184 // Clear related records
185 $this->clearReplies();
186 $this->clearLocation();
187 $this->clearRepeats();
189 $this->clearGroupInboxes();
191 $this->clearAttentions();
192 // NOTE: we don't clear queue items
196 public function delete($useWhere=false)
198 $this->deleteRelated();
200 $result = parent::delete($useWhere);
202 $this->blowOnDelete();
206 public function getUri()
212 * Get a Notice object by URI. Will call external plugins for help
213 * using the event StartGetNoticeFromURI.
215 * @param string $uri A unique identifier for a resource (notice in this case)
217 static function fromUri($uri)
221 if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
222 $notice = Notice::getKV('uri', $uri);
223 Event::handle('EndGetNoticeFromUri', array($uri, $notice));
226 if (!$notice instanceof Notice) {
227 throw new UnknownUriException($uri);
234 * @param $root boolean If true, link to just the conversation root.
236 * @return URL to conversation
238 public function getConversationUrl($anchor=true)
240 return Conversation::getUrlFromNotice($this, $anchor);
244 * Get the local representation URL of this notice.
246 public function getLocalUrl()
248 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
251 public function getTitle($imply=true)
254 if (Event::handle('GetNoticeTitle', array($this, &$title)) && $imply) {
255 // TRANS: Title of a notice posted without a title value.
256 // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
257 $title = sprintf(_('%1$s\'s status on %2$s'),
258 $this->getProfile()->getFancyName(),
259 common_exact_date($this->created));
264 public function getContent()
266 return $this->content;
269 public function getRendered()
271 // we test $this->id because if it's not inserted yet, we can't update the field
272 if (!empty($this->id) && (is_null($this->rendered) || $this->rendered === '')) {
273 // update to include rendered content on-the-fly, so we don't have to have a fix-up script in upgrade.php
274 common_debug('Rendering notice '.$this->getID().' as it had no rendered HTML content.');
275 $orig = clone($this);
276 $this->rendered = common_render_content($this->getContent(),
278 $this->hasParent() ? $this->getParent() : null);
279 $this->update($orig);
281 return $this->rendered;
284 public function getCreated()
286 return $this->created;
289 public function getVerb($make_relative=false)
291 return ActivityUtils::resolveUri($this->verb, $make_relative);
294 public function isVerb(array $verbs)
296 return ActivityUtils::compareVerbs($this->getVerb(), $verbs);
300 * Get the original representation URL of this notice.
302 * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
304 public function getUrl($fallback=false)
306 // The risk is we start having empty urls and non-http uris...
307 // and we can't really handle any other protocol right now.
309 case $this->isLocal():
310 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
311 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
313 case common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
316 // let's generate a valid link to our locally available notice on demand
317 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
319 throw new InvalidUrlException($this->url);
323 public function getObjectType($canonical=false) {
324 if (is_null($this->object_type) || $this->object_type==='') {
325 throw new NoObjectTypeException($this);
327 return ActivityUtils::resolveUri($this->object_type, $canonical);
330 public function isObjectType(array $types)
333 return ActivityUtils::compareTypes($this->getObjectType(), $types);
334 } catch (NoObjectTypeException $e) {
340 * Extract #hashtags from this notice's content and save them to the database.
344 /* extract all #hastags */
345 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
350 /* Add them to the database */
351 return $this->saveKnownTags($match[1]);
355 * Record the given set of hash tags in the db for this notice.
356 * Given tag strings will be normalized and checked for dupes.
358 function saveKnownTags($hashtags)
360 //turn each into their canonical tag
361 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
362 for($i=0; $i<count($hashtags); $i++) {
363 /* elide characters we don't want in the tag */
364 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
367 foreach(array_unique($hashtags) as $hashtag) {
368 $this->saveTag($hashtag);
369 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
375 * Record a single hash tag as associated with this notice.
376 * Tag format and uniqueness must be validated by caller.
378 function saveTag($hashtag)
380 $tag = new Notice_tag();
381 $tag->notice_id = $this->id;
382 $tag->tag = $hashtag;
383 $tag->created = $this->created;
384 $id = $tag->insert();
387 // TRANS: Server exception. %s are the error details.
388 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
389 $last_error->message));
393 // if it's saved, blow its cache
394 $tag->blowCache(false);
398 * Save a new notice and push it out to subscribers' inboxes.
399 * Poster's permissions are checked before sending.
401 * @param int $profile_id Profile ID of the poster
402 * @param string $content source message text; links may be shortened
403 * per current user's preference
404 * @param string $source source key ('web', 'api', etc)
405 * @param array $options Associative array of optional properties:
406 * string 'created' timestamp of notice; defaults to now
407 * int 'is_local' source/gateway ID, one of:
408 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
409 * Notice::REMOTE - Sent from a remote service;
410 * hide from public timeline but show in
411 * local "and friends" timelines
412 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
413 * Notice::GATEWAY - From another non-OStatus service;
414 * will not appear in public views
415 * float 'lat' decimal latitude for geolocation
416 * float 'lon' decimal longitude for geolocation
417 * int 'location_id' geoname identifier
418 * int 'location_ns' geoname namespace to interpret location_id
419 * int 'reply_to'; notice ID this is a reply to
420 * int 'repeat_of'; notice ID this is a repeat of
421 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
422 * string 'url' permalink to notice; defaults to local notice URL
423 * string 'rendered' rendered HTML version of content
424 * array 'replies' list of profile URIs for reply delivery in
425 * place of extracting @-replies from content.
426 * array 'groups' list of group IDs to deliver to, in place of
427 * extracting ! tags from content
428 * array 'tags' list of hashtag strings to save with the notice
429 * in place of extracting # tags from content
430 * array 'urls' list of attached/referred URLs to save with the
431 * notice in place of extracting links from content
432 * boolean 'distribute' whether to distribute the notice, default true
433 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
434 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
435 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
437 * @fixme tag override
440 * @throws ClientException
442 static function saveNew($profile_id, $content, $source, array $options=null) {
443 $defaults = array('uri' => null,
445 'conversation' => null, // URI of conversation
446 'reply_to' => null, // This will override convo URI if the parent is known
447 'repeat_of' => null, // This will override convo URI if the repeated notice is known
449 'distribute' => true,
450 'object_type' => null,
453 if (!empty($options) && is_array($options)) {
454 $options = array_merge($defaults, $options);
460 if (!isset($is_local)) {
461 $is_local = Notice::LOCAL_PUBLIC;
464 $profile = Profile::getKV('id', $profile_id);
465 if (!$profile instanceof Profile) {
466 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
467 throw new ClientException(_('Problem saving notice. Unknown user.'));
470 $user = User::getKV('id', $profile_id);
471 if ($user instanceof User) {
472 // Use the local user's shortening preferences, if applicable.
473 $final = $user->shortenLinks($content);
475 $final = common_shorten_links($content);
478 if (Notice::contentTooLong($final)) {
479 // TRANS: Client exception thrown if a notice contains too many characters.
480 throw new ClientException(_('Problem saving notice. Too long.'));
483 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
484 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
485 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
486 throw new ClientException(_('Too many notices too fast; take a breather '.
487 'and post again in a few minutes.'));
490 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
491 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
492 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
493 throw new ClientException(_('Too many duplicate messages too quickly;'.
494 ' take a breather and post again in a few minutes.'));
497 if (!$profile->hasRight(Right::NEWNOTICE)) {
498 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
500 // TRANS: Client exception thrown when a user tries to post while being banned.
501 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
504 $notice = new Notice();
505 $notice->profile_id = $profile_id;
507 if ($source && in_array($source, common_config('public', 'autosource'))) {
508 $notice->is_local = Notice::LOCAL_NONPUBLIC;
510 $notice->is_local = $is_local;
513 if (!empty($created)) {
514 $notice->created = $created;
516 $notice->created = common_sql_now();
519 if (!$notice->isLocal()) {
520 // Only do these checks for non-local notices. Local notices will generate these values later.
522 throw new ServerException('No URI for remote notice. Cannot accept that.');
526 $notice->content = $final;
528 $notice->source = $source;
532 // Get the groups here so we can figure out replies and such
533 if (!isset($groups)) {
534 $groups = User_group::idsFromText($notice->content, $profile);
539 // Handle repeat case
541 if (!empty($options['repeat_of'])) {
543 // Check for a private one
545 $repeat = Notice::getByID($options['repeat_of']);
547 if ($profile->sameAs($repeat->getProfile())) {
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) a reply to unknown remote user. Activity creation time ('.$notice->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
625 // Conversation entry with specified URI was not found, so we must create it.
626 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
627 // The insert in Conversation::create throws exception on failure
628 $conv = Conversation::create($options['conversation'], $notice->created);
630 $notice->conversation = $conv->getID();
635 // If it's not part of a conversation, it's the beginning of a new conversation.
636 if (empty($notice->conversation)) {
637 $conv = Conversation::create();
638 $notice->conversation = $conv->getID();
643 $notloc = new Notice_location();
644 if (!empty($lat) && !empty($lon)) {
649 if (!empty($location_ns) && !empty($location_id)) {
650 $notloc->location_id = $location_id;
651 $notloc->location_ns = $location_ns;
654 if (!empty($rendered)) {
655 $notice->rendered = $rendered;
657 $notice->rendered = common_render_content($final,
658 $notice->getProfile(),
659 $notice->hasParent() ? $notice->getParent() : null);
663 if ($notice->isRepeat()) {
664 $notice->verb = ActivityVerb::SHARE;
665 $notice->object_type = ActivityObject::ACTIVITY;
667 $notice->verb = ActivityVerb::POST;
670 $notice->verb = $verb;
673 if (empty($object_type)) {
674 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
676 $notice->object_type = $object_type;
679 if (is_null($scope) && $reply instanceof Notice) {
680 $notice->scope = $reply->scope;
682 $notice->scope = $scope;
685 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
687 if (Event::handle('StartNoticeSave', array(&$notice))) {
689 // XXX: some of these functions write to the DB
692 $notice->insert(); // throws exception on failure, if successful we have an ->id
694 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
695 $notloc->notice_id = $notice->getID();
696 $notloc->insert(); // store the notice location if it had any information
698 } catch (Exception $e) {
699 // Let's test if we managed initial insert, which would imply
700 // failing on some update-part (check 'insert()'). Delete if
701 // something had been stored to the database.
702 if (!empty($notice->id)) {
709 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
710 // the activityverb is a POST (since stuff like repeat, favorite etc.
711 // reasonably handle notifications themselves.
712 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
713 if (isset($replies)) {
714 $notice->saveKnownReplies($replies);
716 $notice->saveReplies();
720 $notice->saveKnownTags($tags);
725 // Note: groups may save tags, so must be run after tags are saved
726 // to avoid errors on duplicates.
727 // Note: groups should always be set.
729 $notice->saveKnownGroups($groups);
732 $notice->saveKnownUrls($urls);
739 // Prepare inbox delivery, may be queued to background.
740 $notice->distribute();
746 static function saveActivity(Activity $act, Profile $actor, array $options=array())
748 // First check if we're going to let this Activity through from the specific actor
749 if (!$actor->hasRight(Right::NEWNOTICE)) {
750 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
752 // TRANS: Client exception thrown when a user tries to post while being banned.
753 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
755 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
756 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
757 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
758 throw new ClientException(_m('Too many notices too fast; take a breather '.
759 'and post again in a few minutes.'));
762 // Get ActivityObject properties
764 if (!empty($act->id)) {
766 $options['uri'] = $act->id;
767 $options['url'] = $act->link;
769 $actobj = count($act->objects)===1 ? $act->objects[0] : null;
770 if (!is_null($actobj) && !empty($actobj->id)) {
771 $options['uri'] = $actobj->id;
773 $options['url'] = $actobj->link;
774 } elseif (preg_match('!^https?://!', $actobj->id)) {
775 $options['url'] = $actobj->id;
782 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
783 'mentions' => array(),
787 'source' => 'unknown',
792 'distribute' => true);
794 // options will have default values when nothing has been supplied
795 $options = array_merge($defaults, $options);
796 foreach (array_keys($defaults) as $key) {
797 // Only convert the keynames we specify ourselves from 'defaults' array into variables
798 $$key = $options[$key];
800 extract($options, EXTR_SKIP);
803 $stored = new Notice();
804 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
806 if ($stored->find()) {
807 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
808 // I _assume_ saving a Notice with a colliding URI means we're really trying to
809 // save the same notice again...
810 throw new AlreadyFulfilledException('Notice URI already exists');
814 // NOTE: Sandboxed users previously got all the notices _during_
815 // sandbox period set to to is_local=Notice::LOCAL_NONPUBLIC here.
816 // Since then we have started just filtering _when_ it gets shown
817 // instead of creating a mixed jumble of differently scoped notices.
819 if ($source && in_array($source, common_config('public', 'autosource'))) {
820 $stored->is_local = Notice::LOCAL_NONPUBLIC;
822 $stored->is_local = intval($is_local);
825 if (!$stored->isLocal()) {
826 // Only do these checks for non-local notices. Local notices will generate these values later.
827 if (!common_valid_http_url($url)) {
828 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
831 throw new ServerException('No URI for remote notice. Cannot accept that.');
835 $stored->profile_id = $actor->getID();
836 $stored->source = $source;
839 $stored->verb = $act->verb;
841 // we use mb_strlen because it _might_ be that the content is just the string "0"...
842 $content = mb_strlen($act->content) ? $act->content : $act->summary;
843 if (mb_strlen($content)===0 && !is_null($actobj)) {
844 $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
846 // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
847 $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
848 $stored->content = common_strip_html($stored->getRendered(), true, true);
849 if (trim($stored->content) === '') {
850 // TRANS: Error message when the plain text content of a notice has zero length.
851 throw new ClientException(_('Empty notice content, will not save this.'));
853 unset($content); // garbage collect
855 // Maybe a missing act-time should be fatal if the actor is not local?
856 if (!empty($act->time)) {
857 $stored->created = common_sql_date($act->time);
859 $stored->created = common_sql_now();
862 $reply = null; // this will store the in-reply-to Notice if found
863 $replyUris = []; // this keeps a list of possible URIs to look up
864 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
865 $replyUris[] = $act->context->replyToID;
867 if ($act->target instanceof ActivityObject && !empty($act->target->id)) {
868 $replyUris[] = $act->target->id;
870 foreach (array_unique($replyUris) as $replyUri) {
871 $reply = self::getKV('uri', $replyUri);
872 // Only do remote fetching if we're not a private site
873 if (!common_config('site', 'private') && !$reply instanceof Notice) {
874 // the URI is the object we're looking for, $actor is a
875 // Profile that surely knows of it and &$reply where it
876 // will be stored when fetched
877 Event::handle('FetchRemoteNotice', array($replyUri, $actor, &$reply));
879 // we got what we're in-reply-to now, so let's move on
880 if ($reply instanceof Notice) {
883 // otherwise reset whatever we might've gotten from the event
886 unset($replyUris); // garbage collect
888 if ($reply instanceof Notice) {
889 if (!$reply->inScope($actor)) {
890 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
891 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
892 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
895 $stored->reply_to = $reply->id;
896 $stored->conversation = $reply->conversation;
898 // If the original is private to a group, and notice has no group specified,
899 // make it to the same group(s)
900 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
901 $replyGroups = $reply->getGroups();
902 foreach ($replyGroups as $group) {
903 if ($actor->isMember($group)) {
904 $groups[] = $group->id;
909 if (is_null($scope)) {
910 $scope = $reply->scope;
913 // If we don't know the reply, we might know the conversation!
914 // This will happen if a known remote user replies to an
915 // unknown remote user - within a known conversation.
916 if (empty($stored->conversation) and !empty($act->context->conversation)) {
917 $conv = Conversation::getKV('uri', $act->context->conversation);
918 if ($conv instanceof Conversation) {
919 common_debug('Conversation stitched together from (probably) a reply activity to unknown remote user. Activity creation time ('.$stored->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
921 // Conversation entry with specified URI was not found, so we must create it.
922 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
923 // The insert in Conversation::create throws exception on failure
924 $conv = Conversation::create($act->context->conversation, $stored->created);
926 $stored->conversation = $conv->getID();
930 unset($reply); // garbage collect
932 // If it's not part of a conversation, it's the beginning of a new conversation.
933 if (empty($stored->conversation)) {
934 $conv = Conversation::create();
935 $stored->conversation = $conv->getID();
940 if ($act->context instanceof ActivityContext) {
941 if ($act->context->location instanceof Location) {
942 $notloc = Notice_location::fromLocation($act->context->location);
945 $act->context = new ActivityContext();
948 if (array_key_exists(ActivityContext::ATTN_PUBLIC, $act->context->attention)) {
949 $stored->scope = Notice::PUBLIC_SCOPE;
950 // TODO: maybe we should actually keep this? if the saveAttentions thing wants to use it...
951 unset($act->context->attention[ActivityContext::ATTN_PUBLIC]);
953 $stored->scope = self::figureOutScope($actor, $groups, $scope);
956 foreach ($act->categories as $cat) {
958 $term = common_canonical_tag($cat->term);
965 foreach ($act->enclosures as $href) {
966 // @todo FIXME: Save these locally or....?
970 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
971 if (empty($act->objects[0]->type)) {
972 // Default type for the post verb is 'note', but we know it's
973 // a 'comment' if it is in reply to something.
974 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
976 //TODO: Is it safe to always return a relative URI? The
977 // JSON version of ActivityStreams always use it, so we
978 // should definitely be able to handle it...
979 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
983 if (Event::handle('StartNoticeSave', array(&$stored))) {
984 // XXX: some of these functions write to the DB
987 $result = $stored->insert(); // throws exception on error
989 if ($notloc instanceof Notice_location) {
990 $notloc->notice_id = $stored->getID();
994 $orig = clone($stored); // for updating later in this try clause
997 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
998 if (empty($object)) {
999 throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
1003 // If something changed in the Notice during StoreActivityObject
1004 $stored->update($orig);
1005 } catch (Exception $e) {
1006 if (empty($stored->id)) {
1007 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
1009 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
1015 unset($notloc); // garbage collect
1017 if (!$stored instanceof Notice) {
1018 throw new ServerException('StartNoticeSave did not give back a Notice.');
1019 } elseif (empty($stored->id)) {
1020 throw new ServerException('Supposedly saved Notice has no ID.');
1023 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
1024 // the activityverb is a POST (since stuff like repeat, favorite etc.
1025 // reasonably handle notifications themselves.
1026 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
1028 if (!empty($tags)) {
1029 $stored->saveKnownTags($tags);
1031 $stored->saveTags();
1034 // Note: groups may save tags, so must be run after tags are saved
1035 // to avoid errors on duplicates.
1036 $stored->saveAttentions($act->context->attention);
1038 if (!empty($urls)) {
1039 $stored->saveKnownUrls($urls);
1041 $stored->saveUrls();
1046 // Prepare inbox delivery, may be queued to background.
1047 $stored->distribute();
1053 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1054 $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1056 // For private streams
1058 $user = $actor->getUser();
1059 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1060 if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1061 $scope |= Notice::FOLLOWER_SCOPE;
1063 } catch (NoSuchUserException $e) {
1064 // TODO: Not a local user, so we don't know about scope preferences... yet!
1067 // Force the scope for private groups
1068 foreach ($groups as $group_id) {
1070 $group = User_group::getByID($group_id);
1071 if ($group->force_scope) {
1072 $scope |= Notice::GROUP_SCOPE;
1075 } catch (Exception $e) {
1076 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1083 function blowOnInsert($conversation = false)
1085 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1087 if ($this->isPublic()) {
1088 $this->blowStream('public');
1089 $this->blowStream('networkpublic');
1092 if ($this->conversation) {
1093 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1094 self::blow('conversation:notice_count:%d', $this->conversation);
1097 if ($this->isRepeat()) {
1098 // XXX: we should probably only use one of these
1099 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1100 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1103 $original = Notice::getKV('id', $this->repeat_of);
1105 if ($original instanceof Notice) {
1106 $originalUser = User::getKV('id', $original->profile_id);
1107 if ($originalUser instanceof User) {
1108 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1112 $profile = Profile::getKV($this->profile_id);
1114 if ($profile instanceof Profile) {
1115 $profile->blowNoticeCount();
1118 $ptags = $this->getProfileTags();
1119 foreach ($ptags as $ptag) {
1120 $ptag->blowNoticeStreamCache();
1125 * Clear cache entries related to this notice at delete time.
1126 * Necessary to avoid breaking paging on public, profile timelines.
1128 function blowOnDelete()
1130 $this->blowOnInsert();
1132 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1134 if ($this->isPublic()) {
1135 self::blow('public;last');
1136 self::blow('networkpublic;last');
1139 self::blow('fave:by_notice', $this->id);
1141 if ($this->conversation) {
1142 // In case we're the first, will need to calc a new root.
1143 self::blow('notice:conversation_root:%d', $this->conversation);
1146 $ptags = $this->getProfileTags();
1147 foreach ($ptags as $ptag) {
1148 $ptag->blowNoticeStreamCache(true);
1152 function blowStream()
1154 $c = self::memcache();
1160 $args = func_get_args();
1161 $format = array_shift($args);
1162 $keyPart = vsprintf($format, $args);
1163 $cacheKey = Cache::key($keyPart);
1164 $c->delete($cacheKey);
1166 // delete the "last" stream, too, if this notice is
1167 // older than the top of that stream
1169 $lastKey = $cacheKey.';last';
1171 $lastStr = $c->get($lastKey);
1173 if ($lastStr !== false) {
1174 $window = explode(',', $lastStr);
1175 $lastID = $window[0];
1176 $lastNotice = Notice::getKV('id', $lastID);
1177 if (!$lastNotice instanceof Notice // just weird
1178 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1179 $c->delete($lastKey);
1184 /** save all urls in the notice to the db
1186 * follow redirects and save all available file information
1187 * (mimetype, date, size, oembed, etc.)
1191 function saveUrls() {
1192 if (common_config('attachments', 'process_links')) {
1193 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1198 * Save the given URLs as related links/attachments to the db
1200 * follow redirects and save all available file information
1201 * (mimetype, date, size, oembed, etc.)
1205 function saveKnownUrls($urls)
1207 if (common_config('attachments', 'process_links')) {
1208 // @fixme validation?
1209 foreach (array_unique($urls) as $url) {
1210 $this->saveUrl($url, $this);
1218 function saveUrl($url, Notice $notice) {
1220 File::processNew($url, $notice);
1221 } catch (ServerException $e) {
1222 // Could not save URL. Log it?
1226 static function checkDupes($profile_id, $content) {
1227 $profile = Profile::getKV($profile_id);
1228 if (!$profile instanceof Profile) {
1231 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1232 if (!empty($notice)) {
1234 while ($notice->fetch()) {
1235 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1237 } else if ($notice->content == $content) {
1242 // If we get here, oldest item in cache window is not
1243 // old enough for dupe limit; do direct check against DB
1244 $notice = new Notice();
1245 $notice->profile_id = $profile_id;
1246 $notice->content = $content;
1247 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1248 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1250 $cnt = $notice->count();
1254 static function checkEditThrottle($profile_id) {
1255 $profile = Profile::getKV($profile_id);
1256 if (!$profile instanceof Profile) {
1259 // Get the Nth notice
1260 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1261 if ($notice && $notice->fetch()) {
1262 // If the Nth notice was posted less than timespan seconds ago
1263 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1268 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1272 protected $_attachments = array();
1274 function attachments() {
1275 if (isset($this->_attachments[$this->id])) {
1276 return $this->_attachments[$this->id];
1279 $f2ps = File_to_post::listGet('post_id', array($this->id));
1281 foreach ($f2ps[$this->id] as $f2p) {
1282 $ids[] = $f2p->file_id;
1285 return $this->_setAttachments(File::multiGet('id', $ids)->fetchAll());
1288 public function _setAttachments(array $attachments)
1290 return $this->_attachments[$this->id] = $attachments;
1293 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1295 $stream = new PublicNoticeStream();
1296 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1299 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null, Profile $scoped=null)
1301 $stream = new ConversationNoticeStream($id, $scoped);
1302 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1306 * Is this notice part of an active conversation?
1308 * @return boolean true if other messages exist in the same
1309 * conversation, false if this is the only one
1311 function hasConversation()
1313 if (empty($this->conversation)) {
1314 // this notice is not part of a conversation apparently
1315 // FIXME: all notices should have a conversation value, right?
1319 //FIXME: Get the Profile::current() stuff some other way
1320 // to avoid confusion between queue processing and session.
1321 $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
1323 // if our "offset 1, limit 1" query got a result, return true else false
1324 return $notice->N > 0;
1328 * Grab the earliest notice from this conversation.
1330 * @return Notice or null
1332 function conversationRoot($profile=-1)
1334 // XXX: can this happen?
1336 if (empty($this->conversation)) {
1340 // Get the current profile if not specified
1342 if (is_int($profile) && $profile == -1) {
1343 $profile = Profile::current();
1346 // If this notice is out of scope, no root for you!
1348 if (!$this->inScope($profile)) {
1352 // If this isn't a reply to anything, then it's its own
1353 // root if it's the earliest notice in the conversation:
1355 if (empty($this->reply_to)) {
1357 $root->conversation = $this->conversation;
1358 $root->orderBy('notice.created ASC');
1359 $root->find(true); // true means "fetch first result"
1364 if (is_null($profile)) {
1365 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1367 $keypart = sprintf('notice:conversation_root:%d:%d',
1372 $root = self::cacheGet($keypart);
1374 if ($root !== false && $root->inScope($profile)) {
1381 $parent = $last->getParent();
1382 if ($parent->inScope($profile)) {
1386 } catch (NoParentNoticeException $e) {
1387 // Latest notice has no parent
1388 } catch (NoResultException $e) {
1389 // Notice was not found, so we can't go further up in the tree.
1390 // FIXME: Maybe we should do this in a more stable way where deleted
1391 // notices won't break conversation chains?
1393 // No parent, or parent out of scope
1398 self::cacheSet($keypart, $root);
1404 * Pull up a full list of local recipients who will be getting
1405 * this notice in their inbox. Results will be cached, so don't
1406 * change the input data wily-nilly!
1408 * @param array $groups optional list of Group objects;
1409 * if left empty, will be loaded from group_inbox records
1410 * @param array $recipient optional list of reply profile ids
1411 * if left empty, will be loaded from reply records
1412 * @return array associating recipient user IDs with an inbox source constant
1414 function whoGets(array $groups=null, array $recipients=null)
1416 $c = self::memcache();
1419 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1420 if ($ni !== false) {
1425 if (is_null($recipients)) {
1426 $recipients = $this->getReplies();
1431 // Give plugins a chance to add folks in at start...
1432 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1434 $users = $this->getSubscribedUsers();
1435 foreach ($users as $id) {
1436 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1439 if (is_null($groups)) {
1440 $groups = $this->getGroups();
1442 foreach ($groups as $group) {
1443 $users = $group->getUserMembers();
1444 foreach ($users as $id) {
1445 if (!array_key_exists($id, $ni)) {
1446 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1451 $ptAtts = $this->getAttentionsFromProfileTags();
1452 foreach ($ptAtts as $key=>$val) {
1453 if (!array_key_exists($key, $ni)) {
1458 foreach ($recipients as $recipient) {
1459 if (!array_key_exists($recipient, $ni)) {
1460 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1464 // Exclude any deleted, non-local, or blocking recipients.
1465 $profile = $this->getProfile();
1466 $originalProfile = null;
1467 if ($this->isRepeat()) {
1468 // Check blocks against the original notice's poster as well.
1469 $original = Notice::getKV('id', $this->repeat_of);
1470 if ($original instanceof Notice) {
1471 $originalProfile = $original->getProfile();
1475 foreach ($ni as $id => $source) {
1477 $user = User::getKV('id', $id);
1478 if (!$user instanceof User ||
1479 $user->hasBlocked($profile) ||
1480 ($originalProfile && $user->hasBlocked($originalProfile))) {
1483 } catch (UserNoProfileException $e) {
1484 // User doesn't have a profile; invalid; skip them.
1489 // Give plugins a chance to filter out...
1490 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1494 // XXX: pack this data better
1495 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1501 function getSubscribedUsers()
1505 if(common_config('db','quote_identifiers'))
1506 $user_table = '"user"';
1507 else $user_table = 'user';
1511 'FROM '. $user_table .' JOIN subscription '.
1512 'ON '. $user_table .'.id = subscription.subscriber ' .
1513 'WHERE subscription.subscribed = %d ';
1515 $user->query(sprintf($qry, $this->profile_id));
1519 while ($user->fetch()) {
1528 function getProfileTags()
1532 $profile = $this->getProfile();
1533 $list = $profile->getOtherTags($profile);
1535 while($list->fetch()) {
1536 $ptags[] = clone($list);
1538 } catch (Exception $e) {
1539 common_log(LOG_ERR, "Error during Notice->getProfileTags() for id=={$this->getID()}: {$e->getMessage()}");
1545 public function getAttentionsFromProfileTags()
1548 $ptags = $this->getProfileTags();
1549 foreach ($ptags as $ptag) {
1550 $users = $ptag->getUserSubscribers();
1551 foreach ($users as $id) {
1552 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1559 * Record this notice to the given group inboxes for delivery.
1560 * Overrides the regular parsing of !group markup.
1562 * @param string $group_ids
1563 * @fixme might prefer URIs as identifiers, as for replies?
1564 * best with generalizations on user_group to support
1565 * remote groups better.
1567 function saveKnownGroups(array $group_ids)
1570 foreach (array_unique($group_ids) as $id) {
1571 $group = User_group::getKV('id', $id);
1572 if ($group instanceof User_group) {
1573 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1574 $result = $this->addToGroupInbox($group);
1576 common_log_db_error($gi, 'INSERT', __FILE__);
1579 if (common_config('group', 'addtag')) {
1580 // we automatically add a tag for every group name, too
1582 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1583 'notice_id' => $this->id));
1585 if (is_null($tag)) {
1586 $this->saveTag($group->nickname);
1590 $groups[] = clone($group);
1592 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1599 function addToGroupInbox(User_group $group)
1601 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1602 'notice_id' => $this->id));
1604 if (!$gi instanceof Group_inbox) {
1606 $gi = new Group_inbox();
1608 $gi->group_id = $group->id;
1609 $gi->notice_id = $this->id;
1610 $gi->created = $this->created;
1612 $result = $gi->insert();
1615 common_log_db_error($gi, 'INSERT', __FILE__);
1616 // TRANS: Server exception thrown when an update for a group inbox fails.
1617 throw new ServerException(_('Problem saving group inbox.'));
1620 self::blow('user_group:notice_ids:%d', $gi->group_id);
1626 function saveAttentions(array $uris)
1628 foreach ($uris as $uri=>$type) {
1630 $target = Profile::fromUri($uri);
1631 } catch (UnknownUriException $e) {
1632 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1637 $this->saveAttention($target);
1638 } catch (AlreadyFulfilledException $e) {
1639 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1640 } catch (Exception $e) {
1641 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1647 * Saves an attention for a profile (user or group) which means
1648 * it shows up in their home feed and such.
1650 function saveAttention(Profile $target, $reason=null)
1652 if ($target->isGroup()) {
1653 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1655 // legacy notification method, will still be in use for quite a while I think
1656 $this->addToGroupInbox($target->getGroup());
1658 if ($target->hasBlocked($this->getProfile())) {
1659 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1664 if ($target->isLocal()) {
1665 // legacy notification method, will still be in use for quite a while I think
1666 $this->saveReply($target->getID());
1669 $att = Attention::saveNew($this, $target, $reason);
1674 * Save reply records indicating that this notice needs to be
1675 * delivered to the local users with the given URIs.
1677 * Since this is expected to be used when saving foreign-sourced
1678 * messages, we won't deliver to any remote targets as that's the
1679 * source service's responsibility.
1681 * Mail notifications etc will be handled later.
1683 * @param array $uris Array of unique identifier URIs for recipients
1685 function saveKnownReplies(array $uris)
1691 $sender = $this->getProfile();
1693 foreach (array_unique($uris) as $uri) {
1695 $profile = Profile::fromUri($uri);
1696 } catch (UnknownUriException $e) {
1697 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1701 if ($profile->hasBlocked($sender)) {
1702 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1706 $this->saveReply($profile->getID());
1707 self::blow('reply:stream:%d', $profile->getID());
1712 * Pull @-replies from this message's content in StatusNet markup format
1713 * and save reply records indicating that this message needs to be
1714 * delivered to those users.
1716 * Mail notifications to local profiles will be sent later.
1718 * @return array of integer profile IDs
1721 function saveReplies()
1723 $sender = $this->getProfile();
1727 // If it's a reply, save for the replied-to author
1729 $parent = $this->getParent();
1730 $parentauthor = $parent->getProfile();
1731 $this->saveReply($parentauthor->getID());
1732 $replied[$parentauthor->getID()] = 1;
1733 self::blow('reply:stream:%d', $parentauthor->getID());
1734 } catch (NoParentNoticeException $e) {
1735 // Not a reply, since it has no parent!
1737 } catch (NoResultException $e) {
1738 // Parent notice was probably deleted
1742 // @todo ideally this parser information would only
1743 // be calculated once.
1745 $mentions = common_find_mentions($this->content, $sender, $parent);
1747 foreach ($mentions as $mention) {
1749 foreach ($mention['mentioned'] as $mentioned) {
1751 // skip if they're already covered
1752 if (array_key_exists($mentioned->id, $replied)) {
1756 // Don't save replies from blocked profile to local user
1757 if ($mentioned->hasBlocked($sender)) {
1761 $this->saveReply($mentioned->id);
1762 $replied[$mentioned->id] = 1;
1763 self::blow('reply:stream:%d', $mentioned->id);
1767 $recipientIds = array_keys($replied);
1769 return $recipientIds;
1772 function saveReply($profileId)
1774 $reply = new Reply();
1776 $reply->notice_id = $this->id;
1777 $reply->profile_id = $profileId;
1778 $reply->modified = $this->created;
1785 protected $_attentionids = array();
1788 * Pull the complete list of known activity context attentions for this notice.
1790 * @return array of integer profile ids (also group profiles)
1792 function getAttentionProfileIDs()
1794 if (!isset($this->_attentionids[$this->getID()])) {
1795 $atts = Attention::multiGet('notice_id', array($this->getID()));
1796 // (array)null means empty array
1797 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1799 return $this->_attentionids[$this->getID()];
1802 protected $_replies = array();
1805 * Pull the complete list of @-mentioned profile IDs for this notice.
1807 * @return array of integer profile ids
1809 function getReplies()
1811 if (!isset($this->_replies[$this->getID()])) {
1812 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1813 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1815 return $this->_replies[$this->getID()];
1818 function _setReplies($replies)
1820 $this->_replies[$this->getID()] = $replies;
1824 * Pull the complete list of @-reply targets for this notice.
1826 * @return array of Profiles
1828 function getAttentionProfiles()
1830 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1832 $profiles = Profile::multiGet('id', (array)$ids);
1834 return $profiles->fetchAll();
1838 * Send e-mail notifications to local @-reply targets.
1840 * Replies must already have been saved; this is expected to be run
1841 * from the distrib queue handler.
1843 function sendReplyNotifications()
1845 // Don't send reply notifications for repeats
1846 if ($this->isRepeat()) {
1850 $recipientIds = $this->getReplies();
1851 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1852 require_once INSTALLDIR.'/lib/mail.php';
1854 foreach ($recipientIds as $recipientId) {
1856 $user = User::getByID($recipientId);
1857 mail_notify_attn($user->getProfile(), $this);
1858 } catch (NoResultException $e) {
1862 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1867 * Pull list of Profile IDs of groups this notice addresses.
1869 * @return array of Group _profile_ IDs
1872 function getGroupProfileIDs()
1876 foreach ($this->getGroups() as $group) {
1877 $ids[] = $group->profile_id;
1884 * Pull list of groups this notice needs to be delivered to,
1885 * as previously recorded by saveKnownGroups().
1887 * @return array of Group objects
1890 protected $_groups = array();
1892 function getGroups()
1894 // Don't save groups for repeats
1896 if (!empty($this->repeat_of)) {
1900 if (isset($this->_groups[$this->id])) {
1901 return $this->_groups[$this->id];
1904 $gis = Group_inbox::listGet('notice_id', array($this->id));
1908 foreach ($gis[$this->id] as $gi) {
1909 $ids[] = $gi->group_id;
1912 $groups = User_group::multiGet('id', $ids);
1913 $this->_groups[$this->id] = $groups->fetchAll();
1914 return $this->_groups[$this->id];
1917 function _setGroups($groups)
1919 $this->_groups[$this->id] = $groups;
1923 * Convert a notice into an activity for export.
1925 * @param Profile $scoped The currently logged in/scoped profile
1927 * @return Activity activity object representing this Notice.
1930 function asActivity(Profile $scoped=null)
1932 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1934 if ($act instanceof Activity) {
1937 $act = new Activity();
1939 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1941 $act->id = $this->uri;
1942 $act->time = strtotime($this->created);
1944 $act->link = $this->getUrl();
1945 } catch (InvalidUrlException $e) {
1946 // The notice is probably a share or similar, which don't
1947 // have a representational URL of their own.
1949 $act->content = common_xml_safe_str($this->getRendered());
1951 $profile = $this->getProfile();
1953 $act->actor = $profile->asActivityObject();
1954 $act->actor->extra[] = $profile->profileInfo($scoped);
1956 $act->verb = $this->verb;
1958 if (!$this->repeat_of) {
1959 $act->objects[] = $this->asActivityObject();
1962 // XXX: should this be handled by default processing for object entry?
1966 $tags = $this->getTags();
1968 foreach ($tags as $tag) {
1969 $cat = new AtomCategory();
1972 $act->categories[] = $cat;
1976 // XXX: use Atom Media and/or File activity objects instead
1978 $attachments = $this->attachments();
1980 foreach ($attachments as $attachment) {
1981 // Include local attachments in Activity
1982 if (!empty($attachment->filename)) {
1983 $act->enclosures[] = $attachment->getEnclosure();
1987 $ctx = new ActivityContext();
1990 $reply = $this->getParent();
1991 $ctx->replyToID = $reply->getUri();
1992 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1993 } catch (NoParentNoticeException $e) {
1994 // This is not a reply to something
1995 } catch (NoResultException $e) {
1996 // Parent notice was probably deleted
2000 $ctx->location = Notice_location::locFromStored($this);
2001 } catch (ServerException $e) {
2002 $ctx->location = null;
2007 if (!empty($this->conversation)) {
2008 $conv = Conversation::getKV('id', $this->conversation);
2009 if ($conv instanceof Conversation) {
2010 $ctx->conversation = $conv->uri;
2014 // This covers the legacy getReplies and getGroups too which get their data
2015 // from entries stored via Notice::saveNew (which we want to move away from)...
2016 foreach ($this->getAttentionProfiles() as $target) {
2017 // User and group profiles which get the attention of this notice
2018 $ctx->attention[$target->getUri()] = $target->getObjectType();
2021 switch ($this->scope) {
2022 case Notice::PUBLIC_SCOPE:
2023 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2025 case Notice::FOLLOWER_SCOPE:
2026 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2027 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2031 $act->context = $ctx;
2033 $source = $this->getSource();
2035 if ($source instanceof Notice_source) {
2036 $act->generator = ActivityObject::fromNoticeSource($source);
2041 $atom_feed = $profile->getAtomFeed();
2043 if (!empty($atom_feed)) {
2045 $act->source = new ActivitySource();
2047 // XXX: we should store the actual feed ID
2049 $act->source->id = $atom_feed;
2051 // XXX: we should store the actual feed title
2053 $act->source->title = $profile->getBestName();
2055 $act->source->links['alternate'] = $profile->profileurl;
2056 $act->source->links['self'] = $atom_feed;
2058 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2060 $notice = $profile->getCurrentNotice();
2062 if ($notice instanceof Notice) {
2063 $act->source->updated = self::utcDate($notice->created);
2066 $user = User::getKV('id', $profile->id);
2068 if ($user instanceof User) {
2069 $act->source->links['license'] = common_config('license', 'url');
2073 if ($this->isLocal()) {
2074 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2075 'format' => 'atom'));
2076 $act->editLink = $act->selfLink;
2079 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2082 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2087 // This has gotten way too long. Needs to be sliced up into functional bits
2088 // or ideally exported to a utility class.
2090 function asAtomEntry($namespace=false,
2093 Profile $scoped=null)
2095 $act = $this->asActivity($scoped);
2096 $act->extra[] = $this->noticeInfo($scoped);
2097 return $act->asString($namespace, $author, $source);
2101 * Extra notice info for atom entries
2103 * Clients use some extra notice info in the atom stream.
2104 * This gives it to them.
2106 * @param Profile $scoped The currently logged in/scoped profile
2108 * @return array representation of <statusnet:notice_info> element
2111 function noticeInfo(Profile $scoped=null)
2113 // local notice ID (useful to clients for ordering)
2115 $noticeInfoAttr = array('local_id' => $this->id);
2119 $ns = $this->getSource();
2121 if ($ns instanceof Notice_source) {
2122 $noticeInfoAttr['source'] = $ns->code;
2123 if (!empty($ns->url)) {
2124 $noticeInfoAttr['source_link'] = $ns->url;
2125 if (!empty($ns->name)) {
2126 $noticeInfoAttr['source'] = '<a href="'
2127 . htmlspecialchars($ns->url)
2128 . '" rel="nofollow">'
2129 . htmlspecialchars($ns->name)
2135 // favorite and repeated
2137 if ($scoped instanceof Profile) {
2138 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2141 if (!empty($this->repeat_of)) {
2142 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2145 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2147 return array('statusnet:notice_info', $noticeInfoAttr, null);
2151 * Returns an XML string fragment with a reference to a notice as an
2152 * Activity Streams noun object with the given element type.
2154 * Assumes that 'activity' namespace has been previously defined.
2156 * @param string $element one of 'subject', 'object', 'target'
2160 function asActivityNoun($element)
2162 $noun = $this->asActivityObject();
2163 return $noun->asString('activity:' . $element);
2166 public function asActivityObject()
2168 $object = new ActivityObject();
2170 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2171 $object->type = $this->object_type ?: ActivityObject::NOTE;
2172 $object->id = $this->getUri();
2173 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2174 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2175 $object->content = $this->getRendered();
2176 $object->link = $this->getUrl();
2178 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2180 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2183 if (!$object instanceof ActivityObject) {
2184 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2185 throw new ServerException('Notice asActivityObject created something else.');
2192 * Determine which notice, if any, a new notice is in reply to.
2194 * For conversation tracking, we try to see where this notice fits
2195 * in the tree. Beware that this may very well give false positives
2196 * and add replies to wrong threads (if there have been newer posts
2197 * by the same user as we're replying to).
2199 * @param Profile $sender Author profile
2200 * @param string $content Final notice content
2202 * @return integer ID of replied-to notice, or null for not a reply.
2205 static function getInlineReplyTo(Profile $sender, $content)
2207 // Is there an initial @ or T?
2208 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2209 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2210 $nickname = common_canonical_nickname($match[1]);
2215 // Figure out who that is.
2216 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2218 if ($recipient instanceof Profile) {
2219 // Get their last notice
2220 $last = $recipient->getCurrentNotice();
2221 if ($last instanceof Notice) {
2224 // Maybe in the future we want to handle something else below
2225 // so don't return getCurrentNotice() immediately.
2231 static function maxContent()
2233 $contentlimit = common_config('notice', 'contentlimit');
2234 // null => use global limit (distinct from 0!)
2235 if (is_null($contentlimit)) {
2236 $contentlimit = common_config('site', 'textlimit');
2238 return $contentlimit;
2241 static function contentTooLong($content)
2243 $contentlimit = self::maxContent();
2244 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2248 * Convenience function for posting a repeat of an existing message.
2250 * @param Profile $repeater Profile which is doing the repeat
2251 * @param string $source: posting source key, eg 'web', 'api', etc
2254 * @throws Exception on failure or permission problems
2256 function repeat(Profile $repeater, $source)
2258 $author = $this->getProfile();
2260 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2261 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2262 $content = sprintf(_('RT @%1$s %2$s'),
2263 $author->getNickname(),
2266 $maxlen = self::maxContent();
2267 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2268 // Web interface and current Twitter API clients will
2269 // pull the original notice's text, but some older
2270 // clients and RSS/Atom feeds will see this trimmed text.
2272 // Unfortunately this is likely to lose tags or URLs
2273 // at the end of long notices.
2274 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2278 // Scope is same as this one's
2279 return self::saveNew($repeater->id,
2282 array('repeat_of' => $this->id,
2283 'scope' => $this->scope));
2286 // These are supposed to be in chron order!
2288 function repeatStream($limit=100)
2290 $cache = Cache::instance();
2292 if (empty($cache)) {
2293 $ids = $this->_repeatStreamDirect($limit);
2295 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2296 if ($idstr !== false) {
2297 if (empty($idstr)) {
2300 $ids = explode(',', $idstr);
2303 $ids = $this->_repeatStreamDirect(100);
2304 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2307 // We do a max of 100, so slice down to limit
2308 $ids = array_slice($ids, 0, $limit);
2312 return NoticeStream::getStreamByIds($ids);
2315 function _repeatStreamDirect($limit)
2317 $notice = new Notice();
2319 $notice->selectAdd(); // clears it
2320 $notice->selectAdd('id');
2322 $notice->repeat_of = $this->id;
2324 $notice->orderBy('created, id'); // NB: asc!
2326 if (!is_null($limit)) {
2327 $notice->limit(0, $limit);
2330 return $notice->fetchAll('id');
2333 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2337 if (!empty($location_id) && !empty($location_ns)) {
2338 $options['location_id'] = $location_id;
2339 $options['location_ns'] = $location_ns;
2341 $location = Location::fromId($location_id, $location_ns);
2343 if ($location instanceof Location) {
2344 $options['lat'] = $location->lat;
2345 $options['lon'] = $location->lon;
2348 } else if (!empty($lat) && !empty($lon)) {
2349 $options['lat'] = $lat;
2350 $options['lon'] = $lon;
2352 $location = Location::fromLatLon($lat, $lon);
2354 if ($location instanceof Location) {
2355 $options['location_id'] = $location->location_id;
2356 $options['location_ns'] = $location->location_ns;
2358 } else if (!empty($profile)) {
2359 if (isset($profile->lat) && isset($profile->lon)) {
2360 $options['lat'] = $profile->lat;
2361 $options['lon'] = $profile->lon;
2364 if (isset($profile->location_id) && isset($profile->location_ns)) {
2365 $options['location_id'] = $profile->location_id;
2366 $options['location_ns'] = $profile->location_ns;
2373 function clearAttentions()
2375 $att = new Attention();
2376 $att->notice_id = $this->getID();
2379 while ($att->fetch()) {
2380 // Can't do delete() on the object directly since it won't remove all of it
2381 $other = clone($att);
2387 function clearReplies()
2389 $replyNotice = new Notice();
2390 $replyNotice->reply_to = $this->id;
2392 //Null any notices that are replies to this notice
2394 if ($replyNotice->find()) {
2395 while ($replyNotice->fetch()) {
2396 $orig = clone($replyNotice);
2397 $replyNotice->reply_to = null;
2398 $replyNotice->update($orig);
2404 $reply = new Reply();
2405 $reply->notice_id = $this->id;
2407 if ($reply->find()) {
2408 while($reply->fetch()) {
2409 self::blow('reply:stream:%d', $reply->profile_id);
2417 function clearLocation()
2419 $loc = new Notice_location();
2420 $loc->notice_id = $this->id;
2427 function clearFiles()
2429 $f2p = new File_to_post();
2431 $f2p->post_id = $this->id;
2434 while ($f2p->fetch()) {
2438 // FIXME: decide whether to delete File objects
2439 // ...and related (actual) files
2442 function clearRepeats()
2444 $repeatNotice = new Notice();
2445 $repeatNotice->repeat_of = $this->id;
2447 //Null any notices that are repeats of this notice
2449 if ($repeatNotice->find()) {
2450 while ($repeatNotice->fetch()) {
2451 $orig = clone($repeatNotice);
2452 $repeatNotice->repeat_of = null;
2453 $repeatNotice->update($orig);
2458 function clearTags()
2460 $tag = new Notice_tag();
2461 $tag->notice_id = $this->id;
2464 while ($tag->fetch()) {
2465 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2466 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2467 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2468 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2476 function clearGroupInboxes()
2478 $gi = new Group_inbox();
2480 $gi->notice_id = $this->id;
2483 while ($gi->fetch()) {
2484 self::blow('user_group:notice_ids:%d', $gi->group_id);
2492 function distribute()
2494 // We always insert for the author so they don't
2496 Event::handle('StartNoticeDistribute', array($this));
2498 // If there's a failure, we want to _force_
2499 // distribution at this point.
2501 $json = json_encode((object)array('id' => $this->getID(),
2504 $qm = QueueManager::get();
2505 $qm->enqueue($json, 'distrib');
2506 } catch (Exception $e) {
2507 // If the exception isn't transient, this
2508 // may throw more exceptions as DQH does
2509 // its own enqueueing. So, we ignore them!
2511 $handler = new DistribQueueHandler();
2512 $handler->handle($this);
2513 } catch (Exception $e) {
2514 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2516 // Re-throw so somebody smarter can handle it.
2523 $result = parent::insert();
2525 if ($result === false) {
2526 common_log_db_error($this, 'INSERT', __FILE__);
2527 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2528 throw new ServerException('Could not save Notice');
2531 // Profile::hasRepeated() abuses pkeyGet(), so we
2532 // have to clear manually
2533 if (!empty($this->repeat_of)) {
2534 $c = self::memcache();
2536 $ck = self::multicacheKey('Notice',
2537 array('profile_id' => $this->profile_id,
2538 'repeat_of' => $this->repeat_of));
2543 // Update possibly ID-dependent columns: URI, conversation
2544 // (now that INSERT has added the notice's local id)
2545 $orig = clone($this);
2548 // We can only get here if it's a local notice, since remote notices
2549 // should've bailed out earlier due to lacking a URI.
2550 if (empty($this->uri)) {
2551 $this->uri = sprintf('%s%s=%d:%s=%s',
2553 'noticeId', $this->id,
2554 'objectType', $this->getObjectType(true));
2558 if ($changed && $this->update($orig) === false) {
2559 common_log_db_error($notice, 'UPDATE', __FILE__);
2560 // TRANS: Server exception thrown when a notice cannot be updated.
2561 throw new ServerException(_('Problem saving notice.'));
2564 $this->blowOnInsert();
2570 * Get the source of the notice
2572 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2573 * guaranteed to be populated.
2575 function getSource()
2577 if (empty($this->source)) {
2581 $ns = new Notice_source();
2582 switch ($this->source) {
2589 $ns->code = $this->source;
2592 $ns = Notice_source::getKV($this->source);
2594 $ns = new Notice_source();
2595 $ns->code = $this->source;
2596 $app = Oauth_application::getKV('name', $this->source);
2598 $ns->name = $app->name;
2599 $ns->url = $app->source_url;
2609 * Determine whether the notice was locally created
2611 * @return boolean locality
2614 public function isLocal()
2616 $is_local = intval($this->is_local);
2617 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2620 public function getScope()
2622 return intval($this->scope);
2625 public function isRepeat()
2627 return !empty($this->repeat_of);
2631 * Get the list of hash tags saved with this notice.
2633 * @return array of strings
2635 public function getTags()
2639 $keypart = sprintf('notice:tags:%d', $this->id);
2641 $tagstr = self::cacheGet($keypart);
2643 if ($tagstr !== false) {
2644 $tags = explode(',', $tagstr);
2646 $tag = new Notice_tag();
2647 $tag->notice_id = $this->id;
2649 while ($tag->fetch()) {
2650 $tags[] = $tag->tag;
2653 self::cacheSet($keypart, implode(',', $tags));
2659 static private function utcDate($dt)
2661 $dateStr = date('d F Y H:i:s', strtotime($dt));
2662 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2663 return $d->format(DATE_W3C);
2667 * Look up the creation timestamp for a given notice ID, even
2668 * if it's been deleted.
2671 * @return mixed string recorded creation timestamp, or false if can't be found
2673 public static function getAsTimestamp($id)
2676 throw new EmptyPkeyValueException('Notice', 'id');
2680 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2681 // getByID throws exception if $id isn't found
2682 $notice = Notice::getByID($id);
2683 $timestamp = $notice->created;
2686 if (empty($timestamp)) {
2687 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2693 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2694 * parameter, matching notices posted after the given one (exclusive).
2696 * If the referenced notice can't be found, will return false.
2699 * @param string $idField
2700 * @param string $createdField
2701 * @return mixed string or false if no match
2703 public static function whereSinceId($id, $idField='id', $createdField='created')
2706 $since = Notice::getAsTimestamp($id);
2707 } catch (Exception $e) {
2710 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2714 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2715 * parameter, matching notices posted after the given one (exclusive), and
2716 * if necessary add it to the data object's query.
2718 * @param DB_DataObject $obj
2720 * @param string $idField
2721 * @param string $createdField
2722 * @return mixed string or false if no match
2724 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2726 $since = self::whereSinceId($id, $idField, $createdField);
2728 $obj->whereAdd($since);
2733 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2734 * parameter, matching notices posted before the given one (inclusive).
2736 * If the referenced notice can't be found, will return false.
2739 * @param string $idField
2740 * @param string $createdField
2741 * @return mixed string or false if no match
2743 public static function whereMaxId($id, $idField='id', $createdField='created')
2746 $max = Notice::getAsTimestamp($id);
2747 } catch (Exception $e) {
2750 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2754 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2755 * parameter, matching notices posted before the given one (inclusive), and
2756 * if necessary add it to the data object's query.
2758 * @param DB_DataObject $obj
2760 * @param string $idField
2761 * @param string $createdField
2762 * @return mixed string or false if no match
2764 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2766 $max = self::whereMaxId($id, $idField, $createdField);
2768 $obj->whereAdd($max);
2772 public function isPublic()
2774 $is_local = intval($this->is_local);
2775 return !($is_local === Notice::LOCAL_NONPUBLIC || $is_local === Notice::GATEWAY);
2779 * Check that the given profile is allowed to read, respond to, or otherwise
2780 * act on this notice.
2782 * The $scope member is a bitmask of scopes, representing a logical AND of the
2783 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2784 * "only visible to people who are mentioned in the notice AND are users on this site."
2785 * Users on the site who are not mentioned in the notice will not be able to see the
2788 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2790 * @return boolean whether the profile is in the notice's scope
2792 function inScope($profile)
2794 if (is_null($profile)) {
2795 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2797 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2800 $result = self::cacheGet($keypart);
2802 if ($result === false) {
2804 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2805 $bResult = $this->_inScope($profile);
2806 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2808 $result = ($bResult) ? 1 : 0;
2809 self::cacheSet($keypart, $result, 0, 300);
2812 return ($result == 1) ? true : false;
2815 protected function _inScope($profile)
2817 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2819 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2820 return !$this->isHiddenSpam($profile);
2823 // If there's scope, anon cannot be in scope
2824 if (empty($profile)) {
2828 // Author is always in scope
2829 if ($this->profile_id == $profile->id) {
2833 // Only for users on this site
2834 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2838 // Only for users mentioned in the notice
2839 if ($scope & Notice::ADDRESSEE_SCOPE) {
2841 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2842 'profile_id' => $profile->id));
2844 if (!$reply instanceof Reply) {
2849 // Only for members of the given group
2850 if ($scope & Notice::GROUP_SCOPE) {
2852 // XXX: just query for the single membership
2854 $groups = $this->getGroups();
2858 foreach ($groups as $group) {
2859 if ($profile->isMember($group)) {
2870 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2872 if (!Subscription::exists($profile, $this->getProfile())) {
2877 return !$this->isHiddenSpam($profile);
2880 function isHiddenSpam($profile) {
2882 // Hide posts by silenced users from everyone but moderators.
2884 if (common_config('notice', 'hidespam')) {
2887 $author = $this->getProfile();
2888 } catch(Exception $e) {
2889 // If we can't get an author, keep it hidden.
2890 // XXX: technically not spam, but, whatever.
2894 if ($author->hasRole(Profile_role::SILENCED)) {
2895 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2904 public function hasParent()
2908 } catch (NoParentNoticeException $e) {
2914 public function getParent()
2916 $reply_to_id = null;
2918 if (empty($this->reply_to)) {
2919 throw new NoParentNoticeException($this);
2922 // The reply_to ID in the table Notice could exist with a number
2923 // however, the replied to notice might not exist in the database.
2924 // Thus we need to catch the exception and throw the NoParentNoticeException else
2925 // the timeline will not display correctly.
2927 $reply_to_id = self::getByID($this->reply_to);
2928 } catch(Exception $e){
2929 throw new NoParentNoticeException($this);
2932 return $reply_to_id;
2936 * Magic function called at serialize() time.
2938 * We use this to drop a couple process-specific references
2939 * from DB_DataObject which can cause trouble in future
2942 * @return array of variable names to include in serialization.
2947 $vars = parent::__sleep();
2948 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2949 return array_diff($vars, $skip);
2952 static function defaultScope()
2954 $scope = common_config('notice', 'defaultscope');
2955 if (is_null($scope)) {
2956 if (common_config('site', 'private')) {
2965 static function fillProfiles($notices)
2967 $map = self::getProfiles($notices);
2968 foreach ($notices as $entry=>$notice) {
2970 if (array_key_exists($notice->profile_id, $map)) {
2971 $notice->_setProfile($map[$notice->profile_id]);
2973 } catch (NoProfileException $e) {
2974 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2975 unset($notices[$entry]);
2979 return array_values($map);
2982 static function getProfiles(&$notices)
2985 foreach ($notices as $notice) {
2986 $ids[] = $notice->profile_id;
2988 $ids = array_unique($ids);
2989 return Profile::pivotGet('id', $ids);
2992 static function fillGroups(&$notices)
2994 $ids = self::_idsOf($notices);
2995 $gis = Group_inbox::listGet('notice_id', $ids);
2998 foreach ($gis as $id => $gi) {
3001 $gids[] = $g->group_id;
3005 $gids = array_unique($gids);
3006 $group = User_group::pivotGet('id', $gids);
3007 foreach ($notices as $notice)
3010 $gi = $gis[$notice->id];
3011 foreach ($gi as $g) {
3012 $grps[] = $group[$g->group_id];
3014 $notice->_setGroups($grps);
3018 static function _idsOf(array &$notices)
3021 foreach ($notices as $notice) {
3022 $ids[$notice->id] = true;
3024 return array_keys($ids);
3027 static function fillAttachments(&$notices)
3029 $ids = self::_idsOf($notices);
3030 $f2pMap = File_to_post::listGet('post_id', $ids);
3032 foreach ($f2pMap as $noticeId => $f2ps) {
3033 foreach ($f2ps as $f2p) {
3034 $fileIds[] = $f2p->file_id;
3038 $fileIds = array_unique($fileIds);
3039 $fileMap = File::pivotGet('id', $fileIds);
3040 foreach ($notices as $notice)
3043 $f2ps = $f2pMap[$notice->id];
3044 foreach ($f2ps as $f2p) {
3045 if (!isset($fileMap[$f2p->file_id])) {
3046 // We have probably deleted value from fileMap since
3047 // it as a NULL entry (see the following elseif).
3049 } elseif (is_null($fileMap[$f2p->file_id])) {
3050 // If the file id lookup returned a NULL value, it doesn't
3051 // exist in our file table! So this is a remnant file_to_post
3052 // entry that is no longer valid and should be removed.
3053 common_debug('ATTACHMENT deleting f2p for post_id='.$f2p->post_id.' file_id='.$f2p->file_id);
3055 unset($fileMap[$f2p->file_id]);
3058 $files[] = $fileMap[$f2p->file_id];
3060 $notice->_setAttachments($files);
3064 static function fillReplies(&$notices)
3066 $ids = self::_idsOf($notices);
3067 $replyMap = Reply::listGet('notice_id', $ids);
3068 foreach ($notices as $notice) {
3069 $replies = $replyMap[$notice->id];
3071 foreach ($replies as $reply) {
3072 $ids[] = $reply->profile_id;
3074 $notice->_setReplies($ids);
3078 static public function beforeSchemaUpdate()
3080 $table = strtolower(get_called_class());
3081 $schema = Schema::get();
3082 $schemadef = $schema->getTableDef($table);
3085 * Make sure constraints are met before upgrading, if foreign keys
3086 * are not already in use.
3089 if (!isset($schemadef['foreign keys'])) {
3090 $newschemadef = self::schemaDef();
3091 printfnq("\nConstraint checking Notice table...\n");
3093 * Improve typing and make sure no NULL values in any id-related columns are 0
3096 foreach (['reply_to', 'repeat_of'] as $field) {
3097 $notice = new Notice(); // reset the object
3098 $notice->query(sprintf('UPDATE %1$s SET %2$s=NULL WHERE %2$s=0', $notice->escapedTableName(), $field));
3099 // Now we're sure that no Notice entries have repeat_of=0, only an id > 0 or NULL
3104 * This Will find foreign keys which do not fulfill the constraints and fix
3105 * where appropriate, such as delete when "repeat_of" ID not found in notice.id
3106 * or set to NULL for "reply_to" in the same case.
3109 * XXX: How does this work if we would use multicolumn foreign keys?
3111 foreach (['reply_to' => 'reset', 'repeat_of' => 'delete', 'profile_id' => 'delete'] as $field=>$action) {
3112 $notice = new Notice();
3114 $fkeyname = $notice->tableName().'_'.$field.'_fkey';
3115 assert(isset($newschemadef['foreign keys'][$fkeyname]));
3116 assert($newschemadef['foreign keys'][$fkeyname]);
3118 $foreign_key = $newschemadef['foreign keys'][$fkeyname];
3119 $fkeytable = $foreign_key[0];
3120 assert(isset($foreign_key[1][$field]));
3121 $fkeycol = $foreign_key[1][$field];
3123 printfnq("* {$fkeyname} ({$field} => {$fkeytable}.{$fkeycol})\n");
3125 // NOTE: Above we set all repeat_of to NULL if they were 0, so this really gets them all.
3126 $notice->whereAdd(sprintf('%1$s NOT IN (SELECT %2$s FROM %3$s)', $field, $fkeycol, $fkeytable));
3127 if ($notice->find()) {
3128 printfnq("\tFound {$notice->N} notices with {$field} NOT IN notice.id, {$action}ing...");
3130 case 'delete': // since it's a directly dependant notice for an unknown ID we don't want it in our DB
3131 while ($notice->fetch()) {
3135 case 'reset': // just set it to NULL to be compatible with our constraints, if it was related to an unknown ID
3137 foreach ($notice->fetchAll('id') as $id) {
3138 settype($id, 'int');
3142 $notice = new Notice();
3143 $notice->query(sprintf('UPDATE %1$s SET %2$s=NULL WHERE id IN (%3$s)',
3144 $notice->escapedTableName(),
3146 implode(',', $ids)));
3149 throw new ServerException('The programmer sucks, invalid action name when fixing table.');
3151 printfnq("DONE.\n");
3157 // 2015-09-04 We move Notice location data to Notice_location
3158 // First we see if we have to do this at all
3159 if (!isset($schemadef['fields']['lat'])
3160 && !isset($schemadef['fields']['lon'])
3161 && !isset($schemadef['fields']['location_id'])
3162 && !isset($schemadef['fields']['location_ns'])) {
3163 // We have already removed the location fields, so no need to migrate.
3166 // Then we make sure the Notice_location table is created!
3167 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3169 // Then we continue on our road to migration!
3170 echo "\nFound old $table table, moving location data to 'notice_location' table... (this will probably take a LONG time, but can be aborted and continued)";
3172 $notice = new Notice();
3173 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3174 'WHERE lat IS NOT NULL ' .
3175 'OR lon IS NOT NULL ' .
3176 'OR location_id IS NOT NULL ' .
3177 'OR location_ns IS NOT NULL',
3178 $schema->quoteIdentifier($table)));
3179 print "\nFound {$notice->N} notices with location data, inserting";
3180 while ($notice->fetch()) {
3181 $notloc = Notice_location::getKV('notice_id', $notice->id);
3182 if ($notloc instanceof Notice_location) {
3186 $notloc = new Notice_location();
3187 $notloc->notice_id = $notice->id;
3188 $notloc->lat= $notice->lat;
3189 $notloc->lon= $notice->lon;
3190 $notloc->location_id= $notice->location_id;
3191 $notloc->location_ns= $notice->location_ns;