1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: Apache-2.0
7 # A Locator is used to parse and manipulate Keep locator strings.
9 # Locators obey the following syntax:
11 # locator ::= address hint*
12 # address ::= digest size-hint
13 # digest ::= <32 hexadecimal digits>
14 # size-hint ::= "+" [0-9]+
15 # hint ::= "+" hint-type hint-content
17 # hint-content ::= [A-Za-z0-9@_-]+
19 # Individual hints may have their own required format:
21 # sign-hint ::= "+A" <40 lowercase hex digits> "@" sign-timestamp
22 # sign-timestamp ::= <8 lowercase hex digits>
23 attr_reader :hash, :hints, :size
25 LOCATOR_REGEXP = /^([[:xdigit:]]{32})(\+([[:digit:]]+))?((\+([[:upper:]][[:alnum:]@_-]*))+)?\z/
27 def initialize(hasharg, sizearg, hintarg)
34 !!(LOCATOR_REGEXP.match tok)
37 # Locator.parse returns a Locator object parsed from the string tok.
38 # Returns nil if tok could not be parsed as a valid locator.
47 # Locator.parse! returns a Locator object parsed from the string tok,
48 # raising an ArgumentError if tok cannot be parsed.
50 if tok.nil? or tok.empty?
51 raise ArgumentError.new "locator is nil or empty"
54 m = LOCATOR_REGEXP.match(tok)
56 raise ArgumentError.new "not a valid locator #{tok}"
59 tokhash, _, toksize, _, _, trailer = m[1..6]
62 trailer.split('+').each do |hint|
63 if hint =~ /^[[:upper:]][[:alnum:]@_-]*$/
66 raise ArgumentError.new "invalid hint #{hint}"
71 Locator.new(tokhash, toksize, tokhints)
74 # Returns the signature hint supplied with this locator,
75 # or nil if the locator was not signed.
77 @hints.grep(/^A/).first
80 # Returns an unsigned Locator.
82 Locator.new(@hash, @size, @hints.reject { |o| o.start_with?("A") })
86 Locator.new(@hash, @size, [])
96 [ @hash, @size, *@hints ].join('+')
98 [ @hash, *@hints ].join('+')
104 STRICT_STREAM_TOKEN_REGEXP = /^(\.)(\/[^\/\s]+)*$/
105 STRICT_FILE_TOKEN_REGEXP = /^[[:digit:]]+:[[:digit:]]+:([^\s\/]+(\/[^\s\/]+)*)$/
106 EMPTY_DOT_FILE_TOKEN_REGEXP = /^0:0:\.$/
108 # Class to parse a manifest text and provide common views of that data.
109 def initialize(manifest_text)
110 @text = manifest_text
115 return to_enum(__method__) unless block_given?
116 @text.each_line do |line|
120 line.scan(/\S+/) do |token|
122 stream_name = unescape token
123 elsif file_tokens.empty? and Locator.valid? token
124 block_tokens << token
126 file_tokens << unescape(token)
130 next if stream_name.nil?
131 yield [stream_name, block_tokens, file_tokens]
135 def self.unescape(s, except=[])
138 # Parse backslash escapes in a Keep manifest stream or file name.
139 s.gsub(/\\(\\|[0-7]{3})/) do |_|
142 elsif except.include? $1
151 self.class.unescape(s)
154 def split_file_token token
155 start_pos, filesize, filename = token.split(':', 3)
157 raise ArgumentError.new "Invalid file token '#{token}'"
159 [start_pos.to_i, filesize.to_i, unescape(filename)]
163 return to_enum(__method__) unless block_given?
164 @text.each_line do |line|
166 in_file_tokens = false
167 line.scan(/\S+/) do |token|
169 stream_name = unescape token
170 elsif in_file_tokens or not Locator.valid? token
171 in_file_tokens = true
173 start_pos, file_size, file_name = split_file_token(token)
174 stream_name_adjuster = ''
175 if file_name.include?('/') # '/' in filename
176 dirname, sep, basename = file_name.rpartition('/')
177 stream_name_adjuster = sep + dirname # /dir_parts
181 yield [stream_name + stream_name_adjuster, start_pos, file_size, file_name]
190 file_sizes = Hash.new(0)
191 each_file_spec do |streamname, _, filesize, filename|
192 file_sizes[[streamname, filename]] += filesize
194 @files = file_sizes.each_pair.map do |(streamname, filename), size|
195 [streamname, filename, size]
201 def files_count(stop_after=nil)
202 # Return the number of files represented in this manifest.
203 # If stop_after is provided, files_count will read the manifest
204 # incrementally, and return immediately when it counts that number of
205 # files. This can help you avoid parsing the entire manifest if you
206 # just want to check if a small number of files are specified.
207 if stop_after.nil? or not @files.nil?
208 # Avoid counting empty dir placeholders
209 return files.reject{|_, name, size| name == '.' and size == 0}.size
212 each_file_spec do |streamname, _, filesize, filename|
213 # Avoid counting empty dir placeholders
214 next if filename == "." and filesize == 0
215 seen_files[[streamname, filename]] = true
216 return stop_after if (seen_files.size >= stop_after)
222 # Return the total size of all files in this manifest.
223 files.reduce(0) { |total, (_, _, size)| total + size }
226 def exact_file_count?(want_count)
227 files_count(want_count + 1) == want_count
230 def minimum_file_count?(want_count)
231 files_count(want_count) >= want_count
234 def has_file?(want_stream, want_file=nil)
236 want_stream, want_file = File.split(want_stream)
238 each_file_spec do |streamname, _, _, name|
239 if streamname == want_stream and name == want_file
246 # Verify that a given manifest is valid according to
247 # https://arvados.org/projects/arvados/wiki/Keep_manifest_format
248 def self.validate! manifest
249 raise ArgumentError.new "No manifest found" if !manifest
251 return true if manifest.empty?
253 raise ArgumentError.new "Invalid manifest: does not end with newline" if !manifest.end_with?("\n")
255 manifest.each_line do |line|
258 words = line[0..-2].split(/ /)
259 raise ArgumentError.new "Manifest invalid for stream #{line_count}: missing stream name" if words.empty?
264 unescaped_word = unescape(word, except=["040"])
265 count += 1 if unescaped_word =~ STRICT_STREAM_TOKEN_REGEXP and unescaped_word !~ /\/\.\.?(\/|$)/
266 raise ArgumentError.new "Manifest invalid for stream #{line_count}: missing or invalid stream name #{word.inspect if word}" if count != 1
270 while word =~ Locator::LOCATOR_REGEXP
274 raise ArgumentError.new "Manifest invalid for stream #{line_count}: missing or invalid locator #{word.inspect if word}" if count == 0
277 while unescape(word) =~ EMPTY_DOT_FILE_TOKEN_REGEXP or
278 (unescape(word, except=["040"]) =~ STRICT_FILE_TOKEN_REGEXP and ($~[1].split('/') & ['..', '.']).empty?)
284 raise ArgumentError.new "Manifest invalid for stream #{line_count}: invalid file token #{word.inspect}"
286 raise ArgumentError.new "Manifest invalid for stream #{line_count}: no file tokens"
289 # Ruby's split() method silently drops trailing empty tokens
290 # (which are not allowed by the manifest format) so we have to
291 # check trailing spaces manually.
292 raise ArgumentError.new "Manifest invalid for stream #{line_count}: trailing space" if line.end_with? " \n"
297 def self.valid? manifest