<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;

]>

<!-- Module User's Guide -->

<chapter>

    <title>&adminguide;</title>

    <section>
	<title>Overview</title>
	<para>
		This module allows real-time queries against the Max Mind GeoIP2
		database to be performed from the config script.
	</para>
	<para>
		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.
	</para>
	<para>
		This database itself can be obtained on a free or commercial basis
		from <ulink url="http://dev.maxmind.com/geoip/">
		http://dev.maxmind.com/geoip/</ulink>. 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
		<ulink url="http://dev.maxmind.com/geoip/geoip2/downloadable/">
		http://dev.maxmind.com/geoip/geoip2/downloadable/</ulink>.
	</para>
	<para>
		This module exports a new class of pseudo-variables -
		$gip2(pvc=&gt;key) - to enable access to the results of a query to the
		database.
	</para>
	<para>
		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 <quote>move</quote> command.
	</para>
    </section>
    <section>
	<title>Dependencies</title>
	<section>
	    <title>&kamailio; Modules</title>
	    <para>
		The following modules must be loaded before this module:
	    	<itemizedlist>
		    <listitem>
			<para>
			    <emphasis>none</emphasis>.
			</para>
		    </listitem>
	    	</itemizedlist>
	    </para>
	</section>
	<section>
	    <title>External Libraries or Applications</title>
	    <para>
		The following libraries or applications must be installed before running
		&kamailio; with this module loaded:
	    	<itemizedlist>
		    <listitem>
			<para>
			    <emphasis>libmaxminddb</emphasis> - the GeoIP2 library.
			</para>
		    </listitem>
	    	</itemizedlist>
	    </para>
	</section>
    </section>
    <section>
	<title>Parameters</title>
	<section id="geoip2.p.path">
	    <title><varname>path</varname> (string)</title>
	    <para>
		Path to the GeoIP2 database file.
	    </para>
	    <para>
		<emphasis>
		    Default value is <quote>null</quote>.
		</emphasis>
	    </para>
	    <example>
		<title>Set <varname>path</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("geoip2", "path", "/usr/local/share/GeoIP/GeoLite2-City.mmdb")
...
</programlisting>
	    </example>
	</section>
	<section id="geoip2.p.resid">
	    <title><varname>resid</varname> (str)</title>
	    <para>
		Preregister result container id during initialization, enabling the use
		of the module in KEMI scripts. In native &kamailio;.cfg file, registration
		is done when parsing config and finding variables.
	    </para>
	    <para>
		<emphasis>
		    Default value is <quote></quote> (empty).
		</emphasis>
	    </para>
	    <example>
		<title>Set <varname>resid</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("geoip2", "resid", "src")
...
if(geoip2_match("$si", "src")) {
   ...
}
...
</programlisting>
	    </example>
	</section>
	</section>

    <section>
	<title>Functions</title>
 	<section>
	    <title>
		<function moreinfo="none">geoip2_match(ipaddr, pvc)</function>
	    </title>
	    <para>
			Match ipaddr against the GeoIP database and set the pvc container. The
			function has to be called before accessing a key via: $gip2(pvc=&gt;key).
			At least one function needs to be present that access the pvc container,
			otherwise this function will not work.
	    </para>
		<example>
		<title><function>geoip2_match</function> usage</title>
		<programlisting format="linespecific">
...
if(geoip2_match("$si", "src"))
    xlog("SIP message from: $gip2(src=&gt;cc)\n");
...
</programlisting>
	    </example>
	</section>

    </section>

    <section>
	<title>RPC Commands</title>
	<section id="geoip2.r.reload">
	   <title>
		<function moreinfo="none">geoip2.reload</function>
	   </title>
	   <para>
			Reload the internal GeoIP database. This is necessary after
			the database file has been changed on the disk.
	   </para>
		<example>
		<title><function>geoip2.reload</function> usage</title>
		<programlisting format="linespecific">
...
&kamcmd; geoip2.reload
...
		</programlisting>
		</example>
	</section>
    </section>

	<section>
		<title>Exported pseudo-variables</title>
		<itemizedlist>
			<listitem><para>
				<emphasis>$gip2(pvc=&gt;key)</emphasis> - <emphasis>pvc</emphasis> is an
				identifier for this query result;  it is designated by the second
				parameter of geoip2_match(). The <emphasis>key</emphasis> can be one of
				the following:
				</para>
			<itemizedlist>
				<listitem><para>
					<emphasis>cc</emphasis> - country code
				</para></listitem>
				<listitem><para>
					<emphasis>tz</emphasis> - time zone
				</para></listitem>
				<listitem><para>
					<emphasis>zip</emphasis> - postal code
				</para></listitem>
				<listitem><para>
					<emphasis>lat</emphasis> - latitude
				</para></listitem>
				<listitem><para>
					<emphasis>lon</emphasis> - longitude
				</para></listitem>
				<listitem><para>
					<emphasis>nmask</emphasis> - network mask (CIDR format)
				</para></listitem>
				<listitem><para>
					<emphasis>city</emphasis> - city
				</para></listitem>
				<listitem><para>
					<emphasis>regc</emphasis> - region
				</para></listitem>
				<listitem><para>
					<emphasis>regn</emphasis> - region name
				</para></listitem>
				<listitem><para>
					<emphasis>metro</emphasis> - metro code
				</para></listitem>
				<listitem><para>
					<emphasis>contc</emphasis> - continent code
				</para></listitem>
			</itemizedlist>
			</listitem>
		</itemizedlist>
		<para>
		Exported pseudo-variables are documented at &kamwikilink;.
		</para>
	</section>

</chapter>

