forked from TrueCloudLab/frostfs-locode-db
Compare commits
No commits in common. "empty" and "master" have entirely different histories.
59 changed files with 3602 additions and 2 deletions
45
.forgejo/ISSUE_TEMPLATE/bug_report.md
Normal file
45
.forgejo/ISSUE_TEMPLATE/bug_report.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: community, triage, bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Expected Behavior
|
||||
<!--- If you're describing a bug, tell us what should happen -->
|
||||
<!--- If you're suggesting a change/improvement, tell us how it should work -->
|
||||
|
||||
## Current Behavior
|
||||
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
|
||||
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
|
||||
|
||||
## Possible Solution
|
||||
<!--- Not obligatory -->
|
||||
<!--- If no reason/fix/additions for the bug can be suggested, -->
|
||||
<!--- uncomment the following phrase: -->
|
||||
|
||||
<!--- No fix can be suggested by a QA engineer. Further solutions shall be up to developers. -->
|
||||
|
||||
## Steps to Reproduce (for bugs)
|
||||
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
|
||||
<!--- reproduce this bug. -->
|
||||
|
||||
1.
|
||||
|
||||
## Context
|
||||
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
|
||||
|
||||
## Regression
|
||||
<!-- Is this issue a regression? (Yes / No) -->
|
||||
<!-- If Yes, optionally please include version or commit id or PR# that caused this regression, if you have these details. -->
|
||||
|
||||
## Your Environment
|
||||
<!--- Include as many relevant details about the environment you experienced the bug in -->
|
||||
* Version used:
|
||||
* Server setup and configuration:
|
||||
* Operating System and version (`uname -a`):
|
||||
1
.forgejo/ISSUE_TEMPLATE/config.yml
Normal file
1
.forgejo/ISSUE_TEMPLATE/config.yml
Normal file
|
|
@ -0,0 +1 @@
|
|||
blank_issues_enabled: false
|
||||
20
.forgejo/ISSUE_TEMPLATE/feature_request.md
Normal file
20
.forgejo/ISSUE_TEMPLATE/feature_request.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: community, triage
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Is your feature request related to a problem? Please describe.
|
||||
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
## Describe the solution you'd like
|
||||
<!--- A clear and concise description of what you want to happen. -->
|
||||
|
||||
## Describe alternatives you've considered
|
||||
<!--- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
## Additional context
|
||||
<!--- Add any other context or screenshots about the feature request here. -->
|
||||
70
.forgejo/logo.svg
Normal file
70
.forgejo/logo.svg
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 25.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Слой_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 184.2 51.8" style="enable-background:new 0 0 184.2 51.8;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{display:none;}
|
||||
.st1{display:inline;}
|
||||
.st2{fill:#01E397;}
|
||||
.st3{display:inline;fill:#010032;}
|
||||
.st4{display:inline;fill:#00E599;}
|
||||
.st5{display:inline;fill:#00AF92;}
|
||||
.st6{fill:#00C3E5;}
|
||||
</style>
|
||||
<g id="Layer_2">
|
||||
<g id="Layer_1-2" class="st0">
|
||||
<g class="st1">
|
||||
<path class="st2" d="M146.6,18.3v7.2h10.9V29h-10.9v10.7h-4V14.8h18v3.5H146.6z"/>
|
||||
<path class="st2" d="M180,15.7c1.7,0.9,3,2.2,4,3.8l-3,2.7c-0.6-1.3-1.5-2.4-2.6-3.3c-1.3-0.7-2.8-1-4.3-1
|
||||
c-1.4-0.1-2.8,0.3-4,1.1c-0.9,0.5-1.5,1.5-1.4,2.6c0,1,0.5,1.9,1.4,2.4c1.5,0.8,3.2,1.3,4.9,1.5c1.9,0.3,3.7,0.8,5.4,1.6
|
||||
c1.2,0.5,2.2,1.3,2.9,2.3c0.6,1,1,2.2,0.9,3.4c0,1.4-0.5,2.7-1.3,3.8c-0.9,1.2-2.1,2.1-3.5,2.6c-1.7,0.6-3.4,0.9-5.2,0.8
|
||||
c-5,0-8.6-1.6-10.7-5l2.9-2.8c0.7,1.4,1.8,2.5,3.1,3.3c1.5,0.7,3.1,1.1,4.7,1c1.5,0.1,2.9-0.2,4.2-0.9c0.9-0.5,1.5-1.5,1.5-2.6
|
||||
c0-0.9-0.5-1.8-1.3-2.2c-1.5-0.7-3.1-1.2-4.8-1.5c-1.9-0.3-3.7-0.8-5.5-1.5c-1.2-0.5-2.2-1.4-3-2.4c-0.6-1-1-2.2-0.9-3.4
|
||||
c0-1.4,0.4-2.7,1.2-3.8c0.8-1.2,2-2.2,3.3-2.8c1.6-0.7,3.4-1.1,5.2-1C176.1,14.3,178.2,14.8,180,15.7z"/>
|
||||
</g>
|
||||
<path class="st3" d="M73.3,16.3c1.9,1.9,2.9,4.5,2.7,7.1v15.9h-4V24.8c0-2.6-0.5-4.5-1.6-5.7c-1.2-1.2-2.8-1.8-4.5-1.7
|
||||
c-1.3,0-2.5,0.3-3.7,0.8c-1.2,0.7-2.2,1.7-2.9,2.9c-0.8,1.5-1.1,3.2-1.1,4.9v13.3h-4V15.1l3.6,1.5v1.7c0.8-1.5,2.1-2.6,3.6-3.3
|
||||
c1.5-0.8,3.2-1.2,4.9-1.1C68.9,13.8,71.3,14.7,73.3,16.3z"/>
|
||||
<path class="st3" d="M104.4,28.3H85.6c0.1,2.2,1,4.3,2.5,5.9c1.5,1.4,3.5,2.2,5.6,2.1c1.6,0.1,3.2-0.2,4.6-0.9
|
||||
c1.1-0.6,2-1.6,2.5-2.8l3.3,1.8c-0.9,1.7-2.3,3.1-4,4c-2,1-4.2,1.5-6.4,1.4c-3.7,0-6.7-1.1-8.8-3.4s-3.2-5.5-3.2-9.6s1-7.2,3-9.5
|
||||
s5-3.4,8.7-3.4c2.1-0.1,4.2,0.5,6.1,1.5c1.6,1,3,2.5,3.8,4.2c0.9,1.8,1.3,3.9,1.3,5.9C104.6,26.4,104.6,27.4,104.4,28.3z
|
||||
M88.1,19.3c-1.4,1.5-2.2,3.4-2.4,5.5h15.1c-0.2-2-1-3.9-2.3-5.5c-1.4-1.3-3.2-2-5.1-1.9C91.5,17.3,89.6,18,88.1,19.3z"/>
|
||||
<path class="st3" d="M131,17.3c2.2,2.3,3.2,5.5,3.2,9.5s-1,7.3-3.2,9.6s-5.1,3.4-8.8,3.4s-6.7-1.1-8.9-3.4s-3.2-5.5-3.2-9.6
|
||||
s1.1-7.2,3.2-9.5s5.1-3.4,8.9-3.4S128.9,15,131,17.3z M116.2,19.9c-1.5,2-2.2,4.4-2.1,6.9c-0.2,2.5,0.6,5,2.1,7
|
||||
c1.5,1.7,3.7,2.7,6,2.6c2.3,0.1,4.4-0.9,5.9-2.6c1.5-2,2.3-4.5,2.1-7c0.1-2.5-0.6-4.9-2.1-6.9c-1.5-1.7-3.6-2.7-5.9-2.6
|
||||
C119.9,17.2,117.7,18.2,116.2,19.9z"/>
|
||||
<polygon class="st4" points="0,9.1 0,43.7 22.5,51.8 22.5,16.9 46.8,7.9 24.8,0 "/>
|
||||
<polygon class="st5" points="24.3,17.9 24.3,36.8 46.8,44.9 46.8,9.6 "/>
|
||||
</g>
|
||||
<g>
|
||||
<g>
|
||||
<path class="st6" d="M41.6,17.5H28.2v6.9h10.4v3.3H28.2v10.2h-3.9V14.2h17.2V17.5z"/>
|
||||
<path class="st6" d="M45.8,37.9v-18h3.3l0.4,3.2c0.5-1.2,1.2-2.1,2.1-2.7c0.9-0.6,2.1-0.9,3.5-0.9c0.4,0,0.7,0,1.1,0.1
|
||||
c0.4,0.1,0.7,0.2,0.9,0.3l-0.5,3.4c-0.3-0.1-0.6-0.2-0.9-0.2C55.4,23,54.9,23,54.4,23c-0.7,0-1.5,0.2-2.2,0.6
|
||||
c-0.7,0.4-1.3,1-1.8,1.8s-0.7,1.8-0.7,3v9.5H45.8z"/>
|
||||
<path class="st6" d="M68.6,19.6c1.8,0,3.3,0.4,4.6,1.1c1.3,0.7,2.4,1.8,3.1,3.2s1.1,3.1,1.1,5c0,1.9-0.4,3.6-1.1,5
|
||||
c-0.8,1.4-1.8,2.5-3.1,3.2c-1.3,0.7-2.9,1.1-4.6,1.1s-3.3-0.4-4.6-1.1c-1.3-0.7-2.4-1.8-3.2-3.2c-0.8-1.4-1.2-3.1-1.2-5
|
||||
c0-1.9,0.4-3.6,1.2-5s1.8-2.5,3.2-3.2C65.3,19.9,66.8,19.6,68.6,19.6z M68.6,22.6c-1.1,0-2,0.2-2.8,0.7c-0.8,0.5-1.3,1.2-1.7,2.1
|
||||
s-0.6,2.1-0.6,3.5c0,1.3,0.2,2.5,0.6,3.4s1,1.7,1.7,2.2s1.7,0.7,2.8,0.7c1.1,0,2-0.2,2.7-0.7c0.7-0.5,1.3-1.2,1.7-2.2
|
||||
s0.6-2.1,0.6-3.4c0-1.4-0.2-2.5-0.6-3.5s-1-1.6-1.7-2.1C70.6,22.8,69.6,22.6,68.6,22.6z"/>
|
||||
<path class="st6" d="M89.2,38.3c-1.8,0-3.4-0.3-4.9-1c-1.5-0.7-2.7-1.7-3.5-3l2.7-2.3c0.5,1,1.3,1.8,2.3,2.4
|
||||
c1,0.6,2.2,0.9,3.6,0.9c1.1,0,2-0.2,2.6-0.6c0.6-0.4,1-0.9,1-1.6c0-0.5-0.2-0.9-0.5-1.2s-0.9-0.6-1.7-0.8l-3.8-0.8
|
||||
c-1.9-0.4-3.3-1-4.1-1.9c-0.8-0.9-1.2-1.9-1.2-3.3c0-1,0.3-1.9,0.9-2.7c0.6-0.8,1.4-1.5,2.5-2s2.5-0.8,4-0.8c1.8,0,3.3,0.3,4.6,1
|
||||
c1.3,0.6,2.2,1.5,2.9,2.7l-2.7,2.2c-0.5-1-1.1-1.7-2-2.1c-0.9-0.5-1.8-0.7-2.8-0.7c-0.8,0-1.4,0.1-2,0.3c-0.6,0.2-1,0.5-1.3,0.8
|
||||
c-0.3,0.3-0.4,0.7-0.4,1.2c0,0.5,0.2,0.9,0.5,1.3s1,0.6,1.9,0.8l4.1,0.9c1.7,0.3,2.9,0.9,3.7,1.7c0.7,0.8,1.1,1.8,1.1,2.9
|
||||
c0,1.2-0.3,2.2-0.9,3c-0.6,0.9-1.5,1.6-2.6,2C92.1,38.1,90.7,38.3,89.2,38.3z"/>
|
||||
<path class="st6" d="M112.8,19.9v3H99.3v-3H112.8z M106.6,14.6v17.9c0,0.9,0.2,1.5,0.7,1.9c0.5,0.4,1.1,0.6,1.9,0.6
|
||||
c0.6,0,1.2-0.1,1.7-0.3c0.5-0.2,0.9-0.5,1.3-0.8l0.9,2.8c-0.6,0.5-1.2,0.9-2,1.1c-0.8,0.3-1.7,0.4-2.7,0.4c-1,0-2-0.2-2.8-0.5
|
||||
s-1.5-0.9-2-1.6c-0.5-0.8-0.7-1.7-0.8-3V15.7L106.6,14.6z"/>
|
||||
<path d="M137.9,17.5h-13.3v6.9h10.4v3.3h-10.4v10.2h-3.9V14.2h17.2V17.5z"/>
|
||||
<path d="M150.9,13.8c2.1,0,4,0.4,5.5,1.2c1.6,0.8,2.9,2,4,3.5l-2.6,2.5c-0.9-1.4-1.9-2.4-3.1-3c-1.1-0.6-2.5-0.9-4-0.9
|
||||
c-1.2,0-2.1,0.2-2.8,0.5c-0.7,0.3-1.3,0.7-1.6,1.2c-0.3,0.5-0.5,1.1-0.5,1.7c0,0.7,0.3,1.4,0.8,1.9c0.5,0.6,1.5,1,2.9,1.3
|
||||
l4.8,1.1c2.3,0.5,3.9,1.3,4.9,2.3c1,1,1.4,2.3,1.4,3.9c0,1.5-0.4,2.7-1.2,3.8c-0.8,1.1-1.9,1.9-3.3,2.5s-3.1,0.9-5,0.9
|
||||
c-1.7,0-3.2-0.2-4.5-0.6c-1.3-0.4-2.5-1-3.5-1.8c-1-0.7-1.8-1.6-2.5-2.6l2.7-2.7c0.5,0.8,1.1,1.6,1.9,2.2
|
||||
c0.8,0.7,1.7,1.2,2.7,1.5c1,0.4,2.2,0.5,3.4,0.5c1.1,0,2.1-0.1,2.9-0.4c0.8-0.3,1.4-0.7,1.8-1.2c0.4-0.5,0.6-1.1,0.6-1.9
|
||||
c0-0.7-0.2-1.3-0.7-1.8c-0.5-0.5-1.3-0.9-2.6-1.2l-5.2-1.2c-1.4-0.3-2.6-0.8-3.6-1.3c-0.9-0.6-1.6-1.3-2.1-2.1s-0.7-1.8-0.7-2.8
|
||||
c0-1.3,0.4-2.6,1.1-3.7c0.7-1.1,1.8-2,3.2-2.6C147.3,14.1,148.9,13.8,150.9,13.8z"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 5.5 KiB |
26
.forgejo/workflows/dco.yml
Normal file
26
.forgejo/workflows/dco.yml
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# yamllint disable rule:truthy
|
||||
|
||||
name: DCO check
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
dco:
|
||||
name: DCO
|
||||
runs-on: docker
|
||||
container:
|
||||
image: node:22-bookworm
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Go
|
||||
uses: actions/setup-go@v3
|
||||
with:
|
||||
go-version: '1.22'
|
||||
|
||||
- name: Run commit format checker
|
||||
uses: https://git.frostfs.info/TrueCloudLab/dco-go@v3
|
||||
with:
|
||||
from: 'origin/${{ github.event.pull_request.base.ref }}'
|
||||
17
.forgejo/workflows/updatechecker.yml
Normal file
17
.forgejo/workflows/updatechecker.yml
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
on:
|
||||
schedule:
|
||||
- cron: "2 0 1 * *"
|
||||
jobs:
|
||||
checkupdates:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- run: make update
|
||||
- run: |
|
||||
git config user.name "Snegurochka"
|
||||
git config user.email "snegurochka@frostfs.info"
|
||||
git switch -c update-dbs
|
||||
git add .
|
||||
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
git commit -m "Automatic database update (UN/LOCODE version $(cat tmp/locode-version.txt))" && \
|
||||
git push origin HEAD:refs/for/master -o topic=automatic-database-update
|
||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
/**/*.pb.go -diff -merge
|
||||
/**/*.pb.go linguist-generated=true
|
||||
6
.gitignore
vendored
Normal file
6
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
tmp/
|
||||
in/
|
||||
locode_db
|
||||
# debhelpers
|
||||
**/.debhelper
|
||||
debian/changelog
|
||||
11
.gitlint
Normal file
11
.gitlint
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
[general]
|
||||
fail-without-commits=True
|
||||
regex-style-search=True
|
||||
contrib=CC1
|
||||
|
||||
[title-match-regex]
|
||||
regex=^\[\#[0-9Xx]+\]\s
|
||||
|
||||
[ignore-by-title]
|
||||
regex=^Release(.*)
|
||||
ignore=title-match-regex
|
||||
64
.golangci.yml
Normal file
64
.golangci.yml
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# This file contains all available configuration options
|
||||
# with their default values.
|
||||
|
||||
# options for analysis running
|
||||
run:
|
||||
# timeout for analysis, e.g. 30s, 5m, default is 1m
|
||||
timeout: 10m
|
||||
|
||||
# include test files or not, default is true
|
||||
tests: false
|
||||
|
||||
# output configuration options
|
||||
output:
|
||||
# colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
|
||||
format: tab
|
||||
|
||||
# all available settings of specific linters
|
||||
linters-settings:
|
||||
exhaustive:
|
||||
# indicates that switch statements are to be considered exhaustive if a
|
||||
# 'default' case is present, even if all enum members aren't listed in the
|
||||
# switch
|
||||
default-signifies-exhaustive: true
|
||||
govet:
|
||||
# report about shadowed variables
|
||||
check-shadowing: false
|
||||
staticcheck:
|
||||
checks: ["all"]
|
||||
funlen:
|
||||
lines: 80 # default 60
|
||||
statements: 60 # default 40
|
||||
gocognit:
|
||||
min-complexity: 40 # default 30
|
||||
|
||||
linters:
|
||||
enable:
|
||||
# mandatory linters
|
||||
- govet
|
||||
- revive
|
||||
- errcheck
|
||||
- gosimple
|
||||
- ineffassign
|
||||
- staticcheck
|
||||
- typecheck
|
||||
- unused
|
||||
- bidichk
|
||||
- durationcheck
|
||||
- exhaustive
|
||||
- exportloopref
|
||||
- gofmt
|
||||
- goimports
|
||||
- misspell
|
||||
- whitespace
|
||||
|
||||
# extra linters
|
||||
- godot
|
||||
- predeclared
|
||||
- reassign
|
||||
- containedctx
|
||||
- funlen
|
||||
- gocognit
|
||||
- contextcheck
|
||||
disable-all: true
|
||||
fast: false
|
||||
45
.pre-commit-config.yaml
Normal file
45
.pre-commit-config.yaml
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
ci:
|
||||
autofix_prs: false
|
||||
|
||||
repos:
|
||||
- repo: https://github.com/jorisroovers/gitlint
|
||||
rev: v0.19.1
|
||||
hooks:
|
||||
- id: gitlint
|
||||
stages: [commit-msg]
|
||||
- id: gitlint-ci
|
||||
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.4.0
|
||||
hooks:
|
||||
- id: check-added-large-files
|
||||
- id: check-case-conflict
|
||||
- id: check-executables-have-shebangs
|
||||
- id: check-shebang-scripts-are-executable
|
||||
- id: check-merge-conflict
|
||||
- id: check-json
|
||||
- id: check-xml
|
||||
- id: check-yaml
|
||||
- id: trailing-whitespace
|
||||
args: [--markdown-linebreak-ext=md]
|
||||
- id: end-of-file-fixer
|
||||
exclude: ".key$"
|
||||
|
||||
- repo: https://github.com/shellcheck-py/shellcheck-py
|
||||
rev: v0.9.0.2
|
||||
hooks:
|
||||
- id: shellcheck
|
||||
|
||||
- repo: https://github.com/golangci/golangci-lint
|
||||
rev: v1.51.2
|
||||
hooks:
|
||||
- id: golangci-lint
|
||||
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: go-unit-tests
|
||||
name: go unit tests
|
||||
entry: make test
|
||||
pass_filenames: false
|
||||
types: [go]
|
||||
language: system
|
||||
52
CHANGELOG.md
Normal file
52
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# Changelog
|
||||
Changelog for FrostFS LOCODE database
|
||||
|
||||
## 0.5.0 - 2023-09-30
|
||||
|
||||
The package now contains tool to generate database to be used
|
||||
by FrostFS inner ring nodes. The dependency on the `frostfs-cli`
|
||||
is removed from the debian package.
|
||||
|
||||
## 0.4.0 - 2023-04-24
|
||||
|
||||
Now we can build UN/LOCODE DB without Internet connection and with a
|
||||
reproducible result, as we take all inputs form files stored in local
|
||||
repository.
|
||||
|
||||
### Changed
|
||||
- Added data sources into repository to provide offline builds (#5)
|
||||
- Rename data files to simplify update (#5)
|
||||
|
||||
### Fixed
|
||||
- Makefile fixes for parallel make (#4)
|
||||
|
||||
## 0.3.1 - 2022-12-22
|
||||
|
||||
### Changed
|
||||
- Rebranding to FrostFS
|
||||
|
||||
## 0.3.0 - 2022-10-28
|
||||
|
||||
### Changed
|
||||
- Added Makefile to simplify DB build (#9)
|
||||
- Added .deb packages support (#11)
|
||||
|
||||
### Updated
|
||||
- UN/LOCODE to `2022-1` version
|
||||
|
||||
## 0.2.1 - 2021-11-02
|
||||
|
||||
### Changed
|
||||
- Find the nearest continent for LOCODEs without exact continent match (#3, #6)
|
||||
|
||||
## 0.2.0 - 2021-10-21
|
||||
|
||||
### Fixed
|
||||
- Decimal parts of coordinates contains minutes, not degrees (#2)
|
||||
|
||||
### Updated
|
||||
- UN/LOCODE to `2021-1` version
|
||||
|
||||
## 0.1.0 - 2021-02-10
|
||||
|
||||
Initial release.
|
||||
1
CODEOWNERS
Normal file
1
CODEOWNERS
Normal file
|
|
@ -0,0 +1 @@
|
|||
.* @alexvanin @realloc @fyrchik @a.bogatyrev
|
||||
156
CONTRIBUTING.md
Normal file
156
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
# Contribution guide
|
||||
|
||||
First, thank you for contributing! We love and encourage pull requests from
|
||||
everyone. Please follow the guidelines:
|
||||
|
||||
- Check the open [issues](https://git.frostfs.info/TrueCloudLab/frostfs-locode-db/issues) and
|
||||
[pull requests](https://git.frostfs.info/TrueCloudLab/frostfs-locode-db/pulls) for existing
|
||||
discussions.
|
||||
|
||||
- Open an issue first, to discuss a new feature or enhancement.
|
||||
|
||||
- Write tests, and make sure the test suite passes locally and on CI.
|
||||
|
||||
- Open a pull request, and reference the relevant issue(s).
|
||||
|
||||
- Make sure your commits are logically separated and have good comments
|
||||
explaining the details of your change.
|
||||
|
||||
- After receiving feedback, amend your commits or add new ones as
|
||||
appropriate.
|
||||
|
||||
- **Have fun!**
|
||||
|
||||
## Development Workflow
|
||||
|
||||
Start by forking the `frostfs-locode-db` repository, make changes in a branch and then
|
||||
send a pull request. We encourage pull requests to discuss code changes. Here
|
||||
are the steps in details:
|
||||
|
||||
### Set up your Forgejo repository
|
||||
Fork [FrostFS node upstream](https://git.frostfs.info/TrueCloudLab/frostfs-locode-db) source
|
||||
repository to your own personal repository. Copy the URL of your fork (you will
|
||||
need it for the `git clone` command below).
|
||||
|
||||
```sh
|
||||
$ git clone https://git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
```
|
||||
|
||||
### Set up git remote as ``upstream``
|
||||
```sh
|
||||
$ cd frostfs-locode-db
|
||||
$ git remote add upstream https://git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
$ git fetch upstream
|
||||
$ git merge upstream/master
|
||||
...
|
||||
```
|
||||
|
||||
### Create your feature branch
|
||||
Before making code changes, make sure you create a separate branch for these
|
||||
changes. Maybe you will find it convenient to name branch in
|
||||
`<type>/<Issue>-<changes_topic>` format.
|
||||
|
||||
```
|
||||
$ git checkout -b feature/123-something_awesome
|
||||
```
|
||||
|
||||
### Test your changes
|
||||
After your code changes, make sure
|
||||
|
||||
- To add test cases for the new code.
|
||||
- To run `make lint` and `make staticcheck-run`
|
||||
- To squash your commits into a single commit or a series of logically separated
|
||||
commits run `git rebase -i`. It's okay to force update your pull request.
|
||||
- To run `make test` and `make all` completes.
|
||||
|
||||
### Commit changes
|
||||
After verification, commit your changes. This is a [great
|
||||
post](https://chris.beams.io/posts/git-commit/) on how to write useful commit
|
||||
messages. Try following this template:
|
||||
|
||||
```
|
||||
[#Issue] <component> Summary
|
||||
|
||||
Description
|
||||
|
||||
<Macros>
|
||||
|
||||
<Sign-Off>
|
||||
```
|
||||
|
||||
```
|
||||
$ git commit -sam '[#123] Add some feature'
|
||||
```
|
||||
|
||||
### Push to the branch
|
||||
Push your locally committed changes to the remote origin (your fork)
|
||||
```
|
||||
$ git push origin feature/123-something_awesome
|
||||
```
|
||||
|
||||
### Create a Pull Request
|
||||
Pull requests can be created via Forgejo. Refer to [this
|
||||
document](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/) for
|
||||
detailed steps on how to create a pull request. After a Pull Request gets peer
|
||||
reviewed and approved, it will be merged.
|
||||
|
||||
## DCO Sign off
|
||||
|
||||
All authors to the project retain copyright to their work. However, to ensure
|
||||
that they are only submitting work that they have rights to, we are requiring
|
||||
everyone to acknowledge this by signing their work.
|
||||
|
||||
Any copyright notices in this repository should specify the authors as "the
|
||||
contributors".
|
||||
|
||||
To sign your work, just add a line like this at the end of your commit message:
|
||||
|
||||
```
|
||||
Signed-off-by: Samii Sakisaka <samii@ivunojikan.co.jp>
|
||||
|
||||
```
|
||||
|
||||
This can easily be done with the `--signoff` option to `git commit`.
|
||||
|
||||
By doing this you state that you can certify the following (from [The Developer
|
||||
Certificate of Origin](https://developercertificate.org/)):
|
||||
|
||||
```
|
||||
Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
1 Letterman Drive
|
||||
Suite D4700
|
||||
San Francisco, CA, 94129
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
```
|
||||
428
LICENSE
Normal file
428
LICENSE
Normal file
|
|
@ -0,0 +1,428 @@
|
|||
Attribution-ShareAlike 4.0 International
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More_considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||
License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||
License"). To the extent this Public License may be interpreted as a
|
||||
contract, You are granted the Licensed Rights in consideration of Your
|
||||
acceptance of these terms and conditions, and the Licensor grants You
|
||||
such rights in consideration of benefits the Licensor receives from
|
||||
making the Licensed Material available under these terms and
|
||||
conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at
|
||||
creativecommons.org/compatiblelicenses, approved by Creative
|
||||
Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name
|
||||
of a Creative Commons Public License. The License Elements of this
|
||||
Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. Additional offer from the Licensor -- Adapted Material.
|
||||
Every recipient of Adapted Material from You
|
||||
automatically receives an offer from the Licensor to
|
||||
exercise the Licensed Rights in the Adapted Material
|
||||
under the conditions of the Adapter's License You apply.
|
||||
|
||||
c. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
b. ShareAlike.
|
||||
|
||||
In addition to the conditions in Section 3(a), if You Share
|
||||
Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter's License You apply must be a Creative Commons
|
||||
license with the same License Elements, this version or
|
||||
later, or a BY-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the
|
||||
Adapter's License You apply. You may satisfy this condition
|
||||
in any reasonable manner based on the medium, means, and
|
||||
context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms
|
||||
or conditions on, or apply any Effective Technological
|
||||
Measures to, Adapted Material that restrict exercise of the
|
||||
rights granted under the Adapter's License You apply.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material,
|
||||
|
||||
including for purposes of Section 3(b); and
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
||||
131
Makefile
Executable file
131
Makefile
Executable file
|
|
@ -0,0 +1,131 @@
|
|||
#!/usr/bin/make -f
|
||||
|
||||
VERSION ?= "$(shell git describe --tags --match "v*" --dirty --always --abbrev=8 2>/dev/null || cat VERSION 2>/dev/null || echo "develop")"
|
||||
FROST_LOCODE = ./frostfs-locode-db
|
||||
|
||||
.PHONY: all clean version help update debpackage
|
||||
|
||||
DIRS = in tmp
|
||||
|
||||
# IGNORE
|
||||
space := $(subst ,, )
|
||||
|
||||
# .deb package versioning
|
||||
OS_RELEASE = $(shell lsb_release -cs)
|
||||
PKG_VERSION ?= $(shell echo $(VERSION) | sed "s/^v//" | \
|
||||
sed -E "s/(.*)-(g[a-fA-F0-9]{6,8})(.*)/\1\3~\2/" | \
|
||||
sed "s/-/~/")-${OS_RELEASE}
|
||||
|
||||
# Generate locode_db BoltDB file
|
||||
all: $(DIRS) $(FROST_LOCODE) locode_db
|
||||
|
||||
$(FROST_LOCODE):
|
||||
go build .
|
||||
|
||||
$(DIRS):
|
||||
@echo "⇒ Ensure dir: $@"
|
||||
@mkdir -p $@
|
||||
|
||||
in/airports.dat: $(DIRS)
|
||||
zcat data/airports.dat.gz > in/airports.dat
|
||||
|
||||
in/countries.dat: $(DIRS)
|
||||
zcat data/countries.dat.gz > in/countries.dat
|
||||
|
||||
in/continents.geojson: $(DIRS)
|
||||
zcat data/continents.geojson.gz > in/continents.geojson
|
||||
|
||||
in/unlocode-SubdivisionCodes.csv: $(DIRS)
|
||||
zcat data/unlocode-SubdivisionCodes.csv.gz > in/unlocode-SubdivisionCodes.csv
|
||||
|
||||
in/unlocode-CodeList.csv: $(DIRS)
|
||||
zcat data/unlocode-CodeList.csv.gz > in/unlocode-CodeList.csv
|
||||
|
||||
# Generate locode_db BoltDB file
|
||||
locode_db: in/unlocode-CodeList.csv in/unlocode-SubdivisionCodes.csv in/continents.geojson in/airports.dat in/countries.dat $(FROST_LOCODE)
|
||||
$(FROST_LOCODE) generate \
|
||||
--airports in/airports.dat \
|
||||
--continents in/continents.geojson \
|
||||
--countries in/countries.dat \
|
||||
--in in/unlocode-CodeList.csv \
|
||||
--subdiv in/unlocode-SubdivisionCodes.csv \
|
||||
--out locode_db
|
||||
chmod 644 locode_db
|
||||
|
||||
# IGNORE
|
||||
# Openflights doesn't have tags or releases, so update would always take latest master version.
|
||||
# See https://github.com/jpatokal/openflights
|
||||
data/airports.dat.gz: $(DIRS)
|
||||
wget -c https://raw.githubusercontent.com/jpatokal/openflights/master/data/airports.dat -O tmp/airports.dat && \
|
||||
gzip -c tmp/airports.dat > data/airports.dat.gz
|
||||
|
||||
data/countries.dat.gz: $(DIRS)
|
||||
wget -c https://raw.githubusercontent.com/jpatokal/openflights/master/data/countries.dat -O tmp/countries.dat && \
|
||||
gzip -c tmp/countries.dat > data/countries.dat.gz
|
||||
|
||||
# IGNORE
|
||||
# See https://unece.org/trade/cefact/UNLOCODE-Download
|
||||
tmp/locode.csv.zip :$(DIRS)
|
||||
DOWNLOADURL=$$(wget -O - https://unece.org/trade/cefact/UNLOCODE-Download \
|
||||
| grep -oP '(?<=href=")\S+loc\d+csv\.zip'); \
|
||||
echo "$$DOWNLOADURL" | grep -oP '(?<=loc)\d+' > tmp/locode-version.txt; \
|
||||
wget -c "$$DOWNLOADURL" -O tmp/locode.csv.zip
|
||||
|
||||
data/unlocode-SubdivisionCodes.csv.gz: tmp/locode.csv.zip
|
||||
unzip -p tmp/locode.csv.zip "*SubdivisionCodes.csv" | gzip > data/unlocode-SubdivisionCodes.csv.gz
|
||||
|
||||
data/unlocode-CodeList.csv.gz: tmp/locode.csv.zip
|
||||
unzip -p tmp/locode.csv.zip "*CodeListPart*" | gzip > data/unlocode-CodeList.csv.gz
|
||||
|
||||
# Download and repack external data-sources
|
||||
update: data/unlocode-CodeList.csv.gz data/unlocode-SubdivisionCodes.csv.gz data/countries.dat.gz data/airports.dat.gz
|
||||
|
||||
# Print version
|
||||
version:
|
||||
@echo $(VERSION)
|
||||
|
||||
# Show this help prompt
|
||||
help:
|
||||
@echo ' Usage:'
|
||||
@echo ''
|
||||
@echo ' make <target>'
|
||||
@echo ''
|
||||
@echo ' Targets:'
|
||||
@echo ''
|
||||
@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print " ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort -u
|
||||
|
||||
# Run tests
|
||||
test: locode_db
|
||||
test -n "$$($(FROST_LOCODE) info --db locode_db --locode "US NYC" 2>&1 | grep "New York")"
|
||||
test -n "$$($(FROST_LOCODE) info --db locode_db --locode "RU LED" 2>&1 | grep "Leningrad")"
|
||||
test -n "$$($(FROST_LOCODE) info --db locode_db --locode "RU KUF" 2>&1 | grep "Samara")"
|
||||
test -n "$$($(FROST_LOCODE) info --db locode_db --locode "VN DAN" 2>&1 | grep "Binh Hoa")"
|
||||
test -n "$$($(FROST_LOCODE) info --db locode_db --locode "FR PAR" 2>&1 | grep "Paris")"
|
||||
|
||||
# Clean data directory before update
|
||||
clean_data:
|
||||
rm -f data/unlocode-CodeList.csv.gz
|
||||
rm -f data/unlocode-SubdivisionCodes.csv.gz
|
||||
rm -f data/countries.dat.gz
|
||||
rm -f data/airports.dat.gz
|
||||
|
||||
# Clean up
|
||||
clean:
|
||||
rm -f in/*
|
||||
rm -f tmp/*
|
||||
rm -f locode_db
|
||||
rm -f $(FROST_LOCODE)
|
||||
|
||||
# Package for Debian
|
||||
debpackage:
|
||||
dch --package frostfs-locode-db \
|
||||
--controlmaint \
|
||||
--newversion $(PKG_VERSION) \
|
||||
--force-bad-version \
|
||||
--distribution $(OS_RELEASE) \
|
||||
"Please see CHANGELOG.md for code changes for $(VERSION)"
|
||||
dpkg-buildpackage --no-sign -b
|
||||
|
||||
# Clean up debian packaging leftovers
|
||||
debclean:
|
||||
dh clean
|
||||
105
README.md
105
README.md
|
|
@ -1,3 +1,104 @@
|
|||
# WIP area: this repo is just a fork!
|
||||
<p align="center">
|
||||
<img src="./.forgejo/logo.svg" width="500px" alt="FrostFS logo">
|
||||
</p>
|
||||
<p align="center">
|
||||
UN/LOCODE database for <a href="https://frostfs.info">ForstFS</a>
|
||||
</p>
|
||||
|
||||
Useful things may be published only in [other branches](../../../branches)
|
||||
---
|
||||
# Overview
|
||||
|
||||
FrostFS uses UN/LOCODE in storage node attributes and storage policies. Inner
|
||||
ring nodes converts UN/LOCODE into human-readable set of attributes such as
|
||||
continent, country name, etc.
|
||||
|
||||
This repository tools generate UN/LOCODE database for FrostFS using data from
|
||||
following sources:
|
||||
- [UN/LOCODE](https://unece.org/trade/cefact/UNLOCODE-Download) database in CSV
|
||||
format, licensed under the [ODC Public Domain Dedication and Licence (PDDL)](http://opendatacommons.org/licenses/pddl/1-0/)
|
||||
- [OpenFlight Airports and
|
||||
Countries](https://raw.githubusercontent.com/jpatokal/openflights/master/data/)
|
||||
databases, licensed under the [GNU AGPL-3.0
|
||||
license](https://github.com/jpatokal/openflights/blob/master/LICENSE)
|
||||
- [OpenStreetMap](https://www.openstreetmap.org/)® open data, licensed under the [Open Data Commons Open
|
||||
Database License](https://opendatacommons.org/licenses/odbl/) (ODbL)
|
||||
|
||||
# Build
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Go 1.21
|
||||
|
||||
## Quick start
|
||||
|
||||
Just run `make` to generate `locode_db` file for use with FrostFS InnerRing nodes.
|
||||
|
||||
``` shell
|
||||
$ make
|
||||
...
|
||||
--out locode_db
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
Then run frost-cli command to generate UN/LOCODE database.
|
||||
```
|
||||
$ ./frostfs-locode-db generate
|
||||
Generate UN/LOCODE database for FrostFS
|
||||
|
||||
Usage:
|
||||
frostfs-locode-db generate [flags]
|
||||
|
||||
Flags:
|
||||
--airports string Path to OpenFlights airport database (csv)
|
||||
--continents string Path to continent polygons (GeoJSON)
|
||||
--countries string Path to OpenFlights country database (csv)
|
||||
-h, --help help for generate
|
||||
--in strings List of paths to UN/LOCODE tables (csv)
|
||||
--out string Target path for generated database
|
||||
--subdiv string Path to UN/LOCODE subdivision database (csv)
|
||||
|
||||
$ ./frostfs-locode-db generate \
|
||||
--airports airports.dat \
|
||||
--continents continents.geojson \
|
||||
--countries countries.dat \
|
||||
--in 2022-2\ UNLOCODE\ CodeList.csv \
|
||||
--subdiv 2022-2\ SubdivisionCodes.csv \
|
||||
--out locode_db
|
||||
```
|
||||
|
||||
**Database generation might take some time!**
|
||||
|
||||
You can test generated database with `frostfs-locode-db`.
|
||||
```
|
||||
$ frostfs-locode-db info --db locode_db --locode 'RU LED'
|
||||
Country: Russia
|
||||
Location: Saint Petersburg (ex Leningrad)
|
||||
Continent: Europe
|
||||
Subdivision: [SPE] Sankt-Peterburg
|
||||
Coordinates: 59.88, 30.25
|
||||
```
|
||||
|
||||
# Building Debian package
|
||||
|
||||
The most simple way is to run a make target
|
||||
|
||||
```shell
|
||||
$ make debpackage
|
||||
```
|
||||
|
||||
When packages are built, you can clean up the leftover with
|
||||
|
||||
```shell
|
||||
$ dh clean
|
||||
```
|
||||
or
|
||||
```shell
|
||||
$ make debclean
|
||||
```
|
||||
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the CC Attribution-ShareAlike 4.0 International -
|
||||
see the [LICENSE](LICENSE) file for details
|
||||
|
|
|
|||
1
VERSION
Normal file
1
VERSION
Normal file
|
|
@ -0,0 +1 @@
|
|||
v0.3.1
|
||||
BIN
data/airports.dat.gz
Normal file
BIN
data/airports.dat.gz
Normal file
Binary file not shown.
BIN
data/continents.geojson.gz
Normal file
BIN
data/continents.geojson.gz
Normal file
Binary file not shown.
BIN
data/countries.dat.gz
Normal file
BIN
data/countries.dat.gz
Normal file
Binary file not shown.
BIN
data/unlocode-CodeList.csv.gz
Normal file
BIN
data/unlocode-CodeList.csv.gz
Normal file
Binary file not shown.
BIN
data/unlocode-SubdivisionCodes.csv.gz
Normal file
BIN
data/unlocode-SubdivisionCodes.csv.gz
Normal file
Binary file not shown.
5
debian/changelog
vendored
Normal file
5
debian/changelog
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
frostfs-locode-db (0.3.0) stable; urgency=medium
|
||||
|
||||
* Initial change.
|
||||
|
||||
-- TrueCloudLab <tech@frostfs.info> Wed, 19 Oct 2022 12:33:04 +0300
|
||||
17
debian/control
vendored
Normal file
17
debian/control
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
Source: frostfs-locode-db
|
||||
Section: misc
|
||||
Priority: optional
|
||||
Maintainer: TrueCloudLabs <tech@frostfs.info>
|
||||
Build-Depends: debhelper-compat (= 13), git, devscripts, wget
|
||||
Standards-Version: 4.5.1
|
||||
Homepage: https://frostfs.info/
|
||||
Vcs-Git: https://git.frostfs.info/TrueCloudLab/frostfs-locode-db.git
|
||||
Vcs-Browser: https://git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
|
||||
Package: frostfs-locode-db
|
||||
Architecture: any
|
||||
Depends: ${misc:Depends}
|
||||
Description: Compiled UN/LOCODE database for FrostFS
|
||||
Frostfs uses UN/LOCODE in storage node attributes and storage policies.
|
||||
Inner ring nodes converts UN/LOCODE into human-readable set of attributes
|
||||
such as continent, country name, etc.
|
||||
12
debian/copyright
vendored
Normal file
12
debian/copyright
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: frostfs-locode-db
|
||||
Upstream-Contact: tech@frostfs.info
|
||||
Source: https://git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
|
||||
Files: *
|
||||
Copyright: 2022-2023 TrueCloudLab (@TrueCloudLab)
|
||||
Copyright: 2018-2022 NeoSPCC (@nspcc-dev)
|
||||
|
||||
License: CC-BY-SA-4.0
|
||||
This project is licensed under the CC Attribution-ShareAlike 4.0 International
|
||||
https://creativecommons.org/licenses/by-sa/4.0/legalcode
|
||||
2
debian/frostfs-locode-db.install
vendored
Normal file
2
debian/frostfs-locode-db.install
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
locode_db var/lib/frostfs/ir
|
||||
frostfs-locode-db usr/bin/frostfs-locode-db
|
||||
15
debian/rules
vendored
Executable file
15
debian/rules
vendored
Executable file
|
|
@ -0,0 +1,15 @@
|
|||
#!/usr/bin/make -f
|
||||
|
||||
export DEB_BUILD_OPTIONS := nostrip nocheck
|
||||
|
||||
%:
|
||||
dh $@
|
||||
|
||||
override_dh_auto_build:
|
||||
$(MAKE) all
|
||||
|
||||
override_dh_installchangelogs:
|
||||
dh_installchangelogs -k CHANGELOG.md
|
||||
|
||||
override_dh_clean:
|
||||
dh_clean
|
||||
1
debian/source/format
vendored
Normal file
1
debian/source/format
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
3.0 (quilt)
|
||||
21
go.mod
Normal file
21
go.mod
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
module git.frostfs.info/TrueCloudLab/frostfs-locode-db
|
||||
|
||||
go 1.21
|
||||
|
||||
require (
|
||||
github.com/paulmach/orb v0.11.1
|
||||
github.com/spf13/cobra v1.8.1
|
||||
github.com/stretchr/testify v1.9.0
|
||||
go.etcd.io/bbolt v1.3.10
|
||||
golang.org/x/sync v0.7.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
|
||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
|
||||
github.com/spf13/pflag v1.0.5 // indirect
|
||||
go.mongodb.org/mongo-driver v1.13.1 // indirect
|
||||
golang.org/x/sys v0.18.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
110
go.sum
Normal file
110
go.sum
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
|
||||
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
|
||||
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
|
||||
github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
|
||||
github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
|
||||
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
|
||||
github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
|
||||
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
|
||||
github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
|
||||
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
|
||||
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe/go.mod h1:wL8QJuTMNUDYhXwkmfOly8iTdp5TEcJFWZD2D7SIkUc=
|
||||
github.com/paulmach/orb v0.11.1 h1:3koVegMC4X/WeiXYz9iswopaTwMem53NzTJuTF20JzU=
|
||||
github.com/paulmach/orb v0.11.1/go.mod h1:5mULz1xQfs3bmQm63QEJA6lNGujuRafwA5S/EnuLaLU=
|
||||
github.com/paulmach/protoscan v0.2.1/go.mod h1:SpcSwydNLrxUGSDvXvO0P7g7AuhJ7lcKfDlhJCDw2gY=
|
||||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
|
||||
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||
github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
|
||||
github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
|
||||
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
|
||||
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
|
||||
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
|
||||
github.com/xdg-go/pbkdf2 v1.0.0/go.mod h1:jrpuAogTd400dnrH08LKmI/xc1MbPOebTwRqcT5RDeI=
|
||||
github.com/xdg-go/scram v1.1.1/go.mod h1:RaEWvsqvNKKvBPvcKeFjrG2cJqOkHTiyTpzz23ni57g=
|
||||
github.com/xdg-go/scram v1.1.2/go.mod h1:RT/sEzTbU5y00aCK8UOx6R7YryM0iF1N2MOmC3kKLN4=
|
||||
github.com/xdg-go/stringprep v1.0.3/go.mod h1:W3f5j4i+9rC0kuIEJL0ky1VpHXQU3ocBgklLGvcBnW8=
|
||||
github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gijq1dTyGkM=
|
||||
github.com/youmark/pkcs8 v0.0.0-20181117223130-1be2e3e5546d/go.mod h1:rHwXgn7JulP+udvsHwJoVG1YGAP6VLg4y9I5dyZdqmA=
|
||||
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||
go.etcd.io/bbolt v1.3.10 h1:+BqfJTcCzTItrop8mq/lbzL8wSGtj94UO/3U31shqG0=
|
||||
go.etcd.io/bbolt v1.3.10/go.mod h1:bK3UQLPJZly7IlNmV7uVHJDxfe5aK9Ll93e/74Y9oEQ=
|
||||
go.mongodb.org/mongo-driver v1.11.4/go.mod h1:PTSz5yu21bkT/wXpkS7WR5f0ddqw5quethTUn9WM+2g=
|
||||
go.mongodb.org/mongo-driver v1.13.1 h1:YIc7HTYsKndGK4RFzJ3covLz1byri52x0IoMB0Pt/vk=
|
||||
go.mongodb.org/mongo-driver v1.13.1/go.mod h1:wcDf1JBCXy2mOW0bWHwO/IOYqdca1MPCwDtFu/Z9+eo=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
|
||||
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
|
||||
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
|
||||
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||
golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
|
||||
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
||||
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
|
||||
google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
96
locode_generate.go
Normal file
96
locode_generate.go
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
airportsdb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db/airports"
|
||||
locodebolt "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db/boltdb"
|
||||
continentsdb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db/continents/geojson"
|
||||
csvlocode "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/table/csv"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
type namesDB struct {
|
||||
*airportsdb.DB
|
||||
*csvlocode.Table
|
||||
}
|
||||
|
||||
const (
|
||||
locodeGenerateInputFlag = "in"
|
||||
locodeGenerateSubDivFlag = "subdiv"
|
||||
locodeGenerateAirportsFlag = "airports"
|
||||
locodeGenerateCountriesFlag = "countries"
|
||||
locodeGenerateContinentsFlag = "continents"
|
||||
locodeGenerateOutputFlag = "out"
|
||||
)
|
||||
|
||||
var (
|
||||
locodeGenerateInPaths []string
|
||||
locodeGenerateSubDivPath string
|
||||
locodeGenerateAirportsPath string
|
||||
locodeGenerateCountriesPath string
|
||||
locodeGenerateContinentsPath string
|
||||
locodeGenerateOutPath string
|
||||
|
||||
locodeGenerateCmd = &cobra.Command{
|
||||
Use: "generate",
|
||||
Short: "Generate UN/LOCODE database for FrostFS",
|
||||
Run: func(cmd *cobra.Command, _ []string) {
|
||||
|
||||
locodeDB := csvlocode.New(
|
||||
csvlocode.Prm{
|
||||
Path: locodeGenerateInPaths[0],
|
||||
SubDivPath: locodeGenerateSubDivPath,
|
||||
},
|
||||
csvlocode.WithExtraPaths(locodeGenerateInPaths[1:]...),
|
||||
)
|
||||
|
||||
airportDB := airportsdb.New(airportsdb.Prm{
|
||||
AirportsPath: locodeGenerateAirportsPath,
|
||||
CountriesPath: locodeGenerateCountriesPath,
|
||||
})
|
||||
|
||||
continentsDB := continentsdb.New(continentsdb.Prm{
|
||||
Path: locodeGenerateContinentsPath,
|
||||
})
|
||||
|
||||
targetDB := locodebolt.New(locodebolt.Prm{
|
||||
Path: locodeGenerateOutPath,
|
||||
})
|
||||
|
||||
err := targetDB.Open()
|
||||
ExitOnErr(cmd, "", err)
|
||||
|
||||
defer targetDB.Close()
|
||||
|
||||
names := &namesDB{
|
||||
DB: airportDB,
|
||||
Table: locodeDB,
|
||||
}
|
||||
|
||||
err = locodedb.FillDatabase(locodeDB, airportDB, continentsDB, names, targetDB)
|
||||
ExitOnErr(cmd, "", err)
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
func initUtilLocodeGenerateCmd() {
|
||||
flags := locodeGenerateCmd.Flags()
|
||||
|
||||
flags.StringSliceVar(&locodeGenerateInPaths, locodeGenerateInputFlag, nil, "List of paths to UN/LOCODE tables (csv)")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateInputFlag)
|
||||
|
||||
flags.StringVar(&locodeGenerateSubDivPath, locodeGenerateSubDivFlag, "", "Path to UN/LOCODE subdivision database (csv)")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateSubDivFlag)
|
||||
|
||||
flags.StringVar(&locodeGenerateAirportsPath, locodeGenerateAirportsFlag, "", "Path to OpenFlights airport database (csv)")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateAirportsFlag)
|
||||
|
||||
flags.StringVar(&locodeGenerateCountriesPath, locodeGenerateCountriesFlag, "", "Path to OpenFlights country database (csv)")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateCountriesFlag)
|
||||
|
||||
flags.StringVar(&locodeGenerateContinentsPath, locodeGenerateContinentsFlag, "", "Path to continent polygons (GeoJSON)")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateContinentsFlag)
|
||||
|
||||
flags.StringVar(&locodeGenerateOutPath, locodeGenerateOutputFlag, "", "Target path for generated database")
|
||||
_ = locodeGenerateCmd.MarkFlagRequired(locodeGenerateOutputFlag)
|
||||
}
|
||||
30
locode_generate_test.go
Normal file
30
locode_generate_test.go
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"testing"
|
||||
)
|
||||
|
||||
var (
|
||||
in = flag.String(locodeGenerateInputFlag, "", "List of paths to UN/LOCODE tables (csv)")
|
||||
subdiv = flag.String(locodeGenerateSubDivFlag, "", "Path to UN/LOCODE subdivision database (csv)")
|
||||
airports = flag.String(locodeGenerateAirportsFlag, "", "Path to OpenFlights airport database (csv)")
|
||||
countries = flag.String(locodeGenerateCountriesFlag, "", "Path to OpenFlights country database (csv)")
|
||||
continents = flag.String(locodeGenerateContinentsFlag, "", "Path to continent polygons (GeoJSON)")
|
||||
out = flag.String(locodeGenerateOutputFlag, "", "Target path for generated database")
|
||||
)
|
||||
|
||||
func BenchmarkLocodeGenerate(b *testing.B) {
|
||||
locodeGenerateInPaths = append(locodeGenerateInPaths, *in)
|
||||
locodeGenerateSubDivPath = *subdiv
|
||||
locodeGenerateAirportsPath = *airports
|
||||
locodeGenerateCountriesPath = *countries
|
||||
locodeGenerateContinentsPath = *continents
|
||||
locodeGenerateOutPath = *out
|
||||
|
||||
b.ResetTimer()
|
||||
|
||||
for i := 0; i < b.N; i++ {
|
||||
locodeGenerateCmd.Run(locodeGenerateCmd, []string{})
|
||||
}
|
||||
}
|
||||
55
locode_info.go
Normal file
55
locode_info.go
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
locodebolt "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db/boltdb"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
const (
|
||||
locodeInfoDBFlag = "db"
|
||||
locodeInfoCodeFlag = "locode"
|
||||
)
|
||||
|
||||
var (
|
||||
locodeInfoDBPath string
|
||||
locodeInfoCode string
|
||||
|
||||
locodeInfoCmd = &cobra.Command{
|
||||
Use: "info",
|
||||
Short: "Print information about UN/LOCODE from FrostFS database",
|
||||
Run: func(cmd *cobra.Command, _ []string) {
|
||||
targetDB := locodebolt.New(locodebolt.Prm{
|
||||
Path: locodeInfoDBPath,
|
||||
}, locodebolt.ReadOnly())
|
||||
|
||||
err := targetDB.Open()
|
||||
ExitOnErr(cmd, "", err)
|
||||
|
||||
defer targetDB.Close()
|
||||
|
||||
record, err := locodedb.LocodeRecord(targetDB, locodeInfoCode)
|
||||
ExitOnErr(cmd, "", err)
|
||||
|
||||
cmd.Printf("Country: %s\n", record.CountryName())
|
||||
cmd.Printf("Location: %s\n", record.LocationName())
|
||||
cmd.Printf("Continent: %s\n", record.Continent())
|
||||
if subDivCode := record.SubDivCode(); subDivCode != "" {
|
||||
cmd.Printf("Subdivision: [%s] %s\n", subDivCode, record.SubDivName())
|
||||
}
|
||||
|
||||
geoPoint := record.GeoPoint()
|
||||
cmd.Printf("Coordinates: %0.2f, %0.2f\n", geoPoint.Latitude(), geoPoint.Longitude())
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
func initUtilLocodeInfoCmd() {
|
||||
flags := locodeInfoCmd.Flags()
|
||||
|
||||
flags.StringVar(&locodeInfoDBPath, locodeInfoDBFlag, "", "Path to FrostFS UN/LOCODE database")
|
||||
_ = locodeInfoCmd.MarkFlagRequired(locodeInfoDBFlag)
|
||||
|
||||
flags.StringVar(&locodeInfoCode, locodeInfoCodeFlag, "", "UN/LOCODE")
|
||||
_ = locodeInfoCmd.MarkFlagRequired(locodeInfoCodeFlag)
|
||||
}
|
||||
45
main.go
Normal file
45
main.go
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
var rootCmd = &cobra.Command{
|
||||
Use: "frostfs-locode-db",
|
||||
Short: "Command Line Tool to work with FrostFS' UN/LOCODE databases",
|
||||
Long: "This tool can be used for generating or accessing FrostFS UN/LOCODE databases.",
|
||||
}
|
||||
|
||||
func ExitOnErr(cmd *cobra.Command, errFmt string, err error) {
|
||||
if err == nil {
|
||||
return
|
||||
}
|
||||
|
||||
if errFmt != "" {
|
||||
err = fmt.Errorf(errFmt, err)
|
||||
}
|
||||
|
||||
const (
|
||||
_ = iota
|
||||
internal
|
||||
aclDenied
|
||||
)
|
||||
cmd.PrintErrln(err)
|
||||
if cmd.PersistentPostRun != nil {
|
||||
cmd.PersistentPostRun(cmd, nil)
|
||||
}
|
||||
os.Exit(internal)
|
||||
}
|
||||
|
||||
func main() {
|
||||
initUtilLocodeGenerateCmd()
|
||||
initUtilLocodeInfoCmd()
|
||||
rootCmd.AddCommand(locodeGenerateCmd, locodeInfoCmd)
|
||||
err := rootCmd.Execute()
|
||||
if err != nil {
|
||||
ExitOnErr(rootCmd, "", err)
|
||||
}
|
||||
}
|
||||
193
pkg/locode/column/coordinates.go
Normal file
193
pkg/locode/column/coordinates.go
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
package locodecolumn
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
)
|
||||
|
||||
const (
|
||||
minutesDigits = 2
|
||||
hemisphereSymbols = 1
|
||||
)
|
||||
|
||||
const (
|
||||
latDegDigits = 2
|
||||
lngDegDigits = 3
|
||||
)
|
||||
|
||||
type coordinateCode struct {
|
||||
degDigits int
|
||||
value []uint8
|
||||
}
|
||||
|
||||
// LongitudeCode represents the value of the longitude
|
||||
// of the location conforming to UN/LOCODE specification.
|
||||
type LongitudeCode coordinateCode
|
||||
|
||||
// LongitudeHemisphere represents the hemisphere of the earth
|
||||
// // along the Greenwich meridian.
|
||||
type LongitudeHemisphere [hemisphereSymbols]uint8
|
||||
|
||||
// LatitudeCode represents the value of the latitude
|
||||
// of the location conforming to UN/LOCODE specification.
|
||||
type LatitudeCode coordinateCode
|
||||
|
||||
// LatitudeHemisphere represents the hemisphere of the earth
|
||||
// along the equator.
|
||||
type LatitudeHemisphere [hemisphereSymbols]uint8
|
||||
|
||||
func coordinateFromString(s string, degDigits int, hemisphereAlphabet []uint8) (*coordinateCode, error) {
|
||||
if len(s) != degDigits+minutesDigits+hemisphereSymbols {
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
|
||||
for i := range s[:degDigits+minutesDigits] {
|
||||
if !isDigit(s[i]) {
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
}
|
||||
|
||||
loop:
|
||||
for _, sym := range s[degDigits+minutesDigits:] {
|
||||
for j := range hemisphereAlphabet {
|
||||
if hemisphereAlphabet[j] == uint8(sym) {
|
||||
continue loop
|
||||
}
|
||||
}
|
||||
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
|
||||
return &coordinateCode{
|
||||
degDigits: degDigits,
|
||||
value: []uint8(s),
|
||||
}, nil
|
||||
}
|
||||
|
||||
// LongitudeFromString parses a string and returns the location's longitude.
|
||||
func LongitudeFromString(s string) (*LongitudeCode, error) {
|
||||
cc, err := coordinateFromString(s, lngDegDigits, []uint8{'W', 'E'})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return (*LongitudeCode)(cc), nil
|
||||
}
|
||||
|
||||
// LatitudeFromString parses a string and returns the location's latitude.
|
||||
func LatitudeFromString(s string) (*LatitudeCode, error) {
|
||||
cc, err := coordinateFromString(s, latDegDigits, []uint8{'N', 'S'})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return (*LatitudeCode)(cc), nil
|
||||
}
|
||||
|
||||
func (cc *coordinateCode) degrees() []uint8 {
|
||||
return cc.value[:cc.degDigits]
|
||||
}
|
||||
|
||||
// Degrees returns the longitude's degrees.
|
||||
func (lc *LongitudeCode) Degrees() (l [lngDegDigits]uint8) {
|
||||
copy(l[:], (*coordinateCode)(lc).degrees())
|
||||
return
|
||||
}
|
||||
|
||||
// Degrees returns the latitude's degrees.
|
||||
func (lc *LatitudeCode) Degrees() (l [latDegDigits]uint8) {
|
||||
copy(l[:], (*coordinateCode)(lc).degrees())
|
||||
return
|
||||
}
|
||||
|
||||
func (cc *coordinateCode) minutes() (mnt [minutesDigits]uint8) {
|
||||
for i := 0; i < minutesDigits; i++ {
|
||||
mnt[i] = cc.value[cc.degDigits+i]
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Minutes returns the longitude's minutes.
|
||||
func (lc *LongitudeCode) Minutes() [minutesDigits]uint8 {
|
||||
return (*coordinateCode)(lc).minutes()
|
||||
}
|
||||
|
||||
// Minutes returns the latitude's minutes.
|
||||
func (lc *LatitudeCode) Minutes() [minutesDigits]uint8 {
|
||||
return (*coordinateCode)(lc).minutes()
|
||||
}
|
||||
|
||||
// Hemisphere returns the longitude's hemisphere code.
|
||||
func (lc *LongitudeCode) Hemisphere() LongitudeHemisphere {
|
||||
return (*coordinateCode)(lc).hemisphere()
|
||||
}
|
||||
|
||||
// Hemisphere returns the latitude's hemisphere code.
|
||||
func (lc *LatitudeCode) Hemisphere() LatitudeHemisphere {
|
||||
return (*coordinateCode)(lc).hemisphere()
|
||||
}
|
||||
|
||||
func (cc *coordinateCode) hemisphere() (h [hemisphereSymbols]uint8) {
|
||||
for i := 0; i < hemisphereSymbols; i++ {
|
||||
h[i] = cc.value[cc.degDigits+minutesDigits+i]
|
||||
}
|
||||
|
||||
return h
|
||||
}
|
||||
|
||||
// North returns true for the northern hemisphere.
|
||||
func (h LatitudeHemisphere) North() bool {
|
||||
return h[0] == 'N'
|
||||
}
|
||||
|
||||
// East returns true for the eastern hemisphere.
|
||||
func (h LongitudeHemisphere) East() bool {
|
||||
return h[0] == 'E'
|
||||
}
|
||||
|
||||
// Coordinates represents the coordinates of the location from UN/LOCODE table.
|
||||
type Coordinates struct {
|
||||
lat *LatitudeCode
|
||||
|
||||
lng *LongitudeCode
|
||||
}
|
||||
|
||||
// Latitude returns the location's latitude.
|
||||
func (c *Coordinates) Latitude() *LatitudeCode {
|
||||
return c.lat
|
||||
}
|
||||
|
||||
// Longitude returns the location's longitude.
|
||||
func (c *Coordinates) Longitude() *LongitudeCode {
|
||||
return c.lng
|
||||
}
|
||||
|
||||
// CoordinatesFromString parses a string and returns the location's coordinates.
|
||||
func CoordinatesFromString(s string) (*Coordinates, error) {
|
||||
if len(s) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
strs := strings.Split(s, " ")
|
||||
if len(strs) != 2 {
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
|
||||
lat, err := LatitudeFromString(strs[0])
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse latitude: %w", err)
|
||||
}
|
||||
|
||||
lng, err := LongitudeFromString(strs[1])
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse longitude: %w", err)
|
||||
}
|
||||
|
||||
return &Coordinates{
|
||||
lat: lat,
|
||||
lng: lng,
|
||||
}, nil
|
||||
}
|
||||
38
pkg/locode/column/country.go
Normal file
38
pkg/locode/column/country.go
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
package locodecolumn
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
)
|
||||
|
||||
const countryCodeLen = 2
|
||||
|
||||
// CountryCode represents ISO 3166 alpha-2 Country Code.
|
||||
type CountryCode [countryCodeLen]uint8
|
||||
|
||||
// Symbols returns digits of the country code.
|
||||
func (cc *CountryCode) Symbols() [countryCodeLen]uint8 {
|
||||
return *cc
|
||||
}
|
||||
|
||||
// CountryCodeFromString parses a string and returns the country code.
|
||||
func CountryCodeFromString(s string) (*CountryCode, error) {
|
||||
if l := len(s); l != countryCodeLen {
|
||||
return nil, fmt.Errorf("incorrect country code length: expect: %d, got: %d",
|
||||
countryCodeLen,
|
||||
l,
|
||||
)
|
||||
}
|
||||
|
||||
for i := range s {
|
||||
if !isUpperAlpha(s[i]) {
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
}
|
||||
|
||||
cc := CountryCode{}
|
||||
copy(cc[:], s)
|
||||
|
||||
return &cc, nil
|
||||
}
|
||||
38
pkg/locode/column/location.go
Normal file
38
pkg/locode/column/location.go
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
package locodecolumn
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
)
|
||||
|
||||
const locationCodeLen = 3
|
||||
|
||||
// LocationCode represents 3-character code for the location.
|
||||
type LocationCode [locationCodeLen]uint8
|
||||
|
||||
// Symbols returns characters of the location code.
|
||||
func (lc *LocationCode) Symbols() [locationCodeLen]uint8 {
|
||||
return *lc
|
||||
}
|
||||
|
||||
// LocationCodeFromString parses a string and returns the location code.
|
||||
func LocationCodeFromString(s string) (*LocationCode, error) {
|
||||
if l := len(s); l != locationCodeLen {
|
||||
return nil, fmt.Errorf("incorrect location code length: expect: %d, got: %d",
|
||||
locationCodeLen,
|
||||
l,
|
||||
)
|
||||
}
|
||||
|
||||
for i := range s {
|
||||
if !isUpperAlpha(s[i]) && !isDigit(s[i]) {
|
||||
return nil, locode.ErrInvalidString
|
||||
}
|
||||
}
|
||||
|
||||
lc := LocationCode{}
|
||||
copy(lc[:], s)
|
||||
|
||||
return &lc, nil
|
||||
}
|
||||
9
pkg/locode/column/util.go
Normal file
9
pkg/locode/column/util.go
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
package locodecolumn
|
||||
|
||||
func isDigit(sym uint8) bool {
|
||||
return sym >= '0' && sym <= '9'
|
||||
}
|
||||
|
||||
func isUpperAlpha(sym uint8) bool {
|
||||
return sym >= 'A' && sym <= 'Z'
|
||||
}
|
||||
194
pkg/locode/db/airports/calls.go
Normal file
194
pkg/locode/db/airports/calls.go
Normal file
|
|
@ -0,0 +1,194 @@
|
|||
package airportsdb
|
||||
|
||||
import (
|
||||
"encoding/csv"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"strconv"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
)
|
||||
|
||||
const (
|
||||
_ = iota - 1
|
||||
|
||||
_ // Airport ID
|
||||
_ // Name
|
||||
airportCity
|
||||
airportCountry
|
||||
airportIATA
|
||||
_ // ICAO
|
||||
airportLatitude
|
||||
airportLongitude
|
||||
_ // Altitude
|
||||
_ // Timezone
|
||||
_ // DST
|
||||
_ // Tz database time zone
|
||||
_ // Type
|
||||
_ // Source
|
||||
|
||||
airportFldNum
|
||||
)
|
||||
|
||||
type record struct {
|
||||
city,
|
||||
country,
|
||||
iata,
|
||||
lat,
|
||||
lng string
|
||||
}
|
||||
|
||||
// Get scans the records of the OpenFlights Airport to an in-memory table (once),
|
||||
// and returns an entry that matches the passed UN/LOCODE record.
|
||||
//
|
||||
// Records are matched if they have the same country code and either
|
||||
// same IATA code or same city name (location name in UN/LOCODE).
|
||||
//
|
||||
// Returns locodedb.ErrAirportNotFound if no entry matches.
|
||||
func (db *DB) Get(locodeRecord locode.Record) (*locodedb.AirportRecord, error) {
|
||||
if err := db.initAirports(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
records := db.mAirports[locodeRecord.LOCODE.CountryCode()]
|
||||
|
||||
for i := range records {
|
||||
if locodeRecord.LOCODE.LocationCode() != records[i].iata &&
|
||||
locodeRecord.NameWoDiacritics != records[i].city {
|
||||
continue
|
||||
}
|
||||
|
||||
lat, err := strconv.ParseFloat(records[i].lat, 64)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
lng, err := strconv.ParseFloat(records[i].lng, 64)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &locodedb.AirportRecord{
|
||||
CountryName: records[i].country,
|
||||
Point: locodedb.NewPoint(lat, lng),
|
||||
}, nil
|
||||
}
|
||||
|
||||
return nil, locodedb.ErrAirportNotFound
|
||||
}
|
||||
|
||||
const (
|
||||
_ = iota - 1
|
||||
|
||||
countryName
|
||||
countryISOCode
|
||||
_ // dafif_code
|
||||
|
||||
countryFldNum
|
||||
)
|
||||
|
||||
// CountryName scans the records of the OpenFlights Country table to an in-memory table (once),
|
||||
// and returns the name of the country by code.
|
||||
//
|
||||
// Returns locodedb.ErrCountryNotFound if no entry matches.
|
||||
func (db *DB) CountryName(code *locodedb.CountryCode) (name string, err error) {
|
||||
if err = db.initCountries(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
argCode := code.String()
|
||||
|
||||
for cName, cCode := range db.mCountries {
|
||||
if cCode == argCode {
|
||||
name = cName
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if name == "" {
|
||||
err = locodedb.ErrCountryNotFound
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (db *DB) initAirports() (err error) {
|
||||
db.airportsOnce.Do(func() {
|
||||
db.mAirports = make(map[string][]record)
|
||||
|
||||
if err = db.initCountries(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = db.scanWords(db.airports, airportFldNum, func(words []string) error {
|
||||
countryCode := db.mCountries[words[airportCountry]]
|
||||
if countryCode != "" {
|
||||
db.mAirports[countryCode] = append(db.mAirports[countryCode], record{
|
||||
city: words[airportCity],
|
||||
country: words[airportCountry],
|
||||
iata: words[airportIATA],
|
||||
lat: words[airportLatitude],
|
||||
lng: words[airportLongitude],
|
||||
})
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
})
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (db *DB) initCountries() (err error) {
|
||||
db.countriesOnce.Do(func() {
|
||||
db.mCountries = make(map[string]string)
|
||||
|
||||
err = db.scanWords(db.countries, countryFldNum, func(words []string) error {
|
||||
db.mCountries[words[countryName]] = words[countryISOCode]
|
||||
|
||||
return nil
|
||||
})
|
||||
})
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
var errScanInt = errors.New("interrupt scan")
|
||||
|
||||
func (db *DB) scanWords(pm pathMode, num int, wordsHandler func([]string) error) error {
|
||||
tableFile, err := os.OpenFile(pm.path, os.O_RDONLY, pm.mode)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
defer tableFile.Close()
|
||||
|
||||
r := csv.NewReader(tableFile)
|
||||
r.ReuseRecord = true
|
||||
|
||||
for {
|
||||
words, err := r.Read()
|
||||
if err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
break
|
||||
}
|
||||
|
||||
return err
|
||||
} else if ln := len(words); ln != num {
|
||||
return fmt.Errorf("unexpected number of words %d", ln)
|
||||
}
|
||||
|
||||
if err := wordsHandler(words); err != nil {
|
||||
if errors.Is(err, errScanInt) {
|
||||
break
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
83
pkg/locode/db/airports/db.go
Normal file
83
pkg/locode/db/airports/db.go
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
package airportsdb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Prm groups the required parameters of the DB's constructor.
|
||||
//
|
||||
// All values must comply with the requirements imposed on them.
|
||||
// Passing incorrect parameter values will result in constructor
|
||||
// failure (error or panic depending on the implementation).
|
||||
type Prm struct {
|
||||
// Path to OpenFlights Airport csv table.
|
||||
//
|
||||
// Must not be empty.
|
||||
AirportsPath string
|
||||
|
||||
// Path to OpenFlights Countries csv table.
|
||||
//
|
||||
// Must not be empty.
|
||||
CountriesPath string
|
||||
}
|
||||
|
||||
// DB is a descriptor of the OpenFlights database in csv format.
|
||||
//
|
||||
// For correct operation, DB must be created
|
||||
// using the constructor (New) based on the required parameters
|
||||
// and optional components. After successful creation,
|
||||
// The DB is immediately ready to work through API.
|
||||
type DB struct {
|
||||
airports, countries pathMode
|
||||
|
||||
airportsOnce, countriesOnce sync.Once
|
||||
|
||||
mCountries map[string]string
|
||||
|
||||
mAirports map[string][]record
|
||||
}
|
||||
|
||||
type pathMode struct {
|
||||
path string
|
||||
mode fs.FileMode
|
||||
}
|
||||
|
||||
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
|
||||
|
||||
func panicOnPrmValue(n string, v any) {
|
||||
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
|
||||
}
|
||||
|
||||
// New creates a new instance of the DB.
|
||||
//
|
||||
// Panics if at least one value of the parameters is invalid.
|
||||
//
|
||||
// The created DB does not require additional
|
||||
// initialization and is completely ready for work.
|
||||
func New(prm Prm, opts ...Option) *DB {
|
||||
switch {
|
||||
case prm.AirportsPath == "":
|
||||
panicOnPrmValue("AirportsPath", prm.AirportsPath)
|
||||
case prm.CountriesPath == "":
|
||||
panicOnPrmValue("CountriesPath", prm.CountriesPath)
|
||||
}
|
||||
|
||||
o := defaultOpts()
|
||||
|
||||
for i := range opts {
|
||||
opts[i](o)
|
||||
}
|
||||
|
||||
return &DB{
|
||||
airports: pathMode{
|
||||
path: prm.AirportsPath,
|
||||
mode: o.airportMode,
|
||||
},
|
||||
countries: pathMode{
|
||||
path: prm.CountriesPath,
|
||||
mode: o.countryMode,
|
||||
},
|
||||
}
|
||||
}
|
||||
19
pkg/locode/db/airports/opts.go
Normal file
19
pkg/locode/db/airports/opts.go
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
package airportsdb
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
)
|
||||
|
||||
// Option sets an optional parameter of DB.
|
||||
type Option func(*options)
|
||||
|
||||
type options struct {
|
||||
airportMode, countryMode fs.FileMode
|
||||
}
|
||||
|
||||
func defaultOpts() *options {
|
||||
return &options{
|
||||
airportMode: fs.ModePerm, // 0777
|
||||
countryMode: fs.ModePerm, // 0777
|
||||
}
|
||||
}
|
||||
166
pkg/locode/db/boltdb/calls.go
Normal file
166
pkg/locode/db/boltdb/calls.go
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
package locodebolt
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
"go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
// Open opens an underlying BoltDB instance.
|
||||
//
|
||||
// Timeout of BoltDB opening is 3s (only for Linux or Darwin).
|
||||
//
|
||||
// Opens BoltDB in read-only mode if DB is read-only.
|
||||
func (db *DB) Open() error {
|
||||
// copy-paste from metabase:
|
||||
// consider universal Open/Close for BoltDB wrappers
|
||||
|
||||
err := os.MkdirAll(filepath.Dir(db.path), db.mode|0o110)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not create dir for BoltDB: %w", err)
|
||||
}
|
||||
|
||||
db.bolt, err = bbolt.Open(db.path, db.mode, db.boltOpts)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not open BoltDB: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Close closes an underlying BoltDB instance.
|
||||
//
|
||||
// Must not be called before successful Open call.
|
||||
func (db *DB) Close() error {
|
||||
return db.bolt.Close()
|
||||
}
|
||||
|
||||
func countryBucketKey(cc *locodedb.CountryCode) ([]byte, error) {
|
||||
return []byte(cc.String()), nil
|
||||
}
|
||||
|
||||
func locationBucketKey(lc *locodedb.LocationCode) ([]byte, error) {
|
||||
return []byte(lc.String()), nil
|
||||
}
|
||||
|
||||
type recordJSON struct {
|
||||
CountryName string
|
||||
LocationName string
|
||||
SubDivName string
|
||||
SubDivCode string
|
||||
Latitude float64
|
||||
Longitude float64
|
||||
Continent string
|
||||
}
|
||||
|
||||
func recordValue(r locodedb.Record) ([]byte, error) {
|
||||
p := r.GeoPoint()
|
||||
|
||||
rj := &recordJSON{
|
||||
CountryName: r.CountryName(),
|
||||
LocationName: r.LocationName(),
|
||||
SubDivName: r.SubDivName(),
|
||||
SubDivCode: r.SubDivCode(),
|
||||
Latitude: p.Latitude(),
|
||||
Longitude: p.Longitude(),
|
||||
Continent: r.Continent().String(),
|
||||
}
|
||||
|
||||
return json.Marshal(rj)
|
||||
}
|
||||
|
||||
func recordFromValue(data []byte) (*locodedb.Record, error) {
|
||||
rj := new(recordJSON)
|
||||
|
||||
if err := json.Unmarshal(data, rj); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
r := new(locodedb.Record)
|
||||
r.SetCountryName(rj.CountryName)
|
||||
r.SetLocationName(rj.LocationName)
|
||||
r.SetSubDivName(rj.SubDivName)
|
||||
r.SetSubDivCode(rj.SubDivCode)
|
||||
r.SetGeoPoint(locodedb.NewPoint(rj.Latitude, rj.Longitude))
|
||||
|
||||
cont := locodedb.ContinentFromString(rj.Continent)
|
||||
r.SetContinent(&cont)
|
||||
|
||||
return r, nil
|
||||
}
|
||||
|
||||
// Put saves the record by key in an underlying BoltDB instance.
|
||||
//
|
||||
// Country code from the key is used for allocating the 1st level buckets.
|
||||
// Records are stored in country buckets by the location code from the key.
|
||||
// The records are stored in internal binary JSON format.
|
||||
//
|
||||
// Must not be called before successful Open call.
|
||||
// Must not be called in read-only mode: behavior is undefined.
|
||||
func (db *DB) Put(key locodedb.Key, rec locodedb.Record) error {
|
||||
return db.bolt.Batch(func(tx *bbolt.Tx) error {
|
||||
countryKey, err := countryBucketKey(key.CountryCode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
bktCountry, err := tx.CreateBucketIfNotExists(countryKey)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not create country bucket: %w", err)
|
||||
}
|
||||
|
||||
locationKey, err := locationBucketKey(key.LocationCode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
cont, err := recordValue(rec)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return bktCountry.Put(locationKey, cont)
|
||||
})
|
||||
}
|
||||
|
||||
var errRecordNotFound = errors.New("record not found")
|
||||
|
||||
// Get reads the record by key from underlying BoltDB instance.
|
||||
//
|
||||
// Returns an error if no record is presented by key in DB.
|
||||
//
|
||||
// Must not be called before successful Open call.
|
||||
func (db *DB) Get(key locodedb.Key) (rec *locodedb.Record, err error) {
|
||||
err = db.bolt.View(func(tx *bbolt.Tx) error {
|
||||
countryKey, err := countryBucketKey(key.CountryCode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
bktCountry := tx.Bucket(countryKey)
|
||||
if bktCountry == nil {
|
||||
return errRecordNotFound
|
||||
}
|
||||
|
||||
locationKey, err := locationBucketKey(key.LocationCode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
data := bktCountry.Get(locationKey)
|
||||
if data == nil {
|
||||
return errRecordNotFound
|
||||
}
|
||||
|
||||
rec, err = recordFromValue(data)
|
||||
|
||||
return err
|
||||
})
|
||||
|
||||
return
|
||||
}
|
||||
73
pkg/locode/db/boltdb/db.go
Normal file
73
pkg/locode/db/boltdb/db.go
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
package locodebolt
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/fs"
|
||||
|
||||
"go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
// Prm groups the required parameters of the DB's constructor.
|
||||
//
|
||||
// All values must comply with the requirements imposed on them.
|
||||
// Passing incorrect parameter values will result in constructor
|
||||
// failure (error or panic depending on the implementation).
|
||||
type Prm struct {
|
||||
// Path to BoltDB file with FrostFS location database.
|
||||
//
|
||||
// Must not be empty.
|
||||
Path string
|
||||
}
|
||||
|
||||
// DB is a descriptor of the FrostFS BoltDB location database.
|
||||
//
|
||||
// For correct operation, DB must be created
|
||||
// using the constructor (New) based on the required parameters
|
||||
// and optional components.
|
||||
//
|
||||
// After successful creation,
|
||||
// DB must be opened through Open call. After successful opening,
|
||||
// DB is ready to work through API (until Close call).
|
||||
//
|
||||
// Upon completion of work with the DB, it must be closed
|
||||
// by Close method.
|
||||
type DB struct {
|
||||
path string
|
||||
|
||||
mode fs.FileMode
|
||||
|
||||
boltOpts *bbolt.Options
|
||||
|
||||
bolt *bbolt.DB
|
||||
}
|
||||
|
||||
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
|
||||
|
||||
func panicOnPrmValue(n string, v any) {
|
||||
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
|
||||
}
|
||||
|
||||
// New creates a new instance of the DB.
|
||||
//
|
||||
// Panics if at least one value of the parameters is invalid.
|
||||
//
|
||||
// The created DB requires calling the Open method in order
|
||||
// to initialize required resources.
|
||||
func New(prm Prm, opts ...Option) *DB {
|
||||
switch {
|
||||
case prm.Path == "":
|
||||
panicOnPrmValue("Path", prm.Path)
|
||||
}
|
||||
|
||||
o := defaultOpts()
|
||||
|
||||
for i := range opts {
|
||||
opts[i](o)
|
||||
}
|
||||
|
||||
return &DB{
|
||||
path: prm.Path,
|
||||
mode: o.mode,
|
||||
boltOpts: o.boltOpts,
|
||||
}
|
||||
}
|
||||
37
pkg/locode/db/boltdb/opts.go
Normal file
37
pkg/locode/db/boltdb/opts.go
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
package locodebolt
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
// Option sets an optional parameter of DB.
|
||||
type Option func(*options)
|
||||
|
||||
type options struct {
|
||||
mode fs.FileMode
|
||||
|
||||
boltOpts *bbolt.Options
|
||||
}
|
||||
|
||||
func defaultOpts() *options {
|
||||
return &options{
|
||||
mode: os.ModePerm, // 0777
|
||||
boltOpts: &bbolt.Options{
|
||||
Timeout: 3 * time.Second,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// ReadOnly enables read-only mode of the DB.
|
||||
//
|
||||
// Do not call DB.Put method on instances with
|
||||
// this option: the behavior is undefined.
|
||||
func ReadOnly() Option {
|
||||
return func(o *options) {
|
||||
o.boltOpts.ReadOnly = true
|
||||
}
|
||||
}
|
||||
81
pkg/locode/db/continent.go
Normal file
81
pkg/locode/db/continent.go
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
package locodedb
|
||||
|
||||
// Continent is an enumeration of Earth's continent.
|
||||
type Continent uint8
|
||||
|
||||
const (
|
||||
// ContinentUnknown is an undefined Continent value.
|
||||
ContinentUnknown = iota
|
||||
|
||||
// ContinentEurope corresponds to Europe.
|
||||
ContinentEurope
|
||||
|
||||
// ContinentAfrica corresponds to Africa.
|
||||
ContinentAfrica
|
||||
|
||||
// ContinentNorthAmerica corresponds to North America.
|
||||
ContinentNorthAmerica
|
||||
|
||||
// ContinentSouthAmerica corresponds to South America.
|
||||
ContinentSouthAmerica
|
||||
|
||||
// ContinentAsia corresponds to Asia.
|
||||
ContinentAsia
|
||||
|
||||
// ContinentAntarctica corresponds to Antarctica.
|
||||
ContinentAntarctica
|
||||
|
||||
// ContinentOceania corresponds to Oceania.
|
||||
ContinentOceania
|
||||
)
|
||||
|
||||
// Is checks if c is the same continent as c2.
|
||||
func (c *Continent) Is(c2 Continent) bool {
|
||||
return *c == c2
|
||||
}
|
||||
|
||||
func (c Continent) String() string {
|
||||
switch c {
|
||||
case ContinentUnknown:
|
||||
fallthrough
|
||||
default:
|
||||
return "Unknown"
|
||||
case ContinentEurope:
|
||||
return "Europe"
|
||||
case ContinentAfrica:
|
||||
return "Africa"
|
||||
case ContinentNorthAmerica:
|
||||
return "North America"
|
||||
case ContinentSouthAmerica:
|
||||
return "South America"
|
||||
case ContinentAsia:
|
||||
return "Asia"
|
||||
case ContinentAntarctica:
|
||||
return "Antarctica"
|
||||
case ContinentOceania:
|
||||
return "Oceania"
|
||||
}
|
||||
}
|
||||
|
||||
// ContinentFromString returns Continent value
|
||||
// corresponding to the passed string representation.
|
||||
func ContinentFromString(str string) Continent {
|
||||
switch str {
|
||||
default:
|
||||
return ContinentUnknown
|
||||
case "Europe":
|
||||
return ContinentEurope
|
||||
case "Africa":
|
||||
return ContinentAfrica
|
||||
case "North America":
|
||||
return ContinentNorthAmerica
|
||||
case "South America":
|
||||
return ContinentSouthAmerica
|
||||
case "Asia":
|
||||
return ContinentAsia
|
||||
case "Antarctica":
|
||||
return ContinentAntarctica
|
||||
case "Oceania":
|
||||
return ContinentOceania
|
||||
}
|
||||
}
|
||||
134
pkg/locode/db/continents/geojson/calls.go
Normal file
134
pkg/locode/db/continents/geojson/calls.go
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
package continentsdb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
"github.com/paulmach/orb"
|
||||
"github.com/paulmach/orb/geojson"
|
||||
"github.com/paulmach/orb/planar"
|
||||
"github.com/paulmach/orb/quadtree"
|
||||
)
|
||||
|
||||
const continentProperty = "Continent"
|
||||
|
||||
// PointContinent goes through all polygons and returns the continent
|
||||
// in which the point is located.
|
||||
//
|
||||
// Returns locodedb.ContinentUnknown if no entry matches.
|
||||
//
|
||||
// All GeoJSON feature are parsed from file once and stored in memory.
|
||||
func (db *DB) PointContinent(point *locodedb.Point) (*locodedb.Continent, error) {
|
||||
var err error
|
||||
|
||||
db.once.Do(func() {
|
||||
err = db.init()
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
planarPoint := orb.Point{point.Longitude(), point.Latitude()}
|
||||
|
||||
var (
|
||||
continent string
|
||||
minDst float64
|
||||
)
|
||||
|
||||
pointer := db.tree.Matching(planarPoint, func(p orb.Pointer) bool {
|
||||
return planar.PolygonContains(
|
||||
p.(*geojson.Feature).Geometry.(orb.Polygon),
|
||||
planarPoint,
|
||||
)
|
||||
})
|
||||
|
||||
if pointer != nil {
|
||||
continent = pointer.(*geojson.Feature).Properties.MustString(continentProperty)
|
||||
}
|
||||
|
||||
if continent == "" {
|
||||
for _, feature := range db.features {
|
||||
distance := planar.DistanceFrom(feature.Geometry, planarPoint)
|
||||
if minDst == 0 || minDst > distance {
|
||||
minDst = distance
|
||||
continent = feature.Properties.MustString(continentProperty)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
c := continentFromString(continent)
|
||||
|
||||
return &c, nil
|
||||
}
|
||||
|
||||
func (db *DB) init() error {
|
||||
data, err := os.ReadFile(db.path)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not read data file: %w", err)
|
||||
}
|
||||
|
||||
features, err := geojson.UnmarshalFeatureCollection(data)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not unmarshal GeoJSON feature collection: %w", err)
|
||||
}
|
||||
|
||||
db.features = features.Features
|
||||
|
||||
err = db.buildQuadtree()
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not build quadtree: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (db *DB) buildQuadtree() error {
|
||||
db.tree = quadtree.New(orb.Bound{
|
||||
Min: orb.Point{-180, -180},
|
||||
Max: orb.Point{180, 180},
|
||||
})
|
||||
|
||||
for _, feature := range db.features {
|
||||
var multiPolygon orb.MultiPolygon
|
||||
|
||||
if polygon, ok := feature.Geometry.(orb.Polygon); ok {
|
||||
multiPolygon = append(multiPolygon, polygon)
|
||||
} else {
|
||||
multiPolygon = feature.Geometry.(orb.MultiPolygon)
|
||||
}
|
||||
|
||||
for _, polygon := range multiPolygon {
|
||||
newFeature := geojson.NewFeature(polygon)
|
||||
newFeature.Properties = feature.Properties.Clone()
|
||||
err := db.tree.Add(newFeature)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func continentFromString(c string) locodedb.Continent {
|
||||
switch c {
|
||||
default:
|
||||
return locodedb.ContinentUnknown
|
||||
case "Africa":
|
||||
return locodedb.ContinentAfrica
|
||||
case "Asia":
|
||||
return locodedb.ContinentAsia
|
||||
case "Europe":
|
||||
return locodedb.ContinentEurope
|
||||
case "North America":
|
||||
return locodedb.ContinentNorthAmerica
|
||||
case "South America":
|
||||
return locodedb.ContinentSouthAmerica
|
||||
case "Antarctica":
|
||||
return locodedb.ContinentAntarctica
|
||||
case "Australia", "Oceania":
|
||||
return locodedb.ContinentOceania
|
||||
}
|
||||
}
|
||||
66
pkg/locode/db/continents/geojson/db.go
Normal file
66
pkg/locode/db/continents/geojson/db.go
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
package continentsdb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sync"
|
||||
|
||||
"github.com/paulmach/orb/geojson"
|
||||
"github.com/paulmach/orb/quadtree"
|
||||
)
|
||||
|
||||
// Prm groups the required parameters of the DB's constructor.
|
||||
//
|
||||
// All values must comply with the requirements imposed on them.
|
||||
// Passing incorrect parameter values will result in constructor
|
||||
// failure (error or panic depending on the implementation).
|
||||
type Prm struct {
|
||||
// Path to polygons of Earth's continents in GeoJSON format.
|
||||
//
|
||||
// Must not be empty.
|
||||
Path string
|
||||
}
|
||||
|
||||
// DB is a descriptor of the Earth's polygons in GeoJSON format.
|
||||
//
|
||||
// For correct operation, DB must be created
|
||||
// using the constructor (New) based on the required parameters
|
||||
// and optional components. After successful creation,
|
||||
// The DB is immediately ready to work through API.
|
||||
type DB struct {
|
||||
path string
|
||||
|
||||
once sync.Once
|
||||
|
||||
features []*geojson.Feature
|
||||
|
||||
tree *quadtree.Quadtree
|
||||
}
|
||||
|
||||
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
|
||||
|
||||
func panicOnPrmValue(n string, v any) {
|
||||
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
|
||||
}
|
||||
|
||||
// New creates a new instance of the DB.
|
||||
//
|
||||
// Panics if at least one value of the parameters is invalid.
|
||||
//
|
||||
// The created DB does not require additional
|
||||
// initialization and is completely ready for work.
|
||||
func New(prm Prm, opts ...Option) *DB {
|
||||
switch {
|
||||
case prm.Path == "":
|
||||
panicOnPrmValue("Path", prm.Path)
|
||||
}
|
||||
|
||||
o := defaultOpts()
|
||||
|
||||
for i := range opts {
|
||||
opts[i](o)
|
||||
}
|
||||
|
||||
return &DB{
|
||||
path: prm.Path,
|
||||
}
|
||||
}
|
||||
10
pkg/locode/db/continents/geojson/opts.go
Normal file
10
pkg/locode/db/continents/geojson/opts.go
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
package continentsdb
|
||||
|
||||
// Option sets an optional parameter of DB.
|
||||
type Option func(*options)
|
||||
|
||||
type options struct{}
|
||||
|
||||
func defaultOpts() *options {
|
||||
return &options{}
|
||||
}
|
||||
32
pkg/locode/db/country.go
Normal file
32
pkg/locode/db/country.go
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
locodecolumn "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/column"
|
||||
)
|
||||
|
||||
// CountryCode represents a country code for
|
||||
// the storage in the FrostFS location database.
|
||||
type CountryCode locodecolumn.CountryCode
|
||||
|
||||
// CountryCodeFromString parses a string UN/LOCODE country code
|
||||
// and returns a CountryCode.
|
||||
func CountryCodeFromString(s string) (*CountryCode, error) {
|
||||
cc, err := locodecolumn.CountryCodeFromString(s)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse country code: %w", err)
|
||||
}
|
||||
|
||||
return CountryFromColumn(cc)
|
||||
}
|
||||
|
||||
// CountryFromColumn converts a UN/LOCODE country code to a CountryCode.
|
||||
func CountryFromColumn(cc *locodecolumn.CountryCode) (*CountryCode, error) {
|
||||
return (*CountryCode)(cc), nil
|
||||
}
|
||||
|
||||
func (c *CountryCode) String() string {
|
||||
syms := (*locodecolumn.CountryCode)(c).Symbols()
|
||||
return string(syms[:])
|
||||
}
|
||||
183
pkg/locode/db/db.go
Normal file
183
pkg/locode/db/db.go
Normal file
|
|
@ -0,0 +1,183 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"runtime"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
"golang.org/x/sync/errgroup"
|
||||
)
|
||||
|
||||
// SourceTable is an interface of the UN/LOCODE table.
|
||||
type SourceTable interface {
|
||||
// Must iterate over all entries of the table
|
||||
// and pass next entry to the handler.
|
||||
//
|
||||
// Must return handler's errors directly.
|
||||
IterateAll(func(locode.Record) error) error
|
||||
}
|
||||
|
||||
// DB is an interface of FrostFS location database.
|
||||
type DB interface {
|
||||
// Must save the record by key in the database.
|
||||
Put(Key, Record) error
|
||||
|
||||
// Must return the record by key from the database.
|
||||
Get(Key) (*Record, error)
|
||||
}
|
||||
|
||||
// AirportRecord represents the entry in FrostFS airport database.
|
||||
type AirportRecord struct {
|
||||
// Name of the country where airport is located.
|
||||
CountryName string
|
||||
|
||||
// Geo point where airport is located.
|
||||
Point *Point
|
||||
}
|
||||
|
||||
// ErrAirportNotFound is returned by AirportRecord readers
|
||||
// when the required airport is not found.
|
||||
var ErrAirportNotFound = errors.New("airport not found")
|
||||
|
||||
// AirportDB is an interface of FrostFS airport database.
|
||||
type AirportDB interface {
|
||||
// Must return the record by UN/LOCODE table record.
|
||||
//
|
||||
// Must return ErrAirportNotFound if there is no
|
||||
// related airport in the database.
|
||||
Get(locode.Record) (*AirportRecord, error)
|
||||
}
|
||||
|
||||
// ContinentsDB is an interface of FrostFS continent database.
|
||||
type ContinentsDB interface {
|
||||
// Must return continent of the geo point.
|
||||
PointContinent(*Point) (*Continent, error)
|
||||
}
|
||||
|
||||
var ErrSubDivNotFound = errors.New("subdivision not found")
|
||||
|
||||
var ErrCountryNotFound = errors.New("country not found")
|
||||
|
||||
// NamesDB is an interface of the FrostFS location namespace.
|
||||
type NamesDB interface {
|
||||
// Must resolve a country code to a country name.
|
||||
//
|
||||
// Must return ErrCountryNotFound if there is no
|
||||
// country with the provided code.
|
||||
CountryName(*CountryCode) (string, error)
|
||||
|
||||
// Must resolve (country code, subdivision code) to
|
||||
// a subdivision name.
|
||||
//
|
||||
// Must return ErrSubDivNotFound if either country or
|
||||
// subdivision is not presented in database.
|
||||
SubDivName(*CountryCode, string) (string, error)
|
||||
}
|
||||
|
||||
// FillDatabase generates the FrostFS location database based on the UN/LOCODE table.
|
||||
func FillDatabase(table SourceTable, airports AirportDB, continents ContinentsDB, names NamesDB, db DB) error {
|
||||
var errG errgroup.Group
|
||||
|
||||
// Pick some sane default, after this the performance stopped increasing.
|
||||
errG.SetLimit(runtime.NumCPU() * 16)
|
||||
_ = table.IterateAll(func(tableRecord locode.Record) error {
|
||||
errG.Go(func() error {
|
||||
return processTableRecord(tableRecord, airports, continents, names, db)
|
||||
})
|
||||
return nil
|
||||
})
|
||||
return errG.Wait()
|
||||
}
|
||||
|
||||
func processTableRecord(tableRecord locode.Record, airports AirportDB, continents ContinentsDB, names NamesDB, db DB) error {
|
||||
if tableRecord.LOCODE.LocationCode() == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
dbKey, err := NewKey(tableRecord.LOCODE)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
dbRecord, err := NewRecord(tableRecord)
|
||||
if err != nil {
|
||||
if errors.Is(err, errParseCoordinates) {
|
||||
return nil
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
geoPoint := dbRecord.GeoPoint()
|
||||
countryName := ""
|
||||
|
||||
if geoPoint == nil {
|
||||
airportRecord, err := airports.Get(tableRecord)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrAirportNotFound) {
|
||||
return nil
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
geoPoint = airportRecord.Point
|
||||
countryName = airportRecord.CountryName
|
||||
}
|
||||
|
||||
dbRecord.SetGeoPoint(geoPoint)
|
||||
|
||||
if countryName == "" {
|
||||
countryName, err = names.CountryName(dbKey.CountryCode())
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrCountryNotFound) {
|
||||
return nil
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
dbRecord.SetCountryName(countryName)
|
||||
|
||||
if subDivCode := dbRecord.SubDivCode(); subDivCode != "" {
|
||||
subDivName, err := names.SubDivName(dbKey.CountryCode(), subDivCode)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrSubDivNotFound) {
|
||||
return nil
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
dbRecord.SetSubDivName(subDivName)
|
||||
}
|
||||
|
||||
continent, err := continents.PointContinent(geoPoint)
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not calculate continent geo point: %w", err)
|
||||
} else if continent.Is(ContinentUnknown) {
|
||||
return nil
|
||||
}
|
||||
|
||||
dbRecord.SetContinent(continent)
|
||||
|
||||
return db.Put(*dbKey, *dbRecord)
|
||||
}
|
||||
|
||||
// LocodeRecord returns the record from the FrostFS location database
|
||||
// corresponding to the string representation of UN/LOCODE.
|
||||
func LocodeRecord(db DB, sLocode string) (*Record, error) {
|
||||
lc, err := locode.FromString(sLocode)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse locode: %w", err)
|
||||
}
|
||||
|
||||
key, err := NewKey(*lc)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return db.Get(*key)
|
||||
}
|
||||
32
pkg/locode/db/location.go
Normal file
32
pkg/locode/db/location.go
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
locodecolumn "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/column"
|
||||
)
|
||||
|
||||
// LocationCode represents a location code for
|
||||
// the storage in the FrostFS location database.
|
||||
type LocationCode locodecolumn.LocationCode
|
||||
|
||||
// LocationCodeFromString parses a string UN/LOCODE location code
|
||||
// and returns a LocationCode.
|
||||
func LocationCodeFromString(s string) (*LocationCode, error) {
|
||||
lc, err := locodecolumn.LocationCodeFromString(s)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse location code: %w", err)
|
||||
}
|
||||
|
||||
return LocationFromColumn(lc)
|
||||
}
|
||||
|
||||
// LocationFromColumn converts a UN/LOCODE country code to a LocationCode.
|
||||
func LocationFromColumn(cc *locodecolumn.LocationCode) (*LocationCode, error) {
|
||||
return (*LocationCode)(cc), nil
|
||||
}
|
||||
|
||||
func (l *LocationCode) String() string {
|
||||
syms := (*locodecolumn.LocationCode)(l).Symbols()
|
||||
return string(syms[:])
|
||||
}
|
||||
93
pkg/locode/db/point.go
Normal file
93
pkg/locode/db/point.go
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
locodecolumn "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/column"
|
||||
)
|
||||
|
||||
// Point represents a 2D geographic point.
|
||||
type Point struct {
|
||||
lat, lng float64
|
||||
}
|
||||
|
||||
// NewPoint creates, initializes and returns a new Point.
|
||||
func NewPoint(lat, lng float64) *Point {
|
||||
return &Point{
|
||||
lat: lat,
|
||||
lng: lng,
|
||||
}
|
||||
}
|
||||
|
||||
// Latitude returns the Point's latitude.
|
||||
func (p Point) Latitude() float64 {
|
||||
return p.lat
|
||||
}
|
||||
|
||||
// Longitude returns the Point's longitude.
|
||||
func (p Point) Longitude() float64 {
|
||||
return p.lng
|
||||
}
|
||||
|
||||
// PointFromCoordinates converts a UN/LOCODE coordinates to a Point.
|
||||
func PointFromCoordinates(crd *locodecolumn.Coordinates) (*Point, error) {
|
||||
if crd == nil {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
cLat := crd.Latitude()
|
||||
cLatDeg := cLat.Degrees()
|
||||
cLatMnt := cLat.Minutes()
|
||||
|
||||
lat, err := toDecimal(cLatDeg[:], cLatMnt[:])
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse latitude: %w", err)
|
||||
}
|
||||
|
||||
if !cLat.Hemisphere().North() {
|
||||
lat = -lat
|
||||
}
|
||||
|
||||
cLng := crd.Longitude()
|
||||
cLngDeg := cLng.Degrees()
|
||||
cLngMnt := cLng.Minutes()
|
||||
|
||||
lng, err := toDecimal(cLngDeg[:], cLngMnt[:])
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse longitude: %w", err)
|
||||
}
|
||||
|
||||
if !cLng.Hemisphere().East() {
|
||||
lng = -lng
|
||||
}
|
||||
|
||||
return &Point{
|
||||
lat: lat,
|
||||
lng: lng,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func toDecimal(intRaw, minutesRaw []byte) (float64, error) {
|
||||
integer, err := strconv.ParseFloat(string(intRaw), 64)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("could not parse integer part: %w", err)
|
||||
}
|
||||
|
||||
decimal, err := minutesToDegrees(minutesRaw)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("could not parse decimal part: %w", err)
|
||||
}
|
||||
|
||||
return integer + decimal, nil
|
||||
}
|
||||
|
||||
// minutesToDegrees converts minutes to decimal part of a degree.
|
||||
func minutesToDegrees(raw []byte) (float64, error) {
|
||||
minutes, err := strconv.ParseFloat(string(raw), 64)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
return minutes / 60, nil
|
||||
}
|
||||
51
pkg/locode/db/point_test.go
Normal file
51
pkg/locode/db/point_test.go
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
locodecolumn "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/column"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestPointFromCoordinates(t *testing.T) {
|
||||
testCases := []struct {
|
||||
latGot, longGot string
|
||||
latWant, longWant float64
|
||||
}{
|
||||
{
|
||||
latGot: "5915N",
|
||||
longGot: "01806E",
|
||||
latWant: 59.25,
|
||||
longWant: 18.10,
|
||||
},
|
||||
{
|
||||
latGot: "1000N",
|
||||
longGot: "02030E",
|
||||
latWant: 10.00,
|
||||
longWant: 20.50,
|
||||
},
|
||||
{
|
||||
latGot: "0145S",
|
||||
longGot: "03512W",
|
||||
latWant: -01.75,
|
||||
longWant: -35.20,
|
||||
},
|
||||
}
|
||||
|
||||
var (
|
||||
crd *locodecolumn.Coordinates
|
||||
point *Point
|
||||
err error
|
||||
)
|
||||
|
||||
for _, test := range testCases {
|
||||
crd, err = locodecolumn.CoordinatesFromString(test.latGot + " " + test.longGot)
|
||||
require.NoError(t, err)
|
||||
|
||||
point, err = PointFromCoordinates(crd)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Equal(t, test.latWant, point.Latitude())
|
||||
require.Equal(t, test.longWant, point.Longitude())
|
||||
}
|
||||
}
|
||||
140
pkg/locode/db/record.go
Normal file
140
pkg/locode/db/record.go
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
package locodedb
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
locodecolumn "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/column"
|
||||
)
|
||||
|
||||
// Key represents the key in FrostFS location database.
|
||||
type Key struct {
|
||||
cc *CountryCode
|
||||
|
||||
lc *LocationCode
|
||||
}
|
||||
|
||||
// NewKey calculates Key from LOCODE.
|
||||
func NewKey(lc locode.LOCODE) (*Key, error) {
|
||||
country, err := CountryCodeFromString(lc.CountryCode())
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse country: %w", err)
|
||||
}
|
||||
|
||||
location, err := LocationCodeFromString(lc.LocationCode())
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse location: %w", err)
|
||||
}
|
||||
|
||||
return &Key{
|
||||
cc: country,
|
||||
lc: location,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// CountryCode returns the location's country code.
|
||||
func (k *Key) CountryCode() *CountryCode {
|
||||
return k.cc
|
||||
}
|
||||
|
||||
// LocationCode returns the location code.
|
||||
func (k *Key) LocationCode() *LocationCode {
|
||||
return k.lc
|
||||
}
|
||||
|
||||
// Record represents the entry in FrostFS location database.
|
||||
type Record struct {
|
||||
countryName string
|
||||
|
||||
locationName string
|
||||
|
||||
subDivName string
|
||||
|
||||
subDivCode string
|
||||
|
||||
p *Point
|
||||
|
||||
cont *Continent
|
||||
}
|
||||
|
||||
var errParseCoordinates = errors.New("invalid coordinates")
|
||||
|
||||
// NewRecord calculates the Record from the UN/LOCODE table record.
|
||||
func NewRecord(r locode.Record) (*Record, error) {
|
||||
crd, err := locodecolumn.CoordinatesFromString(r.Coordinates)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%w: %v", errParseCoordinates, err)
|
||||
}
|
||||
|
||||
point, err := PointFromCoordinates(crd)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not parse geo point: %w", err)
|
||||
}
|
||||
|
||||
return &Record{
|
||||
locationName: r.NameWoDiacritics,
|
||||
subDivCode: r.SubDiv,
|
||||
p: point,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// CountryName returns the country name.
|
||||
func (r *Record) CountryName() string {
|
||||
return r.countryName
|
||||
}
|
||||
|
||||
// SetCountryName sets the country name.
|
||||
func (r *Record) SetCountryName(name string) {
|
||||
r.countryName = name
|
||||
}
|
||||
|
||||
// LocationName returns the location name.
|
||||
func (r *Record) LocationName() string {
|
||||
return r.locationName
|
||||
}
|
||||
|
||||
// SetLocationName sets the location name.
|
||||
func (r *Record) SetLocationName(name string) {
|
||||
r.locationName = name
|
||||
}
|
||||
|
||||
// SubDivCode returns the subdivision code.
|
||||
func (r *Record) SubDivCode() string {
|
||||
return r.subDivCode
|
||||
}
|
||||
|
||||
// SetSubDivCode sets the subdivision code.
|
||||
func (r *Record) SetSubDivCode(name string) {
|
||||
r.subDivCode = name
|
||||
}
|
||||
|
||||
// SubDivName returns the subdivision name.
|
||||
func (r *Record) SubDivName() string {
|
||||
return r.subDivName
|
||||
}
|
||||
|
||||
// SetSubDivName sets the subdivision name.
|
||||
func (r *Record) SetSubDivName(name string) {
|
||||
r.subDivName = name
|
||||
}
|
||||
|
||||
// GeoPoint returns geo point of the location.
|
||||
func (r *Record) GeoPoint() *Point {
|
||||
return r.p
|
||||
}
|
||||
|
||||
// SetGeoPoint sets geo point of the location.
|
||||
func (r *Record) SetGeoPoint(p *Point) {
|
||||
r.p = p
|
||||
}
|
||||
|
||||
// Continent returns the location continent.
|
||||
func (r *Record) Continent() *Continent {
|
||||
return r.cont
|
||||
}
|
||||
|
||||
// SetContinent sets the location continent.
|
||||
func (r *Record) SetContinent(c *Continent) {
|
||||
r.cont = c
|
||||
}
|
||||
83
pkg/locode/record.go
Normal file
83
pkg/locode/record.go
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
package locode
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// LOCODE represents code from UN/LOCODE coding scheme.
|
||||
type LOCODE [2]string
|
||||
|
||||
// Record represents a single record of the UN/LOCODE table.
|
||||
type Record struct {
|
||||
// Change Indicator.
|
||||
Ch string
|
||||
|
||||
// Combination of a 2-character country code and a 3-character location code.
|
||||
LOCODE LOCODE
|
||||
|
||||
// Name of the locations which has been allocated a UN/LOCODE.
|
||||
Name string
|
||||
|
||||
// Names of the locations which have been allocated a UN/LOCODE without diacritic signs.
|
||||
NameWoDiacritics string
|
||||
|
||||
// ISO 1-3 character alphabetic and/or numeric code for the administrative division of the country concerned.
|
||||
SubDiv string
|
||||
|
||||
// 8-digit function classifier code for the location.
|
||||
Function string
|
||||
|
||||
// Status of the entry by a 2-character code.
|
||||
Status string
|
||||
|
||||
// Last date when the location was updated/entered.
|
||||
Date string
|
||||
|
||||
// The IATA code for the location if different from location code in column LOCODE.
|
||||
IATA string
|
||||
|
||||
// Geographical coordinates (latitude/longitude) of the location, if there is any.
|
||||
Coordinates string
|
||||
|
||||
// Some general remarks regarding the UN/LOCODE in question.
|
||||
Remarks string
|
||||
}
|
||||
|
||||
// ErrInvalidString is the error of incorrect string format of the LOCODE.
|
||||
var ErrInvalidString = errors.New("invalid string format in UN/Locode")
|
||||
|
||||
// FromString parses string and returns LOCODE.
|
||||
//
|
||||
// If string has incorrect format, ErrInvalidString returns.
|
||||
func FromString(s string) (*LOCODE, error) {
|
||||
const (
|
||||
locationSeparator = " "
|
||||
locodePartsNumber = 2
|
||||
)
|
||||
|
||||
words := strings.Split(s, locationSeparator)
|
||||
if ln := len(words); ln != locodePartsNumber {
|
||||
return nil, fmt.Errorf(
|
||||
"incorrect locode: it must consist of %d codes separated with a witespase, got: %d",
|
||||
locodePartsNumber,
|
||||
ln,
|
||||
)
|
||||
}
|
||||
|
||||
l := new(LOCODE)
|
||||
copy(l[:], words)
|
||||
|
||||
return l, nil
|
||||
}
|
||||
|
||||
// CountryCode returns a string representation of country code.
|
||||
func (l *LOCODE) CountryCode() string {
|
||||
return l[0]
|
||||
}
|
||||
|
||||
// LocationCode returns a string representation of location code.
|
||||
func (l *LOCODE) LocationCode() string {
|
||||
return l[1]
|
||||
}
|
||||
156
pkg/locode/table/csv/calls.go
Normal file
156
pkg/locode/table/csv/calls.go
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
package csvlocode
|
||||
|
||||
import (
|
||||
"encoding/csv"
|
||||
"errors"
|
||||
"io"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode"
|
||||
locodedb "git.frostfs.info/TrueCloudLab/frostfs-locode-db/pkg/locode/db"
|
||||
)
|
||||
|
||||
var errInvalidRecord = errors.New("invalid table record")
|
||||
|
||||
// IterateAll scans a table record one-by-one, parses a UN/LOCODE record
|
||||
// from it and passes it to f.
|
||||
//
|
||||
// Returns f's errors directly.
|
||||
func (t *Table) IterateAll(f func(locode.Record) error) error {
|
||||
const wordsPerRecord = 12
|
||||
|
||||
return t.scanWords(t.paths, wordsPerRecord, func(words []string) error {
|
||||
lc, err := locode.FromString(strings.Join(words[1:3], " "))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
record := locode.Record{
|
||||
Ch: words[0],
|
||||
LOCODE: *lc,
|
||||
Name: words[3],
|
||||
NameWoDiacritics: words[4],
|
||||
SubDiv: words[5],
|
||||
Function: words[6],
|
||||
Status: words[7],
|
||||
Date: words[8],
|
||||
IATA: words[9],
|
||||
Coordinates: words[10],
|
||||
Remarks: words[11],
|
||||
}
|
||||
|
||||
return f(record)
|
||||
})
|
||||
}
|
||||
|
||||
const (
|
||||
_ = iota - 1
|
||||
|
||||
subDivCountry
|
||||
subDivSubdivision
|
||||
subDivName
|
||||
_ // subDivLevel
|
||||
|
||||
subDivFldNum
|
||||
)
|
||||
|
||||
type subDivKey struct {
|
||||
countryCode,
|
||||
subDivCode string
|
||||
}
|
||||
|
||||
type subDivRecord struct {
|
||||
name string
|
||||
}
|
||||
|
||||
// SubDivName scans a table record to an in-memory table (once),
|
||||
// and returns the subdivision name of the country and the subdivision codes match.
|
||||
//
|
||||
// Returns locodedb.ErrSubDivNotFound if no entry matches.
|
||||
func (t *Table) SubDivName(countryCode *locodedb.CountryCode, code string) (string, error) {
|
||||
if err := t.initSubDiv(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
rec, ok := t.mSubDiv[subDivKey{
|
||||
countryCode: countryCode.String(),
|
||||
subDivCode: code,
|
||||
}]
|
||||
if !ok {
|
||||
return "", locodedb.ErrSubDivNotFound
|
||||
}
|
||||
|
||||
return rec.name, nil
|
||||
}
|
||||
|
||||
func (t *Table) initSubDiv() (err error) {
|
||||
t.subDivOnce.Do(func() {
|
||||
t.mSubDiv = make(map[subDivKey]subDivRecord)
|
||||
|
||||
err = t.scanWords([]string{t.subDivPath}, subDivFldNum, func(words []string) error {
|
||||
t.mSubDiv[subDivKey{
|
||||
countryCode: words[subDivCountry],
|
||||
subDivCode: words[subDivSubdivision],
|
||||
}] = subDivRecord{
|
||||
name: words[subDivName],
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
})
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
var errScanInt = errors.New("interrupt scan")
|
||||
|
||||
func (t *Table) scanWords(paths []string, fpr int, wordsHandler func([]string) error) error {
|
||||
var (
|
||||
rdrs = make([]io.Reader, 0, len(t.paths))
|
||||
closers = make([]io.Closer, 0, len(t.paths))
|
||||
)
|
||||
|
||||
for i := range paths {
|
||||
file, err := os.OpenFile(paths[i], os.O_RDONLY, t.mode)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
rdrs = append(rdrs, file)
|
||||
closers = append(closers, file)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
for i := range closers {
|
||||
_ = closers[i].Close()
|
||||
}
|
||||
}()
|
||||
|
||||
r := csv.NewReader(io.MultiReader(rdrs...))
|
||||
r.ReuseRecord = true
|
||||
r.FieldsPerRecord = fpr
|
||||
|
||||
for {
|
||||
words, err := r.Read()
|
||||
if err != nil {
|
||||
if errors.Is(err, io.EOF) {
|
||||
break
|
||||
}
|
||||
|
||||
return err
|
||||
} else if len(words) != fpr {
|
||||
return errInvalidRecord
|
||||
}
|
||||
|
||||
if err := wordsHandler(words); err != nil {
|
||||
if errors.Is(err, errScanInt) {
|
||||
break
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
28
pkg/locode/table/csv/opts.go
Normal file
28
pkg/locode/table/csv/opts.go
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
package csvlocode
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
)
|
||||
|
||||
// Option sets an optional parameter of Table.
|
||||
type Option func(*options)
|
||||
|
||||
type options struct {
|
||||
mode fs.FileMode
|
||||
|
||||
extraPaths []string
|
||||
}
|
||||
|
||||
func defaultOpts() *options {
|
||||
return &options{
|
||||
mode: 0o700,
|
||||
}
|
||||
}
|
||||
|
||||
// WithExtraPaths returns an option to add extra paths
|
||||
// to UN/LOCODE tables in csv format.
|
||||
func WithExtraPaths(ps ...string) Option {
|
||||
return func(o *options) {
|
||||
o.extraPaths = append(o.extraPaths, ps...)
|
||||
}
|
||||
}
|
||||
75
pkg/locode/table/csv/table.go
Normal file
75
pkg/locode/table/csv/table.go
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
package csvlocode
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Prm groups the required parameters of the Table's constructor.
|
||||
//
|
||||
// All values must comply with the requirements imposed on them.
|
||||
// Passing incorrect parameter values will result in constructor
|
||||
// failure (error or panic depending on the implementation).
|
||||
type Prm struct {
|
||||
// Path to UN/LOCODE csv table.
|
||||
//
|
||||
// Must not be empty.
|
||||
Path string
|
||||
|
||||
// Path to csv table of UN/LOCODE Subdivisions.
|
||||
//
|
||||
// Must not be empty.
|
||||
SubDivPath string
|
||||
}
|
||||
|
||||
// Table is a descriptor of the UN/LOCODE table in csv format.
|
||||
//
|
||||
// For correct operation, Table must be created
|
||||
// using the constructor (New) based on the required parameters
|
||||
// and optional components. After successful creation,
|
||||
// The Table is immediately ready to work through API.
|
||||
type Table struct {
|
||||
paths []string
|
||||
|
||||
mode fs.FileMode
|
||||
|
||||
subDivPath string
|
||||
|
||||
subDivOnce sync.Once
|
||||
|
||||
mSubDiv map[subDivKey]subDivRecord
|
||||
}
|
||||
|
||||
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
|
||||
|
||||
func panicOnPrmValue(n string, v any) {
|
||||
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
|
||||
}
|
||||
|
||||
// New creates a new instance of the Table.
|
||||
//
|
||||
// Panics if at least one value of the parameters is invalid.
|
||||
//
|
||||
// The created Table does not require additional
|
||||
// initialization and is completely ready for work.
|
||||
func New(prm Prm, opts ...Option) *Table {
|
||||
switch {
|
||||
case prm.Path == "":
|
||||
panicOnPrmValue("Path", prm.Path)
|
||||
case prm.SubDivPath == "":
|
||||
panicOnPrmValue("SubDivPath", prm.SubDivPath)
|
||||
}
|
||||
|
||||
o := defaultOpts()
|
||||
|
||||
for i := range opts {
|
||||
opts[i](o)
|
||||
}
|
||||
|
||||
return &Table{
|
||||
paths: append(o.extraPaths, prm.Path),
|
||||
mode: o.mode,
|
||||
subDivPath: prm.SubDivPath,
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue