summaryrefslogtreecommitdiff
path: root/plugins/OStatus/lib/feedmunger.php
blob: 5dce95342e1cfe26672535fce90bf30f0fc7ff66 (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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2009, 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 FeedSubPlugin
 * @maintainer Brion Vibber <brion@status.net>
 */

if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }

class FeedSubPreviewNotice extends Notice
{
    protected $fetched = true;

    function __construct($profile)
    {
        $this->profile = $profile;
        $this->profile_id = 0;
    }
    
    function getProfile()
    {
        return $this->profile;
    }
    
    function find()
    {
        return true;
    }
    
    function fetch()
    {
        $got = $this->fetched;
        $this->fetched = false;
        return $got;
    }
}

class FeedSubPreviewProfile extends Profile
{
    function getAvatar($width, $height=null)
    {
        return new FeedSubPreviewAvatar($width, $height, $this->avatar);
    }
}

class FeedSubPreviewAvatar extends Avatar
{
    function __construct($width, $height, $remote)
    {
        $this->remoteImage = $remote;
    }

    function displayUrl() {
        return $this->remoteImage;
    }
}

class FeedMunger
{
    /**
     * @param XML_Feed_Parser $feed
     */
    function __construct($feed, $url=null)
    {
        $this->feed = $feed;
        $this->url = $url;
    }
    
    function feedinfo()
    {
        $feedinfo = new Feedinfo();
        $feedinfo->feeduri = $this->url;
        $feedinfo->homeuri = $this->feed->link;
        $feedinfo->huburi = $this->getHubLink();
        return $feedinfo;
    }

    function getAtomLink($item, $attribs=array())
    {
        // XML_Feed_Parser gets confused by multiple <link> elements.
        $dom = $item->model;

        // Note that RSS feeds would embed an <atom:link> so this should work for both.
        /// http://code.google.com/p/pubsubhubbub/wiki/RssFeeds
        // <link rel='hub' href='http://pubsubhubbub.appspot.com/'/>
        $links = $dom->getElementsByTagNameNS('http://www.w3.org/2005/Atom', 'link');
        for ($i = 0; $i < $links->length; $i++) {
            $node = $links->item($i);
            if ($node->hasAttributes()) {
                $href = $node->attributes->getNamedItem('href');
                if ($href) {
                    $matches = 0;
                    foreach ($attribs as $name => $val) {
                        $attrib = $node->attributes->getNamedItem($name);
                        if ($attrib && $attrib->value == $val) {
                            $matches++;
                        }
                    }
                    if ($matches == count($attribs)) {
                        return $href->value;
                    }
                }
            }
        }
        return false;
    }

    function getRssLink($item)
    {
        // XML_Feed_Parser gets confused by multiple <link> elements.
        $dom = $item->model;

        // Note that RSS feeds would embed an <atom:link> so this should work for both.
        /// http://code.google.com/p/pubsubhubbub/wiki/RssFeeds
        // <link rel='hub' href='http://pubsubhubbub.appspot.com/'/>
        $links = $dom->getElementsByTagName('link');
        for ($i = 0; $i < $links->length; $i++) {
            $node = $links->item($i);
            if (!$node->hasAttributes()) {
                return $node->textContent;
            }
        }
        return false;
    }

    function getAltLink($item)
    {
        // Check for an atom link...
        $link = $this->getAtomLink($item, array('rel' => 'alternate', 'type' => 'text/html'));
        if (!$link) {
            $link = $this->getRssLink($item);
        }
        return $link;
    }

    function getHubLink()
    {
        return $this->getAtomLink($this->feed, array('rel' => 'hub'));
    }

    /**
     * Get an appropriate avatar image source URL, if available.
     * @return mixed string or false
     */
    function getAvatar()
    {
        $logo = $this->feed->logo;
        if ($logo) {
            return $logo;
        }
        $icon = $this->feed->icon;
        if ($icon) {
            return $icon;
        }
        return common_path('plugins/OStatus/images/48px-Feed-icon.svg.png');
    }

    function profile($preview=false)
    {
        if ($preview) {
            $profile = new FeedSubPreviewProfile();
        } else {
            $profile = new Profile();
        }
        
        // @todo validate/normalize nick?
        $profile->nickname   = $this->feed->title;
        $profile->fullname   = $this->feed->title;
        $profile->homepage   = $this->getAltLink($this->feed);
        $profile->bio        = $this->feed->description;
        $profile->profileurl = $this->getAltLink($this->feed);

        if ($preview) {
            $profile->avatar = $this->getAvatar();
        }
        
        // @todo tags from categories
        // @todo lat/lon/location?

        return $profile;
    }

    function notice($index=1, $preview=false)
    {
        $entry = $this->feed->getEntryByOffset($index);
        if (!$entry) {
            return null;
        }

        if ($preview) {
            $notice = new FeedSubPreviewNotice($this->profile(true));
            $notice->id = -1;
        } else {
            $notice = new Notice();
        }

        $link = $this->getAltLink($entry);
        if (empty($link)) {
            if (preg_match('!^https?://!', $entry->id)) {
                $link = $entry->id;
                common_log(LOG_DEBUG, "No link on entry, using URL from id: $link");
            }
        }
        $notice->uri = $link;
        $notice->url = $link;
        $notice->content = $this->noticeFromEntry($entry);
        $notice->rendered = common_render_content($notice->content, $notice); // @fixme this is failing on group posts
        $notice->created = common_sql_date($entry->updated); // @fixme
        $notice->is_local = Notice::GATEWAY;
        $notice->source = 'feed';

        $location = $this->getLocation($entry);
        if ($location) {
            if ($location->location_id) {
                $notice->location_ns = $location->location_ns;
                $notice->location_id = $location->location_id;
            }
            $notice->lat = $location->lat;
            $notice->lon = $location->lon;
        }

        return $notice;
    }

    /**
     * @param feed item $entry
     * @return mixed Location or false
     */
    function getLocation($entry)
    {
        $dom = $entry->model;
        $points = $dom->getElementsByTagNameNS('http://www.georss.org/georss', 'point');
        
        for ($i = 0; $i < $points->length; $i++) {
            $point = trim($points->item(0)->textContent);
            $coords = explode(' ', $point);
            if (count($coords) == 2) {
                list($lat, $lon) = $coords;
                if (is_numeric($lat) && is_numeric($lon)) {
                    common_log(LOG_INFO, "Looking up location for $lat $lon from georss");
                    return Location::fromLatLon($lat, $lon);
                }
            }
            common_log(LOG_ERR, "Ignoring bogus georss:point value $point");
        }

        return false;
    }

    /**
     * @param XML_Feed_Type $entry
     * @return string notice text, within post size limit
     */
    function noticeFromEntry($entry)
    {
        $max = Notice::maxContent();
        $ellipsis = "\xe2\x80\xa6"; // U+2026 HORIZONTAL ELLIPSIS
        $title = $entry->title;
        $link = $entry->link;

        // @todo We can get <category> entries like this:
        // $cats = $entry->getCategory('category', array(0, true));
        // but it feels like an awful hack. If it's accessible cleanly,
        // try adding #hashtags from the categories/tags on a post.

        $title = $entry->title;
        $link = $this->getAltLink($entry);
        if ($link) {
            // Blog post or such...
            // @todo Should we force a language here?
            $format = _m('New post: "%1$s" %2$s');
            $out = sprintf($format, $title, $link);

            // Trim link if needed...
            if (mb_strlen($out) > $max) {
                $link = common_shorten_url($link);
                $out = sprintf($format, $title, $link);
            }

            // Trim title if needed...
            if (mb_strlen($out) > $max) {
                $used = mb_strlen($out) - mb_strlen($title);
                $available = $max - $used - mb_strlen($ellipsis);
                $title = mb_substr($title, 0, $available) . $ellipsis;
                $out = sprintf($format, $title, $link);
            }
        } else {
            // No link? Consider a bare status update.
            if (mb_strlen($title) > $max) {
                $available = $max - mb_strlen($ellipsis);
                $out = mb_substr($title, 0, $available) . $ellipsis;
            } else {
                $out = $title;
            }
        }
        
        return $out;
    }
}