EXT: dmc_geoIP¶

What does it do?¶

The dmc_geoIP extension uses the free database by MaxMind to determine the country of residence for visitors based on their IP address.

The extension will make sure every visitor browses the correct rootpage tree for his country of residence. So for example certain pagetrees can be denied to users from specified countries.

Users manual¶

The dmc_geoIP extension is an include only extension and provides no GUI whatsoever.

detailed workflow¶

The dmc_geoIP extension is included as library upon every pagerequest.

So on every page request the extension tries to find the country of residence for the requesting IP.

If the country can be determined – the IP is found in the MaxMind geoIP database – the extension reads its TypoScript configuration and looks for a pageID configured for the country determined in step 1.

If a (root) pageID is configured for the country of residence the extension checks whether the currently requested page lies within the rootline of the pageID found in step 2. If that is the case no action is performed.

If the currently requested page does not lie in the rootline found in step 2 – and thus the currently requested page is invalid – a Location Redirect header is sent ot the browser with the appropriate root pageID. No redirection will be performed if the extension is configured not to do so (see below).

Configuring country rootpages¶

Currently the most important option to configure the dmc_geoIP extension is to provide pageIDs of rootpages within the Typo3 pagetree for certain country ISOCodes. This is done via TypoScript setup

modules.tx_dmc_geoip {
             country.rootpages {
                     US = 45
               DE = 1241
             }
     }

Configuring the ISOType¶

Other than the two-letter ISO 3166 standard (which is used by Typo3) the dmc_geoIP extension can be configured to request three-letter ISOCodes (US becomes USA, DE becomes DEU, etc).

modules.tx_dmc_geoip {
             isoType = 3166-3
     }

disabling redirects¶

It might be useful to have the dmc_geoIP extension determine the country of residence for your visitors, but still allowing everybody to see everything. If thats the case the extension must be configured in such a way that no redirect is performed. This can be done as follows:

modules.tx_dmc_geoip {
             redirect = 0
     }

Reference¶

The MaxMind geoIP country database¶

The dmc_geoIP extension relies on the geoIP country database from MaxMind, available freely on http://www.maxmind.com

The database is licensed under the open data license.

The database is updated on a regular basis, so a cronjob should be configured to download the current database once in a while. This is the only way to make sure the IP to country mapping of the dmc_geoIP extension is always up to date and generates as much correct results as possible.

As of now the most recent geoIP database can be obtained here:

http://www.maxmind.com/download/geoip/database/geoIP.dat.gz

It has to be installed into the 'geodata' subdirectory of the extension directory.

MaxMind also provides a free PHP library licensed under LGPL that accesses that database. The dmc_geoIP extension already comes with that PHP library. It is the original code as provided by MaxMind. The only addition that has been made is the function geoip_countrycode3_by_addr() which maps an IP to a three-letter ISO 3166 code. The library can be found in the 'lib' subdirectory of the dmc_geoIP extension.

((generated))¶