libipg.h File Reference

ipgeo library interface More...

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>

Go to the source code of this file.

Data Structures
struct	ipgeo_context
Defines
#define	LIBIPG_VERSION   "1.0"
#define	LIBIPG_BIG_ENDIAN   1
#define	IPGEO_BUF_SIZE   512
#define	IPGEO_ERRBUF_SIZE   256
Typedefs
typedef ipgeo_context	ipgeo_t
Functions
ipgeo_t *	ipgeo_init (char *file, u_int8_t flags, char *err_buf)
void	ipgeo_destroy (ipgeo_t *ipg)
u_int32_t	ipgeo_ipa2ipn (char *ip)
int	ipgeo_lookup (u_int32_t ipn, u_int8_t flags, ipgeo_t *ipg)
char *	ipgeo_get_cc (ipgeo_t *ipg)
char *	ipgeo_get_country (ipgeo_t *ipg)
char *	ipgeo_get_region (ipgeo_t *ipg)
char *	ipgeo_get_city (ipgeo_t *ipg)
char *	ipgeo_get_isp (ipgeo_t *ipg)
double	ipgeo_get_lat (ipgeo_t *ipg)
double	ipgeo_get_long (ipgeo_t *ipg)
char *	ipgeo_geterror (ipgeo_t *ipg)
int	ipgeo_getfd (ipgeo_t *ipg)
int	ipgeo_getdbt (ipgeo_t *ipg)

---

Detailed Description

ipgeo library interface

Definition in file libipg.h.

---

Define Documentation

#define LIBIPG_VERSION   "1.0"

current libipg version Definition at line 82 of file libipg.h.

#define LIBIPG_BIG_ENDIAN   1

libipg works with multibyte numbers and needs to know how they're ordered Definition at line 85 of file libipg.h.

#define IPGEO_BUF_SIZE   512

internal work buffers Definition at line 88 of file libipg.h. Referenced by ipgeo_lookup().

---

Typedef Documentation

typedef struct ipgeo_context ipgeo_t

ipgeo_t is the monolithic datatype describing an ipgeo session Definition at line 110 of file libipg.h. Referenced by ipgeo_destroy(), ipgeo_get_cc(), ipgeo_get_city(), ipgeo_get_country(), ipgeo_get_isp(), ipgeo_get_lat(), ipgeo_get_long(), ipgeo_get_region(), ipgeo_getdbt(), ipgeo_geterror(), ipgeo_getfd(), ipgeo_init(), and ipgeo_lookup().

---

Function Documentation

ipgeo_t* ipgeo_init (  char *  file, u_int8_t  flags, char *  err_buf )

only CSV db type currently supported control flags are currently undefined Definition at line 49 of file libipg_init.c. References ipgeo_context::db, ipgeo_context::dbt, ipgeo_context::flags, and ipgeo_t. { ipgeo_t *ipg = NULL; ipg = (ipgeo_t *)malloc(sizeof (ipgeo_t)); if (ipg == NULL) { snprintf(err_buf, IPGEO_ERRBUF_SIZE, "malloc(): %s\n", strerror(errno)); goto bad; } memset(ipg, 0, sizeof (ipg)); ipg->db = fopen(file, "r"); if (ipg->db == NULL) { snprintf(err_buf, IPGEO_ERRBUF_SIZE, "fopen() (%s): %s\n", file, strerror(errno)); goto bad; } ipg->dbt = 6; ipg->flags = flags; return (ipg); bad: if (ipg) { if (ipg->db) { fclose(ipg->db); } free (ipg); } return (NULL); }

void ipgeo_destroy (  ipgeo_t *  ipg  )

Shuts down the libipg session and frees all memory referenced by ipg. Parameters: ipg  pointer to a ipgeo context Definition at line 91 of file libipg_init.c. References ipgeo_context::db, and ipgeo_t. { if (ipg) { if (ipg->db) { fclose(ipg->db); } free (ipg); } }

u_int32_t ipgeo_ipa2ipn (  char *  ip  )

currently we don't deal with hostnames; ip has to be dots n decimals compute first byte (256^3 * o1) compute second byte (256^2 * o2) compute third byte (256 * o3) compute fourth byte (o4) Definition at line 50 of file libipg_lookup.c. { char *p = ip; u_int32_t o1, o2, o3, o4; if (!isdigit(ip[0])) { return (0); } o1 = 16777216 * atol(strsep(&p, ".")); o2 = 65536 * atol(strsep(&p, ".")); o3 = 256 * atol(strsep(&p, ".")); o4 = atol(strsep(&p, ".")); return (o1 + o2 + o3 + o4); }

int ipgeo_lookup (  u_int32_t  ipn, u_int8_t  flags, ipgeo_t *  ipg )

Performs a lookup into the ipg database for the given IPv4 number. If successful, the funcion will fill in internal libipg structure members with location information specific to the queried IPv4 address. Currently libipg supports Country Code, Country, Region, City and ISP information. Depending on the IPv4 number queried; none, some or all of this information may be returned. Currently the only db access method is a linear search through the ASCII CSV file. Expect this to change shortly in favor of something faster, along the lines of O(ln n) or so. The database has over 95% accuracy at the Country and ISP level, 70% at the regional level and 65% at the city level, which, according to the IP2LOCATION documentation, is the highest accuracy available. The country-level inaccuracy is due to dynamic IP address allocation by large ISPs such as AOL and MSN TV. AOL, for example, uses a network that routes all of their Internet traffic through Reston, Virginia. As such, all IP-based geo-location databases are unable to determine the state and city for computers on the AOL network. The regional and country level inaccuracy is due to the flexibility given to each ISP to reassign dynamic IP addresses within their service areas. Parameters: ipn  a network byte ordered IPv4 number, as returned by a function like ipgeo_ipa2ipn() or libnet_name2addr4(). After a successful call to ipgeo_lookup(), one or more calls to ipgeo_get_cc(), ipgeo_get_country(), ipgeo_get_region(), ipgeo_get_city(), and/or ipgeo_get_isp() may be made to obtain lookup information. flags  lookup parameters, or 0 for default ipg  pointer to a ipgeo context Returns: 1 on success, -1 on error Definition at line 77 of file libipg_lookup.c. References ipgeo_context::cc, ipgeo_context::city, ipgeo_context::country, ipgeo_context::db, IPGEO_BUF_SIZE, ipgeo_t, ipgeo_context::isp, ipgeo_context::latitude, ipgeo_context::longitude, and ipgeo_context::region. { int n; char *p, *q; u_int32_t min, max; char buf[IPGEO_BUF_SIZE]; if (ipg == NULL) { return (-1); } #if (LIBIPG_LIL_ENDIAN) ipn = htonl(ipn); #endif /* perform a linear search through the CSV file */ for (; fgets(buf, IPGEO_BUF_SIZE - 1, ipg->db); ) { if (buf[0] == '#') { /* ignore comments */ continue; } p = buf; /* step over quote */ p += 1; min = strtoul(strsep(&p, ","), (char **)NULL, 10); /* step over quote */ p += 1; max = strtoul(strsep(&p, ","), (char **)NULL, 10); if (ipn >= min && ipn <= max) { p += 1; q = strsep(&p, ","); for (n = 0; n < sizeof(ipg->cc) - 1; n++) { if (q[n] == '"') { ipg->cc[n] = NULL; break; } ipg->cc[n] = q[n]; } /* get cc */ p += 1; q = strsep(&p, ","); for (n = 0; n < sizeof(ipg->country) - 1; n++) { if (q[n] == '"') { ipg->country[n] = NULL; break; } ipg->country[n] = q[n]; } /* get country */ p += 1; q = strsep(&p, ","); for (n = 0; n < sizeof(ipg->region) - 1; n++) { if (q[n] == '"') { ipg->region[n] = NULL; break; } ipg->region[n] = q[n]; } /* get city */ p += 1; q = strsep(&p, ","); for (n = 0; n < sizeof(ipg->city) - 1; n++) { if (q[n] == '"') { ipg->city[n] = NULL; break; } ipg->city[n] = q[n]; } /* get latitude */ p += 1; ipg->latitude = strtod(strsep(&p, ","), (char **)NULL); /* get longitude */ p += 1; ipg->longitude = strtod(strsep(&p, ","), (char **)NULL); /* get isp */ p += 1; q = strsep(&p, ","); for (n = 0; n < sizeof(ipg->isp) - 1; n++) { if (q[n] == '"') { ipg->isp[n] = NULL; break; } ipg->isp[n] = q[n]; } rewind(ipg->db); return (1); } } /* no match */ return (0); }

char* ipgeo_get_cc (  ipgeo_t *  ipg  )

Returns the country code for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the country code on success, NULL on error Definition at line 195 of file libipg_lookup.c. References ipgeo_context::cc, and ipgeo_t. { if (ipg->cc[0] == '-') { return("UNKNOWN"); } return (ipg->cc); }

char* ipgeo_get_country (  ipgeo_t *  ipg  )

Returns the country for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the country code on success, NULL on error Definition at line 205 of file libipg_lookup.c. References ipgeo_context::country, and ipgeo_t. { if (ipg->country[0] == '-') { return("UNKNOWN"); } return (ipg->country); }

char* ipgeo_get_region (  ipgeo_t *  ipg  )

Returns the region for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the country code on success, NULL on error Definition at line 215 of file libipg_lookup.c. References ipgeo_t, and ipgeo_context::region. { if (ipg->region[0] == '-') { return("UNKNOWN"); } return (ipg->region); }

char* ipgeo_get_city (  ipgeo_t *  ipg  )

Returns the city for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the country code on success, NULL on error Definition at line 225 of file libipg_lookup.c. References ipgeo_context::city, and ipgeo_t. { if (ipg->city[0] == '-') { return("UNKNOWN"); } return (ipg->city); }

char* ipgeo_get_isp (  ipgeo_t *  ipg  )

Returns the isp for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the country code on success, NULL on error Definition at line 235 of file libipg_lookup.c. References ipgeo_t, and ipgeo_context::isp. { if (ipg->isp[0] == '-') { return("UNKNOWN"); } return (ipg->isp); }

double ipgeo_get_lat (  ipgeo_t *  ipg  )

Returns the latitude for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the latitude on success, 0 on error Definition at line 245 of file libipg_lookup.c. References ipgeo_t, and ipgeo_context::latitude. { return (ipg->latitude); }

double ipgeo_get_long (  ipgeo_t *  ipg  )

Returns the longitude for the most recent ipgeo db lookup. The function must be called after a successful call to ipgeo_lookup(). Parameters: ipg  pointer to a ipgeo context Returns: the longitude on success, 0 on error Definition at line 251 of file libipg_lookup.c. References ipgeo_t, and ipgeo_context::longitude. { return (ipg->longitude); }

char* ipgeo_geterror (  ipgeo_t *  ipg  )

Returns the last error set inside of the referenced libipg context. This function should be called anytime a function fails or an error condition is detected inside of libipg. Parameters: ipg  pointer to a libipg context Returns: an error string or NULL if no error has occured Definition at line 104 of file libipg_init.c. References ipgeo_context::err_buf, and ipgeo_t. { return (ipg->err_buf); }

int ipgeo_getfd (  ipgeo_t *  ipg  )

we should not return -1 here since any error should be caught during initialization Definition at line 120 of file libipg_init.c. References ipgeo_context::db, and ipgeo_t. { if (ipg == NULL || ipg->db == NULL) { return (-1); } return (fileno(ipg->db)); }

int ipgeo_getdbt (  ipgeo_t *  ipg  )

Returns the type of IP2LOCATION db libipg has open. Parameters: ipg  pointer to a ipgeo context Returns: the type of db open Definition at line 110 of file libipg_init.c. References ipgeo_context::db, ipgeo_context::dbt, and ipgeo_t. { if (ipg == NULL || ipg->db == NULL) { return (-1); } return (ipg->dbt); }

---