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_verb_idx' => array('verb'),
114 'notice_replyto_idx' => array('reply_to')
118 if (common_config('search', 'type') == 'fulltext') {
119 $def['fulltext indexes'] = array('content' => array('content'));
126 const LOCAL_PUBLIC = 1;
128 const LOCAL_NONPUBLIC = -1;
131 const PUBLIC_SCOPE = 0; // Useful fake constant
132 const SITE_SCOPE = 1;
133 const ADDRESSEE_SCOPE = 2;
134 const GROUP_SCOPE = 4;
135 const FOLLOWER_SCOPE = 8;
137 protected $_profile = array();
140 * Will always return a profile, if anything fails it will
141 * (through _setProfile) throw a NoProfileException.
143 public function getProfile()
145 if (!isset($this->_profile[$this->profile_id])) {
146 // We could've sent getKV directly to _setProfile, but occasionally we get
147 // a "false" (instead of null), likely because it indicates a cache miss.
148 $profile = Profile::getKV('id', $this->profile_id);
149 $this->_setProfile($profile instanceof Profile ? $profile : null);
151 return $this->_profile[$this->profile_id];
154 public function _setProfile(Profile $profile=null)
156 if (!$profile instanceof Profile) {
157 throw new NoProfileException($this->profile_id);
159 $this->_profile[$this->profile_id] = $profile;
162 public function deleteAs(Profile $actor, $delete_event=true)
164 if (!$this->getProfile()->sameAs($actor) && !$actor->hasRight(Right::DELETEOTHERSNOTICE)) {
165 throw new AuthorizationException(_('You are not allowed to delete another user\'s notice.'));
169 if (!$delete_event || Event::handle('DeleteNoticeAsProfile', array($this, $actor, &$result))) {
170 // If $delete_event is true, we run the event. If the Event then
171 // returns false it is assumed everything was handled properly
172 // and the notice was deleted.
173 $result = $this->delete();
178 protected function deleteRelated()
180 if (Event::handle('NoticeDeleteRelated', array($this))) {
181 // Clear related records
182 $this->clearReplies();
183 $this->clearLocation();
184 $this->clearRepeats();
186 $this->clearGroupInboxes();
188 $this->clearAttentions();
189 // NOTE: we don't clear queue items
193 public function delete($useWhere=false)
195 $this->deleteRelated();
197 $result = parent::delete($useWhere);
199 $this->blowOnDelete();
203 public function getUri()
209 * Get a Notice object by URI. Will call external plugins for help
210 * using the event StartGetNoticeFromURI.
212 * @param string $uri A unique identifier for a resource (notice in this case)
214 static function fromUri($uri)
218 if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
219 $notice = Notice::getKV('uri', $uri);
220 Event::handle('EndGetNoticeFromUri', array($uri, $notice));
223 if (!$notice instanceof Notice) {
224 throw new UnknownUriException($uri);
231 * @param $root boolean If true, link to just the conversation root.
233 * @return URL to conversation
235 public function getConversationUrl($anchor=true)
237 return Conversation::getUrlFromNotice($this, $anchor);
241 * Get the local representation URL of this notice.
243 public function getLocalUrl()
245 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
248 public function getTitle()
251 if (Event::handle('GetNoticeTitle', array($this, &$title))) {
252 // TRANS: Title of a notice posted without a title value.
253 // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
254 $title = sprintf(_('%1$s\'s status on %2$s'),
255 $this->getProfile()->getFancyName(),
256 common_exact_date($this->created));
261 public function getContent()
263 return $this->content;
266 public function getRendered()
268 // we test $this->id because if it's not inserted yet, we can't update the field
269 if (!empty($this->id) && (is_null($this->rendered) || $this->rendered === '')) {
270 // update to include rendered content on-the-fly, so we don't have to have a fix-up script in upgrade.php
271 common_debug('Rendering notice '.$this->getID().' as it had no rendered HTML content.');
272 $orig = clone($this);
273 $this->rendered = common_render_content($this->getContent(),
275 $this->hasParent() ? $this->getParent() : null);
276 $this->update($orig);
278 return $this->rendered;
281 public function getCreated()
283 return $this->created;
286 public function getVerb($make_relative=false)
288 return ActivityUtils::resolveUri($this->verb, $make_relative);
291 public function isVerb(array $verbs)
293 return ActivityUtils::compareVerbs($this->getVerb(), $verbs);
297 * Get the original representation URL of this notice.
299 * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
301 public function getUrl($fallback=false)
303 // The risk is we start having empty urls and non-http uris...
304 // and we can't really handle any other protocol right now.
306 case $this->isLocal():
307 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
308 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
310 case common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
313 // let's generate a valid link to our locally available notice on demand
314 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
316 throw new InvalidUrlException($this->url);
320 public function getObjectType($canonical=false) {
321 if (is_null($this->object_type) || $this->object_type==='') {
322 throw new NoObjectTypeException($this);
324 return ActivityUtils::resolveUri($this->object_type, $canonical);
327 public function isObjectType(array $types)
330 return ActivityUtils::compareTypes($this->getObjectType(), $types);
331 } catch (NoObjectTypeException $e) {
336 public static function getByUri($uri)
338 $notice = new Notice();
340 if (!$notice->find(true)) {
341 throw new NoResultException($notice);
347 * Extract #hashtags from this notice's content and save them to the database.
351 /* extract all #hastags */
352 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
357 /* Add them to the database */
358 return $this->saveKnownTags($match[1]);
362 * Record the given set of hash tags in the db for this notice.
363 * Given tag strings will be normalized and checked for dupes.
365 function saveKnownTags($hashtags)
367 //turn each into their canonical tag
368 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
369 for($i=0; $i<count($hashtags); $i++) {
370 /* elide characters we don't want in the tag */
371 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
374 foreach(array_unique($hashtags) as $hashtag) {
375 $this->saveTag($hashtag);
376 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
382 * Record a single hash tag as associated with this notice.
383 * Tag format and uniqueness must be validated by caller.
385 function saveTag($hashtag)
387 $tag = new Notice_tag();
388 $tag->notice_id = $this->id;
389 $tag->tag = $hashtag;
390 $tag->created = $this->created;
391 $id = $tag->insert();
394 // TRANS: Server exception. %s are the error details.
395 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
396 $last_error->message));
400 // if it's saved, blow its cache
401 $tag->blowCache(false);
405 * Save a new notice and push it out to subscribers' inboxes.
406 * Poster's permissions are checked before sending.
408 * @param int $profile_id Profile ID of the poster
409 * @param string $content source message text; links may be shortened
410 * per current user's preference
411 * @param string $source source key ('web', 'api', etc)
412 * @param array $options Associative array of optional properties:
413 * string 'created' timestamp of notice; defaults to now
414 * int 'is_local' source/gateway ID, one of:
415 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
416 * Notice::REMOTE - Sent from a remote service;
417 * hide from public timeline but show in
418 * local "and friends" timelines
419 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
420 * Notice::GATEWAY - From another non-OStatus service;
421 * will not appear in public views
422 * float 'lat' decimal latitude for geolocation
423 * float 'lon' decimal longitude for geolocation
424 * int 'location_id' geoname identifier
425 * int 'location_ns' geoname namespace to interpret location_id
426 * int 'reply_to'; notice ID this is a reply to
427 * int 'repeat_of'; notice ID this is a repeat of
428 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
429 * string 'url' permalink to notice; defaults to local notice URL
430 * string 'rendered' rendered HTML version of content
431 * array 'replies' list of profile URIs for reply delivery in
432 * place of extracting @-replies from content.
433 * array 'groups' list of group IDs to deliver to, in place of
434 * extracting ! tags from content
435 * array 'tags' list of hashtag strings to save with the notice
436 * in place of extracting # tags from content
437 * array 'urls' list of attached/referred URLs to save with the
438 * notice in place of extracting links from content
439 * boolean 'distribute' whether to distribute the notice, default true
440 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
441 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
442 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
444 * @fixme tag override
447 * @throws ClientException
449 static function saveNew($profile_id, $content, $source, array $options=null) {
450 $defaults = array('uri' => null,
452 'conversation' => null, // URI of conversation
453 'reply_to' => null, // This will override convo URI if the parent is known
454 'repeat_of' => null, // This will override convo URI if the repeated notice is known
456 'distribute' => true,
457 'object_type' => null,
460 if (!empty($options) && is_array($options)) {
461 $options = array_merge($defaults, $options);
467 if (!isset($is_local)) {
468 $is_local = Notice::LOCAL_PUBLIC;
471 $profile = Profile::getKV('id', $profile_id);
472 if (!$profile instanceof Profile) {
473 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
474 throw new ClientException(_('Problem saving notice. Unknown user.'));
477 $user = User::getKV('id', $profile_id);
478 if ($user instanceof User) {
479 // Use the local user's shortening preferences, if applicable.
480 $final = $user->shortenLinks($content);
482 $final = common_shorten_links($content);
485 if (Notice::contentTooLong($final)) {
486 // TRANS: Client exception thrown if a notice contains too many characters.
487 throw new ClientException(_('Problem saving notice. Too long.'));
490 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
491 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
492 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
493 throw new ClientException(_('Too many notices too fast; take a breather '.
494 'and post again in a few minutes.'));
497 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
498 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
499 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
500 throw new ClientException(_('Too many duplicate messages too quickly;'.
501 ' take a breather and post again in a few minutes.'));
504 if (!$profile->hasRight(Right::NEWNOTICE)) {
505 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
507 // TRANS: Client exception thrown when a user tries to post while being banned.
508 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
511 $notice = new Notice();
512 $notice->profile_id = $profile_id;
514 if ($source && in_array($source, common_config('public', 'autosource'))) {
515 $notice->is_local = Notice::LOCAL_NONPUBLIC;
517 $notice->is_local = $is_local;
520 if (!empty($created)) {
521 $notice->created = $created;
523 $notice->created = common_sql_now();
526 if (!$notice->isLocal()) {
527 // Only do these checks for non-local notices. Local notices will generate these values later.
529 throw new ServerException('No URI for remote notice. Cannot accept that.');
533 $notice->content = $final;
535 $notice->source = $source;
539 // Get the groups here so we can figure out replies and such
540 if (!isset($groups)) {
541 $groups = User_group::idsFromText($notice->content, $profile);
546 // Handle repeat case
548 if (!empty($options['repeat_of'])) {
550 // Check for a private one
552 $repeat = Notice::getByID($options['repeat_of']);
554 if ($profile->sameAs($repeat->getProfile())) {
555 // TRANS: Client error displayed when trying to repeat an own notice.
556 throw new ClientException(_('You cannot repeat your own notice.'));
559 if ($repeat->scope != Notice::SITE_SCOPE &&
560 $repeat->scope != Notice::PUBLIC_SCOPE) {
561 // TRANS: Client error displayed when trying to repeat a non-public notice.
562 throw new ClientException(_('Cannot repeat a private notice.'), 403);
565 if (!$repeat->inScope($profile)) {
566 // The generic checks above should cover this, but let's be sure!
567 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
568 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
571 if ($profile->hasRepeated($repeat)) {
572 // TRANS: Client error displayed when trying to repeat an already repeated notice.
573 throw new ClientException(_('You already repeated that notice.'));
576 $notice->repeat_of = $repeat->id;
577 $notice->conversation = $repeat->conversation;
581 // If $reply_to is specified, we check that it exists, and then
582 // return it if it does
583 if (!empty($reply_to)) {
584 $reply = Notice::getKV('id', $reply_to);
585 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
586 // If the source lacks capability of sending the "reply_to"
587 // metadata, let's try to find an inline replyto-reference.
588 $reply = self::getInlineReplyTo($profile, $final);
591 if ($reply instanceof Notice) {
592 if (!$reply->inScope($profile)) {
593 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
594 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
595 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
596 $profile->nickname, $reply->id), 403);
599 // If it's a repeat, the reply_to should be to the original
600 if ($reply->isRepeat()) {
601 $notice->reply_to = $reply->repeat_of;
603 $notice->reply_to = $reply->id;
605 // But the conversation ought to be the same :)
606 $notice->conversation = $reply->conversation;
608 // If the original is private to a group, and notice has
609 // no group specified, make it to the same group(s)
611 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
613 $replyGroups = $reply->getGroups();
614 foreach ($replyGroups as $group) {
615 if ($profile->isMember($group)) {
616 $groups[] = $group->id;
624 // If we don't know the reply, we might know the conversation!
625 // This will happen if a known remote user replies to an
626 // unknown remote user - within a known conversation.
627 if (empty($notice->conversation) and !empty($options['conversation'])) {
628 $conv = Conversation::getKV('uri', $options['conversation']);
629 if ($conv instanceof Conversation) {
630 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.').');
632 // Conversation entry with specified URI was not found, so we must create it.
633 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
634 // The insert in Conversation::create throws exception on failure
635 $conv = Conversation::create($options['conversation'], $notice->created);
637 $notice->conversation = $conv->getID();
642 // If it's not part of a conversation, it's the beginning of a new conversation.
643 if (empty($notice->conversation)) {
644 $conv = Conversation::create();
645 $notice->conversation = $conv->getID();
650 $notloc = new Notice_location();
651 if (!empty($lat) && !empty($lon)) {
656 if (!empty($location_ns) && !empty($location_id)) {
657 $notloc->location_id = $location_id;
658 $notloc->location_ns = $location_ns;
661 if (!empty($rendered)) {
662 $notice->rendered = $rendered;
664 $notice->rendered = common_render_content($final,
665 $notice->getProfile(),
666 $notice->hasParent() ? $notice->getParent() : null);
670 if ($notice->isRepeat()) {
671 $notice->verb = ActivityVerb::SHARE;
672 $notice->object_type = ActivityObject::ACTIVITY;
674 $notice->verb = ActivityVerb::POST;
677 $notice->verb = $verb;
680 if (empty($object_type)) {
681 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
683 $notice->object_type = $object_type;
686 if (is_null($scope) && $reply instanceof Notice) {
687 $notice->scope = $reply->scope;
689 $notice->scope = $scope;
692 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
694 if (Event::handle('StartNoticeSave', array(&$notice))) {
696 // XXX: some of these functions write to the DB
699 $notice->insert(); // throws exception on failure, if successful we have an ->id
701 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
702 $notloc->notice_id = $notice->getID();
703 $notloc->insert(); // store the notice location if it had any information
705 } catch (Exception $e) {
706 // Let's test if we managed initial insert, which would imply
707 // failing on some update-part (check 'insert()'). Delete if
708 // something had been stored to the database.
709 if (!empty($notice->id)) {
716 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
717 // the activityverb is a POST (since stuff like repeat, favorite etc.
718 // reasonably handle notifications themselves.
719 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
720 if (isset($replies)) {
721 $notice->saveKnownReplies($replies);
723 $notice->saveReplies();
727 $notice->saveKnownTags($tags);
732 // Note: groups may save tags, so must be run after tags are saved
733 // to avoid errors on duplicates.
734 // Note: groups should always be set.
736 $notice->saveKnownGroups($groups);
739 $notice->saveKnownUrls($urls);
746 // Prepare inbox delivery, may be queued to background.
747 $notice->distribute();
753 static function saveActivity(Activity $act, Profile $actor, array $options=array())
755 // First check if we're going to let this Activity through from the specific actor
756 if (!$actor->hasRight(Right::NEWNOTICE)) {
757 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
759 // TRANS: Client exception thrown when a user tries to post while being banned.
760 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
762 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
763 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
764 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
765 throw new ClientException(_m('Too many notices too fast; take a breather '.
766 'and post again in a few minutes.'));
769 // Get ActivityObject properties
771 if (!empty($act->id)) {
773 $options['uri'] = $act->id;
774 $options['url'] = $act->link;
776 $actobj = count($act->objects)===1 ? $act->objects[0] : null;
777 if (!is_null($actobj) && !empty($actobj->id)) {
778 $options['uri'] = $actobj->id;
780 $options['url'] = $actobj->link;
781 } elseif (preg_match('!^https?://!', $actobj->id)) {
782 $options['url'] = $actobj->id;
789 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
790 'mentions' => array(),
794 'source' => 'unknown',
799 'distribute' => true);
801 // options will have default values when nothing has been supplied
802 $options = array_merge($defaults, $options);
803 foreach (array_keys($defaults) as $key) {
804 // Only convert the keynames we specify ourselves from 'defaults' array into variables
805 $$key = $options[$key];
807 extract($options, EXTR_SKIP);
810 $stored = new Notice();
811 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
813 if ($stored->find()) {
814 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
815 // I _assume_ saving a Notice with a colliding URI means we're really trying to
816 // save the same notice again...
817 throw new AlreadyFulfilledException('Notice URI already exists');
821 // NOTE: Sandboxed users previously got all the notices _during_
822 // sandbox period set to to is_local=Notice::LOCAL_NONPUBLIC here.
823 // Since then we have started just filtering _when_ it gets shown
824 // instead of creating a mixed jumble of differently scoped notices.
826 if ($source && in_array($source, common_config('public', 'autosource'))) {
827 $stored->is_local = Notice::LOCAL_NONPUBLIC;
829 $stored->is_local = intval($is_local);
832 if (!$stored->isLocal()) {
833 // Only do these checks for non-local notices. Local notices will generate these values later.
834 if (!common_valid_http_url($url)) {
835 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
838 throw new ServerException('No URI for remote notice. Cannot accept that.');
842 $stored->profile_id = $actor->id;
843 $stored->source = $source;
846 $stored->verb = $act->verb;
848 // we use mb_strlen because it _might_ be that the content is just the string "0"...
849 $content = mb_strlen($act->content) ? $act->content : $act->summary;
850 if (mb_strlen($content)===0 && !is_null($actobj)) {
851 $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
853 // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
854 $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
855 $stored->content = common_strip_html($stored->getRendered(), true, true);
856 if (trim($stored->content) === '') {
857 // TRANS: Error message when the plain text content of a notice has zero length.
858 throw new ClientException(_('Empty notice content, will not save this.'));
861 // Maybe a missing act-time should be fatal if the actor is not local?
862 if (!empty($act->time)) {
863 $stored->created = common_sql_date($act->time);
865 $stored->created = common_sql_now();
869 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
870 $reply = self::getKV('uri', $act->context->replyToID);
872 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
873 $reply = self::getKV('uri', $act->target->id);
876 if ($reply instanceof Notice) {
877 if (!$reply->inScope($actor)) {
878 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
879 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
880 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
883 $stored->reply_to = $reply->id;
884 $stored->conversation = $reply->conversation;
886 // If the original is private to a group, and notice has no group specified,
887 // make it to the same group(s)
888 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
889 $replyGroups = $reply->getGroups();
890 foreach ($replyGroups as $group) {
891 if ($actor->isMember($group)) {
892 $groups[] = $group->id;
897 if (is_null($scope)) {
898 $scope = $reply->scope;
901 // If we don't know the reply, we might know the conversation!
902 // This will happen if a known remote user replies to an
903 // unknown remote user - within a known conversation.
904 if (empty($stored->conversation) and !empty($act->context->conversation)) {
905 $conv = Conversation::getKV('uri', $act->context->conversation);
906 if ($conv instanceof Conversation) {
907 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.').');
909 // Conversation entry with specified URI was not found, so we must create it.
910 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
911 // The insert in Conversation::create throws exception on failure
912 $conv = Conversation::create($act->context->conversation, $stored->created);
914 $stored->conversation = $conv->getID();
919 // If it's not part of a conversation, it's the beginning of a new conversation.
920 if (empty($stored->conversation)) {
921 $conv = Conversation::create();
922 $stored->conversation = $conv->getID();
927 if ($act->context instanceof ActivityContext) {
928 if ($act->context->location instanceof Location) {
929 $notloc = Notice_location::fromLocation($act->context->location);
932 $act->context = new ActivityContext();
935 if (array_key_exists('http://activityschema.org/collection/public', $act->context->attention)) {
936 $stored->scope = Notice::PUBLIC_SCOPE;
937 // TODO: maybe we should actually keep this? if the saveAttentions thing wants to use it...
938 unset($act->context->attention['http://activityschema.org/collection/public']);
940 $stored->scope = self::figureOutScope($actor, $groups, $scope);
943 foreach ($act->categories as $cat) {
945 $term = common_canonical_tag($cat->term);
952 foreach ($act->enclosures as $href) {
953 // @todo FIXME: Save these locally or....?
957 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
958 if (empty($act->objects[0]->type)) {
959 // Default type for the post verb is 'note', but we know it's
960 // a 'comment' if it is in reply to something.
961 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
963 //TODO: Is it safe to always return a relative URI? The
964 // JSON version of ActivityStreams always use it, so we
965 // should definitely be able to handle it...
966 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
970 if (Event::handle('StartNoticeSave', array(&$stored))) {
971 // XXX: some of these functions write to the DB
974 $result = $stored->insert(); // throws exception on error
976 if ($notloc instanceof Notice_location) {
977 $notloc->notice_id = $stored->getID();
981 $orig = clone($stored); // for updating later in this try clause
984 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
985 if (empty($object)) {
986 throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
989 // If something changed in the Notice during StoreActivityObject
990 $stored->update($orig);
991 } catch (Exception $e) {
992 if (empty($stored->id)) {
993 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
995 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
1001 if (!$stored instanceof Notice) {
1002 throw new ServerException('StartNoticeSave did not give back a Notice.');
1003 } elseif (empty($stored->id)) {
1004 throw new ServerException('Supposedly saved Notice has no ID.');
1007 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
1008 // the activityverb is a POST (since stuff like repeat, favorite etc.
1009 // reasonably handle notifications themselves.
1010 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
1012 if (!empty($tags)) {
1013 $stored->saveKnownTags($tags);
1015 $stored->saveTags();
1018 // Note: groups may save tags, so must be run after tags are saved
1019 // to avoid errors on duplicates.
1020 $stored->saveAttentions($act->context->attention);
1022 if (!empty($urls)) {
1023 $stored->saveKnownUrls($urls);
1025 $stored->saveUrls();
1030 // Prepare inbox delivery, may be queued to background.
1031 $stored->distribute();
1037 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1038 $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1040 // For private streams
1042 $user = $actor->getUser();
1043 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1044 if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1045 $scope |= Notice::FOLLOWER_SCOPE;
1047 } catch (NoSuchUserException $e) {
1048 // TODO: Not a local user, so we don't know about scope preferences... yet!
1051 // Force the scope for private groups
1052 foreach ($groups as $group_id) {
1054 $group = User_group::getByID($group_id);
1055 if ($group->force_scope) {
1056 $scope |= Notice::GROUP_SCOPE;
1059 } catch (Exception $e) {
1060 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1067 function blowOnInsert($conversation = false)
1069 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1071 if ($this->isPublic()) {
1072 $this->blowStream('public');
1073 $this->blowStream('networkpublic');
1076 if ($this->conversation) {
1077 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1078 self::blow('conversation:notice_count:%d', $this->conversation);
1081 if ($this->isRepeat()) {
1082 // XXX: we should probably only use one of these
1083 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1084 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1087 $original = Notice::getKV('id', $this->repeat_of);
1089 if ($original instanceof Notice) {
1090 $originalUser = User::getKV('id', $original->profile_id);
1091 if ($originalUser instanceof User) {
1092 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1096 $profile = Profile::getKV($this->profile_id);
1098 if ($profile instanceof Profile) {
1099 $profile->blowNoticeCount();
1102 $ptags = $this->getProfileTags();
1103 foreach ($ptags as $ptag) {
1104 $ptag->blowNoticeStreamCache();
1109 * Clear cache entries related to this notice at delete time.
1110 * Necessary to avoid breaking paging on public, profile timelines.
1112 function blowOnDelete()
1114 $this->blowOnInsert();
1116 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1118 if ($this->isPublic()) {
1119 self::blow('public;last');
1120 self::blow('networkpublic;last');
1123 self::blow('fave:by_notice', $this->id);
1125 if ($this->conversation) {
1126 // In case we're the first, will need to calc a new root.
1127 self::blow('notice:conversation_root:%d', $this->conversation);
1130 $ptags = $this->getProfileTags();
1131 foreach ($ptags as $ptag) {
1132 $ptag->blowNoticeStreamCache(true);
1136 function blowStream()
1138 $c = self::memcache();
1144 $args = func_get_args();
1145 $format = array_shift($args);
1146 $keyPart = vsprintf($format, $args);
1147 $cacheKey = Cache::key($keyPart);
1148 $c->delete($cacheKey);
1150 // delete the "last" stream, too, if this notice is
1151 // older than the top of that stream
1153 $lastKey = $cacheKey.';last';
1155 $lastStr = $c->get($lastKey);
1157 if ($lastStr !== false) {
1158 $window = explode(',', $lastStr);
1159 $lastID = $window[0];
1160 $lastNotice = Notice::getKV('id', $lastID);
1161 if (!$lastNotice instanceof Notice // just weird
1162 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1163 $c->delete($lastKey);
1168 /** save all urls in the notice to the db
1170 * follow redirects and save all available file information
1171 * (mimetype, date, size, oembed, etc.)
1175 function saveUrls() {
1176 if (common_config('attachments', 'process_links')) {
1177 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1182 * Save the given URLs as related links/attachments to the db
1184 * follow redirects and save all available file information
1185 * (mimetype, date, size, oembed, etc.)
1189 function saveKnownUrls($urls)
1191 if (common_config('attachments', 'process_links')) {
1192 // @fixme validation?
1193 foreach (array_unique($urls) as $url) {
1194 $this->saveUrl($url, $this);
1202 function saveUrl($url, Notice $notice) {
1204 File::processNew($url, $notice);
1205 } catch (ServerException $e) {
1206 // Could not save URL. Log it?
1210 static function checkDupes($profile_id, $content) {
1211 $profile = Profile::getKV($profile_id);
1212 if (!$profile instanceof Profile) {
1215 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1216 if (!empty($notice)) {
1218 while ($notice->fetch()) {
1219 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1221 } else if ($notice->content == $content) {
1226 // If we get here, oldest item in cache window is not
1227 // old enough for dupe limit; do direct check against DB
1228 $notice = new Notice();
1229 $notice->profile_id = $profile_id;
1230 $notice->content = $content;
1231 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1232 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1234 $cnt = $notice->count();
1238 static function checkEditThrottle($profile_id) {
1239 $profile = Profile::getKV($profile_id);
1240 if (!$profile instanceof Profile) {
1243 // Get the Nth notice
1244 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1245 if ($notice && $notice->fetch()) {
1246 // If the Nth notice was posted less than timespan seconds ago
1247 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1252 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1256 protected $_attachments = array();
1258 function attachments() {
1259 if (isset($this->_attachments[$this->id])) {
1260 return $this->_attachments[$this->id];
1263 $f2ps = File_to_post::listGet('post_id', array($this->id));
1265 foreach ($f2ps[$this->id] as $f2p) {
1266 $ids[] = $f2p->file_id;
1269 return $this->_setAttachments(File::multiGet('id', $ids)->fetchAll());
1272 public function _setAttachments(array $attachments)
1274 return $this->_attachments[$this->id] = $attachments;
1277 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1279 $stream = new PublicNoticeStream();
1280 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1283 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null, Profile $scoped=null)
1285 $stream = new ConversationNoticeStream($id, $scoped);
1286 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1290 * Is this notice part of an active conversation?
1292 * @return boolean true if other messages exist in the same
1293 * conversation, false if this is the only one
1295 function hasConversation()
1297 if (empty($this->conversation)) {
1298 // this notice is not part of a conversation apparently
1299 // FIXME: all notices should have a conversation value, right?
1303 //FIXME: Get the Profile::current() stuff some other way
1304 // to avoid confusion between queue processing and session.
1305 $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
1307 // if our "offset 1, limit 1" query got a result, return true else false
1308 return $notice->N > 0;
1312 * Grab the earliest notice from this conversation.
1314 * @return Notice or null
1316 function conversationRoot($profile=-1)
1318 // XXX: can this happen?
1320 if (empty($this->conversation)) {
1324 // Get the current profile if not specified
1326 if (is_int($profile) && $profile == -1) {
1327 $profile = Profile::current();
1330 // If this notice is out of scope, no root for you!
1332 if (!$this->inScope($profile)) {
1336 // If this isn't a reply to anything, then it's its own
1337 // root if it's the earliest notice in the conversation:
1339 if (empty($this->reply_to)) {
1341 $root->conversation = $this->conversation;
1342 $root->orderBy('notice.created ASC');
1343 $root->find(true); // true means "fetch first result"
1348 if (is_null($profile)) {
1349 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1351 $keypart = sprintf('notice:conversation_root:%d:%d',
1356 $root = self::cacheGet($keypart);
1358 if ($root !== false && $root->inScope($profile)) {
1365 $parent = $last->getParent();
1366 if ($parent->inScope($profile)) {
1370 } catch (NoParentNoticeException $e) {
1371 // Latest notice has no parent
1372 } catch (NoResultException $e) {
1373 // Notice was not found, so we can't go further up in the tree.
1374 // FIXME: Maybe we should do this in a more stable way where deleted
1375 // notices won't break conversation chains?
1377 // No parent, or parent out of scope
1382 self::cacheSet($keypart, $root);
1388 * Pull up a full list of local recipients who will be getting
1389 * this notice in their inbox. Results will be cached, so don't
1390 * change the input data wily-nilly!
1392 * @param array $groups optional list of Group objects;
1393 * if left empty, will be loaded from group_inbox records
1394 * @param array $recipient optional list of reply profile ids
1395 * if left empty, will be loaded from reply records
1396 * @return array associating recipient user IDs with an inbox source constant
1398 function whoGets(array $groups=null, array $recipients=null)
1400 $c = self::memcache();
1403 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1404 if ($ni !== false) {
1409 if (is_null($recipients)) {
1410 $recipients = $this->getReplies();
1415 // Give plugins a chance to add folks in at start...
1416 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1418 $users = $this->getSubscribedUsers();
1419 foreach ($users as $id) {
1420 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1423 if (is_null($groups)) {
1424 $groups = $this->getGroups();
1426 foreach ($groups as $group) {
1427 $users = $group->getUserMembers();
1428 foreach ($users as $id) {
1429 if (!array_key_exists($id, $ni)) {
1430 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1435 $ptAtts = $this->getAttentionsFromProfileTags();
1436 foreach ($ptAtts as $key=>$val) {
1437 if (!array_key_exists($key, $ni)) {
1442 foreach ($recipients as $recipient) {
1443 if (!array_key_exists($recipient, $ni)) {
1444 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1448 // Exclude any deleted, non-local, or blocking recipients.
1449 $profile = $this->getProfile();
1450 $originalProfile = null;
1451 if ($this->isRepeat()) {
1452 // Check blocks against the original notice's poster as well.
1453 $original = Notice::getKV('id', $this->repeat_of);
1454 if ($original instanceof Notice) {
1455 $originalProfile = $original->getProfile();
1459 foreach ($ni as $id => $source) {
1461 $user = User::getKV('id', $id);
1462 if (!$user instanceof User ||
1463 $user->hasBlocked($profile) ||
1464 ($originalProfile && $user->hasBlocked($originalProfile))) {
1467 } catch (UserNoProfileException $e) {
1468 // User doesn't have a profile; invalid; skip them.
1473 // Give plugins a chance to filter out...
1474 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1478 // XXX: pack this data better
1479 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1485 function getSubscribedUsers()
1489 if(common_config('db','quote_identifiers'))
1490 $user_table = '"user"';
1491 else $user_table = 'user';
1495 'FROM '. $user_table .' JOIN subscription '.
1496 'ON '. $user_table .'.id = subscription.subscriber ' .
1497 'WHERE subscription.subscribed = %d ';
1499 $user->query(sprintf($qry, $this->profile_id));
1503 while ($user->fetch()) {
1512 function getProfileTags()
1514 $profile = $this->getProfile();
1515 $list = $profile->getOtherTags($profile);
1518 while($list->fetch()) {
1519 $ptags[] = clone($list);
1525 public function getAttentionsFromProfileTags()
1528 $ptags = $this->getProfileTags();
1529 foreach ($ptags as $ptag) {
1530 $users = $ptag->getUserSubscribers();
1531 foreach ($users as $id) {
1532 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1539 * Record this notice to the given group inboxes for delivery.
1540 * Overrides the regular parsing of !group markup.
1542 * @param string $group_ids
1543 * @fixme might prefer URIs as identifiers, as for replies?
1544 * best with generalizations on user_group to support
1545 * remote groups better.
1547 function saveKnownGroups(array $group_ids)
1550 foreach (array_unique($group_ids) as $id) {
1551 $group = User_group::getKV('id', $id);
1552 if ($group instanceof User_group) {
1553 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1554 $result = $this->addToGroupInbox($group);
1556 common_log_db_error($gi, 'INSERT', __FILE__);
1559 if (common_config('group', 'addtag')) {
1560 // we automatically add a tag for every group name, too
1562 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1563 'notice_id' => $this->id));
1565 if (is_null($tag)) {
1566 $this->saveTag($group->nickname);
1570 $groups[] = clone($group);
1572 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1579 function addToGroupInbox(User_group $group)
1581 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1582 'notice_id' => $this->id));
1584 if (!$gi instanceof Group_inbox) {
1586 $gi = new Group_inbox();
1588 $gi->group_id = $group->id;
1589 $gi->notice_id = $this->id;
1590 $gi->created = $this->created;
1592 $result = $gi->insert();
1595 common_log_db_error($gi, 'INSERT', __FILE__);
1596 // TRANS: Server exception thrown when an update for a group inbox fails.
1597 throw new ServerException(_('Problem saving group inbox.'));
1600 self::blow('user_group:notice_ids:%d', $gi->group_id);
1606 function saveAttentions(array $uris)
1608 foreach ($uris as $uri=>$type) {
1610 $target = Profile::fromUri($uri);
1611 } catch (UnknownUriException $e) {
1612 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1617 $this->saveAttention($target);
1618 } catch (AlreadyFulfilledException $e) {
1619 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1620 } catch (Exception $e) {
1621 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1627 * Saves an attention for a profile (user or group) which means
1628 * it shows up in their home feed and such.
1630 function saveAttention(Profile $target, $reason=null)
1632 if ($target->isGroup()) {
1633 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1635 // legacy notification method, will still be in use for quite a while I think
1636 $this->addToGroupInbox($target->getGroup());
1638 if ($target->hasBlocked($this->getProfile())) {
1639 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1644 if ($target->isLocal()) {
1645 // legacy notification method, will still be in use for quite a while I think
1646 $this->saveReply($target->getID());
1649 $att = Attention::saveNew($this, $target, $reason);
1654 * Save reply records indicating that this notice needs to be
1655 * delivered to the local users with the given URIs.
1657 * Since this is expected to be used when saving foreign-sourced
1658 * messages, we won't deliver to any remote targets as that's the
1659 * source service's responsibility.
1661 * Mail notifications etc will be handled later.
1663 * @param array $uris Array of unique identifier URIs for recipients
1665 function saveKnownReplies(array $uris)
1671 $sender = $this->getProfile();
1673 foreach (array_unique($uris) as $uri) {
1675 $profile = Profile::fromUri($uri);
1676 } catch (UnknownUriException $e) {
1677 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1681 if ($profile->hasBlocked($sender)) {
1682 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1686 $this->saveReply($profile->getID());
1687 self::blow('reply:stream:%d', $profile->getID());
1692 * Pull @-replies from this message's content in StatusNet markup format
1693 * and save reply records indicating that this message needs to be
1694 * delivered to those users.
1696 * Mail notifications to local profiles will be sent later.
1698 * @return array of integer profile IDs
1701 function saveReplies()
1703 $sender = $this->getProfile();
1707 // If it's a reply, save for the replied-to author
1709 $parent = $this->getParent();
1710 $parentauthor = $parent->getProfile();
1711 $this->saveReply($parentauthor->getID());
1712 $replied[$parentauthor->getID()] = 1;
1713 self::blow('reply:stream:%d', $parentauthor->getID());
1714 } catch (NoParentNoticeException $e) {
1715 // Not a reply, since it has no parent!
1717 } catch (NoResultException $e) {
1718 // Parent notice was probably deleted
1722 // @todo ideally this parser information would only
1723 // be calculated once.
1725 $mentions = common_find_mentions($this->content, $sender, $parent);
1727 foreach ($mentions as $mention) {
1729 foreach ($mention['mentioned'] as $mentioned) {
1731 // skip if they're already covered
1732 if (array_key_exists($mentioned->id, $replied)) {
1736 // Don't save replies from blocked profile to local user
1737 if ($mentioned->hasBlocked($sender)) {
1741 $this->saveReply($mentioned->id);
1742 $replied[$mentioned->id] = 1;
1743 self::blow('reply:stream:%d', $mentioned->id);
1747 $recipientIds = array_keys($replied);
1749 return $recipientIds;
1752 function saveReply($profileId)
1754 $reply = new Reply();
1756 $reply->notice_id = $this->id;
1757 $reply->profile_id = $profileId;
1758 $reply->modified = $this->created;
1765 protected $_attentionids = array();
1768 * Pull the complete list of known activity context attentions for this notice.
1770 * @return array of integer profile ids (also group profiles)
1772 function getAttentionProfileIDs()
1774 if (!isset($this->_attentionids[$this->getID()])) {
1775 $atts = Attention::multiGet('notice_id', array($this->getID()));
1776 // (array)null means empty array
1777 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1779 return $this->_attentionids[$this->getID()];
1782 protected $_replies = array();
1785 * Pull the complete list of @-mentioned profile IDs for this notice.
1787 * @return array of integer profile ids
1789 function getReplies()
1791 if (!isset($this->_replies[$this->getID()])) {
1792 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1793 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1795 return $this->_replies[$this->getID()];
1798 function _setReplies($replies)
1800 $this->_replies[$this->getID()] = $replies;
1804 * Pull the complete list of @-reply targets for this notice.
1806 * @return array of Profiles
1808 function getAttentionProfiles()
1810 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1812 $profiles = Profile::multiGet('id', (array)$ids);
1814 return $profiles->fetchAll();
1818 * Send e-mail notifications to local @-reply targets.
1820 * Replies must already have been saved; this is expected to be run
1821 * from the distrib queue handler.
1823 function sendReplyNotifications()
1825 // Don't send reply notifications for repeats
1826 if ($this->isRepeat()) {
1830 $recipientIds = $this->getReplies();
1831 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1832 require_once INSTALLDIR.'/lib/mail.php';
1834 foreach ($recipientIds as $recipientId) {
1836 $user = User::getByID($recipientId);
1837 mail_notify_attn($user->getProfile(), $this);
1838 } catch (NoResultException $e) {
1842 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1847 * Pull list of Profile IDs of groups this notice addresses.
1849 * @return array of Group _profile_ IDs
1852 function getGroupProfileIDs()
1856 foreach ($this->getGroups() as $group) {
1857 $ids[] = $group->profile_id;
1864 * Pull list of groups this notice needs to be delivered to,
1865 * as previously recorded by saveKnownGroups().
1867 * @return array of Group objects
1870 protected $_groups = array();
1872 function getGroups()
1874 // Don't save groups for repeats
1876 if (!empty($this->repeat_of)) {
1880 if (isset($this->_groups[$this->id])) {
1881 return $this->_groups[$this->id];
1884 $gis = Group_inbox::listGet('notice_id', array($this->id));
1888 foreach ($gis[$this->id] as $gi) {
1889 $ids[] = $gi->group_id;
1892 $groups = User_group::multiGet('id', $ids);
1893 $this->_groups[$this->id] = $groups->fetchAll();
1894 return $this->_groups[$this->id];
1897 function _setGroups($groups)
1899 $this->_groups[$this->id] = $groups;
1903 * Convert a notice into an activity for export.
1905 * @param Profile $scoped The currently logged in/scoped profile
1907 * @return Activity activity object representing this Notice.
1910 function asActivity(Profile $scoped=null)
1912 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1914 if ($act instanceof Activity) {
1917 $act = new Activity();
1919 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1921 $act->id = $this->uri;
1922 $act->time = strtotime($this->created);
1924 $act->link = $this->getUrl();
1925 } catch (InvalidUrlException $e) {
1926 // The notice is probably a share or similar, which don't
1927 // have a representational URL of their own.
1929 $act->content = common_xml_safe_str($this->getRendered());
1931 $profile = $this->getProfile();
1933 $act->actor = $profile->asActivityObject();
1934 $act->actor->extra[] = $profile->profileInfo($scoped);
1936 $act->verb = $this->verb;
1938 if (!$this->repeat_of) {
1939 $act->objects[] = $this->asActivityObject();
1942 // XXX: should this be handled by default processing for object entry?
1946 $tags = $this->getTags();
1948 foreach ($tags as $tag) {
1949 $cat = new AtomCategory();
1952 $act->categories[] = $cat;
1956 // XXX: use Atom Media and/or File activity objects instead
1958 $attachments = $this->attachments();
1960 foreach ($attachments as $attachment) {
1961 // Include local attachments in Activity
1962 if (!empty($attachment->filename)) {
1963 $act->enclosures[] = $attachment->getEnclosure();
1967 $ctx = new ActivityContext();
1970 $reply = $this->getParent();
1971 $ctx->replyToID = $reply->getUri();
1972 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1973 } catch (NoParentNoticeException $e) {
1974 // This is not a reply to something
1975 } catch (NoResultException $e) {
1976 // Parent notice was probably deleted
1980 $ctx->location = Notice_location::locFromStored($this);
1981 } catch (ServerException $e) {
1982 $ctx->location = null;
1987 if (!empty($this->conversation)) {
1988 $conv = Conversation::getKV('id', $this->conversation);
1989 if ($conv instanceof Conversation) {
1990 $ctx->conversation = $conv->uri;
1994 // This covers the legacy getReplies and getGroups too which get their data
1995 // from entries stored via Notice::saveNew (which we want to move away from)...
1996 foreach ($this->getAttentionProfiles() as $target) {
1997 // User and group profiles which get the attention of this notice
1998 $ctx->attention[$target->getUri()] = $target->getObjectType();
2001 switch ($this->scope) {
2002 case Notice::PUBLIC_SCOPE:
2003 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2005 case Notice::FOLLOWER_SCOPE:
2006 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2007 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2011 $act->context = $ctx;
2013 $source = $this->getSource();
2015 if ($source instanceof Notice_source) {
2016 $act->generator = ActivityObject::fromNoticeSource($source);
2021 $atom_feed = $profile->getAtomFeed();
2023 if (!empty($atom_feed)) {
2025 $act->source = new ActivitySource();
2027 // XXX: we should store the actual feed ID
2029 $act->source->id = $atom_feed;
2031 // XXX: we should store the actual feed title
2033 $act->source->title = $profile->getBestName();
2035 $act->source->links['alternate'] = $profile->profileurl;
2036 $act->source->links['self'] = $atom_feed;
2038 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2040 $notice = $profile->getCurrentNotice();
2042 if ($notice instanceof Notice) {
2043 $act->source->updated = self::utcDate($notice->created);
2046 $user = User::getKV('id', $profile->id);
2048 if ($user instanceof User) {
2049 $act->source->links['license'] = common_config('license', 'url');
2053 if ($this->isLocal()) {
2054 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2055 'format' => 'atom'));
2056 $act->editLink = $act->selfLink;
2059 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2062 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2067 // This has gotten way too long. Needs to be sliced up into functional bits
2068 // or ideally exported to a utility class.
2070 function asAtomEntry($namespace=false,
2073 Profile $scoped=null)
2075 $act = $this->asActivity($scoped);
2076 $act->extra[] = $this->noticeInfo($scoped);
2077 return $act->asString($namespace, $author, $source);
2081 * Extra notice info for atom entries
2083 * Clients use some extra notice info in the atom stream.
2084 * This gives it to them.
2086 * @param Profile $scoped The currently logged in/scoped profile
2088 * @return array representation of <statusnet:notice_info> element
2091 function noticeInfo(Profile $scoped=null)
2093 // local notice ID (useful to clients for ordering)
2095 $noticeInfoAttr = array('local_id' => $this->id);
2099 $ns = $this->getSource();
2101 if ($ns instanceof Notice_source) {
2102 $noticeInfoAttr['source'] = $ns->code;
2103 if (!empty($ns->url)) {
2104 $noticeInfoAttr['source_link'] = $ns->url;
2105 if (!empty($ns->name)) {
2106 $noticeInfoAttr['source'] = '<a href="'
2107 . htmlspecialchars($ns->url)
2108 . '" rel="nofollow">'
2109 . htmlspecialchars($ns->name)
2115 // favorite and repeated
2117 if ($scoped instanceof Profile) {
2118 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2121 if (!empty($this->repeat_of)) {
2122 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2125 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2127 return array('statusnet:notice_info', $noticeInfoAttr, null);
2131 * Returns an XML string fragment with a reference to a notice as an
2132 * Activity Streams noun object with the given element type.
2134 * Assumes that 'activity' namespace has been previously defined.
2136 * @param string $element one of 'subject', 'object', 'target'
2140 function asActivityNoun($element)
2142 $noun = $this->asActivityObject();
2143 return $noun->asString('activity:' . $element);
2146 public function asActivityObject()
2148 $object = new ActivityObject();
2150 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2151 $object->type = $this->object_type ?: ActivityObject::NOTE;
2152 $object->id = $this->getUri();
2153 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2154 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2155 $object->content = $this->getRendered();
2156 $object->link = $this->getUrl();
2158 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2160 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2163 if (!$object instanceof ActivityObject) {
2164 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2165 throw new ServerException('Notice asActivityObject created something else.');
2172 * Determine which notice, if any, a new notice is in reply to.
2174 * For conversation tracking, we try to see where this notice fits
2175 * in the tree. Beware that this may very well give false positives
2176 * and add replies to wrong threads (if there have been newer posts
2177 * by the same user as we're replying to).
2179 * @param Profile $sender Author profile
2180 * @param string $content Final notice content
2182 * @return integer ID of replied-to notice, or null for not a reply.
2185 static function getInlineReplyTo(Profile $sender, $content)
2187 // Is there an initial @ or T?
2188 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2189 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2190 $nickname = common_canonical_nickname($match[1]);
2195 // Figure out who that is.
2196 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2198 if ($recipient instanceof Profile) {
2199 // Get their last notice
2200 $last = $recipient->getCurrentNotice();
2201 if ($last instanceof Notice) {
2204 // Maybe in the future we want to handle something else below
2205 // so don't return getCurrentNotice() immediately.
2211 static function maxContent()
2213 $contentlimit = common_config('notice', 'contentlimit');
2214 // null => use global limit (distinct from 0!)
2215 if (is_null($contentlimit)) {
2216 $contentlimit = common_config('site', 'textlimit');
2218 return $contentlimit;
2221 static function contentTooLong($content)
2223 $contentlimit = self::maxContent();
2224 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2228 * Convenience function for posting a repeat of an existing message.
2230 * @param Profile $repeater Profile which is doing the repeat
2231 * @param string $source: posting source key, eg 'web', 'api', etc
2234 * @throws Exception on failure or permission problems
2236 function repeat(Profile $repeater, $source)
2238 $author = $this->getProfile();
2240 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2241 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2242 $content = sprintf(_('RT @%1$s %2$s'),
2243 $author->getNickname(),
2246 $maxlen = self::maxContent();
2247 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2248 // Web interface and current Twitter API clients will
2249 // pull the original notice's text, but some older
2250 // clients and RSS/Atom feeds will see this trimmed text.
2252 // Unfortunately this is likely to lose tags or URLs
2253 // at the end of long notices.
2254 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2258 // Scope is same as this one's
2259 return self::saveNew($repeater->id,
2262 array('repeat_of' => $this->id,
2263 'scope' => $this->scope));
2266 // These are supposed to be in chron order!
2268 function repeatStream($limit=100)
2270 $cache = Cache::instance();
2272 if (empty($cache)) {
2273 $ids = $this->_repeatStreamDirect($limit);
2275 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2276 if ($idstr !== false) {
2277 if (empty($idstr)) {
2280 $ids = explode(',', $idstr);
2283 $ids = $this->_repeatStreamDirect(100);
2284 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2287 // We do a max of 100, so slice down to limit
2288 $ids = array_slice($ids, 0, $limit);
2292 return NoticeStream::getStreamByIds($ids);
2295 function _repeatStreamDirect($limit)
2297 $notice = new Notice();
2299 $notice->selectAdd(); // clears it
2300 $notice->selectAdd('id');
2302 $notice->repeat_of = $this->id;
2304 $notice->orderBy('created, id'); // NB: asc!
2306 if (!is_null($limit)) {
2307 $notice->limit(0, $limit);
2310 return $notice->fetchAll('id');
2313 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2317 if (!empty($location_id) && !empty($location_ns)) {
2318 $options['location_id'] = $location_id;
2319 $options['location_ns'] = $location_ns;
2321 $location = Location::fromId($location_id, $location_ns);
2323 if ($location instanceof Location) {
2324 $options['lat'] = $location->lat;
2325 $options['lon'] = $location->lon;
2328 } else if (!empty($lat) && !empty($lon)) {
2329 $options['lat'] = $lat;
2330 $options['lon'] = $lon;
2332 $location = Location::fromLatLon($lat, $lon);
2334 if ($location instanceof Location) {
2335 $options['location_id'] = $location->location_id;
2336 $options['location_ns'] = $location->location_ns;
2338 } else if (!empty($profile)) {
2339 if (isset($profile->lat) && isset($profile->lon)) {
2340 $options['lat'] = $profile->lat;
2341 $options['lon'] = $profile->lon;
2344 if (isset($profile->location_id) && isset($profile->location_ns)) {
2345 $options['location_id'] = $profile->location_id;
2346 $options['location_ns'] = $profile->location_ns;
2353 function clearAttentions()
2355 $att = new Attention();
2356 $att->notice_id = $this->getID();
2359 while ($att->fetch()) {
2360 // Can't do delete() on the object directly since it won't remove all of it
2361 $other = clone($att);
2367 function clearReplies()
2369 $replyNotice = new Notice();
2370 $replyNotice->reply_to = $this->id;
2372 //Null any notices that are replies to this notice
2374 if ($replyNotice->find()) {
2375 while ($replyNotice->fetch()) {
2376 $orig = clone($replyNotice);
2377 $replyNotice->reply_to = null;
2378 $replyNotice->update($orig);
2384 $reply = new Reply();
2385 $reply->notice_id = $this->id;
2387 if ($reply->find()) {
2388 while($reply->fetch()) {
2389 self::blow('reply:stream:%d', $reply->profile_id);
2397 function clearLocation()
2399 $loc = new Notice_location();
2400 $loc->notice_id = $this->id;
2407 function clearFiles()
2409 $f2p = new File_to_post();
2411 $f2p->post_id = $this->id;
2414 while ($f2p->fetch()) {
2418 // FIXME: decide whether to delete File objects
2419 // ...and related (actual) files
2422 function clearRepeats()
2424 $repeatNotice = new Notice();
2425 $repeatNotice->repeat_of = $this->id;
2427 //Null any notices that are repeats of this notice
2429 if ($repeatNotice->find()) {
2430 while ($repeatNotice->fetch()) {
2431 $orig = clone($repeatNotice);
2432 $repeatNotice->repeat_of = null;
2433 $repeatNotice->update($orig);
2438 function clearTags()
2440 $tag = new Notice_tag();
2441 $tag->notice_id = $this->id;
2444 while ($tag->fetch()) {
2445 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2446 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2447 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2448 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2456 function clearGroupInboxes()
2458 $gi = new Group_inbox();
2460 $gi->notice_id = $this->id;
2463 while ($gi->fetch()) {
2464 self::blow('user_group:notice_ids:%d', $gi->group_id);
2472 function distribute()
2474 // We always insert for the author so they don't
2476 Event::handle('StartNoticeDistribute', array($this));
2478 // If there's a failure, we want to _force_
2479 // distribution at this point.
2481 $json = json_encode((object)array('id' => $this->getID(),
2484 $qm = QueueManager::get();
2485 $qm->enqueue($json, 'distrib');
2486 } catch (Exception $e) {
2487 // If the exception isn't transient, this
2488 // may throw more exceptions as DQH does
2489 // its own enqueueing. So, we ignore them!
2491 $handler = new DistribQueueHandler();
2492 $handler->handle($this);
2493 } catch (Exception $e) {
2494 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2496 // Re-throw so somebody smarter can handle it.
2503 $result = parent::insert();
2505 if ($result === false) {
2506 common_log_db_error($this, 'INSERT', __FILE__);
2507 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2508 throw new ServerException('Could not save Notice');
2511 // Profile::hasRepeated() abuses pkeyGet(), so we
2512 // have to clear manually
2513 if (!empty($this->repeat_of)) {
2514 $c = self::memcache();
2516 $ck = self::multicacheKey('Notice',
2517 array('profile_id' => $this->profile_id,
2518 'repeat_of' => $this->repeat_of));
2523 // Update possibly ID-dependent columns: URI, conversation
2524 // (now that INSERT has added the notice's local id)
2525 $orig = clone($this);
2528 // We can only get here if it's a local notice, since remote notices
2529 // should've bailed out earlier due to lacking a URI.
2530 if (empty($this->uri)) {
2531 $this->uri = sprintf('%s%s=%d:%s=%s',
2533 'noticeId', $this->id,
2534 'objectType', $this->getObjectType(true));
2538 if ($changed && $this->update($orig) === false) {
2539 common_log_db_error($notice, 'UPDATE', __FILE__);
2540 // TRANS: Server exception thrown when a notice cannot be updated.
2541 throw new ServerException(_('Problem saving notice.'));
2544 $this->blowOnInsert();
2550 * Get the source of the notice
2552 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2553 * guaranteed to be populated.
2555 function getSource()
2557 if (empty($this->source)) {
2561 $ns = new Notice_source();
2562 switch ($this->source) {
2569 $ns->code = $this->source;
2572 $ns = Notice_source::getKV($this->source);
2574 $ns = new Notice_source();
2575 $ns->code = $this->source;
2576 $app = Oauth_application::getKV('name', $this->source);
2578 $ns->name = $app->name;
2579 $ns->url = $app->source_url;
2589 * Determine whether the notice was locally created
2591 * @return boolean locality
2594 public function isLocal()
2596 $is_local = intval($this->is_local);
2597 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2600 public function getScope()
2602 return intval($this->scope);
2605 public function isRepeat()
2607 return !empty($this->repeat_of);
2611 * Get the list of hash tags saved with this notice.
2613 * @return array of strings
2615 public function getTags()
2619 $keypart = sprintf('notice:tags:%d', $this->id);
2621 $tagstr = self::cacheGet($keypart);
2623 if ($tagstr !== false) {
2624 $tags = explode(',', $tagstr);
2626 $tag = new Notice_tag();
2627 $tag->notice_id = $this->id;
2629 while ($tag->fetch()) {
2630 $tags[] = $tag->tag;
2633 self::cacheSet($keypart, implode(',', $tags));
2639 static private function utcDate($dt)
2641 $dateStr = date('d F Y H:i:s', strtotime($dt));
2642 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2643 return $d->format(DATE_W3C);
2647 * Look up the creation timestamp for a given notice ID, even
2648 * if it's been deleted.
2651 * @return mixed string recorded creation timestamp, or false if can't be found
2653 public static function getAsTimestamp($id)
2656 throw new EmptyIdException('Notice');
2660 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2661 // getByID throws exception if $id isn't found
2662 $notice = Notice::getByID($id);
2663 $timestamp = $notice->created;
2666 if (empty($timestamp)) {
2667 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2673 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2674 * parameter, matching notices posted after the given one (exclusive).
2676 * If the referenced notice can't be found, will return false.
2679 * @param string $idField
2680 * @param string $createdField
2681 * @return mixed string or false if no match
2683 public static function whereSinceId($id, $idField='id', $createdField='created')
2686 $since = Notice::getAsTimestamp($id);
2687 } catch (Exception $e) {
2690 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2694 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2695 * parameter, matching notices posted after the given one (exclusive), and
2696 * if necessary add it to the data object's query.
2698 * @param DB_DataObject $obj
2700 * @param string $idField
2701 * @param string $createdField
2702 * @return mixed string or false if no match
2704 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2706 $since = self::whereSinceId($id, $idField, $createdField);
2708 $obj->whereAdd($since);
2713 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2714 * parameter, matching notices posted before the given one (inclusive).
2716 * If the referenced notice can't be found, will return false.
2719 * @param string $idField
2720 * @param string $createdField
2721 * @return mixed string or false if no match
2723 public static function whereMaxId($id, $idField='id', $createdField='created')
2726 $max = Notice::getAsTimestamp($id);
2727 } catch (Exception $e) {
2730 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2734 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2735 * parameter, matching notices posted before the given one (inclusive), and
2736 * if necessary add it to the data object's query.
2738 * @param DB_DataObject $obj
2740 * @param string $idField
2741 * @param string $createdField
2742 * @return mixed string or false if no match
2744 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2746 $max = self::whereMaxId($id, $idField, $createdField);
2748 $obj->whereAdd($max);
2752 public function isPublic()
2754 $is_local = intval($this->is_local);
2755 return !($is_local === Notice::LOCAL_NONPUBLIC || $is_local === Notice::GATEWAY);
2759 * Check that the given profile is allowed to read, respond to, or otherwise
2760 * act on this notice.
2762 * The $scope member is a bitmask of scopes, representing a logical AND of the
2763 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2764 * "only visible to people who are mentioned in the notice AND are users on this site."
2765 * Users on the site who are not mentioned in the notice will not be able to see the
2768 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2770 * @return boolean whether the profile is in the notice's scope
2772 function inScope($profile)
2774 if (is_null($profile)) {
2775 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2777 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2780 $result = self::cacheGet($keypart);
2782 if ($result === false) {
2784 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2785 $bResult = $this->_inScope($profile);
2786 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2788 $result = ($bResult) ? 1 : 0;
2789 self::cacheSet($keypart, $result, 0, 300);
2792 return ($result == 1) ? true : false;
2795 protected function _inScope($profile)
2797 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2799 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2800 return !$this->isHiddenSpam($profile);
2803 // If there's scope, anon cannot be in scope
2804 if (empty($profile)) {
2808 // Author is always in scope
2809 if ($this->profile_id == $profile->id) {
2813 // Only for users on this site
2814 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2818 // Only for users mentioned in the notice
2819 if ($scope & Notice::ADDRESSEE_SCOPE) {
2821 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2822 'profile_id' => $profile->id));
2824 if (!$reply instanceof Reply) {
2829 // Only for members of the given group
2830 if ($scope & Notice::GROUP_SCOPE) {
2832 // XXX: just query for the single membership
2834 $groups = $this->getGroups();
2838 foreach ($groups as $group) {
2839 if ($profile->isMember($group)) {
2850 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2852 if (!Subscription::exists($profile, $this->getProfile())) {
2857 return !$this->isHiddenSpam($profile);
2860 function isHiddenSpam($profile) {
2862 // Hide posts by silenced users from everyone but moderators.
2864 if (common_config('notice', 'hidespam')) {
2867 $author = $this->getProfile();
2868 } catch(Exception $e) {
2869 // If we can't get an author, keep it hidden.
2870 // XXX: technically not spam, but, whatever.
2874 if ($author->hasRole(Profile_role::SILENCED)) {
2875 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2884 public function hasParent()
2888 } catch (NoParentNoticeException $e) {
2894 public function getParent()
2896 $reply_to_id = null;
2898 if (empty($this->reply_to)) {
2899 throw new NoParentNoticeException($this);
2902 // The reply_to ID in the table Notice could exist with a number
2903 // however, the replied to notice might not exist in the database.
2904 // Thus we need to catch the exception and throw the NoParentNoticeException else
2905 // the timeline will not display correctly.
2907 $reply_to_id = self::getByID($this->reply_to);
2908 } catch(Exception $e){
2909 throw new NoParentNoticeException($this);
2912 return $reply_to_id;
2916 * Magic function called at serialize() time.
2918 * We use this to drop a couple process-specific references
2919 * from DB_DataObject which can cause trouble in future
2922 * @return array of variable names to include in serialization.
2927 $vars = parent::__sleep();
2928 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2929 return array_diff($vars, $skip);
2932 static function defaultScope()
2934 $scope = common_config('notice', 'defaultscope');
2935 if (is_null($scope)) {
2936 if (common_config('site', 'private')) {
2945 static function fillProfiles($notices)
2947 $map = self::getProfiles($notices);
2948 foreach ($notices as $entry=>$notice) {
2950 if (array_key_exists($notice->profile_id, $map)) {
2951 $notice->_setProfile($map[$notice->profile_id]);
2953 } catch (NoProfileException $e) {
2954 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2955 unset($notices[$entry]);
2959 return array_values($map);
2962 static function getProfiles(&$notices)
2965 foreach ($notices as $notice) {
2966 $ids[] = $notice->profile_id;
2968 $ids = array_unique($ids);
2969 return Profile::pivotGet('id', $ids);
2972 static function fillGroups(&$notices)
2974 $ids = self::_idsOf($notices);
2975 $gis = Group_inbox::listGet('notice_id', $ids);
2978 foreach ($gis as $id => $gi) {
2981 $gids[] = $g->group_id;
2985 $gids = array_unique($gids);
2986 $group = User_group::pivotGet('id', $gids);
2987 foreach ($notices as $notice)
2990 $gi = $gis[$notice->id];
2991 foreach ($gi as $g) {
2992 $grps[] = $group[$g->group_id];
2994 $notice->_setGroups($grps);
2998 static function _idsOf(array &$notices)
3001 foreach ($notices as $notice) {
3002 $ids[$notice->id] = true;
3004 return array_keys($ids);
3007 static function fillAttachments(&$notices)
3009 $ids = self::_idsOf($notices);
3010 $f2pMap = File_to_post::listGet('post_id', $ids);
3012 foreach ($f2pMap as $noticeId => $f2ps) {
3013 foreach ($f2ps as $f2p) {
3014 $fileIds[] = $f2p->file_id;
3018 $fileIds = array_unique($fileIds);
3019 $fileMap = File::pivotGet('id', $fileIds);
3020 foreach ($notices as $notice)
3023 $f2ps = $f2pMap[$notice->id];
3024 foreach ($f2ps as $f2p) {
3025 if (!isset($fileMap[$f2p->file_id])) {
3026 // We have probably deleted value from fileMap since
3027 // it as a NULL entry (see the following elseif).
3029 } elseif (is_null($fileMap[$f2p->file_id])) {
3030 // If the file id lookup returned a NULL value, it doesn't
3031 // exist in our file table! So this is a remnant file_to_post
3032 // entry that is no longer valid and should be removed.
3033 common_debug('ATTACHMENT deleting f2p for post_id='.$f2p->post_id.' file_id='.$f2p->file_id);
3035 unset($fileMap[$f2p->file_id]);
3038 $files[] = $fileMap[$f2p->file_id];
3040 $notice->_setAttachments($files);
3044 static function fillReplies(&$notices)
3046 $ids = self::_idsOf($notices);
3047 $replyMap = Reply::listGet('notice_id', $ids);
3048 foreach ($notices as $notice) {
3049 $replies = $replyMap[$notice->id];
3051 foreach ($replies as $reply) {
3052 $ids[] = $reply->profile_id;
3054 $notice->_setReplies($ids);
3058 static public function beforeSchemaUpdate()
3060 $table = strtolower(get_called_class());
3061 $schema = Schema::get();
3062 $schemadef = $schema->getTableDef($table);
3064 // 2015-09-04 We move Notice location data to Notice_location
3065 // First we see if we have to do this at all
3066 if (!isset($schemadef['fields']['lat'])
3067 && !isset($schemadef['fields']['lon'])
3068 && !isset($schemadef['fields']['location_id'])
3069 && !isset($schemadef['fields']['location_ns'])) {
3070 // We have already removed the location fields, so no need to migrate.
3073 // Then we make sure the Notice_location table is created!
3074 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3076 // Then we continue on our road to migration!
3077 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)";
3079 $notice = new Notice();
3080 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3081 'WHERE lat IS NOT NULL ' .
3082 'OR lon IS NOT NULL ' .
3083 'OR location_id IS NOT NULL ' .
3084 'OR location_ns IS NOT NULL',
3085 $schema->quoteIdentifier($table)));
3086 print "\nFound {$notice->N} notices with location data, inserting";
3087 while ($notice->fetch()) {
3088 $notloc = Notice_location::getKV('notice_id', $notice->id);
3089 if ($notloc instanceof Notice_location) {
3093 $notloc = new Notice_location();
3094 $notloc->notice_id = $notice->id;
3095 $notloc->lat= $notice->lat;
3096 $notloc->lon= $notice->lon;
3097 $notloc->location_id= $notice->location_id;
3098 $notloc->location_ns= $notice->location_ns;