From 94c25b6a690b4a71b48a9347e021dcc9d5a7783a Mon Sep 17 00:00:00 2001 From: Dmitriy Simushev Date: Fri, 5 Dec 2014 13:44:40 +0000 Subject: [PATCH] Initial commit --- .gitignore | 19 +++++ LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++ Plugin.php | 166 +++++++++++++++++++++++++++++++++++++++++ README.md | 56 ++++++++++++++ composer.json | 8 ++ db/.htaccess | 1 + gulpfile.js | 76 +++++++++++++++++++ package.json | 18 +++++ 8 files changed, 546 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Plugin.php create mode 100644 README.md create mode 100644 composer.json create mode 100644 db/.htaccess create mode 100644 gulpfile.js create mode 100644 package.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..13af972 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# Do not index node.js modules that are used for building +node_modules + +# Do not index composer components +vendor + +# Do not index releases +release + +# Do not index vendor binaries +bin + +# Do not index GeoIP databases but not the .htaccess file that hides them. +db/* +!db/.htaccess + +# Do not index composer executable and its lock file +composer.phar +composer.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Plugin.php b/Plugin.php new file mode 100644 index 0000000..fb402d3 --- /dev/null +++ b/Plugin.php @@ -0,0 +1,166 @@ +. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file The main file of Mibew:GeoIp plugin. + */ + +namespace Mibew\Mibew\Plugin\GeoIp; + +use GeoIp2\Database\Reader as GeoIpReader; + +/** + * This plugin provides an API for GeoIP information. + */ +class Plugin extends \Mibew\Plugin\AbstractPlugin implements \Mibew\Plugin\PluginInterface +{ + /** + * Class construct. + * + * @param array $config Configurations array. + */ + public function __construct($config) + { + $config += array( + 'database_path' => $this->getFilesPath() . '/db/GeoIP.mmdb', + ); + + parent::__construct($config); + + // Use autoloader for Composer's packages that shipped with the plugin + require(__DIR__ . '/vendor/autoload.php'); + } + + /** + * The plugin does not need extra initialization thus it is always ready to + * work. + * + * @return boolean + */ + public function initialized() + { + return true; + } + + /** + * Retrieves Geo Info by IP. + * + * @param string $ip IP address + * @param string $locale Locale name which should be used for country and + * city names. If this argument is ommited default names in english will + * be used. + * @return array Associative array of Geo information. It has the following + * keys: + * - "country_name": Name of the country the IP is situated in. + * - "country_code": ISO 3166-1 Alpha-2 code the IP is situated in. + * - "city": Name of the city the IP is situated in. + * - "latitude": Latitude of the place the IP is situated in. + * - "longitude": Longitude of the place the IP is situated in. + */ + public function getGeoInfo($ip, $locale = false) + { + try { + $reader = new GeoIpReader($this->config['database_path']); + $record = $reader->city($ip); + } catch (\GeoIp2\Exception\AddressNotFoundException $e) { + return array( + 'country_name' => 'Unknown', + 'country_code' => false, + 'city' => 'Unknown', + 'latitude' => 0, + 'longitude' => 0, + ); + } + + if ($locale) { + // Make sure the locale in "xx-XX" format. + $locale = $this->formatLocale($locale); + } + + // Try to use localized names for country and city. If there are no such + // names use english ones. + $country_name = $locale && isset($record->country->names[$locale]) + ? $record->country->names[$locale] + : $record->country->name; + $city = $locale && isset($record->city->names[$locale]) + ? $record->city->names[$locale] + : $record->city->name; + + return array( + 'country_name' => $country_name, + 'country_code' => $record->country->isoCode, + 'city' => $city, + 'latitude' => $record->location->latitude, + 'longitude' => $record->location->longitude, + ); + } + + /** + * This method is intentionally empty but should exist to let the plugin + * implements {@link \Mibew\Plugin\PluginInterface}. + */ + public function run() + { + } + + /** + * Returns pluing's version. + * + * @return string + */ + public static function getVersion() + { + return '1.0.0'; + } + + /** + * Returns plugin's dependencies. + * + * @return type + */ + public static function getDependencies() + { + return array(); + } + + /** + * Format locale name using "xx-XX" format. + * + * @param string $locale Original locale name in format it is used in Mibew. + * @return string|false Formatted locale name or boolean false if the + * original locale name is not correct. + */ + protected function formatLocale($locale) + { + // Make sure the original locale name is correct + if (!locale_pattern_check($locale)) { + return false; + } + + $parts = explode('-', $locale); + + if (count($parts) == 1) { + // The locale is just in "xx" format. There is no need to modify it. + return $parts[0]; + } + + // Make sure the locale in "xx-XX" format. + return $parts[0] . '-' . strtoupper($parts[1]); + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..88246af --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Mibew Geo IP plugin + +Provides Geo IP information for other plugins. + + +## Installation + +1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources. + +2. Untar/unzip the plugin's archive. + +3. Put files of the plugins to the `/plugins` folder. + +4. Obtain a copy of MaxMind's GeoIP2 City datatbase. You can use a free one from here http://dev.maxmind.com/geoip/geoip2/geolite2/. + +5. Rename the database file to `GeoIP.mmdb` and put it into `/plugins/Mibew/Mibew/Plugin/GeoIp/db` directory. + +6. (optional) Add plugins configs to "plugins" structure in "``/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become: + ```yaml + plugins: + "Mibew:GeoIp": # Plugin's configurations are described below + database_path: "/usr/local/share/GeoIP/GeoIP2-City.mmdb" + ``` + +7. Navigate to "``/operator/plugin" page and enable the plugin. + + +## Plugin's configurations + +The plugin can be configured with values in "``/configs/config.yml" file. + +### config.database_path + +Type: `String` + +Default: `/db/GeoIP.mmdb` + +Specify location of the GeoIP database. This value is optional and can be skipped. + + +## Build from sources + +There are several actions one should do before use the latest version of the plugin from the repository: + +1. Obtain a copy of the repository using `git clone`, download button, or another way. +2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). +3. Install [Gulp](http://gulpjs.com/). +4. Install npm dependencies using `npm install`. +5. Run Gulp to build the sources using `gulp default`. + +Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. + + +## License + +[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..fbefb77 --- /dev/null +++ b/composer.json @@ -0,0 +1,8 @@ +{ + "require": { + "geoip2/geoip2": "2.1.*" + }, + "config": { + "bin-dir": "bin" + } +} \ No newline at end of file diff --git a/db/.htaccess b/db/.htaccess new file mode 100644 index 0000000..14249c5 --- /dev/null +++ b/db/.htaccess @@ -0,0 +1 @@ +Deny from all \ No newline at end of file diff --git a/gulpfile.js b/gulpfile.js new file mode 100644 index 0000000..43c485d --- /dev/null +++ b/gulpfile.js @@ -0,0 +1,76 @@ +var fs = require('fs'), + https = require('https'), + exec = require('child_process').exec, + eventStream = require('event-stream'), + gulp = require('gulp'), + chmod = require('gulp-chmod'), + zip = require('gulp-zip'), + tar = require('gulp-tar'), + gzip = require('gulp-gzip'), + rename = require('gulp-rename'); + +// Get and install PHP Composer +gulp.task('get-composer', function(callback) { + // Check if Composer already in place + if (fs.existsSync('./composer.phar')) { + callback(null); + + return; + } + + // Get installer from the internet + https.get('https://getcomposer.org/installer', function(response) { + // Run PHP to install Composer + var php = exec('php', function(error, stdout, stderr) { + callback(error ? stderr : null); + }); + // Pass installer code to PHP via STDIN + response.pipe(php.stdin); + }); +}); + +// Install Composer dependencies +gulp.task('composer-install', ['get-composer'], function(callback) { + exec('php -d "suhosin.executor.include.whitelist = phar" composer.phar install --no-dev', function(error, stdout, stderr) { + callback(error ? stderr : null); + }); +}); + +gulp.task('prepare-release', ['composer-install'], function() { + var version = require('./package.json').version; + + return eventStream.merge( + getSources() + .pipe(zip('geo-ip-plugin-' + version + '.zip')), + getSources() + .pipe(tar('geo-ip-plugin-' + version + '.tar')) + .pipe(gzip()) + ) + .pipe(chmod(0644)) + .pipe(gulp.dest('release')); +}); + +// Builds and packs plugins sources +gulp.task('default', ['prepare-release'], function() { + // The "default" task is just an alias for "prepare-release" task. +}); + +/** + * Returns files stream with the plugin sources. + * + * @returns {Object} Stream with VinylFS files. + */ +var getSources = function() { + return gulp.src([ + 'Plugin.php', + 'README.md', + 'LICENSE', + 'db/.htaccess', + 'vendor/**/*.*' + ], + {base: './'} + ) + .pipe(rename(function(path) { + path.dirname = 'Mibew/Mibew/Plugin/GeoIp/' + path.dirname; + })); +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..ed0bfc6 --- /dev/null +++ b/package.json @@ -0,0 +1,18 @@ +{ + "name": "geo-ip", + "version": "1.0.0", + "description": "A plugin for Mibew that provides GeoIP information.", + "private": true, + "bugs": { + "url": "https://github.com/mibew/geo-ip-plugin/issues" + }, + "devDependencies": { + "gulp": "~3.8.8", + "event-stream": "~3.1.7", + "gulp-zip": "~2.0.2", + "gulp-tar": "~1.1.0", + "gulp-gzip": "~0.0.8", + "gulp-chmod": "~1.1.1", + "gulp-rename": "~1.2.0" + } +} \ No newline at end of file