]>
git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - config/cfgroot/location-functions.pl
2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2021 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 2 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
22 package Location
::Functions
;
26 # Hash which contains country codes and their names which are special or not
28 my %not_iso_3166_location = (
29 "A1" => "Anonymous Proxy",
30 "A2" => "Satellite Provider",
31 "A3" => "Worldwide Anycast Instance",
32 "XD" => "Hostile networks safe to drop",
35 # Hash which contains possible network flags and their mapped location codes.
37 "LOC_NETWORK_FLAG_ANONYMOUS_PROXY" => "A1",
38 "LOC_NETWORK_FLAG_SATELLITE_PROVIDER" => "A2",
39 "LOC_NETWORK_FLAG_ANYCAST" => "A3",
40 "LOC_NETWORK_FLAG_DROP" => "XD",
43 # Array which contains special country codes.
44 my @special_locations = ( "A1", "A2", "A3", "XD" );
46 # Directory where the libloc database and keyfile lives.
47 our $location_dir = "/var/lib/location";
49 # Libloc database file.
50 our $database = "$location_dir/database.db";
52 # Libloc keyfile to verify the database.
53 our $keyfile = "$location_dir/signing-key.pem";
55 # Directory which contains the exported databases.
56 our $ipset_db_directory = "$location_dir/ipset";
58 # Create libloc database handle.
59 my $db_handle = &init
();
62 ## Tiny function to init the location database.
65 # Init and open the database.
66 my $db = &Location
::init
($database);
68 # Return the database handle.
73 ## Function to verify the integrity of the location database.
78 # Verify the integrity of the database.
79 if(&Location
::verify
($db_handle, $keyfile)) {
80 # Success, return "1".
84 # If we got here, return nothing.
89 ## Function to get the country code of a given address.
91 sub lookup_country_code
($$) {
94 # Lookup the given address.
95 my $country_code = &Location
::lookup_country_code
($db_handle, $address);
97 # Return the name of the country
101 # Function to get the flag icon for a specified country code.
102 sub get_flag_icon
($) {
105 # Webserver's root dir. (Required for generating full path)
106 my $webroot = "/srv/web/ipfire/html";
108 # Directory which contains the flag icons.
109 my $flagdir = "/images/flags";
111 # File extension of the country flags.
114 # Remove whitespaces.
117 # Convert given country code to upper case.
118 my $ccode = uc($input);
120 # Generate filename, based on the contry code in lower case
121 # and the defined file extension.
122 my $file = join('.', $ccode,$ext);
124 # Generate path inside webroot to the previously generated file.
125 my $flag_icon = join('/', $flagdir,$file);
127 # Generate absolute path to the icon file.
128 my $absolute_path = join('', $webroot,$flag_icon);
130 # Check if the a icon file exists.
131 if (-e
"$absolute_path") {
132 # Return content of flag_icon.
135 # If no icon for the specified country exists, try to use
136 # the icon for "unknown".
137 my $ccode = "unknown";
139 # Redoing all the stuff from above for the "unknown" icon.
140 my $file = join('.', $ccode, $ext);
141 my $flag_icon = join('/', $flagdir, $file);
142 my $absolute_path = join('', $webroot, $flag_icon);
144 # Check if the icon is present.
145 if (-e
"$absolute_path") {
146 # Return "unknown" icon.
152 # Function to get the county name by a given country code.
153 sub get_full_country_name
($) {
157 # Remove whitespaces.
160 # Convert input into upper case format.
161 my $code = uc($input);
163 # Handle country codes which are special or not part of the list.
164 if ($not_iso_3166_location{$code}) {
165 # Grab location name from hash.
166 $name = $not_iso_3166_location{$code};
168 # Get the country name by using the location module.
169 $name = &Location
::get_country_name
($db_handle, $code);
175 # Function to get all available locations.
176 sub get_locations
() {
179 # Set default mode to add_special_locations.
180 $mode = $mode ?
$mode : "add_special_locations";
182 # Get locations which are stored in the location database.
183 my @locations = &Location
::database_countries
($db_handle);
185 # Check if the special locations should be added.
186 if ($mode ne "no_special_locations") {
187 # Merge special locations array and the database locations array.
188 @locations = (@special_locations, @locations);
191 # Sort locations array in alphabetical order.
192 my @sorted_locations = sort(@locations);
195 return @sorted_locations;
198 # Function to get the continent code of a given country code.
199 sub get_continent_code
($) {
200 my ($country_code) = @_;
202 # Use location module to grab the continent code.
203 my $continent_code = &Location
::get_continent_code
($db_handle, $country_code);
205 return $continent_code;
208 # Function to check if a given address has one ore more special flags.
209 sub address_has_flags
($) {
212 # Array to store the flags of the address.
215 # Loop through the hash of possible network flags.
216 foreach my $flag (keys(%network_flags)) {
217 # Check if the address has the current flag.
218 if (&Location
::lookup_network_has_flag
($db_handle, $address, $flag)) {
219 # The given address has the requested flag.
221 # Grab the mapped location code for this flag.
222 $mapped_code = $network_flags{$flag};
224 # Add the mapped code to the array of flags.
225 push(@flags, $mapped_code);
229 # Sort the array of flags.
230 @flags = sort(@flags);
232 # Return the array of flags.
237 ## Function to get the Autonomous System Number of a given address.
242 # Lookup the given address.
243 my $asn = &Location
::lookup_asn
($db_handle, $address);
245 # Return the number of the Autonomous System
250 ## Function to get the name of an Autonomous System.
255 # Fetch the name of this AS...
256 my $as_name = &Location
::get_as_name
($db_handle, $asn);
258 # Return the name of the Autonomous System
262 # Custom END declaration which will be executed when perl
263 # ends, to release the database handle to libloc.
265 # Check if a database handle exists.
267 # Destroy libloc database handle.
268 &Location
::DESTROY
($db_handle);