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
|
require 'mini_magick/utilities'
require 'logger'
module MiniMagick
module Configuration
##
# Uses [GraphicsMagick](http://www.graphicsmagick.org/) instead of
# ImageMagick, by prefixing commands with `gm` instead of `magick`.
#
# @return [Boolean]
attr_accessor :graphicsmagick
##
# Adds a prefix to the CLI command.
# For example, you could use `firejail` to run all commands in a sandbox.
# Can be a string, or an array of strings.
# e.g. 'firejail', or ['firejail', '--force']
#
# @return [String]
# @return [Array<String>]
#
attr_accessor :cli_prefix
##
# Adds environment variables to every CLI command call.
# For example, you could use it to set `LD_PRELOAD="/path/to/libsomething.so"`.
# Must be a hash of strings keyed to valid environment variable name strings.
# e.g. {'MY_ENV' => 'my value'}
#
# @return [Hash]
#
attr_accessor :cli_env
##
# If set to true, Open3 will restrict system calls to access only
# environment variables defined in :cli_env, plus HOME, PATH, and LANG
# since those are required for such system calls. It will not pass on any
# other environment variables from the system.
#
# @return [Boolean]
#
attr_accessor :restricted_env
##
# If you don't want commands to take too long, you can set a timeout (in
# seconds).
#
# @return [Integer]
#
attr_accessor :timeout
##
# Logger for commands, default is `Logger.new($stdout)`, but you can
# override it, for example if you want the logs to be written to a file.
#
# @return [Logger]
#
attr_accessor :logger
##
# Temporary directory used by MiniMagick, default is `Dir.tmpdir`, but
# you can override it.
#
# @return [String]
#
attr_accessor :tmpdir
##
# If set to `false`, it will not raise errors when ImageMagick returns
# status code different than 0. Defaults to `true`.
#
# @return [Boolean]
#
attr_accessor :errors
##
# If set to `false`, it will not forward warnings from ImageMagick to
# standard error.
attr_accessor :warnings
def self.extended(base)
base.tmpdir = Dir.tmpdir
base.errors = true
base.logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
base.warnings = true
base.cli_env = {}.freeze
base.restricted_env = false
base.graphicsmagick = false
end
##
# @yield [self]
# @example
# MiniMagick.configure do |config|
# config.timeout = 5
# end
#
def configure
yield self
end
end
end
|
