mapcachetools 1.0.1

package/README.md

@@ -0,0 +1,45 @@
+# MAP Cache Tool
+
+This tool download any area from map provider and store it as images in a folder.
+You can use these images with a library like [Leafet](https://leafletjs.com/ "Leafet") to make your own map server easily without the need to download a local OpenStreetMap server.
+
+
+## Usage
+
+Download area from 58.5500977,-4.5231876   to 58.5501,-4.5231976 with maximum zoom in of 20 and minimum zoom in of 0 i.e. whole world zoom, and store images in folder called image_folder
+
+
+    downloadmaps --lat1=58.5500977 --lng1=-4.5231876 --lat2=58.5501 --lng2=-4.5231976 --zin=20 --zout=0 --folder=./image_folder
+
+## Map Providers
+
+The application supports [openstreetmap.org](https://www.openstreetmap.org/#map=7/26.805/30.246 "openstreetmap.org") 
+
+```bash
+downloadmaps --lat1=58.5500977 --lng1=-4.5231876 --lat2=58.5501 --lng2=-4.5231976 --zin=20  --folder=./out 
+
+```
+
+and [api.mapbox.com](https://api.mapbox.com "api.mapbox.com"). You need to have a **TOKEN** for using [api.mapbox.com](https://api.mapbox.com "api.mapbox.com").
+
+```bash
+ downloadmaps --lat1=58.5500977 --lng1=-4.5231876 --lat2=58.5501 --lng2=-4.5231976 --zin=20  --folder=./out --provider=1 --token=pk.eyJ1IjoibSahlZm59IiwiYSI6ImNrZW84Nm9rYTA2ZWgycv9mdmNscmFxYzcifQ.c-z43FdasErPzKhbQ
+```
+
+## Sample
+
+folder ./site contains a folder called **cachedMaps** you can put your maps into it and browse them.
+
+
+
+    cd ./site
+    http-server .
+    
+
+
+
+
+### Disclaimer
+Please make sure to review any terms and conditions of map providers you want to use. Author assumes no liability for any incidental, consequential or other liability from the use of this product.
+
+

package/REALKEY.txt

@@ -0,0 +1 @@
+const TOKEN = "pk.eyJ1IjoiaHNhYWQiLCJhIjoiY2tqZnIwNXRuMndvdTJ4cnV0ODQ4djZ3NiJ9.LKojA3YMrG34L93jRThEGQ"

package/downloadmaps.js

@@ -0,0 +1,377 @@
+/*
+    Download images sequentially
+*/
+"use strict";
+const v_pjson = require("./package.json");
+const c_args = require("./helpers/hlp_args.js");
+const c_colors = require("./helpers/js_colors.js").Colors;
+
+const fs = require("fs");
+const axios = require("axios");
+
+const EARTH_RADIUS = 6378137;
+const MAX_LATITUDE = 85.0511287798;
+const R_MINOR = 6356752.314245179;
+const TOKEN = "GET YOUR TOKEN";
+var map_provider = 0;
+var myArgs = c_args.getArgs();
+
+/*
+ * @namespace Projection
+ * @projection L.Projection.SphericalMercator
+ *
+ * Spherical Mercator projection — the most common projection for online maps,
+ * used by almost all free and commercial tile providers. Assumes that Earth is
+ * a sphere. Used by the `EPSG:3857` CRS.
+ */
+function project(lat, lng) {
+  var d = Math.PI / 180,
+    max = MAX_LATITUDE,
+    lat = Math.max(Math.min(max, lat), -max),
+    sin = Math.sin(lat * d);
+
+  return {
+    x: EARTH_RADIUS * lng * d,
+    y: (EARTH_RADIUS * Math.log((1 + sin) / (1 - sin))) / 2,
+  };
+}
+
+function unproject(point) {
+  var d = 180 / Math.PI;
+
+  return {
+    lat: (2 * Math.atan(Math.exp(point.y / EARTH_RADIUS)) - Math.PI / 2) * d,
+    lng: (point.x * d) / EARTH_RADIUS,
+  };
+}
+
+function zoomScale(zoom) {
+  return 256 * Math.pow(2, zoom);
+}
+
+function transform(point, scale) {
+  scale = scale || 1;
+  point.x = scale * (2.495320233665337e-8 * point.x + 0.5);
+  point.y = scale * (-2.495320233665337e-8 * point.y + 0.5);
+  return point;
+}
+
+function fn_convertFromLngLatToPoints(lat1, lng1, lat2, lng2, zoom) {
+  // order location
+  if (lng1 > lng2) {
+    var t = lng2;
+    lng2 = lng1;
+    lng1 = t;
+  }
+
+  if (lat1 > lat2) {
+    var t = lat2;
+    lat2 = lat1;
+    lat1 = t;
+  }
+
+  // convert to points
+  var point1 = project(lat1, lng1);
+  var point2 = project(lat2, lng2);
+
+  var scaledZoom = zoomScale(zoom);
+  point1 = transform(point1, scaledZoom);
+  point2 = transform(point2, scaledZoom);
+
+  // convert to integer
+  point1.x = Math.floor(point1.x / 256);
+  point1.y = Math.floor(point1.y / 256);
+  point2.x = Math.floor(point2.x / 256);
+  point2.y = Math.floor(point2.y / 256);
+
+  // sort
+  if (point1.y > point2.y) {
+    var t = point2.y;
+    point2.y = point1.y;
+    point1.y = t;
+  }
+
+  var point = [];
+
+  point.push(point1);
+  point.push(point2);
+
+  return point;
+}
+
+/* ============================================================
+  Function: Download Image
+============================================================ */
+
+const download_image = (url, image_path) =>
+  axios({
+    url,
+    responseType: "stream",
+  }).then(
+    (response) =>
+      new Promise((resolve, reject) => {
+        response.data
+          .pipe(fs.createWriteStream(image_path))
+          .on("finish", () => resolve())
+          .on("error", (e) => reject(e));
+      })
+  ).catch((error) => {
+    console.log(error.message);
+  });;
+
+function fn_download_images(point1, point2, zoom) {
+  (async () => {
+    var url, filename;
+    var totalImages =
+      (1 + (point2.x + 1) - point1.x) * (1 + (point2.y + 1) - point1.y);
+    var START_FROM = 0;
+
+    for (var j, c = 0, i = point1.x; i <= point2.x + 1; ++i)
+      for (j = point1.y; j <= point2.y + 1; ++j, ++c) {
+        if (c >= START_FROM) {
+         /*
+            You can edit URL here to download from any provider.
+         */ 
+          if (map_provider==1)
+          {
+              // MAPBOX API       
+              url =
+                  "https://api.mapbox.com/styles/v1/mapbox/satellite-v9/tiles/" +
+                  zoom +
+                  "/" +
+                  i +
+                  "/" +
+                  j +
+                  "?access_token=" +
+                  TOKEN;
+          }
+          else
+          {
+              // Open Street Map 
+              // URL https://tile.openstreetmap.org/{z}/{x}/{y}.png
+              url =
+                  "https://tile.openstreetmap.org/" +
+                  zoom +
+                  "/" +
+                  i +
+                  "/" +
+                  j +
+                  ".png";
+          }
+          filename = folder + "/" + i + "_" + j + "_" + zoom +  ".jpeg";
+          if (!fs.existsSync(filename)) {
+            await download_image(url, filename);
+          }
+          else
+          {
+            console.log ("image no. " + c + " already exists.");
+          }
+          console.log(c + " of " + totalImages + ":" + url);
+        }
+      }
+  })();
+}
+
+function fn_handle_arguments() {
+  myArgs = c_args.getArgs();
+  console.log(JSON.stringify(myArgs));
+  var error = false;
+  if (
+    myArgs.hasOwnProperty("version") === true ||
+    myArgs.hasOwnProperty("v") === true
+  ) {
+    console.log(
+      c_colors.BSuccess +
+        "MAP Cache version" +
+        c_colors.FgYellow +
+        JSON.stringify(v_pjson.version) +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--lat1" +
+        c_colors.FgWhite +
+        " for Start latitude. " +
+        c_colors.FgYellow +
+        " Example --lat1=-54.652332555" +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--lng1" +
+        c_colors.FgWhite +
+        "  for start longitude. " +
+        c_colors.FgYellow +
+        " Example --lng1=-54.652332555" +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--lat2" +
+        c_colors.FgWhite +
+        "  for end latitude. " +
+        c_colors.FgYellow +
+        " Example --lat2=-54.652332555" +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--lng2" +
+        c_colors.FgWhite +
+        "  for end longitude. " +
+        c_colors.FgYellow +
+        " Example --lng2=-54.652332555" +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--zout" +
+        c_colors.FgWhite +
+        "  for maximum zoom in. You need to check provider normally up to 20" +
+        c_colors.FgYellow +
+        " Example --zout=2 " +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--zin" +
+        c_colors.FgWhite +
+        "  for maximum zoom out. can be as low as 0. " +
+        c_colors.FgYellow +
+        " Example --zin=10 " +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--folder" +
+        c_colors.FgWhite +
+        "  folder to store images in. " +
+        c_colors.FgYellow +
+        " Example --folder=./out " +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--provider" +
+        c_colors.FgWhite +
+        "  if equal to 1 then use https://api.mapbox.com else use tile.openstreetmap.org. " +
+        c_colors.FgYellow +
+        " Example --folder=./out " +
+        c_colors.Reset
+    );
+    console.log(
+      c_colors.BSuccess +
+        "--token" +
+        c_colors.FgWhite +
+        " Required only with https://api.mapbox.com " +
+        c_colors.FgYellow +
+        " Example --folder=pk.eyJ1IjoibZglZm55IiwiYSI698mNrZW84Nm9rYTA2ZWgycm9mdmNscmFxYzcifQ.c-zxDZXCthXmRsErPzKhbQ " +
+        c_colors.Reset
+    );
+    process.exit();
+  }
+  if (myArgs.hasOwnProperty("lat1") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing start latitude. " +
+        c_colors.FgYellow +
+        " Example --lat1=-54.652332555" +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("lng1") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing start longitude. " +
+        c_colors.FgYellow +
+        " Example --lng1=-54.652332555" +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("lat2") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing end latitude. " +
+        c_colors.FgYellow +
+        " Example --lat2=-54.652332555" +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("lng2") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing end longitude. " +
+        c_colors.FgYellow +
+        " Example --lng2=-54.652332555" +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("zout") !== true) {
+    myArgs.zout = 0;
+    console.log(
+      c_colors.FgCyan +
+        "Missing zoom out max. Use zero as a default. " +
+        c_colors.FgYellow +
+        " Example --zout=0 " +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("zin") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing zoom in max between 18 & 2. " +
+        c_colors.FgYellow +
+        " Example --zin=10 " +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("folder") !== true) {
+    error = true;
+    console.log(
+      c_colors.BError +
+        "Missing output folder. " +
+        c_colors.FgYellow +
+        " Example --folder=./out " +
+        c_colors.Reset
+    );
+  }
+  if (myArgs.hasOwnProperty("provider") === true) {
+    if (myArgs.provider == 1)
+    {
+      map_provider = 1;
+      if (myArgs.hasOwnProperty("token") !== true) {
+        error = true;
+        console.log(
+          c_colors.BError +
+            "Missing TOKEN file for https://api.mapbox.com. " +
+            c_colors.FgYellow +
+            " Example --token=pk.eyJ1IjoibZglZm55IiwiYSI698mNrZW84Nm9rYTA2ZWgycm9mdmNscmFxYzcifQ.c-zxDZXCthXmRsErPzKhbQ " +
+            c_colors.Reset
+        );
+      }
+    }
+  }
+
+  if (map_provider)
+  if (error === true) process.exit(0);
+}
+
+/* ============================================================
+  Download Images in Order
+============================================================ */
+
+fn_handle_arguments();
+var folder = myArgs.folder;
+for (var zoom = myArgs.zout; zoom <= myArgs.zin; ++zoom) {
+  var points = fn_convertFromLngLatToPoints(myArgs.lat1, myArgs.lng1, myArgs.lat2, myArgs.lng2, zoom);
+
+  var point1 = points[0];
+  var point2 = points[1];
+
+  fn_download_images(point1, point2, zoom);
+}

package/helpers/hlp_args.js

@@ -0,0 +1,26 @@
+"use strict";
+
+
+exports.getArgs = function getArgs () {
+    //https://stackoverflow.com/questions/4351521/how-do-i-pass-command-line-arguments-to-a-node-js-program
+    //node test.js -D --name=Hello
+
+    const args = {}
+    process.argv
+      .slice(2, process.argv.length)
+      .forEach( arg => {
+        // long arg
+        if (arg.slice(0,2) === '--') {
+          const longArg = arg.split('=')
+          args[longArg[0].slice(2,longArg[0].length)] = longArg[1]
+        }
+       // flags
+        else if (arg[0] === '-') {
+          const flags = arg.slice(1,arg.length).split('')
+          flags.forEach(flag => {
+            args[flag] = true
+          })
+        }
+      })
+    return args
+}

package/helpers/js_colors.js

@@ -0,0 +1,33 @@
+const c_Colors = 
+{
+Reset : "\x1b[0m",
+Bright : "\x1b[1m",
+Dim : "\x1b[2m",
+Underscore : "\x1b[4m",
+Blink : "\x1b[5m",
+Reverse : "\x1b[7m",
+Hidden : "\x1b[8m",
+
+FgBlack     : "\x1b[30m",
+Error       : "\x1b[31m",
+BError      : "\x1b[1;31m",
+Success     : "\x1b[32m",
+BSuccess    : "\x1b[1;32m",
+FgYellow    : "\x1b[33m",
+BFgYellow   : "\x1b[1;33m",
+Log         : "\x1b[34m",
+FgMagenta   : "\x1b[35m",
+FgCyan      : "\x1b[36m",
+FgWhite     : "\x1b[37m",
+Info        : "\x1b[33m",
+BgBlack     : "\x1b[40m",
+BgRed       : "\x1b[41m",
+BgGreen     : "\x1b[42m",
+BgYellow    : "\x1b[43m",
+BgBlue      : "\x1b[44m",
+BgMagenta   : "\x1b[45m",
+BgCyan      : "\x1b[46m",
+BgWhite     : "\x1b[47m"
+}
+
+exports.Colors = c_Colors;

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "mapcachetools",
+  "version": "1.0.1",
+  "description": "This tool downloads images from a map provider and cache it locally on your device. Please check terms and condition of your map provider. The tool is provided as is with no responsibility from author. Please Use IT AT YOUR OWN RISK.",
+  "main": "downloadmaps.js",
+  "scripts": {
+    "start": "node ./bin/downloadmaps.js"
+  },
+  "bin": {
+    "mapcache": "downloadmaps.js"
+  },
+  "keywords": [
+    "map",
+    "local server",
+    "cache"
+  ],
+  "author": "Mohammad Said Hefny - rcmobilestuff <rcmobilestuff@gmail.com> (http://www.andruav.com)",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^0.21.1",
+    "request": "^2.88.2"
+  }
+}