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

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

New dracos format

File size: 11.1 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
195                sql = "SELECT id, outward, inward, deleted FROM postcodes WHERE source = %s AND NOT deleted"
196                sth = dbh.cursor()
197                sth.execute(sql, source_id)
198
199                spcs = {}
200                while 1:
201                        row = sth.fetchone()
202                        if row == None:
203                                break
204                        id, outward, inward, deleted = row
205                        spcs["%s %s" % (outward, inward)] = \
206                                                { 'outward':outward, 'inward':inward, 'id':id, 'deleted':deleted, 'done':False }
207                sth.close()
208                count = len(spcs.keys())
209
210                # And for interest, the count of deleted ones
211                sql = "SELECT COUNT(id) FROM postcodes WHERE source = %s AND deleted"
212                sth = dbh.cursor()
213                sth.execute(sql, source_id)
214                deleted_count = sth.fetchone()[0]
215                sth.close()
216
217                print "There are currently %d entries in the database from the %s. (Additionally, there are %d deleted ones)" % (count, self.source_name, deleted_count)
218                print "The new import contains %d entries" % len(postcodes)
219
220                # Only prompt if it's a big difference
221                if self.confirm_update:
222                        if (count == 0 or len(postcodes) == 0 or 
223                                        len(postcodes) < count or (len(postcodes)-count) > 50):
224                                print "Are you sure you wish to run an import?"
225                                confirm = raw_input("")
226                                print ""
227
228                                if confirm == "y" or confirm == "yes":
229                                        # Good, go ahead
230                                        pass
231                                else:
232                                        print ""
233                                        raise Exception("Aborting import")
234                else:
235                        # Don't trash everything even with --no-confirm
236                        if len(postcodes) == 0 or abs(len(postcodes)-count) > 100:
237                                raise Exception("Postcode count too different, not running (re-run without --no-confirm to allow")
238
239
240                # Add the latest list to the database, tweaking if already there
241                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)"
242                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"
243                del_sql = "UPDATE postcodes SET deleted='t', delete_reason=%s WHERE id=%s"
244                sth = dbh.cursor()
245                worked = 0
246
247                # Add the postcodes
248                for postcode in postcodes:
249                        pc = "%s %s" % (postcode["outer"], postcode["inner"])
250                        if self.verbose:
251                                print "Processing %s" % pc
252
253                        if spcs.has_key(pc):
254                                # Update existing one
255                                spcs[pc]['done'] = True
256                                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']))
257                                if self.verbose:
258                                        print "\tupdated record at %d" % spcs[pc]['id']
259                        else:
260                                # New record, add
261                                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))
262                                if self.verbose:
263                                        print "\tadded new postcode"
264                                else:
265                                        print "Added postcode %s" % pc
266                        worked = worked + 1
267
268                print "Processed %d entries" % worked
269
270
271                # Find ones that have gone
272                if self.verbose:
273                        print "\nDeleting any postcodes no longer in source:"
274                for gone_pc in [ pc for pc in spcs.keys() if not spcs[pc]['done'] ]:
275                        print "\tflagging as deleted old postcode %s" % gone_pc
276                        sth.execute(del_sql, (reason_id, spcs[gone_pc]['id']))
277
278                # All done
279                if self.verbose:
280                        print "\nAll Done"
281                sth.close()
282                dbh.commit()
283                dbh.close()
284
285class FreeThePostcodeImporter(Importer):
286        "An importer for FreeThePostcode.org"
287        def __init__(self):
288                super(FreeThePostcodeImporter, self).__init__(
289                        source_name="FreeThePostcode.org Importer",
290                        delete_reason="Gone from FTP",
291                        url="http://www.freethepostcode.org/currentlist"
292                )
293
294        def process_line(self,line):
295                "Process one line of the file"
296                line = line[0:-1]
297                if line[0:1] == "#":
298                        return
299
300                parts = re.split(" +", line)
301                if not len(parts) == 4:
302                        print "Invalid line '%s'" % line
303                        return
304
305                pc = {}
306                pc["outer"] = parts[2]
307                pc["inner"] = parts[3]
308                pc["raw"] = "%s %s" % (parts[2],parts[3])
309                pc["raw_outer"] = parts[2]
310                pc["raw_inner"] = parts[3]
311                pc["latitude"] = parts[0]
312                pc["longitude"] = parts[1]
313
314                self.generate_easting_northing(pc)
315
316                # All done
317                return pc
318
319class DracosPostboxImporter(Importer):
320        "An importer for the postcode tagged postbox data from dracos.co.uk"
321
322        def __init__(self):
323                super(DracosPostboxImporter, self).__init__(
324                        source_name="Dracos.co.uk Postbox Importer",
325                        delete_reason="Gone from Dracos Postboxes",
326                        url="http://www.dracos.co.uk/play/locating-postboxes/export.php?rm=1"
327                )
328                self.valid_pc = re.compile("^([A-Z]+\d+\s*[A-Z]?)\s*(\d[A-Z][A-Z])$")
329
330        def process_line(self,line):
331                "Process one line of the file"
332                line = line[0:-1]
333                if line[0:1] == "#":
334                        return
335                if line.startswith("Ref"):
336                        return
337
338                # Ref, Postcode, Loc1, Loc2, Latitude, Longitude, last m-f, last sat
339                parts = line.split("\t")
340                if len(parts) == 6 or len(parts) == 7 or len(parts) == 8:
341                        pass
342                else:
343                        print "Invalid line '%s'" % line
344                        return
345
346                if not parts[1]:
347                        # No postcode
348                        return
349
350                # Does the postcode part look valid?
351                match = self.valid_pc.match(parts[1])
352                if not match:
353                        #print "Invalid - %s" % parts[1]
354                        return
355                outer, inner = match.groups()
356
357                # Seems to be things like "W1 C2DN" not "W1C 2DN", fix
358                outer = outer.replace(" ", "")
359                #print "%s ** %s" % (outer,inner)
360
361                pc = {}
362                pc["raw"] = parts[1]
363                pc["outer"] = outer
364                pc["inner"] = inner
365                pc["raw_outer"] = outer
366                pc["raw_inner"] = inner
367                pc["latitude"] = parts[4]
368                pc["longitude"] = parts[5]
369
370                self.generate_easting_northing(pc)
371
372                # All done
373                return pc
Note: See TracBrowser for help on using the repository browser.