Module: Metaclean::Mat2

Defined in:
lib/metaclean/mat2.rb

Constant Summary collapse

SUPPORTED_EXTS = 
%w[
  epub pdf odc odf odg odi odp ods odt pptx xlsx docx torrent ncx tar
  xht xhtml zip flac m3a mp2a mp3 mp2 m2a mpga oga spx ogg opus
  aifc aiff aif wav bmp gif heic jpg jpe jpeg png svgz svg tiff tif
  webp ppm css htm html text txt in def list log conf
  mp4 mp4v mpg4 m4v wmv avi
].freeze
UNSUPPORTED_RE = 
/(not supported|isn't supported|cannot be cleaned|unsupported file)/i.freeze

Class Method Summary collapse

Class Method Details

.available? ⇒ Boolean

Returns:

  • (Boolean) 


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

def available?
  return @available if defined?(@available)

  out, _err, status = Metaclean.capture3(
    'mat2', '--version',
    timeout: Metaclean::PROBE_TIMEOUT,
    max_output: Metaclean::PROBE_MAX_OUTPUT_BYTES
  )
  @available = status.success?
  @version = @available ? out.strip.split.last : nil
  @available
rescue Errno::ENOENT, Error
  @version = nil
  @available = false
end

.cleaned_path_for(path) ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/metaclean/mat2.rb', line 70

def cleaned_path_for(path)
  dir  = File.dirname(path)
  ext  = File.extname(path)
  stem = File.basename(path, ext)
  File.join(dir, "#{stem}.cleaned#{ext}")
end

.strip!(path) ⇒ Object

Raises:



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
 
# File 'lib/metaclean/mat2.rb', line 43

def strip!(path)
  raise Error, 'mat2 not available' unless available?

  source = FileOps.regular_stat!(path)
  FileOps.with_private_workspace(path, 'mat2') do |workspace|
    work = File.join(workspace, "input#{File.extname(path)}")
    FileOps.copy_exclusive(path, work, preserve: true, expected: source)
    cleaned = cleaned_path_for(work)
    out, err, status = Metaclean.capture3('mat2', Metaclean.safe_path(work))

    if status.success?
      return :no_metadata unless File.exist?(cleaned)

      FileOps.validate_output!(cleaned)
      FileOps.ensure_same_file!(path, source)
      FileOps.restore_metadata(cleaned, source)
      File.rename(cleaned, path)
      return true
    end

    combined = "#{out}\n#{err}"
    return :unsupported if combined.match?(UNSUPPORTED_RE)

    raise Error, "mat2 failed: #{err.strip.empty? ? out.strip : err.strip}"
  end
end

.supports?(path) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
 
# File 'lib/metaclean/mat2.rb', line 37

def supports?(path)
  return false unless available?

  SUPPORTED_EXTS.include?(Metaclean.ext_of(path))
end

.version ⇒ Object 



33
34
35
 
# File 'lib/metaclean/mat2.rb', line 33

def version
  available? ? @version : nil
end