├── requeriments.txt ├── banner.png ├── .github └── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── python_test.py ├── php_test.php ├── README.md ├── ApiLib.py ├── ApiLib.php ├── LICENSE └── parser.php /requeriments.txt: -------------------------------------------------------------------------------- 1 | requests 2 | bs4 3 | unidecode 4 | -------------------------------------------------------------------------------- /banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MrSentex/0day.today-API/HEAD/banner.png -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /python_test.py: -------------------------------------------------------------------------------- 1 | 2 | from ApiLib import api_0day_today 3 | 4 | search_param = "ssh" 5 | 6 | Api = api_0day_today() 7 | 8 | print "Searching '{}' in 0day.today database".format(search_param) 9 | 10 | results = Api.search(search_param) 11 | 12 | if results["status"] != "fail": 13 | 14 | for result in results["response"]: 15 | 16 | print "====== Exploit =======" 17 | print "Date: {}\nDescription: {}\nPlatform: {}\nPrice: {}\nAuthor: {}\nURL: {}".format(result["date"], result["desc"], result["platform"], result["price"], result["author"], result["url"]) 18 | print "======================" 19 | 20 | else: 21 | 22 | print "[ERROR] {}".format(results["exception"]) -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Screenshots** 20 | If applicable, add screenshots to help explain your problem. 21 | 22 | **Desktop (please complete the following information):** 23 | - OS: [e.g. iOS] 24 | - Python version [e.g. 2.7, 3.5] 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /php_test.php: -------------------------------------------------------------------------------- 1 | search($search_param); 10 | 11 | if ($search["status"] === "fail") { 12 | printf("[Error] ".$search["exception"]."\n"); die(); 13 | } 14 | 15 | foreach($search["response"] as $hit) { 16 | printf("====== Exploit ======\n"); 17 | printf("Date: %s\n", $hit["date"]); 18 | printf("Description: %s\n", $hit["desc"]); 19 | printf("Platform: %s\n", $hit["platform"]); 20 | printf("Price: %s\n", $hit["price"]); 21 | printf("Author: %s\n", $hit["author"]); 22 | printf("URL : %s\n", $hit["url"]); 23 | printf("======================\n"); 24 | } 25 | 26 | ?> -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 0day.today unofficial API | 0.2 beta 2 | ![Banner.png](https://raw.githubusercontent.com/MrSentex/0day.today-API/master/banner.png?token=AorkL9f8tQVCKNF6tnFOxW4LHEu_1_E4ks5cPhNmwA%3D%3D) 3 | 4 | Unofficial API for 0day.today database. 5 | 6 | This API is not affiliated in any way with "0day.today" and its operation may be against the terms and conditions of "0day.today", therefore the execution of the API will be carried out under the legal responsibility of the user and MrSentex will be uncharged from any illegal use of the API. 7 | 8 | #### Special thanks: 9 | 10 | * @virtualminds (Telegram) 11 | 12 | ## Dependencies 13 | 14 | All you need to use the API and start to work with it. 15 | 16 | ### Python 17 | 18 | Dependencies needed to use the API with Python 19 | 20 | * Python 2.7 with PyPi (pip) 21 | 22 | 23 | Python packages needed: 24 | 25 | * requests 26 | * bs4 27 | * unidecode 28 | 29 | These dependencies are available in PyPi so they can be installed from the command `pip install ` or they can be installed with the following command: `pip install -r requeriments.txt` (Must be executed from the folder). 30 | 31 | #### Usage 32 | 33 | ```python 34 | from ApiLib import api_0day_today 35 | 36 | search_param = "ssh" 37 | 38 | Api = api_0day_today() 39 | 40 | print "Searching '{}' in 0day.today database".format(search_param) 41 | 42 | results = Api.search(search_param) 43 | 44 | if results["status"] != "fail": 45 | 46 | for result in results["response"]: 47 | 48 | print "====== Exploit =======" 49 | print "Date: {}\nDescription: {}\nPlatform: {}\nPrice: {}\nAuthor: {}\nURL: {}".format(result["date"], result["desc"], result["platform"], result["price"], result["author"], result["url"]) 50 | print "======================" 51 | 52 | else: 53 | 54 | print "[ERROR] {}".format(results["exception"]) 55 | ``` 56 | 57 | ### PHP 58 | 59 | Dependencies needed to use the API with PHP 60 | 61 | * PHP (5/7) 62 | 63 | PHP modules needed: 64 | 65 | * php-curl 66 | * php-xml 67 | * parser.php (Already in repo, downloaded from http://simplehtmldom.sourceforge.net/) 68 | 69 | The first two packages are installed through `apt`, `yum` or any other linux package installer. In the case of windows `php-xml` is already included in the php core and for the install of `php-curl` is necessary to modify the php.init file and possibly download php_curl.dll . 70 | 71 | #### Usage 72 | ```php 73 | search($search_param); 82 | 83 | if ($search["status"] === "fail") { 84 | printf("[Error] ".$search["exception"]."\n"); die(); 85 | } 86 | 87 | foreach($search["response"] as $hit) { 88 | printf("====== Exploit ======\n"); 89 | printf("Date: %s\n", $hit["date"]); 90 | printf("Description: %s\n", $hit["desc"]); 91 | printf("Platform: %s\n", $hit["platform"]); 92 | printf("Price: %s\n", $hit["price"]); 93 | printf("Author: %s\n", $hit["author"]); 94 | printf("URL : %s\n", $hit["url"]); 95 | printf("======================\n"); 96 | } 97 | 98 | ?> 99 | ``` 100 | -------------------------------------------------------------------------------- /ApiLib.py: -------------------------------------------------------------------------------- 1 | 2 | ############################# 3 | # 0day.today unofficial api # 4 | # By MrSentex # 5 | ############################# 6 | 7 | # <= Imports => 8 | from random import SystemRandom 9 | from requests import Session 10 | from codecs import ascii_encode 11 | from unidecode import unidecode 12 | from bs4 import BeautifulSoup as Soup 13 | # <= Imports => 14 | 15 | class api_0day_today: 16 | 17 | def __init__(self): 18 | 19 | self.url = "http://{}.0day.today".format(self.randomSubDomain(5)) 20 | self.session_obj = Session() 21 | 22 | self.terms = self.acceptTerms() 23 | 24 | def acceptTerms(self): 25 | try: 26 | self.session_obj.post(self.url, data={"agree" : "Yes, I agree"}) 27 | return (True, None) 28 | except Exception as err: 29 | return (False, str(err)) 30 | 31 | def randomSubDomain(self, interactions): 32 | 33 | string = "" 34 | 35 | for _ in range(1, interactions): 36 | string += SystemRandom().choice("abcdefghijklmnopqrstuvwxyz1234567890") 37 | 38 | return string 39 | 40 | def fixString(self, string): 41 | 42 | string = ascii_encode(unidecode(string.replace("\n", "").replace("\t", "")))[0] 43 | 44 | if string.find("Comments:") != -1: 45 | string = string[:string.find("Comments: {}".format(string[string.find("Comments:")+10:string.find("Comments:")+len(string)-string.find("Comments:")-1]))] 46 | 47 | if string.find("Rate down:") != -1: 48 | string = string[:string.find("Rate down: {}".format(string[string.find("Rate down:")+11:string.find("Rate down:")+len(string)-string.find("Rate down:")-1]))] 49 | 50 | if string.find("Rate up:") != -1: 51 | string = string[:string.find("Rate up: {}".format(string[string.find("Rate up:")+9:string.find("Rate up:")+len(string)-string.find("Rate up:")-1]))] 52 | 53 | return string 54 | 55 | def fixPrice(self, price): 56 | 57 | price = self.fixString(price) 58 | 59 | if price.startswith("free"): 60 | return "free" 61 | 62 | btc = price[price.find("for")+4:price.find("BTC")-1] 63 | pre_gold = price[price.find("BTC")+4:len(price)] 64 | gold = pre_gold[pre_gold.find("for")+4:pre_gold.find("GOLD")-1] 65 | return "{} BTC or {} GOLD".format(btc, gold) 66 | 67 | def search(self, param): 68 | 69 | if not self.terms[0]: 70 | return {"status" : "fail", "exception" : "An error ocurred in the acceptTerms function | {}".format(self.terms[1])} 71 | 72 | param = param.replace(" ", "+") 73 | 74 | try: 75 | 76 | response = self.session_obj.get("{}/search?search_request={}".format(self.url, param)) 77 | parser = Soup(response.text, "lxml") 78 | 79 | result = [] 80 | 81 | tables = parser.find_all("div", attrs={"class" : "ExploitTableContent"}) 82 | 83 | for table in tables: 84 | rows = table.find_all("div", attrs={"class" : "td"}) 85 | 86 | date = self.fixString(rows[0].getText()) 87 | desc = self.fixString(rows[1].getText()) 88 | platform = self.fixString(rows[2].getText()) 89 | price = self.fixPrice(rows[9].getText()) 90 | author = self.fixString(rows[10].getText())[0:self.fixString(rows[10].getText()).find("Exploits")] 91 | url = rows[1].find("a", href=True)["href"].replace("/description", "") 92 | 93 | result.append({"date" : date, "desc" : desc, "platform" : platform, "price" : price, "author" : author, "url" : "https://0day.today/"+url}) 94 | 95 | return {"status" : "success", "response" : result} 96 | 97 | except Exception as err: 98 | return {"status" : "fail", "exception" : str(err)} 99 | 100 | def getIndex(self): 101 | 102 | if not self.terms[0]: 103 | return {"status" : "fail", "exception" : "An error ocurred in the acceptTerms function | {}".format(self.terms[1])} 104 | 105 | try: 106 | 107 | response = self.session_obj.get("{}".format(self.url)) 108 | parser = Soup(response.text, "lxml") 109 | 110 | result = [] 111 | 112 | tables = parser.find_all("div", attrs={"class" : "ExploitTableContent"}) 113 | 114 | for table in tables: 115 | rows = table.find_all("div", attrs={"class" : "td"}) 116 | 117 | date = self.fixString(rows[0].getText()) 118 | desc = self.fixString(rows[1].getText()) 119 | platform = self.fixString(rows[2].getText()) 120 | price = self.fixPrice(rows[9].getText()) 121 | author = self.fixString(rows[10].getText())[0:self.fixString(rows[10].getText()).find("Exploits")] 122 | url = rows[1].find("a", href=True)["href"].replace("/description", "") 123 | 124 | result.append({"date" : date, "desc" : desc, "platform" : platform, "price" : price, "author" : author, "url" : self.url+url}) 125 | 126 | return {"status" : "success", "response" : result} 127 | 128 | except Exception as err: 129 | return {"status" : "fail", "exception" : str(err)} -------------------------------------------------------------------------------- /ApiLib.php: -------------------------------------------------------------------------------- 1 | url = sprintf("http://%s.0day.today/", 8, $this->randomSubDomain(5)); 10 | 11 | $this->curl_obj = curl_init(); 12 | curl_setopt($this->curl_obj, CURLOPT_COOKIEJAR, dirname(__FILE__) . '/cookie.txt'); 13 | curl_setopt($this->curl_obj, CURLOPT_RETURNTRANSFER,1); 14 | 15 | $this->terms = $this->acceptTerms(); 16 | 17 | $this->platforms = array("aix", "Android", "bsd", "freebsd", "hp-ux", "iOS", "irix", "linux", "macOS", "minix", "netware", "novell", "openbsd", "plan9", "QNX", "sco", "solaris", "Symbian", "tru64", "ultrix", "unix", "windows", "hardware", "multiple", "unsorted", "aix", "alpha", "arm", "bsd", "bsd/ppc", "bsd/x86", "bsdi/x86", "freebsd/x86", "freebsd/x86-64", "generator", "hardware", "hpux", "irix", "linux/amd64", "linux/mips", "linux/ppc", "linux/sparc", "linux/x86", "linux/x86-64", "multiple", "netbsd/x86", "openbsd/x86", "os-x/ppc", "os-x/x86", "sco/x86", "solaris/sparc", "solaris/x86", "unixware", "win32", "win64", "asp", "cgi", "java", "jsp", "perl", "php", "python", "ruby", "tricks", "xml"); 18 | 19 | } 20 | 21 | function acceptTerms() { 22 | try { 23 | 24 | curl_setopt($this->curl_obj, CURLOPT_URL, $this->url); 25 | curl_setopt($this->curl_obj, CURLOPT_POST, true); 26 | curl_setopt($this->curl_obj, CURLOPT_POSTFIELDS, "agree=Yes, I agree"); 27 | $ot = curl_exec($this->curl_obj); 28 | 29 | curl_setopt($this->curl_obj, CURLOPT_POST, false); 30 | 31 | $s_code = curl_getinfo($this->curl_obj, CURLINFO_HTTP_CODE); 32 | 33 | if ($s_code != 200) { 34 | return array(false, "Status code: ".$s_code); 35 | } 36 | 37 | return array(true, null); 38 | 39 | } catch (Exception $err) { 40 | return array(false, $err->getMessage()); 41 | } 42 | 43 | } 44 | 45 | function randomSubDomain($interactions) { 46 | 47 | $string = ""; 48 | 49 | foreach(range(1, $interactions) as $n) { 50 | $string .= "abcdefghijklmnopqrsuvwxzy1234567890"[rand(0, 35)]; 51 | } 52 | 53 | return $string; 54 | 55 | } 56 | 57 | function findUrl($array) { 58 | foreach($array as $hit) { 59 | 60 | if (strpos($hit->href, "exploit")) { 61 | $url = explode("/", $hit->href); 62 | return $url[count($url)-1]; 63 | } 64 | 65 | } 66 | } 67 | 68 | function fixArray($array_str, $url) { 69 | 70 | $array = explode(" ", $array_str); 71 | $array_fix = array(); 72 | 73 | for($i = 0; $i < count($array); $i++) { 74 | if (trim($array[$i]) !== "") { 75 | $array_fix[$i] = trim($array[$i]); 76 | } 77 | } 78 | 79 | $array = $array_fix; 80 | 81 | $date = $array[0]; 82 | $desc = ""; 83 | 84 | for($i = 1; $i < count($array); $i++) { 85 | if ($array[$i] === "Comments:") { 86 | $last = $i; 87 | break; 88 | } 89 | 90 | $desc .= $array[$i]." "; 91 | 92 | } 93 | 94 | for($i = $last; $i < count($array); $i++) { 95 | if (in_array($array[$i], $this->platforms)) { 96 | $platform = $array[$i]; 97 | $last = $i; 98 | break; 99 | } 100 | } 101 | 102 | if (!in_array("BTC", $array)) { 103 | $price = "free"; 104 | } else { 105 | 106 | for($i = $last; $i < count($array); $i++) { 107 | 108 | if ($array[$i] === "BTC") { 109 | $btc = $array[$i-1]; 110 | } 111 | 112 | if ($array[$i] === "GOLD") { 113 | $gold = $array[$i-1]; 114 | } 115 | 116 | if(isset($btc) && isset($gold)) { 117 | $last = $i; 118 | $price = $btc." BTC or ".$gold." GOLD"; 119 | break; 120 | } 121 | 122 | } 123 | 124 | } 125 | 126 | $name = ""; 127 | 128 | for($i = $last; $i < count($array); $i++) { 129 | 130 | if($array[$i] === "Exploits:") { 131 | $l = $i; 132 | for($i = $l-3; $i < $l; $i++) { 133 | 134 | if ($array[$i] !== "free" && $array[$i] !== "GOLD") { 135 | $name .= $array[$i]." "; 136 | } 137 | 138 | } 139 | } 140 | 141 | } 142 | 143 | $name = utf8_decode(substr($name, 0, count($name)-2)); 144 | $desc = substr($desc, 0, count($desc)-2); 145 | 146 | return array( 147 | "date" => $date, 148 | "desc" => $desc, 149 | "platform" => $platform, 150 | "price" => $price, 151 | "author" => $name, 152 | "url" => "https://0day.today/exploit/".$url 153 | ); 154 | 155 | } 156 | 157 | function search($param) { 158 | 159 | if (!$this->terms[0]) { 160 | return array( 161 | "status" => "fail", 162 | "exception" => "An error ocurred in the acceptTerms function | ".$this->terms[1] 163 | ); 164 | } 165 | 166 | $param = str_replace(" ", "+", $param); 167 | 168 | try { 169 | 170 | curl_setopt($this->curl_obj, CURLOPT_URL, $this->url."search?search_request=".$param); 171 | $response = curl_exec($this->curl_obj); 172 | 173 | $exploits = array(); 174 | 175 | if (!$response) { 176 | return array( 177 | "status" => "fail", 178 | "exception" => "Bad response form 0day.today" 179 | ); 180 | } 181 | 182 | $parser = str_get_html($response); 183 | 184 | foreach($parser->find("div") as $divs) { 185 | if ($divs->class === "ExploitTableContent") { 186 | $url = $this->findUrl($divs->find("a")); 187 | $tmp_parser = str_get_html($divs->plaintext); 188 | $data = $tmp_parser->plaintext; 189 | array_push($exploits, $this->fixArray($data, $url)); 190 | } 191 | } 192 | 193 | 194 | return array( 195 | "status" => "success", 196 | "response" => $exploits 197 | ); 198 | 199 | } catch (Exception $err) { 200 | return array( 201 | "status" => "fail", 202 | "exception" => "Scrape error | ".$err->getMessage() 203 | ); 204 | } 205 | 206 | } 207 | } 208 | ?> -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /parser.php: -------------------------------------------------------------------------------- 1 | size is the "real" number of bytes the dom was created from. 18 | * but for most purposes, it's a really good estimation. 19 | * Paperg - Added the forceTagsClosed to the dom constructor. Forcing tags closed is great for malformed html, but it CAN lead to parsing errors. 20 | * Allow the user to tell us how much they trust the html. 21 | * Paperg add the text and plaintext to the selectors for the find syntax. plaintext implies text in the innertext of a node. text implies that the tag is a text node. 22 | * This allows for us to find tags based on the text they contain. 23 | * Create find_ancestor_tag to see if a tag is - at any level - inside of another specific tag. 24 | * Paperg: added parse_charset so that we know about the character set of the source document. 25 | * NOTE: If the user's system has a routine called get_last_retrieve_url_contents_content_type availalbe, we will assume it's returning the content-type header from the 26 | * last transfer or curl_exec, and we will parse that and use it in preference to any other method of charset detection. 27 | * 28 | * Found infinite loop in the case of broken html in restore_noise. Rewrote to protect from that. 29 | * PaperG (John Schlick) Added get_display_size for "IMG" tags. 30 | * 31 | * Licensed under The MIT License 32 | * Redistributions of files must retain the above copyright notice. 33 | * 34 | * @author S.C. Chen 35 | * @author John Schlick 36 | * @author Rus Carroll 37 | * @version Rev. 1.7 (214) 38 | * @package PlaceLocalInclude 39 | * @subpackage simple_html_dom 40 | */ 41 | 42 | /** 43 | * All of the Defines for the classes below. 44 | * @author S.C. Chen 45 | */ 46 | define('HDOM_TYPE_ELEMENT', 1); 47 | define('HDOM_TYPE_COMMENT', 2); 48 | define('HDOM_TYPE_TEXT', 3); 49 | define('HDOM_TYPE_ENDTAG', 4); 50 | define('HDOM_TYPE_ROOT', 5); 51 | define('HDOM_TYPE_UNKNOWN', 6); 52 | define('HDOM_QUOTE_DOUBLE', 0); 53 | define('HDOM_QUOTE_SINGLE', 1); 54 | define('HDOM_QUOTE_NO', 3); 55 | define('HDOM_INFO_BEGIN', 0); 56 | define('HDOM_INFO_END', 1); 57 | define('HDOM_INFO_QUOTE', 2); 58 | define('HDOM_INFO_SPACE', 3); 59 | define('HDOM_INFO_TEXT', 4); 60 | define('HDOM_INFO_INNER', 5); 61 | define('HDOM_INFO_OUTER', 6); 62 | define('HDOM_INFO_ENDSPACE',7); 63 | define('DEFAULT_TARGET_CHARSET', 'UTF-8'); 64 | define('DEFAULT_BR_TEXT', "\r\n"); 65 | define('DEFAULT_SPAN_TEXT', " "); 66 | define('MAX_FILE_SIZE', 600000); 67 | 68 | /** Contents between curly braces "{" and "}" are interpreted as text */ 69 | define('HDOM_SMARTY_AS_TEXT', 1); 70 | 71 | // helper functions 72 | // ----------------------------------------------------------------------------- 73 | // get html dom from file 74 | // $maxlen is defined in the code as PHP_STREAM_COPY_ALL which is defined as -1. 75 | function file_get_html($url, $use_include_path = false, $context=null, $offset = 0, $maxLen=-1, $lowercase = true, $forceTagsClosed=true, $target_charset = DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT) 76 | { 77 | // Ensure maximum length is greater than zero 78 | if($maxLen <= 0) { $maxLen = MAX_FILE_SIZE; } 79 | 80 | // We DO force the tags to be terminated. 81 | $dom = new simple_html_dom(null, $lowercase, $forceTagsClosed, $target_charset, $stripRN, $defaultBRText, $defaultSpanText); 82 | // For sourceforge users: uncomment the next line and comment the retrieve_url_contents line 2 lines down if it is not already done. 83 | $contents = file_get_contents($url, $use_include_path, $context, $offset, $maxLen); 84 | // Paperg - use our own mechanism for getting the contents as we want to control the timeout. 85 | //$contents = retrieve_url_contents($url); 86 | if (empty($contents) || strlen($contents) > $maxLen) 87 | { 88 | return false; 89 | } 90 | // The second parameter can force the selectors to all be lowercase. 91 | $dom->load($contents, $lowercase, $stripRN); 92 | return $dom; 93 | } 94 | 95 | // get html dom from string 96 | function str_get_html($str, $lowercase=true, $forceTagsClosed=true, $target_charset = DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT) 97 | { 98 | $dom = new simple_html_dom(null, $lowercase, $forceTagsClosed, $target_charset, $stripRN, $defaultBRText, $defaultSpanText); 99 | if (empty($str) || strlen($str) > MAX_FILE_SIZE) 100 | { 101 | $dom->clear(); 102 | return false; 103 | } 104 | $dom->load($str, $lowercase, $stripRN); 105 | return $dom; 106 | } 107 | 108 | // dump html dom tree 109 | function dump_html_tree($node, $show_attr=true, $deep=0) 110 | { 111 | $node->dump($node); 112 | } 113 | 114 | 115 | /** 116 | * simple html dom node 117 | * PaperG - added ability for "find" routine to lowercase the value of the selector. 118 | * PaperG - added $tag_start to track the start position of the tag in the total byte index 119 | * 120 | * @package PlaceLocalInclude 121 | */ 122 | class simple_html_dom_node 123 | { 124 | /** 125 | * Node type 126 | * 127 | * Default is {@see HDOM_TYPE_TEXT} 128 | * 129 | * @var int 130 | */ 131 | public $nodetype = HDOM_TYPE_TEXT; 132 | 133 | /** 134 | * Tag name 135 | * 136 | * Default is 'text' 137 | * 138 | * @var string 139 | */ 140 | public $tag = 'text'; 141 | 142 | /** 143 | * List of attributes 144 | * 145 | * @var array 146 | */ 147 | public $attr = array(); 148 | 149 | /** 150 | * List of child node objects 151 | * 152 | * @var array 153 | */ 154 | public $children = array(); 155 | public $nodes = array(); 156 | 157 | /** 158 | * The parent node object 159 | * 160 | * @var object|null 161 | */ 162 | public $parent = null; 163 | 164 | // The "info" array - see HDOM_INFO_... for what each element contains. 165 | public $_ = array(); 166 | 167 | /** 168 | * Start position of the tag in the document 169 | * 170 | * @var int 171 | */ 172 | public $tag_start = 0; 173 | 174 | /** 175 | * The DOM object 176 | * 177 | * @var object|null 178 | */ 179 | private $dom = null; 180 | 181 | /** 182 | * Construct new node object 183 | * 184 | * Adds itself to the list of DOM Nodes {@see simple_html_dom::$nodes} 185 | */ 186 | function __construct($dom) 187 | { 188 | $this->dom = $dom; 189 | $dom->nodes[] = $this; 190 | } 191 | 192 | function __destruct() 193 | { 194 | $this->clear(); 195 | } 196 | 197 | function __toString() 198 | { 199 | return $this->outertext(); 200 | } 201 | 202 | // clean up memory due to php5 circular references memory leak... 203 | function clear() 204 | { 205 | $this->dom = null; 206 | $this->nodes = null; 207 | $this->parent = null; 208 | $this->children = null; 209 | } 210 | 211 | // dump node's tree 212 | function dump($show_attr=true, $deep=0) 213 | { 214 | $lead = str_repeat(' ', $deep); 215 | 216 | echo $lead.$this->tag; 217 | if ($show_attr && count($this->attr)>0) 218 | { 219 | echo '('; 220 | foreach ($this->attr as $k=>$v) 221 | echo "[$k]=>\"".$this->$k.'", '; 222 | echo ')'; 223 | } 224 | echo "\n"; 225 | 226 | if ($this->nodes) 227 | { 228 | foreach ($this->nodes as $c) 229 | { 230 | $c->dump($show_attr, $deep+1); 231 | } 232 | } 233 | } 234 | 235 | 236 | // Debugging function to dump a single dom node with a bunch of information about it. 237 | function dump_node($echo=true) 238 | { 239 | 240 | $string = $this->tag; 241 | if (count($this->attr)>0) 242 | { 243 | $string .= '('; 244 | foreach ($this->attr as $k=>$v) 245 | { 246 | $string .= "[$k]=>\"".$this->$k.'", '; 247 | } 248 | $string .= ')'; 249 | } 250 | if (count($this->_)>0) 251 | { 252 | $string .= ' $_ ('; 253 | foreach ($this->_ as $k=>$v) 254 | { 255 | if (is_array($v)) 256 | { 257 | $string .= "[$k]=>("; 258 | foreach ($v as $k2=>$v2) 259 | { 260 | $string .= "[$k2]=>\"".$v2.'", '; 261 | } 262 | $string .= ")"; 263 | } else { 264 | $string .= "[$k]=>\"".$v.'", '; 265 | } 266 | } 267 | $string .= ")"; 268 | } 269 | 270 | if (isset($this->text)) 271 | { 272 | $string .= " text: (" . $this->text . ")"; 273 | } 274 | 275 | $string .= " HDOM_INNER_INFO: '"; 276 | if (isset($node->_[HDOM_INFO_INNER])) 277 | { 278 | $string .= $node->_[HDOM_INFO_INNER] . "'"; 279 | } 280 | else 281 | { 282 | $string .= ' NULL '; 283 | } 284 | 285 | $string .= " children: " . count($this->children); 286 | $string .= " nodes: " . count($this->nodes); 287 | $string .= " tag_start: " . $this->tag_start; 288 | $string .= "\n"; 289 | 290 | if ($echo) 291 | { 292 | echo $string; 293 | return; 294 | } 295 | else 296 | { 297 | return $string; 298 | } 299 | } 300 | 301 | /** 302 | * Return or set parent node 303 | * 304 | * @param object|null $parent (optional) The parent node, `null` to return 305 | * the current parent node. 306 | * @return object|null The parent node 307 | */ 308 | function parent($parent=null) 309 | { 310 | // I am SURE that this doesn't work properly. 311 | // It fails to unset the current node from it's current parents nodes or children list first. 312 | if ($parent !== null) 313 | { 314 | $this->parent = $parent; 315 | $this->parent->nodes[] = $this; 316 | $this->parent->children[] = $this; 317 | } 318 | 319 | return $this->parent; 320 | } 321 | 322 | /** 323 | * @return bool True if the node has at least one child node 324 | */ 325 | function has_child() 326 | { 327 | return !empty($this->children); 328 | } 329 | 330 | /** 331 | * Get child node at specified index 332 | * 333 | * @param int $idx The index of the child node to return, `-1` to return all 334 | * child nodes. 335 | * @return object|array|null The child node at the specified index, all child 336 | * nodes or null if the index is invalid. 337 | */ 338 | function children($idx=-1) 339 | { 340 | if ($idx===-1) 341 | { 342 | return $this->children; 343 | } 344 | if (isset($this->children[$idx])) 345 | { 346 | return $this->children[$idx]; 347 | } 348 | return null; 349 | } 350 | 351 | /** 352 | * Get first child node 353 | * 354 | * @return object|null The first child node or null if the current node has 355 | * no child nodes. 356 | * 357 | * @todo Use `empty()` instead of `count()` to improve performance on large 358 | * arrays. 359 | */ 360 | function first_child() 361 | { 362 | if (count($this->children)>0) 363 | { 364 | return $this->children[0]; 365 | } 366 | return null; 367 | } 368 | 369 | /** 370 | * Get last child node 371 | * 372 | * @return object|null The last child node or null if the current node has 373 | * no child nodes. 374 | * 375 | * @todo Use `end()` to slightly improve performance on large arrays. 376 | */ 377 | function last_child() 378 | { 379 | if (($count=count($this->children))>0) 380 | { 381 | return $this->children[$count-1]; 382 | } 383 | return null; 384 | } 385 | 386 | /** 387 | * Get next sibling node 388 | * 389 | * @return object|null The sibling node or null if the current node has no 390 | * sibling nodes. 391 | */ 392 | function next_sibling() 393 | { 394 | if ($this->parent===null) 395 | { 396 | return null; 397 | } 398 | 399 | $idx = 0; 400 | $count = count($this->parent->children); 401 | while ($idx<$count && $this!==$this->parent->children[$idx]) 402 | { 403 | ++$idx; 404 | } 405 | if (++$idx>=$count) 406 | { 407 | return null; 408 | } 409 | return $this->parent->children[$idx]; 410 | } 411 | 412 | /** 413 | * Get previous sibling node 414 | * 415 | * @return object|null The sibling node or null if the current node has no 416 | * sibling nodes. 417 | */ 418 | function prev_sibling() 419 | { 420 | if ($this->parent===null) return null; 421 | $idx = 0; 422 | $count = count($this->parent->children); 423 | while ($idx<$count && $this!==$this->parent->children[$idx]) 424 | ++$idx; 425 | if (--$idx<0) return null; 426 | return $this->parent->children[$idx]; 427 | } 428 | 429 | /** 430 | * Traverse ancestors to the first matching tag. 431 | * 432 | * @param string $tag Tag to find 433 | * @return object|null First matching node in the DOM tree or null if no 434 | * match was found. 435 | * 436 | * @todo Null is returned implicitly by calling ->parent on the root node. 437 | * This behaviour could change at any time, rendering this function invalid. 438 | */ 439 | function find_ancestor_tag($tag) 440 | { 441 | global $debug_object; 442 | if (is_object($debug_object)) { $debug_object->debug_log_entry(1); } 443 | 444 | // Start by including ourselves in the comparison. 445 | $returnDom = $this; 446 | 447 | while (!is_null($returnDom)) 448 | { 449 | if (is_object($debug_object)) { $debug_object->debug_log(2, "Current tag is: " . $returnDom->tag); } 450 | 451 | if ($returnDom->tag == $tag) 452 | { 453 | break; 454 | } 455 | $returnDom = $returnDom->parent; 456 | } 457 | return $returnDom; 458 | } 459 | 460 | /** 461 | * Get node's inner text (everything inside the opening and closing tags) 462 | * 463 | * @return string 464 | */ 465 | function innertext() 466 | { 467 | if (isset($this->_[HDOM_INFO_INNER])) return $this->_[HDOM_INFO_INNER]; 468 | if (isset($this->_[HDOM_INFO_TEXT])) return $this->dom->restore_noise($this->_[HDOM_INFO_TEXT]); 469 | 470 | $ret = ''; 471 | foreach ($this->nodes as $n) 472 | $ret .= $n->outertext(); 473 | return $ret; 474 | } 475 | 476 | /** 477 | * Get node's outer text (everything including the opening and closing tags) 478 | * 479 | * @return string 480 | */ 481 | function outertext() 482 | { 483 | global $debug_object; 484 | if (is_object($debug_object)) 485 | { 486 | $text = ''; 487 | if ($this->tag == 'text') 488 | { 489 | if (!empty($this->text)) 490 | { 491 | $text = " with text: " . $this->text; 492 | } 493 | } 494 | $debug_object->debug_log(1, 'Innertext of tag: ' . $this->tag . $text); 495 | } 496 | 497 | if ($this->tag==='root') return $this->innertext(); 498 | 499 | // trigger callback 500 | if ($this->dom && $this->dom->callback!==null) 501 | { 502 | call_user_func_array($this->dom->callback, array($this)); 503 | } 504 | 505 | if (isset($this->_[HDOM_INFO_OUTER])) return $this->_[HDOM_INFO_OUTER]; 506 | if (isset($this->_[HDOM_INFO_TEXT])) return $this->dom->restore_noise($this->_[HDOM_INFO_TEXT]); 507 | 508 | // render begin tag 509 | if ($this->dom && $this->dom->nodes[$this->_[HDOM_INFO_BEGIN]]) 510 | { 511 | $ret = $this->dom->nodes[$this->_[HDOM_INFO_BEGIN]]->makeup(); 512 | } else { 513 | $ret = ""; 514 | } 515 | 516 | // render inner text 517 | if (isset($this->_[HDOM_INFO_INNER])) 518 | { 519 | // If it's a br tag... don't return the HDOM_INNER_INFO that we may or may not have added. 520 | if ($this->tag != "br") 521 | { 522 | $ret .= $this->_[HDOM_INFO_INNER]; 523 | } 524 | } else { 525 | if ($this->nodes) 526 | { 527 | foreach ($this->nodes as $n) 528 | { 529 | $ret .= $this->convert_text($n->outertext()); 530 | } 531 | } 532 | } 533 | 534 | // render end tag 535 | if (isset($this->_[HDOM_INFO_END]) && $this->_[HDOM_INFO_END]!=0) 536 | $ret .= 'tag.'>'; 537 | return $ret; 538 | } 539 | 540 | /** 541 | * Get node's plain text (everything excluding all tags) 542 | * 543 | * @return string 544 | */ 545 | function text() 546 | { 547 | if (isset($this->_[HDOM_INFO_INNER])) return $this->_[HDOM_INFO_INNER]; 548 | switch ($this->nodetype) 549 | { 550 | case HDOM_TYPE_TEXT: return $this->dom->restore_noise($this->_[HDOM_INFO_TEXT]); 551 | case HDOM_TYPE_COMMENT: return ''; 552 | case HDOM_TYPE_UNKNOWN: return ''; 553 | } 554 | if (strcasecmp($this->tag, 'script')===0) return ''; 555 | if (strcasecmp($this->tag, 'style')===0) return ''; 556 | 557 | $ret = ''; 558 | // In rare cases, (always node type 1 or HDOM_TYPE_ELEMENT - observed for some span tags, and some p tags) $this->nodes is set to NULL. 559 | // NOTE: This indicates that there is a problem where it's set to NULL without a clear happening. 560 | // WHY is this happening? 561 | if (!is_null($this->nodes)) 562 | { 563 | foreach ($this->nodes as $n) 564 | { 565 | // Start paragraph after a blank line 566 | if ($n->tag == 'p') 567 | { 568 | $ret .= "\n\n"; 569 | } 570 | 571 | $ret .= $this->convert_text($n->text()); 572 | 573 | // If this node is a span... add a space at the end of it so multiple spans don't run into each other. This is plaintext after all. 574 | if ($n->tag == "span") 575 | { 576 | $ret .= $this->dom->default_span_text; 577 | } 578 | } 579 | } 580 | return trim($ret); 581 | } 582 | 583 | /** 584 | * Get node's xml text (inner text as a CDATA section) 585 | * 586 | * @return string 587 | */ 588 | function xmltext() 589 | { 590 | $ret = $this->innertext(); 591 | $ret = str_ireplace('', '', $ret); 593 | return $ret; 594 | } 595 | 596 | // build node's text with tag 597 | function makeup() 598 | { 599 | // text, comment, unknown 600 | if (isset($this->_[HDOM_INFO_TEXT])) return $this->dom->restore_noise($this->_[HDOM_INFO_TEXT]); 601 | 602 | $ret = '<'.$this->tag; 603 | $i = -1; 604 | 605 | foreach ($this->attr as $key=>$val) 606 | { 607 | ++$i; 608 | 609 | // skip removed attribute 610 | if ($val===null || $val===false) 611 | continue; 612 | 613 | $ret .= $this->_[HDOM_INFO_SPACE][$i][0]; 614 | //no value attr: nowrap, checked selected... 615 | if ($val===true) 616 | $ret .= $key; 617 | else { 618 | switch ($this->_[HDOM_INFO_QUOTE][$i]) 619 | { 620 | case HDOM_QUOTE_DOUBLE: $quote = '"'; break; 621 | case HDOM_QUOTE_SINGLE: $quote = '\''; break; 622 | default: $quote = ''; 623 | } 624 | $ret .= $key.$this->_[HDOM_INFO_SPACE][$i][1].'='.$this->_[HDOM_INFO_SPACE][$i][2].$quote.$val.$quote; 625 | } 626 | } 627 | $ret = $this->dom->restore_noise($ret); 628 | return $ret . $this->_[HDOM_INFO_ENDSPACE] . '>'; 629 | } 630 | 631 | // find elements by css selector 632 | //PaperG - added ability for find to lowercase the value of the selector. 633 | function find($selector, $idx=null, $lowercase=false) 634 | { 635 | $selectors = $this->parse_selector($selector); 636 | if (($count=count($selectors))===0) return array(); 637 | $found_keys = array(); 638 | 639 | // find each selector 640 | for ($c=0; $c<$count; ++$c) 641 | { 642 | // The change on the below line was documented on the sourceforge code tracker id 2788009 643 | // used to be: if (($levle=count($selectors[0]))===0) return array(); 644 | if (($levle=count($selectors[$c]))===0) return array(); 645 | if (!isset($this->_[HDOM_INFO_BEGIN])) return array(); 646 | 647 | $head = array($this->_[HDOM_INFO_BEGIN]=>1); 648 | 649 | // handle descendant selectors, no recursive! 650 | for ($l=0; $l<$levle; ++$l) 651 | { 652 | $ret = array(); 653 | foreach ($head as $k=>$v) 654 | { 655 | $n = ($k===-1) ? $this->dom->root : $this->dom->nodes[$k]; 656 | //PaperG - Pass this optional parameter on to the seek function. 657 | $n->seek($selectors[$c][$l], $ret, $lowercase); 658 | } 659 | $head = $ret; 660 | } 661 | 662 | foreach ($head as $k=>$v) 663 | { 664 | if (!isset($found_keys[$k])) 665 | { 666 | $found_keys[$k] = 1; 667 | } 668 | } 669 | } 670 | 671 | // sort keys 672 | ksort($found_keys); 673 | 674 | $found = array(); 675 | foreach ($found_keys as $k=>$v) 676 | $found[] = $this->dom->nodes[$k]; 677 | 678 | // return nth-element or array 679 | if (is_null($idx)) return $found; 680 | else if ($idx<0) $idx = count($found) + $idx; 681 | return (isset($found[$idx])) ? $found[$idx] : null; 682 | } 683 | 684 | // seek for given conditions 685 | // PaperG - added parameter to allow for case insensitive testing of the value of a selector. 686 | protected function seek($selector, &$ret, $lowercase=false) 687 | { 688 | global $debug_object; 689 | if (is_object($debug_object)) { $debug_object->debug_log_entry(1); } 690 | 691 | list($tag, $key, $val, $exp, $no_key) = $selector; 692 | 693 | // xpath index 694 | if ($tag && $key && is_numeric($key)) 695 | { 696 | $count = 0; 697 | foreach ($this->children as $c) 698 | { 699 | if ($tag==='*' || $tag===$c->tag) { 700 | if (++$count==$key) { 701 | $ret[$c->_[HDOM_INFO_BEGIN]] = 1; 702 | return; 703 | } 704 | } 705 | } 706 | return; 707 | } 708 | 709 | $end = (!empty($this->_[HDOM_INFO_END])) ? $this->_[HDOM_INFO_END] : 0; 710 | if ($end==0) { 711 | $parent = $this->parent; 712 | while (!isset($parent->_[HDOM_INFO_END]) && $parent!==null) { 713 | $end -= 1; 714 | $parent = $parent->parent; 715 | } 716 | $end += $parent->_[HDOM_INFO_END]; 717 | } 718 | 719 | for ($i=$this->_[HDOM_INFO_BEGIN]+1; $i<$end; ++$i) { 720 | $node = $this->dom->nodes[$i]; 721 | 722 | $pass = true; 723 | 724 | if ($tag==='*' && !$key) { 725 | if (in_array($node, $this->children, true)) 726 | $ret[$i] = 1; 727 | continue; 728 | } 729 | 730 | // compare tag 731 | if ($tag && $tag!=$node->tag && $tag!=='*') {$pass=false;} 732 | // compare key 733 | if ($pass && $key) { 734 | if ($no_key) { 735 | if (isset($node->attr[$key])) $pass=false; 736 | } else { 737 | if (($key != "plaintext") && !isset($node->attr[$key])) $pass=false; 738 | } 739 | } 740 | // compare value 741 | if ($pass && $key && $val && $val!=='*') { 742 | // If they have told us that this is a "plaintext" search then we want the plaintext of the node - right? 743 | if ($key == "plaintext") { 744 | // $node->plaintext actually returns $node->text(); 745 | $nodeKeyValue = $node->text(); 746 | } else { 747 | // this is a normal search, we want the value of that attribute of the tag. 748 | $nodeKeyValue = $node->attr[$key]; 749 | } 750 | if (is_object($debug_object)) {$debug_object->debug_log(2, "testing node: " . $node->tag . " for attribute: " . $key . $exp . $val . " where nodes value is: " . $nodeKeyValue);} 751 | 752 | //PaperG - If lowercase is set, do a case insensitive test of the value of the selector. 753 | if ($lowercase) { 754 | $check = $this->match($exp, strtolower($val), strtolower($nodeKeyValue)); 755 | } else { 756 | $check = $this->match($exp, $val, $nodeKeyValue); 757 | } 758 | if (is_object($debug_object)) {$debug_object->debug_log(2, "after match: " . ($check ? "true" : "false"));} 759 | 760 | // handle multiple class 761 | if (!$check && strcasecmp($key, 'class')===0) { 762 | foreach (explode(' ',$node->attr[$key]) as $k) { 763 | // Without this, there were cases where leading, trailing, or double spaces lead to our comparing blanks - bad form. 764 | if (!empty($k)) { 765 | if ($lowercase) { 766 | $check = $this->match($exp, strtolower($val), strtolower($k)); 767 | } else { 768 | $check = $this->match($exp, $val, $k); 769 | } 770 | if ($check) break; 771 | } 772 | } 773 | } 774 | if (!$check) $pass = false; 775 | } 776 | if ($pass) $ret[$i] = 1; 777 | unset($node); 778 | } 779 | // It's passed by reference so this is actually what this function returns. 780 | if (is_object($debug_object)) {$debug_object->debug_log(1, "EXIT - ret: ", $ret);} 781 | } 782 | 783 | protected function match($exp, $pattern, $value) { 784 | global $debug_object; 785 | if (is_object($debug_object)) {$debug_object->debug_log_entry(1);} 786 | 787 | switch ($exp) { 788 | case '=': 789 | return ($value===$pattern); 790 | case '!=': 791 | return ($value!==$pattern); 792 | case '^=': 793 | return preg_match("/^".preg_quote($pattern,'/')."/", $value); 794 | case '$=': 795 | return preg_match("/".preg_quote($pattern,'/')."$/", $value); 796 | case '*=': 797 | if ($pattern[0]=='/') { 798 | return preg_match($pattern, $value); 799 | } 800 | return preg_match("/".$pattern."/i", $value); 801 | } 802 | return false; 803 | } 804 | 805 | protected function parse_selector($selector_string) { 806 | global $debug_object; 807 | if (is_object($debug_object)) {$debug_object->debug_log_entry(1);} 808 | 809 | // pattern of CSS selectors, modified from mootools 810 | // Paperg: Add the colon to the attrbute, so that it properly finds like google does. 811 | // Note: if you try to look at this attribute, yo MUST use getAttribute since $dom->x:y will fail the php syntax check. 812 | // Notice the \[ starting the attbute? and the @? following? This implies that an attribute can begin with an @ sign that is not captured. 813 | // This implies that an html attribute specifier may start with an @ sign that is NOT captured by the expression. 814 | // farther study is required to determine of this should be documented or removed. 815 | // $pattern = "/([\w-:\*]*)(?:\#([\w-]+)|\.([\w-]+))?(?:\[@?(!?[\w-]+)(?:([!*^$]?=)[\"']?(.*?)[\"']?)?\])?([\/, ]+)/is"; 816 | $pattern = "/([\w:\*-]*)(?:\#([\w-]+)|\.([\w-]+))?(?:\[@?(!?[\w:-]+)(?:([!*^$]?=)[\"']?(.*?)[\"']?)?\])?([\/, ]+)/is"; 817 | preg_match_all($pattern, trim($selector_string).' ', $matches, PREG_SET_ORDER); 818 | if (is_object($debug_object)) {$debug_object->debug_log(2, "Matches Array: ", $matches);} 819 | 820 | $selectors = array(); 821 | $result = array(); 822 | //print_r($matches); 823 | 824 | foreach ($matches as $m) { 825 | $m[0] = trim($m[0]); 826 | if ($m[0]==='' || $m[0]==='/' || $m[0]==='//') continue; 827 | // for browser generated xpath 828 | if ($m[1]==='tbody') continue; 829 | 830 | list($tag, $key, $val, $exp, $no_key) = array($m[1], null, null, '=', false); 831 | if (!empty($m[2])) {$key='id'; $val=$m[2];} 832 | if (!empty($m[3])) {$key='class'; $val=$m[3];} 833 | if (!empty($m[4])) {$key=$m[4];} 834 | if (!empty($m[5])) {$exp=$m[5];} 835 | if (!empty($m[6])) {$val=$m[6];} 836 | 837 | // convert to lowercase 838 | if ($this->dom->lowercase) {$tag=strtolower($tag); $key=strtolower($key);} 839 | //elements that do NOT have the specified attribute 840 | if (isset($key[0]) && $key[0]==='!') {$key=substr($key, 1); $no_key=true;} 841 | 842 | $result[] = array($tag, $key, $val, $exp, $no_key); 843 | if (trim($m[7])===',') { 844 | $selectors[] = $result; 845 | $result = array(); 846 | } 847 | } 848 | if (count($result)>0) 849 | $selectors[] = $result; 850 | return $selectors; 851 | } 852 | 853 | function __get($name) 854 | { 855 | if (isset($this->attr[$name])) 856 | { 857 | return $this->convert_text($this->attr[$name]); 858 | } 859 | switch ($name) 860 | { 861 | case 'outertext': return $this->outertext(); 862 | case 'innertext': return $this->innertext(); 863 | case 'plaintext': return $this->text(); 864 | case 'xmltext': return $this->xmltext(); 865 | default: return array_key_exists($name, $this->attr); 866 | } 867 | } 868 | 869 | function __set($name, $value) 870 | { 871 | global $debug_object; 872 | if (is_object($debug_object)) {$debug_object->debug_log_entry(1);} 873 | 874 | switch ($name) 875 | { 876 | case 'outertext': return $this->_[HDOM_INFO_OUTER] = $value; 877 | case 'innertext': 878 | if (isset($this->_[HDOM_INFO_TEXT])) return $this->_[HDOM_INFO_TEXT] = $value; 879 | return $this->_[HDOM_INFO_INNER] = $value; 880 | } 881 | if (!isset($this->attr[$name])) 882 | { 883 | $this->_[HDOM_INFO_SPACE][] = array(' ', '', ''); 884 | $this->_[HDOM_INFO_QUOTE][] = HDOM_QUOTE_DOUBLE; 885 | } 886 | $this->attr[$name] = $value; 887 | } 888 | 889 | function __isset($name) 890 | { 891 | switch ($name) 892 | { 893 | case 'outertext': return true; 894 | case 'innertext': return true; 895 | case 'plaintext': return true; 896 | } 897 | //no value attr: nowrap, checked selected... 898 | return (array_key_exists($name, $this->attr)) ? true : isset($this->attr[$name]); 899 | } 900 | 901 | function __unset($name) { 902 | if (isset($this->attr[$name])) 903 | unset($this->attr[$name]); 904 | } 905 | 906 | // PaperG - Function to convert the text from one character set to another if the two sets are not the same. 907 | function convert_text($text) 908 | { 909 | global $debug_object; 910 | if (is_object($debug_object)) {$debug_object->debug_log_entry(1);} 911 | 912 | $converted_text = $text; 913 | 914 | $sourceCharset = ""; 915 | $targetCharset = ""; 916 | 917 | if ($this->dom) 918 | { 919 | $sourceCharset = strtoupper($this->dom->_charset); 920 | $targetCharset = strtoupper($this->dom->_target_charset); 921 | } 922 | if (is_object($debug_object)) {$debug_object->debug_log(3, "source charset: " . $sourceCharset . " target charaset: " . $targetCharset);} 923 | 924 | if (!empty($sourceCharset) && !empty($targetCharset) && (strcasecmp($sourceCharset, $targetCharset) != 0)) 925 | { 926 | // Check if the reported encoding could have been incorrect and the text is actually already UTF-8 927 | if ((strcasecmp($targetCharset, 'UTF-8') == 0) && ($this->is_utf8($text))) 928 | { 929 | $converted_text = $text; 930 | } 931 | else 932 | { 933 | $converted_text = iconv($sourceCharset, $targetCharset, $text); 934 | } 935 | } 936 | 937 | // Lets make sure that we don't have that silly BOM issue with any of the utf-8 text we output. 938 | if ($targetCharset == 'UTF-8') 939 | { 940 | if (substr($converted_text, 0, 3) == "\xef\xbb\xbf") 941 | { 942 | $converted_text = substr($converted_text, 3); 943 | } 944 | if (substr($converted_text, -3) == "\xef\xbb\xbf") 945 | { 946 | $converted_text = substr($converted_text, 0, -3); 947 | } 948 | } 949 | 950 | return $converted_text; 951 | } 952 | 953 | /** 954 | * Returns true if $string is valid UTF-8 and false otherwise. 955 | * 956 | * @param mixed $str String to be tested 957 | * @return boolean 958 | */ 959 | static function is_utf8($str) 960 | { 961 | $c=0; $b=0; 962 | $bits=0; 963 | $len=strlen($str); 964 | for($i=0; $i<$len; $i++) 965 | { 966 | $c=ord($str[$i]); 967 | if($c > 128) 968 | { 969 | if(($c >= 254)) return false; 970 | elseif($c >= 252) $bits=6; 971 | elseif($c >= 248) $bits=5; 972 | elseif($c >= 240) $bits=4; 973 | elseif($c >= 224) $bits=3; 974 | elseif($c >= 192) $bits=2; 975 | else return false; 976 | if(($i+$bits) > $len) return false; 977 | while($bits > 1) 978 | { 979 | $i++; 980 | $b=ord($str[$i]); 981 | if($b < 128 || $b > 191) return false; 982 | $bits--; 983 | } 984 | } 985 | } 986 | return true; 987 | } 988 | /* 989 | function is_utf8($string) 990 | { 991 | //this is buggy 992 | return (utf8_encode(utf8_decode($string)) == $string); 993 | } 994 | */ 995 | 996 | /** 997 | * Function to try a few tricks to determine the displayed size of an img on the page. 998 | * NOTE: This will ONLY work on an IMG tag. Returns FALSE on all other tag types. 999 | * 1000 | * @author John Schlick 1001 | * @version April 19 2012 1002 | * @return array an array containing the 'height' and 'width' of the image on the page or -1 if we can't figure it out. 1003 | */ 1004 | function get_display_size() 1005 | { 1006 | global $debug_object; 1007 | 1008 | $width = -1; 1009 | $height = -1; 1010 | 1011 | if ($this->tag !== 'img') 1012 | { 1013 | return false; 1014 | } 1015 | 1016 | // See if there is aheight or width attribute in the tag itself. 1017 | if (isset($this->attr['width'])) 1018 | { 1019 | $width = $this->attr['width']; 1020 | } 1021 | 1022 | if (isset($this->attr['height'])) 1023 | { 1024 | $height = $this->attr['height']; 1025 | } 1026 | 1027 | // Now look for an inline style. 1028 | if (isset($this->attr['style'])) 1029 | { 1030 | // Thanks to user gnarf from stackoverflow for this regular expression. 1031 | $attributes = array(); 1032 | preg_match_all("/([\w-]+)\s*:\s*([^;]+)\s*;?/", $this->attr['style'], $matches, PREG_SET_ORDER); 1033 | foreach ($matches as $match) { 1034 | $attributes[$match[1]] = $match[2]; 1035 | } 1036 | 1037 | // If there is a width in the style attributes: 1038 | if (isset($attributes['width']) && $width == -1) 1039 | { 1040 | // check that the last two characters are px (pixels) 1041 | if (strtolower(substr($attributes['width'], -2)) == 'px') 1042 | { 1043 | $proposed_width = substr($attributes['width'], 0, -2); 1044 | // Now make sure that it's an integer and not something stupid. 1045 | if (filter_var($proposed_width, FILTER_VALIDATE_INT)) 1046 | { 1047 | $width = $proposed_width; 1048 | } 1049 | } 1050 | } 1051 | 1052 | // If there is a width in the style attributes: 1053 | if (isset($attributes['height']) && $height == -1) 1054 | { 1055 | // check that the last two characters are px (pixels) 1056 | if (strtolower(substr($attributes['height'], -2)) == 'px') 1057 | { 1058 | $proposed_height = substr($attributes['height'], 0, -2); 1059 | // Now make sure that it's an integer and not something stupid. 1060 | if (filter_var($proposed_height, FILTER_VALIDATE_INT)) 1061 | { 1062 | $height = $proposed_height; 1063 | } 1064 | } 1065 | } 1066 | 1067 | } 1068 | 1069 | // Future enhancement: 1070 | // Look in the tag to see if there is a class or id specified that has a height or width attribute to it. 1071 | 1072 | // Far future enhancement 1073 | // Look at all the parent tags of this image to see if they specify a class or id that has an img selector that specifies a height or width 1074 | // Note that in this case, the class or id will have the img subselector for it to apply to the image. 1075 | 1076 | // ridiculously far future development 1077 | // If the class or id is specified in a SEPARATE css file thats not on the page, go get it and do what we were just doing for the ones on the page. 1078 | 1079 | $result = array('height' => $height, 1080 | 'width' => $width); 1081 | return $result; 1082 | } 1083 | 1084 | // camel naming conventions 1085 | function getAllAttributes() {return $this->attr;} 1086 | function getAttribute($name) {return $this->__get($name);} 1087 | function setAttribute($name, $value) {$this->__set($name, $value);} 1088 | function hasAttribute($name) {return $this->__isset($name);} 1089 | function removeAttribute($name) {$this->__set($name, null);} 1090 | function getElementById($id) {return $this->find("#$id", 0);} 1091 | function getElementsById($id, $idx=null) {return $this->find("#$id", $idx);} 1092 | function getElementByTagName($name) {return $this->find($name, 0);} 1093 | function getElementsByTagName($name, $idx=null) {return $this->find($name, $idx);} 1094 | function parentNode() {return $this->parent();} 1095 | function childNodes($idx=-1) {return $this->children($idx);} 1096 | function firstChild() {return $this->first_child();} 1097 | function lastChild() {return $this->last_child();} 1098 | function nextSibling() {return $this->next_sibling();} 1099 | function previousSibling() {return $this->prev_sibling();} 1100 | function hasChildNodes() {return $this->has_child();} 1101 | function nodeName() {return $this->tag;} 1102 | function appendChild($node) {$node->parent($this); return $node;} 1103 | 1104 | } 1105 | 1106 | /** 1107 | * simple html dom parser 1108 | * Paperg - in the find routine: allow us to specify that we want case insensitive testing of the value of the selector. 1109 | * Paperg - change $size from protected to public so we can easily access it 1110 | * Paperg - added ForceTagsClosed in the constructor which tells us whether we trust the html or not. Default is to NOT trust it. 1111 | * 1112 | * @package PlaceLocalInclude 1113 | */ 1114 | class simple_html_dom 1115 | { 1116 | /** 1117 | * The root node of the document 1118 | * 1119 | * @var object 1120 | */ 1121 | public $root = null; 1122 | 1123 | /** 1124 | * List of nodes in the current DOM 1125 | * 1126 | * @var array 1127 | */ 1128 | public $nodes = array(); 1129 | 1130 | /** 1131 | * Callback function to run for each element in the DOM. 1132 | * 1133 | * @var callable|null 1134 | */ 1135 | public $callback = null; 1136 | 1137 | /** 1138 | * Indicates how tags and attributes are matched 1139 | * 1140 | * @var bool When set to **true** tags and attributes will be converted to 1141 | * lowercase before matching. 1142 | */ 1143 | public $lowercase = false; 1144 | 1145 | /** 1146 | * Original document size 1147 | * 1148 | * Holds the original document size. 1149 | * 1150 | * @var int 1151 | */ 1152 | public $original_size; 1153 | 1154 | /** 1155 | * Current document size 1156 | * 1157 | * Holds the current document size. The document size is determined by the 1158 | * string length of ({@see simple_html_dom::$doc}). 1159 | * 1160 | * _Note_: Using this variable is more efficient than calling `strlen($doc)` 1161 | * 1162 | * @var int 1163 | * */ 1164 | public $size; 1165 | 1166 | /** 1167 | * Current position in the document 1168 | * 1169 | * @var int 1170 | */ 1171 | protected $pos; 1172 | 1173 | /** 1174 | * The document 1175 | * 1176 | * @var string 1177 | */ 1178 | protected $doc; 1179 | 1180 | /** 1181 | * Current character 1182 | * 1183 | * Holds the current character at position {@see simple_html_dom::$pos} in 1184 | * the document {@see simple_html_dom::$doc} 1185 | * 1186 | * _Note_: Using this variable is more efficient than calling `substr($doc, $pos, 1)` 1187 | * 1188 | * @var string 1189 | */ 1190 | protected $char; 1191 | 1192 | protected $cursor; 1193 | 1194 | /** 1195 | * Parent node of the next node detected by the parser 1196 | * 1197 | * @var object 1198 | */ 1199 | protected $parent; 1200 | protected $noise = array(); 1201 | 1202 | /** 1203 | * Tokens considered blank in HTML 1204 | * 1205 | * @var string 1206 | */ 1207 | protected $token_blank = " \t\r\n"; 1208 | 1209 | /** 1210 | * Tokens to identify the equal sign for attributes, stopping either at the 1211 | * closing tag ("/" i.e. "") or the end of an opening tag (">" i.e. 1212 | * "") 1213 | * 1214 | * @var string 1215 | */ 1216 | protected $token_equal = ' =/>'; 1217 | 1218 | /** 1219 | * Tokens to identify the end of a tag name. A tag name either ends on the 1220 | * ending slash ("/" i.e. "") or whitespace ("\s\r\n\t") 1221 | * 1222 | * @var string 1223 | */ 1224 | protected $token_slash = " />\r\n\t"; 1225 | 1226 | /** 1227 | * Tokens to identify the end of an attribute 1228 | * 1229 | * @var string 1230 | */ 1231 | protected $token_attr = ' >'; 1232 | 1233 | // Note that this is referenced by a child node, and so it needs to be public for that node to see this information. 1234 | public $_charset = ''; 1235 | public $_target_charset = ''; 1236 | 1237 | /** 1238 | * Innertext for
elements 1239 | * 1240 | * @var string 1241 | */ 1242 | protected $default_br_text = ""; 1243 | 1244 | /** 1245 | * Suffix for elements 1246 | * 1247 | * @var string 1248 | */ 1249 | public $default_span_text = ""; 1250 | 1251 | /** 1252 | * Defines a list of self-closing tags (Void elements) according to the HTML 1253 | * Specification 1254 | * 1255 | * _Remarks_: 1256 | * - Use `isset()` instead of `in_array()` on array elements to boost 1257 | * performance about 30% 1258 | * - Sort elements by name for better readability! 1259 | * 1260 | * @link https://www.w3.org/TR/html HTML Specification 1261 | * @link https://www.w3.org/TR/html/syntax.html#void-elements Void elements 1262 | */ 1263 | protected $self_closing_tags = array( 1264 | 'area'=>1, 1265 | 'base'=>1, 1266 | 'br'=>1, 1267 | 'col'=>1, 1268 | 'embed'=>1, 1269 | 'hr'=>1, 1270 | 'img'=>1, 1271 | 'input'=>1, 1272 | 'link'=>1, 1273 | 'meta'=>1, 1274 | 'param'=>1, 1275 | 'source'=>1, 1276 | 'track'=>1, 1277 | 'wbr'=>1 1278 | ); 1279 | 1280 | /** 1281 | * Defines a list of tags which - if closed - close all optional closing 1282 | * elements within if they haven't been closed yet. (So, an element where 1283 | * neither opening nor closing tag is omissible consistently closes every 1284 | * optional closing element within) 1285 | * 1286 | * _Remarks_: 1287 | * - Use `isset()` instead of `in_array()` on array elements to boost 1288 | * performance about 30% 1289 | * - Sort elements by name for better readability! 1290 | */ 1291 | protected $block_tags = array( 1292 | 'body'=>1, 1293 | 'div'=>1, 1294 | 'form'=>1, 1295 | 'root'=>1, 1296 | 'span'=>1, 1297 | 'table'=>1 1298 | ); 1299 | 1300 | /** 1301 | * Defines elements whose end tag is omissible. 1302 | * 1303 | * * key = Name of an element whose end tag is omissible. 1304 | * * value = Names of elements whose end tag is omissible, that are closed 1305 | * by the current element. 1306 | * 1307 | * _Remarks_: 1308 | * - Use `isset()` instead of `in_array()` on array elements to boost 1309 | * performance about 30% 1310 | * - Sort elements by name for better readability! 1311 | * 1312 | * **Example** 1313 | * 1314 | * An `li` element’s end tag may be omitted if the `li` element is immediately 1315 | * followed by another `li` element. To do that, add following element to the 1316 | * array: 1317 | * 1318 | * ```php 1319 | * 'li' => array('li'), 1320 | * ``` 1321 | * 1322 | * With this, the following two examples are considered equal. Note that the 1323 | * second example is missing the closing tags on `li` elements. 1324 | * 1325 | * ```html 1326 | *
  • First Item
  • Second Item
1327 | * ``` 1328 | * 1329 | *
  • First Item
  • Second Item
1330 | * 1331 | * ```html 1332 | *
  • First Item
  • Second Item
1333 | * ``` 1334 | * 1335 | *
  • First Item
  • Second Item
1336 | * 1337 | * @var array A two-dimensional array where the key is the name of an 1338 | * element whose end tag is omissible and the value is an array of elements 1339 | * whose end tag is omissible, that are closed by the current element. 1340 | * 1341 | * @link https://www.w3.org/TR/html/syntax.html#optional-tags Optional tags 1342 | * 1343 | * @todo The implementation of optional closing tags doesn't work in all cases 1344 | * because it only consideres elements who close other optional closing 1345 | * tags, not taking into account that some (non-blocking) tags should close 1346 | * these optional closing tags. For example, the end tag for "p" is omissible 1347 | * and can be closed by an "address" element, whose end tag is NOT omissible. 1348 | * Currently a "p" element without closing tag stops at the next "p" element 1349 | * or blocking tag, even if it contains other elements. 1350 | * 1351 | * @todo Known sourceforge issue #2977341 1352 | * B tags that are not closed cause us to return everything to the end of 1353 | * the document. 1354 | */ 1355 | protected $optional_closing_tags = array( 1356 | 'b'=>array('b'=>1), // Not optional, see https://www.w3.org/TR/html/textlevel-semantics.html#the-b-element 1357 | 'dd'=>array('dd'=>1, 'dt'=>1), 1358 | 'dl'=>array('dd'=>1, 'dt'=>1), // Not optional, see https://www.w3.org/TR/html/grouping-content.html#the-dl-element 1359 | 'dt'=>array('dd'=>1, 'dt'=>1), 1360 | 'li'=>array('li'=>1), 1361 | 'optgroup'=>array('optgroup'=>1, 'option'=>1), 1362 | 'option'=>array('optgroup'=>1, 'option'=>1), 1363 | 'p'=>array('p'=>1), 1364 | 'rp'=>array('rp'=>1, 'rt'=>1), 1365 | 'rt'=>array('rp'=>1, 'rt'=>1), 1366 | 'td'=>array('td'=>1, 'th'=>1), 1367 | 'th'=>array('td'=>1, 'th'=>1), 1368 | 'tr'=>array('td'=>1, 'th'=>1, 'tr'=>1), 1369 | ); 1370 | 1371 | function __construct($str=null, $lowercase=true, $forceTagsClosed=true, $target_charset=DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT, $options=0) 1372 | { 1373 | if ($str) 1374 | { 1375 | if (preg_match("/^http:\/\//i",$str) || is_file($str)) 1376 | { 1377 | $this->load_file($str); 1378 | } 1379 | else 1380 | { 1381 | $this->load($str, $lowercase, $stripRN, $defaultBRText, $defaultSpanText, $options); 1382 | } 1383 | } 1384 | // Forcing tags to be closed implies that we don't trust the html, but it can lead to parsing errors if we SHOULD trust the html. 1385 | if (!$forceTagsClosed) { 1386 | $this->optional_closing_array=array(); 1387 | } 1388 | $this->_target_charset = $target_charset; 1389 | } 1390 | 1391 | function __destruct() 1392 | { 1393 | $this->clear(); 1394 | } 1395 | 1396 | // load html from string 1397 | function load($str, $lowercase=true, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT, $options=0) 1398 | { 1399 | global $debug_object; 1400 | 1401 | // prepare 1402 | $this->prepare($str, $lowercase, $defaultBRText, $defaultSpanText); 1403 | 1404 | // Per sourceforge http://sourceforge.net/tracker/?func=detail&aid=2949097&group_id=218559&atid=1044037 1405 | // Script tags removal now preceeds style tag removal. 1406 | // strip out