puppet 0.23.2 → 0.24.0

data/lib/puppet/indirector/facts/memory.rb

@@ -0,0 +1,9 @@
+require 'puppet/node/facts'
+require 'puppet/indirector/memory'
+
+class Puppet::Node::Facts::Memory < Puppet::Indirector::Memory
+    desc "Keep track of facts in memory but nowhere else.  This is used for
+        one-time compiles, such as what the stand-alone ``puppet`` does.
+        To use this terminus, you must load it with the data you want it
+        to contain."
+end

data/lib/puppet/indirector/facts/yaml.rb

@@ -0,0 +1,7 @@
+require 'puppet/node/facts'
+require 'puppet/indirector/yaml'
+
+class Puppet::Node::Facts::Yaml < Puppet::Indirector::Yaml
+    desc "Store client facts as flat files, serialized using YAML, or
+        return deserialized facts from disk."
+end

data/lib/puppet/indirector/file.rb

@@ -0,0 +1,54 @@
+require 'puppet/indirector/terminus'
+
+# An empty terminus type, meant to just return empty objects.
+class Puppet::Indirector::File < Puppet::Indirector::Terminus
+    def destroy(file)
+        if respond_to?(:path)
+            path = path(file.name)
+        else
+            path = file.path
+        end
+        raise Puppet::Error.new("File %s does not exist; cannot destroy" % [file]) unless File.exist?(path)
+
+        begin
+            File.unlink(path)
+        rescue => detail
+            raise Puppet::Error, "Could not remove %s: %s" % [file, detail]
+        end
+    end
+
+    def find(name)
+        if respond_to?(:path)
+            path = path(name)
+        else
+            path = name
+        end
+
+        return nil unless File.exist?(path)
+
+        begin
+            content = File.read(path)
+        rescue => detail
+            raise Puppet::Error, "Could not retrieve path %s: %s" % [path, detail]
+        end
+
+        return model.new(content)
+    end
+
+    def save(file)
+        if respond_to?(:path)
+            path = path(file.name)
+        else
+            path = file.path
+        end
+        dir = File.dirname(path)
+
+        raise Puppet::Error.new("Cannot save %s; parent directory %s does not exist" % [file, dir]) unless File.directory?(dir)
+
+        begin
+            File.open(path, "w") { |f| f.print file.content }
+        rescue => detail
+            raise Puppet::Error, "Could not write %s: %s" % [file, detail]
+        end
+    end
+end

data/lib/puppet/indirector/file_content.rb

@@ -0,0 +1,5 @@
+require 'puppet/file_serving/content'
+
+# A stub class, so our constants work.
+class Puppet::Indirector::FileContent # :nodoc:
+end

data/lib/puppet/indirector/file_content/file.rb

@@ -0,0 +1,11 @@
+#
+#  Created by Luke Kanies on 2007-10-16.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/content'
+require 'puppet/indirector/file_content'
+require 'puppet/indirector/direct_file_server'
+
+class Puppet::Indirector::FileContent::File < Puppet::Indirector::DirectFileServer
+    desc "Retrieve file contents from disk."
+end

data/lib/puppet/indirector/file_content/file_server.rb

@@ -0,0 +1,11 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/content'
+require 'puppet/indirector/file_content'
+require 'puppet/indirector/file_server'
+
+class Puppet::Indirector::FileContent::FileServer < Puppet::Indirector::FileServer
+    desc "Retrieve file contents using Puppet's fileserver."
+end

data/lib/puppet/indirector/file_content/modules.rb

@@ -0,0 +1,11 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/content'
+require 'puppet/indirector/file_content'
+require 'puppet/indirector/module_files'
+
+class Puppet::Indirector::FileContent::Modules < Puppet::Indirector::ModuleFiles
+    desc "Retrieve file contents from modules."
+end

data/lib/puppet/indirector/file_content/rest.rb

@@ -0,0 +1,12 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/content'
+require 'puppet/util/uri_helper'
+require 'puppet/indirector/file_content'
+require 'puppet/indirector/rest'
+
+class Puppet::Indirector::FileContent::Rest < Puppet::Indirector::REST
+    desc "Retrieve file contents via a REST HTTP interface."
+end

data/lib/puppet/indirector/file_metadata.rb

@@ -0,0 +1,5 @@
+require 'puppet/file_serving/metadata'
+
+# A stub class, so our constants work.
+class Puppet::Indirector::FileMetadata # :nodoc:
+end

data/lib/puppet/indirector/file_metadata/file.rb

@@ -0,0 +1,26 @@
+#
+#  Created by Luke Kanies on 2007-10-16.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/direct_file_server'
+
+class Puppet::Indirector::FileMetadata::File < Puppet::Indirector::DirectFileServer
+    desc "Retrieve file metadata directly from the local filesystem."
+
+    def find(key, options = {})
+        return unless data = super
+        data.collect_attributes
+
+        return data
+    end
+
+    def search(key, options = {})
+        return unless result = super
+
+        result.each { |instance| instance.collect_attributes }
+
+        return result
+    end
+end

data/lib/puppet/indirector/file_metadata/file_server.rb

@@ -0,0 +1,11 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/file_server'
+
+class Puppet::Indirector::FileMetadata::FileServer < Puppet::Indirector::FileServer
+    desc "Retrieve file metadata using Puppet's fileserver."
+end

data/lib/puppet/indirector/file_metadata/modules.rb

@@ -0,0 +1,17 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/module_files'
+
+class Puppet::Indirector::FileMetadata::Modules < Puppet::Indirector::ModuleFiles
+    desc "Retrieve file metadata from modules."
+
+    def find(*args)
+        return unless instance = super
+        instance.collect_attributes
+        instance
+    end
+end

data/lib/puppet/indirector/file_metadata/rest.rb

@@ -0,0 +1,12 @@
+#
+#  Created by Luke Kanies on 2007-10-18.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/file_serving/metadata'
+require 'puppet/util/uri_helper'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/rest'
+
+class Puppet::Indirector::FileMetadata::Rest < Puppet::Indirector::REST
+    desc "Retrieve file metadata via a REST HTTP interface."
+end

data/lib/puppet/indirector/file_server.rb

@@ -0,0 +1,56 @@
+#
+#  Created by Luke Kanies on 2007-10-19.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'puppet/util/uri_helper'
+require 'puppet/file_serving/configuration'
+require 'puppet/file_serving/fileset'
+require 'puppet/file_serving/terminus_helper'
+require 'puppet/indirector/terminus'
+
+# Look files up using the file server.
+class Puppet::Indirector::FileServer < Puppet::Indirector::Terminus
+    include Puppet::Util::URIHelper
+    include Puppet::FileServing::TerminusHelper
+
+    # Is the client authorized to perform this action?
+    def authorized?(method, key, options = {})
+        return false unless [:find, :search].include?(method)
+
+        uri = key2uri(key)
+
+        configuration.authorized?(uri.path, :node => options[:node], :ipaddress => options[:ipaddress])
+    end
+
+    # Find our key using the fileserver.
+    def find(key, options = {})
+        return nil unless path = find_path(key, options)
+        result =  model.new(key, :path => path)
+        result.links = options[:links] if options[:links]
+        return result
+    end
+
+    # Search for files.  This returns an array rather than a single
+    # file.
+    def search(key, options = {})
+        return nil unless path = find_path(key, options)
+
+        path2instances(key, path, options)
+    end
+
+    private
+
+    # Our fileserver configuration, if needed.
+    def configuration
+        Puppet::FileServing::Configuration.create
+    end
+
+    # Find our path; used by :find and :search.
+    def find_path(key, options)
+        uri = key2uri(key)
+
+        return nil unless path = configuration.file_path(uri.path, :node => options[:node])
+
+        return path
+    end
+end

data/lib/puppet/indirector/indirection.rb

@@ -0,0 +1,237 @@
+require 'puppet/util/docs'
+
+# The class that connects functional classes with their different collection
+# back-ends.  Each indirection has a set of associated terminus classes,
+# each of which is a subclass of Puppet::Indirector::Terminus.
+class Puppet::Indirector::Indirection
+    include Puppet::Util::Docs
+
+    @@indirections = []
+
+    # Clear all cached termini from all indirections.
+    def self.clear_cache
+        @@indirections.each { |ind| ind.clear_cache }
+    end
+
+    # Find an indirection by name.  This is provided so that Terminus classes
+    # can specifically hook up with the indirections they are associated with.
+    def self.instance(name)
+        @@indirections.find { |i| i.name == name }
+    end
+
+    # Return a list of all known indirections.  Used to generate the
+    # reference.
+    def self.instances
+        @@indirections.collect { |i| i.name }
+    end
+    
+    # Find an indirected model by name.  This is provided so that Terminus classes
+    # can specifically hook up with the indirections they are associated with.
+    def self.model(name)
+        match = @@indirections.find { |i| i.name == name }
+        return nil unless match
+        match.model
+    end
+    
+    attr_accessor :name, :model
+
+    # Create and return our cache terminus.
+    def cache
+        raise(Puppet::DevError, "Tried to cache when no cache class was set") unless cache_class
+        terminus(cache_class)
+    end
+
+    # Should we use a cache?
+    def cache?
+        cache_class ? true : false
+    end
+
+    attr_reader :cache_class
+    # Define a terminus class to be used for caching.
+    def cache_class=(class_name)
+        validate_terminus_class(class_name)
+        @cache_class = class_name
+    end
+
+    # Clear our cached list of termini, and reset the cache name
+    # so it's looked up again.
+    # This is only used for testing.
+    def clear_cache
+        @termini.clear
+    end
+
+    # This is only used for testing.
+    def delete
+        @@indirections.delete(self) if @@indirections.include?(self)
+    end
+
+    # Generate the full doc string.
+    def doc
+        text = ""
+
+        if defined? @doc and @doc
+            text += scrub(@doc) + "\n\n"
+        end
+
+        if s = terminus_setting()
+            text += "* **Terminus Setting**: %s" % terminus_setting
+        end
+
+        text
+    end
+
+    def initialize(model, name, options = {})
+        @model = model
+        @name = name
+
+        @termini = {}
+        @cache_class = nil
+        @terminus_class = nil
+
+        raise(ArgumentError, "Indirection %s is already defined" % @name) if @@indirections.find { |i| i.name == @name }
+        @@indirections << self
+
+        if mod = options[:extend]
+            extend(mod)
+            options.delete(:extend)
+        end
+
+        # This is currently only used for cache_class and terminus_class.
+        options.each do |name, value|
+            begin
+                send(name.to_s + "=", value)
+            rescue NoMethodError
+                raise ArgumentError, "%s is not a valid Indirection parameter" % name
+            end
+        end
+    end
+
+    # Return the singleton terminus for this indirection.
+    def terminus(terminus_name = nil)
+        # Get the name of the terminus.
+        unless terminus_name ||= terminus_class
+            raise Puppet::DevError, "No terminus specified for %s; cannot redirect" % self.name
+        end
+        
+        return @termini[terminus_name] ||= make_terminus(terminus_name)
+    end
+
+    # This can be used to select the terminus class.
+    attr_accessor :terminus_setting
+
+    # Determine the terminus class.
+    def terminus_class
+        unless @terminus_class
+            if setting = self.terminus_setting
+                self.terminus_class = Puppet.settings[setting].to_sym
+            else
+                raise Puppet::DevError, "No terminus class nor terminus setting was provided for indirection %s" % self.name
+            end
+        end
+        @terminus_class
+    end
+
+    # Specify the terminus class to use.
+    def terminus_class=(klass)
+        validate_terminus_class(klass)
+        @terminus_class = klass
+    end
+
+    # This is used by terminus_class= and cache=.
+    def validate_terminus_class(terminus_class)
+        unless terminus_class and terminus_class.to_s != ""
+            raise ArgumentError, "Invalid terminus name %s" % terminus_class.inspect
+        end
+        unless Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+            raise ArgumentError, "Could not find terminus %s for indirection %s" % [terminus_class, self.name]
+        end
+    end
+
+    def find(key, *args)
+        # Select the appropriate terminus if there's a hook
+        # for doing so.  This allows the caller to pass in some kind
+        # of URI that the indirection can use for routing to the appropriate
+        # terminus.
+        if respond_to?(:select_terminus)
+            terminus_name = select_terminus(key, *args)
+        else
+            terminus_name = terminus_class
+        end
+
+        check_authorization(:find, terminus_name, ([key] + args))
+
+        # See if our instance is in the cache and up to date.
+        if cache? and cache.has_most_recent?(key, terminus(terminus_name).version(key))
+            Puppet.info "Using cached %s %s" % [self.name, key]
+            return cache.find(key, *args)
+        end
+
+        # Otherwise, return the result from the terminus, caching if appropriate.
+        if result = terminus(terminus_name).find(key, *args)
+            result.version ||= Time.now.utc
+            if cache?
+                Puppet.info "Caching %s %s" % [self.name, key]
+                cache.save(result, *args)
+            end
+
+            terminus(terminus_name).post_find(result) if terminus(terminus_name).respond_to?(:post_find)
+
+            return result
+        end
+    end
+
+    def destroy(*args)
+        check_authorization(:destroy, terminus_class, args)
+
+        terminus.destroy(*args)
+    end
+
+    def search(*args)
+        check_authorization(:search, terminus_class, args)
+
+        result = terminus.search(*args)
+
+        terminus().post_search(result) if terminus().respond_to?(:post_search)
+
+        result
+    end
+
+    # these become instance methods 
+    def save(instance, *args)
+        check_authorization(:save, terminus_class, ([instance] + args))
+
+        instance.version ||= Time.now.utc
+        dest = cache? ? cache : terminus
+        return if dest.has_most_recent?(instance.name, instance.version)
+        Puppet.info "Caching %s %s" % [self.name, instance.name] if cache?
+        cache.save(instance, *args) if cache?
+        terminus.save(instance, *args)
+    end
+
+    def version(*args)
+        terminus.version(*args)
+    end
+
+    private
+
+    # Check authorization if there's a hook available; fail if there is one
+    # and it returns false.
+    def check_authorization(method, terminus_name, arguments)
+        # Don't check authorization if there's no node.
+        # LAK:FIXME This is a hack and is quite possibly not the design we want.
+        return unless arguments[-1].is_a?(Hash) and arguments[-1][:node]
+
+        if terminus(terminus_name).respond_to?(:authorized?) and ! terminus(terminus_name).authorized?(method, *arguments)
+            raise ArgumentError, "Not authorized to call %s with %s" % [method, arguments[0]]
+        end
+    end
+
+    # Create a new terminus instance.
+    def make_terminus(terminus_class)
+        # Load our terminus class.
+        unless klass = Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+            raise ArgumentError, "Could not find terminus %s for indirection %s" % [terminus_class, self.name]
+        end
+        return klass.new
+    end
+end