Changeset 403

Timestamp:

Dec 3, 2006, 5:29:41 PM (15 years ago)

Author:

Nick Burch

Message:

Support nearest postcodes, and nearby areas

File:

• trunk/npemap.org.uk/cgi/geocoder.fcgi (modified) (6 diffs)

trunk/npemap.org.uk/cgi/geocoder.fcgi

@@ -2 +2 @@
 # Looks up a location for a given postcode, returning the closest we have,
 #  and an idea of how accurate a match we found.
-# Can return plain text, or XML
+# Looks up the nearest postcode for a given location, optionally returning
+#  the several nearest (rather than just the nearest)
+# Looks up the nearest postcode area for a given location, optionally
+#  returning the several nearest (rather than just the nearest)
+#
+# Can return plain text, JS, JS callback, or XML
 #
 # TODO: Make me more generic, so I can work on the portal site
 #
-# Copyright (c) 2006 Dominic Hargreaves
+# Copyright (c) 2006 Dominic Hargreaves, Nick Burch and David Sheldon
 # See accompanying file "LICENCE" for licence details
 
@@ -71 +76 @@
         }
 
+        # How many results did they want?
+        # (Not all searches support more than one result)
+        my $limit_results = 1;
+        if(defined $cgi->param("results")) {
+                $limit_results = $cgi->param("results");
+                unless($limit_results =~ /^\d+$/) {
+                        print_err ("Invalid maximum number of results '$limit_results' supplied");
+                        next REQUEST;
+                }
+        }
+
+
         # Did they want to do postcode -> location, or location -> postcode?
+        my %request;
+        my @results;
 
         # What postcode were they asking about?
-        my $postcode;
-        my $outward;
-        my $inward;
         if(defined $cgi->param("postcode")) {
-                $postcode = uc($cgi->param("postcode"));
-                ($outward,$inward) = ($postcode =~ /^([A-Z]+\d+[A-Z]?)\s*(\d[A-Z][A-Z])?$/);
-                unless($outward) {
-                        print_err ("Invalid postcode '$postcode' supplied");
+                $limit_results = 1;
+                $request{type} = "location";
+
+                $request{postcode} = uc($cgi->param("postcode"));
+                ($request{outward},$request{inward}) = 
+                                ($request{postcode} =~ /^([A-Z]+\d+[A-Z]?)\s*(\d[A-Z][A-Z])?$/);
+
+                unless($request{outward}) {
+                        print_err ("Invalid postcode '".$request{postcode}."' supplied");
                         next REQUEST;
                 }
+        } elsif(defined $cgi->param("easting") && defined $cgi->param("northing")) {
+                $request{type} = "postcode";
+                $request{easting} = $cgi->param("easting");
+                $request{northing} = $cgi->param("northing");
+
+                if( (defined $cgi->param("area") && $cgi->param("area")) ||
+                    (defined $cgi->param("areas") && $cgi->param("areas")) ) {
+                        $request{type} = "area";
+                }
+
+                unless($request{easting} =~ /^\d+$/) {
+                        print_err ("Invalid easting '".$request{easting}."' supplied");
+                        next REQUEST;
+                }
+                unless($request{northing} =~ /^\d+$/) {
+                        print_err ("Invalid northing '".$request{northing}."' supplied");
+                        next REQUEST;
+                }
         } else {
-                print_err ("Required parameter 'postcode' not supplied");
+                print_err ("You must either supply the parameter 'postcode', or the two parameters 'easting' and 'northing'");
                 next REQUEST;
         }
 
 
-        my ($easting,$northing,$matched,$pc);
-
-        # Work out until we find a match
-        ($easting,$northing,$matched,$pc) = execute($full_matcher,$outward,$inward);
-        unless($matched) {
-                ($easting,$northing,$matched,$pc) = 
-                                execute($outer1_matcher,$outward,substr($inward,0,1));
-        }
-        unless($matched) {
-                ($easting,$northing,$matched,$pc) = 
-                                execute($outer_matcher,$outward);
-        }
-        unless($matched) {
-                my ($mpart) = ($outward =~ /^([A-Z]+)\d/);
-                my $mlen = length($mpart);
-
-                ($easting,$northing,$matched,$pc) = 
-                                execute($area_matcher,$mpart,$mlen,$mpart,$mlen);
-
+        # Find what the user was after
+        if($request{type} eq "area") {
+                @results = execute_lt($pc_area_matcher, $request{easting}, $request{northing}, $limit_results);
+        }
+        elsif($request{type} eq "postcode") {
+                @results = execute_lt($postcode_matcher, $request{easting}, $request{northing}, $limit_results);
+        }
+        else {
+                my ($easting,$northing,$matched,$pc);
+                my ($outward,$inward) = ($request{outward},$request{inward});
+
+                # Work out until we find a match
+                ($easting,$northing,$matched,$pc) = execute_ptl($full_matcher,$outward,$inward);
                 unless($matched) {
-                        print_err "Postcode area '$mpart' not found, postcode probably invalid";
-                        next REQUEST;
-                }
-        }
+                        ($easting,$northing,$matched,$pc) = 
+                                        execute_ptl($outer1_matcher,$outward,substr($inward,0,1));
+                }
+                unless($matched) {
+                        ($easting,$northing,$matched,$pc) = 
+                                        execute_ptl($outer_matcher,$outward);
+                }
+                unless($matched) {
+                        my ($mpart) = ($outward =~ /^([A-Z]+)\d/);
+                        my $mlen = length($mpart);
+
+                        ($easting,$northing,$matched,$pc) = 
+                                        execute_ptl($area_matcher,$mpart,$mlen,$mpart,$mlen);
+
+                        unless($matched) {
+                                print_err "Postcode area '$mpart' not found, postcode probably invalid";
+                                next REQUEST;
+                        }
+                }
+
+                # Save the results
+                my %res;
+                $res{easting} = $easting;
+                $res{northing} = $northing;
+                $res{matched} = $matched;
+                $res{postcode} = $pc;
+                push @results, \%res;
+        }
+
+
+        # Format the easting and northing, if we have them
+        foreach my $res (@results) {
+                if($res->{easting}) {
+                        $res->{ieasting} = int($res->{easting});
+                }
+                if($res->{northing}) {
+                        $res->{inorthing} = int($res->{northing});
+                }
+        }
+
 
         # Render
@@ -121 +190 @@
                 print "<geocoder>\n";
                 print "  <request>\n";
-                print "     <postcode>$postcode</postcode>\n";
-                print "     <outward>$outward</outward>\n";
-                print "     <inward>$inward</inward>\n";
+                if($request{postcode}) {
+                        print "     <postcode>$request{postcode}</postcode>\n";
+                        print "     <outward>$request{outward}</outward>\n";
+                        print "     <inward>$request{inward}</inward>\n";
+                } else {
+                        print "     <easting>$request{easting}</easting>\n";
+                        print "     <northing>$request{northing}</northing>\n";
+                }
                 print "  </request>\n\n";
-                print "  <easting>".int($easting)."</easting>\n";
-                print "  <northing>".int($northing)."</northing>\n";
-                print "  <postcode>$pc</postcode>\n";
+
+                foreach my $res (@results) {
+                        if(scalar @results > 1) {
+                                print "  <result>\n";
+                        }
+                        print "    <easting>".$res->{ieasting}."</easting>\n";
+                        print "    <northing>".$res->{inorthing}."</northing>\n";
+                        print "    <postcode>$res->{postcode}</postcode>\n";
+                        if(scalar @results > 1) {
+                                print "  </result>\n";
+                        }
+                }
+
                 print "</geocoder>\n";
         } elsif ($output eq "js") {
                 print header("text/javascript");
-        my ($e, $n) = (int($easting), int($northing));
-          if(defined $cgi->param("callback")) {
-          print $cgi->param("callback") . "(";
-      }
-      print "{ pc: \"$pc\", e: $e, n: $n }";
-          if(defined $cgi->param("callback")) {
-          print ");";
-      }
-      print "\n";
-       
+
+                if(defined $cgi->param("callback")) {
+                        print $cgi->param("callback") . "(";
+                }
+                # TODO:
+                #  make me play nicely if there are several results
+                #  (need to do some array magic probably)
+                foreach my $res (@results) {
+                        print "{ pc: \"$res->{postcode}\", e: $res->{ieasting}, n: $res->{inorthing} }";
+                }
+                if(defined $cgi->param("callback")) {
+                        print ");";
+                }
+                print "\n";
     } else {
                 print header("text/plain");
                 print "# Easting,Northing,Matched Postcode\n";
-                print int($easting).",".int($northing).",'$pc'\n";
+
+                foreach my $res (@results) {
+                        print $res->{ieasting}.",".$res->{inorthing}.",'".$res->{postcode}."'\n";
+                }
         }
 }
@@ -151 +242 @@
 $dbh->disconnect;
 
-# Run a matcher query
-sub execute {
+# Run a postcode to location matcher
+sub execute_ptl {
         my $matcher = shift;
         my @args = @_;
@@ -165 +256 @@
         return ($easting,$northing,$matched,$pc);
 }
+
+# Run a location to postcode/area matcher
+sub execute_lt {
+        my $matcher = shift;
+        my @args = @_;
+
+        my @results;
+
+        $matcher->execute(@args);
+        while( my @row = $matcher->fetchrow_array ) {
+                my %res = (
+                        outward  => $row[0],
+                        inward   => $row[1],
+                        easting  => $row[2],
+                        northing => $row[3]
+                );
+
+                if($res{inward}) {
+                        $res{postcode} = $res{outward}." ".$res{inward};
+                } else {
+                        $res{postcode} = $res{outward};
+                }
+
+                push @results, \%res;
+        }
+
+        return @results;
+}
+
 
 # Build our various matcher prepared statements
@@ -217 +337 @@
         my $dbh = shift;
 
-        my $sql = "SELECT outward, avg_e AS easting, avg_n AS northing ".
+        my $sql = "SELECT outward, '' AS inward, avg_e AS easting, avg_n AS northing ".
                   "FROM ( ".
                   "   SELECT outward, ".