summaryrefslogtreecommitdiffstats
path: root/lib/puppet/type/file/source.rb
blob: 74cd4c028e90a1745048d17f916034251269cc1a (plain)
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
182
183
184
185
186
187
188
189
190
191
192
193

require 'puppet/file_serving/content'
require 'puppet/file_serving/metadata'

module Puppet
    # Copy files from a local or remote source.  This state *only* does any work
    # when the remote file is an actual file; in that case, this state copies
    # the file down.  If the remote file is a dir or a link or whatever, then
    # this state, during retrieval, modifies the appropriate other states
    # so that things get taken care of appropriately.
    Puppet::Type.type(:file).newparam(:source) do
        include Puppet::Util::Diff

        attr_accessor :source, :local
        desc "Copy a file over the current file.  Uses ``checksum`` to
            determine when a file should be copied.  Valid values are either
            fully qualified paths to files, or URIs.  Currently supported URI
            types are *puppet* and *file*.

            This is one of the primary mechanisms for getting content into
            applications that Puppet does not directly support and is very
            useful for those configuration files that don't change much across
            sytems.  For instance::

                class sendmail {
                    file { \"/etc/mail/sendmail.cf\":
                        source => \"puppet://server/modules/module_name/sendmail.cf\"
                    }
                }

            You can also leave out the server name, in which case ``puppet agent``
            will fill in the name of its configuration server and ``puppet apply``
            will use the local filesystem.  This makes it easy to use the same
            configuration in both local and centralized forms.

            Currently, only the ``puppet`` scheme is supported for source
            URL's. Puppet will connect to the file server running on
            ``server`` to retrieve the contents of the file. If the
            ``server`` part is empty, the behavior of the command-line
            interpreter (``puppet apply``) and the client demon (``puppet agent``) differs
            slightly: ``apply`` will look such a file up on the module path
            on the local host, whereas ``agent`` will connect to the
            puppet server that it received the manifest from.

            See the `FileServingConfiguration fileserver configuration documentation`:trac: for information on how to configure
            and use file services within Puppet.

            If you specify multiple file sources for a file, then the first
            source that exists will be used.  This allows you to specify
            what amount to search paths for files::

                file { \"/path/to/my/file\":
                    source => [
                        \"/modules/nfs/files/file.$host\",
                        \"/modules/nfs/files/file.$operatingsystem\",
                        \"/modules/nfs/files/file\"
                    ]
                }

            This will use the first found file as the source.

            You cannot currently copy links using this mechanism; set ``links``
            to ``follow`` if any remote sources are links.
            "

        validate do |sources|
            sources = [sources] unless sources.is_a?(Array)
            sources.each do |source|
                begin
                    uri = URI.parse(URI.escape(source))
                rescue => detail
                    self.fail "Could not understand source #{source}: #{detail}"
                end

                unless uri.scheme.nil? or %w{file puppet}.include?(uri.scheme)
                    self.fail "Cannot use URLs of type '#{uri.scheme}' as source for fileserving"
                end
            end
        end

        munge do |sources|
            sources = [sources] unless sources.is_a?(Array)
            sources.collect { |source| source.sub(/\/$/, '') }
        end

        def change_to_s(currentvalue, newvalue)
            # newvalue = "{md5}#{@metadata.checksum}"
            if @resource.property(:ensure).retrieve == :absent
                return "creating from source #{metadata.source} with contents #{metadata.checksum}"
            else
                return "replacing from source #{metadata.source} with contents #{metadata.checksum}"
            end
        end

        def checksum
            metadata && metadata.checksum
        end

        # Copy the values from the source to the resource.  Yay.
        def copy_source_values
            devfail "Somehow got asked to copy source values without any metadata" unless metadata

            # Take each of the stats and set them as states on the local file
            # if a value has not already been provided.
            [:owner, :mode, :group, :checksum].each do |metadata_method|
                param_name = (metadata_method == :checksum) ? :content : metadata_method
                next if metadata_method == :owner and !Puppet.features.root?
                next if metadata_method == :checksum and metadata.ftype == "directory"

                if resource[param_name].nil? or resource[param_name] == :absent
                    v = metadata.send(metadata_method)
                    resource.info "Setting #{param_name} to #{v}"
                    resource[param_name] = metadata.send(metadata_method)
                end
            end

            if resource[:ensure] == :absent
                # We know all we need to
            elsif metadata.ftype != "link"
                resource[:ensure] = metadata.ftype
            elsif @resource[:links] == :follow
                resource[:ensure] = :present
            else
                resource[:ensure] = "link"
                resource[:target] = metadata.destination
            end
        end

        def pinparams
            [:mode, :type, :owner, :group, :content]
        end

        def found?
            ! (metadata.nil? or metadata.ftype.nil?)
        end

        # Provide, and retrieve if necessary, the metadata for this file.  Fail
        # if we can't find data about this host, and fail if there are any
        # problems in our query.
        cached_attr(:metadata) do
            return nil unless value
            result = nil
            value.each do |source|
                begin
                    if data = Puppet::FileServing::Metadata.find(source)
                        result = data
                        result.source = source
                        break
                    end
                rescue => detail
                    fail detail, "Could not retrieve file metadata for #{source}: #{detail}"
                end
            end
            fail "Could not retrieve information from source(s) #{value.join(", ")}" unless result
            result
        end

        # Make sure we're also checking the checksum
        def value=(value)
            super

            checks = (pinparams + [:ensure])
            checks.delete(:checksum)

            resource[:audit] = checks
            resource[:checksum] = :md5 unless resource.property(:checksum)
        end

        def local?
            found? and uri and (uri.scheme || "file") == "file"
        end

        def full_path
            if found? and uri
                return URI.unescape(uri.path)
            end
        end

        def server
            (uri and uri.host) or Puppet.settings[:server]
        end

        def port
            (uri and uri.port) or Puppet.settings[:masterport]
        end

        private

        def uri
            @uri ||= URI.parse(URI.escape(metadata.source))
        end
    end
end