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)) { // 0 is a valid value
631 if (!empty($reply)) {
632 $notice->scope = $reply->scope;
634 $notice->scope = self::defaultScope();
637 $notice->scope = $scope;
640 // For private streams
643 $user = $profile->getUser();
645 if ($user->private_stream &&
646 ($notice->scope == Notice::PUBLIC_SCOPE ||
647 $notice->scope == Notice::SITE_SCOPE)) {
648 $notice->scope |= Notice::FOLLOWER_SCOPE;
650 } catch (NoSuchUserException $e) {
651 // Cannot handle private streams for remote profiles
654 // Force the scope for private groups
656 foreach ($groups as $groupId) {
657 $group = User_group::getKV('id', $groupId);
658 if ($group instanceof User_group) {
659 if ($group->force_scope) {
660 $notice->scope |= Notice::GROUP_SCOPE;
666 if (Event::handle('StartNoticeSave', array(&$notice))) {
668 // XXX: some of these functions write to the DB
670 $id = $notice->insert();
673 common_log_db_error($notice, 'INSERT', __FILE__);
674 // TRANS: Server exception thrown when a notice cannot be saved.
675 throw new ServerException(_('Problem saving notice.'));
678 // Update ID-dependent columns: URI, conversation
680 $orig = clone($notice);
684 // We can only get here if it's a local notice, since remote notices
685 // should've bailed out earlier due to lacking a URI.
686 if (empty($notice->uri)) {
687 $notice->uri = sprintf('%s%s=%d:%s=%s',
689 'noticeId', $notice->id,
690 'objectType', $notice->get_object_type(true));
694 // If it's not part of a conversation, it's
695 // the beginning of a new conversation.
697 if (empty($notice->conversation)) {
698 $conv = Conversation::create($notice);
699 $notice->conversation = $conv->id;
704 if ($notice->update($orig) === false) {
705 common_log_db_error($notice, 'UPDATE', __FILE__);
706 // TRANS: Server exception thrown when a notice cannot be updated.
707 throw new ServerException(_('Problem saving notice.'));
713 // Clear the cache for subscribed users, so they'll update at next request
714 // XXX: someone clever could prepend instead of clearing the cache
716 $notice->blowOnInsert();
718 // Save per-notice metadata...
720 if (isset($replies)) {
721 $notice->saveKnownReplies($replies);
723 $notice->saveReplies();
727 $notice->saveKnownTags($tags);
732 // Note: groups may save tags, so must be run after tags are saved
733 // to avoid errors on duplicates.
734 // Note: groups should always be set.
736 $notice->saveKnownGroups($groups);
739 $notice->saveKnownUrls($urls);
745 // Prepare inbox delivery, may be queued to background.
746 $notice->distribute();
752 function blowOnInsert($conversation = false)
754 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
756 if ($this->isPublic()) {
757 $this->blowStream('public');
760 self::blow('notice:list-ids:conversation:%s', $this->conversation);
761 self::blow('conversation:notice_count:%d', $this->conversation);
763 if (!empty($this->repeat_of)) {
764 // XXX: we should probably only use one of these
765 $this->blowStream('notice:repeats:%d', $this->repeat_of);
766 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
769 $original = Notice::getKV('id', $this->repeat_of);
771 if ($original instanceof Notice) {
772 $originalUser = User::getKV('id', $original->profile_id);
773 if ($originalUser instanceof User) {
774 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
778 $profile = Profile::getKV($this->profile_id);
780 if ($profile instanceof Profile) {
781 $profile->blowNoticeCount();
784 $ptags = $this->getProfileTags();
785 foreach ($ptags as $ptag) {
786 $ptag->blowNoticeStreamCache();
791 * Clear cache entries related to this notice at delete time.
792 * Necessary to avoid breaking paging on public, profile timelines.
794 function blowOnDelete()
796 $this->blowOnInsert();
798 self::blow('profile:notice_ids:%d;last', $this->profile_id);
800 if ($this->isPublic()) {
801 self::blow('public;last');
804 self::blow('fave:by_notice', $this->id);
806 if ($this->conversation) {
807 // In case we're the first, will need to calc a new root.
808 self::blow('notice:conversation_root:%d', $this->conversation);
811 $ptags = $this->getProfileTags();
812 foreach ($ptags as $ptag) {
813 $ptag->blowNoticeStreamCache(true);
817 function blowStream()
819 $c = self::memcache();
825 $args = func_get_args();
827 $format = array_shift($args);
829 $keyPart = vsprintf($format, $args);
831 $cacheKey = Cache::key($keyPart);
833 $c->delete($cacheKey);
835 // delete the "last" stream, too, if this notice is
836 // older than the top of that stream
838 $lastKey = $cacheKey.';last';
840 $lastStr = $c->get($lastKey);
842 if ($lastStr !== false) {
843 $window = explode(',', $lastStr);
844 $lastID = $window[0];
845 $lastNotice = Notice::getKV('id', $lastID);
846 if (!$lastNotice instanceof Notice // just weird
847 || strtotime($lastNotice->created) >= strtotime($this->created)) {
848 $c->delete($lastKey);
853 /** save all urls in the notice to the db
855 * follow redirects and save all available file information
856 * (mimetype, date, size, oembed, etc.)
860 function saveUrls() {
861 if (common_config('attachments', 'process_links')) {
862 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
867 * Save the given URLs as related links/attachments to the db
869 * follow redirects and save all available file information
870 * (mimetype, date, size, oembed, etc.)
874 function saveKnownUrls($urls)
876 if (common_config('attachments', 'process_links')) {
877 // @fixme validation?
878 foreach (array_unique($urls) as $url) {
880 File::processNew($url, $this->id);
881 } catch (ServerException $e) {
882 // Could not save URL. Log it?
891 function saveUrl($url, $notice_id) {
893 File::processNew($url, $notice_id);
894 } catch (ServerException $e) {
895 // Could not save URL. Log it?
899 static function checkDupes($profile_id, $content) {
900 $profile = Profile::getKV($profile_id);
901 if (!$profile instanceof Profile) {
904 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
905 if (!empty($notice)) {
907 while ($notice->fetch()) {
908 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
910 } else if ($notice->content == $content) {
915 // If we get here, oldest item in cache window is not
916 // old enough for dupe limit; do direct check against DB
917 $notice = new Notice();
918 $notice->profile_id = $profile_id;
919 $notice->content = $content;
920 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
921 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
923 $cnt = $notice->count();
927 static function checkEditThrottle($profile_id) {
928 $profile = Profile::getKV($profile_id);
929 if (!$profile instanceof Profile) {
932 // Get the Nth notice
933 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
934 if ($notice && $notice->fetch()) {
935 // If the Nth notice was posted less than timespan seconds ago
936 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
941 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
945 protected $_attachments = array();
947 function attachments() {
948 if (isset($this->_attachments[$this->id])) {
949 return $this->_attachments[$this->id];
952 $f2ps = File_to_post::listGet('post_id', array($this->id));
956 foreach ($f2ps[$this->id] as $f2p) {
957 $ids[] = $f2p->file_id;
960 $files = File::multiGet('id', $ids);
962 $this->_attachments[$this->id] = $files->fetchAll();
964 return $this->_attachments[$this->id];
967 function _setAttachments($attachments)
969 $this->_attachments[$this->id] = $attachments;
972 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
974 $stream = new PublicNoticeStream();
975 return $stream->getNotices($offset, $limit, $since_id, $max_id);
979 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
981 $stream = new ConversationNoticeStream($id);
983 return $stream->getNotices($offset, $limit, $since_id, $max_id);
987 * Is this notice part of an active conversation?
989 * @return boolean true if other messages exist in the same
990 * conversation, false if this is the only one
992 function hasConversation()
994 if (!empty($this->conversation)) {
995 $conversation = Notice::conversationStream(
1001 if ($conversation->N > 0) {
1009 * Grab the earliest notice from this conversation.
1011 * @return Notice or null
1013 function conversationRoot($profile=-1)
1015 // XXX: can this happen?
1017 if (empty($this->conversation)) {
1021 // Get the current profile if not specified
1023 if (is_int($profile) && $profile == -1) {
1024 $profile = Profile::current();
1027 // If this notice is out of scope, no root for you!
1029 if (!$this->inScope($profile)) {
1033 // If this isn't a reply to anything, then it's its own
1036 if (empty($this->reply_to)) {
1040 if (is_null($profile)) {
1041 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
1043 $keypart = sprintf('notice:conversation_root:%d:%d',
1048 $root = self::cacheGet($keypart);
1050 if ($root !== false && $root->inScope($profile)) {
1057 $parent = $last->getParent();
1058 if ($parent->inScope($profile)) {
1062 } catch (Exception $e) {
1063 // Latest notice has no parent
1065 // No parent, or parent out of scope
1070 self::cacheSet($keypart, $root);
1076 * Pull up a full list of local recipients who will be getting
1077 * this notice in their inbox. Results will be cached, so don't
1078 * change the input data wily-nilly!
1080 * @param array $groups optional list of Group objects;
1081 * if left empty, will be loaded from group_inbox records
1082 * @param array $recipient optional list of reply profile ids
1083 * if left empty, will be loaded from reply records
1084 * @return array associating recipient user IDs with an inbox source constant
1086 function whoGets(array $groups=null, array $recipients=null)
1088 $c = self::memcache();
1091 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1092 if ($ni !== false) {
1097 if (is_null($recipients)) {
1098 $recipients = $this->getReplies();
1103 // Give plugins a chance to add folks in at start...
1104 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1106 $users = $this->getSubscribedUsers();
1107 foreach ($users as $id) {
1108 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1111 if (is_null($groups)) {
1112 $groups = $this->getGroups();
1114 foreach ($groups as $group) {
1115 $users = $group->getUserMembers();
1116 foreach ($users as $id) {
1117 if (!array_key_exists($id, $ni)) {
1118 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1123 $ptAtts = $this->getAttentionsFromProfileTags();
1124 foreach ($ptAtts as $key=>$val) {
1125 if (!array_key_exists($key, $ni)) {
1130 foreach ($recipients as $recipient) {
1131 if (!array_key_exists($recipient, $ni)) {
1132 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1136 // Exclude any deleted, non-local, or blocking recipients.
1137 $profile = $this->getProfile();
1138 $originalProfile = null;
1139 if ($this->repeat_of) {
1140 // Check blocks against the original notice's poster as well.
1141 $original = Notice::getKV('id', $this->repeat_of);
1142 if ($original instanceof Notice) {
1143 $originalProfile = $original->getProfile();
1147 foreach ($ni as $id => $source) {
1149 $user = User::getKV('id', $id);
1150 if (!$user instanceof User ||
1151 $user->hasBlocked($profile) ||
1152 ($originalProfile && $user->hasBlocked($originalProfile))) {
1155 } catch (UserNoProfileException $e) {
1156 // User doesn't have a profile; invalid; skip them.
1161 // Give plugins a chance to filter out...
1162 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1166 // XXX: pack this data better
1167 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1173 function getSubscribedUsers()
1177 if(common_config('db','quote_identifiers'))
1178 $user_table = '"user"';
1179 else $user_table = 'user';
1183 'FROM '. $user_table .' JOIN subscription '.
1184 'ON '. $user_table .'.id = subscription.subscriber ' .
1185 'WHERE subscription.subscribed = %d ';
1187 $user->query(sprintf($qry, $this->profile_id));
1191 while ($user->fetch()) {
1200 function getProfileTags()
1202 $profile = $this->getProfile();
1203 $list = $profile->getOtherTags($profile);
1206 while($list->fetch()) {
1207 $ptags[] = clone($list);
1213 public function getAttentionsFromProfileTags()
1216 $ptags = $this->getProfileTags();
1217 foreach ($ptags as $ptag) {
1218 $users = $ptag->getUserSubscribers();
1219 foreach ($users as $id) {
1220 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1227 * Record this notice to the given group inboxes for delivery.
1228 * Overrides the regular parsing of !group markup.
1230 * @param string $group_ids
1231 * @fixme might prefer URIs as identifiers, as for replies?
1232 * best with generalizations on user_group to support
1233 * remote groups better.
1235 function saveKnownGroups($group_ids)
1237 if (!is_array($group_ids)) {
1238 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1239 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1243 foreach (array_unique($group_ids) as $id) {
1244 $group = User_group::getKV('id', $id);
1245 if ($group instanceof User_group) {
1246 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
1247 $result = $this->addToGroupInbox($group);
1249 common_log_db_error($gi, 'INSERT', __FILE__);
1252 if (common_config('group', 'addtag')) {
1253 // we automatically add a tag for every group name, too
1255 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1256 'notice_id' => $this->id));
1258 if (is_null($tag)) {
1259 $this->saveTag($group->nickname);
1263 $groups[] = clone($group);
1265 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1272 function addToGroupInbox(User_group $group)
1274 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1275 'notice_id' => $this->id));
1277 if (!$gi instanceof Group_inbox) {
1279 $gi = new Group_inbox();
1281 $gi->group_id = $group->id;
1282 $gi->notice_id = $this->id;
1283 $gi->created = $this->created;
1285 $result = $gi->insert();
1288 common_log_db_error($gi, 'INSERT', __FILE__);
1289 // TRANS: Server exception thrown when an update for a group inbox fails.
1290 throw new ServerException(_('Problem saving group inbox.'));
1293 self::blow('user_group:notice_ids:%d', $gi->group_id);
1300 * Save reply records indicating that this notice needs to be
1301 * delivered to the local users with the given URIs.
1303 * Since this is expected to be used when saving foreign-sourced
1304 * messages, we won't deliver to any remote targets as that's the
1305 * source service's responsibility.
1307 * Mail notifications etc will be handled later.
1309 * @param array $uris Array of unique identifier URIs for recipients
1311 function saveKnownReplies(array $uris)
1317 $sender = Profile::getKV($this->profile_id);
1319 foreach (array_unique($uris) as $uri) {
1321 $profile = Profile::fromUri($uri);
1322 } catch (UnknownUriException $e) {
1323 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1327 if ($profile->hasBlocked($sender)) {
1328 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1332 $this->saveReply($profile->id);
1333 self::blow('reply:stream:%d', $profile->id);
1340 * Pull @-replies from this message's content in StatusNet markup format
1341 * and save reply records indicating that this message needs to be
1342 * delivered to those users.
1344 * Mail notifications to local profiles will be sent later.
1346 * @return array of integer profile IDs
1349 function saveReplies()
1351 // Don't save reply data for repeats
1353 if (!empty($this->repeat_of)) {
1357 $sender = $this->getProfile();
1361 // If it's a reply, save for the replied-to author
1363 $parent = $this->getParent();
1364 $parentauthor = $parent->getProfile();
1365 $this->saveReply($parentauthor->id);
1366 $replied[$parentauthor->id] = 1;
1367 self::blow('reply:stream:%d', $parentauthor->id);
1368 } catch (Exception $e) {
1369 // Not a reply, since it has no parent!
1372 // @todo ideally this parser information would only
1373 // be calculated once.
1375 $mentions = common_find_mentions($this->content, $this);
1377 // store replied only for first @ (what user/notice what the reply directed,
1378 // we assume first @ is it)
1380 foreach ($mentions as $mention) {
1382 foreach ($mention['mentioned'] as $mentioned) {
1384 // skip if they're already covered
1386 if (!empty($replied[$mentioned->id])) {
1390 // Don't save replies from blocked profile to local user
1392 $mentioned_user = User::getKV('id', $mentioned->id);
1393 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1397 $this->saveReply($mentioned->id);
1398 $replied[$mentioned->id] = 1;
1399 self::blow('reply:stream:%d', $mentioned->id);
1403 $recipientIds = array_keys($replied);
1405 return $recipientIds;
1408 function saveReply($profileId)
1410 $reply = new Reply();
1412 $reply->notice_id = $this->id;
1413 $reply->profile_id = $profileId;
1414 $reply->modified = $this->created;
1421 protected $_replies = array();
1424 * Pull the complete list of @-reply targets for this notice.
1426 * @return array of integer profile ids
1428 function getReplies()
1430 if (isset($this->_replies[$this->id])) {
1431 return $this->_replies[$this->id];
1434 $replyMap = Reply::listGet('notice_id', array($this->id));
1438 foreach ($replyMap[$this->id] as $reply) {
1439 $ids[] = $reply->profile_id;
1442 $this->_replies[$this->id] = $ids;
1447 function _setReplies($replies)
1449 $this->_replies[$this->id] = $replies;
1453 * Pull the complete list of @-reply targets for this notice.
1455 * @return array of Profiles
1457 function getReplyProfiles()
1459 $ids = $this->getReplies();
1461 $profiles = Profile::multiGet('id', $ids);
1463 return $profiles->fetchAll();
1467 * Send e-mail notifications to local @-reply targets.
1469 * Replies must already have been saved; this is expected to be run
1470 * from the distrib queue handler.
1472 function sendReplyNotifications()
1474 // Don't send reply notifications for repeats
1476 if (!empty($this->repeat_of)) {
1480 $recipientIds = $this->getReplies();
1482 foreach ($recipientIds as $recipientId) {
1483 $user = User::getKV('id', $recipientId);
1484 if ($user instanceof User) {
1485 mail_notify_attn($user, $this);
1491 * Pull list of groups this notice needs to be delivered to,
1492 * as previously recorded by saveKnownGroups().
1494 * @return array of Group objects
1497 protected $_groups = array();
1499 function getGroups()
1501 // Don't save groups for repeats
1503 if (!empty($this->repeat_of)) {
1507 if (isset($this->_groups[$this->id])) {
1508 return $this->_groups[$this->id];
1511 $gis = Group_inbox::listGet('notice_id', array($this->id));
1515 foreach ($gis[$this->id] as $gi)
1517 $ids[] = $gi->group_id;
1520 $groups = User_group::multiGet('id', $ids);
1522 $this->_groups[$this->id] = $groups->fetchAll();
1524 return $this->_groups[$this->id];
1527 function _setGroups($groups)
1529 $this->_groups[$this->id] = $groups;
1533 * Convert a notice into an activity for export.
1535 * @param User $cur Current user
1537 * @return Activity activity object representing this Notice.
1540 function asActivity($cur=null)
1542 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1544 if ($act instanceof Activity) {
1547 $act = new Activity();
1549 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1551 $act->id = $this->uri;
1552 $act->time = strtotime($this->created);
1554 $act->link = $this->getUrl();
1555 } catch (InvalidUrlException $e) {
1556 // The notice is probably a share or similar, which don't
1557 // have a representational URL of their own.
1559 $act->content = common_xml_safe_str($this->rendered);
1561 $profile = $this->getProfile();
1563 $act->actor = ActivityObject::fromProfile($profile);
1564 $act->actor->extra[] = $profile->profileInfo($cur);
1566 $act->verb = $this->verb;
1568 if ($this->repeat_of) {
1569 $repeated = Notice::getKV('id', $this->repeat_of);
1570 if ($repeated instanceof Notice) {
1571 $act->objects[] = $repeated->asActivity($cur);
1574 $act->objects[] = ActivityObject::fromNotice($this);
1577 // XXX: should this be handled by default processing for object entry?
1581 $tags = $this->getTags();
1583 foreach ($tags as $tag) {
1584 $cat = new AtomCategory();
1587 $act->categories[] = $cat;
1591 // XXX: use Atom Media and/or File activity objects instead
1593 $attachments = $this->attachments();
1595 foreach ($attachments as $attachment) {
1596 // Save local attachments
1597 if (!empty($attachment->filename)) {
1598 $act->attachments[] = ActivityObject::fromFile($attachment);
1602 $ctx = new ActivityContext();
1605 $reply = $this->getParent();
1606 $ctx->replyToID = $reply->getUri();
1607 $ctx->replyToUrl = $reply->getUrl();
1608 } catch (Exception $e) {
1609 // This is not a reply to something
1612 $ctx->location = $this->getLocation();
1616 if (!empty($this->conversation)) {
1617 $conv = Conversation::getKV('id', $this->conversation);
1618 if ($conv instanceof Conversation) {
1619 $ctx->conversation = $conv->uri;
1623 $reply_ids = $this->getReplies();
1625 foreach ($reply_ids as $id) {
1626 $rprofile = Profile::getKV('id', $id);
1627 if ($rprofile instanceof Profile) {
1628 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1632 $groups = $this->getGroups();
1634 foreach ($groups as $group) {
1635 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1638 switch ($this->scope) {
1639 case Notice::PUBLIC_SCOPE:
1640 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1642 case Notice::FOLLOWER_SCOPE:
1643 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1644 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1648 $act->context = $ctx;
1650 $source = $this->getSource();
1652 if ($source instanceof Notice_source) {
1653 $act->generator = ActivityObject::fromNoticeSource($source);
1658 $atom_feed = $profile->getAtomFeed();
1660 if (!empty($atom_feed)) {
1662 $act->source = new ActivitySource();
1664 // XXX: we should store the actual feed ID
1666 $act->source->id = $atom_feed;
1668 // XXX: we should store the actual feed title
1670 $act->source->title = $profile->getBestName();
1672 $act->source->links['alternate'] = $profile->profileurl;
1673 $act->source->links['self'] = $atom_feed;
1675 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1677 $notice = $profile->getCurrentNotice();
1679 if ($notice instanceof Notice) {
1680 $act->source->updated = self::utcDate($notice->created);
1683 $user = User::getKV('id', $profile->id);
1685 if ($user instanceof User) {
1686 $act->source->links['license'] = common_config('license', 'url');
1690 if ($this->isLocal()) {
1691 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1692 'format' => 'atom'));
1693 $act->editLink = $act->selfLink;
1696 Event::handle('EndNoticeAsActivity', array($this, &$act));
1699 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1704 // This has gotten way too long. Needs to be sliced up into functional bits
1705 // or ideally exported to a utility class.
1707 function asAtomEntry($namespace=false,
1712 $act = $this->asActivity($cur);
1713 $act->extra[] = $this->noticeInfo($cur);
1714 return $act->asString($namespace, $author, $source);
1718 * Extra notice info for atom entries
1720 * Clients use some extra notice info in the atom stream.
1721 * This gives it to them.
1723 * @param User $cur Current user
1725 * @return array representation of <statusnet:notice_info> element
1728 function noticeInfo($cur)
1730 // local notice ID (useful to clients for ordering)
1732 $noticeInfoAttr = array('local_id' => $this->id);
1736 $ns = $this->getSource();
1738 if ($ns instanceof Notice_source) {
1739 $noticeInfoAttr['source'] = $ns->code;
1740 if (!empty($ns->url)) {
1741 $noticeInfoAttr['source_link'] = $ns->url;
1742 if (!empty($ns->name)) {
1743 $noticeInfoAttr['source'] = '<a href="'
1744 . htmlspecialchars($ns->url)
1745 . '" rel="nofollow">'
1746 . htmlspecialchars($ns->name)
1752 // favorite and repeated
1756 $scoped = $cur->getProfile();
1757 $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
1760 if (!empty($this->repeat_of)) {
1761 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1764 Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
1766 return array('statusnet:notice_info', $noticeInfoAttr, null);
1770 * Returns an XML string fragment with a reference to a notice as an
1771 * Activity Streams noun object with the given element type.
1773 * Assumes that 'activity' namespace has been previously defined.
1775 * @param string $element one of 'subject', 'object', 'target'
1779 function asActivityNoun($element)
1781 $noun = ActivityObject::fromNotice($this);
1782 return $noun->asString('activity:' . $element);
1786 * Determine which notice, if any, a new notice is in reply to.
1788 * For conversation tracking, we try to see where this notice fits
1789 * in the tree. Beware that this may very well give false positives
1790 * and add replies to wrong threads (if there have been newer posts
1791 * by the same user as we're replying to).
1793 * @param Profile $sender Author profile
1794 * @param string $content Final notice content
1796 * @return integer ID of replied-to notice, or null for not a reply.
1799 static function getInlineReplyTo(Profile $sender, $content)
1801 // Is there an initial @ or T?
1802 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
1803 || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1804 $nickname = common_canonical_nickname($match[1]);
1809 // Figure out who that is.
1810 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1812 if ($recipient instanceof Profile) {
1813 // Get their last notice
1814 $last = $recipient->getCurrentNotice();
1815 if ($last instanceof Notice) {
1818 // Maybe in the future we want to handle something else below
1819 // so don't return getCurrentNotice() immediately.
1825 static function maxContent()
1827 $contentlimit = common_config('notice', 'contentlimit');
1828 // null => use global limit (distinct from 0!)
1829 if (is_null($contentlimit)) {
1830 $contentlimit = common_config('site', 'textlimit');
1832 return $contentlimit;
1835 static function contentTooLong($content)
1837 $contentlimit = self::maxContent();
1838 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1841 function getLocation()
1845 if (!empty($this->location_id) && !empty($this->location_ns)) {
1846 $location = Location::fromId($this->location_id, $this->location_ns);
1849 if (is_null($location)) { // no ID, or Location::fromId() failed
1850 if (!empty($this->lat) && !empty($this->lon)) {
1851 $location = Location::fromLatLon($this->lat, $this->lon);
1859 * Convenience function for posting a repeat of an existing message.
1861 * @param Profile $repeater Profile which is doing the repeat
1862 * @param string $source: posting source key, eg 'web', 'api', etc
1865 * @throws Exception on failure or permission problems
1867 function repeat(Profile $repeater, $source)
1869 $author = $this->getProfile();
1871 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1872 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1873 $content = sprintf(_('RT @%1$s %2$s'),
1874 $author->getNickname(),
1877 // Scope is same as this one's
1878 return self::saveNew($repeater->id,
1881 array('repeat_of' => $this->id,
1882 'scope' => $this->scope));
1885 // These are supposed to be in chron order!
1887 function repeatStream($limit=100)
1889 $cache = Cache::instance();
1891 if (empty($cache)) {
1892 $ids = $this->_repeatStreamDirect($limit);
1894 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1895 if ($idstr !== false) {
1896 if (empty($idstr)) {
1899 $ids = explode(',', $idstr);
1902 $ids = $this->_repeatStreamDirect(100);
1903 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1906 // We do a max of 100, so slice down to limit
1907 $ids = array_slice($ids, 0, $limit);
1911 return NoticeStream::getStreamByIds($ids);
1914 function _repeatStreamDirect($limit)
1916 $notice = new Notice();
1918 $notice->selectAdd(); // clears it
1919 $notice->selectAdd('id');
1921 $notice->repeat_of = $this->id;
1923 $notice->orderBy('created, id'); // NB: asc!
1925 if (!is_null($limit)) {
1926 $notice->limit(0, $limit);
1929 return $notice->fetchAll('id');
1932 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1936 if (!empty($location_id) && !empty($location_ns)) {
1937 $options['location_id'] = $location_id;
1938 $options['location_ns'] = $location_ns;
1940 $location = Location::fromId($location_id, $location_ns);
1942 if ($location instanceof Location) {
1943 $options['lat'] = $location->lat;
1944 $options['lon'] = $location->lon;
1947 } else if (!empty($lat) && !empty($lon)) {
1948 $options['lat'] = $lat;
1949 $options['lon'] = $lon;
1951 $location = Location::fromLatLon($lat, $lon);
1953 if ($location instanceof Location) {
1954 $options['location_id'] = $location->location_id;
1955 $options['location_ns'] = $location->location_ns;
1957 } else if (!empty($profile)) {
1958 if (isset($profile->lat) && isset($profile->lon)) {
1959 $options['lat'] = $profile->lat;
1960 $options['lon'] = $profile->lon;
1963 if (isset($profile->location_id) && isset($profile->location_ns)) {
1964 $options['location_id'] = $profile->location_id;
1965 $options['location_ns'] = $profile->location_ns;
1972 function clearAttentions()
1974 $att = new Attention();
1975 $att->notice_id = $this->getID();
1978 while ($att->fetch()) {
1979 // Can't do delete() on the object directly since it won't remove all of it
1980 $other = clone($att);
1986 function clearReplies()
1988 $replyNotice = new Notice();
1989 $replyNotice->reply_to = $this->id;
1991 //Null any notices that are replies to this notice
1993 if ($replyNotice->find()) {
1994 while ($replyNotice->fetch()) {
1995 $orig = clone($replyNotice);
1996 $replyNotice->reply_to = null;
1997 $replyNotice->update($orig);
2003 $reply = new Reply();
2004 $reply->notice_id = $this->id;
2006 if ($reply->find()) {
2007 while($reply->fetch()) {
2008 self::blow('reply:stream:%d', $reply->profile_id);
2016 function clearFiles()
2018 $f2p = new File_to_post();
2020 $f2p->post_id = $this->id;
2023 while ($f2p->fetch()) {
2027 // FIXME: decide whether to delete File objects
2028 // ...and related (actual) files
2031 function clearRepeats()
2033 $repeatNotice = new Notice();
2034 $repeatNotice->repeat_of = $this->id;
2036 //Null any notices that are repeats of this notice
2038 if ($repeatNotice->find()) {
2039 while ($repeatNotice->fetch()) {
2040 $orig = clone($repeatNotice);
2041 $repeatNotice->repeat_of = null;
2042 $repeatNotice->update($orig);
2047 function clearTags()
2049 $tag = new Notice_tag();
2050 $tag->notice_id = $this->id;
2053 while ($tag->fetch()) {
2054 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2055 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2056 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2057 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2065 function clearGroupInboxes()
2067 $gi = new Group_inbox();
2069 $gi->notice_id = $this->id;
2072 while ($gi->fetch()) {
2073 self::blow('user_group:notice_ids:%d', $gi->group_id);
2081 function distribute()
2083 // We always insert for the author so they don't
2085 Event::handle('StartNoticeDistribute', array($this));
2087 // If there's a failure, we want to _force_
2088 // distribution at this point.
2090 $qm = QueueManager::get();
2091 $qm->enqueue($this, 'distrib');
2092 } catch (Exception $e) {
2093 // If the exception isn't transient, this
2094 // may throw more exceptions as DQH does
2095 // its own enqueueing. So, we ignore them!
2097 $handler = new DistribQueueHandler();
2098 $handler->handle($this);
2099 } catch (Exception $e) {
2100 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2102 // Re-throw so somebody smarter can handle it.
2109 $result = parent::insert();
2111 if ($result !== false) {
2112 // Profile::hasRepeated() abuses pkeyGet(), so we
2113 // have to clear manually
2114 if (!empty($this->repeat_of)) {
2115 $c = self::memcache();
2117 $ck = self::multicacheKey('Notice',
2118 array('profile_id' => $this->profile_id,
2119 'repeat_of' => $this->repeat_of));
2129 * Get the source of the notice
2131 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2132 * guaranteed to be populated.
2134 function getSource()
2136 $ns = new Notice_source();
2137 if (!empty($this->source)) {
2138 switch ($this->source) {
2145 $ns->code = $this->source;
2148 $ns = Notice_source::getKV($this->source);
2150 $ns = new Notice_source();
2151 $ns->code = $this->source;
2152 $app = Oauth_application::getKV('name', $this->source);
2154 $ns->name = $app->name;
2155 $ns->url = $app->source_url;
2165 * Determine whether the notice was locally created
2167 * @return boolean locality
2170 public function isLocal()
2172 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2173 $this->is_local == Notice::LOCAL_NONPUBLIC);
2177 * Get the list of hash tags saved with this notice.
2179 * @return array of strings
2181 public function getTags()
2185 $keypart = sprintf('notice:tags:%d', $this->id);
2187 $tagstr = self::cacheGet($keypart);
2189 if ($tagstr !== false) {
2190 $tags = explode(',', $tagstr);
2192 $tag = new Notice_tag();
2193 $tag->notice_id = $this->id;
2195 while ($tag->fetch()) {
2196 $tags[] = $tag->tag;
2199 self::cacheSet($keypart, implode(',', $tags));
2205 static private function utcDate($dt)
2207 $dateStr = date('d F Y H:i:s', strtotime($dt));
2208 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2209 return $d->format(DATE_W3C);
2213 * Look up the creation timestamp for a given notice ID, even
2214 * if it's been deleted.
2217 * @return mixed string recorded creation timestamp, or false if can't be found
2219 public static function getAsTimestamp($id)
2225 $notice = Notice::getKV('id', $id);
2227 return $notice->created;
2230 $deleted = Deleted_notice::getKV('id', $id);
2232 return $deleted->created;
2239 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2240 * parameter, matching notices posted after the given one (exclusive).
2242 * If the referenced notice can't be found, will return false.
2245 * @param string $idField
2246 * @param string $createdField
2247 * @return mixed string or false if no match
2249 public static function whereSinceId($id, $idField='id', $createdField='created')
2251 $since = Notice::getAsTimestamp($id);
2253 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2259 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2260 * parameter, matching notices posted after the given one (exclusive), and
2261 * if necessary add it to the data object's query.
2263 * @param DB_DataObject $obj
2265 * @param string $idField
2266 * @param string $createdField
2267 * @return mixed string or false if no match
2269 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2271 $since = self::whereSinceId($id, $idField, $createdField);
2273 $obj->whereAdd($since);
2278 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2279 * parameter, matching notices posted before the given one (inclusive).
2281 * If the referenced notice can't be found, will return false.
2284 * @param string $idField
2285 * @param string $createdField
2286 * @return mixed string or false if no match
2288 public static function whereMaxId($id, $idField='id', $createdField='created')
2290 $max = Notice::getAsTimestamp($id);
2292 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2298 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2299 * parameter, matching notices posted before the given one (inclusive), and
2300 * if necessary add it to the data object's query.
2302 * @param DB_DataObject $obj
2304 * @param string $idField
2305 * @param string $createdField
2306 * @return mixed string or false if no match
2308 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2310 $max = self::whereMaxId($id, $idField, $createdField);
2312 $obj->whereAdd($max);
2318 if (common_config('public', 'localonly')) {
2319 return ($this->is_local == Notice::LOCAL_PUBLIC);
2321 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2322 ($this->is_local != Notice::GATEWAY));
2327 * Check that the given profile is allowed to read, respond to, or otherwise
2328 * act on this notice.
2330 * The $scope member is a bitmask of scopes, representing a logical AND of the
2331 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2332 * "only visible to people who are mentioned in the notice AND are users on this site."
2333 * Users on the site who are not mentioned in the notice will not be able to see the
2336 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2338 * @return boolean whether the profile is in the notice's scope
2340 function inScope($profile)
2342 if (is_null($profile)) {
2343 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2345 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2348 $result = self::cacheGet($keypart);
2350 if ($result === false) {
2352 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2353 $bResult = $this->_inScope($profile);
2354 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2356 $result = ($bResult) ? 1 : 0;
2357 self::cacheSet($keypart, $result, 0, 300);
2360 return ($result == 1) ? true : false;
2363 protected function _inScope($profile)
2365 if (!is_null($this->scope)) {
2366 $scope = $this->scope;
2368 $scope = self::defaultScope();
2371 // If there's no scope, anyone (even anon) is in scope.
2373 if ($scope == 0) { // Not private
2375 return !$this->isHiddenSpam($profile);
2377 } else { // Private, somehow
2379 // If there's scope, anon cannot be in scope
2381 if (empty($profile)) {
2385 // Author is always in scope
2387 if ($this->profile_id == $profile->id) {
2391 // Only for users on this site
2393 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2397 // Only for users mentioned in the notice
2399 if ($scope & Notice::ADDRESSEE_SCOPE) {
2401 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2402 'profile_id' => $profile->id));
2404 if (!$reply instanceof Reply) {
2409 // Only for members of the given group
2411 if ($scope & Notice::GROUP_SCOPE) {
2413 // XXX: just query for the single membership
2415 $groups = $this->getGroups();
2419 foreach ($groups as $group) {
2420 if ($profile->isMember($group)) {
2431 // Only for followers of the author
2435 if ($scope & Notice::FOLLOWER_SCOPE) {
2438 $author = $this->getProfile();
2439 } catch (Exception $e) {
2443 if (!Subscription::exists($profile, $author)) {
2448 return !$this->isHiddenSpam($profile);
2452 function isHiddenSpam($profile) {
2454 // Hide posts by silenced users from everyone but moderators.
2456 if (common_config('notice', 'hidespam')) {
2459 $author = $this->getProfile();
2460 } catch(Exception $e) {
2461 // If we can't get an author, keep it hidden.
2462 // XXX: technically not spam, but, whatever.
2466 if ($author->hasRole(Profile_role::SILENCED)) {
2467 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2476 public function getParent()
2478 $parent = Notice::getKV('id', $this->reply_to);
2480 if (!$parent instanceof Notice) {
2481 throw new ServerException('Notice has no parent');
2488 * Magic function called at serialize() time.
2490 * We use this to drop a couple process-specific references
2491 * from DB_DataObject which can cause trouble in future
2494 * @return array of variable names to include in serialization.
2499 $vars = parent::__sleep();
2500 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2501 return array_diff($vars, $skip);
2504 static function defaultScope()
2506 $scope = common_config('notice', 'defaultscope');
2507 if (is_null($scope)) {
2508 if (common_config('site', 'private')) {
2517 static function fillProfiles($notices)
2519 $map = self::getProfiles($notices);
2521 foreach ($notices as $entry=>$notice) {
2523 if (array_key_exists($notice->profile_id, $map)) {
2524 $notice->_setProfile($map[$notice->profile_id]);
2526 } catch (NoProfileException $e) {
2527 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
2528 unset($notices[$entry]);
2532 return array_values($map);
2535 static function getProfiles(&$notices)
2538 foreach ($notices as $notice) {
2539 $ids[] = $notice->profile_id;
2542 $ids = array_unique($ids);
2544 return Profile::pivotGet('id', $ids);
2547 static function fillGroups(&$notices)
2549 $ids = self::_idsOf($notices);
2551 $gis = Group_inbox::listGet('notice_id', $ids);
2555 foreach ($gis as $id => $gi)
2559 $gids[] = $g->group_id;
2563 $gids = array_unique($gids);
2565 $group = User_group::pivotGet('id', $gids);
2567 foreach ($notices as $notice)
2570 $gi = $gis[$notice->id];
2571 foreach ($gi as $g) {
2572 $grps[] = $group[$g->group_id];
2574 $notice->_setGroups($grps);
2578 static function _idsOf(array &$notices)
2581 foreach ($notices as $notice) {
2582 $ids[$notice->id] = true;
2584 return array_keys($ids);
2587 static function fillAttachments(&$notices)
2589 $ids = self::_idsOf($notices);
2591 $f2pMap = File_to_post::listGet('post_id', $ids);
2595 foreach ($f2pMap as $noticeId => $f2ps) {
2596 foreach ($f2ps as $f2p) {
2597 $fileIds[] = $f2p->file_id;
2601 $fileIds = array_unique($fileIds);
2603 $fileMap = File::pivotGet('id', $fileIds);
2605 foreach ($notices as $notice)
2608 $f2ps = $f2pMap[$notice->id];
2609 foreach ($f2ps as $f2p) {
2610 $files[] = $fileMap[$f2p->file_id];
2612 $notice->_setAttachments($files);
2616 static function fillReplies(&$notices)
2618 $ids = self::_idsOf($notices);
2619 $replyMap = Reply::listGet('notice_id', $ids);
2620 foreach ($notices as $notice) {
2621 $replies = $replyMap[$notice->id];
2623 foreach ($replies as $reply) {
2624 $ids[] = $reply->profile_id;
2626 $notice->_setReplies($ids);
2630 protected $_repeats = array();
2632 function getRepeats()
2634 if (isset($this->_repeats[$this->id])) {
2635 return $this->_repeats[$this->id];
2637 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2638 $this->_repeats[$this->id] = $repeatMap[$this->id];
2639 return $this->_repeats[$this->id];
2642 function _setRepeats($repeats)
2644 $this->_repeats[$this->id] = $repeats;
2647 static function fillRepeats(&$notices)
2649 $ids = self::_idsOf($notices);
2650 $repeatMap = Notice::listGet('repeat_of', $ids);
2651 foreach ($notices as $notice) {
2652 $repeats = $repeatMap[$notice->id];
2653 $notice->_setRepeats($repeats);