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 = -1;
146 public function getProfile()
148 if ($this->_profile === -1) {
149 $this->_setProfile(Profile::getKV('id', $this->profile_id));
151 return $this->_profile;
154 public function _setProfile(Profile $profile=null)
156 if (!$profile instanceof Profile) {
157 throw new NoProfileException($this->profile_id);
159 $this->_profile = $profile;
162 function delete($useWhere=false)
164 // For auditing purposes, save a record that the notice
167 // @fixme we have some cases where things get re-run and so the
169 $deleted = Deleted_notice::getKV('id', $this->id);
171 if (!$deleted instanceof Deleted_notice) {
172 $deleted = Deleted_notice::getKV('uri', $this->uri);
175 if (!$deleted instanceof Deleted_notice) {
176 $deleted = new Deleted_notice();
178 $deleted->id = $this->id;
179 $deleted->profile_id = $this->profile_id;
180 $deleted->uri = $this->uri;
181 $deleted->created = $this->created;
182 $deleted->deleted = common_sql_now();
187 if (Event::handle('NoticeDeleteRelated', array($this))) {
189 // Clear related records
191 $this->clearReplies();
192 $this->clearRepeats();
195 $this->clearGroupInboxes();
197 $this->clearAttentions();
199 // NOTE: we don't clear queue items
202 $result = parent::delete($useWhere);
204 $this->blowOnDelete();
208 public function getUri()
214 * @param $root boolean If true, link to just the conversation root.
216 * @return URL to conversation
218 public function getConversationUrl($anchor=true)
220 return Conversation::getUrlFromNotice($this, $anchor);
224 * Get the local representation URL of this notice.
226 public function getLocalUrl()
228 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
232 * Get the original representation URL of this notice.
234 public function getUrl()
236 // The risk is we start having empty urls and non-http uris...
237 // and we can't really handle any other protocol right now.
239 case common_valid_http_url($this->url): // should we allow non-http/https URLs?
241 case $this->isLocal():
242 // let's generate a valid link to our locally available notice on demand
243 return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
244 case common_valid_http_url($this->uri):
247 common_debug('No URL available for notice: id='.$this->id);
248 throw new InvalidUrlException($this->url);
252 public function get_object_type($canonical=false) {
254 ? ActivityObject::canonicalType($this->object_type)
255 : $this->object_type;
258 public static function getByUri($uri)
260 $notice = new Notice();
262 if (!$notice->find(true)) {
263 throw new NoResultException($notice);
269 * Extract #hashtags from this notice's content and save them to the database.
273 /* extract all #hastags */
274 $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
279 /* Add them to the database */
280 return $this->saveKnownTags($match[1]);
284 * Record the given set of hash tags in the db for this notice.
285 * Given tag strings will be normalized and checked for dupes.
287 function saveKnownTags($hashtags)
289 //turn each into their canonical tag
290 //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
291 for($i=0; $i<count($hashtags); $i++) {
292 /* elide characters we don't want in the tag */
293 $hashtags[$i] = common_canonical_tag($hashtags[$i]);
296 foreach(array_unique($hashtags) as $hashtag) {
297 $this->saveTag($hashtag);
298 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
304 * Record a single hash tag as associated with this notice.
305 * Tag format and uniqueness must be validated by caller.
307 function saveTag($hashtag)
309 $tag = new Notice_tag();
310 $tag->notice_id = $this->id;
311 $tag->tag = $hashtag;
312 $tag->created = $this->created;
313 $id = $tag->insert();
316 // TRANS: Server exception. %s are the error details.
317 throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'),
318 $last_error->message));
322 // if it's saved, blow its cache
323 $tag->blowCache(false);
327 * Save a new notice and push it out to subscribers' inboxes.
328 * Poster's permissions are checked before sending.
330 * @param int $profile_id Profile ID of the poster
331 * @param string $content source message text; links may be shortened
332 * per current user's preference
333 * @param string $source source key ('web', 'api', etc)
334 * @param array $options Associative array of optional properties:
335 * string 'created' timestamp of notice; defaults to now
336 * int 'is_local' source/gateway ID, one of:
337 * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
338 * Notice::REMOTE - Sent from a remote service;
339 * hide from public timeline but show in
340 * local "and friends" timelines
341 * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
342 * Notice::GATEWAY - From another non-OStatus service;
343 * will not appear in public views
344 * float 'lat' decimal latitude for geolocation
345 * float 'lon' decimal longitude for geolocation
346 * int 'location_id' geoname identifier
347 * int 'location_ns' geoname namespace to interpret location_id
348 * int 'reply_to'; notice ID this is a reply to
349 * int 'repeat_of'; notice ID this is a repeat of
350 * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
351 * string 'url' permalink to notice; defaults to local notice URL
352 * string 'rendered' rendered HTML version of content
353 * array 'replies' list of profile URIs for reply delivery in
354 * place of extracting @-replies from content.
355 * array 'groups' list of group IDs to deliver to, in place of
356 * extracting ! tags from content
357 * array 'tags' list of hashtag strings to save with the notice
358 * in place of extracting # tags from content
359 * array 'urls' list of attached/referred URLs to save with the
360 * notice in place of extracting links from content
361 * boolean 'distribute' whether to distribute the notice, default true
362 * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
363 * string 'verb' URL of the associated verb (default ActivityVerb::POST)
364 * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
366 * @fixme tag override
369 * @throws ClientException
371 static function saveNew($profile_id, $content, $source, array $options=null) {
372 $defaults = array('uri' => null,
377 'distribute' => true,
378 'object_type' => null,
381 if (!empty($options) && is_array($options)) {
382 $options = array_merge($defaults, $options);
388 if (!isset($is_local)) {
389 $is_local = Notice::LOCAL_PUBLIC;
392 $profile = Profile::getKV('id', $profile_id);
393 if (!$profile instanceof Profile) {
394 // TRANS: Client exception thrown when trying to save a notice for an unknown user.
395 throw new ClientException(_('Problem saving notice. Unknown user.'));
398 $user = User::getKV('id', $profile_id);
399 if ($user instanceof User) {
400 // Use the local user's shortening preferences, if applicable.
401 $final = $user->shortenLinks($content);
403 $final = common_shorten_links($content);
406 if (Notice::contentTooLong($final)) {
407 // TRANS: Client exception thrown if a notice contains too many characters.
408 throw new ClientException(_('Problem saving notice. Too long.'));
411 if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
412 common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
413 // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
414 throw new ClientException(_('Too many notices too fast; take a breather '.
415 'and post again in a few minutes.'));
418 if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
419 common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
420 // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
421 throw new ClientException(_('Too many duplicate messages too quickly;'.
422 ' take a breather and post again in a few minutes.'));
425 if (!$profile->hasRight(Right::NEWNOTICE)) {
426 common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
428 // TRANS: Client exception thrown when a user tries to post while being banned.
429 throw new ClientException(_('You are banned from posting notices on this site.'), 403);
432 $notice = new Notice();
433 $notice->profile_id = $profile_id;
435 $autosource = common_config('public', 'autosource');
437 // Sandboxed are non-false, but not 1, either
439 if (!$profile->hasRight(Right::PUBLICNOTICE) ||
440 ($source && $autosource && in_array($source, $autosource))) {
441 $notice->is_local = Notice::LOCAL_NONPUBLIC;
443 $notice->is_local = $is_local;
446 if (!empty($created)) {
447 $notice->created = $created;
449 $notice->created = common_sql_now();
452 if (!$notice->isLocal()) {
453 // Only do these checks for non-local notices. Local notices will generate these values later.
454 if (!common_valid_http_url($url)) {
455 common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
458 throw new ServerException('No URI for remote notice. Cannot accept that.');
462 $notice->content = $final;
464 $notice->source = $source;
468 // Get the groups here so we can figure out replies and such
469 if (!isset($groups)) {
470 $groups = User_group::idsFromText($notice->content, $profile);
475 // Handle repeat case
477 if (isset($repeat_of)) {
479 // Check for a private one
481 $repeat = Notice::getKV('id', $repeat_of);
483 if (!($repeat instanceof Notice)) {
484 // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice.
485 throw new ClientException(_('Cannot repeat; original notice is missing or deleted.'));
488 if ($profile->id == $repeat->profile_id) {
489 // TRANS: Client error displayed when trying to repeat an own notice.
490 throw new ClientException(_('You cannot repeat your own notice.'));
493 if ($repeat->scope != Notice::SITE_SCOPE &&
494 $repeat->scope != Notice::PUBLIC_SCOPE) {
495 // TRANS: Client error displayed when trying to repeat a non-public notice.
496 throw new ClientException(_('Cannot repeat a private notice.'), 403);
499 if (!$repeat->inScope($profile)) {
500 // The generic checks above should cover this, but let's be sure!
501 // TRANS: Client error displayed when trying to repeat a notice you cannot access.
502 throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
505 if ($profile->hasRepeated($repeat)) {
506 // TRANS: Client error displayed when trying to repeat an already repeated notice.
507 throw new ClientException(_('You already repeated that notice.'));
510 $notice->repeat_of = $repeat_of;
512 $reply = self::getReplyTo($reply_to, $profile_id, $source, $final);
514 if (!empty($reply)) {
516 if (!$reply->inScope($profile)) {
517 // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
518 // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
519 throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'),
520 $profile->nickname, $reply->id), 403);
523 $notice->reply_to = $reply->id;
524 $notice->conversation = $reply->conversation;
526 // If the original is private to a group, and notice has no group specified,
527 // make it to the same group(s)
529 if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
531 $replyGroups = $reply->getGroups();
532 foreach ($replyGroups as $group) {
533 if ($profile->isMember($group)) {
534 $groups[] = $group->id;
543 if (!empty($lat) && !empty($lon)) {
548 if (!empty($location_ns) && !empty($location_id)) {
549 $notice->location_id = $location_id;
550 $notice->location_ns = $location_ns;
553 if (!empty($rendered)) {
554 $notice->rendered = $rendered;
556 $notice->rendered = common_render_content($final, $notice);
560 if (!empty($notice->repeat_of)) {
561 $notice->verb = ActivityVerb::SHARE;
562 $notice->object_type = ActivityObject::ACTIVITY;
564 $notice->verb = ActivityVerb::POST;
567 $notice->verb = $verb;
570 if (empty($object_type)) {
571 $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
573 $notice->object_type = $object_type;
576 if (is_null($scope)) { // 0 is a valid value
577 if (!empty($reply)) {
578 $notice->scope = $reply->scope;
580 $notice->scope = self::defaultScope();
583 $notice->scope = $scope;
586 // For private streams
589 $user = $profile->getUser();
591 if ($user->private_stream &&
592 ($notice->scope == Notice::PUBLIC_SCOPE ||
593 $notice->scope == Notice::SITE_SCOPE)) {
594 $notice->scope |= Notice::FOLLOWER_SCOPE;
596 } catch (NoSuchUserException $e) {
597 // Cannot handle private streams for remote profiles
600 // Force the scope for private groups
602 foreach ($groups as $groupId) {
603 $group = User_group::getKV('id', $groupId);
604 if ($group instanceof User_group) {
605 if ($group->force_scope) {
606 $notice->scope |= Notice::GROUP_SCOPE;
612 if (Event::handle('StartNoticeSave', array(&$notice))) {
614 // XXX: some of these functions write to the DB
616 $id = $notice->insert();
619 common_log_db_error($notice, 'INSERT', __FILE__);
620 // TRANS: Server exception thrown when a notice cannot be saved.
621 throw new ServerException(_('Problem saving notice.'));
624 // Update ID-dependent columns: URI, conversation
626 $orig = clone($notice);
630 // We can only get here if it's a local notice, since remote notices
631 // should've bailed out earlier due to lacking a URI.
632 if (empty($notice->uri)) {
633 $notice->uri = sprintf('%s%s=%d:%s=%s',
635 'noticeId', $notice->id,
636 'objectType', $notice->get_object_type(true));
640 // If it's not part of a conversation, it's
641 // the beginning of a new conversation.
643 if (empty($notice->conversation)) {
644 $conv = Conversation::create($notice);
645 $notice->conversation = $conv->id;
650 if ($notice->update($orig) === false) {
651 common_log_db_error($notice, 'UPDATE', __FILE__);
652 // TRANS: Server exception thrown when a notice cannot be updated.
653 throw new ServerException(_('Problem saving notice.'));
659 // Clear the cache for subscribed users, so they'll update at next request
660 // XXX: someone clever could prepend instead of clearing the cache
662 $notice->blowOnInsert();
664 // Save per-notice metadata...
666 if (isset($replies)) {
667 $notice->saveKnownReplies($replies);
669 $notice->saveReplies();
673 $notice->saveKnownTags($tags);
678 // Note: groups may save tags, so must be run after tags are saved
679 // to avoid errors on duplicates.
680 // Note: groups should always be set.
682 $notice->saveKnownGroups($groups);
685 $notice->saveKnownUrls($urls);
691 // Prepare inbox delivery, may be queued to background.
692 $notice->distribute();
698 function blowOnInsert($conversation = false)
700 $this->blowStream('profile:notice_ids:%d', $this->profile_id);
702 if ($this->isPublic()) {
703 $this->blowStream('public');
706 self::blow('notice:list-ids:conversation:%s', $this->conversation);
707 self::blow('conversation:notice_count:%d', $this->conversation);
709 if (!empty($this->repeat_of)) {
710 // XXX: we should probably only use one of these
711 $this->blowStream('notice:repeats:%d', $this->repeat_of);
712 self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
715 $original = Notice::getKV('id', $this->repeat_of);
717 if ($original instanceof Notice) {
718 $originalUser = User::getKV('id', $original->profile_id);
719 if ($originalUser instanceof User) {
720 $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
724 $profile = Profile::getKV($this->profile_id);
726 if ($profile instanceof Profile) {
727 $profile->blowNoticeCount();
730 $ptags = $this->getProfileTags();
731 foreach ($ptags as $ptag) {
732 $ptag->blowNoticeStreamCache();
737 * Clear cache entries related to this notice at delete time.
738 * Necessary to avoid breaking paging on public, profile timelines.
740 function blowOnDelete()
742 $this->blowOnInsert();
744 self::blow('profile:notice_ids:%d;last', $this->profile_id);
746 if ($this->isPublic()) {
747 self::blow('public;last');
750 self::blow('fave:by_notice', $this->id);
752 if ($this->conversation) {
753 // In case we're the first, will need to calc a new root.
754 self::blow('notice:conversation_root:%d', $this->conversation);
757 $ptags = $this->getProfileTags();
758 foreach ($ptags as $ptag) {
759 $ptag->blowNoticeStreamCache(true);
763 function blowStream()
765 $c = self::memcache();
771 $args = func_get_args();
773 $format = array_shift($args);
775 $keyPart = vsprintf($format, $args);
777 $cacheKey = Cache::key($keyPart);
779 $c->delete($cacheKey);
781 // delete the "last" stream, too, if this notice is
782 // older than the top of that stream
784 $lastKey = $cacheKey.';last';
786 $lastStr = $c->get($lastKey);
788 if ($lastStr !== false) {
789 $window = explode(',', $lastStr);
790 $lastID = $window[0];
791 $lastNotice = Notice::getKV('id', $lastID);
792 if (!$lastNotice instanceof Notice // just weird
793 || strtotime($lastNotice->created) >= strtotime($this->created)) {
794 $c->delete($lastKey);
799 /** save all urls in the notice to the db
801 * follow redirects and save all available file information
802 * (mimetype, date, size, oembed, etc.)
806 function saveUrls() {
807 if (common_config('attachments', 'process_links')) {
808 common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id);
813 * Save the given URLs as related links/attachments to the db
815 * follow redirects and save all available file information
816 * (mimetype, date, size, oembed, etc.)
820 function saveKnownUrls($urls)
822 if (common_config('attachments', 'process_links')) {
823 // @fixme validation?
824 foreach (array_unique($urls) as $url) {
825 File::processNew($url, $this->id);
833 function saveUrl($url, $notice_id) {
834 File::processNew($url, $notice_id);
837 static function checkDupes($profile_id, $content) {
838 $profile = Profile::getKV($profile_id);
839 if (!$profile instanceof Profile) {
842 $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
843 if (!empty($notice)) {
845 while ($notice->fetch()) {
846 if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
848 } else if ($notice->content == $content) {
853 // If we get here, oldest item in cache window is not
854 // old enough for dupe limit; do direct check against DB
855 $notice = new Notice();
856 $notice->profile_id = $profile_id;
857 $notice->content = $content;
858 $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
859 $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
861 $cnt = $notice->count();
865 static function checkEditThrottle($profile_id) {
866 $profile = Profile::getKV($profile_id);
867 if (!$profile instanceof Profile) {
870 // Get the Nth notice
871 $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
872 if ($notice && $notice->fetch()) {
873 // If the Nth notice was posted less than timespan seconds ago
874 if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
879 // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
883 protected $_attachments = -1;
885 function attachments() {
887 if ($this->_attachments != -1) {
888 return $this->_attachments;
891 $f2ps = File_to_post::listGet('post_id', array($this->id));
895 foreach ($f2ps[$this->id] as $f2p) {
896 $ids[] = $f2p->file_id;
899 $files = File::multiGet('id', $ids);
901 $this->_attachments = $files->fetchAll();
903 return $this->_attachments;
906 function _setAttachments($attachments)
908 $this->_attachments = $attachments;
911 function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
913 $stream = new PublicNoticeStream();
914 return $stream->getNotices($offset, $limit, $since_id, $max_id);
918 function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
920 $stream = new ConversationNoticeStream($id);
922 return $stream->getNotices($offset, $limit, $since_id, $max_id);
926 * Is this notice part of an active conversation?
928 * @return boolean true if other messages exist in the same
929 * conversation, false if this is the only one
931 function hasConversation()
933 if (!empty($this->conversation)) {
934 $conversation = Notice::conversationStream(
940 if ($conversation->N > 0) {
948 * Grab the earliest notice from this conversation.
950 * @return Notice or null
952 function conversationRoot($profile=-1)
954 // XXX: can this happen?
956 if (empty($this->conversation)) {
960 // Get the current profile if not specified
962 if (is_int($profile) && $profile == -1) {
963 $profile = Profile::current();
966 // If this notice is out of scope, no root for you!
968 if (!$this->inScope($profile)) {
972 // If this isn't a reply to anything, then it's its own
975 if (empty($this->reply_to)) {
979 if (is_null($profile)) {
980 $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
982 $keypart = sprintf('notice:conversation_root:%d:%d',
987 $root = self::cacheGet($keypart);
989 if ($root !== false && $root->inScope($profile)) {
996 $parent = $last->getParent();
997 if ($parent->inScope($profile)) {
1001 } catch (Exception $e) {
1002 // Latest notice has no parent
1004 // No parent, or parent out of scope
1009 self::cacheSet($keypart, $root);
1015 * Pull up a full list of local recipients who will be getting
1016 * this notice in their inbox. Results will be cached, so don't
1017 * change the input data wily-nilly!
1019 * @param array $groups optional list of Group objects;
1020 * if left empty, will be loaded from group_inbox records
1021 * @param array $recipient optional list of reply profile ids
1022 * if left empty, will be loaded from reply records
1023 * @return array associating recipient user IDs with an inbox source constant
1025 function whoGets(array $groups=null, array $recipients=null)
1027 $c = self::memcache();
1030 $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
1031 if ($ni !== false) {
1036 if (is_null($recipients)) {
1037 $recipients = $this->getReplies();
1042 // Give plugins a chance to add folks in at start...
1043 if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
1045 $users = $this->getSubscribedUsers();
1046 foreach ($users as $id) {
1047 $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
1050 if (is_null($groups)) {
1051 $groups = $this->getGroups();
1053 foreach ($groups as $group) {
1054 $users = $group->getUserMembers();
1055 foreach ($users as $id) {
1056 if (!array_key_exists($id, $ni)) {
1057 $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
1062 $ptAtts = $this->getAttentionsFromProfileTags();
1063 foreach ($ptAtts as $key=>$val) {
1064 if (!array_key_exists($key, $ni)) {
1069 foreach ($recipients as $recipient) {
1070 if (!array_key_exists($recipient, $ni)) {
1071 $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
1075 // Exclude any deleted, non-local, or blocking recipients.
1076 $profile = $this->getProfile();
1077 $originalProfile = null;
1078 if ($this->repeat_of) {
1079 // Check blocks against the original notice's poster as well.
1080 $original = Notice::getKV('id', $this->repeat_of);
1081 if ($original instanceof Notice) {
1082 $originalProfile = $original->getProfile();
1086 foreach ($ni as $id => $source) {
1088 $user = User::getKV('id', $id);
1089 if (!$user instanceof User ||
1090 $user->hasBlocked($profile) ||
1091 ($originalProfile && $user->hasBlocked($originalProfile))) {
1094 } catch (UserNoProfileException $e) {
1095 // User doesn't have a profile; invalid; skip them.
1100 // Give plugins a chance to filter out...
1101 Event::handle('EndNoticeWhoGets', array($this, &$ni));
1105 // XXX: pack this data better
1106 $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
1112 function getSubscribedUsers()
1116 if(common_config('db','quote_identifiers'))
1117 $user_table = '"user"';
1118 else $user_table = 'user';
1122 'FROM '. $user_table .' JOIN subscription '.
1123 'ON '. $user_table .'.id = subscription.subscriber ' .
1124 'WHERE subscription.subscribed = %d ';
1126 $user->query(sprintf($qry, $this->profile_id));
1130 while ($user->fetch()) {
1139 function getProfileTags()
1141 $profile = $this->getProfile();
1142 $list = $profile->getOtherTags($profile);
1145 while($list->fetch()) {
1146 $ptags[] = clone($list);
1152 public function getAttentionsFromProfileTags()
1155 $ptags = $this->getProfileTags();
1156 foreach ($ptags as $ptag) {
1157 $users = $ptag->getUserSubscribers();
1158 foreach ($users as $id) {
1159 $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
1166 * Record this notice to the given group inboxes for delivery.
1167 * Overrides the regular parsing of !group markup.
1169 * @param string $group_ids
1170 * @fixme might prefer URIs as identifiers, as for replies?
1171 * best with generalizations on user_group to support
1172 * remote groups better.
1174 function saveKnownGroups($group_ids)
1176 if (!is_array($group_ids)) {
1177 // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups().
1178 throw new ServerException(_('Bad type provided to saveKnownGroups.'));
1182 foreach (array_unique($group_ids) as $id) {
1183 $group = User_group::getKV('id', $id);
1184 if ($group instanceof User_group) {
1185 common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname");
1186 $result = $this->addToGroupInbox($group);
1188 common_log_db_error($gi, 'INSERT', __FILE__);
1191 if (common_config('group', 'addtag')) {
1192 // we automatically add a tag for every group name, too
1194 $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname),
1195 'notice_id' => $this->id));
1197 if (is_null($tag)) {
1198 $this->saveTag($group->nickname);
1202 $groups[] = clone($group);
1204 common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
1211 function addToGroupInbox(User_group $group)
1213 $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
1214 'notice_id' => $this->id));
1216 if (!$gi instanceof Group_inbox) {
1218 $gi = new Group_inbox();
1220 $gi->group_id = $group->id;
1221 $gi->notice_id = $this->id;
1222 $gi->created = $this->created;
1224 $result = $gi->insert();
1227 common_log_db_error($gi, 'INSERT', __FILE__);
1228 // TRANS: Server exception thrown when an update for a group inbox fails.
1229 throw new ServerException(_('Problem saving group inbox.'));
1232 self::blow('user_group:notice_ids:%d', $gi->group_id);
1239 * Save reply records indicating that this notice needs to be
1240 * delivered to the local users with the given URIs.
1242 * Since this is expected to be used when saving foreign-sourced
1243 * messages, we won't deliver to any remote targets as that's the
1244 * source service's responsibility.
1246 * Mail notifications etc will be handled later.
1248 * @param array $uris Array of unique identifier URIs for recipients
1250 function saveKnownReplies(array $uris)
1256 $sender = Profile::getKV($this->profile_id);
1258 foreach (array_unique($uris) as $uri) {
1260 $profile = Profile::fromURI($uri);
1262 if (!$profile instanceof Profile) {
1263 common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
1267 if ($profile->hasBlocked($sender)) {
1268 common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
1272 $this->saveReply($profile->id);
1273 self::blow('reply:stream:%d', $profile->id);
1280 * Pull @-replies from this message's content in StatusNet markup format
1281 * and save reply records indicating that this message needs to be
1282 * delivered to those users.
1284 * Mail notifications to local profiles will be sent later.
1286 * @return array of integer profile IDs
1289 function saveReplies()
1291 // Don't save reply data for repeats
1293 if (!empty($this->repeat_of)) {
1297 $sender = Profile::getKV($this->profile_id);
1301 // If it's a reply, save for the replied-to author
1303 $parent = $this->getParent();
1304 $author = $parent->getProfile();
1305 if ($author instanceof Profile) {
1306 $this->saveReply($author->id);
1307 $replied[$author->id] = 1;
1308 self::blow('reply:stream:%d', $author->id);
1310 } catch (Exception $e) {
1311 // Not a reply, since it has no parent!
1314 // @todo ideally this parser information would only
1315 // be calculated once.
1317 $mentions = common_find_mentions($this->content, $this);
1319 // store replied only for first @ (what user/notice what the reply directed,
1320 // we assume first @ is it)
1322 foreach ($mentions as $mention) {
1324 foreach ($mention['mentioned'] as $mentioned) {
1326 // skip if they're already covered
1328 if (!empty($replied[$mentioned->id])) {
1332 // Don't save replies from blocked profile to local user
1334 $mentioned_user = User::getKV('id', $mentioned->id);
1335 if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) {
1339 $this->saveReply($mentioned->id);
1340 $replied[$mentioned->id] = 1;
1341 self::blow('reply:stream:%d', $mentioned->id);
1345 $recipientIds = array_keys($replied);
1347 return $recipientIds;
1350 function saveReply($profileId)
1352 $reply = new Reply();
1354 $reply->notice_id = $this->id;
1355 $reply->profile_id = $profileId;
1356 $reply->modified = $this->created;
1363 protected $_replies = -1;
1366 * Pull the complete list of @-reply targets for this notice.
1368 * @return array of integer profile ids
1370 function getReplies()
1372 if ($this->_replies != -1) {
1373 return $this->_replies;
1376 $replyMap = Reply::listGet('notice_id', array($this->id));
1380 foreach ($replyMap[$this->id] as $reply) {
1381 $ids[] = $reply->profile_id;
1384 $this->_replies = $ids;
1389 function _setReplies($replies)
1391 $this->_replies = $replies;
1395 * Pull the complete list of @-reply targets for this notice.
1397 * @return array of Profiles
1399 function getReplyProfiles()
1401 $ids = $this->getReplies();
1403 $profiles = Profile::multiGet('id', $ids);
1405 return $profiles->fetchAll();
1409 * Send e-mail notifications to local @-reply targets.
1411 * Replies must already have been saved; this is expected to be run
1412 * from the distrib queue handler.
1414 function sendReplyNotifications()
1416 // Don't send reply notifications for repeats
1418 if (!empty($this->repeat_of)) {
1422 $recipientIds = $this->getReplies();
1424 foreach ($recipientIds as $recipientId) {
1425 $user = User::getKV('id', $recipientId);
1426 if ($user instanceof User) {
1427 mail_notify_attn($user, $this);
1433 * Pull list of groups this notice needs to be delivered to,
1434 * as previously recorded by saveKnownGroups().
1436 * @return array of Group objects
1439 protected $_groups = -1;
1441 function getGroups()
1443 // Don't save groups for repeats
1445 if (!empty($this->repeat_of)) {
1449 if ($this->_groups != -1)
1451 return $this->_groups;
1454 $gis = Group_inbox::listGet('notice_id', array($this->id));
1458 foreach ($gis[$this->id] as $gi)
1460 $ids[] = $gi->group_id;
1463 $groups = User_group::multiGet('id', $ids);
1465 $this->_groups = $groups->fetchAll();
1467 return $this->_groups;
1470 function _setGroups($groups)
1472 $this->_groups = $groups;
1476 * Convert a notice into an activity for export.
1478 * @param User $cur Current user
1480 * @return Activity activity object representing this Notice.
1483 function asActivity($cur=null)
1485 $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
1487 if ($act instanceof Activity) {
1490 $act = new Activity();
1492 if (Event::handle('StartNoticeAsActivity', array($this, &$act))) {
1494 $act->id = $this->uri;
1495 $act->time = strtotime($this->created);
1497 $act->link = $this->getUrl();
1498 } catch (InvalidUrlException $e) {
1499 // The notice is probably a share or similar, which don't
1500 // have a representational URL of their own.
1502 $act->content = common_xml_safe_str($this->rendered);
1504 $profile = $this->getProfile();
1506 $act->actor = ActivityObject::fromProfile($profile);
1507 $act->actor->extra[] = $profile->profileInfo($cur);
1509 $act->verb = $this->verb;
1511 if ($this->repeat_of) {
1512 $repeated = Notice::getKV('id', $this->repeat_of);
1513 if ($repeated instanceof Notice) {
1514 $act->objects[] = $repeated->asActivity($cur);
1517 $act->objects[] = ActivityObject::fromNotice($this);
1520 // XXX: should this be handled by default processing for object entry?
1524 $tags = $this->getTags();
1526 foreach ($tags as $tag) {
1527 $cat = new AtomCategory();
1530 $act->categories[] = $cat;
1534 // XXX: use Atom Media and/or File activity objects instead
1536 $attachments = $this->attachments();
1538 foreach ($attachments as $attachment) {
1539 // Save local attachments
1540 if (!empty($attachment->filename)) {
1541 $act->attachments[] = ActivityObject::fromFile($attachment);
1545 $ctx = new ActivityContext();
1548 $reply = $this->getParent();
1549 $ctx->replyToID = $reply->getUri();
1550 $ctx->replyToUrl = $reply->getUrl();
1551 } catch (Exception $e) {
1552 // This is not a reply to something
1555 $ctx->location = $this->getLocation();
1559 if (!empty($this->conversation)) {
1560 $conv = Conversation::getKV('id', $this->conversation);
1561 if ($conv instanceof Conversation) {
1562 $ctx->conversation = $conv->uri;
1566 $reply_ids = $this->getReplies();
1568 foreach ($reply_ids as $id) {
1569 $rprofile = Profile::getKV('id', $id);
1570 if ($rprofile instanceof Profile) {
1571 $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON;
1575 $groups = $this->getGroups();
1577 foreach ($groups as $group) {
1578 $ctx->attention[$group->getUri()] = ActivityObject::GROUP;
1581 switch ($this->scope) {
1582 case Notice::PUBLIC_SCOPE:
1583 $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
1585 case Notice::FOLLOWER_SCOPE:
1586 $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
1587 $ctx->attention[$surl] = ActivityObject::COLLECTION;
1591 $act->context = $ctx;
1593 $source = $this->getSource();
1595 if ($source instanceof Notice_source) {
1596 $act->generator = ActivityObject::fromNoticeSource($source);
1601 $atom_feed = $profile->getAtomFeed();
1603 if (!empty($atom_feed)) {
1605 $act->source = new ActivitySource();
1607 // XXX: we should store the actual feed ID
1609 $act->source->id = $atom_feed;
1611 // XXX: we should store the actual feed title
1613 $act->source->title = $profile->getBestName();
1615 $act->source->links['alternate'] = $profile->profileurl;
1616 $act->source->links['self'] = $atom_feed;
1618 $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
1620 $notice = $profile->getCurrentNotice();
1622 if ($notice instanceof Notice) {
1623 $act->source->updated = self::utcDate($notice->created);
1626 $user = User::getKV('id', $profile->id);
1628 if ($user instanceof User) {
1629 $act->source->links['license'] = common_config('license', 'url');
1633 if ($this->isLocal()) {
1634 $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id,
1635 'format' => 'atom'));
1636 $act->editLink = $act->selfLink;
1639 Event::handle('EndNoticeAsActivity', array($this, &$act));
1642 self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
1647 // This has gotten way too long. Needs to be sliced up into functional bits
1648 // or ideally exported to a utility class.
1650 function asAtomEntry($namespace=false,
1655 $act = $this->asActivity($cur);
1656 $act->extra[] = $this->noticeInfo($cur);
1657 return $act->asString($namespace, $author, $source);
1661 * Extra notice info for atom entries
1663 * Clients use some extra notice info in the atom stream.
1664 * This gives it to them.
1666 * @param User $cur Current user
1668 * @return array representation of <statusnet:notice_info> element
1671 function noticeInfo($cur)
1673 // local notice ID (useful to clients for ordering)
1675 $noticeInfoAttr = array('local_id' => $this->id);
1679 $ns = $this->getSource();
1681 if ($ns instanceof Notice_source) {
1682 $noticeInfoAttr['source'] = $ns->code;
1683 if (!empty($ns->url)) {
1684 $noticeInfoAttr['source_link'] = $ns->url;
1685 if (!empty($ns->name)) {
1686 $noticeInfoAttr['source'] = '<a href="'
1687 . htmlspecialchars($ns->url)
1688 . '" rel="nofollow">'
1689 . htmlspecialchars($ns->name)
1695 // favorite and repeated
1698 $cp = $cur->getProfile();
1699 $noticeInfoAttr['favorite'] = ($cp->hasFave($this)) ? "true" : "false";
1700 $noticeInfoAttr['repeated'] = ($cp->hasRepeated($this)) ? "true" : "false";
1703 if (!empty($this->repeat_of)) {
1704 $noticeInfoAttr['repeat_of'] = $this->repeat_of;
1707 return array('statusnet:notice_info', $noticeInfoAttr, null);
1711 * Returns an XML string fragment with a reference to a notice as an
1712 * Activity Streams noun object with the given element type.
1714 * Assumes that 'activity' namespace has been previously defined.
1716 * @param string $element one of 'subject', 'object', 'target'
1720 function asActivityNoun($element)
1722 $noun = ActivityObject::fromNotice($this);
1723 return $noun->asString('activity:' . $element);
1727 * Determine which notice, if any, a new notice is in reply to.
1729 * For conversation tracking, we try to see where this notice fits
1730 * in the tree. Rough algorithm is:
1732 * if (reply_to is set and valid) {
1734 * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
1735 * return ID of last notice by initial @name in content;
1738 * Note that all @nickname instances will still be used to save "reply" records,
1739 * so the notice shows up in the mentioned users' "replies" tab.
1741 * @param integer $reply_to ID passed in by Web or API
1742 * @param integer $profile_id ID of author
1743 * @param string $source Source tag, like 'web' or 'gwibber'
1744 * @param string $content Final notice content
1746 * @return integer ID of replied-to notice, or null for not a reply.
1749 static function getReplyTo($reply_to, $profile_id, $source, $content)
1751 static $lb = array('xmpp', 'mail', 'sms', 'omb');
1753 // If $reply_to is specified, we check that it exists, and then
1754 // return it if it does
1756 if (!empty($reply_to)) {
1757 $reply_notice = Notice::getKV('id', $reply_to);
1758 if ($reply_notice instanceof Notice) {
1759 return $reply_notice;
1763 // If it's not a "low bandwidth" source (one where you can't set
1764 // a reply_to argument), we return. This is mostly web and API
1767 if (!in_array($source, $lb)) {
1771 // Is there an initial @ or T?
1773 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) ||
1774 preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
1775 $nickname = common_canonical_nickname($match[1]);
1780 // Figure out who that is.
1782 $sender = Profile::getKV('id', $profile_id);
1783 if (!$sender instanceof Profile) {
1787 $recipient = common_relative_profile($sender, $nickname, common_sql_now());
1789 if (!$recipient instanceof Profile) {
1793 // Get their last notice
1795 $last = $recipient->getCurrentNotice();
1797 if ($last instanceof Notice) {
1804 static function maxContent()
1806 $contentlimit = common_config('notice', 'contentlimit');
1807 // null => use global limit (distinct from 0!)
1808 if (is_null($contentlimit)) {
1809 $contentlimit = common_config('site', 'textlimit');
1811 return $contentlimit;
1814 static function contentTooLong($content)
1816 $contentlimit = self::maxContent();
1817 return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
1820 function getLocation()
1824 if (!empty($this->location_id) && !empty($this->location_ns)) {
1825 $location = Location::fromId($this->location_id, $this->location_ns);
1828 if (is_null($location)) { // no ID, or Location::fromId() failed
1829 if (!empty($this->lat) && !empty($this->lon)) {
1830 $location = Location::fromLatLon($this->lat, $this->lon);
1838 * Convenience function for posting a repeat of an existing message.
1840 * @param int $repeater_id: profile ID of user doing the repeat
1841 * @param string $source: posting source key, eg 'web', 'api', etc
1844 * @throws Exception on failure or permission problems
1846 function repeat($repeater_id, $source)
1848 $author = Profile::getKV('id', $this->profile_id);
1850 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
1851 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
1852 $content = sprintf(_('RT @%1$s %2$s'),
1856 $maxlen = common_config('site', 'textlimit');
1857 if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
1858 // Web interface and current Twitter API clients will
1859 // pull the original notice's text, but some older
1860 // clients and RSS/Atom feeds will see this trimmed text.
1862 // Unfortunately this is likely to lose tags or URLs
1863 // at the end of long notices.
1864 $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
1867 // Scope is same as this one's
1869 return self::saveNew($repeater_id,
1872 array('repeat_of' => $this->id,
1873 'scope' => $this->scope));
1876 // These are supposed to be in chron order!
1878 function repeatStream($limit=100)
1880 $cache = Cache::instance();
1882 if (empty($cache)) {
1883 $ids = $this->_repeatStreamDirect($limit);
1885 $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
1886 if ($idstr !== false) {
1887 if (empty($idstr)) {
1890 $ids = explode(',', $idstr);
1893 $ids = $this->_repeatStreamDirect(100);
1894 $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
1897 // We do a max of 100, so slice down to limit
1898 $ids = array_slice($ids, 0, $limit);
1902 return NoticeStream::getStreamByIds($ids);
1905 function _repeatStreamDirect($limit)
1907 $notice = new Notice();
1909 $notice->selectAdd(); // clears it
1910 $notice->selectAdd('id');
1912 $notice->repeat_of = $this->id;
1914 $notice->orderBy('created, id'); // NB: asc!
1916 if (!is_null($limit)) {
1917 $notice->limit(0, $limit);
1920 return $notice->fetchAll('id');
1923 function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
1927 if (!empty($location_id) && !empty($location_ns)) {
1928 $options['location_id'] = $location_id;
1929 $options['location_ns'] = $location_ns;
1931 $location = Location::fromId($location_id, $location_ns);
1933 if ($location instanceof Location) {
1934 $options['lat'] = $location->lat;
1935 $options['lon'] = $location->lon;
1938 } else if (!empty($lat) && !empty($lon)) {
1939 $options['lat'] = $lat;
1940 $options['lon'] = $lon;
1942 $location = Location::fromLatLon($lat, $lon);
1944 if ($location instanceof Location) {
1945 $options['location_id'] = $location->location_id;
1946 $options['location_ns'] = $location->location_ns;
1948 } else if (!empty($profile)) {
1949 if (isset($profile->lat) && isset($profile->lon)) {
1950 $options['lat'] = $profile->lat;
1951 $options['lon'] = $profile->lon;
1954 if (isset($profile->location_id) && isset($profile->location_ns)) {
1955 $options['location_id'] = $profile->location_id;
1956 $options['location_ns'] = $profile->location_ns;
1963 function clearAttentions()
1965 $att = new Attention();
1966 $att->notice_id = $this->getID();
1969 while ($att->fetch()) {
1970 // Can't do delete() on the object directly since it won't remove all of it
1971 $other = clone($att);
1977 function clearReplies()
1979 $replyNotice = new Notice();
1980 $replyNotice->reply_to = $this->id;
1982 //Null any notices that are replies to this notice
1984 if ($replyNotice->find()) {
1985 while ($replyNotice->fetch()) {
1986 $orig = clone($replyNotice);
1987 $replyNotice->reply_to = null;
1988 $replyNotice->update($orig);
1994 $reply = new Reply();
1995 $reply->notice_id = $this->id;
1997 if ($reply->find()) {
1998 while($reply->fetch()) {
1999 self::blow('reply:stream:%d', $reply->profile_id);
2007 function clearFiles()
2009 $f2p = new File_to_post();
2011 $f2p->post_id = $this->id;
2014 while ($f2p->fetch()) {
2018 // FIXME: decide whether to delete File objects
2019 // ...and related (actual) files
2022 function clearRepeats()
2024 $repeatNotice = new Notice();
2025 $repeatNotice->repeat_of = $this->id;
2027 //Null any notices that are repeats of this notice
2029 if ($repeatNotice->find()) {
2030 while ($repeatNotice->fetch()) {
2031 $orig = clone($repeatNotice);
2032 $repeatNotice->repeat_of = null;
2033 $repeatNotice->update($orig);
2038 function clearFaves()
2041 $fave->notice_id = $this->id;
2043 if ($fave->find()) {
2044 while ($fave->fetch()) {
2045 self::blow('fave:ids_by_user_own:%d', $fave->user_id);
2046 self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
2047 self::blow('fave:ids_by_user:%d', $fave->user_id);
2048 self::blow('fave:ids_by_user:%d;last', $fave->user_id);
2056 function clearTags()
2058 $tag = new Notice_tag();
2059 $tag->notice_id = $this->id;
2062 while ($tag->fetch()) {
2063 self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
2064 self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
2065 self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
2066 self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
2074 function clearGroupInboxes()
2076 $gi = new Group_inbox();
2078 $gi->notice_id = $this->id;
2081 while ($gi->fetch()) {
2082 self::blow('user_group:notice_ids:%d', $gi->group_id);
2090 function distribute()
2092 // We always insert for the author so they don't
2094 Event::handle('StartNoticeDistribute', array($this));
2096 // If there's a failure, we want to _force_
2097 // distribution at this point.
2099 $qm = QueueManager::get();
2100 $qm->enqueue($this, 'distrib');
2101 } catch (Exception $e) {
2102 // If the exception isn't transient, this
2103 // may throw more exceptions as DQH does
2104 // its own enqueueing. So, we ignore them!
2106 $handler = new DistribQueueHandler();
2107 $handler->handle($this);
2108 } catch (Exception $e) {
2109 common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
2111 // Re-throw so somebody smarter can handle it.
2118 $result = parent::insert();
2120 if ($result !== false) {
2121 // Profile::hasRepeated() abuses pkeyGet(), so we
2122 // have to clear manually
2123 if (!empty($this->repeat_of)) {
2124 $c = self::memcache();
2126 $ck = self::multicacheKey('Notice',
2127 array('profile_id' => $this->profile_id,
2128 'repeat_of' => $this->repeat_of));
2138 * Get the source of the notice
2140 * @return Notice_source $ns A notice source object. 'code' is the only attribute
2141 * guaranteed to be populated.
2143 function getSource()
2145 $ns = new Notice_source();
2146 if (!empty($this->source)) {
2147 switch ($this->source) {
2154 $ns->code = $this->source;
2157 $ns = Notice_source::getKV($this->source);
2159 $ns = new Notice_source();
2160 $ns->code = $this->source;
2161 $app = Oauth_application::getKV('name', $this->source);
2163 $ns->name = $app->name;
2164 $ns->url = $app->source_url;
2174 * Determine whether the notice was locally created
2176 * @return boolean locality
2179 public function isLocal()
2181 return ($this->is_local == Notice::LOCAL_PUBLIC ||
2182 $this->is_local == Notice::LOCAL_NONPUBLIC);
2186 * Get the list of hash tags saved with this notice.
2188 * @return array of strings
2190 public function getTags()
2194 $keypart = sprintf('notice:tags:%d', $this->id);
2196 $tagstr = self::cacheGet($keypart);
2198 if ($tagstr !== false) {
2199 $tags = explode(',', $tagstr);
2201 $tag = new Notice_tag();
2202 $tag->notice_id = $this->id;
2204 while ($tag->fetch()) {
2205 $tags[] = $tag->tag;
2208 self::cacheSet($keypart, implode(',', $tags));
2214 static private function utcDate($dt)
2216 $dateStr = date('d F Y H:i:s', strtotime($dt));
2217 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
2218 return $d->format(DATE_W3C);
2222 * Look up the creation timestamp for a given notice ID, even
2223 * if it's been deleted.
2226 * @return mixed string recorded creation timestamp, or false if can't be found
2228 public static function getAsTimestamp($id)
2234 $notice = Notice::getKV('id', $id);
2236 return $notice->created;
2239 $deleted = Deleted_notice::getKV('id', $id);
2241 return $deleted->created;
2248 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2249 * parameter, matching notices posted after the given one (exclusive).
2251 * If the referenced notice can't be found, will return false.
2254 * @param string $idField
2255 * @param string $createdField
2256 * @return mixed string or false if no match
2258 public static function whereSinceId($id, $idField='id', $createdField='created')
2260 $since = Notice::getAsTimestamp($id);
2262 return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
2268 * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
2269 * parameter, matching notices posted after the given one (exclusive), and
2270 * if necessary add it to the data object's query.
2272 * @param DB_DataObject $obj
2274 * @param string $idField
2275 * @param string $createdField
2276 * @return mixed string or false if no match
2278 public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2280 $since = self::whereSinceId($id, $idField, $createdField);
2282 $obj->whereAdd($since);
2287 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2288 * parameter, matching notices posted before the given one (inclusive).
2290 * If the referenced notice can't be found, will return false.
2293 * @param string $idField
2294 * @param string $createdField
2295 * @return mixed string or false if no match
2297 public static function whereMaxId($id, $idField='id', $createdField='created')
2299 $max = Notice::getAsTimestamp($id);
2301 return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
2307 * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
2308 * parameter, matching notices posted before the given one (inclusive), and
2309 * if necessary add it to the data object's query.
2311 * @param DB_DataObject $obj
2313 * @param string $idField
2314 * @param string $createdField
2315 * @return mixed string or false if no match
2317 public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
2319 $max = self::whereMaxId($id, $idField, $createdField);
2321 $obj->whereAdd($max);
2327 if (common_config('public', 'localonly')) {
2328 return ($this->is_local == Notice::LOCAL_PUBLIC);
2330 return (($this->is_local != Notice::LOCAL_NONPUBLIC) &&
2331 ($this->is_local != Notice::GATEWAY));
2336 * Check that the given profile is allowed to read, respond to, or otherwise
2337 * act on this notice.
2339 * The $scope member is a bitmask of scopes, representing a logical AND of the
2340 * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
2341 * "only visible to people who are mentioned in the notice AND are users on this site."
2342 * Users on the site who are not mentioned in the notice will not be able to see the
2345 * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
2347 * @return boolean whether the profile is in the notice's scope
2349 function inScope($profile)
2351 if (is_null($profile)) {
2352 $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
2354 $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
2357 $result = self::cacheGet($keypart);
2359 if ($result === false) {
2361 if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
2362 $bResult = $this->_inScope($profile);
2363 Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
2365 $result = ($bResult) ? 1 : 0;
2366 self::cacheSet($keypart, $result, 0, 300);
2369 return ($result == 1) ? true : false;
2372 protected function _inScope($profile)
2374 if (!is_null($this->scope)) {
2375 $scope = $this->scope;
2377 $scope = self::defaultScope();
2380 // If there's no scope, anyone (even anon) is in scope.
2382 if ($scope == 0) { // Not private
2384 return !$this->isHiddenSpam($profile);
2386 } else { // Private, somehow
2388 // If there's scope, anon cannot be in scope
2390 if (empty($profile)) {
2394 // Author is always in scope
2396 if ($this->profile_id == $profile->id) {
2400 // Only for users on this site
2402 if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
2406 // Only for users mentioned in the notice
2408 if ($scope & Notice::ADDRESSEE_SCOPE) {
2410 $reply = Reply::pkeyGet(array('notice_id' => $this->id,
2411 'profile_id' => $profile->id));
2413 if (!$reply instanceof Reply) {
2418 // Only for members of the given group
2420 if ($scope & Notice::GROUP_SCOPE) {
2422 // XXX: just query for the single membership
2424 $groups = $this->getGroups();
2428 foreach ($groups as $group) {
2429 if ($profile->isMember($group)) {
2440 // Only for followers of the author
2444 if ($scope & Notice::FOLLOWER_SCOPE) {
2447 $author = $this->getProfile();
2448 } catch (Exception $e) {
2452 if (!Subscription::exists($profile, $author)) {
2457 return !$this->isHiddenSpam($profile);
2461 function isHiddenSpam($profile) {
2463 // Hide posts by silenced users from everyone but moderators.
2465 if (common_config('notice', 'hidespam')) {
2468 $author = $this->getProfile();
2469 } catch(Exception $e) {
2470 // If we can't get an author, keep it hidden.
2471 // XXX: technically not spam, but, whatever.
2475 if ($author->hasRole(Profile_role::SILENCED)) {
2476 if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
2485 public function getParent()
2487 $parent = Notice::getKV('id', $this->reply_to);
2489 if (!$parent instanceof Notice) {
2490 throw new ServerException('Notice has no parent');
2497 * Magic function called at serialize() time.
2499 * We use this to drop a couple process-specific references
2500 * from DB_DataObject which can cause trouble in future
2503 * @return array of variable names to include in serialization.
2508 $vars = parent::__sleep();
2509 $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
2510 return array_diff($vars, $skip);
2513 static function defaultScope()
2515 $scope = common_config('notice', 'defaultscope');
2516 if (is_null($scope)) {
2517 if (common_config('site', 'private')) {
2526 static function fillProfiles($notices)
2528 $map = self::getProfiles($notices);
2530 foreach ($notices as $entry=>$notice) {
2532 if (array_key_exists($notice->profile_id, $map)) {
2533 $notice->_setProfile($map[$notice->profile_id]);
2535 } catch (NoProfileException $e) {
2536 common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->id}");
2537 unset($notices[$entry]);
2541 return array_values($map);
2544 static function getProfiles(&$notices)
2547 foreach ($notices as $notice) {
2548 $ids[] = $notice->profile_id;
2551 $ids = array_unique($ids);
2553 return Profile::pivotGet('id', $ids);
2556 static function fillGroups(&$notices)
2558 $ids = self::_idsOf($notices);
2560 $gis = Group_inbox::listGet('notice_id', $ids);
2564 foreach ($gis as $id => $gi)
2568 $gids[] = $g->group_id;
2572 $gids = array_unique($gids);
2574 $group = User_group::pivotGet('id', $gids);
2576 foreach ($notices as $notice)
2579 $gi = $gis[$notice->id];
2580 foreach ($gi as $g) {
2581 $grps[] = $group[$g->group_id];
2583 $notice->_setGroups($grps);
2587 static function _idsOf(&$notices)
2590 foreach ($notices as $notice) {
2591 $ids[] = $notice->id;
2593 $ids = array_unique($ids);
2597 static function fillAttachments(&$notices)
2599 $ids = self::_idsOf($notices);
2601 $f2pMap = File_to_post::listGet('post_id', $ids);
2605 foreach ($f2pMap as $noticeId => $f2ps) {
2606 foreach ($f2ps as $f2p) {
2607 $fileIds[] = $f2p->file_id;
2611 $fileIds = array_unique($fileIds);
2613 $fileMap = File::pivotGet('id', $fileIds);
2615 foreach ($notices as $notice)
2618 $f2ps = $f2pMap[$notice->id];
2619 foreach ($f2ps as $f2p) {
2620 $files[] = $fileMap[$f2p->file_id];
2622 $notice->_setAttachments($files);
2629 * All faves of this notice
2631 * @return array Array of Fave objects
2636 if (isset($this->_faves) && is_array($this->_faves)) {
2637 return $this->_faves;
2639 $faveMap = Fave::listGet('notice_id', array($this->id));
2640 $this->_faves = $faveMap[$this->id];
2641 return $this->_faves;
2644 function _setFaves($faves)
2646 $this->_faves = $faves;
2649 static function fillFaves(&$notices)
2651 $ids = self::_idsOf($notices);
2652 $faveMap = Fave::listGet('notice_id', $ids);
2655 foreach ($faveMap as $id => $faves) {
2656 $cnt += count($faves);
2657 if (count($faves) > 0) {
2661 foreach ($notices as $notice) {
2662 $faves = $faveMap[$notice->id];
2663 $notice->_setFaves($faves);
2667 static function fillReplies(&$notices)
2669 $ids = self::_idsOf($notices);
2670 $replyMap = Reply::listGet('notice_id', $ids);
2671 foreach ($notices as $notice) {
2672 $replies = $replyMap[$notice->id];
2674 foreach ($replies as $reply) {
2675 $ids[] = $reply->profile_id;
2677 $notice->_setReplies($ids);
2681 protected $_repeats;
2683 function getRepeats()
2685 if (isset($this->_repeats) && is_array($this->_repeats)) {
2686 return $this->_repeats;
2688 $repeatMap = Notice::listGet('repeat_of', array($this->id));
2689 $this->_repeats = $repeatMap[$this->id];
2690 return $this->_repeats;
2693 function _setRepeats($repeats)
2695 $this->_repeats = $repeats;
2698 static function fillRepeats(&$notices)
2700 $ids = self::_idsOf($notices);
2701 $repeatMap = Notice::listGet('repeat_of', $ids);
2702 foreach ($notices as $notice) {
2703 $repeats = $repeatMap[$notice->id];
2704 $notice->_setRepeats($repeats);