Skip to content
Open

19.0 #432

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions web_leaflet_lib/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

==========================
Leaflet Javascript Library
==========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e2958825380defcea854d52ad207b7e610d5ac1dbc754b7c3dee544ac418fb8c
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fgeospatial-lightgray.png?logo=github
:target: https://github.com/OCA/geospatial/tree/18.0/web_leaflet_lib
:alt: OCA/geospatial
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/geospatial-18-0/geospatial-18-0-web_leaflet_lib
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/geospatial&target_branch=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends odoo to include Leaflet Javacript library.

This module is used by ``web_view_leaflet_map``.

**Important Note**

The javascript library is opensource and distributed under BSD 2
Licence. See : https://github.com/Leaflet/Leaflet/blob/main/LICENSE. The
plugin library is opensource and distributed under MIT Licence. See :
https://github.com/Leaflet/Leaflet.markercluster/blob/master/MIT-LICENCE.txt.

You can so use it freely.

However, display maps requires to display layers provided by tiles
servers, that requires ressources.

**For testing purpose**

You can use the openStreetMap url
``https://tile.openstreetmap.org/{z}/{x}/{y}.png`` or other, listed in
that page : https://wiki.openstreetmap.org/wiki/Tile_servers

Apart from very limited testing purposes, you should not use the tiles
supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run
non-profit body and cannot supply tiles for large-scale commercial use.

**Regular / High Usage**

- you can contact one of the following companies :
https://switch2osm.org/providers/
- You can also install yourself your own tiles servers. See
documentation : https://switch2osm.org/serving-tiles/

**Library Update**

For the time being, the module embed the lealflet.js library version
1.9.4 ( released on May 18, 2023.)

If a new release is out:

- please download it here https://leafletjs.com/download.html
- update the javascript, css and images, present in the folder
``static/lib/leaflet``
- update the plugins
- test the features
- make a Pull Request

**Table of contents**

.. contents::
:local:

Configuration
=============

- Go to Settings > Technical > Parameters > System Parameters
- Create or edit the parameter with the key ``leaflet.tile_url``
- As a value, set the url of the tiles server you chose. (See
description)

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/geospatial/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/geospatial/issues/new?body=module:%20web_leaflet_lib%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* GRAP

Contributors
------------

- Sylvain LE GAL (https://www.twitter.com/legalsylvain)

Other credits
-------------

The module embed:

- the Leaflet.js library. (https://github.com/Leaflet/Leaflet)
- the markercluster plugin.
(https://github.com/Leaflet/Leaflet.markercluster)

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
:target: https://github.com/legalsylvain
:alt: legalsylvain

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-legalsylvain|

This module is part of the `OCA/geospatial <https://github.com/OCA/geospatial/tree/18.0/web_leaflet_lib>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions web_leaflet_lib/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from .hooks import post_init_hook
24 changes: 24 additions & 0 deletions web_leaflet_lib/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Copyright (C) 2024 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

{
"name": "Leaflet Javascript Library",
"summary": "Bring leaflet.js librairy in odoo.",
"version": "19.0.1.0.0",
"author": "GRAP, Odoo Community Association (OCA)",
"maintainers": ["legalsylvain"],
"website": "https://github.com/OCA/geospatial",
"license": "AGPL-3",
"category": "Extra Tools",
"depends": ["base"],
"data": ["data/ir_config_parameter.xml"],
"assets": {
"web.assets_backend": [
"/web_leaflet_lib/static/lib/leaflet/*",
"/web_leaflet_lib/static/lib/leaflet_markercluster/*",
],
},
"installable": True,
"post_init_hook": "post_init_hook",
}
28 changes: 28 additions & 0 deletions web_leaflet_lib/data/ir_config_parameter.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Copyright (C) 2022 - Today: GRAP (http://www.grap.coop)
@author: Sylvain LE GAL (https://twitter.com/legalsylvain)
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
-->
<odoo noupdate="1">
<record
id="config_parameter_leaflet_copyright"
model="ir.config_parameter"
forcecreate="True"
>
<field name="key">leaflet.copyright</field>
<field
name="value"
><![CDATA[
&copy; <a href='http://www.openstreetmap.org/copyright'>OpenStreetMap</a>]]>
</field>
</record>
<record
id="config_parameter_leaflet_tile_url"
model="ir.config_parameter"
forcecreate="True"
>
<field name="key">leaflet.tile_url</field>
<field name="value">False</field>
</record>
</odoo>
11 changes: 11 additions & 0 deletions web_leaflet_lib/hooks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
def post_init_hook(env):
"""
Update the default tile URL in demo data if needed.
"""
base = env.ref("base.module_base")
if base.demo:
tile_url_param = env["ir.config_parameter"].search(
[("key", "=", "leaflet.tile_url")]
)
if tile_url_param.value == "False":
tile_url_param.value = "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
22 changes: 22 additions & 0 deletions web_leaflet_lib/i18n/fr.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * web_leaflet_lib
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-10-12 20:11+0000\n"
"PO-Revision-Date: 2024-10-12 20:11+0000\n"
"Last-Translator: \n"
"Language-Team: \n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"

#. module: web_leaflet_lib
#: model:ir.model,name:web_leaflet_lib.model_ir_http
msgid "HTTP Routing"
msgstr "Routage HTTP"
22 changes: 22 additions & 0 deletions web_leaflet_lib/i18n/it.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * web_leaflet_lib
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 17.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-11-21 11:06+0000\n"
"Last-Translator: mymage <stefano.consolaro@mymage.it>\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 5.6.2\n"

#. module: web_leaflet_lib
#: model:ir.model,name:web_leaflet_lib.model_ir_http
msgid "HTTP Routing"
msgstr "Instradamento HTTP"
1 change: 1 addition & 0 deletions web_leaflet_lib/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import ir_http
17 changes: 17 additions & 0 deletions web_leaflet_lib/models/ir_http.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright (C) 2022 - Today: GRAP (http://www.grap.coop)
# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

from odoo import api, models


class IrConfigParameter(models.Model):
_inherit = "ir.config_parameter"

@api.model
def get_leaflet_config(self):
"""Returns leaflet configuration for the map view."""
return {
"tile_url": self.sudo().get_param("leaflet.tile_url", default=""),
"copyright": self.sudo().get_param("leaflet.copyright", default=""),
}
3 changes: 3 additions & 0 deletions web_leaflet_lib/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
4 changes: 4 additions & 0 deletions web_leaflet_lib/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- Go to Settings \> Technical \> Parameters \> System Parameters
- Create or edit the parameter with the key `leaflet.tile_url`
- As a value, set the url of the tiles server you chose. (See
description)
1 change: 1 addition & 0 deletions web_leaflet_lib/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Sylvain LE GAL (<https://www.twitter.com/legalsylvain>)
3 changes: 3 additions & 0 deletions web_leaflet_lib/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The module embed:
- the Leaflet.js library. (https://github.com/Leaflet/Leaflet)
- the markercluster plugin. (https://github.com/Leaflet/Leaflet.markercluster)
46 changes: 46 additions & 0 deletions web_leaflet_lib/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
This module extends odoo to include Leaflet Javacript library.

This module is used by `web_view_leaflet_map`.

**Important Note**

The javascript library is opensource and distributed under BSD 2
Licence. See : <https://github.com/Leaflet/Leaflet/blob/main/LICENSE>.
The plugin library is opensource and distributed under MIT
Licence. See : <https://github.com/Leaflet/Leaflet.markercluster/blob/master/MIT-LICENCE.txt>.

You can so use it freely.

However, display maps requires to display layers provided by tiles
servers, that requires ressources.

**For testing purpose**

You can use the openStreetMap url
`https://tile.openstreetmap.org/{z}/{x}/{y}.png` or other, listed in
that page : <https://wiki.openstreetmap.org/wiki/Tile_servers>

Apart from very limited testing purposes, you should not use the tiles
supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run
non-profit body and cannot supply tiles for large-scale commercial use.

**Regular / High Usage**

- you can contact one of the following companies :
<https://switch2osm.org/providers/>
- You can also install yourself your own tiles servers. See
documentation : <https://switch2osm.org/serving-tiles/>

**Library Update**

For the time being, the module embed the lealflet.js library version
1.9.4 ( released on May 18, 2023.)

If a new release is out:

- please download it here <https://leafletjs.com/download.html>
- update the javascript, css and images, present in the folder
`static/lib/leaflet`
- update the plugins
- test the features
- make a Pull Request
Binary file added web_leaflet_lib/static/description/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading