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

Last change on this file since 650 was 650, checked in by Nick Burch, 11 years ago

dracos postbox import

File size: 9.9 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 verbose:
153                                print "Downloading from %s" % self.url
154                        os.system("wget --quiet -O currentlist '%s'" % self.url)
155                        current_file = "currentlist"
156                        if verbose:
157                                print ""
158
159
160                # Read in the new list
161                postcodes = []
162                ftpc = open(current_file, 'r')
163                for line in ftpc:
164                        pc = self.process_line(line)
165                        if pc:
166                                postcodes.append(pc)
167
168
169                # Grab all of the current ones
170                sql = "SELECT id, outward, inward, deleted FROM postcodes WHERE source = %s AND NOT deleted"
171                sth = dbh.cursor()
172                sth.execute(sql, source_id)
173
174                spcs = {}
175                while 1:
176                        row = sth.fetchone()
177                        if row == None:
178                                break
179                        id, outward, inward, deleted = row
180                        spcs["%s %s" % (outward, inward)] = \
181                                                { 'outward':outward, 'inward':inward, 'id':id, 'deleted':deleted, 'done':False }
182                sth.close()
183                count = len(spcs.keys())
184
185                print "There are currently %d entries in the database from %s" % (count, self.source_name)
186                print "The new import contains %d entries" % len(postcodes)
187
188                # Only prompt if it's a big difference
189                if self.confirm_update:
190                        if (count == 0 or len(postcodes) == 0 or 
191                                        len(postcodes) < count or (len(postcodes)-count) > 50):
192                                print "Are you sure you wish to run an import?"
193                                confirm = raw_input("")
194                                print ""
195
196                                if confirm == "y" or confirm == "yes":
197                                        # Good, go ahead
198                                        pass
199                                else:
200                                        print ""
201                                        raise Exception("Aborting import")
202                else:
203                        # Don't trash everything even with --no-confirm
204                        if len(postcodes) == 0 or abs(len(postcodes)-count) > 100:
205                                raise Exception("Postcode count too different, not running (re-run without --no-confirm to allow")
206
207
208                # Add the latest list to the database, tweaking if already there
209                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)"
210                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"
211                del_sql = "UPDATE postcodes SET deleted='t', delete_reason=%s WHERE id=%s"
212                sth = dbh.cursor()
213                worked = 0
214
215                # Add the postcodes
216                for postcode in postcodes:
217                        pc = "%s %s" % (postcode["outer"], postcode["inner"])
218                        if self.verbose:
219                                print "Processing %s" % pc
220
221                        if spcs.has_key(pc):
222                                # Update existing one
223                                spcs[pc]['done'] = True
224                                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']))
225                                if self.verbose:
226                                        print "\tupdated record at %d" % spcs[pc]['id']
227                        else:
228                                # New record, add
229                                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))
230                                if self.verbose:
231                                        print "\tadded new postcode"
232                                else:
233                                        print "Added postcode %s" % pc
234                        worked = worked + 1
235
236                print "Processed %d entries" % worked
237
238
239                # Find ones that have gone
240                if self.verbose:
241                        print "\nDeleting any postcodes no longer in source:"
242                for gone_pc in [ pc for pc in spcs.keys() if not spcs[pc]['done'] ]:
243                        print "\tflagging as deleted old postcode %s" % gone_pc
244                        sth.execute(del_sql, (reason_id, spcs[gone_pc]['id']))
245
246                # All done
247                if self.verbose:
248                        print "\nAll Done"
249                sth.close()
250                dbh.commit()
251                dbh.close()
252
253class FreeThePostcodeImporter(Importer):
254        "An importer for FreeThePostcode.org"
255        def __init__(self):
256                super(FreeThePostcodeImporter, self).__init__(
257                        source_name="FreeThePostcode.org Importer",
258                        delete_reason="Gone from FTP",
259                        url="http://www.freethepostcode.org/currentlist"
260                )
261
262        def process_line(self,line):
263                "Process one line of the file"
264                line = line[0:-1]
265                if line[0:1] == "#":
266                        return
267
268                # Replace double spaces
269                line = line.replace("  "," ")
270
271                parts = line.split(" ")
272                if not len(parts) == 4:
273                        print "Invalid line '%s'" % line
274                        return
275
276                pc = {}
277                pc["outer"] = parts[2]
278                pc["inner"] = parts[3]
279                pc["raw"] = "%s %s" % (parts[2],parts[3])
280                pc["raw_outer"] = parts[2]
281                pc["raw_inner"] = parts[3]
282                pc["latitude"] = parts[0]
283                pc["longitude"] = parts[1]
284
285                self.generate_easting_northing(pc)
286
287                # All done
288                return pc
289
290class DracosPostboxImporter(Importer):
291        "An importer for the postcode tagged postbox data from dracos.co.uk"
292
293        def __init__(self):
294                super(DracosPostboxImporter, self).__init__(
295                        source_name="Dracos.co.uk Postbox Importer",
296                        delete_reason="Gone from Dracos Postboxes",
297                        url="http://www.dracos.co.uk/play/locating-postboxes/export.php?rm=1"
298                )
299                self.valid_pc = re.compile("^([A-Z]+\d+)(\d[A-Z][A-Z])$")
300
301        def process_line(self,line):
302                "Process one line of the file"
303                line = line[0:-1]
304                if line[0:1] == "#":
305                        return
306                if line.startswith("Ref"):
307                        return
308
309                parts = line.split("\t")
310                if not len(parts) == 6:
311                        print "Invalid line '%s'" % line
312                        return
313
314                if not parts[1]:
315                        # No postcode
316                        return
317
318                # Does the postcode part look valid?
319                match = self.valid_pc.match(parts[1])
320                if not match:
321                        return
322                outer, inner = match.groups()
323
324                pc = {}
325                pc["raw"] = parts[1]
326                pc["outer"] = outer
327                pc["inner"] = inner
328                pc["raw_outer"] = outer
329                pc["raw_inner"] = inner
330                pc["latitude"] = parts[4]
331                pc["longitude"] = parts[5]
332
333                self.generate_easting_northing(pc)
334
335                # All done
336                return pc
Note: See TracBrowser for help on using the repository browser.