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 Managed_DataObject
27 public $__table = 'submirror';
38 * return table definition for DB_DataObject
40 * DB_DataObject needs to know something about the table to manipulate
41 * instances. This method provides all the DB_DataObject needs to know.
43 * @return array array of column definitions
48 return array('subscriber' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
49 'subscribed' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
51 'style' => DB_DATAOBJECT_STR,
53 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
54 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
57 static function schemaDef()
59 // @fixme need a reverse key on (subscribed, subscriber) as well
60 return array(new ColumnDef('subscriber', 'integer',
62 new ColumnDef('subscribed', 'integer',
65 new ColumnDef('style', 'varchar',
68 new ColumnDef('created', 'datetime',
70 new ColumnDef('modified', 'datetime',
75 * Temporary hack to set up the compound index, since we can't do
76 * it yet through regular Schema interface. (Coming for 1.0...)
78 * @param Schema $schema
81 static function fixIndexes($schema)
84 $schema->createIndex('submirror', array('subscribed', 'subscriber'));
85 } catch (Exception $e) {
86 common_log(LOG_ERR, __METHOD__ . ': ' . $e->getMessage());
91 * return key definitions for DB_DataObject
93 * DB_DataObject needs to know about keys that the table has; this function
96 * @return array key definitions
101 return array_keys($this->keyTypes());
105 * return key definitions for Memcached_DataObject
107 * Our caching system uses the same key definitions, but uses a different
108 * method to get them.
110 * @return array key definitions
116 // need a sane key for reverse lookup too
117 return array('subscriber' => 'K', 'subscribed' => 'K');
120 function sequenceKey()
122 return array(false, false, false);
126 * @param Profile $subscribed
127 * @param Profile $subscribed
129 * @throws ServerException
131 public static function saveMirror($subscriber, $subscribed, $style='repeat')
133 // @fixme make sure they're subscribed!
134 $mirror = new SubMirror();
136 $mirror->subscriber = $subscriber->id;
137 $mirror->subscribed = $subscribed->id;
138 $mirror->style = $style;
140 $mirror->created = common_sql_now();
141 $mirror->modified = common_sql_now();
148 * @param Notice $notice
149 * @return mixed Notice on successful mirroring, boolean if not
151 public function mirrorNotice(Notice $notice)
153 $profile = Profile::getKV('id', $this->subscriber);
154 if (!($profile instanceof Profile)) {
155 common_log(LOG_ERR, "SubMirror plugin skipping auto-repeat of notice $notice->id for missing user $profile->id");
159 if ($this->style == 'copy') {
160 return $this->copyNotice($profile, $notice);
161 } else { // default to repeat mode
162 return $this->repeatNotice($profile, $notice);
167 * Mirror a notice using StatusNet's repeat functionality.
168 * This retains attribution within the site, and other nice things,
169 * but currently ends up looking like 'RT @foobar bla bla' when
170 * bridged out over OStatus or TwitterBridge.
172 * @param Notice $notice
173 * @return mixed Notice on successful repeat, true if already repeated, false on failure
175 protected function repeatNotice(Profile $profile, Notice $notice)
177 if($profile->hasRepeated($notice)) {
178 common_log(LOG_INFO, "SubMirror plugin skipping auto-repeat of notice $notice->id for user $profile->id; already repeated.");
181 common_log(LOG_INFO, "SubMirror plugin auto-repeating notice $notice->id for $profile->id");
182 return $notice->repeat($profile, 'mirror');
187 * Mirror a notice by emitting a new notice with the same contents.
188 * Kind of dirty, but if pulling an external data feed into an account
189 * that may be what you want.
191 * @param Notice $notice
192 * @return mixed Notice on successful repeat, true if already repeated, false on failure
194 protected function copyNotice($profile, $notice)
196 $options = array('is_local' => Notice::LOCAL_PUBLIC,
197 'url' => $notice->getUrl(), // pass through the foreign link...
198 'rendered' => $notice->getRendered());
200 $saved = Notice::saveNew($profile->id,
208 * Get the mirroring setting for a pair of profiles, if existing.
210 * @param Profile $subscriber
211 * @param Profile $subscribed
212 * @return mixed Profile or empty
214 public static function getMirror($subscriber, $subscribed)
216 return self::pkeyGet(array('subscriber' => $subscriber->id,
217 'subscribed' => $subscribed->id));