summaryrefslogtreecommitdiffstats
path: root/lib/puppet/indirector/request.rb
blob: 8227db17465b6411be39147c6ab3699a4e4c6563 (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
require 'puppet/indirector'

# This class encapsulates all of the information you need to make an
# Indirection call, and as a a result also handles REST calls.  It's somewhat
# analogous to an HTTP Request object, except tuned for our Indirector.
class Puppet::Indirector::Request
    attr_accessor :indirection_name, :key, :method, :options, :instance, :node, :ip, :authenticated, :ignore_cache, :ignore_terminus

    attr_accessor :server, :port, :uri, :protocol

    # Is this an authenticated request?
    def authenticated?
        # Double negative, so we just get true or false
        ! ! authenticated
    end

    # LAK:NOTE This is a messy interface to the cache, and it's only
    # used by the Configurer class.  I decided it was better to implement
    # it now and refactor later, when we have a better design, than
    # to spend another month coming up with a design now that might
    # not be any better.
    def ignore_cache?
        ignore_cache
    end

    def ignore_terminus?
        ignore_terminus
    end

    def initialize(indirection_name, method, key, options = {})
        options ||= {}
        raise ArgumentError, "Request options must be a hash, not %s" % options.class unless options.is_a?(Hash)

        @indirection_name, @method = indirection_name, method

        @options = options.inject({}) do |result, ary|
            param, value = ary
            if respond_to?(param.to_s + "=")
                send(param.to_s + "=", value)
            else
                result[param] = value
            end
            result
        end

        if key.is_a?(String) or key.is_a?(Symbol)
            # If the request key is a URI, then we need to treat it specially,
            # because it rewrites the key.  We could otherwise strip server/port/etc
            # info out in the REST class, but it seemed bad design for the REST
            # class to rewrite the key.
            if key.to_s =~ /^\w+:\/\// # it's a URI
                set_uri_key(key)
            else
                @key = key
            end
        else
            @instance = key
            @key = @instance.name
        end
    end

    # Look up the indirection based on the name provided.
    def indirection
        Puppet::Indirector::Indirection.instance(indirection_name)
    end

    # Should we allow use of the cached object?
    def use_cache?
        if defined?(@use_cache)
            ! ! use_cache
        else
            true
        end
    end

    # Are we trying to interact with multiple resources, or just one?
    def plural?
        method == :search
    end

    private

    # Parse the key as a URI, setting attributes appropriately.
    def set_uri_key(key)
        @uri = key
        begin
            uri = URI.parse(URI.escape(key))
        rescue => detail
            raise ArgumentError, "Could not understand URL %s: %s" % [source, detail.to_s]
        end

        # Just short-circuit these to full paths
        if uri.scheme == "file"
            @key = uri.path
            return
        end

        @server = uri.host if uri.host

        # If the URI class can look up the scheme, it will provide a port,
        # otherwise it will default to '0'.
        if uri.port.to_i == 0 and uri.scheme == "puppet"
            @port = Puppet.settings[:masterport].to_i
        else
            @port = uri.port.to_i
        end

        @protocol = uri.scheme
        @key = uri.path.sub(/^\//, '')
    end
end