ripxplore 0.0.1

data/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/DumpUtilities.rb

@@ -0,0 +1,34 @@
+class DumpUtilities
+  
+  def DumpUtilities.hex_dump(buffer)
+   	s=""
+		(0..(buffer.length/16)).each {|line_number|
+			 lhs=""
+			 rhs=""
+			 start_byte=line_number*16
+			 line=buffer[start_byte..start_byte+15]
+			if line.length>0 then
+				 line.each_byte {|byte|
+					  lhs+= sprintf("%02X ", byte)
+					  rhs+= (byte%128).chr.sub(/[\x00-\x1f]/,'.')
+			 	}
+				lhs+=" "*(16-line.length)*3
+				s+=sprintf("%02X\t%s %s\n",start_byte,lhs,rhs)
+			end
+		}
+		s
+  end
+  
+  def DumpUtilities.font_dump(buffer)
+  #treat buffer as a set 8 bit wide characters
+  s=""
+  c=0
+  buffer.each_byte do |byte| 
+      s<<sprintf(";char %02x\n",c>>3) if c%8==0
+      s<<sprintf("%08b\n",byte).tr("1","#").tr("0"," ")
+      c+=1
+      
+  end
+  s
+  end
+end

data/lib/FileCache.rb

@@ -0,0 +1,84 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'open-uri'
+require 'digest/md5'
+require 'RipXploreLog'
+
+
+class FileCacheItem < File
+  def set_path(path)
+    @path=path
+  end
+  def path
+    @path
+  end
+end
+
+#creates and manages a local cache of files,  so an URL can be requested, if it is in the cache, the local copy is used, otherwise the file is downloaded to the local cache
+class FileCache
+  attr_accessor :cache_dir
+  
+  #create a local_name for a URL. format of local_name "#{cache_dir}/#{Digest::MD5.hexdigest(url)}"
+  def local_name(url)
+    "#{cache_dir}/#{Digest::MD5.hexdigest(url)}.cached"
+  end
+  
+  def initialize(cache_dir)
+    @cache_dir=cache_dir
+    Dir.mkdir(cache_dir) unless File.exists?(cache_dir)
+    raise "cache directory #{cache_dir} invalid" unless File.directory?(cache_dir)
+  end
+  
+  def purge(url)
+    local_file_name=local_name(url)
+    if File.exists?(local_file_name) then
+      RipXploreLog.log "purging local copy of #{url}"
+      File.delete(local_file_name)
+    end
+  end
+  
+  def get(url)
+    local_file_name=local_name(url)
+    if !File.exists?(local_file_name) then
+      RipXploreLog.log "downloading #{url}"
+      remote_file=open(url,"rb")
+      local_file=File.open(local_file_name,"wb")      
+      local_file<<remote_file.read
+      local_file.close
+      local_file_info_filename="#{local_file_name}.info"
+      local_file_info_file=File.open(local_file_info_filename,"w")
+      local_file_info_file<<url
+      local_file_info_file.close
+    end
+    file=FileCacheItem.open(local_file_name,"rb")
+    file.set_path(url)
+    file
+  end
+end
+
+
+
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2008 Jonno Downes (jonno@jamtronix.com)
+#
+#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/lib/FileContainer.rb

@@ -0,0 +1,45 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+#FileContainer is a container for holding files, files can then be retrieved either by a number or a name
+#retrieving by number is necessary when multiple files can have the same name (which is possible on CBM disks especially)
+class FileContainer<Array  
+  def [](index)
+    return super(index) if index.kind_of?(Integer)
+    each do |f| 
+      if f.respond_to?(:full_filename)
+        return f if f.full_filename.upcase==index.upcase
+      else 
+        puts "not a file - #{f.class}"
+      end
+    end
+    nil
+  end  
+end
+
+
+
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2008 Jonno Downes (jonno@jamtronix.com)
+#
+#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/lib/FileSystem.rb

@@ -0,0 +1,83 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'open-uri'
+require 'SubclassTracking'
+require 'RipXploreLog'
+require 'FileContainer'
+#
+#
+class FileSystem 
+  FileSystem.extend SubclassTracking
+  
+  def FileSystem.all_file_systems
+    FileSystem.subclasses
+  end
+  
+  def FileSystem.matching_score
+    0
+  end
+  
+  def FileSystem.non_matching_score
+    -1
+  end
+  
+  #each subclass needs to overide this function to calculate how good a match the specified combination of FileSystem and ImageFormat is for the bytestream in question
+  def FileSystem.compatability_score(filesystem_image)
+    FileSystem.matching_score
+  end
+
+#each subclass needs to overide this function to extract files from a file_system_image
+  def FileSystem.files(file_system_image)
+    []
+  end
+
+
+@@code_for_tests={}
+def self.code_for_tests
+  @@code_for_tests[self] || []
+end
+
+def self.is_valid_file_system_if(code_for_test)
+  #puts "adding test for #{self}: #{code_for_test.source}"
+  @@code_for_tests[self] ||=[]
+  @@code_for_tests[self]<<code_for_test.source
+end
+
+def self.compatability_score(file_system_image)
+  final_score=1
+   code_for_tests.each do |code_for_test|
+    result = eval code_for_test,binding
+#    puts "test for #{file_system_image.filename}#{self} : #{code_for_test} : #{result}"     
+    final_score+=1
+    return 0  unless (result)
+  end
+  return final_score
+end
+end
+
+
+  
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2007 Jonno Downes (jonno@jamtronix.com)
+#
+#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/lib/FileSystemImage.rb

@@ -0,0 +1,176 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'open-uri'
+require 'RipXploreLog'
+
+class FileSystemImage
+
+attr_reader :file_system, :image_format,:filename
+attr_accessor :volume_name
+
+def FileSystemImage.is_file_system_image_filename?(filename)
+  extension=File.extname(File.basename(filename,".gz")).downcase
+  ImageFormat.all_possible_extensions.include?(extension)
+end
+
+#given a bytestream (and, optionally, filename the bytes are from), return the class that is the best match for this class
+def FileSystemImage.best_fit(file_bytes,filename=nil)
+  candidates=[]
+  file_ext=File.extname(filename.sub(/\.gz$/,"")).downcase
+  RipXploreLog.debug("looking for best fit for image format for #{filename} : extension #{file_ext}")
+  ImageFormat.all_image_formats.each do |image_format|
+    if !file_ext.nil? && !image_format.possible_extensions.include?(file_ext) then
+      RipXploreLog.debug("skipping #{image_format} - unmatched extension #{file_ext}")
+    else
+      image_format.possible_file_systems.each do |file_system|
+        RipXploreLog.debug("checking image format #{image_format} and file system #{file_system}")
+        candidate=FileSystemImage.new(file_bytes,file_system,image_format,filename)
+        RipXploreLog.debug("score - #{candidate.compatability_score}")
+        candidates<<candidate
+      end
+    end    
+  end
+  
+  
+  if candidates.length==0 then
+    RipXploreLog.debug( 'no valid combination of file system and image format found')
+    return nil
+  end
+  best_candidate=candidates.sort{|a,b| b.compatability_score<=>a.compatability_score}[0]
+  RipXploreLog.debug("best candidate = #{best_candidate.file_system}/#{best_candidate.image_format} score: #{best_candidate.compatability_score}")
+  best_candidate
+end
+
+@compatability_score=nil
+def compatability_score
+  if @compatability_score.nil? then
+    image_format_compatability_score=image_format.compatability_score(self)    
+    if image_format_compatability_score>0 then #if we don't have a valid image_format, don't bother checking the file_system!
+      file_system_compatability_score=file_system.compatability_score(self)
+      @compatability_score=file_system_compatability_score*image_format_compatability_score
+    else
+      @compatability_score=0
+    end
+  end
+  @compatability_score
+end
+
+def file_bytes
+    return image_format.file_bytes
+end
+
+def get_sector(track,sector)
+  image_format.get_sector(track,sector)
+end
+
+#how many tracks are in this particular image?
+def track_count
+  image_format.track_count
+end
+
+def initialize(file_bytes,file_system,image_format,filename=nil)
+  #@file_bytes=file_bytes
+  @file_system=file_system
+  @image_format=image_format.new(file_bytes)
+  @filename=filename
+  @files=file_system.files(self) if compatability_score>0
+end
+
+
+  def files
+    @files=file_system.files(self) if @files.nil?
+    @files
+  end
+ 
+#return an array containing a list of numbers of valid tracks on this image
+ def track_list
+    image_format.track_list
+end
+
+
+ #return a list of all valid sectors in the specified track on this image
+ def sectors_in_track(track_no)
+  image_format.sectors_in_track(track_no)
+end
+
+def start_track
+  image_format.host_system.start_track
+end
+
+def end_track
+  image_format.end_track
+end
+
+def to_hex_dump
+		s=""   
+		track_list.each {|track| s<<dump_track(track)}
+		s
+  end
+  
+  #return a formatted hex dump of a single 256 byte sector
+	def dump_sector(track,sector)
+  	s=hline
+		s<<sprintf("TRACK: $%02X SECTOR $%02X\n",track,sector)
+		sector_data=get_sector(track,sector)
+		s<< file_system.host_system.hex_dump(sector_data)
+		s
+	end
+
+#return a formatted hex dump of all sectors in a track
+  def dump_track(track)
+    s=""
+      sector_list_for_track(track).each do |sector|
+				s<<dump_sector(track,sector)
+			end
+    s
+	end
+
+def host_system
+  file_system.host_system
+end
+
+#produce a list of all files contained in this file system images
+def catalog
+  s="\n%-32s %-16s %04s   %s\n\n" % ["FILENAME","TYPE","LENGTH","LOAD ADDRESS"]
+  self.files.sort.each do |file|      
+    raise "bogus file '#{file.filename}'" if file.contents.nil?
+    s<<"%-32s %-16s $%04x    $%04x\n" % [file.filename,file.type_description,file.contents.length,file.load_address]
+  end
+  s
+end
+
+
+private
+
+	def hline
+		"-"*79+"\n"
+	end
+
+end
+
+FileSystemImage.extend SubclassTracking
+  
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2008 Jonno Downes (jonno@jamtronix.com)
+#
+#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.