├── NOTICE ├── .editorconfig ├── composer.json ├── README.md ├── src └── GitScraper.php └── LICENSE /NOTICE: -------------------------------------------------------------------------------- 1 | PHP-GitScraper 2 | Copyright (c) delight.im 3 | 4 | This product includes software developed by 5 | delight.im (http://www.delight.im/). 6 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | indent_style = tab 7 | trim_trailing_whitespace = true 8 | end_of_line = lf 9 | insert_final_newline = true 10 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "delight-im/git-scraper", 3 | "description": "Downloads entire Git repositories from publicly accessible \".git\" folders over HTTP", 4 | "require": { 5 | "php": ">=5.5.0" 6 | }, 7 | "type": "library", 8 | "keywords": [ "git", "vcs", "scm", "scraper", "security" ], 9 | "homepage": "https://github.com/delight-im/PHP-GitScraper", 10 | "license": "Apache-2.0", 11 | "autoload": { 12 | "psr-4": { 13 | "Delight\\GitScraper\\": "src/" 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitScraper 2 | 3 | Downloads entire Git repositories from publicly accessible `.git` folders over HTTP 4 | 5 | * Directory indexes or directory browsing on the web server are *not* required 6 | * Running `git update-server-info` on the server is *not* required 7 | 8 | ## Requirements 9 | 10 | * PHP 5.5.0+ 11 | 12 | ## Installation 13 | 14 | 1. Include the library via Composer [[?]](https://github.com/delight-im/Knowledge/blob/master/Composer%20(PHP).md): 15 | 16 | ``` 17 | $ composer require delight-im/git-scraper 18 | ``` 19 | 20 | 1. Include the Composer autoloader: 21 | 22 | ```php 23 | require __DIR__ . '/vendor/autoload.php'; 24 | ``` 25 | 26 | ## Usage 27 | 28 | ``` 29 | $scraper = new \Delight\GitScraper\GitScraper('http://www.example.com/.git/'); 30 | $scraper->fetch(); 31 | // var_dump($scraper->getFiles()); 32 | $scraper->download('./'); 33 | ``` 34 | 35 | ## Terminology 36 | 37 | * hash 38 | * used to identify objects in Git 39 | * always uses the SHA-1 algorithm 40 | * has a length of 20 bytes, 40 hex characters or 160 bits 41 | * ensures file integrity 42 | * object 43 | * stored in `.git/objects` 44 | * addressable by its unique hash 45 | * has a small header describing the type and length of its content 46 | * compressed with `zlib` 47 | * can be previewed (in a slightly modified version) by running the command `git cat-file -p {hash}` 48 | * `commit` object 49 | * points to a single `tree` object (stored as 40 hex characters) 50 | * contains the name and email address of the committer as well as the commit time 51 | * includes information about the author (may *not* be the committer) which are analogous to the committer data 52 | * holds the commit message or description of the commit 53 | * points to the parent tree as well so that you can browse the history 54 | * `tree` object 55 | * corresponds to a directory on the file system 56 | * contains pointers to other objects (stored as 20 bytes) 57 | * `tree` objects (i.e. sub-directories) and `blob` objects (i.e. files inside the directory) may be listed here 58 | * `blob` object 59 | * similar to a file on the file system 60 | * simply a binary representation of the file 61 | 62 | ## Further reading 63 | 64 | * [Pro Git](https://git-scm.com/book/en/v2) 65 | * ["Git Internals"](https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain) 66 | * ["The Dumb Protocol"](https://git-scm.com/book/en/v2/Git-Internals-Transfer-Protocols#The-Dumb-Protocol) 67 | * [Git Magic](http://www-cs-students.stanford.edu/~blynn/gitmagic/) 68 | * ["Secrets Revealed"](http://www-cs-students.stanford.edu/~blynn/gitmagic/ch08.html) 69 | * [A Hacker's Guide to Git](http://wildlyinaccurate.com/a-hackers-guide-to-git/) 70 | 71 | ## Contributing 72 | 73 | All contributions are welcome! If you wish to contribute, please create an issue first so that your feature, problem or question can be discussed. 74 | 75 | ## Disclaimer 76 | 77 | You should probably use this library with your own websites and repositories only. 78 | 79 | ## License 80 | 81 | ``` 82 | Copyright (c) delight.im 83 | 84 | Licensed under the Apache License, Version 2.0 (the "License"); 85 | you may not use this file except in compliance with the License. 86 | You may obtain a copy of the License at 87 | 88 | http://www.apache.org/licenses/LICENSE-2.0 89 | 90 | Unless required by applicable law or agreed to in writing, software 91 | distributed under the License is distributed on an "AS IS" BASIS, 92 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 93 | See the License for the specific language governing permissions and 94 | limitations under the License. 95 | ``` 96 | -------------------------------------------------------------------------------- /src/GitScraper.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * Licensed under the Apache License, Version 2.0 (the "License"); 7 | * you may not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, software 13 | * distributed under the License is distributed on an "AS IS" BASIS, 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | * See the License for the specific language governing permissions and 16 | * limitations under the License. 17 | */ 18 | 19 | namespace Delight\GitScraper; 20 | 21 | /** Downloads entire Git repositories from publicly accessible `.git` folders over HTTP */ 22 | class GitScraper { 23 | 24 | const HASH_REGEX = '[a-z0-9]{40}'; 25 | const GIT_URL_REGEX = '/^(http|https):\\/\\/(.*?)(?:\\/|$)(.*?)(?:\\/)?(?:\\.git)?(?:\\/)?$/i'; 26 | const HEAD_REF_REGEX = '/^ref: ([a-zA-Z\\/]+)\\s*/'; 27 | const TREE_ENTRIES_REGEX = '/(1)?([0-7]{5}) ([^\x00]+)\x00(.{20})/s'; 28 | const OBJECT_STRUCTURE_REGEX = '/^([a-z]+) ([0-9]+)\x00(.*)/s'; 29 | 30 | private $path; 31 | private $workingDir; 32 | private $files; 33 | 34 | public function __construct($url) { 35 | $this->path = self::normalizeGitUrl($url); 36 | $this->workingDir = array(); 37 | $this->files = array(); 38 | } 39 | 40 | public function fetch() { 41 | $head = @file_get_contents($this->path.'/HEAD'); 42 | $headRef = self::parseHead($head); 43 | 44 | $ref = @file_get_contents($this->path.'/'.$headRef); 45 | $refHash = self::parseHash($ref); 46 | 47 | $this->loadObject($refHash); 48 | } 49 | 50 | private static function normalizeGitUrl($url) { 51 | $url = trim($url); 52 | 53 | if (preg_match(self::GIT_URL_REGEX, $url, $matches)) { 54 | $protocol = $matches[1]; 55 | $host = $matches[2]; 56 | 57 | $path = $protocol.'://'.$host; 58 | if (!empty($matches[3])) { 59 | $path .= '/'.$matches[3]; 60 | } 61 | 62 | $path .= '/.git'; 63 | 64 | return $path; 65 | } 66 | else { 67 | throw new \Exception('Invalid URL: '.$url); 68 | } 69 | } 70 | 71 | private static function parseHead($head) { 72 | if (preg_match(self::HEAD_REF_REGEX, $head, $matches)) { 73 | return $matches[1]; 74 | } 75 | else { 76 | throw new \Exception('No head reference found: '.$head); 77 | } 78 | } 79 | 80 | private static function parseHash($hash) { 81 | if (preg_match('/^\\s*('.self::HASH_REGEX.')\\s*$/', $hash, $matches)) { 82 | return $matches[1]; 83 | } 84 | else { 85 | throw new \Exception('Hash could not be parsed: '.$hash); 86 | } 87 | } 88 | 89 | private static function createPathFromHash($hash) { 90 | return substr($hash, 0, 2).'/'.substr($hash, 2); 91 | } 92 | 93 | private static function decode($data) { 94 | $decoded = zlib_decode($data); 95 | 96 | if ($decoded === false) { 97 | throw new \Exception('Cannot decode data: '.base64_encode($data)); 98 | } 99 | 100 | return $decoded; 101 | } 102 | 103 | private function getWorkingDir($asString = false) { 104 | if ($asString) { 105 | if (count($this->workingDir) === 0) { 106 | return ''; 107 | } 108 | else { 109 | return implode('/', $this->workingDir).'/'; 110 | } 111 | } 112 | else { 113 | return $this->workingDir; 114 | } 115 | } 116 | 117 | private function extractEntriesFromTree($data) { 118 | $numMatches = preg_match_all(self::TREE_ENTRIES_REGEX, $data, $matches); 119 | 120 | if ($numMatches !== false) { 121 | for ($i = 0; $i < $numMatches; $i++) { 122 | $hash = bin2hex($matches[4][$i]); 123 | $name = $matches[3][$i]; 124 | $isBlob = ($matches[1][$i] === '1'); 125 | 126 | if ($isBlob) { 127 | $this->files[] = array( 128 | 'hash' => $hash, 129 | 'name' => $this->getWorkingDir(true).$name, 130 | 'mode' => $matches[2][$i] 131 | ); 132 | } 133 | else { 134 | $this->changeWorkingDir($name); 135 | $this->loadObject($hash); 136 | $this->changeWorkingDir('../'); 137 | } 138 | } 139 | } 140 | } 141 | 142 | private function changeWorkingDir($dir) { 143 | if ($dir === '../') { 144 | array_pop($this->workingDir); 145 | } 146 | elseif ($dir === './') { 147 | // ignore 148 | } 149 | else { 150 | $this->workingDir[] = $dir; 151 | } 152 | } 153 | 154 | private function createObjectUrl($hash) { 155 | return $this->path.'/objects/'.self::createPathFromHash($hash); 156 | } 157 | 158 | private function loadObject($hash, $mode = null) { 159 | $obj = @file_get_contents($this->createObjectUrl($hash)); 160 | 161 | if (empty($obj)) { 162 | return null; 163 | } 164 | 165 | return $this->parseObject($obj); 166 | } 167 | 168 | private function extractTreeFromCommit($data) { 169 | $treeHash = self::findTreeHash($data); 170 | $this->loadObject($treeHash); 171 | } 172 | 173 | private function parseObject($obj) { 174 | $str = self::decode($obj); 175 | 176 | if (preg_match(self::OBJECT_STRUCTURE_REGEX, $str, $matches)) { 177 | $type = $matches[1]; 178 | $length = $matches[2]; 179 | $data = $matches[3]; 180 | 181 | if ($type === 'commit') { 182 | $this->extractTreeFromCommit($data); 183 | 184 | return null; 185 | } 186 | elseif ($type === 'tree') { 187 | $this->extractEntriesFromTree($data); 188 | 189 | return null; 190 | } 191 | elseif ($type === 'blob') { 192 | return $data; 193 | } 194 | elseif ($type === 'tag') { 195 | // TODO 196 | 197 | return null; 198 | } 199 | else { 200 | throw new \Exception('Unknown type: '.$type); 201 | } 202 | } 203 | else { 204 | throw new \Exception('Cannot parse object'); 205 | } 206 | } 207 | 208 | private static function findTreeHash($str) { 209 | if (preg_match('/tree ([a-z0-9]{40})/', $str, $matches)) { 210 | return $matches[1]; 211 | } 212 | else { 213 | throw new \Exception('Could not find tree hash: '.$str); 214 | } 215 | } 216 | 217 | public function getFiles() { 218 | if (count($this->files) === 0) { 219 | throw new \Exception('Either there are no files or you didn\'t call `fetch()` yet'); 220 | } 221 | 222 | return $this->files; 223 | } 224 | 225 | private static function normalizeTargetDir($dir) { 226 | $lastChar = substr($dir, -1); 227 | 228 | if ($lastChar !== '/' && $lastChar !== '\\') { 229 | $dir .= '/'; 230 | } 231 | 232 | return $dir; 233 | } 234 | 235 | public function download($targetDir = './') { 236 | $targetDir = self::normalizeTargetDir($targetDir); 237 | 238 | if (!file_exists($targetDir) || !is_dir($targetDir)) { 239 | throw new \Exception('Target directory does not exist: '.$targetDir); 240 | } 241 | 242 | foreach ($this->files as $file) { 243 | $pathSegments = explode('/', $file['name']); 244 | $filename = array_pop($pathSegments); 245 | 246 | // if the file is not in the root directory but in a sub-directory 247 | if (count($pathSegments) > 0) { 248 | $path = implode('/', $pathSegments).'/'; 249 | 250 | // if the specific sub-directory does not exist yet 251 | if (!file_exists($targetDir.$path)) { 252 | // create the directory 253 | @mkdir($targetDir.$path, 0755, true); 254 | } 255 | } 256 | else { 257 | $path = ''; 258 | } 259 | 260 | $content = $this->loadObject($file['hash'], $file['mode']); 261 | 262 | // save the file 263 | file_put_contents($targetDir.$path.$filename, $content); 264 | } 265 | } 266 | 267 | } 268 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------