]> git.wh0rd.org Git - tt-rss.git/blob - classes/feedparser.php
atom: consider link rel=alternate in feed element for site urls
[tt-rss.git] / classes / feedparser.php
1 <?php
2 class FeedParser {
3         private $doc;
4         private $error;
5         private $libxml_errors = array();
6         private $items;
7         private $link;
8         private $title;
9         private $type;
10         private $xpath;
11
12         const FEED_RDF = 0;
13         const FEED_RSS = 1;
14         const FEED_ATOM = 2;
15
16         function normalize_encoding($data) {
17                 if (preg_match('/^(<\?xml[\t\n\r ].*?encoding[\t\n\r ]*=[\t\n\r ]*["\'])(.+?)(["\'].*?\?>)/s', $data, $matches) === 1) {
18                         $data = mb_convert_encoding($data, 'UTF-8', $matches[2]);
19
20                         $data = preg_replace('/^<\?xml[\t\n\r ].*?\?>/s', $matches[1] . "UTF-8" . $matches[3] , $data);
21                 }
22
23                 return $data;
24         }
25
26         function __construct($data) {
27                 libxml_use_internal_errors(true);
28                 libxml_clear_errors();
29                 $this->doc = new DOMDocument();
30                 $this->doc->loadXML($data);
31
32                 mb_substitute_character("none");
33
34                 $error = libxml_get_last_error();
35
36                 // libxml compiled without iconv?
37                 if ($error && $error->code == 32) {
38                         $data = $this->normalize_encoding($data);
39
40                         if ($data) {
41                                 libxml_clear_errors();
42
43                                 $this->doc = new DOMDocument();
44                                 $this->doc->loadXML($data);
45
46                                 $error = libxml_get_last_error();
47                         }
48                 }
49
50                 // some terrible invalid unicode entity?
51                 if ($error) {
52                         foreach (libxml_get_errors() as $err) {
53                                 if ($err->code == 9) {
54                                         // if the source feed is not in utf8, next conversion will fail
55                                         $data = $this->normalize_encoding($data);
56
57                                         // remove dangling bytes
58                                         $data = mb_convert_encoding($data, 'UTF-8', 'UTF-8');
59
60                                         // apparently not all UTF-8 characters are valid for XML
61                                         $data = preg_replace('/[^\x{0009}\x{000a}\x{000d}\x{0020}-\x{D7FF}\x{E000}-\x{FFFD}]+/u', ' ', $data);
62
63                                         if ($data) {
64                                                 libxml_clear_errors();
65
66                                                 $this->doc = new DOMDocument();
67                                                 $this->doc->loadXML($data);
68
69                                                 $error = libxml_get_last_error();
70                                         }
71                                         break;
72                                 }
73                         }
74                 }
75
76                 if ($error) {
77                         foreach (libxml_get_errors() as $error) {
78                                 if ($error->level == LIBXML_ERR_FATAL) {
79                                         if(!isset($this->error)) //currently only the first error is reported
80                                                 $this->error = $this->format_error($error);
81                                         $this->libxml_errors [] = $this->format_error($error);
82                                 }
83                         }
84                 }
85                 libxml_clear_errors();
86
87                 $this->items = array();
88         }
89
90         function init() {
91                 $root = $this->doc->firstChild;
92                 $xpath = new DOMXPath($this->doc);
93                 $xpath->registerNamespace('atom', 'http://www.w3.org/2005/Atom');
94                 $xpath->registerNamespace('atom03', 'http://purl.org/atom/ns#');
95                 $xpath->registerNamespace('media', 'http://search.yahoo.com/mrss/');
96                 $xpath->registerNamespace('rdf', 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');
97                 $xpath->registerNamespace('slash', 'http://purl.org/rss/1.0/modules/slash/');
98                 $xpath->registerNamespace('dc', 'http://purl.org/dc/elements/1.1/');
99                 $xpath->registerNamespace('content', 'http://purl.org/rss/1.0/modules/content/');
100                 $xpath->registerNamespace('thread', 'http://purl.org/syndication/thread/1.0');
101
102                 $this->xpath = $xpath;
103
104                 $root = $xpath->query("(//atom03:feed|//atom:feed|//channel|//rdf:rdf|//rdf:RDF)");
105
106                 if ($root && $root->length > 0) {
107                         $root = $root->item(0);
108
109                         if ($root) {
110                                 switch (mb_strtolower($root->tagName)) {
111                                 case "rdf:rdf":
112                                         $this->type = $this::FEED_RDF;
113                                         break;
114                                 case "channel":
115                                         $this->type = $this::FEED_RSS;
116                                         break;
117                                 case "feed":
118                                 case "atom:feed":
119                                         $this->type = $this::FEED_ATOM;
120                                         break;
121                                 default:
122                                         if( !isset($this->error) ){
123                                                 $this->error = "Unknown/unsupported feed type";
124                                         }
125                                         return;
126                                 }
127                         }
128
129                         switch ($this->type) {
130                         case $this::FEED_ATOM:
131
132                                 $title = $xpath->query("//atom:feed/atom:title")->item(0);
133
134                                 if (!$title)
135                                         $title = $xpath->query("//atom03:feed/atom03:title")->item(0);
136
137
138                                 if ($title) {
139                                         $this->title = $title->nodeValue;
140                                 }
141
142                                 $link = $xpath->query("//atom:feed/atom:link[not(@rel)]")->item(0);
143
144                                 if (!$link)
145                                         $link = $xpath->query("//atom:feed/atom:link[@rel='alternate']")->item(0);
146
147                                 if (!$link)
148                                         $link = $xpath->query("//atom03:feed/atom03:link[not(@rel)]")->item(0);
149
150                                 if (!$link)
151                                         $link = $xpath->query("//atom03:feed/atom03:link[@rel='alternate']")->item(0);
152
153                                 if ($link && $link->hasAttributes()) {
154                                         $this->link = $link->getAttribute("href");
155                                 }
156
157                                 $articles = $xpath->query("//atom:entry");
158
159                                 if (!$articles || $articles->length == 0)
160                                         $articles = $xpath->query("//atom03:entry");
161
162                                 foreach ($articles as $article) {
163                                         array_push($this->items, new FeedItem_Atom($article, $this->doc, $this->xpath));
164                                 }
165
166                                 break;
167                         case $this::FEED_RSS:
168                                 $title = $xpath->query("//channel/title")->item(0);
169
170                                 if ($title) {
171                                         $this->title = $title->nodeValue;
172                                 }
173
174                                 $link = $xpath->query("//channel/link")->item(0);
175
176                                 if ($link) {
177                                         if ($link->getAttribute("href"))
178                                                 $this->link = $link->getAttribute("href");
179                                         else if ($link->nodeValue)
180                                                 $this->link = $link->nodeValue;
181                                 }
182
183                                 $articles = $xpath->query("//channel/item");
184
185                                 foreach ($articles as $article) {
186                                         array_push($this->items, new FeedItem_RSS($article, $this->doc, $this->xpath));
187                                 }
188
189                                 break;
190                         case $this::FEED_RDF:
191                                 $xpath->registerNamespace('rssfake', 'http://purl.org/rss/1.0/');
192
193                                 $title = $xpath->query("//rssfake:channel/rssfake:title")->item(0);
194
195                                 if ($title) {
196                                         $this->title = $title->nodeValue;
197                                 }
198
199                                 $link = $xpath->query("//rssfake:channel/rssfake:link")->item(0);
200
201                                 if ($link) {
202                                         $this->link = $link->nodeValue;
203                                 }
204
205                                 $articles = $xpath->query("//rssfake:item");
206
207                                 foreach ($articles as $article) {
208                                         array_push($this->items, new FeedItem_RSS($article, $this->doc, $this->xpath));
209                                 }
210
211                                 break;
212
213                         }
214
215                         if ($this->title) $this->title = trim($this->title);
216                         if ($this->link) $this->link = trim($this->link);
217
218                 } else {
219                         if( !isset($this->error) ){
220                                 $this->error = "Unknown/unsupported feed type";
221                         }
222                         return;
223                 }
224         }
225
226         function format_error($error) {
227                 if ($error) {
228                         return sprintf("LibXML error %s at line %d (column %d): %s",
229                                 $error->code, $error->line, $error->column,
230                                 $error->message);
231                 } else {
232                         return "";
233                 }
234         }
235
236         function error() {
237                 return $this->error;
238         }
239
240         function errors() {
241                 return $this->libxml_errors;
242         }
243
244         function get_link() {
245                 return $this->link;
246         }
247
248         function get_title() {
249                 return $this->title;
250         }
251
252         function get_items() {
253                 return $this->items;
254         }
255
256         function get_links($rel) {
257                 $rv = array();
258
259                 switch ($this->type) {
260                 case $this::FEED_ATOM:
261                         $links = $this->xpath->query("//atom:feed/atom:link");
262
263                         foreach ($links as $link) {
264                                 if (!$rel || $link->hasAttribute('rel') && $link->getAttribute('rel') == $rel) {
265                                         array_push($rv, trim($link->getAttribute('href')));
266                                 }
267                         }
268                         break;
269                 case $this::FEED_RSS:
270                         $links = $this->xpath->query("//atom:link");
271
272                         foreach ($links as $link) {
273                                 if (!$rel || $link->hasAttribute('rel') && $link->getAttribute('rel') == $rel) {
274                                         array_push($rv, trim($link->getAttribute('href')));
275                                 }
276                         }
277                         break;
278                 }
279
280                 return $rv;
281         }
282 } ?>