summaryrefslogtreecommitdiff
path: root/plugins/SubMirror/classes/SubMirror.php
blob: 4e7e005db261d637742711074151113c9b6c1747 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * 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.
 *
 * 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.
 *
 * 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/>.
 */

/**
 * @package SubMirrorPlugin
 * @maintainer Brion Vibber <brion@status.net>
 */

class SubMirror extends Memcached_DataObject
{
    public $__table = 'submirror';

    public $subscriber;
    public $subscribed;

    public $style;

    public $created;
    public $modified;

    public /*static*/ function staticGet($k, $v=null)
    {
        return parent::staticGet(__CLASS__, $k, $v);
    }

    /**
     * return table definition for DB_DataObject
     *
     * DB_DataObject needs to know something about the table to manipulate
     * instances. This method provides all the DB_DataObject needs to know.
     *
     * @return array array of column definitions
     */

    function table()
    {
        return array('subscriber' =>  DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
                     'subscribed' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,

                     'style' => DB_DATAOBJECT_STR,

                     'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
                     'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
    }

    static function schemaDef()
    {
        // @fixme need a reverse key on (subscribed, subscriber) as well
        return array(new ColumnDef('subscriber', 'integer',
                                   null, false, 'PRI'),
                     new ColumnDef('subscribed', 'integer',
                                   null, false, 'PRI'),

                     new ColumnDef('style', 'varchar',
                                   16, true),

                     new ColumnDef('created', 'datetime',
                                   null, false),
                     new ColumnDef('modified', 'datetime',
                                   null, false));
    }

    /**
     * return key definitions for DB_DataObject
     *
     * DB_DataObject needs to know about keys that the table has; this function
     * defines them.
     *
     * @return array key definitions
     */

    function keys()
    {
        return array_keys($this->keyTypes());
    }

    /**
     * return key definitions for Memcached_DataObject
     *
     * Our caching system uses the same key definitions, but uses a different
     * method to get them.
     *
     * @return array key definitions
     */

    function keyTypes()
    {
        // @fixme keys
        // need a sane key for reverse lookup too
        return array('subscriber' => 'K', 'subscribed' => 'K');
    }

    function sequenceKey()
    {
        return array(false, false, false);
    }

    /**
     * @param Profile $subscribed
     * @param Profile $subscribed
     * @return SubMirror
     * @throws ServerException
     */
    public static function saveMirror($subscriber, $subscribed, $style='repeat')
    {
        // @fixme make sure they're subscribed!
        $mirror = new SubMirror();

        $mirror->subscriber = $subscriber->id;
        $mirror->subscribed = $subscribed->id;
        $mirror->style = $style;

        $mirror->created = common_sql_now();
        $mirror->modified = common_sql_now();
        $mirror->insert();
        
        return $mirror;
    }

    /**
     * @param Notice $notice
     * @return mixed Notice on successful mirroring, boolean if not
     */
    public function mirrorNotice($notice)
    {
        $profile = Profile::staticGet('id', $this->subscriber);
        if (!$profile) {
            common_log(LOG_ERROR, "SubMirror plugin skipping auto-repeat of notice $notice->id for missing user $profile->id");
            return false;
        }

        if ($this->style == 'copy') {
            return $this->copyNotice($profile, $notice);
        } else { // default to repeat mode
            return $this->repeatNotice($profile, $notice);
        }
    }

    /**
     * Mirror a notice using StatusNet's repeat functionality.
     * This retains attribution within the site, and other nice things,
     * but currently ends up looking like 'RT @foobar bla bla' when
     * bridged out over OStatus or TwitterBridge.
     * 
     * @param Notice $notice
     * @return mixed Notice on successful repeat, true if already repeated, false on failure
     */
    protected function repeatNotice($profile, $notice)
    {
        if($profile->hasRepeated($notice->id)) {
            common_log(LOG_INFO, "SubMirror plugin skipping auto-repeat of notice $notice->id for user $profile->id; already repeated.");
            return true;
        } else {
            common_log(LOG_INFO, "SubMirror plugin auto-repeating notice $notice->id for $profile->id");
            return $notice->repeat($profile->id, 'mirror');
        }
    }

    /**
     * Mirror a notice by emitting a new notice with the same contents.
     * Kind of dirty, but if pulling an external data feed into an account
     * that may be what you want.
     * 
     * @param Notice $notice
     * @return mixed Notice on successful repeat, true if already repeated, false on failure
     */
    protected function copyNotice($profile, $notice)
    {
        $options = array('is_local' => Notice::LOCAL_PUBLIC,
                         'url' => $notice->bestUrl(), // pass through the foreign link...
                         'rendered' => $notice->rendered);

        $saved = Notice::saveNew($profile->id,
                                 $notice->content,
                                 'feed',
                                 $options);
        return $saved;
    }

    public /*static*/ function pkeyGet($v)
    {
        return parent::pkeyGet(__CLASS__, $v);
    }

    /**
     * Get the mirroring setting for a pair of profiles, if existing.
     * 
     * @param Profile $subscriber
     * @param Profile $subscribed
     * @return mixed Profile or empty
     */
    public static function getMirror($subscriber, $subscribed)
    {
        return self::pkeyGet(array('subscriber' => $subscriber->id,
                                   'subscribed' => $subscribed->id));
    }
}