halostatue / minitar / 135

pending completion

Build # 135

Build Type

Pull #36

travis-ci

Committed by

web-flow

Commit Message

Treat a regular file entry with a name ending with a slash as a directory

This is what other major tar implementations do for interoperability
and compatibility with older tar variants and some new ones.

- GNU tar: http://git.savannah.gnu.org/cgit/tar.git/tree/src/extract.c?id=3c2a2cd94#n1543
- libarchive: https://github.com/libarchive/libarchive/blob/f5e11acaa/libarchive/archive_read_support_format_tar.c#L566-L583

Pull Request Pull Request #36: Treat a regular file entry with a name ending with a slash as a directory

Run Details

12 of 12 new or added lines in 2 files covered. (100.0%)

825 of 1013 relevant lines covered (81.44%)

326.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.54

/lib/archive/tar/minitar/reader.rb

# coding: utf-8

module Archive::Tar::Minitar
  # The class that reads a tar format archive from a data stream. The data
  # stream may be sequential or random access, but certain features only work
  # with random access data streams.
  class Reader
    include Enumerable
    # This marks the EntryStream closed for reading without closing the
    # actual data stream.
    module InvalidEntryStream
      # rubocop:disable Style/SingleLineMethods
      # rubocop:disable Style/EmptyLineBetweenDefs
      def read(*); raise ClosedStream; end
      def getc; raise ClosedStream; end
      def rewind; raise ClosedStream; end
      def closed?; true; end
      # rubocop:enable Style/EmptyLineBetweenDefs
      # rubocop:enable Style/SingleLineMethods Style/EmptyLineBetweenDefs
    end

    # EntryStreams are pseudo-streams on top of the main data stream.
    class EntryStream
      Archive::Tar::Minitar::PosixHeader::FIELDS.each do |field|
        attr_reader field.to_sym
      end

      def initialize(header, io)
        @io       = io
        @name     = header.name
        @mode     = header.mode
        @uid      = header.uid
        @gid      = header.gid
        @size     = header.size
        @mtime    = header.mtime
        @checksum = header.checksum
        @typeflag = header.typeflag
        @linkname = header.linkname
        @magic    = header.magic
        @version  = header.version
        @uname    = header.uname
        @gname    = header.gname
        @devmajor = header.devmajor
        @devminor = header.devminor
        @prefix   = header.prefix
        @read     = 0
        @orig_pos =
          if Archive::Tar::Minitar.seekable?(@io)
            @io.pos
          else
            0
          end
      end

      # Reads +len+ bytes (or all remaining data) from the entry. Returns
      # +nil+ if there is no more data to read.
      def read(len = nil)
        return nil if @read >= @size
        len ||= @size - @read
        max_read = [len, @size - @read].min
        ret = @io.read(max_read)
        @read += ret.size
        ret
      end

      # Reads one byte from the entry. Returns +nil+ if there is no more data
      # to read.
      def getc
        return nil if @read >= @size
        ret = @io.getc
        @read += 1 if ret
        ret
      end

      # Returns +true+ if the entry represents a directory.
      def directory?
        case @typeflag
        when '5'
          true
        when '0', "\0"
          # If the name ends with a slash, treat it as a directory.
          # This is what other major tar implementations do for
          # interoperability and compatibility with older tar variants
          # and some new ones.
          @name.end_with?('/')
        else
          false
        end
      end
      alias directory directory?

      # Returns +true+ if the entry represents a plain file.
      def file?
        (@typeflag == '0' || @typeflag == "\0") && !@name.end_with?('/')
      end
      alias file file?

      # Returns +true+ if the current read pointer is at the end of the
      # EntryStream data.
      def eof?
        @read >= @size
      end

      # Returns the current read pointer in the EntryStream.
      def pos
        @read
      end

      # Sets the current read pointer to the beginning of the EntryStream.
      def rewind
        unless Archive::Tar::Minitar.seekable?(@io, :pos=)
          raise Archive::Tar::Minitar::NonSeekableStream
        end
        @io.pos = @orig_pos
        @read = 0
      end

      def bytes_read
        @read
      end

      # Returns the full and proper name of the entry.
      def full_name
        if @prefix != ''
          File.join(@prefix, @name)
        else
          @name
        end
      end

      # Returns false if the entry stream is valid.
      def closed?
        false
      end

      # Closes the entry.
      def close
        invalidate
      end

      private

      def invalidate
        extend InvalidEntryStream
      end
    end

    # With no associated block, +Reader::open+ is a synonym for
    # +Reader::new+. If the optional code block is given, it will be passed
    # the new _writer_ as an argument and the Reader object will
    # automatically be closed when the block terminates. In this instance,
    # +Reader::open+ returns the value of the block.
    def self.open(io)
      reader = new(io)
      return reader unless block_given?

      # This exception context must remain, otherwise the stream closes on open
      # even if a block is not given.
      begin
        yield reader
      ensure
        reader.close
      end
    end

    # Iterates over each entry in the provided input. This wraps the common
    # pattern of:
    #
    #     Archive::Tar::Minitar::Input.open(io) do |i|
    #       inp.each do |entry|
    #         # ...
    #       end
    #     end
    #
    # If a block is not provided, an enumerator will be created with the same
    # behaviour.
    #
    # call-seq:
    #    Archive::Tar::Minitar::Reader.each_entry(io) -> enumerator
    #    Archive::Tar::Minitar::Reader.each_entry(io) { |entry| block } -> obj
    def self.each_entry(io)
      return to_enum(__method__, io) unless block_given?

      open(io) do |reader|
        reader.each_entry do |entry|
          yield entry
        end
      end
    end

    # Creates and returns a new Reader object.
    def initialize(io)
      @io = io
      @init_pos = io.pos rescue nil
    end

    # Resets the read pointer to the beginning of data stream. Do not call
    # this during a #each or #each_entry iteration. This only works with
    # random access data streams that respond to #rewind and #pos.
    def rewind
      if @init_pos.zero?
        unless Archive::Tar::Minitar.seekable?(@io, :rewind)
          raise Archive::Tar::Minitar::NonSeekableStream
        end
        @io.rewind
      else
        unless Archive::Tar::Minitar.seekable?(@io, :pos=)
          raise Archive::Tar::Minitar::NonSeekableStream
        end
        @io.pos = @init_pos
      end
    end

    # Iterates through each entry in the data stream.
    def each_entry
      return to_enum unless block_given?

      loop do
        return if @io.eof?

        header = Archive::Tar::Minitar::PosixHeader.from_stream(@io)
        raise Archive::Tar::Minitar::InvalidTarStream unless header.valid?
        return if header.empty?

        raise Archive::Tar::Minitar::InvalidTarStream if header.size < 0

        if header.long_name?
          name = @io.read(512).rstrip
          header = PosixHeader.from_stream(@io)
          return if header.empty?
          header.name = name
        end

        entry = EntryStream.new(header, @io)
        size  = entry.size

        yield entry

        skip = (512 - (size % 512)) % 512

        if Archive::Tar::Minitar.seekable?(@io, :seek)
          # avoid reading...
          @io.seek(size - entry.bytes_read, IO::SEEK_CUR)
        else
          pending = size - entry.bytes_read
          while pending > 0
            bread = @io.read([pending, 4096].min).size
            raise UnexpectedEOF if @io.eof?
            pending -= bread
          end
        end

        @io.read(skip) # discard trailing zeros
        # make sure nobody can use #read, #getc or #rewind anymore
        entry.close
      end
    end
    alias each each_entry

    # Returns false if the reader is open (it never closes).
    def closed?
      false
    end

    def close
    end
  end
end

1	# coding: utf-8
2
3	module Archive::Tar::Minitar	7✔
4	# The class that reads a tar format archive from a data stream. The data
5	# stream may be sequential or random access, but certain features only work
6	# with random access data streams.
7	class Reader	7✔
8	include Enumerable	7✔
9	# This marks the EntryStream closed for reading without closing the
10	# actual data stream.
11	module InvalidEntryStream	7✔
12	# rubocop:disable Style/SingleLineMethods
13	# rubocop:disable Style/EmptyLineBetweenDefs
14	def read(*); raise ClosedStream; end	7✔
15	def getc; raise ClosedStream; end	7✔
16	def rewind; raise ClosedStream; end	7✔
17	def closed?; true; end	7✔
18	# rubocop:enable Style/EmptyLineBetweenDefs
19	# rubocop:enable Style/SingleLineMethods Style/EmptyLineBetweenDefs
20	end
21
22	# EntryStreams are pseudo-streams on top of the main data stream.
23	class EntryStream	7✔
24	Archive::Tar::Minitar::PosixHeader::FIELDS.each do \|field\|	7✔
25	attr_reader field.to_sym	112✔
26	end
27
28	def initialize(header, io)	7✔
29	@io = io	161✔
30	@name = header.name	161✔
31	@mode = header.mode	161✔
32	@uid = header.uid	161✔
33	@gid = header.gid	161✔
34	@size = header.size	161✔
35	@mtime = header.mtime	161✔
36	@checksum = header.checksum	161✔
37	@typeflag = header.typeflag	161✔
38	@linkname = header.linkname	161✔
39	@magic = header.magic	161✔
40	@version = header.version	161✔
41	@uname = header.uname	161✔
42	@gname = header.gname	161✔
43	@devmajor = header.devmajor	161✔
44	@devminor = header.devminor	161✔
45	@prefix = header.prefix	161✔
46	@read = 0	161✔
47	@orig_pos =	138✔
48	if Archive::Tar::Minitar.seekable?(@io)	92✔
49	@io.pos	28✔
50	else
51	0	133✔
52	end
53	end
54
55	# Reads +len+ bytes (or all remaining data) from the entry. Returns
56	# +nil+ if there is no more data to read.
57	def read(len = nil)	7✔
58	return nil if @read >= @size	119✔
59	len \|\|= @size - @read	63✔
60	max_read = [len, @size - @read].min	63✔
61	ret = @io.read(max_read)	63✔
62	@read += ret.size	63✔
63	ret	63✔
64	end
65
66	# Reads one byte from the entry. Returns +nil+ if there is no more data
67	# to read.
68	def getc	7✔
69	return nil if @read >= @size	×
70	ret = @io.getc	×
71	@read += 1 if ret	×
72	ret	×
73	end
74
75	# Returns +true+ if the entry represents a directory.
76	def directory?	7✔
77	case @typeflag	126✔
78	when '5'
79	true	42✔
80	when '0', "\0"
81	# If the name ends with a slash, treat it as a directory.
82	# This is what other major tar implementations do for
83	# interoperability and compatibility with older tar variants
84	# and some new ones.
85	@name.end_with?('/')	84✔
86	else
87	false	×
88	end
89	end
90	alias directory directory?	7✔
91
92	# Returns +true+ if the entry represents a plain file.
93	def file?	7✔
94	(@typeflag == '0' \|\| @typeflag == "\0") && !@name.end_with?('/')	×
95	end
96	alias file file?	7✔
97
98	# Returns +true+ if the current read pointer is at the end of the
99	# EntryStream data.
100	def eof?	7✔
101	@read >= @size	×
102	end
103
104	# Returns the current read pointer in the EntryStream.
105	def pos	7✔
106	@read	×
107	end
108
109	# Sets the current read pointer to the beginning of the EntryStream.
110	def rewind	7✔
111	unless Archive::Tar::Minitar.seekable?(@io, :pos=)	×
112	raise Archive::Tar::Minitar::NonSeekableStream	×
113	end
114	@io.pos = @orig_pos	×
115	@read = 0	×
116	end
117
118	def bytes_read	7✔
119	@read	161✔
120	end
121
122	# Returns the full and proper name of the entry.
123	def full_name	7✔
124	if @prefix != ''	91✔
125	File.join(@prefix, @name)	×
126	else
127	@name	91✔
128	end
129	end
130
131	# Returns false if the entry stream is valid.
132	def closed?	7✔
133	false	×
134	end
135
136	# Closes the entry.
137	def close	7✔
138	invalidate	161✔
139	end
140
141	private	7✔
142
143	def invalidate	7✔
144	extend InvalidEntryStream	161✔
145	end
146	end
147
148	# With no associated block, +Reader::open+ is a synonym for
149	# +Reader::new+. If the optional code block is given, it will be passed
150	# the new _writer_ as an argument and the Reader object will
151	# automatically be closed when the block terminates. In this instance,
152	# +Reader::open+ returns the value of the block.
153	def self.open(io)	7✔
154	reader = new(io)	21✔
155	return reader unless block_given?	21✔
156
157	# This exception context must remain, otherwise the stream closes on open
158	# even if a block is not given.
159	begin	12✔
160	yield reader	14✔
161	ensure
162	reader.close	14✔
163	end
164	end
165
166	# Iterates over each entry in the provided input. This wraps the common
167	# pattern of:
168	#
169	# Archive::Tar::Minitar::Input.open(io) do \|i\|
170	# inp.each do \|entry\|
171	# # ...
172	# end
173	# end
174	#
175	# If a block is not provided, an enumerator will be created with the same
176	# behaviour.
177	#
178	# call-seq:
179	# Archive::Tar::Minitar::Reader.each_entry(io) -> enumerator
180	# Archive::Tar::Minitar::Reader.each_entry(io) { \|entry\| block } -> obj
181	def self.each_entry(io)	7✔
182	return to_enum(__method__, io) unless block_given?	×
183
184	open(io) do \|reader\|	×
185	reader.each_entry do \|entry\|	×
186	yield entry	×
187	end
188	end
189	end
190
191	# Creates and returns a new Reader object.
192	def initialize(io)	7✔
193	@io = io	140✔
194	@init_pos = io.pos rescue nil	140✔
195	end
196
197	# Resets the read pointer to the beginning of data stream. Do not call
198	# this during a #each or #each_entry iteration. This only works with
199	# random access data streams that respond to #rewind and #pos.
200	def rewind	7✔
201	if @init_pos.zero?	56✔
202	unless Archive::Tar::Minitar.seekable?(@io, :rewind)	56✔
203	raise Archive::Tar::Minitar::NonSeekableStream	×
204	end
205	@io.rewind	56✔
206	else
207	unless Archive::Tar::Minitar.seekable?(@io, :pos=)	×
208	raise Archive::Tar::Minitar::NonSeekableStream	×
209	end
210	@io.pos = @init_pos	×
211	end
212	end
213
214	# Iterates through each entry in the data stream.
215	def each_entry	7✔
216	return to_enum unless block_given?	63✔
217
218	loop do	63✔
219	return if @io.eof?	224✔
220
221	header = Archive::Tar::Minitar::PosixHeader.from_stream(@io)	224✔
222	raise Archive::Tar::Minitar::InvalidTarStream unless header.valid?	224✔
223	return if header.empty?	217✔
224
225	raise Archive::Tar::Minitar::InvalidTarStream if header.size < 0	161✔
226
227	if header.long_name?	161✔
228	name = @io.read(512).rstrip	7✔
229	header = PosixHeader.from_stream(@io)	7✔
230	return if header.empty?	7✔
231	header.name = name	7✔
232	end
233
234	entry = EntryStream.new(header, @io)	161✔
235	size = entry.size	161✔
236
237	yield entry	161✔
238
239	skip = (512 - (size % 512)) % 512	161✔
240
241	if Archive::Tar::Minitar.seekable?(@io, :seek)	161✔
242	# avoid reading...
243	@io.seek(size - entry.bytes_read, IO::SEEK_CUR)	28✔
244	else
245	pending = size - entry.bytes_read	133✔
246	while pending > 0	133✔
247	bread = @io.read([pending, 4096].min).size	21✔
248	raise UnexpectedEOF if @io.eof?	21✔
249	pending -= bread	21✔
250	end
251	end
252
253	@io.read(skip) # discard trailing zeros	161✔
254	# make sure nobody can use #read, #getc or #rewind anymore
255	entry.close	161✔
256	end
257	end
258	alias each each_entry	7✔
259
260	# Returns false if the reader is open (it never closes).
261	def closed?	7✔
262	false	14✔
263	end
264
265	def close	7✔
266	end
267	end
268	end

halostatue / minitar / 135

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous