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(255) unique_key
59 public $content; // text
60 public $rendered; // text
61 public $url; // varchar(255)
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 $lat; // decimal(10,7)
69 public $lon; // decimal(10,7)
70 public $location_id; // int(4)
71 public $location_ns; // int(4)
72 public $repeat_of; // int(4)
73 public $verb; // varchar(255)
74 public $object_type; // varchar(255)
75 public $scope; // int(4)
77 /* the code above is auto generated do not remove the tag below */
80 public static function schemaDef()
84 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
85 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
86 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'),
87 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8_general_ci'),
88 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
89 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
90 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
91 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
92 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
93 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
94 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
95 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'),
96 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'),
97 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'),
98 'location_id' => array('type' => 'int', 'description' => 'location id if possible'),
99 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'),
100 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
101 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'),
102 'verb' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
103 'scope' => array('type' => 'int',
104 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'),
106 'primary key' => array('id'),
107 'unique keys' => array(
108 'notice_uri_key' => array('uri'),
110 'foreign keys' => array(
111 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
112 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
113 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
114 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
117 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'),
118 'notice_profile_id_idx' => array('profile_id', 'created', 'id'),
119 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
120 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
121 'notice_replyto_idx' => array('reply_to')
125 if (common_config('search', 'type') == 'fulltext') {
126 $def['fulltext indexes'] = array('content' => array('content'));
133 const LOCAL_PUBLIC = 1;
135 const LOCAL_NONPUBLIC = -1;
138 const PUBLIC_SCOPE = 0; // Useful fake constant
139 const SITE_SCOPE = 1;
140 const ADDRESSEE_SCOPE = 2;
141 const GROUP_SCOPE = 4;
142 const FOLLOWER_SCOPE = 8;
144 protected $_profile = array();
147 * Will always return a profile, if anything fails it will
148 * (through _setProfile) throw a NoProfileException.
150 public function getProfile()
152 if (!isset($this->_profile[$this->profile_id])) {
153 $this->_setProfile(Profile::getKV('id', $this->profile_id));
155 return $this->_profile[$this->profile_id];
158 public function _setProfile(Profile $profile=null)
160 if (!$profile instanceof Profile) {
161 throw new NoProfileException($this->profile_id);
163 $this->_profile[$this->profile_id] = $profile;
166 function delete($useWhere=false)
168 // For auditing purposes, save a record that the notice
171 // @fixme we have some cases where things get re-run and so the
173 $deleted = Deleted_notice::getKV('id', $this->id);
175 if (!$deleted instanceof Deleted_notice) {
176 $deleted = Deleted_notice::getKV('uri', $this->uri);
179 if (!$deleted instanceof Deleted_notice) {
180 $deleted = new Deleted_notice();
182 $deleted->id = $this->id;
183 $deleted->profile_id = $this->profile_id;
184 $deleted->uri = $this->uri;
185 $deleted->created = $this->created;
186 $deleted->deleted = common_sql_now();
191 if (Event::handle('NoticeDeleteRelated', array($this))) {
193 // Clear related records
195 $this->clearReplies();
196 $this->clearRepeats();
198 $this->clearGroupInboxes();
200 $this->clearAttentions();
202 // NOTE: we don't clear queue items
205 $result = parent::delete($useWhere);
207 $this->blowOnDelete();
211 public function getUri()
217 * Get a Notice object by URI. Will call external plugins for help
218 * using the event StartGetNoticeFromURI.
220 * @param string $uri A unique identifier for a resource (notice in this case)
222 static function fromUri($uri)
226 if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
227 $notice = Notice::getKV('uri', $uri);
228 Event::handle('EndGetNoticeFromUri', array($uri, $notice));
231 if (!$notice instanceof Notice) {
232 throw new UnknownUriException($uri);
239 * @param $root boolean If true, link to just the conversation root.
241 * @return URL to conversation
243 public function getConversationUrl($anchor=true)
245 return Conversation::getUrlFromNotice($this, $anchor);
249 * Get the local representation URL of this notice.
251 public function getLocalUrl()
253 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
256 public function getTitle()
259 if (Event::handle('GetNoticeTitle', array($this, &$title))) {
260 // TRANS: Title of a notice posted without a title value.
261 // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
262 $title = sprintf(_('%1$s\'s status on %2$s'),
263 $this->getProfile()->getFancyName(),
264 common_exact_date($this->created));
270 * Get the original representation URL of this notice.
272 public function getUrl()
274 // The risk is we start having empty urls and non-http uris...
275 // and we can't really handle any other protocol right now.
277 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
279 case $this->isLocal():
280 // let's generate a valid link to our locally available notice on demand
281 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
282 case common_valid_http_url($this->uri):
285 common_debug('No URL available for notice: id='.$this->id);
286 throw new InvalidUrlException($this->url);
290 public function get_object_type($canonical=false) {
292 ? ActivityObject::canonicalType($this->object_type)
293 : $this->object_type;
296 public static function getByUri($uri)
298 $notice = new Notice();
300 if (!$notice->find(true)) {
301 throw new NoResultException($notice);
307 * Extract #hashtags from this notice's content and save them to the database.
311 /* extract all #hastags */
312 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
317 /* Add them to the database */
318 return $this->saveKnownTags($match[1]);
322 * Record the given set of hash tags in the db for this notice.
323 * Given tag strings will be normalized and checked for dupes.
325 function saveKnownTags($hashtags)
327 //turn each into their canonical tag
328 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
329 for($i=0; $i<count($hashtags); $i++) {
330 /* elide characters we don't want in the tag */
331 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
334 foreach(array_unique($hashtags) as $hashtag) {
335 $this->saveTag($hashtag);
336 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
342 * Record a single hash tag as associated with this notice.
343 * Tag format and uniqueness must be validated by caller.
345 function saveTag($hashtag)
347 $tag = new Notice_tag();
348 $tag->notice_id = $this->id;
349 $tag->tag = $hashtag;
350 $tag->created = $this->created;
351 $id = $tag->insert();
354 // TRANS: Server exception. %s are the error details.
355 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
356 $last_error->message));
360 // if it's saved, blow its cache
361 $tag->blowCache(false);
365 * Save a new notice and push it out to subscribers' inboxes.
366 * Poster's permissions are checked before sending.
368 * @param int $profile_id Profile ID of the poster
369 * @param string $content source message text; links may be shortened
370 * per current user's preference
371 * @param string $source source key ('web', 'api', etc)
372 * @param array $options Associative array of optional properties:
373 * string 'created' timestamp of notice; defaults to now
374 * int 'is_local' source/gateway ID, one of:
375 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
376 * Notice::REMOTE - Sent from a remote service;
377 * hide from public timeline but show in
378 * local "and friends" timelines
379 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
380 * Notice::GATEWAY - From another non-OStatus service;
381 * will not appear in public views
382 * float 'lat' decimal latitude for geolocation
383 * float 'lon' decimal longitude for geolocation
384 * int 'location_id' geoname identifier
385 * int 'location_ns' geoname namespace to interpret location_id
386 * int 'reply_to'; notice ID this is a reply to
387 * int 'repeat_of'; notice ID this is a repeat of
388 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
389 * string 'url' permalink to notice; defaults to local notice URL
390 * string 'rendered' rendered HTML version of content
391 * array 'replies' list of profile URIs for reply delivery in
392 * place of extracting @-replies from content.
393 * array 'groups' list of group IDs to deliver to, in place of
394 * extracting ! tags from content
395 * array 'tags' list of hashtag strings to save with the notice
396 * in place of extracting # tags from content
397 * array 'urls' list of attached/referred URLs to save with the
398 * notice in place of extracting links from content
399 * boolean 'distribute' whether to distribute the notice, default true
400 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
401 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
402 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
404 * @fixme tag override
407 * @throws ClientException
409 static function saveNew($profile_id, $content, $source, array $options=null) {
410 $defaults = array('uri' => null,
415 'distribute' => true,
416 'object_type' => null,
419 if (!empty($options) && is_array($options)) {
420 $options = array_merge($defaults, $options);
426 if (!isset($is_local)) {
427 $is_local = Notice::LOCAL_PUBLIC;
430 $profile = Profile::getKV('id', $profile_id);
431 if (!$profile instanceof Profile) {
432 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
433 throw new ClientException(_('Problem saving notice. Unknown user.'));
436 $user = User::getKV('id', $profile_id);
437 if ($user instanceof User) {
438 // Use the local user's shortening preferences, if applicable.
439 $final = $user->shortenLinks($content);
441 $final = common_shorten_links($content);
444 if (Notice::contentTooLong($final)) {
445 // TRANS: Client exception thrown if a notice contains too many characters.
446 throw new ClientException(_('Problem saving notice. Too long.'));
449 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
450 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
451 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
452 throw new ClientException(_('Too many notices too fast; take a breather '.
453 'and post again in a few minutes.'));
456 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
457 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
458 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
459 throw new ClientException(_('Too many duplicate messages too quickly;'.
460 ' take a breather and post again in a few minutes.'));
463 if (!$profile->hasRight(Right::NEWNOTICE)) {
464 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
466 // TRANS: Client exception thrown when a user tries to post while being banned.
467 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
470 $notice = new Notice();
471 $notice->profile_id = $profile_id;
473 $autosource = common_config('public', 'autosource');
475 // Sandboxed are non-false, but not 1, either
477 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
478 ($source && $autosource && in_array($source, $autosource))) {
479 $notice->is_local = Notice::LOCAL_NONPUBLIC;
481 $notice->is_local = $is_local;
484 if (!empty($created)) {
485 $notice->created = $created;
487 $notice->created = common_sql_now();
490 if (!$notice->isLocal()) {
491 // Only do these checks for non-local notices. Local notices will generate these values later.
492 if (!common_valid_http_url($url)) {
493 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
496 throw new ServerException('No URI for remote notice. Cannot accept that.');
500 $notice->content = $final;
502 $notice->source = $source;
506 // Get the groups here so we can figure out replies and such
507 if (!isset($groups)) {
508 $groups = User_group::idsFromText($notice->content, $profile);
513 // Handle repeat case
515 if (isset($repeat_of)) {
517 // Check for a private one
519 $repeat = Notice::getKV('id', $repeat_of);
521 if (!($repeat instanceof Notice)) {
522 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
523 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
526 if ($profile->id == $repeat->profile_id) {
527 // TRANS: Client error displayed when trying to repeat an own notice.
528 throw new ClientException(_('You cannot repeat your own notice.'));
531 if ($repeat->scope != Notice::SITE_SCOPE &&
532 $repeat->scope != Notice::PUBLIC_SCOPE) {
533 // TRANS: Client error displayed when trying to repeat a non-public notice.
534 throw new ClientException(_('Cannot repeat a private notice.'), 403);
537 if (!$repeat->inScope($profile)) {
538 // The generic checks above should cover this, but let's be sure!
539 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
540 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
543 if ($profile->hasRepeated($repeat)) {
544 // TRANS: Client error displayed when trying to repeat an already repeated notice.
545 throw new ClientException(_('You already repeated that notice.'));
548 $notice->repeat_of = $repeat->id;
549 $notice->conversation = $repeat->conversation;
553 // If $reply_to is specified, we check that it exists, and then
554 // return it if it does
555 if (!empty($reply_to)) {
556 $reply = Notice::getKV('id', $reply_to);
557 } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
558 // If the source lacks capability of sending the "reply_to"
559 // metadata, let's try to find an inline replyto-reference.
560 $reply = self::getInlineReplyTo($profile, $final);
563 if ($reply instanceof Notice) {
564 if (!$reply->inScope($profile)) {
565 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
566 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
567 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
568 $profile->nickname, $reply->id), 403);
571 // If it's a repeat, the reply_to should be to the original
572 if (!empty($reply->repeat_of)) {
573 $notice->reply_to = $reply->repeat_of;
575 $notice->reply_to = $reply->id;
577 // But the conversation ought to be the same :)
578 $notice->conversation = $reply->conversation;
580 // If the original is private to a group, and notice has
581 // no group specified, make it to the same group(s)
583 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
585 $replyGroups = $reply->getGroups();
586 foreach ($replyGroups as $group) {
587 if ($profile->isMember($group)) {
588 $groups[] = $group->id;
597 if (!empty($lat) && !empty($lon)) {
602 if (!empty($location_ns) && !empty($location_id)) {
603 $notice->location_id = $location_id;
604 $notice->location_ns = $location_ns;
607 if (!empty($rendered)) {
608 $notice->rendered = $rendered;
610 $notice->rendered = common_render_content($final, $notice);
614 if (!empty($notice->repeat_of)) {
615 $notice->verb = ActivityVerb::SHARE;
616 $notice->object_type = ActivityObject::ACTIVITY;
618 $notice->verb = ActivityVerb::POST;
621 $notice->verb = $verb;
624 if (empty($object_type)) {
625 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
627 $notice->object_type = $object_type;
630 if (is_null($scope) && $reply instanceof Notice) {
631 $notice->scope = $reply->scope;
633 $notice->scope = $scope;
636 $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
638 if (Event::handle('StartNoticeSave', array(&$notice))) {
640 // XXX: some of these functions write to the DB
642 $id = $notice->insert();
645 common_log_db_error($notice, 'INSERT', __FILE__);
646 // TRANS: Server exception thrown when a notice cannot be saved.
647 throw new ServerException(_('Problem saving notice.'));
650 // Update ID-dependent columns: URI, conversation
652 $orig = clone($notice);
656 // We can only get here if it's a local notice, since remote notices
657 // should've bailed out earlier due to lacking a URI.
658 if (empty($notice->uri)) {
659 $notice->uri = sprintf('%s%s=%d:%s=%s',
661 'noticeId', $notice->id,
662 'objectType', $notice->get_object_type(true));
666 // If it's not part of a conversation, it's
667 // the beginning of a new conversation.
669 if (empty($notice->conversation)) {
670 $conv = Conversation::create($notice);
671 $notice->conversation = $conv->id;
676 if ($notice->update($orig) === false) {
677 common_log_db_error($notice, 'UPDATE', __FILE__);
678 // TRANS: Server exception thrown when a notice cannot be updated.
679 throw new ServerException(_('Problem saving notice.'));
685 // Clear the cache for subscribed users, so they'll update at next request
686 // XXX: someone clever could prepend instead of clearing the cache
688 $notice->blowOnInsert();
690 // Save per-notice metadata...
692 if (isset($replies)) {
693 $notice->saveKnownReplies($replies);
695 $notice->saveReplies();
699 $notice->saveKnownTags($tags);
704 // Note: groups may save tags, so must be run after tags are saved
705 // to avoid errors on duplicates.
706 // Note: groups should always be set.
708 $notice->saveKnownGroups($groups);
711 $notice->saveKnownUrls($urls);
717 // Prepare inbox delivery, may be queued to background.
718 $notice->distribute();
724 static function saveActivity(Activity $act, Profile $actor, array $options=array())
726 // First check if we're going to let this Activity through from the specific actor
727 if (!$actor->hasRight(Right::NEWNOTICE)) {
728 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
730 // TRANS: Client exception thrown when a user tries to post while being banned.
731 throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
733 if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
734 common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
735 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
736 throw new ClientException(_m('Too many notices too fast; take a breather '.
737 'and post again in a few minutes.'));
740 /* This interferes with stuff like Favorites from old StatusNet installations (first object in objects is the favored notice)
741 // Get ActivityObject properties
742 $actobj = count($act->objects)==1 ? $act->objects[0] : null;
743 if (!is_null($actobj) && $actobj->id) {
744 $options['uri'] = $actobj->id;
746 $options['url'] = $actobj->link;
747 } elseif ($act->link) {
748 $options['url'] = $act->link;
749 } elseif (preg_match('!^https?://!', $actobj->id)) {
750 $options['url'] = $actobj->id;
754 $options['uri'] = $act->id;
755 $options['url'] = $act->link;
761 'is_local' => self::LOCAL_PUBLIC,
762 'mentions' => array(),
766 'source' => 'unknown',
771 'distribute' => true);
773 // options will have default values when nothing has been supplied
774 $options = array_merge($defaults, $options);
775 foreach (array_keys($defaults) as $key) {
776 // Only convert the keynames we specify ourselves from 'defaults' array into variables
777 $$key = $options[$key];
779 extract($options, EXTR_SKIP);
781 $stored = new Notice();
784 if ($stored->find()) {
785 common_debug('cannot create duplicate Notice URI: '.$stored->uri);
786 throw new Exception('Notice URI already exists');
790 $stored->profile_id = $actor->id;
791 $stored->source = $source;
794 $stored->verb = $act->verb;
796 $autosource = common_config('public', 'autosource');
798 // Sandboxed are non-false, but not 1, either
799 if (!$actor->hasRight(Right::PUBLICNOTICE) ||
800 ($source && $autosource && in_array($source, $autosource))) {
801 $stored->is_local = Notice::LOCAL_NONPUBLIC;
804 // Maybe a missing act-time should be fatal if the actor is not local?
805 if (!empty($act->time)) {
806 $stored->created = common_sql_date($act->time);
808 $stored->created = common_sql_now();
812 if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
813 $reply = self::getKV('uri', $act->context->replyToID);
815 if (!$reply instanceof Notice && $act->target instanceof ActivityObject) {
816 $reply = self::getKV('uri', $act->target->id);
819 if ($reply instanceof Notice) {
820 if (!$reply->inScope($actor)) {
821 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
822 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
823 throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
826 $stored->reply_to = $reply->id;
827 $stored->conversation = $reply->conversation;
829 // If the original is private to a group, and notice has no group specified,
830 // make it to the same group(s)
831 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
833 $replyGroups = $reply->getGroups();
834 foreach ($replyGroups as $group) {
835 if ($actor->isMember($group)) {
836 $groups[] = $group->id;
841 if (is_null($scope)) {
842 $scope = $reply->scope;
846 if ($act->context instanceof ActivityContext) {
847 $location = $act->context->location;
849 $stored->lat = $location->lat;
850 $stored->lon = $location->lon;
851 if ($location->location_id) {
852 $stored->location_ns = $location->location_ns;
853 $stored->location_id = $location->location_id;
857 $act->context = new ActivityContext();
860 $stored->scope = self::figureOutScope($actor, $groups, $scope);
862 foreach ($act->categories as $cat) {
864 $term = common_canonical_tag($cat->term);
871 foreach ($act->enclosures as $href) {
872 // @todo FIXME: Save these locally or....?
876 if (Event::handle('StartNoticeSave', array(&$stored))) {
877 // XXX: some of these functions write to the DB
880 $stored->insert(); // throws exception on error
883 Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
884 if (empty($object)) {
885 throw new ServerException('No object from StoreActivityObject '.$stored->uri . ': '.$act->asString());
887 $orig = clone($stored);
888 $stored->object_type = ActivityUtils::resolveUri($object->getObjectType(), true);
889 $stored->update($orig);
890 } catch (Exception $e) {
891 if (empty($stored->id)) {
892 common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
894 common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
901 common_debug(get_called_class().' looking up mentions metadata etc.');
902 // Save per-notice metadata...
906 // This event lets plugins filter out non-local recipients (attentions we don't care about)
907 // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway)
908 Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups));
910 if (!empty($mentions)) {
911 $stored->saveKnownReplies($mentions);
913 $stored->saveReplies();
917 $stored->saveKnownTags($tags);
922 // Note: groups may save tags, so must be run after tags are saved
923 // to avoid errors on duplicates.
924 // Note: groups should always be set.
926 $stored->saveKnownGroups($groups);
929 $stored->saveKnownUrls($urls);
935 // Prepare inbox delivery, may be queued to background.
936 $stored->distribute();
939 common_debug(get_called_class().' returning stored activity - success!');
944 static public function figureOutScope(Profile $actor, array $groups, $scope=null) {
945 if (is_null($scope)) {
946 $scope = self::defaultScope();
949 // For private streams
951 $user = $actor->getUser();
952 // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
953 if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) {
954 $scope |= Notice::FOLLOWER_SCOPE;
956 } catch (NoSuchUserException $e) {
957 // TODO: Not a local user, so we don't know about scope preferences... yet!
960 // Force the scope for private groups
961 foreach ($groups as $group_id) {
962 $group = User_group::staticGet('id', $group_id);
963 if ($group instanceof User_group) {
964 if ($group->force_scope) {
965 $scope |= Notice::GROUP_SCOPE;
974 function blowOnInsert($conversation = false)
976 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
978 if ($this->isPublic()) {
979 $this->blowStream('public');
982 self::blow('notice:list-ids:conversation:%s', $this->conversation);
983 self::blow('conversation:notice_count:%d', $this->conversation);
985 if (!empty($this->repeat_of)) {
986 // XXX: we should probably only use one of these
987 $this->blowStream('notice:repeats:%d', $this->repeat_of);
988 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
991 $original = Notice::getKV('id', $this->repeat_of);
993 if ($original instanceof Notice) {
994 $originalUser = User::getKV('id', $original->profile_id);
995 if ($originalUser instanceof User) {
996 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
1000 $profile = Profile::getKV($this->profile_id);
1002 if ($profile instanceof Profile) {
1003 $profile->blowNoticeCount();
1006 $ptags = $this->getProfileTags();
1007 foreach ($ptags as $ptag) {
1008 $ptag->blowNoticeStreamCache();
1013 * Clear cache entries related to this notice at delete time.
1014 * Necessary to avoid breaking paging on public, profile timelines.
1016 function blowOnDelete()
1018 $this->blowOnInsert();
1020 self::blow('profile:notice_ids:%d;last', $this->profile_id);
1022 if ($this->isPublic()) {
1023 self::blow('public;last');
1026 self::blow('fave:by_notice', $this->id);
1028 if ($this->conversation) {
1029 // In case we're the first, will need to calc a new root.
1030 self::blow('notice:conversation_root:%d', $this->conversation);
1033 $ptags = $this->getProfileTags();
1034 foreach ($ptags as $ptag) {
1035 $ptag->blowNoticeStreamCache(true);
1039 function blowStream()
1041 $c = self::memcache();
1047 $args = func_get_args();
1049 $format = array_shift($args);
1051 $keyPart = vsprintf($format, $args);
1053 $cacheKey = Cache::key($keyPart);
1055 $c->delete($cacheKey);
1057 // delete the "last" stream, too, if this notice is
1058 // older than the top of that stream
1060 $lastKey = $cacheKey.';last';
1062 $lastStr = $c->get($lastKey);
1064 if ($lastStr !== false) {
1065 $window = explode(',', $lastStr);
1066 $lastID = $window[0];
1067 $lastNotice = Notice::getKV('id', $lastID);
1068 if (!$lastNotice instanceof Notice // just weird
1069 || strtotime($lastNotice->created) >= strtotime($this->created)) {
1070 $c->delete($lastKey);
1075 /** save all urls in the notice to the db
1077 * follow redirects and save all available file information
1078 * (mimetype, date, size, oembed, etc.)
1082 function saveUrls() {
1083 if (common_config('attachments', 'process_links')) {
1084 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
1089 * Save the given URLs as related links/attachments to the db
1091 * follow redirects and save all available file information
1092 * (mimetype, date, size, oembed, etc.)
1096 function saveKnownUrls($urls)
1098 if (common_config('attachments', 'process_links')) {
1099 // @fixme validation?
1100 foreach (array_unique($urls) as $url) {
1102 File::processNew($url, $this->id);
1103 } catch (ServerException $e) {
1104 // Could not save URL. Log it?
1113 function saveUrl($url, $notice_id) {
1115 File::processNew($url, $notice_id);
1116 } catch (ServerException $e) {
1117 // Could not save URL. Log it?
1121 static function checkDupes($profile_id, $content) {
1122 $profile = Profile::getKV($profile_id);
1123 if (!$profile instanceof Profile) {
1126 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
1127 if (!empty($notice)) {
1129 while ($notice->fetch()) {
1130 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
1132 } else if ($notice->content == $content) {
1137 // If we get here, oldest item in cache window is not
1138 // old enough for dupe limit; do direct check against DB
1139 $notice = new Notice();
1140 $notice->profile_id = $profile_id;
1141 $notice->content = $content;
1142 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
1143 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
1145 $cnt = $notice->count();
1149 static function checkEditThrottle($profile_id) {
1150 $profile = Profile::getKV($profile_id);
1151 if (!$profile instanceof Profile) {
1154 // Get the Nth notice
1155 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
1156 if ($notice && $notice->fetch()) {
1157 // If the Nth notice was posted less than timespan seconds ago
1158 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
1163 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
1167 protected $_attachments = array();
1169 function attachments() {
1170 if (isset($this->_attachments[$this->id])) {
1171 return $this->_attachments[$this->id];
1174 $f2ps = File_to_post::listGet('post_id', array($this->id));
1178 foreach ($f2ps[$this->id] as $f2p) {
1179 $ids[] = $f2p->file_id;
1182 $files = File::multiGet('id', $ids);
1184 $this->_attachments[$this->id] = $files->fetchAll();
1186 return $this->_attachments[$this->id];
1189 function _setAttachments($attachments)
1191 $this->_attachments[$this->id] = $attachments;
1194 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
1196 $stream = new PublicNoticeStream();
1197 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1201 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
1203 $stream = new ConversationNoticeStream($id);
1205 return $stream->getNotices($offset, $limit, $since_id, $max_id);
1209 * Is this notice part of an active conversation?
1211 * @return boolean true if other messages exist in the same
1212 * conversation, false if this is the only one
1214 function hasConversation()
1216 if (!empty($this->conversation)) {
1217 $conversation = Notice::conversationStream(
1218 $this->conversation,
1223 if ($conversation->N > 0) {
1231 * Grab the earliest notice from this conversation.
1233 * @return Notice or null
1235 function conversationRoot($profile=-1)
1237 // XXX: can this happen?
1239 if (empty($this->conversation)) {
1243 // Get the current profile if not specified
1245 if (is_int($profile) && $profile == -1) {
1246 $profile = Profile::current();
1249 // If this notice is out of scope, no root for you!
1251 if (!$this->inScope($profile)) {
1255 // If this isn't a reply to anything, then it's its own
1258 if (empty($this->reply_to)) {
1262 if (is_null($profile)) {
1263 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1265 $keypart = sprintf('notice:conversation_root:%d:%d',
1270 $root = self::cacheGet($keypart);
1272 if ($root !== false && $root->inScope($profile)) {
1279 $parent = $last->getParent();
1280 if ($parent->inScope($profile)) {
1284 } catch (Exception $e) {
1285 // Latest notice has no parent
1287 // No parent, or parent out of scope
1292 self::cacheSet($keypart, $root);
1298 * Pull up a full list of local recipients who will be getting
1299 * this notice in their inbox. Results will be cached, so don't
1300 * change the input data wily-nilly!
1302 * @param array $groups optional list of Group objects;
1303 * if left empty, will be loaded from group_inbox records
1304 * @param array $recipient optional list of reply profile ids
1305 * if left empty, will be loaded from reply records
1306 * @return array associating recipient user IDs with an inbox source constant
1308 function whoGets(array $groups=null, array $recipients=null)
1310 $c = self::memcache();
1313 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1314 if ($ni !== false) {
1319 if (is_null($recipients)) {
1320 $recipients = $this->getReplies();
1325 // Give plugins a chance to add folks in at start...
1326 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1328 $users = $this->getSubscribedUsers();
1329 foreach ($users as $id) {
1330 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1333 if (is_null($groups)) {
1334 $groups = $this->getGroups();
1336 foreach ($groups as $group) {
1337 $users = $group->getUserMembers();
1338 foreach ($users as $id) {
1339 if (!array_key_exists($id, $ni)) {
1340 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1345 $ptAtts = $this->getAttentionsFromProfileTags();
1346 foreach ($ptAtts as $key=>$val) {
1347 if (!array_key_exists($key, $ni)) {
1352 foreach ($recipients as $recipient) {
1353 if (!array_key_exists($recipient, $ni)) {
1354 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1358 // Exclude any deleted, non-local, or blocking recipients.
1359 $profile = $this->getProfile();
1360 $originalProfile = null;
1361 if ($this->repeat_of) {
1362 // Check blocks against the original notice's poster as well.
1363 $original = Notice::getKV('id', $this->repeat_of);
1364 if ($original instanceof Notice) {
1365 $originalProfile = $original->getProfile();
1369 foreach ($ni as $id => $source) {
1371 $user = User::getKV('id', $id);
1372 if (!$user instanceof User ||
1373 $user->hasBlocked($profile) ||
1374 ($originalProfile && $user->hasBlocked($originalProfile))) {
1377 } catch (UserNoProfileException $e) {
1378 // User doesn't have a profile; invalid; skip them.
1383 // Give plugins a chance to filter out...
1384 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1388 // XXX: pack this data better
1389 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1395 function getSubscribedUsers()
1399 if(common_config('db','quote_identifiers'))
1400 $user_table = '"user"';
1401 else $user_table = 'user';
1405 'FROM '. $user_table .' JOIN subscription '.
1406 'ON '. $user_table .'.id = subscription.subscriber ' .
1407 'WHERE subscription.subscribed = %d ';
1409 $user->query(sprintf($qry, $this->profile_id));
1413 while ($user->fetch()) {
1422 function getProfileTags()
1424 $profile = $this->getProfile();
1425 $list = $profile->getOtherTags($profile);
1428 while($list->fetch()) {
1429 $ptags[] = clone($list);
1435 public function getAttentionsFromProfileTags()
1438 $ptags = $this->getProfileTags();
1439 foreach ($ptags as $ptag) {
1440 $users = $ptag->getUserSubscribers();
1441 foreach ($users as $id) {
1442 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1449 * Record this notice to the given group inboxes for delivery.
1450 * Overrides the regular parsing of !group markup.
1452 * @param string $group_ids
1453 * @fixme might prefer URIs as identifiers, as for replies?
1454 * best with generalizations on user_group to support
1455 * remote groups better.
1457 function saveKnownGroups($group_ids)
1459 if (!is_array($group_ids)) {
1460 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1461 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1465 foreach (array_unique($group_ids) as $id) {
1466 $group = User_group::getKV('id', $id);
1467 if ($group instanceof User_group) {
1468 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
1469 $result = $this->addToGroupInbox($group);
1471 common_log_db_error($gi, 'INSERT', __FILE__);
1474 if (common_config('group', 'addtag')) {
1475 // we automatically add a tag for every group name, too
1477 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1478 'notice_id' => $this->id));
1480 if (is_null($tag)) {
1481 $this->saveTag($group->nickname);
1485 $groups[] = clone($group);
1487 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1494 function addToGroupInbox(User_group $group)
1496 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1497 'notice_id' => $this->id));
1499 if (!$gi instanceof Group_inbox) {
1501 $gi = new Group_inbox();
1503 $gi->group_id = $group->id;
1504 $gi->notice_id = $this->id;
1505 $gi->created = $this->created;
1507 $result = $gi->insert();
1510 common_log_db_error($gi, 'INSERT', __FILE__);
1511 // TRANS: Server exception thrown when an update for a group inbox fails.
1512 throw new ServerException(_('Problem saving group inbox.'));
1515 self::blow('user_group:notice_ids:%d', $gi->group_id);
1522 * Save reply records indicating that this notice needs to be
1523 * delivered to the local users with the given URIs.
1525 * Since this is expected to be used when saving foreign-sourced
1526 * messages, we won't deliver to any remote targets as that's the
1527 * source service's responsibility.
1529 * Mail notifications etc will be handled later.
1531 * @param array $uris Array of unique identifier URIs for recipients
1533 function saveKnownReplies(array $uris)
1539 $sender = Profile::getKV($this->profile_id);
1541 foreach (array_unique($uris) as $uri) {
1543 $profile = Profile::fromUri($uri);
1544 } catch (UnknownUriException $e) {
1545 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1549 if ($profile->hasBlocked($sender)) {
1550 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1554 $this->saveReply($profile->id);
1555 self::blow('reply:stream:%d', $profile->id);
1562 * Pull @-replies from this message's content in StatusNet markup format
1563 * and save reply records indicating that this message needs to be
1564 * delivered to those users.
1566 * Mail notifications to local profiles will be sent later.
1568 * @return array of integer profile IDs
1571 function saveReplies()
1573 // Don't save reply data for repeats
1575 if (!empty($this->repeat_of)) {
1579 $sender = $this->getProfile();
1583 // If it's a reply, save for the replied-to author
1585 $parent = $this->getParent();
1586 $parentauthor = $parent->getProfile();
1587 $this->saveReply($parentauthor->id);
1588 $replied[$parentauthor->id] = 1;
1589 self::blow('reply:stream:%d', $parentauthor->id);
1590 } catch (Exception $e) {
1591 // Not a reply, since it has no parent!
1594 // @todo ideally this parser information would only
1595 // be calculated once.
1597 $mentions = common_find_mentions($this->content, $this);
1599 // store replied only for first @ (what user/notice what the reply directed,
1600 // we assume first @ is it)
1602 foreach ($mentions as $mention) {
1604 foreach ($mention['mentioned'] as $mentioned) {
1606 // skip if they're already covered
1608 if (!empty($replied[$mentioned->id])) {
1612 // Don't save replies from blocked profile to local user
1614 $mentioned_user = User::getKV('id', $mentioned->id);
1615 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1619 $this->saveReply($mentioned->id);
1620 $replied[$mentioned->id] = 1;
1621 self::blow('reply:stream:%d', $mentioned->id);
1625 $recipientIds = array_keys($replied);
1627 return $recipientIds;
1630 function saveReply($profileId)
1632 $reply = new Reply();
1634 $reply->notice_id = $this->id;
1635 $reply->profile_id = $profileId;
1636 $reply->modified = $this->created;
1643 protected $_replies = array();
1646 * Pull the complete list of @-reply targets for this notice.
1648 * @return array of integer profile ids
1650 function getReplies()
1652 if (isset($this->_replies[$this->id])) {
1653 return $this->_replies[$this->id];
1656 $replyMap = Reply::listGet('notice_id', array($this->id));
1660 foreach ($replyMap[$this->id] as $reply) {
1661 $ids[] = $reply->profile_id;
1664 $this->_replies[$this->id] = $ids;
1669 function _setReplies($replies)
1671 $this->_replies[$this->id] = $replies;
1675 * Pull the complete list of @-reply targets for this notice.
1677 * @return array of Profiles
1679 function getReplyProfiles()
1681 $ids = $this->getReplies();
1683 $profiles = Profile::multiGet('id', $ids);
1685 return $profiles->fetchAll();
1689 * Send e-mail notifications to local @-reply targets.
1691 * Replies must already have been saved; this is expected to be run
1692 * from the distrib queue handler.
1694 function sendReplyNotifications()
1696 // Don't send reply notifications for repeats
1698 if (!empty($this->repeat_of)) {
1702 $recipientIds = $this->getReplies();
1704 foreach ($recipientIds as $recipientId) {
1705 $user = User::getKV('id', $recipientId);
1706 if ($user instanceof User) {
1707 mail_notify_attn($user, $this);
1713 * Pull list of groups this notice needs to be delivered to,
1714 * as previously recorded by saveKnownGroups().
1716 * @return array of Group objects
1719 protected $_groups = array();
1721 function getGroups()
1723 // Don't save groups for repeats
1725 if (!empty($this->repeat_of)) {
1729 if (isset($this->_groups[$this->id])) {
1730 return $this->_groups[$this->id];
1733 $gis = Group_inbox::listGet('notice_id', array($this->id));
1737 foreach ($gis[$this->id] as $gi)
1739 $ids[] = $gi->group_id;
1742 $groups = User_group::multiGet('id', $ids);
1744 $this->_groups[$this->id] = $groups->fetchAll();
1746 return $this->_groups[$this->id];
1749 function _setGroups($groups)
1751 $this->_groups[$this->id] = $groups;
1755 * Convert a notice into an activity for export.
1757 * @param User $cur Current user
1759 * @return Activity activity object representing this Notice.
1762 function asActivity($cur=null)
1764 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1766 if ($act instanceof Activity) {
1769 $act = new Activity();
1771 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1773 $act->id = $this->uri;
1774 $act->time = strtotime($this->created);
1776 $act->link = $this->getUrl();
1777 } catch (InvalidUrlException $e) {
1778 // The notice is probably a share or similar, which don't
1779 // have a representational URL of their own.
1781 $act->content = common_xml_safe_str($this->rendered);
1783 $profile = $this->getProfile();
1785 $act->actor = ActivityObject::fromProfile($profile);
1786 $act->actor->extra[] = $profile->profileInfo($cur);
1788 $act->verb = $this->verb;
1790 if ($this->repeat_of) {
1791 $repeated = Notice::getKV('id', $this->repeat_of);
1792 if ($repeated instanceof Notice) {
1793 $act->objects[] = $repeated->asActivity($cur);
1796 $act->objects[] = ActivityObject::fromNotice($this);
1799 // XXX: should this be handled by default processing for object entry?
1803 $tags = $this->getTags();
1805 foreach ($tags as $tag) {
1806 $cat = new AtomCategory();
1809 $act->categories[] = $cat;
1813 // XXX: use Atom Media and/or File activity objects instead
1815 $attachments = $this->attachments();
1817 foreach ($attachments as $attachment) {
1818 // Save local attachments
1819 if (!empty($attachment->filename)) {
1820 $act->attachments[] = ActivityObject::fromFile($attachment);
1824 $ctx = new ActivityContext();
1827 $reply = $this->getParent();
1828 $ctx->replyToID = $reply->getUri();
1829 $ctx->replyToUrl = $reply->getUrl();
1830 } catch (Exception $e) {
1831 // This is not a reply to something
1834 $ctx->location = $this->getLocation();
1838 if (!empty($this->conversation)) {
1839 $conv = Conversation::getKV('id', $this->conversation);
1840 if ($conv instanceof Conversation) {
1841 $ctx->conversation = $conv->uri;
1845 $reply_ids = $this->getReplies();
1847 foreach ($reply_ids as $id) {
1848 $rprofile = Profile::getKV('id', $id);
1849 if ($rprofile instanceof Profile) {
1850 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1854 $groups = $this->getGroups();
1856 foreach ($groups as $group) {
1857 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1860 switch ($this->scope) {
1861 case Notice::PUBLIC_SCOPE:
1862 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1864 case Notice::FOLLOWER_SCOPE:
1865 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1866 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1870 $act->context = $ctx;
1872 $source = $this->getSource();
1874 if ($source instanceof Notice_source) {
1875 $act->generator = ActivityObject::fromNoticeSource($source);
1880 $atom_feed = $profile->getAtomFeed();
1882 if (!empty($atom_feed)) {
1884 $act->source = new ActivitySource();
1886 // XXX: we should store the actual feed ID
1888 $act->source->id = $atom_feed;
1890 // XXX: we should store the actual feed title
1892 $act->source->title = $profile->getBestName();
1894 $act->source->links['alternate'] = $profile->profileurl;
1895 $act->source->links['self'] = $atom_feed;
1897 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1899 $notice = $profile->getCurrentNotice();
1901 if ($notice instanceof Notice) {
1902 $act->source->updated = self::utcDate($notice->created);
1905 $user = User::getKV('id', $profile->id);
1907 if ($user instanceof User) {
1908 $act->source->links['license'] = common_config('license', 'url');
1912 if ($this->isLocal()) {
1913 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1914 'format' => 'atom'));
1915 $act->editLink = $act->selfLink;
1918 Event::handle('EndNoticeAsActivity', array($this, &$act));
1921 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1926 // This has gotten way too long. Needs to be sliced up into functional bits
1927 // or ideally exported to a utility class.
1929 function asAtomEntry($namespace=false,
1934 $act = $this->asActivity($cur);
1935 $act->extra[] = $this->noticeInfo($cur);
1936 return $act->asString($namespace, $author, $source);
1940 * Extra notice info for atom entries
1942 * Clients use some extra notice info in the atom stream.
1943 * This gives it to them.
1945 * @param User $cur Current user
1947 * @return array representation of <statusnet:notice_info> element
1950 function noticeInfo($cur)
1952 // local notice ID (useful to clients for ordering)
1954 $noticeInfoAttr = array('local_id' => $this->id);
1958 $ns = $this->getSource();
1960 if ($ns instanceof Notice_source) {
1961 $noticeInfoAttr['source'] = $ns->code;
1962 if (!empty($ns->url)) {
1963 $noticeInfoAttr['source_link'] = $ns->url;
1964 if (!empty($ns->name)) {
1965 $noticeInfoAttr['source'] = '<a href="'
1966 . htmlspecialchars($ns->url)
1967 . '" rel="nofollow">'
1968 . htmlspecialchars($ns->name)
1974 // favorite and repeated
1978 $scoped = $cur->getProfile();
1979 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
1982 if (!empty($this->repeat_of)) {
1983 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1986 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
1988 return array('statusnet:notice_info', $noticeInfoAttr, null);
1992 * Returns an XML string fragment with a reference to a notice as an
1993 * Activity Streams noun object with the given element type.
1995 * Assumes that 'activity' namespace has been previously defined.
1997 * @param string $element one of 'subject', 'object', 'target'
2001 function asActivityNoun($element)
2003 $noun = ActivityObject::fromNotice($this);
2004 return $noun->asString('activity:' . $element);
2008 * Determine which notice, if any, a new notice is in reply to.
2010 * For conversation tracking, we try to see where this notice fits
2011 * in the tree. Beware that this may very well give false positives
2012 * and add replies to wrong threads (if there have been newer posts
2013 * by the same user as we're replying to).
2015 * @param Profile $sender Author profile
2016 * @param string $content Final notice content
2018 * @return integer ID of replied-to notice, or null for not a reply.
2021 static function getInlineReplyTo(Profile $sender, $content)
2023 // Is there an initial @ or T?
2024 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
2025 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
2026 $nickname = common_canonical_nickname($match[1]);
2031 // Figure out who that is.
2032 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
2034 if ($recipient instanceof Profile) {
2035 // Get their last notice
2036 $last = $recipient->getCurrentNotice();
2037 if ($last instanceof Notice) {
2040 // Maybe in the future we want to handle something else below
2041 // so don't return getCurrentNotice() immediately.
2047 static function maxContent()
2049 $contentlimit = common_config('notice', 'contentlimit');
2050 // null => use global limit (distinct from 0!)
2051 if (is_null($contentlimit)) {
2052 $contentlimit = common_config('site', 'textlimit');
2054 return $contentlimit;
2057 static function contentTooLong($content)
2059 $contentlimit = self::maxContent();
2060 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
2063 function getLocation()
2067 if (!empty($this->location_id) && !empty($this->location_ns)) {
2068 $location = Location::fromId($this->location_id, $this->location_ns);
2071 if (is_null($location)) { // no ID, or Location::fromId() failed
2072 if (!empty($this->lat) && !empty($this->lon)) {
2073 $location = Location::fromLatLon($this->lat, $this->lon);
2081 * Convenience function for posting a repeat of an existing message.
2083 * @param Profile $repeater Profile which is doing the repeat
2084 * @param string $source: posting source key, eg 'web', 'api', etc
2087 * @throws Exception on failure or permission problems
2089 function repeat(Profile $repeater, $source)
2091 $author = $this->getProfile();
2093 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
2094 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
2095 $content = sprintf(_('RT @%1$s %2$s'),
2096 $author->getNickname(),
2099 // Scope is same as this one's
2100 return self::saveNew($repeater->id,
2103 array('repeat_of' => $this->id,
2104 'scope' => $this->scope));
2107 // These are supposed to be in chron order!
2109 function repeatStream($limit=100)
2111 $cache = Cache::instance();
2113 if (empty($cache)) {
2114 $ids = $this->_repeatStreamDirect($limit);
2116 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
2117 if ($idstr !== false) {
2118 if (empty($idstr)) {
2121 $ids = explode(',', $idstr);
2124 $ids = $this->_repeatStreamDirect(100);
2125 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
2128 // We do a max of 100, so slice down to limit
2129 $ids = array_slice($ids, 0, $limit);
2133 return NoticeStream::getStreamByIds($ids);
2136 function _repeatStreamDirect($limit)
2138 $notice = new Notice();
2140 $notice->selectAdd(); // clears it
2141 $notice->selectAdd('id');
2143 $notice->repeat_of = $this->id;
2145 $notice->orderBy('created, id'); // NB: asc!
2147 if (!is_null($limit)) {
2148 $notice->limit(0, $limit);
2151 return $notice->fetchAll('id');
2154 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
2158 if (!empty($location_id) && !empty($location_ns)) {
2159 $options['location_id'] = $location_id;
2160 $options['location_ns'] = $location_ns;
2162 $location = Location::fromId($location_id, $location_ns);
2164 if ($location instanceof Location) {
2165 $options['lat'] = $location->lat;
2166 $options['lon'] = $location->lon;
2169 } else if (!empty($lat) && !empty($lon)) {
2170 $options['lat'] = $lat;
2171 $options['lon'] = $lon;
2173 $location = Location::fromLatLon($lat, $lon);
2175 if ($location instanceof Location) {
2176 $options['location_id'] = $location->location_id;
2177 $options['location_ns'] = $location->location_ns;
2179 } else if (!empty($profile)) {
2180 if (isset($profile->lat) && isset($profile->lon)) {
2181 $options['lat'] = $profile->lat;
2182 $options['lon'] = $profile->lon;
2185 if (isset($profile->location_id) && isset($profile->location_ns)) {
2186 $options['location_id'] = $profile->location_id;
2187 $options['location_ns'] = $profile->location_ns;
2194 function clearAttentions()
2196 $att = new Attention();
2197 $att->notice_id = $this->getID();
2200 while ($att->fetch()) {
2201 // Can't do delete() on the object directly since it won't remove all of it
2202 $other = clone($att);
2208 function clearReplies()
2210 $replyNotice = new Notice();
2211 $replyNotice->reply_to = $this->id;
2213 //Null any notices that are replies to this notice
2215 if ($replyNotice->find()) {
2216 while ($replyNotice->fetch()) {
2217 $orig = clone($replyNotice);
2218 $replyNotice->reply_to = null;
2219 $replyNotice->update($orig);
2225 $reply = new Reply();
2226 $reply->notice_id = $this->id;
2228 if ($reply->find()) {
2229 while($reply->fetch()) {
2230 self::blow('reply:stream:%d', $reply->profile_id);
2238 function clearFiles()
2240 $f2p = new File_to_post();
2242 $f2p->post_id = $this->id;
2245 while ($f2p->fetch()) {
2249 // FIXME: decide whether to delete File objects
2250 // ...and related (actual) files
2253 function clearRepeats()
2255 $repeatNotice = new Notice();
2256 $repeatNotice->repeat_of = $this->id;
2258 //Null any notices that are repeats of this notice
2260 if ($repeatNotice->find()) {
2261 while ($repeatNotice->fetch()) {
2262 $orig = clone($repeatNotice);
2263 $repeatNotice->repeat_of = null;
2264 $repeatNotice->update($orig);
2269 function clearTags()
2271 $tag = new Notice_tag();
2272 $tag->notice_id = $this->id;
2275 while ($tag->fetch()) {
2276 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2277 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2278 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2279 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2287 function clearGroupInboxes()
2289 $gi = new Group_inbox();
2291 $gi->notice_id = $this->id;
2294 while ($gi->fetch()) {
2295 self::blow('user_group:notice_ids:%d', $gi->group_id);
2303 function distribute()
2305 // We always insert for the author so they don't
2307 Event::handle('StartNoticeDistribute', array($this));
2309 // If there's a failure, we want to _force_
2310 // distribution at this point.
2312 $qm = QueueManager::get();
2313 $qm->enqueue($this, 'distrib');
2314 } catch (Exception $e) {
2315 // If the exception isn't transient, this
2316 // may throw more exceptions as DQH does
2317 // its own enqueueing. So, we ignore them!
2319 $handler = new DistribQueueHandler();
2320 $handler->handle($this);
2321 } catch (Exception $e) {
2322 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2324 // Re-throw so somebody smarter can handle it.
2331 $result = parent::insert();
2333 if ($result !== false) {
2334 // Profile::hasRepeated() abuses pkeyGet(), so we
2335 // have to clear manually
2336 if (!empty($this->repeat_of)) {
2337 $c = self::memcache();
2339 $ck = self::multicacheKey('Notice',
2340 array('profile_id' => $this->profile_id,
2341 'repeat_of' => $this->repeat_of));
2351 * Get the source of the notice
2353 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2354 * guaranteed to be populated.
2356 function getSource()
2358 $ns = new Notice_source();
2359 if (!empty($this->source)) {
2360 switch ($this->source) {
2367 $ns->code = $this->source;
2370 $ns = Notice_source::getKV($this->source);
2372 $ns = new Notice_source();
2373 $ns->code = $this->source;
2374 $app = Oauth_application::getKV('name', $this->source);
2376 $ns->name = $app->name;
2377 $ns->url = $app->source_url;
2387 * Determine whether the notice was locally created
2389 * @return boolean locality
2392 public function isLocal()
2394 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2395 $this->is_local == Notice::LOCAL_NONPUBLIC);
2399 * Get the list of hash tags saved with this notice.
2401 * @return array of strings
2403 public function getTags()
2407 $keypart = sprintf('notice:tags:%d', $this->id);
2409 $tagstr = self::cacheGet($keypart);
2411 if ($tagstr !== false) {
2412 $tags = explode(',', $tagstr);
2414 $tag = new Notice_tag();
2415 $tag->notice_id = $this->id;
2417 while ($tag->fetch()) {
2418 $tags[] = $tag->tag;
2421 self::cacheSet($keypart, implode(',', $tags));
2427 static private function utcDate($dt)
2429 $dateStr = date('d F Y H:i:s', strtotime($dt));
2430 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2431 return $d->format(DATE_W3C);
2435 * Look up the creation timestamp for a given notice ID, even
2436 * if it's been deleted.
2439 * @return mixed string recorded creation timestamp, or false if can't be found
2441 public static function getAsTimestamp($id)
2447 $notice = Notice::getKV('id', $id);
2449 return $notice->created;
2452 $deleted = Deleted_notice::getKV('id', $id);
2454 return $deleted->created;
2461 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2462 * parameter, matching notices posted after the given one (exclusive).
2464 * If the referenced notice can't be found, will return false.
2467 * @param string $idField
2468 * @param string $createdField
2469 * @return mixed string or false if no match
2471 public static function whereSinceId($id, $idField='id', $createdField='created')
2473 $since = Notice::getAsTimestamp($id);
2475 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2481 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2482 * parameter, matching notices posted after the given one (exclusive), and
2483 * if necessary add it to the data object's query.
2485 * @param DB_DataObject $obj
2487 * @param string $idField
2488 * @param string $createdField
2489 * @return mixed string or false if no match
2491 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2493 $since = self::whereSinceId($id, $idField, $createdField);
2495 $obj->whereAdd($since);
2500 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2501 * parameter, matching notices posted before the given one (inclusive).
2503 * If the referenced notice can't be found, will return false.
2506 * @param string $idField
2507 * @param string $createdField
2508 * @return mixed string or false if no match
2510 public static function whereMaxId($id, $idField='id', $createdField='created')
2512 $max = Notice::getAsTimestamp($id);
2514 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2520 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2521 * parameter, matching notices posted before the given one (inclusive), and
2522 * if necessary add it to the data object's query.
2524 * @param DB_DataObject $obj
2526 * @param string $idField
2527 * @param string $createdField
2528 * @return mixed string or false if no match
2530 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2532 $max = self::whereMaxId($id, $idField, $createdField);
2534 $obj->whereAdd($max);
2540 if (common_config('public', 'localonly')) {
2541 return ($this->is_local == Notice::LOCAL_PUBLIC);
2543 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2544 ($this->is_local != Notice::GATEWAY));
2549 * Check that the given profile is allowed to read, respond to, or otherwise
2550 * act on this notice.
2552 * The $scope member is a bitmask of scopes, representing a logical AND of the
2553 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2554 * "only visible to people who are mentioned in the notice AND are users on this site."
2555 * Users on the site who are not mentioned in the notice will not be able to see the
2558 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2560 * @return boolean whether the profile is in the notice's scope
2562 function inScope($profile)
2564 if (is_null($profile)) {
2565 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2567 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2570 $result = self::cacheGet($keypart);
2572 if ($result === false) {
2574 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2575 $bResult = $this->_inScope($profile);
2576 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2578 $result = ($bResult) ? 1 : 0;
2579 self::cacheSet($keypart, $result, 0, 300);
2582 return ($result == 1) ? true : false;
2585 protected function _inScope($profile)
2587 if (!is_null($this->scope)) {
2588 $scope = $this->scope;
2590 $scope = self::defaultScope();
2593 // If there's no scope, anyone (even anon) is in scope.
2595 if ($scope == 0) { // Not private
2597 return !$this->isHiddenSpam($profile);
2599 } else { // Private, somehow
2601 // If there's scope, anon cannot be in scope
2603 if (empty($profile)) {
2607 // Author is always in scope
2609 if ($this->profile_id == $profile->id) {
2613 // Only for users on this site
2615 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2619 // Only for users mentioned in the notice
2621 if ($scope & Notice::ADDRESSEE_SCOPE) {
2623 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2624 'profile_id' => $profile->id));
2626 if (!$reply instanceof Reply) {
2631 // Only for members of the given group
2633 if ($scope & Notice::GROUP_SCOPE) {
2635 // XXX: just query for the single membership
2637 $groups = $this->getGroups();
2641 foreach ($groups as $group) {
2642 if ($profile->isMember($group)) {
2653 // Only for followers of the author
2657 if ($scope & Notice::FOLLOWER_SCOPE) {
2660 $author = $this->getProfile();
2661 } catch (Exception $e) {
2665 if (!Subscription::exists($profile, $author)) {
2670 return !$this->isHiddenSpam($profile);
2674 function isHiddenSpam($profile) {
2676 // Hide posts by silenced users from everyone but moderators.
2678 if (common_config('notice', 'hidespam')) {
2681 $author = $this->getProfile();
2682 } catch(Exception $e) {
2683 // If we can't get an author, keep it hidden.
2684 // XXX: technically not spam, but, whatever.
2688 if ($author->hasRole(Profile_role::SILENCED)) {
2689 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2698 public function getParent()
2700 $parent = Notice::getKV('id', $this->reply_to);
2702 if (!$parent instanceof Notice) {
2703 throw new ServerException('Notice has no parent');
2710 * Magic function called at serialize() time.
2712 * We use this to drop a couple process-specific references
2713 * from DB_DataObject which can cause trouble in future
2716 * @return array of variable names to include in serialization.
2721 $vars = parent::__sleep();
2722 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2723 return array_diff($vars, $skip);
2726 static function defaultScope()
2728 $scope = common_config('notice', 'defaultscope');
2729 if (is_null($scope)) {
2730 if (common_config('site', 'private')) {
2739 static function fillProfiles($notices)
2741 $map = self::getProfiles($notices);
2743 foreach ($notices as $entry=>$notice) {
2745 if (array_key_exists($notice->profile_id, $map)) {
2746 $notice->_setProfile($map[$notice->profile_id]);
2748 } catch (NoProfileException $e) {
2749 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2750 unset($notices[$entry]);
2754 return array_values($map);
2757 static function getProfiles(&$notices)
2760 foreach ($notices as $notice) {
2761 $ids[] = $notice->profile_id;
2764 $ids = array_unique($ids);
2766 return Profile::pivotGet('id', $ids);
2769 static function fillGroups(&$notices)
2771 $ids = self::_idsOf($notices);
2773 $gis = Group_inbox::listGet('notice_id', $ids);
2777 foreach ($gis as $id => $gi)
2781 $gids[] = $g->group_id;
2785 $gids = array_unique($gids);
2787 $group = User_group::pivotGet('id', $gids);
2789 foreach ($notices as $notice)
2792 $gi = $gis[$notice->id];
2793 foreach ($gi as $g) {
2794 $grps[] = $group[$g->group_id];
2796 $notice->_setGroups($grps);
2800 static function _idsOf(array &$notices)
2803 foreach ($notices as $notice) {
2804 $ids[$notice->id] = true;
2806 return array_keys($ids);
2809 static function fillAttachments(&$notices)
2811 $ids = self::_idsOf($notices);
2813 $f2pMap = File_to_post::listGet('post_id', $ids);
2817 foreach ($f2pMap as $noticeId => $f2ps) {
2818 foreach ($f2ps as $f2p) {
2819 $fileIds[] = $f2p->file_id;
2823 $fileIds = array_unique($fileIds);
2825 $fileMap = File::pivotGet('id', $fileIds);
2827 foreach ($notices as $notice)
2830 $f2ps = $f2pMap[$notice->id];
2831 foreach ($f2ps as $f2p) {
2832 $files[] = $fileMap[$f2p->file_id];
2834 $notice->_setAttachments($files);
2838 static function fillReplies(&$notices)
2840 $ids = self::_idsOf($notices);
2841 $replyMap = Reply::listGet('notice_id', $ids);
2842 foreach ($notices as $notice) {
2843 $replies = $replyMap[$notice->id];
2845 foreach ($replies as $reply) {
2846 $ids[] = $reply->profile_id;
2848 $notice->_setReplies($ids);
2852 protected $_repeats = array();
2854 function getRepeats()
2856 if (isset($this->_repeats[$this->id])) {
2857 return $this->_repeats[$this->id];
2859 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2860 $this->_repeats[$this->id] = $repeatMap[$this->id];
2861 return $this->_repeats[$this->id];
2864 function _setRepeats($repeats)
2866 $this->_repeats[$this->id] = $repeats;
2869 static function fillRepeats(&$notices)
2871 $ids = self::_idsOf($notices);
2872 $repeatMap = Notice::listGet('repeat_of', $ids);
2873 foreach ($notices as $notice) {
2874 $repeats = $repeatMap[$notice->id];
2875 $notice->_setRepeats($repeats);