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

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

Tweak the count display

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