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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
|
#
# Author:: Bryan McLellan <btm@loftninjas.org>
# Copyright:: Copyright (c) 2014 Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
class Chef
class Util
class PathHelper
# Maximum characters in a standard Windows path (260 including drive letter and NUL)
WIN_MAX_PATH = 259
def self.dirname(path)
if Chef::Platform.windows?
# Find the first slash, not counting trailing slashes
end_slash = path.size
while true
slash = path.rindex(/[#{Regexp.escape(File::SEPARATOR)}#{Regexp.escape(path_separator)}]/, end_slash - 1)
if !slash
return end_slash == path.size ? '.' : path_separator
elsif slash == end_slash - 1
end_slash = slash
else
return path[0..slash-1]
end
end
else
::File.dirname(path)
end
end
BACKSLASH = '\\'.freeze
def self.path_separator
if Chef::Platform.windows?
File::ALT_SEPARATOR || BACKSLASH
else
File::SEPARATOR
end
end
def self.join(*args)
args.flatten.inject do |joined_path, component|
# Joined path ends with /
joined_path = joined_path.sub(/[#{Regexp.escape(File::SEPARATOR)}#{Regexp.escape(path_separator)}]+$/, '')
component = component.sub(/^[#{Regexp.escape(File::SEPARATOR)}#{Regexp.escape(path_separator)}]+/, '')
joined_path += "#{path_separator}#{component}"
end
end
def self.validate_path(path)
if Chef::Platform.windows?
unless printable?(path)
msg = "Path '#{path}' contains non-printable characters. Check that backslashes are escaped with another backslash (e.g. C:\\\\Windows) in double-quoted strings."
Chef::Log.error(msg)
raise Chef::Exceptions::ValidationFailed, msg
end
if windows_max_length_exceeded?(path)
Chef::Log.debug("Path '#{path}' is longer than #{WIN_MAX_PATH}, prefixing with'\\\\?\\'")
path.insert(0, "\\\\?\\")
end
end
path
end
def self.windows_max_length_exceeded?(path)
# Check to see if paths without the \\?\ prefix are over the maximum allowed length for the Windows API
# http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx
unless path =~ /^\\\\?\\/
if path.length > WIN_MAX_PATH
return true
end
end
false
end
def self.printable?(string)
# returns true if string is free of non-printable characters (escape sequences)
# this returns false for whitespace escape sequences as well, e.g. \n\t
if string =~ /[^[:print:]]/
false
else
true
end
end
# Produces a comparable path.
def self.canonical_path(path, add_prefix=true)
# Rather than find an equivalent for File.absolute_path on 1.8.7, just bail out
raise NotImplementedError, "This feature is not supported on Ruby versions < 1.9" if RUBY_VERSION.to_f < 1.9
# First remove extra separators and resolve any relative paths
abs_path = File.absolute_path(path)
if Chef::Platform.windows?
# Add the \\?\ API prefix on Windows unless add_prefix is false
# Downcase on Windows where paths are still case-insensitive
abs_path.gsub!(::File::SEPARATOR, path_separator)
if add_prefix && abs_path !~ /^\\\\?\\/
abs_path.insert(0, "\\\\?\\")
end
abs_path.downcase!
end
abs_path
end
def self.cleanpath(path)
path = Pathname.new(path).cleanpath.to_s
# ensure all forward slashes are backslashes
if Chef::Platform.windows?
path = path.gsub(File::SEPARATOR, path_separator)
end
path
end
def self.paths_eql?(path1, path2)
canonical_path(path1) == canonical_path(path2)
end
end
end
end
# Break a require loop when require chef/util/path_helper
require 'chef/platform'
require 'chef/exceptions'
|
