We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Notice.php 9.54 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1
<?php
Evan Prodromou's avatar
Evan Prodromou committed
2
/*
Evan Prodromou's avatar
Evan Prodromou committed
3 4
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
5
 *
Evan Prodromou's avatar
Evan Prodromou committed
6 7 8 9
 * 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.
Evan Prodromou's avatar
Evan Prodromou committed
10
 *
Evan Prodromou's avatar
Evan Prodromou committed
11 12 13 14
 * 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.
Evan Prodromou's avatar
Evan Prodromou committed
15
 *
Evan Prodromou's avatar
Evan Prodromou committed
16 17 18
 * 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/>.
 */
Evan Prodromou's avatar
Evan Prodromou committed
19

Evan Prodromou's avatar
Evan Prodromou committed
20
if (!defined('LACONICA')) { exit(1); }
Evan Prodromou's avatar
Evan Prodromou committed
21

Evan Prodromou's avatar
Evan Prodromou committed
22 23 24
/**
 * Table Definition for notice
 */
25
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
Evan Prodromou's avatar
Evan Prodromou committed
26

27 28 29 30 31
/* We keep the first three 20-notice pages, plus one for pagination check,
 * in the memcached cache. */

define('NOTICE_CACHE_WINDOW', 61);

32
class Notice extends Memcached_DataObject 
Evan Prodromou's avatar
Evan Prodromou committed
33 34 35 36 37 38 39
{
    ###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
40
    public $uri;                             // varchar(255)  unique_key
41 42 43
    public $content;                         // varchar(140)  
    public $rendered;                        // text()  
    public $url;                             // varchar(255)  
Evan Prodromou's avatar
Evan Prodromou committed
44 45
    public $created;                         // datetime()   not_null
    public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
46
    public $reply_to;                        // int(4)  
Evan Prodromou's avatar
Evan Prodromou committed
47
    public $is_local;                        // tinyint(1)  
48
    public $source;                          // varchar(32)  
Evan Prodromou's avatar
Evan Prodromou committed
49 50

    /* Static get */
51
    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Notice',$k,$v); }
Evan Prodromou's avatar
Evan Prodromou committed
52 53 54

    /* the code above is auto generated do not remove the tag below */
    ###END_AUTOCODE
Evan Prodromou's avatar
Evan Prodromou committed
55 56

	function getProfile() {
57
		return Profile::staticGet('id', $this->profile_id);
Evan Prodromou's avatar
Evan Prodromou committed
58
	}
Mike Cochrane's avatar
Mike Cochrane committed
59

60 61 62
	function delete() {
		$this->blowCaches();
		$this->blowFavesCache();
Evan Prodromou's avatar
Evan Prodromou committed
63
		$this->blowInboxes();
64 65 66
		parent::delete();
	}
	
Mike Cochrane's avatar
Mike Cochrane committed
67 68
	function saveTags() {
		/* extract all #hastags */
Garret Buell's avatar
Garret Buell committed
69
		$count = preg_match_all('/(?:^|\s)#([A-Za-z0-9_\-\.]{1,64})/', strtolower($this->content), $match);
Mike Cochrane's avatar
Mike Cochrane committed
70 71 72
		if (!$count) {
			return true;
		}
Garret Buell's avatar
Garret Buell committed
73 74 75
		
		/* elide characters we don't want in the tag */
		$match[1] = str_replace(array('-', '_', '.'), '', $match[1]);
Mike Cochrane's avatar
Mike Cochrane committed
76 77 78 79 80 81 82 83 84 85

		/* Add them to the database */
		foreach(array_unique($match[1]) as $hashtag) {
			$tag = DB_DataObject::factory('Notice_tag');
			$tag->notice_id = $this->id;
			$tag->tag = $hashtag;
			$tag->created = $this->created;
			$id = $tag->insert();
			if (!$id) {
				$last_error = PEAR::getStaticProperty('DB_DataObject','lastError');
Evan Prodromou's avatar
Evan Prodromou committed
86
				common_log(LOG_ERR, 'DB error inserting hashtag: ' . $last_error->message);
Mike Cochrane's avatar
Mike Cochrane committed
87 88 89 90 91 92
				common_server_error(sprintf(_('DB error inserting hashtag: %s'), $last_error->message));
				return;
			}
		}
		return true;
	}
93 94

	static function saveNew($profile_id, $content, $source=NULL, $is_local=1, $reply_to=NULL, $uri=NULL) {
95 96 97 98
		
		$notice = new Notice();
		$notice->profile_id = $profile_id;
		$notice->is_local = $is_local;
99
		$notice->reply_to = $reply_to;
100
		$notice->created = common_sql_now();
101 102
		$notice->content = $content;
		$notice->rendered = common_render_content($notice->content, $notice);
Ori Avtalion's avatar
Ori Avtalion committed
103 104
		$notice->source = $source;
		$notice->uri = $uri;
Evan Prodromou's avatar
Evan Prodromou committed
105
		
106 107 108
		$id = $notice->insert();

		if (!$id) {
109
			common_log_db_error($notice, 'INSERT', __FILE__);
110 111 112
			return _('Problem saving notice.');
		}

Ori Avtalion's avatar
Ori Avtalion committed
113 114 115
		# Update the URI after the notice is in the database
		if (!$uri) {
			$orig = clone($notice);
116
			$notice->uri = common_notice_uri($notice);
117

Ori Avtalion's avatar
Ori Avtalion committed
118
			if (!$notice->update($orig)) {
119
				common_log_db_error($notice, 'UPDATE', __FILE__);
Ori Avtalion's avatar
Ori Avtalion committed
120 121
				return _('Problem saving notice.');
			}
122 123
		}

124 125
		# XXX: do we need to change this for remote users?
		
126 127
		common_save_replies($notice);
		$notice->saveTags();
128 129 130 131 132

		# Clear the cache for subscribed users, so they'll update at next request
		# XXX: someone clever could prepend instead of clearing the cache
		
		if (common_config('memcached', 'enabled')) {
133
			$notice->blowCaches();
134
		}
135 136

		$notice->addToInboxes();
137 138
		return $notice;
	}
139 140 141 142 143 144

	function blowCaches() {
		$this->blowSubsCache();
		$this->blowNoticeCache();
		$this->blowRepliesCache();
		$this->blowPublicCache();
145 146 147 148 149 150 151 152 153 154
		$this->blowTagCache();
	}

	function blowTagCache() {
		$cache = common_memcache();
		if ($cache) {
			$tag = new Notice_tag();
			$tag->notice_id = $this->id;
			if ($tag->find()) {
				while ($tag->fetch()) {
Evan Prodromou's avatar
Evan Prodromou committed
155
					$cache->delete(common_cache_key('notice_tag:notice_stream:' . $tag->tag));
156 157 158 159 160
				}
			}
			$tag->free();
			unset($tag);
		}
161
	}
162 163
	
	function blowSubsCache() {
164 165
		$cache = common_memcache();
		if ($cache) {
166 167 168 169 170 171 172 173 174 175 176 177 178 179
			$user = new User();
			
			$user->query('SELECT id ' .
						 'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
						 'WHERE subscription.subscribed = ' . $this->profile_id);
			
			while ($user->fetch()) {
				$cache->delete(common_cache_key('user:notices_with_friends:' . $user->id));
			}
			
			$user->free();
			unset($user);
		}
	}
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

	function blowNoticeCache() {
		if ($this->is_local) {
			$cache = common_memcache();
			if ($cache) {
				$cache->delete(common_cache_key('user:notices:'.$this->profile_id));
			}
		}
	}

	function blowRepliesCache() {
		$cache = common_memcache();
		if ($cache) {
			$reply = new Reply();
			$reply->notice_id = $this->id;
			if ($reply->find()) {
				while ($reply->fetch()) {
					$cache->delete(common_cache_key('user:replies:'.$reply->profile_id));
				}
			}
			$reply->free();
			unset($reply);
		}
	}

	function blowPublicCache() {
		if ($this->is_local) {
			$cache = common_memcache();
			if ($cache) {
				$cache->delete(common_cache_key('public'));
			}
		}
	}

	function blowFavesCache() {
		$cache = common_memcache();
		if ($cache) {
			$fave = new Fave();
			$fave->notice_id = $this->id;
			if ($fave->find()) {
				while ($fave->fetch()) {
					$cache->delete(common_cache_key('user:faves:'.$fave->user_id));
				}
			}
			$fave->free();
			unset($fave);
		}
	}
	
	static function getStream($qry, $cachekey, $offset=0, $limit=20) {
		
		if (common_config('memcached', 'enabled')) {
			return Notice::getCachedStream($qry, $cachekey, $offset, $limit);
		} else {
			return Notice::getStreamDirect($qry, $offset, $limit);
		}
	
	}

	static function getStreamDirect($qry, $offset, $limit) {
		
241
		$qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
242 243
		
		if(common_config('db','type')=='pgsql') {
244
			$qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
245
		} else {
246
			$qry .= ' LIMIT ' . $offset . ', ' . $limit;
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
		}

		$notice = new Notice();

		$notice->query($qry);
		
		return $notice;
	}
	
	static function getCachedStream($qry, $cachekey, $offset, $limit) {

		# If outside our cache window, just go to the DB
		
		if ($offset + $limit > NOTICE_CACHE_WINDOW) {
			return Notice::getStreamDirect($qry, $offset, $limit);
		}

		# Get the cache; if we can't, just go to the DB
		
		$cache = common_memcache();
267

268 269 270 271 272 273 274 275 276 277 278
		
		if (!$cache) {
			return Notice::getStreamDirect($qry, $offset, $limit);
		}

		# Get the notices out of the cache
		
		$notices = $cache->get(common_cache_key($cachekey));
		
		# On a cache hit, return a DB-object-like wrapper
		
279
		if ($notices !== FALSE) {
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
			$wrapper = new NoticeWrapper(array_slice($notices, $offset, $limit));
			return $wrapper;
		}

		# Otherwise, get the full cache window out of the DB

		$notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW);
		
		# 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);
		}

		# Store the array in the cache for next time
		
304 305
		$result = $cache->set(common_cache_key($cachekey), $notices);

306 307 308
		# return a wrapper of the array for use now
		
		$wrapper = new NoticeWrapper(array_slice($notices, $offset, $limit));
309
		
310 311
		return $wrapper;
	}
312

313
	function publicStream($offset=0, $limit=20, $since_id=0, $before_id=0) {
314
		
315 316 317
		$needAnd = FALSE;
      	$needWhere = TRUE;

318 319 320 321
		$qry = 'SELECT * FROM notice ';

		if (common_config('public', 'localonly')) {
			$qry .= ' WHERE is_local = 1 ';
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
			$needWhere = FALSE;
			$needAnd = TRUE;
		}

   		// NOTE: since_id and before_id are extensions to Twitter API
        if ($since_id > 0) {
            if ($needWhere)
                $qry .= ' WHERE ';
            if ($needAnd)
				$qry .= ' AND ';
            $qry .= ' notice.id > ' . $since_id . ' ';
			$needAnd = FALSE;
			$needWhere = FALSE;
        }

		if ($before_id > 0) {
            if ($needWhere)
                $qry .= ' WHERE ';
			if ($needAnd)
				$qry .= ' AND ';
			$qry .= ' notice.id < ' . $before_id . ' ';
			$needAnd = FALSE;
			$needWhere = FALSE;
345 346 347 348
		}

		return Notice::getStream($qry,
								 'public',
349
								 $offset, $limit);
350
	}
351 352 353 354 355 356 357 358 359 360 361 362
	
	function addToInboxes() {

		$inbox = new Notice_inbox();
		
		$inbox->query('INSERT INTO notice_inbox (user_id, notice_id) ' .
					  'SELECT user.id, ' . $this->id . ' ' .
					  'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
					  'WHERE subscription.subscribed = ' . $this->profile_id);
		
		return;
	}
Evan Prodromou's avatar
Evan Prodromou committed
363 364 365 366 367 368 369 370 371 372 373 374

	# Delete from inboxes if we're deleted.
	
	function blowInboxes() {

		$inbox = new Notice_inbox();
		$inbox->notice_id = $this->id;
		$inbox->delete();
		
		return;
	}
	
Evan Prodromou's avatar
Evan Prodromou committed
375
}
376