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' => 'id of root notice in this conversation'),
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 if (is_null($this->rendered) || $this->rendered === '') {
264 // update to include rendered content on-the-fly, so we don't have to have a fix-up script in upgrade.php
265 common_debug('Rendering notice '.$this->getID().' as it had no rendered HTML content.');
266 $orig = clone($this);
267 $this->rendered = common_render_content($this->getContent(),
269 $this->hasParent() ? $this->getParent() : null);
270 $this->update($orig);
272 return $this->rendered;
276 * Get the original representation URL of this notice.
278 * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
280 public function getUrl($fallback=false)
282 // The risk is we start having empty urls and non-http uris...
283 // and we can't really handle any other protocol right now.
285 case $this->isLocal():
286 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
287 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
289 case common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
292 // let's generate a valid link to our locally available notice on demand
293 return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
295 common_debug('No URL available for notice: id='.$this->getID());
296 throw new InvalidUrlException($this->url);
300 public function getObjectType($canonical=false) {
301 return ActivityUtils::resolveUri($this->object_type, $canonical);
304 public static function getByUri($uri)
306 $notice = new Notice();
308 if (!$notice->find(true)) {
309 throw new NoResultException($notice);
315 * Extract #hashtags from this notice's content and save them to the database.
319 /* extract all #hastags */
320 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
325 /* Add them to the database */
326 return $this->saveKnownTags($match[1]);
330 * Record the given set of hash tags in the db for this notice.
331 * Given tag strings will be normalized and checked for dupes.
333 function saveKnownTags($hashtags)
335 //turn each into their canonical tag
336 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
337 for($i=0; $i<count($hashtags); $i++) {
338 /* elide characters we don't want in the tag */
339 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
342 foreach(array_unique($hashtags) as $hashtag) {
343 $this->saveTag($hashtag);
344 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
350 * Record a single hash tag as associated with this notice.
351 * Tag format and uniqueness must be validated by caller.
353 function saveTag($hashtag)
355 $tag = new Notice_tag();
356 $tag->notice_id = $this->id;
357 $tag->tag = $hashtag;
358 $tag->created = $this->created;
359 $id = $tag->insert();
362 // TRANS: Server exception. %s are the error details.
363 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
364 $last_error->message));
368 // if it's saved, blow its cache
369 $tag->blowCache(false);
373 * Save a new notice and push it out to subscribers' inboxes.
374 * Poster's permissions are checked before sending.
376 * @param int $profile_id Profile ID of the poster
377 * @param string $content source message text; links may be shortened
378 * per current user's preference
379 * @param string $source source key ('web', 'api', etc)
380 * @param array $options Associative array of optional properties:
381 * string 'created' timestamp of notice; defaults to now
382 * int 'is_local' source/gateway ID, one of:
383 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
384 * Notice::REMOTE - Sent from a remote service;
385 * hide from public timeline but show in
386 * local "and friends" timelines
387 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
388 * Notice::GATEWAY - From another non-OStatus service;
389 * will not appear in public views
390 * float 'lat' decimal latitude for geolocation
391 * float 'lon' decimal longitude for geolocation
392 * int 'location_id' geoname identifier
393 * int 'location_ns' geoname namespace to interpret location_id
394 * int 'reply_to'; notice ID this is a reply to
395 * int 'repeat_of'; notice ID this is a repeat of
396 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
397 * string 'url' permalink to notice; defaults to local notice URL
398 * string 'rendered' rendered HTML version of content
399 * array 'replies' list of profile URIs for reply delivery in
400 * place of extracting @-replies from content.
401 * array 'groups' list of group IDs to deliver to, in place of
402 * extracting ! tags from content
403 * array 'tags' list of hashtag strings to save with the notice
404 * in place of extracting # tags from content
405 * array 'urls' list of attached/referred URLs to save with the
406 * notice in place of extracting links from content
407 * boolean 'distribute' whether to distribute the notice, default true
408 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
409 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
410 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
412 * @fixme tag override
415 * @throws ClientException
417 static function saveNew($profile_id, $content, $source, array $options=null) {
418 $defaults = array('uri' => null,
420 'conversation' => null, // URI of conversation
421 'reply_to' => null, // This will override convo URI if the parent is known
422 'repeat_of' => null, // This will override convo URI if the repeated notice is known
424 'distribute' => true,
425 'object_type' => null,
428 if (!empty($options) && is_array($options)) {
429 $options = array_merge($defaults, $options);
435 if (!isset($is_local)) {
436 $is_local = Notice::LOCAL_PUBLIC;
439 $profile = Profile::getKV('id', $profile_id);
440 if (!$profile instanceof Profile) {
441 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
442 throw new ClientException(_('Problem saving notice. Unknown user.'));
445 $user = User::getKV('id', $profile_id);
446 if ($user instanceof User) {
447 // Use the local user's shortening preferences, if applicable.
448 $final = $user->shortenLinks($content);
450 $final = common_shorten_links($content);
453 if (Notice::contentTooLong($final)) {
454 // TRANS: Client exception thrown if a notice contains too many characters.
455 throw new ClientException(_('Problem saving notice. Too long.'));
458 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
459 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
460 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
461 throw new ClientException(_('Too many notices too fast; take a breather '.
462 'and post again in a few minutes.'));
465 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
466 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
467 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
468 throw new ClientException(_('Too many duplicate messages too quickly;'.
469 ' take a breather and post again in a few minutes.'));
472 if (!$profile->hasRight(Right::NEWNOTICE)) {
473 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
475 // TRANS: Client exception thrown when a user tries to post while being banned.
476 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
479 $notice = new Notice();
480 $notice->profile_id = $profile_id;
482 $autosource = common_config('public', 'autosource');
484 // Sandboxed are non-false, but not 1, either
486 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
487 ($source && $autosource && in_array($source, $autosource))) {
488 $notice->is_local = Notice::LOCAL_NONPUBLIC;
490 $notice->is_local = $is_local;
493 if (!empty($created)) {
494 $notice->created = $created;
496 $notice->created = common_sql_now();
499 if (!$notice->isLocal()) {
500 // Only do these checks for non-local notices. Local notices will generate these values later.
501 if (!common_valid_http_url($url)) {
502 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
505 throw new ServerException('No URI for remote notice. Cannot accept that.');
509 $notice->content = $final;
511 $notice->source = $source;
515 // Get the groups here so we can figure out replies and such
516 if (!isset($groups)) {
517 $groups = User_group::idsFromText($notice->content, $profile);
522 // Handle repeat case
524 if (!empty($options['repeat_of'])) {
526 // Check for a private one
528 $repeat = Notice::getByID($options['repeat_of']);
530 if ($profile->sameAs($repeat->getProfile())) {
531 // TRANS: Client error displayed when trying to repeat an own notice.
532 throw new ClientException(_('You cannot repeat your own notice.'));
535 if ($repeat->scope != Notice::SITE_SCOPE &&
536 $repeat->scope != Notice::PUBLIC_SCOPE) {
537 // TRANS: Client error displayed when trying to repeat a non-public notice.
538 throw new ClientException(_('Cannot repeat a private notice.'), 403);
541 if (!$repeat->inScope($profile)) {
542 // The generic checks above should cover this, but let's be sure!
543 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
544 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
547 if ($profile->hasRepeated($repeat)) {
548 // TRANS: Client error displayed when trying to repeat an already repeated notice.
549 throw new ClientException(_('You already repeated that notice.'));
552 $notice->repeat_of = $repeat->id;
553 $notice->conversation = $repeat->conversation;
557 // If $reply_to is specified, we check that it exists, and then
558 // return it if it does
559 if (!empty($reply_to)) {
560 $reply = Notice::getKV('id', $reply_to);
561 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
562 // If the source lacks capability of sending the "reply_to"
563 // metadata, let's try to find an inline replyto-reference.
564 $reply = self::getInlineReplyTo($profile, $final);
567 if ($reply instanceof Notice) {
568 if (!$reply->inScope($profile)) {
569 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
570 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
571 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
572 $profile->nickname, $reply->id), 403);
575 // If it's a repeat, the reply_to should be to the original
576 if ($reply->isRepeat()) {
577 $notice->reply_to = $reply->repeat_of;
579 $notice->reply_to = $reply->id;
581 // But the conversation ought to be the same :)
582 $notice->conversation = $reply->conversation;
584 // If the original is private to a group, and notice has
585 // no group specified, make it to the same group(s)
587 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
589 $replyGroups = $reply->getGroups();
590 foreach ($replyGroups as $group) {
591 if ($profile->isMember($group)) {
592 $groups[] = $group->id;
600 // If we don't know the reply, we might know the conversation!
601 // This will happen if a known remote user replies to an
602 // unknown remote user - within a known conversation.
603 if (empty($notice->conversation) and !empty($options['conversation'])) {
604 $conv = Conversation::getKV('uri', $options['conversation']);
605 if ($conv instanceof Conversation) {
606 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.').');
608 // Conversation entry with specified URI was not found, so we must create it.
609 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
610 // The insert in Conversation::create throws exception on failure
611 $conv = Conversation::create($options['conversation'], $notice->created);
613 $notice->conversation = $conv->getID();
618 // If it's not part of a conversation, it's the beginning of a new conversation.
619 if (empty($notice->conversation)) {
620 $conv = Conversation::create();
621 $notice->conversation = $conv->getID();
626 $notloc = new Notice_location();
627 if (!empty($lat) && !empty($lon)) {
632 if (!empty($location_ns) && !empty($location_id)) {
633 $notloc->location_id = $location_id;
634 $notloc->location_ns = $location_ns;
637 if (!empty($rendered)) {
638 $notice->rendered = $rendered;
640 $notice->rendered = common_render_content($final,
641 $notice->getProfile(),
642 $notice->hasParent() ? $notice->getParent() : null);
646 if ($notice->isRepeat()) {
647 $notice->verb = ActivityVerb::SHARE;
648 $notice->object_type = ActivityObject::ACTIVITY;
650 $notice->verb = ActivityVerb::POST;
653 $notice->verb = $verb;
656 if (empty($object_type)) {
657 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
659 $notice->object_type = $object_type;
662 if (is_null($scope) && $reply instanceof Notice) {
663 $notice->scope = $reply->scope;
665 $notice->scope = $scope;
668 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
670 if (Event::handle('StartNoticeSave', array(&$notice))) {
672 // XXX: some of these functions write to the DB
675 $notice->insert(); // throws exception on failure, if successful we have an ->id
677 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
678 $notloc->notice_id = $notice->getID();
679 $notloc->insert(); // store the notice location if it had any information
681 } catch (Exception $e) {
682 // Let's test if we managed initial insert, which would imply
683 // failing on some update-part (check 'insert()'). Delete if
684 // something had been stored to the database.
685 if (!empty($notice->id)) {
692 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
693 // the activityverb is a POST (since stuff like repeat, favorite etc.
694 // reasonably handle notifications themselves.
695 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
696 if (isset($replies)) {
697 $notice->saveKnownReplies($replies);
699 $notice->saveReplies();
703 $notice->saveKnownTags($tags);
708 // Note: groups may save tags, so must be run after tags are saved
709 // to avoid errors on duplicates.
710 // Note: groups should always be set.
712 $notice->saveKnownGroups($groups);
715 $notice->saveKnownUrls($urls);
722 // Prepare inbox delivery, may be queued to background.
723 $notice->distribute();
729 static function saveActivity(Activity $act, Profile $actor, array $options=array())
731 // First check if we're going to let this Activity through from the specific actor
732 if (!$actor->hasRight(Right::NEWNOTICE)) {
733 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
735 // TRANS: Client exception thrown when a user tries to post while being banned.
736 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
738 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
739 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
740 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
741 throw new ClientException(_m('Too many notices too fast; take a breather '.
742 'and post again in a few minutes.'));
745 // Get ActivityObject properties
747 if (!empty($act->id)) {
749 $options['uri'] = $act->id;
750 $options['url'] = $act->link;
752 $actobj = count($act->objects)==1 ? $act->objects[0] : null;
753 if (!is_null($actobj) && !empty($actobj->id)) {
754 $options['uri'] = $actobj->id;
756 $options['url'] = $actobj->link;
757 } elseif (preg_match('!^https?://!', $actobj->id)) {
758 $options['url'] = $actobj->id;
765 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
766 'mentions' => array(),
770 'source' => 'unknown',
775 'distribute' => true);
777 // options will have default values when nothing has been supplied
778 $options = array_merge($defaults, $options);
779 foreach (array_keys($defaults) as $key) {
780 // Only convert the keynames we specify ourselves from 'defaults' array into variables
781 $$key = $options[$key];
783 extract($options, EXTR_SKIP);
786 $stored = new Notice();
787 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
789 if ($stored->find()) {
790 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
791 // I _assume_ saving a Notice with a colliding URI means we're really trying to
792 // save the same notice again...
793 throw new AlreadyFulfilledException('Notice URI already exists');
797 $autosource = common_config('public', 'autosource');
799 // Sandboxed are non-false, but not 1, either
800 if (!$actor->hasRight(Right::PUBLICNOTICE) ||
801 ($source && $autosource && in_array($source, $autosource))) {
802 // FIXME: ...what about remote nonpublic? Hmmm. That is, if we sandbox remote profiles...
803 $stored->is_local = Notice::LOCAL_NONPUBLIC;
805 $stored->is_local = intval($is_local);
808 if (!$stored->isLocal()) {
809 // Only do these checks for non-local notices. Local notices will generate these values later.
810 if (!common_valid_http_url($url)) {
811 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
814 throw new ServerException('No URI for remote notice. Cannot accept that.');
818 $stored->profile_id = $actor->id;
819 $stored->source = $source;
822 $stored->verb = $act->verb;
824 // Notice content. We trust local users to provide HTML we like, but of course not remote users.
825 // FIXME: What about local users importing feeds? Mirror functions must filter out bad HTML first...
826 $content = $act->content ?: $act->summary;
827 if (is_null($content) && !is_null($actobj)) {
828 $content = $actobj->content ?: $actobj->summary;
830 $stored->rendered = $actor->isLocal() ? $content : common_purify($content);
831 // yeah, just don't use getRendered() here since it's not inserted yet ;)
832 $stored->content = common_strip_html($stored->rendered);
834 // Maybe a missing act-time should be fatal if the actor is not local?
835 if (!empty($act->time)) {
836 $stored->created = common_sql_date($act->time);
838 $stored->created = common_sql_now();
842 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
843 $reply = self::getKV('uri', $act->context->replyToID);
845 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
846 $reply = self::getKV('uri', $act->target->id);
849 if ($reply instanceof Notice) {
850 if (!$reply->inScope($actor)) {
851 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
852 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
853 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
856 $stored->reply_to = $reply->id;
857 $stored->conversation = $reply->conversation;
859 // If the original is private to a group, and notice has no group specified,
860 // make it to the same group(s)
861 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
862 $replyGroups = $reply->getGroups();
863 foreach ($replyGroups as $group) {
864 if ($actor->isMember($group)) {
865 $groups[] = $group->id;
870 if (is_null($scope)) {
871 $scope = $reply->scope;
874 // If we don't know the reply, we might know the conversation!
875 // This will happen if a known remote user replies to an
876 // unknown remote user - within a known conversation.
877 if (empty($stored->conversation) and !empty($act->context->conversation)) {
878 $conv = Conversation::getKV('uri', $act->context->conversation);
879 if ($conv instanceof Conversation) {
880 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.').');
882 // Conversation entry with specified URI was not found, so we must create it.
883 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
884 // The insert in Conversation::create throws exception on failure
885 $conv = Conversation::create($act->context->conversation, $stored->created);
887 $stored->conversation = $conv->getID();
892 // If it's not part of a conversation, it's the beginning of a new conversation.
893 if (empty($stored->conversation)) {
894 $conv = Conversation::create();
895 $stored->conversation = $conv->getID();
900 if ($act->context instanceof ActivityContext) {
901 if ($act->context->location instanceof Location) {
902 $notloc = Notice_location::fromLocation($act->context->location);
905 $act->context = new ActivityContext();
908 $stored->scope = self::figureOutScope($actor, $groups, $scope);
910 foreach ($act->categories as $cat) {
912 $term = common_canonical_tag($cat->term);
919 foreach ($act->enclosures as $href) {
920 // @todo FIXME: Save these locally or....?
924 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
925 if (empty($act->objects[0]->type)) {
926 // Default type for the post verb is 'note', but we know it's
927 // a 'comment' if it is in reply to something.
928 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
930 //TODO: Is it safe to always return a relative URI? The
931 // JSON version of ActivityStreams always use it, so we
932 // should definitely be able to handle it...
933 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
937 if (Event::handle('StartNoticeSave', array(&$stored))) {
938 // XXX: some of these functions write to the DB
941 $result = $stored->insert(); // throws exception on error
943 if ($notloc instanceof Notice_location) {
944 $notloc->notice_id = $stored->getID();
948 $orig = clone($stored); // for updating later in this try clause
951 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
952 if (empty($object)) {
953 throw new ServerException('Unsuccessful call to StoreActivityObject '.$stored->getUri() . ': '.$act->asString());
956 // If something changed in the Notice during StoreActivityObject
957 $stored->update($orig);
958 } catch (Exception $e) {
959 if (empty($stored->id)) {
960 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
962 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
968 if (!$stored instanceof Notice) {
969 throw new ServerException('StartNoticeSave did not give back a Notice');
972 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
973 // the activityverb is a POST (since stuff like repeat, favorite etc.
974 // reasonably handle notifications themselves.
975 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
978 $stored->saveKnownTags($tags);
983 // Note: groups may save tags, so must be run after tags are saved
984 // to avoid errors on duplicates.
985 $stored->saveAttentions($act->context->attention);
988 $stored->saveKnownUrls($urls);
995 // Prepare inbox delivery, may be queued to background.
996 $stored->distribute();
1002 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1003 $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1005 // For private streams
1007 $user = $actor->getUser();
1008 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1009 if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1010 $scope |= Notice::FOLLOWER_SCOPE;
1012 } catch (NoSuchUserException $e) {
1013 // TODO: Not a local user, so we don't know about scope preferences... yet!
1016 // Force the scope for private groups
1017 foreach ($groups as $group_id) {
1019 $group = User_group::getByID($group_id);
1020 if ($group->force_scope) {
1021 $scope |= Notice::GROUP_SCOPE;
1024 } catch (Exception $e) {
1025 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1032 function blowOnInsert($conversation = false)
1034 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1036 if ($this->isPublic()) {
1037 $this->blowStream('public');
1038 $this->blowStream('networkpublic');
1041 if ($this->conversation) {
1042 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1043 self::blow('conversation:notice_count:%d', $this->conversation);
1046 if ($this->isRepeat()) {
1047 // XXX: we should probably only use one of these
1048 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1049 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1052 $original = Notice::getKV('id', $this->repeat_of);
1054 if ($original instanceof Notice) {
1055 $originalUser = User::getKV('id', $original->profile_id);
1056 if ($originalUser instanceof User) {
1057 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1061 $profile = Profile::getKV($this->profile_id);
1063 if ($profile instanceof Profile) {
1064 $profile->blowNoticeCount();
1067 $ptags = $this->getProfileTags();
1068 foreach ($ptags as $ptag) {
1069 $ptag->blowNoticeStreamCache();
1074 * Clear cache entries related to this notice at delete time.
1075 * Necessary to avoid breaking paging on public, profile timelines.
1077 function blowOnDelete()
1079 $this->blowOnInsert();
1081 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1083 if ($this->isPublic()) {
1084 self::blow('public;last');
1085 self::blow('networkpublic;last');
1088 self::blow('fave:by_notice', $this->id);
1090 if ($this->conversation) {
1091 // In case we're the first, will need to calc a new root.
1092 self::blow('notice:conversation_root:%d', $this->conversation);
1095 $ptags = $this->getProfileTags();
1096 foreach ($ptags as $ptag) {
1097 $ptag->blowNoticeStreamCache(true);
1101 function blowStream()
1103 $c = self::memcache();
1109 $args = func_get_args();
1110 $format = array_shift($args);
1111 $keyPart = vsprintf($format, $args);
1112 $cacheKey = Cache::key($keyPart);
1113 $c->delete($cacheKey);
1115 // delete the "last" stream, too, if this notice is
1116 // older than the top of that stream
1118 $lastKey = $cacheKey.';last';
1120 $lastStr = $c->get($lastKey);
1122 if ($lastStr !== false) {
1123 $window = explode(',', $lastStr);
1124 $lastID = $window[0];
1125 $lastNotice = Notice::getKV('id', $lastID);
1126 if (!$lastNotice instanceof Notice // just weird
1127 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1128 $c->delete($lastKey);
1133 /** save all urls in the notice to the db
1135 * follow redirects and save all available file information
1136 * (mimetype, date, size, oembed, etc.)
1140 function saveUrls() {
1141 if (common_config('attachments', 'process_links')) {
1142 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1147 * Save the given URLs as related links/attachments to the db
1149 * follow redirects and save all available file information
1150 * (mimetype, date, size, oembed, etc.)
1154 function saveKnownUrls($urls)
1156 if (common_config('attachments', 'process_links')) {
1157 // @fixme validation?
1158 foreach (array_unique($urls) as $url) {
1159 $this->saveUrl($url, $this);
1167 function saveUrl($url, Notice $notice) {
1169 File::processNew($url, $notice);
1170 } catch (ServerException $e) {
1171 // Could not save URL. Log it?
1175 static function checkDupes($profile_id, $content) {
1176 $profile = Profile::getKV($profile_id);
1177 if (!$profile instanceof Profile) {
1180 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1181 if (!empty($notice)) {
1183 while ($notice->fetch()) {
1184 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1186 } else if ($notice->content == $content) {
1191 // If we get here, oldest item in cache window is not
1192 // old enough for dupe limit; do direct check against DB
1193 $notice = new Notice();
1194 $notice->profile_id = $profile_id;
1195 $notice->content = $content;
1196 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1197 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1199 $cnt = $notice->count();
1203 static function checkEditThrottle($profile_id) {
1204 $profile = Profile::getKV($profile_id);
1205 if (!$profile instanceof Profile) {
1208 // Get the Nth notice
1209 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1210 if ($notice && $notice->fetch()) {
1211 // If the Nth notice was posted less than timespan seconds ago
1212 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1217 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1221 protected $_attachments = array();
1223 function attachments() {
1224 if (isset($this->_attachments[$this->id])) {
1225 return $this->_attachments[$this->id];
1228 $f2ps = File_to_post::listGet('post_id', array($this->id));
1230 foreach ($f2ps[$this->id] as $f2p) {
1231 $ids[] = $f2p->file_id;
1234 $files = File::multiGet('id', $ids);
1235 $this->_attachments[$this->id] = $files->fetchAll();
1236 return $this->_attachments[$this->id];
1239 function _setAttachments($attachments)
1241 $this->_attachments[$this->id] = $attachments;
1244 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1246 $stream = new PublicNoticeStream();
1247 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1250 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null)
1252 $stream = new ConversationNoticeStream($id);
1253 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1257 * Is this notice part of an active conversation?
1259 * @return boolean true if other messages exist in the same
1260 * conversation, false if this is the only one
1262 function hasConversation()
1264 if (empty($this->conversation)) {
1265 // this notice is not part of a conversation apparently
1266 // FIXME: all notices should have a conversation value, right?
1270 $stream = new ConversationNoticeStream($this->conversation);
1271 $notice = $stream->getNotices(/*offset*/ 1, /*limit*/ 1);
1273 // if our "offset 1, limit 1" query got a result, return true else false
1274 return $notice->N > 0;
1278 * Grab the earliest notice from this conversation.
1280 * @return Notice or null
1282 function conversationRoot($profile=-1)
1284 // XXX: can this happen?
1286 if (empty($this->conversation)) {
1290 // Get the current profile if not specified
1292 if (is_int($profile) && $profile == -1) {
1293 $profile = Profile::current();
1296 // If this notice is out of scope, no root for you!
1298 if (!$this->inScope($profile)) {
1302 // If this isn't a reply to anything, then it's its own
1303 // root if it's the earliest notice in the conversation:
1305 if (empty($this->reply_to)) {
1307 $root->conversation = $this->conversation;
1308 $root->orderBy('notice.created ASC');
1309 $root->find(true); // true means "fetch first result"
1314 if (is_null($profile)) {
1315 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1317 $keypart = sprintf('notice:conversation_root:%d:%d',
1322 $root = self::cacheGet($keypart);
1324 if ($root !== false && $root->inScope($profile)) {
1331 $parent = $last->getParent();
1332 if ($parent->inScope($profile)) {
1336 } catch (NoParentNoticeException $e) {
1337 // Latest notice has no parent
1338 } catch (NoResultException $e) {
1339 // Notice was not found, so we can't go further up in the tree.
1340 // FIXME: Maybe we should do this in a more stable way where deleted
1341 // notices won't break conversation chains?
1343 // No parent, or parent out of scope
1348 self::cacheSet($keypart, $root);
1354 * Pull up a full list of local recipients who will be getting
1355 * this notice in their inbox. Results will be cached, so don't
1356 * change the input data wily-nilly!
1358 * @param array $groups optional list of Group objects;
1359 * if left empty, will be loaded from group_inbox records
1360 * @param array $recipient optional list of reply profile ids
1361 * if left empty, will be loaded from reply records
1362 * @return array associating recipient user IDs with an inbox source constant
1364 function whoGets(array $groups=null, array $recipients=null)
1366 $c = self::memcache();
1369 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1370 if ($ni !== false) {
1375 if (is_null($recipients)) {
1376 $recipients = $this->getReplies();
1381 // Give plugins a chance to add folks in at start...
1382 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1384 $users = $this->getSubscribedUsers();
1385 foreach ($users as $id) {
1386 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1389 if (is_null($groups)) {
1390 $groups = $this->getGroups();
1392 foreach ($groups as $group) {
1393 $users = $group->getUserMembers();
1394 foreach ($users as $id) {
1395 if (!array_key_exists($id, $ni)) {
1396 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1401 $ptAtts = $this->getAttentionsFromProfileTags();
1402 foreach ($ptAtts as $key=>$val) {
1403 if (!array_key_exists($key, $ni)) {
1408 foreach ($recipients as $recipient) {
1409 if (!array_key_exists($recipient, $ni)) {
1410 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1414 // Exclude any deleted, non-local, or blocking recipients.
1415 $profile = $this->getProfile();
1416 $originalProfile = null;
1417 if ($this->isRepeat()) {
1418 // Check blocks against the original notice's poster as well.
1419 $original = Notice::getKV('id', $this->repeat_of);
1420 if ($original instanceof Notice) {
1421 $originalProfile = $original->getProfile();
1425 foreach ($ni as $id => $source) {
1427 $user = User::getKV('id', $id);
1428 if (!$user instanceof User ||
1429 $user->hasBlocked($profile) ||
1430 ($originalProfile && $user->hasBlocked($originalProfile))) {
1433 } catch (UserNoProfileException $e) {
1434 // User doesn't have a profile; invalid; skip them.
1439 // Give plugins a chance to filter out...
1440 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1444 // XXX: pack this data better
1445 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1451 function getSubscribedUsers()
1455 if(common_config('db','quote_identifiers'))
1456 $user_table = '"user"';
1457 else $user_table = 'user';
1461 'FROM '. $user_table .' JOIN subscription '.
1462 'ON '. $user_table .'.id = subscription.subscriber ' .
1463 'WHERE subscription.subscribed = %d ';
1465 $user->query(sprintf($qry, $this->profile_id));
1469 while ($user->fetch()) {
1478 function getProfileTags()
1480 $profile = $this->getProfile();
1481 $list = $profile->getOtherTags($profile);
1484 while($list->fetch()) {
1485 $ptags[] = clone($list);
1491 public function getAttentionsFromProfileTags()
1494 $ptags = $this->getProfileTags();
1495 foreach ($ptags as $ptag) {
1496 $users = $ptag->getUserSubscribers();
1497 foreach ($users as $id) {
1498 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1505 * Record this notice to the given group inboxes for delivery.
1506 * Overrides the regular parsing of !group markup.
1508 * @param string $group_ids
1509 * @fixme might prefer URIs as identifiers, as for replies?
1510 * best with generalizations on user_group to support
1511 * remote groups better.
1513 function saveKnownGroups(array $group_ids)
1516 foreach (array_unique($group_ids) as $id) {
1517 $group = User_group::getKV('id', $id);
1518 if ($group instanceof User_group) {
1519 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1520 $result = $this->addToGroupInbox($group);
1522 common_log_db_error($gi, 'INSERT', __FILE__);
1525 if (common_config('group', 'addtag')) {
1526 // we automatically add a tag for every group name, too
1528 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1529 'notice_id' => $this->id));
1531 if (is_null($tag)) {
1532 $this->saveTag($group->nickname);
1536 $groups[] = clone($group);
1538 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1545 function addToGroupInbox(User_group $group)
1547 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1548 'notice_id' => $this->id));
1550 if (!$gi instanceof Group_inbox) {
1552 $gi = new Group_inbox();
1554 $gi->group_id = $group->id;
1555 $gi->notice_id = $this->id;
1556 $gi->created = $this->created;
1558 $result = $gi->insert();
1561 common_log_db_error($gi, 'INSERT', __FILE__);
1562 // TRANS: Server exception thrown when an update for a group inbox fails.
1563 throw new ServerException(_('Problem saving group inbox.'));
1566 self::blow('user_group:notice_ids:%d', $gi->group_id);
1572 function saveAttentions(array $uris)
1574 foreach ($uris as $uri=>$type) {
1576 $target = Profile::fromUri($uri);
1577 } catch (UnknownUriException $e) {
1578 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1583 $this->saveAttention($target);
1584 } catch (AlreadyFulfilledException $e) {
1585 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1586 } catch (Exception $e) {
1587 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1593 * Saves an attention for a profile (user or group) which means
1594 * it shows up in their home feed and such.
1596 function saveAttention(Profile $target, $reason=null)
1598 if ($target->isGroup()) {
1599 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1601 // legacy notification method, will still be in use for quite a while I think
1602 $this->addToGroupInbox($target->getGroup());
1604 if ($target->hasBlocked($this->getProfile())) {
1605 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1610 if ($target->isLocal()) {
1611 // legacy notification method, will still be in use for quite a while I think
1612 $this->saveReply($target->getID());
1615 $att = Attention::saveNew($this, $target, $reason);
1617 self::blow('reply:stream:%d', $target->getID());
1622 * Save reply records indicating that this notice needs to be
1623 * delivered to the local users with the given URIs.
1625 * Since this is expected to be used when saving foreign-sourced
1626 * messages, we won't deliver to any remote targets as that's the
1627 * source service's responsibility.
1629 * Mail notifications etc will be handled later.
1631 * @param array $uris Array of unique identifier URIs for recipients
1633 function saveKnownReplies(array $uris)
1639 $sender = $this->getProfile();
1641 foreach (array_unique($uris) as $uri) {
1643 $profile = Profile::fromUri($uri);
1644 } catch (UnknownUriException $e) {
1645 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1649 if ($profile->hasBlocked($sender)) {
1650 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1654 $this->saveReply($profile->getID());
1655 self::blow('reply:stream:%d', $profile->getID());
1660 * Pull @-replies from this message's content in StatusNet markup format
1661 * and save reply records indicating that this message needs to be
1662 * delivered to those users.
1664 * Mail notifications to local profiles will be sent later.
1666 * @return array of integer profile IDs
1669 function saveReplies()
1671 $sender = $this->getProfile();
1675 // If it's a reply, save for the replied-to author
1677 $parent = $this->getParent();
1678 $parentauthor = $parent->getProfile();
1679 $this->saveReply($parentauthor->getID());
1680 $replied[$parentauthor->getID()] = 1;
1681 self::blow('reply:stream:%d', $parentauthor->getID());
1682 } catch (NoParentNoticeException $e) {
1683 // Not a reply, since it has no parent!
1685 } catch (NoResultException $e) {
1686 // Parent notice was probably deleted
1690 // @todo ideally this parser information would only
1691 // be calculated once.
1693 $mentions = common_find_mentions($this->content, $sender, $parent);
1695 foreach ($mentions as $mention) {
1697 foreach ($mention['mentioned'] as $mentioned) {
1699 // skip if they're already covered
1700 if (array_key_exists($mentioned->id, $replied)) {
1704 // Don't save replies from blocked profile to local user
1705 if ($mentioned->hasBlocked($sender)) {
1709 $this->saveReply($mentioned->id);
1710 $replied[$mentioned->id] = 1;
1711 self::blow('reply:stream:%d', $mentioned->id);
1715 $recipientIds = array_keys($replied);
1717 return $recipientIds;
1720 function saveReply($profileId)
1722 $reply = new Reply();
1724 $reply->notice_id = $this->id;
1725 $reply->profile_id = $profileId;
1726 $reply->modified = $this->created;
1733 protected $_attentionids = array();
1736 * Pull the complete list of known activity context attentions for this notice.
1738 * @return array of integer profile ids (also group profiles)
1740 function getAttentionProfileIDs()
1742 if (!isset($this->_attentionids[$this->getID()])) {
1743 $atts = Attention::multiGet('notice_id', array($this->getID()));
1744 // (array)null means empty array
1745 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1747 return $this->_attentionids[$this->getID()];
1750 protected $_replies = array();
1753 * Pull the complete list of @-mentioned profile IDs for this notice.
1755 * @return array of integer profile ids
1757 function getReplies()
1759 if (!isset($this->_replies[$this->getID()])) {
1760 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1761 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1763 return $this->_replies[$this->getID()];
1766 function _setReplies($replies)
1768 $this->_replies[$this->getID()] = $replies;
1772 * Pull the complete list of @-reply targets for this notice.
1774 * @return array of Profiles
1776 function getAttentionProfiles()
1778 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1780 $profiles = Profile::multiGet('id', (array)$ids);
1782 return $profiles->fetchAll();
1786 * Send e-mail notifications to local @-reply targets.
1788 * Replies must already have been saved; this is expected to be run
1789 * from the distrib queue handler.
1791 function sendReplyNotifications()
1793 // Don't send reply notifications for repeats
1794 if ($this->isRepeat()) {
1798 $recipientIds = $this->getReplies();
1799 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1800 require_once INSTALLDIR.'/lib/mail.php';
1802 foreach ($recipientIds as $recipientId) {
1804 $user = User::getByID($recipientId);
1805 mail_notify_attn($user, $this);
1806 } catch (NoResultException $e) {
1810 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1815 * Pull list of Profile IDs of groups this notice addresses.
1817 * @return array of Group _profile_ IDs
1820 function getGroupProfileIDs()
1824 foreach ($this->getGroups() as $group) {
1825 $ids[] = $group->profile_id;
1832 * Pull list of groups this notice needs to be delivered to,
1833 * as previously recorded by saveKnownGroups().
1835 * @return array of Group objects
1838 protected $_groups = array();
1840 function getGroups()
1842 // Don't save groups for repeats
1844 if (!empty($this->repeat_of)) {
1848 if (isset($this->_groups[$this->id])) {
1849 return $this->_groups[$this->id];
1852 $gis = Group_inbox::listGet('notice_id', array($this->id));
1856 foreach ($gis[$this->id] as $gi) {
1857 $ids[] = $gi->group_id;
1860 $groups = User_group::multiGet('id', $ids);
1861 $this->_groups[$this->id] = $groups->fetchAll();
1862 return $this->_groups[$this->id];
1865 function _setGroups($groups)
1867 $this->_groups[$this->id] = $groups;
1871 * Convert a notice into an activity for export.
1873 * @param Profile $scoped The currently logged in/scoped profile
1875 * @return Activity activity object representing this Notice.
1878 function asActivity(Profile $scoped=null)
1880 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1882 if ($act instanceof Activity) {
1885 $act = new Activity();
1887 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1889 $act->id = $this->uri;
1890 $act->time = strtotime($this->created);
1892 $act->link = $this->getUrl();
1893 } catch (InvalidUrlException $e) {
1894 // The notice is probably a share or similar, which don't
1895 // have a representational URL of their own.
1897 $act->content = common_xml_safe_str($this->getRendered());
1899 $profile = $this->getProfile();
1901 $act->actor = $profile->asActivityObject();
1902 $act->actor->extra[] = $profile->profileInfo($scoped);
1904 $act->verb = $this->verb;
1906 if (!$this->repeat_of) {
1907 $act->objects[] = $this->asActivityObject();
1910 // XXX: should this be handled by default processing for object entry?
1914 $tags = $this->getTags();
1916 foreach ($tags as $tag) {
1917 $cat = new AtomCategory();
1920 $act->categories[] = $cat;
1924 // XXX: use Atom Media and/or File activity objects instead
1926 $attachments = $this->attachments();
1928 foreach ($attachments as $attachment) {
1929 // Include local attachments in Activity
1930 if (!empty($attachment->filename)) {
1931 $act->enclosures[] = $attachment->getEnclosure();
1935 $ctx = new ActivityContext();
1938 $reply = $this->getParent();
1939 $ctx->replyToID = $reply->getUri();
1940 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1941 } catch (NoParentNoticeException $e) {
1942 // This is not a reply to something
1943 } catch (NoResultException $e) {
1944 // Parent notice was probably deleted
1948 $ctx->location = Notice_location::locFromStored($this);
1949 } catch (ServerException $e) {
1950 $ctx->location = null;
1955 if (!empty($this->conversation)) {
1956 $conv = Conversation::getKV('id', $this->conversation);
1957 if ($conv instanceof Conversation) {
1958 $ctx->conversation = $conv->uri;
1962 // This covers the legacy getReplies and getGroups too which get their data
1963 // from entries stored via Notice::saveNew (which we want to move away from)...
1964 foreach ($this->getAttentionProfiles() as $target) {
1965 // User and group profiles which get the attention of this notice
1966 $ctx->attention[$target->getUri()] = $target->getObjectType();
1969 switch ($this->scope) {
1970 case Notice::PUBLIC_SCOPE:
1971 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1973 case Notice::FOLLOWER_SCOPE:
1974 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1975 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1979 $act->context = $ctx;
1981 $source = $this->getSource();
1983 if ($source instanceof Notice_source) {
1984 $act->generator = ActivityObject::fromNoticeSource($source);
1989 $atom_feed = $profile->getAtomFeed();
1991 if (!empty($atom_feed)) {
1993 $act->source = new ActivitySource();
1995 // XXX: we should store the actual feed ID
1997 $act->source->id = $atom_feed;
1999 // XXX: we should store the actual feed title
2001 $act->source->title = $profile->getBestName();
2003 $act->source->links['alternate'] = $profile->profileurl;
2004 $act->source->links['self'] = $atom_feed;
2006 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2008 $notice = $profile->getCurrentNotice();
2010 if ($notice instanceof Notice) {
2011 $act->source->updated = self::utcDate($notice->created);
2014 $user = User::getKV('id', $profile->id);
2016 if ($user instanceof User) {
2017 $act->source->links['license'] = common_config('license', 'url');
2021 if ($this->isLocal()) {
2022 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2023 'format' => 'atom'));
2024 $act->editLink = $act->selfLink;
2027 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2030 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2035 // This has gotten way too long. Needs to be sliced up into functional bits
2036 // or ideally exported to a utility class.
2038 function asAtomEntry($namespace=false,
2041 Profile $scoped=null)
2043 $act = $this->asActivity($scoped);
2044 $act->extra[] = $this->noticeInfo($scoped);
2045 return $act->asString($namespace, $author, $source);
2049 * Extra notice info for atom entries
2051 * Clients use some extra notice info in the atom stream.
2052 * This gives it to them.
2054 * @param Profile $scoped The currently logged in/scoped profile
2056 * @return array representation of <statusnet:notice_info> element
2059 function noticeInfo(Profile $scoped=null)
2061 // local notice ID (useful to clients for ordering)
2063 $noticeInfoAttr = array('local_id' => $this->id);
2067 $ns = $this->getSource();
2069 if ($ns instanceof Notice_source) {
2070 $noticeInfoAttr['source'] = $ns->code;
2071 if (!empty($ns->url)) {
2072 $noticeInfoAttr['source_link'] = $ns->url;
2073 if (!empty($ns->name)) {
2074 $noticeInfoAttr['source'] = '<a href="'
2075 . htmlspecialchars($ns->url)
2076 . '" rel="nofollow">'
2077 . htmlspecialchars($ns->name)
2083 // favorite and repeated
2085 if ($scoped instanceof Profile) {
2086 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2089 if (!empty($this->repeat_of)) {
2090 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2093 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2095 return array('statusnet:notice_info', $noticeInfoAttr, null);
2099 * Returns an XML string fragment with a reference to a notice as an
2100 * Activity Streams noun object with the given element type.
2102 * Assumes that 'activity' namespace has been previously defined.
2104 * @param string $element one of 'subject', 'object', 'target'
2108 function asActivityNoun($element)
2110 $noun = $this->asActivityObject();
2111 return $noun->asString('activity:' . $element);
2114 public function asActivityObject()
2116 $object = new ActivityObject();
2118 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2119 $object->type = $this->object_type ?: ActivityObject::NOTE;
2120 $object->id = $this->getUri();
2121 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2122 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2123 $object->content = $this->getRendered();
2124 $object->link = $this->getUrl();
2126 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2128 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2131 if (!$object instanceof ActivityObject) {
2132 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2133 throw new ServerException('Notice asActivityObject created something else.');
2140 * Determine which notice, if any, a new notice is in reply to.
2142 * For conversation tracking, we try to see where this notice fits
2143 * in the tree. Beware that this may very well give false positives
2144 * and add replies to wrong threads (if there have been newer posts
2145 * by the same user as we're replying to).
2147 * @param Profile $sender Author profile
2148 * @param string $content Final notice content
2150 * @return integer ID of replied-to notice, or null for not a reply.
2153 static function getInlineReplyTo(Profile $sender, $content)
2155 // Is there an initial @ or T?
2156 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2157 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2158 $nickname = common_canonical_nickname($match[1]);
2163 // Figure out who that is.
2164 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2166 if ($recipient instanceof Profile) {
2167 // Get their last notice
2168 $last = $recipient->getCurrentNotice();
2169 if ($last instanceof Notice) {
2172 // Maybe in the future we want to handle something else below
2173 // so don't return getCurrentNotice() immediately.
2179 static function maxContent()
2181 $contentlimit = common_config('notice', 'contentlimit');
2182 // null => use global limit (distinct from 0!)
2183 if (is_null($contentlimit)) {
2184 $contentlimit = common_config('site', 'textlimit');
2186 return $contentlimit;
2189 static function contentTooLong($content)
2191 $contentlimit = self::maxContent();
2192 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2196 * Convenience function for posting a repeat of an existing message.
2198 * @param Profile $repeater Profile which is doing the repeat
2199 * @param string $source: posting source key, eg 'web', 'api', etc
2202 * @throws Exception on failure or permission problems
2204 function repeat(Profile $repeater, $source)
2206 $author = $this->getProfile();
2208 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2209 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2210 $content = sprintf(_('RT @%1$s %2$s'),
2211 $author->getNickname(),
2214 $maxlen = self::maxContent();
2215 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2216 // Web interface and current Twitter API clients will
2217 // pull the original notice's text, but some older
2218 // clients and RSS/Atom feeds will see this trimmed text.
2220 // Unfortunately this is likely to lose tags or URLs
2221 // at the end of long notices.
2222 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2226 // Scope is same as this one's
2227 return self::saveNew($repeater->id,
2230 array('repeat_of' => $this->id,
2231 'scope' => $this->scope));
2234 // These are supposed to be in chron order!
2236 function repeatStream($limit=100)
2238 $cache = Cache::instance();
2240 if (empty($cache)) {
2241 $ids = $this->_repeatStreamDirect($limit);
2243 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2244 if ($idstr !== false) {
2245 if (empty($idstr)) {
2248 $ids = explode(',', $idstr);
2251 $ids = $this->_repeatStreamDirect(100);
2252 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2255 // We do a max of 100, so slice down to limit
2256 $ids = array_slice($ids, 0, $limit);
2260 return NoticeStream::getStreamByIds($ids);
2263 function _repeatStreamDirect($limit)
2265 $notice = new Notice();
2267 $notice->selectAdd(); // clears it
2268 $notice->selectAdd('id');
2270 $notice->repeat_of = $this->id;
2272 $notice->orderBy('created, id'); // NB: asc!
2274 if (!is_null($limit)) {
2275 $notice->limit(0, $limit);
2278 return $notice->fetchAll('id');
2281 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2285 if (!empty($location_id) && !empty($location_ns)) {
2286 $options['location_id'] = $location_id;
2287 $options['location_ns'] = $location_ns;
2289 $location = Location::fromId($location_id, $location_ns);
2291 if ($location instanceof Location) {
2292 $options['lat'] = $location->lat;
2293 $options['lon'] = $location->lon;
2296 } else if (!empty($lat) && !empty($lon)) {
2297 $options['lat'] = $lat;
2298 $options['lon'] = $lon;
2300 $location = Location::fromLatLon($lat, $lon);
2302 if ($location instanceof Location) {
2303 $options['location_id'] = $location->location_id;
2304 $options['location_ns'] = $location->location_ns;
2306 } else if (!empty($profile)) {
2307 if (isset($profile->lat) && isset($profile->lon)) {
2308 $options['lat'] = $profile->lat;
2309 $options['lon'] = $profile->lon;
2312 if (isset($profile->location_id) && isset($profile->location_ns)) {
2313 $options['location_id'] = $profile->location_id;
2314 $options['location_ns'] = $profile->location_ns;
2321 function clearAttentions()
2323 $att = new Attention();
2324 $att->notice_id = $this->getID();
2327 while ($att->fetch()) {
2328 // Can't do delete() on the object directly since it won't remove all of it
2329 $other = clone($att);
2335 function clearReplies()
2337 $replyNotice = new Notice();
2338 $replyNotice->reply_to = $this->id;
2340 //Null any notices that are replies to this notice
2342 if ($replyNotice->find()) {
2343 while ($replyNotice->fetch()) {
2344 $orig = clone($replyNotice);
2345 $replyNotice->reply_to = null;
2346 $replyNotice->update($orig);
2352 $reply = new Reply();
2353 $reply->notice_id = $this->id;
2355 if ($reply->find()) {
2356 while($reply->fetch()) {
2357 self::blow('reply:stream:%d', $reply->profile_id);
2365 function clearLocation()
2367 $loc = new Notice_location();
2368 $loc->notice_id = $this->id;
2375 function clearFiles()
2377 $f2p = new File_to_post();
2379 $f2p->post_id = $this->id;
2382 while ($f2p->fetch()) {
2386 // FIXME: decide whether to delete File objects
2387 // ...and related (actual) files
2390 function clearRepeats()
2392 $repeatNotice = new Notice();
2393 $repeatNotice->repeat_of = $this->id;
2395 //Null any notices that are repeats of this notice
2397 if ($repeatNotice->find()) {
2398 while ($repeatNotice->fetch()) {
2399 $orig = clone($repeatNotice);
2400 $repeatNotice->repeat_of = null;
2401 $repeatNotice->update($orig);
2406 function clearTags()
2408 $tag = new Notice_tag();
2409 $tag->notice_id = $this->id;
2412 while ($tag->fetch()) {
2413 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2414 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2415 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2416 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2424 function clearGroupInboxes()
2426 $gi = new Group_inbox();
2428 $gi->notice_id = $this->id;
2431 while ($gi->fetch()) {
2432 self::blow('user_group:notice_ids:%d', $gi->group_id);
2440 function distribute()
2442 // We always insert for the author so they don't
2444 Event::handle('StartNoticeDistribute', array($this));
2446 // If there's a failure, we want to _force_
2447 // distribution at this point.
2449 $json = json_encode((object)array('id' => $this->getID(),
2452 $qm = QueueManager::get();
2453 $qm->enqueue($json, 'distrib');
2454 } catch (Exception $e) {
2455 // If the exception isn't transient, this
2456 // may throw more exceptions as DQH does
2457 // its own enqueueing. So, we ignore them!
2459 $handler = new DistribQueueHandler();
2460 $handler->handle($this);
2461 } catch (Exception $e) {
2462 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2464 // Re-throw so somebody smarter can handle it.
2471 $result = parent::insert();
2473 if ($result === false) {
2474 common_log_db_error($this, 'INSERT', __FILE__);
2475 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2476 throw new ServerException('Could not save Notice');
2479 // Profile::hasRepeated() abuses pkeyGet(), so we
2480 // have to clear manually
2481 if (!empty($this->repeat_of)) {
2482 $c = self::memcache();
2484 $ck = self::multicacheKey('Notice',
2485 array('profile_id' => $this->profile_id,
2486 'repeat_of' => $this->repeat_of));
2491 // Update possibly ID-dependent columns: URI, conversation
2492 // (now that INSERT has added the notice's local id)
2493 $orig = clone($this);
2496 // We can only get here if it's a local notice, since remote notices
2497 // should've bailed out earlier due to lacking a URI.
2498 if (empty($this->uri)) {
2499 $this->uri = sprintf('%s%s=%d:%s=%s',
2501 'noticeId', $this->id,
2502 'objectType', $this->getObjectType(true));
2506 if ($changed && $this->update($orig) === false) {
2507 common_log_db_error($notice, 'UPDATE', __FILE__);
2508 // TRANS: Server exception thrown when a notice cannot be updated.
2509 throw new ServerException(_('Problem saving notice.'));
2512 $this->blowOnInsert();
2518 * Get the source of the notice
2520 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2521 * guaranteed to be populated.
2523 function getSource()
2525 if (empty($this->source)) {
2529 $ns = new Notice_source();
2530 switch ($this->source) {
2537 $ns->code = $this->source;
2540 $ns = Notice_source::getKV($this->source);
2542 $ns = new Notice_source();
2543 $ns->code = $this->source;
2544 $app = Oauth_application::getKV('name', $this->source);
2546 $ns->name = $app->name;
2547 $ns->url = $app->source_url;
2557 * Determine whether the notice was locally created
2559 * @return boolean locality
2562 public function isLocal()
2564 $is_local = intval($this->is_local);
2565 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2568 public function getScope()
2570 return intval($this->scope);
2573 public function isRepeat()
2575 return !empty($this->repeat_of);
2579 * Get the list of hash tags saved with this notice.
2581 * @return array of strings
2583 public function getTags()
2587 $keypart = sprintf('notice:tags:%d', $this->id);
2589 $tagstr = self::cacheGet($keypart);
2591 if ($tagstr !== false) {
2592 $tags = explode(',', $tagstr);
2594 $tag = new Notice_tag();
2595 $tag->notice_id = $this->id;
2597 while ($tag->fetch()) {
2598 $tags[] = $tag->tag;
2601 self::cacheSet($keypart, implode(',', $tags));
2607 static private function utcDate($dt)
2609 $dateStr = date('d F Y H:i:s', strtotime($dt));
2610 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2611 return $d->format(DATE_W3C);
2615 * Look up the creation timestamp for a given notice ID, even
2616 * if it's been deleted.
2619 * @return mixed string recorded creation timestamp, or false if can't be found
2621 public static function getAsTimestamp($id)
2624 throw new EmptyIdException('Notice');
2628 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2629 // getByID throws exception if $id isn't found
2630 $notice = Notice::getByID($id);
2631 $timestamp = $notice->created;
2634 if (empty($timestamp)) {
2635 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2641 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2642 * parameter, matching notices posted after the given one (exclusive).
2644 * If the referenced notice can't be found, will return false.
2647 * @param string $idField
2648 * @param string $createdField
2649 * @return mixed string or false if no match
2651 public static function whereSinceId($id, $idField='id', $createdField='created')
2654 $since = Notice::getAsTimestamp($id);
2655 } catch (Exception $e) {
2658 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2662 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2663 * parameter, matching notices posted after the given one (exclusive), and
2664 * if necessary add it to the data object's query.
2666 * @param DB_DataObject $obj
2668 * @param string $idField
2669 * @param string $createdField
2670 * @return mixed string or false if no match
2672 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2674 $since = self::whereSinceId($id, $idField, $createdField);
2676 $obj->whereAdd($since);
2681 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2682 * parameter, matching notices posted before the given one (inclusive).
2684 * If the referenced notice can't be found, will return false.
2687 * @param string $idField
2688 * @param string $createdField
2689 * @return mixed string or false if no match
2691 public static function whereMaxId($id, $idField='id', $createdField='created')
2694 $max = Notice::getAsTimestamp($id);
2695 } catch (Exception $e) {
2698 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2702 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2703 * parameter, matching notices posted before the given one (inclusive), and
2704 * if necessary add it to the data object's query.
2706 * @param DB_DataObject $obj
2708 * @param string $idField
2709 * @param string $createdField
2710 * @return mixed string or false if no match
2712 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2714 $max = self::whereMaxId($id, $idField, $createdField);
2716 $obj->whereAdd($max);
2722 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2723 ($this->is_local != Notice::GATEWAY));
2727 * Check that the given profile is allowed to read, respond to, or otherwise
2728 * act on this notice.
2730 * The $scope member is a bitmask of scopes, representing a logical AND of the
2731 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2732 * "only visible to people who are mentioned in the notice AND are users on this site."
2733 * Users on the site who are not mentioned in the notice will not be able to see the
2736 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2738 * @return boolean whether the profile is in the notice's scope
2740 function inScope($profile)
2742 if (is_null($profile)) {
2743 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2745 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2748 $result = self::cacheGet($keypart);
2750 if ($result === false) {
2752 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2753 $bResult = $this->_inScope($profile);
2754 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2756 $result = ($bResult) ? 1 : 0;
2757 self::cacheSet($keypart, $result, 0, 300);
2760 return ($result == 1) ? true : false;
2763 protected function _inScope($profile)
2765 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2767 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2768 return !$this->isHiddenSpam($profile);
2771 // If there's scope, anon cannot be in scope
2772 if (empty($profile)) {
2776 // Author is always in scope
2777 if ($this->profile_id == $profile->id) {
2781 // Only for users on this site
2782 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2786 // Only for users mentioned in the notice
2787 if ($scope & Notice::ADDRESSEE_SCOPE) {
2789 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2790 'profile_id' => $profile->id));
2792 if (!$reply instanceof Reply) {
2797 // Only for members of the given group
2798 if ($scope & Notice::GROUP_SCOPE) {
2800 // XXX: just query for the single membership
2802 $groups = $this->getGroups();
2806 foreach ($groups as $group) {
2807 if ($profile->isMember($group)) {
2818 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2820 if (!Subscription::exists($profile, $this->getProfile())) {
2825 return !$this->isHiddenSpam($profile);
2828 function isHiddenSpam($profile) {
2830 // Hide posts by silenced users from everyone but moderators.
2832 if (common_config('notice', 'hidespam')) {
2835 $author = $this->getProfile();
2836 } catch(Exception $e) {
2837 // If we can't get an author, keep it hidden.
2838 // XXX: technically not spam, but, whatever.
2842 if ($author->hasRole(Profile_role::SILENCED)) {
2843 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2852 public function hasParent()
2856 } catch (NoParentNoticeException $e) {
2862 public function getParent()
2864 $reply_to_id = null;
2866 if (empty($this->reply_to)) {
2867 throw new NoParentNoticeException($this);
2870 // The reply_to ID in the table Notice could exist with a number
2871 // however, the replied to notice might not exist in the database.
2872 // Thus we need to catch the exception and throw the NoParentNoticeException else
2873 // the timeline will not display correctly.
2875 $reply_to_id = self::getByID($this->reply_to);
2876 } catch(Exception $e){
2877 throw new NoParentNoticeException($this);
2880 return $reply_to_id;
2884 * Magic function called at serialize() time.
2886 * We use this to drop a couple process-specific references
2887 * from DB_DataObject which can cause trouble in future
2890 * @return array of variable names to include in serialization.
2895 $vars = parent::__sleep();
2896 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2897 return array_diff($vars, $skip);
2900 static function defaultScope()
2902 $scope = common_config('notice', 'defaultscope');
2903 if (is_null($scope)) {
2904 if (common_config('site', 'private')) {
2913 static function fillProfiles($notices)
2915 $map = self::getProfiles($notices);
2916 foreach ($notices as $entry=>$notice) {
2918 if (array_key_exists($notice->profile_id, $map)) {
2919 $notice->_setProfile($map[$notice->profile_id]);
2921 } catch (NoProfileException $e) {
2922 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2923 unset($notices[$entry]);
2927 return array_values($map);
2930 static function getProfiles(&$notices)
2933 foreach ($notices as $notice) {
2934 $ids[] = $notice->profile_id;
2936 $ids = array_unique($ids);
2937 return Profile::pivotGet('id', $ids);
2940 static function fillGroups(&$notices)
2942 $ids = self::_idsOf($notices);
2943 $gis = Group_inbox::listGet('notice_id', $ids);
2946 foreach ($gis as $id => $gi) {
2949 $gids[] = $g->group_id;
2953 $gids = array_unique($gids);
2954 $group = User_group::pivotGet('id', $gids);
2955 foreach ($notices as $notice)
2958 $gi = $gis[$notice->id];
2959 foreach ($gi as $g) {
2960 $grps[] = $group[$g->group_id];
2962 $notice->_setGroups($grps);
2966 static function _idsOf(array &$notices)
2969 foreach ($notices as $notice) {
2970 $ids[$notice->id] = true;
2972 return array_keys($ids);
2975 static function fillAttachments(&$notices)
2977 $ids = self::_idsOf($notices);
2978 $f2pMap = File_to_post::listGet('post_id', $ids);
2980 foreach ($f2pMap as $noticeId => $f2ps) {
2981 foreach ($f2ps as $f2p) {
2982 $fileIds[] = $f2p->file_id;
2986 $fileIds = array_unique($fileIds);
2987 $fileMap = File::pivotGet('id', $fileIds);
2988 foreach ($notices as $notice)
2991 $f2ps = $f2pMap[$notice->id];
2992 foreach ($f2ps as $f2p) {
2993 $files[] = $fileMap[$f2p->file_id];
2995 $notice->_setAttachments($files);
2999 static function fillReplies(&$notices)
3001 $ids = self::_idsOf($notices);
3002 $replyMap = Reply::listGet('notice_id', $ids);
3003 foreach ($notices as $notice) {
3004 $replies = $replyMap[$notice->id];
3006 foreach ($replies as $reply) {
3007 $ids[] = $reply->profile_id;
3009 $notice->_setReplies($ids);
3013 static public function beforeSchemaUpdate()
3015 $table = strtolower(get_called_class());
3016 $schema = Schema::get();
3017 $schemadef = $schema->getTableDef($table);
3019 // 2015-09-04 We move Notice location data to Notice_location
3020 // First we see if we have to do this at all
3021 if (!isset($schemadef['fields']['lat'])
3022 && !isset($schemadef['fields']['lon'])
3023 && !isset($schemadef['fields']['location_id'])
3024 && !isset($schemadef['fields']['location_ns'])) {
3025 // We have already removed the location fields, so no need to migrate.
3028 // Then we make sure the Notice_location table is created!
3029 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3031 // Then we continue on our road to migration!
3032 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)";
3034 $notice = new Notice();
3035 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3036 'WHERE lat IS NOT NULL ' .
3037 'OR lon IS NOT NULL ' .
3038 'OR location_id IS NOT NULL ' .
3039 'OR location_ns IS NOT NULL',
3040 $schema->quoteIdentifier($table)));
3041 print "\nFound {$notice->N} notices with location data, inserting";
3042 while ($notice->fetch()) {
3043 $notloc = Notice_location::getKV('notice_id', $notice->id);
3044 if ($notloc instanceof Notice_location) {
3048 $notloc = new Notice_location();
3049 $notloc->notice_id = $notice->id;
3050 $notloc->lat= $notice->lat;
3051 $notloc->lon= $notice->lon;
3052 $notloc->location_id= $notice->location_id;
3053 $notloc->location_ns= $notice->location_ns;