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.'));
168 if (Event::handle('NoticeDeleteRelated', array($this))) {
169 // Clear related records
170 $this->clearReplies();
171 $this->clearLocation();
172 $this->clearRepeats();
174 $this->clearGroupInboxes();
176 $this->clearAttentions();
177 // NOTE: we don't clear queue items
181 if (!$delete_event || Event::handle('DeleteNoticeAsProfile', array($this, $actor, &$result))) {
182 // If $delete_event is true, we run the event. If the Event then
183 // returns false it is assumed everything was handled properly
184 // and the notice was deleted.
185 $result = $this->delete();
190 public function delete($useWhere=false)
192 $result = parent::delete($useWhere);
194 $this->blowOnDelete();
198 public function getUri()
204 * Get a Notice object by URI. Will call external plugins for help
205 * using the event StartGetNoticeFromURI.
207 * @param string $uri A unique identifier for a resource (notice in this case)
209 static function fromUri($uri)
213 if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
214 $notice = Notice::getKV('uri', $uri);
215 Event::handle('EndGetNoticeFromUri', array($uri, $notice));
218 if (!$notice instanceof Notice) {
219 throw new UnknownUriException($uri);
226 * @param $root boolean If true, link to just the conversation root.
228 * @return URL to conversation
230 public function getConversationUrl($anchor=true)
232 return Conversation::getUrlFromNotice($this, $anchor);
236 * Get the local representation URL of this notice.
238 public function getLocalUrl()
240 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
243 public function getTitle()
246 if (Event::handle('GetNoticeTitle', array($this, &$title))) {
247 // TRANS: Title of a notice posted without a title value.
248 // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
249 $title = sprintf(_('%1$s\'s status on %2$s'),
250 $this->getProfile()->getFancyName(),
251 common_exact_date($this->created));
256 public function getContent()
258 return $this->content;
261 public function getRendered()
263 // we test $this->id because if it's not inserted yet, we can't update the field
264 if (!empty($this->id) && (is_null($this->rendered) || $this->rendered === '')) {
265 // update to include rendered content on-the-fly, so we don't have to have a fix-up script in upgrade.php
266 common_debug('Rendering notice '.$this->getID().' as it had no rendered HTML content.');
267 $orig = clone($this);
268 $this->rendered = common_render_content($this->getContent(),
270 $this->hasParent() ? $this->getParent() : null);
271 $this->update($orig);
273 return $this->rendered;
276 public function getCreated()
278 return $this->created;
281 public function getVerb($make_relative=false)
283 return ActivityUtils::resolveUri($this->verb, $make_relative);
286 public function isVerb(array $verbs)
288 return ActivityUtils::compareVerbs($this->getVerb(), $verbs);
292 * Get the original representation URL of this notice.
294 * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
296 public function getUrl($fallback=false)
298 // The risk is we start having empty urls and non-http uris...
299 // and we can't really handle any other protocol right now.
301 case $this->isLocal():
302 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
303 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
305 case common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
308 // let's generate a valid link to our locally available notice on demand
309 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
311 common_debug('No URL available for notice: id='.$this->getID());
312 throw new InvalidUrlException($this->url);
316 public function getObjectType($canonical=false) {
317 if (is_null($this->object_type) || $this->object_type==='') {
318 throw new NoObjectTypeException($this);
320 return ActivityUtils::resolveUri($this->object_type, $canonical);
323 public function isObjectType(array $types)
326 return ActivityUtils::compareTypes($this->getObjectType(), $types);
327 } catch (NoObjectTypeException $e) {
332 public static function getByUri($uri)
334 $notice = new Notice();
336 if (!$notice->find(true)) {
337 throw new NoResultException($notice);
343 * Extract #hashtags from this notice's content and save them to the database.
347 /* extract all #hastags */
348 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
353 /* Add them to the database */
354 return $this->saveKnownTags($match[1]);
358 * Record the given set of hash tags in the db for this notice.
359 * Given tag strings will be normalized and checked for dupes.
361 function saveKnownTags($hashtags)
363 //turn each into their canonical tag
364 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
365 for($i=0; $i<count($hashtags); $i++) {
366 /* elide characters we don't want in the tag */
367 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
370 foreach(array_unique($hashtags) as $hashtag) {
371 $this->saveTag($hashtag);
372 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
378 * Record a single hash tag as associated with this notice.
379 * Tag format and uniqueness must be validated by caller.
381 function saveTag($hashtag)
383 $tag = new Notice_tag();
384 $tag->notice_id = $this->id;
385 $tag->tag = $hashtag;
386 $tag->created = $this->created;
387 $id = $tag->insert();
390 // TRANS: Server exception. %s are the error details.
391 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
392 $last_error->message));
396 // if it's saved, blow its cache
397 $tag->blowCache(false);
401 * Save a new notice and push it out to subscribers' inboxes.
402 * Poster's permissions are checked before sending.
404 * @param int $profile_id Profile ID of the poster
405 * @param string $content source message text; links may be shortened
406 * per current user's preference
407 * @param string $source source key ('web', 'api', etc)
408 * @param array $options Associative array of optional properties:
409 * string 'created' timestamp of notice; defaults to now
410 * int 'is_local' source/gateway ID, one of:
411 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
412 * Notice::REMOTE - Sent from a remote service;
413 * hide from public timeline but show in
414 * local "and friends" timelines
415 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
416 * Notice::GATEWAY - From another non-OStatus service;
417 * will not appear in public views
418 * float 'lat' decimal latitude for geolocation
419 * float 'lon' decimal longitude for geolocation
420 * int 'location_id' geoname identifier
421 * int 'location_ns' geoname namespace to interpret location_id
422 * int 'reply_to'; notice ID this is a reply to
423 * int 'repeat_of'; notice ID this is a repeat of
424 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
425 * string 'url' permalink to notice; defaults to local notice URL
426 * string 'rendered' rendered HTML version of content
427 * array 'replies' list of profile URIs for reply delivery in
428 * place of extracting @-replies from content.
429 * array 'groups' list of group IDs to deliver to, in place of
430 * extracting ! tags from content
431 * array 'tags' list of hashtag strings to save with the notice
432 * in place of extracting # tags from content
433 * array 'urls' list of attached/referred URLs to save with the
434 * notice in place of extracting links from content
435 * boolean 'distribute' whether to distribute the notice, default true
436 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
437 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
438 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
440 * @fixme tag override
443 * @throws ClientException
445 static function saveNew($profile_id, $content, $source, array $options=null) {
446 $defaults = array('uri' => null,
448 'conversation' => null, // URI of conversation
449 'reply_to' => null, // This will override convo URI if the parent is known
450 'repeat_of' => null, // This will override convo URI if the repeated notice is known
452 'distribute' => true,
453 'object_type' => null,
456 if (!empty($options) && is_array($options)) {
457 $options = array_merge($defaults, $options);
463 if (!isset($is_local)) {
464 $is_local = Notice::LOCAL_PUBLIC;
467 $profile = Profile::getKV('id', $profile_id);
468 if (!$profile instanceof Profile) {
469 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
470 throw new ClientException(_('Problem saving notice. Unknown user.'));
473 $user = User::getKV('id', $profile_id);
474 if ($user instanceof User) {
475 // Use the local user's shortening preferences, if applicable.
476 $final = $user->shortenLinks($content);
478 $final = common_shorten_links($content);
481 if (Notice::contentTooLong($final)) {
482 // TRANS: Client exception thrown if a notice contains too many characters.
483 throw new ClientException(_('Problem saving notice. Too long.'));
486 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
487 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
488 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
489 throw new ClientException(_('Too many notices too fast; take a breather '.
490 'and post again in a few minutes.'));
493 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
494 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
495 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
496 throw new ClientException(_('Too many duplicate messages too quickly;'.
497 ' take a breather and post again in a few minutes.'));
500 if (!$profile->hasRight(Right::NEWNOTICE)) {
501 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
503 // TRANS: Client exception thrown when a user tries to post while being banned.
504 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
507 $notice = new Notice();
508 $notice->profile_id = $profile_id;
510 if ($source && in_array($source, common_config('public', 'autosource'))) {
511 $notice->is_local = Notice::LOCAL_NONPUBLIC;
513 $notice->is_local = $is_local;
516 if (!empty($created)) {
517 $notice->created = $created;
519 $notice->created = common_sql_now();
522 if (!$notice->isLocal()) {
523 // Only do these checks for non-local notices. Local notices will generate these values later.
524 if (!common_valid_http_url($url)) {
525 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
528 throw new ServerException('No URI for remote notice. Cannot accept that.');
532 $notice->content = $final;
534 $notice->source = $source;
538 // Get the groups here so we can figure out replies and such
539 if (!isset($groups)) {
540 $groups = User_group::idsFromText($notice->content, $profile);
545 // Handle repeat case
547 if (!empty($options['repeat_of'])) {
549 // Check for a private one
551 $repeat = Notice::getByID($options['repeat_of']);
553 if ($profile->sameAs($repeat->getProfile())) {
554 // TRANS: Client error displayed when trying to repeat an own notice.
555 throw new ClientException(_('You cannot repeat your own notice.'));
558 if ($repeat->scope != Notice::SITE_SCOPE &&
559 $repeat->scope != Notice::PUBLIC_SCOPE) {
560 // TRANS: Client error displayed when trying to repeat a non-public notice.
561 throw new ClientException(_('Cannot repeat a private notice.'), 403);
564 if (!$repeat->inScope($profile)) {
565 // The generic checks above should cover this, but let's be sure!
566 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
567 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
570 if ($profile->hasRepeated($repeat)) {
571 // TRANS: Client error displayed when trying to repeat an already repeated notice.
572 throw new ClientException(_('You already repeated that notice.'));
575 $notice->repeat_of = $repeat->id;
576 $notice->conversation = $repeat->conversation;
580 // If $reply_to is specified, we check that it exists, and then
581 // return it if it does
582 if (!empty($reply_to)) {
583 $reply = Notice::getKV('id', $reply_to);
584 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
585 // If the source lacks capability of sending the "reply_to"
586 // metadata, let's try to find an inline replyto-reference.
587 $reply = self::getInlineReplyTo($profile, $final);
590 if ($reply instanceof Notice) {
591 if (!$reply->inScope($profile)) {
592 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
593 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
594 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
595 $profile->nickname, $reply->id), 403);
598 // If it's a repeat, the reply_to should be to the original
599 if ($reply->isRepeat()) {
600 $notice->reply_to = $reply->repeat_of;
602 $notice->reply_to = $reply->id;
604 // But the conversation ought to be the same :)
605 $notice->conversation = $reply->conversation;
607 // If the original is private to a group, and notice has
608 // no group specified, make it to the same group(s)
610 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
612 $replyGroups = $reply->getGroups();
613 foreach ($replyGroups as $group) {
614 if ($profile->isMember($group)) {
615 $groups[] = $group->id;
623 // If we don't know the reply, we might know the conversation!
624 // This will happen if a known remote user replies to an
625 // unknown remote user - within a known conversation.
626 if (empty($notice->conversation) and !empty($options['conversation'])) {
627 $conv = Conversation::getKV('uri', $options['conversation']);
628 if ($conv instanceof Conversation) {
629 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.').');
631 // Conversation entry with specified URI was not found, so we must create it.
632 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
633 // The insert in Conversation::create throws exception on failure
634 $conv = Conversation::create($options['conversation'], $notice->created);
636 $notice->conversation = $conv->getID();
641 // If it's not part of a conversation, it's the beginning of a new conversation.
642 if (empty($notice->conversation)) {
643 $conv = Conversation::create();
644 $notice->conversation = $conv->getID();
649 $notloc = new Notice_location();
650 if (!empty($lat) && !empty($lon)) {
655 if (!empty($location_ns) && !empty($location_id)) {
656 $notloc->location_id = $location_id;
657 $notloc->location_ns = $location_ns;
660 if (!empty($rendered)) {
661 $notice->rendered = $rendered;
663 $notice->rendered = common_render_content($final,
664 $notice->getProfile(),
665 $notice->hasParent() ? $notice->getParent() : null);
669 if ($notice->isRepeat()) {
670 $notice->verb = ActivityVerb::SHARE;
671 $notice->object_type = ActivityObject::ACTIVITY;
673 $notice->verb = ActivityVerb::POST;
676 $notice->verb = $verb;
679 if (empty($object_type)) {
680 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
682 $notice->object_type = $object_type;
685 if (is_null($scope) && $reply instanceof Notice) {
686 $notice->scope = $reply->scope;
688 $notice->scope = $scope;
691 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
693 if (Event::handle('StartNoticeSave', array(&$notice))) {
695 // XXX: some of these functions write to the DB
698 $notice->insert(); // throws exception on failure, if successful we have an ->id
700 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
701 $notloc->notice_id = $notice->getID();
702 $notloc->insert(); // store the notice location if it had any information
704 } catch (Exception $e) {
705 // Let's test if we managed initial insert, which would imply
706 // failing on some update-part (check 'insert()'). Delete if
707 // something had been stored to the database.
708 if (!empty($notice->id)) {
715 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
716 // the activityverb is a POST (since stuff like repeat, favorite etc.
717 // reasonably handle notifications themselves.
718 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
719 if (isset($replies)) {
720 $notice->saveKnownReplies($replies);
722 $notice->saveReplies();
726 $notice->saveKnownTags($tags);
731 // Note: groups may save tags, so must be run after tags are saved
732 // to avoid errors on duplicates.
733 // Note: groups should always be set.
735 $notice->saveKnownGroups($groups);
738 $notice->saveKnownUrls($urls);
745 // Prepare inbox delivery, may be queued to background.
746 $notice->distribute();
752 static function saveActivity(Activity $act, Profile $actor, array $options=array())
754 // First check if we're going to let this Activity through from the specific actor
755 if (!$actor->hasRight(Right::NEWNOTICE)) {
756 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
758 // TRANS: Client exception thrown when a user tries to post while being banned.
759 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
761 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
762 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
763 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
764 throw new ClientException(_m('Too many notices too fast; take a breather '.
765 'and post again in a few minutes.'));
768 // Get ActivityObject properties
770 if (!empty($act->id)) {
772 $options['uri'] = $act->id;
773 $options['url'] = $act->link;
775 $actobj = count($act->objects)===1 ? $act->objects[0] : null;
776 if (!is_null($actobj) && !empty($actobj->id)) {
777 $options['uri'] = $actobj->id;
779 $options['url'] = $actobj->link;
780 } elseif (preg_match('!^https?://!', $actobj->id)) {
781 $options['url'] = $actobj->id;
788 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
789 'mentions' => array(),
793 'source' => 'unknown',
798 'distribute' => true);
800 // options will have default values when nothing has been supplied
801 $options = array_merge($defaults, $options);
802 foreach (array_keys($defaults) as $key) {
803 // Only convert the keynames we specify ourselves from 'defaults' array into variables
804 $$key = $options[$key];
806 extract($options, EXTR_SKIP);
809 $stored = new Notice();
810 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
812 if ($stored->find()) {
813 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
814 // I _assume_ saving a Notice with a colliding URI means we're really trying to
815 // save the same notice again...
816 throw new AlreadyFulfilledException('Notice URI already exists');
820 // NOTE: Sandboxed users previously got all the notices _during_
821 // sandbox period set to to is_local=Notice::LOCAL_NONPUBLIC here.
822 // Since then we have started just filtering _when_ it gets shown
823 // instead of creating a mixed jumble of differently scoped notices.
825 if ($source && in_array($source, common_config('public', 'autosource'))) {
826 $stored->is_local = Notice::LOCAL_NONPUBLIC;
828 $stored->is_local = intval($is_local);
831 if (!$stored->isLocal()) {
832 // Only do these checks for non-local notices. Local notices will generate these values later.
833 if (!common_valid_http_url($url)) {
834 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
837 throw new ServerException('No URI for remote notice. Cannot accept that.');
841 $stored->profile_id = $actor->id;
842 $stored->source = $source;
845 $stored->verb = $act->verb;
847 // we use mb_strlen because it _might_ be that the content is just the string "0"...
848 $content = mb_strlen($act->content) ? $act->content : $act->summary;
849 if (mb_strlen($content)===0 && !is_null($actobj)) {
850 $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
852 // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
853 $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
854 $stored->content = common_strip_html($stored->getRendered(), true, true);
855 if (trim($stored->content) === '') {
856 // TRANS: Error message when the plain text content of a notice has zero length.
857 throw new ClientException(_('Empty notice content, will not save this.'));
860 // Maybe a missing act-time should be fatal if the actor is not local?
861 if (!empty($act->time)) {
862 $stored->created = common_sql_date($act->time);
864 $stored->created = common_sql_now();
868 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
869 $reply = self::getKV('uri', $act->context->replyToID);
871 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
872 $reply = self::getKV('uri', $act->target->id);
875 if ($reply instanceof Notice) {
876 if (!$reply->inScope($actor)) {
877 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
878 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
879 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
882 $stored->reply_to = $reply->id;
883 $stored->conversation = $reply->conversation;
885 // If the original is private to a group, and notice has no group specified,
886 // make it to the same group(s)
887 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
888 $replyGroups = $reply->getGroups();
889 foreach ($replyGroups as $group) {
890 if ($actor->isMember($group)) {
891 $groups[] = $group->id;
896 if (is_null($scope)) {
897 $scope = $reply->scope;
900 // If we don't know the reply, we might know the conversation!
901 // This will happen if a known remote user replies to an
902 // unknown remote user - within a known conversation.
903 if (empty($stored->conversation) and !empty($act->context->conversation)) {
904 $conv = Conversation::getKV('uri', $act->context->conversation);
905 if ($conv instanceof Conversation) {
906 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.').');
908 // Conversation entry with specified URI was not found, so we must create it.
909 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
910 // The insert in Conversation::create throws exception on failure
911 $conv = Conversation::create($act->context->conversation, $stored->created);
913 $stored->conversation = $conv->getID();
918 // If it's not part of a conversation, it's the beginning of a new conversation.
919 if (empty($stored->conversation)) {
920 $conv = Conversation::create();
921 $stored->conversation = $conv->getID();
926 if ($act->context instanceof ActivityContext) {
927 if ($act->context->location instanceof Location) {
928 $notloc = Notice_location::fromLocation($act->context->location);
931 $act->context = new ActivityContext();
934 if (array_key_exists('http://activityschema.org/collection/public', $act->context->attention)) {
935 common_debug('URI "http://activityschema.org/collection/public" was in notice attention, so we scope this public.');
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 $files = File::multiGet('id', $ids);
1270 $this->_attachments[$this->id] = $files->fetchAll();
1271 return $this->_attachments[$this->id];
1274 function _setAttachments($attachments)
1276 $this->_attachments[$this->id] = $attachments;
1279 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1281 $stream = new PublicNoticeStream();
1282 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1285 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null, Profile $scoped=null)
1287 $stream = new ConversationNoticeStream($id, $scoped);
1288 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1292 * Is this notice part of an active conversation?
1294 * @return boolean true if other messages exist in the same
1295 * conversation, false if this is the only one
1297 function hasConversation()
1299 if (empty($this->conversation)) {
1300 // this notice is not part of a conversation apparently
1301 // FIXME: all notices should have a conversation value, right?
1305 //FIXME: Get the Profile::current() stuff some other way
1306 // to avoid confusion between queue processing and session.
1307 $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
1309 // if our "offset 1, limit 1" query got a result, return true else false
1310 return $notice->N > 0;
1314 * Grab the earliest notice from this conversation.
1316 * @return Notice or null
1318 function conversationRoot($profile=-1)
1320 // XXX: can this happen?
1322 if (empty($this->conversation)) {
1326 // Get the current profile if not specified
1328 if (is_int($profile) && $profile == -1) {
1329 $profile = Profile::current();
1332 // If this notice is out of scope, no root for you!
1334 if (!$this->inScope($profile)) {
1338 // If this isn't a reply to anything, then it's its own
1339 // root if it's the earliest notice in the conversation:
1341 if (empty($this->reply_to)) {
1343 $root->conversation = $this->conversation;
1344 $root->orderBy('notice.created ASC');
1345 $root->find(true); // true means "fetch first result"
1350 if (is_null($profile)) {
1351 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1353 $keypart = sprintf('notice:conversation_root:%d:%d',
1358 $root = self::cacheGet($keypart);
1360 if ($root !== false && $root->inScope($profile)) {
1367 $parent = $last->getParent();
1368 if ($parent->inScope($profile)) {
1372 } catch (NoParentNoticeException $e) {
1373 // Latest notice has no parent
1374 } catch (NoResultException $e) {
1375 // Notice was not found, so we can't go further up in the tree.
1376 // FIXME: Maybe we should do this in a more stable way where deleted
1377 // notices won't break conversation chains?
1379 // No parent, or parent out of scope
1384 self::cacheSet($keypart, $root);
1390 * Pull up a full list of local recipients who will be getting
1391 * this notice in their inbox. Results will be cached, so don't
1392 * change the input data wily-nilly!
1394 * @param array $groups optional list of Group objects;
1395 * if left empty, will be loaded from group_inbox records
1396 * @param array $recipient optional list of reply profile ids
1397 * if left empty, will be loaded from reply records
1398 * @return array associating recipient user IDs with an inbox source constant
1400 function whoGets(array $groups=null, array $recipients=null)
1402 $c = self::memcache();
1405 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1406 if ($ni !== false) {
1411 if (is_null($recipients)) {
1412 $recipients = $this->getReplies();
1417 // Give plugins a chance to add folks in at start...
1418 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1420 $users = $this->getSubscribedUsers();
1421 foreach ($users as $id) {
1422 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1425 if (is_null($groups)) {
1426 $groups = $this->getGroups();
1428 foreach ($groups as $group) {
1429 $users = $group->getUserMembers();
1430 foreach ($users as $id) {
1431 if (!array_key_exists($id, $ni)) {
1432 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1437 $ptAtts = $this->getAttentionsFromProfileTags();
1438 foreach ($ptAtts as $key=>$val) {
1439 if (!array_key_exists($key, $ni)) {
1444 foreach ($recipients as $recipient) {
1445 if (!array_key_exists($recipient, $ni)) {
1446 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1450 // Exclude any deleted, non-local, or blocking recipients.
1451 $profile = $this->getProfile();
1452 $originalProfile = null;
1453 if ($this->isRepeat()) {
1454 // Check blocks against the original notice's poster as well.
1455 $original = Notice::getKV('id', $this->repeat_of);
1456 if ($original instanceof Notice) {
1457 $originalProfile = $original->getProfile();
1461 foreach ($ni as $id => $source) {
1463 $user = User::getKV('id', $id);
1464 if (!$user instanceof User ||
1465 $user->hasBlocked($profile) ||
1466 ($originalProfile && $user->hasBlocked($originalProfile))) {
1469 } catch (UserNoProfileException $e) {
1470 // User doesn't have a profile; invalid; skip them.
1475 // Give plugins a chance to filter out...
1476 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1480 // XXX: pack this data better
1481 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1487 function getSubscribedUsers()
1491 if(common_config('db','quote_identifiers'))
1492 $user_table = '"user"';
1493 else $user_table = 'user';
1497 'FROM '. $user_table .' JOIN subscription '.
1498 'ON '. $user_table .'.id = subscription.subscriber ' .
1499 'WHERE subscription.subscribed = %d ';
1501 $user->query(sprintf($qry, $this->profile_id));
1505 while ($user->fetch()) {
1514 function getProfileTags()
1516 $profile = $this->getProfile();
1517 $list = $profile->getOtherTags($profile);
1520 while($list->fetch()) {
1521 $ptags[] = clone($list);
1527 public function getAttentionsFromProfileTags()
1530 $ptags = $this->getProfileTags();
1531 foreach ($ptags as $ptag) {
1532 $users = $ptag->getUserSubscribers();
1533 foreach ($users as $id) {
1534 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1541 * Record this notice to the given group inboxes for delivery.
1542 * Overrides the regular parsing of !group markup.
1544 * @param string $group_ids
1545 * @fixme might prefer URIs as identifiers, as for replies?
1546 * best with generalizations on user_group to support
1547 * remote groups better.
1549 function saveKnownGroups(array $group_ids)
1552 foreach (array_unique($group_ids) as $id) {
1553 $group = User_group::getKV('id', $id);
1554 if ($group instanceof User_group) {
1555 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1556 $result = $this->addToGroupInbox($group);
1558 common_log_db_error($gi, 'INSERT', __FILE__);
1561 if (common_config('group', 'addtag')) {
1562 // we automatically add a tag for every group name, too
1564 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1565 'notice_id' => $this->id));
1567 if (is_null($tag)) {
1568 $this->saveTag($group->nickname);
1572 $groups[] = clone($group);
1574 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1581 function addToGroupInbox(User_group $group)
1583 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1584 'notice_id' => $this->id));
1586 if (!$gi instanceof Group_inbox) {
1588 $gi = new Group_inbox();
1590 $gi->group_id = $group->id;
1591 $gi->notice_id = $this->id;
1592 $gi->created = $this->created;
1594 $result = $gi->insert();
1597 common_log_db_error($gi, 'INSERT', __FILE__);
1598 // TRANS: Server exception thrown when an update for a group inbox fails.
1599 throw new ServerException(_('Problem saving group inbox.'));
1602 self::blow('user_group:notice_ids:%d', $gi->group_id);
1608 function saveAttentions(array $uris)
1610 foreach ($uris as $uri=>$type) {
1612 $target = Profile::fromUri($uri);
1613 } catch (UnknownUriException $e) {
1614 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1619 $this->saveAttention($target);
1620 } catch (AlreadyFulfilledException $e) {
1621 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1622 } catch (Exception $e) {
1623 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1629 * Saves an attention for a profile (user or group) which means
1630 * it shows up in their home feed and such.
1632 function saveAttention(Profile $target, $reason=null)
1634 if ($target->isGroup()) {
1635 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1637 // legacy notification method, will still be in use for quite a while I think
1638 $this->addToGroupInbox($target->getGroup());
1640 if ($target->hasBlocked($this->getProfile())) {
1641 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1646 if ($target->isLocal()) {
1647 // legacy notification method, will still be in use for quite a while I think
1648 $this->saveReply($target->getID());
1651 $att = Attention::saveNew($this, $target, $reason);
1656 * Save reply records indicating that this notice needs to be
1657 * delivered to the local users with the given URIs.
1659 * Since this is expected to be used when saving foreign-sourced
1660 * messages, we won't deliver to any remote targets as that's the
1661 * source service's responsibility.
1663 * Mail notifications etc will be handled later.
1665 * @param array $uris Array of unique identifier URIs for recipients
1667 function saveKnownReplies(array $uris)
1673 $sender = $this->getProfile();
1675 foreach (array_unique($uris) as $uri) {
1677 $profile = Profile::fromUri($uri);
1678 } catch (UnknownUriException $e) {
1679 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1683 if ($profile->hasBlocked($sender)) {
1684 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1688 $this->saveReply($profile->getID());
1689 self::blow('reply:stream:%d', $profile->getID());
1694 * Pull @-replies from this message's content in StatusNet markup format
1695 * and save reply records indicating that this message needs to be
1696 * delivered to those users.
1698 * Mail notifications to local profiles will be sent later.
1700 * @return array of integer profile IDs
1703 function saveReplies()
1705 $sender = $this->getProfile();
1709 // If it's a reply, save for the replied-to author
1711 $parent = $this->getParent();
1712 $parentauthor = $parent->getProfile();
1713 $this->saveReply($parentauthor->getID());
1714 $replied[$parentauthor->getID()] = 1;
1715 self::blow('reply:stream:%d', $parentauthor->getID());
1716 } catch (NoParentNoticeException $e) {
1717 // Not a reply, since it has no parent!
1719 } catch (NoResultException $e) {
1720 // Parent notice was probably deleted
1724 // @todo ideally this parser information would only
1725 // be calculated once.
1727 $mentions = common_find_mentions($this->content, $sender, $parent);
1729 foreach ($mentions as $mention) {
1731 foreach ($mention['mentioned'] as $mentioned) {
1733 // skip if they're already covered
1734 if (array_key_exists($mentioned->id, $replied)) {
1738 // Don't save replies from blocked profile to local user
1739 if ($mentioned->hasBlocked($sender)) {
1743 $this->saveReply($mentioned->id);
1744 $replied[$mentioned->id] = 1;
1745 self::blow('reply:stream:%d', $mentioned->id);
1749 $recipientIds = array_keys($replied);
1751 return $recipientIds;
1754 function saveReply($profileId)
1756 $reply = new Reply();
1758 $reply->notice_id = $this->id;
1759 $reply->profile_id = $profileId;
1760 $reply->modified = $this->created;
1767 protected $_attentionids = array();
1770 * Pull the complete list of known activity context attentions for this notice.
1772 * @return array of integer profile ids (also group profiles)
1774 function getAttentionProfileIDs()
1776 if (!isset($this->_attentionids[$this->getID()])) {
1777 $atts = Attention::multiGet('notice_id', array($this->getID()));
1778 // (array)null means empty array
1779 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1781 return $this->_attentionids[$this->getID()];
1784 protected $_replies = array();
1787 * Pull the complete list of @-mentioned profile IDs for this notice.
1789 * @return array of integer profile ids
1791 function getReplies()
1793 if (!isset($this->_replies[$this->getID()])) {
1794 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1795 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1797 return $this->_replies[$this->getID()];
1800 function _setReplies($replies)
1802 $this->_replies[$this->getID()] = $replies;
1806 * Pull the complete list of @-reply targets for this notice.
1808 * @return array of Profiles
1810 function getAttentionProfiles()
1812 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1814 $profiles = Profile::multiGet('id', (array)$ids);
1816 return $profiles->fetchAll();
1820 * Send e-mail notifications to local @-reply targets.
1822 * Replies must already have been saved; this is expected to be run
1823 * from the distrib queue handler.
1825 function sendReplyNotifications()
1827 // Don't send reply notifications for repeats
1828 if ($this->isRepeat()) {
1832 $recipientIds = $this->getReplies();
1833 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1834 require_once INSTALLDIR.'/lib/mail.php';
1836 foreach ($recipientIds as $recipientId) {
1838 $user = User::getByID($recipientId);
1839 mail_notify_attn($user->getProfile(), $this);
1840 } catch (NoResultException $e) {
1844 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1849 * Pull list of Profile IDs of groups this notice addresses.
1851 * @return array of Group _profile_ IDs
1854 function getGroupProfileIDs()
1858 foreach ($this->getGroups() as $group) {
1859 $ids[] = $group->profile_id;
1866 * Pull list of groups this notice needs to be delivered to,
1867 * as previously recorded by saveKnownGroups().
1869 * @return array of Group objects
1872 protected $_groups = array();
1874 function getGroups()
1876 // Don't save groups for repeats
1878 if (!empty($this->repeat_of)) {
1882 if (isset($this->_groups[$this->id])) {
1883 return $this->_groups[$this->id];
1886 $gis = Group_inbox::listGet('notice_id', array($this->id));
1890 foreach ($gis[$this->id] as $gi) {
1891 $ids[] = $gi->group_id;
1894 $groups = User_group::multiGet('id', $ids);
1895 $this->_groups[$this->id] = $groups->fetchAll();
1896 return $this->_groups[$this->id];
1899 function _setGroups($groups)
1901 $this->_groups[$this->id] = $groups;
1905 * Convert a notice into an activity for export.
1907 * @param Profile $scoped The currently logged in/scoped profile
1909 * @return Activity activity object representing this Notice.
1912 function asActivity(Profile $scoped=null)
1914 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1916 if ($act instanceof Activity) {
1919 $act = new Activity();
1921 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1923 $act->id = $this->uri;
1924 $act->time = strtotime($this->created);
1926 $act->link = $this->getUrl();
1927 } catch (InvalidUrlException $e) {
1928 // The notice is probably a share or similar, which don't
1929 // have a representational URL of their own.
1931 $act->content = common_xml_safe_str($this->getRendered());
1933 $profile = $this->getProfile();
1935 $act->actor = $profile->asActivityObject();
1936 $act->actor->extra[] = $profile->profileInfo($scoped);
1938 $act->verb = $this->verb;
1940 if (!$this->repeat_of) {
1941 $act->objects[] = $this->asActivityObject();
1944 // XXX: should this be handled by default processing for object entry?
1948 $tags = $this->getTags();
1950 foreach ($tags as $tag) {
1951 $cat = new AtomCategory();
1954 $act->categories[] = $cat;
1958 // XXX: use Atom Media and/or File activity objects instead
1960 $attachments = $this->attachments();
1962 foreach ($attachments as $attachment) {
1963 // Include local attachments in Activity
1964 if (!empty($attachment->filename)) {
1965 $act->enclosures[] = $attachment->getEnclosure();
1969 $ctx = new ActivityContext();
1972 $reply = $this->getParent();
1973 $ctx->replyToID = $reply->getUri();
1974 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1975 } catch (NoParentNoticeException $e) {
1976 // This is not a reply to something
1977 } catch (NoResultException $e) {
1978 // Parent notice was probably deleted
1982 $ctx->location = Notice_location::locFromStored($this);
1983 } catch (ServerException $e) {
1984 $ctx->location = null;
1989 if (!empty($this->conversation)) {
1990 $conv = Conversation::getKV('id', $this->conversation);
1991 if ($conv instanceof Conversation) {
1992 $ctx->conversation = $conv->uri;
1996 // This covers the legacy getReplies and getGroups too which get their data
1997 // from entries stored via Notice::saveNew (which we want to move away from)...
1998 foreach ($this->getAttentionProfiles() as $target) {
1999 // User and group profiles which get the attention of this notice
2000 $ctx->attention[$target->getUri()] = $target->getObjectType();
2003 switch ($this->scope) {
2004 case Notice::PUBLIC_SCOPE:
2005 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2007 case Notice::FOLLOWER_SCOPE:
2008 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2009 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2013 $act->context = $ctx;
2015 $source = $this->getSource();
2017 if ($source instanceof Notice_source) {
2018 $act->generator = ActivityObject::fromNoticeSource($source);
2023 $atom_feed = $profile->getAtomFeed();
2025 if (!empty($atom_feed)) {
2027 $act->source = new ActivitySource();
2029 // XXX: we should store the actual feed ID
2031 $act->source->id = $atom_feed;
2033 // XXX: we should store the actual feed title
2035 $act->source->title = $profile->getBestName();
2037 $act->source->links['alternate'] = $profile->profileurl;
2038 $act->source->links['self'] = $atom_feed;
2040 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2042 $notice = $profile->getCurrentNotice();
2044 if ($notice instanceof Notice) {
2045 $act->source->updated = self::utcDate($notice->created);
2048 $user = User::getKV('id', $profile->id);
2050 if ($user instanceof User) {
2051 $act->source->links['license'] = common_config('license', 'url');
2055 if ($this->isLocal()) {
2056 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2057 'format' => 'atom'));
2058 $act->editLink = $act->selfLink;
2061 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2064 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2069 // This has gotten way too long. Needs to be sliced up into functional bits
2070 // or ideally exported to a utility class.
2072 function asAtomEntry($namespace=false,
2075 Profile $scoped=null)
2077 $act = $this->asActivity($scoped);
2078 $act->extra[] = $this->noticeInfo($scoped);
2079 return $act->asString($namespace, $author, $source);
2083 * Extra notice info for atom entries
2085 * Clients use some extra notice info in the atom stream.
2086 * This gives it to them.
2088 * @param Profile $scoped The currently logged in/scoped profile
2090 * @return array representation of <statusnet:notice_info> element
2093 function noticeInfo(Profile $scoped=null)
2095 // local notice ID (useful to clients for ordering)
2097 $noticeInfoAttr = array('local_id' => $this->id);
2101 $ns = $this->getSource();
2103 if ($ns instanceof Notice_source) {
2104 $noticeInfoAttr['source'] = $ns->code;
2105 if (!empty($ns->url)) {
2106 $noticeInfoAttr['source_link'] = $ns->url;
2107 if (!empty($ns->name)) {
2108 $noticeInfoAttr['source'] = '<a href="'
2109 . htmlspecialchars($ns->url)
2110 . '" rel="nofollow">'
2111 . htmlspecialchars($ns->name)
2117 // favorite and repeated
2119 if ($scoped instanceof Profile) {
2120 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2123 if (!empty($this->repeat_of)) {
2124 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2127 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2129 return array('statusnet:notice_info', $noticeInfoAttr, null);
2133 * Returns an XML string fragment with a reference to a notice as an
2134 * Activity Streams noun object with the given element type.
2136 * Assumes that 'activity' namespace has been previously defined.
2138 * @param string $element one of 'subject', 'object', 'target'
2142 function asActivityNoun($element)
2144 $noun = $this->asActivityObject();
2145 return $noun->asString('activity:' . $element);
2148 public function asActivityObject()
2150 $object = new ActivityObject();
2152 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2153 $object->type = $this->object_type ?: ActivityObject::NOTE;
2154 $object->id = $this->getUri();
2155 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2156 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2157 $object->content = $this->getRendered();
2158 $object->link = $this->getUrl();
2160 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2162 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2165 if (!$object instanceof ActivityObject) {
2166 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2167 throw new ServerException('Notice asActivityObject created something else.');
2174 * Determine which notice, if any, a new notice is in reply to.
2176 * For conversation tracking, we try to see where this notice fits
2177 * in the tree. Beware that this may very well give false positives
2178 * and add replies to wrong threads (if there have been newer posts
2179 * by the same user as we're replying to).
2181 * @param Profile $sender Author profile
2182 * @param string $content Final notice content
2184 * @return integer ID of replied-to notice, or null for not a reply.
2187 static function getInlineReplyTo(Profile $sender, $content)
2189 // Is there an initial @ or T?
2190 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2191 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2192 $nickname = common_canonical_nickname($match[1]);
2197 // Figure out who that is.
2198 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2200 if ($recipient instanceof Profile) {
2201 // Get their last notice
2202 $last = $recipient->getCurrentNotice();
2203 if ($last instanceof Notice) {
2206 // Maybe in the future we want to handle something else below
2207 // so don't return getCurrentNotice() immediately.
2213 static function maxContent()
2215 $contentlimit = common_config('notice', 'contentlimit');
2216 // null => use global limit (distinct from 0!)
2217 if (is_null($contentlimit)) {
2218 $contentlimit = common_config('site', 'textlimit');
2220 return $contentlimit;
2223 static function contentTooLong($content)
2225 $contentlimit = self::maxContent();
2226 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2230 * Convenience function for posting a repeat of an existing message.
2232 * @param Profile $repeater Profile which is doing the repeat
2233 * @param string $source: posting source key, eg 'web', 'api', etc
2236 * @throws Exception on failure or permission problems
2238 function repeat(Profile $repeater, $source)
2240 $author = $this->getProfile();
2242 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2243 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2244 $content = sprintf(_('RT @%1$s %2$s'),
2245 $author->getNickname(),
2248 $maxlen = self::maxContent();
2249 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2250 // Web interface and current Twitter API clients will
2251 // pull the original notice's text, but some older
2252 // clients and RSS/Atom feeds will see this trimmed text.
2254 // Unfortunately this is likely to lose tags or URLs
2255 // at the end of long notices.
2256 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2260 // Scope is same as this one's
2261 return self::saveNew($repeater->id,
2264 array('repeat_of' => $this->id,
2265 'scope' => $this->scope));
2268 // These are supposed to be in chron order!
2270 function repeatStream($limit=100)
2272 $cache = Cache::instance();
2274 if (empty($cache)) {
2275 $ids = $this->_repeatStreamDirect($limit);
2277 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2278 if ($idstr !== false) {
2279 if (empty($idstr)) {
2282 $ids = explode(',', $idstr);
2285 $ids = $this->_repeatStreamDirect(100);
2286 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2289 // We do a max of 100, so slice down to limit
2290 $ids = array_slice($ids, 0, $limit);
2294 return NoticeStream::getStreamByIds($ids);
2297 function _repeatStreamDirect($limit)
2299 $notice = new Notice();
2301 $notice->selectAdd(); // clears it
2302 $notice->selectAdd('id');
2304 $notice->repeat_of = $this->id;
2306 $notice->orderBy('created, id'); // NB: asc!
2308 if (!is_null($limit)) {
2309 $notice->limit(0, $limit);
2312 return $notice->fetchAll('id');
2315 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2319 if (!empty($location_id) && !empty($location_ns)) {
2320 $options['location_id'] = $location_id;
2321 $options['location_ns'] = $location_ns;
2323 $location = Location::fromId($location_id, $location_ns);
2325 if ($location instanceof Location) {
2326 $options['lat'] = $location->lat;
2327 $options['lon'] = $location->lon;
2330 } else if (!empty($lat) && !empty($lon)) {
2331 $options['lat'] = $lat;
2332 $options['lon'] = $lon;
2334 $location = Location::fromLatLon($lat, $lon);
2336 if ($location instanceof Location) {
2337 $options['location_id'] = $location->location_id;
2338 $options['location_ns'] = $location->location_ns;
2340 } else if (!empty($profile)) {
2341 if (isset($profile->lat) && isset($profile->lon)) {
2342 $options['lat'] = $profile->lat;
2343 $options['lon'] = $profile->lon;
2346 if (isset($profile->location_id) && isset($profile->location_ns)) {
2347 $options['location_id'] = $profile->location_id;
2348 $options['location_ns'] = $profile->location_ns;
2355 function clearAttentions()
2357 $att = new Attention();
2358 $att->notice_id = $this->getID();
2361 while ($att->fetch()) {
2362 // Can't do delete() on the object directly since it won't remove all of it
2363 $other = clone($att);
2369 function clearReplies()
2371 $replyNotice = new Notice();
2372 $replyNotice->reply_to = $this->id;
2374 //Null any notices that are replies to this notice
2376 if ($replyNotice->find()) {
2377 while ($replyNotice->fetch()) {
2378 $orig = clone($replyNotice);
2379 $replyNotice->reply_to = null;
2380 $replyNotice->update($orig);
2386 $reply = new Reply();
2387 $reply->notice_id = $this->id;
2389 if ($reply->find()) {
2390 while($reply->fetch()) {
2391 self::blow('reply:stream:%d', $reply->profile_id);
2399 function clearLocation()
2401 $loc = new Notice_location();
2402 $loc->notice_id = $this->id;
2409 function clearFiles()
2411 $f2p = new File_to_post();
2413 $f2p->post_id = $this->id;
2416 while ($f2p->fetch()) {
2420 // FIXME: decide whether to delete File objects
2421 // ...and related (actual) files
2424 function clearRepeats()
2426 $repeatNotice = new Notice();
2427 $repeatNotice->repeat_of = $this->id;
2429 //Null any notices that are repeats of this notice
2431 if ($repeatNotice->find()) {
2432 while ($repeatNotice->fetch()) {
2433 $orig = clone($repeatNotice);
2434 $repeatNotice->repeat_of = null;
2435 $repeatNotice->update($orig);
2440 function clearTags()
2442 $tag = new Notice_tag();
2443 $tag->notice_id = $this->id;
2446 while ($tag->fetch()) {
2447 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2448 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2449 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2450 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2458 function clearGroupInboxes()
2460 $gi = new Group_inbox();
2462 $gi->notice_id = $this->id;
2465 while ($gi->fetch()) {
2466 self::blow('user_group:notice_ids:%d', $gi->group_id);
2474 function distribute()
2476 // We always insert for the author so they don't
2478 Event::handle('StartNoticeDistribute', array($this));
2480 // If there's a failure, we want to _force_
2481 // distribution at this point.
2483 $json = json_encode((object)array('id' => $this->getID(),
2486 $qm = QueueManager::get();
2487 $qm->enqueue($json, 'distrib');
2488 } catch (Exception $e) {
2489 // If the exception isn't transient, this
2490 // may throw more exceptions as DQH does
2491 // its own enqueueing. So, we ignore them!
2493 $handler = new DistribQueueHandler();
2494 $handler->handle($this);
2495 } catch (Exception $e) {
2496 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2498 // Re-throw so somebody smarter can handle it.
2505 $result = parent::insert();
2507 if ($result === false) {
2508 common_log_db_error($this, 'INSERT', __FILE__);
2509 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2510 throw new ServerException('Could not save Notice');
2513 // Profile::hasRepeated() abuses pkeyGet(), so we
2514 // have to clear manually
2515 if (!empty($this->repeat_of)) {
2516 $c = self::memcache();
2518 $ck = self::multicacheKey('Notice',
2519 array('profile_id' => $this->profile_id,
2520 'repeat_of' => $this->repeat_of));
2525 // Update possibly ID-dependent columns: URI, conversation
2526 // (now that INSERT has added the notice's local id)
2527 $orig = clone($this);
2530 // We can only get here if it's a local notice, since remote notices
2531 // should've bailed out earlier due to lacking a URI.
2532 if (empty($this->uri)) {
2533 $this->uri = sprintf('%s%s=%d:%s=%s',
2535 'noticeId', $this->id,
2536 'objectType', $this->getObjectType(true));
2540 if ($changed && $this->update($orig) === false) {
2541 common_log_db_error($notice, 'UPDATE', __FILE__);
2542 // TRANS: Server exception thrown when a notice cannot be updated.
2543 throw new ServerException(_('Problem saving notice.'));
2546 $this->blowOnInsert();
2552 * Get the source of the notice
2554 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2555 * guaranteed to be populated.
2557 function getSource()
2559 if (empty($this->source)) {
2563 $ns = new Notice_source();
2564 switch ($this->source) {
2571 $ns->code = $this->source;
2574 $ns = Notice_source::getKV($this->source);
2576 $ns = new Notice_source();
2577 $ns->code = $this->source;
2578 $app = Oauth_application::getKV('name', $this->source);
2580 $ns->name = $app->name;
2581 $ns->url = $app->source_url;
2591 * Determine whether the notice was locally created
2593 * @return boolean locality
2596 public function isLocal()
2598 $is_local = intval($this->is_local);
2599 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2602 public function getScope()
2604 return intval($this->scope);
2607 public function isRepeat()
2609 return !empty($this->repeat_of);
2613 * Get the list of hash tags saved with this notice.
2615 * @return array of strings
2617 public function getTags()
2621 $keypart = sprintf('notice:tags:%d', $this->id);
2623 $tagstr = self::cacheGet($keypart);
2625 if ($tagstr !== false) {
2626 $tags = explode(',', $tagstr);
2628 $tag = new Notice_tag();
2629 $tag->notice_id = $this->id;
2631 while ($tag->fetch()) {
2632 $tags[] = $tag->tag;
2635 self::cacheSet($keypart, implode(',', $tags));
2641 static private function utcDate($dt)
2643 $dateStr = date('d F Y H:i:s', strtotime($dt));
2644 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2645 return $d->format(DATE_W3C);
2649 * Look up the creation timestamp for a given notice ID, even
2650 * if it's been deleted.
2653 * @return mixed string recorded creation timestamp, or false if can't be found
2655 public static function getAsTimestamp($id)
2658 throw new EmptyIdException('Notice');
2662 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2663 // getByID throws exception if $id isn't found
2664 $notice = Notice::getByID($id);
2665 $timestamp = $notice->created;
2668 if (empty($timestamp)) {
2669 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2675 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2676 * parameter, matching notices posted after the given one (exclusive).
2678 * If the referenced notice can't be found, will return false.
2681 * @param string $idField
2682 * @param string $createdField
2683 * @return mixed string or false if no match
2685 public static function whereSinceId($id, $idField='id', $createdField='created')
2688 $since = Notice::getAsTimestamp($id);
2689 } catch (Exception $e) {
2692 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2696 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2697 * parameter, matching notices posted after the given one (exclusive), and
2698 * if necessary add it to the data object's query.
2700 * @param DB_DataObject $obj
2702 * @param string $idField
2703 * @param string $createdField
2704 * @return mixed string or false if no match
2706 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2708 $since = self::whereSinceId($id, $idField, $createdField);
2710 $obj->whereAdd($since);
2715 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2716 * parameter, matching notices posted before the given one (inclusive).
2718 * If the referenced notice can't be found, will return false.
2721 * @param string $idField
2722 * @param string $createdField
2723 * @return mixed string or false if no match
2725 public static function whereMaxId($id, $idField='id', $createdField='created')
2728 $max = Notice::getAsTimestamp($id);
2729 } catch (Exception $e) {
2732 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2736 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2737 * parameter, matching notices posted before the given one (inclusive), and
2738 * if necessary add it to the data object's query.
2740 * @param DB_DataObject $obj
2742 * @param string $idField
2743 * @param string $createdField
2744 * @return mixed string or false if no match
2746 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2748 $max = self::whereMaxId($id, $idField, $createdField);
2750 $obj->whereAdd($max);
2756 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2757 ($this->is_local != Notice::GATEWAY));
2761 * Check that the given profile is allowed to read, respond to, or otherwise
2762 * act on this notice.
2764 * The $scope member is a bitmask of scopes, representing a logical AND of the
2765 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2766 * "only visible to people who are mentioned in the notice AND are users on this site."
2767 * Users on the site who are not mentioned in the notice will not be able to see the
2770 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2772 * @return boolean whether the profile is in the notice's scope
2774 function inScope($profile)
2776 if (is_null($profile)) {
2777 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2779 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2782 $result = self::cacheGet($keypart);
2784 if ($result === false) {
2786 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2787 $bResult = $this->_inScope($profile);
2788 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2790 $result = ($bResult) ? 1 : 0;
2791 self::cacheSet($keypart, $result, 0, 300);
2794 return ($result == 1) ? true : false;
2797 protected function _inScope($profile)
2799 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2801 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2802 return !$this->isHiddenSpam($profile);
2805 // If there's scope, anon cannot be in scope
2806 if (empty($profile)) {
2810 // Author is always in scope
2811 if ($this->profile_id == $profile->id) {
2815 // Only for users on this site
2816 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2820 // Only for users mentioned in the notice
2821 if ($scope & Notice::ADDRESSEE_SCOPE) {
2823 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2824 'profile_id' => $profile->id));
2826 if (!$reply instanceof Reply) {
2831 // Only for members of the given group
2832 if ($scope & Notice::GROUP_SCOPE) {
2834 // XXX: just query for the single membership
2836 $groups = $this->getGroups();
2840 foreach ($groups as $group) {
2841 if ($profile->isMember($group)) {
2852 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2854 if (!Subscription::exists($profile, $this->getProfile())) {
2859 return !$this->isHiddenSpam($profile);
2862 function isHiddenSpam($profile) {
2864 // Hide posts by silenced users from everyone but moderators.
2866 if (common_config('notice', 'hidespam')) {
2869 $author = $this->getProfile();
2870 } catch(Exception $e) {
2871 // If we can't get an author, keep it hidden.
2872 // XXX: technically not spam, but, whatever.
2876 if ($author->hasRole(Profile_role::SILENCED)) {
2877 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2886 public function hasParent()
2890 } catch (NoParentNoticeException $e) {
2896 public function getParent()
2898 $reply_to_id = null;
2900 if (empty($this->reply_to)) {
2901 throw new NoParentNoticeException($this);
2904 // The reply_to ID in the table Notice could exist with a number
2905 // however, the replied to notice might not exist in the database.
2906 // Thus we need to catch the exception and throw the NoParentNoticeException else
2907 // the timeline will not display correctly.
2909 $reply_to_id = self::getByID($this->reply_to);
2910 } catch(Exception $e){
2911 throw new NoParentNoticeException($this);
2914 return $reply_to_id;
2918 * Magic function called at serialize() time.
2920 * We use this to drop a couple process-specific references
2921 * from DB_DataObject which can cause trouble in future
2924 * @return array of variable names to include in serialization.
2929 $vars = parent::__sleep();
2930 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2931 return array_diff($vars, $skip);
2934 static function defaultScope()
2936 $scope = common_config('notice', 'defaultscope');
2937 if (is_null($scope)) {
2938 if (common_config('site', 'private')) {
2947 static function fillProfiles($notices)
2949 $map = self::getProfiles($notices);
2950 foreach ($notices as $entry=>$notice) {
2952 if (array_key_exists($notice->profile_id, $map)) {
2953 $notice->_setProfile($map[$notice->profile_id]);
2955 } catch (NoProfileException $e) {
2956 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2957 unset($notices[$entry]);
2961 return array_values($map);
2964 static function getProfiles(&$notices)
2967 foreach ($notices as $notice) {
2968 $ids[] = $notice->profile_id;
2970 $ids = array_unique($ids);
2971 return Profile::pivotGet('id', $ids);
2974 static function fillGroups(&$notices)
2976 $ids = self::_idsOf($notices);
2977 $gis = Group_inbox::listGet('notice_id', $ids);
2980 foreach ($gis as $id => $gi) {
2983 $gids[] = $g->group_id;
2987 $gids = array_unique($gids);
2988 $group = User_group::pivotGet('id', $gids);
2989 foreach ($notices as $notice)
2992 $gi = $gis[$notice->id];
2993 foreach ($gi as $g) {
2994 $grps[] = $group[$g->group_id];
2996 $notice->_setGroups($grps);
3000 static function _idsOf(array &$notices)
3003 foreach ($notices as $notice) {
3004 $ids[$notice->id] = true;
3006 return array_keys($ids);
3009 static function fillAttachments(&$notices)
3011 $ids = self::_idsOf($notices);
3012 $f2pMap = File_to_post::listGet('post_id', $ids);
3014 foreach ($f2pMap as $noticeId => $f2ps) {
3015 foreach ($f2ps as $f2p) {
3016 $fileIds[] = $f2p->file_id;
3020 $fileIds = array_unique($fileIds);
3021 $fileMap = File::pivotGet('id', $fileIds);
3022 foreach ($notices as $notice)
3025 $f2ps = $f2pMap[$notice->id];
3026 foreach ($f2ps as $f2p) {
3027 $files[] = $fileMap[$f2p->file_id];
3029 $notice->_setAttachments($files);
3033 static function fillReplies(&$notices)
3035 $ids = self::_idsOf($notices);
3036 $replyMap = Reply::listGet('notice_id', $ids);
3037 foreach ($notices as $notice) {
3038 $replies = $replyMap[$notice->id];
3040 foreach ($replies as $reply) {
3041 $ids[] = $reply->profile_id;
3043 $notice->_setReplies($ids);
3047 static public function beforeSchemaUpdate()
3049 $table = strtolower(get_called_class());
3050 $schema = Schema::get();
3051 $schemadef = $schema->getTableDef($table);
3053 // 2015-09-04 We move Notice location data to Notice_location
3054 // First we see if we have to do this at all
3055 if (!isset($schemadef['fields']['lat'])
3056 && !isset($schemadef['fields']['lon'])
3057 && !isset($schemadef['fields']['location_id'])
3058 && !isset($schemadef['fields']['location_ns'])) {
3059 // We have already removed the location fields, so no need to migrate.
3062 // Then we make sure the Notice_location table is created!
3063 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3065 // Then we continue on our road to migration!
3066 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)";
3068 $notice = new Notice();
3069 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3070 'WHERE lat IS NOT NULL ' .
3071 'OR lon IS NOT NULL ' .
3072 'OR location_id IS NOT NULL ' .
3073 'OR location_ns IS NOT NULL',
3074 $schema->quoteIdentifier($table)));
3075 print "\nFound {$notice->N} notices with location data, inserting";
3076 while ($notice->fetch()) {
3077 $notloc = Notice_location::getKV('notice_id', $notice->id);
3078 if ($notloc instanceof Notice_location) {
3082 $notloc = new Notice_location();
3083 $notloc->notice_id = $notice->id;
3084 $notloc->lat= $notice->lat;
3085 $notloc->lon= $notice->lon;
3086 $notloc->location_id= $notice->location_id;
3087 $notloc->location_ns= $notice->location_ns;