File: mod_geoip.c

package info (click to toggle)
libapache2-mod-geoip 1.1.8-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 96 kB
  • ctags: 40
  • sloc: ansic: 341; makefile: 36; sh: 35; php: 7
file content (458 lines) | stat: -rw-r--r-- 14,931 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2004 MaxMind LLC.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        MaxMind (http://www.maxmind.com/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "MaxMind" and "GeoIP" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact support@maxmind.com.
 *
 * 5. Products derived from this software may not be called "GeoIP",
 *    nor may "MaxMind" appear in their name, without prior written
 *    permission of the MaxMind.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 */

/* geoip module
 *
 * Version 1.1.1
 *
 * This module sets an environment variable to the remote country
 * based on the requestor's IP address.  It uses the GeoIP library
 * to lookup the country by IP address.
 *
 * Copyright 2004, MaxMind LLC
 * July 12th 2004
 *
 * Initial port Contributed by Corris Randall <corris@cpan.org>
 *
 */

#include "httpd.h"
#include "http_config.h"
#include "http_protocol.h"
#include "http_log.h"
#include "ap_config.h"
#include "apr_strings.h"
#include <GeoIP.h>
#include <GeoIPCity.h>

typedef struct {
	GeoIP **gips;
	int numGeoIPFiles;
	char **GeoIPFilenames;
	int GeoIPEnabled;
	char GeoIPOutput;
	int GeoIPFlags;
	int *GeoIPFlags2;
} geoip_server_config_rec;

static const int GEOIP_NONE    = 0;
static const int GEOIP_DEFAULT = 1;
static const int GEOIP_NOTES   = 2;
static const int GEOIP_ENV     = 4;
static const int GEOIP_ALL     = 6;
static const int GEOIP_INIT    = 7;

static const int GEOIP_UNKNOWN = -1;

char dmacodestr[100];
char areacodestr[100];
char latstr[100];
char lonstr[100];
const char *netspeedstring;

module AP_MODULE_DECLARE_DATA geoip_module;

static void *create_geoip_server_config( apr_pool_t *p, server_rec *d )
{
	geoip_server_config_rec *conf = apr_pcalloc(p, sizeof(geoip_server_config_rec));
	if (!conf){
		return NULL;
	}
	
	conf->gips = NULL;
	conf->numGeoIPFiles = 0;
	conf->GeoIPFilenames = NULL;
	conf->GeoIPEnabled = 0;
	conf->GeoIPOutput = GEOIP_INIT;
	conf->GeoIPFlags = GEOIP_STANDARD;
	conf->GeoIPFlags2 = NULL;
	return (void *)conf;
}


static apr_status_t geoip_cleanup(void *cfgdata)
{
	int i;
	geoip_server_config_rec *cfg = (geoip_server_config_rec *)cfgdata;
	for (i = 0;i < cfg->numGeoIPFiles;i++){
		GeoIP_delete( cfg->gips[i] );
	}
	return APR_SUCCESS;
}


static void geoip_child_init(apr_pool_t *p, server_rec *s)
{
	geoip_server_config_rec *cfg;
	int i;

	cfg = (geoip_server_config_rec *)
		ap_get_module_config(s->module_config,  &geoip_module);

	if ( !cfg->gips ) {
		if ( cfg->GeoIPFilenames != NULL ) {
			cfg->gips = malloc(sizeof(GeoIP *) * cfg->numGeoIPFiles);
			for (i = 0;i < cfg->numGeoIPFiles;i++){
				cfg->gips[i] = GeoIP_open(cfg->GeoIPFilenames[i], (cfg->GeoIPFlags2[i] == GEOIP_UNKNOWN) ? cfg->GeoIPFlags : cfg->GeoIPFlags2[i]);
				if(!cfg->gips[i]) {
					ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "[mod_geoip]: Error while opening data file %s", cfg->GeoIPFilenames[i]);
					return;
				}
			}
		}
		else {
			cfg->gips = malloc(sizeof(GeoIP *));
			cfg->gips[0] = GeoIP_new( GEOIP_STANDARD );
			if (!cfg->gips[0]){
				ap_log_error(APLOG_MARK, APLOG_ERR, 0, s, "[mod_geoip]: Error while opening data file");
				return;
			}
			cfg->numGeoIPFiles = 1;
		}
	}


	apr_pool_cleanup_register(p, (void *)cfg, geoip_cleanup, geoip_cleanup);

}



static int geoip_post_read_request(request_rec *r)
{
	char *orgorisp;
	char *ipaddr;
	short int country_id;
	GeoIP *gip;
	const char *country_code;
	const char *country_name;

	geoip_server_config_rec *cfg;
	unsigned char databaseType;
	GeoIPRecord * gir;
	GeoIPRegion * giregion;
	int i;
	int netspeed;


	cfg = ap_get_module_config(r->server->module_config, &geoip_module);

	if ( !cfg ) 
		return DECLINED;

	if ( !cfg->GeoIPEnabled ) 
		return DECLINED;

	ipaddr = r->connection->remote_ip;

	if ( !cfg->gips ) {
		if ( cfg->GeoIPFilenames != NULL ) {
			cfg->gips = malloc(sizeof(GeoIP *) * cfg->numGeoIPFiles);
			for (i = 0;i < cfg->numGeoIPFiles;i++){
				cfg->gips[i] = GeoIP_open(cfg->GeoIPFilenames[i], (cfg->GeoIPFlags2[i] == GEOIP_UNKNOWN) ? cfg->GeoIPFlags : cfg->GeoIPFlags2[i]);
				if(!cfg->gips[i]) {
					ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server, "[mod_geoip]: Error while opening data file %s", cfg->GeoIPFilenames[i]);
					return DECLINED;
				}
			}
		}
		else {
			cfg->gips = malloc(sizeof(GeoIP *));
			cfg->gips[0] = GeoIP_new( GEOIP_STANDARD );
			if (!cfg->gips[0]){
				ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server, "[mod_geoip]: Error while opening data file");
				return DECLINED;
			}
			cfg->numGeoIPFiles = 1;
		}
	}
	for (i = 0; i < cfg->numGeoIPFiles;i++){
        	databaseType = GeoIP_database_edition(cfg->gips[i]);
		switch (databaseType){
                case GEOIP_NETSPEED_EDITION:
			netspeed = GeoIP_id_by_addr (cfg->gips[i], ipaddr);
			if (netspeed == GEOIP_UNKNOWN_SPEED) {
        	              	netspeedstring = "unknown";
      			}
                        else if (netspeed == GEOIP_DIALUP_SPEED) {
        			netspeedstring = "dialup";
      			}
      			else if (netspeed == GEOIP_CABLEDSL_SPEED) {
        			netspeedstring = "cabledsl";
      			}
      			else if (netspeed == GEOIP_CORPORATE_SPEED) {
        			netspeedstring = "corporate";
      			}
			if (cfg->GeoIPOutput & GEOIP_NOTES){
        		        apr_table_setn(r->notes,"GEOIP_NETSPEED",netspeedstring);
        		}
			if (cfg->GeoIPOutput & GEOIP_ENV){
			        apr_table_setn(r->subprocess_env,"GEOIP_NETSPEED",netspeedstring);
			}
                break;
		case GEOIP_COUNTRY_EDITION:
			/* Get the Country ID */
			country_id = GeoIP_country_id_by_addr( cfg->gips[i], ipaddr );

			/* Lookup the Code and the Name with the ID */
			country_code = GeoIP_country_code[country_id];
			country_name = GeoIP_country_name[country_id];

			if (cfg->numGeoIPFiles == 0){cfg->numGeoIPFiles = 0;}
			if (cfg->GeoIPFilenames == 0){cfg->GeoIPFilenames = 0;}
			/* Set it for our user */
			if (cfg->GeoIPOutput & GEOIP_NOTES){
			        apr_table_setn( r->notes,          "GEOIP_COUNTRY_CODE", country_code );
			        apr_table_setn( r->notes,          "GEOIP_COUNTRY_NAME", country_name );
			}
			if (cfg->GeoIPOutput & GEOIP_ENV){
				apr_table_setn( r->subprocess_env, "GEOIP_COUNTRY_CODE", country_code );
				apr_table_setn( r->subprocess_env, "GEOIP_COUNTRY_NAME", country_name );
			}
			break;
		case GEOIP_REGION_EDITION_REV0:
		case GEOIP_REGION_EDITION_REV1:
			giregion = GeoIP_region_by_name( cfg->gips[i], ipaddr);
			if (giregion != NULL){
				if (cfg->GeoIPOutput & GEOIP_NOTES){
					apr_table_set(r->notes, "GEOIP_COUNTRY_CODE", giregion->country_code);
					apr_table_set(r->notes, "GEOIP_REGION", giregion->region);
				}
				if (cfg->GeoIPOutput & GEOIP_ENV){
					apr_table_set(r->subprocess_env, "GEOIP_COUNTRY_CODE", giregion->country_code);
					apr_table_set(r->subprocess_env, "GEOIP_REGION", giregion->region);
				}
				GeoIPRegion_delete(giregion);
			}
			break;
		case GEOIP_CITY_EDITION_REV0:
		case GEOIP_CITY_EDITION_REV1:
			gir = GeoIP_record_by_addr(cfg->gips[i], ipaddr);
		if (gir != NULL) {
			sprintf(dmacodestr,"%d",gir->dma_code);
			sprintf(areacodestr,"%d",gir->area_code);
			if (cfg->GeoIPOutput & GEOIP_NOTES){
				apr_table_setn(r->notes, "GEOIP_COUNTRY_CODE", gir->country_code);
				apr_table_setn(r->notes, "GEOIP_COUNTRY_NAME", gir->country_name);
				if (gir->region != NULL){
					apr_table_set(r->notes, "GEOIP_REGION", gir->region);
				}
				if (gir->city != NULL){
					apr_table_set(r->notes, "GEOIP_CITY", gir->city);
				}
				apr_table_setn(r->notes,"GEOIP_DMA_CODE",dmacodestr);
				apr_table_setn(r->notes,"GEOIP_AREA_CODE",areacodestr);
			}
			if (cfg->GeoIPOutput & GEOIP_ENV){
				apr_table_setn(r->subprocess_env, "GEOIP_COUNTRY_CODE", gir->country_code);
				apr_table_setn(r->subprocess_env, "GEOIP_COUNTRY_NAME", gir->country_name);
				if (gir->region != NULL){
					apr_table_set(r->subprocess_env, "GEOIP_REGION", gir->region);
				}
				if (gir->city != NULL){
					apr_table_set(r->subprocess_env, "GEOIP_CITY", gir->city);
				}
				apr_table_setn(r->subprocess_env,"GEOIP_DMA_CODE",dmacodestr);
				apr_table_setn(r->subprocess_env,"GEOIP_AREA_CODE",areacodestr);
			}
			sprintf(latstr,"%f",gir->latitude);
			sprintf(lonstr,"%f",gir->longitude);
			if (cfg->GeoIPOutput & GEOIP_NOTES){
				apr_table_setn(r->notes,"GEOIP_LATITUDE",latstr);
			}
			if (cfg->GeoIPOutput & GEOIP_ENV){
				apr_table_setn(r->subprocess_env,"GEOIP_LATITUDE",latstr);
			}
			if (cfg->GeoIPOutput & GEOIP_NOTES){
				apr_table_setn(r->notes,"GEOIP_LONGITUDE",lonstr);
			}
			if (cfg->GeoIPOutput & GEOIP_ENV){
				apr_table_setn(r->subprocess_env,"GEOIP_LONGITUDE",lonstr);
			}
			if (gir->postal_code != NULL){
				if (cfg->GeoIPOutput & GEOIP_NOTES){
					apr_table_set(r->notes,"GEOIP_POSTAL_CODE",gir->postal_code);
				}
				if (cfg->GeoIPOutput & GEOIP_ENV){
					apr_table_set(r->subprocess_env,"GEOIP_POSTAL_CODE",gir->postal_code);
				}
			}
			GeoIPRecord_delete(gir);
		}			
		break;
		case GEOIP_ORG_EDITION:
			orgorisp = GeoIP_name_by_addr(cfg->gips[i],ipaddr);
			if (orgorisp != NULL){
				if (cfg->GeoIPOutput & GEOIP_NOTES){
					apr_table_setn(r->notes, "GEOIP_ORGANIZATION", orgorisp);
				}
				if (cfg->GeoIPOutput & GEOIP_ENV){
					apr_table_setn(r->subprocess_env, "GEOIP_ORGANIZATION", orgorisp);
				}
			}
			break;
		case GEOIP_ISP_EDITION:
			orgorisp = GeoIP_name_by_addr(cfg->gips[i],ipaddr);
			if (orgorisp != NULL){
				if (cfg->GeoIPOutput & GEOIP_NOTES){
					apr_table_setn(r->notes, "GEOIP_ISP", orgorisp);
				}
				if (cfg->GeoIPOutput & GEOIP_ENV){
					apr_table_setn(r->subprocess_env, "GEOIP_ISP", orgorisp);
				}
			}
			break;
		}
	}
	
	return OK;
}


static const char *set_geoip_enable(cmd_parms *cmd, void *dummy, int arg)
{
	geoip_server_config_rec *conf = (geoip_server_config_rec *)
	ap_get_module_config(cmd->server->module_config, &geoip_module);

	if (!conf)
		return "mod_geoip: server structure not allocated";


	conf->GeoIPEnabled = arg;
	return NULL;
}


static const char *set_geoip_filename(cmd_parms *cmd, void *dummy, const char *filename,const char *arg2)
{
	int i;
	geoip_server_config_rec *conf = (geoip_server_config_rec *)
		ap_get_module_config(cmd->server->module_config, &geoip_module);

	if ( ! filename )
		return NULL;

	i = conf->numGeoIPFiles;
	conf->numGeoIPFiles++;
	conf->GeoIPFilenames = realloc(conf->GeoIPFilenames, conf->numGeoIPFiles * sizeof(char *));
	conf->GeoIPFilenames[i] = (char *)apr_pstrdup(cmd->pool,filename);
	conf->GeoIPFlags2 = realloc(conf->GeoIPFlags2, conf->numGeoIPFiles * sizeof(int));
	if (arg2 == NULL){
		conf->GeoIPFlags2[i] = GEOIP_UNKNOWN;
	} else if (!strcmp(arg2, "Standard")){
		conf->GeoIPFlags2[i] = GEOIP_STANDARD;
	} else if (!strcmp(arg2, "MemoryCache")){
		conf->GeoIPFlags2[i] = GEOIP_MEMORY_CACHE;
	} else if (!strcmp(arg2, "CheckCache")){
		conf->GeoIPFlags2[i] = GEOIP_CHECK_CACHE;
	} else if (!strcmp(arg2, "IndexCache")){
		conf->GeoIPFlags2[i] = GEOIP_INDEX_CACHE;
	}
	return NULL;
}

static const char *set_geoip_output(cmd_parms *cmd, void *dummy,const char *arg) {
       	geoip_server_config_rec *cfg = (geoip_server_config_rec *) ap_get_module_config(cmd->server->module_config, &geoip_module);
  	if (cfg->GeoIPOutput & GEOIP_DEFAULT) {
    		/* was set to default, clear so can be reset with user specified values */
    		cfg->GeoIPOutput = GEOIP_NONE;
  	}
  	if (!strcmp(arg, "Notes")) {
   	 	cfg->GeoIPOutput |= GEOIP_NOTES;
  	} else if (!strcmp(arg, "Env")) {
    		cfg->GeoIPOutput |= GEOIP_ENV;
  	} else if (!strcmp(arg, "All")) {
    		cfg->GeoIPOutput |= GEOIP_ALL;
  	}
  	return NULL;
}

static void *make_geoip(apr_pool_t *p, server_rec *d)
{
	geoip_server_config_rec *dcfg;

	dcfg = (geoip_server_config_rec *) apr_pcalloc(p, sizeof(geoip_server_config_rec));
	dcfg->gips = NULL;
	dcfg->numGeoIPFiles = 0;
	dcfg->GeoIPFilenames = NULL;
	dcfg->GeoIPEnabled = 0;
	dcfg->GeoIPOutput = GEOIP_INIT;
	dcfg->GeoIPFlags = GEOIP_STANDARD;
	dcfg->GeoIPFlags2 = NULL;
	return dcfg;
}


static const command_rec geoip_cmds[] = 
{
	AP_INIT_FLAG( "GeoIPEnable", set_geoip_enable,   NULL, OR_FILEINFO, "Turn on mod_geoip"),
	AP_INIT_TAKE12("GeoIPDBFile", set_geoip_filename, NULL, OR_FILEINFO, "Path to GeoIP Data File"),
	AP_INIT_ITERATE("GeoIPOutput", set_geoip_output, NULL, OR_FILEINFO, "Specify output method(s)"),
	{NULL}
};


static void geoip_register_hooks(apr_pool_t *p)
{
	ap_hook_post_read_request( geoip_post_read_request, NULL, NULL, APR_HOOK_MIDDLE );
	ap_hook_child_init(        geoip_child_init,        NULL, NULL, APR_HOOK_MIDDLE );
}


/* Dispatch list for API hooks */
module AP_MODULE_DECLARE_DATA geoip_module = {
	STANDARD20_MODULE_STUFF, 
	NULL,                        /* create per-dir    config structures */
	NULL,                        /* merge  per-dir    config structures */
	make_geoip,                  /* create per-server config structures */
	NULL,                        /* merge  per-server config structures */
	geoip_cmds,                  /* table of config file commands       */
	geoip_register_hooks         /* register hooks                      */
};