/classes/Notice.php
PHP | 2158 lines | 1372 code | 428 blank | 358 comment | 267 complexity | e56d6f4c7a503ad9b5b1cf961f3f8dae MD5 | raw file
Possible License(s): AGPL-3.0, GPL-2.0, LGPL-2.1, MIT, MPL-2.0-no-copyleft-exception, BSD-3-Clause
Large files files are truncated, but you can click here to view the full file
- <?php
- /**
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category Notices
- * @package StatusNet
- * @author Brenda Wallace <shiny@cpan.org>
- * @author Christopher Vollick <psycotica0@gmail.com>
- * @author CiaranG <ciaran@ciarang.com>
- * @author Craig Andrews <candrews@integralblue.com>
- * @author Evan Prodromou <evan@controlezvous.ca>
- * @author Gina Haeussge <osd@foosel.net>
- * @author Jeffery To <jeffery.to@gmail.com>
- * @author Mike Cochrane <mikec@mikenz.geek.nz>
- * @author Robin Millette <millette@controlyourself.ca>
- * @author Sarven Capadisli <csarven@controlyourself.ca>
- * @author Tom Adams <tom@holizz.com>
- * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
- * @license GNU Affero General Public License http://www.gnu.org/licenses/
- */
- if (!defined('STATUSNET') && !defined('LACONICA')) {
- exit(1);
- }
- /**
- * Table Definition for notice
- */
- require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
- /* We keep 200 notices, the max number of notices available per API request,
- * in the memcached cache. */
- define('NOTICE_CACHE_WINDOW', 200);
- define('MAX_BOXCARS', 128);
- class Notice extends Memcached_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)
- /* Static get */
- function staticGet($k,$v=NULL)
- {
- return Memcached_DataObject::staticGet('Notice',$k,$v);
- }
- /* the code above is auto generated do not remove the tag below */
- ###END_AUTOCODE
- /* Notice types */
- const LOCAL_PUBLIC = 1;
- const REMOTE_OMB = 0;
- const LOCAL_NONPUBLIC = -1;
- const GATEWAY = -2;
- function getProfile()
- {
- $profile = Profile::staticGet('id', $this->profile_id);
- if (empty($profile)) {
- // TRANS: Server exception thrown when a user profile for a notice cannot be found.
- // TRANS: %1$d is a profile ID (number), %2$d is a notice ID (number).
- throw new ServerException(sprintf(_('No such profile (%1$d) for notice (%2$d).'), $this->profile_id, $this->id));
- }
- return $profile;
- }
- function delete()
- {
- // 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::staticGet('id', $this->id);
- if (!$deleted) {
- $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->clearFaves();
- $this->clearTags();
- $this->clearGroupInboxes();
- // NOTE: we don't clear inboxes
- // NOTE: we don't clear queue items
- }
- $result = parent::delete();
- $this->blowOnDelete();
- return $result;
- }
- /**
- * 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})/', 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; $i<count($hashtags); $i++) {
- /* elide characters we don't want in the tag */
- $hashtags[$i] = common_canonical_tag($hashtags[$i]);
- }
- foreach(array_unique($hashtags) as $hashtag) {
- $this->saveTag($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_OMB - Sent from a remote OMB 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-OMB 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; defaults to local notice URL
- * 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
- * @fixme tag override
- *
- * @return Notice
- * @throws ClientException
- */
- static function saveNew($profile_id, $content, $source, $options=null) {
- $defaults = array('uri' => null,
- 'url' => null,
- 'reply_to' => null,
- 'repeat_of' => null);
- if (!empty($options)) {
- $options = $options + $defaults;
- extract($options);
- } else {
- extract($defaults);
- }
- if (!isset($is_local)) {
- $is_local = Notice::LOCAL_PUBLIC;
- }
- $profile = Profile::staticGet($profile_id);
- $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 (empty($profile)) {
- // TRANS: Client exception thrown when trying to save a notice for an unknown user.
- throw new ClientException(_('Problem saving notice. Unknown user.'));
- }
- 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();
- }
- $notice->content = $final;
- $notice->source = $source;
- $notice->uri = $uri;
- $notice->url = $url;
- // Handle repeat case
- if (isset($repeat_of)) {
- $notice->repeat_of = $repeat_of;
- } else {
- $notice->reply_to = self::getReplyTo($reply_to, $profile_id, $source, $final);
- }
- if (!empty($notice->reply_to)) {
- $reply = Notice::staticGet('id', $notice->reply_to);
- $notice->conversation = $reply->conversation;
- }
- 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 (Event::handle('StartNoticeSave', array(&$notice))) {
- // XXX: some of these functions write to the DB
- $id = $notice->insert();
- if (!$id) {
- common_log_db_error($notice, 'INSERT', __FILE__);
- // TRANS: Server exception thrown when a notice cannot be saved.
- throw new ServerException(_('Problem saving notice.'));
- }
- // Update ID-dependent columns: URI, conversation
- $orig = clone($notice);
- $changed = false;
- if (empty($uri)) {
- $notice->uri = common_notice_uri($notice);
- $changed = true;
- }
- // If it's not part of a conversation, it's
- // the beginning of a new conversation.
- if (empty($notice->conversation)) {
- $conv = Conversation::create();
- $notice->conversation = $conv->id;
- $changed = true;
- }
- if ($changed) {
- if (!$notice->update($orig)) {
- common_log_db_error($notice, 'UPDATE', __FILE__);
- // TRANS: Server exception thrown when a notice cannot be updated.
- throw new ServerException(_('Problem saving notice.'));
- }
- }
- }
- # Clear the cache for subscribed users, so they'll update at next request
- # XXX: someone clever could prepend instead of clearing the cache
- $notice->blowOnInsert();
- // 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.
- if (isset($groups)) {
- $notice->saveKnownGroups($groups);
- } else {
- $notice->saveGroups();
- }
- if (isset($urls)) {
- $notice->saveKnownUrls($urls);
- } else {
- $notice->saveUrls();
- }
- // Prepare inbox delivery, may be queued to background.
- $notice->distribute();
- return $notice;
- }
- function blowOnInsert($conversation = false)
- {
- self::blow('profile:notice_ids:%d', $this->profile_id);
- self::blow('public');
- // XXX: Before we were blowing the casche only if the notice id
- // was not the root of the conversation. What to do now?
- self::blow('notice:conversation_ids:%d', $this->conversation);
- if (!empty($this->repeat_of)) {
- self::blow('notice:repeats:%d', $this->repeat_of);
- }
- $original = Notice::staticGet('id', $this->repeat_of);
- if (!empty($original)) {
- $originalUser = User::staticGet('id', $original->profile_id);
- if (!empty($originalUser)) {
- self::blow('user:repeats_of_me:%d', $originalUser->id);
- }
- }
- $profile = Profile::staticGet($this->profile_id);
- if (!empty($profile)) {
- $profile->blowNoticeCount();
- }
- }
- /**
- * 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);
- self::blow('public;last');
- }
- /** 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() {
- 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)
- {
- // @fixme validation?
- foreach (array_unique($urls) as $url) {
- File::processNew($url, $this->id);
- }
- }
- /**
- * @private callback
- */
- function saveUrl($data) {
- list($url, $notice_id) = $data;
- File::processNew($url, $notice_id);
- }
- static function checkDupes($profile_id, $content) {
- $profile = Profile::staticGet($profile_id);
- if (empty($profile)) {
- return false;
- }
- $notice = $profile->getNotices(0, NOTICE_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;
- if (common_config('db','type') == 'pgsql')
- $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
- else
- $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
- $cnt = $notice->count();
- return ($cnt == 0);
- }
- static function checkEditThrottle($profile_id) {
- $profile = Profile::staticGet($profile_id);
- if (empty($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;
- }
- function getUploadedAttachment() {
- $post = clone $this;
- $query = 'select file.url as up, file.id as i from file join file_to_post on file.id = file_id where post_id=' . $post->escape($post->id) . ' and url like "%/notice/%/file"';
- $post->query($query);
- $post->fetch();
- if (empty($post->up) || empty($post->i)) {
- $ret = false;
- } else {
- $ret = array($post->up, $post->i);
- }
- $post->free();
- return $ret;
- }
- function hasAttachments() {
- $post = clone $this;
- $query = "select count(file_id) as n_attachments from file join file_to_post on (file_id = file.id) join notice on (post_id = notice.id) where post_id = " . $post->escape($post->id);
- $post->query($query);
- $post->fetch();
- $n_attachments = intval($post->n_attachments);
- $post->free();
- return $n_attachments;
- }
- function attachments() {
- // XXX: cache this
- $att = array();
- $f2p = new File_to_post;
- $f2p->post_id = $this->id;
- if ($f2p->find()) {
- while ($f2p->fetch()) {
- $f = File::staticGet($f2p->file_id);
- if ($f) {
- $att[] = clone($f);
- }
- }
- }
- return $att;
- }
- function getStreamByIds($ids)
- {
- $cache = common_memcache();
- if (!empty($cache)) {
- $notices = array();
- foreach ($ids as $id) {
- $n = Notice::staticGet('id', $id);
- if (!empty($n)) {
- $notices[] = $n;
- }
- }
- return new ArrayWrapper($notices);
- } else {
- $notice = new Notice();
- if (empty($ids)) {
- //if no IDs requested, just return the notice object
- return $notice;
- }
- $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
- $notice->find();
- $temp = array();
- while ($notice->fetch()) {
- $temp[$notice->id] = clone($notice);
- }
- $wrapped = array();
- foreach ($ids as $id) {
- if (array_key_exists($id, $temp)) {
- $wrapped[] = $temp[$id];
- }
- }
- return new ArrayWrapper($wrapped);
- }
- }
- function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0)
- {
- $ids = Notice::stream(array('Notice', '_publicStreamDirect'),
- array(),
- 'public',
- $offset, $limit, $since_id, $max_id);
- return Notice::getStreamByIds($ids);
- }
- function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0)
- {
- $notice = new Notice();
- $notice->selectAdd(); // clears it
- $notice->selectAdd('id');
- $notice->orderBy('id DESC');
- if (!is_null($offset)) {
- $notice->limit($offset, $limit);
- }
- if (common_config('public', 'localonly')) {
- $notice->whereAdd('is_local = ' . Notice::LOCAL_PUBLIC);
- } else {
- # -1 == blacklisted, -2 == gateway (i.e. Twitter)
- $notice->whereAdd('is_local !='. Notice::LOCAL_NONPUBLIC);
- $notice->whereAdd('is_local !='. Notice::GATEWAY);
- }
- if ($since_id != 0) {
- $notice->whereAdd('id > ' . $since_id);
- }
- if ($max_id != 0) {
- $notice->whereAdd('id <= ' . $max_id);
- }
- $ids = array();
- if ($notice->find()) {
- while ($notice->fetch()) {
- $ids[] = $notice->id;
- }
- }
- $notice->free();
- $notice = NULL;
- return $ids;
- }
- function conversationStream($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
- {
- $ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
- array($id),
- 'notice:conversation_ids:'.$id,
- $offset, $limit, $since_id, $max_id);
- return Notice::getStreamByIds($ids);
- }
- function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0)
- {
- $notice = new Notice();
- $notice->selectAdd(); // clears it
- $notice->selectAdd('id');
- $notice->conversation = $id;
- $notice->orderBy('id DESC');
- if (!is_null($offset)) {
- $notice->limit($offset, $limit);
- }
- if ($since_id != 0) {
- $notice->whereAdd('id > ' . $since_id);
- }
- if ($max_id != 0) {
- $notice->whereAdd('id <= ' . $max_id);
- }
- $ids = array();
- if ($notice->find()) {
- while ($notice->fetch()) {
- $ids[] = $notice->id;
- }
- }
- $notice->free();
- $notice = NULL;
- return $ids;
- }
- /**
- * 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;
- }
- /**
- * 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($groups=null, $recipients=null)
- {
- $c = self::memcache();
- if (!empty($c)) {
- $ni = $c->get(common_cache_key('notice:who_gets:'.$this->id));
- if ($ni !== false) {
- return $ni;
- }
- }
- if (is_null($groups)) {
- $groups = $this->getGroups();
- }
- if (is_null($recipients)) {
- $recipients = $this->getReplies();
- }
- $users = $this->getSubscribedUsers();
- // FIXME: kind of ignoring 'transitional'...
- // we'll probably stop supporting inboxless mode
- // in 0.9.x
- $ni = array();
- foreach ($users as $id) {
- $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
- }
- foreach ($groups as $group) {
- $users = $group->getUserMembers();
- foreach ($users as $id) {
- if (!array_key_exists($id, $ni)) {
- $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
- }
- }
- }
- 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();
- foreach ($ni as $id => $source) {
- $user = User::staticGet('id', $id);
- if (empty($user) || $user->hasBlocked($profile)) {
- unset($ni[$id]);
- }
- }
- if (!empty($c)) {
- // XXX: pack this data better
- $c->set(common_cache_key('notice:who_gets:'.$this->id), $ni);
- }
- return $ni;
- }
- /**
- * Adds this notice to the inboxes of each local user who should receive
- * it, based on author subscriptions, group memberships, and @-replies.
- *
- * Warning: running a second time currently will make items appear
- * multiple times in users' inboxes.
- *
- * @fixme make more robust against errors
- * @fixme break up massive deliveries to smaller background tasks
- *
- * @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
- */
- function addToInboxes($groups=null, $recipients=null)
- {
- $ni = $this->whoGets($groups, $recipients);
- $ids = array_keys($ni);
- // We remove the author (if they're a local user),
- // since we'll have already done this in distribute()
- $i = array_search($this->profile_id, $ids);
- if ($i !== false) {
- unset($ids[$i]);
- }
- // Bulk insert
- Inbox::bulkInsert($this->id, $ids);
- return;
- }
- 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;
- }
- /**
- * 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::staticGet('id', $id);
- if ($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__);
- }
- // @fixme should we save the tags here or not?
- $groups[] = clone($group);
- } else {
- common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
- }
- }
- return $groups;
- }
- /**
- * Parse !group delivery and record targets into group_inbox.
- * @return array of Group objects
- */
- function saveGroups()
- {
- // Don't save groups for repeats
- if (!empty($this->repeat_of)) {
- return array();
- }
- $groups = array();
- /* extract all !group */
- $count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
- strtolower($this->content),
- $match);
- if (!$count) {
- return $groups;
- }
- $profile = $this->getProfile();
- /* Add them to the database */
- foreach (array_unique($match[1]) as $nickname) {
- /* XXX: remote groups. */
- $group = User_group::getForNickname($nickname, $profile);
- if (empty($group)) {
- continue;
- }
- // we automatically add a tag for every group name, too
- $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($nickname),
- 'notice_id' => $this->id));
- if (is_null($tag)) {
- $this->saveTag($nickname);
- }
- if ($profile->isMember($group)) {
- $result = $this->addToGroupInbox($group);
- if (!$result) {
- common_log_db_error($gi, 'INSERT', __FILE__);
- }
- $groups[] = clone($group);
- }
- }
- return $groups;
- }
- function addToGroupInbox($group)
- {
- $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
- 'notice_id' => $this->id));
- if (empty($gi)) {
- $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 of unique identifier URIs for recipients
- */
- function saveKnownReplies($uris)
- {
- if (empty($uris)) {
- return;
- }
- $sender = Profile::staticGet($this->profile_id);
- foreach (array_unique($uris) as $uri) {
- $profile = Profile::fromURI($uri);
- if (empty($profile)) {
- 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;
- }
- $reply = new Reply();
- $reply->notice_id = $this->id;
- $reply->profile_id = $profile->id;
- common_log(LOG_INFO, __METHOD__ . ": saving reply: notice $this->id to profile $profile->id");
- $id = $reply->insert();
- }
- 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 = Profile::staticGet($this->profile_id);
- // @todo ideally this parser information would only
- // be calculated once.
- $mentions = common_find_mentions($this->content, $this);
- $replied = array();
- // 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::staticGet('id', $mentioned->id);
- if (!empty($mentioned_user) && $mentioned_user->hasBlocked($sender)) {
- continue;
- }
- $reply = new Reply();
- $reply->notice_id = $this->id;
- $reply->profile_id = $mentioned->id;
- $id = $reply->insert();
- if (!$id) {
- common_log_db_error($reply, 'INSERT', __FILE__);
- // TRANS: Server exception thrown when a reply cannot be saved.
- // TRANS: %1$d is a notice ID, %2$d is the ID of the mentioned user.
- throw new ServerException(sprintf(_('Could not save reply for %1$d, %2$d.'), $this->id, $mentioned->id));
- } else {
- $replied[$mentioned->id] = 1;
- self::blow('reply:stream:%d', $mentioned->id);
- }
- }
- }
- $recipientIds = array_keys($replied);
- return $recipientIds;
- }
- /**
- * Pull the complete list of @-reply targets for this notice.
- *
- * @return array of integer profile ids
- */
- function getReplies()
- {
- // XXX: cache me
- $ids = array();
- $reply = new Reply();
- $reply->selectAdd();
- $reply->selectAdd('profile_id');
- $reply->notice_id = $this->id;
- if ($reply->find()) {
- while($reply->fetch()) {
- $ids[] = $reply->profile_id;
- }
- }
- $reply->free();
- return $ids;
- }
- /**
- * 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::staticGet('id', $recipientId);
- if (!empty($user)) {
- mail_notify_attn($user, $this);
- }
- }
- }
- /**
- * Pull list of groups this notice needs to be delivered to,
- * as previously recorded by saveGroups() or saveKnownGroups().
- *
- * @return array of Group objects
- */
- function getGroups()
- {
- // Don't save groups for repeats
- if (!empty($this->repeat_of)) {
- return array();
- }
- // XXX: cache me
- $groups = array();
- $gi = new Group_inbox();
- $gi->selectAdd();
- $gi->selectAdd('group_id');
- $gi->notice_id = $this->id;
- if ($gi->find()) {
- while ($gi->fetch()) {
- $group = User_group::staticGet('id', $gi->group_id);
- if ($group) {
- $groups[] = $group;
- }
- }
- }
- $gi->free();
- return $groups;
- }
- function asActivity()
- {
- $profile = $this->getProfile();
- $act = new Activity();
- $act->actor = ActivityObject::fromProfile($profile);
- $act->verb = ActivityVerb::POST;
- $act->objects[] = ActivityObject::fromNotice($this);
- $act->time = strtotime($this->created);
- $act->link = $this->bestUrl();
- $act->content = common_xml_safe_str($this->rendered);
- $act->id = $this->uri;
- $act->title = common_xml_safe_str($this->content);
- $ctx = new ActivityContext();
- if (!empty($this->reply_to)) {
- $reply = Notice::staticGet('id', $this->reply_to);
- if (!empty($reply)) {
- $ctx->replyToID = $reply->uri;
- $ctx->replyToUrl = $reply->bestUrl();
- }
- }
- $ctx->location = $this->getLocation();
- $conv = null;
- if (!empty($this->conversation)) {
- $conv = Conversation::staticGet('id', $this->conversation);
- if (!empty($conv)) {
- $ctx->conversation = $conv->uri;
- }
- }
- $reply_ids = $this->getReplies();
- foreach ($reply_ids as $id) {
- $profile = Profile::staticGet('id', $id);
- if (!empty($profile)) {
- $ctx->attention[] = $profile->getUri();
- }
- }
- $groups = $this->getGroups();
- foreach ($groups as $group) {
- $ctx->attention[] = $group->uri;
- }
- $act->context = $ctx;
- 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)
- {
- $profile = $this->getProfile();
- $xs = new XMLStringer(true);
- if ($namespace) {
- $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
- 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
- 'xmlns:georss' => 'http://www.georss.org/georss',
- 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
- 'xmlns:media' => 'http://purl.org/syndication/atommedia',
- 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
- 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
- 'xmlns:statusnet' => 'http://status.net/schema/api/1/');
- } else {
- $attrs = array();
- }
- if (Event::handle('StartActivityStart', array(&$this, &$xs, &$attrs))) {
- $xs->elementStart('entry', $attrs);
- Event::handle('EndActivityStart', array(&$this, &$xs, &$attrs));
- }
- if (Event::handle('StartActivitySource', array(&$this, &$xs))) {
- if ($source) {
- $atom_feed = $profile->getAtomFeed();
- if (!empty($atom_feed)) {
- $xs->elementStart('source');
- // XXX: we should store the actual feed ID
- $xs->element('id', null, $atom_feed);
- // XXX: we should store the actual feed title
- $xs->element('title', null, $profile->getBestName());
- $xs->element('link', array('rel' => 'alternate',
- 'type' => 'text/html',
- 'href' => $profile->profileurl));
- $xs->element('link', array('rel' => 'self',
- 'type' => 'application/atom+xml',
- 'href' => $atom_feed));
- $xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
- $notice = $profile->getCurrentNotice();
- if (!empty($notice)) {
- $xs->element('updated', null, self::utcDate($notice->created));
- }
- $user = User::staticGet('id', $profile->id);
- if (!empty($user)) {
- $xs->element('link', array('rel' => 'license',
- 'href' => common_config('license', 'url')));
- }
- $xs->elementEnd('source');
- }
- }
- Event::handle('EndActivitySource', array(&$this, &$xs));
- }
- $title = common_xml_safe_str($this->content);
- if (Event::handle('StartActivityTitle', array(&$this, &$xs, &$title))) {
- $xs->element('title', null, $title);
- Event::handle('EndActivityTitle', array($this, &$xs, $title));
- }
- $atomAuthor = '';
- if ($author) {
- $atomAuthor = $profile->asAtomAuthor($cur);
- }
- if (Event::handle('StartActivityAuthor', array(&$this, &$xs, &$atomAuthor))) {
- if (!empty($atomAuthor)) {
- $xs->raw($atomAuthor);
- Event::handle('EndActivityAuthor', array(&$this, &$xs, &$atomAuthor));
- }
- }
- $actor = '';
- if ($author) {
- $actor = $profile->asActivityActor();
- }
- if (Event::handle('StartActivityActor', array(&$this, &$xs, &$actor))) {
- if (!empty($actor)) {
- $xs->raw($actor);
- Event::handle('EndActivityActor', array(&$this, &$xs, &$actor));
- }
- }
- $url = $this->bestUrl();
- if (Event::handle('StartActivityLink', array(&$this, &$xs, &$url))) {
- $xs->element('link', array('rel' => 'alternate',
- 'type' => 'text/html',
- 'href' => $url));
- Event::handle('EndActivityLink', array(&$this, &$xs, $url));
- }
- $id = $this->uri;
- if (Event::handle('StartActivityId', array(&$this, &$xs, &$id))) {
- $xs->element('id', null, $id);
- Event::handle('EndActivityId', array(&$this, &$xs, $id));
- }
- $published = self::utcDate($this->created);
- if (Event::handle('StartActivityPublished', array(&$this, &$xs, &$published))) {
- $xs->element('published', null, $published);
- Event::handle('EndActivityPublished', array(&$this, &$xs, $published));
- }
- $updated = $published; // XXX: notices are usually immutable
- if (Event::handle('StartActivityUpdated', array(&$this, &$xs, &$updated))) {
- $xs->element('updated', null, $updated);
- Event::handle('EndActivityUpdated', array(&$this, &$xs, $updated));
- }
- $content = common_xml_safe_str($this->rendered);
- if (Event::handle('StartActivityContent', array(&$this, &$xs, &$content))) {
- $xs->element('content', array('type' => 'html'), $content);
- Event::handle('EndActivityContent', array(&$this, &$xs, $content));
- }
- // Most of our notices represent POSTing a NOTE. This is the default verb
- // for activity streams, so we normally just leave it out.
- $verb = ActivityVerb::POST;
- if (Event::handle('StartActivityVerb', array(&$this, &$xs, &$verb))) {
- $xs->element('activity:verb', null, $verb);
- Event::handle('EndActivityVerb', array(&$this, &$xs, $verb));
- }
- // We use the default behavior for activity streams: if there's no activity:object,
- // then treat the entry itself as the object. Here, you can set the type of that object,
- // which is normally a NOTE.
- $type = ActivityObject::NOTE;
- if (Event::handle('StartActivityDefaultObjectType', array(&$this, &$xs, &$type))) {
- $xs->element('activity:object-type', null, $type);
- Event::handle('EndActivityDefaultObjectType', array(&$this, &$xs, $type));
- }
- // Since we usually use the entry itself as an object, we don't have an explicit
- // object. Some extensions may want to add them (for photo, event, music, etc.).
- $objects = array();
- if (Event::handle('StartActivityObjects', array(&$this, &$xs, &$objects))) {
- foreach ($objects as $object) {
- $xs->raw($object->asString());
- }
- Event::handle('EndActivityObjects', array(&$this, &$xs, $objects));
- }
- $noticeInfoAttr = array('local_id' => $this->id); // local notice ID (useful to clients for ordering)
- $ns = $this->getSource();
- if (!empty($ns)) {
- $noticeInfoAttr['source'] = $ns->code;
- if (!empty($ns->url)) {
- $noticeInfoAttr['source_link'] = $ns->url;
- if (!empty($ns->name)) {
- $noticeInfoAttr['source'] = '<a href="'
- . htmlspecialchars($ns->url)
- . '" rel="nofollow">'
- . htmlspecialchars($ns->name)
- . '</a>';
- }
- }
- }
- if (!empty($cur)) {
- $noticeInfoAttr['favorite'] = ($cur->hasFave($this)) ? "true" : "false";
- $profile = $cur->getProfile();
- $noticeInfoAttr['repeated'] = ($profile->hasRepeated($this->id)) ? "true" : "false";
- }
- if (!empty($this->repeat_of)) {
- $noticeInfoAttr['repeat_of'] = $this->repeat_of;
- }
- if (Event::handle('StartActivityNoticeInfo', array(&$this, &$xs, &$noticeInfoAttr))) {
- $xs->element('statusnet:notice_info', $noticeInfoAttr, null);
- Event::handle('EndActivityNoticeInfo', array(&$this, &$xs, $noticeInfoAttr));
- }
- $replyNotice = null;
- if ($this->reply_to) {
- $replyNotice = Notice::staticGet('id', $this->reply_to);
- }
- if (Event::handle('StartActivityInReplyTo', array(&$this, &$xs, &$replyNotice))) {
- if (!empty($replyNotice)) {
- $xs->element('link', array('rel' => 'related',
- 'href' => $replyNotice->bestUrl()));
- $xs->element('thr:in-reply-to',
- array('ref' => $replyNotice->uri,
- 'href' => $replyNotice->bestUrl()));
- Event::handle('EndActivityInReplyTo', array(&$this, &$xs, $replyNotice));
- }
- }
- $conv = null;
- if (!empty($this->conversation)) {
- $conv = Conversation::staticGet('id', $this->conversation);
- }
- if (Event::handle('StartActivityConversation', array(&$this, &$xs, &$conv))) {
- if (!empty($conv)) {
- $xs->element('link', array('rel' => 'ostatus:conversation',
- 'href' => $conv->uri));
- }
- Event::handle('EndActivityConversation', array(&$this, &$xs, $conv));
- }
- $replyProfiles = array();
- $reply_ids = $this->getReplies();
- foreach ($reply…
Large files files are truncated, but you can click here to view the full file