mirror of https://github.com/owen0o0/getFavicon
the first
commit
2cceb8d816
|
@ -0,0 +1,614 @@
|
|||
<?php
|
||||
/**
|
||||
* 获取网站Favicon服务接口
|
||||
*
|
||||
* @author Jerry Bendy / 一为
|
||||
* @date 2014-09-10
|
||||
* @link https://www.iowen.cn
|
||||
* @version 2.1.0
|
||||
*/
|
||||
|
||||
namespace Jerrybendy\Favicon;
|
||||
|
||||
|
||||
/**
|
||||
* Favicon 获取类
|
||||
*
|
||||
* ## 关于缓存:
|
||||
* 本来类库中是调用Redis来做缓存,后来想了下,还是让这个类只专注于自己的业
|
||||
* 务吧(获取图标)缓存这些操作交给外部来处理
|
||||
*
|
||||
* @author Jerry Bendy
|
||||
*
|
||||
* @link http://blog.icewingcc.com
|
||||
*
|
||||
*/
|
||||
|
||||
class Favicon
|
||||
{
|
||||
|
||||
/**
|
||||
* 是否使用调试模式,默认不启用
|
||||
* 可以通过修改此变量的值以启用调试,将会在控制台中
|
||||
* 或错误日志中输出一些运行相关的信息
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
public $debug_mode = false;
|
||||
|
||||
|
||||
/**
|
||||
* 保存传入的参数,其中:
|
||||
*
|
||||
* origin_url: 保存传入的url参数的原始字符串信息
|
||||
*
|
||||
*
|
||||
* 以及一些额外的参数及暂存的数据
|
||||
*/
|
||||
private $params = array();
|
||||
|
||||
/**
|
||||
* 完整的形如 http://xxx.xxx.com:8888 这样的地址
|
||||
*/
|
||||
private $full_host = '';
|
||||
|
||||
/**
|
||||
* 包含获取到的最终的二进制数据
|
||||
*
|
||||
*/
|
||||
private $data = NULL;
|
||||
|
||||
/**
|
||||
* 最后一次请求花费的时间
|
||||
*
|
||||
* @var double
|
||||
*/
|
||||
private $_last_time_spend = 0;
|
||||
|
||||
/**
|
||||
* 最后一次请求消耗的内存
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $_last_memory_usage = 0;
|
||||
|
||||
/**
|
||||
* 文件映射,用于在规则匹配时直接返回内容
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $_file_map = [];
|
||||
|
||||
|
||||
/**
|
||||
* 默认图标,如果设置了此文件将会在请求失败时返回这个图标
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $_default_icon = '';
|
||||
|
||||
|
||||
/**
|
||||
* 获取网站Favicon并输出
|
||||
*
|
||||
* @param string $url 输入的网址
|
||||
* (The input URL)
|
||||
* @param bool $return 是要求返回二进制内容还是直接显示它
|
||||
* @throws \InvalidArgumentException
|
||||
* @return string
|
||||
*
|
||||
*/
|
||||
public function getFavicon($url = '', $return = FALSE)
|
||||
{
|
||||
|
||||
/**
|
||||
* 验证传入参数
|
||||
*/
|
||||
if (!$url) {
|
||||
throw new \InvalidArgumentException(__CLASS__ . ': Url cannot be empty', E_ERROR);
|
||||
}
|
||||
|
||||
//
|
||||
$this->params['origin_url'] = $url;
|
||||
|
||||
//解析URL参数
|
||||
$ret = $this->formatUrl($url);
|
||||
if (!$ret) {
|
||||
throw new \InvalidArgumentException(__CLASS__ . ': Invalided url', E_WARNING);
|
||||
}
|
||||
|
||||
/**
|
||||
* 开始获取图标过程
|
||||
*/
|
||||
$time_start = microtime(TRUE);
|
||||
|
||||
$this->_log_message('Begin to get icon, ' . $url);
|
||||
|
||||
|
||||
/**
|
||||
* get the favicon bin data
|
||||
*/
|
||||
$data = $this->getData();
|
||||
|
||||
/**
|
||||
* 获取过程结束
|
||||
* 计算时间及内存的占用信息
|
||||
*/
|
||||
$time_end = microtime(TRUE);
|
||||
$this->_last_time_spend = $time_end - $time_start;
|
||||
|
||||
$this->_last_memory_usage = ((!function_exists('memory_get_usage')) ? '0' : round(memory_get_usage() / 1024 / 1024, 2)) . 'MB';
|
||||
|
||||
$this->_log_message('Get icon complate, spent time ' . $this->_last_time_spend . 's, Memory_usage ' . $this->_last_memory_usage);
|
||||
|
||||
/**
|
||||
* 设置输出Header信息
|
||||
* Output common header
|
||||
*
|
||||
*/
|
||||
|
||||
if ($data === FALSE && $this->_default_icon) {
|
||||
$data = @file_get_contents($this->_default_icon);
|
||||
}
|
||||
|
||||
|
||||
if ($return) {
|
||||
return $data;
|
||||
|
||||
} else {
|
||||
|
||||
if ($data !== FALSE) {
|
||||
|
||||
foreach ($this->getHeader() as $header) {
|
||||
@header($header);
|
||||
}
|
||||
|
||||
echo $data;
|
||||
|
||||
} else {
|
||||
header('Content-type: application/json');
|
||||
echo json_encode(array('status' => -1, 'msg' => 'Unknown Error'));
|
||||
}
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 获取输出 header
|
||||
* 2019 添加缓存时间
|
||||
*
|
||||
* @since v2.1
|
||||
* @return array
|
||||
*/
|
||||
public function getHeader()
|
||||
{
|
||||
return array(
|
||||
'X-Robots-Tag: noindex, nofollow',
|
||||
'Content-type: image/x-icon',
|
||||
'Cache-Control: public, max-age=604800'
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 设置一组正则表达式到文件的映射,
|
||||
* 用于在规则匹配成功时直接从本地或指定的URL处获取内容并返回
|
||||
*
|
||||
* @param array $map 映射内容必须是 正则表达式 => 文件路径 的数组,
|
||||
* 文件通过 file_get_contents 函数读取,所以可以是本地文件或网络文件路径,
|
||||
* 但必须要保证对应的文件是一定能被读取的
|
||||
* @return $this
|
||||
*/
|
||||
public function setFileMap(array $map)
|
||||
{
|
||||
$this->_file_map = $map;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @param string $filePath
|
||||
* @return $this
|
||||
*/
|
||||
public function setDefaultIcon($filePath)
|
||||
{
|
||||
$this->_default_icon = $filePath;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 获取最终的Favicon图标数据
|
||||
* 此为该类获取图标的核心函数
|
||||
*
|
||||
* @return bool|string
|
||||
*/
|
||||
protected function getData()
|
||||
{
|
||||
// 尝试匹配映射
|
||||
$this->data = $this->_match_file_map();
|
||||
|
||||
//判断data中有没有来自插件写入的内容
|
||||
if ($this->data !== NULL) {
|
||||
$this->_log_message('Get icon from static file map, ' . $this->full_host);
|
||||
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
//从网络获取图标
|
||||
|
||||
//从源网址获取HTML内容并解析其中的LINK标签
|
||||
$html = $this->getFile($this->params['origin_url']);
|
||||
|
||||
if ($html && $html['status'] == 'OK') {
|
||||
|
||||
/*
|
||||
* 2016-01-31
|
||||
* FIX #1
|
||||
* 对取到的HTML内容进行删除换行符的处理,避免link信息折行导致的正则匹配失败
|
||||
*/
|
||||
$html = str_replace(array("\n", "\r"), '', $html);
|
||||
|
||||
//匹配完整的LINK标签,再从LINK标签中获取HREF的值
|
||||
if (@preg_match('/((<link[^>]+rel=.(icon|shortcut icon|alternate icon|apple-touch-icon)[^>]+>))/i', $html['data'], $match_tag)) {
|
||||
|
||||
if (isset($match_tag[1]) && $match_tag[1] && @preg_match('/href=(\'|\")(.*?)\1/i', $match_tag[1], $match_url)) {
|
||||
|
||||
if (isset($match_url[2]) && $match_url[2]) {
|
||||
|
||||
//解析HTML中的相对URL 路径
|
||||
$match_url[2] = $this->filterRelativeUrl(trim($match_url[2]), $this->params['origin_url']);
|
||||
|
||||
$icon = $this->getFile($match_url[2],true);
|
||||
|
||||
if ($icon && $icon['status'] == 'OK') {
|
||||
|
||||
$this->_log_message("Success get icon from {$this->params['origin_url']}, icon url is {$match_url[2]}");
|
||||
|
||||
$this->data = $icon['data'];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($this->data != NULL) {
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
//用来在第一次获取后保存可能的重定向后的地址
|
||||
$redirected_url = $html['real_url'];
|
||||
|
||||
//未能从LINK标签中获取图标(可能是网址无法打开,或者指定的文件无法打开,或未定义图标地址)
|
||||
//将使用网站根目录的文件代替
|
||||
$data = $this->getFile($this->full_host . '/favicon.ico',true);
|
||||
|
||||
if ($data && $data['status'] == 'OK') {
|
||||
$this->_log_message("Success get icon from website root: {$this->full_host}/favicon.ico");
|
||||
$this->data = $data['data'];
|
||||
|
||||
} else {
|
||||
//如果直接取根目录文件返回了301或404,先读取重定向,再从重定向的网址获取
|
||||
$ret = $this->formatUrl($redirected_url);
|
||||
|
||||
if ($ret) {
|
||||
//最后的尝试,从重定向后的网址根目录获取favicon文件
|
||||
$data = $this->getFile($this->full_host . '/favicon.ico',true);
|
||||
|
||||
if ($data && $data['status'] == 'OK') {
|
||||
$this->_log_message("Success get icon from redirect file: {$this->full_host}/favicon.ico");
|
||||
$this->data = $data['data'];
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 从其他api最后获取图像 -----------------------------------------------------
|
||||
*
|
||||
*/
|
||||
//if ($this->data == NULL) {
|
||||
// $thrurl='http://www.google.cn/s2/favicons?domain=';
|
||||
// $icon = file_get_contents($thrurl.$this->full_host);
|
||||
// //$this->_log_message("--图标 md5 值为".md5($icon));
|
||||
// if($icon && md5($icon)!="3ca64f83fdcf25135d87e08af65e68c9"){ //判断是否为对方 api 返回的默认图标,可通过上行 log 查看
|
||||
// $this->_log_message("--从 {$thrurl} 获取到图标");
|
||||
// $this->data = $icon;
|
||||
// }
|
||||
//}
|
||||
|
||||
|
||||
if ($this->data == NULL) {
|
||||
//各个方法都试过了,还是获取不到。。。
|
||||
$this->_log_message("Cannot get icon from {$this->params['origin_url']}");
|
||||
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* 解析一个完整的URL中并返回其中的协议、域名和端口部分
|
||||
* 同时会设置类中的parsed_url和full_host属性
|
||||
*
|
||||
* @param $url
|
||||
* @return bool|string
|
||||
*/
|
||||
public function formatUrl($url)
|
||||
{
|
||||
/**
|
||||
* 尝试解析URL参数,如果解析失败的话再加上http前缀重新尝试解析
|
||||
*
|
||||
*/
|
||||
$parsed_url = parse_url($url);
|
||||
|
||||
if (!isset($parsed_url['host']) || !$parsed_url['host']) {
|
||||
//在URL的前面加上http://
|
||||
// add the prefix
|
||||
if (!preg_match('/^https?:\/\/.*/', $url))
|
||||
$url = 'http://' . $url;
|
||||
//解析URL并将结果保存到 $this->url
|
||||
$parsed_url = parse_url($url);
|
||||
|
||||
if ($parsed_url == FALSE) {
|
||||
return FALSE;
|
||||
} else {
|
||||
/**
|
||||
* 能成功解析的话就可以设置原始URL为这个添加过http://前缀的URL
|
||||
*/
|
||||
$this->params['origin_url'] = $url;
|
||||
}
|
||||
}
|
||||
|
||||
$this->full_host = (isset($parsed_url['scheme']) ? $parsed_url['scheme'] : 'http') . '://' . $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
|
||||
|
||||
return $this->full_host;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 把从HTML源码中获取的相对路径转换成绝对路径
|
||||
*
|
||||
* @see 函数详情: http://blog.icewingcc.com/php-conv-addr-re-ab-2.html
|
||||
*
|
||||
* @param string $url HTML中获取的网址
|
||||
* @param string $URI 用来参考判断的原始地址
|
||||
* @return string 返回修改过的网址
|
||||
*/
|
||||
private function filterRelativeUrl($url, $URI = '')
|
||||
{
|
||||
//STEP1: 先去判断URL中是否包含协议,如果包含说明是绝对地址则可以原样返回
|
||||
if (strpos($url, '://') !== FALSE) {
|
||||
return $url;
|
||||
}
|
||||
|
||||
//STEP2: 解析传入的URI
|
||||
$URI_part = parse_url($URI);
|
||||
if ($URI_part == FALSE)
|
||||
return FALSE;
|
||||
|
||||
$URI_root = $URI_part['scheme'] . '://' . $URI_part['host'] . (isset($URI_part['port']) ? ':' . $URI_part['port'] : '');
|
||||
|
||||
//STEP3: 如果URL以左斜线开头,表示位于根目录
|
||||
|
||||
// 如果URL以 // 开头,表示是省略协议的绝对路径,可以添加协议后返回
|
||||
if (substr($url, 0, 2) === '//') {
|
||||
return $URI_part['scheme'] . ':' . $url;
|
||||
}
|
||||
|
||||
if (strpos($url, '/') === 0) {
|
||||
return $URI_root . $url;
|
||||
}
|
||||
|
||||
//STEP4: 不位于根目录,也不是绝对路径,考虑如果不包含'./'的话,需要把相对地址接在原URL的目录名上
|
||||
$URI_dir = (isset($URI_part['path']) && $URI_part['path']) ? '/' . ltrim(dirname($URI_part['path']), '/') : '';
|
||||
if (strpos($url, './') === FALSE) {
|
||||
if ($URI_dir != '') {
|
||||
return $URI_root . $URI_dir . '/' . $url;
|
||||
} else {
|
||||
return $URI_root . '/' . $url;
|
||||
}
|
||||
}
|
||||
|
||||
//STEP5: 如果相对路径中包含'../'或'./'表示的目录,需要对路径进行解析并递归
|
||||
//STEP5.1: 把路径中所有的'./'改为'/','//'改为'/'
|
||||
$url = preg_replace('/[^\.]\.\/|\/\//', '/', $url);
|
||||
if (strpos($url, './') === 0)
|
||||
$url = substr($url, 2);
|
||||
|
||||
//STEP5.2: 使用'/'分割URL字符串以获取目录的每一部分进行判断
|
||||
$URI_full_dir = ltrim($URI_dir . '/' . $url, '/');
|
||||
$URL_arr = explode('/', $URI_full_dir);
|
||||
|
||||
// 这里为了解决有些网站在根目录下的文件也使用 ../img/favicon.ico 这种形式的错误,
|
||||
// 对这种本来不合理的路径予以通过, 并忽略掉前面的两个点 (没错, 我说的是 gruntjs 的官网)
|
||||
if ($URL_arr[0] == '..') {
|
||||
array_shift($URL_arr);
|
||||
}
|
||||
|
||||
//因为数组的第一个元素不可能为'..',所以这里从第二个元素可以循环
|
||||
$dst_arr = $URL_arr; //拷贝一个副本,用于最后组合URL
|
||||
for ($i = 1; $i < count($URL_arr); $i++) {
|
||||
if ($URL_arr[$i] == '..') {
|
||||
$j = 1;
|
||||
while (TRUE) {
|
||||
if (isset($dst_arr[$i - $j]) && $dst_arr[$i - $j] != FALSE) {
|
||||
$dst_arr[$i - $j] = FALSE;
|
||||
$dst_arr[$i] = FALSE;
|
||||
break;
|
||||
} else {
|
||||
$j++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//STEP6: 组合最后的URL并返回
|
||||
$dst_str = $URI_root;
|
||||
foreach ($dst_arr as $val) {
|
||||
if ($val != FALSE)
|
||||
$dst_str .= '/' . $val;
|
||||
}
|
||||
|
||||
return $dst_str;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* 从指定URL获取文件
|
||||
* 2019 添加请求内容判断
|
||||
*
|
||||
* @param string $url
|
||||
* @param bool $isimg 是否为图片
|
||||
* @param int $timeout 超时值,默认为10秒
|
||||
* @return string 成功返回获取到的内容,同时设置 $this->content,失败返回FALSE
|
||||
*/
|
||||
private function getFile($url, $isimg = false, $timeout = 2)
|
||||
{
|
||||
$ch = curl_init($url);
|
||||
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
|
||||
/*
|
||||
* 2019-06-20
|
||||
* 修复ssl的错误
|
||||
*/
|
||||
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
|
||||
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
|
||||
|
||||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
|
||||
curl_setopt($ch, CURLOPT_FAILONERROR, 1);
|
||||
//执行重定向获取
|
||||
$ret = $this->curlExecFollow($ch, 2);
|
||||
|
||||
if($isimg){
|
||||
$mime=curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
|
||||
$mimeArray=explode('/',$mime);
|
||||
}
|
||||
$arr = array(
|
||||
'status' => 'FAIL',
|
||||
'data' => '',
|
||||
'real_url' => ''
|
||||
);
|
||||
if(!$isimg || $mimeArray[0] == 'image'){
|
||||
if ($ret != false) {
|
||||
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
|
||||
|
||||
$arr = array(
|
||||
'status' => ($status >= 200 && $status <= 299) ? TRUE : FALSE,
|
||||
'data' => $ret,
|
||||
'real_url' => curl_getinfo($ch, CURLINFO_EFFECTIVE_URL)
|
||||
);
|
||||
|
||||
}
|
||||
curl_close($ch);
|
||||
|
||||
return $arr;
|
||||
}else{
|
||||
$this->_log_message("不是图片:{$url}");
|
||||
return $arr;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* 使用跟综重定向的方式查找被301/302跳转后的实际地址,并执行curl_exec
|
||||
* 代码来自: http://php.net/manual/zh/function.curl-setopt.php#102121
|
||||
*
|
||||
* @param resource $ch CURL资源句柄
|
||||
* @param int $maxredirect 最大允许的重定向次数
|
||||
* @return string
|
||||
*/
|
||||
private function curlExecFollow( &$ch, $maxredirect = null) {
|
||||
$mr = $maxredirect === null ? 5 : intval($maxredirect);
|
||||
if (ini_get('open_basedir') == '' && ini_get('safe_mode' == 'Off')) {
|
||||
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, $mr > 0);
|
||||
curl_setopt($ch, CURLOPT_MAXREDIRS, $mr);
|
||||
} else {
|
||||
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, false);
|
||||
if ($mr > 0) {
|
||||
$newurl = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
|
||||
|
||||
$rch = curl_copy_handle($ch);
|
||||
curl_setopt($rch, CURLOPT_HEADER, true);
|
||||
curl_setopt($rch, CURLOPT_NOBODY, true);
|
||||
curl_setopt($rch, CURLOPT_NOSIGNAL, 1);
|
||||
curl_setopt($rch, CURLOPT_CONNECTTIMEOUT_MS, 800);
|
||||
curl_setopt($rch, CURLOPT_FORBID_REUSE, false);
|
||||
curl_setopt($rch, CURLOPT_RETURNTRANSFER, true);
|
||||
do {
|
||||
curl_setopt($rch, CURLOPT_URL, $newurl);
|
||||
$header = curl_exec($rch);
|
||||
if (curl_errno($rch)) {
|
||||
$code = 0;
|
||||
} else {
|
||||
$code = curl_getinfo($rch, CURLINFO_HTTP_CODE);
|
||||
if ($code == 301 || $code == 302) {
|
||||
preg_match('/Location:(.*?)\n/', $header, $matches);
|
||||
$newurl = trim(array_pop($matches));
|
||||
/**
|
||||
* 这里由于部分网站返回的 Location 的值可能是相对网址, 所以还需要做一步
|
||||
* 转换成完整地址的操作
|
||||
*
|
||||
* @since v2.2.2
|
||||
*/
|
||||
$newurl = $this->filterRelativeUrl($newurl, $this->params['origin_url']);
|
||||
} else {
|
||||
$code = 0;
|
||||
}
|
||||
}
|
||||
} while ($code && --$mr);
|
||||
curl_close($rch);
|
||||
if (!$mr) {
|
||||
if ($maxredirect === null) {
|
||||
trigger_error('Too many redirects. When following redirects, libcurl hit the maximum amount.', E_USER_WARNING);
|
||||
} else {
|
||||
$maxredirect = 0;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
curl_setopt($ch, CURLOPT_URL, $newurl);
|
||||
}
|
||||
}
|
||||
return curl_exec($ch);
|
||||
}
|
||||
|
||||
/**
|
||||
* 在设定的映射条件中循环并尝试匹配每一条规则,
|
||||
* 在条件匹配时返回对应的文件内容
|
||||
*
|
||||
* @return null|string
|
||||
*/
|
||||
private function _match_file_map()
|
||||
{
|
||||
foreach ($this->_file_map as $rule => $file) {
|
||||
if (preg_match($rule, $this->full_host)) {
|
||||
return @file_get_contents($file);
|
||||
}
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 如果开启了调试模式,将会在控制台或错误日志中输出一些信息
|
||||
*
|
||||
* @param $message
|
||||
*/
|
||||
private function _log_message($message)
|
||||
{
|
||||
if ($this->debug_mode) {
|
||||
error_log(date('d/m/Y H:i:s : ').$message.PHP_EOL,3, "./my-errors.log");
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
@ -0,0 +1,17 @@
|
|||
# getFavicon
|
||||
获取网站的Favicon图标并显示在你的网页上.
|
||||
<br/>
|
||||
|
||||
### 演示
|
||||
<a href="https://api.iowen.cn/favicon/" target="_blank">演示地址</a>
|
||||
<br/>
|
||||
|
||||
### 安装使用
|
||||
+ 上传到网站根目录
|
||||
+ cache 文件夹给 755 权限
|
||||
+ 然后访问 http://you.url/get.php?url=https://www.iowen.cn
|
||||
<br/>
|
||||
|
||||
### 感谢
|
||||
感谢 <a href="https://github.com/jerrybendy/get_favicon" target="_blank">jerrybendy</a> ,此版本只是修复一些 bug 和编写了获取方法。
|
||||
<br/>
|
Binary file not shown.
After Width: | Height: | Size: 5.4 KiB |
|
@ -0,0 +1,118 @@
|
|||
<?php
|
||||
/**
|
||||
* getFavicon
|
||||
* @author 一为
|
||||
* @date 2019-05-18
|
||||
* @link https://www.iowen.cn
|
||||
* @version 1.0.0
|
||||
*/
|
||||
|
||||
if( !isset($_GET['url'])){
|
||||
return http_response_code(404);
|
||||
}
|
||||
|
||||
require "./Favicon.php";
|
||||
|
||||
$favicon = new \Jerrybendy\Favicon\Favicon;
|
||||
|
||||
/**
|
||||
* 默认图标
|
||||
*/
|
||||
$favicon->setDefaultIcon('favicon.png');
|
||||
|
||||
/**
|
||||
* 检测URL参数
|
||||
*/
|
||||
$url = $_GET['url'];
|
||||
|
||||
|
||||
/*
|
||||
* 格式化 URL, 并尝试读取缓存
|
||||
*/
|
||||
$formatUrl = $favicon->formatUrl($url);
|
||||
|
||||
if (Cache::get($formatUrl) !== NULL) {
|
||||
|
||||
foreach ($favicon->getHeader() as $header) {
|
||||
@header($header);
|
||||
}
|
||||
|
||||
echo Cache::get($formatUrl);
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* 缓存中没有指定的内容时, 重新获取内容并缓存起来
|
||||
*/
|
||||
$content = $favicon->getFavicon($formatUrl, TRUE);
|
||||
|
||||
Cache::set($formatUrl, $content, 86400);
|
||||
|
||||
foreach ($favicon->getHeader() as $header) {
|
||||
@header($header);
|
||||
}
|
||||
|
||||
echo $content;
|
||||
exit;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* 缓存类
|
||||
*/
|
||||
class Cache
|
||||
{
|
||||
/**
|
||||
* 获取缓存的值, 不存在时返回 null
|
||||
*
|
||||
* @param $key
|
||||
* @return string
|
||||
*/
|
||||
public static function get($key)
|
||||
{
|
||||
$dir = 'cache'; //图标缓存目录
|
||||
|
||||
//$f = md5( strtolower( $key ) );
|
||||
$f = parse_url($key)['host'];
|
||||
|
||||
$a = $dir . '/' . $f . '.txt';
|
||||
$t = 2592000; // 缓存有效期30天, 这里单位:秒
|
||||
if ( !is_file($a) || (time() - filemtime($a)) > $t ) {
|
||||
return null;
|
||||
}
|
||||
else {
|
||||
return file_get_contents($a);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* 设置缓存
|
||||
*
|
||||
* @param $key
|
||||
* @param $value
|
||||
* @param $expire
|
||||
*/
|
||||
public static function set($key, $value, $expire)
|
||||
{
|
||||
|
||||
$dir = 'cache'; //图标缓存目录
|
||||
|
||||
//$f = md5( strtolower( $key ) );
|
||||
$f = parse_url($key)['host'];
|
||||
|
||||
$a = $dir . '/' . $f . '.txt';
|
||||
|
||||
//如果缓存目录不存在则创建
|
||||
if (!is_dir($dir)) mkdir($dir,0777,true) or die('创建缓存目录失败!');
|
||||
|
||||
$t = 2592000; // 缓存有效期30天, 这里单位:秒
|
||||
if ( !is_file($a) || (time() - filemtime($a)) > $t ) {
|
||||
$imgdata = fopen($a, "w") or die("Unable to open file!"); //w 重写 a追加
|
||||
fwrite($imgdata, $value);
|
||||
fclose($imgdata);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
Loading…
Reference in New Issue