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()
254 if (Event::handle('GetNoticeTitle', array($this, &$title))) {
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) {
339 public static function getByUri($uri)
341 $notice = new Notice();
343 if (!$notice->find(true)) {
344 throw new NoResultException($notice);
350 * Extract #hashtags from this notice's content and save them to the database.
354 /* extract all #hastags */
355 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
360 /* Add them to the database */
361 return $this->saveKnownTags($match[1]);
365 * Record the given set of hash tags in the db for this notice.
366 * Given tag strings will be normalized and checked for dupes.
368 function saveKnownTags($hashtags)
370 //turn each into their canonical tag
371 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
372 for($i=0; $i<count($hashtags); $i++) {
373 /* elide characters we don't want in the tag */
374 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
377 foreach(array_unique($hashtags) as $hashtag) {
378 $this->saveTag($hashtag);
379 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
385 * Record a single hash tag as associated with this notice.
386 * Tag format and uniqueness must be validated by caller.
388 function saveTag($hashtag)
390 $tag = new Notice_tag();
391 $tag->notice_id = $this->id;
392 $tag->tag = $hashtag;
393 $tag->created = $this->created;
394 $id = $tag->insert();
397 // TRANS: Server exception. %s are the error details.
398 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
399 $last_error->message));
403 // if it's saved, blow its cache
404 $tag->blowCache(false);
408 * Save a new notice and push it out to subscribers' inboxes.
409 * Poster's permissions are checked before sending.
411 * @param int $profile_id Profile ID of the poster
412 * @param string $content source message text; links may be shortened
413 * per current user's preference
414 * @param string $source source key ('web', 'api', etc)
415 * @param array $options Associative array of optional properties:
416 * string 'created' timestamp of notice; defaults to now
417 * int 'is_local' source/gateway ID, one of:
418 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
419 * Notice::REMOTE - Sent from a remote service;
420 * hide from public timeline but show in
421 * local "and friends" timelines
422 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
423 * Notice::GATEWAY - From another non-OStatus service;
424 * will not appear in public views
425 * float 'lat' decimal latitude for geolocation
426 * float 'lon' decimal longitude for geolocation
427 * int 'location_id' geoname identifier
428 * int 'location_ns' geoname namespace to interpret location_id
429 * int 'reply_to'; notice ID this is a reply to
430 * int 'repeat_of'; notice ID this is a repeat of
431 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
432 * string 'url' permalink to notice; defaults to local notice URL
433 * string 'rendered' rendered HTML version of content
434 * array 'replies' list of profile URIs for reply delivery in
435 * place of extracting @-replies from content.
436 * array 'groups' list of group IDs to deliver to, in place of
437 * extracting ! tags from content
438 * array 'tags' list of hashtag strings to save with the notice
439 * in place of extracting # tags from content
440 * array 'urls' list of attached/referred URLs to save with the
441 * notice in place of extracting links from content
442 * boolean 'distribute' whether to distribute the notice, default true
443 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
444 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
445 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
447 * @fixme tag override
450 * @throws ClientException
452 static function saveNew($profile_id, $content, $source, array $options=null) {
453 $defaults = array('uri' => null,
455 'conversation' => null, // URI of conversation
456 'reply_to' => null, // This will override convo URI if the parent is known
457 'repeat_of' => null, // This will override convo URI if the repeated notice is known
459 'distribute' => true,
460 'object_type' => null,
463 if (!empty($options) && is_array($options)) {
464 $options = array_merge($defaults, $options);
470 if (!isset($is_local)) {
471 $is_local = Notice::LOCAL_PUBLIC;
474 $profile = Profile::getKV('id', $profile_id);
475 if (!$profile instanceof Profile) {
476 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
477 throw new ClientException(_('Problem saving notice. Unknown user.'));
480 $user = User::getKV('id', $profile_id);
481 if ($user instanceof User) {
482 // Use the local user's shortening preferences, if applicable.
483 $final = $user->shortenLinks($content);
485 $final = common_shorten_links($content);
488 if (Notice::contentTooLong($final)) {
489 // TRANS: Client exception thrown if a notice contains too many characters.
490 throw new ClientException(_('Problem saving notice. Too long.'));
493 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
494 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
495 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
496 throw new ClientException(_('Too many notices too fast; take a breather '.
497 'and post again in a few minutes.'));
500 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
501 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
502 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
503 throw new ClientException(_('Too many duplicate messages too quickly;'.
504 ' take a breather and post again in a few minutes.'));
507 if (!$profile->hasRight(Right::NEWNOTICE)) {
508 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
510 // TRANS: Client exception thrown when a user tries to post while being banned.
511 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
514 $notice = new Notice();
515 $notice->profile_id = $profile_id;
517 if ($source && in_array($source, common_config('public', 'autosource'))) {
518 $notice->is_local = Notice::LOCAL_NONPUBLIC;
520 $notice->is_local = $is_local;
523 if (!empty($created)) {
524 $notice->created = $created;
526 $notice->created = common_sql_now();
529 if (!$notice->isLocal()) {
530 // Only do these checks for non-local notices. Local notices will generate these values later.
532 throw new ServerException('No URI for remote notice. Cannot accept that.');
536 $notice->content = $final;
538 $notice->source = $source;
542 // Get the groups here so we can figure out replies and such
543 if (!isset($groups)) {
544 $groups = User_group::idsFromText($notice->content, $profile);
549 // Handle repeat case
551 if (!empty($options['repeat_of'])) {
553 // Check for a private one
555 $repeat = Notice::getByID($options['repeat_of']);
557 if ($profile->sameAs($repeat->getProfile())) {
558 // TRANS: Client error displayed when trying to repeat an own notice.
559 throw new ClientException(_('You cannot repeat your own notice.'));
562 if ($repeat->scope != Notice::SITE_SCOPE &&
563 $repeat->scope != Notice::PUBLIC_SCOPE) {
564 // TRANS: Client error displayed when trying to repeat a non-public notice.
565 throw new ClientException(_('Cannot repeat a private notice.'), 403);
568 if (!$repeat->inScope($profile)) {
569 // The generic checks above should cover this, but let's be sure!
570 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
571 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
574 if ($profile->hasRepeated($repeat)) {
575 // TRANS: Client error displayed when trying to repeat an already repeated notice.
576 throw new ClientException(_('You already repeated that notice.'));
579 $notice->repeat_of = $repeat->id;
580 $notice->conversation = $repeat->conversation;
584 // If $reply_to is specified, we check that it exists, and then
585 // return it if it does
586 if (!empty($reply_to)) {
587 $reply = Notice::getKV('id', $reply_to);
588 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
589 // If the source lacks capability of sending the "reply_to"
590 // metadata, let's try to find an inline replyto-reference.
591 $reply = self::getInlineReplyTo($profile, $final);
594 if ($reply instanceof Notice) {
595 if (!$reply->inScope($profile)) {
596 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
597 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
598 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
599 $profile->nickname, $reply->id), 403);
602 // If it's a repeat, the reply_to should be to the original
603 if ($reply->isRepeat()) {
604 $notice->reply_to = $reply->repeat_of;
606 $notice->reply_to = $reply->id;
608 // But the conversation ought to be the same :)
609 $notice->conversation = $reply->conversation;
611 // If the original is private to a group, and notice has
612 // no group specified, make it to the same group(s)
614 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
616 $replyGroups = $reply->getGroups();
617 foreach ($replyGroups as $group) {
618 if ($profile->isMember($group)) {
619 $groups[] = $group->id;
627 // If we don't know the reply, we might know the conversation!
628 // This will happen if a known remote user replies to an
629 // unknown remote user - within a known conversation.
630 if (empty($notice->conversation) and !empty($options['conversation'])) {
631 $conv = Conversation::getKV('uri', $options['conversation']);
632 if ($conv instanceof Conversation) {
633 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.').');
635 // Conversation entry with specified URI was not found, so we must create it.
636 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
637 // The insert in Conversation::create throws exception on failure
638 $conv = Conversation::create($options['conversation'], $notice->created);
640 $notice->conversation = $conv->getID();
645 // If it's not part of a conversation, it's the beginning of a new conversation.
646 if (empty($notice->conversation)) {
647 $conv = Conversation::create();
648 $notice->conversation = $conv->getID();
653 $notloc = new Notice_location();
654 if (!empty($lat) && !empty($lon)) {
659 if (!empty($location_ns) && !empty($location_id)) {
660 $notloc->location_id = $location_id;
661 $notloc->location_ns = $location_ns;
664 if (!empty($rendered)) {
665 $notice->rendered = $rendered;
667 $notice->rendered = common_render_content($final,
668 $notice->getProfile(),
669 $notice->hasParent() ? $notice->getParent() : null);
673 if ($notice->isRepeat()) {
674 $notice->verb = ActivityVerb::SHARE;
675 $notice->object_type = ActivityObject::ACTIVITY;
677 $notice->verb = ActivityVerb::POST;
680 $notice->verb = $verb;
683 if (empty($object_type)) {
684 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
686 $notice->object_type = $object_type;
689 if (is_null($scope) && $reply instanceof Notice) {
690 $notice->scope = $reply->scope;
692 $notice->scope = $scope;
695 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
697 if (Event::handle('StartNoticeSave', array(&$notice))) {
699 // XXX: some of these functions write to the DB
702 $notice->insert(); // throws exception on failure, if successful we have an ->id
704 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
705 $notloc->notice_id = $notice->getID();
706 $notloc->insert(); // store the notice location if it had any information
708 } catch (Exception $e) {
709 // Let's test if we managed initial insert, which would imply
710 // failing on some update-part (check 'insert()'). Delete if
711 // something had been stored to the database.
712 if (!empty($notice->id)) {
719 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
720 // the activityverb is a POST (since stuff like repeat, favorite etc.
721 // reasonably handle notifications themselves.
722 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
723 if (isset($replies)) {
724 $notice->saveKnownReplies($replies);
726 $notice->saveReplies();
730 $notice->saveKnownTags($tags);
735 // Note: groups may save tags, so must be run after tags are saved
736 // to avoid errors on duplicates.
737 // Note: groups should always be set.
739 $notice->saveKnownGroups($groups);
742 $notice->saveKnownUrls($urls);
749 // Prepare inbox delivery, may be queued to background.
750 $notice->distribute();
756 static function saveActivity(Activity $act, Profile $actor, array $options=array())
758 // First check if we're going to let this Activity through from the specific actor
759 if (!$actor->hasRight(Right::NEWNOTICE)) {
760 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
762 // TRANS: Client exception thrown when a user tries to post while being banned.
763 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
765 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
766 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
767 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
768 throw new ClientException(_m('Too many notices too fast; take a breather '.
769 'and post again in a few minutes.'));
772 // Get ActivityObject properties
774 if (!empty($act->id)) {
776 $options['uri'] = $act->id;
777 $options['url'] = $act->link;
779 $actobj = count($act->objects)===1 ? $act->objects[0] : null;
780 if (!is_null($actobj) && !empty($actobj->id)) {
781 $options['uri'] = $actobj->id;
783 $options['url'] = $actobj->link;
784 } elseif (preg_match('!^https?://!', $actobj->id)) {
785 $options['url'] = $actobj->id;
792 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
793 'mentions' => array(),
797 'source' => 'unknown',
802 'distribute' => true);
804 // options will have default values when nothing has been supplied
805 $options = array_merge($defaults, $options);
806 foreach (array_keys($defaults) as $key) {
807 // Only convert the keynames we specify ourselves from 'defaults' array into variables
808 $$key = $options[$key];
810 extract($options, EXTR_SKIP);
813 $stored = new Notice();
814 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
816 if ($stored->find()) {
817 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
818 // I _assume_ saving a Notice with a colliding URI means we're really trying to
819 // save the same notice again...
820 throw new AlreadyFulfilledException('Notice URI already exists');
824 // NOTE: Sandboxed users previously got all the notices _during_
825 // sandbox period set to to is_local=Notice::LOCAL_NONPUBLIC here.
826 // Since then we have started just filtering _when_ it gets shown
827 // instead of creating a mixed jumble of differently scoped notices.
829 if ($source && in_array($source, common_config('public', 'autosource'))) {
830 $stored->is_local = Notice::LOCAL_NONPUBLIC;
832 $stored->is_local = intval($is_local);
835 if (!$stored->isLocal()) {
836 // Only do these checks for non-local notices. Local notices will generate these values later.
837 if (!common_valid_http_url($url)) {
838 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
841 throw new ServerException('No URI for remote notice. Cannot accept that.');
845 $stored->profile_id = $actor->getID();
846 $stored->source = $source;
849 $stored->verb = $act->verb;
851 // we use mb_strlen because it _might_ be that the content is just the string "0"...
852 $content = mb_strlen($act->content) ? $act->content : $act->summary;
853 if (mb_strlen($content)===0 && !is_null($actobj)) {
854 $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
856 // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
857 $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
858 $stored->content = common_strip_html($stored->getRendered(), true, true);
859 if (trim($stored->content) === '') {
860 // TRANS: Error message when the plain text content of a notice has zero length.
861 throw new ClientException(_('Empty notice content, will not save this.'));
863 unset($content); // garbage collect
865 // Maybe a missing act-time should be fatal if the actor is not local?
866 if (!empty($act->time)) {
867 $stored->created = common_sql_date($act->time);
869 $stored->created = common_sql_now();
872 $reply = null; // this will store the in-reply-to Notice if found
873 $replyUris = []; // this keeps a list of possible URIs to look up
874 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
875 $replyUris[] = $act->context->replyToID;
877 if ($act->target instanceof ActivityObject && !empty($act->target->id)) {
878 $replyUris[] = $act->target->id;
880 foreach (array_unique($replyUris) as $replyUri) {
881 $reply = self::getKV('uri', $replyUri);
882 // Only do remote fetching if we're not a private site
883 if (!common_config('site', 'private') && !$reply instanceof Notice) {
884 // the URI is the object we're looking for, $actor is a
885 // Profile that surely knows of it and &$reply where it
886 // will be stored when fetched
887 Event::handle('FetchRemoteNotice', array($replyUri, $actor, &$reply));
889 // we got what we're in-reply-to now, so let's move on
890 if ($reply instanceof Notice) {
893 // otherwise reset whatever we might've gotten from the event
896 unset($replyUris); // garbage collect
898 if ($reply instanceof Notice) {
899 if (!$reply->inScope($actor)) {
900 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
901 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
902 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
905 $stored->reply_to = $reply->id;
906 $stored->conversation = $reply->conversation;
908 // If the original is private to a group, and notice has no group specified,
909 // make it to the same group(s)
910 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
911 $replyGroups = $reply->getGroups();
912 foreach ($replyGroups as $group) {
913 if ($actor->isMember($group)) {
914 $groups[] = $group->id;
919 if (is_null($scope)) {
920 $scope = $reply->scope;
923 // If we don't know the reply, we might know the conversation!
924 // This will happen if a known remote user replies to an
925 // unknown remote user - within a known conversation.
926 if (empty($stored->conversation) and !empty($act->context->conversation)) {
927 $conv = Conversation::getKV('uri', $act->context->conversation);
928 if ($conv instanceof Conversation) {
929 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.').');
931 // Conversation entry with specified URI was not found, so we must create it.
932 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
933 // The insert in Conversation::create throws exception on failure
934 $conv = Conversation::create($act->context->conversation, $stored->created);
936 $stored->conversation = $conv->getID();
940 unset($reply); // garbage collect
942 // If it's not part of a conversation, it's the beginning of a new conversation.
943 if (empty($stored->conversation)) {
944 $conv = Conversation::create();
945 $stored->conversation = $conv->getID();
950 if ($act->context instanceof ActivityContext) {
951 if ($act->context->location instanceof Location) {
952 $notloc = Notice_location::fromLocation($act->context->location);
955 $act->context = new ActivityContext();
958 if (array_key_exists('http://activityschema.org/collection/public', $act->context->attention)) {
959 $stored->scope = Notice::PUBLIC_SCOPE;
960 // TODO: maybe we should actually keep this? if the saveAttentions thing wants to use it...
961 unset($act->context->attention['http://activityschema.org/collection/public']);
963 $stored->scope = self::figureOutScope($actor, $groups, $scope);
966 foreach ($act->categories as $cat) {
968 $term = common_canonical_tag($cat->term);
975 foreach ($act->enclosures as $href) {
976 // @todo FIXME: Save these locally or....?
980 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
981 if (empty($act->objects[0]->type)) {
982 // Default type for the post verb is 'note', but we know it's
983 // a 'comment' if it is in reply to something.
984 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
986 //TODO: Is it safe to always return a relative URI? The
987 // JSON version of ActivityStreams always use it, so we
988 // should definitely be able to handle it...
989 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
993 if (Event::handle('StartNoticeSave', array(&$stored))) {
994 // XXX: some of these functions write to the DB
997 $result = $stored->insert(); // throws exception on error
999 if ($notloc instanceof Notice_location) {
1000 $notloc->notice_id = $stored->getID();
1004 $orig = clone($stored); // for updating later in this try clause
1007 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
1008 if (empty($object)) {
1009 throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
1013 // If something changed in the Notice during StoreActivityObject
1014 $stored->update($orig);
1015 } catch (Exception $e) {
1016 if (empty($stored->id)) {
1017 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
1019 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
1025 unset($notloc); // garbage collect
1027 if (!$stored instanceof Notice) {
1028 throw new ServerException('StartNoticeSave did not give back a Notice.');
1029 } elseif (empty($stored->id)) {
1030 throw new ServerException('Supposedly saved Notice has no ID.');
1033 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
1034 // the activityverb is a POST (since stuff like repeat, favorite etc.
1035 // reasonably handle notifications themselves.
1036 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
1038 if (!empty($tags)) {
1039 $stored->saveKnownTags($tags);
1041 $stored->saveTags();
1044 // Note: groups may save tags, so must be run after tags are saved
1045 // to avoid errors on duplicates.
1046 $stored->saveAttentions($act->context->attention);
1048 if (!empty($urls)) {
1049 $stored->saveKnownUrls($urls);
1051 $stored->saveUrls();
1056 // Prepare inbox delivery, may be queued to background.
1057 $stored->distribute();
1063 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1064 $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1066 // For private streams
1068 $user = $actor->getUser();
1069 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1070 if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1071 $scope |= Notice::FOLLOWER_SCOPE;
1073 } catch (NoSuchUserException $e) {
1074 // TODO: Not a local user, so we don't know about scope preferences... yet!
1077 // Force the scope for private groups
1078 foreach ($groups as $group_id) {
1080 $group = User_group::getByID($group_id);
1081 if ($group->force_scope) {
1082 $scope |= Notice::GROUP_SCOPE;
1085 } catch (Exception $e) {
1086 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1093 function blowOnInsert($conversation = false)
1095 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1097 if ($this->isPublic()) {
1098 $this->blowStream('public');
1099 $this->blowStream('networkpublic');
1102 if ($this->conversation) {
1103 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1104 self::blow('conversation:notice_count:%d', $this->conversation);
1107 if ($this->isRepeat()) {
1108 // XXX: we should probably only use one of these
1109 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1110 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1113 $original = Notice::getKV('id', $this->repeat_of);
1115 if ($original instanceof Notice) {
1116 $originalUser = User::getKV('id', $original->profile_id);
1117 if ($originalUser instanceof User) {
1118 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1122 $profile = Profile::getKV($this->profile_id);
1124 if ($profile instanceof Profile) {
1125 $profile->blowNoticeCount();
1128 $ptags = $this->getProfileTags();
1129 foreach ($ptags as $ptag) {
1130 $ptag->blowNoticeStreamCache();
1135 * Clear cache entries related to this notice at delete time.
1136 * Necessary to avoid breaking paging on public, profile timelines.
1138 function blowOnDelete()
1140 $this->blowOnInsert();
1142 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1144 if ($this->isPublic()) {
1145 self::blow('public;last');
1146 self::blow('networkpublic;last');
1149 self::blow('fave:by_notice', $this->id);
1151 if ($this->conversation) {
1152 // In case we're the first, will need to calc a new root.
1153 self::blow('notice:conversation_root:%d', $this->conversation);
1156 $ptags = $this->getProfileTags();
1157 foreach ($ptags as $ptag) {
1158 $ptag->blowNoticeStreamCache(true);
1162 function blowStream()
1164 $c = self::memcache();
1170 $args = func_get_args();
1171 $format = array_shift($args);
1172 $keyPart = vsprintf($format, $args);
1173 $cacheKey = Cache::key($keyPart);
1174 $c->delete($cacheKey);
1176 // delete the "last" stream, too, if this notice is
1177 // older than the top of that stream
1179 $lastKey = $cacheKey.';last';
1181 $lastStr = $c->get($lastKey);
1183 if ($lastStr !== false) {
1184 $window = explode(',', $lastStr);
1185 $lastID = $window[0];
1186 $lastNotice = Notice::getKV('id', $lastID);
1187 if (!$lastNotice instanceof Notice // just weird
1188 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1189 $c->delete($lastKey);
1194 /** save all urls in the notice to the db
1196 * follow redirects and save all available file information
1197 * (mimetype, date, size, oembed, etc.)
1201 function saveUrls() {
1202 if (common_config('attachments', 'process_links')) {
1203 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1208 * Save the given URLs as related links/attachments to the db
1210 * follow redirects and save all available file information
1211 * (mimetype, date, size, oembed, etc.)
1215 function saveKnownUrls($urls)
1217 if (common_config('attachments', 'process_links')) {
1218 // @fixme validation?
1219 foreach (array_unique($urls) as $url) {
1220 $this->saveUrl($url, $this);
1228 function saveUrl($url, Notice $notice) {
1230 File::processNew($url, $notice);
1231 } catch (ServerException $e) {
1232 // Could not save URL. Log it?
1236 static function checkDupes($profile_id, $content) {
1237 $profile = Profile::getKV($profile_id);
1238 if (!$profile instanceof Profile) {
1241 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1242 if (!empty($notice)) {
1244 while ($notice->fetch()) {
1245 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1247 } else if ($notice->content == $content) {
1252 // If we get here, oldest item in cache window is not
1253 // old enough for dupe limit; do direct check against DB
1254 $notice = new Notice();
1255 $notice->profile_id = $profile_id;
1256 $notice->content = $content;
1257 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1258 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1260 $cnt = $notice->count();
1264 static function checkEditThrottle($profile_id) {
1265 $profile = Profile::getKV($profile_id);
1266 if (!$profile instanceof Profile) {
1269 // Get the Nth notice
1270 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1271 if ($notice && $notice->fetch()) {
1272 // If the Nth notice was posted less than timespan seconds ago
1273 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1278 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1282 protected $_attachments = array();
1284 function attachments() {
1285 if (isset($this->_attachments[$this->id])) {
1286 return $this->_attachments[$this->id];
1289 $f2ps = File_to_post::listGet('post_id', array($this->id));
1291 foreach ($f2ps[$this->id] as $f2p) {
1292 $ids[] = $f2p->file_id;
1295 return $this->_setAttachments(File::multiGet('id', $ids)->fetchAll());
1298 public function _setAttachments(array $attachments)
1300 return $this->_attachments[$this->id] = $attachments;
1303 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1305 $stream = new PublicNoticeStream();
1306 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1309 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null, Profile $scoped=null)
1311 $stream = new ConversationNoticeStream($id, $scoped);
1312 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1316 * Is this notice part of an active conversation?
1318 * @return boolean true if other messages exist in the same
1319 * conversation, false if this is the only one
1321 function hasConversation()
1323 if (empty($this->conversation)) {
1324 // this notice is not part of a conversation apparently
1325 // FIXME: all notices should have a conversation value, right?
1329 //FIXME: Get the Profile::current() stuff some other way
1330 // to avoid confusion between queue processing and session.
1331 $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
1333 // if our "offset 1, limit 1" query got a result, return true else false
1334 return $notice->N > 0;
1338 * Grab the earliest notice from this conversation.
1340 * @return Notice or null
1342 function conversationRoot($profile=-1)
1344 // XXX: can this happen?
1346 if (empty($this->conversation)) {
1350 // Get the current profile if not specified
1352 if (is_int($profile) && $profile == -1) {
1353 $profile = Profile::current();
1356 // If this notice is out of scope, no root for you!
1358 if (!$this->inScope($profile)) {
1362 // If this isn't a reply to anything, then it's its own
1363 // root if it's the earliest notice in the conversation:
1365 if (empty($this->reply_to)) {
1367 $root->conversation = $this->conversation;
1368 $root->orderBy('notice.created ASC');
1369 $root->find(true); // true means "fetch first result"
1374 if (is_null($profile)) {
1375 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1377 $keypart = sprintf('notice:conversation_root:%d:%d',
1382 $root = self::cacheGet($keypart);
1384 if ($root !== false && $root->inScope($profile)) {
1391 $parent = $last->getParent();
1392 if ($parent->inScope($profile)) {
1396 } catch (NoParentNoticeException $e) {
1397 // Latest notice has no parent
1398 } catch (NoResultException $e) {
1399 // Notice was not found, so we can't go further up in the tree.
1400 // FIXME: Maybe we should do this in a more stable way where deleted
1401 // notices won't break conversation chains?
1403 // No parent, or parent out of scope
1408 self::cacheSet($keypart, $root);
1414 * Pull up a full list of local recipients who will be getting
1415 * this notice in their inbox. Results will be cached, so don't
1416 * change the input data wily-nilly!
1418 * @param array $groups optional list of Group objects;
1419 * if left empty, will be loaded from group_inbox records
1420 * @param array $recipient optional list of reply profile ids
1421 * if left empty, will be loaded from reply records
1422 * @return array associating recipient user IDs with an inbox source constant
1424 function whoGets(array $groups=null, array $recipients=null)
1426 $c = self::memcache();
1429 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1430 if ($ni !== false) {
1435 if (is_null($recipients)) {
1436 $recipients = $this->getReplies();
1441 // Give plugins a chance to add folks in at start...
1442 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1444 $users = $this->getSubscribedUsers();
1445 foreach ($users as $id) {
1446 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1449 if (is_null($groups)) {
1450 $groups = $this->getGroups();
1452 foreach ($groups as $group) {
1453 $users = $group->getUserMembers();
1454 foreach ($users as $id) {
1455 if (!array_key_exists($id, $ni)) {
1456 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1461 $ptAtts = $this->getAttentionsFromProfileTags();
1462 foreach ($ptAtts as $key=>$val) {
1463 if (!array_key_exists($key, $ni)) {
1468 foreach ($recipients as $recipient) {
1469 if (!array_key_exists($recipient, $ni)) {
1470 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1474 // Exclude any deleted, non-local, or blocking recipients.
1475 $profile = $this->getProfile();
1476 $originalProfile = null;
1477 if ($this->isRepeat()) {
1478 // Check blocks against the original notice's poster as well.
1479 $original = Notice::getKV('id', $this->repeat_of);
1480 if ($original instanceof Notice) {
1481 $originalProfile = $original->getProfile();
1485 foreach ($ni as $id => $source) {
1487 $user = User::getKV('id', $id);
1488 if (!$user instanceof User ||
1489 $user->hasBlocked($profile) ||
1490 ($originalProfile && $user->hasBlocked($originalProfile))) {
1493 } catch (UserNoProfileException $e) {
1494 // User doesn't have a profile; invalid; skip them.
1499 // Give plugins a chance to filter out...
1500 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1504 // XXX: pack this data better
1505 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1511 function getSubscribedUsers()
1515 if(common_config('db','quote_identifiers'))
1516 $user_table = '"user"';
1517 else $user_table = 'user';
1521 'FROM '. $user_table .' JOIN subscription '.
1522 'ON '. $user_table .'.id = subscription.subscriber ' .
1523 'WHERE subscription.subscribed = %d ';
1525 $user->query(sprintf($qry, $this->profile_id));
1529 while ($user->fetch()) {
1538 function getProfileTags()
1540 $profile = $this->getProfile();
1541 $list = $profile->getOtherTags($profile);
1544 while($list->fetch()) {
1545 $ptags[] = clone($list);
1551 public function getAttentionsFromProfileTags()
1554 $ptags = $this->getProfileTags();
1555 foreach ($ptags as $ptag) {
1556 $users = $ptag->getUserSubscribers();
1557 foreach ($users as $id) {
1558 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1565 * Record this notice to the given group inboxes for delivery.
1566 * Overrides the regular parsing of !group markup.
1568 * @param string $group_ids
1569 * @fixme might prefer URIs as identifiers, as for replies?
1570 * best with generalizations on user_group to support
1571 * remote groups better.
1573 function saveKnownGroups(array $group_ids)
1576 foreach (array_unique($group_ids) as $id) {
1577 $group = User_group::getKV('id', $id);
1578 if ($group instanceof User_group) {
1579 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1580 $result = $this->addToGroupInbox($group);
1582 common_log_db_error($gi, 'INSERT', __FILE__);
1585 if (common_config('group', 'addtag')) {
1586 // we automatically add a tag for every group name, too
1588 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1589 'notice_id' => $this->id));
1591 if (is_null($tag)) {
1592 $this->saveTag($group->nickname);
1596 $groups[] = clone($group);
1598 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1605 function addToGroupInbox(User_group $group)
1607 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1608 'notice_id' => $this->id));
1610 if (!$gi instanceof Group_inbox) {
1612 $gi = new Group_inbox();
1614 $gi->group_id = $group->id;
1615 $gi->notice_id = $this->id;
1616 $gi->created = $this->created;
1618 $result = $gi->insert();
1621 common_log_db_error($gi, 'INSERT', __FILE__);
1622 // TRANS: Server exception thrown when an update for a group inbox fails.
1623 throw new ServerException(_('Problem saving group inbox.'));
1626 self::blow('user_group:notice_ids:%d', $gi->group_id);
1632 function saveAttentions(array $uris)
1634 foreach ($uris as $uri=>$type) {
1636 $target = Profile::fromUri($uri);
1637 } catch (UnknownUriException $e) {
1638 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1643 $this->saveAttention($target);
1644 } catch (AlreadyFulfilledException $e) {
1645 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1646 } catch (Exception $e) {
1647 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1653 * Saves an attention for a profile (user or group) which means
1654 * it shows up in their home feed and such.
1656 function saveAttention(Profile $target, $reason=null)
1658 if ($target->isGroup()) {
1659 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1661 // legacy notification method, will still be in use for quite a while I think
1662 $this->addToGroupInbox($target->getGroup());
1664 if ($target->hasBlocked($this->getProfile())) {
1665 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1670 if ($target->isLocal()) {
1671 // legacy notification method, will still be in use for quite a while I think
1672 $this->saveReply($target->getID());
1675 $att = Attention::saveNew($this, $target, $reason);
1680 * Save reply records indicating that this notice needs to be
1681 * delivered to the local users with the given URIs.
1683 * Since this is expected to be used when saving foreign-sourced
1684 * messages, we won't deliver to any remote targets as that's the
1685 * source service's responsibility.
1687 * Mail notifications etc will be handled later.
1689 * @param array $uris Array of unique identifier URIs for recipients
1691 function saveKnownReplies(array $uris)
1697 $sender = $this->getProfile();
1699 foreach (array_unique($uris) as $uri) {
1701 $profile = Profile::fromUri($uri);
1702 } catch (UnknownUriException $e) {
1703 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1707 if ($profile->hasBlocked($sender)) {
1708 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1712 $this->saveReply($profile->getID());
1713 self::blow('reply:stream:%d', $profile->getID());
1718 * Pull @-replies from this message's content in StatusNet markup format
1719 * and save reply records indicating that this message needs to be
1720 * delivered to those users.
1722 * Mail notifications to local profiles will be sent later.
1724 * @return array of integer profile IDs
1727 function saveReplies()
1729 $sender = $this->getProfile();
1733 // If it's a reply, save for the replied-to author
1735 $parent = $this->getParent();
1736 $parentauthor = $parent->getProfile();
1737 $this->saveReply($parentauthor->getID());
1738 $replied[$parentauthor->getID()] = 1;
1739 self::blow('reply:stream:%d', $parentauthor->getID());
1740 } catch (NoParentNoticeException $e) {
1741 // Not a reply, since it has no parent!
1743 } catch (NoResultException $e) {
1744 // Parent notice was probably deleted
1748 // @todo ideally this parser information would only
1749 // be calculated once.
1751 $mentions = common_find_mentions($this->content, $sender, $parent);
1753 foreach ($mentions as $mention) {
1755 foreach ($mention['mentioned'] as $mentioned) {
1757 // skip if they're already covered
1758 if (array_key_exists($mentioned->id, $replied)) {
1762 // Don't save replies from blocked profile to local user
1763 if ($mentioned->hasBlocked($sender)) {
1767 $this->saveReply($mentioned->id);
1768 $replied[$mentioned->id] = 1;
1769 self::blow('reply:stream:%d', $mentioned->id);
1773 $recipientIds = array_keys($replied);
1775 return $recipientIds;
1778 function saveReply($profileId)
1780 $reply = new Reply();
1782 $reply->notice_id = $this->id;
1783 $reply->profile_id = $profileId;
1784 $reply->modified = $this->created;
1791 protected $_attentionids = array();
1794 * Pull the complete list of known activity context attentions for this notice.
1796 * @return array of integer profile ids (also group profiles)
1798 function getAttentionProfileIDs()
1800 if (!isset($this->_attentionids[$this->getID()])) {
1801 $atts = Attention::multiGet('notice_id', array($this->getID()));
1802 // (array)null means empty array
1803 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1805 return $this->_attentionids[$this->getID()];
1808 protected $_replies = array();
1811 * Pull the complete list of @-mentioned profile IDs for this notice.
1813 * @return array of integer profile ids
1815 function getReplies()
1817 if (!isset($this->_replies[$this->getID()])) {
1818 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1819 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1821 return $this->_replies[$this->getID()];
1824 function _setReplies($replies)
1826 $this->_replies[$this->getID()] = $replies;
1830 * Pull the complete list of @-reply targets for this notice.
1832 * @return array of Profiles
1834 function getAttentionProfiles()
1836 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1838 $profiles = Profile::multiGet('id', (array)$ids);
1840 return $profiles->fetchAll();
1844 * Send e-mail notifications to local @-reply targets.
1846 * Replies must already have been saved; this is expected to be run
1847 * from the distrib queue handler.
1849 function sendReplyNotifications()
1851 // Don't send reply notifications for repeats
1852 if ($this->isRepeat()) {
1856 $recipientIds = $this->getReplies();
1857 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1858 require_once INSTALLDIR.'/lib/mail.php';
1860 foreach ($recipientIds as $recipientId) {
1862 $user = User::getByID($recipientId);
1863 mail_notify_attn($user->getProfile(), $this);
1864 } catch (NoResultException $e) {
1868 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1873 * Pull list of Profile IDs of groups this notice addresses.
1875 * @return array of Group _profile_ IDs
1878 function getGroupProfileIDs()
1882 foreach ($this->getGroups() as $group) {
1883 $ids[] = $group->profile_id;
1890 * Pull list of groups this notice needs to be delivered to,
1891 * as previously recorded by saveKnownGroups().
1893 * @return array of Group objects
1896 protected $_groups = array();
1898 function getGroups()
1900 // Don't save groups for repeats
1902 if (!empty($this->repeat_of)) {
1906 if (isset($this->_groups[$this->id])) {
1907 return $this->_groups[$this->id];
1910 $gis = Group_inbox::listGet('notice_id', array($this->id));
1914 foreach ($gis[$this->id] as $gi) {
1915 $ids[] = $gi->group_id;
1918 $groups = User_group::multiGet('id', $ids);
1919 $this->_groups[$this->id] = $groups->fetchAll();
1920 return $this->_groups[$this->id];
1923 function _setGroups($groups)
1925 $this->_groups[$this->id] = $groups;
1929 * Convert a notice into an activity for export.
1931 * @param Profile $scoped The currently logged in/scoped profile
1933 * @return Activity activity object representing this Notice.
1936 function asActivity(Profile $scoped=null)
1938 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1940 if ($act instanceof Activity) {
1943 $act = new Activity();
1945 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1947 $act->id = $this->uri;
1948 $act->time = strtotime($this->created);
1950 $act->link = $this->getUrl();
1951 } catch (InvalidUrlException $e) {
1952 // The notice is probably a share or similar, which don't
1953 // have a representational URL of their own.
1955 $act->content = common_xml_safe_str($this->getRendered());
1957 $profile = $this->getProfile();
1959 $act->actor = $profile->asActivityObject();
1960 $act->actor->extra[] = $profile->profileInfo($scoped);
1962 $act->verb = $this->verb;
1964 if (!$this->repeat_of) {
1965 $act->objects[] = $this->asActivityObject();
1968 // XXX: should this be handled by default processing for object entry?
1972 $tags = $this->getTags();
1974 foreach ($tags as $tag) {
1975 $cat = new AtomCategory();
1978 $act->categories[] = $cat;
1982 // XXX: use Atom Media and/or File activity objects instead
1984 $attachments = $this->attachments();
1986 foreach ($attachments as $attachment) {
1987 // Include local attachments in Activity
1988 if (!empty($attachment->filename)) {
1989 $act->enclosures[] = $attachment->getEnclosure();
1993 $ctx = new ActivityContext();
1996 $reply = $this->getParent();
1997 $ctx->replyToID = $reply->getUri();
1998 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1999 } catch (NoParentNoticeException $e) {
2000 // This is not a reply to something
2001 } catch (NoResultException $e) {
2002 // Parent notice was probably deleted
2006 $ctx->location = Notice_location::locFromStored($this);
2007 } catch (ServerException $e) {
2008 $ctx->location = null;
2013 if (!empty($this->conversation)) {
2014 $conv = Conversation::getKV('id', $this->conversation);
2015 if ($conv instanceof Conversation) {
2016 $ctx->conversation = $conv->uri;
2020 // This covers the legacy getReplies and getGroups too which get their data
2021 // from entries stored via Notice::saveNew (which we want to move away from)...
2022 foreach ($this->getAttentionProfiles() as $target) {
2023 // User and group profiles which get the attention of this notice
2024 $ctx->attention[$target->getUri()] = $target->getObjectType();
2027 switch ($this->scope) {
2028 case Notice::PUBLIC_SCOPE:
2029 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2031 case Notice::FOLLOWER_SCOPE:
2032 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2033 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2037 $act->context = $ctx;
2039 $source = $this->getSource();
2041 if ($source instanceof Notice_source) {
2042 $act->generator = ActivityObject::fromNoticeSource($source);
2047 $atom_feed = $profile->getAtomFeed();
2049 if (!empty($atom_feed)) {
2051 $act->source = new ActivitySource();
2053 // XXX: we should store the actual feed ID
2055 $act->source->id = $atom_feed;
2057 // XXX: we should store the actual feed title
2059 $act->source->title = $profile->getBestName();
2061 $act->source->links['alternate'] = $profile->profileurl;
2062 $act->source->links['self'] = $atom_feed;
2064 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2066 $notice = $profile->getCurrentNotice();
2068 if ($notice instanceof Notice) {
2069 $act->source->updated = self::utcDate($notice->created);
2072 $user = User::getKV('id', $profile->id);
2074 if ($user instanceof User) {
2075 $act->source->links['license'] = common_config('license', 'url');
2079 if ($this->isLocal()) {
2080 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2081 'format' => 'atom'));
2082 $act->editLink = $act->selfLink;
2085 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2088 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2093 // This has gotten way too long. Needs to be sliced up into functional bits
2094 // or ideally exported to a utility class.
2096 function asAtomEntry($namespace=false,
2099 Profile $scoped=null)
2101 $act = $this->asActivity($scoped);
2102 $act->extra[] = $this->noticeInfo($scoped);
2103 return $act->asString($namespace, $author, $source);
2107 * Extra notice info for atom entries
2109 * Clients use some extra notice info in the atom stream.
2110 * This gives it to them.
2112 * @param Profile $scoped The currently logged in/scoped profile
2114 * @return array representation of <statusnet:notice_info> element
2117 function noticeInfo(Profile $scoped=null)
2119 // local notice ID (useful to clients for ordering)
2121 $noticeInfoAttr = array('local_id' => $this->id);
2125 $ns = $this->getSource();
2127 if ($ns instanceof Notice_source) {
2128 $noticeInfoAttr['source'] = $ns->code;
2129 if (!empty($ns->url)) {
2130 $noticeInfoAttr['source_link'] = $ns->url;
2131 if (!empty($ns->name)) {
2132 $noticeInfoAttr['source'] = '<a href="'
2133 . htmlspecialchars($ns->url)
2134 . '" rel="nofollow">'
2135 . htmlspecialchars($ns->name)
2141 // favorite and repeated
2143 if ($scoped instanceof Profile) {
2144 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2147 if (!empty($this->repeat_of)) {
2148 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2151 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2153 return array('statusnet:notice_info', $noticeInfoAttr, null);
2157 * Returns an XML string fragment with a reference to a notice as an
2158 * Activity Streams noun object with the given element type.
2160 * Assumes that 'activity' namespace has been previously defined.
2162 * @param string $element one of 'subject', 'object', 'target'
2166 function asActivityNoun($element)
2168 $noun = $this->asActivityObject();
2169 return $noun->asString('activity:' . $element);
2172 public function asActivityObject()
2174 $object = new ActivityObject();
2176 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2177 $object->type = $this->object_type ?: ActivityObject::NOTE;
2178 $object->id = $this->getUri();
2179 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2180 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2181 $object->content = $this->getRendered();
2182 $object->link = $this->getUrl();
2184 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2186 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2189 if (!$object instanceof ActivityObject) {
2190 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2191 throw new ServerException('Notice asActivityObject created something else.');
2198 * Determine which notice, if any, a new notice is in reply to.
2200 * For conversation tracking, we try to see where this notice fits
2201 * in the tree. Beware that this may very well give false positives
2202 * and add replies to wrong threads (if there have been newer posts
2203 * by the same user as we're replying to).
2205 * @param Profile $sender Author profile
2206 * @param string $content Final notice content
2208 * @return integer ID of replied-to notice, or null for not a reply.
2211 static function getInlineReplyTo(Profile $sender, $content)
2213 // Is there an initial @ or T?
2214 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2215 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2216 $nickname = common_canonical_nickname($match[1]);
2221 // Figure out who that is.
2222 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2224 if ($recipient instanceof Profile) {
2225 // Get their last notice
2226 $last = $recipient->getCurrentNotice();
2227 if ($last instanceof Notice) {
2230 // Maybe in the future we want to handle something else below
2231 // so don't return getCurrentNotice() immediately.
2237 static function maxContent()
2239 $contentlimit = common_config('notice', 'contentlimit');
2240 // null => use global limit (distinct from 0!)
2241 if (is_null($contentlimit)) {
2242 $contentlimit = common_config('site', 'textlimit');
2244 return $contentlimit;
2247 static function contentTooLong($content)
2249 $contentlimit = self::maxContent();
2250 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2254 * Convenience function for posting a repeat of an existing message.
2256 * @param Profile $repeater Profile which is doing the repeat
2257 * @param string $source: posting source key, eg 'web', 'api', etc
2260 * @throws Exception on failure or permission problems
2262 function repeat(Profile $repeater, $source)
2264 $author = $this->getProfile();
2266 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2267 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2268 $content = sprintf(_('RT @%1$s %2$s'),
2269 $author->getNickname(),
2272 $maxlen = self::maxContent();
2273 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2274 // Web interface and current Twitter API clients will
2275 // pull the original notice's text, but some older
2276 // clients and RSS/Atom feeds will see this trimmed text.
2278 // Unfortunately this is likely to lose tags or URLs
2279 // at the end of long notices.
2280 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2284 // Scope is same as this one's
2285 return self::saveNew($repeater->id,
2288 array('repeat_of' => $this->id,
2289 'scope' => $this->scope));
2292 // These are supposed to be in chron order!
2294 function repeatStream($limit=100)
2296 $cache = Cache::instance();
2298 if (empty($cache)) {
2299 $ids = $this->_repeatStreamDirect($limit);
2301 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2302 if ($idstr !== false) {
2303 if (empty($idstr)) {
2306 $ids = explode(',', $idstr);
2309 $ids = $this->_repeatStreamDirect(100);
2310 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2313 // We do a max of 100, so slice down to limit
2314 $ids = array_slice($ids, 0, $limit);
2318 return NoticeStream::getStreamByIds($ids);
2321 function _repeatStreamDirect($limit)
2323 $notice = new Notice();
2325 $notice->selectAdd(); // clears it
2326 $notice->selectAdd('id');
2328 $notice->repeat_of = $this->id;
2330 $notice->orderBy('created, id'); // NB: asc!
2332 if (!is_null($limit)) {
2333 $notice->limit(0, $limit);
2336 return $notice->fetchAll('id');
2339 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2343 if (!empty($location_id) && !empty($location_ns)) {
2344 $options['location_id'] = $location_id;
2345 $options['location_ns'] = $location_ns;
2347 $location = Location::fromId($location_id, $location_ns);
2349 if ($location instanceof Location) {
2350 $options['lat'] = $location->lat;
2351 $options['lon'] = $location->lon;
2354 } else if (!empty($lat) && !empty($lon)) {
2355 $options['lat'] = $lat;
2356 $options['lon'] = $lon;
2358 $location = Location::fromLatLon($lat, $lon);
2360 if ($location instanceof Location) {
2361 $options['location_id'] = $location->location_id;
2362 $options['location_ns'] = $location->location_ns;
2364 } else if (!empty($profile)) {
2365 if (isset($profile->lat) && isset($profile->lon)) {
2366 $options['lat'] = $profile->lat;
2367 $options['lon'] = $profile->lon;
2370 if (isset($profile->location_id) && isset($profile->location_ns)) {
2371 $options['location_id'] = $profile->location_id;
2372 $options['location_ns'] = $profile->location_ns;
2379 function clearAttentions()
2381 $att = new Attention();
2382 $att->notice_id = $this->getID();
2385 while ($att->fetch()) {
2386 // Can't do delete() on the object directly since it won't remove all of it
2387 $other = clone($att);
2393 function clearReplies()
2395 $replyNotice = new Notice();
2396 $replyNotice->reply_to = $this->id;
2398 //Null any notices that are replies to this notice
2400 if ($replyNotice->find()) {
2401 while ($replyNotice->fetch()) {
2402 $orig = clone($replyNotice);
2403 $replyNotice->reply_to = null;
2404 $replyNotice->update($orig);
2410 $reply = new Reply();
2411 $reply->notice_id = $this->id;
2413 if ($reply->find()) {
2414 while($reply->fetch()) {
2415 self::blow('reply:stream:%d', $reply->profile_id);
2423 function clearLocation()
2425 $loc = new Notice_location();
2426 $loc->notice_id = $this->id;
2433 function clearFiles()
2435 $f2p = new File_to_post();
2437 $f2p->post_id = $this->id;
2440 while ($f2p->fetch()) {
2444 // FIXME: decide whether to delete File objects
2445 // ...and related (actual) files
2448 function clearRepeats()
2450 $repeatNotice = new Notice();
2451 $repeatNotice->repeat_of = $this->id;
2453 //Null any notices that are repeats of this notice
2455 if ($repeatNotice->find()) {
2456 while ($repeatNotice->fetch()) {
2457 $orig = clone($repeatNotice);
2458 $repeatNotice->repeat_of = null;
2459 $repeatNotice->update($orig);
2464 function clearTags()
2466 $tag = new Notice_tag();
2467 $tag->notice_id = $this->id;
2470 while ($tag->fetch()) {
2471 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2472 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2473 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2474 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2482 function clearGroupInboxes()
2484 $gi = new Group_inbox();
2486 $gi->notice_id = $this->id;
2489 while ($gi->fetch()) {
2490 self::blow('user_group:notice_ids:%d', $gi->group_id);
2498 function distribute()
2500 // We always insert for the author so they don't
2502 Event::handle('StartNoticeDistribute', array($this));
2504 // If there's a failure, we want to _force_
2505 // distribution at this point.
2507 $json = json_encode((object)array('id' => $this->getID(),
2510 $qm = QueueManager::get();
2511 $qm->enqueue($json, 'distrib');
2512 } catch (Exception $e) {
2513 // If the exception isn't transient, this
2514 // may throw more exceptions as DQH does
2515 // its own enqueueing. So, we ignore them!
2517 $handler = new DistribQueueHandler();
2518 $handler->handle($this);
2519 } catch (Exception $e) {
2520 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2522 // Re-throw so somebody smarter can handle it.
2529 $result = parent::insert();
2531 if ($result === false) {
2532 common_log_db_error($this, 'INSERT', __FILE__);
2533 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2534 throw new ServerException('Could not save Notice');
2537 // Profile::hasRepeated() abuses pkeyGet(), so we
2538 // have to clear manually
2539 if (!empty($this->repeat_of)) {
2540 $c = self::memcache();
2542 $ck = self::multicacheKey('Notice',
2543 array('profile_id' => $this->profile_id,
2544 'repeat_of' => $this->repeat_of));
2549 // Update possibly ID-dependent columns: URI, conversation
2550 // (now that INSERT has added the notice's local id)
2551 $orig = clone($this);
2554 // We can only get here if it's a local notice, since remote notices
2555 // should've bailed out earlier due to lacking a URI.
2556 if (empty($this->uri)) {
2557 $this->uri = sprintf('%s%s=%d:%s=%s',
2559 'noticeId', $this->id,
2560 'objectType', $this->getObjectType(true));
2564 if ($changed && $this->update($orig) === false) {
2565 common_log_db_error($notice, 'UPDATE', __FILE__);
2566 // TRANS: Server exception thrown when a notice cannot be updated.
2567 throw new ServerException(_('Problem saving notice.'));
2570 $this->blowOnInsert();
2576 * Get the source of the notice
2578 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2579 * guaranteed to be populated.
2581 function getSource()
2583 if (empty($this->source)) {
2587 $ns = new Notice_source();
2588 switch ($this->source) {
2595 $ns->code = $this->source;
2598 $ns = Notice_source::getKV($this->source);
2600 $ns = new Notice_source();
2601 $ns->code = $this->source;
2602 $app = Oauth_application::getKV('name', $this->source);
2604 $ns->name = $app->name;
2605 $ns->url = $app->source_url;
2615 * Determine whether the notice was locally created
2617 * @return boolean locality
2620 public function isLocal()
2622 $is_local = intval($this->is_local);
2623 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2626 public function getScope()
2628 return intval($this->scope);
2631 public function isRepeat()
2633 return !empty($this->repeat_of);
2637 * Get the list of hash tags saved with this notice.
2639 * @return array of strings
2641 public function getTags()
2645 $keypart = sprintf('notice:tags:%d', $this->id);
2647 $tagstr = self::cacheGet($keypart);
2649 if ($tagstr !== false) {
2650 $tags = explode(',', $tagstr);
2652 $tag = new Notice_tag();
2653 $tag->notice_id = $this->id;
2655 while ($tag->fetch()) {
2656 $tags[] = $tag->tag;
2659 self::cacheSet($keypart, implode(',', $tags));
2665 static private function utcDate($dt)
2667 $dateStr = date('d F Y H:i:s', strtotime($dt));
2668 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2669 return $d->format(DATE_W3C);
2673 * Look up the creation timestamp for a given notice ID, even
2674 * if it's been deleted.
2677 * @return mixed string recorded creation timestamp, or false if can't be found
2679 public static function getAsTimestamp($id)
2682 throw new EmptyIdException('Notice');
2686 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2687 // getByID throws exception if $id isn't found
2688 $notice = Notice::getByID($id);
2689 $timestamp = $notice->created;
2692 if (empty($timestamp)) {
2693 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2699 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2700 * parameter, matching notices posted after the given one (exclusive).
2702 * If the referenced notice can't be found, will return false.
2705 * @param string $idField
2706 * @param string $createdField
2707 * @return mixed string or false if no match
2709 public static function whereSinceId($id, $idField='id', $createdField='created')
2712 $since = Notice::getAsTimestamp($id);
2713 } catch (Exception $e) {
2716 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2720 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2721 * parameter, matching notices posted after the given one (exclusive), and
2722 * if necessary add it to the data object's query.
2724 * @param DB_DataObject $obj
2726 * @param string $idField
2727 * @param string $createdField
2728 * @return mixed string or false if no match
2730 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2732 $since = self::whereSinceId($id, $idField, $createdField);
2734 $obj->whereAdd($since);
2739 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2740 * parameter, matching notices posted before the given one (inclusive).
2742 * If the referenced notice can't be found, will return false.
2745 * @param string $idField
2746 * @param string $createdField
2747 * @return mixed string or false if no match
2749 public static function whereMaxId($id, $idField='id', $createdField='created')
2752 $max = Notice::getAsTimestamp($id);
2753 } catch (Exception $e) {
2756 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2760 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2761 * parameter, matching notices posted before the given one (inclusive), and
2762 * if necessary add it to the data object's query.
2764 * @param DB_DataObject $obj
2766 * @param string $idField
2767 * @param string $createdField
2768 * @return mixed string or false if no match
2770 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2772 $max = self::whereMaxId($id, $idField, $createdField);
2774 $obj->whereAdd($max);
2778 public function isPublic()
2780 $is_local = intval($this->is_local);
2781 return !($is_local === Notice::LOCAL_NONPUBLIC || $is_local === Notice::GATEWAY);
2785 * Check that the given profile is allowed to read, respond to, or otherwise
2786 * act on this notice.
2788 * The $scope member is a bitmask of scopes, representing a logical AND of the
2789 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2790 * "only visible to people who are mentioned in the notice AND are users on this site."
2791 * Users on the site who are not mentioned in the notice will not be able to see the
2794 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2796 * @return boolean whether the profile is in the notice's scope
2798 function inScope($profile)
2800 if (is_null($profile)) {
2801 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2803 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2806 $result = self::cacheGet($keypart);
2808 if ($result === false) {
2810 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2811 $bResult = $this->_inScope($profile);
2812 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2814 $result = ($bResult) ? 1 : 0;
2815 self::cacheSet($keypart, $result, 0, 300);
2818 return ($result == 1) ? true : false;
2821 protected function _inScope($profile)
2823 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2825 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2826 return !$this->isHiddenSpam($profile);
2829 // If there's scope, anon cannot be in scope
2830 if (empty($profile)) {
2834 // Author is always in scope
2835 if ($this->profile_id == $profile->id) {
2839 // Only for users on this site
2840 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2844 // Only for users mentioned in the notice
2845 if ($scope & Notice::ADDRESSEE_SCOPE) {
2847 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2848 'profile_id' => $profile->id));
2850 if (!$reply instanceof Reply) {
2855 // Only for members of the given group
2856 if ($scope & Notice::GROUP_SCOPE) {
2858 // XXX: just query for the single membership
2860 $groups = $this->getGroups();
2864 foreach ($groups as $group) {
2865 if ($profile->isMember($group)) {
2876 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2878 if (!Subscription::exists($profile, $this->getProfile())) {
2883 return !$this->isHiddenSpam($profile);
2886 function isHiddenSpam($profile) {
2888 // Hide posts by silenced users from everyone but moderators.
2890 if (common_config('notice', 'hidespam')) {
2893 $author = $this->getProfile();
2894 } catch(Exception $e) {
2895 // If we can't get an author, keep it hidden.
2896 // XXX: technically not spam, but, whatever.
2900 if ($author->hasRole(Profile_role::SILENCED)) {
2901 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2910 public function hasParent()
2914 } catch (NoParentNoticeException $e) {
2920 public function getParent()
2922 $reply_to_id = null;
2924 if (empty($this->reply_to)) {
2925 throw new NoParentNoticeException($this);
2928 // The reply_to ID in the table Notice could exist with a number
2929 // however, the replied to notice might not exist in the database.
2930 // Thus we need to catch the exception and throw the NoParentNoticeException else
2931 // the timeline will not display correctly.
2933 $reply_to_id = self::getByID($this->reply_to);
2934 } catch(Exception $e){
2935 throw new NoParentNoticeException($this);
2938 return $reply_to_id;
2942 * Magic function called at serialize() time.
2944 * We use this to drop a couple process-specific references
2945 * from DB_DataObject which can cause trouble in future
2948 * @return array of variable names to include in serialization.
2953 $vars = parent::__sleep();
2954 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2955 return array_diff($vars, $skip);
2958 static function defaultScope()
2960 $scope = common_config('notice', 'defaultscope');
2961 if (is_null($scope)) {
2962 if (common_config('site', 'private')) {
2971 static function fillProfiles($notices)
2973 $map = self::getProfiles($notices);
2974 foreach ($notices as $entry=>$notice) {
2976 if (array_key_exists($notice->profile_id, $map)) {
2977 $notice->_setProfile($map[$notice->profile_id]);
2979 } catch (NoProfileException $e) {
2980 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2981 unset($notices[$entry]);
2985 return array_values($map);
2988 static function getProfiles(&$notices)
2991 foreach ($notices as $notice) {
2992 $ids[] = $notice->profile_id;
2994 $ids = array_unique($ids);
2995 return Profile::pivotGet('id', $ids);
2998 static function fillGroups(&$notices)
3000 $ids = self::_idsOf($notices);
3001 $gis = Group_inbox::listGet('notice_id', $ids);
3004 foreach ($gis as $id => $gi) {
3007 $gids[] = $g->group_id;
3011 $gids = array_unique($gids);
3012 $group = User_group::pivotGet('id', $gids);
3013 foreach ($notices as $notice)
3016 $gi = $gis[$notice->id];
3017 foreach ($gi as $g) {
3018 $grps[] = $group[$g->group_id];
3020 $notice->_setGroups($grps);
3024 static function _idsOf(array &$notices)
3027 foreach ($notices as $notice) {
3028 $ids[$notice->id] = true;
3030 return array_keys($ids);
3033 static function fillAttachments(&$notices)
3035 $ids = self::_idsOf($notices);
3036 $f2pMap = File_to_post::listGet('post_id', $ids);
3038 foreach ($f2pMap as $noticeId => $f2ps) {
3039 foreach ($f2ps as $f2p) {
3040 $fileIds[] = $f2p->file_id;
3044 $fileIds = array_unique($fileIds);
3045 $fileMap = File::pivotGet('id', $fileIds);
3046 foreach ($notices as $notice)
3049 $f2ps = $f2pMap[$notice->id];
3050 foreach ($f2ps as $f2p) {
3051 if (!isset($fileMap[$f2p->file_id])) {
3052 // We have probably deleted value from fileMap since
3053 // it as a NULL entry (see the following elseif).
3055 } elseif (is_null($fileMap[$f2p->file_id])) {
3056 // If the file id lookup returned a NULL value, it doesn't
3057 // exist in our file table! So this is a remnant file_to_post
3058 // entry that is no longer valid and should be removed.
3059 common_debug('ATTACHMENT deleting f2p for post_id='.$f2p->post_id.' file_id='.$f2p->file_id);
3061 unset($fileMap[$f2p->file_id]);
3064 $files[] = $fileMap[$f2p->file_id];
3066 $notice->_setAttachments($files);
3070 static function fillReplies(&$notices)
3072 $ids = self::_idsOf($notices);
3073 $replyMap = Reply::listGet('notice_id', $ids);
3074 foreach ($notices as $notice) {
3075 $replies = $replyMap[$notice->id];
3077 foreach ($replies as $reply) {
3078 $ids[] = $reply->profile_id;
3080 $notice->_setReplies($ids);
3084 static public function beforeSchemaUpdate()
3086 $table = strtolower(get_called_class());
3087 $schema = Schema::get();
3088 $schemadef = $schema->getTableDef($table);
3091 * Make sure constraints are met before upgrading, if foreign keys
3092 * are not already in use.
3095 if (!isset($schemadef['foreign keys'])) {
3096 $newschemadef = self::schemaDef();
3097 printfnq("\nConstraint checking Notice table...\n");
3099 * Improve typing and make sure no NULL values in any id-related columns are 0
3102 foreach (['reply_to', 'repeat_of'] as $field) {
3103 $notice = new Notice(); // reset the object
3104 $notice->query(sprintf('UPDATE %1$s SET %2$s=NULL WHERE %2$s=0', $notice->escapedTableName(), $field));
3105 // Now we're sure that no Notice entries have repeat_of=0, only an id > 0 or NULL
3110 * This Will find foreign keys which do not fulfill the constraints and fix
3111 * where appropriate, such as delete when "repeat_of" ID not found in notice.id
3112 * or set to NULL for "reply_to" in the same case.
3115 * XXX: How does this work if we would use multicolumn foreign keys?
3117 foreach (['reply_to' => 'reset', 'repeat_of' => 'delete', 'profile_id' => 'delete'] as $field=>$action) {
3118 $notice = new Notice();
3120 $fkeyname = $notice->tableName().'_'.$field.'_fkey';
3121 assert(isset($newschemadef['foreign keys'][$fkeyname]));
3122 assert($newschemadef['foreign keys'][$fkeyname]);
3124 $foreign_key = $newschemadef['foreign keys'][$fkeyname];
3125 $fkeytable = $foreign_key[0];
3126 assert(isset($foreign_key[1][$field]));
3127 $fkeycol = $foreign_key[1][$field];
3129 printfnq("* {$fkeyname} ({$field} => {$fkeytable}.{$fkeycol})\n");
3131 // NOTE: Above we set all repeat_of to NULL if they were 0, so this really gets them all.
3132 $notice->whereAdd(sprintf('%1$s NOT IN (SELECT %2$s FROM %3$s)', $field, $fkeycol, $fkeytable));
3133 if ($notice->find()) {
3134 printfnq("\tFound {$notice->N} notices with {$field} NOT IN notice.id, {$action}ing...");
3136 case 'delete': // since it's a directly dependant notice for an unknown ID we don't want it in our DB
3137 while ($notice->fetch()) {
3141 case 'reset': // just set it to NULL to be compatible with our constraints, if it was related to an unknown ID
3143 foreach ($notice->fetchAll('id') as $id) {
3144 settype($id, 'int');
3148 $notice = new Notice();
3149 $notice->query(sprintf('UPDATE %1$s SET %2$s=NULL WHERE id IN (%3$s)',
3150 $notice->escapedTableName(),
3152 implode(',', $ids)));
3155 throw new ServerException('The programmer sucks, invalid action name when fixing table.');
3157 printfnq("DONE.\n");
3163 // 2015-09-04 We move Notice location data to Notice_location
3164 // First we see if we have to do this at all
3165 if (!isset($schemadef['fields']['lat'])
3166 && !isset($schemadef['fields']['lon'])
3167 && !isset($schemadef['fields']['location_id'])
3168 && !isset($schemadef['fields']['location_ns'])) {
3169 // We have already removed the location fields, so no need to migrate.
3172 // Then we make sure the Notice_location table is created!
3173 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3175 // Then we continue on our road to migration!
3176 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)";
3178 $notice = new Notice();
3179 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3180 'WHERE lat IS NOT NULL ' .
3181 'OR lon IS NOT NULL ' .
3182 'OR location_id IS NOT NULL ' .
3183 'OR location_ns IS NOT NULL',
3184 $schema->quoteIdentifier($table)));
3185 print "\nFound {$notice->N} notices with location data, inserting";
3186 while ($notice->fetch()) {
3187 $notloc = Notice_location::getKV('notice_id', $notice->id);
3188 if ($notloc instanceof Notice_location) {
3192 $notloc = new Notice_location();
3193 $notloc->notice_id = $notice->id;
3194 $notloc->lat= $notice->lat;
3195 $notloc->lon= $notice->lon;
3196 $notloc->location_id= $notice->location_id;
3197 $notloc->location_ns= $notice->location_ns;