Enable --tmp option to specify temporary folder for downloaded tiles

Also enable resuming failed download with this option

package.json

@@ -58,6 +58,7 @@
   "dependencies": {
     "axios": "^0.19.2",
     "axios-rate-limit": "^1.3.0",
+    "chalk": "^4.1.2",
     "fs-extra": "^8.1.0",
     "gm": "^1.23.1",
     "haversine": "^1.1.1",

src/config.ts

@@ -16,6 +16,7 @@ interface BaseConfig extends ModeConfig {
   tileServer: TileServer;
   pageSizeX: number;
   pageSizeY: number;
+  tmp: string;
 }
 
 interface MapConfig extends BaseConfig {
@@ -57,12 +58,13 @@ export default function getConfig(): MapConfig | RouteConfig | HelpConfig | Tile
   }
 
   if (argv.route || argv.map) {
-    const zoom = argv.zoom ?? 12;
-    const pageSizeX = argv.x ?? 4;
-    const pageSizeY = argv.y ?? 5;
-    const tileServer = getTileServer(argv['tile-server'], argv['rate-limit']);
-
-    const baseConfig = { zoom, pageSizeX, pageSizeY, tileServer };
+    const baseConfig = {
+      zoom: argv.zoom ?? 12,
+      pageSizeX: argv.x ?? 4,
+      pageSizeY: argv.y ?? 5,
+      tileServer: getTileServer(argv['tile-server'], argv['rate-limit']),
+      tmp: argv.tmp ?? `tmp${Date.now()}`,
+    };
 
     if (argv.route) {
       const input = argv.input;
@@ -80,7 +82,7 @@ export default function getConfig(): MapConfig | RouteConfig | HelpConfig | Tile
           `route-${input
             .split('.')
             .slice(0, -1)
-            .join('.')}-${zoom}`,
+            .join('.')}-${baseConfig.zoom}`,
       };
     }
 
@@ -98,7 +100,7 @@ export default function getConfig(): MapConfig | RouteConfig | HelpConfig | Tile
       )
         return helpConfig;
 
-      const output = argv.output ?? `map_${north}_${west}_${south}_${east}_${zoom}`;
+      const output = argv.output ?? `map_${north}_${west}_${south}_${east}_${baseConfig.zoom}`;
       return {
         ...baseConfig,
         mode: 'map',

src/download.ts

@@ -3,17 +3,20 @@ import { getHttp } from './http';
 import fs from 'fs-extra';
 import mergeImg from 'merge-img';
 import log from './log';
-import { getFilename } from './utils';
+import { getFilename, fileExists } from './utils';
 
 // This is the main exported function. Provide pages, folder and server to dowload from and it fills the tmp folder with the pages
 export async function downloadPages(pages: Page[], tmp: string, tileServer: TileServer) {
   await fs.ensureDir(tmp);
   const http = getHttp(tileServer.rateLimit);
   for (let i = 0, len = pages.length; i < len; i++) {
-    const page = pages[i];
-    const info = `downloading page ${i + 1}/${pages.length}`;
-    const pageTiles = await getPage(page, { http, tileServer }, info);
-    await savePage(pageTiles, getFilename(tmp, i));
+    const filename = getFilename(tmp, i);
+    if (!(await fileExists(filename))) {
+      const page = pages[i];
+      const info = `downloading page ${i + 1}/${pages.length}`;
+      const pageTiles = await getPage(page, { http, tileServer }, info);
+      await savePage(pageTiles, filename);
+    }
   }
 }
 

src/help.ts

@@ -14,6 +14,10 @@ osm2pdf [options]
 --output        name of the generated pdf file (".pdf" will be attached, existing files will be overwritten)
 -x              tiles per page horizontally (default 4)
 -y              tiles per page vertically (default 5)
+--tmp           temporary folder to save downloaded tiles to (default tmp[timestamp])
+                  if the folder doesn't exist, it will be created
+                  you can resume failed download with this option
+                  use carefully! folder will be deleted after successful download
 
 
 === Methods ===

src/map.ts

@@ -15,6 +15,7 @@ export default async function map({
   south,
   east,
   tileServer,
+  tmp,
 }: {
   zoom: number;
   output: string;
@@ -25,11 +26,11 @@ export default async function map({
   south: number;
   east: number;
   tileServer: TileServer;
+  tmp: string;
 }) {
   // collect pages
   const pages: Page[] = boundaries2pages({ north, west, south, east, pageSizeX, pageSizeY, zoom });
   // download pages
-  const tmp = `tmp${Date.now()}`;
   await downloadPages(pages, tmp, tileServer);
   // create pdf
   await createPdf(output, tmp);

src/route.ts

@@ -36,6 +36,7 @@ export default async function path({
   distance,
   distanceStep,
   tileServer,
+  tmp,
 }: {
   zoom: number;
   input: string;
@@ -46,6 +47,7 @@ export default async function path({
   distance: boolean;
   distanceStep: number;
   tileServer: TileServer;
+  tmp: string;
 }) {
   // collect pages:
   //
@@ -59,7 +61,6 @@ export default async function path({
   const pages = collectPages(tileRoute, pageSizeX, pageSizeY);
 
   // download the tiles and connect them to pages
-  const tmp = `tmp${Date.now()}`;
   await downloadPages(pages, tmp, tileServer);
 
   // draw path on pages

src/run.ts

@@ -13,32 +13,41 @@ import map from './map';
 import route from './route';
 import help from './help';
 import { listTileServers } from './tile-servers';
+import chalk from 'chalk';
 
 (async () => {
+  let config;
   try {
-    const config = getConfig();
+    config = getConfig();
 
     switch (config.mode) {
       case 'tiles': {
-        return listTileServers();
+        listTileServers();
+        return;
       }
       case 'map': {
-        const { zoom, output, pageSizeX, pageSizeY, north, west, south, east, tileServer } = config;
-        return map({ zoom, output, pageSizeX, pageSizeY, north, west, south, east, tileServer });
+        await map(config);
+        return;
       }
       case 'route': {
-        const { zoom, input, output, pageSizeX, pageSizeY, draw, distance, distanceStep, tileServer } = config;
-        return route({ zoom, input, output, pageSizeX, pageSizeY, draw, distance, distanceStep, tileServer });
+        await route(config);
+        return;
       }
       default:
-        return help();
+        help();
+        return;
     }
   } catch (e) {
-    // tslint:disable-next-line:no-console
-    console.log(JSON.stringify(e));
     // tslint:disable-next-line:no-console
     console.log(JSON.stringify(e));
     // tslint:disable-next-line:no-console
     console.error(e);
+    if (config && 'tmp' in config) {
+      console.log(
+        chalk.red(
+          `\n\n************************\n\nError: ${e.message}\n\nYour download failed. You can resume it by adding "--tmp ${config.tmp}" to your command.\n\n************************\n`,
+        ),
+      );
+    }
   }
 })();

src/tile-servers.ts

@@ -37,7 +37,7 @@ export const rawServers = [
   {
     name: 'OpenTopoMap',
     url: 'https://{a|b|c}.tile.opentopomap.org/{z}/{x}/{y}.png',
-    rateLimit: 1,
+    rateLimit: 2,
   },
   {
     name: 'Stamen Toner Black & White map',

src/utils.ts

@@ -13,3 +13,12 @@ export const getFilename = (tmp: string, i: number) => `${tmp}/${pad(i)}.png`;
 export function random<T>(input: Array<T>): T {
   return input[Math.floor(Math.random() * input.length)];
 }
+
+export const fileExists = async (file: string): Promise<boolean> => {
+  try {
+    await fs.access(file, fs.constants.F_OK);
+    return true;
+  } catch {
+    return false;
+  }
+};

yarn.lock

@@ -861,6 +861,14 @@ chalk@^3.0.0:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
 
+chalk@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01"
+  integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==
+  dependencies:
+    ansi-styles "^4.1.0"
+    supports-color "^7.1.0"
+
 ci-info@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-2.0.0.tgz#67a9e964be31a51e15e5010d58e6f12834002f46"