summaryrefslogtreecommitdiff
path: root/chimere/utils.py
blob: b2c8ccc271bd90edf408e177161a4fba94a0ad10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (C) 2012  Étienne Loks  <etienne.loks_AT_peacefrogsDOTnet>

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# See the file COPYING for details.

"""
Utilitaries
"""

import urllib2, re
from external_utils import OsmApi
from lxml import etree
from chimere import get_version

from django.conf import settings
from django.core.exceptions import ObjectDoesNotExist
from django.utils.translation import ugettext_lazy as _

class ImportManager:
    u"""
    Generic class for specific importers
    """
    def __init__(self, importer_instance):
        self.importer_instance = importer_instance

    def get(self):
        pass

    def put(self):
        pass

class KMLManager(ImportManager):
    u"""
    KML importer
    The filtr argument has to be defined as the exact name of the folder to be
    imported
    """
    XPATH = '//kml:Folder/kml:name[text()="%s"]/../kml:Placemark'
    def __init__(self, importer_instance, ns=''):
        self.importer_instance = importer_instance
        self.ns = ns

    def get(self):
        u"""
        Get data from the source
        Return a tuple with:
        - number of new item ;
        - number of item updated ;
        - error detail on error
        """
        from models import Marker
        new_item, updated_item, msg = 0, 0, ''
        try:
            source = urllib2.urlopen(self.importer_instance.source)
        except ValueError:
            # assume it is a local file
            try:
                source = open(self.importer_instance.source)
            except IOError, msg:
                return (new_item, updated_item, msg)
        except urllib2.URLError as error:
            return (new_item, updated_item, error.message)
        tree = etree.parse(source)
        # try to get default namespace
        if not self.ns:
            self.ns = tree.getroot().nsmap[None]
        for placemark in tree.xpath(self.XPATH % self.importer_instance.filtr,
                                    namespaces={'kml':self.ns}):
            name, point, linestring = None, None, None
            pl_id = placemark.attrib.get('id')
            pl_key = 'kml-%d' % self.importer_instance.pk
            ns = '{%s}' % self.ns
            for item in placemark:
                if item.tag == ns + 'name':
                    name = item.text
                elif item.tag == ns + 'description':
                    description = item.text
                elif item.tag == ns + 'Point':
                    for coord in item:
                        if coord.tag == ns + 'coordinates':
                            x, y, z = coord.text.split(',')
                            point = 'SRID=4326;POINT(%s %s)' % (x, y)
            if point:
                dct = {'point':point,
                       'description':description,
                       'name':name,}
                m = None
                if pl_id:
                    dct_import = {
                        'import_key__icontains':'%s:%s;' % (pl_key, pl_id),
                        'import_source':self.importer_instance.source}
                    try:
                        m = Marker.objects.get(**dct_import)
                        for k in dct:
                            setattr(m, k, dct[k])
                        m.save()
                        updated_item += 1
                    except ObjectDoesNotExist:
                        m = None
                        dct.update({
                            'import_source':self.importer_instance.source})
                if not m:
                    dct['status'] = 'I'
                    m = Marker.objects.create(**dct)
                    new_item += 1
                if pl_id:
                    m.set_key(pl_key, pl_id)
                m.categories.clear()
                for cat in self.importer_instance.categories.all():
                    m.categories.add(cat)
        return (new_item, updated_item, msg)

RE_NODE = re.compile('node\[([^\]]*)\]')

# manage deleted item from OSM

class OSMManager(ImportManager):
    u"""
    OSM importer
    The source url is a path to an OSM file or a XAPI url
    The filtr argument is XAPI args or empty if it is an OSM file.
    """

    def get(self, get_items=None):
        u"""
        Get data from the source
        Return a tuple with:
        - new items or number of new items if nb_only = True;
        - updated items or number of updated items if nb_only = True;
        - error detail on error
        """
        from models import Marker
        new_item, updated_item = 0 , 0
        items = []
        msg = ''
        try:
            source = urllib2.urlopen(settings.CHIMERE_XAPI_URL+
                                     self.importer_instance.filtr)
        except ValueError:
            # assume it is a local file
            try:
                source = open(self.importer_instance.source)
            except IOError, msg:
                return (new_item, updated_item, msg)
        except urllib2.URLError as error:
            return (new_item, updated_item, error.message)
        tree = etree.parse(source)
        for node in tree.xpath('//node'):
            name, point, linestring = None, None, None
            node_id = node.attrib.get('id')
            version = node.attrib.get('version')
            for item in node:
                k = item.attrib.get('k')
                if k == 'name':
                    name = item.attrib.get('v')
            point = 'SRID=4326;POINT(%s %s)' % (node.get('lon'),
                                                node.get('lat'))
            if point:
                dct = {'point':point,
                       'name':name,
                       'import_version':version}
                m = None
                if node_id:
                    dct_import = {
                        'import_key__icontains':'OSM:%s;' % (node_id),
                        'import_source':self.importer_instance.source}
                    try:
                        m = Marker.objects.get(**dct_import)
                        items.append(m)
                        if version and m.import_version == int(version):
                            # no update since the last import
                            continue
                        for k in dct:
                            setattr(m, k, dct[k])
                        m.save()
                        updated_item += 1
                    except ObjectDoesNotExist:
                        m = None
                        dct.update({
                            'import_source':self.importer_instance.source})
                if not m:
                    dct['status'] = 'I'
                    m = Marker.objects.create(**dct)
                    new_item += 1
                    items.append(m)
                if node_id:
                    m.set_key('OSM', node_id)
                m.categories.clear()
                for cat in self.importer_instance.categories.all():
                    m.categories.add(cat)
        if not get_items:
            return (new_item, updated_item, msg)
        return (items, new_item, updated_item, msg)

    def put(self):
        # first of all: reimport in order to verify that no changes has been
        # made since the last import
        from models import Marker
        items, new_item, updated_item, msg = self.get(get_items=True)
        # check if import is possible
        if msg:
            return 0, msg
        if new_item:
            return 0, _(u"New items imported - validate them before exporting")
        if Marker.objects.filter(status='I').count():
            return 0, _(u"There are items from a former import not yet "
                        u"validated - validate them before exporting")
        # start import
        api = OsmApi.OsmApi(api=settings.CHIMERE_OSM_API_URL,
                     username=settings.CHIMERE_OSM_USER,
                     password=settings.CHIMERE_OSM_PASSWORD)
        api.ChangesetCreate({u"comment": u"Import from Chimère %s" % \
                                                            get_version()})
        tag = RE_NODE.finddall(self.importer_instance.filtr)
        if not tag:
            return 0, _(u"Bad param")
        tag = tag[0].split('=')
        default_dct = {'tag':{tag[0]:tag[1]},
                       'import_source':self.importer_instance.source}
        for idx, item in Marker.objects.filter(status='A',
                categories=self.importer_instance.categories.all()):
            dct = default_dct.update({
                        'name':item.name,
                        'lon':item.point.lon,
                        'lat':item.point.lat})
            node = None
            import_key = marker.get_key('OSM')
            if not import_key:
                node = OsmApi.NodeCreate(dct)
                item.set_key('OSM', node['id'])
            else:
                dct['id'] = import_key
                node = OsmApi.NodeUpdate(dct)
            item.import_version = node['version']
            item.save()
        api.ChangesetClose()
        return idx+1, None