. * * @category Notices * @package StatusNet * @author Brenda Wallace * @author Christopher Vollick * @author CiaranG * @author Craig Andrews * @author Evan Prodromou * @author Gina Haeussge * @author Jeffery To * @author Mike Cochrane * @author Robin Millette * @author Sarven Capadisli * @author Tom Adams * @author Mikael Nordfeldth * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org * @license GNU Affero General Public License http://www.gnu.org/licenses/ */ if (!defined('GNUSOCIAL')) { exit(1); } /** * Table Definition for notice */ /* We keep 200 notices, the max number of notices available per API request, * in the memcached cache. */ define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW); define('MAX_BOXCARS', 128); class Notice extends Managed_DataObject { ###START_AUTOCODE /* the code below is auto generated do not remove the above tag */ public $__table = 'notice'; // table name public $id; // int(4) primary_key not_null public $profile_id; // int(4) multiple_key not_null public $uri; // varchar(255) unique_key public $content; // text public $rendered; // text public $url; // varchar(255) public $created; // datetime multiple_key not_null default_0000-00-00%2000%3A00%3A00 public $modified; // timestamp not_null default_CURRENT_TIMESTAMP public $reply_to; // int(4) public $is_local; // int(4) public $source; // varchar(32) public $conversation; // int(4) public $lat; // decimal(10,7) public $lon; // decimal(10,7) public $location_id; // int(4) public $location_ns; // int(4) public $repeat_of; // int(4) public $verb; // varchar(255) public $object_type; // varchar(255) public $scope; // int(4) /* the code above is auto generated do not remove the tag below */ ###END_AUTOCODE public static function schemaDef() { $def = array( 'fields' => array( 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'), 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'), 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier, usually a tag URI'), 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8_general_ci'), 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'), 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of any attachment (image, video, bookmark, whatever)'), 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'), 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'), 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'), 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'), 'conversation' => array('type' => 'int', 'description' => 'id of root notice in this conversation'), 'lat' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'latitude'), 'lon' => array('type' => 'numeric', 'precision' => 10, 'scale' => 7, 'description' => 'longitude'), 'location_id' => array('type' => 'int', 'description' => 'location id if possible'), 'location_ns' => array('type' => 'int', 'description' => 'namespace for location'), 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'), 'object_type' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams object type', 'default' => 'http://activitystrea.ms/schema/1.0/note'), 'verb' => array('type' => 'varchar', 'length' => 255, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'), 'scope' => array('type' => 'int', 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = followers; null = default'), ), 'primary key' => array('id'), 'unique keys' => array( 'notice_uri_key' => array('uri'), ), 'foreign keys' => array( 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')), 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')), 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices? ), 'indexes' => array( 'notice_created_id_is_local_idx' => array('created', 'id', 'is_local'), 'notice_profile_id_idx' => array('profile_id', 'created', 'id'), 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'), 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'), 'notice_replyto_idx' => array('reply_to') ) ); if (common_config('search', 'type') == 'fulltext') { $def['fulltext indexes'] = array('content' => array('content')); } return $def; } /* Notice types */ const LOCAL_PUBLIC = 1; const REMOTE = 0; const LOCAL_NONPUBLIC = -1; const GATEWAY = -2; const PUBLIC_SCOPE = 0; // Useful fake constant const SITE_SCOPE = 1; const ADDRESSEE_SCOPE = 2; const GROUP_SCOPE = 4; const FOLLOWER_SCOPE = 8; protected $_profile = array(); /** * Will always return a profile, if anything fails it will * (through _setProfile) throw a NoProfileException. */ public function getProfile() { if (!isset($this->_profile[$this->profile_id])) { // We could've sent getKV directly to _setProfile, but occasionally we get // a "false" (instead of null), likely because it indicates a cache miss. $profile = Profile::getKV('id', $this->profile_id); $this->_setProfile($profile instanceof Profile ? $profile : null); } return $this->_profile[$this->profile_id]; } public function _setProfile(Profile $profile=null) { if (!$profile instanceof Profile) { throw new NoProfileException($this->profile_id); } $this->_profile[$this->profile_id] = $profile; } function delete($useWhere=false) { // For auditing purposes, save a record that the notice // was deleted. // @fixme we have some cases where things get re-run and so the // insert fails. $deleted = Deleted_notice::getKV('id', $this->id); if (!$deleted instanceof Deleted_notice) { $deleted = Deleted_notice::getKV('uri', $this->uri); } if (!$deleted instanceof Deleted_notice) { $deleted = new Deleted_notice(); $deleted->id = $this->id; $deleted->profile_id = $this->profile_id; $deleted->uri = $this->uri; $deleted->created = $this->created; $deleted->deleted = common_sql_now(); $deleted->insert(); } if (Event::handle('NoticeDeleteRelated', array($this))) { // Clear related records $this->clearReplies(); $this->clearRepeats(); $this->clearTags(); $this->clearGroupInboxes(); $this->clearFiles(); $this->clearAttentions(); // NOTE: we don't clear queue items } $result = parent::delete($useWhere); $this->blowOnDelete(); return $result; } public function getUri() { return $this->uri; } /* * Get a Notice object by URI. Will call external plugins for help * using the event StartGetNoticeFromURI. * * @param string $uri A unique identifier for a resource (notice in this case) */ static function fromUri($uri) { $notice = null; if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) { $notice = Notice::getKV('uri', $uri); Event::handle('EndGetNoticeFromUri', array($uri, $notice)); } if (!$notice instanceof Notice) { throw new UnknownUriException($uri); } return $notice; } /* * @param $root boolean If true, link to just the conversation root. * * @return URL to conversation */ public function getConversationUrl($anchor=true) { return Conversation::getUrlFromNotice($this, $anchor); } /* * Get the local representation URL of this notice. */ public function getLocalUrl() { return common_local_url('shownotice', array('notice' => $this->id), null, null, false); } public function getTitle() { $title = null; if (Event::handle('GetNoticeTitle', array($this, &$title))) { // TRANS: Title of a notice posted without a title value. // TRANS: %1$s is a user name, %2$s is the notice creation date/time. $title = sprintf(_('%1$s\'s status on %2$s'), $this->getProfile()->getFancyName(), common_exact_date($this->created)); } return $title; } public function getContent() { return $this->content; } /* * Get the original representation URL of this notice. */ public function getUrl() { // The risk is we start having empty urls and non-http uris... // and we can't really handle any other protocol right now. switch (true) { case common_valid_http_url($this->url): // should we allow non-http/https URLs? return $this->url; case $this->isLocal(): // let's generate a valid link to our locally available notice on demand return common_local_url('shownotice', array('notice' => $this->id), null, null, false); case common_valid_http_url($this->uri): return $this->uri; default: common_debug('No URL available for notice: id='.$this->id); throw new InvalidUrlException($this->url); } } public function get_object_type($canonical=false) { return $canonical ? ActivityObject::canonicalType($this->object_type) : $this->object_type; } public static function getByUri($uri) { $notice = new Notice(); $notice->uri = $uri; if (!$notice->find(true)) { throw new NoResultException($notice); } return $notice; } /** * Extract #hashtags from this notice's content and save them to the database. */ function saveTags() { /* extract all #hastags */ $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match); if (!$count) { return true; } /* Add them to the database */ return $this->saveKnownTags($match[1]); } /** * Record the given set of hash tags in the db for this notice. * Given tag strings will be normalized and checked for dupes. */ function saveKnownTags($hashtags) { //turn each into their canonical tag //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag for($i=0; $isaveTag($hashtag); self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag); } return true; } /** * Record a single hash tag as associated with this notice. * Tag format and uniqueness must be validated by caller. */ function saveTag($hashtag) { $tag = new Notice_tag(); $tag->notice_id = $this->id; $tag->tag = $hashtag; $tag->created = $this->created; $id = $tag->insert(); if (!$id) { // TRANS: Server exception. %s are the error details. throw new ServerException(sprintf(_('Database error inserting hashtag: %s.'), $last_error->message)); return; } // if it's saved, blow its cache $tag->blowCache(false); } /** * Save a new notice and push it out to subscribers' inboxes. * Poster's permissions are checked before sending. * * @param int $profile_id Profile ID of the poster * @param string $content source message text; links may be shortened * per current user's preference * @param string $source source key ('web', 'api', etc) * @param array $options Associative array of optional properties: * string 'created' timestamp of notice; defaults to now * int 'is_local' source/gateway ID, one of: * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline * Notice::REMOTE - Sent from a remote service; * hide from public timeline but show in * local "and friends" timelines * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline * Notice::GATEWAY - From another non-OStatus service; * will not appear in public views * float 'lat' decimal latitude for geolocation * float 'lon' decimal longitude for geolocation * int 'location_id' geoname identifier * int 'location_ns' geoname namespace to interpret location_id * int 'reply_to'; notice ID this is a reply to * int 'repeat_of'; notice ID this is a repeat of * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too) * string 'url' permalink to notice; defaults to local notice URL * string 'rendered' rendered HTML version of content * array 'replies' list of profile URIs for reply delivery in * place of extracting @-replies from content. * array 'groups' list of group IDs to deliver to, in place of * extracting ! tags from content * array 'tags' list of hashtag strings to save with the notice * in place of extracting # tags from content * array 'urls' list of attached/referred URLs to save with the * notice in place of extracting links from content * boolean 'distribute' whether to distribute the notice, default true * string 'object_type' URL of the associated object type (default ActivityObject::NOTE) * string 'verb' URL of the associated verb (default ActivityVerb::POST) * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise * * @fixme tag override * * @return Notice * @throws ClientException */ static function saveNew($profile_id, $content, $source, array $options=null) { $defaults = array('uri' => null, 'url' => null, 'reply_to' => null, 'repeat_of' => null, 'scope' => null, 'distribute' => true, 'object_type' => null, 'verb' => null); if (!empty($options) && is_array($options)) { $options = array_merge($defaults, $options); extract($options); } else { extract($defaults); } if (!isset($is_local)) { $is_local = Notice::LOCAL_PUBLIC; } $profile = Profile::getKV('id', $profile_id); if (!$profile instanceof Profile) { // TRANS: Client exception thrown when trying to save a notice for an unknown user. throw new ClientException(_('Problem saving notice. Unknown user.')); } $user = User::getKV('id', $profile_id); if ($user instanceof User) { // Use the local user's shortening preferences, if applicable. $final = $user->shortenLinks($content); } else { $final = common_shorten_links($content); } if (Notice::contentTooLong($final)) { // TRANS: Client exception thrown if a notice contains too many characters. throw new ClientException(_('Problem saving notice. Too long.')); } if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) { common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.'); // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame. throw new ClientException(_('Too many notices too fast; take a breather '. 'and post again in a few minutes.')); } if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) { common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.'); // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame. throw new ClientException(_('Too many duplicate messages too quickly;'. ' take a breather and post again in a few minutes.')); } if (!$profile->hasRight(Right::NEWNOTICE)) { common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname); // TRANS: Client exception thrown when a user tries to post while being banned. throw new ClientException(_('You are banned from posting notices on this site.'), 403); } $notice = new Notice(); $notice->profile_id = $profile_id; $autosource = common_config('public', 'autosource'); // Sandboxed are non-false, but not 1, either if (!$profile->hasRight(Right::PUBLICNOTICE) || ($source && $autosource && in_array($source, $autosource))) { $notice->is_local = Notice::LOCAL_NONPUBLIC; } else { $notice->is_local = $is_local; } if (!empty($created)) { $notice->created = $created; } else { $notice->created = common_sql_now(); } if (!$notice->isLocal()) { // Only do these checks for non-local notices. Local notices will generate these values later. if (!common_valid_http_url($url)) { common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.'); } if (empty($uri)) { throw new ServerException('No URI for remote notice. Cannot accept that.'); } } $notice->content = $final; $notice->source = $source; $notice->uri = $uri; $notice->url = $url; // Get the groups here so we can figure out replies and such if (!isset($groups)) { $groups = User_group::idsFromText($notice->content, $profile); } $reply = null; // Handle repeat case if (isset($repeat_of)) { // Check for a private one $repeat = Notice::getKV('id', $repeat_of); if (!($repeat instanceof Notice)) { // TRANS: Client exception thrown in notice when trying to repeat a missing or deleted notice. throw new ClientException(_('Cannot repeat; original notice is missing or deleted.')); } if ($profile->id == $repeat->profile_id) { // TRANS: Client error displayed when trying to repeat an own notice. throw new ClientException(_('You cannot repeat your own notice.')); } if ($repeat->scope != Notice::SITE_SCOPE && $repeat->scope != Notice::PUBLIC_SCOPE) { // TRANS: Client error displayed when trying to repeat a non-public notice. throw new ClientException(_('Cannot repeat a private notice.'), 403); } if (!$repeat->inScope($profile)) { // The generic checks above should cover this, but let's be sure! // TRANS: Client error displayed when trying to repeat a notice you cannot access. throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403); } if ($profile->hasRepeated($repeat)) { // TRANS: Client error displayed when trying to repeat an already repeated notice. throw new ClientException(_('You already repeated that notice.')); } $notice->repeat_of = $repeat->id; $notice->conversation = $repeat->conversation; } else { $reply = null; // If $reply_to is specified, we check that it exists, and then // return it if it does if (!empty($reply_to)) { $reply = Notice::getKV('id', $reply_to); } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) { // If the source lacks capability of sending the "reply_to" // metadata, let's try to find an inline replyto-reference. $reply = self::getInlineReplyTo($profile, $final); } if ($reply instanceof Notice) { if (!$reply->inScope($profile)) { // TRANS: Client error displayed when trying to reply to a notice a the target has no access to. // TRANS: %1$s is a user nickname, %2$d is a notice ID (number). throw new ClientException(sprintf(_('%1$s has no access to notice %2$d.'), $profile->nickname, $reply->id), 403); } // If it's a repeat, the reply_to should be to the original if (!empty($reply->repeat_of)) { $notice->reply_to = $reply->repeat_of; } else { $notice->reply_to = $reply->id; } // But the conversation ought to be the same :) $notice->conversation = $reply->conversation; // If the original is private to a group, and notice has // no group specified, make it to the same group(s) if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) { $groups = array(); $replyGroups = $reply->getGroups(); foreach ($replyGroups as $group) { if ($profile->isMember($group)) { $groups[] = $group->id; } } } // Scope set below } } if (!empty($lat) && !empty($lon)) { $notice->lat = $lat; $notice->lon = $lon; } if (!empty($location_ns) && !empty($location_id)) { $notice->location_id = $location_id; $notice->location_ns = $location_ns; } if (!empty($rendered)) { $notice->rendered = $rendered; } else { $notice->rendered = common_render_content($final, $notice); } if (empty($verb)) { if (!empty($notice->repeat_of)) { $notice->verb = ActivityVerb::SHARE; $notice->object_type = ActivityObject::ACTIVITY; } else { $notice->verb = ActivityVerb::POST; } } else { $notice->verb = $verb; } if (empty($object_type)) { $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT; } else { $notice->object_type = $object_type; } if (is_null($scope) && $reply instanceof Notice) { $notice->scope = $reply->scope; } else { $notice->scope = $scope; } $notice->scope = self::figureOutScope($profile, $groups, $notice->scope); if (Event::handle('StartNoticeSave', array(&$notice))) { // XXX: some of these functions write to the DB try { $notice->insert(); // throws exception on failure } catch (Exception $e) { // Let's test if we managed initial insert, which would imply // failing on some update-part (check 'insert()'). Delete if // something had been stored to the database. if (!empty($notice->id)) { $notice->delete(); } } } // Clear the cache for subscribed users, so they'll update at next request // XXX: someone clever could prepend instead of clearing the cache // Save per-notice metadata... if (isset($replies)) { $notice->saveKnownReplies($replies); } else { $notice->saveReplies(); } if (isset($tags)) { $notice->saveKnownTags($tags); } else { $notice->saveTags(); } // Note: groups may save tags, so must be run after tags are saved // to avoid errors on duplicates. // Note: groups should always be set. $notice->saveKnownGroups($groups); if (isset($urls)) { $notice->saveKnownUrls($urls); } else { $notice->saveUrls(); } if ($distribute) { // Prepare inbox delivery, may be queued to background. $notice->distribute(); } return $notice; } static function saveActivity(Activity $act, Profile $actor, array $options=array()) { // First check if we're going to let this Activity through from the specific actor if (!$actor->hasRight(Right::NEWNOTICE)) { common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname()); // TRANS: Client exception thrown when a user tries to post while being banned. throw new ClientException(_m('You are banned from posting notices on this site.'), 403); } if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) { common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.'); // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame. throw new ClientException(_m('Too many notices too fast; take a breather '. 'and post again in a few minutes.')); } /* This interferes with stuff like Favorites from old StatusNet installations (first object in objects is the favored notice) // Get ActivityObject properties $actobj = count($act->objects)==1 ? $act->objects[0] : null; if (!is_null($actobj) && $actobj->id) { $options['uri'] = $actobj->id; if ($actobj->link) { $options['url'] = $actobj->link; } elseif ($act->link) { $options['url'] = $act->link; } elseif (preg_match('!^https?://!', $actobj->id)) { $options['url'] = $actobj->id; } } else { // implied object $options['uri'] = $act->id; $options['url'] = $act->link; } */ $defaults = array( 'groups' => array(), 'is_local' => self::LOCAL_PUBLIC, 'mentions' => array(), 'reply_to' => null, 'repeat_of' => null, 'scope' => null, 'source' => 'unknown', 'tags' => array(), 'uri' => null, 'url' => null, 'urls' => array(), 'distribute' => true); // options will have default values when nothing has been supplied $options = array_merge($defaults, $options); foreach (array_keys($defaults) as $key) { // Only convert the keynames we specify ourselves from 'defaults' array into variables $$key = $options[$key]; } extract($options, EXTR_SKIP); $stored = new Notice(); if (!empty($uri)) { $stored->uri = $uri; if ($stored->find()) { common_debug('cannot create duplicate Notice URI: '.$stored->uri); throw new Exception('Notice URI already exists'); } } $stored->profile_id = $actor->id; $stored->source = $source; $stored->uri = $uri; $stored->url = $url; $stored->verb = $act->verb; $autosource = common_config('public', 'autosource'); // Sandboxed are non-false, but not 1, either if (!$actor->hasRight(Right::PUBLICNOTICE) || ($source && $autosource && in_array($source, $autosource))) { $stored->is_local = Notice::LOCAL_NONPUBLIC; } // Maybe a missing act-time should be fatal if the actor is not local? if (!empty($act->time)) { $stored->created = common_sql_date($act->time); } else { $stored->created = common_sql_now(); } $reply = null; if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) { $reply = self::getKV('uri', $act->context->replyToID); } if (!$reply instanceof Notice && $act->target instanceof ActivityObject) { $reply = self::getKV('uri', $act->target->id); } if ($reply instanceof Notice) { if (!$reply->inScope($actor)) { // TRANS: Client error displayed when trying to reply to a notice a the target has no access to. // TRANS: %1$s is a user nickname, %2$d is a notice ID (number). throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403); } $stored->reply_to = $reply->id; $stored->conversation = $reply->conversation; // If the original is private to a group, and notice has no group specified, // make it to the same group(s) if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) { $groups = array(); $replyGroups = $reply->getGroups(); foreach ($replyGroups as $group) { if ($actor->isMember($group)) { $groups[] = $group->id; } } } if (is_null($scope)) { $scope = $reply->scope; } } if ($act->context instanceof ActivityContext) { $location = $act->context->location; if ($location) { $stored->lat = $location->lat; $stored->lon = $location->lon; if ($location->location_id) { $stored->location_ns = $location->location_ns; $stored->location_id = $location->location_id; } } } else { $act->context = new ActivityContext(); } $stored->scope = self::figureOutScope($actor, $groups, $scope); foreach ($act->categories as $cat) { if ($cat->term) { $term = common_canonical_tag($cat->term); if (!empty($term)) { $tags[] = $term; } } } foreach ($act->enclosures as $href) { // @todo FIXME: Save these locally or....? $urls[] = $href; } if (Event::handle('StartNoticeSave', array(&$stored))) { // XXX: some of these functions write to the DB try { $stored->insert(); // throws exception on error $object = null; Event::handle('StoreActivityObject', array($act, $stored, $options, &$object)); if (empty($object)) { throw new ServerException('No object from StoreActivityObject '.$stored->uri . ': '.$act->asString()); } $orig = clone($stored); $stored->object_type = ActivityUtils::resolveUri($object->getObjectType(), true); $stored->update($orig); } catch (Exception $e) { if (empty($stored->id)) { common_debug('Failed to save stored object entry in database ('.$e->getMessage().')'); } else { common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id); $stored->delete(); } throw $e; } } if (!$stored instanceof Notice) { throw new ServerException('StartNoticeSave did not give back a Notice'); } // Save per-notice metadata... $mentions = array(); $groups = array(); // This event lets plugins filter out non-local recipients (attentions we don't care about) // Used primarily for OStatus (and if we don't federate, all attentions would be local anyway) Event::handle('GetLocalAttentions', array($actor, $act->context->attention, &$mentions, &$groups)); if (!empty($mentions)) { $stored->saveKnownReplies($mentions); } else { $stored->saveReplies(); } if (!empty($tags)) { $stored->saveKnownTags($tags); } else { $stored->saveTags(); } // Note: groups may save tags, so must be run after tags are saved // to avoid errors on duplicates. // Note: groups should always be set. $stored->saveKnownGroups($groups); if (!empty($urls)) { $stored->saveKnownUrls($urls); } else { $stored->saveUrls(); } if ($distribute) { // Prepare inbox delivery, may be queued to background. $stored->distribute(); } return $stored; } static public function figureOutScope(Profile $actor, array $groups, $scope=null) { if (is_null($scope)) { $scope = self::defaultScope(); } // For private streams try { $user = $actor->getUser(); // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.) if ($user->private_stream && ($scope == Notice::PUBLIC_SCOPE || $scope == Notice::SITE_SCOPE)) { $scope |= Notice::FOLLOWER_SCOPE; } } catch (NoSuchUserException $e) { // TODO: Not a local user, so we don't know about scope preferences... yet! } // Force the scope for private groups foreach ($groups as $group_id) { $group = User_group::staticGet('id', $group_id); if ($group instanceof User_group) { if ($group->force_scope) { $scope |= Notice::GROUP_SCOPE; break; } } } return $scope; } function blowOnInsert($conversation = false) { $this->blowStream('profile:notice_ids:%d', $this->profile_id); if ($this->isPublic()) { $this->blowStream('public'); } self::blow('notice:list-ids:conversation:%s', $this->conversation); self::blow('conversation:notice_count:%d', $this->conversation); if (!empty($this->repeat_of)) { // XXX: we should probably only use one of these $this->blowStream('notice:repeats:%d', $this->repeat_of); self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of); } $original = Notice::getKV('id', $this->repeat_of); if ($original instanceof Notice) { $originalUser = User::getKV('id', $original->profile_id); if ($originalUser instanceof User) { $this->blowStream('user:repeats_of_me:%d', $originalUser->id); } } $profile = Profile::getKV($this->profile_id); if ($profile instanceof Profile) { $profile->blowNoticeCount(); } $ptags = $this->getProfileTags(); foreach ($ptags as $ptag) { $ptag->blowNoticeStreamCache(); } } /** * Clear cache entries related to this notice at delete time. * Necessary to avoid breaking paging on public, profile timelines. */ function blowOnDelete() { $this->blowOnInsert(); self::blow('profile:notice_ids:%d;last', $this->profile_id); if ($this->isPublic()) { self::blow('public;last'); } self::blow('fave:by_notice', $this->id); if ($this->conversation) { // In case we're the first, will need to calc a new root. self::blow('notice:conversation_root:%d', $this->conversation); } $ptags = $this->getProfileTags(); foreach ($ptags as $ptag) { $ptag->blowNoticeStreamCache(true); } } function blowStream() { $c = self::memcache(); if (empty($c)) { return false; } $args = func_get_args(); $format = array_shift($args); $keyPart = vsprintf($format, $args); $cacheKey = Cache::key($keyPart); $c->delete($cacheKey); // delete the "last" stream, too, if this notice is // older than the top of that stream $lastKey = $cacheKey.';last'; $lastStr = $c->get($lastKey); if ($lastStr !== false) { $window = explode(',', $lastStr); $lastID = $window[0]; $lastNotice = Notice::getKV('id', $lastID); if (!$lastNotice instanceof Notice // just weird || strtotime($lastNotice->created) >= strtotime($this->created)) { $c->delete($lastKey); } } } /** save all urls in the notice to the db * * follow redirects and save all available file information * (mimetype, date, size, oembed, etc.) * * @return void */ function saveUrls() { if (common_config('attachments', 'process_links')) { common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this->id); } } /** * Save the given URLs as related links/attachments to the db * * follow redirects and save all available file information * (mimetype, date, size, oembed, etc.) * * @return void */ function saveKnownUrls($urls) { if (common_config('attachments', 'process_links')) { // @fixme validation? foreach (array_unique($urls) as $url) { try { File::processNew($url, $this->id); } catch (ServerException $e) { // Could not save URL. Log it? } } } } /** * @private callback */ function saveUrl($url, $notice_id) { try { File::processNew($url, $notice_id); } catch (ServerException $e) { // Could not save URL. Log it? } } static function checkDupes($profile_id, $content) { $profile = Profile::getKV($profile_id); if (!$profile instanceof Profile) { return false; } $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW); if (!empty($notice)) { $last = 0; while ($notice->fetch()) { if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) { return true; } else if ($notice->content == $content) { return false; } } } // If we get here, oldest item in cache window is not // old enough for dupe limit; do direct check against DB $notice = new Notice(); $notice->profile_id = $profile_id; $notice->content = $content; $threshold = common_sql_date(time() - common_config('site', 'dupelimit')); $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold))); $cnt = $notice->count(); return ($cnt == 0); } static function checkEditThrottle($profile_id) { $profile = Profile::getKV($profile_id); if (!$profile instanceof Profile) { return false; } // Get the Nth notice $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1); if ($notice && $notice->fetch()) { // If the Nth notice was posted less than timespan seconds ago if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) { // Then we throttle return false; } } // Either not N notices in the stream, OR the Nth was not posted within timespan seconds return true; } protected $_attachments = array(); function attachments() { if (isset($this->_attachments[$this->id])) { return $this->_attachments[$this->id]; } $f2ps = File_to_post::listGet('post_id', array($this->id)); $ids = array(); foreach ($f2ps[$this->id] as $f2p) { $ids[] = $f2p->file_id; } $files = File::multiGet('id', $ids); $this->_attachments[$this->id] = $files->fetchAll(); return $this->_attachments[$this->id]; } function _setAttachments($attachments) { $this->_attachments[$this->id] = $attachments; } function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0) { $stream = new PublicNoticeStream(); return $stream->getNotices($offset, $limit, $since_id, $max_id); } function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0) { $stream = new ConversationNoticeStream($id); return $stream->getNotices($offset, $limit, $since_id, $max_id); } /** * Is this notice part of an active conversation? * * @return boolean true if other messages exist in the same * conversation, false if this is the only one */ function hasConversation() { if (!empty($this->conversation)) { $conversation = Notice::conversationStream( $this->conversation, 1, 1 ); if ($conversation->N > 0) { return true; } } return false; } /** * Grab the earliest notice from this conversation. * * @return Notice or null */ function conversationRoot($profile=-1) { // XXX: can this happen? if (empty($this->conversation)) { return null; } // Get the current profile if not specified if (is_int($profile) && $profile == -1) { $profile = Profile::current(); } // If this notice is out of scope, no root for you! if (!$this->inScope($profile)) { return null; } // If this isn't a reply to anything, then it's its own // root. if (empty($this->reply_to)) { return $this; } if (is_null($profile)) { $keypart = sprintf('notice:conversation_root:%d:null', $this->id); } else { $keypart = sprintf('notice:conversation_root:%d:%d', $this->id, $profile->id); } $root = self::cacheGet($keypart); if ($root !== false && $root->inScope($profile)) { return $root; } $last = $this; while (true) { try { $parent = $last->getParent(); if ($parent->inScope($profile)) { $last = $parent; continue; } } catch (Exception $e) { // Latest notice has no parent } // No parent, or parent out of scope $root = $last; break; } self::cacheSet($keypart, $root); return $root; } /** * Pull up a full list of local recipients who will be getting * this notice in their inbox. Results will be cached, so don't * change the input data wily-nilly! * * @param array $groups optional list of Group objects; * if left empty, will be loaded from group_inbox records * @param array $recipient optional list of reply profile ids * if left empty, will be loaded from reply records * @return array associating recipient user IDs with an inbox source constant */ function whoGets(array $groups=null, array $recipients=null) { $c = self::memcache(); if (!empty($c)) { $ni = $c->get(Cache::key('notice:who_gets:'.$this->id)); if ($ni !== false) { return $ni; } } if (is_null($recipients)) { $recipients = $this->getReplies(); } $ni = array(); // Give plugins a chance to add folks in at start... if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) { $users = $this->getSubscribedUsers(); foreach ($users as $id) { $ni[$id] = NOTICE_INBOX_SOURCE_SUB; } if (is_null($groups)) { $groups = $this->getGroups(); } foreach ($groups as $group) { $users = $group->getUserMembers(); foreach ($users as $id) { if (!array_key_exists($id, $ni)) { $ni[$id] = NOTICE_INBOX_SOURCE_GROUP; } } } $ptAtts = $this->getAttentionsFromProfileTags(); foreach ($ptAtts as $key=>$val) { if (!array_key_exists($key, $ni)) { $ni[$key] = $val; } } foreach ($recipients as $recipient) { if (!array_key_exists($recipient, $ni)) { $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY; } } // Exclude any deleted, non-local, or blocking recipients. $profile = $this->getProfile(); $originalProfile = null; if ($this->repeat_of) { // Check blocks against the original notice's poster as well. $original = Notice::getKV('id', $this->repeat_of); if ($original instanceof Notice) { $originalProfile = $original->getProfile(); } } foreach ($ni as $id => $source) { try { $user = User::getKV('id', $id); if (!$user instanceof User || $user->hasBlocked($profile) || ($originalProfile && $user->hasBlocked($originalProfile))) { unset($ni[$id]); } } catch (UserNoProfileException $e) { // User doesn't have a profile; invalid; skip them. unset($ni[$id]); } } // Give plugins a chance to filter out... Event::handle('EndNoticeWhoGets', array($this, &$ni)); } if (!empty($c)) { // XXX: pack this data better $c->set(Cache::key('notice:who_gets:'.$this->id), $ni); } return $ni; } function getSubscribedUsers() { $user = new User(); if(common_config('db','quote_identifiers')) $user_table = '"user"'; else $user_table = 'user'; $qry = 'SELECT id ' . 'FROM '. $user_table .' JOIN subscription '. 'ON '. $user_table .'.id = subscription.subscriber ' . 'WHERE subscription.subscribed = %d '; $user->query(sprintf($qry, $this->profile_id)); $ids = array(); while ($user->fetch()) { $ids[] = $user->id; } $user->free(); return $ids; } function getProfileTags() { $profile = $this->getProfile(); $list = $profile->getOtherTags($profile); $ptags = array(); while($list->fetch()) { $ptags[] = clone($list); } return $ptags; } public function getAttentionsFromProfileTags() { $ni = array(); $ptags = $this->getProfileTags(); foreach ($ptags as $ptag) { $users = $ptag->getUserSubscribers(); foreach ($users as $id) { $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG; } } return $ni; } /** * Record this notice to the given group inboxes for delivery. * Overrides the regular parsing of !group markup. * * @param string $group_ids * @fixme might prefer URIs as identifiers, as for replies? * best with generalizations on user_group to support * remote groups better. */ function saveKnownGroups($group_ids) { if (!is_array($group_ids)) { // TRANS: Server exception thrown when no array is provided to the method saveKnownGroups(). throw new ServerException(_('Bad type provided to saveKnownGroups.')); } $groups = array(); foreach (array_unique($group_ids) as $id) { $group = User_group::getKV('id', $id); if ($group instanceof User_group) { common_log(LOG_ERR, "Local delivery to group id $id, $group->nickname"); $result = $this->addToGroupInbox($group); if (!$result) { common_log_db_error($gi, 'INSERT', __FILE__); } if (common_config('group', 'addtag')) { // we automatically add a tag for every group name, too $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->nickname), 'notice_id' => $this->id)); if (is_null($tag)) { $this->saveTag($group->nickname); } } $groups[] = clone($group); } else { common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist"); } } return $groups; } function addToGroupInbox(User_group $group) { $gi = Group_inbox::pkeyGet(array('group_id' => $group->id, 'notice_id' => $this->id)); if (!$gi instanceof Group_inbox) { $gi = new Group_inbox(); $gi->group_id = $group->id; $gi->notice_id = $this->id; $gi->created = $this->created; $result = $gi->insert(); if (!$result) { common_log_db_error($gi, 'INSERT', __FILE__); // TRANS: Server exception thrown when an update for a group inbox fails. throw new ServerException(_('Problem saving group inbox.')); } self::blow('user_group:notice_ids:%d', $gi->group_id); } return true; } /** * Save reply records indicating that this notice needs to be * delivered to the local users with the given URIs. * * Since this is expected to be used when saving foreign-sourced * messages, we won't deliver to any remote targets as that's the * source service's responsibility. * * Mail notifications etc will be handled later. * * @param array $uris Array of unique identifier URIs for recipients */ function saveKnownReplies(array $uris) { if (empty($uris)) { return; } $sender = Profile::getKV($this->profile_id); foreach (array_unique($uris) as $uri) { try { $profile = Profile::fromUri($uri); } catch (UnknownUriException $e) { common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'"); continue; } if ($profile->hasBlocked($sender)) { common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block."); continue; } $this->saveReply($profile->id); self::blow('reply:stream:%d', $profile->id); } return; } /** * Pull @-replies from this message's content in StatusNet markup format * and save reply records indicating that this message needs to be * delivered to those users. * * Mail notifications to local profiles will be sent later. * * @return array of integer profile IDs */ function saveReplies() { // Don't save reply data for repeats if (!empty($this->repeat_of)) { return array(); } $sender = $this->getProfile(); $replied = array(); // If it's a reply, save for the replied-to author try { $parent = $this->getParent(); $parentauthor = $parent->getProfile(); $this->saveReply($parentauthor->id); $replied[$parentauthor->id] = 1; self::blow('reply:stream:%d', $parentauthor->id); } catch (Exception $e) { // Not a reply, since it has no parent! } // @todo ideally this parser information would only // be calculated once. $mentions = common_find_mentions($this->content, $this); // store replied only for first @ (what user/notice what the reply directed, // we assume first @ is it) foreach ($mentions as $mention) { foreach ($mention['mentioned'] as $mentioned) { // skip if they're already covered if (!empty($replied[$mentioned->id])) { continue; } // Don't save replies from blocked profile to local user $mentioned_user = User::getKV('id', $mentioned->id); if ($mentioned_user instanceof User && $mentioned_user->hasBlocked($sender)) { continue; } $this->saveReply($mentioned->id); $replied[$mentioned->id] = 1; self::blow('reply:stream:%d', $mentioned->id); } } $recipientIds = array_keys($replied); return $recipientIds; } function saveReply($profileId) { $reply = new Reply(); $reply->notice_id = $this->id; $reply->profile_id = $profileId; $reply->modified = $this->created; $reply->insert(); return $reply; } protected $_replies = array(); /** * Pull the complete list of @-reply targets for this notice. * * @return array of integer profile ids */ function getReplies() { if (isset($this->_replies[$this->id])) { return $this->_replies[$this->id]; } $replyMap = Reply::listGet('notice_id', array($this->id)); $ids = array(); foreach ($replyMap[$this->id] as $reply) { $ids[] = $reply->profile_id; } $this->_replies[$this->id] = $ids; return $ids; } function _setReplies($replies) { $this->_replies[$this->id] = $replies; } /** * Pull the complete list of @-reply targets for this notice. * * @return array of Profiles */ function getReplyProfiles() { $ids = $this->getReplies(); $profiles = Profile::multiGet('id', $ids); return $profiles->fetchAll(); } /** * Send e-mail notifications to local @-reply targets. * * Replies must already have been saved; this is expected to be run * from the distrib queue handler. */ function sendReplyNotifications() { // Don't send reply notifications for repeats if (!empty($this->repeat_of)) { return array(); } $recipientIds = $this->getReplies(); foreach ($recipientIds as $recipientId) { $user = User::getKV('id', $recipientId); if ($user instanceof User) { mail_notify_attn($user, $this); } } } /** * Pull list of groups this notice needs to be delivered to, * as previously recorded by saveKnownGroups(). * * @return array of Group objects */ protected $_groups = array(); function getGroups() { // Don't save groups for repeats if (!empty($this->repeat_of)) { return array(); } if (isset($this->_groups[$this->id])) { return $this->_groups[$this->id]; } $gis = Group_inbox::listGet('notice_id', array($this->id)); $ids = array(); foreach ($gis[$this->id] as $gi) { $ids[] = $gi->group_id; } $groups = User_group::multiGet('id', $ids); $this->_groups[$this->id] = $groups->fetchAll(); return $this->_groups[$this->id]; } function _setGroups($groups) { $this->_groups[$this->id] = $groups; } /** * Convert a notice into an activity for export. * * @param User $cur Current user * * @return Activity activity object representing this Notice. */ function asActivity($cur=null) { $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id)); if ($act instanceof Activity) { return $act; } $act = new Activity(); if (Event::handle('StartNoticeAsActivity', array($this, &$act))) { $act->id = $this->uri; $act->time = strtotime($this->created); try { $act->link = $this->getUrl(); } catch (InvalidUrlException $e) { // The notice is probably a share or similar, which don't // have a representational URL of their own. } $act->content = common_xml_safe_str($this->rendered); $profile = $this->getProfile(); $act->actor = $profile->asActivityObject(); $act->actor->extra[] = $profile->profileInfo($cur); $act->verb = $this->verb; if ($this->repeat_of) { $repeated = Notice::getKV('id', $this->repeat_of); if ($repeated instanceof Notice) { $act->objects[] = $repeated->asActivity($cur); } } else { $act->objects[] = $this->asActivityObject(); } // XXX: should this be handled by default processing for object entry? // Categories $tags = $this->getTags(); foreach ($tags as $tag) { $cat = new AtomCategory(); $cat->term = $tag; $act->categories[] = $cat; } // Enclosures // XXX: use Atom Media and/or File activity objects instead $attachments = $this->attachments(); foreach ($attachments as $attachment) { // Save local attachments if (!empty($attachment->filename)) { $act->attachments[] = ActivityObject::fromFile($attachment); } } $ctx = new ActivityContext(); try { $reply = $this->getParent(); $ctx->replyToID = $reply->getUri(); $ctx->replyToUrl = $reply->getUrl(); } catch (Exception $e) { // This is not a reply to something } $ctx->location = $this->getLocation(); $conv = null; if (!empty($this->conversation)) { $conv = Conversation::getKV('id', $this->conversation); if ($conv instanceof Conversation) { $ctx->conversation = $conv->uri; } } $reply_ids = $this->getReplies(); foreach ($reply_ids as $id) { $rprofile = Profile::getKV('id', $id); if ($rprofile instanceof Profile) { $ctx->attention[$rprofile->getUri()] = ActivityObject::PERSON; } } $groups = $this->getGroups(); foreach ($groups as $group) { $ctx->attention[$group->getUri()] = ActivityObject::GROUP; } switch ($this->scope) { case Notice::PUBLIC_SCOPE: $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION; break; case Notice::FOLLOWER_SCOPE: $surl = common_local_url("subscribers", array('nickname' => $profile->nickname)); $ctx->attention[$surl] = ActivityObject::COLLECTION; break; } $act->context = $ctx; $source = $this->getSource(); if ($source instanceof Notice_source) { $act->generator = ActivityObject::fromNoticeSource($source); } // Source $atom_feed = $profile->getAtomFeed(); if (!empty($atom_feed)) { $act->source = new ActivitySource(); // XXX: we should store the actual feed ID $act->source->id = $atom_feed; // XXX: we should store the actual feed title $act->source->title = $profile->getBestName(); $act->source->links['alternate'] = $profile->profileurl; $act->source->links['self'] = $atom_feed; $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE); $notice = $profile->getCurrentNotice(); if ($notice instanceof Notice) { $act->source->updated = self::utcDate($notice->created); } $user = User::getKV('id', $profile->id); if ($user instanceof User) { $act->source->links['license'] = common_config('license', 'url'); } } if ($this->isLocal()) { $act->selfLink = common_local_url('ApiStatusesShow', array('id' => $this->id, 'format' => 'atom')); $act->editLink = $act->selfLink; } Event::handle('EndNoticeAsActivity', array($this, &$act)); } self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act); return $act; } // This has gotten way too long. Needs to be sliced up into functional bits // or ideally exported to a utility class. function asAtomEntry($namespace=false, $source=false, $author=true, $cur=null) { $act = $this->asActivity($cur); $act->extra[] = $this->noticeInfo($cur); return $act->asString($namespace, $author, $source); } /** * Extra notice info for atom entries * * Clients use some extra notice info in the atom stream. * This gives it to them. * * @param User $cur Current user * * @return array representation of element */ function noticeInfo($cur) { // local notice ID (useful to clients for ordering) $noticeInfoAttr = array('local_id' => $this->id); // notice source $ns = $this->getSource(); if ($ns instanceof Notice_source) { $noticeInfoAttr['source'] = $ns->code; if (!empty($ns->url)) { $noticeInfoAttr['source_link'] = $ns->url; if (!empty($ns->name)) { $noticeInfoAttr['source'] = '' . htmlspecialchars($ns->name) . ''; } } } // favorite and repeated $scoped = null; if (!empty($cur)) { $scoped = $cur->getProfile(); $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false"; } if (!empty($this->repeat_of)) { $noticeInfoAttr['repeat_of'] = $this->repeat_of; } Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped)); return array('statusnet:notice_info', $noticeInfoAttr, null); } /** * Returns an XML string fragment with a reference to a notice as an * Activity Streams noun object with the given element type. * * Assumes that 'activity' namespace has been previously defined. * * @param string $element one of 'subject', 'object', 'target' * @return string */ function asActivityNoun($element) { $noun = $this->asActivityObject(); return $noun->asString('activity:' . $element); } public function asActivityObject() { $object = new ActivityObject(); if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) { $object->type = $this->object_type ?: ActivityObject::NOTE; $object->id = $this->getUri(); $object->title = sprintf('New %1$s by %2$s', $object->type, $this->getProfile()->getNickname()); $object->content = $this->rendered; $object->link = $this->getUrl(); $object->extra[] = array('status_net', array('notice_id' => $this->id)); Event::handle('EndActivityObjectFromNotice', array($this, &$object)); } return $object; } /** * Determine which notice, if any, a new notice is in reply to. * * For conversation tracking, we try to see where this notice fits * in the tree. Beware that this may very well give false positives * and add replies to wrong threads (if there have been newer posts * by the same user as we're replying to). * * @param Profile $sender Author profile * @param string $content Final notice content * * @return integer ID of replied-to notice, or null for not a reply. */ static function getInlineReplyTo(Profile $sender, $content) { // Is there an initial @ or T? if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match) || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) { $nickname = common_canonical_nickname($match[1]); } else { return null; } // Figure out who that is. $recipient = common_relative_profile($sender, $nickname, common_sql_now()); if ($recipient instanceof Profile) { // Get their last notice $last = $recipient->getCurrentNotice(); if ($last instanceof Notice) { return $last; } // Maybe in the future we want to handle something else below // so don't return getCurrentNotice() immediately. } return null; } static function maxContent() { $contentlimit = common_config('notice', 'contentlimit'); // null => use global limit (distinct from 0!) if (is_null($contentlimit)) { $contentlimit = common_config('site', 'textlimit'); } return $contentlimit; } static function contentTooLong($content) { $contentlimit = self::maxContent(); return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit)); } function getLocation() { $location = null; if (!empty($this->location_id) && !empty($this->location_ns)) { $location = Location::fromId($this->location_id, $this->location_ns); } if (is_null($location)) { // no ID, or Location::fromId() failed if (!empty($this->lat) && !empty($this->lon)) { $location = Location::fromLatLon($this->lat, $this->lon); } } return $location; } /** * Convenience function for posting a repeat of an existing message. * * @param Profile $repeater Profile which is doing the repeat * @param string $source: posting source key, eg 'web', 'api', etc * @return Notice * * @throws Exception on failure or permission problems */ function repeat(Profile $repeater, $source) { $author = $this->getProfile(); // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'. // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice. $content = sprintf(_('RT @%1$s %2$s'), $author->getNickname(), $this->content); // Scope is same as this one's return self::saveNew($repeater->id, $content, $source, array('repeat_of' => $this->id, 'scope' => $this->scope)); } // These are supposed to be in chron order! function repeatStream($limit=100) { $cache = Cache::instance(); if (empty($cache)) { $ids = $this->_repeatStreamDirect($limit); } else { $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id)); if ($idstr !== false) { if (empty($idstr)) { $ids = array(); } else { $ids = explode(',', $idstr); } } else { $ids = $this->_repeatStreamDirect(100); $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids)); } if ($limit < 100) { // We do a max of 100, so slice down to limit $ids = array_slice($ids, 0, $limit); } } return NoticeStream::getStreamByIds($ids); } function _repeatStreamDirect($limit) { $notice = new Notice(); $notice->selectAdd(); // clears it $notice->selectAdd('id'); $notice->repeat_of = $this->id; $notice->orderBy('created, id'); // NB: asc! if (!is_null($limit)) { $notice->limit(0, $limit); } return $notice->fetchAll('id'); } function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null) { $options = array(); if (!empty($location_id) && !empty($location_ns)) { $options['location_id'] = $location_id; $options['location_ns'] = $location_ns; $location = Location::fromId($location_id, $location_ns); if ($location instanceof Location) { $options['lat'] = $location->lat; $options['lon'] = $location->lon; } } else if (!empty($lat) && !empty($lon)) { $options['lat'] = $lat; $options['lon'] = $lon; $location = Location::fromLatLon($lat, $lon); if ($location instanceof Location) { $options['location_id'] = $location->location_id; $options['location_ns'] = $location->location_ns; } } else if (!empty($profile)) { if (isset($profile->lat) && isset($profile->lon)) { $options['lat'] = $profile->lat; $options['lon'] = $profile->lon; } if (isset($profile->location_id) && isset($profile->location_ns)) { $options['location_id'] = $profile->location_id; $options['location_ns'] = $profile->location_ns; } } return $options; } function clearAttentions() { $att = new Attention(); $att->notice_id = $this->getID(); if ($att->find()) { while ($att->fetch()) { // Can't do delete() on the object directly since it won't remove all of it $other = clone($att); $other->delete(); } } } function clearReplies() { $replyNotice = new Notice(); $replyNotice->reply_to = $this->id; //Null any notices that are replies to this notice if ($replyNotice->find()) { while ($replyNotice->fetch()) { $orig = clone($replyNotice); $replyNotice->reply_to = null; $replyNotice->update($orig); } } // Reply records $reply = new Reply(); $reply->notice_id = $this->id; if ($reply->find()) { while($reply->fetch()) { self::blow('reply:stream:%d', $reply->profile_id); $reply->delete(); } } $reply->free(); } function clearFiles() { $f2p = new File_to_post(); $f2p->post_id = $this->id; if ($f2p->find()) { while ($f2p->fetch()) { $f2p->delete(); } } // FIXME: decide whether to delete File objects // ...and related (actual) files } function clearRepeats() { $repeatNotice = new Notice(); $repeatNotice->repeat_of = $this->id; //Null any notices that are repeats of this notice if ($repeatNotice->find()) { while ($repeatNotice->fetch()) { $orig = clone($repeatNotice); $repeatNotice->repeat_of = null; $repeatNotice->update($orig); } } } function clearTags() { $tag = new Notice_tag(); $tag->notice_id = $this->id; if ($tag->find()) { while ($tag->fetch()) { self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag)); self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag)); self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag)); self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag)); $tag->delete(); } } $tag->free(); } function clearGroupInboxes() { $gi = new Group_inbox(); $gi->notice_id = $this->id; if ($gi->find()) { while ($gi->fetch()) { self::blow('user_group:notice_ids:%d', $gi->group_id); $gi->delete(); } } $gi->free(); } function distribute() { // We always insert for the author so they don't // have to wait Event::handle('StartNoticeDistribute', array($this)); // If there's a failure, we want to _force_ // distribution at this point. try { $qm = QueueManager::get(); $qm->enqueue($this, 'distrib'); } catch (Exception $e) { // If the exception isn't transient, this // may throw more exceptions as DQH does // its own enqueueing. So, we ignore them! try { $handler = new DistribQueueHandler(); $handler->handle($this); } catch (Exception $e) { common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage()); } // Re-throw so somebody smarter can handle it. throw $e; } } function insert() { $result = parent::insert(); if ($result === false) { common_log_db_error($this, 'INSERT', __FILE__); // TRANS: Server exception thrown when a stored object entry cannot be saved. throw new ServerException('Could not save Notice'); } // Profile::hasRepeated() abuses pkeyGet(), so we // have to clear manually if (!empty($this->repeat_of)) { $c = self::memcache(); if (!empty($c)) { $ck = self::multicacheKey('Notice', array('profile_id' => $this->profile_id, 'repeat_of' => $this->repeat_of)); $c->delete($ck); } } // Update possibly ID-dependent columns: URI, conversation // (now that INSERT has added the notice's local id) $orig = clone($this); $changed = false; // We can only get here if it's a local notice, since remote notices // should've bailed out earlier due to lacking a URI. if (empty($this->uri)) { $this->uri = sprintf('%s%s=%d:%s=%s', TagURI::mint(), 'noticeId', $this->id, 'objectType', $this->get_object_type(true)); $changed = true; } // If it's not part of a conversation, it's // the beginning of a new conversation. if (empty($this->conversation)) { $conv = Conversation::create($this); $this->conversation = $conv->id; $changed = true; } if ($changed && $this->update($orig) === false) { common_log_db_error($notice, 'UPDATE', __FILE__); // TRANS: Server exception thrown when a notice cannot be updated. throw new ServerException(_('Problem saving notice.')); } $this->blowOnInsert(); return $result; } /** * Get the source of the notice * * @return Notice_source $ns A notice source object. 'code' is the only attribute * guaranteed to be populated. */ function getSource() { $ns = new Notice_source(); if (!empty($this->source)) { switch ($this->source) { case 'web': case 'xmpp': case 'mail': case 'omb': case 'system': case 'api': $ns->code = $this->source; break; default: $ns = Notice_source::getKV($this->source); if (!$ns) { $ns = new Notice_source(); $ns->code = $this->source; $app = Oauth_application::getKV('name', $this->source); if ($app) { $ns->name = $app->name; $ns->url = $app->source_url; } } break; } } return $ns; } /** * Determine whether the notice was locally created * * @return boolean locality */ public function isLocal() { return ($this->is_local == Notice::LOCAL_PUBLIC || $this->is_local == Notice::LOCAL_NONPUBLIC); } /** * Get the list of hash tags saved with this notice. * * @return array of strings */ public function getTags() { $tags = array(); $keypart = sprintf('notice:tags:%d', $this->id); $tagstr = self::cacheGet($keypart); if ($tagstr !== false) { $tags = explode(',', $tagstr); } else { $tag = new Notice_tag(); $tag->notice_id = $this->id; if ($tag->find()) { while ($tag->fetch()) { $tags[] = $tag->tag; } } self::cacheSet($keypart, implode(',', $tags)); } return $tags; } static private function utcDate($dt) { $dateStr = date('d F Y H:i:s', strtotime($dt)); $d = new DateTime($dateStr, new DateTimeZone('UTC')); return $d->format(DATE_W3C); } /** * Look up the creation timestamp for a given notice ID, even * if it's been deleted. * * @param int $id * @return mixed string recorded creation timestamp, or false if can't be found */ public static function getAsTimestamp($id) { if (!$id) { return false; } $notice = Notice::getKV('id', $id); if ($notice) { return $notice->created; } $deleted = Deleted_notice::getKV('id', $id); if ($deleted) { return $deleted->created; } return false; } /** * Build an SQL 'where' fragment for timestamp-based sorting from a since_id * parameter, matching notices posted after the given one (exclusive). * * If the referenced notice can't be found, will return false. * * @param int $id * @param string $idField * @param string $createdField * @return mixed string or false if no match */ public static function whereSinceId($id, $idField='id', $createdField='created') { $since = Notice::getAsTimestamp($id); if ($since) { return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since); } return false; } /** * Build an SQL 'where' fragment for timestamp-based sorting from a since_id * parameter, matching notices posted after the given one (exclusive), and * if necessary add it to the data object's query. * * @param DB_DataObject $obj * @param int $id * @param string $idField * @param string $createdField * @return mixed string or false if no match */ public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created') { $since = self::whereSinceId($id, $idField, $createdField); if ($since) { $obj->whereAdd($since); } } /** * Build an SQL 'where' fragment for timestamp-based sorting from a max_id * parameter, matching notices posted before the given one (inclusive). * * If the referenced notice can't be found, will return false. * * @param int $id * @param string $idField * @param string $createdField * @return mixed string or false if no match */ public static function whereMaxId($id, $idField='id', $createdField='created') { $max = Notice::getAsTimestamp($id); if ($max) { return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id); } return false; } /** * Build an SQL 'where' fragment for timestamp-based sorting from a max_id * parameter, matching notices posted before the given one (inclusive), and * if necessary add it to the data object's query. * * @param DB_DataObject $obj * @param int $id * @param string $idField * @param string $createdField * @return mixed string or false if no match */ public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created') { $max = self::whereMaxId($id, $idField, $createdField); if ($max) { $obj->whereAdd($max); } } function isPublic() { if (common_config('public', 'localonly')) { return ($this->is_local == Notice::LOCAL_PUBLIC); } else { return (($this->is_local != Notice::LOCAL_NONPUBLIC) && ($this->is_local != Notice::GATEWAY)); } } /** * Check that the given profile is allowed to read, respond to, or otherwise * act on this notice. * * The $scope member is a bitmask of scopes, representing a logical AND of the * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means * "only visible to people who are mentioned in the notice AND are users on this site." * Users on the site who are not mentioned in the notice will not be able to see the * notice. * * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users. * * @return boolean whether the profile is in the notice's scope */ function inScope($profile) { if (is_null($profile)) { $keypart = sprintf('notice:in-scope-for:%d:null', $this->id); } else { $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id); } $result = self::cacheGet($keypart); if ($result === false) { $bResult = false; if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) { $bResult = $this->_inScope($profile); Event::handle('EndNoticeInScope', array($this, $profile, &$bResult)); } $result = ($bResult) ? 1 : 0; self::cacheSet($keypart, $result, 0, 300); } return ($result == 1) ? true : false; } protected function _inScope($profile) { if (!is_null($this->scope)) { $scope = $this->scope; } else { $scope = self::defaultScope(); } // If there's no scope, anyone (even anon) is in scope. if ($scope == 0) { // Not private return !$this->isHiddenSpam($profile); } else { // Private, somehow // If there's scope, anon cannot be in scope if (empty($profile)) { return false; } // Author is always in scope if ($this->profile_id == $profile->id) { return true; } // Only for users on this site if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) { return false; } // Only for users mentioned in the notice if ($scope & Notice::ADDRESSEE_SCOPE) { $reply = Reply::pkeyGet(array('notice_id' => $this->id, 'profile_id' => $profile->id)); if (!$reply instanceof Reply) { return false; } } // Only for members of the given group if ($scope & Notice::GROUP_SCOPE) { // XXX: just query for the single membership $groups = $this->getGroups(); $foundOne = false; foreach ($groups as $group) { if ($profile->isMember($group)) { $foundOne = true; break; } } if (!$foundOne) { return false; } } // Only for followers of the author $author = null; if ($scope & Notice::FOLLOWER_SCOPE) { try { $author = $this->getProfile(); } catch (Exception $e) { return false; } if (!Subscription::exists($profile, $author)) { return false; } } return !$this->isHiddenSpam($profile); } } function isHiddenSpam($profile) { // Hide posts by silenced users from everyone but moderators. if (common_config('notice', 'hidespam')) { try { $author = $this->getProfile(); } catch(Exception $e) { // If we can't get an author, keep it hidden. // XXX: technically not spam, but, whatever. return true; } if ($author->hasRole(Profile_role::SILENCED)) { if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) { return true; } } } return false; } public function getParent() { $parent = Notice::getKV('id', $this->reply_to); if (!$parent instanceof Notice) { throw new ServerException('Notice has no parent'); } return $parent; } /** * Magic function called at serialize() time. * * We use this to drop a couple process-specific references * from DB_DataObject which can cause trouble in future * processes. * * @return array of variable names to include in serialization. */ function __sleep() { $vars = parent::__sleep(); $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats'); return array_diff($vars, $skip); } static function defaultScope() { $scope = common_config('notice', 'defaultscope'); if (is_null($scope)) { if (common_config('site', 'private')) { $scope = 1; } else { $scope = 0; } } return $scope; } static function fillProfiles($notices) { $map = self::getProfiles($notices); foreach ($notices as $entry=>$notice) { try { if (array_key_exists($notice->profile_id, $map)) { $notice->_setProfile($map[$notice->profile_id]); } } catch (NoProfileException $e) { common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}"); unset($notices[$entry]); } } return array_values($map); } static function getProfiles(&$notices) { $ids = array(); foreach ($notices as $notice) { $ids[] = $notice->profile_id; } $ids = array_unique($ids); return Profile::pivotGet('id', $ids); } static function fillGroups(&$notices) { $ids = self::_idsOf($notices); $gis = Group_inbox::listGet('notice_id', $ids); $gids = array(); foreach ($gis as $id => $gi) { foreach ($gi as $g) { $gids[] = $g->group_id; } } $gids = array_unique($gids); $group = User_group::pivotGet('id', $gids); foreach ($notices as $notice) { $grps = array(); $gi = $gis[$notice->id]; foreach ($gi as $g) { $grps[] = $group[$g->group_id]; } $notice->_setGroups($grps); } } static function _idsOf(array &$notices) { $ids = array(); foreach ($notices as $notice) { $ids[$notice->id] = true; } return array_keys($ids); } static function fillAttachments(&$notices) { $ids = self::_idsOf($notices); $f2pMap = File_to_post::listGet('post_id', $ids); $fileIds = array(); foreach ($f2pMap as $noticeId => $f2ps) { foreach ($f2ps as $f2p) { $fileIds[] = $f2p->file_id; } } $fileIds = array_unique($fileIds); $fileMap = File::pivotGet('id', $fileIds); foreach ($notices as $notice) { $files = array(); $f2ps = $f2pMap[$notice->id]; foreach ($f2ps as $f2p) { $files[] = $fileMap[$f2p->file_id]; } $notice->_setAttachments($files); } } static function fillReplies(&$notices) { $ids = self::_idsOf($notices); $replyMap = Reply::listGet('notice_id', $ids); foreach ($notices as $notice) { $replies = $replyMap[$notice->id]; $ids = array(); foreach ($replies as $reply) { $ids[] = $reply->profile_id; } $notice->_setReplies($ids); } } protected $_repeats = array(); function getRepeats() { if (isset($this->_repeats[$this->id])) { return $this->_repeats[$this->id]; } $repeatMap = Notice::listGet('repeat_of', array($this->id)); $this->_repeats[$this->id] = $repeatMap[$this->id]; return $this->_repeats[$this->id]; } function _setRepeats($repeats) { $this->_repeats[$this->id] = $repeats; } static function fillRepeats(&$notices) { $ids = self::_idsOf($notices); $repeatMap = Notice::listGet('repeat_of', $ids); foreach ($notices as $notice) { $repeats = $repeatMap[$notice->id]; $notice->_setRepeats($repeats); } } }