gamerom 0.4.1 → 0.6.0

data/lib/gamerom/cli.rb

@@ -31,11 +31,11 @@ module Gamerom
       validate_platform repo, options[:platform]
       puts "showing info for game #{game_identifier} on #{options[:platform]} platform on #{options[:repo]} repo..."
       game = repo.find(options[:platform], game_identifier)
-      if !game.nil?
+      if game.nil?
+        shell.say "Game #{game_identifier} not found", :red
+      else
         puts game
         puts game.filenames if game.installed?
-      else
-        shell.say "Game #{game_identifier} not found", :red
       end
     rescue StandardError => e
       render_error e, options
@@ -61,6 +61,8 @@ module Gamerom
       end
       game.install
       shell.say 'Game installed', :green
+    rescue Gamerom::ManualDownloadRequired => e
+      shell.say e.message, :yellow
     rescue StandardError => e
       render_error e, options
       exit 1
@@ -75,7 +77,13 @@ module Gamerom
       validate_platform repo, options[:platform]
       games = repo.games options[:platform], region: options[:region]
       games.each do |game|
-        install(game.id) unless game.installed?
+        if game.installed?
+          shell.say "Game #{game.name} already installed", :yellow
+          next
+        end
+        install(game.id)
+      rescue StandardError, SystemExit => e
+        shell.say "Error installing game #{game.name}: #{e.message}", :red
       end
     rescue StandardError => e
       render_error e, options
@@ -116,28 +124,12 @@ module Gamerom
       validate_platform repo, options[:platform]
       puts "recovering state of roms for #{options[:platform]} platform on #{options[:repo]} repo..."
       games = repo.games options[:platform]
-      games_not_found = []
-      games.each do |game|
-        filename = nil
-        basename = "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{game[:region]}/#{game[:name]}"
-        %w[zip 7z rar].each do |ext|
-          fullname = "#{basename}.#{ext}"
-          filename = fullname if File.exist? fullname
-        end
+      game_names = games.to_h { |game| [game.id, game.name] }
+      results = games.group_by { |game| recover_game(game, game_names) }
 
-        if filename
-          game.update_state File.basename(filename)
-          puts "Found game #{game[:name]}"
-        else
-          games_not_found << game[:name]
-        end
-      end
-      if games_not_found.count.positive?
-        puts 'Games not found:'
-        puts games_not_found
-      end
+      print_recover_summary(results.fetch(:found, []), results.fetch(:already_installed, []), results.fetch(:not_found, []))
     rescue StandardError => e
-      puts e.message
+      render_error e, options
       exit 1
     end
 
@@ -308,10 +300,8 @@ module Gamerom
     private
 
     def print_game_table(games)
-      results = []
-
-      games.each do |game|
-        results << [
+      results = games.map do |game|
+        [
           game.id,
           game.name,
           game.region,
@@ -334,5 +324,113 @@ module Gamerom
 
       raise "Expected '--platform' to be one of #{repo.platforms.keys.join(", ")}; got #{platform}"
     end
+
+    # Recover helpers
+
+    def recover_game(game, game_names)
+      puts
+      puts "Checking game #{game}"
+      if game.filenames.any?
+        puts "#{shell.set_color("*", :green)} Found game at: #{game.filenames.first}"
+        return :already_installed
+      end
+
+      game_files = glob_game_files(game).select { |file| file_belongs_to_game?(file, game, game_names) }.sort
+      if game_files.empty?
+        puts "#{shell.set_color("*", :red)} not found"
+        return :not_found
+      end
+
+      game.update_state(game_files.map { |file| File.basename(file) })
+      print_recovered_files(game_files)
+      :found
+    end
+
+    def glob_game_files(game)
+      patterns = [
+        glob_escape(game.name.tr(' ', '_'), '_'),
+        glob_escape(game.name, ' ')
+      ]
+      patterns.flat_map { |pattern| Dir.glob("#{game.filepath}/#{pattern}*") }.uniq
+    end
+
+    def glob_escape(str, spacer)
+      str
+        .gsub(/([\\\[\]*?{}) ,])/, '\\\\\1')
+        .gsub(':', "#{spacer}-")
+        .gsub('!', '\!*')
+        .gsub('(', '*\(')
+    end
+
+    # A globbed file is kept for a game unless it is a better match for another
+    # game whose name starts with this game's name (e.g. "Kung-Fu" vs "Kung-Fu Master").
+    def file_belongs_to_game?(file, game, game_names)
+      filename = File.basename(file).downcase
+      return true if exact_filename_match?(filename, game.name.downcase)
+
+      number = sequel_number(game.name)
+      return true if number && filename.include?(number)
+      return true if game.name.include?('Limited Run Games') && filename.include?('limited_run')
+
+      !claimed_by_other_game?(filename, game, game_names)
+    end
+
+    # "Game.zip", "Game_Name.zip" or "Game (USA).zip"
+    def exact_filename_match?(filename, name)
+      [name, name.tr(' ', '_')].any? do |variant|
+        filename.match?(/\A#{Regexp.escape(variant)}(\s*\(\w+\))?\.\w+\z/i)
+      end
+    end
+
+    # The number that identifies a sequel, e.g. "2" in "Tony Hawk's Pro Skater 2"
+    def sequel_number(name)
+      match = name.match(/(\d+|\s+\d+)[\s':]/) || name.match(/\s(\d+)$/)
+      match && match[1].strip
+    end
+
+    def claimed_by_other_game?(filename, game, game_names)
+      name = game.name.downcase
+      game_names.any? do |other_id, other_name|
+        next false if other_id == game.id
+
+        other = other_name.downcase
+        next false unless other.length > name.length && other.start_with?(name)
+
+        filename_matches_other_game?(filename, other_name)
+      end
+    end
+
+    def filename_matches_other_game?(filename, other_name)
+      other = other_name.downcase
+      other_underscored = other.tr(' ', '_')
+      return false unless filename.include?(other_underscored) || filename.include?(other)
+
+      number = sequel_number(other_name)
+      return filename.include?(number) if number
+
+      filename.start_with?(other_underscored) ||
+        filename.start_with?(other) ||
+        filename.include?(other_underscored.tr(':', '_')) ||
+        filename.include?(other.tr(':', '-'))
+    end
+
+    def print_recovered_files(game_files)
+      if game_files.size > 1
+        puts "#{shell.set_color("*", :green)} Found #{game_files.size} disks for game:"
+        game_files.each { |file| puts "  - #{file}" }
+      else
+        puts "#{shell.set_color("*", :green)} Found game at: #{game_files.first}"
+      end
+    end
+
+    def print_recover_summary(games_found, games_already_installed, games_not_found)
+      if games_not_found.empty?
+        puts "All #{games_found.count + games_already_installed.count} games found"
+      else
+        puts "#{shell.set_color(games_found.count, :green)} games found"
+        puts "#{shell.set_color(games_already_installed.count, :yellow)} games already installed"
+        puts "#{shell.set_color(games_not_found.count, :red)} games not found"
+      end
+    end
   end
 end

data/lib/gamerom/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Gamerom
+  class Error < StandardError; end
+
+  # Raised by repo adapters whose site does not allow automated downloads.
+  # The message tells the user where to download the game and where to save it.
+  class ManualDownloadRequired < Error; end
+end

data/lib/gamerom/game.rb

@@ -1,14 +1,24 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'ostruct'
 require 'yaml'
 
 module Gamerom
   # Game - Represents a game ROM
-  class Game < OpenStruct
+  class Game
+    attr_accessor :id, :name, :platform, :region, :repo, :tags, :url
+
+    def initialize(attributes = {})
+      @tags = []
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
     def filenames
-      YAML.load_file(state_filename).map do |filename|
+      return [] unless File.exist? state_filename
+
+      Array(YAML.load_file(state_filename)).map do |filename|
         "#{filepath}/#{filename}"
       end
     end

data/lib/gamerom/game_info.rb

@@ -84,7 +84,7 @@ module Gamerom
       tags = []
       codes = @name.scan(/\[(?<code>[^\]]+)\]/).flatten
       codes.each do |code|
-        code = Regexp.last_match(1) if code.match /^(?<code>[abcfhop])[0-9]*/
+        code = Regexp.last_match(1) if code.match(/^(?<code>[abcfhop])[0-9]*/)
         tags << TAGS[code] if TAGS.include?(code)
       end
       tags

data/lib/gamerom/repo.rb

@@ -27,8 +27,8 @@ module Gamerom
       @repo = Gamerom::RepoAdapters.const_get(name.capitalize)
     end
 
-    def install(game, &block)
-      @repo.install game, &block
+    def install(game, &)
+      @repo.install game, &
     end
 
     def find(platform, game_identifier)

data/lib/gamerom/repo_adapter.rb

@@ -12,14 +12,25 @@ module Gamerom
 
     def games(platform)
       games = []
-      progress_bar = ProgressBar.new(platform, sections.count)
+
+      columns = `tput cols`.to_i
+      length = [120, columns].min
+
+      progress_bar = ProgressBar.create(
+        title: platform,
+        total: sections.count,
+        autofinish: true,
+        length: length,
+        format: "%t: %b\e[0;93m\u{15E7}\e[0m%i %j%% %e",
+        progress_mark: ' ',
+        remainder_mark: "\e[0;34m\u{FF65}\e[0m"
+      )
 
       extract_games(platform) do |section_games, section_index|
         games.append(*section_games)
-        progress_bar.set(section_index + 1)
+        progress_bar.progress = section_index + 1
       end
 
-      progress_bar.finish
       games
     end
   end

data/lib/gamerom/repo_adapters/coolrom.rb

@@ -33,6 +33,7 @@ module Gamerom
         'saturn' => 'Sega Saturn',
         'psx' => 'Sony Playstation',
         'ps2' => 'Sony Playstation 2',
+        'ps3' => 'Sony Playstation 3',
         'psp' => 'Sony Playstation Portable',
       }.freeze
 
@@ -48,10 +49,12 @@ module Gamerom
         sections.each_with_index do |section, index|
           page = nokogiri_get("https://coolrom.com.au/roms/#{platform}/#{section}/")
           regions = page.css('input.region').map { |i| i['name'] }
+          game_links = []
           regions.each do |region|
-            game_links = page.css("div.#{region} a")
-            yield game_links.map { |game_link| game(game_link, region) }, index
+            region_game_links = page.css("div.#{region} a")
+            game_links.append(*region_game_links.map { |game_link| game(game_link, region) })
           end
+          yield game_links, index
         end
       end
 
@@ -78,6 +81,7 @@ module Gamerom
         filename = response.filename
         FileUtils.mkdir_p(game.filepath)
         response.save!("#{game.filepath}/#{filename}")
+        puts "Downloaded: #{filename}"
         yield [filename]
       end
     end

data/lib/gamerom/repo_adapters/edgeemu.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'mechanize'
+require 'uri'
+require 'mechanize/progressbar'
+require 'mechanizeprogress'
+
+module Gamerom
+  module RepoAdapters
+    # Edgeemu - An adapter for the Edge Emulation repository website
+    class Edgeemu
+      extend Gamerom::RepoAdapter
+
+      BASE_URL = 'https://edgeemu.net'
+
+      PLATFORM = {
+        'atari-2600' => 'Atari 2600',
+        'atari-5200' => 'Atari 5200',
+        'atari-7800' => 'Atari 7800',
+        'atari-jaguar' => 'Atari Jaguar',
+        'atari-jaguar-cd' => 'Atari Jaguar CD',
+        'atari-lynx' => 'Atari Lynx',
+        'atari-st' => 'Atari ST',
+        'bandai-wonderswan' => 'Bandai WonderSwan',
+        'colecovision' => 'Coleco ColecoVision',
+        'commodore-64' => 'Commodore 64',
+        'commodore-amiga' => 'Commodore Amiga',
+        'commodore-amiga-cd' => 'Commodore Amiga CD',
+        'commodore-amiga-cd32' => 'Commodore Amiga CD32',
+        'commodore-plus-4' => 'Commodore Plus-4',
+        'commodore-vic-20' => 'Commodore VIC-20',
+        'fairchild-channel-f' => 'Fairchild Channel F',
+        'gce-vectrex' => 'GCE Vectrex',
+        'microsoft-msx' => 'Microsoft MSX / MSX2',
+        'nec-pc-engine-cd-turbografx-cd' => 'NEC PC Engine CD / TurboGrafx CD',
+        'nec-pc-engine-supergrafx' => 'NEC PC Engine SuperGrafx',
+        'nec-pc-engine-turbografx-16' => 'NEC PC Engine / TurboGrafx 16',
+        'nintendo-64' => 'Nintendo 64',
+        'nintendo-ds' => 'Nintendo DS',
+        'nintendo-fds' => 'Nintendo Famicom Disk System (FDS)',
+        'nintendo-gameboy' => 'Nintendo Game Boy',
+        'nintendo-gameboy-advance' => 'Nintendo Game Boy Advance',
+        'nintendo-gameboy-color' => 'Nintendo Game Boy Color',
+        'nintendo-gamecube' => 'Nintendo Gamecube',
+        'nintendo-nes' => 'Nintendo Entertainment System (NES)',
+        'nintendo-satellaview' => 'Nintendo Satellaview',
+        'nintendo-snes' => 'Super NES (SNES)',
+        'nintendo-virtualboy' => 'Nintendo Virtual Boy',
+        'panasonic-3do' => 'Panasonic 3DO',
+        'philips-cdi' => 'Philips CDi',
+        'rca-studioii' => 'RCA Studio II',
+        'sega-32x' => 'Sega 32X',
+        'sega-cd' => 'Sega Mega-CD / Sega CD',
+        'sega-dreamcast' => 'Sega Dreamcast',
+        'sega-gamegear' => 'Sega Game Gear',
+        'sega-genesis' => 'Sega Mega Drive / Genesis',
+        'sega-pico' => 'Sega PICO',
+        'sega-saturn' => 'Sega Saturn',
+        'sega-sg1000' => 'Sega SG-1000',
+        'sega-sms' => 'Sega Master System / Mark III',
+        'sinclair-zx-spectrum-3' => 'Sinclair ZX Spectrum +3',
+        'snk-neo-geo-cd' => 'SNK Neo Geo CD',
+        'snk-ngpc' => 'SNK Neo Geo Pocket Color',
+        'watara-supervision' => 'Watara Supervision',
+      }.freeze
+
+      # No-Intro region tags, as they appear in parentheses in the file names
+      REGIONS = [
+        'World', 'USA', 'Europe', 'Japan', 'Asia', 'Australia', 'Brazil', 'Canada', 'China', 'France',
+        'Germany', 'Greece', 'Hong Kong', 'Italy', 'Korea', 'Netherlands', 'Norway', 'Poland', 'Portugal',
+        'Russia', 'Scandinavia', 'Spain', 'Sweden', 'Taiwan', 'UK', 'Unknown', 'Latin America'
+      ].freeze
+
+      def self.platforms
+        PLATFORM
+      end
+
+      def self.sections
+        ('a'..'z').to_a.unshift('1')
+      end
+
+      def self.extract_games(platform)
+        sections.each_with_index do |section, index|
+          page = nokogiri_get("#{BASE_URL}/browse/#{platform}/#{section}")
+          yield page.css('div.item details').map { |item| game(item) }, index
+        rescue RestClient::NotFound
+          yield [], index
+        end
+      end
+
+      # Each item looks like:
+      #   <details data-name="Espial (USA).zip">
+      #     <summary>Espial (USA)</summary>
+      #     <p><a href="/download/atari-2600/Espial%20%28USA%29.zip">download</a> ...</p>
+      #     <p>hash:&nbsp;<span>931A0BDC</span></p>
+      #   </details>
+      # The hash is the CRC32 of the ROM, which is used as the game id.
+      def self.game(item)
+        name = item.at_css('summary').text.strip
+        {
+          id: item.css('p').find { |p| p.text.start_with?('hash') }.at_css('span').text.strip.to_i(16),
+          name: name,
+          region: region(name),
+          url: "#{BASE_URL}#{item.at_css('a[href^="/download/"]')["href"]}",
+        }
+      end
+
+      # "Espial (USA)" => "USA", "Game (USA, Europe) (Proto)" => "USA, Europe"
+      def self.region(name)
+        groups = name.scan(/\(([^)]+)\)/).flatten
+        groups.find { |group| REGIONS.include?(group.split(',').first.strip) } || 'Unknown'
+      end
+
+      def self.install(game)
+        agent = Mechanize.new
+        agent.pluggable_parser.default = Mechanize::Download
+        agent.user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36'
+
+        response = nil
+        agent.progressbar do
+          response = agent.get(game.url)
+        end
+
+        return unless response.code.to_i == 200
+
+        # The Content-Disposition header ends with a stray ";" that Mechanize cannot parse,
+        # so it falls back to the percent-encoded URL basename. Decode it instead.
+        filename = URI.decode_uri_component(File.basename(URI.parse(game.url).path))
+        FileUtils.mkdir_p(game.filepath)
+        response.save!("#{game.filepath}/#{filename}")
+        puts "Downloaded: #{filename}"
+        yield [filename]
+      end
+    end
+  end
+end

data/lib/gamerom/repo_adapters/vimm.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'mechanize'
-require 'mechanize/progressbar'
-require 'mechanizeprogress'
+require 'fileutils'
 
 module Gamerom
   module RepoAdapters
@@ -11,6 +9,10 @@ module Gamerom
       extend Gamerom::RepoAdapter
 
       PLATFORM = {
+        '32X' => 'Sega 32X',
+        'Atari2600' => 'Atari 2600',
+        'Atari5200' => 'Atari 5200',
+        'Atari7800' => 'Atari 7800',
         'Dreamcast' => 'Dreamcast',
         'DS' => 'Nintendo DS',
         'GameCube' => 'GameCube',
@@ -18,6 +20,8 @@ module Gamerom
         'GBA' => 'Game Boy Advance',
         'GBC' => 'Game Boy Color',
         'Genesis' => 'Genesis',
+        'GG' => 'Game Gear',
+        'Lynx' => 'Lynx',
         'N64' => 'Nintendo 64',
         'NES' => 'Nintendo',
         'PS1' => 'PlayStation',
@@ -25,9 +29,16 @@ module Gamerom
         'PS3' => 'PlayStation 3',
         'PSP' => 'PlayStation Portable',
         'Saturn' => 'Saturn',
+        'SegaCD' => 'Sega CD',
+        'SMS' => 'Master System',
         'SNES' => 'Super Nintendo',
+        'TG16' => 'TurboGrafx-16',
+        'TGCD' => 'TurboGrafx-CD',
+        'VB' => 'Virtual Boy',
         'Wii' => 'Wii',
         'WiiWare' => 'WiiWare',
+        'Xbox' => 'Xbox',
+        'Xbox360' => 'Xbox 360',
       }.freeze
 
       def self.platforms
@@ -43,6 +54,8 @@ module Gamerom
           page = nokogiri_get("https://vimm.net/vault/?p=list&system=#{platform}&section=#{section}")
           game_links = page.css('table.hovertable td:first-child a:first-child')
           yield game_links.map { |game_link| game(game_link) }, index
+        rescue RestClient::NotFound
+          yield [], index
         end
       end
 
@@ -54,42 +67,20 @@ module Gamerom
         }
       end
 
+      # Vimm's Lair protects game pages with a browser challenge, so games have to be
+      # downloaded by hand. Prepare the target directory and tell the user what to do.
       def self.install(game)
         FileUtils.mkdir_p(game.filepath)
-        agent = Mechanize.new
-        agent.pluggable_parser.default = Mechanize::Download
-        agent.user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36'
-        page = agent.get("https://vimm.net/vault/#{game.id}")
-        form = page.form_with(id: 'download_form')
-
-        filenames = []
-        game_files = []
-        multiple_disks = page.css('#download_disc_number')
-
-        if multiple_disks.empty?
-          game_files << { id: form['mediaId'], name: 'single file rom' }
-        else
-          puts 'multiple discs detected'
-          game_files.concat(multiple_disks.children[1..-2].map { |disk| { name: disk.text, id: disk['value'] } })
-        end
-
-        game_files.each do |game_file|
-          puts "downloading #{game_file[:name]}"
-          form.method = 'GET'
-          button = form.button_with(type: 'submit')
-          response = nil
-          form['mediaId'] = game_file[:id]
-          agent.progressbar do
-            response = form.click_button(button)
-          end
-
-          break unless response.code.to_i == 200
+        raise Gamerom::ManualDownloadRequired, <<~MSG
+          vimm.net does not allow automated downloads.
+          Download the game from #{game_url(game)} in your browser and save it to:
+            #{game.filepath}/
+          Then run `gamerom recover -r vimm -p #{game.platform}` to register it.
+        MSG
+      end
 
-          filename = response.filename
-          response.save!("#{game.filepath}/#{filename}")
-          filenames << filename
-        end
-        yield filenames
+      def self.game_url(game)
+        "https://vimm.net/vault/#{game.id}"
       end
     end
   end

data/lib/gamerom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamerom
-  VERSION = '0.4.1'
+  VERSION = '0.6.0'
 end

data/lib/gamerom.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'gamerom/errors'
 require_relative 'gamerom/config'
 require_relative 'gamerom/game'
 require_relative 'gamerom/game_info'
 require_relative 'gamerom/repo'
 require_relative 'gamerom/cli'
 require_relative 'gamerom/version'
-
-module Gamerom
-  class Error < StandardError; end
-end

data/lib/mechanizeprogress.rb

@@ -3,6 +3,7 @@
 # Mechanize - A Monkeypatch for the mechanize progressbar
 class Mechanize
   include MechanizeProgressBarAPI # (1of7)a
+
   class HTTP
     # Agent - A Monkeypatch for the mechanize progressbar
     class Agent
@@ -31,11 +32,11 @@ class Mechanize
         log.debug("Read #{total} bytes total") if log && !mpbar.suppress_logger? # (7of7)a
 
         raise Mechanize::ResponseCodeError, response if
-          Net::HTTPUnknownResponse == response
+          response == Net::HTTPUnknownResponse
 
         content_length = response.content_length
 
-        unless Net::HTTP::Head == request || Net::HTTPRedirection == response
+        unless request == Net::HTTP::Head || response == Net::HTTPRedirection
           if content_length && content_length != body_io.length
             raise EOFError, "Content-Length (#{content_length}) does not match response body length (#{body_io.length})"
           end
@@ -46,3 +47,37 @@ class Mechanize
     end
   end
 end
+
+# MechanizeProgressBar - A Monkeypatch for the mechanize progressbar
+class MechanizeProgressBar
+  def inc(step)
+    @progressbar.progress = @progressbar.progress + step if @progressbar
+  end
+
+  def progressbar_new(pbar_opts, request, response)
+    out = pbar_opts[:out] || pbar_opts[:output] || $stderr
+    format = pbar_opts[:format] || "%j%% %b\e[0;93m\u{15E7}\e[0m%i Progress: %c/%C  %a %e  Speed: %rKB/sec %t"
+    if pbar_opts[:single]
+      title = pbar_opts[:title] || request['Host']
+    else
+      title = pbar_opts[:title] || ''
+      out.print "#{pbar_opts[:title] || uri(request)}\n"
+    end
+    total = pbar_opts[:total] || filesize(response)
+    pbar_class = pbar_opts[:reversed] ? ReversedProgressBar : ProgressBar
+
+    columns = `tput cols`.to_i
+    length = [120, columns].min
+
+    pbar_class.create(
+      title: title,
+      total: total,
+      output: out,
+      length: length,
+      format: format,
+      rate_scale: ->(rate) { rate / 1024 },
+      progress_mark: ' ',
+      remainder_mark: "\e[0;34m\u{FF65}\e[0m"
+    )
+  end
+end