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

Last change on this file since 460 was 460, checked in by Nick Burch, 14 years ago

Shift Geo::HelmertTransform? from scripts/exporter into perllib

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