3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * A channel for real-time browser data
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Evan Prodromou <evan@status.net>
26 * @copyright 2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * A channel for real-time browser data
38 * For each user currently browsing the site, we want to know which page they're on
39 * so we can send real-time updates to their browser.
43 * @author Evan Prodromou <evan@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
45 * @link http://status.net/
50 class Realtime_channel extends Managed_DataObject
52 const TIMEOUT = 1800; // 30 minutes
54 public $__table = 'realtime_channel'; // table name
56 public $user_id; // int -> user.id, can be null
57 public $action; // string
58 public $arg1; // argument
59 public $arg2; // argument, usually null
60 public $channel_key; // 128-bit shared secret key
61 public $created; // created date
62 public $modified; // modified date
65 * Get an instance by key
67 * This is a utility method to get a single instance with a given key value.
69 * @param string $k Key to use to lookup (usually 'user_id' for this class)
70 * @param mixed $v Value to lookup
72 * @return Realtime_channel object found, or null for no hits
75 function staticGet($k, $v=null)
77 return Managed_DataObject::staticGet('Realtime_channel', $k, $v);
81 * Get an instance by compound key
83 * @param array $kv array of key-value mappings
85 * @return Realtime_channel object found, or null for no hits
90 return Managed_DataObject::pkeyGet('Realtime_channel', $kv);
94 * The One True Thingy that must be defined and declared.
96 public static function schemaDef()
99 'description' => 'A channel of realtime notice data',
101 'user_id' => array('type' => 'int',
103 'description' => 'user viewing page; can be null'),
104 'action' => array('type' => 'varchar',
107 'description' => 'page being viewed'),
108 'arg1' => array('type' => 'varchar',
111 'description' => 'page argument, like username or tag'),
112 'arg2' => array('type' => 'varchar',
115 'description' => 'second page argument, like tag for showstream'),
116 'channel_key' => array('type' => 'varchar',
119 'description' => 'shared secret key for this channel'),
120 'created' => array('type' => 'datetime',
122 'description' => 'date this record was created'),
123 'modified' => array('type' => 'datetime',
125 'description' => 'date this record was modified'),
127 'primary key' => array('user_id', 'action', 'arg1', 'arg2'),
128 'unique keys' => array('channel_key'),
129 'foreign keys' => array(
130 'realtime_channel_user_id_fkey' => array('user', array('user_id' => 'id')),
133 'realtime_channel_modified_idx' => array('modified'),
138 static function saveNew($user_id, $action, $arg1, $arg2)
140 $channel = self::getChannel($user_id, $action, $arg1, $arg2);
142 $channel = new Realtime_channel();
144 $channel->user_id = $user_id;
145 $channel->action = $action;
146 $channel->arg1 = $arg1;
147 $channel->arg2 = $arg2;
149 $channel->channel_key = common_good_rand(16); // 128-bit key, 32 hex chars
151 $channel->created = common_sql_now();
152 $channel->modified = $channel->created;
159 static function getChannel($user_id, $action, $arg1, $arg2)
161 $channel = self::pkeyGet(array('user_id' => $user_id,
166 // Ignore (and delete!) old channels
168 if (!empty($channel)) {
169 $modTime = strtotime($channel->modified);
170 if ((time() - $modTime) > self::TIMEOUT) {