rwdtorrent 0.01
Sign up to get free protection for your applications and to get access to all the features.
- data/Readme.txt +146 -0
- data/bin/rwdtorrent +19 -0
- data/code/01rwdcore/01rwdcore.rb +22 -0
- data/code/01rwdcore/02helptexthashbegin.rb +4 -0
- data/code/01rwdcore/03helptexthash.rb +31 -0
- data/code/01rwdcore/04helptextend.rb +6 -0
- data/code/01rwdcore/openhelpwindow.rb +31 -0
- data/code/01rwdcore/returntomain.rb +10 -0
- data/code/01rwdcore/rwdtinkerversion.rb +15 -0
- data/code/01rwdcore/rwdwindowreturn.rb +11 -0
- data/code/01rwdcore/test_cases.rb +126 -0
- data/code/01rwdcore/test_harness.rb +15 -0
- data/code/01rwdcore/uploadreturns.rb +62 -0
- data/code/superant.com.rwdtinkerbackwindow/controlclient.rb +99 -0
- data/code/superant.com.rwdtinkerbackwindow/diagnostictab.rb +25 -0
- data/code/superant.com.rwdtinkerbackwindow/helptexthashtinkerwin2.rb +61 -0
- data/code/superant.com.rwdtinkerbackwindow/installapplet.rb +24 -0
- data/code/superant.com.rwdtinkerbackwindow/installgemapplet.rb +20 -0
- data/code/superant.com.rwdtinkerbackwindow/installremotegem.rb +19 -0
- data/code/superant.com.rwdtinkerbackwindow/listgemdirs.rb +12 -0
- data/code/superant.com.rwdtinkerbackwindow/listgemzips.rb +54 -0
- data/code/superant.com.rwdtinkerbackwindow/listinstalledfiles.rb +11 -0
- data/code/superant.com.rwdtinkerbackwindow/listzips.rb +31 -0
- data/code/superant.com.rwdtinkerbackwindow/loadconfigurationrecord.rb +32 -0
- data/code/superant.com.rwdtinkerbackwindow/loadconfigurationvariables.rb +13 -0
- data/code/superant.com.rwdtinkerbackwindow/network.rb +87 -0
- data/code/superant.com.rwdtinkerbackwindow/openappletname.rb +18 -0
- data/code/superant.com.rwdtinkerbackwindow/openhelpwindowtinkerwin2.rb +42 -0
- data/code/superant.com.rwdtinkerbackwindow/remotegemlist.rb +24 -0
- data/code/superant.com.rwdtinkerbackwindow/removeapplet.rb +32 -0
- data/code/superant.com.rwdtinkerbackwindow/runrwdtinkerbackwindow.rb +12 -0
- data/code/superant.com.rwdtinkerbackwindow/rwdtinkerwin2version.rb +14 -0
- data/code/superant.com.rwdtinkerbackwindow/saveconfigurationrecord.rb +18 -0
- data/code/superant.com.rwdtinkerbackwindow/viewappletcontents.rb +21 -0
- data/code/superant.com.rwdtinkerbackwindow/viewgemappletcontents.rb +21 -0
- data/code/superant.com.rwdtorrent/helptesthashrwdtorrent.rb +55 -0
- data/code/superant.com.rwdtorrent/listnamerecord.rb +15 -0
- data/code/superant.com.rwdtorrent/loadconfigurationrecord.rb +36 -0
- data/code/superant.com.rwdtorrent/loadconfigurationvariables.rb +13 -0
- data/code/superant.com.rwdtorrent/openhelpwindowtorrent.rb +32 -0
- data/code/superant.com.rwdtorrent/returntomain.rb +10 -0
- data/code/superant.com.rwdtorrent/runtorrentwindow.rb +57 -0
- data/code/superant.com.rwdtorrent/rwdtorrenthelpabout.rb +14 -0
- data/code/superant.com.rwdtorrent/saveconfigurationrecord.rb +18 -0
- data/code/superant.com.rwdtorrent/stoptorrentdownload.rb +12 -0
- data/code/superant.com.rwdtorrent/viewtorrentlist.rb +20 -0
- data/code/superant.com.rwdtorrent/viewtorrentmetafile.rb +36 -0
- data/code/zz0applicationend/zz0end.rb +4 -0
- data/configuration/language.dist +7 -0
- data/configuration/rwdapplicationidentity.dist +3 -0
- data/configuration/rwdtinker.dist +15 -0
- data/configuration/rwdtorrent.dist +11 -0
- data/configuration/tinkerwin2variables.dist +17 -0
- data/downloads/nodownloads.txt +1 -0
- data/ev/browser.rb +109 -0
- data/ev/ftools.rb +170 -0
- data/ev/net.rb +750 -0
- data/ev/ruby.rb +819 -0
- data/ev/rwd.rb +1849 -0
- data/ev/sgml.rb +236 -0
- data/ev/thread.rb +63 -0
- data/ev/tree.rb +343 -0
- data/ev/xml.rb +4 -0
- data/extras/aversa.rb +261 -0
- data/extras/rconftool.rb +380 -0
- data/extras/rubytorrent.rb +94 -0
- data/extras/rubytorrent/bencoding.rb +174 -0
- data/extras/rubytorrent/controller.rb +610 -0
- data/extras/rubytorrent/message.rb +128 -0
- data/extras/rubytorrent/metainfo.rb +214 -0
- data/extras/rubytorrent/package.rb +600 -0
- data/extras/rubytorrent/peer.rb +536 -0
- data/extras/rubytorrent/server.rb +166 -0
- data/extras/rubytorrent/tracker.rb +225 -0
- data/extras/rubytorrent/typedstruct.rb +132 -0
- data/extras/rubytorrent/util.rb +186 -0
- data/extras/zip/ioextras.rb +114 -0
- data/extras/zip/stdrubyext.rb +111 -0
- data/extras/zip/tempfile_bugfixed.rb +195 -0
- data/extras/zip/zip.rb +1377 -0
- data/extras/zip/zipfilesystem.rb +558 -0
- data/extras/zip/ziprequire.rb +61 -0
- data/gui/00coreguibegin/applicationguitop.rwd +4 -0
- data/gui/frontwindow0/10viewnote.rwd +32 -0
- data/gui/frontwindow0/30viewtorrent.rwd +13 -0
- data/gui/frontwindow0/40rwdtorrentrefresh.rwd +28 -0
- data/gui/frontwindow0/67viewconfiguration.rwd +38 -0
- data/gui/frontwindowselectionbegin/selectiontabbegin/selectiontabbegin.rwd +16 -0
- data/gui/frontwindowselections/superant.com.rwdtinkerwin2selectiontab/rwdwin2selectiontab.rwd +12 -0
- data/gui/frontwindowselectionzend/viewselectionzend/viewselectionend.rwd +3 -0
- data/gui/frontwindowtdocumentbegin/superant.com.documentsbegin/tt0documentbegin.rwd +6 -0
- data/gui/frontwindowtdocuments/superant.com.documents/uu5documents.rwd +15 -0
- data/gui/frontwindowtdocuments/superant.com.tinkerwin2documents/uu5documents.rwd +6 -0
- data/gui/frontwindowtdocuments/superant.com.torrentdocument/doctorrent.rwd +6 -0
- data/gui/frontwindowtdocumentzend/superant.com.documentsend/ww0documentend.rwd +12 -0
- data/gui/frontwindowz1end/frontwindowend/xx0rwdfirsttab.rwd +6 -0
- data/gui/helpaboutbegin/superant.com.helpaboutbegin/ya0helpscreenstart.rwd +3 -0
- data/gui/helpaboutinstalled/superant.com.tinkerhelpabout/1appname.rwd +4 -0
- data/gui/helpaboutinstalled/superant.com.tinkerhelpabout/3copyright.rwd +3 -0
- data/gui/helpaboutinstalled/superant.com.tinkerhelpabout/5version.rwd +10 -0
- data/gui/helpaboutinstalled/superant.com.torrenthelpabout/1appname.rwd +4 -0
- data/gui/helpaboutinstalled/superant.com.torrenthelpabout/3copyright.rwd +3 -0
- data/gui/helpaboutinstalled/superant.com.torrenthelpabout/5version.rwd +9 -0
- data/gui/helpaboutzend/superant.com.helpaboutend/helpscreenend.rwd +3 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/1appname.rwd +5 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/40rwdlistzips.rwd +42 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/45installremotezip.rwd +44 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/50rwdlistapplets.rwd +44 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/60editconfiguration.rwd +38 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/70rwddiagnostics.rwd +29 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/75rwdcontrol.rwd +33 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/80tab1.rwd +11 -0
- data/gui/tinkerbackwindows/superant.com.tinkerbackwindow/9backend.rwd +6 -0
- data/gui/tinkerbackwindows/superant.com.tinkerhelpwindow/1appname.rwd +31 -0
- data/gui/tinkerbackwindows/superant.com.tinkerhelpwindow/9end.rwd +4 -0
- data/gui/tinkerbackwindows/superant.com.torrentdisplay/torrentdisplaywindow.rwd +31 -0
- data/gui/tinkerbackwindows/superant.com.versionwindow/1appname.rwd +19 -0
- data/gui/zzcoreguiend/tinkerapplicationguiend/yy9rwdend.rwd +4 -0
- data/init.rb +277 -0
- data/installed/rwdviewlogo-0.4.inf +4 -0
- data/lang/en/rwdcore/languagefile.rb +16 -0
- data/lang/es/rwdcore/languagefile-es.rb +14 -0
- data/lang/jp/rwdcore/languagefile.rb +9 -0
- data/lang/nl/rwdcore/languagefile.rb +19 -0
- data/lib/temp.rb +1 -0
- data/rwd_files/HowTo_Tinker.txt +405 -0
- data/rwd_files/HowTo_TinkerWin2.txt +202 -0
- data/rwd_files/HowTo_Torrent.txt +146 -0
- data/rwd_files/Readme.txt +57 -0
- data/rwd_files/favicon.ico +0 -0
- data/rwd_files/rdoc-style.css +175 -0
- data/rwd_files/rwdapplications.html +54 -0
- data/rwd_files/rwdindex.html +6 -0
- data/rwd_files/tinker.png +0 -0
- data/rwdconfig.dist +10 -0
- data/tests/checkdepends.sh +4 -0
- data/tests/cleancnf.sh +5 -0
- data/tests/makedist.rb +44 -0
- data/tests/rdep.rb +354 -0
- data/tests/rwdtinkertestEN.rb +163 -0
- data/tests/test.result +32 -0
- data/tests/totranslate.lang +93 -0
- data/torrentfiles/freeculture-audiobook.zip.torrent +0 -0
- data/torrentfiles/freeculture.zip.torrent +0 -0
- data/zips/rwdahelloworld-0.5.zip +0 -0
- metadata +199 -0
data/ev/xml.rb
ADDED
data/extras/aversa.rb
ADDED
@@ -0,0 +1,261 @@
|
|
1
|
+
#!/usr/local/bin/ruby
|
2
|
+
|
3
|
+
require 'net/http'
|
4
|
+
require 'optparse'
|
5
|
+
require 'ostruct'
|
6
|
+
require 'uri'
|
7
|
+
require 'digest/sha1'
|
8
|
+
|
9
|
+
AVERSA_VERSION = 0.3
|
10
|
+
|
11
|
+
class Encoder
|
12
|
+
def encode_hash(hash, res="")
|
13
|
+
res << "d"
|
14
|
+
sorted = hash.sort # note that BEncoding implies sorted keys
|
15
|
+
sorted.each {|x|
|
16
|
+
encode_str(x[0], res)
|
17
|
+
if x[1].kind_of?(String)
|
18
|
+
encode_str(x[1], res)
|
19
|
+
elsif x[1].kind_of?(Fixnum) || x[1].kind_of?(Bignum)
|
20
|
+
encode_int(x[1], res)
|
21
|
+
elsif x[1].kind_of?(Array)
|
22
|
+
encode_list(x[1], res)
|
23
|
+
elsif x[1].kind_of?(Hash)
|
24
|
+
encode_hash(x[1], res)
|
25
|
+
end
|
26
|
+
}
|
27
|
+
res << "e"
|
28
|
+
end
|
29
|
+
def encode_list(list, res="")
|
30
|
+
res << "l"
|
31
|
+
list.each {|x|
|
32
|
+
if x.kind_of?(String)
|
33
|
+
encode_str(x, res)
|
34
|
+
elsif x.kind_of?(Number)
|
35
|
+
encode_int(x, res)
|
36
|
+
elsif x.kind_of?(Array)
|
37
|
+
encode_list(x, res)
|
38
|
+
elsif x.kind_of?(Hash)
|
39
|
+
encode_hash(x, res)
|
40
|
+
else
|
41
|
+
raise "Unknown type to encode #{x.class}"
|
42
|
+
end
|
43
|
+
}
|
44
|
+
res << "e"
|
45
|
+
end
|
46
|
+
def encode_str(str, res="")
|
47
|
+
res << "#{str.size}:#{str}"
|
48
|
+
end
|
49
|
+
def encode_int(int, res="")
|
50
|
+
res << "i#{int}e"
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
class AbstractDecoder
|
55
|
+
def make(char)
|
56
|
+
if char =~ /^[1-9]/
|
57
|
+
return StringCodec.new
|
58
|
+
elsif char == "i"
|
59
|
+
return IntegerCodec.new
|
60
|
+
elsif char == "l"
|
61
|
+
return ListCodec.new
|
62
|
+
elsif char == "d"
|
63
|
+
return DictionaryCodec.new
|
64
|
+
end
|
65
|
+
raise "Unknown BCoding type: #{char}"
|
66
|
+
end
|
67
|
+
end
|
68
|
+
class DictionaryCodec < AbstractDecoder
|
69
|
+
def decode(txt)
|
70
|
+
h = {}
|
71
|
+
txt = txt.slice(1, txt.size-1) # remove leading "d"
|
72
|
+
while txt.length > 0
|
73
|
+
if txt[0].chr == "e"
|
74
|
+
txt = txt.slice(1, txt.size-1)
|
75
|
+
break
|
76
|
+
end
|
77
|
+
txt, key = make(txt[0].chr).decode(txt)
|
78
|
+
txt, value = make(txt[0].chr).decode(txt)
|
79
|
+
h[key] = value
|
80
|
+
end
|
81
|
+
[txt, h]
|
82
|
+
end
|
83
|
+
end
|
84
|
+
class ListCodec < AbstractDecoder
|
85
|
+
def decode(txt)
|
86
|
+
list = []
|
87
|
+
txt = txt.slice(1, txt.size-1) # remove leading "l"
|
88
|
+
while txt.length > 0
|
89
|
+
if txt[0].chr == "e"
|
90
|
+
txt = txt.slice(1, txt.size-1)
|
91
|
+
break
|
92
|
+
end
|
93
|
+
txt, value = make(txt[0].chr).decode(txt)
|
94
|
+
list << value
|
95
|
+
end
|
96
|
+
[txt, list]
|
97
|
+
end
|
98
|
+
end
|
99
|
+
class IntegerCodec
|
100
|
+
def decode(txt)
|
101
|
+
end_num = txt =~ /e/
|
102
|
+
value = txt.slice(1, end_num - 1).to_i
|
103
|
+
newtxt = txt.slice(end_num + 1, txt.size)
|
104
|
+
[newtxt, value]
|
105
|
+
end
|
106
|
+
end
|
107
|
+
class StringCodec
|
108
|
+
def decode(txt)
|
109
|
+
length = txt.split(":")[0].to_i
|
110
|
+
text_start = txt.index(":") + 1
|
111
|
+
text_end = text_start + length
|
112
|
+
newtxt = txt.slice(text_end, txt.size-text_end)
|
113
|
+
value = txt.slice(text_start, length)
|
114
|
+
[newtxt, value]
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
class PrettyPrinter
|
119
|
+
def print(obj, depth=0)
|
120
|
+
if obj.kind_of?(Hash)
|
121
|
+
obj.sort.each {|x|
|
122
|
+
if x[1].kind_of?(Array) && x[0] == "path"
|
123
|
+
show(x[0], x[1].join("/"), depth)
|
124
|
+
elsif x[1].kind_of?(Hash) && x[0] == "resume"
|
125
|
+
show(x[0], "[Resume data]", depth)
|
126
|
+
elsif x[1].kind_of?(Hash) && x[0] == "tracker_cache"
|
127
|
+
show(x[0], "[Tracker data]", depth)
|
128
|
+
elsif x[1].kind_of?(Hash) || x[1].kind_of?(Array)
|
129
|
+
show(x[0], "", depth)
|
130
|
+
print(x[1], depth + 1)
|
131
|
+
else
|
132
|
+
show(x[0], x[1], depth)
|
133
|
+
end
|
134
|
+
}
|
135
|
+
elsif obj.kind_of?(Array)
|
136
|
+
obj.each {|x| print(x, depth + 1) }
|
137
|
+
else
|
138
|
+
show("", obj, depth)
|
139
|
+
end
|
140
|
+
end
|
141
|
+
def show(label, txt, depth)
|
142
|
+
if label == "pieces"
|
143
|
+
txt = "[#{txt.size/20} SHA checksums]"
|
144
|
+
elsif label == "creation date"
|
145
|
+
txt = Time.at(txt).to_s
|
146
|
+
end
|
147
|
+
puts "#{"".ljust(depth)}#{label} #{txt} "
|
148
|
+
end
|
149
|
+
end
|
150
|
+
|
151
|
+
class PiecesCalc
|
152
|
+
def pieces(piece_size, file_size)
|
153
|
+
return file_size / piece_size if file_size % piece_size == 0
|
154
|
+
(file_size.to_f / piece_size.to_f).to_i + 1
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
class MetaInfo
|
159
|
+
DEFAULT_PIECE_LENGTH = 262144
|
160
|
+
attr_reader :hash
|
161
|
+
def makemetafile(file,trackerurl)
|
162
|
+
@hash = {}
|
163
|
+
@hash["announce"] = trackerurl
|
164
|
+
@hash["creation date"] = Time.now.to_i
|
165
|
+
@hash["created by"] = "Aversa (http://aversa.rubyforge.org) v#{AVERSA_VERSION}"
|
166
|
+
@hash["info"] = {}
|
167
|
+
@hash["info"]["name"] = file
|
168
|
+
@hash["info"]["piece length"] = DEFAULT_PIECE_LENGTH
|
169
|
+
gather_date_for_actual_file if File.exists?(file)
|
170
|
+
write
|
171
|
+
end
|
172
|
+
def add(key, value)
|
173
|
+
@hash[key] = value
|
174
|
+
end
|
175
|
+
def write
|
176
|
+
File.open("#{@hash['info']['name']}.torrent", "w") {|f|
|
177
|
+
f.write(Encoder.new.encode_hash(@hash))
|
178
|
+
}
|
179
|
+
end
|
180
|
+
def gather_date_for_actual_file
|
181
|
+
# should do this in chunks, not all at once
|
182
|
+
data = File.read(@hash["info"]["name"])
|
183
|
+
@hash["info"]["length"] = data.size
|
184
|
+
pieces = PiecesCalc.new.pieces(@hash["info"]["piece length"], @hash["info"]["length"])
|
185
|
+
pieces_string = ""
|
186
|
+
pieces.times {|piece|
|
187
|
+
d = Digest::SHA1.new
|
188
|
+
offset = piece * @hash["info"]["piece length"]
|
189
|
+
if (@hash["info"]["length"] - offset) < @hash["info"]["piece length"]
|
190
|
+
d << data.slice(offset, data.size-offset)
|
191
|
+
else
|
192
|
+
d << data.slice(offset, @hash["info"]["piece length"])
|
193
|
+
end
|
194
|
+
pieces_string << d.digest
|
195
|
+
}
|
196
|
+
@hash["info"]["pieces"] = pieces_string
|
197
|
+
end
|
198
|
+
def decode(file)
|
199
|
+
txt, @hash = DictionaryCodec.new.decode(File.read(file))
|
200
|
+
end
|
201
|
+
def decode_txt(txt)
|
202
|
+
txt, @hash = DictionaryCodec.new.decode(txt)
|
203
|
+
end
|
204
|
+
def decode_url(url)
|
205
|
+
data = Net::HTTP.get(URI.parse(url))
|
206
|
+
txt, @hash = DictionaryCodec.new.decode(data)
|
207
|
+
end
|
208
|
+
def announce
|
209
|
+
@hash["announce"]
|
210
|
+
end
|
211
|
+
def creation_date
|
212
|
+
@hash["creation date"]
|
213
|
+
end
|
214
|
+
def encoding
|
215
|
+
@hash["encoding"]
|
216
|
+
end
|
217
|
+
def name
|
218
|
+
@hash["info"]["name"]
|
219
|
+
end
|
220
|
+
def piece_length
|
221
|
+
@hash["info"]["piece length"]
|
222
|
+
end
|
223
|
+
def pieces
|
224
|
+
@hash["info"]["pieces"]
|
225
|
+
end
|
226
|
+
def key(str)
|
227
|
+
@hash[str]
|
228
|
+
end
|
229
|
+
def print
|
230
|
+
PrettyPrinter.new.print(@hash)
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
# http://www.tlm-project.org/kernels/2.6.x/linux-2.6.5.tar.bz2.torrent
|
235
|
+
# ../../metainfo_samples/specifix.torrent
|
236
|
+
if __FILE__ == $0
|
237
|
+
setup = OpenStruct.new
|
238
|
+
ARGV.options {|opt|
|
239
|
+
opt.banner = "Usage: aversa.rb [options]"
|
240
|
+
opt.on("Options:")
|
241
|
+
opt.on("--decode SOURCE", String, "Specify metainfo file or URL to be parsed") {|src| setup.decode = src }
|
242
|
+
opt.on("--makemetafile file,tracker", Array, "Specify a file and a tracker URL for which to create a metainfo file") {|arr| setup.makemetafile = arr}
|
243
|
+
opt.on("--help", "Display a usage message") { puts opt ; exit(0)}
|
244
|
+
opt.parse!
|
245
|
+
}
|
246
|
+
|
247
|
+
if !setup.decode.nil?
|
248
|
+
m = MetaInfo.new
|
249
|
+
if setup.decode =~ /^http/
|
250
|
+
m.decode_url(setup.decode)
|
251
|
+
else
|
252
|
+
m.decode(setup.decode)
|
253
|
+
end
|
254
|
+
m.print
|
255
|
+
elsif setup.makemetafile
|
256
|
+
m = MetaInfo.new
|
257
|
+
m.makemetafile(setup.makemetafile[0], setup.makemetafile[1])
|
258
|
+
m.write
|
259
|
+
m.print
|
260
|
+
end
|
261
|
+
end
|
data/extras/rconftool.rb
ADDED
@@ -0,0 +1,380 @@
|
|
1
|
+
#!/usr/local/bin/ruby -w
|
2
|
+
|
3
|
+
# Copyright (c) 2005 Brian Candler
|
4
|
+
#
|
5
|
+
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
# of this software and associated documentation files (the "Software"), to
|
7
|
+
# deal in the Software without restriction, including without limitation the
|
8
|
+
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
9
|
+
# sell copies of the Software, and to permit persons to whom the Software is
|
10
|
+
# furnished to do so, subject to the following conditions:
|
11
|
+
#
|
12
|
+
# The above copyright notice and this permission notice shall be included in
|
13
|
+
# all copies or substantial portions of the Software.
|
14
|
+
#
|
15
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
20
|
+
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
21
|
+
# IN THE SOFTWARE.
|
22
|
+
|
23
|
+
##########################################################################
|
24
|
+
# rconftool is a reimplementation of Sam Varshavchik's sysconftool in Ruby.
|
25
|
+
# See http://www.courier-mta.org/sysconftool/ for details of the original.
|
26
|
+
# Its purpose is to keep configuration files "fresh" when upgrading an
|
27
|
+
# application from one version to another, ensuring that all necessary
|
28
|
+
# settings are present and obsolete ones removed.
|
29
|
+
#
|
30
|
+
# rconftool can be called as a library function or from the command line. It
|
31
|
+
# can also install groups of files recursively from one directory tree into
|
32
|
+
# another.
|
33
|
+
##########################################################################
|
34
|
+
|
35
|
+
require 'fileutils'
|
36
|
+
|
37
|
+
module Rconftool
|
38
|
+
VERSION = "0.1"
|
39
|
+
class NoVersionLine < RuntimeError; end
|
40
|
+
|
41
|
+
# This module function installs a single source (.dist) file to a target
|
42
|
+
# location, having first merged in any compatible settings from the
|
43
|
+
# target file if it existed previously [if it does not exist, any settings
|
44
|
+
# from 'oldfile' are used instead]
|
45
|
+
#
|
46
|
+
# If the distfile is not in sysconftool format (i.e. doesn't have a
|
47
|
+
# ##VERSION: header within the first 20 lines), then for safety it is only
|
48
|
+
# installed if the target file does not already exist. No attempt at data
|
49
|
+
# merging is made in that case.
|
50
|
+
|
51
|
+
def self.install(distfile, targetfile=nil, oldfile=nil, opt={})
|
52
|
+
debug = opt[:debug] || $stdout
|
53
|
+
|
54
|
+
targetfile ||= distfile
|
55
|
+
if opt[:strip_regexp]
|
56
|
+
targetfile = targetfile.sub(opt[:strip_regexp], '')
|
57
|
+
oldfile = oldfile.sub(opt[:strip_regexp], '') if oldfile
|
58
|
+
end
|
59
|
+
if opt[:add_suffix]
|
60
|
+
targetfile = targetfile + opt[:add_suffix]
|
61
|
+
oldfile = oldfile + opt[:add_suffix] if oldfile
|
62
|
+
end
|
63
|
+
raise Errno::EEXIST, "#{distfile}: dist and target filenames are the same" if distfile == targetfile
|
64
|
+
|
65
|
+
# Read in the source (.dist) file
|
66
|
+
begin
|
67
|
+
src = ConfigFile.new(distfile)
|
68
|
+
rescue NoVersionLine
|
69
|
+
# Fallback behaviour when installing a file which is not in sysconftool
|
70
|
+
# format: we install the file only if it doesn't already exist
|
71
|
+
if File.exist?(targetfile)
|
72
|
+
debug << "#{targetfile}: already exists, skipping\n"
|
73
|
+
return
|
74
|
+
end
|
75
|
+
return if opt[:noclobber]
|
76
|
+
copyfrom = (oldfile and File.exist?(oldfile)) ? oldfile : distfile
|
77
|
+
if File.symlink?(copyfrom)
|
78
|
+
File.symlink(File.readlink(copyfrom), targetfile)
|
79
|
+
debug << "#{targetfile}: symlink copied from #{copyfrom}\n"
|
80
|
+
else
|
81
|
+
FileUtils.cp copyfrom, targetfile, :preserve=>true
|
82
|
+
debug << "#{targetfile}: copied from #{copyfrom}\n"
|
83
|
+
end
|
84
|
+
return
|
85
|
+
end
|
86
|
+
|
87
|
+
# OK, so we have a sysconftool file to install. Read in the existing
|
88
|
+
# target file, or if that does not exist, the oldfile
|
89
|
+
begin
|
90
|
+
old = ConfigFile.new
|
91
|
+
old.read(targetfile)
|
92
|
+
rescue NoVersionLine
|
93
|
+
# That's OK; the old target will be renamed to .bak
|
94
|
+
rescue Errno::ENOENT
|
95
|
+
begin
|
96
|
+
target_missing = true
|
97
|
+
old.read(oldfile) if oldfile
|
98
|
+
rescue Errno::ENOENT, NoVersionLine
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# Same VERSION? No merge is required
|
103
|
+
if src.version == old.version and not opt[:force]
|
104
|
+
if target_missing
|
105
|
+
FileUtils.cp oldfile, targetfile, :preserve=>true
|
106
|
+
debug << "#{targetfile}: same VERSION, copied from #{oldfile}\n"
|
107
|
+
return
|
108
|
+
end
|
109
|
+
debug << "#{targetfile}: same VERSION, no change\n"
|
110
|
+
return
|
111
|
+
end
|
112
|
+
|
113
|
+
# Merge in old settings (note: any settings which are in targetfile but
|
114
|
+
# not in distfile will be silently dropped)
|
115
|
+
debug << "#{targetfile}:\n"
|
116
|
+
src.settings[1..-1].each do |src_setting|
|
117
|
+
name = src_setting.name
|
118
|
+
old_setting = old[name]
|
119
|
+
unless old_setting
|
120
|
+
debug << " #{name}: new\n"
|
121
|
+
next
|
122
|
+
end
|
123
|
+
if old_setting.version == src_setting.version
|
124
|
+
debug << " #{name}: unchanged\n"
|
125
|
+
src_setting.add_comment("\n DEFAULT SETTING from #{distfile}:\n")
|
126
|
+
src_setting.add_comment(src_setting.content)
|
127
|
+
src_setting.content = old_setting.content
|
128
|
+
next
|
129
|
+
end
|
130
|
+
# Otherwise, must install updated setting and comment out
|
131
|
+
# the current setting for reference
|
132
|
+
debug << " #{name}: UPDATED\n"
|
133
|
+
src_setting.add_comment("\n Previous setting (inserted by rconftool):\n\n")
|
134
|
+
src_setting.add_comment(old_setting.content)
|
135
|
+
end
|
136
|
+
|
137
|
+
return if opt[:noclobber]
|
138
|
+
|
139
|
+
# Write out the new file and carry forward permissions
|
140
|
+
begin
|
141
|
+
tempfile = targetfile+".new#{$$}"
|
142
|
+
src.write(tempfile)
|
143
|
+
st = File.stat(distfile)
|
144
|
+
begin
|
145
|
+
File.chown(st.uid, st.gid, tempfile)
|
146
|
+
rescue Errno::EPERM
|
147
|
+
end
|
148
|
+
File.chmod(st.mode, tempfile)
|
149
|
+
File.rename(targetfile, targetfile+".bak") unless target_missing
|
150
|
+
File.rename(tempfile, targetfile)
|
151
|
+
rescue
|
152
|
+
File.delete(tempfile) rescue nil
|
153
|
+
raise
|
154
|
+
end
|
155
|
+
end
|
156
|
+
|
157
|
+
HEADER_ID = '__header__'
|
158
|
+
|
159
|
+
# Object to represent a single setting
|
160
|
+
|
161
|
+
class Setting
|
162
|
+
attr_reader :name, :version
|
163
|
+
attr_accessor :content
|
164
|
+
|
165
|
+
def initialize(name, version)
|
166
|
+
@name = name.gsub(/\s+/,'')
|
167
|
+
@version = version.gsub(/s+/,'')
|
168
|
+
@comment = ""
|
169
|
+
@content = ""
|
170
|
+
@in_content = false
|
171
|
+
end
|
172
|
+
def <<(str)
|
173
|
+
@in_content = true unless /\A#/ =~ str
|
174
|
+
if @in_content
|
175
|
+
@content << str
|
176
|
+
else
|
177
|
+
@comment << str
|
178
|
+
end
|
179
|
+
end
|
180
|
+
# Add text to 'comment' portion of setting, prefixing each line with '#'
|
181
|
+
def add_comment(str)
|
182
|
+
@comment << str.gsub(/^/,'#')
|
183
|
+
end
|
184
|
+
def to_s
|
185
|
+
return "#{@comment}#{@content}" if @name == HEADER_ID
|
186
|
+
return "##NAME: #{@name}:#{@version}\n#{@comment}#{@content}"
|
187
|
+
end
|
188
|
+
end # class Setting
|
189
|
+
|
190
|
+
# Object to represent an entire configuration file. It consists of
|
191
|
+
# an array of Setting objects, with the first one having a special name
|
192
|
+
# (__header__). We also keep a hash of setting name => setting object
|
193
|
+
# to enable us to find a particular setting quickly.
|
194
|
+
|
195
|
+
class ConfigFile
|
196
|
+
attr_reader :version, :settings
|
197
|
+
|
198
|
+
def initialize(filename=nil)
|
199
|
+
read(filename) if filename
|
200
|
+
end
|
201
|
+
|
202
|
+
# fetch a setting by name
|
203
|
+
def [](item)
|
204
|
+
@settings_hash[item]
|
205
|
+
end
|
206
|
+
|
207
|
+
def read(filename)
|
208
|
+
@version = nil
|
209
|
+
curr_setting = Setting.new(HEADER_ID,'')
|
210
|
+
@settings = [curr_setting]
|
211
|
+
@settings_hash = {}
|
212
|
+
|
213
|
+
File.open(filename) do |f|
|
214
|
+
# VERSION header must occur within first 20 lines
|
215
|
+
20.times do
|
216
|
+
line = f.gets
|
217
|
+
break unless line
|
218
|
+
curr_setting << line
|
219
|
+
if line =~ /\A##VERSION:/
|
220
|
+
@version = line
|
221
|
+
break
|
222
|
+
end
|
223
|
+
end
|
224
|
+
raise NoVersionLine, "#{filename}: No VERSION line found" unless @version
|
225
|
+
|
226
|
+
while line = f.gets
|
227
|
+
unless line =~ /\A##NAME:(.*):(.*)/
|
228
|
+
curr_setting << line
|
229
|
+
next
|
230
|
+
end
|
231
|
+
curr_setting = Setting.new($1,$2)
|
232
|
+
@settings << curr_setting
|
233
|
+
@settings_hash[curr_setting.name] = curr_setting
|
234
|
+
end
|
235
|
+
end
|
236
|
+
end
|
237
|
+
|
238
|
+
def write(filename)
|
239
|
+
File.open(filename,"w") do |f|
|
240
|
+
@settings.each do |s|
|
241
|
+
f << s.to_s
|
242
|
+
end
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end # class ConfigFile
|
246
|
+
|
247
|
+
# Yield directory contents recursively, without doing chdir(). Note
|
248
|
+
# that yielded pathnames are relative to the base directory given;
|
249
|
+
# so that, for example, you can simulate 'cp -r /foo/bar/ /baz/' by
|
250
|
+
# recurse_dir("/foo/bar") { |n| copy("/foo/bar/"+n,"/baz/"+n) unless
|
251
|
+
# File.directory?("/foo/bar/"+n) }
|
252
|
+
# Current behaviour is that if a directory is a symlink, we follow it.
|
253
|
+
# (Perhaps the block we yield should return true/false?)
|
254
|
+
|
255
|
+
def self.recurse_dir(base)
|
256
|
+
base = base+File::SEPARATOR unless base[-1,1] == File::SEPARATOR
|
257
|
+
dirs = ['']
|
258
|
+
while dir = dirs.pop
|
259
|
+
yield dir unless dir == ''
|
260
|
+
Dir.foreach(base+dir) do |n|
|
261
|
+
next if n == '.' || n == '..'
|
262
|
+
target = dir + n
|
263
|
+
if File.directory?(base+target)
|
264
|
+
dirs << target+File::SEPARATOR
|
265
|
+
next
|
266
|
+
end
|
267
|
+
yield target
|
268
|
+
end
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
class Processor
|
273
|
+
attr_reader :o
|
274
|
+
|
275
|
+
# Parse command-line options and set the @o options hash
|
276
|
+
|
277
|
+
def initialize(argv=nil)
|
278
|
+
require 'optparse'
|
279
|
+
|
280
|
+
@o = { :strip_regexp => /\.dist\z/ }
|
281
|
+
return unless argv
|
282
|
+
opts = OptionParser.new do |opts|
|
283
|
+
opts.banner = "rconftool version #{VERSION}"
|
284
|
+
opts.separator "Usage: #{$0} [options]"
|
285
|
+
opts.separator ""
|
286
|
+
opts.separator "Specific options:"
|
287
|
+
|
288
|
+
opts.on("-n", "--noclobber", "Dummy run") do
|
289
|
+
@o[:noclobber] = true
|
290
|
+
end
|
291
|
+
opts.on("-f", "--force", "Update files even if VERSION is same") do
|
292
|
+
@o[:force] = true
|
293
|
+
end
|
294
|
+
opts.on("-q", "--quiet", "No progress reporting") do
|
295
|
+
@o[:debug] = ""
|
296
|
+
end
|
297
|
+
opts.on("--targetdir DIR", "Where to write merged config files") do |dir|
|
298
|
+
@o[:targetdir] = dir
|
299
|
+
end
|
300
|
+
opts.on("--olddir DIR", "If file does not exist in targetdir,",
|
301
|
+
"try to merge from here") do |dir|
|
302
|
+
@o[:olddir] = dir
|
303
|
+
end
|
304
|
+
opts.on("--[no-]recursive", "Traverse directories recursively") do |v|
|
305
|
+
@o[:recursive] = v
|
306
|
+
end
|
307
|
+
opts.on("--strip-suffix FOO", "Remove suffix FOO from target filenames",
|
308
|
+
"(default .dist)") do |suffix|
|
309
|
+
@o[:strip_regexp] = /#{Regexp.escape(suffix)}\z/
|
310
|
+
end
|
311
|
+
opts.on("-a", "--add-suffix FOO", "Add suffix FOO to target filenames") do |suffix|
|
312
|
+
@o[:add_suffix] = suffix
|
313
|
+
end
|
314
|
+
|
315
|
+
opts.on_tail("-?", "--help", "Show this message") do
|
316
|
+
puts opts
|
317
|
+
exit
|
318
|
+
end
|
319
|
+
end
|
320
|
+
opts.parse!(argv)
|
321
|
+
end
|
322
|
+
|
323
|
+
# Process a list of files, [src1,src2,...]. If recursive mode has been
|
324
|
+
# enabled, then subdirectories of destdir are created as necessary
|
325
|
+
# when 'src' is a directory, and the mode/ownership of these newly
|
326
|
+
# created directories is copied from the original.
|
327
|
+
|
328
|
+
def run(files)
|
329
|
+
done_work = false
|
330
|
+
files.each do |f|
|
331
|
+
if not File.directory?(f)
|
332
|
+
dst = old = nil
|
333
|
+
dst = @o[:targetdir] + File::SEPARATOR + File.basename(f) if @o[:targetdir]
|
334
|
+
old = @o[:olddir] + File::SEPARATOR + File.basename(f) if @o[:olddir]
|
335
|
+
Rconftool::install(f, dst, old, @o)
|
336
|
+
elsif not @o[:recursive]
|
337
|
+
raise Errno::EISDIR, "#{f} (not copied). Need --recursive?"
|
338
|
+
else
|
339
|
+
Rconftool::recurse_dir(f) do |nf|
|
340
|
+
src = f + File::SEPARATOR + nf
|
341
|
+
dst = old = nil
|
342
|
+
dst = @o[:targetdir] + File::SEPARATOR + nf if @o[:targetdir]
|
343
|
+
old = @o[:olddir] + File::SEPARATOR + nf if @o[:olddir]
|
344
|
+
if File.directory?(src)
|
345
|
+
if dst and not File.directory?(dst)
|
346
|
+
orig = File.stat(src)
|
347
|
+
Dir.mkdir(dst, orig.mode)
|
348
|
+
begin
|
349
|
+
File.chown(orig.uid, orig.gid, dst)
|
350
|
+
rescue Errno::EPERM
|
351
|
+
end
|
352
|
+
end
|
353
|
+
else
|
354
|
+
Rconftool::install(src, dst, old, @o)
|
355
|
+
end
|
356
|
+
end
|
357
|
+
end
|
358
|
+
done_work = true
|
359
|
+
end
|
360
|
+
unless done_work
|
361
|
+
$stderr.puts "Usage: #{$0} [options] src1 src2 ...\n"+
|
362
|
+
"Try #{$0} --help for more information\n"
|
363
|
+
exit 1
|
364
|
+
end
|
365
|
+
end
|
366
|
+
end # class Processor
|
367
|
+
|
368
|
+
end # module Rconftool
|
369
|
+
|
370
|
+
# Run from command line?
|
371
|
+
if __FILE__ == $0
|
372
|
+
|
373
|
+
begin
|
374
|
+
s = Rconftool::Processor.new(ARGV)
|
375
|
+
s.run(ARGV)
|
376
|
+
rescue Exception => e
|
377
|
+
$stderr.puts "#{$0}: #{e}"
|
378
|
+
end
|
379
|
+
|
380
|
+
end
|