summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrenda Wallace <shiny@cpan.org>2009-10-04 11:14:26 +1300
committerBrenda Wallace <shiny@cpan.org>2009-10-04 11:14:26 +1300
commitbcdf31c639d7a50a7eefd16706fa0d9d6f33601f (patch)
treee1039feb163f838d074acd83e29bc0dc99ffd2f6
parent00c0becd56c1185f26524828be4722ffd8f05712 (diff)
added all them doxygens
-rw-r--r--classes/Notice.php825
1 files changed, 421 insertions, 404 deletions
diff --git a/classes/Notice.php b/classes/Notice.php
index 93d5de790..c68098c65 100644
--- a/classes/Notice.php
+++ b/classes/Notice.php
@@ -1,5 +1,5 @@
<?php
-/*
+/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, StatusNet, Inc.
*
@@ -15,13 +15,30 @@
*
* 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>
+ * @license GNU Affero General Public License http://www.gnu.org/licenses/
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+ exit(1);
+}
/**
- * Table Definition for notice
- */
+* Table Definition for notice
+*/
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
/* We keep the first three 20-notice pages, plus one for pagination check,
@@ -35,7 +52,7 @@ 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) not_null
@@ -49,45 +66,45 @@ class Notice extends Memcached_DataObject
public $is_local; // tinyint(1)
public $source; // varchar(32)
public $conversation; // 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()
{
return Profile::staticGet('id', $this->profile_id);
}
-
+
function delete()
{
$this->blowCaches(true);
$this->blowFavesCache(true);
$this->blowSubsCache(true);
-
+
// For auditing purposes, save a record that the notice
// was 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();
-
+
$this->query('BEGIN');
-
+
$deleted->insert();
-
+
//Null any notices that are replies to this notice
$this->query(sprintf("UPDATE notice set reply_to = null WHERE reply_to = %d", $this->id));
$related = array('Reply',
@@ -106,7 +123,7 @@ class Notice extends Memcached_DataObject
$result = parent::delete();
$this->query('COMMIT');
}
-
+
function saveTags()
{
/* extract all #hastags */
@@ -114,14 +131,14 @@ class Notice extends Memcached_DataObject
if (!$count) {
return true;
}
-
+
//turn each into their canonical tag
//this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
$hashtags = array();
for($i=0; $i<count($match[1]); $i++) {
$hashtags[] = common_canonical_tag($match[1][$i]);
}
-
+
/* Add them to the database */
foreach(array_unique($hashtags) as $hashtag) {
/* elide characters we don't want in the tag */
@@ -129,7 +146,7 @@ class Notice extends Memcached_DataObject
}
return true;
}
-
+
function saveTag($hashtag)
{
$tag = new Notice_tag();
@@ -137,158 +154,158 @@ class Notice extends Memcached_DataObject
$tag->tag = $hashtag;
$tag->created = $this->created;
$id = $tag->insert();
-
+
if (!$id) {
throw new ServerException(sprintf(_('DB error inserting hashtag: %s'),
$last_error->message));
return;
}
}
-
+
static function saveNew($profile_id, $content, $source=null,
$is_local=Notice::LOCAL_PUBLIC, $reply_to=null, $uri=null, $created=null) {
-
- $profile = Profile::staticGet($profile_id);
-
- $final = common_shorten_links($content);
-
- if (Notice::contentTooLong($final)) {
- throw new ClientException(_('Problem saving notice. Too long.'));
- }
-
- if (!$profile) {
- 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.');
- throw new ClientException(_('Too many notices too fast; take a breather '.
+
+ $profile = Profile::staticGet($profile_id);
+
+ $final = common_shorten_links($content);
+
+ if (Notice::contentTooLong($final)) {
+ throw new ClientException(_('Problem saving notice. Too long.'));
+ }
+
+ if (!$profile) {
+ 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.');
+ 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.');
- throw new ClientException(_('Too many duplicate messages too quickly;'.
+ }
+
+ if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
+ common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
+ throw new ClientException(_('Too many duplicate messages too quickly;'.
' take a breather and post again in a few minutes.'));
- }
-
- $banned = common_config('profile', 'banned');
-
- if ( in_array($profile_id, $banned) || in_array($profile->nickname, $banned)) {
- common_log(LOG_WARNING, "Attempted post from banned user: $profile->nickname (user id = $profile_id).");
- throw new ClientException(_('You are banned from posting notices on this site.'));
- }
-
- $notice = new Notice();
- $notice->profile_id = $profile_id;
-
- $blacklist = common_config('public', 'blacklist');
- $autosource = common_config('public', 'autosource');
-
+ }
+
+ $banned = common_config('profile', 'banned');
+
+ if ( in_array($profile_id, $banned) || in_array($profile->nickname, $banned)) {
+ common_log(LOG_WARNING, "Attempted post from banned user: $profile->nickname (user id = $profile_id).");
+ throw new ClientException(_('You are banned from posting notices on this site.'));
+ }
+
+ $notice = new Notice();
+ $notice->profile_id = $profile_id;
+
+ $blacklist = common_config('public', 'blacklist');
+ $autosource = common_config('public', 'autosource');
+
# Blacklisted are non-false, but not 1, either
-
- if (($blacklist && in_array($profile_id, $blacklist)) ||
- ($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->rendered = common_render_content($final, $notice);
- $notice->source = $source;
- $notice->uri = $uri;
-
- $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 (Event::handle('StartNoticeSave', array(&$notice))) {
-
+
+ if (($blacklist && in_array($profile_id, $blacklist)) ||
+ ($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->rendered = common_render_content($final, $notice);
+ $notice->source = $source;
+ $notice->uri = $uri;
+
+ $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 (Event::handle('StartNoticeSave', array(&$notice))) {
+
// XXX: some of these functions write to the DB
-
- $notice->query('BEGIN');
-
- $id = $notice->insert();
-
- if (!$id) {
- common_log_db_error($notice, 'INSERT', __FILE__);
- throw new ServerException(_('Problem saving notice.'));
- }
-
+
+ $notice->query('BEGIN');
+
+ $id = $notice->insert();
+
+ if (!$id) {
+ common_log_db_error($notice, 'INSERT', __FILE__);
+ 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;
- }
-
+
+ $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)) {
- $notice->conversation = $notice->id;
- $changed = true;
- }
-
- if ($changed) {
- if (!$notice->update($orig)) {
- common_log_db_error($notice, 'UPDATE', __FILE__);
- throw new ServerException(_('Problem saving notice.'));
- }
- }
-
+
+ if (empty($notice->conversation)) {
+ $notice->conversation = $notice->id;
+ $changed = true;
+ }
+
+ if ($changed) {
+ if (!$notice->update($orig)) {
+ common_log_db_error($notice, 'UPDATE', __FILE__);
+ throw new ServerException(_('Problem saving notice.'));
+ }
+ }
+
// XXX: do we need to change this for remote users?
-
- $notice->saveReplies();
- $notice->saveTags();
-
- $notice->addToInboxes();
-
- $notice->saveUrls();
-
- $notice->query('COMMIT');
-
- Event::handle('EndNoticeSave', array($notice));
- }
-
+
+ $notice->saveReplies();
+ $notice->saveTags();
+
+ $notice->addToInboxes();
+
+ $notice->saveUrls();
+
+ $notice->query('COMMIT');
+
+ Event::handle('EndNoticeSave', array($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->blowCaches();
-
- return $notice;
- }
-
+
+ $notice->blowCaches();
+
+ return $notice;
+ }
+
/** 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);
- }
-
+ *
+ * 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);
+ }
+
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 (!$profile) {
@@ -311,14 +328,14 @@ class Notice extends Memcached_DataObject
$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'));
+ $notice->whereAdd('extract(epoch from now() - created) < ' . common_config('site', 'dupelimit'));
else
- $notice->whereAdd('now() - created < ' . common_config('site', 'dupelimit'));
-
+ $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 (!$profile) {
@@ -336,7 +353,7 @@ class Notice extends Memcached_DataObject
# 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"';
@@ -350,7 +367,7 @@ class Notice extends Memcached_DataObject
$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);
@@ -360,7 +377,7 @@ class Notice extends Memcached_DataObject
$post->free();
return $n_attachments;
}
-
+
function attachments() {
// XXX: cache this
$att = array();
@@ -374,7 +391,7 @@ class Notice extends Memcached_DataObject
}
return $att;
}
-
+
function blowCaches($blowLast=false)
{
$this->blowSubsCache($blowLast);
@@ -387,7 +404,7 @@ class Notice extends Memcached_DataObject
$profile = Profile::staticGet($this->profile_id);
$profile->blowNoticeCount();
}
-
+
function blowConversationCache($blowLast=false)
{
$cache = common_memcache();
@@ -399,7 +416,7 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
function blowGroupCache($blowLast=false)
{
$cache = common_memcache();
@@ -428,7 +445,7 @@ class Notice extends Memcached_DataObject
unset($group_inbox);
}
}
-
+
function blowTagCache($blowLast=false)
{
$cache = common_memcache();
@@ -439,7 +456,7 @@ class Notice extends Memcached_DataObject
while ($tag->fetch()) {
$tag->blowCache($blowLast);
$ck = 'profile:notice_ids_tagged:' . $this->profile_id . ':' . $tag->tag;
-
+
$cache->delete($ck);
if ($blowLast) {
$cache->delete($ck . ';last');
@@ -450,19 +467,19 @@ class Notice extends Memcached_DataObject
unset($tag);
}
}
-
+
function blowSubsCache($blowLast=false)
{
$cache = common_memcache();
if ($cache) {
$user = new User();
-
+
$UT = common_config('db','type')=='pgsql'?'"user"':'user';
$user->query('SELECT id ' .
-
+
"FROM $UT JOIN subscription ON $UT.id = subscription.subscriber " .
'WHERE subscription.subscribed = ' . $this->profile_id);
-
+
while ($user->fetch()) {
$cache->delete(common_cache_key('notice_inbox:by_user:'.$user->id));
$cache->delete(common_cache_key('notice_inbox:by_user_own:'.$user->id));
@@ -475,7 +492,7 @@ class Notice extends Memcached_DataObject
unset($user);
}
}
-
+
function blowNoticeCache($blowLast=false)
{
if ($this->is_local) {
@@ -488,7 +505,7 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
function blowRepliesCache($blowLast=false)
{
$cache = common_memcache();
@@ -507,7 +524,7 @@ class Notice extends Memcached_DataObject
unset($reply);
}
}
-
+
function blowPublicCache($blowLast=false)
{
if ($this->is_local == Notice::LOCAL_PUBLIC) {
@@ -520,7 +537,7 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
function blowFavesCache($blowLast=false)
{
$cache = common_memcache();
@@ -541,14 +558,14 @@ class Notice extends Memcached_DataObject
unset($fave);
}
}
-
+
# XXX: too many args; we need to move to named params or even a separate
# class for notice streams
-
+
static function getStream($qry, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $order=null, $since=null) {
-
+
if (common_config('memcached', 'enabled')) {
-
+
# Skip the cache if this is a since, since_id or max_id qry
if ($since_id > 0 || $max_id > 0 || $since) {
return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since);
@@ -556,127 +573,127 @@ class Notice extends Memcached_DataObject
return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
}
}
-
+
return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since);
}
-
+
static function getStreamDirect($qry, $offset, $limit, $since_id, $max_id, $order, $since) {
-
+
$needAnd = false;
$needWhere = true;
-
+
if (preg_match('/\bWHERE\b/i', $qry)) {
$needWhere = false;
$needAnd = true;
}
-
+
if ($since_id > 0) {
-
+
if ($needWhere) {
$qry .= ' WHERE ';
$needWhere = false;
} else {
$qry .= ' AND ';
}
-
+
$qry .= ' notice.id > ' . $since_id;
}
-
+
if ($max_id > 0) {
-
+
if ($needWhere) {
$qry .= ' WHERE ';
$needWhere = false;
} else {
$qry .= ' AND ';
}
-
+
$qry .= ' notice.id <= ' . $max_id;
}
-
+
if ($since) {
-
+
if ($needWhere) {
$qry .= ' WHERE ';
$needWhere = false;
} else {
$qry .= ' AND ';
}
-
+
$qry .= ' notice.created > \'' . date('Y-m-d H:i:s', $since) . '\'';
}
-
+
# Allow ORDER override
-
+
if ($order) {
$qry .= $order;
} else {
$qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
}
-
+
if (common_config('db','type') == 'pgsql') {
$qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
} else {
$qry .= ' LIMIT ' . $offset . ', ' . $limit;
}
-
+
$notice = new Notice();
-
+
$notice->query($qry);
-
+
return $notice;
}
-
+
# XXX: this is pretty long and should probably be broken up into
# some helper functions
-
+
static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
-
+
# If outside our cache window, just go to the DB
-
+
if ($offset + $limit > NOTICE_CACHE_WINDOW) {
return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
}
-
+
# Get the cache; if we can't, just go to the DB
-
+
$cache = common_memcache();
-
+
if (!$cache) {
return Notice::getStreamDirect($qry, $offset, $limit, null, null, $order, null);
}
-
+
# Get the notices out of the cache
-
+
$notices = $cache->get(common_cache_key($cachekey));
-
+
# On a cache hit, return a DB-object-like wrapper
-
+
if ($notices !== false) {
$wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
return $wrapper;
}
-
+
# If the cache was invalidated because of new data being
# added, we can try and just get the new stuff. We keep an additional
# copy of the data at the key + ';last'
-
+
# No cache hit. Try to get the *last* cached version
-
+
$last_notices = $cache->get(common_cache_key($cachekey) . ';last');
-
+
if ($last_notices) {
-
+
# Reverse-chron order, so last ID is last.
-
+
$last_id = $last_notices[0]->id;
-
+
# XXX: this assumes monotonically increasing IDs; a fair
# bet with our DB.
-
+
$new_notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW,
- $last_id, null, $order, null);
-
+ $last_id, null, $order, null);
+
if ($new_notice) {
$new_notices = array();
while ($new_notice->fetch()) {
@@ -685,54 +702,54 @@ class Notice extends Memcached_DataObject
$new_notice->free();
$notices = array_slice(array_merge($new_notices, $last_notices),
0, NOTICE_CACHE_WINDOW);
-
+
# Store the array in the cache for next time
-
+
$result = $cache->set(common_cache_key($cachekey), $notices);
$result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
-
+
# return a wrapper of the array for use now
-
+
return new ArrayWrapper(array_slice($notices, $offset, $limit));
}
}
-
+
# Otherwise, get the full cache window out of the DB
-
+
$notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, null, null, $order, null);
-
+
# If there are no hits, just return the value
-
+
if (!$notice) {
return $notice;
}
-
+
# Pack results into an array
-
+
$notices = array();
-
+
while ($notice->fetch()) {
$notices[] = clone($notice);
}
-
+
$notice->free();
-
+
# Store the array in the cache for next time
-
+
$result = $cache->set(common_cache_key($cachekey), $notices);
$result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
-
+
# return a wrapper of the array for use now
-
+
$wrapper = new ArrayWrapper(array_slice($notices, $offset, $limit));
-
+
return $wrapper;
}
-
+
function getStreamByIds($ids)
{
$cache = common_memcache();
-
+
if (!empty($cache)) {
$notices = array();
foreach ($ids as $id) {
@@ -750,35 +767,35 @@ class Notice extends Memcached_DataObject
}
$notice->whereAdd('id in (' . implode(', ', $ids) . ')');
$notice->orderBy('id DESC');
-
+
$notice->find();
return $notice;
}
}
-
+
function publicStream($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
{
$ids = Notice::stream(array('Notice', '_publicStreamDirect'),
array(),
'public',
$offset, $limit, $since_id, $max_id, $since);
-
+
return Notice::getStreamByIds($ids);
}
-
+
function _publicStreamDirect($offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
{
$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 {
@@ -786,108 +803,108 @@ class Notice extends Memcached_DataObject
$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);
}
-
+
if (!is_null($since)) {
$notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
}
-
+
$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, $since=null)
{
$ids = Notice::stream(array('Notice', '_conversationStreamDirect'),
array($id),
'notice:conversation_ids:'.$id,
$offset, $limit, $since_id, $max_id, $since);
-
+
return Notice::getStreamByIds($ids);
}
-
+
function _conversationStreamDirect($id, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
{
$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);
}
-
+
if (!is_null($since)) {
$notice->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
}
-
+
$ids = array();
-
+
if ($notice->find()) {
while ($notice->fetch()) {
$ids[] = $notice->id;
}
}
-
+
$notice->free();
$notice = NULL;
-
+
return $ids;
}
-
+
function addToInboxes()
{
$enabled = common_config('inboxes', 'enabled');
-
+
if ($enabled === true || $enabled === 'transitional') {
-
+
// XXX: loads constants
-
+
$inbox = new Notice_inbox();
-
+
$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;
}
-
+
$groups = $this->saveGroups();
-
+
foreach ($groups as $group) {
$users = $group->getUserMembers();
foreach ($users as $id) {
@@ -896,12 +913,12 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
$cnt = 0;
-
+
$qryhdr = 'INSERT INTO notice_inbox (user_id, notice_id, source, created) VALUES ';
$qry = $qryhdr;
-
+
foreach ($ni as $id => $source) {
if ($cnt > 0) {
$qry .= ', ';
@@ -919,52 +936,52 @@ class Notice extends Memcached_DataObject
$cnt = 0;
}
}
-
+
if ($cnt > 0) {
$inbox = new Notice_inbox();
$inbox->query($qry);
}
}
-
+
return;
}
-
+
function getSubscribedUsers()
{
$user = new User();
-
+
if(common_config('db','quote_identifiers'))
- $user_table = '"user"';
+ $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 ';
-
+ '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 saveGroups()
{
$groups = array();
-
+
$enabled = common_config('inboxes', 'enabled');
if ($enabled !== true && $enabled !== 'transitional') {
return $groups;
}
-
+
/* extract all !group */
$count = preg_match_all('/(?:^|\s)!([A-Za-z0-9]{1,64})/',
strtolower($this->content),
@@ -972,62 +989,62 @@ class Notice extends Memcached_DataObject
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);
-
+
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;
-
+
return $gi->insert();
}
-
+
return true;
}
-
+
function saveReplies()
{
// Alternative reply format
@@ -1037,21 +1054,21 @@ class Notice extends Memcached_DataObject
}
// extract all @messages
$cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $this->content, $match);
-
+
$names = array();
-
+
if ($cnt || $tname) {
// XXX: is there another way to make an array copy?
$names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
}
-
+
$sender = Profile::staticGet($this->profile_id);
-
+
$replied = array();
-
+
// store replied only for first @ (what user/notice what the reply directed,
// we assume first @ is it)
-
+
for ($i=0; $i<count($names); $i++) {
$nickname = $names[$i];
$recipient = common_relative_profile($sender, $nickname, $this->created);
@@ -1076,7 +1093,7 @@ class Notice extends Memcached_DataObject
$replied[$recipient->id] = 1;
}
}
-
+
// Hash format replies, too
$cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $this->content, $match);
if ($cnt) {
@@ -1103,7 +1120,7 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
foreach (array_keys($replied) as $recipient) {
$user = User::staticGet('id', $recipient);
if ($user) {
@@ -1111,22 +1128,22 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
function asAtomEntry($namespace=false, $source=false)
{
$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');
} else {
$attrs = array();
}
-
+
$xs->elementStart('entry', $attrs);
-
+
if ($source) {
$xs->elementStart('source');
$xs->element('title', null, $profile->nickname . " - " . common_config('site', 'name'));
@@ -1135,38 +1152,38 @@ class Notice extends Memcached_DataObject
if (!empty($user)) {
$atom_feed = common_local_url('api',
array('apiaction' => 'statuses',
- 'method' => 'user_timeline',
- 'argument' => $profile->nickname.'.atom'));
+ 'method' => 'user_timeline',
+ 'argument' => $profile->nickname.'.atom'));
$xs->element('link', array('rel' => 'self',
'type' => 'application/atom+xml',
'href' => $profile->profileurl));
$xs->element('link', array('rel' => 'license',
'href' => common_config('license', 'url')));
}
-
+
$xs->element('icon', null, $profile->avatarUrl(AVATAR_PROFILE_SIZE));
}
-
+
$xs->elementStart('author');
$xs->element('name', null, $profile->nickname);
$xs->element('uri', null, $profile->profileurl);
$xs->elementEnd('author');
-
+
if ($source) {
$xs->elementEnd('source');
}
-
+
$xs->element('title', null, $this->content);
$xs->element('summary', null, $this->content);
-
+
$xs->element('link', array('rel' => 'alternate',
'href' => $this->bestUrl()));
-
+
$xs->element('id', null, $this->uri);
-
+
$xs->element('published', null, common_date_w3dtf($this->created));
$xs->element('updated', null, common_date_w3dtf($this->modified));
-
+
if ($this->reply_to) {
$reply_notice = Notice::staticGet('id', $this->reply_to);
if (!empty($reply_notice)) {
@@ -1177,9 +1194,9 @@ class Notice extends Memcached_DataObject
'href' => $reply_notice->bestUrl()));
}
}
-
+
$xs->element('content', array('type' => 'html'), $this->rendered);
-
+
$tag = new Notice_tag();
$tag->notice_id = $this->id;
if ($tag->find()) {
@@ -1188,7 +1205,7 @@ class Notice extends Memcached_DataObject
}
}
$tag->free();
-
+
# Enclosures
$attachments = $this->attachments();
if($attachments){
@@ -1203,12 +1220,12 @@ class Notice extends Memcached_DataObject
}
}
}
-
+
$xs->elementEnd('entry');
-
+
return $xs->getString();
}
-
+
function bestUrl()
{
if (!empty($this->url)) {
@@ -1220,135 +1237,135 @@ class Notice extends Memcached_DataObject
array('notice' => $this->id));
}
}
-
+
function stream($fn, $args, $cachekey, $offset=0, $limit=20, $since_id=0, $max_id=0, $since=null)
{
$cache = common_memcache();
-
+
if (empty($cache) ||
$since_id != 0 || $max_id != 0 || (!is_null($since) && $since > 0) ||
is_null($limit) ||
($offset + $limit) > NOTICE_CACHE_WINDOW) {
- return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
- $max_id, $since)));
- }
-
+ return call_user_func_array($fn, array_merge($args, array($offset, $limit, $since_id,
+ $max_id, $since)));
+ }
+
$idkey = common_cache_key($cachekey);
-
+
$idstr = $cache->get($idkey);
-
+
if (!empty($idstr)) {
// Cache hit! Woohoo!
$window = explode(',', $idstr);
$ids = array_slice($window, $offset, $limit);
return $ids;
}
-
+
$laststr = $cache->get($idkey.';last');
-
+
if (!empty($laststr)) {
$window = explode(',', $laststr);
$last_id = $window[0];
$new_ids = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
- $last_id, 0, null)));
-
+ $last_id, 0, null)));
+
$new_window = array_merge($new_ids, $window);
-
+
$new_windowstr = implode(',', $new_window);
-
+
$result = $cache->set($idkey, $new_windowstr);
$result = $cache->set($idkey . ';last', $new_windowstr);
-
+
$ids = array_slice($new_window, $offset, $limit);
-
+
return $ids;
}
-
+
$window = call_user_func_array($fn, array_merge($args, array(0, NOTICE_CACHE_WINDOW,
- 0, 0, null)));
-
+ 0, 0, null)));
+
$windowstr = implode(',', $window);
-
+
$result = $cache->set($idkey, $windowstr);
$result = $cache->set($idkey . ';last', $windowstr);
-
+
$ids = array_slice($window, $offset, $limit);
-
+
return $ids;
}
-
+
/**
- * 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. Rough algorithm is:
- *
- * if (reply_to is set and valid) {
- * return reply_to;
- * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
- * return ID of last notice by initial @name in content;
- * }
- *
- * Note that all @nickname instances will still be used to save "reply" records,
- * so the notice shows up in the mentioned users' "replies" tab.
- *
- * @param integer $reply_to ID passed in by Web or API
- * @param integer $profile_id ID of author
- * @param string $source Source tag, like 'web' or 'gwibber'
- * @param string $content Final notice content
- *
- * @return integer ID of replied-to notice, or null for not a reply.
- */
-
- static function getReplyTo($reply_to, $profile_id, $source, $content)
+ * 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. Rough algorithm is:
+ *
+ * if (reply_to is set and valid) {
+ * return reply_to;
+ * } else if ((source not API or Web) and (content starts with "T NAME" or "@name ")) {
+ * return ID of last notice by initial @name in content;
+ * }
+ *
+ * Note that all @nickname instances will still be used to save "reply" records,
+ * so the notice shows up in the mentioned users' "replies" tab.
+ *
+ * @param integer $reply_to ID passed in by Web or API
+ * @param integer $profile_id ID of author
+ * @param string $source Source tag, like 'web' or 'gwibber'
+ * @param string $content Final notice content
+ *
+ * @return integer ID of replied-to notice, or null for not a reply.
+ */
+
+ static function getReplyTo($reply_to, $profile_id, $source, $content)
{
static $lb = array('xmpp', 'mail', 'sms', 'omb');
-
+
// If $reply_to is specified, we check that it exists, and then
// return it if it does
-
+
if (!empty($reply_to)) {
$reply_notice = Notice::staticGet('id', $reply_to);
if (!empty($reply_notice)) {
return $reply_to;
}
}
-
+
// If it's not a "low bandwidth" source (one where you can't set
// a reply_to argument), we return. This is mostly web and API
// clients.
-
+
if (!in_array($source, $lb)) {
return null;
}
-
+
// 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;
- }
-
+ $nickname = common_canonical_nickname($match[1]);
+ } else {
+ return null;
+ }
+
// Figure out who that is.
-
+
$sender = Profile::staticGet('id', $profile_id);
$recipient = common_relative_profile($sender, $nickname, common_sql_now());
-
+
if (empty($recipient)) {
return null;
}
-
+
// Get their last notice
-
+
$last = $recipient->getCurrentNotice();
-
+
if (!empty($last)) {
return $last->id;
}
}
-
+
static function maxContent()
{
$contentlimit = common_config('notice', 'contentlimit');
@@ -1358,7 +1375,7 @@ class Notice extends Memcached_DataObject
}
return $contentlimit;
}
-
+
static function contentTooLong($content)
{
$contentlimit = self::maxContent();