Class: Aspera::Cli::Plugins::Preview

Inherits:
BasicAuth show all
Defined in:
lib/aspera/cli/plugins/preview.rb

Constant Summary collapse

ACTIONS = 
%i[scan events trevents check test show].freeze

Instance Attribute Summary collapse

Attributes inherited from Base

#context

Instance Method Summary collapse

Methods inherited from BasicAuth

#basic_auth_api, #basic_auth_params, declare_options

Methods inherited from Base

#add_manual_header, #config, declare_options, #do_bulk_operation, #entity_execute, #formatter, #options, #persistency, #query_read_delete, #transfer, #value_create_modify

Constructor Details

#initialize(**_) ⇒ Preview

Returns a new instance of Preview.



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
 
# File 'lib/aspera/cli/plugins/preview.rb', line 51

def initialize(**_)
  super
  @option_skip_types = []
  @option_skip_folders = []
  @option_previews_folder = nil
  @option_overwrite = nil
  @option_folder_reset_cache = nil
  # Generator configuration populated from CLI options.
  @gen_options = Aspera::Preview::Options.new
  # Used to rate-limit periodic progress logging and checkpoint persistence.
  @periodic = TimerLimiter.new(LOG_LIMITER_SEC)
  # Optional callback used to filter entries before generation.
  @filter_block = nil
  @access_remote = true
  # Bind CLI options directly to generator option attributes.
  options.declare(
    :skip_format, 'Skip this preview format',
    allowed: Aspera::Preview::Generator::PREVIEW_FORMATS
  )
  # TODO: use the same option as in `node` plugin
  options.declare(
    :folder_reset_cache, 'Force detection of generated preview by refresh cache',
    allowed: %i[no header read],
    handler: {o: self, m: :option_folder_reset_cache},
    default: :no
  )
  options.declare(:skip_types, 'Skip generation for those types of files', handler: {o: self, m: :option_skip_types}, allowed: Allowed::TYPES_SYMBOL_ARRAY + Aspera::Preview::FileTypes::CONVERSION_TYPES)
  options.declare(:previews_folder, 'Preview folder in storage root', handler: {o: self, m: :option_previews_folder}, default: DEFAULT_PREVIEWS_FOLDER)
  options.declare(:skip_folders, 'List of folder to skip', handler: {o: self, m: :option_skip_folders}, allowed: Allowed::TYPES_STRING_ARRAY)
  options.declare(:base, 'Basename of output for for test')
  options.declare(:scan_path, 'Subpath in folder id to start scan in (default=/)')
  options.declare(:scan_id, 'Folder id in storage to start scan in, default is access key main folder id')
  options.declare(:mimemagic, 'Use Mime type detection of gem mimemagic', allowed: Allowed::TYPES_BOOLEAN, default: false)
  options.declare(:overwrite, 'When to overwrite result file', handler: {o: self, m: :option_overwrite}, allowed: %i[always never mtime], default: :mtime)
  options.declare(
    :root_url,
    "How to read and write files on storage (<empty>, #{REMOTE_ACCESS}, or #{UriReader.file_url('<folder>')})",
    allowed: Allowed::TYPES_STRING,
    default: ''
  )
  # Declare generator-specific options and apply their default values.
  Aspera::Preview::Options::DESCRIPTIONS.each do |opt|
    values = if opt.key?(:values)
      opt[:values]
    elsif BoolValue.symbol?(opt[:default])
      BoolValue::TYPES
    end
    options.declare(opt[:name], opt[:description].capitalize, allowed: values, handler: {o: @gen_options, m: opt[:name]}, default: opt[:default])
  end

  options.parse_options!
  Api::Node.api_options[:cache] = !@option_folder_reset_cache.eql?(:header)
  # Start from the full supported format list, then remove any skipped format.
  @preview_formats_to_generate = Aspera::Preview::Generator::PREVIEW_FORMATS.clone
  skip = options.get_option(:skip_format)
  @preview_formats_to_generate.delete(skip) if skip
  @tmp_folder = File.join(TempFileManager.instance.global_temp, "#{TMP_DIR_PREFIX}.#{SecureRandom.uuid}")
  FileUtils.mkdir_p(@tmp_folder)
  Log.log.debug{"tmpdir: #{@tmp_folder}"}
end

Instance Attribute Details

#option_folder_reset_cache ⇒ Object

Returns the value of attribute option_folder_reset_cache.



49
50
51
 
# File 'lib/aspera/cli/plugins/preview.rb', line 49

def option_folder_reset_cache
  @option_folder_reset_cache
end

#option_overwrite ⇒ Object

Returns the value of attribute option_overwrite.



49
50
51
 
# File 'lib/aspera/cli/plugins/preview.rb', line 49

def option_overwrite
  @option_overwrite
end

#option_previews_folder ⇒ Object

Returns the value of attribute option_previews_folder.



49
50
51
 
# File 'lib/aspera/cli/plugins/preview.rb', line 49

def option_previews_folder
  @option_previews_folder
end

#option_skip_folders ⇒ Object

Returns the value of attribute option_skip_folders.



49
50
51
 
# File 'lib/aspera/cli/plugins/preview.rb', line 49

def option_skip_folders
  @option_skip_folders
end

#option_skip_types ⇒ Object

Returns the value of attribute option_skip_types.



49
50
51
 
# File 'lib/aspera/cli/plugins/preview.rb', line 49

def option_skip_types
  @option_skip_types
end

Instance Method Details

#do_transfer(direction, folder_id, source_filename, destination = '/') ⇒ Object

Transfer a file to or from the configured Node storage using a tagged transfer spec.

Parameters:

  • direction (String) —

    transfer direction, typically from [‘Transfer::Spec`](lib/aspera/transfer/spec.rb)

  • folder_id (String) —

    Node API identifier of the reference folder

  • source_filename (String) —

    relative source path inside the transfer root

  • destination (String, nil) (defaults to: '/') —

    local destination root for receive operations

Returns:

  • (Object) —

    transfer result returned by [‘Main.result_transfer`](lib/aspera/cli/main.rb)



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/aspera/cli/plugins/preview.rb', line 200

def do_transfer(direction, folder_id, source_filename, destination = '/')
  Aspera.assert(!(destination.nil? && direction.eql?(Transfer::Spec::DIRECTION_RECEIVE)))
  t_spec = @api_node.transfer_spec_gen4(folder_id, direction, {
    'paths' => [{'source' => source_filename}],
    'tags'  => {Transfer::Spec::TAG_RESERVED => {PREV_GEN_TAG => true}}
  })
  # Force the destination on the transfer agent object.
  # Setting `t_spec['destination_root']` directly would later be overwritten.
  transfer.user_transfer_spec['destination_root'] = destination
  Main.result_transfer(transfer.start(t_spec))
end

#entry_preview_folder_name(entry) ⇒ String

Build the preview folder name for a file entry using the Node API convention.

Parameters:

  • entry (Hash) —

    file entry containing an ‘id`

Returns:

  • (String) —

    preview folder name for the entry



262
263
264
 
# File 'lib/aspera/cli/plugins/preview.rb', line 262

def entry_preview_folder_name(entry)
  "#{entry['id']}#{PREVIEW_FOLDER_SUFFIX}"
end

#execute_action ⇒ Object 



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/aspera/cli/plugins/preview.rb', line 411

def execute_action
  command = options.get_next_command(ACTIONS)
  unless %i[check test show].include?(command)
    # This will use node api
    @api_node = Api::Node.new(**basic_auth_params)
    @transfer_server_address = URI.parse(@api_node.base_url).host
    # Get current access key information
    @access_key_self = @api_node.read('access_keys/self')
    # TODO: check events is activated here:
    # note that docroot is good to look at as well
    node_info = @api_node.read('info')
    Log.log.debug{"root: #{node_info['docroot']}"}
    # Default storage url to local file if not provided
    option_root_url = options.get_option(:root_url, mandatory: true)
    option_root_url = UriReader.file_url(@access_key_self['storage']['path']) if option_root_url.empty? && @access_key_self['storage']['type'].eql?('local')
    @access_remote = !UriReader.file?(option_root_url)
    Log.log.debug{"remote: #{@access_remote}"}
    # TODO: can the `previews` folder parameter be read from Node API ?
    @option_skip_folders.push("/#{@option_previews_folder}")
    if @access_remote
      # NOTE: the filter "name", it's why we take the first one
      @previews_folder_entry = @api_node.read_folder_content(@access_key_self['root_file_id'], {name: @option_previews_folder}).first
      raise Cli::Error, "Folder #{@option_previews_folder} does not exist on node. " \
        'Please create it in the storage root, or specify an alternate name.' if @previews_folder_entry.nil?
    else
      @local_storage_root = UriReader.file_path(option_root_url)
      # TODO: Windows could have "C:" ?
      Aspera.assert(@local_storage_root.start_with?('/')){"not local storage: #{@local_storage_root}"}
      Aspera.assert(File.directory?(@local_storage_root), type: Cli::Error){"Local storage root folder #{@local_storage_root} does not exist."}
      @local_preview_folder = File.join(@local_storage_root, @option_previews_folder)
      Aspera.assert(File.directory?(@local_preview_folder), type: Cli::Error){"Folder #{@local_preview_folder} does not exist locally. Please create it, or specify an alternate name."}
      # Protection to avoid clash of file id for two different access keys
      marker_file = File.join(@local_preview_folder, AK_MARKER_FILE)
      Log.log.debug{"marker file: #{marker_file}"}
      if File.exist?(marker_file)
        ak = File.read(marker_file).chomp
        Aspera.assert(@access_key_self['id'].eql?(ak)){"mismatch access key in #{marker_file}: contains #{ak}, using #{@access_key_self['id']}"}
      else
        File.write(marker_file, @access_key_self['id'])
      end
    end
  end
  Aspera::Preview::FileTypes.instance.use_mimemagic = options.get_option(:mimemagic, mandatory: true)
  # check tools that are anyway required for all cases
  Aspera::Preview::Utils.check_tools(@option_skip_types)
  case command
  when :scan
    scan_path = options.get_option(:scan_path)
    scan_id = options.get_option(:scan_id)
    # by default start at root
    folder_info =
      if scan_id.nil?
        {
          'id'   => @access_key_self['root_file_id'],
          'name' => '/',
          'type' => 'folder',
          'path' => '/'
        }
      else
        @api_node.read("files/#{scan_id}")
      end
    @filter_block = Api::Node.file_matcher_from_argument(options)
    scan_folder_files(folder_info, scan_path)
    return Main.result_status('scan finished')
  when :events, :trevents
    @filter_block = Api::Node.file_matcher_from_argument(options)
    iteration_persistency = nil
    if options.get_option(:once_only, mandatory: true)
      iteration_persistency = PersistencyActionOnce.new(
        manager: persistency,
        data:    [],
        id:      IdGenerator.from_list(
          'preview_iteration',
          command.to_s,
          options.get_option(:url, mandatory: true),
          options.get_option(:username, mandatory: true)
        )
      )
    end
    # call processing method specified by command line command
    send(:"process_#{command}", iteration_persistency)
    return Main.result_status("#{command} finished")
  when :check
    return Main.result_status('Tools validated')
  when :test
    source = options.get_next_argument('source file')
    format = options.get_next_argument('format', accept_list: Aspera::Preview::Generator::PREVIEW_FORMATS, default: :png)
    generated_file_path = preview_filename(format, options.get_option(:base))
    Aspera::Preview::Generator.new(source, generated_file_path, @gen_options, @tmp_folder).generate
    return Main.result_status("generated: #{generated_file_path}")
  when :show
    source = options.get_next_argument('source file')
    # terminal_options = options.get_next_argument('options', validation: Hash, default: {}).symbolize_keys
    generated_file_path = preview_filename(:png, options.get_option(:base))
    Aspera::Preview::Generator.new(source, generated_file_path, @gen_options, @tmp_folder).generate
    formatter.display_status("generated: #{generated_file_path}")
    # formatter.display_status(Aspera::Preview::Terminal.build(File.read(generated_file_path), **terminal_options))
    # return Main.result_status("generated: #{generated_file_path}")
    return Main.result_image(UriReader.file_url(generated_file_path))
  else Aspera.error_unexpected_value(command)
  end
ensure
  Log.log.debug{"cleaning up temp folder #{@tmp_folder}"}
  FileUtils.rm_rf(@tmp_folder)
end

#generate_preview(entry) ⇒ void

This method returns an undefined value.

Generate all required previews for a single file entry when regeneration is needed.

Remote entries must include ‘parent_file_id`.

Parameters:

  • entry (Hash) —

    local or remote file entry to preview



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/aspera/cli/plugins/preview.rb', line 282

def generate_preview(entry)
  # prepare generic information
  gen_infos = @preview_formats_to_generate.map do |preview_format|
    {
      preview_format: preview_format,
      base_dest:      preview_filename(preview_format)
    }
  end
  # lets gather some infos on possibly existing previews
  # it depends if files access locally or remotely
  # folder where previews will be generated for this particular entry
  local_entry_preview_dir = @access_remote ? get_infos_remote(gen_infos, entry) : get_infos_local(gen_infos, entry)
  # here we have the status on preview files
  # let's find if they need generation
  gen_infos.select! do |gen_info|
    # if it exists, what about overwrite policy ?
    if gen_info[:preview_exist]
      case @option_overwrite
      when :always
        # continue: generate
      when :never
        # never overwrite
        next false
      when :mtime
        # skip if preview is newer than original
        next false if gen_info[:preview_newer_than_original]
      end
    end
    begin
      # need generator for further checks
      gen_info[:generator] = Aspera::Preview::Generator.new(gen_info[:src], gen_info[:dst], @gen_options, @tmp_folder, mime: entry['content_type'])
    rescue
      # no conversion supported
      next false
    end
    # shall we skip it ?
    next false if @option_skip_types.include?(gen_info[:generator].conversion_type)
    # ok we need to generate
    true
  end
  return if gen_infos.empty?
  # create folder if needed
  FileUtils.mkdir_p(local_entry_preview_dir)
  if @access_remote
    Aspera.assert(!entry['parent_file_id'].nil?){'missing parent_file_id in entry'}
    #  download original file to temp folder
    do_transfer(Transfer::Spec::DIRECTION_RECEIVE, entry['parent_file_id'], entry['name'], @tmp_folder)
  end
  Log.log.debug{"source: #{entry['id']}: #{entry['path']}"}
  gen_infos.each do |gen_info|
    gen_info[:generator].generate
  rescue => e
    Log.log.error{"Ignoring: #{e.class} #{e.message}"}
    Log.log.debug(e.backtrace.join("\n").red)
    # in case of any error, place a standard error image
    FileUtils.cp(gen_info[:generator].error_asset, @destination_file_path)
  end
  if @access_remote
    # upload
    do_transfer(Transfer::Spec::DIRECTION_SEND, @previews_folder_entry['id'], local_entry_preview_dir)
    # cleanup after upload
    FileUtils.rm_rf(local_entry_preview_dir)
    File.delete(File.join(@tmp_folder, entry['name']))
  end
  # force read file updated previews
  @api_node.read("files/#{entry['id']}") if @option_folder_reset_cache.eql?(:read)
rescue StandardError => e
  Log.log.error{"Ignore: #{e.message}"}
  Log.log.debug(e.backtrace.join("\n").red)
end

#get_infos_local(gen_infos, entry) ⇒ String

Populate generation metadata for a source file available on the local filesystem.

Parameters:

  • gen_infos (Array<Hash>) —

    preview generation descriptors to enrich

  • entry (Hash) —

    file entry containing at least the relative path

Returns:

  • (String) —

    local directory where previews for this entry are stored



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/aspera/cli/plugins/preview.rb', line 217

def get_infos_local(gen_infos, entry)
  local_original_filepath = File.join(@local_storage_root, entry['path'])
  original_mtime = File.mtime(local_original_filepath)
  # Output directory for previews generated from the local source file.
  local_entry_preview_dir = File.join(@local_preview_folder, entry_preview_folder_name(entry))
  gen_infos.each do |gen_info|
    gen_info[:src] = local_original_filepath
    gen_info[:dst] = File.join(local_entry_preview_dir, gen_info[:base_dest])
    gen_info[:preview_exist] = File.exist?(gen_info[:dst])
    gen_info[:preview_newer_than_original] = (gen_info[:preview_exist] && (File.mtime(gen_info[:dst]) > original_mtime))
  end
  return local_entry_preview_dir
end

#get_infos_remote(gen_infos, entry) ⇒ String

Populate generation metadata for a source file stored remotely on Node.

Parameters:

  • gen_infos (Array<Hash>) —

    preview generation descriptors to enrich

  • entry (Hash) —

    remote file entry returned by Node API

Returns:

  • (String) —

    temporary local directory where previews are generated



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/aspera/cli/plugins/preview.rb', line 236

def get_infos_remote(gen_infos, entry)
  # Download the source file into the temporary workspace before generating previews.
  local_original_filepath = File.join(@tmp_folder, entry['name'])
  # require 'date'
  # original_mtime=DateTime.parse(entry['modified_time'])
  # Local directory where previews are generated before being uploaded back.
  local_entry_preview_dir = File.join(@tmp_folder, entry_preview_folder_name(entry))
  file_info = @api_node.read("files/#{entry['id']}")
  # TODO: This does not work with Gen4 because preview folders are hidden by the API.
  # this_preview_folder_entries=@api_node.read_folder_content(@previews_folder_entry['id'],{name: @entry_preview_folder_name})
  # TODO: Query Gen3 APIs to list preview files and retrieve timestamps.
  gen_infos.each do |gen_info|
    gen_info[:src] = local_original_filepath
    gen_info[:dst] = File.join(local_entry_preview_dir, gen_info[:base_dest])
    # TODO: Reuse `this_preview_folder_entries` once preview folders become visible.
    gen_info[:preview_exist] = file_info.key?('preview')
    # TODO: Compare source and preview modification times when remote timestamps are available.
    gen_info[:preview_newer_than_original] = gen_info[:preview_exist]
  end
  return local_entry_preview_dir
end

#preview_filename(preview_format, base_name = nil) ⇒ String

Build a preview filename from a basename and target format.

Parameters:

  • preview_format (String, Symbol) —

    preview format used as filename extension

  • base_name (String, nil) (defaults to: nil) —

    basename to use before the extension

Returns:

  • (String) —

    preview filename



271
272
273
274
 
# File 'lib/aspera/cli/plugins/preview.rb', line 271

def preview_filename(preview_format, base_name = nil)
  base_name ||= PREVIEW_BASENAME
  return "#{base_name}.#{preview_format}"
end

#process_events(iteration_persistency) ⇒ void

This method returns an undefined value.

Process recent Node API file events since the last persisted checkpoint.

Parameters:



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
 
# File 'lib/aspera/cli/plugins/preview.rb', line 161

def process_events(iteration_persistency)
  # Restrict the event stream to file-related changes for the current access key.
  events_filter = {
    'access_key' => @access_key_self['id'],
    'type'       => 'file.*'
  }
  # Resume from the last persisted event id when available.
  events_filter['iteration_token'] = iteration_persistency.data.first unless iteration_persistency.nil?
  events = @api_node.read('events', events_filter)
  return if events.empty?
  events.each do |event|
    # Ignore non-file events such as folder notifications.
    if event.dig('data', 'type').eql?('file')
      file_entry = @api_node.read("files/#{event['data']['id']}") rescue nil
      if !file_entry.nil? &&
          @option_skip_folders.none?{ |d| file_entry['path'].start_with?(d)}
        file_entry['parent_file_id'] = event['data']['parent_file_id']
        Log.log.error('TODO'.red) if event['types'].include?('file.deleted')
        generate_preview(file_entry) if event['types'].include?('file.deleted')
      end
    end
    # Periodically log progress and persist the latest processed event.
    next unless @periodic.trigger? || event.equal?(events.last)
    Log.log.debug{"Processing event #{event['id']}"}
    # Save a checkpoint to avoid replaying the full batch after a failure.
    if !iteration_persistency.nil?
      iteration_persistency.data[0] = event['id'].to_s
      iteration_persistency.save
    end
  end
end

#process_trevents(iteration_persistency) ⇒ void

This method returns an undefined value.

Process legacy transfer events and trigger preview generation for completed downloads.

Parameters:



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
 
# File 'lib/aspera/cli/plugins/preview.rb', line 116

def process_trevents(iteration_persistency)
  events_filter = {
    'access_key' => @access_key_self['id'],
    'type'       => 'download.ended'
  }
  # Resume from the last persisted event id when available.
  events_filter['iteration_token'] = iteration_persistency.data.first unless iteration_persistency.nil?
  begin
    events = @api_node.read('events', events_filter)
  rescue RestCallError => e
    if e.message.include?('Invalid iteration_token')
      Log.log.warn{"Retrying without iteration token: #{e}"}
      events_filter.delete('iteration_token')
      retry
    end
    raise e
  end
  return if events.empty?
  events.each do |event|
    if event['data']['direction'].eql?(Transfer::Spec::DIRECTION_RECEIVE) &&
        event['data']['status'].eql?('completed') &&
        event['data']['error_code'].eql?(0) &&
        event['data'].dig('tags', Transfer::Spec::TAG_RESERVED, PREV_GEN_TAG).nil?
      folder_id = event.dig('data', 'tags', Transfer::Spec::TAG_RESERVED, 'node', 'file_id')
      folder_id ||= event.dig('data', 'file_id')
      if !folder_id.nil?
        folder_entry = @api_node.read("files/#{folder_id}") rescue nil
        scan_folder_files(folder_entry) unless folder_entry.nil?
      end
    end
    # Periodically log progress and persist the latest processed event.
    next unless @periodic.trigger? || event.equal?(events.last)
    Log.log.debug{"Processed event #{event['id']}"}
    # Save a checkpoint to avoid replaying the full batch after a failure.
    if !iteration_persistency.nil?
      iteration_persistency.data[0] = event['id'].to_s
      iteration_persistency.save
    end
  end
end

#scan_folder_files(top_entry, top_path = nil) ⇒ Object

Scan all files in provided folder entry

Parameters:

  • top_entry (Hash) —

    the top entry to scan

  • top_path (String, nil) (defaults to: nil) —

    subpath to start folder scan inside



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/aspera/cli/plugins/preview.rb', line 356

def scan_folder_files(top_entry, top_path = nil)
  unless top_path.nil?
    # canonical path: start with / and ends with /
    top_path = "/#{top_path.split('/').reject(&:empty?).join('/')}/"
  end
  Log.log.debug{"scan: #{top_entry} : #{top_path}".green}
  # don't use recursive call, use list instead
  entries_to_process = [top_entry]
  until entries_to_process.empty?
    entry = entries_to_process.shift
    # process this entry only if it is within the top_path
    entry_path_with_slash = entry['path']
    Log.log.debug{"processing entry #{entry_path_with_slash}"} if @periodic.trigger?
    entry_path_with_slash = "#{entry_path_with_slash}/" unless entry_path_with_slash.end_with?('/')
    if !top_path.nil? && !top_path.start_with?(entry_path_with_slash) && !entry_path_with_slash.start_with?(top_path)
      Log.log.debug{"#{entry['path']} folder (skip start)".bg_red}
      next
    end
    Log.log.debug{"item:#{entry}"}
    begin
      case entry['type']
      when 'file'
        if @filter_block.call(entry)
          generate_preview(entry)
        else
          Log.log.debug('skip by filter')
        end
      when 'link'
        Log.log.debug('Ignoring link.')
      when 'folder'
        if @option_skip_folders.include?(entry['path'])
          Log.log.debug{"#{entry['path']} folder (skip list)".bg_red}
        else
          Log.log.debug{"#{entry['path']} folder".green}
          # get folder content
          folder_entries = @api_node.read_folder_content(entry['id'])
          # process all items in current folder
          folder_entries.each do |folder_entry|
            # add path for older versions of ES
            folder_entry['path'] = entry_path_with_slash + folder_entry['name'] if !folder_entry.key?('path')
            folder_entry['parent_file_id'] = entry['id']
            entries_to_process.push(folder_entry)
          end
        end
      else
        Log.log.warn{"unknown entry type: #{entry['type']}"}
      end
    rescue StandardError => e
      Log.log.warn{"An error occurred: #{e}, ignoring"}
    end
  end
end