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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Seth Chisamore (<schisamo@chef.io>)
# Copyright:: Copyright 2008-2016, 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.
#
require "uri"
require "chef/resource/file"
require "chef/provider/remote_file"
require "chef/mixin/securable"
require "chef/mixin/uris"
class Chef
class Resource
class RemoteFile < Chef::Resource::File
include Chef::Mixin::Securable
description "Use the remote_file resource to transfer a file from a remote location"\
" using file specificity. This resource is similar to the file resource."
def initialize(name, run_context = nil)
super
@source = []
end
# source can take any of the following as arguments
# - A single string argument
# - Multiple string arguments
# - An array or strings
# - A delayed evaluator that evaluates to a string
# or array of strings
# All strings must be parsable as URIs.
# source returns an array of strings.
def source(*args)
arg = parse_source_args(args)
ret = set_or_return(:source,
arg,
{ callbacks: {
validate_source: method(:validate_source),
} })
if ret.is_a? String
Array(ret)
else
ret
end
end
def parse_source_args(args)
if args.empty?
nil
elsif args[0].is_a?(Chef::DelayedEvaluator) && args.count == 1
args[0]
elsif args.any? { |a| a.is_a?(Chef::DelayedEvaluator) } && args.count > 1
raise Exceptions::InvalidRemoteFileURI, "Only 1 source argument allowed when using a lazy evaluator"
else
Array(args).flatten
end
end
property :checksum, String
# Disable or enable ETag and Last Modified conditional GET. Equivalent to
# use_etag(true_or_false)
# use_last_modified(true_or_false)
def use_conditional_get(true_or_false)
use_etag(true_or_false)
use_last_modified(true_or_false)
end
property :use_etag, [ TrueClass, FalseClass ], default: true
alias :use_etags :use_etag
property :use_last_modified, [ TrueClass, FalseClass ], default: true
property :ftp_active_mode, [ TrueClass, FalseClass ], default: false
property :headers, Hash, default: lazy { Hash.new }
property :show_progress, [ TrueClass, FalseClass ], default: false
property :remote_user, String
property :remote_domain, String
property :remote_password, String, sensitive: true
property :authentication, equal_to: [:remote, :local], default: :remote
def after_created
validate_identity_platform(remote_user, remote_password, remote_domain)
identity = qualify_user(remote_user, remote_password, remote_domain)
remote_domain(identity[:domain])
remote_user(identity[:user])
end
def validate_identity_platform(specified_user, password = nil, specified_domain = nil)
if node[:platform_family] == "windows"
if specified_user && password.nil?
raise ArgumentError, "A value for `remote_password` must be specified when a value for `user` is specified on the Windows platform"
end
end
end
def qualify_user(specified_user, password = nil, specified_domain = nil)
domain = specified_domain
user = specified_user
if specified_user.nil? && ! specified_domain.nil?
raise ArgumentError, "The domain `#{specified_domain}` was specified, but no user name was given"
end
# if domain is provided in both username and domain
if specified_user && ((specified_user.include? '\\') || (specified_user.include? "@")) && specified_domain
raise ArgumentError, "The domain is provided twice. Username: `#{specified_user}`, Domain: `#{specified_domain}`. Please specify domain only once."
end
if ! specified_user.nil? && specified_domain.nil?
# Splitting username of format: Domain\Username
domain_and_user = user.split('\\')
if domain_and_user.length == 2
domain = domain_and_user[0]
user = domain_and_user[1]
elsif domain_and_user.length == 1
# Splitting username of format: Username@Domain
domain_and_user = user.split("@")
if domain_and_user.length == 2
domain = domain_and_user[1]
user = domain_and_user[0]
elsif domain_and_user.length != 1
raise ArgumentError, "The specified user name `#{user}` is not a syntactically valid user name"
end
end
end
if ( password || domain ) && user.nil?
raise ArgumentError, "A value for `password` or `domain` was specified without specification of a value for `user`"
end
{ domain: domain, user: user }
end
private
include Chef::Mixin::Uris
def validate_source(source)
source = Array(source).flatten
raise ArgumentError, "#{resource_name} has an empty source" if source.empty?
source.each do |src|
unless absolute_uri?(src)
raise Exceptions::InvalidRemoteFileURI,
"#{src.inspect} is not a valid `source` parameter for #{resource_name}. `source` must be an absolute URI or an array of URIs."
end
end
true
end
def absolute_uri?(source)
Chef::Provider::RemoteFile::Fetcher.network_share?(source) || (source.kind_of?(String) && as_uri(source).absolute?)
rescue URI::InvalidURIError
false
end
end
end
end
|
