Автоопределение города пользователя на основе GeoIP - версия 2.0

22 декабря 2011 г.

Предлагаю вашему вниманию обновленную версия дополнения для HostCMS, для определения региона пользователя с помощью GeoIP-сервиса ipgeobase.ru.

Задача по-прежнему та же - определить город, регион и страну пользователя и подставить их в форму ввода адреса, так чтобы пользователю осталось только вписать улицу-дом-квартиру.

Ключевые отличия второй версии от первой:

Полностью переписан класс для работы с сервисом ipgeobase.ru
Реализована поддержка нового XML-PRC сервиса, работающего с GET-запросами (подробнее см. в новостях сервиса ipgeopbase.ru)
База данных сервиса проанализирована на предмет соответствия справочнику городов и регионов в HostCMS. Повышена точность определения города - ранее, если города с одинаковыми названиями встречались в различных регионах, то в ряде случаев в форме адреса подставлялся город не из того региона, в котором находится пользователь, а из одноименного города в другом регионе. Теперь эта ошибка исключена.
Изменен формат результата, возвращаемого классом при определении. В 1й версии класс возвращал название города в виде строки, либо false. Во 2й версии класс возвращает массив идентификаторов города, региона и области, либо false. Массив содержит элементы city, location и country, хранящие идентификаторы города, региона и страны по справочнику HostCMS соответствнно.

Установка и использование

Код класса приведен в файле geoip2.class.php который необходимо разместить в папке /modules/ системы.

Класс подключается в коде ТДС "Интернет-магазин Корзина". Необходимо найти фрагмент, в котором вызывается метод ShowAddress() и заменить его вызов следующим кодом:

        /** Kotoff - Здесь начинается вставка кода для GeoIP v2 **/

        // Определяем город пользователя

        // подключим файл класса
        @include_once (CMS_FOLDER . 'modules/geoip2.class.php');

        if(class_exists('GeoIp'))
        {
            // создадим экземпляр объекта GeoIp
            $geoIp = new GeoIp;

            // Определим IP пользователя
            $user_ip = ($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : getenv("HTTP_X_FORWARDED_FOR");

            // определим город, регион и страну по IP-адресу
            // метод возвращает массив или false
            $geoData = $geoIp->GetLocation($user_ip);
        }

        if (isset($geoData) && is_array($geoData)) {
            // если удалось определить город пользователя,
            // то передадим его город, область и страну в XML
            $external_propertys['city_id'] = $geoData['city'];
            $external_propertys['location_id'] = $geoData['location'];
            $external_propertys['country_id'] = $geoData['country'];
            // включим передачу в XML информацию обо всех странах, регионах, городах
            $show = true;
        } else {
            // Не выбираем show_location, show_city и show_city_area, т.к. подгружаются через AJAX
            $show = false;
        }

        /* Отображаем форму ввода адреса */
        $shop->ShowAddress(to_str($GLOBALS['LA']['xsl_delivery_address']), $shop_id,
            array('show_location' => $show, 'show_city' => $show, 'show_city_area' => $show),
            $external_propertys);

        /** Kotoff - Здесь заканчивается вставка кода для GeoIP v2 **/

Файл kod_TDS_Internet-Magazin_Korzina.php представляет собой код ТДС "Интернет-магазин Корзина" от HostCMS версии 5.9.32 со вставленным кодом для определения города пользователя по GeoIP. Вы можете воспользоваться этим файлом.

Теперь необходимо обновить XSL-шаблон, отображающий форму ввода адреса доставки. В файле MagazinAdresDostavki.xsl содержится доработанный код XSL-шаблона "МагазинАдресДоставки", основанный на одноименном стандартном шаблоне от HostCMS версии 5.9.32

XSL-шаблон для новой версии GeoIP-дополнения не изменился, и если вы ранее использовали первую версию модуля, то вам нет необходимости обновлять XSL-шаблон или вносить в него какие-либо изменения.

После этого вы можете тестировать определение города. При правильной работе модуля, в момент отображения формы для ввода адреса доставки, в выпадающих списках автоматически будут выбраны страна, регион и город пользователя.

О точности определения

Точность определения города не зависит ни от работы модуля, ни от его автора. Вся информация о соответствии города и IP-адреса пользователя предоставляется сервисом ipgeobase.ru и если ваш город определяется неверно, то вам следует обратиться в службу поддержки этого сервиса.

Где взять?

Репозитарий новой версии дополнения размещен по адресу https://bitbucket.org/JamesKotov/geoip-v2-for-hostcms-v5/ там можно всегда скачать архив с последней версией, следить за изменениями и выходами апдейтов, а в разделе wiki можно прочитать самую последнюю версию инструкции по установке.

Желаю всем точных определений!