summaryrefslogtreecommitdiffstats
path: root/lib/puppet/indirector/request.rb
blob: 450b43bd2aa0f3acc3a91acec91ecbb6a1a4a6ae (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
require 'uri'
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 :key, :method, :options, :instance, :node, :ip, :authenticated, :ignore_cache, :ignore_terminus

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

    attr_reader :environment, :indirection_name

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

    def environment=(env)
        @environment = if env.is_a?(Puppet::Node::Environment)
            env
        else
            Puppet::Node::Environment.new(env)
        end
    end

    def escaped_key
        URI.escape(key)
    end

    def indirection_name=(name)
        @indirection_name = name.to_sym
    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)

        self.indirection_name = indirection_name
        self.method = 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

    # Create the query string, if options are present.
    def query_string
        return "" unless options and ! options.empty?
        "?" + options.collect do |key, value|
            case value
            when nil; next
            when true, false; value = value.to_s
            when Fixnum, Bignum, Float; value = value # nothing
            when String; value = URI.escape(value)
            when Symbol; value = URI.escape(value.to_s)
            when Array; value = URI.escape(YAML.dump(value))
            else
                raise ArgumentError, "HTTP REST queries cannot handle values of type '%s'" % value.class
            end

            "%s=%s" % [key, value]
        end.join("&")
    end

    def to_s
        return uri if uri
        return "/%s/%s" % [indirection_name, key]
    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.unescape(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.unescape(uri.path.sub(/^\//, ''))
    end
end