Merge branch 'MDL-36941_master-fix' of git://github.com/markn86/moodle
[moodle.git] / iplookup / lib.php
CommitLineData
b9ee1fc7
PS
1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * IP Lookup utility functions
20 *
21 * @package core
22 * @subpackage iplookup
23 * @copyright 2010 Petr Skoda {@link http://skodak.org}
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 */
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Returns location information
31 * @param string $ip
32 * @return array
33 */
34function iplookup_find_location($ip) {
35 global $CFG;
36
37 $info = array('city'=>null, 'country'=>null, 'longitude'=>null, 'latitude'=>null, 'error'=>null, 'note'=>'', 'title'=>array());
38
3fad0f1a
DP
39 if (!empty($CFG->geoip2file) and file_exists($CFG->geoip2file)) {
40 $reader = new GeoIp2\Database\Reader($CFG->geoip2file);
41 $record = $reader->city($ip);
b9ee1fc7 42
3fad0f1a 43 if (empty($record)) {
b9ee1fc7
PS
44 $info['error'] = get_string('iplookupfailed', 'error', $ip);
45 return $info;
46 }
b9ee1fc7 47
3fad0f1a
DP
48 $info['city'] = core_text::convert($record->city->name, 'iso-8859-1', 'utf-8');
49 $info['title'][] = $info['city'];
64b0f3ab 50
3fad0f1a
DP
51 $countrycode = $record->country->isoCode;
52 $countries = get_string_manager()->get_list_of_countries(true);
53 if (isset($countries[$countrycode])) {
54 // Prefer our localized country names.
55 $info['country'] = $countries[$countrycode];
56 } else {
57 $info['country'] = $record->country->names['en'];
b9ee1fc7 58 }
3fad0f1a 59 $info['title'][] = $info['country'];
64b0f3ab 60
3fad0f1a
DP
61 $info['longitude'] = $record->location->longitude;
62 $info['latitude'] = $record->location->latitude;
b9ee1fc7
PS
63 $info['note'] = get_string('iplookupmaxmindnote', 'admin');
64
65 return $info;
66
67 } else {
68 require_once($CFG->libdir.'/filelib.php');
69
3fad0f1a
DP
70 if (strpos($ip, ':') !== false) {
71 // IPv6 is not supported by geoplugin.net.
72 $info['error'] = get_string('invalidipformat', 'error');
73 return $info;
74 }
75
8c6136a8
PS
76 $ipdata = download_file_content('http://www.geoplugin.net/json.gp?ip='.$ip);
77 if ($ipdata) {
78 $ipdata = preg_replace('/^geoPlugin\((.*)\)\s*$/s', '$1', $ipdata);
79 $ipdata = json_decode($ipdata, true);
b9ee1fc7 80 }
8c6136a8
PS
81 if (!is_array($ipdata)) {
82 $info['error'] = get_string('cannotgeoplugin', 'error');
b9ee1fc7
PS
83 return $info;
84 }
8c6136a8
PS
85 $info['latitude'] = (float)$ipdata['geoplugin_latitude'];
86 $info['longitude'] = (float)$ipdata['geoplugin_longitude'];
87 $info['city'] = s($ipdata['geoplugin_city']);
88
89 $countrycode = $ipdata['geoplugin_countryCode'];
90 $countries = get_string_manager()->get_list_of_countries(true);
91 if (isset($countries[$countrycode])) {
92 // prefer our localized country names
93 $info['country'] = $countries[$countrycode];
94 } else {
95 $info['country'] = s($ipdata['geoplugin_countryName']);
b9ee1fc7 96 }
b9ee1fc7 97
8c6136a8 98 $info['note'] = get_string('iplookupgeoplugin', 'admin');
b9ee1fc7 99
8c6136a8 100 $info['title'][] = $info['city'];
64b0f3ab 101 $info['title'][] = $info['country'];
b9ee1fc7
PS
102
103 return $info;
104 }
105
8c6136a8 106}