Initial commit

.eslintrc.yml

@@ -0,0 +1,18 @@
+env:
+  es2020: true
+  worker: true
+extends: ["plugin:@typescript-eslint/recommended"]
+parser: "@typescript-eslint/parser"
+parserOptions:
+  ecmaVersion: 2020
+  ecmaFeatures:
+    impliedStrict: true
+  sourceType: module
+root: true
+rules:
+  indent: [error, 2, { SwitchCase: 1 }]
+  semi: [error, always]
+  quotes: [error, single, avoid-escape]
+  no-trailing-spaces: [error]
+  no-unused-vars: [error, { argsIgnorePattern: ^_ }]
+  prefer-const: [error, { destructuring: all }]

.github/workflows/deploy-master-to-prod.yml

@@ -0,0 +1,18 @@
+name: Deploy master on push
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: wrangler publish
+        uses: cloudflare/wrangler-action@1.3.0
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          environment: omaps
+
+# TODO: Add organicmaps deploy.

.gitignore

@@ -0,0 +1,3 @@
+# Autogenerated by esbuild.
+workers-site/index.js
+node_modules/

.nvmrc

@@ -0,0 +1 @@
+v14.17.0

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "arrowParens": "always"
+}

README.md

@@ -0,0 +1,52 @@
+# Static resources and short links (ge0) decoder for Organic Maps
+
+Root domain redirects to https://organicmaps.app/.
+
+URLs like `http(s)://omaps.app/ENCODEDCOORDINATES/PINNAME` are decoded to lat, lon and zoom level. Then the OSM
+map is displayed and url schemes are opened on mobile apps.
+
+Add some query parameters to test:
+
+- For dev environment:
+  - [http](http://url-processor.omaps.workers.dev/B4srhdHVVt/Some+Name)
+  - [https](https://url-processor.omaps.workers.dev/B4srhdHVVt/Some+Name)
+  - [http ru](http://url-processor.omaps.workers.dev/AwAAAAAAAA/%d0%9c%d0%b8%d0%bd%d1%81%d0%ba_%d1%83%d0%bb._%d0%9b%d0%b5%d0%bd%d0%b8%d0%bd%d0%b0_9)
+  - [https ru](https://url-processor.omaps.workers.dev/AwAAAAAAAA/%d0%9c%d0%b8%d0%bd%d1%81%d0%ba_%d1%83%d0%bb._%d0%9b%d0%b5%d0%bd%d0%b8%d0%bd%d0%b0_9)
+- For prod environment:
+  - [http](http://omaps.app/B4srhdHVVt/Some+Name)
+  - [https](https://omaps.app/B4srhdHVVt/Some+Name)
+  - [http ru](http://omaps.app/AwAAAAAAAA/%d0%9c%d0%b8%d0%bd%d1%81%d0%ba_%d1%83%d0%bb._%d0%9b%d0%b5%d0%bd%d0%b8%d0%bd%d0%b0_9)
+  - [https ru](https://omaps.app/AwAAAAAAAA/%d0%9c%d0%b8%d0%bd%d1%81%d0%ba_%d1%83%d0%bb._%d0%9b%d0%b5%d0%bd%d0%b8%d0%bd%d0%b0_9)
+
+[![Deploy master to Production](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/organicmaps/url-processor)
+
+## Requirements
+
+Install CloudFlare's wrangler and other dev dependencies using npm:
+
+```bash
+npm i
+```
+
+## Development
+
+Use `npx wrangler dev` for localhost development.
+
+## Preview on workers.dev
+
+Use `npx wrangler preview` to open and test deployed worker in browser.
+
+## Deployment
+
+All pushes to master automatically deploy dev version to https://url-processor.omaps.workers.dev/
+
+Deploy to prod manually using `npx wrangler publish --env omaps` or this
+[action](https://github.com/organicmaps/url-processor/actions/workflows/deploy-master-to-prod.yml).
+
+## Known issues
+
+- Cloudflare's free Flexible SSL certificates does not support 4-th level
+  subdomains like a.b.example.com, so you can see strange SSL errors.
+- HTTPS `fetch` requests from Workers are converted to HTTP ones if the target
+  host is in the same Cloudflare zone, see [here](https://community.cloudflare.com/t/does-cloudflare-worker-allow-secure-https-connection-to-fetch-even-on-flexible-ssl/68051/12)
+  for more details.

metadata.json

@@ -0,0 +1 @@
+{ "version": 1 }

package.json

@@ -0,0 +1,27 @@
+{
+  "private": true,
+  "name": "omaps-url-handler",
+  "version": "1.0.0",
+  "description": "Processes specific HTTP requests to domains",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "esbuild src/index.ts --bundle --outfile=workers-site/index.js",
+    "test": "eslint src/**/*.ts && tsc --noEmit",
+    "format": "prettier --write 'src/**/*.{ts,tsx,json}'"
+  },
+  "author": "Alexander Borsuk <me@alex.bio>",
+  "license": "MIT",
+  "devDependencies": {
+    "@cloudflare/workers-types": "^2.2.2",
+    "@cloudflare/wrangler": "^1.16.1",
+    "@typescript-eslint/eslint-plugin": "^4.24.0",
+    "@typescript-eslint/parser": "^4.24.0",
+    "esbuild": "^0.12.1",
+    "eslint": "^7.26.0",
+    "prettier": "^2.3.0",
+    "typescript": "^4.2.4"
+  },
+  "dependencies": {
+    "@cloudflare/kv-asset-handler": "^0.1.2"
+  }
+}

public/.well-known/apple-app-site-association

@@ -0,0 +1,28 @@
+{
+  "applinks": {
+    "apps": [],
+    "details": [
+      {
+        "appID": "9Z6432XD7L.app.organicmaps",
+        "paths": [
+          "NOT /",
+          "*"
+        ]
+      },
+      {
+        "appID": "9Z6432XD7L.app.organicmaps.debug",
+        "paths": [
+          "NOT /",
+          "*"
+        ]
+      },
+      {
+        "appID": "9Z6432XD7L.app.organicmaps.beta",
+        "paths": [
+          "NOT /",
+          "*"
+        ]
+      }
+    ]
+  }
+}

public/.well-known/assetlinks.json

@@ -0,0 +1,38 @@
+[
+  {
+    "relation": [
+      "delegate_permission/common.handle_all_urls"
+    ],
+    "target": {
+      "namespace": "android_app",
+      "package_name": "app.organicmaps",
+      "sha256_cert_fingerprints": [
+        "B9:C7:AE:79:A5:A9:02:70:DF:08:A1:32:E5:36:B9:C6:66:F5:BE:F1:F5:9B:30:4F:CE:CF:86:87:86:5E:4B:5B"
+      ]
+    }
+  },
+  {
+    "relation": [
+      "delegate_permission/common.handle_all_urls"
+    ],
+    "target": {
+      "namespace": "android_app",
+      "package_name": "app.organicmaps.beta",
+      "sha256_cert_fingerprints": [
+        "B9:C7:AE:79:A5:A9:02:70:DF:08:A1:32:E5:36:B9:C6:66:F5:BE:F1:F5:9B:30:4F:CE:CF:86:87:86:5E:4B:5B"
+      ]
+    }
+  },
+  {
+    "relation": [
+      "delegate_permission/common.handle_all_urls"
+    ],
+    "target": {
+      "namespace": "android_app",
+      "package_name": "app.organicmaps.debug",
+      "sha256_cert_fingerprints": [
+        "96:D6:28:81:78:B0:1B:86:9B:D3:FF:BF:95:B3:3B:EE:DE:23:01:68:DF:88:2A:1D:7A:4B:B2:8B:85:34:59:F4"
+      ]
+    }
+  }
+]

public/apple-app-site-association

@@ -0,0 +1 @@
+./.well-known/apple-app-site-association

public/ge0.html

@@ -0,0 +1,77 @@
+<!-- Template which is processed and returned by worker. -->
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8" />
+  <link rel="stylesheet" href="https://unpkg.com/leaflet@1.7.1/dist/leaflet.css" integrity="sha512-xodZBNTC5n17Xt2atTPuE1HxjVMSvLVW9ocqUKLsCC5CXdbqCmblAshOMAS6/keqq/sMZMZ19scR4PsZChSR7A==" crossorigin="" />
+  <style>
+    html,
+    body {
+      margin: 0;
+      padding: 0;
+      background-color: green;
+    }
+
+    a,
+    a:link,
+    a:visited,
+    a:hover,
+    a:active {
+      color: black;
+    }
+
+    #header {
+      text-align: center;
+    }
+
+    h2 {
+      color: white;
+    }
+
+    #map {
+      height: 400px;
+      width: 100%;
+    }
+  </style>
+  <script src="https://unpkg.com/leaflet@1.7.1/dist/leaflet.js" integrity="sha512-XQoYMqMTK8LvdxXYG3nZ448hOEQiglfqkJs1NOQV44cWnUrBc8PkAOcXy20w0vlaXaVUearIOBhiXZ5V3ynxwA==" crossorigin=""></script>
+  <title>${title}</title>
+</head>
+
+<body>
+  <div id="header">
+    <h2 id="name">${name}</h2>
+    <h3>
+      <a id="open" href="#" onclick="onOpenClick">Open in <strong>O</strong>rganic <strong>M</strong>aps app</a>
+      <a href="https://organicmaps.app/">Install <strong>O</strong>rganic <strong>M</strong>aps app</a>
+      <a href="https://www.openstreetmap.org/?mlat=${lat}&mlon=${lon}#map=${zoom}/${lat}/${lon}" target="_blank">See on OpenStreet Map</a>
+    </h3>
+  </div>
+  <div id="map" class="map"></div>
+  <script type="text/javascript">
+    const isiOS = navigator.platform.substr(0, 2) === 'iP' ||  // iPhone, iPad, iPod, including simulators.
+      (navigator.userAgent.includes('Mac') && 'ontouchend' in document);  // iPad on iOS 13.
+    const isAndroid = !isiOS && /(android)/i.test(navigator.userAgent);
+    const isDesktop = !isiOS && !isAndroid;
+
+    if (isDesktop)
+      document.getElementById('open').remove();
+
+    function onOpenClick() {
+      window.open('om://' + location.pathname);
+    }
+    const lat = ${ lat };
+    const lon = ${ lon };
+    const zoom = ${ zoom };
+    const map = L.map('map').setView([lat, lon], zoom);
+    L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
+      attribution: '&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
+      maxZoom: 19,
+    }).addTo(map);
+
+    const marker = L.marker([lat, lon]).addTo(map);
+    marker.bindPopup('${name}');//.openPopup();
+  </script>
+</body>
+
+</html>

public/robots.txt

@@ -0,0 +1 @@
+User-agent: *

src/bindings.d.ts

@@ -0,0 +1,6 @@
+export { };
+
+// Defined in wrangler.toml
+declare global {
+  const DEBUG: boolean;
+}

src/ge0.ts

@@ -0,0 +1,131 @@
+declare type LatLonZoom = {
+  lat: number;
+  lon: number;
+  zoom: number;
+};
+
+function replaceInTemplate(template: string, data: Record<string, any>) {
+  const pattern = /\${\s*(\w+?)\s*}/g;
+  return template.replace(pattern, (_, token) => data[token] || '');
+}
+
+// Throws on decode error.
+export async function onGe0Decode(template: string, encodedLatLonZoom: string, name?: string): Promise<Response> {
+  const llz = decodeLatLonZoom(encodedLatLonZoom);
+  let title = 'Organic Maps';
+  if (name) {
+    name = decodeURIComponent(name.replaceAll('_', ' ')).replaceAll('"', "'");
+    title = name + ' | ' + title;
+  } else {
+    name = '♥';
+  }
+
+  template = replaceInTemplate(template, { ...llz, title, name });
+  return new Response(template, { headers: { 'content-type': 'text/html' } });
+}
+
+// Throws exceptions on errors.
+function decodeLatLonZoom(encodedLatLonZoom: string): LatLonZoom {
+  const GE0_MAX_POINT_BYTES = 10;
+  const GE0_MAX_COORD_BITS = GE0_MAX_POINT_BYTES * 3;
+
+  let zoom = base64Reverse[encodedLatLonZoom.charCodeAt(0)];
+  if (zoom > 63) throw new Error('Invalid zoom level: the url was not encoded properly');
+  zoom = Math.round(zoom / 4 + 4);
+
+  const latLonStr = encodedLatLonZoom.substr(1);
+  const latLonBytes = latLonStr.length;
+
+  let lat = 0;
+  let lon = 0;
+
+  for (let i = 0, shift = GE0_MAX_COORD_BITS - 3; i < latLonBytes; i++, shift -= 3) {
+    const a = base64Reverse[latLonStr.charCodeAt(i)];
+    const lat1 = (((a >> 5) & 1) << 2) | (((a >> 3) & 1) << 1) | ((a >> 1) & 1);
+    const lon1 = (((a >> 4) & 1) << 2) | (((a >> 2) & 1) << 1) | (a & 1);
+    lat |= lat1 << shift;
+    lon |= lon1 << shift;
+  }
+
+  const middleOfSquare = 1 << (3 * (GE0_MAX_POINT_BYTES - latLonBytes) - 1);
+  lat += middleOfSquare;
+  lon += middleOfSquare;
+
+  lat = (lat / ((1 << GE0_MAX_COORD_BITS) - 1)) * 180.0 - 90.0;
+  lon = (lon / (1 << GE0_MAX_COORD_BITS)) * 360.0 - 180.0;
+
+  lat = Math.round(lat * 1e5) / 1e5;
+  lon = Math.round(lon * 1e5) / 1e5;
+
+  if (lat <= -90.0 || lat >= 90.0 || lon <= -180.0 || lon >= 180.0)
+    throw new Error('Invalid coordinates: the url was not encoded properly');
+
+  return { lat, lon, zoom };
+}
+
+const base64Reverse: { [key: number]: number } = {
+  65: 0,
+  66: 1,
+  67: 2,
+  68: 3,
+  69: 4,
+  70: 5,
+  71: 6,
+  72: 7,
+  73: 8,
+  74: 9,
+  75: 10,
+  76: 11,
+  77: 12,
+  78: 13,
+  79: 14,
+  80: 15,
+  81: 16,
+  82: 17,
+  83: 18,
+  84: 19,
+  85: 20,
+  86: 21,
+  87: 22,
+  88: 23,
+  89: 24,
+  90: 25,
+  97: 26,
+  98: 27,
+  99: 28,
+  100: 29,
+  101: 30,
+  102: 31,
+  103: 32,
+  104: 33,
+  105: 34,
+  106: 35,
+  107: 36,
+  108: 37,
+  109: 38,
+  110: 39,
+  111: 40,
+  112: 41,
+  113: 42,
+  114: 43,
+  115: 44,
+  116: 45,
+  117: 46,
+  118: 47,
+  119: 48,
+  120: 49,
+  121: 50,
+  122: 51,
+  48: 52,
+  49: 53,
+  50: 54,
+  51: 55,
+  52: 56,
+  53: 57,
+  54: 58,
+  55: 59,
+  56: 60,
+  57: 61,
+  45: 62,
+  95: 63,
+};

src/index.ts

@@ -0,0 +1,54 @@
+import { getAssetFromKV, mapRequestToAsset } from '@cloudflare/kv-asset-handler';
+import { onGe0Decode } from './ge0';
+
+const NOT_FOUND_REDIRECT_URL = 'https://organicmaps.app/';
+const GE0_TEMPLATE_URL = '/ge0.html';
+
+addEventListener('fetch', (event) => {
+  try {
+    event.respondWith(handleFetchEvent(event));
+  } catch (e) {
+    if (DEBUG) {
+      event.respondWith(new Response(e.message || e.toString(), { status: 500 }));
+    } else {
+      // In case of unexpected errors, always redirect to the default url.
+      event.respondWith(onRedirect(NOT_FOUND_REDIRECT_URL));
+    }
+  }
+});
+
+async function handleFetchEvent(event: FetchEvent) {
+  // See https://github.com/cloudflare/kv-asset-handler#optional-arguments
+  const getAssetOptions: {
+    cacheControl?: { bypassCache: boolean };
+    mapRequestToAsset?: (_: Request) => Request;
+  } = {};
+
+  if (DEBUG) {
+    // Disable caching in debug.
+    getAssetOptions.cacheControl = { bypassCache: true };
+  }
+
+  // Try to return a static resource first.
+  try {
+    return await getAssetFromKV(event, getAssetOptions);
+  } catch (_) { }
+  // No static resource were found, try to handle a specific dynamic request.
+  const { pathname } = new URL(event.request.url);
+  // Filter empty pathname elements.
+  const params = pathname.split('/').filter(Boolean);
+  if (params.length === 0) return onRedirect(NOT_FOUND_REDIRECT_URL);
+
+  getAssetOptions.mapRequestToAsset = (request: Request) => {
+    const url = new URL(request.url);
+    url.pathname = GE0_TEMPLATE_URL;
+    return mapRequestToAsset(new Request(url.toString(), request));
+  };
+  const resp = await getAssetFromKV(event, getAssetOptions);
+  const ge0HtmlTemplate = await resp.text();
+  return onGe0Decode(ge0HtmlTemplate, params[0], params.length >= 2 ? params[1] : undefined);
+}
+
+function onRedirect(url: string) {
+  return Response.redirect(url, 301);
+}

tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "isolatedModules": true,
+    "outDir": "./dist",
+    "module": "ES6",
+    "moduleResolution": "node",
+    "target": "ES2021",
+    "lib": [
+      "ES2021",
+      "webworker"
+    ],
+    "alwaysStrict": true,
+    "strict": true,
+    "preserveConstEnums": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "types": [
+      "@cloudflare/workers-types"
+    ]
+  },
+  "include": [
+    "src/",
+  ],
+  "exclude": [
+    "node_modules/",
+    "dist/",
+  ]
+}

workers-site/package.json

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "version": "1.0.0",
+  "description": "HTTP requests handler",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@cloudflare/kv-asset-handler": "~0.1.2"
+  }
+}

wrangler.toml

@@ -0,0 +1,43 @@
+# Default worker is for dev only.
+# See omaps and organicmaps environments below for production.
+name = 'url-processor'
+type = 'javascript'
+# Organic Maps CF Account ID.
+account_id = '462f578f0939f041e2c24ec99adce458'
+workers_dev = true
+
+[site]
+bucket = './public'
+entry-point = './workers-site'
+
+[build]
+upload.format = 'service-worker'
+command = 'npm i --prefer-offline --no-audit && npm run build'
+
+[vars]
+DEBUG = true
+
+
+[env.omaps]
+name = 'url-processor-omaps'
+workers_dev = false
+# omaps.app CF zone ID.
+zone_id = '3fce06554abc3899504e11d928be0ee7'
+# See the full list of handled files in the code.
+route = 'omaps.app/*'
+
+[env.omaps.vars]
+DEBUG = false
+
+
+#[env.organicmaps]
+#DEBUG = false
+#name = 'url-processor-organicmaps'
+#workers_dev = false
+# organicmaps.app CF zone ID.
+#zone_id = 'a520ad91909e819d66c62f53f9454589'
+# See the full list of handled files in the code.
+#route = 'organicmaps.app/*'
+
+[env.organicmaps.vars]
+DEBUG = false