Class: Cabriolet::CLI

Inherits:
Thor
  • Object
show all
Defined in:
lib/cabriolet/cli.rb

Overview

CLI provides command-line interface for Cabriolet

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/cabriolet/cli.rb', line 8

def self.exit_on_failure?
  true
end

Instance Method Details

#chm_extract(file, output_dir = nil) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/cabriolet/cli.rb', line 165

def chm_extract(file, output_dir = nil)
  setup_verbose(options[:verbose])
  output_dir ||= options[:output] || "."

  decompressor = CHM::Decompressor.new
  chm = decompressor.open(file)

  require "fileutils"
  FileUtils.mkdir_p(output_dir)

  count = 0
  chm.all_files.each do |f|
    next if f.system_file?

    output_path = File.join(output_dir, f.filename)
    output_subdir = File.dirname(output_path)
    FileUtils.mkdir_p(output_subdir)

    puts "Extracting: #{f.filename}" if options[:verbose]
    decompressor.extract(f, output_path)
    count += 1
  end

  decompressor.close
  puts "Extracted #{count} file(s) to #{output_dir}"
rescue Error => e
  abort "Error: #{e.message}"
end

#chm_info(file) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cabriolet/cli.rb', line 197

def chm_info(file)
  setup_verbose(options[:verbose])

  decompressor = CHM::Decompressor.new
  chm = decompressor.open(file)

  display_chm_info(chm)
  decompressor.close
rescue Error => e
  abort "Error: #{e.message}"

  desc "chm-create OUTPUT FILES...", "Create a CHM file from HTML files"
  option :window_bits, type: :numeric, default: 16,
                       desc: "LZX window size (15-21)"
  option :verbose, type: :boolean, aliases: "-v",
                   desc: "Enable verbose output"
  def chm_create(output, *files)
    setup_verbose(options[:verbose])

    raise ArgumentError, "No files specified" if files.empty?

    files.each do |f|
      raise ArgumentError, "File does not exist: #{f}" unless File.exist?(f)
    end

    compressor = CHM::Compressor.new
    files.each do |f|
      # Default to compressed section for .html, uncompressed for images
      section = f.end_with?(".html", ".htm") ? :compressed : :uncompressed
      compressor.add_file(f, "/#{File.basename(f)}", section: section)
    end

    if options[:verbose]
      puts "Creating #{output} with #{files.size} file(s) (window_bits: #{options[:window_bits]})"
    end
    bytes = compressor.generate(output, window_bits: options[:window_bits])
    puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
  rescue Error => e
    abort "Error: #{e.message}"
  end
end

#chm_list(file) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cabriolet/cli.rb', line 139

def chm_list(file)
  setup_verbose(options[:verbose])

  decompressor = CHM::Decompressor.new
  chm = decompressor.open(file)

  puts "CHM File: #{chm.filename}"
  puts "Version: #{chm.version}"
  puts "Language: #{chm.language}"
  puts "Chunks: #{chm.num_chunks}, Chunk Size: #{chm.chunk_size}"
  puts "\nFiles:"

  chm.all_files.each do |f|
    section_name = f.section.id.zero? ? "Uncompressed" : "MSCompressed"
    puts "  #{f.filename} (#{f.length} bytes, #{section_name})"
  end

  decompressor.close
rescue Error => e
  abort "Error: #{e.message}"
end

#compress(file, output = nil) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/cabriolet/cli.rb', line 297

def compress(file, output = nil)
  setup_verbose(options[:verbose])
  output ||= options[:output]

  # Auto-generate output name: file.txt -> file.tx_
  if output.nil?
    output = file.sub(/\.([^.])$/, "._")
    # If no extension or single char extension, just append _
    output = "#{file}_" if output == file
  end

  compressor = SZDD::Compressor.new

  puts "Compressing #{file} -> #{output}" if options[:verbose]

  compress_options = { format: options[:format].to_sym }
  if options[:missing_char]
    compress_options[:missing_char] =
      options[:missing_char]
  end

  bytes = compressor.compress(file, output, **compress_options)

  puts "Compressed #{file} to #{output} (#{bytes} bytes)"
rescue Error => e
  abort "Error: #{e.message}"
end

#create(output, *files) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cabriolet/cli.rb', line 115

def create(output, *files)
  setup_verbose(options[:verbose])

  raise ArgumentError, "No files specified" if files.empty?

  files.each do |f|
    raise ArgumentError, "File does not exist: #{f}" unless File.exist?(f)
  end

  compressor = CAB::Compressor.new
  files.each { |f| compressor.add_file(f) }

  puts "Creating #{output} with #{files.size} file(s) (#{options[:compression]} compression)" if options[:verbose]
  bytes = compressor.generate(output,
                              compression: options[:compression].to_sym)
  puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
rescue Error => e
  abort "Error: #{e.message}"
end

#expand(file, output = nil) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/cabriolet/cli.rb', line 245

def expand(file, output = nil)
  setup_verbose(options[:verbose])
  output ||= options[:output]

  decompressor = SZDD::Decompressor.new
  header = decompressor.open(file)

  # Auto-detect output name if not provided
  output ||= decompressor.auto_output_filename(file, header)

  puts "Expanding #{file} -> #{output}" if options[:verbose]
  bytes = decompressor.extract(header, output)
  decompressor.close(header)

  puts "Expanded #{file} to #{output} (#{bytes} bytes)"
rescue Error => e
  abort "Error: #{e.message}"
end

#extract(file, output_dir = nil) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/cabriolet/cli.rb', line 39

def extract(file, output_dir = nil)
  setup_verbose(options[:verbose])
  output_dir ||= options[:output] || "."

  decompressor = CAB::Decompressor.new
  decompressor.salvage = options[:salvage] if options[:salvage]

  cabinet = decompressor.open(file)
  count = decompressor.extract_all(cabinet, output_dir)

  puts "Extracted #{count} file(s) to #{output_dir}"
rescue Error => e
  abort "Error: #{e.message}"
end

#hlp_create(output, *files) ⇒ Object 



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/cabriolet/cli.rb', line 441

def hlp_create(output, *files)
  setup_verbose(options[:verbose])

  raise ArgumentError, "No files specified" if files.empty?

  files.each do |f|
    raise ArgumentError, "File does not exist: #{f}" unless File.exist?(f)
  end

  compressor = HLP::Compressor.new
  files.each do |f|
    compressor.add_file(f, File.basename(f), compress: options[:compress])
  end

  puts "Creating #{output} with #{files.size} file(s)" if options[:verbose]
  bytes = compressor.generate(output)
  puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
rescue Error => e
  abort "Error: #{e.message}"
end

#hlp_extract(file, output_dir = nil) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/cabriolet/cli.rb', line 417

def hlp_extract(file, output_dir = nil)
  setup_verbose(options[:verbose])
  output_dir ||= options[:output] || "."

  decompressor = HLP::Decompressor.new
  header = decompressor.open(file)

  require "fileutils"
  FileUtils.mkdir_p(output_dir)

  puts "Extracting #{header.files.size} files from #{file}" if options[:verbose]
  count = decompressor.extract_all(header, output_dir)

  decompressor.close(header)
  puts "Extracted #{count} file(s) to #{output_dir}"
rescue Error => e
  abort "Error: #{e.message}"
end

#hlp_info(file) ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/cabriolet/cli.rb', line 465

def hlp_info(file)
  setup_verbose(options[:verbose])

  decompressor = HLP::Decompressor.new
  header = decompressor.open(file)

  puts "HLP File Information"
  puts "=" * 50
  puts "Filename: #{file}"
  puts "Version: #{header.version}"
  puts "Files: #{header.files.size}"
  puts ""
  puts "Files:"
  header.files.each do |f|
    compression = f.compressed? ? "LZSS" : "none"
    puts "  #{f.filename}"
    puts "    Uncompressed: #{f.length} bytes"
    puts "    Compressed: #{f.compressed_length} bytes (#{compression})"
  end

  decompressor.close(header)
rescue Error => e
  abort "Error: #{e.message}"
end

#info(file) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cabriolet/cli.rb', line 57

def info(file)
  setup_verbose(options[:verbose])

  decompressor = CAB::Decompressor.new
  cabinet = decompressor.open(file)

  display_cabinet_info(cabinet)
rescue Error => e
  abort "Error: #{e.message}"
end

#kwaj_compress(file, output = nil) ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/cabriolet/cli.rb', line 386

def kwaj_compress(file, output = nil)
  setup_verbose(options[:verbose])
  output ||= options[:output] || "#{file}.kwj"

  compressor = KWAJ::Compressor.new

  puts "Compressing #{file} -> #{output} (#{options[:compression]} compression)" if options[:verbose]

  compress_options = { compression: options[:compression].to_sym }
  if options[:include_length]
    compress_options[:include_length] =
      options[:include_length]
  end
  compress_options[:filename] = options[:filename] if options[:filename]
  if options[:extra_data]
    compress_options[:extra_data] =
      options[:extra_data]
  end

  bytes = compressor.compress(file, output, **compress_options)

  puts "Compressed #{file} to #{output} (#{bytes} bytes, #{options[:compression]} compression)"
rescue Error => e
  abort "Error: #{e.message}"
end

#kwaj_extract(file, output = nil) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/cabriolet/cli.rb', line 330

def kwaj_extract(file, output = nil)
  setup_verbose(options[:verbose])
  output ||= options[:output]

  decompressor = KWAJ::Decompressor.new
  header = decompressor.open(file)

  # Auto-detect output name if not provided
  output ||= decompressor.auto_output_filename(file, header)

  puts "Extracting #{file} -> #{output}" if options[:verbose]
  bytes = decompressor.extract(header, file, output)
  decompressor.close(header)

  puts "Extracted #{file} to #{output} (#{bytes} bytes)"
rescue Error => e
  abort "Error: #{e.message}"
end

#kwaj_info(file) ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/cabriolet/cli.rb', line 352

def kwaj_info(file)
  setup_verbose(options[:verbose])

  decompressor = KWAJ::Decompressor.new
  header = decompressor.open(file)

  puts "KWAJ File Information"
  puts "=" * 50
  puts "Filename: #{file}"
  puts "Compression: #{header.compression_name}"
  puts "Data offset: #{header.data_offset} bytes"
  puts "Uncompressed size: #{header.length || 'unknown'} bytes"
  puts "Original filename: #{header.filename}" if header.filename
  if header.extra && !header.extra.empty?
    puts "Extra data: #{header.extra_length} bytes"
    puts "  #{header.extra}"
  end

  decompressor.close(header)
rescue Error => e
  abort "Error: #{e.message}"
end

#list(file) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/cabriolet/cli.rb', line 15

def list(file)
  setup_verbose(options[:verbose])

  decompressor = CAB::Decompressor.new
  cabinet = decompressor.open(file)

  puts "Cabinet: #{cabinet.filename}"
  puts "Set ID: #{cabinet.set_id}, Index: #{cabinet.set_index}"
  puts "Folders: #{cabinet.folder_count}, Files: #{cabinet.file_count}"
  puts "\nFiles:"

  cabinet.files.each do |f|
    puts "  #{f.filename} (#{f.length} bytes)"
  end
rescue Error => e
  abort "Error: #{e.message}"
end

#lit_create(output, *files) ⇒ Object 



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/cabriolet/cli.rb', line 523

def lit_create(output, *files)
  setup_verbose(options[:verbose])

  raise ArgumentError, "No files specified" if files.empty?

  files.each do |f|
    raise ArgumentError, "File does not exist: #{f}" unless File.exist?(f)
  end

  compressor = LIT::Compressor.new
  files.each do |f|
    compressor.add_file(f, File.basename(f), compress: options[:compress])
  end

  puts "Creating #{output} with #{files.size} file(s)" if options[:verbose]
  bytes = compressor.generate(output)
  puts "Created #{output} (#{bytes} bytes, #{files.size} files)"
rescue Error => e
  abort "Error: #{e.message}"
rescue NotImplementedError => e
  abort "Error: #{e.message}"
end

#lit_extract(file, output_dir = nil) ⇒ Object 



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/cabriolet/cli.rb', line 495

def lit_extract(file, output_dir = nil)
  setup_verbose(options[:verbose])
  output_dir ||= options[:output] || "."

  decompressor = LIT::Decompressor.new
  header = decompressor.open(file)

  abort "Error: LIT file is DRM-encrypted. Decryption not yet supported." if header.encrypted?

  require "fileutils"
  FileUtils.mkdir_p(output_dir)

  puts "Extracting #{header.files.size} files from #{file}" if options[:verbose]
  count = decompressor.extract_all(header, output_dir)

  decompressor.close(header)
  puts "Extracted #{count} file(s) to #{output_dir}"
rescue Error => e
  abort "Error: #{e.message}"
rescue NotImplementedError => e
  abort "Error: #{e.message}"
end

#lit_info(file) ⇒ Object 



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/cabriolet/cli.rb', line 549

def lit_info(file)
  setup_verbose(options[:verbose])

  decompressor = LIT::Decompressor.new
  header = decompressor.open(file)

  puts "LIT File Information"
  puts "=" * 50
  puts "Filename: #{file}"
  puts "Version: #{header.version}"
  puts "Encrypted: #{header.encrypted? ? 'Yes (DES)' : 'No'}"
  puts "Files: #{header.files.size}"
  puts ""
  puts "Files:"
  header.files.each do |f|
    compression = f.compressed? ? "LZX" : "none"
    encryption = f.encrypted? ? " [encrypted]" : ""
    puts "  #{f.filename}"
    puts "    Size: #{f.length} bytes"
    puts "    Compression: #{compression}#{encryption}"
  end

  decompressor.close(header)
rescue Error => e
  abort "Error: #{e.message}"
rescue NotImplementedError => e
  abort "Error: #{e.message}"
end

#oab_create(input, output) ⇒ Object 



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/cabriolet/cli.rb', line 608

def oab_create(input, output)
  setup_verbose(options[:verbose])

  compressor = OAB::Compressor.new

  if options[:base]
    puts "Creating patch: #{input} (base: #{options[:base]}) -> #{output}" if options[:verbose]
    bytes = compressor.compress_incremental(input, options[:base], output,
                                            block_size: options[:block_size])
    puts "Created patch: #{output} (#{bytes} bytes)"
  else
    puts "Compressing: #{input} -> #{output}" if options[:verbose]
    bytes = compressor.compress(input, output,
                                block_size: options[:block_size])
    puts "Created #{output} (#{bytes} bytes)"
  end
rescue Error => e
  abort "Error: #{e.message}"
end

#oab_extract(input, output) ⇒ Object 



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/cabriolet/cli.rb', line 583

def oab_extract(input, output)
  setup_verbose(options[:verbose])

  decompressor = OAB::Decompressor.new

  if options[:base]
    puts "Applying patch: #{input} + #{options[:base]} -> #{output}" if options[:verbose]
    bytes = decompressor.decompress_incremental(input, options[:base],
                                                output)
    puts "Applied patch: #{input} + #{options[:base]} -> #{output} (#{bytes} bytes)"
  else
    puts "Extracting: #{input} -> #{output}" if options[:verbose]
    bytes = decompressor.decompress(input, output)
    puts "Extracted #{input} -> #{output} (#{bytes} bytes)"
  end
rescue Error => e
  abort "Error: #{e.message}"
end

#oab_info(file) ⇒ Object 



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/cabriolet/cli.rb', line 631

def oab_info(file)
  setup_verbose(options[:verbose])

  # Read and parse header
  io_system = System::IOSystem.new
  handle = io_system.open(file, Constants::MODE_READ)

  begin
    header_data = io_system.read(handle, 28) # Read full patch header size
    io_system.close(handle)

    # Try to parse as full header first
    if header_data.length >= 16
      full_header = Binary::OABStructures::FullHeader.read(header_data[0,
                                                                       16])

      if full_header.valid?
        puts "OAB File Information (Full)"
        puts "=" * 50
        puts "Filename: #{file}"
        puts "Version: #{full_header.version_hi}.#{full_header.version_lo}"
        puts "Block size: #{full_header.block_max} bytes"
        puts "Target size: #{full_header.target_size} bytes"
      elsif header_data.length >= 28
        # Try as patch header
        patch_header = Binary::OABStructures::PatchHeader.read(header_data)

        if patch_header.valid?
          puts "OAB File Information (Patch)"
          puts "=" * 50
          puts "Filename: #{file}"
          puts "Version: #{patch_header.version_hi}.#{patch_header.version_lo}"
          puts "Block size: #{patch_header.block_max} bytes"
          puts "Source size: #{patch_header.source_size} bytes"
          puts "Target size: #{patch_header.target_size} bytes"
          puts "Source CRC: 0x#{patch_header.source_crc.to_s(16)}"
          puts "Target CRC: 0x#{patch_header.target_crc.to_s(16)}"
        else
          abort "Error: Not a valid OAB file"
        end
      else
        abort "Error: Not a valid OAB file"
      end
    else
      abort "Error: File too small to be OAB"
    end
  rescue StandardError => e
    io_system.close(handle) if handle
    abort "Error: #{e.message}"
  end
rescue Error => e
  abort "Error: #{e.message}"
end

#search(file) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/cabriolet/cli.rb', line 87

def search(file)
  setup_verbose(options[:verbose])

  decompressor = CAB::Decompressor.new
  cabinet = decompressor.search(file)

  if cabinet
    count = 0
    cab = cabinet
    while cab
      puts "Cabinet found at offset #{cab.base_offset}"
      puts "  Files: #{cab.file_count}, Folders: #{cab.folder_count}"
      cab = cab.next
      count += 1
    end
    puts "\nTotal: #{count} cabinet(s) found"
  else
    puts "No cabinets found in #{file}"
  end
rescue Error => e
  abort "Error: #{e.message}"
end

#szdd_info(file) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/cabriolet/cli.rb', line 267

def szdd_info(file)
  setup_verbose(options[:verbose])

  decompressor = SZDD::Decompressor.new
  header = decompressor.open(file)

  puts "SZDD File Information"
  puts "=" * 50
  puts "Filename: #{file}"
  puts "Format: #{header.format.to_s.upcase}"
  puts "Uncompressed size: #{header.length} bytes"
  if header.missing_char
    puts "Missing character: '#{header.missing_char}'"
    puts "Suggested filename: #{header.suggested_filename(File.basename(file))}"
  end

  decompressor.close(header)
rescue Error => e
  abort "Error: #{e.message}"
end

#test(file) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cabriolet/cli.rb', line 71

def test(file)
  setup_verbose(options[:verbose])

  decompressor = CAB::Decompressor.new
  cabinet = decompressor.open(file)

  puts "Testing #{cabinet.filename}..."
  # TODO: Implement integrity testing
  puts "OK: All #{cabinet.file_count} files passed integrity check"
rescue Error => e
  abort "Error: #{e.message}"
end

#version ⇒ Object 



686
687
688
 
# File 'lib/cabriolet/cli.rb', line 686

def version
  puts "Cabriolet version #{Cabriolet::VERSION}"
end