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

Last change on this file since 586 was 586, checked in by Nick Burch, 12 years ago

Handle the database going away better

  • Property svn:executable set to *
File size: 11.2 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 NPEMap::GeoConverter;
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                sleep 5;
144
145                # Work out until we find a match
146                ($easting,$northing,$matched,$pc) = execute_ptl($full_matcher,$outward,$inward);
147
148                # Ensure the search worked, and the db isn't broken
149                unless(defined $easting) {
150                        warn("Search failed to execute, is the database server down?");
151                        ($full_matcher,$postcode_matcher,$pc_area_matcher) = (undef,undef,undef);
152                        print_internal_err('Error setting up database connection');
153                        next REQUEST;
154                }
155
156                # Keep looking for a match
157                unless($matched) {
158                        ($easting,$northing,$matched,$pc) = 
159                                        execute_ptl($outer1_matcher,$outward,substr($inward,0,1));
160                }
161                unless($matched) {
162                        ($easting,$northing,$matched,$pc) = 
163                                        execute_ptl($outer_matcher,$outward);
164                }
165                unless($matched) {
166                        my ($mpart) = ($outward =~ /^([A-Z]+)\d/);
167                        my $mlen = length($mpart);
168
169                        ($easting,$northing,$matched,$pc) = 
170                                        execute_ptl($area_matcher,$mpart,$mlen,$mpart,$mlen);
171
172                        unless($matched) {
173                                print_err "Postcode area '$mpart' not found, postcode probably invalid";
174                                next REQUEST;
175                        }
176                }
177
178                # Save the results
179                my %res;
180                $res{easting} = $easting;
181                $res{northing} = $northing;
182                $res{matched} = $matched;
183                $res{postcode} = $pc;
184                push @results, \%res;
185        }
186
187
188        # Format the easting and northing, if we have them
189        foreach my $res (@results) {
190                if($res->{easting}) {
191                        $res->{ieasting} = int($res->{easting});
192                }
193                if($res->{northing}) {
194                        $res->{inorthing} = int($res->{northing});
195                }
196        }
197
198        # Generate the lat and long, if we had easting and northings
199        foreach my $res (@results) {
200                if($res->{easting} && $res->{northing}) {
201                        ($res->{lat},$res->{long}) = 
202                                eastingNorthingToLatLong($res->{easting},$res->{northing});
203                }       
204        }
205
206        # Render
207        if($output eq "xml") {
208                print header("text/xml");
209                print "<?xml version='1.0'?>\n";
210                print "<geocoder>\n";
211                print "  <request>\n";
212                if($request{postcode}) {
213                        print "     <postcode>$request{postcode}</postcode>\n";
214                        print "     <outward>$request{outward}</outward>\n";
215                        print "     <inward>$request{inward}</inward>\n";
216                } else {
217                        print "     <easting>$request{easting}</easting>\n";
218                        print "     <northing>$request{northing}</northing>\n";
219                }
220                print "  </request>\n\n";
221
222                foreach my $res (@results) {
223                        if(scalar @results > 1) {
224                                print "  <result>\n";
225                        }
226                        print "    <easting>".$res->{ieasting}."</easting>\n";
227                        print "    <northing>".$res->{inorthing}."</northing>\n";
228                        print "    <postcode>$res->{postcode}</postcode>\n";
229                        print "     <latitude>$res->{lat}</latitude>\n";
230                        print "     <longitude>$res->{long}</longitude>\n";
231                        if(scalar @results > 1) {
232                                print "  </result>\n";
233                        }
234                }
235
236                print "</geocoder>\n";
237        } elsif ($output eq "js") {
238                print header("text/javascript");
239
240                if(defined $cgi->param("callback")) {
241                        print $cgi->param("callback") . "(";
242                }
243                # TODO:
244                #  make me play nicely if there are several results
245                #  (need to do some array magic probably)
246                foreach my $res (@results) {
247                        print "{ \"pc\": \"$res->{postcode}\", \"e\": $res->{ieasting}, \"n\": $res->{inorthing}, \"lat\": $res->{lat}, \"lng\": $res->{long} }";
248                }
249                if(defined $cgi->param("callback")) {
250                        print ");";
251                }
252                print "\n";
253    } else {
254                print header("text/plain");
255                print "# Easting,Northing,Matched Postcode,Latitude,Longitude\n";
256
257                foreach my $res (@results) {
258                        print $res->{ieasting}.",".$res->{inorthing}.",'".$res->{postcode}."',".$res->{lat}.",".$res->{long}."\n";
259                }
260        }
261}
262
263# No more requests to serve, so tidy up
264$dbh->disconnect;
265
266# Run a postcode to location matcher
267sub execute_ptl {
268        my $matcher = shift;
269        my @args = @_;
270
271        my ($easting,$northing,$matched,$pc);
272
273        my $res = $matcher->execute(@args);
274        # Should have got something back, unless it's broken
275        unless(defined $res) {
276                warn("Nothing received from execute, is the connection open?");
277                return undef;
278        }
279
280        while( my @row = $matcher->fetchrow_array ) {
281                ($easting,$northing,$matched,$pc) = @row;
282        }
283
284        return ($easting,$northing,$matched,$pc);
285}
286
287# Run a location to postcode/area matcher
288sub execute_lt {
289        my $matcher = shift;
290        my @args = @_;
291
292        my @results;
293
294        my $res = $matcher->execute(@args);
295        # Should have got something back, unless it's broken
296        unless(defined $res) {
297                warn("Nothing received from execute, is the connection open?");
298                return undef;
299        }
300
301        while( my @row = $matcher->fetchrow_array ) {
302                my %res = (
303                        outward  => $row[0],
304                        inward   => $row[1],
305                        easting  => $row[2],
306                        northing => $row[3]
307                );
308
309                if($res{inward}) {
310                        $res{postcode} = $res{outward}." ".$res{inward};
311                } else {
312                        $res{postcode} = $res{outward};
313                }
314
315                push @results, \%res;
316        }
317
318        return @results;
319}
320
321
322# Build our various matcher prepared statements
323
324# Postcode to Location matchers
325sub build_ptl_matchers {
326        my $dbh = shift;
327
328        my $base_sql_a = "SELECT AVG(easting) AS easting, ".
329                         "AVG(northing) AS northing, COUNT(id) AS matched, ";
330        my $base_sql_b = " AS postcode ".
331                         "FROM postcodes ".
332                         "WHERE NOT deleted ";
333
334        my $full_sql = $base_sql_a . " outward || ' ' || inward " . $base_sql_b . 
335                   "AND outward = ? AND inward = ? ".
336                       "GROUP BY outward, inward";
337        my $outer1_sql = $base_sql_a . " outward || ' ' || substr(inward,1,1) || '##'".
338                       $base_sql_b . "AND outward = ? AND substr(inward,1,1) = ?".
339                       "GROUP BY outward, substr(inward,1,1)";
340        my $outer_sql = $base_sql_a . " outward || ' ###'". $base_sql_b . 
341                   "AND outward = ? GROUP BY outward";
342        my $area_sql = $base_sql_a . " ? || '' " . $base_sql_b . 
343                       "AND substr(outward,1,?) = ? ".
344                       "GROUP BY substr(outward,1,?)";
345
346        my $full_matcher = $dbh->prepare($full_sql);
347        my $outer1_matcher = $dbh->prepare($outer1_sql);
348        my $outer_matcher = $dbh->prepare($outer_sql);
349        my $area_matcher = $dbh->prepare($area_sql);
350
351        return ($full_matcher,$outer1_matcher,$outer_matcher,$area_matcher);
352}
353
354# Location to Postcode matcher
355sub build_ltp_matcher {
356        my $dbh = shift;
357
358        my $sql = "SELECT outward, inward, easting, northing ".
359                  "FROM postcodes ".
360                  "WHERE inward IS NOT NULL AND inward <> '' ".
361                  "ORDER BY ( ".
362                  "   POW(easting - ?, 2) + POW(northing - ?, 2) ".
363                  ") LIMIT ? ";
364
365        my $matcher = $dbh->prepare($sql);
366        return $matcher;
367}
368
369# Location to nearby postcode areas matcher
370sub build_lta_matcher {
371        my $dbh = shift;
372
373        my $sql = "SELECT outward, '' AS inward, avg_e AS easting, avg_n AS northing ".
374                  "FROM ( ".
375                  "   SELECT outward, ".
376                  "          AVG(easting) AS avg_e, ".
377                  "          AVG(northing) AS avg_n ".
378                  "   FROM postcodes ".
379                  "   GROUP BY outward ".
380                  ") AS areas ".
381                  "ORDER BY ( ".
382                  "   POW(avg_e - ?, 2) + POW(avg_n - ?, 2) ".
383                  ") LIMIT ? ";
384
385        my $matcher = $dbh->prepare($sql);
386        return $matcher;
387}
388
389
390# Helper routines
391sub print_err {
392    my $err = shift;
393    print header("text/plain", "400 $err");
394    print "Error: $err\n";
395}
396
397sub print_internal_err {
398    my $err = shift;
399    print header("text/plain", "500 $err");
400    print "Error: $err\n";
401}
Note: See TracBrowser for help on using the repository browser.