The cl-geoip Reference Manual

Table of Contents

The cl-geoip Reference Manual

This is the cl-geoip Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:14:29 2020 GMT+0.

1 Introduction

cl-geoip

A simple cffi-wrapper around some basic functionality of libGeoIP as provided by the debian package http://packages.debian.org/wheezy/libgeoip-dev (original source http://www.maxmind.com). I only implemented the functionality I actually need, and released it since it might be useful for other people. If anybody needs more functionality, patches are welcome!

I tested this under SBCL, Linux x64.

Copyright

Copyright (C) 2013 (let ((n "Christoph-Simon Senjak")) #| |#
 (format nil "~A <~C~C~C~C~A>" n (elt n 0) (elt n 10) (elt n 16)
 #\@ "uxul.de"))

This program is free software. It comes without any warranty, to
the extent permitted by applicable law. You can redistribute it
and/or modify it under the terms of the Do What The Fuck You Want
To Public License, Version 2, as published by Sam Hocevar. See
http://www.wtfpl.net/ for more details.

Usage

Under Debian/Ubuntu, the packages libgeoip-dev and geoip-database should provide the necessary files to get started.

Before we can use the databases, they have to be initialized using open-databases, which wants two file names, one for the IPv4 and one fore the IPv6 database. Under Debian/Ubuntu, the following should be correct:

(geoip:open-databases "/usr/share/GeoIP/GeoIP.dat"
                      "/usr/share/GeoIP/GeoIPv6.dat")

After that, you should be able to find Country-Codes for IP-Strings using get-country-code. If it is not found, NIL is returned:

  CL-USER> (geoip:get-country-code "188.40.170.99")
  "DE"
  CL-USER> (geoip:get-country-code "2a01:4f8:101:281:7ad5:1003:0:1")
  "DE"
  CL-USER> (geoip:get-country-code "some clusterfuck")
  NIL

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-geoip

Author

(let ((n "Christoph-Simon Senjak")) (format nil "~A ~ <~C~C~C~C~A>

License

WTFPL 2.0

Description

Wrapper around libGeoIP

Dependency

cffi

Source

cl-geoip.asd (file)

Component

geoip.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-geoip.asd

Location

cl-geoip.asd

Systems

cl-geoip (system)

3.1.2 cl-geoip/geoip.lisp

Parent

cl-geoip (system)

Location

geoip.lisp

Packages

geoip

Exported Definitions

• get-country-code (function)
• open-databases (function)

Internal Definitions

• *ip4-db* (special variable)
• *ip6-db* (special variable)
• geoip-country-code-by-addr (function)
• geoip-country-code-by-addr-v6 (function)
• geoip-open (function)

4 Packages

Packages are listed by definition order.

4.1 geoip

Source

geoip.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• get-country-code (function)
• open-databases (function)

Internal Definitions

• *ip4-db* (special variable)
• *ip6-db* (special variable)
• geoip-country-code-by-addr (function)
• geoip-country-code-by-addr-v6 (function)
• geoip-open (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: get-country-code IP

Package

geoip

Source

geoip.lisp (file)

Function: open-databases IP4 IP6

Package

geoip

Source

geoip.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *ip4-db*

Package

geoip

Source

geoip.lisp (file)

Special Variable: *ip6-db*

Package

geoip

Source

geoip.lisp (file)

5.2.2 Functions

Function: geoip-country-code-by-addr DATABASE IP-4

Package

geoip

Source

geoip.lisp (file)

Function: geoip-country-code-by-addr-v6 DATABASE IP-6

Package

geoip

Source

geoip.lisp (file)

Function: geoip-open FILENAME FLAGS

Package

geoip

Source

geoip.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types