├── .gitignore ├── .scrutinizer.yml ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── phpcs.xml ├── phpdoc.dist.xml ├── phpunit.xml.dist ├── src ├── BotInterface.php ├── Bots │ ├── AbstractBot.php │ ├── AbstractTaggedBot.php │ ├── Alexa.php │ ├── Baidu.php │ ├── BaseBot.php │ ├── BeeBot.php │ ├── Bing.php │ ├── DiscoBot.php │ ├── EmptyBot.php │ ├── ExaBot.php │ ├── Facebook.php │ ├── Google.php │ ├── MailRU.php │ ├── Seznam.php │ ├── Sogou.php │ ├── Soso.php │ ├── Visitor.php │ ├── WordPress.php │ ├── Yahoo.php │ └── Yandex.php ├── Detector.php └── NotAKnownBotException.php └── test └── units ├── Bots ├── AbstractBotTest.php ├── AbstractTaggedBotTest.php ├── AlexaTest.php ├── BaiduTest.php ├── BaseBotTest.php ├── BeeBotTest.php ├── BingTest.php ├── DiscoBotTest.php ├── EmptyBotTest.php ├── ExaBotTest.php ├── FacebookTest.php ├── GoogleTest.php ├── MailRUTest.php ├── SeznamTest.php ├── SogouTest.php ├── SosoTest.php ├── VisitorTest.php ├── WordPressTest.php ├── YahooTest.php └── YandexTest.php ├── DetectorTest.php └── bootstrap.php /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor/ 2 | /report/ 3 | /bin/ 4 | /composer.lock 5 | -------------------------------------------------------------------------------- /.scrutinizer.yml: -------------------------------------------------------------------------------- 1 | ## Scrutinizer quality insurance configuration 2 | tools: 3 | external_code_coverage: true 4 | php_mess_detector: 5 | config: 6 | unused_code_rules: 7 | unused_local_variable: true 8 | unused_private_method: true 9 | unused_formal_parameter: true 10 | controversial_rules: 11 | camel_case_class_name: true 12 | camel_case_property_name: true 13 | camel_case_method_name: true 14 | php_cs_fixer: true 15 | php_pdepend: true 16 | php_sim: true 17 | php_changetracking: true 18 | php_analyzer: true 19 | sensiolabs_security_checker: true 20 | 21 | filter: 22 | excluded_paths: 23 | - vendor/* 24 | - test/public/* 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: php 3 | php: 4 | - 7.0 5 | - 5.6 6 | - 5.5 7 | - 5.4 8 | install: 9 | - composer install --no-interaction --prefer-source 10 | - composer install:phpunit 11 | script: bin/phpunit --coverage-clover=coverage.clover 12 | after_script: 13 | - wget https://scrutinizer-ci.com/ocular.phar 14 | - php ocular.phar code-coverage:upload --format=php-clover coverage.clover 15 | -------------------------------------------------------------------------------- /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 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | bee4/useragent-classifier 2 | ====================== 3 | 4 | [![Build Status](https://img.shields.io/travis/bee4/useragent-classifier.svg?style=flat-square)](https://travis-ci.org/bee4/useragent-classifier) 5 | [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/bee4/useragent-classifier.svg?style=flat-square)](https://scrutinizer-ci.com/g/bee4/useragent-classifier/?branch=develop) 6 | [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/bee4/useragent-classifier.svg?style=flat-square)](https://scrutinizer-ci.com/g/bee4/useragent-classifier/) 7 | [![SensiolabInsight](https://img.shields.io/sensiolabs/i/3f165beb-2425-4669-a3da-c1794c6f7337.svg?style=flat-square)](https://insight.sensiolabs.com/projects/3f165beb-2425-4669-a3da-c1794c6f7337) 8 | 9 | [![License](https://img.shields.io/packagist/l/bee4/useragent-classifier.svg?style=flat-square)](https://packagist.org/packages/bee4/useragent-classifier) 10 | 11 | This library allow to track and detect who is behind useragents :) 12 | 13 | 14 | Installing 15 | ---------- 16 | [![Latest Stable Version](https://img.shields.io/packagist/v/bee4/useragent-classifier.svg?style=flat-square)](https://packagist.org/packages/bee4/useragent-classifier) 17 | [![Total Downloads](https://img.shields.io/packagist/dm/bee4/useragent-classifier.svg?style=flat-square)](https://packagist.org/packages/bee4/useragent-classifier) 18 | 19 | This project can be installed using Composer. Add the following to your composer.json: 20 | 21 | ```JSON 22 | { 23 | "require": { 24 | "bee4/useragent-classifier": "~1.0" 25 | } 26 | } 27 | ``` 28 | 29 | or run this command: 30 | 31 | ```Shell 32 | composer require bee4/useragent-classifier:~1.0 33 | ``` 34 | 35 | Usage 36 | ----- 37 | 38 | This library is composed of a `Detector` object and different `Bots` implementation. 39 | 40 | ```php 41 | use Bee4\UserAgent\Classifier\Detector; 42 | 43 | $ua = 'Mozilla/5.0 (compatible; Mail.RU/2.0)'; 44 | $bot = Detector::whoIs($ua); //$bot is a Bots\MailRU instance 45 | 46 | $bot->getBot(); //Here we get `mailru` 47 | $bot->getName(); //Here we get `mailru-bot` 48 | 49 | $ua = 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)'; 50 | $bot = Detector::whoIs($ua); //$bot is a Bots\Google instance 51 | 52 | $bot->getBot(); //Here we get `google` 53 | $bot->getName(); //Here we get `google-bot` 54 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "bee4/useragent-classifier", 3 | "description": "A library to work with UserAgent detection and classification", 4 | "license": "Apache-2.0", 5 | "authors": [ 6 | { 7 | "name": "Stephane HULARD", 8 | "email": "s.hulard@chstudio.fr" 9 | } 10 | ], 11 | "require": { 12 | "php": ">=5.4", 13 | "ext-pcre": "*" 14 | }, 15 | "autoload": { 16 | "psr-4": { 17 | "Bee4\\UserAgent\\Classifier\\": "src" 18 | } 19 | }, 20 | "scripts": { 21 | "install:phpunit": [ 22 | "mkdir -p bin && php -r \"file_put_contents('bin/phpunit', file_get_contents('https://phar.phpunit.de/phpunit-4.7.7.phar'));\"", 23 | "chmod 755 bin/phpunit" 24 | ], 25 | "install:phpcodesniffer": [ 26 | "mkdir -p bin && php -r \"file_put_contents('bin/phpcs', file_get_contents('https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar'));\"", 27 | "php -r \"file_put_contents('bin/phpcbf', file_get_contents('https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar'));\"", 28 | "chmod 755 bin/phpcs bin/phpcbf" 29 | ] 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /phpcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | Specific BeeBOT standard 4 | 5 | */vendor/* 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /phpdoc.dist.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | bee4/useragent-classify 4 | 5 | doc/phpdoc 6 | 7 | php 8 | 9 | 10 | 11 | TODO 12 | FIXME 13 | IDEA 14 | 15 | 16 | 17 | doc/phpdoc 18 | 19 | 20 |