mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-14 18:37:58 +00:00
Compare commits
217 Commits
docs-5.1.x
...
docs-5.2.x
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
212b69799c | ||
|
|
9a13b62fb9 | ||
|
|
3ecda751c4 | ||
|
|
5d4c29b84b | ||
|
|
f1fbc04f33 | ||
|
|
353c985b9f | ||
|
|
2dda9079f0 | ||
|
|
4c91a0bc8d | ||
|
|
31c8ec6db0 | ||
|
|
e2330ff4c1 | ||
|
|
589825d37e | ||
|
|
a93113bc44 | ||
|
|
b042eca382 | ||
|
|
d202a8f7d8 | ||
|
|
af6386bd68 | ||
|
|
862bfdf6fb | ||
|
|
28029edc8b | ||
|
|
d6e9196177 | ||
|
|
e0a750e089 | ||
|
|
93b2a0f194 | ||
|
|
aa3fce6852 | ||
|
|
535ffc1e3f | ||
|
|
77ed4635f2 | ||
|
|
7715a9d500 | ||
|
|
58d570ca8a | ||
|
|
5a8aa6cce4 | ||
|
|
72592da0cc | ||
|
|
193d6c4173 | ||
|
|
4fd881bcb2 | ||
|
|
54620f9566 | ||
|
|
42b687f545 | ||
|
|
43ffceff27 | ||
|
|
2fb03cd103 | ||
|
|
8d3d24a1e4 | ||
|
|
8efdab1d6f | ||
|
|
1d1d80e1e3 | ||
|
|
670cf98f93 | ||
|
|
433c40cd68 | ||
|
|
a049569020 | ||
|
|
bf49f6a46f | ||
|
|
45a44f1411 | ||
|
|
5a2bfd7a19 | ||
|
|
fd12d2e9f3 | ||
|
|
3d0867ff16 | ||
|
|
177b16b89b | ||
|
|
0b7bde2500 | ||
|
|
7ac3591433 | ||
|
|
07c2907064 | ||
|
|
355cbcc7b8 | ||
|
|
8339c2b928 | ||
|
|
341c09ee95 | ||
|
|
b0b909be93 | ||
|
|
bf604e36ee | ||
|
|
3a50f749dd | ||
|
|
563255202d | ||
|
|
94d22bbdac | ||
|
|
32d26f12c4 | ||
|
|
0f324c8cb2 | ||
|
|
1e3b56d215 | ||
|
|
e855552e01 | ||
|
|
79a1907c49 | ||
|
|
91e345f77f | ||
|
|
d0ad65f696 | ||
|
|
e916d27b7c | ||
|
|
823ad5d279 | ||
|
|
048d571e46 | ||
|
|
f5e4b74c38 | ||
|
|
c2a311e69c | ||
|
|
5968f7d646 | ||
|
|
4cdd2526b6 | ||
|
|
4ff7696ed3 | ||
|
|
247afe1f56 | ||
|
|
6f74141fa4 | ||
|
|
75ccf97de3 | ||
|
|
196de9e974 | ||
|
|
6b627df4fb | ||
|
|
b7d77b9b43 | ||
|
|
7e84d38a92 | ||
|
|
c7df8738ed | ||
|
|
0045203092 | ||
|
|
b325413486 | ||
|
|
6270c90052 | ||
|
|
a7709c768d | ||
|
|
47c0a101b9 | ||
|
|
64bb8c2a9c | ||
|
|
194b607491 | ||
|
|
9bad3b1e61 | ||
|
|
69e882096c | ||
|
|
f300b00c2d | ||
|
|
242fcc6e4d | ||
|
|
83c6f27f5c | ||
|
|
1111597db5 | ||
|
|
866e6bade9 | ||
|
|
4cbbe04f7f | ||
|
|
e1cef3de0a | ||
|
|
c6088cb4e7 | ||
|
|
a725cab2fc | ||
|
|
8bb53c22be | ||
|
|
8a96e4f802 | ||
|
|
a9cd706bb6 | ||
|
|
09b5ea097b | ||
|
|
e111257644 | ||
|
|
93ac1023f7 | ||
|
|
1fe2353682 | ||
|
|
6d2b79870c | ||
|
|
621d8e785b | ||
|
|
830307484b | ||
|
|
5d6967a1d0 | ||
|
|
26903aec0b | ||
|
|
c39183e3a5 | ||
|
|
21ef3be433 | ||
|
|
99562a197e | ||
|
|
fe30663b21 | ||
|
|
73ee17af95 | ||
|
|
b9252cc348 | ||
|
|
71025f3f43 | ||
|
|
e4b671f8b1 | ||
|
|
7ebd121abc | ||
|
|
4634ad0720 | ||
|
|
4a9253a0a9 | ||
|
|
1aeb8a262c | ||
|
|
ef7e842702 | ||
|
|
ec42fda1bd | ||
|
|
287ba2570e | ||
|
|
4711deeccb | ||
|
|
cf9e8d6b8e | ||
|
|
06d5ab4c2d | ||
|
|
e327512667 | ||
|
|
3e04eb2ffe | ||
|
|
970d81fb27 | ||
|
|
cecdbeb7cf | ||
|
|
c634e9fc5f | ||
|
|
13eaea8aae | ||
|
|
ab5f348a4a | ||
|
|
11d624e92a | ||
|
|
a7797f8b37 | ||
|
|
c4dd0d4f95 | ||
|
|
f43fec0d57 | ||
|
|
af82c3debb | ||
|
|
1ab4d445ea | ||
|
|
678702ceb7 | ||
|
|
f9eb93c4ab | ||
|
|
f97a0a76f2 | ||
|
|
cf9b946eba | ||
|
|
7dc3924a3c | ||
|
|
20cf4b56b9 | ||
|
|
40d5b78eb8 | ||
|
|
8d0e767826 | ||
|
|
87a8c246a0 | ||
|
|
90050de717 | ||
|
|
10a7d1106d | ||
|
|
f2236f68f1 | ||
|
|
831fccdaee | ||
|
|
d2e691b63f | ||
|
|
2a508b6c99 | ||
|
|
02c3a6fffa | ||
|
|
26348764d4 | ||
|
|
f8a56ab6e6 | ||
|
|
75b4c7e56b | ||
|
|
9f1dfb1876 | ||
|
|
730b4204f6 | ||
|
|
4898704b5a | ||
|
|
0cf470f863 | ||
|
|
6220bde2d6 | ||
|
|
a4d3b57f37 | ||
|
|
618fbc63d7 | ||
|
|
3f51cb3fd1 | ||
|
|
59a947c5f5 | ||
|
|
1952290359 | ||
|
|
1a323165f9 | ||
|
|
9c2fdf5eae | ||
|
|
800c56642b | ||
|
|
b51fed025c | ||
|
|
34b72591cc | ||
|
|
bc450d110c | ||
|
|
388acf4727 | ||
|
|
3999977941 | ||
|
|
df58870e3f | ||
|
|
478a8741db | ||
|
|
7f710d2394 | ||
|
|
06e39e42d8 | ||
|
|
2ef0e20a3f | ||
|
|
b680d81f0a | ||
|
|
e0e067b1d6 | ||
|
|
3980791cfd | ||
|
|
497e27bb9a | ||
|
|
1db717b886 | ||
|
|
b47c8ccfb1 | ||
|
|
63b055283d | ||
|
|
b80e6914e7 | ||
|
|
9d00a137fe | ||
|
|
97d9e3c548 | ||
|
|
e4180936c1 | ||
|
|
34e0ecb44f | ||
|
|
d95e9737da | ||
|
|
b34991d85f | ||
|
|
5f44aa2873 | ||
|
|
dae643c040 | ||
|
|
ee62d5e1cf | ||
|
|
fb440f29a2 | ||
|
|
0f725b1880 | ||
|
|
39f56ba4b8 | ||
|
|
6959577aa4 | ||
|
|
50d4b0a386 | ||
|
|
9ff93bdb3d | ||
|
|
e0bf553aa5 | ||
|
|
2ce2d031fa | ||
|
|
186f562dd7 | ||
|
|
c5bbeb626f | ||
|
|
3bc77629c8 | ||
|
|
6cf1287c4e | ||
|
|
a49e8b9cf7 | ||
|
|
2eeec46040 | ||
|
|
6d5a4a20c5 | ||
|
|
4665ea3e77 | ||
|
|
9cf5eee5d4 | ||
|
|
12ad95067d |
2
.flake8
2
.flake8
@@ -7,5 +7,5 @@ extend-ignore =
|
||||
per-file-ignores =
|
||||
__init__.py: F401
|
||||
test/python/utils/test_json_writer.py: E131
|
||||
test/python/conftest.py: E402
|
||||
**/conftest.py: E402
|
||||
test/bdd/*: F821
|
||||
|
||||
35
.github/workflows/ci-tests.yml
vendored
35
.github/workflows/ci-tests.yml
vendored
@@ -44,11 +44,13 @@ jobs:
|
||||
postgresql: 12
|
||||
lua: '5.1'
|
||||
dependencies: pip
|
||||
python: '3.9'
|
||||
- flavour: ubuntu-24
|
||||
ubuntu: 24
|
||||
postgresql: 17
|
||||
postgresql: 18
|
||||
lua: '5.3'
|
||||
dependencies: apt
|
||||
python: 'builtin'
|
||||
|
||||
runs-on: ubuntu-${{ matrix.ubuntu }}.04
|
||||
|
||||
@@ -68,8 +70,22 @@ jobs:
|
||||
with:
|
||||
dependencies: ${{ matrix.dependencies }}
|
||||
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
/usr/local/bin/osm2pgsql
|
||||
key: osm2pgsql-bin-22-1
|
||||
if: matrix.ubuntu == '22'
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python }}
|
||||
if: matrix.python != 'builtin'
|
||||
|
||||
- name: Compile osm2pgsql
|
||||
run: |
|
||||
if [ ! -f /usr/local/bin/osm2pgsql ]; then
|
||||
sudo apt-get install -y -qq libboost-system-dev libboost-filesystem-dev libexpat1-dev zlib1g-dev libbz2-dev libpq-dev libproj-dev libicu-dev liblua${LUA_VERSION}-dev lua-dkjson nlohmann-json3-dev
|
||||
mkdir osm2pgsql-build
|
||||
cd osm2pgsql-build
|
||||
@@ -81,13 +97,13 @@ jobs:
|
||||
sudo make install
|
||||
cd ../..
|
||||
rm -rf osm2pgsql-build
|
||||
else
|
||||
sudo apt-get install -y -qq libexpat1 liblua${LUA_VERSION}
|
||||
fi
|
||||
if: matrix.ubuntu == '22'
|
||||
env:
|
||||
LUA_VERSION: ${{ matrix.lua }}
|
||||
|
||||
- name: Install test prerequisites
|
||||
run: ./venv/bin/pip install behave==1.2.6
|
||||
|
||||
- name: Install test prerequisites (apt)
|
||||
run: sudo apt-get install -y -qq python3-pytest python3-pytest-asyncio uvicorn python3-falcon python3-aiosqlite python3-pyosmium
|
||||
if: matrix.dependencies == 'apt'
|
||||
@@ -96,6 +112,9 @@ jobs:
|
||||
run: ./venv/bin/pip install pytest-asyncio falcon starlette asgi_lifespan aiosqlite osmium uvicorn
|
||||
if: matrix.dependencies == 'pip'
|
||||
|
||||
- name: Install test prerequisites
|
||||
run: ./venv/bin/pip install pytest-bdd
|
||||
|
||||
- name: Install latest flake8
|
||||
run: ./venv/bin/pip install -U flake8
|
||||
|
||||
@@ -108,7 +127,7 @@ jobs:
|
||||
if: matrix.dependencies == 'pip'
|
||||
|
||||
- name: Python static typechecking
|
||||
run: ../venv/bin/python -m mypy --strict --python-version 3.8 src
|
||||
run: ../venv/bin/python -m mypy --strict --python-version 3.9 src
|
||||
working-directory: Nominatim
|
||||
if: matrix.dependencies == 'pip'
|
||||
|
||||
@@ -118,8 +137,8 @@ jobs:
|
||||
|
||||
- name: BDD tests
|
||||
run: |
|
||||
../../../venv/bin/python -m behave -DREMOVE_TEMPLATE=1 --format=progress3
|
||||
working-directory: Nominatim/test/bdd
|
||||
../venv/bin/python -m pytest test/bdd --nominatim-purge
|
||||
working-directory: Nominatim
|
||||
|
||||
install:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -307,7 +326,7 @@ jobs:
|
||||
|
||||
- uses: ./Nominatim/.github/actions/setup-postgresql
|
||||
with:
|
||||
postgresql-version: 17
|
||||
postgresql-version: 18
|
||||
|
||||
- name: Install Python dependencies
|
||||
run: |
|
||||
|
||||
@@ -113,3 +113,5 @@ Checklist for releases:
|
||||
* run `nominatim --version` to confirm correct version
|
||||
* [ ] tag new release and add a release on github.com
|
||||
* [ ] build pip packages and upload to pypi
|
||||
* `make build`
|
||||
* `twine upload dist/*`
|
||||
|
||||
36
ChangeLog
36
ChangeLog
@@ -1,3 +1,39 @@
|
||||
5.2.0
|
||||
* increase minimum required Python to 3.9
|
||||
* index and output entrances of buildings and areas (thanks @emlove)
|
||||
* name tags used for creating display names are now configurable
|
||||
(thanks @astridx)
|
||||
* new pattern-replacement query preprocessor (thanks @TuringVerified)
|
||||
* special phrases can now be filtered by presence of tags (thanks @anqixxx)
|
||||
* lua import style now always includes tags required by Nominatim
|
||||
* improved query time reporting and logging
|
||||
* improve word matching for languages with no word boundaries
|
||||
* POIs with addresses inherited from surrounding building are no
|
||||
longer returned in the address layer
|
||||
* avoid creating a directory for the tokenizer when not needed
|
||||
* replace behave with pytest-bdd for BDD testing
|
||||
* refactoring and performance improvements to query parsing
|
||||
* various smaller updates to styles
|
||||
* remove English as default language for South Korea
|
||||
* remove Japanese word variants
|
||||
* updated country names for Norwegians (thanks @Johannes-Andersen)
|
||||
* remove support for deprecated osm2pgsql gazetteer style
|
||||
* fix updating of importances (also needs to update search_name table)
|
||||
* fix query for deletable endpoint to use index again
|
||||
* fix reindexing of contained places when a boundary is deleted and reinstated
|
||||
* fix difference computation error when updating postcodes
|
||||
* bracket handling sanitizer no longer strips bracket terms in the middle of
|
||||
name
|
||||
* reduce precision of stored coordinates to 7-digits everywhere
|
||||
* avoid ST_Relate as it seems buggy on some systems
|
||||
* remove setting for logging queries in DB, no longer functional
|
||||
* postcode updates no longer require a project directory (needed for tests)
|
||||
* refactor locale handling code (thanks @anqixxx)
|
||||
* code updates for newer Python (thanks @emmanuel-ferdman)
|
||||
* better test coverage (thanks @asharmalik19)
|
||||
* various fixes and improvements to documentation
|
||||
(thanks @anqixxx, @dave-meyer, @hasandiwan)
|
||||
|
||||
5.1.0
|
||||
* replace datrie with simple internal trie implementation
|
||||
* add pattern-based postcode parser for queries,
|
||||
|
||||
4
Makefile
4
Makefile
@@ -18,7 +18,7 @@ build-api:
|
||||
tests: mypy lint pytest bdd
|
||||
|
||||
mypy:
|
||||
mypy --strict --python-version 3.8 src
|
||||
mypy --strict --python-version 3.9 src
|
||||
|
||||
pytest:
|
||||
pytest test/python
|
||||
@@ -27,7 +27,7 @@ lint:
|
||||
flake8 src test/python test/bdd
|
||||
|
||||
bdd:
|
||||
cd test/bdd; behave -DREMOVE_TEMPLATE=1
|
||||
pytest test/bdd --nominatim-purge
|
||||
|
||||
# Documentation
|
||||
|
||||
|
||||
15
README.md
15
README.md
@@ -27,18 +27,25 @@ can be found at nominatim.org as well.
|
||||
|
||||
A quick summary of the necessary steps:
|
||||
|
||||
1. Create a Python virtualenv and install the packages:
|
||||
|
||||
1. Clone this git repository and download the country grid
|
||||
|
||||
git clone https://github.com/osm-search/Nominatim.git
|
||||
wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
|
||||
|
||||
2. Create a Python virtualenv and install the packages:
|
||||
|
||||
python3 -m venv nominatim-venv
|
||||
./nominatim-venv/bin/pip install packaging/nominatim-{api,db}
|
||||
|
||||
2. Create a project directory, get OSM data and import:
|
||||
3. Create a project directory, get OSM data and import:
|
||||
|
||||
mkdir nominatim-project
|
||||
cd nominatim-project
|
||||
../nominatim-venv/bin/nominatim import --osm-file <your planet file>
|
||||
../nominatim-venv/bin/nominatim import --osm-file <your planet file> 2>&1 | tee setup.log
|
||||
|
||||
3. Start the webserver:
|
||||
|
||||
4. Start the webserver:
|
||||
|
||||
./nominatim-venv/bin/pip install uvicorn falcon
|
||||
../nominatim-venv/bin/nominatim serve
|
||||
|
||||
@@ -9,11 +9,11 @@ versions.
|
||||
|
||||
| Version | End of support for security updates |
|
||||
| ------- | ----------------------------------- |
|
||||
| 5.2.x | 2027-10-29 |
|
||||
| 5.1.x | 2027-04-01 |
|
||||
| 5.0.x | 2027-02-06 |
|
||||
| 4.5.x | 2026-09-12 |
|
||||
| 4.4.x | 2026-03-07 |
|
||||
| 4.3.x | 2025-09-07 |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
@@ -32,8 +32,7 @@ description of the nature and severity of the issue. **
|
||||
Patches for identified security issues are applied to all affected versions and
|
||||
new minor versions are released. At the same time we release a statement at
|
||||
the [Nominatim blog](https://nominatim.org/blog/) describing the nature of the
|
||||
incident. Announcements will also be published at the
|
||||
[geocoding mailinglist](https://lists.openstreetmap.org/listinfo/geocoding).
|
||||
incident.
|
||||
|
||||
## List of Previous Incidents
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ For running Nominatim:
|
||||
* [PostgreSQL](https://www.postgresql.org) (12+ will work, 13+ strongly recommended)
|
||||
* [PostGIS](https://postgis.net) (3.0+ will work, 3.2+ strongly recommended)
|
||||
* [osm2pgsql](https://osm2pgsql.org) (1.8+)
|
||||
* [Python 3](https://www.python.org/) (3.7+)
|
||||
* [Python 3](https://www.python.org/) (3.9+)
|
||||
|
||||
Furthermore the following Python libraries are required:
|
||||
|
||||
@@ -110,14 +110,17 @@ Then you can install Nominatim with:
|
||||
|
||||
pip install nominatim-db nominatim-api
|
||||
|
||||
## Downloading and building Nominatim
|
||||
## Downloading and building Nominatim from source
|
||||
|
||||
The following instructions are only relevant, if you want to build and
|
||||
install Nominatim **from source**.
|
||||
|
||||
### Downloading the latest release
|
||||
|
||||
You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
|
||||
The release contains all necessary files. Just unpack it.
|
||||
|
||||
### Downloading the latest development version
|
||||
### Downloading the source for the latest development version
|
||||
|
||||
If you want to install latest development version from github:
|
||||
|
||||
@@ -131,7 +134,7 @@ The development version does not include the country grid. Download it separatel
|
||||
wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
|
||||
```
|
||||
|
||||
### Building Nominatim
|
||||
### Building Nominatim from source
|
||||
|
||||
Nominatim is easiest to run from its own virtual environment. To create one, run:
|
||||
|
||||
|
||||
@@ -17,6 +17,18 @@ breaking changes. **Please read them before running the migration.**
|
||||
and migrate to 4.3 first. Then you can migrate to the current
|
||||
version. It is strongly recommended to do a reimport instead.
|
||||
|
||||
## 5.1.0 -> 5.2.0
|
||||
|
||||
### Lua import style: required extratags removed
|
||||
|
||||
Tags that are required by Nominatim as extratags are now always included
|
||||
independent of what is defined in the style. The line
|
||||
|
||||
flex.add_for_extratags('required')
|
||||
|
||||
is no longer required in custom styles and will throw an error. Simply
|
||||
remove the line from your style.
|
||||
|
||||
## 4.5.0 -> 5.0.0
|
||||
|
||||
### PHP frontend removed
|
||||
|
||||
@@ -36,11 +36,11 @@ The website is now available at `http://localhost:8765`.
|
||||
## Forwarding searches to nominatim-ui
|
||||
|
||||
Nominatim used to provide the search interface directly by itself when
|
||||
`format=html` was requested. For all endpoints except for `/reverse` and
|
||||
`/lookup` this even used to be the default.
|
||||
`format=html` was requested. For the `/search` endpoint this even used
|
||||
to be the default.
|
||||
|
||||
The following section describes how to set up Apache or nginx, so that your
|
||||
users are forwarded to nominatim-ui when they go to URL that formerly presented
|
||||
users are forwarded to nominatim-ui when they go to a URL that formerly presented
|
||||
the UI.
|
||||
|
||||
### Setting up forwarding in Nginx
|
||||
@@ -73,41 +73,28 @@ map $args $format {
|
||||
|
||||
# Determine from the URI and the format parameter above if forwarding is needed.
|
||||
map $uri/$format $forward_to_ui {
|
||||
default 1; # The default is to forward.
|
||||
~^/ui 0; # If the URI point to the UI already, we are done.
|
||||
~/other$ 0; # An explicit non-html format parameter. No forwarding.
|
||||
~/reverse.*/default 0; # Reverse and lookup assume xml format when
|
||||
~/lookup.*/default 0; # no format parameter is given. No forwarding.
|
||||
default 0; # no forwarding by default
|
||||
~/search.*/default 1; # Use this line only, if search should go to UI by default.
|
||||
~/reverse.*/html 1; # Forward API calls that UI supports, when
|
||||
~/status.*/html 1; # format=html is explicitly requested.
|
||||
~/search.*/html 1;
|
||||
~/details.*/html 1;
|
||||
}
|
||||
```
|
||||
|
||||
The `$forward_to_ui` parameter can now be used to conditionally forward the
|
||||
calls:
|
||||
|
||||
```
|
||||
# When no endpoint is given, default to search.
|
||||
# Need to add a rewrite so that the rewrite rules below catch it correctly.
|
||||
rewrite ^/$ /search;
|
||||
|
||||
location @php {
|
||||
# fastcgi stuff..
|
||||
``` nginx
|
||||
location / {
|
||||
if ($forward_to_ui) {
|
||||
rewrite ^(/[^/]*) https://yourserver.com/ui$1.html redirect;
|
||||
}
|
||||
rewrite ^(/[^/.]*) https://$http_host/ui$1.html redirect;
|
||||
}
|
||||
|
||||
location ~ [^/]\.php(/|$) {
|
||||
# fastcgi stuff..
|
||||
if ($forward_to_ui) {
|
||||
rewrite (.*).php https://yourserver.com/ui$1.html redirect;
|
||||
}
|
||||
# proxy_pass commands
|
||||
}
|
||||
```
|
||||
|
||||
!!! warning
|
||||
Be aware that the rewrite commands are slightly different for URIs with and
|
||||
without the .php suffix.
|
||||
|
||||
Reload nginx and the UI should be available.
|
||||
|
||||
### Setting up forwarding in Apache
|
||||
@@ -159,18 +146,16 @@ directory like this:
|
||||
RewriteBase "/nominatim/"
|
||||
|
||||
# If no endpoint is given, then use search.
|
||||
RewriteRule ^(/|$) "search.php"
|
||||
RewriteRule ^(/|$) "search"
|
||||
|
||||
# If format-html is explicitly requested, forward to the UI.
|
||||
RewriteCond %{QUERY_STRING} "format=html"
|
||||
RewriteRule ^([^/]+)(.php)? ui/$1.html [R,END]
|
||||
RewriteRule ^([^/.]+) ui/$1.html [R,END]
|
||||
|
||||
# If no format parameter is there then forward anything
|
||||
# but /reverse and /lookup to the UI.
|
||||
# Optionally: if no format parameter is there then forward /search.
|
||||
RewriteCond %{QUERY_STRING} "!format="
|
||||
RewriteCond %{REQUEST_URI} "!/lookup"
|
||||
RewriteCond %{REQUEST_URI} "!/reverse"
|
||||
RewriteRule ^([^/]+)(.php)? ui/$1.html [R,END]
|
||||
RewriteCond %{REQUEST_URI} "/search"
|
||||
RewriteRule ^([^/.]+) ui/$1.html [R,END]
|
||||
</Directory>
|
||||
```
|
||||
|
||||
|
||||
@@ -105,6 +105,13 @@ grouped by type.
|
||||
|
||||
Include geometry of result.
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| entrances | 0 or 1 | 0 |
|
||||
|
||||
When set to 1, include the tagged entrances in the result.
|
||||
|
||||
|
||||
### Language of results
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|
||||
@@ -49,7 +49,7 @@ Only has an effect for JSON output formats.
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| addressdetails | 0 or 1 | 0 |
|
||||
| addressdetails | 0 or 1 | 1 |
|
||||
|
||||
When set to 1, include a breakdown of the address into elements.
|
||||
The exact content of the address breakdown depends on the output format.
|
||||
@@ -77,6 +77,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
||||
When set to 1, include a full list of names for the result. These may include
|
||||
language variants, older names, references and brand.
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| entrances | 0 or 1 | 0 |
|
||||
|
||||
When set to 1, include the tagged entrances in the result.
|
||||
|
||||
|
||||
### Language of results
|
||||
|
||||
|
||||
@@ -60,6 +60,8 @@ The possible fields are:
|
||||
* `namedetails` - dictionary with full list of available names including ref etc.
|
||||
* `geojson`, `svg`, `geotext`, `geokml` - full geometry
|
||||
(only with the appropriate `polygon_*` parameter)
|
||||
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||
null if none are found (only with `entrances=1`)
|
||||
|
||||
## JSONv2
|
||||
|
||||
@@ -87,6 +89,8 @@ The properties object has the following fields:
|
||||
* `extratags` - dictionary with additional useful tags like `website` or `maxspeed`
|
||||
(only with `extratags=1`)
|
||||
* `namedetails` - dictionary with full list of available names including ref etc.
|
||||
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||
null if none are found (only with `entrances=1`)
|
||||
|
||||
Use `polygon_geojson` to output the full geometry of the object instead
|
||||
of the centroid.
|
||||
@@ -110,6 +114,8 @@ The following feature attributes are implemented:
|
||||
* `admin` - list of localised names of administrative boundaries (only with `addressdetails=1`)
|
||||
* `extra` - dictionary with additional useful tags like `website` or `maxspeed`
|
||||
(only with `extratags=1`)
|
||||
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||
null if none are found (only with `entrances=1`)
|
||||
|
||||
|
||||
Use `polygon_geojson` to output the full geometry of the object instead
|
||||
@@ -162,8 +168,8 @@ The place information can be found in the `result` element. The attributes of th
|
||||
The full address of the result can be found in the content of the
|
||||
`result` element as a comma-separated list.
|
||||
|
||||
Additional information requested with `addressdetails=1`, `extratags=1` and
|
||||
`namedetails=1` can be found in extra elements.
|
||||
Additional information requested with `addressdetails=1`, `extratags=1`,
|
||||
`namedetails=1`, and `entrances=1` can be found in extra elements.
|
||||
|
||||
### Search and Lookup
|
||||
|
||||
@@ -224,9 +230,9 @@ be more than one. The attributes of that element contain:
|
||||
When `addressdetails=1` is requested, the localised address parts appear
|
||||
as subelements with the type of the address part.
|
||||
|
||||
Additional information requested with `extratags=1` and `namedetails=1` can
|
||||
be found in extra elements as sub-element of `extratags` and `namedetails`
|
||||
respectively.
|
||||
Additional information requested with `extratags=1`, `namedetails=1`, and
|
||||
`entrances=1` can be found in extra elements as sub-element of `extratags`,
|
||||
`namedetails`, and `entrances` respectively.
|
||||
|
||||
|
||||
## Notes on field values
|
||||
@@ -303,3 +309,78 @@ with a designation label. Per default the following labels may appear:
|
||||
|
||||
They roughly correspond to the classification of the OpenStreetMap data
|
||||
according to either the `place` tag or the main key of the object.
|
||||
|
||||
### entrances
|
||||
|
||||
Entrance details in the xml and json formats return the latitude and longitude
|
||||
of the entrance, the osm node ID, the [type of
|
||||
entrance](https://wiki.openstreetmap.org/wiki/Key:entrance), and any extra tags
|
||||
associated with the entrance node.
|
||||
|
||||
* osm_id
|
||||
* type
|
||||
* lat
|
||||
* lon
|
||||
* extratags
|
||||
|
||||
They roughly correspond to the classification of the OpenStreetMap data
|
||||
according to either the `place` tag or the main key of the object.
|
||||
|
||||
#### Example
|
||||
|
||||
##### JSON
|
||||
|
||||
[https://nominatim.openstreetmap.org/details?osmtype=W&osmid=32619803&entrances=1&format=json](https://nominatim.openstreetmap.org/details?osmtype=W&osmid=32619803&entrances=1&format=json)
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"place_id": 124325848,
|
||||
"parent_place_id": 123936289,
|
||||
"osm_type": "W",
|
||||
"osm_id": 32619803,
|
||||
"category": "shop",
|
||||
"type": "supermarket",
|
||||
"admin_level": 15,
|
||||
"localname": "PENNY",
|
||||
...
|
||||
"entrances": [
|
||||
{
|
||||
"osm_id": 1733488238,
|
||||
"type": "yes",
|
||||
"lat": "51.0466704",
|
||||
"lon": "12.8077106",
|
||||
"extratags": {
|
||||
"foot": "yes"
|
||||
}
|
||||
},
|
||||
{
|
||||
"osm_id": 1733488256,
|
||||
"type": "main",
|
||||
"lat": "51.0467197",
|
||||
"lon": "12.8078448",
|
||||
"extratags": {
|
||||
"foot": "yes"
|
||||
}
|
||||
},
|
||||
{
|
||||
"osm_id": 1733498087,
|
||||
"type": "exit",
|
||||
"lat": "51.0467081",
|
||||
"lon": "12.8078131",
|
||||
"extratags": {
|
||||
"foot": "yes"
|
||||
}
|
||||
},
|
||||
{
|
||||
"osm_id": 7914950851,
|
||||
"type": "service",
|
||||
"lat": "51.0468487",
|
||||
"lon": "12.8075876",
|
||||
"extratags": {
|
||||
"access": "delivery"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -98,6 +98,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
||||
When set to 1, include a full list of names for the result. These may include
|
||||
language variants, older names, references and brand.
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| entrances | 0 or 1 | 0 |
|
||||
|
||||
When set to 1, include the tagged entrances in the result.
|
||||
|
||||
|
||||
### Language of results
|
||||
|
||||
@@ -146,7 +152,7 @@ In terms of address details the zoom levels are as follows:
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| layer | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | _unset_ (no restriction) |
|
||||
| layer | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | `address,poi` |
|
||||
|
||||
The layer filter allows to select places by themes.
|
||||
|
||||
@@ -212,7 +218,7 @@ This overrides the specified machine readable format.
|
||||
|
||||
## Examples
|
||||
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=xml&lat=52.5487429714954&lon=-1.81602098644987&zoom=18&addressdetails=1](https://nominatim.openstreetmap.org/reverse?format=xml&lat=52.5487429714954&lon=-1.81602098644987&zoom=18&addressdetails=1)
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=xml&lat=52.5487429714954&lon=-1.81602098644987&zoom=18&addressdetails=1&layer=address](https://nominatim.openstreetmap.org/reverse?format=xml&lat=52.5487429714954&lon=-1.81602098644987&zoom=18&addressdetails=1&layer=address)
|
||||
|
||||
```xml
|
||||
<reversegeocode timestamp="Fri, 06 Nov 09 16:33:54 +0000" querystring="...">
|
||||
@@ -235,7 +241,7 @@ This overrides the specified machine readable format.
|
||||
|
||||
##### Example with `format=jsonv2`
|
||||
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=jsonv2&lat=-34.44076&lon=-58.70521](https://nominatim.openstreetmap.org/reverse?format=jsonv2&lat=-34.44076&lon=-58.70521)
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=jsonv2&lat=-34.44076&lon=-58.70521&layer=address](https://nominatim.openstreetmap.org/reverse?format=jsonv2&lat=-34.44076&lon=-58.70521&layer=address)
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -267,7 +273,7 @@ This overrides the specified machine readable format.
|
||||
|
||||
##### Example with `format=geojson`
|
||||
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=geojson&lat=44.50155&lon=11.33989](https://nominatim.openstreetmap.org/reverse?format=geojson&lat=44.50155&lon=11.33989)
|
||||
* [https://nominatim.openstreetmap.org/reverse?format=geojson&lat=44.50155&lon=11.33989&layer=address](https://nominatim.openstreetmap.org/reverse?format=geojson&lat=44.50155&lon=11.33989&layer=address)
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -319,7 +325,7 @@ This overrides the specified machine readable format.
|
||||
|
||||
##### Example with `format=geocodejson`
|
||||
|
||||
[https://nominatim.openstreetmap.org/reverse?format=geocodejson&lat=60.2299&lon=11.1663](https://nominatim.openstreetmap.org/reverse?format=geocodejson&lat=60.2299&lon=11.1663)
|
||||
[https://nominatim.openstreetmap.org/reverse?format=geocodejson&lat=60.2299&lon=11.1663&layer=address](https://nominatim.openstreetmap.org/reverse?format=geocodejson&lat=60.2299&lon=11.1663&layer=address)
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@@ -136,6 +136,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
||||
When set to 1, include a full list of names for the result. These may include
|
||||
language variants, older names, references and brand.
|
||||
|
||||
| Parameter | Value | Default |
|
||||
|-----------| ----- | ------- |
|
||||
| entrances | 0 or 1 | 0 |
|
||||
|
||||
When set to 1, include the tagged entrances in the result.
|
||||
|
||||
|
||||
### Language of results
|
||||
|
||||
@@ -212,7 +218,7 @@ other layers.
|
||||
The featureType allows to have a more fine-grained selection for places
|
||||
from the address layer. Results can be restricted to places that make up
|
||||
the 'state', 'country' or 'city' part of an address. A featureType of
|
||||
settlement selects any human inhabited feature from 'state' down to
|
||||
`settlement` selects any human inhabited feature from 'state' down to
|
||||
'neighbourhood'.
|
||||
|
||||
When featureType is set, then results are automatically restricted
|
||||
|
||||
@@ -36,18 +36,27 @@ local flex = require('flex-base')
|
||||
### Using preset configurations
|
||||
|
||||
If you want to start with one of the existing presets, then you can import
|
||||
its settings using the `import_topic()` function:
|
||||
its settings using the `load_topic()` function:
|
||||
|
||||
```
|
||||
``` lua
|
||||
local flex = require('flex-base')
|
||||
|
||||
flex.import_topic('streets')
|
||||
flex.load_topic('streets')
|
||||
```
|
||||
|
||||
The `import_topic` function takes an optional second configuration
|
||||
The `load_topic` function takes an optional second configuration
|
||||
parameter. The available options are explained in the
|
||||
[themepark section](#using-osm2pgsql-themepark).
|
||||
|
||||
Available topics are: `admin`, `street`, `address`, `full`. These topic
|
||||
correspond to the [import styles](../admin/Import.md#filtering-imported-data)
|
||||
you can choose during import. To start with the 'extratags' style, use the
|
||||
`full` topic with the appropriate config parameter:
|
||||
|
||||
``` lua
|
||||
flex.load_topic('full', {with_extratags = true})
|
||||
```
|
||||
|
||||
!!! note
|
||||
You can also directly import the preset style files, e.g.
|
||||
`local flex = require('import-street')`. It is not possible to
|
||||
@@ -59,15 +68,16 @@ When Nominatim processes an OSM object, it looks for four kinds of tags:
|
||||
The _main tags_ classify what kind of place the OSM object represents. One
|
||||
OSM object can have more than one main tag. In such case one database entry
|
||||
is created for each main tag. _Name tags_ represent searchable names of the
|
||||
place. _Address tags_ are used to compute the address hierarchy of the place.
|
||||
place. _Address tags_ are used to compute the address information of the place.
|
||||
Address tags are used for searching and for creating a display name of the place.
|
||||
_Extra tags_ are any tags that are not directly related to search but
|
||||
contain interesting additional information.
|
||||
contain interesting additional information. These are just saved in the database
|
||||
and may be returned with the result [on request](../api/Search.md#output-details).
|
||||
|
||||
!!! danger
|
||||
Some tags in the extratags category are used by Nominatim to better
|
||||
classify the place. You want to make sure these are always present
|
||||
in custom styles.
|
||||
classify the place. These tags will always be added, independent of
|
||||
any settings in the style.
|
||||
|
||||
Configuring the style means deciding which key and/or key/value is used
|
||||
in which category.
|
||||
@@ -116,8 +126,10 @@ value without key, then this is used as default for values that are not listed.
|
||||
|
||||
`set_main_tags()` will completely replace the current main tag configuration
|
||||
with the new configuration. `modify_main_tags()` will merge the new
|
||||
configuration with the existing one. Otherwise, the two functions do exactly
|
||||
the same.
|
||||
configuration with the existing one. Merging is done at value level.
|
||||
For example, when the current setting is `highway = {'always', primary = 'named'}`,
|
||||
then `set_main_tags{highway = 'delete'}` will result in a rule
|
||||
`highway = {'delete', primary = 'named'}`.
|
||||
|
||||
!!! example
|
||||
``` lua
|
||||
@@ -134,9 +146,9 @@ the same.
|
||||
when it has a value of `administrative`. Objects with `highway` tags are
|
||||
always included with two exceptions: the troll tag `highway=no` is
|
||||
deleted on the spot. And when the value is `street_lamp` then the object
|
||||
must have a name, too. Finally, if a `landuse` tag is present then
|
||||
it will be used independently of the concrete value when neither boundary
|
||||
nor highway tags were found and the object is named.
|
||||
must also have a name, to be included. Finally, if a `landuse` tag is
|
||||
present then it will be used independently of the concrete value when
|
||||
neither boundary nor highway tags were found and the object is named.
|
||||
|
||||
##### Presets
|
||||
|
||||
@@ -255,11 +267,7 @@ in turn take precedence over prefix matches.
|
||||
|
||||
##### Presets
|
||||
|
||||
| Name | Description |
|
||||
| :----- | :---------- |
|
||||
| required | Tags that Nominatim will use for various computations when present in extratags. Always include these. |
|
||||
|
||||
In addition, all [presets from ignored tags](#presets_1) are accepted.
|
||||
Accepts all [presets from ignored tags](#presets_1).
|
||||
|
||||
### General pre-filtering
|
||||
|
||||
@@ -415,6 +423,56 @@ is added for extratags.
|
||||
already delete the tiger tags with `set_prefilters()` because that
|
||||
would remove tiger:county before the address tags are processed.
|
||||
|
||||
## Filling additional tables
|
||||
|
||||
Most of the OSM objects are saved in the main `place` table for further
|
||||
processing. In addition to that, there are some smaller tables that save
|
||||
specialised information. The content of these tables can be customized as
|
||||
well.
|
||||
|
||||
### Entrance table
|
||||
|
||||
The table `place_entrance` saves information about OSM nodes that represent
|
||||
an entrance. This data is later mingled with buildings and other areas and
|
||||
can be returned [on request](../api/Search.md#output-details). The table
|
||||
saves the type of entrance as well as a set of custom extra tags.
|
||||
|
||||
The function `set_entrance_filter()` can be used to customize the table's
|
||||
content.
|
||||
|
||||
When called without any parameter, then filling the entrance table will be
|
||||
disabled. When called with a preset name, the appropriate preset will be
|
||||
applied.
|
||||
|
||||
To create a custom configuration, call the function
|
||||
with a table with the following fields:
|
||||
|
||||
* __main_tags__ is a list of tags that mark an entrance node. The value of the
|
||||
first tag found in the list will be used as the entrance type.
|
||||
* __extra_include__ is an optional list of tags to be added to the extratags
|
||||
for this entrance. When left out, all tags except for the ones defined
|
||||
in 'main_tags' will be included. To disable saving of extra tags, set
|
||||
this to the empty list.
|
||||
* __extra_exclude__ defines an optional list of tags to drop before including
|
||||
the remaining tags as extratags. Note that the tags defined in 'main_tags'
|
||||
will always be excluded, independently of this setting.
|
||||
|
||||
To have even more fine-grained control over the output, you can also hand
|
||||
in a callback for processing entrance information. The callback function
|
||||
receives a single parameter, the
|
||||
[osm2pgsql object](https://osm2pgsql.org/doc/manual.html#processing-callbacks).
|
||||
This object itself must not be modified. The callback should return either
|
||||
`nil` when the object is not an entrance. Or it returns a table with a
|
||||
mandatory `entrance` field containing a string with the type of entrance
|
||||
and an optional `extratags` field with a simple key-value table of extra
|
||||
information.
|
||||
|
||||
##### Presets
|
||||
|
||||
| Name | Description |
|
||||
| :----- | :---------- |
|
||||
| default | Standard configuration used with `full` and `extratags` styles. |
|
||||
|
||||
## Customizing osm2pgsql callbacks
|
||||
|
||||
osm2pgsql expects the flex style to implement three callbacks, one process
|
||||
@@ -556,16 +614,6 @@ the Nominatim topic.
|
||||
```
|
||||
Discarding country-level boundaries when running under themepark.
|
||||
|
||||
## osm2pgsql gazetteer output
|
||||
|
||||
Nominatim still allows you to configure the gazetteer output to remain
|
||||
backwards compatible with older imports. It will be automatically used
|
||||
when the style file name ends in `.style`. For documentation of the
|
||||
old import style, please refer to the documentation of older releases
|
||||
of Nominatim. Do not use the gazetteer output for new imports. There is no
|
||||
guarantee that new versions of Nominatim are fully compatible with the
|
||||
gazetteer output.
|
||||
|
||||
## Changing the style of existing databases
|
||||
|
||||
There is usually no issue changing the style of a database that is already
|
||||
|
||||
@@ -602,25 +602,44 @@ results gathered so far.
|
||||
Note that under high load you may observe that users receive different results
|
||||
than usual without seeing an error. This may cause some confusion.
|
||||
|
||||
### Logging Settings
|
||||
|
||||
#### NOMINATIM_LOG_DB
|
||||
#### NOMINATIM_OUTPUT_NAMES
|
||||
|
||||
| Summary | |
|
||||
| -------------- | --------------------------------------------------- |
|
||||
| **Description:** | Log requests into the database |
|
||||
| **Format:** | boolean |
|
||||
| **Default:** | no |
|
||||
| **After Changes:** | run `nominatim refresh --website` |
|
||||
| **Description:** | Specifies order of name tags |
|
||||
| **Format:** | string: comma-separated list of tag names |
|
||||
| **Default:** | name:XX,name,brand,official_name:XX,short_name:XX,official_name,short_name,ref |
|
||||
|
||||
Enable logging requests into a database table with this setting. The logs
|
||||
can be found in the table `new_query_log`.
|
||||
Specifies the order in which different name tags are used.
|
||||
The values in this list determine the preferred order of name variants,
|
||||
including language-specific names (in OSM: the name tag with and without any language suffix).
|
||||
|
||||
When using this logging method, it is advisable to set up a job that
|
||||
regularly clears out old logging information. Nominatim will not do that
|
||||
on its own.
|
||||
Comma-separated list, where :XX stands for language suffix
|
||||
(e.g. name:en) and no :XX stands for general tags (e.g. name).
|
||||
|
||||
Can be used as the same time as NOMINATIM_LOG_FILE.
|
||||
See also [NOMINATIM_DEFAULT_LANGUAGE](#nominatim_default_language).
|
||||
|
||||
!!! note
|
||||
If NOMINATIM_OUTPUT_NAMES = `name:XX,name,short_name:XX,short_name` the search follows
|
||||
|
||||
```
|
||||
'name', 'short_name'
|
||||
```
|
||||
|
||||
if we have no preferred language order for showing search results.
|
||||
|
||||
For languages ['en', 'es'] the search follows
|
||||
|
||||
```
|
||||
'name:en', 'name:es',
|
||||
'name',
|
||||
'short_name:en', 'short_name:es',
|
||||
'short_name'
|
||||
```
|
||||
|
||||
For those familiar with the internal implementation, the `_place_*` expansion is added, but to simplify, it is not included in this example.
|
||||
|
||||
### Logging Settings
|
||||
|
||||
#### NOMINATIM_LOG_FILE
|
||||
|
||||
@@ -629,23 +648,53 @@ Can be used as the same time as NOMINATIM_LOG_FILE.
|
||||
| **Description:** | Log requests into a file |
|
||||
| **Format:** | path |
|
||||
| **Default:** | _empty_ (logging disabled) |
|
||||
| **After Changes:** | run `nominatim refresh --website` |
|
||||
|
||||
Enable logging of requests into a file with this setting by setting the log
|
||||
file where to log to. A relative file name is assumed to be relative to
|
||||
the project directory.
|
||||
the project directory. The format of the log output can be set
|
||||
with NOMINATIM_LOG_FORMAT.
|
||||
|
||||
#### NOMINATIM_LOG_FORMAT
|
||||
|
||||
The entries in the log file have the following format:
|
||||
| Summary | |
|
||||
| -------------- | --------------------------------------------------- |
|
||||
| **Description:** | Log requests into a file |
|
||||
| **Format:** | [Python String Format](https://docs.python.org/3/library/string.html#formatstrings) string |
|
||||
| **Default:** | `[{start}] {total_time:.4f} {results_total} {endpoint} "{query_string}"` |
|
||||
|
||||
<request time> <execution time in s> <number of results> <type> "<query string>"
|
||||
Describes the content of a log line for a single request. The format
|
||||
must be readable by Python's format function. Nominatim provides a number
|
||||
of metrics than can be logged. The default set of metrics is the following:
|
||||
|
||||
Request time is the time when the request was started. The execution time is
|
||||
given in seconds and includes the entire time the query was queued and executed
|
||||
in the frontend.
|
||||
type contains the name of the endpoint used.
|
||||
/// html | div.simple-table
|
||||
| name | type | Description |
|
||||
| --------------- | ------ | ------------|
|
||||
| start | time | Point in time when the request arrived. |
|
||||
| end | time | Point in time when the request was done. |
|
||||
| query_start | time | Point in time when processing started. |
|
||||
| total_time | float | Total time in seconds to handle the request. |
|
||||
| wait_time | float | Time in seconds the request waited for a database connection to be available. |
|
||||
| query_time | float | Total time in seconds to process the request once a connection was available. |
|
||||
| results_total | int | Number of results found. |
|
||||
| endpoint | string | API endpoint used. |
|
||||
| query_string | string | Raw query string received. |
|
||||
///
|
||||
|
||||
Variables of type 'time' contain a UTC timestamp string in ISO format.
|
||||
|
||||
Nominatim also exposes additional metrics to help with development. These
|
||||
are subject to change between versions:
|
||||
|
||||
/// html | div.simple-table
|
||||
| name | type | Description |
|
||||
| ------------------------- | ------ | ------------|
|
||||
| search_rounds | int | Total number of searches executed for the request. |
|
||||
| search_min_penalty | float | Minimal possible penalty for the request. |
|
||||
| search_first_result_round | int | Number of first search to yield any result. |
|
||||
| search_min_result_penalty | float | Minimal penalty by a result found. |
|
||||
| search_best_penalty_round | int | Search round that yielded the best penalty result. |
|
||||
///
|
||||
|
||||
Can be used as the same time as NOMINATIM_LOG_DB.
|
||||
|
||||
#### NOMINATIM_DEBUG_SQL
|
||||
|
||||
|
||||
@@ -67,7 +67,13 @@ Here is an example configuration file:
|
||||
|
||||
``` yaml
|
||||
query-preprocessing:
|
||||
- normalize
|
||||
- step: split_japanese_phrases
|
||||
- step: regex_replace
|
||||
replacements:
|
||||
- pattern: https?://[^\s]* # Filter URLs starting with http or https
|
||||
replace: ''
|
||||
- step: normalize
|
||||
|
||||
normalization:
|
||||
- ":: lower ()"
|
||||
- "ß > 'ss'" # German szet is unambiguously equal to double ss
|
||||
@@ -88,8 +94,8 @@ token-analysis:
|
||||
replacements: ['ä', 'ae']
|
||||
```
|
||||
|
||||
The configuration file contains four sections:
|
||||
`normalization`, `transliteration`, `sanitizers` and `token-analysis`.
|
||||
The configuration file contains five sections:
|
||||
`query-preprocessing`, `normalization`, `transliteration`, `sanitizers` and `token-analysis`.
|
||||
|
||||
#### Query preprocessing
|
||||
|
||||
@@ -106,6 +112,19 @@ The following is a list of preprocessors that are shipped with Nominatim.
|
||||
heading_level: 6
|
||||
docstring_section_style: spacy
|
||||
|
||||
##### regex-replace
|
||||
|
||||
::: nominatim_api.query_preprocessing.regex_replace
|
||||
options:
|
||||
members: False
|
||||
heading_level: 6
|
||||
docstring_section_style: spacy
|
||||
description:
|
||||
This option runs any given regex pattern on the input and replaces values accordingly
|
||||
replacements:
|
||||
- pattern: regex pattern
|
||||
replace: string to replace with
|
||||
|
||||
|
||||
#### Normalization and Transliteration
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
### Import tables
|
||||
|
||||
OSM data is initially imported using [osm2pgsql](https://osm2pgsql.org).
|
||||
Nominatim uses its own data output style 'gazetteer', which differs from the
|
||||
output style created for map rendering.
|
||||
Nominatim uses a custom flex style to create the initial import tables.
|
||||
|
||||
The import process creates the following tables:
|
||||
|
||||
@@ -14,7 +13,7 @@ The `planet_osm_*` tables are the usual backing tables for OSM data. Note
|
||||
that Nominatim uses them to look up special relations and to find nodes on
|
||||
ways.
|
||||
|
||||
The gazetteer style produces a single table `place` as output with the following
|
||||
The osm2pgsql import produces a single table `place` as output with the following
|
||||
columns:
|
||||
|
||||
* `osm_type` - kind of OSM object (**N** - node, **W** - way, **R** - relation)
|
||||
|
||||
@@ -25,15 +25,15 @@ following packages should get you started:
|
||||
|
||||
## Prerequisites for testing and documentation
|
||||
|
||||
The Nominatim test suite consists of behavioural tests (using behave) and
|
||||
The Nominatim test suite consists of behavioural tests (using pytest-bdd) and
|
||||
unit tests (using pytest). It has the following additional requirements:
|
||||
|
||||
* [behave test framework](https://behave.readthedocs.io) >= 1.2.6
|
||||
* [flake8](https://flake8.pycqa.org/en/stable/) (CI always runs the latest version from pip)
|
||||
* [mypy](http://mypy-lang.org/) (plus typing information for external libs)
|
||||
* [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
|
||||
* [pytest](https://pytest.org)
|
||||
* [pytest-asyncio](https://pytest-asyncio.readthedocs.io)
|
||||
* [pytest-bdd](https://pytest-bdd.readthedocs.io)
|
||||
|
||||
For testing the Python search frontend, you need to install extra dependencies
|
||||
depending on your choice of webserver framework:
|
||||
@@ -48,9 +48,6 @@ The documentation is built with mkdocs:
|
||||
* [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
|
||||
* [mkdocs-gen-files](https://oprypin.github.io/mkdocs-gen-files/)
|
||||
|
||||
Please be aware that tests always run against the globally installed
|
||||
osm2pgsql, so you need to have this set up. If you want to test against
|
||||
the vendored version of osm2pgsql, you need to set the PATH accordingly.
|
||||
|
||||
### Installing prerequisites on Ubuntu/Debian
|
||||
|
||||
@@ -70,8 +67,9 @@ To set up the virtual environment with all necessary packages run:
|
||||
virtualenv ~/nominatim-dev-venv
|
||||
~/nominatim-dev-venv/bin/pip install\
|
||||
psutil 'psycopg[binary]' PyICU SQLAlchemy \
|
||||
python-dotenv jinja2 pyYAML behave \
|
||||
mkdocs 'mkdocstrings[python]' mkdocs-gen-files pytest pytest-asyncio flake8 \
|
||||
python-dotenv jinja2 pyYAML \
|
||||
mkdocs 'mkdocstrings[python]' mkdocs-gen-files \
|
||||
pytest pytest-asyncio pytest-bdd flake8 \
|
||||
types-jinja2 types-markupsafe types-psutil types-psycopg2 \
|
||||
types-pygments types-pyyaml types-requests types-ujson \
|
||||
types-urllib3 typing-extensions unicorn falcon starlette \
|
||||
@@ -94,7 +92,7 @@ but executes against the code in the source tree. For example:
|
||||
```
|
||||
me@machine:~$ cd Nominatim
|
||||
me@machine:~Nominatim$ ./nominatim-cli.py --version
|
||||
Nominatim version 4.4.99-1
|
||||
Nominatim version 5.1.0-0
|
||||
```
|
||||
|
||||
Make sure you have activated the virtual environment holding all
|
||||
|
||||
@@ -43,53 +43,53 @@ The name of the pytest binary depends on your installation.
|
||||
## BDD Functional Tests (`test/bdd`)
|
||||
|
||||
Functional tests are written as BDD instructions. For more information on
|
||||
the philosophy of BDD testing, see the
|
||||
[Behave manual](http://pythonhosted.org/behave/philosophy.html).
|
||||
|
||||
The following explanation assume that the reader is familiar with the BDD
|
||||
notations of features, scenarios and steps.
|
||||
|
||||
All possible steps can be found in the `steps` directory and should ideally
|
||||
be documented.
|
||||
the philosophy of BDD testing, read the Wikipedia article on
|
||||
[Behaviour-driven development](https://en.wikipedia.org/wiki/Behavior-driven_development).
|
||||
|
||||
### General Usage
|
||||
|
||||
To run the functional tests, do
|
||||
|
||||
cd test/bdd
|
||||
behave
|
||||
pytest test/bdd
|
||||
|
||||
The tests can be configured with a set of environment variables (`behave -D key=val`):
|
||||
The BDD tests create databases for the tests. You can set name of the databases
|
||||
through configuration variables in your `pytest.ini`:
|
||||
|
||||
* `TEMPLATE_DB` - name of template database used as a skeleton for
|
||||
the test databases (db tests)
|
||||
* `TEST_DB` - name of test database (db tests)
|
||||
* `API_TEST_DB` - name of the database containing the API test data (api tests)
|
||||
* `API_TEST_FILE` - OSM file to be imported into the API test database (api tests)
|
||||
* `API_ENGINE` - webframe to use for running search queries, same values as
|
||||
`nominatim serve --engine` parameter
|
||||
* `DB_HOST` - (optional) hostname of database host
|
||||
* `DB_PORT` - (optional) port of database on host
|
||||
* `DB_USER` - (optional) username of database login
|
||||
* `DB_PASS` - (optional) password for database login
|
||||
* `REMOVE_TEMPLATE` - if true, the template and API database will not be reused
|
||||
during the next run. Reusing the base templates speeds
|
||||
up tests considerably but might lead to outdated errors
|
||||
for some changes in the database layout.
|
||||
* `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
|
||||
is finished. Should only be used if one single scenario is
|
||||
run, otherwise the result is undefined.
|
||||
* `nominatim_test_db` defines the name of the temporary database created for
|
||||
a single test (default: `test_nominatim`)
|
||||
* `nominatim_api_test_db` defines the name of the database containing
|
||||
the API test data, see also below (default: `test_api_nominatim`)
|
||||
* `nominatim_template_db` defines the name of the template database used
|
||||
for creating the temporary test databases. It contains some static setup
|
||||
which usually doesn't change between imports of OSM data
|
||||
(default: `test_template_nominatim`)
|
||||
|
||||
To change other connection parameters for the PostgreSQL database, use
|
||||
the [libpq enivronment variables](https://www.postgresql.org/docs/current/libpq-envars.html).
|
||||
Never set a password through these variables. Use a
|
||||
[password file](https://www.postgresql.org/docs/current/libpq-pgpass.html) instead.
|
||||
|
||||
The API test database and the template database are only created once and then
|
||||
left untouched. This is usually what you want because it speeds up subsequent
|
||||
runs of BDD tests. If you do change code that has an influence on the content
|
||||
of these databases, you can run pytest with the `--nominatim-purge` parameter
|
||||
and the databases will be dropped and recreated from scratch.
|
||||
|
||||
When running the BDD tests with make (using `make tests` or `make bdd`), then
|
||||
the databases will always be purged.
|
||||
|
||||
The temporary test database is usually dropped directly after the test, so
|
||||
it does not take up unnecessary space. If you want to keep the database around,
|
||||
for example while debugging a specific BDD test, use the parameter
|
||||
`--nominatim-keep-db`.
|
||||
|
||||
Logging can be defined through command line parameters of behave itself. Check
|
||||
out `behave --help` for details. Also have a look at the 'work-in-progress'
|
||||
feature of behave which comes in handy when writing new tests.
|
||||
|
||||
### API Tests (`test/bdd/api`)
|
||||
|
||||
These tests are meant to test the different API endpoints and their parameters.
|
||||
They require to import several datasets into a test database. This is normally
|
||||
done automatically during setup of the test. The API test database is then
|
||||
kept around and reused in subsequent runs of behave. Use `behave -DREMOVE_TEMPLATE`
|
||||
kept around and reused in subsequent runs of behave. Use `--nominatim-purge`
|
||||
to force a reimport of the database.
|
||||
|
||||
The official test dataset is saved in the file `test/testdb/apidb-test-data.pbf`
|
||||
@@ -109,12 +109,12 @@ test the correctness of osm2pgsql. Each test will write some data into the `plac
|
||||
table (and optionally the `planet_osm_*` tables if required) and then run
|
||||
Nominatim's processing functions on that.
|
||||
|
||||
These tests need to create their own test databases. By default they will be
|
||||
called `test_template_nominatim` and `test_nominatim`. Names can be changed with
|
||||
the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
|
||||
needs superuser rights for postgres.
|
||||
These tests use the template database and create temporary test databases for
|
||||
each test.
|
||||
|
||||
### Import Tests (`test/bdd/osm2pgsql`)
|
||||
|
||||
These tests check that data is imported correctly into the place table. They
|
||||
use the same template database as the DB Creation tests, so the same remarks apply.
|
||||
These tests check that data is imported correctly into the place table.
|
||||
|
||||
These tests also use the template database and create temporary test databases
|
||||
for each test.
|
||||
|
||||
@@ -9,7 +9,7 @@ the address computation and the search frontend.
|
||||
The __data import__ stage reads the raw OSM data and extracts all information
|
||||
that is useful for geocoding. This part is done by osm2pgsql, the same tool
|
||||
that can also be used to import a rendering database. It uses the special
|
||||
gazetteer output plugin in `osm2pgsql/src/output-gazetter.[ch]pp`. The result of
|
||||
flex output style defined in the directory `/lib-lua`. The result of
|
||||
the import can be found in the database table `place`.
|
||||
|
||||
The __address computation__ or __indexing__ stage takes the data from `place`
|
||||
|
||||
@@ -39,3 +39,9 @@ th {
|
||||
filter: grayscale(100%);
|
||||
font-size: 80%;
|
||||
}
|
||||
|
||||
.simple-table table:not([class]) th,
|
||||
.simple-table table:not([class]) td {
|
||||
padding: 2px 4px;
|
||||
background: white;
|
||||
}
|
||||
|
||||
@@ -268,13 +268,17 @@ name out of it:
|
||||
'Brugges'
|
||||
```
|
||||
|
||||
The `address_row` field has a helper function to apply the function to all
|
||||
its members and save the result in the `local_name` field. It also returns
|
||||
all the localized names as a convenient simple list. This list can be used
|
||||
to create a human-readable output:
|
||||
The `address_row` field has a helper function to compute the display name for each Address Line
|
||||
component based on its `local_name` field. This is then utilized by the overall `result` object,
|
||||
which has a helper function to apply the function to all its ‘address_row’ members and saves
|
||||
the result in the `locale_name` field.
|
||||
|
||||
However, in order to set this `local_name` field in a preferred language, you must use the `Locale`
|
||||
object which contains the function `localize_results`, which explicitly sets each `local_name field`.
|
||||
|
||||
``` python
|
||||
>>> address_parts = results[0].address_rows.localize(locale)
|
||||
>>> Locales().localize_results(results)
|
||||
>>> address_parts = results[0].address_rows
|
||||
>>> print(', '.join(address_parts))
|
||||
Bruges, Flandre-Occidentale, Flandre, Belgique
|
||||
```
|
||||
|
||||
@@ -49,7 +49,11 @@ its address.
|
||||
|
||||
## Localization
|
||||
|
||||
Results are always returned with the full list of available names.
|
||||
Results are always returned with the full list of available names. However, the
|
||||
default `locale_name` must be explicitly set using the `localize` function within
|
||||
`Locales`. This parses through the full list of available names to find the one
|
||||
most preferred by the user. Once this is set, the user can simply use the
|
||||
`display_name` field within a `Result` object to retrive the localized name.
|
||||
|
||||
### Locale
|
||||
|
||||
|
||||
@@ -29,7 +29,9 @@ local NAME_FILTER = nil
|
||||
local ADDRESS_TAGS = {}
|
||||
local ADDRESS_FILTER = nil
|
||||
local EXTRATAGS_FILTER
|
||||
local REQUIRED_EXTRATAGS_FILTER
|
||||
local POSTCODE_FALLBACK = true
|
||||
local ENTRANCE_FUNCTION = nil
|
||||
|
||||
-- This file can also be directly require'd instead of running it under
|
||||
-- the themepark framework. In that case the first parameter is usually
|
||||
@@ -40,9 +42,9 @@ if type(themepark) ~= 'table' then
|
||||
themepark = nil
|
||||
end
|
||||
|
||||
-- The single place table.
|
||||
local place_table_definition = {
|
||||
name = "place",
|
||||
-- The place tables carry the raw OSM information.
|
||||
local table_definitions = {
|
||||
place = {
|
||||
ids = { type = 'any', id_column = 'osm_id', type_column = 'osm_type' },
|
||||
columns = {
|
||||
{ column = 'class', type = 'text', not_null = true },
|
||||
@@ -53,26 +55,40 @@ local place_table_definition = {
|
||||
{ column = 'extratags', type = 'hstore' },
|
||||
{ column = 'geometry', type = 'geometry', projection = 'WGS84', not_null = true },
|
||||
},
|
||||
data_tablespace = os.getenv("NOMINATIM_TABLESPACE_PLACE_DATA"),
|
||||
index_tablespace = os.getenv("NOMINATIM_TABLESPACE_PLACE_INDEX"),
|
||||
indexes = {}
|
||||
},
|
||||
place_entrance = {
|
||||
ids = { type = 'node', id_column = 'osm_id' },
|
||||
columns = {
|
||||
{ column = 'type', type = 'text', not_null = true },
|
||||
{ column = 'extratags', type = 'hstore' },
|
||||
{ column = 'geometry', type = 'geometry', projection = 'WGS84', not_null = true }
|
||||
},
|
||||
indexes = {}
|
||||
}
|
||||
}
|
||||
|
||||
local insert_row
|
||||
local insert_row = {}
|
||||
local script_path = debug.getinfo(1, "S").source:match("@?(.*/)")
|
||||
local PRESETS = loadfile(script_path .. 'presets.lua')()
|
||||
|
||||
for table_name, table_definition in pairs(table_definitions) do
|
||||
table_definition.name = table_name
|
||||
table_definition.data_tablespace = os.getenv("NOMINATIM_TABLESPACE_PLACE_DATA")
|
||||
table_definition.index_tablespace = os.getenv("NOMINATIM_TABLESPACE_PLACE_INDEX")
|
||||
|
||||
if themepark then
|
||||
themepark:add_table(place_table_definition)
|
||||
insert_row = function(columns)
|
||||
themepark:insert('place', columns, {}, {})
|
||||
themepark:add_table(table_definition)
|
||||
insert_row[table_name] = function(columns)
|
||||
themepark:insert(table_name, columns, {}, {})
|
||||
end
|
||||
else
|
||||
local place_table = osm2pgsql.define_table(place_table_definition)
|
||||
insert_row = function(columns)
|
||||
local place_table = osm2pgsql.define_table(table_definition)
|
||||
insert_row[table_name] = function(columns)
|
||||
place_table:insert(columns)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
------------ Geometry functions for relations ---------------------
|
||||
|
||||
@@ -150,24 +166,6 @@ local function address_fallback(place)
|
||||
return place:clone{names=names}
|
||||
end
|
||||
|
||||
--------- Built-in extratags transformation functions ---------------
|
||||
|
||||
local function default_extratags_filter(p, k)
|
||||
-- Default handling is to copy over place tag for boundaries.
|
||||
-- Nominatim needs this.
|
||||
if k ~= 'boundary' or p.intags.place == nil then
|
||||
return p.extratags
|
||||
end
|
||||
|
||||
local extra = { place = p.intags.place }
|
||||
for kin, vin in pairs(p.extratags) do
|
||||
extra[kin] = vin
|
||||
end
|
||||
|
||||
return extra
|
||||
end
|
||||
EXTRATAGS_FILTER = default_extratags_filter
|
||||
|
||||
----------------- other helper functions -----------------------------
|
||||
|
||||
local function lookup_prefilter_classification(k, v)
|
||||
@@ -429,18 +427,25 @@ function Place:write_row(k, v)
|
||||
return 0
|
||||
end
|
||||
|
||||
local extratags = EXTRATAGS_FILTER(self, k, v)
|
||||
if not (extratags and next(extratags)) then
|
||||
extratags = nil
|
||||
local extra = EXTRATAGS_FILTER(self, k, v) or {}
|
||||
|
||||
for tk, tv in pairs(self.object.tags) do
|
||||
if REQUIRED_EXTRATAGS_FILTER(tk, tv) and extra[tk] == nil then
|
||||
extra[tk] = tv
|
||||
end
|
||||
end
|
||||
|
||||
insert_row{
|
||||
if extra and next(extra) == nil then
|
||||
extra = nil
|
||||
end
|
||||
|
||||
insert_row.place{
|
||||
class = k,
|
||||
type = v,
|
||||
admin_level = self.admin_level,
|
||||
name = next(self.names) and self.names,
|
||||
address = next(self.address) and self.address,
|
||||
extratags = extratags,
|
||||
extratags = extra,
|
||||
geometry = self.geometry
|
||||
}
|
||||
|
||||
@@ -593,6 +598,16 @@ end
|
||||
|
||||
-- Process functions for all data types
|
||||
function module.process_node(object)
|
||||
if ENTRANCE_FUNCTION ~= nil then
|
||||
local entrance_info = ENTRANCE_FUNCTION(object)
|
||||
if entrance_info ~= nil then
|
||||
insert_row.place_entrance{
|
||||
type = entrance_info.entrance,
|
||||
extratags = entrance_info.extratags,
|
||||
geometry = object:as_point()
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
local function geom_func(o)
|
||||
return o:as_point()
|
||||
@@ -687,6 +702,15 @@ function module.process_tags(o)
|
||||
end
|
||||
end
|
||||
|
||||
--------- Extratags post-processing functions ---------------
|
||||
|
||||
local function default_extratags_filter(p, k)
|
||||
return p.extratags
|
||||
end
|
||||
|
||||
EXTRATAGS_FILTER = default_extratags_filter
|
||||
REQUIRED_EXTRATAGS_FILTER = module.tag_match(PRESETS.EXTRATAGS)
|
||||
|
||||
--------- Convenience functions for simple style configuration -----------------
|
||||
|
||||
function module.set_prefilters(data)
|
||||
@@ -717,7 +741,7 @@ end
|
||||
function module.add_for_extratags(data)
|
||||
if type(data) == 'string' then
|
||||
local preset = data
|
||||
data = PRESETS.EXTRATAGS[data] or PRESETS.IGNORE_KEYS[data]
|
||||
data = PRESETS.IGNORE_KEYS[data]
|
||||
if data == nil then
|
||||
error('Unknown preset for extratags: ' .. preset)
|
||||
end
|
||||
@@ -917,6 +941,99 @@ function module.set_relation_types(data)
|
||||
end
|
||||
end
|
||||
|
||||
function module.set_entrance_filter(data)
|
||||
if data == nil or type(data) == 'function' then
|
||||
ENTRANCE_FUNCTION = data
|
||||
return nil
|
||||
end
|
||||
|
||||
if type(data) == 'string' then
|
||||
local preset = data
|
||||
data = PRESETS.ENTRANCE_TABLE[data]
|
||||
if data == nil then
|
||||
error('Unknown preset for entrance table: ' .. preset)
|
||||
end
|
||||
end
|
||||
|
||||
ENTRANCE_FUNCTION = nil
|
||||
|
||||
if data.main_tags ~= nil and next(data.main_tags) ~= nil then
|
||||
if data.extra_include ~= nil and next(data.extra_include) == nil then
|
||||
-- shortcut: no extra tags requested
|
||||
ENTRANCE_FUNCTION = function(o)
|
||||
for _, v in ipairs(data.main_tags) do
|
||||
if o.tags[v] ~= nil then
|
||||
return {entrance = o.tags[v]}
|
||||
end
|
||||
end
|
||||
return nil
|
||||
end
|
||||
else
|
||||
if data.extra_include ~= nil then
|
||||
local tags = {}
|
||||
for _, v in pairs(data.extra_include) do
|
||||
tags[v] = true
|
||||
end
|
||||
if data.extra_exclude ~= nil then
|
||||
for _, v in pairs(data.extra_exclude) do
|
||||
tags[v] = nil
|
||||
end
|
||||
end
|
||||
for _, v in pairs(data.main_tags) do
|
||||
tags[v] = nil
|
||||
end
|
||||
|
||||
ENTRANCE_FUNCTION = function(o)
|
||||
for _, v in ipairs(data.main_tags) do
|
||||
if o.tags[v] ~= nil then
|
||||
local entrance = o.tags[v]
|
||||
local extra = {}
|
||||
for k, v in pairs(tags) do
|
||||
extra[k] = o.tags[k]
|
||||
end
|
||||
if next(extra) == nil then
|
||||
extra = nil
|
||||
end
|
||||
return {entrance = entrance, extratags = extra}
|
||||
end
|
||||
end
|
||||
|
||||
return nil
|
||||
end
|
||||
else
|
||||
local notags = {}
|
||||
if data.extra_exclude ~= nil then
|
||||
for _, v in pairs(data.extra_exclude) do
|
||||
notags[v] = 1
|
||||
end
|
||||
end
|
||||
for _, v in pairs(data.main_tags) do
|
||||
notags[v] = 1
|
||||
end
|
||||
|
||||
ENTRANCE_FUNCTION = function(o)
|
||||
for _, v in ipairs(data.main_tags) do
|
||||
if o.tags[v] ~= nil then
|
||||
local entrance = o.tags[v]
|
||||
local extra = {}
|
||||
for k, v in pairs(o.tags) do
|
||||
if notags[k] ~= 1 then
|
||||
extra[k] = v
|
||||
end
|
||||
end
|
||||
if next(extra) == nil then
|
||||
extra = nil
|
||||
end
|
||||
return {entrance = entrance, extratags = extra}
|
||||
end
|
||||
end
|
||||
|
||||
return nil
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
function module.get_taginfo()
|
||||
return {main = MAIN_KEYS, name = NAMES, address = ADDRESS_TAGS}
|
||||
|
||||
@@ -187,7 +187,7 @@ module.MAIN_TAGS_POIS = function (group)
|
||||
passing_place = group,
|
||||
street_lamp = 'named',
|
||||
traffic_signals = 'named'},
|
||||
historic = {'always',
|
||||
historic = {'fallback',
|
||||
yes = group,
|
||||
no = group},
|
||||
information = {include_when_tag_present('tourism', 'information'),
|
||||
@@ -196,9 +196,12 @@ module.MAIN_TAGS_POIS = function (group)
|
||||
trail_blaze = 'never'},
|
||||
junction = {'fallback',
|
||||
no = group},
|
||||
landuse = {cemetery = 'always'},
|
||||
leisure = {'always',
|
||||
nature_reserve = 'fallback',
|
||||
swimming_pool = 'named',
|
||||
garden = 'named',
|
||||
common = 'named',
|
||||
no = group},
|
||||
lock = {yes = lock_transform},
|
||||
man_made = {pier = 'always',
|
||||
@@ -229,6 +232,7 @@ module.MAIN_TAGS_POIS = function (group)
|
||||
shop = {'always',
|
||||
no = group},
|
||||
tourism = {'always',
|
||||
attraction = 'fallback',
|
||||
no = group,
|
||||
yes = group,
|
||||
information = exclude_when_key_present('information')},
|
||||
@@ -330,7 +334,7 @@ module.NAME_TAGS.core = {main = {'name', 'name:*',
|
||||
}
|
||||
module.NAME_TAGS.address = {house = {'addr:housename'}}
|
||||
module.NAME_TAGS.poi = group_merge({main = {'brand'},
|
||||
extra = {'iata', 'icao'}},
|
||||
extra = {'iata', 'icao', 'faa'}},
|
||||
module.NAME_TAGS.core)
|
||||
|
||||
-- Address tagging
|
||||
@@ -360,7 +364,7 @@ module.IGNORE_KEYS.metatags = {'note', 'note:*', 'source', 'source:*', '*source'
|
||||
'tiger:cfcc', 'tiger:reviewed', 'nysgissam:*',
|
||||
'NHD:*', 'nhd:*', 'gnis:*', 'geobase:*', 'yh:*',
|
||||
'osak:*', 'naptan:*', 'CLC:*', 'import', 'it:fvg:*',
|
||||
'lacounty:*', 'ref:linz:*',
|
||||
'lacounty:*', 'ref:linz:*', 'survey:*',
|
||||
'ref:bygningsnr', 'ref:ruian:*', 'building:ruian:type',
|
||||
'type',
|
||||
'is_in:postcode'}
|
||||
@@ -371,10 +375,15 @@ module.IGNORE_KEYS.address = {'addr:street:*', 'addr:city:*', 'addr:district:*',
|
||||
'addr:province:*', 'addr:subdistrict:*', 'addr:place:*',
|
||||
'addr:TW:dataset'}
|
||||
|
||||
-- Extra tags (prefiltered away)
|
||||
-- INTERNAL: Required extra tags
|
||||
|
||||
module.EXTRATAGS = {}
|
||||
module.EXTRATAGS = {keys = {'wikipedia', 'wikipedia:*', 'wikidata', 'capital'}}
|
||||
|
||||
module.EXTRATAGS.required = {'wikipedia', 'wikipedia:*', 'wikidata', 'capital'}
|
||||
-- Defaults for the entrance table
|
||||
|
||||
module.ENTRANCE_TABLE = {}
|
||||
|
||||
module.ENTRANCE_TABLE.default = {main_tags = {'entrance', 'routing:entrance'},
|
||||
extra_exclude = module.IGNORE_KEYS.metatags}
|
||||
|
||||
return module
|
||||
|
||||
@@ -11,7 +11,6 @@ flex.set_address_tags('core')
|
||||
flex.modify_address_tags('houses')
|
||||
|
||||
flex.ignore_keys('metatags')
|
||||
flex.add_for_extratags('required')
|
||||
|
||||
if cfg.with_extratags then
|
||||
flex.set_unused_handling{delete_keys = {'tiger:*'}}
|
||||
|
||||
@@ -8,7 +8,6 @@ flex.set_address_tags('core')
|
||||
flex.set_postcode_fallback(false)
|
||||
|
||||
flex.ignore_keys('metatags')
|
||||
flex.add_for_extratags('required')
|
||||
|
||||
if cfg.with_extratags then
|
||||
flex.set_unused_handling{delete_keys = {'tiger:*'}}
|
||||
|
||||
@@ -20,7 +20,6 @@ flex.set_address_tags('core')
|
||||
flex.modify_address_tags('houses')
|
||||
|
||||
flex.ignore_keys('metatags')
|
||||
flex.add_for_extratags('required')
|
||||
|
||||
if cfg.with_extratags then
|
||||
flex.set_unused_handling{delete_keys = {'tiger:*'}}
|
||||
@@ -30,3 +29,5 @@ else
|
||||
flex.ignore_keys('name')
|
||||
flex.ignore_keys('address')
|
||||
end
|
||||
|
||||
flex.set_entrance_filter('default')
|
||||
|
||||
@@ -10,7 +10,6 @@ flex.set_address_tags('core')
|
||||
flex.set_postcode_fallback(false)
|
||||
|
||||
flex.ignore_keys('metatags')
|
||||
flex.add_for_extratags('required')
|
||||
|
||||
if cfg.with_extratags then
|
||||
flex.set_unused_handling{delete_keys = {'tiger:*'}}
|
||||
|
||||
@@ -309,7 +309,7 @@ BEGIN
|
||||
IF NEW.startnumber IS NULL THEN
|
||||
NEW.startnumber := startnumber;
|
||||
NEW.endnumber := endnumber;
|
||||
NEW.linegeo := sectiongeo;
|
||||
NEW.linegeo := ST_ReducePrecision(sectiongeo, 0.0000001);
|
||||
NEW.postcode := postcode;
|
||||
ELSE
|
||||
INSERT INTO location_property_osmline
|
||||
@@ -317,7 +317,8 @@ BEGIN
|
||||
startnumber, endnumber, step,
|
||||
address, postcode, country_code,
|
||||
geometry_sector, indexed_status)
|
||||
VALUES (sectiongeo, NEW.partition, NEW.osm_id, NEW.parent_place_id,
|
||||
VALUES (ST_ReducePrecision(sectiongeo, 0.0000001),
|
||||
NEW.partition, NEW.osm_id, NEW.parent_place_id,
|
||||
startnumber, endnumber, NEW.step,
|
||||
NEW.address, postcode,
|
||||
NEW.country_code, NEW.geometry_sector, 0);
|
||||
|
||||
@@ -338,6 +338,11 @@ BEGIN
|
||||
END IF;
|
||||
END IF;
|
||||
|
||||
-- When an existing way is updated, recalculate entrances
|
||||
IF existingplacex.osm_type = 'W' and (existingplacex.rank_search > 27 or existingplacex.class IN ('landuse', 'leisure')) THEN
|
||||
PERFORM place_update_entrances(existingplacex.place_id, existingplacex.osm_id);
|
||||
END IF;
|
||||
|
||||
-- Abort the insertion (we modified the existing place instead)
|
||||
RETURN NULL;
|
||||
END;
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
--
|
||||
-- This file is part of Nominatim. (https://nominatim.org)
|
||||
--
|
||||
-- Copyright (C) 2024 by the Nominatim developer community.
|
||||
-- Copyright (C) 2025 by the Nominatim developer community.
|
||||
-- For a full list of authors see the git log.
|
||||
|
||||
-- Trigger functions for the placex table.
|
||||
@@ -530,6 +530,7 @@ CREATE OR REPLACE FUNCTION insert_addresslines(obj_place_id BIGINT,
|
||||
AS $$
|
||||
DECLARE
|
||||
address_havelevel BOOLEAN[];
|
||||
place_min_distance FLOAT[];
|
||||
|
||||
location_isaddress BOOLEAN;
|
||||
current_boundary GEOMETRY := NULL;
|
||||
@@ -545,6 +546,7 @@ BEGIN
|
||||
nameaddress_vector := '{}'::int[];
|
||||
|
||||
address_havelevel := array_fill(false, ARRAY[maxrank]);
|
||||
place_min_distance := array_fill(1.0, ARRAY[maxrank]);
|
||||
|
||||
FOR location IN
|
||||
SELECT apl.*, key
|
||||
@@ -575,6 +577,10 @@ BEGIN
|
||||
END IF;
|
||||
END IF;
|
||||
|
||||
IF location.isguess and location.distance < place_min_distance[location.rank_address] THEN
|
||||
place_min_distance[location.rank_address] := location.distance;
|
||||
END IF;
|
||||
|
||||
INSERT INTO place_addressline (place_id, address_place_id, fromarea,
|
||||
isaddress, distance, cached_rank_address)
|
||||
VALUES (obj_place_id, location.place_id, not location.isguess,
|
||||
@@ -602,6 +608,16 @@ BEGIN
|
||||
-- If this is the first item in the rank, then assume it is the address.
|
||||
location_isaddress := not address_havelevel[location.rank_address];
|
||||
|
||||
-- Ignore guessed places when they are too far away compared to similar closer ones.
|
||||
IF location.isguess THEN
|
||||
CONTINUE WHEN not location_isaddress
|
||||
AND location.distance > 2 * place_min_distance[location.rank_address];
|
||||
|
||||
IF location.distance < place_min_distance[location.rank_address] THEN
|
||||
place_min_distance[location.rank_address] := location.distance;
|
||||
END IF;
|
||||
END IF;
|
||||
|
||||
-- Further sanity checks to ensure that the address forms a sane hierarchy.
|
||||
IF location_isaddress THEN
|
||||
IF location.isguess and current_node_area is not NULL THEN
|
||||
@@ -638,8 +654,10 @@ BEGIN
|
||||
|
||||
-- Add it to the list of search terms
|
||||
{% if not db.reverse_only %}
|
||||
IF location.rank_address != 11 AND location.rank_address != 5 THEN
|
||||
nameaddress_vector := array_merge(nameaddress_vector,
|
||||
location.keywords::integer[]);
|
||||
END IF;
|
||||
{% endif %}
|
||||
|
||||
INSERT INTO place_addressline (place_id, address_place_id, fromarea,
|
||||
@@ -730,7 +748,7 @@ BEGIN
|
||||
IF NEW.rank_address between 2 and 27 THEN
|
||||
IF (ST_GeometryType(NEW.geometry) in ('ST_Polygon','ST_MultiPolygon') AND ST_IsValid(NEW.geometry)) THEN
|
||||
-- Performance: We just can't handle re-indexing for country level changes
|
||||
IF (NEW.rank_address < 26 and st_area(NEW.geometry) < 1)
|
||||
IF (NEW.rank_address < 26 and st_area(NEW.geometry) <= 2)
|
||||
OR (NEW.rank_address >= 26 and st_area(NEW.geometry) < 0.01)
|
||||
THEN
|
||||
-- mark items within the geometry for re-indexing
|
||||
@@ -778,7 +796,7 @@ BEGIN
|
||||
SELECT count(*)>0 FROM pg_tables WHERE tablename = classtable and schemaname = current_schema() INTO result;
|
||||
IF result THEN
|
||||
EXECUTE 'INSERT INTO ' || classtable::regclass || ' (place_id, centroid) VALUES ($1,$2)'
|
||||
USING NEW.place_id, ST_Centroid(NEW.geometry);
|
||||
USING NEW.place_id, NEW.centroid;
|
||||
END IF;
|
||||
|
||||
{% endif %} -- not disable_diff_updates
|
||||
@@ -872,6 +890,11 @@ BEGIN
|
||||
-- Compute a preliminary centroid.
|
||||
NEW.centroid := get_center_point(NEW.geometry);
|
||||
|
||||
-- Record the entrance node locations
|
||||
IF NEW.osm_type = 'W' and (NEW.rank_search > 27 or NEW.class IN ('landuse', 'leisure')) THEN
|
||||
PERFORM place_update_entrances(NEW.place_id, NEW.osm_id);
|
||||
END IF;
|
||||
|
||||
-- recalculate country and partition
|
||||
IF NEW.rank_search = 4 AND NEW.address is not NULL AND NEW.address ? 'country' THEN
|
||||
-- for countries, believe the mapped country code,
|
||||
@@ -960,9 +983,8 @@ BEGIN
|
||||
WHERE class = 'place' and rank_address between 1 and 23
|
||||
and prank.address_rank >= NEW.rank_address
|
||||
and ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon') -- select right index
|
||||
and geometry && NEW.geometry
|
||||
and geometry ~ NEW.geometry -- needed because ST_Relate does not do bbox cover test
|
||||
and ST_Relate(geometry, NEW.geometry, 'T*T***FF*') -- contains but not equal
|
||||
and ST_Contains(geometry, NEW.geometry)
|
||||
and not ST_Equals(geometry, NEW.geometry)
|
||||
ORDER BY prank.address_rank desc LIMIT 1
|
||||
LOOP
|
||||
NEW.rank_address := location.rank_address + 2;
|
||||
@@ -983,9 +1005,8 @@ BEGIN
|
||||
and rank_address between 1 and 25 -- select right index
|
||||
and ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon') -- select right index
|
||||
and prank.address_rank >= NEW.rank_address
|
||||
and geometry && NEW.geometry
|
||||
and geometry ~ NEW.geometry -- needed because ST_Relate does not do bbox cover test
|
||||
and ST_Relate(geometry, NEW.geometry, 'T*T***FF*') -- contains but not equal
|
||||
and ST_Contains(geometry, NEW.geometry)
|
||||
and not ST_Equals(geometry, NEW.geometry)
|
||||
ORDER BY prank.address_rank desc LIMIT 1
|
||||
LOOP
|
||||
NEW.rank_address := location.rank_address + 2;
|
||||
|
||||
@@ -88,6 +88,10 @@ BEGIN
|
||||
area := area / 3;
|
||||
ELSIF country_code IN ('bo', 'ar', 'sd', 'mn', 'in', 'et', 'cd', 'mz', 'ly', 'cl', 'zm') THEN
|
||||
area := area / 2;
|
||||
ELSIF country_code IN ('sg', 'ws', 'st', 'kn') THEN
|
||||
area := area * 5;
|
||||
ELSIF country_code IN ('dm', 'mt', 'lc', 'gg', 'sc', 'nr') THEN
|
||||
area := area * 20;
|
||||
END IF;
|
||||
|
||||
IF area > 1 THEN
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
--
|
||||
-- This file is part of Nominatim. (https://nominatim.org)
|
||||
--
|
||||
-- Copyright (C) 2022 by the Nominatim developer community.
|
||||
-- Copyright (C) 2025 by the Nominatim developer community.
|
||||
-- For a full list of authors see the git log.
|
||||
|
||||
-- Assorted helper functions for the triggers.
|
||||
@@ -18,10 +18,10 @@ BEGIN
|
||||
RETURN place;
|
||||
END IF;
|
||||
IF geom_type = 'ST_LineString' THEN
|
||||
RETURN ST_LineInterpolatePoint(place, 0.5);
|
||||
RETURN ST_ReducePrecision(ST_LineInterpolatePoint(place, 0.5), 0.0000001);
|
||||
END IF;
|
||||
|
||||
RETURN ST_PointOnSurface(place);
|
||||
RETURN ST_ReducePrecision(ST_PointOnSurface(place), 0.0000001);
|
||||
END;
|
||||
$$
|
||||
LANGUAGE plpgsql IMMUTABLE PARALLEL SAFE;
|
||||
@@ -623,3 +623,34 @@ BEGIN
|
||||
RETURN NULL;
|
||||
END;
|
||||
$$ LANGUAGE plpgsql;
|
||||
|
||||
|
||||
CREATE OR REPLACE FUNCTION place_update_entrances(placeid BIGINT, osmid BIGINT)
|
||||
RETURNS INTEGER
|
||||
AS $$
|
||||
DECLARE
|
||||
entrance RECORD;
|
||||
osm_ids BIGINT[];
|
||||
BEGIN
|
||||
osm_ids := '{}';
|
||||
FOR entrance in SELECT osm_id, type, geometry, extratags
|
||||
FROM place_entrance
|
||||
WHERE osm_id IN (SELECT unnest(nodes) FROM planet_osm_ways WHERE id=osmid)
|
||||
LOOP
|
||||
osm_ids := array_append(osm_ids, entrance.osm_id);
|
||||
INSERT INTO placex_entrance (place_id, osm_id, type, location, extratags)
|
||||
VALUES (placeid, entrance.osm_id, entrance.type, entrance.geometry, entrance.extratags)
|
||||
ON CONFLICT (place_id, osm_id) DO UPDATE
|
||||
SET type = excluded.type, location = excluded.location, extratags = excluded.extratags;
|
||||
END LOOP;
|
||||
|
||||
IF array_length(osm_ids, 1) > 0 THEN
|
||||
DELETE FROM placex_entrance WHERE place_id=placeid AND NOT osm_id=ANY(osm_ids);
|
||||
ELSE
|
||||
DELETE FROM placex_entrance WHERE place_id=placeid;
|
||||
END IF;
|
||||
|
||||
RETURN NULL;
|
||||
END;
|
||||
$$
|
||||
LANGUAGE plpgsql;
|
||||
|
||||
@@ -244,6 +244,25 @@ CREATE UNIQUE INDEX idx_postcode_id ON location_postcode USING BTREE (place_id)
|
||||
CREATE INDEX idx_postcode_geometry ON location_postcode USING GIST (geometry) {{db.tablespace.address_index}};
|
||||
GRANT SELECT ON location_postcode TO "{{config.DATABASE_WEBUSER}}" ;
|
||||
|
||||
-- Table to store location of entrance nodes
|
||||
DROP TABLE IF EXISTS placex_entrance;
|
||||
CREATE TABLE placex_entrance (
|
||||
place_id BIGINT NOT NULL,
|
||||
osm_id BIGINT NOT NULL,
|
||||
type TEXT NOT NULL,
|
||||
location GEOMETRY(Point, 4326) NOT NULL,
|
||||
extratags HSTORE
|
||||
);
|
||||
CREATE UNIQUE INDEX idx_placex_entrance_place_id_osm_id ON placex_entrance
|
||||
USING BTREE (place_id, osm_id) {{db.tablespace.search_index}};
|
||||
GRANT SELECT ON placex_entrance TO "{{config.DATABASE_WEBUSER}}" ;
|
||||
|
||||
-- Create an index on the place table for lookups to populate the entrance
|
||||
-- table
|
||||
CREATE INDEX IF NOT EXISTS idx_placex_entrance_lookup ON place
|
||||
USING BTREE (osm_id)
|
||||
WHERE class IN ('routing:entrance', 'entrance');
|
||||
|
||||
DROP TABLE IF EXISTS import_polygon_error;
|
||||
CREATE TABLE import_polygon_error (
|
||||
osm_id BIGINT,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
site_name: Nominatim Manual
|
||||
site_name: Nominatim 5.2.0 Manual
|
||||
theme:
|
||||
font: false
|
||||
name: material
|
||||
@@ -67,6 +67,7 @@ markdown_extensions:
|
||||
- codehilite
|
||||
- admonition
|
||||
- pymdownx.superfences
|
||||
- pymdownx.blocks.html
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- def_list
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../../COPYING
|
||||
232
packaging/nominatim-api/COPYING
Normal file
232
packaging/nominatim-api/COPYING
Normal file
@@ -0,0 +1,232 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@@ -2,7 +2,7 @@
|
||||
name = "nominatim-api"
|
||||
description = "A tool for building a database of OpenStreetMap for geocoding and for searching the database. Search library."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.7"
|
||||
requires-python = ">=3.9"
|
||||
license = 'GPL-3.0-or-later'
|
||||
maintainers = [
|
||||
{ name = "Sarah Hoffmann", email = "lonvia@denofr.de" },
|
||||
@@ -15,6 +15,7 @@ classifiers = [
|
||||
"Operating System :: OS Independent",
|
||||
]
|
||||
dependencies = [
|
||||
"async-timeout",
|
||||
"python-dotenv",
|
||||
"pyYAML>=5.1",
|
||||
"SQLAlchemy>=1.4.31",
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../../COPYING
|
||||
232
packaging/nominatim-db/COPYING
Normal file
232
packaging/nominatim-db/COPYING
Normal file
@@ -0,0 +1,232 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
@@ -2,7 +2,7 @@
|
||||
name = "nominatim-db"
|
||||
description = "A tool for building a database of OpenStreetMap for geocoding and for searching the database. Database backend."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.7"
|
||||
requires-python = ">=3.9"
|
||||
license = 'GPL-3.0-or-later'
|
||||
maintainers = [
|
||||
{ name = "Sarah Hoffmann", email = "lonvia@denofr.de" },
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
"croft" : 20,
|
||||
"subdivision" : 22,
|
||||
"allotments" : 22,
|
||||
"neighbourhood" : [20, 22],
|
||||
"neighbourhood" : 24,
|
||||
"quarter" : [20, 22],
|
||||
"isolated_dwelling" : [22, 25],
|
||||
"farm" : [22, 25],
|
||||
@@ -48,17 +48,20 @@
|
||||
"" : [25, 0]
|
||||
},
|
||||
"landuse" : {
|
||||
"residential" : 22,
|
||||
"farm" : 22,
|
||||
"farmyard" : 22,
|
||||
"industrial" : 22,
|
||||
"commercial" : 22,
|
||||
"allotments" : 22,
|
||||
"retail" : 22,
|
||||
"" : [22, 0]
|
||||
"residential" : 24,
|
||||
"farm" : 24,
|
||||
"farmyard" : 24,
|
||||
"industrial" : 24,
|
||||
"commercial" : 24,
|
||||
"allotments" : 24,
|
||||
"retail" : 24,
|
||||
"" : [24, 0]
|
||||
},
|
||||
"leisure" : {
|
||||
"park" : [24, 0]
|
||||
"park" : [24, 0],
|
||||
"nature_reserve" : [24, 0],
|
||||
"garden": [25, 0],
|
||||
"common": [25, 0]
|
||||
},
|
||||
"natural" : {
|
||||
"peak" : [18, 0],
|
||||
@@ -236,6 +239,17 @@
|
||||
"administrative11" : 20
|
||||
}
|
||||
}
|
||||
},
|
||||
{ "countries" : ["jp"],
|
||||
"tags" : {
|
||||
"boundary" : {
|
||||
"administrative7" : 16,
|
||||
"administrative8" : 18,
|
||||
"administrative9" : 20,
|
||||
"administrative10" : 22,
|
||||
"administrative11" : 24
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
]
|
||||
|
||||
@@ -97,7 +97,6 @@ name:
|
||||
na: Andorra
|
||||
ne: एण्डोरा
|
||||
nl: Andorra
|
||||
nn: Andorra
|
||||
"no": Andorra
|
||||
nv: Andówa
|
||||
oc: Andòrra
|
||||
|
||||
@@ -74,6 +74,7 @@ name:
|
||||
mt: Emirati Għarab Magħquda
|
||||
my: အာရပ်စော်ဘွားများပြည်ထောင်စုနိုင်ငံ
|
||||
na: Emireitit Arabiya
|
||||
nb: De forente arabiske emirater
|
||||
ne: संयुक्त अरब इमिरेट्स
|
||||
nl: Verenigde Arabische Emiraten
|
||||
nn: Dei sameinte arabiske emirata
|
||||
|
||||
@@ -96,7 +96,6 @@ name:
|
||||
na: Apeganitan
|
||||
ne: अफगानिस्तान
|
||||
nl: Afghanistan
|
||||
nn: Afghanistan
|
||||
"no": Afghanistan
|
||||
oc: Afganistan
|
||||
om: Afgaanistaan
|
||||
|
||||
@@ -86,10 +86,8 @@ name:
|
||||
mt: Antigwa u Barbuda
|
||||
my: အင်တီဂွါနှင့် ဘာဘူဒါ
|
||||
na: Antigua me Barbuda
|
||||
nb: Antigua og Barbuda
|
||||
ne: एन्टिगुआ र बर्बुडा
|
||||
nl: Antigua en Barbuda
|
||||
nn: Antigua og Barbuda
|
||||
"no": Antigua og Barbuda
|
||||
nv: Antíígwa dóó Hashkʼaan Bikéyah Yázhí
|
||||
oc: Antigua e Barbuda
|
||||
|
||||
@@ -50,7 +50,6 @@ name:
|
||||
ms: Anguilla
|
||||
ne: एन्गुला
|
||||
nl: Anguilla
|
||||
nn: Anguilla
|
||||
"no": Anguilla
|
||||
oc: Anguilla
|
||||
pa: ਐਂਗੁਈਲਾ
|
||||
|
||||
@@ -101,7 +101,6 @@ name:
|
||||
na: Arbainiya
|
||||
ne: अल्बानिया
|
||||
nl: Albanië
|
||||
nn: Albania
|
||||
"no": Albania
|
||||
nv: Dziłigaii Bikéyah
|
||||
oc: Albania
|
||||
|
||||
@@ -99,7 +99,6 @@ name:
|
||||
na: Arminiya
|
||||
ne: आर्मेनिया
|
||||
nl: Armenië
|
||||
nn: Armenia
|
||||
"no": Armenia
|
||||
nv: Aooméénii Bikéyah
|
||||
oc: Armenia
|
||||
|
||||
@@ -90,7 +90,6 @@ name:
|
||||
na: Angora
|
||||
ne: अंगोला
|
||||
nl: Angola
|
||||
nn: Angola
|
||||
"no": Angola
|
||||
nv: Angóola
|
||||
ny: Angola
|
||||
|
||||
@@ -99,7 +99,6 @@ name:
|
||||
na: Ardjentina
|
||||
ne: अर्जेन्टिना
|
||||
nl: Argentinië
|
||||
nn: Argentina
|
||||
"no": Argentina
|
||||
nv: Béésh Łigaii Bikéyah
|
||||
oc: Argentina
|
||||
|
||||
@@ -93,6 +93,7 @@ name:
|
||||
mt: Awstrija
|
||||
my: သြစတြီးယားနိုင်ငံ
|
||||
na: Oteriya
|
||||
nb: Østerrike
|
||||
ne: अष्ट्रीया
|
||||
nl: Oostenrijk
|
||||
nn: Austerrike
|
||||
|
||||
@@ -94,7 +94,6 @@ name:
|
||||
na: Otereiriya
|
||||
ne: अष्ट्रेलिया
|
||||
nl: Australië
|
||||
nn: Australia
|
||||
"no": Australia
|
||||
nv: Nahatʼeʼiitsoh Bikéyah
|
||||
oc: Austràlia
|
||||
|
||||
@@ -96,10 +96,8 @@ name:
|
||||
mt: Ażerbajġan
|
||||
my: အဇာဘိုင်ဂျန်နိုင်ငံ
|
||||
na: Aderbaidjan
|
||||
nb: Aserbajdsjan
|
||||
ne: अजरबैजान
|
||||
nl: Azerbeidzjan
|
||||
nn: Aserbajdsjan
|
||||
"no": Aserbajdsjan
|
||||
nv: Azééwii Bikéyah
|
||||
ny: Azerbaijan
|
||||
|
||||
@@ -94,7 +94,6 @@ name:
|
||||
na: Boteniya me Erdegobina
|
||||
ne: बोस्निया र हर्जगोभिना
|
||||
nl: Bosnië en Herzegovina
|
||||
nn: Bosnia-Hercegovina
|
||||
"no": Bosnia-Hercegovina
|
||||
nv: Bosna dóó Hetsog Bikéyah
|
||||
oc: Bòsnia e Ercegovina
|
||||
|
||||
@@ -77,7 +77,6 @@ name:
|
||||
na: Barbadot
|
||||
ne: बार्बाडोस
|
||||
nl: Barbados
|
||||
nn: Barbados
|
||||
"no": Barbados
|
||||
oc: Barbados
|
||||
om: Baarbeedoos
|
||||
|
||||
@@ -29,6 +29,7 @@ name:
|
||||
lt: Bangladešas
|
||||
lv: Bangladeša
|
||||
mn: Бангладеш
|
||||
"no": Bangladesh
|
||||
pl: Bangladesz
|
||||
pt: Bangladesh
|
||||
ru: Бангладеш
|
||||
|
||||
@@ -95,10 +95,8 @@ name:
|
||||
mt: Belġju
|
||||
my: ဘယ်လ်ဂျီယမ်နိုင်ငံ
|
||||
na: Berdjiyum
|
||||
nb: Belgia
|
||||
ne: बेल्जियम
|
||||
nl: België
|
||||
nn: Belgia
|
||||
"no": Belgia
|
||||
oc: Belgica
|
||||
om: Beeljiyeem
|
||||
|
||||
@@ -88,7 +88,6 @@ name:
|
||||
na: Burkinabato
|
||||
ne: बुर्किना फासो
|
||||
nl: Burkina Faso
|
||||
nn: Burkina Faso
|
||||
"no": Burkina Faso
|
||||
oc: Burkina Faso
|
||||
om: Burkinaa Faasoo
|
||||
|
||||
@@ -93,7 +93,6 @@ name:
|
||||
na: Borgeriya
|
||||
ne: बुल्गेरिया
|
||||
nl: Bulgarije
|
||||
nn: Bulgaria
|
||||
"no": Bulgaria
|
||||
nv: Bálgaa Bikéyah
|
||||
oc: Bulgaria
|
||||
|
||||
@@ -91,7 +91,6 @@ name:
|
||||
na: Bahrain
|
||||
ne: बहराइन
|
||||
nl: Bahrein
|
||||
nn: Bahrain
|
||||
"no": Bahrain
|
||||
oc: Bahrayn
|
||||
om: Baahireen
|
||||
|
||||
@@ -88,7 +88,6 @@ name:
|
||||
na: Burundi
|
||||
ne: बुरूण्डी
|
||||
nl: Burundi
|
||||
nn: Burundi
|
||||
"no": Burundi
|
||||
oc: Burundi
|
||||
om: Buruundii
|
||||
|
||||
@@ -91,7 +91,6 @@ name:
|
||||
na: Benin
|
||||
ne: बेनिन
|
||||
nl: Benin
|
||||
nn: Benin
|
||||
"no": Benin
|
||||
oc: Benin
|
||||
om: Beeniin
|
||||
|
||||
@@ -25,6 +25,7 @@ name:
|
||||
lv: Bermudu salas
|
||||
mk: Бермуда
|
||||
mn: Бермудын Арал
|
||||
"no": Bermuda
|
||||
oc: Bermudas
|
||||
pl: Bermudy
|
||||
pt: Bermudas
|
||||
|
||||
@@ -91,7 +91,6 @@ name:
|
||||
na: Brunei
|
||||
ne: ब्रुनेई
|
||||
nl: Brunei
|
||||
nn: Brunei
|
||||
"no": Brunei
|
||||
ny: Brunei
|
||||
oc: Brunei
|
||||
|
||||
@@ -94,7 +94,6 @@ name:
|
||||
na: Boribiya
|
||||
ne: बोलिभिया
|
||||
nl: Bolivia
|
||||
nn: Bolivia
|
||||
"no": Bolivia
|
||||
nv: Bolíbiya
|
||||
oc: Bolívia
|
||||
|
||||
@@ -99,7 +99,6 @@ name:
|
||||
na: Bradir
|
||||
ne: ब्राजिल
|
||||
nl: Brazilië
|
||||
nn: Brasil
|
||||
"no": Brasil
|
||||
nv: Bwazííl
|
||||
oc: Brasil
|
||||
|
||||
@@ -85,7 +85,6 @@ name:
|
||||
na: Bahamat
|
||||
ne: बहामस
|
||||
nl: Bahama's
|
||||
nn: Bahamas
|
||||
"no": Bahamas
|
||||
oc: Las Bahamas
|
||||
om: Bahamaas
|
||||
|
||||
@@ -92,7 +92,6 @@ name:
|
||||
na: Butan
|
||||
ne: भूटान
|
||||
nl: Bhutan
|
||||
nn: Bhutan
|
||||
"no": Bhutan
|
||||
nv: Bikéyah
|
||||
oc: Botan
|
||||
|
||||
@@ -90,7 +90,6 @@ name:
|
||||
na: Botwana
|
||||
ne: बोत्स्वाना
|
||||
nl: Botswana
|
||||
nn: Botswana
|
||||
"no": Botswana
|
||||
nv: Tswana Dineʼé Bikéyah
|
||||
oc: Botswana
|
||||
|
||||
@@ -83,8 +83,7 @@ name:
|
||||
na: Berarut
|
||||
ne: बेलारुस
|
||||
nl: Wit-Rusland
|
||||
nn: Kviterussland
|
||||
"no": Hviterussland
|
||||
"no": Belarus
|
||||
oc: Bielorussia
|
||||
or: ବେଲାଋଷ
|
||||
os: Белорусси
|
||||
|
||||
@@ -85,7 +85,6 @@ name:
|
||||
na: Berij
|
||||
ne: बेलिज
|
||||
nl: Belize
|
||||
nn: Belize
|
||||
"no": Belize
|
||||
oc: Belize
|
||||
om: Beliiz
|
||||
|
||||
@@ -94,7 +94,6 @@ name:
|
||||
na: Kanada
|
||||
ne: क्यानाडा
|
||||
nl: Canada
|
||||
nn: Canada
|
||||
"no": Canada
|
||||
nv: Deeteel Bikéyah
|
||||
oc: Canadà
|
||||
|
||||
@@ -74,7 +74,6 @@ name:
|
||||
na: Ripubrikit Engame Kongo
|
||||
ne: प्रजातान्त्रिक गणतन्त्र कंगो
|
||||
nl: Democratische Republiek Congo
|
||||
nn: Den demokratiske republikken Kongo
|
||||
"no": Den demokratiske republikken Kongo
|
||||
nv: Kéyah Káango Shádiʼááhjí Siʼánígíí
|
||||
oc: Republica Democratica de Còngo
|
||||
|
||||
@@ -72,6 +72,7 @@ name:
|
||||
mt: Repubblika Ċentru-Afrikana
|
||||
my: ဗဟိုအာဖရိကသမ္မတနိုင်ငံ
|
||||
na: Ripubrikin Aprika Yugaga
|
||||
nb: Den sentralafrikanske republikk
|
||||
ne: मध्य अफ्रिकी गणतन्त्र
|
||||
nl: Centraal-Afrikaanse Republiek
|
||||
nn: Den sentralafrikanske republikken
|
||||
|
||||
@@ -70,7 +70,6 @@ name:
|
||||
na: Ripubrikin Kongo
|
||||
ne: कङ्गो
|
||||
nl: Congo-Brazzaville
|
||||
nn: Kongo-Brazzaville
|
||||
"no": Republikken Kongo
|
||||
nv: Kéyah Káango Náhookǫsjí Siʼánígíí
|
||||
oc: Republica de Còngo
|
||||
|
||||
@@ -84,7 +84,6 @@ name:
|
||||
na: Switzerland
|
||||
ne: स्विजरल्याण्ड
|
||||
nl: Zwitserland
|
||||
nn: Sveits
|
||||
"no": Sveits
|
||||
nv: Swis Bikéyah
|
||||
oc: Soïssa
|
||||
|
||||
@@ -75,6 +75,7 @@ name:
|
||||
mt: Kosta tal-Avorju
|
||||
my: အိုင်ဗရီကို့စ်နိုင်ငံ
|
||||
na: Aibori Kot
|
||||
nb: Elfenbenskysten
|
||||
ne: आइभरी कोस्ट
|
||||
nl: Ivoorkust
|
||||
nn: Elfenbeinskysten
|
||||
|
||||
@@ -79,6 +79,7 @@ name:
|
||||
ms: Kepulauan Cook
|
||||
mt: Gżejjer Cook
|
||||
my: ကွတ် ကျွန်းစု
|
||||
nb: Cookøyene
|
||||
ne: कुक टापु
|
||||
nl: Cookeilanden
|
||||
nn: Cookøyane
|
||||
|
||||
@@ -103,7 +103,6 @@ name:
|
||||
na: Tsire
|
||||
ne: चिली
|
||||
nl: Chili
|
||||
nn: Chile
|
||||
"no": Chile
|
||||
nv: Chíilii
|
||||
ny: Chile
|
||||
|
||||
@@ -79,7 +79,6 @@ name:
|
||||
na: Kamerun
|
||||
ne: क्यामेरून
|
||||
nl: Kameroen
|
||||
nn: Kamerun
|
||||
"no": Kamerun
|
||||
nv: Táłtłʼááh Chʼosh Daadánígíí Bitooh
|
||||
oc: Cameron
|
||||
|
||||
@@ -101,10 +101,8 @@ name:
|
||||
mt: Ċina
|
||||
my: တရုတ်
|
||||
na: Tsiene
|
||||
nb: Kina
|
||||
ne: चीन
|
||||
nl: China
|
||||
nn: Kina
|
||||
"no": Kina
|
||||
nv: Tsiiʼyishbizhí Dineʼé Bikéyah
|
||||
ny: China
|
||||
|
||||
@@ -82,7 +82,6 @@ name:
|
||||
na: Korombiya
|
||||
ne: कोलम्बिया
|
||||
nl: Colombia
|
||||
nn: Colombia
|
||||
"no": Colombia
|
||||
nv: Kolámbiya
|
||||
oc: Colómbia
|
||||
|
||||
@@ -81,7 +81,6 @@ name:
|
||||
na: Kosta Rika
|
||||
ne: कोस्टारिका
|
||||
nl: Costa Rica
|
||||
nn: Costa Rica
|
||||
"no": Costa Rica
|
||||
oc: Còsta Rica
|
||||
om: Kostaa Rikaa
|
||||
|
||||
@@ -78,7 +78,6 @@ name:
|
||||
na: Kiuba
|
||||
ne: क्युबा
|
||||
nl: Cuba
|
||||
nn: Cuba
|
||||
"no": Cuba
|
||||
nv: Kyóoba
|
||||
oc: Cuba
|
||||
|
||||
@@ -36,6 +36,7 @@ name:
|
||||
mk: Зелен ’Рт
|
||||
mn: Кабо-Верде
|
||||
nl: Kaapverdië
|
||||
"no": Kapp Verde
|
||||
pl: Republika Zielonego Przylądka
|
||||
pt: Cabo Verde
|
||||
ru: Кабо-Верде
|
||||
|
||||
@@ -77,10 +77,8 @@ name:
|
||||
mt: Ċipru
|
||||
my: ဆိုက်ပရပ်စ်နိုင်ငံ
|
||||
na: Taiprus
|
||||
nb: Kypros
|
||||
ne: साइप्रस
|
||||
nl: Cyprus
|
||||
nn: Kypros
|
||||
"no": Kypros
|
||||
nv: Béésh Łichíiʼii Bikéyah
|
||||
oc: Chipre
|
||||
|
||||
@@ -93,7 +93,6 @@ name:
|
||||
na: Ripubrikin Tsiek
|
||||
ne: चेक गणतन्त्र
|
||||
nl: Tsjechië
|
||||
nn: Tsjekkia
|
||||
"no": Tsjekkia
|
||||
nv: Chek Bikéyah
|
||||
oc: Republica Chèca
|
||||
|
||||
@@ -99,7 +99,6 @@ name:
|
||||
na: Djermani
|
||||
ne: जर्मनी
|
||||
nl: Duitsland
|
||||
nn: Tyskland
|
||||
"no": Tyskland
|
||||
nv: Béésh Bichʼahii Bikéyah
|
||||
oc: Alemanha
|
||||
|
||||
@@ -74,7 +74,6 @@ name:
|
||||
na: Djibuti
|
||||
ne: जिबुटी
|
||||
nl: Djibouti
|
||||
nn: Djibouti
|
||||
"no": Djibouti
|
||||
nv: Jibótii
|
||||
oc: Jiboti
|
||||
|
||||
@@ -85,7 +85,6 @@ name:
|
||||
na: Denemark
|
||||
ne: डेनमार्क
|
||||
nl: Denemarken
|
||||
nn: Danmark
|
||||
"no": Danmark
|
||||
nv: Déinish Dineʼé Bikéyah
|
||||
oc: Danemarc
|
||||
|
||||
@@ -28,6 +28,7 @@ name:
|
||||
lv: Dominika
|
||||
mn: Доминика
|
||||
nl: Dominica
|
||||
"no": Dominica
|
||||
pl: Dominika
|
||||
pt: Dominica
|
||||
ru: Доминика
|
||||
|
||||
@@ -69,6 +69,7 @@ name:
|
||||
mt: Repubblika Dominikana
|
||||
my: ဒိုမီနီကန်သမ္မတနိုင်ငံ
|
||||
na: Ripubrikin Dominika
|
||||
nb: Den dominikanske republikk
|
||||
ne: डोमिनिकन गणतन्त्र
|
||||
nl: Dominicaanse Republiek
|
||||
nn: Den dominikanske republikken
|
||||
|
||||
@@ -93,7 +93,6 @@ name:
|
||||
na: Ardjiriya
|
||||
ne: अल्जेरिया
|
||||
nl: Algerije
|
||||
nn: Algerie
|
||||
"no": Algerie
|
||||
nv: Aljííya
|
||||
ny: Algeria
|
||||
|
||||
@@ -77,7 +77,6 @@ name:
|
||||
na: Ekwador
|
||||
ne: इक्वेडर
|
||||
nl: Ecuador
|
||||
nn: Ecuador
|
||||
"no": Ecuador
|
||||
nv: Kéyah Nahasdzáán Ałníiʼgi Siʼánígíí
|
||||
oc: Eqüator
|
||||
|
||||
@@ -85,7 +85,6 @@ name:
|
||||
na: Etoniya
|
||||
ne: इस्टोनिया
|
||||
nl: Estland
|
||||
nn: Estland
|
||||
"no": Estland
|
||||
nv: Ééstii Bikéyah
|
||||
oc: Estònia
|
||||
|
||||
@@ -97,7 +97,6 @@ name:
|
||||
na: Idjipt
|
||||
ne: मिश्र
|
||||
nl: Egypte
|
||||
nn: Egypt
|
||||
"no": Egypt
|
||||
nv: Ííjip
|
||||
oc: Egipte
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user