forked from nerdonthestreet/Nilamark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfavicon-downloader.php
561 lines (517 loc) · 24.5 KB
/
favicon-downloader.php
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
<?php
/**
* FaviconDownloader
* Find favicon URL and download it easy
* Requirements : PHP 5.2+ with curl extension
* © 2014 www.finalclap.com
* @copyright 2014 Vincent Paré
* @author Vincent Paré
* @link http://www.finalclap.com/
* @version 1
*/
class FaviconDownloader
{
public $url = null; // (string) Page URL
public $pageUrl = null; // (string) Page URL, after prospective redirects
public $siteUrl = null; // (string) Site root URL (homepage), based on $pageUrl
public $icoUrl = null; // (string) full URI to favicon
public $icoType = null; // (string) favicon type (file extension, ex: ico|gif|png)
public $findMethod = null; // (string) favicon url determination method (default favicon.ico or found in <head> <link/> tag)
public $error = null; // (string) details, in case of failure...
public $icoExists = null; // (bool) tell if the favicon exists (set after calling downloadFavicon)
public $icoMd5 = null; // (string) md5 of $icoData
public $icoData = null; // (binary) favicon binary data
public $debugInfo = null; // (array) additionnal debug info
public static $httpProxy = null; // (string) HTTP proxy (ex: localhost:8888)
/**
* Create a new FaviconDownloader object, search & download favicon if $auto is true
*/
public function __construct($url = null, $auto = true)
{
if(!$url) return;
$this->url = $url;
if(!$auto) return;
$this->getFaviconUrl();
$this->downloadFavicon();
}
/**
* Download page and search html to find favicon URL. Returns favicon URL.
*/
public function getFaviconUrl()
{
// If already executed, don't need to search again
if(!empty($this->icoUrl)){
// error_log('Icon URL already found');
return $this->icoUrl;
}
// Check URL to search
if(empty($this->url)){
trigger_error('$this->url is empty', E_USER_WARNING);
// error_log('No URL provided');
return false;
}
// Removing fragment (hash) from URL
$url = $this->url;
$urlInfo = parse_url($this->url);
if(isset($urlInfo['fragment'])){
$url = str_replace('#'.$urlInfo['fragment'], '', $url);
}
// Downloading the page
$html = self::downloadPageAs($url, $info);
if($info['curl_errno'] != 0){
$this->error = $info['curl_error'];
// error_log('Failed to download page');
return false;
}
// Saving final URL (after prospective redirects) and get root URL
$this->pageUrl = $info['effective_url'];
$pageUrlInfo = parse_url($this->pageUrl);
if(!empty($pageUrlInfo['scheme']) && !empty($pageUrlInfo['host'])){
$this->siteUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].'/';
}
// Default favicon URL
$this->icoUrl = $this->siteUrl.'favicon.ico';
$this->findMethod = 'default';
// error_log($html);
// HTML <head> tag extraction
preg_match('#^(.*)<\s*body#isU', $html, $matches);
$htmlHead = isset($matches[1]) ? $matches[1] : $html;
// error_log($htmlHead);
// HTML <base> tag href extraction
$base_href = null;
if(preg_match('#<base[^>]+href=(["\'])([^>]+)\1#i', $htmlHead, $matches)){
$base_href = rtrim($matches[2],'/').'/';
$this->debugInfo['base_href'] = &$base_href;
}
// HTML <link> icon tag analysis (check for explicit shortcut icon first)
if(preg_match('#<\s*link[^>]*(rel=(["\'])[^>\2]*shortcut icon[^>\2]*\2)[^>]*>#i', $htmlHead, $matches)){
// error_log("found a shortcut icon tag");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
// error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
} // Check for one with "favicon" in the name
// error_log($this->icoUrl . $this->findMethod);
} else if(preg_match('#<\s*link[^>]*(rel=(["\'])[^>\2]*icon[^>\2]*\2)(.*favicon)[^>]*>#i', $htmlHead, $matches)){
// error_log("found a favicon tag");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
// error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
} // HTML <link> icon tag analysis (modified to exclude CSS)
} else if(preg_match('#<\s*link[^>]*(rel=(["\'])*icon[^>\2]*\2)[^>]*>#i', $htmlHead, $matches)){
// error_log("found a ref=icon tag without CSS");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
// error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
// error_log($this->icoUrl . $this->findMethod);
} // If there wasn't a generic icon without CSS in the name, check for an iOS icon
} else if(preg_match('#<\s*link[^>]*(rel=(["\'])[^>\2]*apple-touch-icon[^>\2]*\2)[^>]*>#i', $htmlHead, $matches)){
// error_log("found an iOS image in the path");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
// error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
}
} else if(preg_match('#<\s*link[^>]*(rel=(["\'])[^>\2]*icon[^>\2]*\2)(?!.*css)[^>]*>#i', $htmlHead, $matches)){
// error_log("found an iOS image in the path");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
// error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
}
} else if(preg_match('#<\s*link[^>]*(rel=(["\'])[^>\2]*icon[^>\2]*\2)[^>]*>#i', $htmlHead, $matches)){
// error_log("found a link tag");
$link_tag = $matches[0];
$this->debugInfo['link_tag'] = &$link_tag;
// HTML <link> icon tag href analysis
if(preg_match('#href\s*=\s*(["\'])(.*?)\1#i', $link_tag, $matches)){
//error_log("found the href");
$ico_href = trim($matches[2]);
$this->debugInfo['ico_href'] = &$ico_href;
$this->findMethod = 'head';
// Building full absolute URL
$urlType = self::urlType($ico_href);
$this->findMethod .= ' '.$urlType;
switch($urlType){
case 'absolue_full':
$this->icoUrl = $ico_href;
break;
case 'absolute_scheme':
$this->icoUrl = $pageUrlInfo['scheme'].':'.$ico_href;
break;
case 'absolute_path':
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = rtrim($this->siteUrl, '/').'/'.ltrim($ico_href, '/');
$this->findMethod .= ' without base href';
}
break;
case 'relative':
$path = preg_replace('#/[^/]+?$#i', '/', $pageUrlInfo['path']);
if(isset($base_href)){
$this->icoUrl = $base_href.$ico_href;
$this->findMethod .= ' with base href';
} else {
$this->icoUrl = $pageUrlInfo['scheme'].'://'.$pageUrlInfo['host'].$path.$ico_href;
$this->findMethod .= ' without base href';
}
break;
}
}
}
$this->icoType = self::getExtension($this->icoUrl);
// error_log($this->icoUrl);
return $this->icoUrl;
}
/**
* Télécharge le favicon (et vérifie son existance au passage)
*/
public function downloadFavicon()
{
// Check params
if(empty($this->icoUrl)){
return false;
}
// Prevent useless re-download
/*if(!empty($this->icoData)){
return false;
}*/
// Download favicon
// error_log("Downloading: " . $this->icoUrl);
$content = self::downloadAs($this->icoUrl, $info);
$this->debugInfo['favicon_download_metadata'] = $info;
// Failover : if getting a 404 with favicon URL found in HTML source, trying with the default favicon URL
// if($content === false && $info['http_code'] == 404 && $this->findMethod != 'default' && !isset($this->debugInfo['failover'])){
if($content === false && $this->findMethod != 'default' && !isset($this->debugInfo['failover'])){
$this->icoUrl = $this->siteUrl.'favicon.ico';
$this->findMethod = 'default';
$this->icoType = self::getExtension($this->icoUrl);
$this->debugInfo['failover'] = true;
return $this->downloadFavicon();
}
// Download error
if($content === false){
$this->error = 'HTTP '.$info['http_code'];
return false;
}
// Check favicon content
if(strlen($content) == 0){
$this->error = "Empty content";
return false;
}
if(in_array($info['content_type'], array('text/html', 'text/plain')) || preg_match('#(</html>|</b>|DOCTYPE html)#i', $content)){
$this->error = "Seems to be HTML page";
return false;
}
if(in_array($info['content_type'], array('font/truetype', 'font/woff', 'font/woff2', 'application/x-font-woff', 'font/ttf'))){
$this->error = "Seems to be a font";
//error_log('Seems to be a font');
if($this->findMethod != 'default' && !isset($this->debugInfo['failover'])){
// error_log('Trying the default');
$this->icoUrl = $this->siteUrl.'favicon.ico';
$this->findMethod = 'default';
$this->icoType = self::getExtension($this->icoUrl);
$this->debugInfo['failover'] = true;
return $this->downloadFavicon();
}
return false;
}
if(preg_match('#(font-face|font-family|font-weight|background-size)#i', $content)){
$this->error = "Seems to be CSS";
//error_log('Seems to be CSS');
if($this->findMethod != 'default' && !isset($this->debugInfo['failover'])){
// error_log('Trying the default');
$this->icoUrl = $this->siteUrl.'favicon.ico';
$this->findMethod = 'default';
$this->icoType = self::getExtension($this->icoUrl);
$this->debugInfo['failover'] = true;
return $this->downloadFavicon();
}
return false;
}
// All right baby !
$this->icoData = $content;
$this->icoMd5 = md5($content);
$this->icoExists = true;
return true;
}
/**
* Download URL as Firefox with cURL
* Details available in $info if provided
*/
public static function downloadAs($url, &$info = null)
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Don't check SSL certificate to allow autosigned certificate
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // Follow redirects (302, 301)
curl_setopt($ch, CURLOPT_MAXREDIRS, 20); // Follow up to 20 redirects
curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:27.0) Gecko/20100101 Firefox/27.0');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_ENCODING, "identity"); // Don't save in gzip format
if(!empty(self::$httpProxy)){
curl_setopt($ch, CURLOPT_PROXY, self::$httpProxy); // Set HTTP proxy
}
$content = curl_exec($ch);
$info['curl_errno'] = curl_errno($ch);
$info['curl_error'] = curl_error($ch);
$info['http_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$info['effective_url'] = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
$info['redirect_count'] = curl_getinfo($ch, CURLINFO_REDIRECT_COUNT);
$info['content_type'] = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
curl_close($ch);
if($info['curl_errno'] !== 0 || in_array($info['http_code'], array(403, 404, 429, 500, 503))){
return false;
}
return $content;
}
/**
* Download URL as Firefox with cURL
* Details available in $info if provided
* If it's a page, ignore 404's.
*/
public static function downloadPageAs($url, &$info = null)
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Don't check SSL certificate to allow autosigned certificate
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // Follow redirects (302, 301)
curl_setopt($ch, CURLOPT_MAXREDIRS, 20); // Follow up to 20 redirects
curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:27.0) Gecko/20100101 Firefox/27.0');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
if(!empty(self::$httpProxy)){
curl_setopt($ch, CURLOPT_PROXY, self::$httpProxy); // Set HTTP proxy
}
$content = curl_exec($ch);
$info['curl_errno'] = curl_errno($ch);
$info['curl_error'] = curl_error($ch);
$info['http_code'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$info['effective_url'] = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
$info['redirect_count'] = curl_getinfo($ch, CURLINFO_REDIRECT_COUNT);
$info['content_type'] = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
curl_close($ch);
if($info['curl_errno'] !== 0 || in_array($info['http_code'], array(403, 429, 500, 503))){
return false;
}
return $content;
}
/**
* Return file extension from an URL or a file path
*/
public static function getExtension($filename)
{
if(preg_match('#^(https?|ftp)#i', $filename)){
$url = parse_url($filename);
$filename = $url['path'];
}
$info = pathinfo($filename);
return $info['extension'];
}
/**
* Return URL type, either :
* - absolute_full ex: http://www.domain.com/images/fav.ico
* - absolute_scheme ex: //www.domain.com/images/fav.ico
* - absolute_path ex: /images/fav.ico
* - relative ex: ../images/fav.ico
*/
public static function urlType($url)
{
if(empty($url)) return false;
$urlInfo = parse_url($url);
if(!empty($urlInfo['scheme'])) return 'absolue_full';
if(preg_match('#^//#i', $url)) return 'absolute_scheme';
if(preg_match('#^/[^/]#i', $url)) return 'absolute_path';
return 'relative';
}
/**
* Show object printable properties, or return it if $return is true
*/
public function debug($return = false)
{
$dump = clone $this;
unset($dump->icoData);
if($return) return $dump;
print_r($dump);
}
}
?>