source: trunk/npemap.org.uk/scripts/generic-python-import/generic_importer.py @ 734

Last change on this file since 734 was 734, checked in by Nick Burch, 10 years ago

When we have both a deleted and undeleted postcode in the database, prefer the undeleted one

File size: 11.6 KB
Line 
1#!/usr/bin/python
2#
3# Copyright (c) 2006-2007 Nick Burch and Dominic Hargreveaves
4# Permission is hereby granted, free of charge, to any person obtaining a
5# copy of this software and associated documentation files (the "Software"),
6# to deal in the Software without restriction, including without limitation
7# the rights to use, copy, modify, merge, publish, distribute, sublicense,
8# and/or sell copies of the Software, and to permit persons to whom the
9# Software is furnished to do so, subject to the following conditions:
10#
11# The above copyright notice and this permission notice shall be included in
12# all copies or substantial portions of the Software.
13#
14# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20# IN THE SOFTWARE.
21#
22#               External Datafeed Importer
23#               --------------------------
24#
25# Imports external data into the current schema, removing any
26#  existing data from that source.
27#
28# You will need to tweak this script with your database settings for it
29#  to work.
30
31from pyPgSQL import PgSQL
32from geo_helper import turn_wgs84_into_osgb36, turn_osgb36_into_eastingnorthing, \
33                                                turn_wgs84_into_osie36, turn_osie36_into_eastingnorthing
34import os
35import sys
36import re
37
38# Database settings
39dbtype = "postgres"
40dbname = "npemap"
41dbhost = ""
42dbuser = "npemap"
43dbpass = ""
44
45class Importer(object):
46        "Parent class of all generic importers"
47        def __init__(self,source_name,delete_reason,url):
48                self.source_name = source_name
49                self.delete_reason = delete_reason
50                self.url = url
51
52                self.verbose = False
53                self.download = False
54                self.confirm_update = True
55
56        def generate_easting_northing(self,pc):
57                "Handle the lat+long => e+n bit"
58                if not pc:
59                        return
60                pc["easting"] = None
61                pc["northing"] = None
62                pc["ie_easting"] = None
63                pc["ie_northing"] = None
64
65                # Turn lat+long into easting+northing
66                # All NI postcodes are BT
67                if pc["outer"][0:2] == 'BT':
68                        osll = turn_wgs84_into_osie36(pc["latitude"],pc["longitude"], 0)
69                        en = turn_osie36_into_eastingnorthing(osll[0], osll[1])
70                        pc["ie_easting"] = en[0]
71                        pc["ie_northing"] = en[1]
72                else:
73                        osll = turn_wgs84_into_osgb36(pc["latitude"],pc["longitude"], 0)
74                        en = turn_osgb36_into_eastingnorthing(osll[0], osll[1])
75                        pc["easting"] = en[0]
76                        pc["northing"] = en[1]
77
78        def handle_arguments(self, argv):
79                "What arguments did they pass in?"
80                for arg in argv[1:]: 
81                        if arg == "--verbose":
82                                self.verbose = True
83                        if arg == "--download":
84                                self.download = True
85                        if arg == "--no-confirm":
86                                self.confirm_update = False
87
88        def process(self):
89                "Do the main processing loop"
90
91                # Connect to the database
92                dbh = None
93                if dbtype == "pgsql" or dbtype == "postgres" or dbtype == "postgresql":
94                        if len(dbhost):
95                                dbh = PgSQL.connect(database=dbname, host=dbhost, user=dbuser, password=dbpass)
96                        else:
97                                dbh = PgSQL.connect(database=dbname, user=dbuser, password=dbpass)
98                else:
99                        raise Exception("Unknown dbtype %s" % dbtype)
100
101
102                # Check what source value the data will have
103                source_id = None
104
105                sql = "SELECT id FROM sources WHERE name = %s"
106                sth = dbh.cursor()
107                sth.execute(sql, self.source_name)
108                ids = sth.fetchall()
109                sth.close()
110                if len(ids) == 1:
111                        for id in (ids):
112                                source_id = id.id
113                else:
114                        print "Unable to find ID for source '%s' - error code %d" % (self.source_name, len(ids))
115                        print "Please add it to the database"
116                        return
117
118
119                # See if our delete reason exists, and if no, add it
120                reason_id = None
121                while reason_id == None:
122                        sql = "SELECT id FROM delete_reasons WHERE reason = %s"
123                        sth = dbh.cursor()
124                        sth.execute(sql, self.delete_reason)
125                        ids = sth.fetchall()
126                        sth.close()
127                        if len(ids) == 1:
128                                for id in (ids):
129                                        reason_id = id.id
130                        else:
131                                sth = dbh.cursor()
132                                sth.execute("INSERT INTO delete_reasons (reason) VALUES (%s)", self.delete_reason)
133                                sth.close()
134
135
136                # Download the latest list of postcodes if needed
137                current_file = None
138                if os.path.isfile("currentlist"):
139                        current_file = "currentlist"
140                if os.path.isfile("/tmp/currentlist"):
141                        current_file = "/tmp/currentlist"
142
143                if not self.download and not current_file == None:
144                        print "Data found, do you wish to re-download?"
145                        redownload = raw_input("")
146                        if redownload == "y" or redownload == "yes":
147                                download = True
148                else:
149                        self.download = True
150
151                if self.download:
152                        if self.verbose:
153                                print "Downloading from %s" % self.url
154                        os.system("wget --quiet -O currentlist '%s'" % self.url)
155                        current_file = "currentlist"
156                        if self.verbose:
157                                print ""
158
159
160                # Read in the new list
161                raw_postcodes = {}
162                ftpc = open(current_file, 'r')
163                for line in ftpc:
164                        pc = self.process_line(line)
165                        if pc:
166                                raw_pc = pc["raw"]
167                                if not raw_postcodes.has_key(raw_pc):
168                                        raw_postcodes[raw_pc] = []
169                                raw_postcodes[raw_pc].append(pc)
170
171                # Ensure that the postcodes entries are unique, and
172                #  average them if not
173                postcodes = []
174                for raw_pc, arr_data in raw_postcodes.items():
175                        if len(arr_data) == 1:
176                                # Only the one, easy
177                                pc = arr_data[0]
178                        else:
179                                # Several, average
180                                lat = 0
181                                lng = 0
182                                for pc in arr_data:
183                                        lat += float(pc["latitude"])
184                                        lng += float(pc["longitude"])
185                                # Create the average
186                                pc = arr_data[0]
187                                pc["latitude"]  = lat / len(arr_data)
188                                pc["longitude"] = lng / len(arr_data)
189                                self.generate_easting_northing(pc)
190                        # Save the now always-unique postcode
191                        postcodes.append( pc )
192
193
194                # Grab all of the current ones, including deleted ones
195                sql = "SELECT id, outward, inward, deleted FROM postcodes WHERE source = %s ORDER BY deleted DESC"
196                sth = dbh.cursor()
197                sth.execute(sql, source_id)
198
199        # Loop over all rows. Non-deleted come last, so it doesn't matter
200        #  if we override early occurances of a postcode
201                spcs = {}
202                while 1:
203                        row = sth.fetchone()
204                        if row == None:
205                                break
206                        id, outward, inward, deleted = row
207                        spcs["%s %s" % (outward, inward)] = \
208                                                { 'outward':outward, 'inward':inward, 'id':id, 'deleted':deleted, 'done':False }
209                sth.close()
210                count = len(spcs.keys())
211
212                # And for interest, the count of deleted ones
213                sql = "SELECT COUNT(id) FROM postcodes WHERE source = %s AND deleted"
214                sth = dbh.cursor()
215                sth.execute(sql, source_id)
216                deleted_count = sth.fetchone()[0]
217                sth.close()
218
219                print "There are currently %d entries in the database from the %s. (Additionally, there are %d deleted ones)" % (count-deleted_count, self.source_name, deleted_count)
220                print "The new import contains %d entries" % len(postcodes)
221
222                # Only prompt if it's a big difference
223                if self.confirm_update:
224                        if (count == 0 or len(postcodes) == 0 or 
225                                        len(postcodes) < count or (len(postcodes)-count) > 50):
226                                print "Are you sure you wish to run an import?"
227                                confirm = raw_input("")
228                                print ""
229
230                                if confirm == "y" or confirm == "yes":
231                                        # Good, go ahead
232                                        pass
233                                else:
234                                        print ""
235                                        raise Exception("Aborting import")
236                else:
237                        # Don't trash everything even with --no-confirm
238                        if len(postcodes) == 0 or abs(len(postcodes)-count) > 100:
239                                raise Exception("Postcode count too different, not running (re-run without --no-confirm to allow")
240
241
242                # Add the latest list to the database, tweaking if already there
243                add_sql = "INSERT INTO postcodes (outward, inward, raw_postcode_outward, raw_postcode_inward, easting, northing, ie_easting, ie_northing, source) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)"
244                upd_sql = "UPDATE postcodes SET outward=%s, inward=%s, raw_postcode_outward=%s, raw_postcode_inward=%s, easting=%s, northing=%s, ie_easting=%s, ie_northing=%s WHERE id=%s"
245                del_sql = "UPDATE postcodes SET deleted='t', delete_reason=%s WHERE id=%s"
246                sth = dbh.cursor()
247                worked = 0
248
249                # Add the postcodes
250                for postcode in postcodes:
251                        pc = "%s %s" % (postcode["outer"], postcode["inner"])
252                        if self.verbose:
253                                print "Processing %s" % pc
254
255                        if spcs.has_key(pc):
256                                # If it's previously been deleted, just skip it
257                                if spcs[pc]['deleted']:
258                                        if self.verbose:
259                                                print "\tSkipping as previously deleted (id %d)" % spcs[pc]['id']
260                                        continue
261
262                                # Otherwise, update the existing entry
263                                spcs[pc]['done'] = True
264                                sth.execute(upd_sql, (postcode["outer"], postcode["inner"], postcode["raw_outer"], postcode["raw_inner"], postcode["easting"], postcode["northing"], postcode["ie_easting"], postcode["ie_northing"], spcs[pc]['id']))
265                                if self.verbose:
266                                        print "\tupdated record at %d" % spcs[pc]['id']
267                        else:
268                                # New record, add
269                                sth.execute(add_sql, (postcode["outer"], postcode["inner"], postcode["raw_outer"], postcode["raw_inner"], postcode["easting"], postcode["northing"], postcode["ie_easting"], postcode["ie_northing"], source_id))
270                                if self.verbose:
271                                        print "\tadded new postcode"
272                                else:
273                                        print "Added postcode %s" % pc
274                        worked = worked + 1
275
276                print "Processed %d entries" % worked
277
278
279                # Find ones that have gone
280                if self.verbose:
281                        print "\nDeleting any postcodes no longer in source:"
282                for gone_pc in [ pc for pc in spcs.keys() if not spcs[pc]['done'] ]:
283                        print "\tflagging as deleted old postcode %s" % gone_pc
284                        sth.execute(del_sql, (reason_id, spcs[gone_pc]['id']))
285
286                # All done
287                if self.verbose:
288                        print "\nAll Done"
289                sth.close()
290                dbh.commit()
291                dbh.close()
292
293class FreeThePostcodeImporter(Importer):
294        "An importer for FreeThePostcode.org"
295        def __init__(self):
296                super(FreeThePostcodeImporter, self).__init__(
297                        source_name="FreeThePostcode.org Importer",
298                        delete_reason="Gone from FTP",
299                        url="http://www.freethepostcode.org/currentlist"
300                )
301
302        def process_line(self,line):
303                "Process one line of the file"
304                line = line[0:-1]
305                if line[0:1] == "#":
306                        return
307
308                parts = re.split(" +", line)
309                if not len(parts) == 4:
310                        print "Invalid line '%s'" % line
311                        return
312
313                pc = {}
314                pc["outer"] = parts[2]
315                pc["inner"] = parts[3]
316                pc["raw"] = "%s %s" % (parts[2],parts[3])
317                pc["raw_outer"] = parts[2]
318                pc["raw_inner"] = parts[3]
319                pc["latitude"] = parts[0]
320                pc["longitude"] = parts[1]
321
322                self.generate_easting_northing(pc)
323
324                # All done
325                return pc
326
327class DracosPostboxImporter(Importer):
328        "An importer for the postcode tagged postbox data from dracos.co.uk"
329
330        def __init__(self):
331                super(DracosPostboxImporter, self).__init__(
332                        source_name="Dracos.co.uk Postbox Importer",
333                        delete_reason="Gone from Dracos Postboxes",
334                        url="http://www.dracos.co.uk/play/locating-postboxes/export.php?rm=1"
335                )
336                self.valid_pc = re.compile("^([A-Z]+\d+\s*[A-Z]?)\s*(\d[A-Z][A-Z])$")
337
338        def process_line(self,line):
339                "Process one line of the file"
340                line = line[0:-1]
341                if line[0:1] == "#":
342                        return
343                if line.startswith("Ref"):
344                        return
345
346                # Ref, Postcode, Loc1, Loc2, Latitude, Longitude, last m-f, last sat source
347                parts = line.split("\t")
348                if len(parts) == 9:
349                        pass
350                else:
351                        print "Invalid line '%s'" % line
352                        return
353
354                if not parts[1]:
355                        # No postcode
356                        return
357                if not parts[8] == "Website":
358                        # Don't want OSM data, it's not free enough.
359                        return
360
361                # Does the postcode part look valid?
362                match = self.valid_pc.match(parts[1])
363                if not match:
364                        #print "Invalid - %s" % parts[1]
365                        return
366                outer, inner = match.groups()
367
368                # Seems to be things like "W1 C2DN" not "W1C 2DN", fix
369                outer = outer.replace(" ", "")
370                #print "%s ** %s" % (outer,inner)
371
372                pc = {}
373                pc["raw"] = parts[1]
374                pc["outer"] = outer
375                pc["inner"] = inner
376                pc["raw_outer"] = outer
377                pc["raw_inner"] = inner
378                pc["latitude"] = parts[4]
379                pc["longitude"] = parts[5]
380
381                self.generate_easting_northing(pc)
382
383                # All done
384                return pc
Note: See TracBrowser for help on using the repository browser.