├── frontend ├── .nvmrc ├── .gitattributes ├── .env ├── env.d.ts ├── .env.development ├── src │ ├── assets │ │ └── main.css │ ├── interfaces │ │ ├── Coordinates.ts │ │ └── Settings.ts │ ├── components │ │ ├── AwesomeIcon.vue │ │ ├── HelpModal.vue │ │ ├── MapView.vue │ │ ├── DownloadModal.vue │ │ ├── ModalWrap.vue │ │ ├── SearchBar.vue │ │ └── SettingsModal.vue │ ├── main.ts │ ├── composables │ │ ├── useGeocoding.ts │ │ ├── useSettings.ts │ │ └── useDownload.ts │ ├── App.vue │ └── locales │ │ ├── en.json │ │ └── de.json ├── public │ ├── favicon.ico │ ├── geocaching.png │ ├── favicon-16x16.png │ ├── favicon-32x32.png │ ├── apple-touch-icon.png │ ├── android-chrome-192x192.png │ ├── android-chrome-512x512.png │ └── site.webmanifest ├── .prettierrc.json ├── tsconfig.json ├── .editorconfig ├── tsconfig.app.json ├── README.md ├── .gitignore ├── tsconfig.node.json ├── vite.config.ts ├── eslint.config.ts ├── index.html └── package.json ├── .gitignore ├── api ├── templates_custom │ └── .gitkeep ├── src │ ├── request │ │ ├── lab2gpx-by-code.http │ │ ├── lab2gpx-by-uuid.http │ │ ├── download-form-urlencoded.http │ │ ├── get-adventure-id-by-smart-link.http │ │ ├── get-adventure.http │ │ ├── download.http │ │ └── download-by-uuid.http │ ├── Model │ │ ├── Dto │ │ │ ├── Locale.php │ │ │ ├── Coordinates.php │ │ │ ├── CacheType.php │ │ │ ├── Linear.php │ │ │ ├── OutputFormat.php │ │ │ └── Settings.php │ │ ├── Exception │ │ │ └── BadGatewayHttpException.php │ │ ├── Util │ │ │ └── Base31Util.php │ │ ├── Twig │ │ │ ├── XmlEscaper.php │ │ │ ├── CsvEscaper.php │ │ │ └── GpxExportTwigExtension.php │ │ ├── DecimalMinutes.php │ │ ├── AdventureLabApiClient.php │ │ ├── AdventureLabDatabase.php │ │ └── ExportGenerator.php │ ├── Kernel.php │ ├── EventListener │ │ ├── RequestLogger.php │ │ └── ApiExceptionListener.php │ └── Controller │ │ ├── Lab2GpxController.php │ │ ├── AdventureLabController.php │ │ └── DownloadController.php ├── config │ ├── packages │ │ ├── property_info.yaml │ │ ├── translation.yaml │ │ ├── debug.yaml │ │ ├── twig.yaml │ │ ├── web_profiler.yaml │ │ ├── routing.yaml │ │ ├── validator.yaml │ │ ├── framework.yaml │ │ ├── cache.yaml │ │ └── monolog.yaml │ ├── routes.yaml │ ├── routes │ │ ├── framework.yaml │ │ └── web_profiler.yaml │ ├── preload.php │ ├── bundles.php │ └── services.yaml ├── .env.dev ├── phpstan.dist.neon ├── .editorconfig ├── .gitignore ├── migrations │ ├── 0000000000_create.sql │ └── 2025092601.sql ├── translations │ ├── messages+intl-icu.en.php │ └── messages+intl-icu.de.php ├── bin │ └── console ├── public │ ├── .htaccess │ └── index.php ├── .env ├── Makefile ├── templates │ ├── cacheturdotno.csv.twig │ ├── partials │ │ ├── description.html.twig │ │ └── description-waypoints.html.twig │ ├── gpxwaypoints.xml.twig │ └── gpx.xml.twig ├── phpcs.xml.dist ├── composer.json └── symfony.lock ├── data └── .htaccess ├── README.md └── LICENSE.txt /frontend/.nvmrc: -------------------------------------------------------------------------------- 1 | v22.19.0 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | data 3 | -------------------------------------------------------------------------------- /api/templates_custom/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /data/.htaccess: -------------------------------------------------------------------------------- 1 | Order allow,deny 2 | Deny from all -------------------------------------------------------------------------------- /frontend/.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /frontend/.env: -------------------------------------------------------------------------------- 1 | VITE_API_URL=https://api.lab2gpx.gcutils.de -------------------------------------------------------------------------------- /frontend/env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /frontend/.env.development: -------------------------------------------------------------------------------- 1 | VITE_API_URL=http://localhost:8080 2 | -------------------------------------------------------------------------------- /frontend/src/assets/main.css: -------------------------------------------------------------------------------- 1 | html, body, #app { 2 | height: 100%; 3 | margin: 0; 4 | } 5 | -------------------------------------------------------------------------------- /frontend/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/favicon.ico -------------------------------------------------------------------------------- /frontend/public/geocaching.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/geocaching.png -------------------------------------------------------------------------------- /api/src/request/lab2gpx-by-code.http: -------------------------------------------------------------------------------- 1 | @code = 118Q 2 | 3 | GET http://localhost:8080/lab2gpx-data/by-code/{{code}} 4 | -------------------------------------------------------------------------------- /frontend/public/favicon-16x16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/favicon-16x16.png -------------------------------------------------------------------------------- /frontend/public/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/favicon-32x32.png -------------------------------------------------------------------------------- /api/config/packages/property_info.yaml: -------------------------------------------------------------------------------- 1 | framework: 2 | property_info: 3 | with_constructor_extractor: true 4 | -------------------------------------------------------------------------------- /frontend/public/apple-touch-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/apple-touch-icon.png -------------------------------------------------------------------------------- /frontend/src/interfaces/Coordinates.ts: -------------------------------------------------------------------------------- 1 | export interface Coordinates { 2 | lat: number 3 | lon: number 4 | } 5 | -------------------------------------------------------------------------------- /api/.env.dev: -------------------------------------------------------------------------------- 1 | 2 | ###> symfony/framework-bundle ### 3 | APP_SECRET=just_a_random_key 4 | ###< symfony/framework-bundle ### 5 | -------------------------------------------------------------------------------- /frontend/public/android-chrome-192x192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/android-chrome-192x192.png -------------------------------------------------------------------------------- /frontend/public/android-chrome-512x512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mirsch/lab2gpx/HEAD/frontend/public/android-chrome-512x512.png -------------------------------------------------------------------------------- /api/src/request/lab2gpx-by-uuid.http: -------------------------------------------------------------------------------- 1 | @uuid = f59886ec-6902-40fc-a717-86933c27ac6e 2 | 3 | GET http://localhost:8080/lab2gpx-data/by-uuid/{{uuid}} 4 | -------------------------------------------------------------------------------- /api/config/routes.yaml: -------------------------------------------------------------------------------- 1 | controllers: 2 | resource: 3 | path: ../src/Controller/ 4 | namespace: App\Controller 5 | type: attribute 6 | -------------------------------------------------------------------------------- /api/config/routes/framework.yaml: -------------------------------------------------------------------------------- 1 | when@dev: 2 | _errors: 3 | resource: '@FrameworkBundle/Resources/config/routing/errors.php' 4 | prefix: /_error 5 | -------------------------------------------------------------------------------- /api/config/packages/translation.yaml: -------------------------------------------------------------------------------- 1 | framework: 2 | default_locale: en 3 | translator: 4 | default_path: '%kernel.project_dir%/translations' 5 | providers: 6 | -------------------------------------------------------------------------------- /frontend/.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/prettierrc", 3 | "semi": true, 4 | "singleQuote": true, 5 | "printWidth": 100, 6 | "tabWidth": 4 7 | } 8 | -------------------------------------------------------------------------------- /api/src/Model/Dto/Locale.php: -------------------------------------------------------------------------------- 1 | symfony/framework-bundle ### 3 | /.env.local 4 | /.env.local.php 5 | /.env.*.local 6 | /config/secrets/prod/prod.decrypt.private.php 7 | /public/bundles/ 8 | /var/ 9 | /vendor/ 10 | ###< symfony/framework-bundle ### 11 | 12 | ###> squizlabs/php_codesniffer ### 13 | /.phpcs-cache 14 | /phpcs.xml 15 | ###< squizlabs/php_codesniffer ### 16 | 17 | ###> phpstan/phpstan ### 18 | phpstan.neon 19 | ###< phpstan/phpstan ### 20 | 21 | templates_custom/* 22 | dist/* 23 | -------------------------------------------------------------------------------- /api/src/Model/Exception/BadGatewayHttpException.php: -------------------------------------------------------------------------------- 1 | ['all' => true], 5 | Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true], 6 | Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true], 7 | Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true], 8 | Symfony\Bundle\DebugBundle\DebugBundle::class => ['dev' => true], 9 | Twig\Extra\TwigExtraBundle\TwigExtraBundle::class => ['all' => true], 10 | ]; 11 | -------------------------------------------------------------------------------- /api/src/Model/Util/Base31Util.php: -------------------------------------------------------------------------------- 1 | 0) { 14 | $base31 = $alphabet[$id % 31] . $base31; 15 | $id = (int) ($id / 31); 16 | } 17 | 18 | return $base31; 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /frontend/vite.config.ts: -------------------------------------------------------------------------------- 1 | import { fileURLToPath, URL } from 'node:url' 2 | 3 | import { defineConfig } from 'vite' 4 | import vue from '@vitejs/plugin-vue' 5 | import vueJsx from '@vitejs/plugin-vue-jsx' 6 | import vueDevTools from 'vite-plugin-vue-devtools' 7 | 8 | // https://vite.dev/config/ 9 | export default defineConfig({ 10 | plugins: [ 11 | vue(), 12 | vueJsx(), 13 | vueDevTools(), 14 | ], 15 | resolve: { 16 | alias: { 17 | '@': fileURLToPath(new URL('./src', import.meta.url)) 18 | }, 19 | }, 20 | base: '', 21 | }) 22 | -------------------------------------------------------------------------------- /api/translations/messages+intl-icu.en.php: -------------------------------------------------------------------------------- 1 | 'linear', 5 | 'HEADER_GEOFENCING_RADIUS' => 'Radius', 6 | 'HEADER_STAGES_COUNT' => 'Stages', 7 | 'HEADER_POSSIBLY_BONUS' => 'Possibly bonus', 8 | 'HEADER_QUESTION_TYPE' => 'Kind of question', 9 | 'HEADER_QUESTION_TYPE_VALUE_SINGLE' => 'single', 10 | 'HEADER_QUESTION_TYPE_VALUE_MULTIPLE_CHOICE' => 'multiple choice', 11 | 'HEADER_QUESTION' => 'Question', 12 | 'HEADER_WAYPOINT_DESCRIPTION' => 'Waypoint Description', 13 | 'HEADER_LAB_DESCRIPTION' => 'Adventure Lab Description', 14 | ); 15 | -------------------------------------------------------------------------------- /api/translations/messages+intl-icu.de.php: -------------------------------------------------------------------------------- 1 | 'linear', 5 | 'HEADER_GEOFENCING_RADIUS' => 'Radius', 6 | 'HEADER_STAGES_COUNT' => 'Stationen', 7 | 'HEADER_POSSIBLY_BONUS' => 'Möglicher Bonus', 8 | 'HEADER_QUESTION_TYPE' => 'Art der Frage', 9 | 'HEADER_QUESTION_TYPE_VALUE_SINGLE' => 'Einfach', 10 | 'HEADER_QUESTION_TYPE_VALUE_MULTIPLE_CHOICE' => 'Multiple Choice', 11 | 'HEADER_QUESTION' => 'Frage', 12 | 'HEADER_WAYPOINT_DESCRIPTION' => 'Beschreibung der Station', 13 | 'HEADER_LAB_DESCRIPTION' => 'Beschreibung des Adventure Labs', 14 | ); 15 | -------------------------------------------------------------------------------- /api/migrations/2025092601.sql: -------------------------------------------------------------------------------- 1 | create table adventure_labs 2 | ( 3 | id INTEGER primary key autoincrement, 4 | uuid TEXT not null UNIQUE, 5 | code TEXT UNIQUE, 6 | url TEXT, 7 | parent TEXT, 8 | title TEXT, 9 | lat REAL, 10 | lon REAL 11 | ); 12 | 13 | insert into adventure_labs(id, uuid, code) select id, uuid, lab_code from lab_codes; 14 | 15 | create index idx_adventure_labs_uuid on adventure_labs (uuid); 16 | create index idx_adventure_labs_parent on adventure_labs (parent); 17 | create index idx_adventure_labs_code on adventure_labs (code); 18 | 19 | drop table lab_codes; 20 | -------------------------------------------------------------------------------- /api/src/request/download.http: -------------------------------------------------------------------------------- 1 | POST http://localhost:8080/download 2 | Content-Type: application/json 3 | 4 | { 5 | "locale": "de", 6 | "coordinates": { 7 | "lat": 52.51739, 8 | "lon": 13.39513 9 | }, 10 | "radius": 15, 11 | "limit": 300, 12 | "cacheType": "Lab Cache", 13 | "prefix": "LC", 14 | "customCodeTemaplate": null, 15 | "linear": "default", 16 | 17 | "userGuid": null, 18 | "completionStatuses": ["1", "2", "0"], 19 | 20 | "includeQuestion": true, 21 | "includeWaypointDescription": true, 22 | "includeCacheDescription": true, 23 | 24 | "outputFormat": "gpx" 25 | } 26 | -------------------------------------------------------------------------------- /api/src/request/download-by-uuid.http: -------------------------------------------------------------------------------- 1 | POST http://localhost:8080/download 2 | Content-Type: application/json 3 | 4 | { 5 | "locale": "de", 6 | "coordinates": { 7 | "lat": 0, 8 | "lon": 0 9 | }, 10 | "cacheType": "Lab Cache", 11 | "prefix": "LC", 12 | "customCodeTemaplate": null, 13 | "linear": "default", 14 | 15 | "userGuid": null, 16 | "completionStatuses": ["1", "2", "0"], 17 | 18 | "includeQuestion": true, 19 | "includeWaypointDescription": true, 20 | "includeCacheDescription": true, 21 | 22 | "outputFormat": "gpx", 23 | 24 | "uuidsToFetch": "0bd5dc20-cc2c-4023-a42a-80161772fe1f,0cc82cf0-4624-4969-857f-d363a962a1a0" 25 | } 26 | -------------------------------------------------------------------------------- /api/bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | isMainRequest()) { 21 | return; 22 | } 23 | 24 | $request = $event->getRequest(); 25 | $this->logger->info( 26 | sprintf( 27 | '%s %s %s', 28 | $request->getClientIp(), 29 | $request->getMethod(), 30 | $request->getRequestUri(), 31 | ), 32 | ['content' => $request->getContent()], 33 | ); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /api/public/index.php: -------------------------------------------------------------------------------- 1 | 2 | import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'; 3 | import { library as fontAwesomeIconLibrary } from '@fortawesome/fontawesome-svg-core'; 4 | 5 | import { faGear } from '@fortawesome/free-solid-svg-icons/faGear'; 6 | import { faDownload } from '@fortawesome/free-solid-svg-icons/faDownload'; 7 | import { faQuestion} from '@fortawesome/free-solid-svg-icons/faQuestion'; 8 | import { faLocationCrosshairs } from '@fortawesome/free-solid-svg-icons/faLocationCrosshairs'; 9 | import { faXmark } from '@fortawesome/free-solid-svg-icons/faXmark'; 10 | import { faSave } from '@fortawesome/free-solid-svg-icons/faSave'; 11 | 12 | // https://fontawesome.com/icons 13 | fontAwesomeIconLibrary.add([ 14 | faGear, 15 | faDownload, 16 | faQuestion, 17 | faLocationCrosshairs, 18 | faXmark, 19 | faSave 20 | ]); 21 | 22 | defineProps<{ 23 | icon: string 24 | }>(); 25 | 26 | 27 | 32 | -------------------------------------------------------------------------------- /frontend/src/main.ts: -------------------------------------------------------------------------------- 1 | import { createApp } from 'vue'; 2 | import App from './App.vue'; 3 | import 'chota/dist/chota.css'; 4 | import './assets/main.css'; 5 | import { createI18n } from 'vue-i18n'; 6 | import en from './locales/en.json'; 7 | import de from './locales/de.json'; 8 | import { hasStoredSettings, useSettings } from '@/composables/useSettings.ts'; 9 | 10 | 11 | function detectLocale() { 12 | const settings = useSettings(); 13 | const langs = ['de', 'en']; 14 | if (hasStoredSettings() && settings && langs.includes(settings.value.locale)) { 15 | return settings.value.locale; 16 | } 17 | 18 | const nav = navigator.language?.split('-')[0]; 19 | const l = langs.includes(nav) ? nav : 'en'; 20 | settings.value.locale = l; 21 | return l; 22 | } 23 | 24 | const i18n = createI18n({ 25 | locale: detectLocale(), 26 | fallbackLocale: 'en', 27 | globalInjection: true, 28 | messages: { 29 | de: de, 30 | en: en, 31 | }, 32 | }); 33 | 34 | const app = createApp(App); 35 | app.use(i18n); 36 | app.mount('#app'); 37 | -------------------------------------------------------------------------------- /api/.env: -------------------------------------------------------------------------------- 1 | # In all environments, the following files are loaded if they exist, 2 | # the latter taking precedence over the former: 3 | # 4 | # * .env contains default values for the environment variables needed by the app 5 | # * .env.local uncommitted file with local overrides 6 | # * .env.$APP_ENV committed environment-specific defaults 7 | # * .env.$APP_ENV.local uncommitted environment-specific overrides 8 | # 9 | # Real environment variables win over .env files. 10 | # 11 | # DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES. 12 | # https://symfony.com/doc/current/configuration/secrets.html 13 | # 14 | # Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2). 15 | # https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration 16 | 17 | ###> symfony/framework-bundle ### 18 | APP_ENV=dev 19 | APP_SECRET= 20 | ###< symfony/framework-bundle ### 21 | 22 | CONSUMER_KEY= 23 | CACHE_DIR='%kernel.project_dir%/var/data/cache' 24 | CACHE_LIFE_TIME_IN_SECONDS=86400 25 | DATA_DIR='%kernel.project_dir%/var/data/db' 26 | LOGS_DIR='%kernel.project_dir%/var/log' 27 | -------------------------------------------------------------------------------- /api/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: list 2 | list: 3 | @echo "" 4 | @echo "Targets for api:" 5 | @echo "" 6 | @echo " dev > run dev server" 7 | @echo " cs > code sniffer" 8 | @echo " cf > code sniffer fix" 9 | @echo " stan > phpstan" 10 | @echo " trans > extract translations" 11 | 12 | .PHONY: dev 13 | dev: 14 | php -S localhost:8080 -t public public/index.php 15 | 16 | .PHONY: stan 17 | stan: 18 | php -d memory_limit=1G vendor/bin/phpstan analyse 19 | 20 | .PHONY: cs 21 | cs: 22 | vendor/bin/phpcs 23 | 24 | .PHONY: cf 25 | cf: 26 | vendor/bin/phpcbf 27 | 28 | .PHONY: trans 29 | trans: 30 | php bin/console translation:extract en --format=php --force --domain=messages 31 | php bin/console translation:extract de --format=php --force --domain=messages 32 | 33 | .PHONY: build 34 | ASSETS = config public src templates templates_custom translations .env composer.json composer.lock .env 35 | build: 36 | if [ -d dist ]; then \ 37 | rm -rf dist; \ 38 | fi 39 | mkdir -p dist 40 | cp -r $(ASSETS) dist/ 41 | cd dist && APP_ENV=prod composer install --no-dev --no-interaction --no-progress --optimize-autoloader --classmap-authoritative --no-scripts 42 | rm dist/composer.* 43 | -------------------------------------------------------------------------------- /frontend/src/interfaces/Settings.ts: -------------------------------------------------------------------------------- 1 | import type { Coordinates } from '@/interfaces/Coordinates.ts' 2 | 3 | enum CompletionStatus { 4 | COMPLETED = '0', 5 | PARTIAL_COMPLETED = '1', 6 | NOT_STARTED = '2', 7 | } 8 | 9 | interface Settings { 10 | version: number; 11 | locale: string; 12 | 13 | radius: number; 14 | coordinates: Coordinates; 15 | limit: number; 16 | 17 | cacheType: 'Lab Cache' | 'Virtual Cache' | 'Mega-Event Cache'; 18 | linear: 'default' | 'first' | 'mark' | 'corrected' | 'ignore'; 19 | 20 | // code generation 21 | prefix: string; 22 | stageSeparator: boolean; 23 | customCodeTemplate: string|null; 24 | 25 | // filters/personalized search 26 | userGuid: string | null; 27 | completionStatuses: CompletionStatus[]; 28 | 29 | // description generation 30 | includeQuestion: boolean; 31 | includeWaypointDescription: boolean; 32 | includeCacheDescription: boolean; 33 | 34 | // exclusions 35 | excludeOwner: string|null; 36 | excludeNames: string|null; 37 | excludeUuids: string|null; 38 | 39 | quirksL4Ctype: boolean; 40 | quirksBomForCsv: boolean; 41 | 42 | outputFormat: 'zippedgpx' | 'gpx' | 'zippedgpxwpt' | 'gpxwpt' | 'cacheturdotno'; 43 | } 44 | 45 | export { type Settings, CompletionStatus } 46 | -------------------------------------------------------------------------------- /api/src/EventListener/ApiExceptionListener.php: -------------------------------------------------------------------------------- 1 | getThrowable(); 23 | 24 | $statusCode = 500; 25 | $data = ['error' => 'Internal Server Error']; 26 | if ($this->kernel->getEnvironment() === 'dev') { 27 | $data['trace'] = json_encode($exception->getTrace()); 28 | $data['message'] = $exception->getMessage(); 29 | } 30 | 31 | if ($exception instanceof HttpExceptionInterface) { 32 | $statusCode = $exception->getStatusCode(); 33 | $data['error'] = $exception->getStatusCode(); 34 | $data['message'] = $exception->getMessage(); 35 | } 36 | 37 | $response = new JsonResponse($data, $statusCode); 38 | $event->setResponse($response); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /api/src/Controller/Lab2GpxController.php: -------------------------------------------------------------------------------- 1 | database->findLabByUuid($uuid); 25 | if (! $row) { 26 | throw $this->createNotFoundException(sprintf('Nothing found for UUID "%s"', $uuid)); 27 | } 28 | 29 | return $this->json($row); 30 | } 31 | 32 | #[Route('/lab2gpx-data/by-code/{code}', methods: ['GET'])] 33 | public function getDatabaseDataByCodeAction(string $code): Response 34 | { 35 | $row = $this->database->findLabByCode($code); 36 | if (! $row) { 37 | throw $this->createNotFoundException(sprintf('Nothing found for code "%s"', $code)); 38 | } 39 | 40 | return $this->json($row); 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /api/templates/cacheturdotno.csv.twig: -------------------------------------------------------------------------------- 1 | {%- macro getWaypointTitle(settings, adventureLab, wpt, stage) -%} 2 | {%- autoescape false -%} 3 | {%- if adventureLab.IsLinear and settings.linear == constant('App\\Model\\Dto\\Linear::MARK') %}[L] {% endif -%} 4 | {{ adventureLab.Title }} : S{{ formatStageForDisplay(stage, adventureLab) }} {{ wpt.Title }} 5 | {%- endautoescape -%} 6 | {%- endmacro -%} 7 | {%- autoescape 'csv' -%} 8 | {# @var settings \App\Model\Dto\Settings #} 9 | {# @var adventureLab array #} 10 | {%- for adventureLab in adventureLabs -%} 11 | {%- set stage = 0 -%} 12 | {%- set stagesIncluded = 0 -%} 13 | {%- for wpt in adventureLab.GeocacheSummaries -%} 14 | {%- set stage = stage + 1 -%} 15 | {# next two conditions are a bit odd but the is no continue or break in twig #} 16 | {%- if not shouldSkipStage(settings, wpt) -%} 17 | {%- if not adventureLab.IsLinear or settings.linear != constant('App\\Model\\Dto\\Linear::FIRST') or stagesIncluded == 0 -%} 18 | {%- set stagesIncluded = stagesIncluded + 1 -%} 19 | {%- set code = getCode(settings, adventureLab, stage) -%} 20 | {%- set title = _self.getWaypointTitle(settings, adventureLab, wpt, stage) -%} 21 | {{ code }};lab;{{ decimalMinutes(wpt.Location.Latitude, wpt.Location.Longitude) }};{{ title|e('csv') }}{{ "\n" }} 22 | {%- endif -%} 23 | {%- endif -%} 24 | {%- endfor -%} 25 | {%- endfor -%} 26 | {%- endautoescape -%} 27 | -------------------------------------------------------------------------------- /api/src/Controller/AdventureLabController.php: -------------------------------------------------------------------------------- 1 | kernel->getEnvironment() !== 'dev') { 26 | throw new AccessDeniedHttpException(); 27 | } 28 | 29 | return $this->json($this->adventureLabApiClient->getAdventureIdBySmartLink($link)); 30 | } 31 | 32 | #[Route('/adventure-lab/adventure/{id}', methods: ['GET'])] 33 | public function getAdventureAction(string $id): Response 34 | { 35 | if ($this->kernel->getEnvironment() !== 'dev') { 36 | throw new AccessDeniedHttpException(); 37 | } 38 | 39 | return $this->json($this->adventureLabApiClient->getAdventureById($id, null)); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /frontend/src/composables/useGeocoding.ts: -------------------------------------------------------------------------------- 1 | import { convert } from 'geo-coordinates-parser' 2 | import type { Coordinates } from '@/interfaces/Coordinates.ts' 3 | import { useSettings } from '@/composables/useSettings.ts'; 4 | 5 | const NOMINATIM = 'https://nominatim.openstreetmap.org/search?format=jsonv2&limit=5&q=' 6 | 7 | interface NominatimSearchResult { 8 | display_name: string 9 | lat: string 10 | lon: string 11 | } 12 | 13 | const settings = useSettings(); 14 | 15 | export function useGeocoding() { 16 | function normalizeCoords(input: string): Coordinates | null { 17 | try { 18 | const result = convert(input) 19 | return { 20 | lat: result.decimalLatitude, 21 | lon: result.decimalLongitude, 22 | } 23 | } catch { 24 | return null 25 | } 26 | } 27 | 28 | async function geoCode(q: string): Promise<{ display: string; coords: Coordinates }[]> { 29 | const url = `${NOMINATIM}${encodeURIComponent(q)}` 30 | const res = await fetch(url, { 31 | headers: { 32 | 'Accept-Language': settings.value.locale, 33 | 'User-Agent': 'lab2gpx/2.0', 34 | }, 35 | }) 36 | const data = (await res.json()) as NominatimSearchResult[] 37 | return data.map((x) => ({ 38 | display: x.display_name, 39 | coords: { lat: parseFloat(x.lat), lon: parseFloat(x.lon) }, 40 | })) 41 | } 42 | 43 | return { geoCode, normalizeCoords } 44 | } 45 | -------------------------------------------------------------------------------- /api/src/Model/Twig/XmlEscaper.php: -------------------------------------------------------------------------------- 1 | [['register', 2048]], 31 | ConsoleEvents::COMMAND => 'register', 32 | ]; 33 | } 34 | 35 | public function register(): void 36 | { 37 | $escaper = $this->twig->getRuntime(EscaperRuntime::class); 38 | if (in_array('xml', array_keys($escaper->getEscapers()))) { 39 | return; 40 | } 41 | 42 | $escaper->setEscaper('xml', static function (string $v) { 43 | if ($v === '') { 44 | return ''; 45 | } 46 | 47 | // see https://github.com/mirsch/lab2gpx/issues/10, https://github.com/mirsch/lab2gpx/issues/100 48 | $v = (string) preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/u', '', $v); 49 | 50 | return htmlspecialchars($v, ENT_XML1); 51 | }); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /api/src/Model/Twig/CsvEscaper.php: -------------------------------------------------------------------------------- 1 | [['register', 2048]], 29 | ConsoleEvents::COMMAND => 'register', 30 | ]; 31 | } 32 | 33 | public function register(): void 34 | { 35 | $escaper = $this->twig->getRuntime(EscaperRuntime::class); 36 | if (in_array('csv', array_keys($escaper->getEscapers()))) { 37 | return; 38 | } 39 | 40 | $escaper->setEscaper('csv', static function (string $v) { 41 | if ($v === '') { 42 | return ''; 43 | } 44 | 45 | // RFC-4180 46 | // - double quoates 47 | // - Comma, CR, LF oor Quotes -> wrap in " 48 | $needsQuotes = strpbrk($v, ",\r\n\"") !== false; 49 | 50 | $v = str_replace('"', '""', $v); 51 | 52 | return $needsQuotes ? '"' . $v . '"' : $v; 53 | }); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /frontend/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | Lab2Gpx 18 | 19 | 20 |
21 | 22 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /frontend/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "frontend", 3 | "version": "0.0.0", 4 | "private": true, 5 | "type": "module", 6 | "engines": { 7 | "node": "^20.19.0 || >=22.12.0" 8 | }, 9 | "scripts": { 10 | "dev": "vite", 11 | "build": "run-p type-check \"build-only {@}\" --", 12 | "preview": "vite preview", 13 | "build-only": "vite build", 14 | "type-check": "vue-tsc --build", 15 | "lint": "eslint . --fix", 16 | "format": "prettier --write src/" 17 | }, 18 | "dependencies": { 19 | "@fortawesome/fontawesome-svg-core": "^7.0.1", 20 | "@fortawesome/free-regular-svg-icons": "^7.0.1", 21 | "@fortawesome/free-solid-svg-icons": "^7.0.1", 22 | "@fortawesome/vue-fontawesome": "^3.1.2", 23 | "chota": "^0.9.2", 24 | "file-saver": "^2.0.5", 25 | "geo-coordinates-parser": "^1.7.4", 26 | "vue": "^3.5.18", 27 | "vue-i18n": "^11.1.12" 28 | }, 29 | "devDependencies": { 30 | "@tsconfig/node22": "^22.0.2", 31 | "@types/file-saver": "^2.0.7", 32 | "@types/leaflet": "^1.9.20", 33 | "@types/node": "^22.16.5", 34 | "@vitejs/plugin-vue": "^6.0.1", 35 | "@vitejs/plugin-vue-jsx": "^5.0.1", 36 | "@vue-leaflet/vue-leaflet": "^0.10.1", 37 | "@vue/eslint-config-prettier": "^10.2.0", 38 | "@vue/eslint-config-typescript": "^14.6.0", 39 | "@vue/tsconfig": "^0.7.0", 40 | "eslint": "^9.31.0", 41 | "eslint-plugin-vue": "~10.3.0", 42 | "jiti": "^2.4.2", 43 | "leaflet": "^1.9.4", 44 | "npm-run-all2": "^8.0.4", 45 | "prettier": "3.6.2", 46 | "typescript": "~5.8.0", 47 | "vite": "^7.1.11", 48 | "vite-plugin-vue-devtools": "^8.0.0", 49 | "vue-tsc": "^3.0.4" 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /frontend/src/components/HelpModal.vue: -------------------------------------------------------------------------------- 1 | 11 | 12 | 34 | 35 | 37 | -------------------------------------------------------------------------------- /frontend/src/components/MapView.vue: -------------------------------------------------------------------------------- 1 | 26 | 27 | 51 | -------------------------------------------------------------------------------- /api/src/Model/DecimalMinutes.php: -------------------------------------------------------------------------------- 1 | useCardinalLettersAsPrefix) { 16 | if ($lat >= 0) { 17 | return 'N '; 18 | } 19 | 20 | return 'S '; 21 | } 22 | 23 | if ($this->useCardinalLetters || $lat >= 0) { 24 | return ''; 25 | } 26 | 27 | return '-'; 28 | } 29 | 30 | protected function getLngPrefix(float $lng): string 31 | { 32 | if ($this->useCardinalLettersAsPrefix) { 33 | if ($lng >= 0) { 34 | return 'E '; 35 | } 36 | 37 | return 'W '; 38 | } 39 | 40 | if ($this->useCardinalLetters || $lng >= 0) { 41 | return ''; 42 | } 43 | 44 | return '-'; 45 | } 46 | 47 | protected function getLatSuffix(float $lat): string 48 | { 49 | if ($this->useCardinalLettersAsPrefix) { 50 | return ''; 51 | } 52 | 53 | if (! $this->useCardinalLetters) { 54 | return ''; 55 | } 56 | 57 | if ($lat >= 0) { 58 | return ' N'; 59 | } 60 | 61 | return ' S'; 62 | } 63 | 64 | protected function getLngSuffix(float $lng): string 65 | { 66 | if ($this->useCardinalLettersAsPrefix) { 67 | return ''; 68 | } 69 | 70 | if (! $this->useCardinalLetters) { 71 | return ''; 72 | } 73 | 74 | if ($lng >= 0) { 75 | return ' E'; 76 | } 77 | 78 | return ' W'; 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /api/config/services.yaml: -------------------------------------------------------------------------------- 1 | # This file is the entry point to configure your own services. 2 | # Files in the packages/ subdirectory configure your dependencies. 3 | 4 | # Put parameters here that don't need to change on each machine where the app is deployed 5 | # https://symfony.com/doc/current/best_practices.html#use-parameters-for-application-configuration 6 | parameters: 7 | 8 | services: 9 | # default configuration for services in *this* file 10 | _defaults: 11 | autowire: true # Automatically injects dependencies in your services. 12 | autoconfigure: true # Automatically registers your services as commands, event subscribers, etc. 13 | 14 | # makes classes in src/ available to be used as services 15 | # this creates a service per class whose id is the fully-qualified class name 16 | App\: 17 | resource: '../src/' 18 | 19 | # add more service definitions when explicit configuration is needed 20 | # please note that last definitions always *replace* previous ones 21 | App\EventListener\ApiExceptionListener: 22 | tags: 23 | - { name: kernel.event_listener, event: kernel.exception } 24 | 25 | App\Model\AdventureLabApiClient: 26 | class: App\Model\AdventureLabApiClient 27 | arguments: 28 | $consumerKey: '%env(CONSUMER_KEY)%' 29 | 30 | App\Model\ExportGenerator: 31 | class: App\Model\ExportGenerator 32 | arguments: 33 | $cacheDir: '%env(resolve:CACHE_DIR)%' 34 | $cacheTtl: '%env(CACHE_LIFE_TIME_IN_SECONDS)%' 35 | 36 | App\Model\AdventureLabDatabase: 37 | class: App\Model\AdventureLabDatabase 38 | arguments: 39 | $dataDir: '%env(resolve:DATA_DIR)%' 40 | 41 | App\EventListener\RequestLogger: 42 | arguments: [ '@monolog.logger.apirequest' ] 43 | tags: 44 | - { name: 'kernel.event_listener', event: 'kernel.request', method: 'onKernelRequest' } 45 | -------------------------------------------------------------------------------- /frontend/src/composables/useSettings.ts: -------------------------------------------------------------------------------- 1 | import { ref, watch } from 'vue' 2 | import { type Settings } from '@/interfaces/Settings.ts' 3 | import { CompletionStatus } from '@/interfaces/Settings.ts' 4 | 5 | const SETTINGS_KEY = 'lab2gpx-settings'; 6 | 7 | export function hasStoredSettings(): boolean 8 | { 9 | return localStorage.getItem(SETTINGS_KEY) !== null; 10 | } 11 | 12 | export function useSettings() { 13 | const settings = ref({ 14 | version: 2, 15 | locale: 'en', 16 | radius: 15, 17 | coordinates: { lat: 52.520008, lon: 13.404954 }, 18 | limit: 300, 19 | 20 | cacheType: 'Lab Cache', 21 | linear: 'default', 22 | 23 | prefix: 'LC', 24 | stageSeparator: true, 25 | customCodeTemplate: null, 26 | 27 | userGuid: null, 28 | completionStatuses: [ 29 | CompletionStatus.COMPLETED, 30 | CompletionStatus.PARTIAL_COMPLETED, 31 | CompletionStatus.NOT_STARTED, 32 | ], 33 | 34 | includeQuestion: true, 35 | includeWaypointDescription: true, 36 | includeCacheDescription: true, 37 | 38 | excludeOwner: null, 39 | excludeNames: null, 40 | excludeUuids: null, 41 | 42 | quirksL4Ctype: false, 43 | quirksBomForCsv: false, 44 | 45 | outputFormat: 'zippedgpx', 46 | }) 47 | 48 | try { 49 | const storedSettingsJson = localStorage.getItem(SETTINGS_KEY) 50 | if (storedSettingsJson) { 51 | const storedSettings = JSON.parse(storedSettingsJson) as Settings 52 | settings.value = { ...settings.value, ...storedSettings } 53 | } 54 | } catch {} 55 | 56 | watch( 57 | () => settings.value, 58 | () => { 59 | try { 60 | localStorage.setItem(SETTINGS_KEY, JSON.stringify(settings.value)) 61 | } catch (error) { 62 | console.error(`Error persisting settings in localStorage: ${error}`) 63 | } 64 | }, 65 | { deep: true }, 66 | ) 67 | 68 | return settings 69 | } 70 | -------------------------------------------------------------------------------- /api/templates/partials/description.html.twig: -------------------------------------------------------------------------------- 1 | {% block description %} 2 | {% autoescape 'html' %} 3 |

{{ adventureLab.Title }}

4 | {% if wpt.Title is defined %} 5 |

{{ wpt.Title }}

6 | {% endif %} 7 | 8 | {% if adventureLab.IsLinear %} 9 |

10 | {{ 'TAG_LINEAR' | trans }} 11 |

12 | {% endif %} 13 | 14 |

{{ adventureLab.DeepLink }}

15 | 16 | {% if wpt.GeofencingRadius is defined %} 17 |

{{ 'HEADER_GEOFENCING_RADIUS' | trans }}: {{ wpt.GeofencingRadius }}m

18 | {% endif %} 19 | 20 | {% if adventureLab.StagesTotalCount is defined %} 21 |

{{ 'HEADER_STAGES_COUNT' | trans }}: {{ adventureLab.StagesTotalCount }}

22 | {% endif %} 23 | 24 | {% if adventureLab.LAB2GPX_GCCodes | length %} 25 |

{{ 'HEADER_POSSIBLY_BONUS' | trans }}: 26 | {% for gccode in adventureLab.LAB2GPX_GCCodes %} 27 | {{ gccode }}{% if not loop.last %}, {% endif %} 28 | {% endfor %} 29 |

30 | {% endif %} 31 | 32 | {% if settings.includeQuestion and wpt.Question is defined %} 33 |

{{ 'HEADER_QUESTION_TYPE' | trans }}: 34 | {% if wpt.ChallengeType == 0 %} 35 | {{ 'HEADER_QUESTION_TYPE_VALUE_SINGLE' | trans }} 36 | {% elseif wpt.ChallengeType == 1 %} 37 | {{ 'HEADER_QUESTION_TYPE_VALUE_MULTIPLE_CHOICE' | trans }} 38 | {% else %} 39 | {{ wpt.ChallengeType }} 40 | {% endif %} 41 |

42 |

{{ 'HEADER_QUESTION' | trans }}:
{{ wpt.Question }}

43 | {% endif %} 44 | 45 | {% if settings.includeWaypointDescription and wpt.LAB2GPX_Description %} 46 |
47 |
{{ 'HEADER_WAYPOINT_DESCRIPTION' | trans }}
48 |

49 |

{{ wpt.LAB2GPX_Description }}

50 | {% endif %} 51 | 52 | {% if settings.includeCacheDescription and adventureLab.LAB2GPX_Description %} 53 |
54 |
{{ 'HEADER_LAB_DESCRIPTION' | trans }}
55 |

56 |

{{ adventureLab.LAB2GPX_Description }}

57 | {% endif %} 58 | {% endautoescape %} 59 | {% endblock %} 60 | -------------------------------------------------------------------------------- /frontend/src/components/DownloadModal.vue: -------------------------------------------------------------------------------- 1 | 33 | 34 | 45 | 46 | 87 | -------------------------------------------------------------------------------- /api/config/packages/monolog.yaml: -------------------------------------------------------------------------------- 1 | monolog: 2 | channels: 3 | - deprecation # Deprecations are logged in the dedicated "deprecation" channel when it exists 4 | - apirequest 5 | 6 | when@dev: 7 | monolog: 8 | handlers: 9 | main: 10 | type: stream 11 | path: "%kernel.logs_dir%/%kernel.environment%.log" 12 | level: debug 13 | channels: ["!event"] 14 | # uncomment to get logging in your browser 15 | # you may have to allow bigger header sizes in your Web server configuration 16 | #firephp: 17 | # type: firephp 18 | # level: info 19 | #chromephp: 20 | # type: chromephp 21 | # level: info 22 | console: 23 | type: console 24 | process_psr_3_messages: false 25 | channels: ["!event", "!doctrine", "!console"] 26 | apirequest: 27 | type: stream 28 | path: '%env(resolve:LOGS_DIR)%/apirequest.log' 29 | level: info 30 | channels: [ 'apirequest' ] 31 | 32 | when@test: 33 | monolog: 34 | handlers: 35 | main: 36 | type: fingers_crossed 37 | action_level: error 38 | handler: nested 39 | excluded_http_codes: [404, 405] 40 | channels: ["!event"] 41 | nested: 42 | type: stream 43 | path: "%kernel.logs_dir%/%kernel.environment%.log" 44 | level: debug 45 | 46 | when@prod: 47 | monolog: 48 | handlers: 49 | main: 50 | type: fingers_crossed 51 | action_level: error 52 | handler: nested 53 | excluded_http_codes: [404, 405] 54 | buffer_size: 50 # How many messages should be saved? Prevent memory leaks 55 | nested: 56 | type: stream 57 | path: php://stderr 58 | level: debug 59 | formatter: monolog.formatter.json 60 | console: 61 | type: console 62 | process_psr_3_messages: false 63 | channels: ["!event", "!doctrine"] 64 | deprecation: 65 | type: stream 66 | channels: [deprecation] 67 | path: php://stderr 68 | formatter: monolog.formatter.json 69 | apirequest: 70 | type: stream 71 | path: '%env(resolve:LOGS_DIR)%/apirequest.log' 72 | level: info 73 | channels: [ 'apirequest' ] 74 | -------------------------------------------------------------------------------- /frontend/src/components/ModalWrap.vue: -------------------------------------------------------------------------------- 1 | 24 | 25 | 42 | 43 | 112 | -------------------------------------------------------------------------------- /api/phpcs.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | bin/ 15 | public/ 16 | src/ 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /api/composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "project", 3 | "license": "proprietary", 4 | "minimum-stability": "stable", 5 | "prefer-stable": true, 6 | "require": { 7 | "php": "^8.4", 8 | "ext-ctype": "*", 9 | "ext-pdo": "*", 10 | "guzzlehttp/guzzle": "^7.10", 11 | "maennchen/zipstream-php": "^3.2", 12 | "mjaschen/phpgeo": "^6.0", 13 | "phpdocumentor/reflection-docblock": "^5.6.3", 14 | "phpstan/phpdoc-parser": "^2.3", 15 | "phpstan/phpstan": "^2.1.29", 16 | "phpstan/phpstan-symfony": "^2.0.8", 17 | "symfony/console": "7.3.*", 18 | "symfony/dotenv": "7.3.*", 19 | "symfony/flex": "^2.8.2", 20 | "symfony/framework-bundle": "7.3.*", 21 | "symfony/monolog-bundle": "^3.10", 22 | "symfony/property-access": "7.3.*", 23 | "symfony/property-info": "7.3.*", 24 | "symfony/runtime": "7.3.*", 25 | "symfony/serializer": "7.3.*", 26 | "symfony/translation": "7.3.*", 27 | "symfony/twig-bundle": "7.3.*", 28 | "symfony/validator": "7.3.*", 29 | "symfony/yaml": "7.3.*", 30 | "twig/extra-bundle": "^2.12|^3.21", 31 | "twig/twig": "^2.12|^3.21.1" 32 | }, 33 | "require-dev": { 34 | "doctrine/coding-standard": "^13.0.1", 35 | "symfony/debug-bundle": "7.3.*", 36 | "symfony/stopwatch": "7.3.*", 37 | "symfony/web-profiler-bundle": "7.3.*" 38 | }, 39 | "config": { 40 | "allow-plugins": { 41 | "dealerdirect/phpcodesniffer-composer-installer": true, 42 | "php-http/discovery": true, 43 | "symfony/flex": true, 44 | "symfony/runtime": true 45 | }, 46 | "bump-after-update": true, 47 | "sort-packages": true 48 | }, 49 | "autoload": { 50 | "psr-4": { 51 | "App\\": "src/" 52 | } 53 | }, 54 | "autoload-dev": { 55 | "psr-4": { 56 | "App\\Tests\\": "tests/" 57 | } 58 | }, 59 | "replace": { 60 | "symfony/polyfill-ctype": "*", 61 | "symfony/polyfill-iconv": "*", 62 | "symfony/polyfill-php72": "*", 63 | "symfony/polyfill-php73": "*", 64 | "symfony/polyfill-php74": "*", 65 | "symfony/polyfill-php80": "*", 66 | "symfony/polyfill-php81": "*", 67 | "symfony/polyfill-php82": "*" 68 | }, 69 | "scripts": { 70 | "auto-scripts": { 71 | "cache:clear": "symfony-cmd", 72 | "assets:install %PUBLIC_DIR%": "symfony-cmd" 73 | }, 74 | "post-install-cmd": [ 75 | "@auto-scripts" 76 | ], 77 | "post-update-cmd": [ 78 | "@auto-scripts" 79 | ] 80 | }, 81 | "conflict": { 82 | "symfony/symfony": "*" 83 | }, 84 | "extra": { 85 | "symfony": { 86 | "allow-contrib": false, 87 | "require": "7.3.*" 88 | } 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /api/templates/partials/description-waypoints.html.twig: -------------------------------------------------------------------------------- 1 | {%- macro getWaypointTitle(settings, adventureLab, wpt, stage) -%} 2 | {%- if adventureLab.IsLinear and settings.linear == constant('App\\Model\\Dto\\Linear::MARK') %}[L] {% endif -%} 3 | S{{ formatStageForDisplay(stage, adventureLab) }} {{ wpt.Title }} 4 | {%- endmacro -%} 5 | 6 | {% block description %} 7 |

{{ adventureLab.Title }}

8 | 9 | {% if adventureLab.IsLinear %} 10 |

11 | {{ 'TAG_LINEAR' | trans }} 12 |

13 | {% endif %} 14 | 15 |

{{ adventureLab.DeepLink }}

16 | 17 | {% if adventureLab.StagesTotalCount is defined %} 18 |

{{ 'HEADER_STAGES_COUNT' | trans }}: {{ adventureLab.StagesTotalCount }}

19 | {% endif %} 20 | 21 | {% if adventureLab.LAB2GPX_GCCodes | length %} 22 |

{{ 'HEADER_POSSIBLY_BONUS' | trans }}: 23 | {% for gccode in adventureLab.LAB2GPX_GCCodes %} 24 | {{ gccode }}{% if not loop.last %}, {% endif %} 25 | {% endfor %} 26 |

27 | {% endif %} 28 | 29 | {% if settings.includeCacheDescription and adventureLab.LAB2GPX_Description %} 30 |
31 |
{{ 'HEADER_LAB_DESCRIPTION' | trans }}
32 |

33 |

{{ adventureLab.LAB2GPX_Description }}

34 | {% endif %} 35 | 36 | {% set stage = 0 %} 37 | {% for wpt in adventureLab.GeocacheSummaries %} 38 | {% set stage = stage + 1 %} 39 | {% block waypoint_description %} 40 |
41 |

{{ _self.getWaypointTitle(settings, adventureLab, wpt, stage) }}

42 | 43 | {% if wpt.GeofencingRadius is defined %} 44 |

{{ 'HEADER_GEOFENCING_RADIUS' | trans }}: {{ wpt.GeofencingRadius }}m

45 | {% endif %} 46 | 47 | {% if settings.includeQuestion and wpt.Question is defined %} 48 |

{{ 'HEADER_QUESTION_TYPE' | trans }}: 49 | {% if wpt.ChallengeType == 0 %} 50 | {{ 'HEADER_QUESTION_TYPE_VALUE_SINGLE' | trans }} 51 | {% elseif wpt.ChallengeType == 1 %} 52 | {{ 'HEADER_QUESTION_TYPE_VALUE_MULTIPLE_CHOICE' | trans }} 53 | {% else %} 54 | {{ wpt.ChallengeType }} 55 | {% endif %} 56 |

57 |

{{ 'HEADER_QUESTION' | trans }}:
{{ wpt.Question }}

58 | {% endif %} 59 | 60 | {% if settings.includeWaypointDescription and wpt.LAB2GPX_Description %} 61 |
62 |
{{ 'HEADER_WAYPOINT_DESCRIPTION' | trans }}
63 |

64 |

{{ wpt.LAB2GPX_Description }}

65 | {% endif %} 66 | 67 | {% endblock %} 68 | {% endfor %} 69 | {% endblock %} 70 | -------------------------------------------------------------------------------- /frontend/src/composables/useDownload.ts: -------------------------------------------------------------------------------- 1 | import { saveAs } from 'file-saver'; 2 | import type { Settings } from '@/interfaces/Settings.ts'; 3 | import { ref } from 'vue'; 4 | 5 | const showDownloader = ref(false) 6 | 7 | export function useDownload() { 8 | // see https://stackoverflow.com/a/67994693 9 | function _getFileNameFromContentDisposition(disposition: string | null): string { 10 | let fileName = 'download'; 11 | if (disposition === null) { 12 | return fileName; 13 | } 14 | const utf8FilenameRegex = /filename\*=UTF-8''([\w%\-.]+)(?:; ?|$)/i; 15 | const asciiFilenameRegex = /filename=(["']?)(.*?[^\\])\1(?:; ?|$)/i; 16 | 17 | if (utf8FilenameRegex.test(disposition)) { 18 | const matched = utf8FilenameRegex.exec(disposition); 19 | if (matched !== null) { 20 | fileName = decodeURIComponent(matched[1]); 21 | } 22 | } else { 23 | const matches = asciiFilenameRegex.exec(disposition); 24 | if (matches !== null && matches[2]) { 25 | fileName = matches[2]; 26 | } 27 | } 28 | return fileName; 29 | } 30 | 31 | async function triggerDownload(settings: Settings) { 32 | const url = import.meta.env.VITE_API_URL + '/download'; 33 | showDownloader.value = true 34 | 35 | try { 36 | const res = await fetch(url, { 37 | method: 'POST', 38 | headers: { 39 | 'Content-Type': 'application/json', 40 | }, 41 | body: JSON.stringify(settings), 42 | }); 43 | 44 | const contentType = (res.headers.get('content-type') || '').toLowerCase(); 45 | if (contentType.includes('application/json')) { 46 | const data = await res.json(); 47 | if (data && typeof data.error === 'string') { 48 | let msg = data.error; 49 | if (typeof data.errors === 'object') { 50 | for(const prop in data.errors) { 51 | msg += "\n" + prop + ":"; 52 | for(const e in data.errors[prop]) { 53 | msg += "\n" + data.errors[prop][e]; 54 | } 55 | } 56 | } 57 | throw new Error(msg); 58 | } 59 | if (data.message) { 60 | throw new Error(data.message); 61 | } 62 | throw new Error('Unexpected JSON result.'); 63 | } 64 | 65 | if (!res.ok) { 66 | throw new Error(`Download Error ${res.status}`); 67 | } 68 | 69 | const blob = await res.blob(); 70 | const filename = _getFileNameFromContentDisposition( 71 | res.headers.get('content-disposition'), 72 | ); 73 | saveAs(blob, filename); 74 | } catch (err: unknown) { 75 | if (typeof err === 'object' && Object.prototype.hasOwnProperty.call(err, 'message') && (err as {message: string}).message !== '') { 76 | alert((err as {message: string}).message); 77 | } else if (typeof err === 'string') { 78 | alert(err); 79 | } else { 80 | console.error(err); 81 | } 82 | } finally { 83 | showDownloader.value = false 84 | } 85 | 86 | showDownloader.value = false 87 | } 88 | 89 | return { triggerDownload, showDownloader }; 90 | } 91 | -------------------------------------------------------------------------------- /frontend/src/components/SearchBar.vue: -------------------------------------------------------------------------------- 1 | 67 | 68 | 104 | 105 | 116 | -------------------------------------------------------------------------------- /api/src/Model/Twig/GpxExportTwigExtension.php: -------------------------------------------------------------------------------- 1 | shouldSkipStage(...)), 33 | new TwigFunction('formatStageForDisplay', $this->formatStageForDisplay(...)), 34 | new TwigFunction('getCode', $this->getCode(...)), 35 | new TwigFunction('decimalMinutes', $this->decimalMinutes(...)), 36 | ]; 37 | } 38 | 39 | /** @param array $geocacheSummary */ 40 | public function shouldSkipStage(Settings $settings, array $geocacheSummary): bool 41 | { 42 | if (in_array($geocacheSummary['Title'], $settings->getNormalizedExcludeNames())) { 43 | return true; 44 | } 45 | 46 | if (in_array($geocacheSummary['Id'], $settings->getNormalizedExcludeUuids())) { 47 | return true; 48 | } 49 | 50 | return $geocacheSummary['IsComplete'] && ! in_array('0', $settings->completionStatuses); 51 | } 52 | 53 | /** @param array $adventureLab */ 54 | public function formatStageForDisplay(int $stage, array $adventureLab): string 55 | { 56 | return str_pad((string) $stage, count($adventureLab['GeocacheSummaries']) >= 10 ? 2 : 1, '0', STR_PAD_LEFT); 57 | } 58 | 59 | /** @param array $adventureLab */ 60 | private function getCustomCode(Settings $settings, array $adventureLab, int $stage): string 61 | { 62 | $marker = [ 63 | '%CODE%' => $adventureLab['LAB2GPX_CODE'], 64 | '%STAGE_10%' => str_pad((string) $stage, 2, '0', STR_PAD_LEFT), 65 | '%STAGE_31%' => Base31Util::convertToBase31($stage), 66 | '%UUID%' => $adventureLab['Id'], 67 | ]; 68 | assert($settings->customCodeTemplate !== null); 69 | 70 | return str_ireplace(array_keys($marker), array_values($marker), $settings->customCodeTemplate); 71 | } 72 | 73 | /** @param array $adventureLab */ 74 | public function getCode( 75 | Settings $settings, 76 | array $adventureLab, 77 | int $stage, 78 | bool $useStageAsPrefix = false, 79 | ): string { 80 | if ($settings->customCodeTemplate) { 81 | return $this->getCustomCode($settings, $adventureLab, $stage); 82 | } 83 | 84 | $stage = $stage ? str_pad((string) $stage, 2, '0', STR_PAD_LEFT) : 0; 85 | $prefix = $settings->prefix; 86 | if ($useStageAsPrefix) { 87 | $stage = strtoupper(dechex((int) $stage)); 88 | $prefix = 'S' . $stage; 89 | if ($adventureLab['IsLinear']) { 90 | $prefix = 'L' . $stage; 91 | } 92 | 93 | $stage = 0; 94 | } 95 | 96 | $fixedPart = $adventureLab['LAB2GPX_CODE']; 97 | $sep = '-'; 98 | if (! $settings->stageSeparator) { 99 | $sep = ''; 100 | } 101 | 102 | $stage = Base31Util::convertToBase31((int) $stage); 103 | 104 | return strtoupper($prefix) . $fixedPart . ($stage ? $sep . $stage : ''); 105 | } 106 | 107 | public function decimalMinutes(float $lat, float $lon): string 108 | { 109 | $coordinate = new Coordinate($lat, $lon); 110 | $formatter = new DecimalMinutes(); 111 | 112 | return $coordinate->format($formatter); 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /frontend/src/App.vue: -------------------------------------------------------------------------------- 1 | 36 | 37 | 70 | 71 | 144 | -------------------------------------------------------------------------------- /frontend/src/locales/en.json: -------------------------------------------------------------------------------- 1 | { 2 | "language": "Language", 3 | "ok": "Ok", 4 | "cancel": "Cancel", 5 | "save": "Save", 6 | "save_and_download": "Save and Download", 7 | "settings": { 8 | "header": "Settings", 9 | "general": { 10 | "legend": "General", 11 | "limit": "Limit", 12 | "limit_hint": "0 = no limit. WARNING: the download may take a very long time without a limit and may also be aborted due to a timeout. If necessary, reduce the radius or choose a suitable limit.", 13 | "cache_type": "Cache Type", 14 | "cache_type_hint": "Garmin GPS devices do not support Adventure Labs. You probably want to export them as virtual or event caches.", 15 | "linear_label": "Linear Adventure Labs", 16 | "linear": { 17 | "default": "Default", 18 | "first": "Include only first/next stage", 19 | "mark": "Mark using [L] in title", 20 | "corrected": "As corrected coordinates", 21 | "ignore": "Ignore" 22 | } 23 | }, 24 | "code": { 25 | "legend": "Code", 26 | "prefix": "Prefix", 27 | "prefix_hint": "\"AL\" if using c:geo", 28 | "stage_separator": "Add separator before stage suffix (\"LCxxxx-1\")", 29 | "custom_code_template": "Custom Code Template", 30 | "custom_code_template_hint": "leave empty for automatic. See Wiki:" 31 | }, 32 | "personalization": { 33 | "legend": "Personalization", 34 | "user_guid": "Calling user's public GUID", 35 | "user_guid_hint": "Go to https://www.geocaching.com/find/default.aspx and look up your own username to find this. The GUID is included at the end of the URL of the resulting page. (...?guid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx)
Leave empty if you don't care about found state", 36 | "completed": "Include fully completed labs", 37 | "partial": "Include partially completed labs", 38 | "not_started": "Include unstarted labs" 39 | }, 40 | "description": { 41 | "legend": "Description", 42 | "include_question": "Include Waypoint question in Cache description", 43 | "include_waypoint_description": "Include description of the Waypoint in Cache description", 44 | "include_adventure_lab_description": "Include the description of the Adventure Lab in the Cache description" 45 | }, 46 | "exclude": { 47 | "legend": "Exclude", 48 | "owner": "Exclude by Owner name", 49 | "owner_hint": "Separated by new line, comma or semicolon", 50 | "name": "Exclude by Adventure Lab name", 51 | "name_hint": "Separated by new line, comma or semicolon. Excludes names that contain the entered words", 52 | "uuids": "UUIDs to exclude", 53 | "uuids_hint": "Advanced feature, use only if you know what you are doing. See #44 for details" 54 | }, 55 | "quirks": { 56 | "legend": "Quirks & Fixes", 57 | "l4ctype": "Geocache Type Fix for L4C", 58 | "bom2csv": "Add BOM to cachetur.no CSV file (for Excel)" 59 | }, 60 | "download": { 61 | "legend": "Download", 62 | "format_label": "Output Format", 63 | "format": { 64 | "zippedgpx": "Zipped GPX", 65 | "gpx": "GPX", 66 | "zippedgpxwpt": "Zipped GPX with Waypoints", 67 | "gpxwpt": "GPX with Waypoints", 68 | "cacheturdotno": "Cachetur.no Bulk Add Waypoints" 69 | } 70 | }, 71 | "validation": { 72 | "check": "There are errors. Please check double check your settings", 73 | "limit": "Number >= 0", 74 | "prefix": "1-3 Chars" 75 | } 76 | }, 77 | "downloader": { 78 | "please_wait": "Downloading, please wait...", 79 | "wait": [ 80 | "This may take a while.", 81 | "Don't lose patience.", 82 | "The journey is the destination.", 83 | "Almost there.", 84 | "Just a few more bytes." 85 | ] 86 | }, 87 | "search": { 88 | "locate": { 89 | "not_available": "You Browser does not support Geolocation.", 90 | "no_position": "Position could not be determined.", 91 | "current_position": "Current position" 92 | }, 93 | "coordinates": "Coordinates/Location", 94 | "coordinates_placeholder": "Search for coordinates or location…", 95 | "radius": "Radius in km" 96 | } 97 | } -------------------------------------------------------------------------------- /frontend/src/locales/de.json: -------------------------------------------------------------------------------- 1 | { 2 | "language": "Sprache", 3 | "ok": "Ok", 4 | "cancel": "Abbrechen", 5 | "save": "Speichern", 6 | "save_and_download": "Speichern und Downloaden", 7 | "settings": { 8 | "header": "Einstellungen", 9 | "general": { 10 | "legend": "Allgemein", 11 | "limit": "Max. Anzahl", 12 | "limit_hint": "0 = kein Limit, ACHTUNG: der Download kann ohne Limit sehr sehr lange dauern und auch mit timeout abbrechen. ggf. Radius verkleinern oder Limit passend wählen", 13 | "cache_type": "Cache Typ", 14 | "cache_type_hint": "Garmin GPS Geräte unterstützen keine Adventure Labs. Vielleicht willst du sie lieber als Virtuelle- oder Event Caches exportieren.", 15 | "linear_label": "Lineare Adventure Labs", 16 | "linear": { 17 | "default": "Standard", 18 | "first": "Nur die erste/nächste Station", 19 | "mark": "Markieren mit [L] im Namen", 20 | "corrected": "als korrigierte Koordinaten", 21 | "ignore": "Ausschließen" 22 | } 23 | }, 24 | "code": { 25 | "legend": "Code", 26 | "prefix": "Präfix", 27 | "prefix_hint": "\"AL\" für c:geo", 28 | "stage_separator": "Trennzeichen vor Stage-Suffix (\"LCxxxx-1\")", 29 | "custom_code_template": "Custom Code Template", 30 | "custom_code_template_hint": "leer lassen für automatisch. Siehe Wiki:" 31 | }, 32 | "personalization": { 33 | "legend": "Personalisierung", 34 | "user_guid": "Öffentliche GUID für den API-Abruf", 35 | "user_guid_hint": "Rufe die Seite https://www.geocaching.com/find/default.aspx auf und suche nach deinem Benutzername. Die GUID findest du am Ende der URL nach der Suche. (...?guid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx)", 36 | "completed": "Komplett abgeschlossene Labs einschließen", 37 | "partial": "Teilweise abgeschlossene Labs einschließen", 38 | "not_started": "Nicht begonnene Labs einschließen" 39 | }, 40 | "description": { 41 | "legend": "Beschreibung", 42 | "include_question": "Frage zur Station in Beschreibung einfügen", 43 | "include_waypoint_description": "Beschreibung der Station in Cache Beschreibung einfügen", 44 | "include_adventure_lab_description": "Beschreibung des Adventure Labs in Cache Beschreibung einfügen" 45 | }, 46 | "exclude": { 47 | "legend": "Ausschließen", 48 | "owner": "nach Owner Name ausschließen", 49 | "owner_hint": "Trennung durch neue Zeile, Komma or Semikolon", 50 | "name": "nach Adventure Lab name ausschließen", 51 | "name_hint": "Trennung durch neue Zeile, Komma or Semikolon. Schließt Labs aus, deren Name Teile der genannten Wörter enthalten", 52 | "uuids": "UUIDs ausschließen", 53 | "uuids_hint": "Erweiterte Funktion, nur verwenden, wenn du weißt, was es admit auf sich hat.\n Siehe #44" 54 | }, 55 | "quirks": { 56 | "legend": "Quirks & Fixes", 57 | "l4ctype": "Geocache Type Fix für L4C", 58 | "bom2csv": "BOM zur cachetur.no CSV Datei hinzufügen (für Excel)" 59 | }, 60 | "download": { 61 | "legend": "Download", 62 | "format_label": "Ausgabeformat", 63 | "format": { 64 | "zippedgpx": "Gezipptes GPX", 65 | "gpx": "GPX", 66 | "zippedgpxwpt": "Gezipptes GPX mit Wegpunkten", 67 | "gpxwpt": "GPX mit Wegpunkten", 68 | "cacheturdotno": "Cachetur.no Bulk Add Waypoints" 69 | } 70 | }, 71 | "validation": { 72 | "check": "Es sind Fehler aufgetreten. Bitte prüfe deine Einstellungen.", 73 | "limit": "Zahl >= 0", 74 | "prefix": "1-3 Zeichen" 75 | } 76 | }, 77 | "downloader": { 78 | "please_wait": "Download, bitte warten…", 79 | "wait": [ 80 | "Das kann eine Weile dauern.", 81 | "Nicht die Gedult verlieren.", 82 | "Der Weg ist das Ziel.", 83 | "Gleich geschafft.", 84 | "Nur noch ein paar Byte." 85 | ] 86 | }, 87 | "search": { 88 | "locate": { 89 | "not_available": "Dein Browser unterstützt keine Geolocation.", 90 | "no_position": "Position konnte nicht ermittelt werden.", 91 | "current_position": "Aktuelle Position" 92 | }, 93 | "coordinates": "Koordinaten/Ort", 94 | "coordinates_placeholder": "Suche nach Koordinaten oder Ort…", 95 | "radius": "Radius in km" 96 | } 97 | } -------------------------------------------------------------------------------- /api/src/Model/AdventureLabApiClient.php: -------------------------------------------------------------------------------- 1 | client)) { 34 | return $this->client; 35 | } 36 | 37 | $config = [ 38 | 'base_uri' => 'https://labs-api.geocaching.com', 39 | 'headers' => [ 40 | 'User-Agent' => 'Adventures/1.3.4 (2408) (ios/14.6)', 41 | 'Accept' => 'application/json', 42 | 'X-Consumer-Key' => $this->consumerKey, 43 | ], 44 | 'http_errors' => false, 45 | ]; 46 | 47 | $this->client = new Client($config); 48 | 49 | return $this->client; 50 | } 51 | 52 | /** @return array|string */ 53 | private function decodeResponse(ResponseInterface $response): array|string 54 | { 55 | if ($response->getStatusCode() === 404) { 56 | throw new NotFoundHttpException(sprintf('Got status %d from labs-api', $response->getStatusCode())); 57 | } 58 | 59 | if ($response->getStatusCode() !== 200) { 60 | $code = 0; 61 | // the (strange) response is: 62 | // {"Message":"Could not adventures from AdventuresApi. Adventure 9ff5ceb0-c58b-4183-899a-1fbb1bd6c2c0 with player "} 63 | if (stripos($response->getBody()->getContents(), 'Could not adventures from AdventuresApi') !== false) { 64 | $code = BadGatewayHttpException::POSSIBLE_ARCHIVED; 65 | } 66 | 67 | throw new BadGatewayHttpException(sprintf('Got status %d from labs-api', $response->getStatusCode()), $code); 68 | } 69 | 70 | $content = $response->getBody()->getContents(); 71 | if (! $content) { 72 | throw new BadGatewayHttpException('Empty response from labs-api'); 73 | } 74 | 75 | $decoded = json_decode($content, true); 76 | if (! $decoded) { 77 | throw new BadGatewayHttpException('Json decoding of response from labs-api failed'); 78 | } 79 | 80 | return $decoded; 81 | } 82 | 83 | /** 84 | * @param array|string $data 85 | * 86 | * @return array|string 87 | */ 88 | private function post(string $url, array|string $data): array|string 89 | { 90 | $response = $this->getClient()->post($url, [ 91 | 'body' => json_encode($data), 92 | 'headers' => ['Content-Type' => 'application/json'], 93 | ]); 94 | 95 | return $this->decodeResponse($response); 96 | } 97 | 98 | /** @return array */ 99 | private function get(string $url): array 100 | { 101 | $response = $this->getClient()->get($url); 102 | 103 | return (array) $this->decodeResponse($response); 104 | } 105 | 106 | public function getAdventureIdBySmartLink(string $link): string 107 | { 108 | $result = $this->post('/Api/Adventures/GetAdventureIdBySmartLink', $link); 109 | assert(is_string($result)); 110 | 111 | return $result; 112 | } 113 | 114 | /** @return array */ 115 | public function getAdventureById(string $id, string|null $userGuid): array 116 | { 117 | return $this->get('Api/Adventures/' . $id . ($userGuid ? '?callerGuid=' . $userGuid : '')); 118 | } 119 | 120 | /** 121 | * @param string[] $completionStatuses 122 | * 123 | * @return array 124 | */ 125 | public function searchV4( 126 | Coordinates $coordinates, 127 | float $radius, 128 | array $completionStatuses, 129 | string|null $userGuid, 130 | int $skip = 0, 131 | int $take = 300, 132 | ): array { 133 | $data = [ 134 | 'Origin' => ['Latitude' => $coordinates->lat, 'Longitude' => $coordinates->lon], 135 | 'RadiusInMeters' => ceil($radius * 1000), 136 | 'skip' => $skip, 137 | 'take' => $take, 138 | ]; 139 | if ($userGuid) { 140 | $data = array_merge($data, [ 141 | 'CallingUserPublicGuid' => $userGuid, 142 | 'CompletionStatuses' => $completionStatuses, 143 | ]); 144 | } 145 | 146 | $result = $this->post('/Api/Adventures/SearchV4', $data); 147 | assert(is_array($result)); 148 | 149 | return $result; 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /api/src/Controller/DownloadController.php: -------------------------------------------------------------------------------- 1 | getContent(); 46 | // GSAK's PostUrl() can only send Content-Type: application/x-www-form-urlencoded 47 | if ($request->getContentTypeFormat() === 'form') { 48 | $json = json_encode($request->request->all()); 49 | } 50 | 51 | try { 52 | $settings = $this->serializer->deserialize( 53 | $json, 54 | Settings::class, 55 | 'json', 56 | [AbstractObjectNormalizer::DISABLE_TYPE_ENFORCEMENT => $request->getContentTypeFormat() === 'form'], 57 | ); 58 | } catch (NotNormalizableValueException $e) { 59 | return $this->json( 60 | [ 61 | 'error' => 'Validation Error', 62 | 'errors' => [ 63 | $e->getPath() => [ 64 | sprintf('This value has to be "%s", "%s" given.', implode('|', $e->getExpectedTypes() ?? []), $e->getCurrentType() ?? ''), 65 | ], 66 | ], 67 | ], 68 | Response::HTTP_BAD_REQUEST, 69 | ); 70 | } catch (NotEncodableValueException $e) { 71 | return $this->json( 72 | [ 73 | 'error' => 'Invalid JSON.', 74 | 'message' => $e->getMessage(), 75 | ], 76 | Response::HTTP_BAD_REQUEST, 77 | ); 78 | } 79 | 80 | $violations = $this->validator->validate($settings); 81 | 82 | if (count($violations) > 0) { 83 | $errors = []; 84 | foreach ($violations as $violation) { 85 | $errors[$violation->getPropertyPath()][] = $violation->getMessage(); 86 | } 87 | 88 | return $this->json( 89 | [ 90 | 'error' => 'Validation Error', 91 | 'errors' => $errors, 92 | ], 93 | Response::HTTP_UNPROCESSABLE_ENTITY, 94 | ); 95 | } 96 | 97 | $file = $this->exportGenerator->generateFile($settings); 98 | 99 | switch ($settings->outputFormat) { 100 | case OutputFormat::GPX: 101 | case OutputFormat::ZIPPED_GPX: 102 | $fileName = 'lab2gpx.gpx'; 103 | break; 104 | case OutputFormat::GPX_WPT: 105 | case OutputFormat::ZIPPED_GPX_WPT: 106 | $fileName = 'lab2gpx_wpt.gpx'; 107 | break; 108 | case OutputFormat::CACHETURDOTNO: 109 | $fileName = 'lab2gpx_cacheturdotno.csv'; 110 | break; 111 | } 112 | 113 | if (str_contains($settings->outputFormat->value, 'zipped')) { 114 | return new StreamedResponse(static function () use ($file, $fileName): void { 115 | $zip = new ZipStream( 116 | outputName: pathinfo($fileName, PATHINFO_FILENAME) . '.zip', 117 | ); 118 | $zip->addFile($fileName, $file); 119 | $zip->finish(); 120 | }); 121 | } 122 | 123 | $response = new Response($file); 124 | $response->headers->add(['Content-Disposition' => 'attachment; filename=' . basename($fileName)]); 125 | $response->headers->add(['Content-Type' => 'application/octet-stream']); 126 | $response->headers->add(['Content-Length' => strlen($file)]); 127 | 128 | return $response; 129 | } 130 | } 131 | -------------------------------------------------------------------------------- /api/templates/gpxwaypoints.xml.twig: -------------------------------------------------------------------------------- 1 | {% autoescape 'xml' %} 2 | 3 | 4 | Adventure Labs 5 | (HasChildren) 6 | {# @var settings \App\Model\Dto\Settings #} 7 | {# @var adventureLab array #} 8 | {% for adventureLab in adventureLabs %} 9 | {% set code = getCode(settings, adventureLab, 0) %} 10 | 11 | 12 | {{ code }} 13 | {{ adventureLab.Title }} 14 | {{ adventureLab.DeepLink }} 15 | {{ adventureLab.Title }} 16 | Geocache{% if adventureLab.IsComplete %} Found{% endif %} 17 | Geocache|{{ settings.cacheType.value }} 18 | 19 | {{ code }} 20 | false 21 | 0 22 | false 23 | {{ adventureLab.Id }} 24 | false 25 | false 26 | {% if adventureLab.IsLinear and settings.linear == constant('App\\Model\\Dto\\Linear::CORRECTED') %} 27 | ' . {{ adventureLab.Location.Latitude }} . ' 28 | ' . {{ adventureLab.Location.Longitude }} . ' 29 | {% endif %} 30 | 31 | 32 | {{ adventureLab.Title }} 33 | {{ adventureLab.OwnerUsername }} 34 | {{ adventureLab.OwnerUsername }} 35 | {% if settings.quirksL4Ctype %}Geocache|{% endif %}{{ settings.cacheType.value }} 36 | Virtual 37 | 38 | 1 39 | 1 40 | 41 | 42 | 43 | 44 | {% set description %} 45 | {% include 'partials/description-waypoints.html.twig' %} 46 | {% endset %} 47 | {# without manual escaping it is not escaped at all, with escaping it's escaped twice? so we use the raw result of the manually escaped description #} 48 | {{ description|e('xml')|raw }} 49 | 50 | 51 | 52 | 53 | 54 | 55 | {% set stage = 0 %} 56 | {% set stagesIncluded = 0 %} 57 | {% for wpt in adventureLab.GeocacheSummaries %} 58 | {% set stage = stage + 1 %} 59 | {# next two conditions are a bit odd but the is no continue or break in twig #} 60 | {% if not shouldSkipStage(settings, wpt) %} 61 | {% if not adventureLab.IsLinear or settings.linear != constant('App\\Model\\Dto\\Linear::FIRST') or stagesIncluded == 0 %} 62 | {% set stagesIncluded = stagesIncluded + 1 %} 63 | {% set wptCode = getCode(settings, adventureLab, stage, true) %} 64 | 65 | 66 | {{ wptCode }} 67 | {{ wpt.Question }} 68 | {{ adventureLab.DeepLink }} 69 | {{ formatStageForDisplay(stage, adventureLab) }} {{ wpt.Title }} 70 | Virtual Stage 71 | Waypoint|Virtual Stage 72 | 73 | {{ code }} 74 | 75 | 76 | {% endif %} 77 | {% endif %} 78 | {% endfor %} 79 | {% endfor %} 80 | 81 | {% endautoescape %} 82 | -------------------------------------------------------------------------------- /api/templates/gpx.xml.twig: -------------------------------------------------------------------------------- 1 | {%- macro getWaypointTitle(settings, adventureLab, wpt, stage) -%} 2 | {%- if adventureLab.IsLinear and settings.linear == constant('App\\Model\\Dto\\Linear::MARK') %}[L] {% endif -%} 3 | {{ adventureLab.Title }} : S{{ formatStageForDisplay(stage, adventureLab) }} {{ wpt.Title }} 4 | {%- endmacro -%} 5 | {% autoescape 'xml' %} 6 | 7 | 8 | Adventure Labs 9 | {# @var settings \App\Model\Dto\Settings #} 10 | {# @var adventureLab array #} 11 | {% for adventureLab in adventureLabs %} 12 | {% set stage = 0 %} 13 | {% set stagesIncluded = 0 %} 14 | {% for wpt in adventureLab.GeocacheSummaries %} 15 | {% set stage = stage + 1 %} 16 | {# next two conditions are a bit odd but the is no continue or break in twig #} 17 | {% if not shouldSkipStage(settings, wpt) %} 18 | {% if not adventureLab.IsLinear or settings.linear != constant('App\\Model\\Dto\\Linear::FIRST') or stagesIncluded == 0 %} 19 | {% set stagesIncluded = stagesIncluded + 1 %} 20 | {% set code = getCode(settings, adventureLab, stage) %} 21 | 22 | 23 | {{ code }} 24 | {{ wpt.Title }} 25 | {{ adventureLab.DeepLink }} 26 | S{{ formatStageForDisplay(stage, adventureLab) }} {{ adventureLab.Title }} 27 | Geocache{% if adventureLab.IsComplete or wpt.IsComplete %} Found{% endif %} 28 | Geocache|{{ settings.cacheType.value }} 29 | 30 | {{ code }} 31 | false 32 | 0 33 | false 34 | {{ wpt.Id }} 35 | false 36 | false 37 | {% if adventureLab.IsLinear and settings.linear == constant('App\\Model\\Dto\\Linear::CORRECTED') %} 38 | ' . {{ wpt.Location.Latitude }} . ' 39 | ' . {{ wpt.Location.Longitude }} . ' 40 | {% endif %} 41 | 42 | 43 | {{ adventureLab.Id }} 44 | {{ adventureLab.TotalGeocachesCount }} 45 | {{ adventureLab.CompletedGeocachesCount }} 46 | {{ adventureLab.AdventureThemes | join(',') }} 47 | {{ adventureLab.LAB2GPX_GCCodes | join(',') }} 48 | 49 | 50 | {{ _self.getWaypointTitle(settings, adventureLab, wpt, stage) }} 51 | {{ adventureLab.OwnerUsername }} 52 | {{ adventureLab.OwnerUsername }} 53 | {% if settings.quirksL4Ctype %}Geocache|{% endif %}{{ settings.cacheType.value }} 54 | Virtual 55 | 56 | 1 57 | 1 58 | 59 | 60 | 61 | 62 | {% set description %} 63 | {% include 'partials/description.html.twig' %} 64 | {% endset %} 65 | {# without manual escaping it is not escaped at all, with escaping it's escaped twice? so we use the raw result of the manually escaped description #} 66 | {{ description|e('xml')|raw }} 67 | 68 | 69 | 70 | 71 | 72 | 73 | {% endif %} 74 | {% endif %} 75 | {% endfor %} 76 | {% endfor %} 77 | 78 | {% endautoescape %} 79 | -------------------------------------------------------------------------------- /api/symfony.lock: -------------------------------------------------------------------------------- 1 | { 2 | "doctrine/deprecations": { 3 | "version": "1.1", 4 | "recipe": { 5 | "repo": "github.com/symfony/recipes", 6 | "branch": "main", 7 | "version": "1.0", 8 | "ref": "87424683adc81d7dc305eefec1fced883084aab9" 9 | } 10 | }, 11 | "phpstan/phpstan": { 12 | "version": "2.1", 13 | "recipe": { 14 | "repo": "github.com/symfony/recipes-contrib", 15 | "branch": "main", 16 | "version": "1.0", 17 | "ref": "5e490cc197fb6bb1ae22e5abbc531ddc633b6767" 18 | }, 19 | "files": [ 20 | "phpstan.dist.neon" 21 | ] 22 | }, 23 | "squizlabs/php_codesniffer": { 24 | "version": "3.13", 25 | "recipe": { 26 | "repo": "github.com/symfony/recipes-contrib", 27 | "branch": "main", 28 | "version": "3.6", 29 | "ref": "1019e5c08d4821cb9b77f4891f8e9c31ff20ac6f" 30 | }, 31 | "files": [ 32 | "phpcs.xml.dist" 33 | ] 34 | }, 35 | "symfony/console": { 36 | "version": "7.3", 37 | "recipe": { 38 | "repo": "github.com/symfony/recipes", 39 | "branch": "main", 40 | "version": "5.3", 41 | "ref": "1781ff40d8a17d87cf53f8d4cf0c8346ed2bb461" 42 | }, 43 | "files": [ 44 | "bin/console" 45 | ] 46 | }, 47 | "symfony/debug-bundle": { 48 | "version": "7.3", 49 | "recipe": { 50 | "repo": "github.com/symfony/recipes", 51 | "branch": "main", 52 | "version": "5.3", 53 | "ref": "5aa8aa48234c8eb6dbdd7b3cd5d791485d2cec4b" 54 | }, 55 | "files": [ 56 | "config/packages/debug.yaml" 57 | ] 58 | }, 59 | "symfony/flex": { 60 | "version": "2.8", 61 | "recipe": { 62 | "repo": "github.com/symfony/recipes", 63 | "branch": "main", 64 | "version": "2.4", 65 | "ref": "52e9754527a15e2b79d9a610f98185a1fe46622a" 66 | }, 67 | "files": [ 68 | ".env", 69 | ".env.dev" 70 | ] 71 | }, 72 | "symfony/framework-bundle": { 73 | "version": "7.3", 74 | "recipe": { 75 | "repo": "github.com/symfony/recipes", 76 | "branch": "main", 77 | "version": "7.3", 78 | "ref": "5a1497d539f691b96afd45ae397ce5fe30beb4b9" 79 | }, 80 | "files": [ 81 | "config/packages/cache.yaml", 82 | "config/packages/framework.yaml", 83 | "config/preload.php", 84 | "config/routes/framework.yaml", 85 | "config/services.yaml", 86 | "public/index.php", 87 | "src/Controller/.gitignore", 88 | "src/Kernel.php", 89 | ".editorconfig" 90 | ] 91 | }, 92 | "symfony/monolog-bundle": { 93 | "version": "3.10", 94 | "recipe": { 95 | "repo": "github.com/symfony/recipes", 96 | "branch": "main", 97 | "version": "3.7", 98 | "ref": "aff23899c4440dd995907613c1dd709b6f59503f" 99 | }, 100 | "files": [ 101 | "config/packages/monolog.yaml" 102 | ] 103 | }, 104 | "symfony/property-info": { 105 | "version": "7.3", 106 | "recipe": { 107 | "repo": "github.com/symfony/recipes", 108 | "branch": "main", 109 | "version": "7.3", 110 | "ref": "dae70df71978ae9226ae915ffd5fad817f5ca1f7" 111 | }, 112 | "files": [ 113 | "config/packages/property_info.yaml" 114 | ] 115 | }, 116 | "symfony/routing": { 117 | "version": "7.3", 118 | "recipe": { 119 | "repo": "github.com/symfony/recipes", 120 | "branch": "main", 121 | "version": "7.0", 122 | "ref": "21b72649d5622d8f7da329ffb5afb232a023619d" 123 | }, 124 | "files": [ 125 | "config/packages/routing.yaml", 126 | "config/routes.yaml" 127 | ] 128 | }, 129 | "symfony/translation": { 130 | "version": "7.3", 131 | "recipe": { 132 | "repo": "github.com/symfony/recipes", 133 | "branch": "main", 134 | "version": "6.3", 135 | "ref": "620a1b84865ceb2ba304c8f8bf2a185fbf32a843" 136 | }, 137 | "files": [ 138 | "config/packages/translation.yaml", 139 | "translations/.gitignore" 140 | ] 141 | }, 142 | "symfony/twig-bundle": { 143 | "version": "7.3", 144 | "recipe": { 145 | "repo": "github.com/symfony/recipes", 146 | "branch": "main", 147 | "version": "6.4", 148 | "ref": "cab5fd2a13a45c266d45a7d9337e28dee6272877" 149 | }, 150 | "files": [ 151 | "config/packages/twig.yaml", 152 | "templates/base.html.twig" 153 | ] 154 | }, 155 | "symfony/validator": { 156 | "version": "7.3", 157 | "recipe": { 158 | "repo": "github.com/symfony/recipes", 159 | "branch": "main", 160 | "version": "7.0", 161 | "ref": "8c1c4e28d26a124b0bb273f537ca8ce443472bfd" 162 | }, 163 | "files": [ 164 | "config/packages/validator.yaml" 165 | ] 166 | }, 167 | "symfony/web-profiler-bundle": { 168 | "version": "7.3", 169 | "recipe": { 170 | "repo": "github.com/symfony/recipes", 171 | "branch": "main", 172 | "version": "7.3", 173 | "ref": "a363460c1b0b4a4d0242f2ce1a843ca0f6ac9026" 174 | }, 175 | "files": [ 176 | "config/packages/web_profiler.yaml", 177 | "config/routes/web_profiler.yaml" 178 | ] 179 | }, 180 | "twig/extra-bundle": { 181 | "version": "v3.21.0" 182 | } 183 | } 184 | -------------------------------------------------------------------------------- /api/src/Model/AdventureLabDatabase.php: -------------------------------------------------------------------------------- 1 | $adventureLab 31 | * 32 | * @return array 33 | */ 34 | public function updateAdventureLabData(array $adventureLab): array 35 | { 36 | $labUuid = $adventureLab['Id']; 37 | 38 | $row = $this->findLabByUuid($labUuid); 39 | $labUrl = $this->extractLabUrl($adventureLab['DeepLink']); 40 | 41 | if ($row) { 42 | $this->updateLabIfNeeded($row, [ 43 | 'url' => $labUrl, 44 | 'title' => $adventureLab['Title'], 45 | 'lat' => $adventureLab['Location']['Latitude'], 46 | 'lon' => $adventureLab['Location']['Longitude'], 47 | ]); 48 | } else { 49 | $row = $this->insertNewLab([ 50 | 'uuid' => $labUuid, 51 | 'url' => $labUrl, 52 | 'title' => $adventureLab['Title'], 53 | 'lat' => $adventureLab['Location']['Latitude'], 54 | 'lon' => $adventureLab['Location']['Longitude'], 55 | ]); 56 | } 57 | 58 | $adventureLab['LAB2GPX_ID'] = self::ID_OFFSET_IN_GPX + (int) $row['id']; 59 | $adventureLab['LAB2GPX_CODE'] = $row['code']; 60 | 61 | foreach ($adventureLab['GeocacheSummaries'] as $index => $waypoint) { 62 | $waypointRow = $this->findLabByUuid($waypoint['Id']); 63 | 64 | if (! $waypointRow) { 65 | $waypointRow = $this->insertNewLab([ 66 | 'uuid' => $waypoint['Id'], 67 | 'parent' => $labUuid, 68 | 'title' => $waypoint['Title'], 69 | 'lat' => $waypoint['Location']['Latitude'], 70 | 'lon' => $waypoint['Location']['Longitude'], 71 | ]); 72 | } 73 | 74 | $adventureLab['GeocacheSummaries'][$index]['LAB2GPX_ID'] = self::ID_OFFSET_IN_GPX + (int) $waypointRow['id']; 75 | $adventureLab['GeocacheSummaries'][$index]['LAB2GPX_CODE'] = $waypointRow['code']; 76 | } 77 | 78 | return $adventureLab; 79 | } 80 | 81 | /** @return array|null */ 82 | public function findLabByUuid(string $uuid): array|null 83 | { 84 | $stmt = $this->getConnection()->prepare('SELECT * FROM adventure_labs WHERE uuid = :uuid'); 85 | $stmt->execute(['uuid' => $uuid]); 86 | $row = $stmt->fetch(PDO::FETCH_ASSOC); 87 | 88 | return $row ?: null; 89 | } 90 | 91 | /** @return array|null */ 92 | public function findLabByCode(string $code): array|null 93 | { 94 | $stmt = $this->getConnection()->prepare('SELECT * FROM adventure_labs WHERE code = :code'); 95 | $stmt->execute(['code' => $code]); 96 | $row = $stmt->fetch(PDO::FETCH_ASSOC); 97 | 98 | return $row ?: null; 99 | } 100 | 101 | private function extractLabUrl(string $deepLink): string 102 | { 103 | return str_replace(self::DEEPLINK_ULR_TO_REMOVE, '', $deepLink); 104 | } 105 | 106 | /** 107 | * @param array $row 108 | * @param array $data 109 | */ 110 | private function updateLabIfNeeded(array &$row, array $data): void 111 | { 112 | $updateNeeded = false; 113 | 114 | foreach ($data as $field => $value) { 115 | if ($row[$field] !== null) { 116 | continue; 117 | } 118 | 119 | $row[$field] = $value; 120 | $updateNeeded = true; 121 | } 122 | 123 | if (! $updateNeeded) { 124 | return; 125 | } 126 | 127 | $stmt = $this->getConnection()->prepare('UPDATE adventure_labs SET url = :url, title = :title, lat = :lat, lon = :lon WHERE id = :id'); 128 | $stmt->execute([ 129 | 'id' => $row['id'], 130 | 'url' => $row['url'], 131 | 'title' => $row['title'], 132 | 'lat' => $row['lat'], 133 | 'lon' => $row['lon'], 134 | ]); 135 | } 136 | 137 | /** 138 | * @param array $data 139 | * 140 | * @return array 141 | */ 142 | private function insertNewLab(array $data): array 143 | { 144 | $pdo = $this->getConnection(); 145 | $pdo->beginTransaction(); 146 | 147 | $fields = array_keys($data); 148 | $placeholders = array_map(static fn ($field) => sprintf(':%s', $field), $fields); 149 | 150 | $sql = sprintf( 151 | 'INSERT INTO adventure_labs (%s) VALUES (%s)', 152 | implode(', ', $fields), 153 | implode(', ', $placeholders), 154 | ); 155 | 156 | $stmt = $pdo->prepare($sql); 157 | $stmt->execute($data); 158 | 159 | $id = (int) $pdo->lastInsertId(); 160 | $code = Base31Util::convertToBase31($id); 161 | 162 | $stmt = $pdo->prepare('UPDATE adventure_labs SET code = :code WHERE id = :id'); 163 | $stmt->execute(['code' => $code, 'id' => $id]); 164 | 165 | $pdo->commit(); 166 | 167 | return [ 168 | 'id' => $id, 169 | 'code' => $code, 170 | ]; 171 | } 172 | 173 | private function getConnection(): PDO 174 | { 175 | if (isset($this->connection)) { 176 | return $this->connection; 177 | } 178 | 179 | $dbPath = $this->dataDir . '/lab2gpx.sqlite'; 180 | if (! file_exists($dbPath)) { 181 | throw new RuntimeException('Database not found!'); 182 | } 183 | 184 | $pdo = new PDO('sqlite:' . $dbPath); 185 | $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); 186 | $this->connection = $pdo; 187 | 188 | return $pdo; 189 | } 190 | } 191 | -------------------------------------------------------------------------------- /api/src/Model/Dto/Settings.php: -------------------------------------------------------------------------------- 1 | excludeOwner; 70 | } 71 | 72 | public function setExcludeOwner(string|null $excludeOwner): Settings 73 | { 74 | $this->excludeOwner = $excludeOwner; 75 | $this->normalizedExcludeOwners = null; 76 | 77 | return $this; 78 | } 79 | 80 | public function getExcludeNames(): string|null 81 | { 82 | return $this->excludeNames; 83 | } 84 | 85 | public function setExcludeNames(string|null $excludeNames): Settings 86 | { 87 | $this->excludeNames = $excludeNames; 88 | $this->normalizedExcludeNames = null; 89 | 90 | return $this; 91 | } 92 | 93 | public function getExcludeUuids(): string|null 94 | { 95 | return $this->excludeUuids; 96 | } 97 | 98 | public function setExcludeUuids(string|null $excludeUuids): Settings 99 | { 100 | $this->excludeUuids = $excludeUuids; 101 | $this->normalizedExcludeUuids = null; 102 | 103 | return $this; 104 | } 105 | 106 | public function getUuidsToFetch(): string|null 107 | { 108 | return $this->uuidsToFetch; 109 | } 110 | 111 | public function setUuidsToFetch(string|null $uuids): Settings 112 | { 113 | $this->uuidsToFetch = $uuids; 114 | $this->normalizedUuidsToFetch = null; 115 | 116 | return $this; 117 | } 118 | 119 | public bool $quirksL4Ctype = false; 120 | public bool $quirksBomForCsv = false; 121 | public OutputFormat $outputFormat = OutputFormat::ZIPPED_GPX; 122 | 123 | public function getGroupSequence(): array|GroupSequence 124 | { 125 | $groups = ['Settings']; 126 | 127 | if ($this->customCodeTemplate === null) { 128 | $groups[] = 'WithoutCustomCodeTemplate'; 129 | } 130 | 131 | return $groups; 132 | } 133 | 134 | #[Assert\Callback] 135 | public function validateCompletionStatusesUnique(ExecutionContextInterface $context): void 136 | { 137 | $values = $this->completionStatuses; 138 | if (count($values) === count(array_unique($values))) { 139 | return; 140 | } 141 | 142 | $context->buildViolation('Jeder Status darf nur einmal vorkommen.') 143 | ->atPath('completionStatuses') 144 | ->addViolation(); 145 | } 146 | 147 | /** @var string[]|null */ 148 | private array|null $normalizedExcludeOwners = null; 149 | 150 | /** @var string[]|null */ 151 | private array|null $normalizedExcludeNames = null; 152 | 153 | /** @var string[]|null */ 154 | private array|null $normalizedExcludeUuids = null; 155 | 156 | /** @var string[]|null */ 157 | private array|null $normalizedUuidsToFetch = null; 158 | 159 | /** @return string[] */ 160 | private function splitExludeField(string $string): array 161 | { 162 | $string = str_replace("\r\n", "\n", $string); 163 | $string = str_replace("\r", "\n", $string); 164 | $string = str_replace(',', "\n", $string); 165 | $string = str_replace(';', "\n", $string); 166 | 167 | return array_unique(array_map('trim', array_filter(explode("\n", $string)))); 168 | } 169 | 170 | /** @return string[] */ 171 | public function getNormalizedExcludeOwners(): array 172 | { 173 | if ($this->normalizedExcludeOwners !== null) { 174 | return $this->normalizedExcludeOwners; 175 | } 176 | 177 | $this->normalizedExcludeOwners = $this->excludeOwner ? $this->splitExludeField($this->excludeOwner) : []; 178 | 179 | return $this->normalizedExcludeOwners; 180 | } 181 | 182 | /** @return string[] */ 183 | public function getNormalizedExcludeNames(): array 184 | { 185 | if ($this->normalizedExcludeNames !== null) { 186 | return $this->normalizedExcludeNames; 187 | } 188 | 189 | $this->normalizedExcludeNames = $this->excludeNames ? $this->splitExludeField($this->excludeNames) : []; 190 | 191 | return $this->normalizedExcludeNames; 192 | } 193 | 194 | /** @return string[] */ 195 | public function getNormalizedExcludeUuids(): array 196 | { 197 | if ($this->normalizedExcludeUuids !== null) { 198 | return $this->normalizedExcludeUuids; 199 | } 200 | 201 | $this->normalizedExcludeUuids = $this->excludeUuids ? $this->splitExludeField($this->excludeUuids) : []; 202 | 203 | return $this->normalizedExcludeUuids; 204 | } 205 | 206 | /** @return string[] */ 207 | public function getNormalizedUuidsToFetch(): array 208 | { 209 | if ($this->normalizedUuidsToFetch !== null) { 210 | return $this->normalizedUuidsToFetch; 211 | } 212 | 213 | $this->normalizedUuidsToFetch = $this->uuidsToFetch ? $this->splitExludeField($this->uuidsToFetch) : []; 214 | 215 | return $this->normalizedUuidsToFetch; 216 | } 217 | } 218 | -------------------------------------------------------------------------------- /api/src/Model/ExportGenerator.php: -------------------------------------------------------------------------------- 1 | settings = $settings; 55 | $this->localeProvider->setLocale($settings->locale->value); 56 | $labs = []; 57 | if ($this->settings->getNormalizedUuidsToFetch()) { 58 | $this->fetchLabsByUuuids($labs); 59 | } else { 60 | $this->fetchLabs($labs); 61 | } 62 | 63 | switch ($settings->outputFormat) { 64 | case OutputFormat::GPX: 65 | case OutputFormat::ZIPPED_GPX: 66 | $template = 'gpx.xml.twig'; 67 | break; 68 | case OutputFormat::GPX_WPT: 69 | case OutputFormat::ZIPPED_GPX_WPT: 70 | $template = 'gpxwaypoints.xml.twig'; 71 | break; 72 | case OutputFormat::CACHETURDOTNO: 73 | $template = 'cacheturdotno.csv.twig'; 74 | break; 75 | } 76 | 77 | $file = $this->twig->render($template, [ 78 | 'settings' => $settings, 79 | 'adventureLabs' => $labs, 80 | ]); 81 | 82 | if ($this->settings->quirksBomForCsv && $this->settings->outputFormat === OutputFormat::CACHETURDOTNO) { 83 | $file = "\xEF\xBB\xBF" . $file; 84 | } 85 | 86 | return $file; 87 | } 88 | 89 | /** @return array|null */ 90 | private function getCachedAdventureLab(string $id): array|null 91 | { 92 | $file = $this->cacheDir . '/' . $id . '.json'; 93 | if (file_exists($file) && filemtime($file) > time() - $this->cacheTtl) { 94 | $json = @file_get_contents($file); 95 | if (! $json) { 96 | return null; 97 | } 98 | 99 | $result = json_decode($json, true); 100 | if (! $result) { 101 | return null; 102 | } 103 | 104 | return $result; 105 | } 106 | 107 | return null; 108 | } 109 | 110 | /** @param array $adventureLab */ 111 | private function saveCachedAdventureLab(array $adventureLab): void 112 | { 113 | $file = $this->cacheDir . '/' . $adventureLab['Id'] . '.json'; 114 | file_put_contents($file, json_encode($adventureLab, JSON_PRETTY_PRINT)); 115 | } 116 | 117 | /** @param array $adventureLabSearchItem */ 118 | private function shouldSkipAdventureLabSearchItem(array $adventureLabSearchItem): bool 119 | { 120 | if (in_array($adventureLabSearchItem['Title'], $this->settings->getNormalizedExcludeNames())) { 121 | return true; 122 | } 123 | 124 | return in_array($adventureLabSearchItem['Id'], $this->settings->getNormalizedExcludeUuids()); 125 | } 126 | 127 | /** 128 | * this information is not in the search result, so we have to filter after fetching the details 129 | * 130 | * @param array $adventureLab 131 | */ 132 | private function shouldSkipAdventureLab(array $adventureLab): bool 133 | { 134 | if ($adventureLab['IsLinear'] && $this->settings->linear === Linear::IGNORE) { 135 | return true; 136 | } 137 | 138 | return in_array($adventureLab['OwnerUsername'], $this->settings->getNormalizedExcludeOwners()); 139 | } 140 | 141 | /** @param string[] $codes */ 142 | private function findAndLinkGcCodes(string $text, array &$codes): string 143 | { 144 | $pattern = '/(?' . $code . ''; 155 | }, 156 | $text, 157 | ); 158 | } 159 | 160 | /** 161 | * @param array $adventureLab 162 | * 163 | * @return array 164 | */ 165 | private function enrichAdventureLab(array $adventureLab): array 166 | { 167 | $adventureLab = $this->labCode->updateAdventureLabData($adventureLab); 168 | 169 | $gccodes = []; 170 | $adventureLab['LAB2GPX_Description'] = $this->findAndLinkGcCodes($adventureLab['Description'], $gccodes); 171 | foreach ($adventureLab['GeocacheSummaries'] as $k => $geocacheSummary) { 172 | $adventureLab['GeocacheSummaries'][$k]['LAB2GPX_Description'] = $this->findAndLinkGcCodes($geocacheSummary['Description'], $gccodes); 173 | } 174 | 175 | $adventureLab['LAB2GPX_GCCodes'] = $gccodes; 176 | 177 | return $adventureLab; 178 | } 179 | 180 | /** @param array $adventureLab */ 181 | private function setWaypointsFound(array &$adventureLab): void 182 | { 183 | $adventureLab['IsComplete'] = true; 184 | $adventureLab['CompletedGeocachesCount'] = $adventureLab['TotalGeocachesCount']; 185 | foreach ($adventureLab['GeocacheSummaries'] as $k => $geocacheSummary) { 186 | $adventureLab['GeocacheSummaries'][$k]['IsComplete'] = true; 187 | } 188 | } 189 | 190 | /** @param array $labs */ 191 | private function fetchLabs(array &$labs, int $skip = 0): void 192 | { 193 | $take = 300; 194 | $response = $this->adventureLabApiClient->searchV4($this->settings->coordinates, $this->settings->radius, $this->settings->completionStatuses, $this->settings->userGuid, $skip, $take); 195 | if (! isset($response['Items']) || ! count($response['Items']) > 0) { 196 | throw new NotFoundHttpException('No Adventure Labs in Search Result'); 197 | } 198 | 199 | foreach ($response['Items'] as $adventureLabSearchItem) { 200 | if ($this->settings->limit > 0 && count($labs) >= $this->settings->limit) { 201 | return; 202 | } 203 | 204 | if ($this->shouldSkipAdventureLabSearchItem($adventureLabSearchItem)) { 205 | continue; 206 | } 207 | 208 | // partially complete, we can only get this if you call this using a user guid, so do not cache this Adventure Lab result 209 | if ($adventureLabSearchItem['CompletionStatus'] !== self::COMPLETED_PARTIAL) { 210 | $cachedLab = $this->getCachedAdventureLab($adventureLabSearchItem['Id']); 211 | if ($cachedLab) { 212 | // if cached and fully complete, we have to correct completion state in cached result 213 | if ($adventureLabSearchItem['CompletionStatus'] === self::COMPLETED_FULL) { 214 | $this->setWaypointsFound($cachedLab); 215 | } 216 | 217 | if ($this->shouldSkipAdventureLab($cachedLab)) { 218 | continue; 219 | } 220 | 221 | $labs[] = $cachedLab; 222 | continue; 223 | } 224 | } 225 | 226 | @set_time_limit(10); 227 | 228 | try { 229 | if ($adventureLabSearchItem['CompletionStatus'] === self::COMPLETED_PARTIAL) { 230 | $adventureLab = $this->adventureLabApiClient->getAdventureById($adventureLabSearchItem['Id'], $this->settings->userGuid); 231 | } else { 232 | $adventureLab = $this->adventureLabApiClient->getAdventureById($adventureLabSearchItem['Id'], null); 233 | } 234 | } catch (BadGatewayHttpException $exception) { 235 | if ($exception->getCode() === BadGatewayHttpException::POSSIBLE_ARCHIVED) { 236 | continue; 237 | } 238 | 239 | throw $exception; 240 | } 241 | 242 | // just a very basic test, we have at least an Id in the array and not an error message in status code 200 243 | if (! isset($adventureLab['Id'])) { 244 | continue; 245 | } 246 | 247 | $adventureLab = $this->enrichAdventureLab($adventureLab); 248 | 249 | if ($adventureLabSearchItem['CompletionStatus'] !== self::COMPLETED_PARTIAL) { 250 | $this->saveCachedAdventureLab($adventureLab); 251 | } 252 | 253 | if ($adventureLabSearchItem['CompletionStatus'] === self::COMPLETED_FULL) { 254 | $this->setWaypointsFound($adventureLab); 255 | } 256 | 257 | if ($this->shouldSkipAdventureLab($adventureLab)) { 258 | continue; 259 | } 260 | 261 | $labs[] = $adventureLab; 262 | } 263 | 264 | $total = (int) $response['TotalCount']; 265 | if (count($labs) >= $total || $skip + $take >= $total) { 266 | return; 267 | } 268 | 269 | $this->fetchLabs($labs, $skip + $take); 270 | } 271 | 272 | /** @param array $labs */ 273 | private function fetchLabsByUuuids(array &$labs): void 274 | { 275 | foreach ($this->settings->getNormalizedUuidsToFetch() as $uuid) { 276 | $canCache = true; 277 | // if we have a user and want found or partial found we can not cache 278 | if ($this->settings->userGuid && (in_array('0', $this->settings->completionStatuses) || in_array('1', $this->settings->completionStatuses))) { 279 | $canCache = false; 280 | } 281 | 282 | if ($canCache) { 283 | $cachedLab = $this->getCachedAdventureLab($uuid); 284 | if ($cachedLab) { 285 | $labs[] = $cachedLab; 286 | continue; 287 | } 288 | } 289 | 290 | @set_time_limit(10); 291 | 292 | try { 293 | if ($this->settings->userGuid) { 294 | $adventureLab = $this->adventureLabApiClient->getAdventureById($uuid, $this->settings->userGuid); 295 | } else { 296 | $adventureLab = $this->adventureLabApiClient->getAdventureById($uuid, null); 297 | } 298 | } catch (BadGatewayHttpException $exception) { 299 | if ($exception->getCode() === BadGatewayHttpException::POSSIBLE_ARCHIVED) { 300 | continue; 301 | } 302 | 303 | throw $exception; 304 | } 305 | 306 | // just a very basic test, we have at least an Id in the array and not an error message in status code 200 307 | if (! isset($adventureLab['Id'])) { 308 | continue; 309 | } 310 | 311 | $adventureLab = $this->enrichAdventureLab($adventureLab); 312 | 313 | if ($canCache) { 314 | $this->saveCachedAdventureLab($adventureLab); 315 | } 316 | 317 | $labs[] = $adventureLab; 318 | } 319 | } 320 | } 321 | -------------------------------------------------------------------------------- /frontend/src/components/SettingsModal.vue: -------------------------------------------------------------------------------- 1 | 78 | 79 | 321 | 322 | 343 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------