#!/usr/bin/ruby
# dskexplorer.rb
#
# == Synopsis
# A web-based DSK file explorer
#
# == Usage
# dskexplorer.rb [switches]
#
# -h | --help display this message
# -p | --port PORT_NUMBER port number to listen on (default is 6502)
# -r | --root ROOT_DIR root directory to explore from (default is current directory)
# -v | --version show version number
#
# Examples
# dskexplorer.rb -r http://www.apple2.org.za/mirrors/
# dskexplorer.rb -r c:\downloads\apple2\ -p 8080
#make sure the relevant folder with our libraries is in the require path
lib_path=File.expand_path(File.dirname(__FILE__)+"//..//lib")
$:.unshift(lib_path) unless $:.include?(lib_path)
require 'optparse'
require 'rdoc_patch' #RDoc::usage patched to work under gem executables
dskexplorer_VERSION="0.1.0"
@listening_port=6502
@@root_directory="."
opts=OptionParser.new
opts.on("-h","--help") {RDoc::usage_from_file(__FILE__)}
opts.on("-v","--version") do
puts File.basename($0)+" "+dskexplorer_VERSION
exit
end
opts.on("-p","--port PORT_NUMBER",Integer) {|val| @listening_port=val%0xFFFF}
opts.on("-r","--root ROOT_DIR",String) {|val| @@root_directory=val}
filename=opts.parse(ARGV)[0] rescue RDoc::usage_from_file(__FILE__,'Usage')
require 'webrick'
require 'DSK'
include WEBrick
@@uri_cache={}
@@dsk_cache={}
def get_uri_from_cache(uri)
if @@uri_cache[uri].nil? then
@@uri_cache[uri]=open(uri).read
end
@@uri_cache[uri]
end
def get_dsk_from_cache(uri)
if @@dsk_cache[uri].nil? then
@@dsk_cache[uri]=DSK.read(uri)
end
@@dsk_cache[uri]
end
def common_header
"
DSK Explorer
"
end
def common_footer
"
this is alpha software - please send feedback using the dsktool.rb forum
"
end
def root_dir_is_website?
require 'hpricot'
require 'open-uri'
@@root_directory=~/^http[s]?:/?true : false
end
def make_absolute_path(relative_path)
if root_dir_is_website? then
@@root_directory+uri_encode(relative_path)
else
@@root_directory+relative_path
end
end
def html_escape(s) s.gsub("&","&").gsub("<","<")end
def uri_encode(s)
#standard URI.escape appears to miss some important characters
require 'uri'
URI.escape(s).gsub("[","%5b").gsub("]","%5d")
end
def get_directories_and_files(relative_path)
directories=[]
dsk_files=[]
absolute_path=make_absolute_path(relative_path)
if root_dir_is_website? then
html=get_uri_from_cache(absolute_path)
doc=Hpricot(html)
doc.search("a[@href]").each do |a|
href=URI.unescape(a.attributes["href"])
if (href=~/\w\/$/)
if !(href=~/^\//) then #directories end with a /, but skip absolute paths
directories<<(href)
end
elsif DSK.is_dsk_file?(href) then
dsk_files<<(href)
end
end
else
if File.exist?(absolute_path) && (File.stat(absolute_path).directory?) then
dir=Dir.new(absolute_path)
dir.each do |f|
directories<0 then
partial_path+="/#{p}"
if DSK.is_dsk_file?(partial_path) then
s<<"/#{p}"
else
s<<"/#{p}"
end
end
end
mode_param=""
if !display_mode.nil? then
mode_param="&mode=#{display_mode}"
end
if !filename.nil? then
s<<"/#{filename}"
end
#show the contents of the current directory
directories,dsk_files=get_directories_and_files(relative_path)
#list out the directories
s<<""
#s<<"- [dir] ..\n"
directories.sort.each do |d|
s<<"
- [dir] #{d}\n"
end
#list out the DSK files
dsk_files.sort.each do |f|
s<<"
- [dsk] #{f} [ download ]\n"
end
s<<"
"
s
end
def make_catalog(relative_path)
s=""
begin
absolute_path=make_absolute_path(relative_path)
dsk=get_dsk_from_cache(absolute_path)
s<<"
file system: #{dsk.file_system}
sector order: #{dsk.sector_order}
tracks: #{dsk.track_count}
"
if (dsk.respond_to?(:files)) then
s<<"
\n| TYPE | SIZE (BYTES) | NAME | \n"
dsk.files.keys.sort.each do |full_path|
f=dsk.files[full_path]
display_url="/showfile/#{uri_encode(relative_path)+'?filename='+uri_encode(full_path)}"
if f.respond_to?(:file_type) then
s<<"#{f.file_type} | "
else
s<<" | "
end
s<<"#{sprintf('%03d',f.contents.length)} | "
s<<"#{full_path} | "
s<<"hex dump | "
if f.can_be_picture? then
s<<"picture | "
elsif f.respond_to?(:disassembly)
s<<"disassembly | "
else
s<<"text | "
end
s<<"\n"
end
s<<"
"
else
s<<"not a recognised format"
end
s<<"View Sectors"
rescue Exception => exception
s<<"ERROR:#{exception}"
end
s
end
def show_sector(relative_path,track,sector)
track="0" if track.nil?
sector="0" if sector.nil?
track=("0"+track).to_i
sector=("0"+sector).to_i
absolute_path=make_absolute_path(relative_path)
dsk=get_dsk_from_cache(absolute_path)
uri="/showsector/#{uri_encode(relative_path)}"
s=""
s<<"
| TRACK |
|---|
"
s<<""
0.upto(dsk.track_count-1) do |track_no|
if track_no==track then
s<<"| $#{sprintf('%02X',track)} | "
else
s<<"$#{sprintf('%02X',track_no)} | "
end
if track_no>0 && track_no%0x10==0 then
s<<"
"
end
end
s<<""
s<<"
"
s<<"| SECTOR |
|---|
"
s<<""
0.upto(0x0F) do |sector_no|
if sector_no==sector then
s<<"| $#{sprintf('%02X',sector)} | "
else
s<<"$#{sprintf('%02X',sector_no)} | "
end
end
s<<"
"
s<<"
"
s<<"\n"
s<\n"
s<<""
s<<"
\n"
s<\n"
end
def show_file(relative_path,filename,display_mode)
absolute_path=make_absolute_path(relative_path)
dsk=get_dsk_from_cache(absolute_path)
file=dsk.files[filename]
if file.nil? then
s="#{filename} not found"
else
s=""
if display_mode=="hex" then
s<"
else
s<"
end
s
end
class DirectoryServlet < HTTPServlet::AbstractServlet
def do_GET(req,res)
relative_path=URI.unescape(req.path).sub(/^\/dir/,"")
res['Content-Type']="text/html"
res.body=common_header+make_navigation_path(relative_path)+common_footer
end
end
class CatalogServlet < HTTPServlet::AbstractServlet
def do_GET(req,res)
relative_path=URI.unescape(req.path).sub(/^\/catalog/,"")
res['Content-Type']="text/html"
res.body=common_header+make_navigation_path(relative_path)+make_catalog(relative_path)+common_footer
end
end
class ShowFileServlet < HTTPServlet::AbstractServlet
def do_GET(req,res)
relative_path=URI.unescape(req.path).sub(/^\/showfile/,"")
filename=URI.unescape(req.query['filename'])
display_mode=req.query['mode']
res['Content-Type']="text/html"
res.body=common_header+make_navigation_path(relative_path,filename,display_mode)+show_file(relative_path,filename,display_mode)+common_footer
end
end
class ShowPNGServlet < HTTPServlet::AbstractServlet
def do_GET(req,res)
relative_path=URI.unescape(req.path).sub(/^\/png/,"")
filename=URI.unescape(req.query['filename'])
pallete_mode=req.query['pallete_mode']
pallete_mode=:"#{pallete_mode}" unless pallete_mode.nil? #convert string to symbol
absolute_path=make_absolute_path(relative_path)
dsk=get_dsk_from_cache(absolute_path)
file=dsk.files[filename]
res['Content-Type']="image/png"
res.body=file.to_png(pallete_mode)
end
end
class ShowSectorServlet < HTTPServlet::AbstractServlet
def do_GET(req,res)
relative_path=URI.unescape(req.path).sub(/^\/showsector/,"")
track=req.query['track']
sector=req.query['sector']
res['Content-Type']="text/html"
res.body=common_header+make_navigation_path(relative_path)+show_sector(relative_path,track,sector)+common_footer
end
end
s=HTTPServer.new(
:Port=>@listening_port
)
trap("INT") {s.shutdown}
s.mount("/dir",DirectoryServlet)
s.mount("/catalog",CatalogServlet)
s.mount("/showfile",ShowFileServlet)
s.mount("/showsector",ShowSectorServlet)
s.mount("/png",ShowPNGServlet)
#default page - for now, just redirect to the default dir page
s.mount("/",DirectoryServlet)
puts "point your browser at http://localhost:#{@listening_port}/"
s.start
# == 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.