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

Notice.php 12 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 47 48
    public $reply_to;                        // int(4)  
    public $is_local;                        // tinyint(1)  
    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
		parent::delete();
	}
66

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;
		}
73

Garret Buell's avatar
Garret Buell committed
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;
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
		# XXX: do we need to change this for remote users?
125

126 127
		common_save_replies($notice);
		$notice->saveTags();
128 129 130

		# Clear the cache for subscribed users, so they'll update at next request
		# XXX: someone clever could prepend instead of clearing the cache
131

132
		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
			$user = new User();
167

168 169 170
			$user->query('SELECT id ' .
						 'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
						 'WHERE subscription.subscribed = ' . $this->profile_id);
171

172 173 174
			while ($user->fetch()) {
				$cache->delete(common_cache_key('user:notices_with_friends:' . $user->id));
			}
175

176 177 178 179
			$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

	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);
		}
	}
228

229 230 231 232
	# 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, $before_id=0, $order=NULL) {
233

234
		if (common_config('memcached', 'enabled')) {
235 236 237

			# Skip the cache if this is a since_id or before_id qry
			if ($since_id > 0 || $before_id > 0) {
238
				return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order);
239
			} else {
240
				return Notice::getCachedStream($qry, $cachekey, $offset, $limit, $order);
241
			}
242
		}
243

244
		return Notice::getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order);
245 246
	}

247
	static function getStreamDirect($qry, $offset, $limit, $since_id, $before_id, $order) {
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

		$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 ($before_id > 0) {

			if ($needWhere) {
		    	$qry .= ' WHERE ';
				$needWhere = FALSE;
			} else {
				$qry .= ' AND ';
			}

			$qry .= ' notice.id < ' . $before_id;
		}

281 282 283 284 285 286 287
		# Allow ORDER override
		
		if ($order) {
			$qry .= $order;
		} else {
			$qry .= ' ORDER BY notice.created DESC, notice.id DESC ';
		}
288 289

		if (common_config('db','type') == 'pgsql') {
290
			$qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
291
		} else {
292
			$qry .= ' LIMIT ' . $offset . ', ' . $limit;
293 294 295 296 297
		}

		$notice = new Notice();

		$notice->query($qry);
298

299 300
		return $notice;
	}
301

302 303 304
	# XXX: this is pretty long and should probably be broken up into
	# some helper functions
	
305
	static function getCachedStream($qry, $cachekey, $offset, $limit, $order) {
306 307

		# If outside our cache window, just go to the DB
308

309
		if ($offset + $limit > NOTICE_CACHE_WINDOW) {
310
			return Notice::getStreamDirect($qry, $offset, $limit, NULL, NULL, $order);
311 312 313
		}

		# Get the cache; if we can't, just go to the DB
314

315
		$cache = common_memcache();
316

317
		if (!$cache) {
318
			return Notice::getStreamDirect($qry, $offset, $limit, NULL, NULL, $order);
319 320 321
		}

		# Get the notices out of the cache
322

323
		$notices = $cache->get(common_cache_key($cachekey));
324

325
		# On a cache hit, return a DB-object-like wrapper
326

327
		if ($notices !== FALSE) {
328 329 330 331
			$wrapper = new NoticeWrapper(array_slice($notices, $offset, $limit));
			return $wrapper;
		}

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
		# 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);
			
			if ($new_notice) {
				$new_notices = array();
				while ($new_notice->fetch()) {
					$new_notices[] = clone($new_notice);
				}
				$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 NoticeWrapper(array_slice($notices, $offset, $limit));
			}
		}
		
372 373
		# Otherwise, get the full cache window out of the DB

374
		$notice = Notice::getStreamDirect($qry, 0, NOTICE_CACHE_WINDOW, NULL, NULL, $order);
375

376
		# If there are no hits, just return the value
377

378 379 380 381 382
		if (!$notice) {
			return $notice;
		}

		# Pack results into an array
383

384 385 386 387 388 389
		$notices = array();

		while ($notice->fetch()) {
			$notices[] = clone($notice);
		}

390 391
		$notice->free();
		
392
		# Store the array in the cache for next time
393

394
		$result = $cache->set(common_cache_key($cachekey), $notices);
395
		$result = $cache->set(common_cache_key($cachekey) . ';last', $notices);
396

397
		# return a wrapper of the array for use now
398

399
		$wrapper = new NoticeWrapper(array_slice($notices, $offset, $limit));
400

401 402
		return $wrapper;
	}
403

404
	function publicStream($offset=0, $limit=20, $since_id=0, $before_id=0) {
405

406 407
		$parts = array();
		
408 409 410
		$qry = 'SELECT * FROM notice ';

		if (common_config('public', 'localonly')) {
411 412 413 414 415
			$parts[] = 'is_local = 1';
		}

		if (common_config('public', 'blacklist')) {
			$parts[] = 'profile_id not in (' . implode(',', common_config('public', 'blacklist')) . ')';
416 417
		}

418 419 420 421
		if ($parts) {
			$qry .= ' WHERE ' . implode(' AND ', $parts);
		}
			  
422 423
		return Notice::getStream($qry,
								 'public',
424
								 $offset, $limit, $since_id, $before_id);
425
	}
426

427
	function addToInboxes() {
428 429 430 431 432 433 434
		$enabled = common_config('inboxes', 'enabled');

		if ($enabled === true || $enabled === 'transitional') {
			$inbox = new Notice_inbox();
			$qry = 'INSERT INTO notice_inbox (user_id, notice_id, created) ' .
			  'SELECT user.id, ' . $this->id . ', "' . $this->created . '" ' .
			  'FROM user JOIN subscription ON user.id = subscription.subscriber ' .
435 436 437 438 439
			  'WHERE subscription.subscribed = ' . $this->profile_id . ' ' .
			  'AND NOT EXISTS (SELECT user_id, notice_id ' .
			  'FROM notice_inbox ' .
			  'WHERE user_id = user.id ' . 
			  'AND notice_id = ' . $this->id . ' )';
440 441 442 443 444
			if ($enabled === 'transitional') {
				$qry .= ' AND user.inboxed = 1';
			}
			$inbox->query($qry);
		}
445 446
		return;
	}
Evan Prodromou's avatar
Evan Prodromou committed
447 448

	# Delete from inboxes if we're deleted.
449

Evan Prodromou's avatar
Evan Prodromou committed
450 451
	function blowInboxes() {

452 453 454 455 456 457 458
		$enabled = common_config('inboxes', 'enabled');

		if ($enabled === true || $enabled === 'transitional') {
			$inbox = new Notice_inbox();
			$inbox->notice_id = $this->id;
			$inbox->delete();
		}
459

Evan Prodromou's avatar
Evan Prodromou committed
460 461
		return;
	}
462

Evan Prodromou's avatar
Evan Prodromou committed
463
}
464