summaryrefslogtreecommitdiffstats
path: root/lib/puppet/file_serving/mount.rb
blob: c52cedbfb5473087a883e58f53bc1d1d83a40bcc (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
#
#  Created by Luke Kanies on 2007-10-16.
#  Copyright (c) 2007. All rights reserved.

require 'puppet/network/authstore'
require 'puppet/util/logging'
require 'puppet/util/cacher'
require 'puppet/file_serving'
require 'puppet/file_serving/metadata'
require 'puppet/file_serving/content'

# Broker access to the filesystem, converting local URIs into metadata
# or content objects.
class Puppet::FileServing::Mount < Puppet::Network::AuthStore
    include Puppet::Util::Logging
    extend Puppet::Util::Cacher

    def self.localmap
        attr_cache(:localmap) { 
            {   "h" =>  Facter.value("hostname"),
                "H" => [Facter.value("hostname"),
                        Facter.value("domain")].join("."),
                "d" =>  Facter.value("domain")
            }
        }
    end

    attr_reader :name

    # Return a new mount with the same properties as +self+, except
    # with a different name and path.
    def copy(name, path)
        result = self.clone
        result.path = path
        result.instance_variable_set(:@name, name)
        return result
    end

    # Return an instance of the appropriate class.
    def file(short_file, options = {})
        file = file_path(short_file, options[:node])

        return nil unless FileTest.exists?(file)

        return file
    end

    # Return a fully qualified path, given a short path and
    # possibly a client name.
    def file_path(relative_path, node = nil)
        full_path = path(node)
        raise ArgumentError.new("Mounts without paths are not usable") unless full_path

        # If there's no relative path name, then we're serving the mount itself.
        return full_path unless relative_path

        return File.join(full_path, relative_path)
    end

    # Create out object.  It must have a name.
    def initialize(name, path = nil)
        unless name =~ %r{^[-\w]+$}
            raise ArgumentError, "Invalid mount name format '%s'" % name
        end
        @name = name

        if path
            self.path = path
        else
            @path = nil
        end

        super()
    end

    # Return the path as appropriate, expanding as necessary.
    def path(node = nil)
        if expandable?
            return expand(@path, node)
        else
            return @path
        end
    end

    # Set the path.
    def path=(path)
        # FIXME: For now, just don't validate paths with replacement
        # patterns in them.
        if path =~ /%./
            # Mark that we're expandable.
            @expandable = true
        else
            unless FileTest.directory?(path)
                raise ArgumentError, "%s does not exist or is not a directory" % path
            end
            unless FileTest.readable?(path)
                raise ArgumentError, "%s is not readable" % path
            end
            @expandable = false
        end
        @path = path
    end

    def sync(path)
        @@syncs[path] ||= Sync.new
        @@syncs[path]
    end

    def to_s
        "mount[%s]" % @name
    end

    # Verify our configuration is valid.  This should really check to
    # make sure at least someone will be allowed, but, eh.
    def valid?
        return ! @path.nil?
    end

    private

    # LAK:FIXME Move this method to the REST terminus hook.
    def authcheck(file, client, clientip)
        raise "This method should be replaced by a REST/terminus hook"
        # If we're local, don't bother passing in information.
        if local?
            client = nil
            clientip = nil
        end
        unless mount.allowed?(client, clientip)
            mount.warning "%s cannot access %s" %
                [client, file]
            raise Puppet::AuthorizationError, "Cannot access %s" % mount
        end
    end

    # Create a map for a specific node.
    def clientmap(node)
        {
            "h" => node.sub(/\..*$/, ""), 
            "H" => node,
            "d" => node.sub(/[^.]+\./, "") # domain name
        }
    end

    # Replace % patterns as appropriate.
    def expand(path, node = nil)
        # This map should probably be moved into a method.
        map = nil

        if node
            map = clientmap(node)
        else
            Puppet.notice "No client; expanding '%s' with local host" %
                path
            # Else, use the local information
            map = localmap()
        end

        path.gsub(/%(.)/) do |v|
            key = $1
            if key == "%" 
                "%"
            else
                map[key] || v
            end
        end
    end

    # Do we have any patterns in our path, yo?
    def expandable?
        if defined? @expandable
            @expandable
        else
            false
        end
    end

    # Cache this manufactured map, since if it's used it's likely
    # to get used a lot.
    def localmap
        self.class.localmap
    end
end