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 $autosource = common_config('public', 'autosource');
512 // Sandboxed are non-false, but not 1, either
514 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
515 ($source && $autosource && in_array($source, $autosource))) {
516 $notice->is_local = Notice::LOCAL_NONPUBLIC;
518 $notice->is_local = $is_local;
521 if (!empty($created)) {
522 $notice->created = $created;
524 $notice->created = common_sql_now();
527 if (!$notice->isLocal()) {
528 // Only do these checks for non-local notices. Local notices will generate these values later.
529 if (!common_valid_http_url($url)) {
530 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
533 throw new ServerException('No URI for remote notice. Cannot accept that.');
537 $notice->content = $final;
539 $notice->source = $source;
543 // Get the groups here so we can figure out replies and such
544 if (!isset($groups)) {
545 $groups = User_group::idsFromText($notice->content, $profile);
550 // Handle repeat case
552 if (!empty($options['repeat_of'])) {
554 // Check for a private one
556 $repeat = Notice::getByID($options['repeat_of']);
558 if ($profile->sameAs($repeat->getProfile())) {
559 // TRANS: Client error displayed when trying to repeat an own notice.
560 throw new ClientException(_('You cannot repeat your own notice.'));
563 if ($repeat->scope != Notice::SITE_SCOPE &&
564 $repeat->scope != Notice::PUBLIC_SCOPE) {
565 // TRANS: Client error displayed when trying to repeat a non-public notice.
566 throw new ClientException(_('Cannot repeat a private notice.'), 403);
569 if (!$repeat->inScope($profile)) {
570 // The generic checks above should cover this, but let's be sure!
571 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
572 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
575 if ($profile->hasRepeated($repeat)) {
576 // TRANS: Client error displayed when trying to repeat an already repeated notice.
577 throw new ClientException(_('You already repeated that notice.'));
580 $notice->repeat_of = $repeat->id;
581 $notice->conversation = $repeat->conversation;
585 // If $reply_to is specified, we check that it exists, and then
586 // return it if it does
587 if (!empty($reply_to)) {
588 $reply = Notice::getKV('id', $reply_to);
589 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
590 // If the source lacks capability of sending the "reply_to"
591 // metadata, let's try to find an inline replyto-reference.
592 $reply = self::getInlineReplyTo($profile, $final);
595 if ($reply instanceof Notice) {
596 if (!$reply->inScope($profile)) {
597 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
598 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
599 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
600 $profile->nickname, $reply->id), 403);
603 // If it's a repeat, the reply_to should be to the original
604 if ($reply->isRepeat()) {
605 $notice->reply_to = $reply->repeat_of;
607 $notice->reply_to = $reply->id;
609 // But the conversation ought to be the same :)
610 $notice->conversation = $reply->conversation;
612 // If the original is private to a group, and notice has
613 // no group specified, make it to the same group(s)
615 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
617 $replyGroups = $reply->getGroups();
618 foreach ($replyGroups as $group) {
619 if ($profile->isMember($group)) {
620 $groups[] = $group->id;
628 // If we don't know the reply, we might know the conversation!
629 // This will happen if a known remote user replies to an
630 // unknown remote user - within a known conversation.
631 if (empty($notice->conversation) and !empty($options['conversation'])) {
632 $conv = Conversation::getKV('uri', $options['conversation']);
633 if ($conv instanceof Conversation) {
634 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.').');
636 // Conversation entry with specified URI was not found, so we must create it.
637 common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
638 // The insert in Conversation::create throws exception on failure
639 $conv = Conversation::create($options['conversation'], $notice->created);
641 $notice->conversation = $conv->getID();
646 // If it's not part of a conversation, it's the beginning of a new conversation.
647 if (empty($notice->conversation)) {
648 $conv = Conversation::create();
649 $notice->conversation = $conv->getID();
654 $notloc = new Notice_location();
655 if (!empty($lat) && !empty($lon)) {
660 if (!empty($location_ns) && !empty($location_id)) {
661 $notloc->location_id = $location_id;
662 $notloc->location_ns = $location_ns;
665 if (!empty($rendered)) {
666 $notice->rendered = $rendered;
668 $notice->rendered = common_render_content($final,
669 $notice->getProfile(),
670 $notice->hasParent() ? $notice->getParent() : null);
674 if ($notice->isRepeat()) {
675 $notice->verb = ActivityVerb::SHARE;
676 $notice->object_type = ActivityObject::ACTIVITY;
678 $notice->verb = ActivityVerb::POST;
681 $notice->verb = $verb;
684 if (empty($object_type)) {
685 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
687 $notice->object_type = $object_type;
690 if (is_null($scope) && $reply instanceof Notice) {
691 $notice->scope = $reply->scope;
693 $notice->scope = $scope;
696 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
698 if (Event::handle('StartNoticeSave', array(&$notice))) {
700 // XXX: some of these functions write to the DB
703 $notice->insert(); // throws exception on failure, if successful we have an ->id
705 if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
706 $notloc->notice_id = $notice->getID();
707 $notloc->insert(); // store the notice location if it had any information
709 } catch (Exception $e) {
710 // Let's test if we managed initial insert, which would imply
711 // failing on some update-part (check 'insert()'). Delete if
712 // something had been stored to the database.
713 if (!empty($notice->id)) {
720 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
721 // the activityverb is a POST (since stuff like repeat, favorite etc.
722 // reasonably handle notifications themselves.
723 if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
724 if (isset($replies)) {
725 $notice->saveKnownReplies($replies);
727 $notice->saveReplies();
731 $notice->saveKnownTags($tags);
736 // Note: groups may save tags, so must be run after tags are saved
737 // to avoid errors on duplicates.
738 // Note: groups should always be set.
740 $notice->saveKnownGroups($groups);
743 $notice->saveKnownUrls($urls);
750 // Prepare inbox delivery, may be queued to background.
751 $notice->distribute();
757 static function saveActivity(Activity $act, Profile $actor, array $options=array())
759 // First check if we're going to let this Activity through from the specific actor
760 if (!$actor->hasRight(Right::NEWNOTICE)) {
761 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
763 // TRANS: Client exception thrown when a user tries to post while being banned.
764 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
766 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
767 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
768 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
769 throw new ClientException(_m('Too many notices too fast; take a breather '.
770 'and post again in a few minutes.'));
773 // Get ActivityObject properties
775 if (!empty($act->id)) {
777 $options['uri'] = $act->id;
778 $options['url'] = $act->link;
780 $actobj = count($act->objects)===1 ? $act->objects[0] : null;
781 if (!is_null($actobj) && !empty($actobj->id)) {
782 $options['uri'] = $actobj->id;
784 $options['url'] = $actobj->link;
785 } elseif (preg_match('!^https?://!', $actobj->id)) {
786 $options['url'] = $actobj->id;
793 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
794 'mentions' => array(),
798 'source' => 'unknown',
803 'distribute' => true);
805 // options will have default values when nothing has been supplied
806 $options = array_merge($defaults, $options);
807 foreach (array_keys($defaults) as $key) {
808 // Only convert the keynames we specify ourselves from 'defaults' array into variables
809 $$key = $options[$key];
811 extract($options, EXTR_SKIP);
814 $stored = new Notice();
815 if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
817 if ($stored->find()) {
818 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
819 // I _assume_ saving a Notice with a colliding URI means we're really trying to
820 // save the same notice again...
821 throw new AlreadyFulfilledException('Notice URI already exists');
825 $autosource = common_config('public', 'autosource');
827 // Sandboxed are non-false, but not 1, either
828 if (!$actor->hasRight(Right::PUBLICNOTICE) ||
829 ($source && $autosource && in_array($source, $autosource))) {
830 // FIXME: ...what about remote nonpublic? Hmmm. That is, if we sandbox remote profiles...
831 $stored->is_local = Notice::LOCAL_NONPUBLIC;
833 $stored->is_local = intval($is_local);
836 if (!$stored->isLocal()) {
837 // Only do these checks for non-local notices. Local notices will generate these values later.
838 if (!common_valid_http_url($url)) {
839 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
842 throw new ServerException('No URI for remote notice. Cannot accept that.');
846 $stored->profile_id = $actor->id;
847 $stored->source = $source;
850 $stored->verb = $act->verb;
852 // we use mb_strlen because it _might_ be that the content is just the string "0"...
853 $content = mb_strlen($act->content) ? $act->content : $act->summary;
854 if (mb_strlen($content)===0 && !is_null($actobj)) {
855 $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
857 // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
858 $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
859 $stored->content = common_strip_html($stored->getRendered(), true, true);
860 if (trim($stored->content) === '') {
861 // TRANS: Error message when the plain text content of a notice has zero length.
862 throw new ClientException(_('Empty notice content, will not save this.'));
865 // Maybe a missing act-time should be fatal if the actor is not local?
866 if (!empty($act->time)) {
867 $stored->created = common_sql_date($act->time);
869 $stored->created = common_sql_now();
873 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
874 $reply = self::getKV('uri', $act->context->replyToID);
876 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
877 $reply = self::getKV('uri', $act->target->id);
880 if ($reply instanceof Notice) {
881 if (!$reply->inScope($actor)) {
882 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
883 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
884 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
887 $stored->reply_to = $reply->id;
888 $stored->conversation = $reply->conversation;
890 // If the original is private to a group, and notice has no group specified,
891 // make it to the same group(s)
892 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
893 $replyGroups = $reply->getGroups();
894 foreach ($replyGroups as $group) {
895 if ($actor->isMember($group)) {
896 $groups[] = $group->id;
901 if (is_null($scope)) {
902 $scope = $reply->scope;
905 // If we don't know the reply, we might know the conversation!
906 // This will happen if a known remote user replies to an
907 // unknown remote user - within a known conversation.
908 if (empty($stored->conversation) and !empty($act->context->conversation)) {
909 $conv = Conversation::getKV('uri', $act->context->conversation);
910 if ($conv instanceof Conversation) {
911 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.').');
913 // Conversation entry with specified URI was not found, so we must create it.
914 common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
915 // The insert in Conversation::create throws exception on failure
916 $conv = Conversation::create($act->context->conversation, $stored->created);
918 $stored->conversation = $conv->getID();
923 // If it's not part of a conversation, it's the beginning of a new conversation.
924 if (empty($stored->conversation)) {
925 $conv = Conversation::create();
926 $stored->conversation = $conv->getID();
931 if ($act->context instanceof ActivityContext) {
932 if ($act->context->location instanceof Location) {
933 $notloc = Notice_location::fromLocation($act->context->location);
936 $act->context = new ActivityContext();
939 $stored->scope = self::figureOutScope($actor, $groups, $scope);
941 foreach ($act->categories as $cat) {
943 $term = common_canonical_tag($cat->term);
950 foreach ($act->enclosures as $href) {
951 // @todo FIXME: Save these locally or....?
955 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
956 if (empty($act->objects[0]->type)) {
957 // Default type for the post verb is 'note', but we know it's
958 // a 'comment' if it is in reply to something.
959 $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
961 //TODO: Is it safe to always return a relative URI? The
962 // JSON version of ActivityStreams always use it, so we
963 // should definitely be able to handle it...
964 $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
968 if (Event::handle('StartNoticeSave', array(&$stored))) {
969 // XXX: some of these functions write to the DB
972 $result = $stored->insert(); // throws exception on error
974 if ($notloc instanceof Notice_location) {
975 $notloc->notice_id = $stored->getID();
979 $orig = clone($stored); // for updating later in this try clause
982 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
983 if (empty($object)) {
984 throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
987 // If something changed in the Notice during StoreActivityObject
988 $stored->update($orig);
989 } catch (Exception $e) {
990 if (empty($stored->id)) {
991 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
993 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
999 if (!$stored instanceof Notice) {
1000 throw new ServerException('StartNoticeSave did not give back a Notice.');
1001 } elseif (empty($stored->id)) {
1002 throw new ServerException('Supposedly saved Notice has no ID.');
1005 // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
1006 // the activityverb is a POST (since stuff like repeat, favorite etc.
1007 // reasonably handle notifications themselves.
1008 if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
1010 if (!empty($tags)) {
1011 $stored->saveKnownTags($tags);
1013 $stored->saveTags();
1016 // Note: groups may save tags, so must be run after tags are saved
1017 // to avoid errors on duplicates.
1018 $stored->saveAttentions($act->context->attention);
1020 if (!empty($urls)) {
1021 $stored->saveKnownUrls($urls);
1023 $stored->saveUrls();
1028 // Prepare inbox delivery, may be queued to background.
1029 $stored->distribute();
1035 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
1036 $scope = is_null($scope) ? self::defaultScope() : intval($scope);
1038 // For private streams
1040 $user = $actor->getUser();
1041 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
1042 if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
1043 $scope |= Notice::FOLLOWER_SCOPE;
1045 } catch (NoSuchUserException $e) {
1046 // TODO: Not a local user, so we don't know about scope preferences... yet!
1049 // Force the scope for private groups
1050 foreach ($groups as $group_id) {
1052 $group = User_group::getByID($group_id);
1053 if ($group->force_scope) {
1054 $scope |= Notice::GROUP_SCOPE;
1057 } catch (Exception $e) {
1058 common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
1065 function blowOnInsert($conversation = false)
1067 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
1069 if ($this->isPublic()) {
1070 $this->blowStream('public');
1071 $this->blowStream('networkpublic');
1074 if ($this->conversation) {
1075 self::blow('notice:list-ids:conversation:%s', $this->conversation);
1076 self::blow('conversation:notice_count:%d', $this->conversation);
1079 if ($this->isRepeat()) {
1080 // XXX: we should probably only use one of these
1081 $this->blowStream('notice:repeats:%d', $this->repeat_of);
1082 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
1085 $original = Notice::getKV('id', $this->repeat_of);
1087 if ($original instanceof Notice) {
1088 $originalUser = User::getKV('id', $original->profile_id);
1089 if ($originalUser instanceof User) {
1090 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1094 $profile = Profile::getKV($this->profile_id);
1096 if ($profile instanceof Profile) {
1097 $profile->blowNoticeCount();
1100 $ptags = $this->getProfileTags();
1101 foreach ($ptags as $ptag) {
1102 $ptag->blowNoticeStreamCache();
1107 * Clear cache entries related to this notice at delete time.
1108 * Necessary to avoid breaking paging on public, profile timelines.
1110 function blowOnDelete()
1112 $this->blowOnInsert();
1114 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1116 if ($this->isPublic()) {
1117 self::blow('public;last');
1118 self::blow('networkpublic;last');
1121 self::blow('fave:by_notice', $this->id);
1123 if ($this->conversation) {
1124 // In case we're the first, will need to calc a new root.
1125 self::blow('notice:conversation_root:%d', $this->conversation);
1128 $ptags = $this->getProfileTags();
1129 foreach ($ptags as $ptag) {
1130 $ptag->blowNoticeStreamCache(true);
1134 function blowStream()
1136 $c = self::memcache();
1142 $args = func_get_args();
1143 $format = array_shift($args);
1144 $keyPart = vsprintf($format, $args);
1145 $cacheKey = Cache::key($keyPart);
1146 $c->delete($cacheKey);
1148 // delete the "last" stream, too, if this notice is
1149 // older than the top of that stream
1151 $lastKey = $cacheKey.';last';
1153 $lastStr = $c->get($lastKey);
1155 if ($lastStr !== false) {
1156 $window = explode(',', $lastStr);
1157 $lastID = $window[0];
1158 $lastNotice = Notice::getKV('id', $lastID);
1159 if (!$lastNotice instanceof Notice // just weird
1160 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1161 $c->delete($lastKey);
1166 /** save all urls in the notice to the db
1168 * follow redirects and save all available file information
1169 * (mimetype, date, size, oembed, etc.)
1173 function saveUrls() {
1174 if (common_config('attachments', 'process_links')) {
1175 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
1180 * Save the given URLs as related links/attachments to the db
1182 * follow redirects and save all available file information
1183 * (mimetype, date, size, oembed, etc.)
1187 function saveKnownUrls($urls)
1189 if (common_config('attachments', 'process_links')) {
1190 // @fixme validation?
1191 foreach (array_unique($urls) as $url) {
1192 $this->saveUrl($url, $this);
1200 function saveUrl($url, Notice $notice) {
1202 File::processNew($url, $notice);
1203 } catch (ServerException $e) {
1204 // Could not save URL. Log it?
1208 static function checkDupes($profile_id, $content) {
1209 $profile = Profile::getKV($profile_id);
1210 if (!$profile instanceof Profile) {
1213 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1214 if (!empty($notice)) {
1216 while ($notice->fetch()) {
1217 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1219 } else if ($notice->content == $content) {
1224 // If we get here, oldest item in cache window is not
1225 // old enough for dupe limit; do direct check against DB
1226 $notice = new Notice();
1227 $notice->profile_id = $profile_id;
1228 $notice->content = $content;
1229 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1230 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1232 $cnt = $notice->count();
1236 static function checkEditThrottle($profile_id) {
1237 $profile = Profile::getKV($profile_id);
1238 if (!$profile instanceof Profile) {
1241 // Get the Nth notice
1242 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1243 if ($notice && $notice->fetch()) {
1244 // If the Nth notice was posted less than timespan seconds ago
1245 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1250 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1254 protected $_attachments = array();
1256 function attachments() {
1257 if (isset($this->_attachments[$this->id])) {
1258 return $this->_attachments[$this->id];
1261 $f2ps = File_to_post::listGet('post_id', array($this->id));
1263 foreach ($f2ps[$this->id] as $f2p) {
1264 $ids[] = $f2p->file_id;
1267 $files = File::multiGet('id', $ids);
1268 $this->_attachments[$this->id] = $files->fetchAll();
1269 return $this->_attachments[$this->id];
1272 function _setAttachments($attachments)
1274 $this->_attachments[$this->id] = $attachments;
1277 static function publicStream($offset=0, $limit=20, $since_id=null, $max_id=null)
1279 $stream = new PublicNoticeStream();
1280 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1283 static function conversationStream($id, $offset=0, $limit=20, $since_id=null, $max_id=null)
1285 $stream = new ConversationNoticeStream($id);
1286 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1290 * Is this notice part of an active conversation?
1292 * @return boolean true if other messages exist in the same
1293 * conversation, false if this is the only one
1295 function hasConversation()
1297 if (empty($this->conversation)) {
1298 // this notice is not part of a conversation apparently
1299 // FIXME: all notices should have a conversation value, right?
1303 $stream = new ConversationNoticeStream($this->conversation);
1304 $notice = $stream->getNotices(/*offset*/ 1, /*limit*/ 1);
1306 // if our "offset 1, limit 1" query got a result, return true else false
1307 return $notice->N > 0;
1311 * Grab the earliest notice from this conversation.
1313 * @return Notice or null
1315 function conversationRoot($profile=-1)
1317 // XXX: can this happen?
1319 if (empty($this->conversation)) {
1323 // Get the current profile if not specified
1325 if (is_int($profile) && $profile == -1) {
1326 $profile = Profile::current();
1329 // If this notice is out of scope, no root for you!
1331 if (!$this->inScope($profile)) {
1335 // If this isn't a reply to anything, then it's its own
1336 // root if it's the earliest notice in the conversation:
1338 if (empty($this->reply_to)) {
1340 $root->conversation = $this->conversation;
1341 $root->orderBy('notice.created ASC');
1342 $root->find(true); // true means "fetch first result"
1347 if (is_null($profile)) {
1348 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1350 $keypart = sprintf('notice:conversation_root:%d:%d',
1355 $root = self::cacheGet($keypart);
1357 if ($root !== false && $root->inScope($profile)) {
1364 $parent = $last->getParent();
1365 if ($parent->inScope($profile)) {
1369 } catch (NoParentNoticeException $e) {
1370 // Latest notice has no parent
1371 } catch (NoResultException $e) {
1372 // Notice was not found, so we can't go further up in the tree.
1373 // FIXME: Maybe we should do this in a more stable way where deleted
1374 // notices won't break conversation chains?
1376 // No parent, or parent out of scope
1381 self::cacheSet($keypart, $root);
1387 * Pull up a full list of local recipients who will be getting
1388 * this notice in their inbox. Results will be cached, so don't
1389 * change the input data wily-nilly!
1391 * @param array $groups optional list of Group objects;
1392 * if left empty, will be loaded from group_inbox records
1393 * @param array $recipient optional list of reply profile ids
1394 * if left empty, will be loaded from reply records
1395 * @return array associating recipient user IDs with an inbox source constant
1397 function whoGets(array $groups=null, array $recipients=null)
1399 $c = self::memcache();
1402 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1403 if ($ni !== false) {
1408 if (is_null($recipients)) {
1409 $recipients = $this->getReplies();
1414 // Give plugins a chance to add folks in at start...
1415 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1417 $users = $this->getSubscribedUsers();
1418 foreach ($users as $id) {
1419 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1422 if (is_null($groups)) {
1423 $groups = $this->getGroups();
1425 foreach ($groups as $group) {
1426 $users = $group->getUserMembers();
1427 foreach ($users as $id) {
1428 if (!array_key_exists($id, $ni)) {
1429 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1434 $ptAtts = $this->getAttentionsFromProfileTags();
1435 foreach ($ptAtts as $key=>$val) {
1436 if (!array_key_exists($key, $ni)) {
1441 foreach ($recipients as $recipient) {
1442 if (!array_key_exists($recipient, $ni)) {
1443 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1447 // Exclude any deleted, non-local, or blocking recipients.
1448 $profile = $this->getProfile();
1449 $originalProfile = null;
1450 if ($this->isRepeat()) {
1451 // Check blocks against the original notice's poster as well.
1452 $original = Notice::getKV('id', $this->repeat_of);
1453 if ($original instanceof Notice) {
1454 $originalProfile = $original->getProfile();
1458 foreach ($ni as $id => $source) {
1460 $user = User::getKV('id', $id);
1461 if (!$user instanceof User ||
1462 $user->hasBlocked($profile) ||
1463 ($originalProfile && $user->hasBlocked($originalProfile))) {
1466 } catch (UserNoProfileException $e) {
1467 // User doesn't have a profile; invalid; skip them.
1472 // Give plugins a chance to filter out...
1473 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1477 // XXX: pack this data better
1478 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1484 function getSubscribedUsers()
1488 if(common_config('db','quote_identifiers'))
1489 $user_table = '"user"';
1490 else $user_table = 'user';
1494 'FROM '. $user_table .' JOIN subscription '.
1495 'ON '. $user_table .'.id = subscription.subscriber ' .
1496 'WHERE subscription.subscribed = %d ';
1498 $user->query(sprintf($qry, $this->profile_id));
1502 while ($user->fetch()) {
1511 function getProfileTags()
1513 $profile = $this->getProfile();
1514 $list = $profile->getOtherTags($profile);
1517 while($list->fetch()) {
1518 $ptags[] = clone($list);
1524 public function getAttentionsFromProfileTags()
1527 $ptags = $this->getProfileTags();
1528 foreach ($ptags as $ptag) {
1529 $users = $ptag->getUserSubscribers();
1530 foreach ($users as $id) {
1531 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1538 * Record this notice to the given group inboxes for delivery.
1539 * Overrides the regular parsing of !group markup.
1541 * @param string $group_ids
1542 * @fixme might prefer URIs as identifiers, as for replies?
1543 * best with generalizations on user_group to support
1544 * remote groups better.
1546 function saveKnownGroups(array $group_ids)
1549 foreach (array_unique($group_ids) as $id) {
1550 $group = User_group::getKV('id', $id);
1551 if ($group instanceof User_group) {
1552 common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
1553 $result = $this->addToGroupInbox($group);
1555 common_log_db_error($gi, 'INSERT', __FILE__);
1558 if (common_config('group', 'addtag')) {
1559 // we automatically add a tag for every group name, too
1561 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1562 'notice_id' => $this->id));
1564 if (is_null($tag)) {
1565 $this->saveTag($group->nickname);
1569 $groups[] = clone($group);
1571 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1578 function addToGroupInbox(User_group $group)
1580 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1581 'notice_id' => $this->id));
1583 if (!$gi instanceof Group_inbox) {
1585 $gi = new Group_inbox();
1587 $gi->group_id = $group->id;
1588 $gi->notice_id = $this->id;
1589 $gi->created = $this->created;
1591 $result = $gi->insert();
1594 common_log_db_error($gi, 'INSERT', __FILE__);
1595 // TRANS: Server exception thrown when an update for a group inbox fails.
1596 throw new ServerException(_('Problem saving group inbox.'));
1599 self::blow('user_group:notice_ids:%d', $gi->group_id);
1605 function saveAttentions(array $uris)
1607 foreach ($uris as $uri=>$type) {
1609 $target = Profile::fromUri($uri);
1610 } catch (UnknownUriException $e) {
1611 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1616 $this->saveAttention($target);
1617 } catch (AlreadyFulfilledException $e) {
1618 common_debug('Attention already exists: '.var_export($e->getMessage(),true));
1619 } catch (Exception $e) {
1620 common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
1626 * Saves an attention for a profile (user or group) which means
1627 * it shows up in their home feed and such.
1629 function saveAttention(Profile $target, $reason=null)
1631 if ($target->isGroup()) {
1632 // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
1634 // legacy notification method, will still be in use for quite a while I think
1635 $this->addToGroupInbox($target->getGroup());
1637 if ($target->hasBlocked($this->getProfile())) {
1638 common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
1643 if ($target->isLocal()) {
1644 // legacy notification method, will still be in use for quite a while I think
1645 $this->saveReply($target->getID());
1648 $att = Attention::saveNew($this, $target, $reason);
1650 self::blow('reply:stream:%d', $target->getID());
1655 * Save reply records indicating that this notice needs to be
1656 * delivered to the local users with the given URIs.
1658 * Since this is expected to be used when saving foreign-sourced
1659 * messages, we won't deliver to any remote targets as that's the
1660 * source service's responsibility.
1662 * Mail notifications etc will be handled later.
1664 * @param array $uris Array of unique identifier URIs for recipients
1666 function saveKnownReplies(array $uris)
1672 $sender = $this->getProfile();
1674 foreach (array_unique($uris) as $uri) {
1676 $profile = Profile::fromUri($uri);
1677 } catch (UnknownUriException $e) {
1678 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1682 if ($profile->hasBlocked($sender)) {
1683 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1687 $this->saveReply($profile->getID());
1688 self::blow('reply:stream:%d', $profile->getID());
1693 * Pull @-replies from this message's content in StatusNet markup format
1694 * and save reply records indicating that this message needs to be
1695 * delivered to those users.
1697 * Mail notifications to local profiles will be sent later.
1699 * @return array of integer profile IDs
1702 function saveReplies()
1704 $sender = $this->getProfile();
1708 // If it's a reply, save for the replied-to author
1710 $parent = $this->getParent();
1711 $parentauthor = $parent->getProfile();
1712 $this->saveReply($parentauthor->getID());
1713 $replied[$parentauthor->getID()] = 1;
1714 self::blow('reply:stream:%d', $parentauthor->getID());
1715 } catch (NoParentNoticeException $e) {
1716 // Not a reply, since it has no parent!
1718 } catch (NoResultException $e) {
1719 // Parent notice was probably deleted
1723 // @todo ideally this parser information would only
1724 // be calculated once.
1726 $mentions = common_find_mentions($this->content, $sender, $parent);
1728 foreach ($mentions as $mention) {
1730 foreach ($mention['mentioned'] as $mentioned) {
1732 // skip if they're already covered
1733 if (array_key_exists($mentioned->id, $replied)) {
1737 // Don't save replies from blocked profile to local user
1738 if ($mentioned->hasBlocked($sender)) {
1742 $this->saveReply($mentioned->id);
1743 $replied[$mentioned->id] = 1;
1744 self::blow('reply:stream:%d', $mentioned->id);
1748 $recipientIds = array_keys($replied);
1750 return $recipientIds;
1753 function saveReply($profileId)
1755 $reply = new Reply();
1757 $reply->notice_id = $this->id;
1758 $reply->profile_id = $profileId;
1759 $reply->modified = $this->created;
1766 protected $_attentionids = array();
1769 * Pull the complete list of known activity context attentions for this notice.
1771 * @return array of integer profile ids (also group profiles)
1773 function getAttentionProfileIDs()
1775 if (!isset($this->_attentionids[$this->getID()])) {
1776 $atts = Attention::multiGet('notice_id', array($this->getID()));
1777 // (array)null means empty array
1778 $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
1780 return $this->_attentionids[$this->getID()];
1783 protected $_replies = array();
1786 * Pull the complete list of @-mentioned profile IDs for this notice.
1788 * @return array of integer profile ids
1790 function getReplies()
1792 if (!isset($this->_replies[$this->getID()])) {
1793 $mentions = Reply::multiGet('notice_id', array($this->getID()));
1794 $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
1796 return $this->_replies[$this->getID()];
1799 function _setReplies($replies)
1801 $this->_replies[$this->getID()] = $replies;
1805 * Pull the complete list of @-reply targets for this notice.
1807 * @return array of Profiles
1809 function getAttentionProfiles()
1811 $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
1813 $profiles = Profile::multiGet('id', (array)$ids);
1815 return $profiles->fetchAll();
1819 * Send e-mail notifications to local @-reply targets.
1821 * Replies must already have been saved; this is expected to be run
1822 * from the distrib queue handler.
1824 function sendReplyNotifications()
1826 // Don't send reply notifications for repeats
1827 if ($this->isRepeat()) {
1831 $recipientIds = $this->getReplies();
1832 if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
1833 require_once INSTALLDIR.'/lib/mail.php';
1835 foreach ($recipientIds as $recipientId) {
1837 $user = User::getByID($recipientId);
1838 mail_notify_attn($user, $this);
1839 } catch (NoResultException $e) {
1843 Event::handle('EndNotifyMentioned', array($this, $recipientIds));
1848 * Pull list of Profile IDs of groups this notice addresses.
1850 * @return array of Group _profile_ IDs
1853 function getGroupProfileIDs()
1857 foreach ($this->getGroups() as $group) {
1858 $ids[] = $group->profile_id;
1865 * Pull list of groups this notice needs to be delivered to,
1866 * as previously recorded by saveKnownGroups().
1868 * @return array of Group objects
1871 protected $_groups = array();
1873 function getGroups()
1875 // Don't save groups for repeats
1877 if (!empty($this->repeat_of)) {
1881 if (isset($this->_groups[$this->id])) {
1882 return $this->_groups[$this->id];
1885 $gis = Group_inbox::listGet('notice_id', array($this->id));
1889 foreach ($gis[$this->id] as $gi) {
1890 $ids[] = $gi->group_id;
1893 $groups = User_group::multiGet('id', $ids);
1894 $this->_groups[$this->id] = $groups->fetchAll();
1895 return $this->_groups[$this->id];
1898 function _setGroups($groups)
1900 $this->_groups[$this->id] = $groups;
1904 * Convert a notice into an activity for export.
1906 * @param Profile $scoped The currently logged in/scoped profile
1908 * @return Activity activity object representing this Notice.
1911 function asActivity(Profile $scoped=null)
1913 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1915 if ($act instanceof Activity) {
1918 $act = new Activity();
1920 if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
1922 $act->id = $this->uri;
1923 $act->time = strtotime($this->created);
1925 $act->link = $this->getUrl();
1926 } catch (InvalidUrlException $e) {
1927 // The notice is probably a share or similar, which don't
1928 // have a representational URL of their own.
1930 $act->content = common_xml_safe_str($this->getRendered());
1932 $profile = $this->getProfile();
1934 $act->actor = $profile->asActivityObject();
1935 $act->actor->extra[] = $profile->profileInfo($scoped);
1937 $act->verb = $this->verb;
1939 if (!$this->repeat_of) {
1940 $act->objects[] = $this->asActivityObject();
1943 // XXX: should this be handled by default processing for object entry?
1947 $tags = $this->getTags();
1949 foreach ($tags as $tag) {
1950 $cat = new AtomCategory();
1953 $act->categories[] = $cat;
1957 // XXX: use Atom Media and/or File activity objects instead
1959 $attachments = $this->attachments();
1961 foreach ($attachments as $attachment) {
1962 // Include local attachments in Activity
1963 if (!empty($attachment->filename)) {
1964 $act->enclosures[] = $attachment->getEnclosure();
1968 $ctx = new ActivityContext();
1971 $reply = $this->getParent();
1972 $ctx->replyToID = $reply->getUri();
1973 $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
1974 } catch (NoParentNoticeException $e) {
1975 // This is not a reply to something
1976 } catch (NoResultException $e) {
1977 // Parent notice was probably deleted
1981 $ctx->location = Notice_location::locFromStored($this);
1982 } catch (ServerException $e) {
1983 $ctx->location = null;
1988 if (!empty($this->conversation)) {
1989 $conv = Conversation::getKV('id', $this->conversation);
1990 if ($conv instanceof Conversation) {
1991 $ctx->conversation = $conv->uri;
1995 // This covers the legacy getReplies and getGroups too which get their data
1996 // from entries stored via Notice::saveNew (which we want to move away from)...
1997 foreach ($this->getAttentionProfiles() as $target) {
1998 // User and group profiles which get the attention of this notice
1999 $ctx->attention[$target->getUri()] = $target->getObjectType();
2002 switch ($this->scope) {
2003 case Notice::PUBLIC_SCOPE:
2004 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
2006 case Notice::FOLLOWER_SCOPE:
2007 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
2008 $ctx->attention[$surl] = ActivityObject::COLLECTION;
2012 $act->context = $ctx;
2014 $source = $this->getSource();
2016 if ($source instanceof Notice_source) {
2017 $act->generator = ActivityObject::fromNoticeSource($source);
2022 $atom_feed = $profile->getAtomFeed();
2024 if (!empty($atom_feed)) {
2026 $act->source = new ActivitySource();
2028 // XXX: we should store the actual feed ID
2030 $act->source->id = $atom_feed;
2032 // XXX: we should store the actual feed title
2034 $act->source->title = $profile->getBestName();
2036 $act->source->links['alternate'] = $profile->profileurl;
2037 $act->source->links['self'] = $atom_feed;
2039 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
2041 $notice = $profile->getCurrentNotice();
2043 if ($notice instanceof Notice) {
2044 $act->source->updated = self::utcDate($notice->created);
2047 $user = User::getKV('id', $profile->id);
2049 if ($user instanceof User) {
2050 $act->source->links['license'] = common_config('license', 'url');
2054 if ($this->isLocal()) {
2055 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
2056 'format' => 'atom'));
2057 $act->editLink = $act->selfLink;
2060 Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
2063 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
2068 // This has gotten way too long. Needs to be sliced up into functional bits
2069 // or ideally exported to a utility class.
2071 function asAtomEntry($namespace=false,
2074 Profile $scoped=null)
2076 $act = $this->asActivity($scoped);
2077 $act->extra[] = $this->noticeInfo($scoped);
2078 return $act->asString($namespace, $author, $source);
2082 * Extra notice info for atom entries
2084 * Clients use some extra notice info in the atom stream.
2085 * This gives it to them.
2087 * @param Profile $scoped The currently logged in/scoped profile
2089 * @return array representation of <statusnet:notice_info> element
2092 function noticeInfo(Profile $scoped=null)
2094 // local notice ID (useful to clients for ordering)
2096 $noticeInfoAttr = array('local_id' => $this->id);
2100 $ns = $this->getSource();
2102 if ($ns instanceof Notice_source) {
2103 $noticeInfoAttr['source'] = $ns->code;
2104 if (!empty($ns->url)) {
2105 $noticeInfoAttr['source_link'] = $ns->url;
2106 if (!empty($ns->name)) {
2107 $noticeInfoAttr['source'] = '<a href="'
2108 . htmlspecialchars($ns->url)
2109 . '" rel="nofollow">'
2110 . htmlspecialchars($ns->name)
2116 // favorite and repeated
2118 if ($scoped instanceof Profile) {
2119 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
2122 if (!empty($this->repeat_of)) {
2123 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
2126 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
2128 return array('statusnet:notice_info', $noticeInfoAttr, null);
2132 * Returns an XML string fragment with a reference to a notice as an
2133 * Activity Streams noun object with the given element type.
2135 * Assumes that 'activity' namespace has been previously defined.
2137 * @param string $element one of 'subject', 'object', 'target'
2141 function asActivityNoun($element)
2143 $noun = $this->asActivityObject();
2144 return $noun->asString('activity:' . $element);
2147 public function asActivityObject()
2149 $object = new ActivityObject();
2151 if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
2152 $object->type = $this->object_type ?: ActivityObject::NOTE;
2153 $object->id = $this->getUri();
2154 //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
2155 $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
2156 $object->content = $this->getRendered();
2157 $object->link = $this->getUrl();
2159 $object->extra[] = array('status_net', array('notice_id' => $this->id));
2161 Event::handle('EndActivityObjectFromNotice', array($this, &$object));
2164 if (!$object instanceof ActivityObject) {
2165 common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
2166 throw new ServerException('Notice asActivityObject created something else.');
2173 * Determine which notice, if any, a new notice is in reply to.
2175 * For conversation tracking, we try to see where this notice fits
2176 * in the tree. Beware that this may very well give false positives
2177 * and add replies to wrong threads (if there have been newer posts
2178 * by the same user as we're replying to).
2180 * @param Profile $sender Author profile
2181 * @param string $content Final notice content
2183 * @return integer ID of replied-to notice, or null for not a reply.
2186 static function getInlineReplyTo(Profile $sender, $content)
2188 // Is there an initial @ or T?
2189 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2190 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2191 $nickname = common_canonical_nickname($match[1]);
2196 // Figure out who that is.
2197 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2199 if ($recipient instanceof Profile) {
2200 // Get their last notice
2201 $last = $recipient->getCurrentNotice();
2202 if ($last instanceof Notice) {
2205 // Maybe in the future we want to handle something else below
2206 // so don't return getCurrentNotice() immediately.
2212 static function maxContent()
2214 $contentlimit = common_config('notice', 'contentlimit');
2215 // null => use global limit (distinct from 0!)
2216 if (is_null($contentlimit)) {
2217 $contentlimit = common_config('site', 'textlimit');
2219 return $contentlimit;
2222 static function contentTooLong($content)
2224 $contentlimit = self::maxContent();
2225 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2229 * Convenience function for posting a repeat of an existing message.
2231 * @param Profile $repeater Profile which is doing the repeat
2232 * @param string $source: posting source key, eg 'web', 'api', etc
2235 * @throws Exception on failure or permission problems
2237 function repeat(Profile $repeater, $source)
2239 $author = $this->getProfile();
2241 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2242 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2243 $content = sprintf(_('RT @%1$s %2$s'),
2244 $author->getNickname(),
2247 $maxlen = self::maxContent();
2248 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
2249 // Web interface and current Twitter API clients will
2250 // pull the original notice's text, but some older
2251 // clients and RSS/Atom feeds will see this trimmed text.
2253 // Unfortunately this is likely to lose tags or URLs
2254 // at the end of long notices.
2255 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
2259 // Scope is same as this one's
2260 return self::saveNew($repeater->id,
2263 array('repeat_of' => $this->id,
2264 'scope' => $this->scope));
2267 // These are supposed to be in chron order!
2269 function repeatStream($limit=100)
2271 $cache = Cache::instance();
2273 if (empty($cache)) {
2274 $ids = $this->_repeatStreamDirect($limit);
2276 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2277 if ($idstr !== false) {
2278 if (empty($idstr)) {
2281 $ids = explode(',', $idstr);
2284 $ids = $this->_repeatStreamDirect(100);
2285 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2288 // We do a max of 100, so slice down to limit
2289 $ids = array_slice($ids, 0, $limit);
2293 return NoticeStream::getStreamByIds($ids);
2296 function _repeatStreamDirect($limit)
2298 $notice = new Notice();
2300 $notice->selectAdd(); // clears it
2301 $notice->selectAdd('id');
2303 $notice->repeat_of = $this->id;
2305 $notice->orderBy('created, id'); // NB: asc!
2307 if (!is_null($limit)) {
2308 $notice->limit(0, $limit);
2311 return $notice->fetchAll('id');
2314 static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2318 if (!empty($location_id) && !empty($location_ns)) {
2319 $options['location_id'] = $location_id;
2320 $options['location_ns'] = $location_ns;
2322 $location = Location::fromId($location_id, $location_ns);
2324 if ($location instanceof Location) {
2325 $options['lat'] = $location->lat;
2326 $options['lon'] = $location->lon;
2329 } else if (!empty($lat) && !empty($lon)) {
2330 $options['lat'] = $lat;
2331 $options['lon'] = $lon;
2333 $location = Location::fromLatLon($lat, $lon);
2335 if ($location instanceof Location) {
2336 $options['location_id'] = $location->location_id;
2337 $options['location_ns'] = $location->location_ns;
2339 } else if (!empty($profile)) {
2340 if (isset($profile->lat) && isset($profile->lon)) {
2341 $options['lat'] = $profile->lat;
2342 $options['lon'] = $profile->lon;
2345 if (isset($profile->location_id) && isset($profile->location_ns)) {
2346 $options['location_id'] = $profile->location_id;
2347 $options['location_ns'] = $profile->location_ns;
2354 function clearAttentions()
2356 $att = new Attention();
2357 $att->notice_id = $this->getID();
2360 while ($att->fetch()) {
2361 // Can't do delete() on the object directly since it won't remove all of it
2362 $other = clone($att);
2368 function clearReplies()
2370 $replyNotice = new Notice();
2371 $replyNotice->reply_to = $this->id;
2373 //Null any notices that are replies to this notice
2375 if ($replyNotice->find()) {
2376 while ($replyNotice->fetch()) {
2377 $orig = clone($replyNotice);
2378 $replyNotice->reply_to = null;
2379 $replyNotice->update($orig);
2385 $reply = new Reply();
2386 $reply->notice_id = $this->id;
2388 if ($reply->find()) {
2389 while($reply->fetch()) {
2390 self::blow('reply:stream:%d', $reply->profile_id);
2398 function clearLocation()
2400 $loc = new Notice_location();
2401 $loc->notice_id = $this->id;
2408 function clearFiles()
2410 $f2p = new File_to_post();
2412 $f2p->post_id = $this->id;
2415 while ($f2p->fetch()) {
2419 // FIXME: decide whether to delete File objects
2420 // ...and related (actual) files
2423 function clearRepeats()
2425 $repeatNotice = new Notice();
2426 $repeatNotice->repeat_of = $this->id;
2428 //Null any notices that are repeats of this notice
2430 if ($repeatNotice->find()) {
2431 while ($repeatNotice->fetch()) {
2432 $orig = clone($repeatNotice);
2433 $repeatNotice->repeat_of = null;
2434 $repeatNotice->update($orig);
2439 function clearTags()
2441 $tag = new Notice_tag();
2442 $tag->notice_id = $this->id;
2445 while ($tag->fetch()) {
2446 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2447 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2448 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2449 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2457 function clearGroupInboxes()
2459 $gi = new Group_inbox();
2461 $gi->notice_id = $this->id;
2464 while ($gi->fetch()) {
2465 self::blow('user_group:notice_ids:%d', $gi->group_id);
2473 function distribute()
2475 // We always insert for the author so they don't
2477 Event::handle('StartNoticeDistribute', array($this));
2479 // If there's a failure, we want to _force_
2480 // distribution at this point.
2482 $json = json_encode((object)array('id' => $this->getID(),
2485 $qm = QueueManager::get();
2486 $qm->enqueue($json, 'distrib');
2487 } catch (Exception $e) {
2488 // If the exception isn't transient, this
2489 // may throw more exceptions as DQH does
2490 // its own enqueueing. So, we ignore them!
2492 $handler = new DistribQueueHandler();
2493 $handler->handle($this);
2494 } catch (Exception $e) {
2495 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2497 // Re-throw so somebody smarter can handle it.
2504 $result = parent::insert();
2506 if ($result === false) {
2507 common_log_db_error($this, 'INSERT', __FILE__);
2508 // TRANS: Server exception thrown when a stored object entry cannot be saved.
2509 throw new ServerException('Could not save Notice');
2512 // Profile::hasRepeated() abuses pkeyGet(), so we
2513 // have to clear manually
2514 if (!empty($this->repeat_of)) {
2515 $c = self::memcache();
2517 $ck = self::multicacheKey('Notice',
2518 array('profile_id' => $this->profile_id,
2519 'repeat_of' => $this->repeat_of));
2524 // Update possibly ID-dependent columns: URI, conversation
2525 // (now that INSERT has added the notice's local id)
2526 $orig = clone($this);
2529 // We can only get here if it's a local notice, since remote notices
2530 // should've bailed out earlier due to lacking a URI.
2531 if (empty($this->uri)) {
2532 $this->uri = sprintf('%s%s=%d:%s=%s',
2534 'noticeId', $this->id,
2535 'objectType', $this->getObjectType(true));
2539 if ($changed && $this->update($orig) === false) {
2540 common_log_db_error($notice, 'UPDATE', __FILE__);
2541 // TRANS: Server exception thrown when a notice cannot be updated.
2542 throw new ServerException(_('Problem saving notice.'));
2545 $this->blowOnInsert();
2551 * Get the source of the notice
2553 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2554 * guaranteed to be populated.
2556 function getSource()
2558 if (empty($this->source)) {
2562 $ns = new Notice_source();
2563 switch ($this->source) {
2570 $ns->code = $this->source;
2573 $ns = Notice_source::getKV($this->source);
2575 $ns = new Notice_source();
2576 $ns->code = $this->source;
2577 $app = Oauth_application::getKV('name', $this->source);
2579 $ns->name = $app->name;
2580 $ns->url = $app->source_url;
2590 * Determine whether the notice was locally created
2592 * @return boolean locality
2595 public function isLocal()
2597 $is_local = intval($this->is_local);
2598 return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
2601 public function getScope()
2603 return intval($this->scope);
2606 public function isRepeat()
2608 return !empty($this->repeat_of);
2612 * Get the list of hash tags saved with this notice.
2614 * @return array of strings
2616 public function getTags()
2620 $keypart = sprintf('notice:tags:%d', $this->id);
2622 $tagstr = self::cacheGet($keypart);
2624 if ($tagstr !== false) {
2625 $tags = explode(',', $tagstr);
2627 $tag = new Notice_tag();
2628 $tag->notice_id = $this->id;
2630 while ($tag->fetch()) {
2631 $tags[] = $tag->tag;
2634 self::cacheSet($keypart, implode(',', $tags));
2640 static private function utcDate($dt)
2642 $dateStr = date('d F Y H:i:s', strtotime($dt));
2643 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2644 return $d->format(DATE_W3C);
2648 * Look up the creation timestamp for a given notice ID, even
2649 * if it's been deleted.
2652 * @return mixed string recorded creation timestamp, or false if can't be found
2654 public static function getAsTimestamp($id)
2657 throw new EmptyIdException('Notice');
2661 if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
2662 // getByID throws exception if $id isn't found
2663 $notice = Notice::getByID($id);
2664 $timestamp = $notice->created;
2667 if (empty($timestamp)) {
2668 throw new ServerException('No timestamp found for Notice with id=='._ve($id));
2674 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2675 * parameter, matching notices posted after the given one (exclusive).
2677 * If the referenced notice can't be found, will return false.
2680 * @param string $idField
2681 * @param string $createdField
2682 * @return mixed string or false if no match
2684 public static function whereSinceId($id, $idField='id', $createdField='created')
2687 $since = Notice::getAsTimestamp($id);
2688 } catch (Exception $e) {
2691 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2695 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2696 * parameter, matching notices posted after the given one (exclusive), and
2697 * if necessary add it to the data object's query.
2699 * @param DB_DataObject $obj
2701 * @param string $idField
2702 * @param string $createdField
2703 * @return mixed string or false if no match
2705 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2707 $since = self::whereSinceId($id, $idField, $createdField);
2709 $obj->whereAdd($since);
2714 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2715 * parameter, matching notices posted before the given one (inclusive).
2717 * If the referenced notice can't be found, will return false.
2720 * @param string $idField
2721 * @param string $createdField
2722 * @return mixed string or false if no match
2724 public static function whereMaxId($id, $idField='id', $createdField='created')
2727 $max = Notice::getAsTimestamp($id);
2728 } catch (Exception $e) {
2731 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2735 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2736 * parameter, matching notices posted before the given one (inclusive), and
2737 * if necessary add it to the data object's query.
2739 * @param DB_DataObject $obj
2741 * @param string $idField
2742 * @param string $createdField
2743 * @return mixed string or false if no match
2745 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2747 $max = self::whereMaxId($id, $idField, $createdField);
2749 $obj->whereAdd($max);
2755 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2756 ($this->is_local != Notice::GATEWAY));
2760 * Check that the given profile is allowed to read, respond to, or otherwise
2761 * act on this notice.
2763 * The $scope member is a bitmask of scopes, representing a logical AND of the
2764 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2765 * "only visible to people who are mentioned in the notice AND are users on this site."
2766 * Users on the site who are not mentioned in the notice will not be able to see the
2769 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2771 * @return boolean whether the profile is in the notice's scope
2773 function inScope($profile)
2775 if (is_null($profile)) {
2776 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2778 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2781 $result = self::cacheGet($keypart);
2783 if ($result === false) {
2785 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2786 $bResult = $this->_inScope($profile);
2787 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2789 $result = ($bResult) ? 1 : 0;
2790 self::cacheSet($keypart, $result, 0, 300);
2793 return ($result == 1) ? true : false;
2796 protected function _inScope($profile)
2798 $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
2800 if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
2801 return !$this->isHiddenSpam($profile);
2804 // If there's scope, anon cannot be in scope
2805 if (empty($profile)) {
2809 // Author is always in scope
2810 if ($this->profile_id == $profile->id) {
2814 // Only for users on this site
2815 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2819 // Only for users mentioned in the notice
2820 if ($scope & Notice::ADDRESSEE_SCOPE) {
2822 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2823 'profile_id' => $profile->id));
2825 if (!$reply instanceof Reply) {
2830 // Only for members of the given group
2831 if ($scope & Notice::GROUP_SCOPE) {
2833 // XXX: just query for the single membership
2835 $groups = $this->getGroups();
2839 foreach ($groups as $group) {
2840 if ($profile->isMember($group)) {
2851 if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
2853 if (!Subscription::exists($profile, $this->getProfile())) {
2858 return !$this->isHiddenSpam($profile);
2861 function isHiddenSpam($profile) {
2863 // Hide posts by silenced users from everyone but moderators.
2865 if (common_config('notice', 'hidespam')) {
2868 $author = $this->getProfile();
2869 } catch(Exception $e) {
2870 // If we can't get an author, keep it hidden.
2871 // XXX: technically not spam, but, whatever.
2875 if ($author->hasRole(Profile_role::SILENCED)) {
2876 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2885 public function hasParent()
2889 } catch (NoParentNoticeException $e) {
2895 public function getParent()
2897 $reply_to_id = null;
2899 if (empty($this->reply_to)) {
2900 throw new NoParentNoticeException($this);
2903 // The reply_to ID in the table Notice could exist with a number
2904 // however, the replied to notice might not exist in the database.
2905 // Thus we need to catch the exception and throw the NoParentNoticeException else
2906 // the timeline will not display correctly.
2908 $reply_to_id = self::getByID($this->reply_to);
2909 } catch(Exception $e){
2910 throw new NoParentNoticeException($this);
2913 return $reply_to_id;
2917 * Magic function called at serialize() time.
2919 * We use this to drop a couple process-specific references
2920 * from DB_DataObject which can cause trouble in future
2923 * @return array of variable names to include in serialization.
2928 $vars = parent::__sleep();
2929 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2930 return array_diff($vars, $skip);
2933 static function defaultScope()
2935 $scope = common_config('notice', 'defaultscope');
2936 if (is_null($scope)) {
2937 if (common_config('site', 'private')) {
2946 static function fillProfiles($notices)
2948 $map = self::getProfiles($notices);
2949 foreach ($notices as $entry=>$notice) {
2951 if (array_key_exists($notice->profile_id, $map)) {
2952 $notice->_setProfile($map[$notice->profile_id]);
2954 } catch (NoProfileException $e) {
2955 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2956 unset($notices[$entry]);
2960 return array_values($map);
2963 static function getProfiles(&$notices)
2966 foreach ($notices as $notice) {
2967 $ids[] = $notice->profile_id;
2969 $ids = array_unique($ids);
2970 return Profile::pivotGet('id', $ids);
2973 static function fillGroups(&$notices)
2975 $ids = self::_idsOf($notices);
2976 $gis = Group_inbox::listGet('notice_id', $ids);
2979 foreach ($gis as $id => $gi) {
2982 $gids[] = $g->group_id;
2986 $gids = array_unique($gids);
2987 $group = User_group::pivotGet('id', $gids);
2988 foreach ($notices as $notice)
2991 $gi = $gis[$notice->id];
2992 foreach ($gi as $g) {
2993 $grps[] = $group[$g->group_id];
2995 $notice->_setGroups($grps);
2999 static function _idsOf(array &$notices)
3002 foreach ($notices as $notice) {
3003 $ids[$notice->id] = true;
3005 return array_keys($ids);
3008 static function fillAttachments(&$notices)
3010 $ids = self::_idsOf($notices);
3011 $f2pMap = File_to_post::listGet('post_id', $ids);
3013 foreach ($f2pMap as $noticeId => $f2ps) {
3014 foreach ($f2ps as $f2p) {
3015 $fileIds[] = $f2p->file_id;
3019 $fileIds = array_unique($fileIds);
3020 $fileMap = File::pivotGet('id', $fileIds);
3021 foreach ($notices as $notice)
3024 $f2ps = $f2pMap[$notice->id];
3025 foreach ($f2ps as $f2p) {
3026 $files[] = $fileMap[$f2p->file_id];
3028 $notice->_setAttachments($files);
3032 static function fillReplies(&$notices)
3034 $ids = self::_idsOf($notices);
3035 $replyMap = Reply::listGet('notice_id', $ids);
3036 foreach ($notices as $notice) {
3037 $replies = $replyMap[$notice->id];
3039 foreach ($replies as $reply) {
3040 $ids[] = $reply->profile_id;
3042 $notice->_setReplies($ids);
3046 static public function beforeSchemaUpdate()
3048 $table = strtolower(get_called_class());
3049 $schema = Schema::get();
3050 $schemadef = $schema->getTableDef($table);
3052 // 2015-09-04 We move Notice location data to Notice_location
3053 // First we see if we have to do this at all
3054 if (!isset($schemadef['fields']['lat'])
3055 && !isset($schemadef['fields']['lon'])
3056 && !isset($schemadef['fields']['location_id'])
3057 && !isset($schemadef['fields']['location_ns'])) {
3058 // We have already removed the location fields, so no need to migrate.
3061 // Then we make sure the Notice_location table is created!
3062 $schema->ensureTable('notice_location', Notice_location::schemaDef());
3064 // Then we continue on our road to migration!
3065 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)";
3067 $notice = new Notice();
3068 $notice->query(sprintf('SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
3069 'WHERE lat IS NOT NULL ' .
3070 'OR lon IS NOT NULL ' .
3071 'OR location_id IS NOT NULL ' .
3072 'OR location_ns IS NOT NULL',
3073 $schema->quoteIdentifier($table)));
3074 print "\nFound {$notice->N} notices with location data, inserting";
3075 while ($notice->fetch()) {
3076 $notloc = Notice_location::getKV('notice_id', $notice->id);
3077 if ($notloc instanceof Notice_location) {
3081 $notloc = new Notice_location();
3082 $notloc->notice_id = $notice->id;
3083 $notloc->lat= $notice->lat;
3084 $notloc->lon= $notice->lon;
3085 $notloc->location_id= $notice->location_id;
3086 $notloc->location_ns= $notice->location_ns;