Merge lp:~akretion-team/partner-contact-management/base-location-geonames-import into lp:~partner-contact-core-editors/partner-contact-management/7.0

[Alexis de Lattre]

Add module base_location_geonames_import ; this module adds a wizard to import better zip entries from Geonames (http://download.geonames.org/export/zip/).

Nicolas Bessi suggested on twitter that it should be part of the geospacial addons. But, after thinking about it, my opinion is that this module would be better here, because users of the "base_location" module would have a higher chance of finding this module here than in the geospacial addons.

[lp:~akretion-team/partner-contact-management/base-location-geonames-import]

40. By Alexis de Lattre on 2014-04-07

Allow to skip entries in the _prepare method.

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello thanks for the patch.

Is there a good reason not to merge it here: https://launchpad.net/geospatial-addons ?
Some tests would also be a nice addition.

review: Needs Information

[Alexis de Lattre (alexis-via)]

@Nicolas

As I said in my comment, I think that it's better for the module "base_location_geonames_import" to sit right next to the "base_location" module, so that it's easier to find for users of the "base_location" module. We could even imagine that the wizard that is provided by "base_location_geonames_import" could be provided inside "base_location" and not in a separate module.

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Oups I missed that.

Actually, I do not agrees with you, but I won't argue too long on this as for me the branch organisation problem is more deep. Let's see what other think about it.

Some comments Belows:
Some PEP8 in manifest:

328 + _("The content of the file doesn't correspond to the "
329 + "selected country."))

I will add row value and country info it will be more easy for support.

A question with :
+ if res_request.status_code != requests.codes.ok:
349 + raise orm.except_orm(
350 + _('Error:'),
351 + _('Got an error %d when trying to download the file %s.')
352 + % (res_request.status_code, url))

It's been a long time since I used geonames, if I'm correct in case of wrong country it returns 404 that right. If it the case I'm ok with this else we may have to treat a 200 with a message

+ if bzip_ids_to_delete:
356 + bzip_obj.unlink(cr, uid, bzip_ids_to_delete, context=context)
357 + logger.info(
358 + '%d better zip entries deleted for country %s'
359 + % (len(bzip_ids_to_delete), wizard.country_id.name))

This is a quite a direct approach, I agree create, update, unactivate is quite not easy to put in place, but as other development can depends on base location model there should at least be a Big warning in manifest.

Also it would be a good idea to add a small lock to ensure atomicity during the import.
A query "for update no wait" a the begining of transaction would be nice.

Tests are also missing. Without depending on the geoname services having a local excrept to base the tests would be great.

Thanks for the contributions, keep up the good work.

Regards

Nicolas

review: Needs Fixing

[lp:~akretion-team/partner-contact-management/base-location-geonames-import]

41. By Alexis de Lattre on 2014-04-11

Insist on the fact that the wizard deletes current better zip entries in the module description and in the wizard itself.
Better error message when the country code inside the file is wrong.

42. By Alexis de Lattre on 2014-04-11

Add a FOR UPDATE NOWAIT at the beginning of the transaction.

[Alexis de Lattre (alexis-via)]

@Nicolas:

I confirm that it returns 404 if you try to download a wrong country.

I have taken into account your other remarks in my last commits (unless the tests ; I don't have experience in this). I am not sure I fully understand the benefit of the FOR UPDATE NOWAIT in this particular case... at least I hope I implemented it as you wanted.

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

Hello,

Thank for the fixes.
The "UPDATE NO WAIT" will lock the selected rows at postgres database level.
It will avoid a process using the base_location data to alter flushed entries.
It will also avoiding having many concurrent instance of the wizard running on the same rows.
In this case I wonder if we may not want to put a lock on the whole table has we add new entries.

For the test I will see ifI can provide some but I'm in holiday next week, so it have to wait a little.

Regards

Nicolas

[lp:~akretion-team/partner-contact-management/base-location-geonames-import]

43. By Alexis de Lattre on 2014-06-02

Remove France-specific code ; moved to new module l10n_fr_base_location_geonames_import on lp:openerp-french-localization

44. By Alexis de Lattre on 2014-06-11

[MERGE] merge with trunk revno 40.

[Lorenzo Battistini (elbati)]

Hello Alexis, many thanks for the module.

What do you think about creating the res.country.state records if they don't exist, before mapping them in the 'states' dictionary?

The current version is supposed to correctly work with states if you first create states data by modules like l10n_fr_state.
But if base_location_geonames_import also imported states data from geonames (creating records if they don't exist yet) we would not need an extra module just to create states data.

[Lorenzo Battistini (elbati)]

This project is now hosted on https://github.com/OCA/partner-contact. Please move your proposal there. This guide may help you https://github.com/OCA/maintainers-tools/wiki/How-to-move-a-Merge-Proposal-to-GitHub

review: Needs Resubmitting

[Lorenzo Battistini (elbati)]

PR for v8 at https://github.com/OCA/partner-contact/pull/22

Unmerged revisions

44. By Alexis de Lattre on 2014-06-11

[MERGE] merge with trunk revno 40.

43. By Alexis de Lattre on 2014-06-02

Remove France-specific code ; moved to new module l10n_fr_base_location_geonames_import on lp:openerp-french-localization

42. By Alexis de Lattre on 2014-04-11

Add a FOR UPDATE NOWAIT at the beginning of the transaction.

41. By Alexis de Lattre on 2014-04-11

Insist on the fact that the wizard deletes current better zip entries in the module description and in the wizard itself.
Better error message when the country code inside the file is wrong.

40. By Alexis de Lattre on 2014-04-07

Allow to skip entries in the _prepare method.

39. By Alexis de Lattre on 2014-04-07

Add support for states (if states are already present in res.country.state).
Add POT file and FR translation.

38. By Alexis de Lattre on 2014-03-30

Add module base_location_geonames_import

=== added directory 'base_location_geonames_import'
=== added file 'base_location_geonames_import/__init__.py'
--- base_location_geonames_import/__init__.py	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/__init__.py	2014-06-11 06:33:26 +0000
@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Base Location Geonames Import module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+from . import wizard
 
=== added file 'base_location_geonames_import/__openerp__.py'
--- base_location_geonames_import/__openerp__.py	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/__openerp__.py	2014-06-11 06:33:26 +0000
@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Base Location Geonames Import module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+{
+    'name': 'Base Location Geonames Import',
+    'version': '0.1',
+    'category': 'Extra Tools',
+    'license': 'AGPL-3',
+    'summary': 'Import better zip entries from Geonames',
+    'description': """
+Base Location Geonames Import
+=============================
+
+This module adds a wizard to import better zip entries from Geonames (http://download.geonames.org/export/zip/). When you start the wizard, it will ask you to select a country ; then, for the selected country, it will delete all the current better zip entries, download the latest version of the list of cities from geonames.org and create new better zip entries.
+
+Please contact Alexis de Lattre from Akretion <[e-mail]> for any help or question about this module.
+    """,
+    'author': 'Akretion',
+    'website': 'http://www.akretion.com',
+    'depends': ['base_location'],
+    'external_dependencies': {'python': ['requests', 'unicodecsv']},
+    'data': [
+        'wizard/geonames_import_view.xml',
+    ],
+    'installable': True,
+    'active': False,
+}
 
=== added directory 'base_location_geonames_import/i18n'
=== added file 'base_location_geonames_import/i18n/base_location_geonames_import.pot'
--- base_location_geonames_import/i18n/base_location_geonames_import.pot	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/i18n/base_location_geonames_import.pot	2014-06-11 06:33:26 +0000
@@ -0,0 +1,68 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* base_location_geonames_import
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 7.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-04-11 20:55+0000\n"
+"PO-Revision-Date: 2014-04-11 20:55+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "Cancel"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: field:better.zip.geonames.import,country_id:0
+msgid "Country"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:66
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:90
+#, python-format
+msgid "Error:"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "For the country selected above, this wizard will DELETE ALL THE CURRENT BETTER ZIP ENTRIES, download the latest version of the list of cities from geonames.org and create new better zip entries."
+msgstr ""
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:91
+#, python-format
+msgid "Got an error %d when trying to download the file %s."
+msgstr ""
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "Import"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: model:ir.model,name:base_location_geonames_import.model_better_zip_geonames_import
+msgid "Import Better Zip from Geonames"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+#: model:ir.actions.act_window,name:base_location_geonames_import.better_zip_geonames_import_action
+#: model:ir.ui.menu,name:base_location_geonames_import.better_zip_geonames_import_menu
+msgid "Import Geonames"
+msgstr ""
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:67
+#, python-format
+msgid "The country code inside the file (%s) doesn't correspond to the selected country (%s)."
+msgstr ""
+
 
=== added file 'base_location_geonames_import/i18n/fr.po'
--- base_location_geonames_import/i18n/fr.po	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/i18n/fr.po	2014-06-11 06:33:26 +0000
@@ -0,0 +1,68 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* base_location_geonames_import
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 7.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-04-11 20:56+0000\n"
+"PO-Revision-Date: 2014-04-11 20:56+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "Cancel"
+msgstr "Annuler"
+
+#. module: base_location_geonames_import
+#: field:better.zip.geonames.import,country_id:0
+msgid "Country"
+msgstr "Pays"
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:66
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:90
+#, python-format
+msgid "Error:"
+msgstr "Erreur :"
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "For the country selected above, this wizard will DELETE ALL THE CURRENT BETTER ZIP ENTRIES, download the latest version of the list of cities from geonames.org and create new better zip entries."
+msgstr "Pour le pays sélectionné ci-dessus, cet assistant va SUPPRIMER TOUTES LES ENTREES BETTER ZIP, télécharger la dernière version de la liste des villes depuis geonames.org et créer de nouveaux enregistrements better zip."
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:91
+#, python-format
+msgid "Got an error %d when trying to download the file %s."
+msgstr "Erreur %d reçue suite à la tentative de téléchargement du fichier %s."
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+msgid "Import"
+msgstr "Importer"
+
+#. module: base_location_geonames_import
+#: model:ir.model,name:base_location_geonames_import.model_better_zip_geonames_import
+msgid "Import Better Zip from Geonames"
+msgstr "Import Better Zip from Geonames"
+
+#. module: base_location_geonames_import
+#: view:better.zip.geonames.import:0
+#: model:ir.actions.act_window,name:base_location_geonames_import.better_zip_geonames_import_action
+#: model:ir.ui.menu,name:base_location_geonames_import.better_zip_geonames_import_menu
+msgid "Import Geonames"
+msgstr "Importer Geonames"
+
+#. module: base_location_geonames_import
+#: code:addons/base_location_geonames_import/wizard/geonames_import.py:67
+#, python-format
+msgid "The country code inside the file (%s) doesn't correspond to the selected country (%s)."
+msgstr "Le code pays utilisé à l'intérieur du fichier (%s) ne correspond pas au pays sélectionné (%s)."
+
 
=== added directory 'base_location_geonames_import/wizard'
=== added file 'base_location_geonames_import/wizard/__init__.py'
--- base_location_geonames_import/wizard/__init__.py	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/wizard/__init__.py	2014-06-11 06:33:26 +0000
@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Base Location Geonames Import module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+from . import geonames_import
 
=== added file 'base_location_geonames_import/wizard/geonames_import.py'
--- base_location_geonames_import/wizard/geonames_import.py	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/wizard/geonames_import.py	2014-06-11 06:33:26 +0000
@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Base Location Geonames Import module for OpenERP
+#    Copyright (C) 2014 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+from openerp.osv import orm, fields
+from openerp.tools.translate import _
+import requests
+import tempfile
+import StringIO
+import unicodecsv
+import zipfile
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class better_zip_geonames_import(orm.TransientModel):
+    _name = 'better.zip.geonames.import'
+    _description = 'Import Better Zip from Geonames'
+
+    _columns = {
+        'country_id': fields.many2one('res.country', 'Country', required=True),
+    }
+
+    def _prepare_better_zip(
+            self, cr, uid, row, country_id, states, context=None):
+        '''This function is designed to be inherited'''
+        state_id = False
+        if states and row[4] and row[4] in states:
+            state_id = states[row[4].upper()]
+        vals = {
+            'name': row[1],
+            'city': row[2],
+            'state_id': state_id,
+            'country_id': country_id,
+            }
+        return vals
+
+    def create_better_zip(
+            self, cr, uid, row, country_id, country_code, states,
+            context=None):
+        bzip_id = False
+        if row[0] != country_code:
+            raise orm.except_orm(
+                _('Error:'),
+                _("The country code inside the file (%s) doesn't "
+                    "correspond to the selected country (%s).")
+                % (row[0], country_code))
+        logger.debug('ZIP = %s - City = %s' % (row[1], row[2]))
+        if row[1] and row[2]:
+            vals = self._prepare_better_zip(
+                cr, uid, row, country_id, states, context=context)
+            if vals:
+                bzip_id = self.pool['res.better.zip'].create(
+                    cr, uid, vals, context=context)
+        return bzip_id
+
+    def run_import(self, cr, uid, ids, context=None):
+        assert len(ids) == 1, 'Only one ID for the better zip import wizard'
+        bzip_obj = self.pool['res.better.zip']
+        wizard = self.browse(cr, uid, ids[0], context=context)
+        country_id = wizard.country_id.id
+        country_code = wizard.country_id.code.upper()
+        url = 'http://download.geonames.org/export/zip/%s.zip' % country_code
+        logger.info('Starting to download %s' % url)
+        res_request = requests.get(url)
+        if res_request.status_code != requests.codes.ok:
+            raise orm.except_orm(
+                _('Error:'),
+                _('Got an error %d when trying to download the file %s.')
+                % (res_request.status_code, url))
+        bzip_ids_to_delete = bzip_obj.search(
+            cr, uid, [('country_id', '=', country_id)], context=context)
+        if bzip_ids_to_delete:
+            cr.execute('SELECT id FROM res_better_zip WHERE id in %s '
+                'FOR UPDATE NOWAIT', (tuple(bzip_ids_to_delete), ))
+            bzip_obj.unlink(cr, uid, bzip_ids_to_delete, context=context)
+            logger.info(
+                '%d better zip entries deleted for country %s'
+                % (len(bzip_ids_to_delete), wizard.country_id.name))
+        state_ids = self.pool['res.country.state'].search(
+            cr, uid, [('country_id', '=', country_id)], context=context)
+        states = {}
+        # key = code of the state ; value = ID of the state in OpenERP
+        if state_ids:
+            states_r = self.pool['res.country.state'].read(
+                cr, uid, state_ids, ['code', 'country_id'], context=context)
+            for state in states_r:
+                states[state['code'].upper()] = state['id']
+        f_geonames = zipfile.ZipFile(StringIO.StringIO(res_request.content))
+        tempdir = tempfile.mkdtemp(prefix='openerp')
+        f_geonames.extract('%s.txt' % country_code, tempdir)
+        logger.info('The geonames zipfile has been decompressed')
+        data_file = open(os.path.join(tempdir, '%s.txt' % country_code), 'r')
+        data_file.seek(0)
+        logger.info(
+            'Starting to create the better zip entries %s state information'
+            % (states and 'with' or 'without'))
+        for row in unicodecsv.reader(
+                data_file, encoding='utf-8', delimiter='	'):
+            self.create_better_zip(
+                cr, uid, row, country_id, country_code, states,
+                context=context)
+        data_file.close()
+        logger.info(
+            'The wizard to create better zip entries from geonames '
+            'has been successfully completed.')
+        return True
 
=== added file 'base_location_geonames_import/wizard/geonames_import_view.xml'
--- base_location_geonames_import/wizard/geonames_import_view.xml	1970-01-01 00:00:00 +0000
+++ base_location_geonames_import/wizard/geonames_import_view.xml	2014-06-11 06:33:26 +0000
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+    Copyright (C) 2014 Akretion (http://www.akretion.com/)
+    @author: Alexis de Lattre <[e-mail]>
+    The licence is in the file __openerp__.py
+-->
+
+<openerp>
+<data>
+
+<record id="better_zip_geonames_import_form" model="ir.ui.view">
+    <field name="name">asterisk.server.company</field>
+    <field name="model">better.zip.geonames.import</field>
+    <field name="arch"  type="xml">
+        <form string="Import Geonames" version="7.0">
+            <group name="main">
+                <field name="country_id"/>
+                <label string="For the country selected above, this wizard will DELETE ALL THE CURRENT BETTER ZIP ENTRIES, download the latest version of the list of cities from geonames.org and create new better zip entries."
+                    colspan="2" name="import-help"/>
+            </group>
+            <footer>
+                <button name="run_import" type="object"
+                    class="oe_highlight" string="Import"/>
+                <button special="cancel" string="Cancel" class="oe_link"/>
+            </footer>
+        </form>
+    </field>
+</record>
+
+<record id="better_zip_geonames_import_action" model="ir.actions.act_window">
+    <field name="name">Import Geonames</field>
+    <field name="res_model">better.zip.geonames.import</field>
+    <field name="view_type">form</field>
+    <field name="view_mode">form</field>
+    <field name="target">new</field>
+</record>
+
+<menuitem id="better_zip_geonames_import_menu"
+    action="better_zip_geonames_import_action"
+    parent="base.menu_localisation"
+    sequence="50"/>
+
+</data>
+</openerp>