source: trunk/npemap.org.uk/cgi/geocoder.fcgi @ 403

Last change on this file since 403 was 403, checked in by Nick Burch, 15 years ago

Support nearest postcodes, and nearby areas

  • Property svn:executable set to *
File size: 9.9 KB
Line 
1#!/usr/bin/perl
2# Looks up a location for a given postcode, returning the closest we have,
3#  and an idea of how accurate a match we found.
4# Looks up the nearest postcode for a given location, optionally returning
5#  the several nearest (rather than just the nearest)
6# Looks up the nearest postcode area for a given location, optionally
7#  returning the several nearest (rather than just the nearest)
8#
9# Can return plain text, JS, JS callback, or XML
10#
11# TODO: Make me more generic, so I can work on the portal site
12#
13# Copyright (c) 2006 Dominic Hargreaves, Nick Burch and David Sheldon
14# See accompanying file "LICENCE" for licence details
15
16use strict;
17use warnings;
18
19use CGI::Fast qw/:standard -debug/;
20
21# Find our private perl libraries
22use FindBin;
23use lib "$FindBin::Bin/../perllib";
24use NPEMap;
25
26sub print_err;
27
28# Set up database handler to try and make sure it's ready for the first
29# request
30# No point in handling errors here since they'll get handled by the request
31# handler
32my $dbh = setup_dbh();
33
34# Build our prepared statements:
35#   Postcode to location matchers
36my ($full_matcher,$outer1_matcher,$outer_matcher,$area_matcher) =
37        &build_ptl_matchers($dbh);
38#   Location to postcode matcher
39my $postcode_matcher = &build_ltp_matcher($dbh);
40#   Location to area code matchers
41my $pc_area_matcher = &build_lta_matcher($dbh);
42
43
44my @outputs = qw(text xml js);
45
46my $cgi;
47# Process incoming requests
48REQUEST: while ($cgi = new CGI::Fast) {
49
50    # In case the database went away, make sure we have a connection
51    unless ($dbh = setup_dbh()) {
52        print_internal_err('Error setting up database connection');
53        next REQUEST;
54    }
55        # Ensure we still have prepared statements
56        unless($full_matcher) {
57                ($full_matcher,$outer1_matcher,$outer_matcher,$area_matcher) =
58                        &build_ptl_matchers($dbh);
59        }
60        unless($postcode_matcher) {
61                $postcode_matcher = &build_ltp_matcher($dbh);
62        }
63        unless($pc_area_matcher) {
64                $pc_area_matcher = &build_lta_matcher($dbh);
65        }
66
67
68        # What output format do they want?
69        my $output = $outputs[0];
70        if(defined $cgi->param("format")) {
71                foreach my $possoutput (@outputs) {
72                        if($possoutput eq $cgi->param("format")) {
73                                $output = $possoutput;
74                        }
75                }
76        }
77
78        # How many results did they want?
79        # (Not all searches support more than one result)
80        my $limit_results = 1;
81        if(defined $cgi->param("results")) {
82                $limit_results = $cgi->param("results");
83                unless($limit_results =~ /^\d+$/) {
84                        print_err ("Invalid maximum number of results '$limit_results' supplied");
85                        next REQUEST;
86                }
87        }
88
89
90        # Did they want to do postcode -> location, or location -> postcode?
91        my %request;
92        my @results;
93
94        # What postcode were they asking about?
95        if(defined $cgi->param("postcode")) {
96                $limit_results = 1;
97                $request{type} = "location";
98
99                $request{postcode} = uc($cgi->param("postcode"));
100                ($request{outward},$request{inward}) = 
101                                ($request{postcode} =~ /^([A-Z]+\d+[A-Z]?)\s*(\d[A-Z][A-Z])?$/);
102
103                unless($request{outward}) {
104                        print_err ("Invalid postcode '".$request{postcode}."' supplied");
105                        next REQUEST;
106                }
107        } elsif(defined $cgi->param("easting") && defined $cgi->param("northing")) {
108                $request{type} = "postcode";
109                $request{easting} = $cgi->param("easting");
110                $request{northing} = $cgi->param("northing");
111
112                if( (defined $cgi->param("area") && $cgi->param("area")) ||
113                    (defined $cgi->param("areas") && $cgi->param("areas")) ) {
114                        $request{type} = "area";
115                }
116
117                unless($request{easting} =~ /^\d+$/) {
118                        print_err ("Invalid easting '".$request{easting}."' supplied");
119                        next REQUEST;
120                }
121                unless($request{northing} =~ /^\d+$/) {
122                        print_err ("Invalid northing '".$request{northing}."' supplied");
123                        next REQUEST;
124                }
125        } else {
126                print_err ("You must either supply the parameter 'postcode', or the two parameters 'easting' and 'northing'");
127                next REQUEST;
128        }
129
130
131        # Find what the user was after
132        if($request{type} eq "area") {
133                @results = execute_lt($pc_area_matcher, $request{easting}, $request{northing}, $limit_results);
134        }
135        elsif($request{type} eq "postcode") {
136                @results = execute_lt($postcode_matcher, $request{easting}, $request{northing}, $limit_results);
137        }
138        else {
139                my ($easting,$northing,$matched,$pc);
140                my ($outward,$inward) = ($request{outward},$request{inward});
141
142                # Work out until we find a match
143                ($easting,$northing,$matched,$pc) = execute_ptl($full_matcher,$outward,$inward);
144                unless($matched) {
145                        ($easting,$northing,$matched,$pc) = 
146                                        execute_ptl($outer1_matcher,$outward,substr($inward,0,1));
147                }
148                unless($matched) {
149                        ($easting,$northing,$matched,$pc) = 
150                                        execute_ptl($outer_matcher,$outward);
151                }
152                unless($matched) {
153                        my ($mpart) = ($outward =~ /^([A-Z]+)\d/);
154                        my $mlen = length($mpart);
155
156                        ($easting,$northing,$matched,$pc) = 
157                                        execute_ptl($area_matcher,$mpart,$mlen,$mpart,$mlen);
158
159                        unless($matched) {
160                                print_err "Postcode area '$mpart' not found, postcode probably invalid";
161                                next REQUEST;
162                        }
163                }
164
165                # Save the results
166                my %res;
167                $res{easting} = $easting;
168                $res{northing} = $northing;
169                $res{matched} = $matched;
170                $res{postcode} = $pc;
171                push @results, \%res;
172        }
173
174
175        # Format the easting and northing, if we have them
176        foreach my $res (@results) {
177                if($res->{easting}) {
178                        $res->{ieasting} = int($res->{easting});
179                }
180                if($res->{northing}) {
181                        $res->{inorthing} = int($res->{northing});
182                }
183        }
184
185
186        # Render
187        if($output eq "xml") {
188                print header("text/xml");
189                print "<?xml version='1.0'?>\n";
190                print "<geocoder>\n";
191                print "  <request>\n";
192                if($request{postcode}) {
193                        print "     <postcode>$request{postcode}</postcode>\n";
194                        print "     <outward>$request{outward}</outward>\n";
195                        print "     <inward>$request{inward}</inward>\n";
196                } else {
197                        print "     <easting>$request{easting}</easting>\n";
198                        print "     <northing>$request{northing}</northing>\n";
199                }
200                print "  </request>\n\n";
201
202                foreach my $res (@results) {
203                        if(scalar @results > 1) {
204                                print "  <result>\n";
205                        }
206                        print "    <easting>".$res->{ieasting}."</easting>\n";
207                        print "    <northing>".$res->{inorthing}."</northing>\n";
208                        print "    <postcode>$res->{postcode}</postcode>\n";
209                        if(scalar @results > 1) {
210                                print "  </result>\n";
211                        }
212                }
213
214                print "</geocoder>\n";
215        } elsif ($output eq "js") {
216                print header("text/javascript");
217
218                if(defined $cgi->param("callback")) {
219                        print $cgi->param("callback") . "(";
220                }
221                # TODO:
222                #  make me play nicely if there are several results
223                #  (need to do some array magic probably)
224                foreach my $res (@results) {
225                        print "{ pc: \"$res->{postcode}\", e: $res->{ieasting}, n: $res->{inorthing} }";
226                }
227                if(defined $cgi->param("callback")) {
228                        print ");";
229                }
230                print "\n";
231    } else {
232                print header("text/plain");
233                print "# Easting,Northing,Matched Postcode\n";
234
235                foreach my $res (@results) {
236                        print $res->{ieasting}.",".$res->{inorthing}.",'".$res->{postcode}."'\n";
237                }
238        }
239}
240
241# No more requests to serve, so tidy up
242$dbh->disconnect;
243
244# Run a postcode to location matcher
245sub execute_ptl {
246        my $matcher = shift;
247        my @args = @_;
248
249        my ($easting,$northing,$matched,$pc);
250
251        $matcher->execute(@args);
252        while( my @row = $matcher->fetchrow_array ) {
253                ($easting,$northing,$matched,$pc) = @row;
254        }
255
256        return ($easting,$northing,$matched,$pc);
257}
258
259# Run a location to postcode/area matcher
260sub execute_lt {
261        my $matcher = shift;
262        my @args = @_;
263
264        my @results;
265
266        $matcher->execute(@args);
267        while( my @row = $matcher->fetchrow_array ) {
268                my %res = (
269                        outward  => $row[0],
270                        inward   => $row[1],
271                        easting  => $row[2],
272                        northing => $row[3]
273                );
274
275                if($res{inward}) {
276                        $res{postcode} = $res{outward}." ".$res{inward};
277                } else {
278                        $res{postcode} = $res{outward};
279                }
280
281                push @results, \%res;
282        }
283
284        return @results;
285}
286
287
288# Build our various matcher prepared statements
289
290# Postcode to Location matchers
291sub build_ptl_matchers {
292        my $dbh = shift;
293
294        my $base_sql_a = "SELECT AVG(easting) AS easting, ".
295                         "AVG(northing) AS northing, COUNT(id) AS matched, ";
296        my $base_sql_b = " AS postcode ".
297                         "FROM postcodes ".
298                         "WHERE NOT deleted ";
299
300        my $full_sql = $base_sql_a . " outward || ' ' || inward " . $base_sql_b . 
301                   "AND outward = ? AND inward = ? ".
302                       "GROUP BY outward, inward";
303        my $outer1_sql = $base_sql_a . " outward || ' ' || substr(inward,1,1) || '##'".
304                       $base_sql_b . "AND outward = ? AND substr(inward,1,1) = ?".
305                       "GROUP BY outward, substr(inward,1,1)";
306        my $outer_sql = $base_sql_a . " outward || ' ###'". $base_sql_b . 
307                   "AND outward = ? GROUP BY outward";
308        my $area_sql = $base_sql_a . " ? || '' " . $base_sql_b . 
309                       "AND substr(outward,1,?) = ? ".
310                       "GROUP BY substr(outward,1,?)";
311
312        my $full_matcher = $dbh->prepare($full_sql);
313        my $outer1_matcher = $dbh->prepare($outer1_sql);
314        my $outer_matcher = $dbh->prepare($outer_sql);
315        my $area_matcher = $dbh->prepare($area_sql);
316
317        return ($full_matcher,$outer1_matcher,$outer_matcher,$area_matcher);
318}
319
320# Location to Postcode matcher
321sub build_ltp_matcher {
322        my $dbh = shift;
323
324        my $sql = "SELECT outward, inward, easting, northing ".
325                  "FROM postcodes ".
326                  "WHERE inward IS NOT NULL AND inward <> '' ".
327                  "ORDER BY ( ".
328                  "   POW(easting - ?, 2) + POW(northing - ?, 2) ".
329                  ") LIMIT ? ";
330
331        my $matcher = $dbh->prepare($sql);
332        return $matcher;
333}
334
335# Location to nearby postcode areas matcher
336sub build_lta_matcher {
337        my $dbh = shift;
338
339        my $sql = "SELECT outward, '' AS inward, avg_e AS easting, avg_n AS northing ".
340                  "FROM ( ".
341                  "   SELECT outward, ".
342                  "          AVG(easting) AS avg_e, ".
343                  "          AVG(northing) AS avg_n ".
344                  "   FROM postcodes ".
345                  "   GROUP BY outward ".
346                  ") AS areas ".
347                  "ORDER BY ( ".
348                  "   POW(avg_e - ?, 2) + POW(avg_n - ?, 2) ".
349                  ") LIMIT ? ";
350
351        my $matcher = $dbh->prepare($sql);
352        return $matcher;
353}
354
355
356# Helper routines
357sub print_err {
358    my $err = shift;
359    print header("text/plain", "400 $err");
360    print "Error: $err\n";
361}
362
363sub print_internal_err {
364    my $err = shift;
365    print header("text/plain", "500 $err");
366    print "Error: $err\n";
367}
Note: See TracBrowser for help on using the repository browser.