mapsnatcher 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81899844de71e7d8e994867d291b9bf3effee5eac3af6a07686c9b9ee201660d
+  data.tar.gz: 98a6fc9902a46b0a8afc38df9471c805a0a0555066cb516d357a1ad68da76db2
+SHA512:
+  metadata.gz: de0a27be646d2d197f4342c8525a5e5625074eb2d6e47c412e7d9e46dbfc50e795d877b2b621148658784caa60a47c76929cbcc9f4d4442029376ba85818f143
+  data.tar.gz: b72ac47c23bd90ffeb8744af6ba569142e85a967dd55822bc07cc1130815be07894fce94b94f24aa65fbf0d8d32a3e554adbf3975c20946154c139528a033b9e

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Vinny Diehl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# `mapsnatcher`
+
+`mapsnatcher` is a bot to automatically download and splice together tiles from
+QGIS maps. This simple system uses a URL such as
+`http://mapwebsite.com/z/x/y.png`, where `z` is the zoom level, and `x` and `y`
+are the coordinates of the tile.
+
+You can use a tool such as
+[ChromeCacheView](https://www.nirsoft.net/utils/chrome_cache_view.html) to find
+these URLs easily.
+
+## Usage
+
+Usage is as follows:
+
+```mapsnatcher "http://mapwebsite.com/0/XXX/YYY.png"```
+
+Place `XXX` and `YYY` (case-insensitive) where the respective coordinate
+numbers would be in the URL. You will then be prompted to enter the X and Y
+boundaries that you would like to capture.
+
+```mapsnatcher -b "http://mapwebsite.com/0/XXX/YYY.png"```
+
+If you are unsure of the boundaries and would like to capture the entire map,
+add the `-b` argument and you will only need to enter one valid coordinate;
+`mapsnatcher` will do the rest.

data/VERSION

@@ -0,0 +1 @@
+0.1

data/bin/mapsnatcher

@@ -0,0 +1,192 @@
+#!/usr/bin/env ruby
+
+require "fileutils"
+require "yaml"
+require "open-uri"
+require "net/http"
+require "rmagick"
+include Magick
+
+TEMP_DIR = "./.ms.tmp"
+
+# False if URL returns a 200
+#
+# @param url [String] the url to be checked
+# @return [Boolean] whether or not the URL is invalid
+def invalid?(url)
+  uri = URI(url)
+  !Net::HTTP.start(uri.host, 443, use_ssl: true){ |http| break http.head uri.path }.instance_of? Net::HTTPOK
+end
+
+# Parses ARGV input into usable URL with given X and Y values
+#
+# @param x [Integer] x-coordinate
+# @param y [Integer] y-coordinate
+# @return usable URL for map tile
+def build_url(url, x, y)
+  url.gsub(/xxx/i, x.to_s).gsub(/yyy/i, y.to_s)
+end
+
+if ARGV.empty? or %w[-h --help].include? ARGV.first
+  puts 'Usage: mapsnatcher "http://mapwebsite.com/0/XXX/YYY.png"'
+  puts
+  puts "       Place XXX and YYY in place of where the respective coordinate numbers would be"
+  puts "       in the URL. The first number is typically the zoom level, which is constant."
+  puts
+  puts "  [-b] find outer bounds of map automatically"
+  exit 0
+end
+
+if %w[-v --version].include? ARGV.first
+  puts "mapsnatcher #{File.read(File.expand_path("../../VERSION", __FILE__)).strip}"
+  exit 0
+end
+
+# Load/create temp directory
+if !File.exists? TEMP_DIR
+  Dir.mkdir TEMP_DIR
+elsif !Dir.empty? TEMP_DIR
+  print "It looks like mapsnatcher didn't close properly. Use backed up files? [Y/n] "
+  FileUtils.rm_f(Dir.glob("#{TEMP_DIR}/*")) if STDIN.gets.chomp =~ /n.*/i
+  puts
+end
+
+if ARGV.include? "-b"
+  # Automatic boundary mode
+
+  url = (ARGV - ["-b"]).first
+
+  # CLI input function
+  #
+  # @return [Array] user input coordinates
+  def get_coords
+    print "Enter valid X coordinate [0]: "
+    x_in = STDIN.gets.chomp.to_i
+    print "Enter valid Y coordinate [0]: "
+    y_in = STDIN.gets.chomp.to_i
+
+    print "\nLoading...\r"
+
+    [x_in, y_in]
+  end
+
+  valid_x, valid_y = get_coords
+
+  while invalid? build_url(url, valid_x, valid_y)
+    puts "Invalid coordinate! Try again."
+    puts
+    valid_x, valid_y = get_coords
+  end
+
+  x_low = x_high = valid_x
+  until invalid? build_url(url, x_low - 1, valid_y)
+    print "Checking X value: #{x_low}     \r"
+    x_low -= 1
+  end
+  until invalid? build_url(url, x_high + 1, valid_y)
+    print "Checking X value: #{x_high}     \r"
+    x_high += 1
+  end
+
+  y_low = y_high = valid_y
+  until invalid? build_url(url, valid_x, y_low - 1)
+    print "Checking Y value: #{y_low}     \r"
+    y_low -= 1
+  end
+  until invalid? build_url(url, valid_x, y_high + 1)
+    print "Checking Y value: #{y_high}     \r"
+    y_high += 1
+  end
+
+  puts "Found Coordinate Range: [#{x_low}-#{x_high}], [#{y_low}-#{y_high}]"
+
+  x_range, y_range = (x_low..x_high), (y_low..y_high)
+else
+  # User input coordinate mode
+
+  url = ARGV.first
+
+  # CLI input function
+  #
+  # @return [Array] user input coordinate ranges
+  def get_coords
+    print "Start of X range [0]: "
+    x_start = STDIN.gets.chomp.to_i
+    print "End of X range: "
+    x_range_in = (x_start..STDIN.gets.chomp.to_i)
+
+    print "Start of Y range [0]: "
+    y_start = STDIN.gets.chomp.to_i
+    print "End of Y range: "
+    y_range_in = (y_start..STDIN.gets.chomp.to_i)
+
+    print "\nLoading...\r"
+
+    [x_range_in, y_range_in]
+  end
+
+  x_range, y_range = get_coords
+
+  while invalid?(build_url url, x_range.first, y_range.first) or
+        invalid?(build_url url, x_range.first, y_range.last)  or
+        invalid?(build_url url, x_range.last, y_range.first)  or
+        invalid?(build_url url, x_range.last, y_range.last)
+    puts "\nError: Boundaries incorrect."
+    puts "Use `mapsnatcher -b` for help finding the boundaries of the image."
+    puts
+    x_range, y_range = get_coords
+  end
+end
+
+# Use the tile at 0, 0 to calculate final image size
+sample = Image.from_blob(URI.open(build_url url, x_range.first, y_range.first).read).first
+final_size = {x: sample.columns * x_range.size, y: sample.rows * y_range.size}
+puts "Image found, #{sample.format} size #{final_size[:x]}x#{final_size[:y]}"
+puts
+
+dl_counter = 0
+dl_total = x_range.size * y_range.size
+
+stitch = ImageList.new
+y_range.each do |y|
+  row = ImageList.new
+  x_range.each do |x|
+    print "Downloading... [#{dl_counter += 1}/#{dl_total}]\r"
+
+    temp = "#{TEMP_DIR}/#{x}_#{y}.tmp"
+    if File.exists? temp
+      # Load the backup file
+      blob = YAML.load(File.read temp)
+    else
+      blob = URI.open(build_url url, x, y).read
+      File.open(temp, "w") { |f| f.write(YAML.dump blob) }
+    end
+
+    row.push Image.from_blob(blob).first
+  end
+
+  stitch.push row.append(false)
+end
+
+puts "\nDone!"
+
+# Warnings for incompatible formats for large image sizes
+JPEG_MAX = 65535
+WEBP_MAX = 16383
+
+if final_size.values.max > JPEG_MAX
+  puts "\nWarning! Image dimensions greater than #{JPEG_MAX}px, JPG and WEBP"
+  puts "formats are unavailable."
+  puts
+elsif final_size.values.max > WEBP_MAX
+  puts "\nWarning! Image dimensions greater than #{WEBP_MAX}px, WEBP"
+  puts "format is unavailable."
+  puts
+end
+
+print "Enter file name for map: "
+filename = STDIN.gets.chomp
+print "Saving, this may take a minute..."
+stitch.append(true).write filename
+FileUtils.rm_rf TEMP_DIR
+puts "\nImage written to: #{filename}"

data/mapsnatcher.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |gem|
+  gem.name = "mapsnatcher"
+  gem.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+
+  gem.author = "Vinny Diehl"
+  gem.email = "vinny.diehl@gmail.com"
+  gem.homepage = "https://github.com/vinnydiehl/mapsnatcher"
+
+  gem.license = "MIT"
+
+  gem.summary = "Downloads and combines tiles from QGIS maps into an image."
+  gem.description = "Downloads and combines tiles from QGIS maps into an image."
+
+  gem.bindir = "bin"
+  gem.executables = %w[mapsnatcher]
+
+  gem.test_files = Dir["spec/**/*"]
+  gem.files = Dir["bin/**/*"] + gem.test_files + %w[
+    LICENSE README.md VERSION mapsnatcher.gemspec
+  ]
+
+  gem.required_ruby_version = "~> 3.0"
+
+  gem.add_dependency "rmagick", "~> 5.1"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: mapsnatcher
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vinny Diehl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Downloads and combines tiles from QGIS maps into an image.
+email: vinny.diehl@gmail.com
+executables:
+- mapsnatcher
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- bin/mapsnatcher
+- mapsnatcher.gemspec
+homepage: https://github.com/vinnydiehl/mapsnatcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Downloads and combines tiles from QGIS maps into an image.
+test_files: []