3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * @package SubMirrorPlugin
22 * @maintainer Brion Vibber <brion@status.net>
25 class SubMirror extends Memcached_DataObject
27 public $__table = 'submirror';
37 public /*static*/ function staticGet($k, $v=null)
39 return parent::staticGet(__CLASS__, $k, $v);
43 * return table definition for DB_DataObject
45 * DB_DataObject needs to know something about the table to manipulate
46 * instances. This method provides all the DB_DataObject needs to know.
48 * @return array array of column definitions
53 return array('subscriber' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
54 'subscribed' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
56 'style' => DB_DATAOBJECT_STR,
58 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
59 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
62 static function schemaDef()
64 // @fixme need a reverse key on (subscribed, subscriber) as well
65 return array(new ColumnDef('subscriber', 'integer',
67 new ColumnDef('subscribed', 'integer',
70 new ColumnDef('style', 'varchar',
73 new ColumnDef('created', 'datetime',
75 new ColumnDef('modified', 'datetime',
80 * Temporary hack to set up the compound index, since we can't do
81 * it yet through regular Schema interface. (Coming for 1.0...)
83 * @param Schema $schema
86 static function fixIndexes($schema)
89 $schema->createIndex('submirror', array('subscribed', 'subscriber'));
90 } catch (Exception $e) {
91 common_log(LOG_ERR, __METHOD__ . ': ' . $e->getMessage());
96 * return key definitions for DB_DataObject
98 * DB_DataObject needs to know about keys that the table has; this function
101 * @return array key definitions
106 return array_keys($this->keyTypes());
110 * return key definitions for Memcached_DataObject
112 * Our caching system uses the same key definitions, but uses a different
113 * method to get them.
115 * @return array key definitions
121 // need a sane key for reverse lookup too
122 return array('subscriber' => 'K', 'subscribed' => 'K');
125 function sequenceKey()
127 return array(false, false, false);
131 * @param Profile $subscribed
132 * @param Profile $subscribed
134 * @throws ServerException
136 public static function saveMirror($subscriber, $subscribed, $style='repeat')
138 // @fixme make sure they're subscribed!
139 $mirror = new SubMirror();
141 $mirror->subscriber = $subscriber->id;
142 $mirror->subscribed = $subscribed->id;
143 $mirror->style = $style;
145 $mirror->created = common_sql_now();
146 $mirror->modified = common_sql_now();
153 * @param Notice $notice
154 * @return mixed Notice on successful mirroring, boolean if not
156 public function mirrorNotice($notice)
158 $profile = Profile::staticGet('id', $this->subscriber);
160 common_log(LOG_ERROR, "SubMirror plugin skipping auto-repeat of notice $notice->id for missing user $profile->id");
164 if ($this->style == 'copy') {
165 return $this->copyNotice($profile, $notice);
166 } else { // default to repeat mode
167 return $this->repeatNotice($profile, $notice);
172 * Mirror a notice using StatusNet's repeat functionality.
173 * This retains attribution within the site, and other nice things,
174 * but currently ends up looking like 'RT @foobar bla bla' when
175 * bridged out over OStatus or TwitterBridge.
177 * @param Notice $notice
178 * @return mixed Notice on successful repeat, true if already repeated, false on failure
180 protected function repeatNotice($profile, $notice)
182 if($profile->hasRepeated($notice->id)) {
183 common_log(LOG_INFO, "SubMirror plugin skipping auto-repeat of notice $notice->id for user $profile->id; already repeated.");
186 common_log(LOG_INFO, "SubMirror plugin auto-repeating notice $notice->id for $profile->id");
187 return $notice->repeat($profile->id, 'mirror');
192 * Mirror a notice by emitting a new notice with the same contents.
193 * Kind of dirty, but if pulling an external data feed into an account
194 * that may be what you want.
196 * @param Notice $notice
197 * @return mixed Notice on successful repeat, true if already repeated, false on failure
199 protected function copyNotice($profile, $notice)
201 $options = array('is_local' => Notice::LOCAL_PUBLIC,
202 'url' => $notice->bestUrl(), // pass through the foreign link...
203 'rendered' => $notice->rendered);
205 $saved = Notice::saveNew($profile->id,
212 public /*static*/ function pkeyGet($v)
214 return parent::pkeyGet(__CLASS__, $v);
218 * Get the mirroring setting for a pair of profiles, if existing.
220 * @param Profile $subscriber
221 * @param Profile $subscribed
222 * @return mixed Profile or empty
224 public static function getMirror($subscriber, $subscribed)
226 return self::pkeyGet(array('subscriber' => $subscriber->id,
227 'subscribed' => $subscribed->id));