# &adminguide;

## Overview

This module allows real-time queries against the Max Mind GeoIP2 database to be performed from the config script.

The Max Mind GeoIP2 database is a map of IP network address assignments to geographical locales that can be useful -- though approximate -- in identifying the physical location with which an IP host address is associated on a relatively granular level.

This database itself can be obtained on a free or commercial basis from http://dev.maxmind.com/geoip/. The library libmaxminddb that interfaces with the Max Mind API, as well as scripts to automate downloading of the on-disk version are available at http://dev.maxmind.com/geoip/geoip2/downloadable/.

This module exports a new class of pseudo-variables - $gip2(pvc=>key) - to enable access to the results of a query to the database.

Many queries can be done and store results in different containers to be able to use in parallel. Database is loaded at startup in cache. The cache can be reloaded with an RPC command. In this case make sure that you do not overwrite the file in place, but replace it, e.g. with a move command.

## Dependencies

### &kamailio; Modules

The following modules must be loaded before this module:

- none.

### External Libraries or Applications

The following libraries or applications must be installed before running &kamailio; with this module loaded:

- libmaxminddb - the GeoIP2 library.

## Parameters

### `path` (string)

Path to the GeoIP2 database file.

Default value is null.

#### Set `path` parameter

    ...
    modparam("geoip2", "path", "/usr/local/share/GeoIP/GeoLite2-City.mmdb")
    ...

### `resid` (str)

Preregister result container id during initialization, enabling the use of the module in KEMI scripts. In native &kamailioconfig; file, registration is done when parsing config and finding variables.

Default value is (empty).

#### Set `resid` parameter

    ...
    modparam("geoip2", "resid", "src")
    ...
    if(geoip2_match("$si", "src")) {
       ...
    }
    ...

## Functions

### `geoip2_match(ipaddr, pvc)`

Match ipaddr against the GeoIP database and set the pvc container. The function has to be called before accessing a key via: $gip2(pvc=>key). At least one function needs to be present that access the pvc container, otherwise this function will not work.

#### `geoip2_match` usage

    ...
    if(geoip2_match("$si", "src"))
        xlog("SIP message from: $gip2(src=>cc)\n");
    ...

### `geoip2_distance(ip_addr, latitude, longitude)`

The function calculates the distance in miles between the geocoordinates of the IP address passed as parameter (the coordinates are calculated inside the function) and the geocoordinates latitude and longitude

#### `geoip2_distance` usage

    ...
    	$var(client_ip) = "109.184.18.64";
    	$var(lat_pos) = "53.200660";
    	$var(lon_pos) = "45.004640";
    	$var(dist) = geoip2_distance($var(client_ip), $var(lat_pos), $var(lon_pos));

    	xlog("distance is $var(dist)\n");
    ...

## RPC Commands

### `geoip2.reload`

Reload the internal GeoIP database. This is necessary after the database file has been changed on the disk.

#### `geoip2.reload` usage

    ...
    &kamctl; rpc geoip2.reload
    ...

## Exported pseudo-variables

- $gip2(pvc=>key) - pvc is an identifier for this query result; it is designated by the second parameter of geoip2_match(). The key can be one of the following:

  - cc - country code

  - tz - time zone

  - zip - postal code

  - lat - latitude

  - lon - longitude

  - nmask - network mask (CIDR format)

  - city - city

  - regc - region

  - regn - region name

  - metro - metro code

  - contc - continent code

Exported pseudo-variables are documented at &kamwikilink;.