File: cpio.rb

package info (click to toggle)
ruby-arr-pm 0.0.12-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 244 kB
  • sloc: ruby: 1,389; makefile: 27
file content (202 lines) | stat: -rw-r--r-- 5,186 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
193
194
195
196
197
198
199
200
201
202
class BoundedIO
  attr_reader :length
  attr_reader :remaining

  def initialize(io, length, &eof_callback)
    @io = io
    @length = length
    @remaining = length

    @eof_callback = eof_callback
    @eof = false
  end

  def read(size=nil)
    return nil if eof?
    size = @remaining if size.nil?
    data = @io.read(size)
    @remaining -= data.bytesize
    eof?
    data
  end

  def sysread(size)
    raise EOFError, "end of file reached" if eof?
    read(size)
  end

  def eof?
    return false if @remaining > 0
    return @eof if @eof

    @eof_callback.call
    @eof = true
  end
end

module CPIO
  FIELDS = [
    :magic, :ino, :mode, :uid, :gid, :nlink, :mtime, :filesize, :devmajor,
    :devminor, :rdevmajor, :rdevminor, :namesize, :check
  ]
end

class CPIO::ASCIIReader
  FIELD_SIZES = {
    :magic => 6,
    :ino => 8,
    :mode => 8,
    :uid => 8,
    :gid => 8,
    :nlink => 8,
    :mtime => 8,
    :filesize => 8,
    :devmajor => 8,
    :devminor => 8,
    :rdevmajor => 8,
    :rdevminor => 8,
    :namesize => 8,
    :check => 8
  }
  HEADER_LENGTH = FIELD_SIZES.reduce(0) { |m, (_, v)| m + v }
  HEADER_PACK = FIELD_SIZES.collect { |_, v| "A#{v}" }.join

  FIELD_ORDER = [
    :magic, :ino, :mode, :uid, :gid, :nlink, :mtime, :filesize, :devmajor,
    :devminor, :rdevmajor, :rdevminor, :namesize, :check
  ]

  def initialize(io)
    @io = io
  end

  private

  def io
    @io
  end

  def each(&block)
    while true
      entry = read
      break if entry.nil?
      # The CPIO format has the end-of-stream marker as a file called "TRAILER!!!"
      break if entry.name == "TRAILER!!!"
      block.call(entry, entry.file)
      verify_correct_read(entry) unless entry.directory?
    end
  end

  def verify_correct_read(entry)
    # Read and throw away the whole file if not read at all.
    entry.file.tap do |file|
      if file.nil? ||  file.remaining == 0
        # All OK! :)
      elsif file.remaining == file.length
        file.read(16384) while !file.eof?
      else 
        # The file was only partially read? This should be an error by the
        # user.
        consumed = file.length - file.remaining
        raise BadState, "Only #{consumed} bytes were read of the #{file.length} byte file: #{entry.name}"
      end
    end
  end

  def read
    entry = CPIOEntry.new
    header = io.read(HEADER_LENGTH)
    return nil if header.nil?
    FIELD_ORDER.zip(header.unpack(HEADER_PACK)).each do |field, value|
      entry.send("#{field}=", value.to_i(16))
    end

    entry.validate
    entry.mtime = Time.at(entry.mtime)
    read_name(entry, @io)
    read_file(entry, @io)
    entry
  end

  def read_name(entry, io)
    entry.name = io.read(entry.namesize - 1) # - 1 for null terminator
    nul = io.read(1)
    raise ArgumentError, "Corrupt CPIO or bug? Name null terminator was not null: #{nul.inspect}" if nul != "\0"
    padding_data = io.read(padding_name(entry))
    # Padding should be all null bytes
    if padding_data != ("\0" * padding_data.bytesize)
      raise ArgumentError, "Corrupt CPIO or bug? Name null padding was #{padding_name(entry)} bytes: #{padding_data.inspect}"
    end
  end

  def read_file(entry, io)
    if entry.directory?
      entry.file = nil
      #read_file_padding(entry, io)
      nil
    else
      entry.file = BoundedIO.new(io, entry.filesize) do
        read_file_padding(entry, io)
      end
    end
  end

  def read_file_padding(entry, io)
    padding_data = io.read(padding_file(entry))
    if padding_data != ("\0" * padding_data.bytesize)
      raise ArgumentError, "Corrupt CPIO or bug? File null padding was #{padding_file(entry)} bytes: #{padding_data.inspect}"
    end
  end

  def padding_name(entry)
    # name padding is padding up to a multiple of 4 after header+namesize
    -(HEADER_LENGTH + entry.namesize) % 4
  end

  def padding_file(entry)
    (-(HEADER_LENGTH + entry.filesize + 2) % 4)
  end
  public(:each)
end

class CPIOEntry
  CPIO::FIELDS.each do |field|
    attr_accessor field
  end

  attr_accessor :name
  attr_accessor :file

  DIRECTORY_FLAG = 0040000

  def validate
    raise "Invalid magic #{magic.inspect}" if magic != 0x070701
    raise "Invalid ino #{ino.inspect}" if ino < 0
    raise "Invalid mode #{mode.inspect}" if mode < 0
    raise "Invalid uid #{uid.inspect}" if uid < 0
    raise "Invalid gid #{gid.inspect}" if gid < 0
    raise "Invalid nlink #{nlink.inspect}" if nlink < 0
    raise "Invalid mtime #{mtime.inspect}" if mtime < 0
    raise "Invalid filesize #{filesize.inspect}" if filesize < 0
    raise "Invalid devmajor #{devmajor.inspect}" if devmajor < 0
    raise "Invalid devminor #{devminor.inspect}" if devminor < 0
    raise "Invalid rdevmajor #{rdevmajor.inspect}" if rdevmajor < 0
    raise "Invalid rdevminor #{rdevminor.inspect}" if rdevminor < 0
    raise "Invalid namesize #{namesize.inspect}" if namesize < 0
    raise "Invalid check #{check.inspect}" if check < 0
  end # def validate

  def read(*args)
    return nil if directory?
    file.read(*args)
  end

  def directory?
    mode & DIRECTORY_FLAG > 0
  end
end

CPIO::ASCIIReader.new(STDIN).each do |entry, file|
  puts entry.name
  file.read unless entry.directory?
end