ripxplore 0.13.0 → 0.14.0

data/lib/FileCache.rb

@@ -36,6 +36,10 @@ class FileCache
     index=image.files.index(native_file)
     "#{native_file_cache_dir}/#{Digest::MD5.hexdigest(image.filename)}-#{index}.#{extension}"
   end
+
+  def cache_name_for_icon(native_file)
+    "#{native_file_cache_dir}/#{native_file.icon_tag}.icon.#{native_file.icon_format.to_s}"
+  end
   
   def initialize(url_cache_dir,native_file_cache_dir)
     @url_cache_dir=url_cache_dir
@@ -122,6 +126,16 @@ def force_native_file_to_cache(native_file,method_to_cache_on_native_file,extens
     return cache_filename
 end
 
+def force_icon_to_cache(native_file)
+  cache_filename=cache_name_for_icon(native_file)
+  if ! File.exists?(cache_filename) then    
+      local_file=File.open(cache_filename,"wb")      
+      local_file<<native_file.to_icon
+      local_file.close        
+    end
+    return cache_filename
+end
+
 def purge_native_file_from_cache(native_file)
   Dir.glob(cache_name_for_native_file(native_file,'*')).each do |filename|
     RipXploreLog.log "purging local #{filename}"

data/lib/FileSystemImage.rb

@@ -87,7 +87,7 @@ end
 
   def files
     @files=file_system.files(self) if @files.nil?
-    @files
+    @files.flatten
   end
 
 #return an array containing a list of numbers of valid tracks on this image
@@ -142,7 +142,8 @@ 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]
+    contents_length= (file.contents.respond_to?(:length) ? file.contents.length : 0)
+    s<<"%-32s %-16s $%04x    $%04x\n" % [file.filename,file.type_description,contents_length,file.load_address]
   end
   s
 end

data/lib/LibRipXplore.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'open-uri'
 class RipXplore
 
-VERSION="0.13.0"
+VERSION="0.14.0"
 
 private
 def RipXplore.require_files_in_subdir(dirname)

data/lib/NativeFileType.rb

@@ -114,8 +114,13 @@ class NativeFileType
     RipXploreLog.debug(" #{filename} is a GIF")
     native_file.extend GenericGIF
   end
-    
-  native_file
+  
+  if native_file.respond_to?(:files) then
+  	return [native_file,native_file.files].flatten
+  else 
+  	return native_file
+  end
+
 end
 
 

data/lib/file_systems/CVTArchive.rb

@@ -70,11 +70,14 @@ def self.files(file_system_image)
 		file_contents=file_system_image.file_bytes[0x1FC,file_system_image.file_bytes.length-0x1FC]
 	end
 	file=NativeFileType.best_fit(file_system_image,file_name,file_contents,file_type,geos_file_type)
-	file.meta_data["c64_file_type"]=file_type
-	if (is_geos_file) then
-		file.meta_data["geos_file_structure_type"]=("$%02x" % directory_entry[0x15])
-		file.meta_data["geos_file_type"]=geos_file_type
-		file.meta_data["geos_file_modified_date"]="%04d-%02d-%02d %02d:%02d" % [1900+directory_entry[0x17],directory_entry[0x18],directory_entry[0x19],directory_entry[0x1a],directory_entry[0x1b]]
+	[file].flatten.each do |f|
+	
+		f.meta_data["c64_file_type"]=file_type
+		if (is_geos_file) then
+			f.meta_data["geos_file_structure_type"]=("$%02x" % directory_entry[0x15])
+			f.meta_data["geos_file_type"]=geos_file_type
+			f.meta_data["geos_file_modified_date"]="%04d-%02d-%02d %02d:%02d" % [1900+directory_entry[0x17],directory_entry[0x18],directory_entry[0x19],directory_entry[0x1a],directory_entry[0x1b]]
+		end
 	end
 	files<<file
 #	puts file.to_info_dump

data/lib/file_systems/CbmDos.rb

@@ -77,13 +77,16 @@ def self.files(file_system_image)
 			end
         end
         file=NativeFileType.best_fit(file_system_image,file_name,file_contents,file_type,geos_file_type)
-        file.meta_data["c64_file_type"]="$%02x" % directory_entry[0x02]
-        file.meta_data["first_block"]="track $%02x sector $%02x" % [directory_entry[0x03],directory_entry[04]]
-        if (is_geos_file) then
-        	file.meta_data["geos_file_header"]="track $%02x sector $%02x" % [directory_entry[0x15],directory_entry[16]]
-        	file.meta_data["geos_file_structure_type"]="$%02x" % directory_entry[0x17]
-        	file.meta_data["geos_file_type"]="$%02x" % directory_entry[0x18]
-        	file.meta_data["geos_file_modified_date"]="%04d-%02d-%02d %02d:%02d" % [1900+directory_entry[0x19],directory_entry[0x1A],directory_entry[0x1B],directory_entry[0x1C],directory_entry[0x1D]]
+        [file].flatten.each do |f|
+
+        	f.meta_data["c64_file_type"]="$%02x" % directory_entry[0x02]
+        	f.meta_data["first_block"]="track $%02x sector $%02x" % [directory_entry[0x03],directory_entry[04]]
+	        if (is_geos_file) then
+	        	f.meta_data["geos_file_header"]="track $%02x sector $%02x" % [directory_entry[0x15],directory_entry[16]]
+    	    	f.meta_data["geos_file_structure_type"]="$%02x" % directory_entry[0x17]
+    	    	f.meta_data["geos_file_type"]="$%02x" % directory_entry[0x18]
+        		f.meta_data["geos_file_modified_date"]="%04d-%02d-%02d %02d:%02d" % [1900+directory_entry[0x19],directory_entry[0x1A],directory_entry[0x1B],directory_entry[0x1C],directory_entry[0x1D]]
+        	end
         end
         files<<file
     end

data/lib/native_file_types/c64/C64GeoPaintPic.rb

@@ -40,7 +40,9 @@ def unpacked_picture_bytes
 			when (0..0x3F) then
 #				puts "copy $#{"%02x" % b} bytes"
 				b.times do 
-					line<<record[p].chr
+					c=record[p]
+					c=0 if c.nil?
+					line<<c.chr
 					p+=1
 				end
 			when (0x40..0x7F) then
@@ -62,6 +64,9 @@ def unpacked_picture_bytes
 				raise "invalid code byte #{b}"
 			end
 		end
+		
+		#if we don't have enough data, pad with 0s
+		(line<<"\000"*(1448-line.length)) unless line.length>=1448
 		raise "malformed line (length was #{line.length}) at record ##{record_no}" unless line.length>=1448
 
 #		puts "line length was #{line.length}) at record ##{record_no}"

data/lib/native_file_types/c64/C64GeosFile.rb

@@ -8,8 +8,6 @@ require 'CbmFile'
 
 class C64GeosFile<CbmFile
 
-
-
 is_valid_file_if  lambda {(aux_code!=:not_geos)}
 
 def type_description
@@ -25,7 +23,12 @@ def header_filename
 	return nil unless @contents.kind_of?(Array) && !info_block.nil?
 	info_block[0x4d,16].unpack("A*")[0]
 end
-
+def icon_foreground
+	C64::COLOR_BLACK
+end
+def icon_background
+	C64::COLOR_LTGRAY
+end
 def info_block
 	@contents[0]
 end
@@ -63,7 +66,53 @@ end
     s
   end
 
+def icon_bitmap
+	return nil unless @contents.kind_of?(Array)
+	return @contents[0][5,63]
+end
 
+def to_icon
+  canvas = PNG::Canvas.new icon_width, icon_height, PNG::Color::Green
+
+  buffer=icon_bitmap
+  icon_height.times do |y|
+    row_data=buffer[y*3,3]
+    x=0
+    row_data.each_byte do |byte|
+      8.times do |bit_offset|        
+        bitmask=0b10000000>>bit_offset    
+#        puts "y #{y} x #{x} byte #{"%08b" % byte} bit #{bit_offset} #{"%08b" % bitmask}"
+        if ((byte & bitmask)==bitmask) then
+          canvas[x, y]= icon_foreground
+        else
+          canvas[x, y]= icon_background
+        end
+        x+=1
+      end
+    end
+  end
+  png = PNG.new canvas
+  result=png.raw_bytes
+  result
+end
+
+def icon_width
+  8*3
+end
+def icon_height
+  21
+end
+def icon_format
+  :png
+end
+
+#icon tag is used to allow the same icon in different files to be recognised as identical
+def icon_tag
+	return nil if icon_bitmap.nil?
+	require 'digest/md5'
+  	return Digest::MD5.hexdigest(icon_bitmap)
+	
+end
 
 def meta_data
 	return super unless @contents.kind_of?(Array) && !info_block.nil?

data/lib/native_file_types/c64/C64GeosPhotoAlbum.rb

@@ -0,0 +1,76 @@
+
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+require 'NativeFileType'
+
+require 'C64GeosFile'
+
+
+class C64GeosPhotoAlbum<C64GeosFile
+
+is_valid_file_if  lambda {(aux_code==:application_data)}
+is_valid_file_if  lambda {contents.kind_of?(Array) && (contents[0][0x53,5]=="album")}
+
+def type_description
+	"GEOS Photo Album (#{version})"
+end
+
+def version
+	(@contents[0][0x5A,3])
+
+end
+def files
+	if @files.nil? then
+		@files=[]
+		titles=
+				
+		record_nos.each do |r|
+			next if r==0 
+			next if version.to_i>1 && r==record_nos.last #version 2 albums have titles
+			
+			title_offset=1+(17*(r-1))
+			title=""
+			if (version.to_i>1) then
+				17.times do |i|
+					b=@contents[record_nos.last][title_offset+i]
+					break if b==0 || b.nil?
+					title<<b.chr
+				end
+			end
+			title=("scrap %02x" % r) if title.length<1
+			@files<<C64PhotoScrap.new(self,"#{filename}/#{title}",@contents[r])
+		end
+	end
+	@files
+end
+
+
+end
+
+  
+# == Author
+# Jonno Downes (jonno@jamtronix.com)
+#
+# == Copyright
+# Copyright (c) 2010 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.jukoo

data/lib/native_file_types/c64/C64PhotoScrap.rb

@@ -0,0 +1,141 @@
+#Photo Scrap format is defined on pages 436-438 of the GEOS PROGRAMMER'S REFERENCE GUIDE
+#copy of GEOS GEOS PROGRAMMER'S REFERENCE GUIDE can be found at http://lyonlabs.org/commodore/onrequest/geos.html
+
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+require 'NativeFileType'
+
+require 'C64GeosFile'
+
+ class C64PhotoScrap<C64GeosFile
+ 	is_valid_file_if  lambda {false} #nothing should be automatically detected as this type
+ 
+ 	attr_reader :parent_file
+	
+	def type_description
+  	"Photo Scrap (#{parent_file.header_filename})"
+	end
+	def icon_bitmap
+		return parent_file.icon_bitmap
+	end
+	def filename
+		@filename
+	end
+	def file_system_image
+		parent_file.file_system_image
+	end
+	
+	def file_type
+		parent_file.file_type
+	end 
+	
+	def load_address
+		parent_file.load_address
+	end
+	
+	def aux_code
+		parent_file.aux_code
+	end
+	
+ 	def initialize(parent_file,filename,contents)
+  	   @parent_file=parent_file
+  	   @filename=filename
+ 		@contents=contents
+ 	    @meta_data={}
+ 	end
+ 	
+		
+	def picture_width
+		contents[0]*8
+	end
+	def picture_height
+		(contents[1]+(contents[2]*0x100))
+	end
+	def picture_format
+	  :png
+	end
+
+def unpacked_bytes
+	bitmap_length=(picture_width/8)*picture_height
+	colour_length=(bitmap_length)/8
+
+	if @unpacked_bytes.nil? then
+		@unpacked_bytes=Array.new(bitmap_length+colour_length)
+		in_p=3
+		out_p=0
+		while (in_p<contents.length) do
+			count=contents[in_p]
+			in_p+=1
+			case count
+			when 00..127 then
+				repeat=count
+				b=contents[in_p]
+				in_p+=1
+				repeat.times do 
+					@unpacked_bytes[out_p]=b
+					out_p+=1
+				end				
+			when 128..220 then
+				repeat=count-128
+				repeat.times do 
+					b=contents[in_p]
+					in_p+=1
+					@unpacked_bytes[out_p]=b
+					out_p+=1
+				end				
+			when 221..225 then
+				raise "BIGCOUNT not implemented yet"
+			end
+		end
+#		puts "#{filename} #{in_p} #{out_p} of #{bitmap_length} #{count} #{picture_width}x#{picture_height}"
+
+	end
+	return [@unpacked_bytes[0,bitmap_length],@unpacked_bytes[bitmap_length,colour_length]]
+	
+end
+
+def to_picture
+  require 'PatchedPNG'
+  (bitmap_bytes,colour_bytes)=unpacked_bytes
+  width_in_bytes=picture_width/8
+  canvas = PNG::Canvas.new picture_width,picture_height, C64::COLOR_LTGRAY
+  picture_height.times do |line|
+
+  	line_bytes= bitmap_bytes[width_in_bytes*line,width_in_bytes]
+  	width_in_bytes.times do |i|
+  		pattern_byte=line_bytes[i]
+  		card_number=line/8+i
+  		colour_byte=colour_bytes[card_number]
+  		colour_byte=0x0F if colour_byte.nil?
+  		foreground_colour=C64::COLOR_MAP[colour_byte/0x10]
+  		background_colour=C64::COLOR_MAP[colour_byte%0x10]
+  		y=line
+  		bitmask=0b10000000
+  		8.times do |bit|
+  			x=(i*8)+bit  			
+  			canvas[x,y]=(((pattern_byte & bitmask)==0) ? background_colour : foreground_colour )
+  			bitmask=bitmask/2
+  			
+  		end
+  	end
+  	canvas
+  end
+  png = PNG.new canvas
+  result=png.raw_bytes
+  result
+end
+
+  
+def meta_data
+	@meta_data["photo_scrap_contents_length"]=contents.length
+	@meta_data["photo_scrap_width"]=picture_width
+	@meta_data["photo_scrap_height"]=picture_height
+	@meta_data["photo_scrap_unpacked_bitmap_length"]=unpacked_bytes[0].length
+	@meta_data["photo_scrap_unpacked_colour_table_length"]=unpacked_bytes[1].length
+
+	super
+end
+	
+ end

data/test/tc_c64.rb

@@ -6,6 +6,49 @@ class ImageSniffing < Test::Unit::TestCase
   
   def test_c64_images
 
+
+	f=sniff_url("http://lyonlabs.org/commodore/geoLink/geoLink-20100414.d64",D64,CbmDos,
+      [{:filename=>"GEOlINK.INC",:expected_native_file_type=>C64GeoWriteFile,:save_output=>[:to_icon,'icon.png']}]
+    )
+	icon_tag_0=f.icon_tag
+
+	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSArts/GEOC.06A.CVT",CVT,CVTArchive,
+	[{:filename=>"geoc.6a/scrap 33",:expected_native_file_type=>C64PhotoScrap,:save_output=>[:to_picture,'png']}]
+	)
+	icon_tag_1=f.icon_tag
+	assert_not_equal(icon_tag_0,icon_tag_1)
+	
+	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSArts/BL-SPORTS.CVT",CVT,CVTArchive,
+	[{:filename=>"BL.Sports/Bowling1",:expected_native_file_type=>C64PhotoScrap,:save_output=>[:to_picture,'png']}]
+	)
+	icon_tag_2=f.icon_tag	
+	assert_equal(icon_tag_1,icon_tag_2)
+	
+	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSArts/COUNTRY-PIC.CVT",CVT,CVTArchive,
+	[{:filename=>"COUNTRY SCENERY",:expected_native_file_type=>C64GeoPaintPic,:save_output=>[:to_picture,'png']}]
+	)
+
+
+	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSArts/CMDHARDWARE.CVT",CVT,CVTArchive,
+	[{:filename=>"CMD Hardware/CMD FD-2000",:expected_native_file_type=>C64PhotoScrap,:save_output=>[:to_picture,'png']}]
+	)
+	
+	f.file_system_image.pictures.each do |p|
+		file_cache.purge_native_file_from_cache(p)
+		file_cache.force_native_file_to_cache(p,:to_picture,'png')
+	end
+
+	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSArts/GEOC.01A.CVT",CVT,CVTArchive,
+	[{:filename=>"geoc.1a",:expected_native_file_type=>C64GeosPhotoAlbum}]
+	)		
+	f.file_system_image.pictures.each do |p|
+		file_cache.purge_native_file_from_cache(p)
+		file_cache.force_native_file_to_cache(p,:to_picture,'png')
+	end
+
+		
+#  - photo album
+
 	[[:to_picture,'png'],[:to_font,'bdf']].each do |args|
 	   	sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSFonts/SUPRA-SEXY.CVT",CVT,CVTArchive,
 	      [{:filename=>"Supra Sexy",:expected_native_file_type=>C64GeosFont,:save_output=>args}]
@@ -32,6 +75,7 @@ class ImageSniffing < Test::Unit::TestCase
 
 	end
 
+
     
  #	f=sniff_url("http://cbmfiles.com/genie/geniefiles/GEOSFonts/60DPIMEGAS.SFX",D64,CbmDos,
  #     [{:filename=>"klingon ship",:expected_native_file_type=>C64GeoPaintPic,:save_output=>[:to_picture,'png']}]
@@ -55,9 +99,6 @@ class ImageSniffing < Test::Unit::TestCase
   
 #  	puts f.to_info_dump
  
-	sniff_url("http://lyonlabs.org/commodore/geoLink/geoLink-20100414.d64",D64,CbmDos,
-      [{:filename=>"GEOlINK.INC",:expected_native_file_type=>C64GeoWriteFile}]
-    )
     
 	f=get_file_from_url("http://lyonlabs.org/commodore/geoLink/geoLink-20100414.d64","geoLinkIRCd")
    	f.to_text