puppet 0.9.2 → 0.13.0

data/lib/puppet/type/pfile/mode.rb

@@ -2,130 +2,127 @@
 # for specification (e.g., u+rwx, or -0011), but for now only supports
 # specifying the full mode.
 module Puppet
-    class State
-        class PFileMode < Puppet::State
-            require 'etc'
-            @doc = "Mode the file should be.  Currently relatively limited:
-                you must specify the exact mode the file should be."
-            @name = :mode
-            @event = :inode_changed
+    Puppet.type(:file).newstate(:mode) do
+        require 'etc'
+        desc "Mode the file should be.  Currently relatively limited:
+            you must specify the exact mode the file should be."
+        @event = :file_changed
 
-            # Our modes are octal, so make sure they print correctly.  Other
-            # valid values are symbols, basically
-            def is_to_s
-                case @is
-                when Integer
-                    return "%o" % @is
-                when Symbol
-                    return @is
-                else
-                    raise Puppet::DevError, "Invalid 'is' value for mode: %s" %
-                        @is.inspect
-                end
+        # Our modes are octal, so make sure they print correctly.  Other
+        # valid values are symbols, basically
+        def is_to_s
+            case @is
+            when Integer
+                return "%o" % @is
+            when Symbol
+                return @is
+            else
+                raise Puppet::DevError, "Invalid 'is' value for mode: %s" %
+                    @is.inspect
             end
+        end
 
-            def should_to_s
-                case self.should
-                when Integer
-                    return "%o" % self.should
-                when Symbol
-                    return self.should
-                else
-                    raise Puppet::DevError, "Invalid 'should' value for mode: %s" %
-                        self.should.inspect
-                end
+        def should_to_s
+            case self.should
+            when Integer
+                return "%o" % self.should
+            when Symbol
+                return self.should
+            else
+                raise Puppet::DevError, "Invalid 'should' value for mode: %s" %
+                    self.should.inspect
             end
+        end
 
-            def shouldprocess(should)
-                # this is pretty hackish, but i need to make sure the number is in
-                # octal, yet the number can only be specified as a string right now
-                value = should
-                if value.is_a?(String)
-                    unless value =~ /^[0-9]+$/
-                        raise Puppet::Error, "File modes can only be numbers"
-                    end
-                    unless value =~ /^0/
-                        value = "0" + value
-                    end
-                    begin
-                        value = Integer(value)
-                    rescue ArgumentError => detail
-                        raise Puppet::DevError, "Could not convert %s to integer" %
-                            value.inspect
-                    end
+        munge do |should|
+            # this is pretty hackish, but i need to make sure the number is in
+            # octal, yet the number can only be specified as a string right now
+            value = should
+            if value.is_a?(String)
+                unless value =~ /^[0-9]+$/
+                    raise Puppet::Error, "File modes can only be numbers"
                 end
-
-                return value
-            end
-
-            # If we're a directory, we need to be executable for all cases
-            # that are readable.  This should probably be selectable, but eh.
-            def dirmask(value)
-                if FileTest.directory?(@parent.name)
-                    if value & 0400 != 0
-                        value |= 0100
-                    end
-                    if value & 040 != 0
-                        value |= 010
-                    end
-                    if value & 04 != 0
-                        value |= 01
-                    end
+                unless value =~ /^0/
+                    value = "0" + value
+                end
+                begin
+                    value = Integer(value)
+                rescue ArgumentError => detail
+                    raise Puppet::DevError, "Could not convert %s to integer" %
+                        value.inspect
                 end
-
-                return value
             end
 
-            def retrieve
-                if stat = @parent.stat(true)
-                    self.is = stat.mode & 007777
-                    unless defined? @fixed
-                        if defined? @should and @should
-                            @should = @should.collect { |s| self.dirmask(s) }
-                        end
-                    end
-                else
-                    self.is = :notfound
-                end
+            return value
+        end
 
-                #self.debug "chmod state is %o" % self.is
+        # If we're a directory, we need to be executable for all cases
+        # that are readable.  This should probably be selectable, but eh.
+        def dirmask(value)
+            if FileTest.directory?(@parent.name)
+                if value & 0400 != 0
+                    value |= 0100
+                end
+                if value & 040 != 0
+                    value |= 010
+                end
+                if value & 04 != 0
+                    value |= 01
+                end
             end
 
-            def sync
-                if @is == :notfound
-                    @parent.stat(true)
-                    self.retrieve
-                    #self.debug "%s: after refresh, is '%s'" % [self.class.name,@is]
-                    if @is == :notfound
-                        self.info "File does not exist; cannot set mode" %
-                            @parent.name
-                        return nil
-                    end
+            return value
+        end
 
-                    if self.insync?
-                        # we're already in sync
-                        return nil
+        def retrieve
+            if stat = @parent.stat(false)
+                self.is = stat.mode & 007777
+                unless defined? @fixed
+                    if defined? @should and @should
+                        @should = @should.collect { |s| self.dirmask(s) }
                     end
                 end
+            else
+                self.is = :absent
+            end
 
-                mode = self.should
+            #self.debug "chmod state is %o" % self.is
+        end
 
-                if mode == :notfound
-                    # This is really only valid for create states...
+        def sync
+            if @is == :absent
+                @parent.stat(true)
+                self.retrieve
+                #self.debug "%s: after refresh, is '%s'" % [self.class.name,@is]
+                if @is == :absent
+                    self.info "File does not exist; cannot set mode" %
+                        @parent.name
                     return nil
                 end
 
-                begin
-                    File.chmod(mode,@parent[:path])
-                rescue => detail
-                    error = Puppet::Error.new("failed to chmod %s: %s" %
-                        [@parent.name, detail.message])
-                    raise error
+                if self.insync?
+                    # we're already in sync
+                    return nil
                 end
-                return :inode_changed
             end
+
+            mode = self.should
+
+            if mode == :absent
+                # This is really only valid for create states...
+                return nil
+            end
+
+            begin
+                File.chmod(mode,@parent[:path])
+            rescue => detail
+                error = Puppet::Error.new("failed to chmod %s: %s" %
+                    [@parent.name, detail.message])
+                raise error
+            end
+            return :file_changed
         end
     end
 end
 
-# $Id: mode.rb 740 2005-11-01 20:22:19Z luke $
+# $Id: mode.rb 862 2006-01-31 02:07:56Z luke $

data/lib/puppet/type/pfile/source.rb

@@ -1,264 +1,283 @@
 module Puppet
-    class State
-        # Copy files from a local or remote source.
-        class PFileSource < Puppet::State
-            attr_accessor :source, :local
-            @doc = "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*."
-            @name = :source
-
-            # Ask the file server to describe our file.
-            def describe(source)
-                sourceobj, path = @parent.uri2obj(source)
-                server = sourceobj.server
+    # Copy files from a local or remote source.
+    Puppet.type(:file).newstate(:source) do
+        PINPARAMS = [:mode, :type, :owner, :group, :checksum]
+
+        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/module/sendmail.cf\"
+                    }
+                }
+            
+            See the `fileserver docs`_ for information on how to configure
+            and use file services within Puppet.
 
-                begin
-                    desc = server.describe(path)
-                rescue NetworkClientError => detail
-                    self.err "Could not describe %s: %s" %
-                        [path, detail]
-                    return nil
-                end
 
-                args = {}
-                Puppet::Type::PFile::PINPARAMS.zip(
-                    desc.split("\t")
-                ).each { |param, value|
-                    if value =~ /^[0-9]+$/
-                        value = value.to_i
-                    end
-                    unless value.nil?
-                        args[param] = value
-                    end
-                }
+            .. _fileserver docs: /projects/puppet/documentation/fsconfigref
 
-                # we can't manage ownership as root, so don't even try
-                unless Process.uid == 0
-                    args.delete(:owner)
-                end
+            "
 
-                if args.empty?
-                    return nil
-                else
-                    return args
+        # Ask the file server to describe our file.
+        def describe(source)
+            sourceobj, path = @parent.uri2obj(source)
+            server = sourceobj.server
+
+            begin
+                desc = server.describe(path)
+            rescue NetworkClientError => detail
+                self.err "Could not describe %s: %s" %
+                    [path, detail]
+                return nil
+            end
+
+            args = {}
+            PINPARAMS.zip(
+                desc.split("\t")
+            ).each { |param, value|
+                if value =~ /^[0-9]+$/
+                    value = value.to_i
                 end
+                unless value.nil?
+                    args[param] = value
+                end
+            }
+
+            # we can't manage ownership as root, so don't even try
+            unless Process.uid == 0
+                args.delete(:owner)
             end
 
-            # This basically calls describe() on our file, and then sets all
-            # of the local states appropriately.  If the remote file is a normal
-            # file then we set it to copy; if it's a directory, then we just mark
-            # that the local directory should be created.
-            def retrieve
-                sum = nil
+            if args.empty?
+                return nil
+            else
+                return args
+            end
+        end
 
-                unless defined? @shouldorig
-                    raise Puppet::DevError, "No sources defined for %s" %
-                        @parent.name
-                end
+        # This basically calls describe() on our file, and then sets all
+        # of the local states appropriately.  If the remote file is a normal
+        # file then we set it to copy; if it's a directory, then we just mark
+        # that the local directory should be created.
+        def retrieve
+            sum = nil
 
-                @source = nil
-                
-                # Find the first source that exists.  @shouldorig contains
-                # the sources as specified by the user.
-                @shouldorig.each { |source|
-                    if @stats = self.describe(source)
-                        @source = source
-                        break
-                    end
-                }
+            unless defined? @shouldorig
+                raise Puppet::DevError, "No sources defined for %s" %
+                    @parent.name
+            end
 
-                if @stats.nil? or @stats[:type].nil?
-                    @is = :notdescribed
-                    @source = nil
-                    return nil
+            @source = nil
+            
+            # Find the first source that exists.  @shouldorig contains
+            # the sources as specified by the user.
+            @shouldorig.each { |source|
+                if @stats = self.describe(source)
+                    @source = source
+                    break
                 end
+            }
 
-                # Take each of the stats and set them as states on the local file
-                # if a value has not already been provided.
-                @stats.each { |stat, value|
-                    next if stat == :checksum
-                    next if stat == :type
-
-                    # was the stat already specified, or should the value
-                    # be inherited from the source?
-                    unless @parent.argument?(stat)
-                        if state = @parent.state(stat)
-                            state.should = value
-                        else
-                            @parent[stat] = value
-                        end
-                    end
-                }
+            if @stats.nil? or @stats[:type].nil?
+                @is = :notdescribed
+                @source = nil
+                return nil
+            end
 
-                # If we're a normal file, then set things up to copy the file down.
-                case @stats[:type]
-                when "file":
-                    if sum = @parent.state(:checksum)
-                        if sum.is
-                            if sum.is == :notfound
-                                sum.retrieve
-                            end
-                            @is = sum.is
-                        else
-                            @is = :notfound
-                        end
+            # Take each of the stats and set them as states on the local file
+            # if a value has not already been provided.
+            @stats.each { |stat, value|
+                next if stat == :checksum
+                next if stat == :type
+
+                # was the stat already specified, or should the value
+                # be inherited from the source?
+                unless @parent.argument?(stat)
+                    if state = @parent.state(stat)
+                        state.should = value
                     else
-                        self.info "File does not have checksum"
-                        @is = :notfound
-                    end
-
-                    @should = [@stats[:checksum]]
-
-                    if state = @parent.state(:create)
-                        unless state.should == "file"
-                            self.notice(
-                                "File %s had both create and source enabled" %
-                                    @parent.name
-                            )
-                            @parent.delete(:create)
-                        end
+                        @parent[stat] = value
                     end
-                # If we're a directory, then do not copy anything, and instead just
-                # create the directory using the 'create' state.
-                when "directory":
-                    if state = @parent.state(:create)
-                        unless state.should == "directory"
-                            state.should = "directory"
+                end
+            }
+
+            # If we're a normal file, then set things up to copy the file down.
+            case @stats[:type]
+            when "file":
+                if sum = @parent.state(:checksum)
+                    if sum.is
+                        if sum.is == :absent
+                            sum.retrieve
                         end
+                        @is = sum.is
                     else
-                        @parent[:create] = "directory"
-                        @parent.state(:create).retrieve
+                        @is = :absent
                     end
-                    # we'll let the :create state do our work
-                    @should.clear
-                    @is = true
-                # FIXME We should at least support symlinks, I would think...
                 else
-                    self.err "Cannot use files of type %s as sources" %
-                        @stats[:type]
-                    @should = nil
-                    @is = true
+                    self.info "File does not have checksum"
+                    @is = :absent
                 end
-            end
 
-            # The special thing here is that we need to make sure that 'should'
-            # is only set for files, not directories.  The processing we're doing
-            # here doesn't really matter, because the @should values will be
-            # overridden when we 'retrieve'.
-            def shouldprocess(source)
-                unless @parent.uri2obj(source)
-                    raise Puppet::Error, "Invalid source %s" % source
+                @should = [@stats[:checksum]]
+            # If we're a directory, then do not copy anything, and instead just
+            # create the directory using the 'create' state.
+            when "directory":
+                if state = @parent.state(:ensure)
+                    unless state.should == "directory"
+                        state.should = "directory"
+                    end
+                else
+                    @parent[:ensure] = "directory"
+                    @parent.state(:ensure).retrieve
                 end
+                # we'll let the :ensure state do our work
+                @should.clear
+                @is = true
+            # FIXME We should at least support symlinks, I would think...
+            else
+                self.err "Cannot use files of type %s as sources" %
+                    @stats[:type]
+                @should = nil
+                @is = true
+            end
+        end
 
-                if ! defined? @stats or @stats.nil?
-                    # stupid hack for now; it'll get overriden
-                    return source
+        # The special thing here is that we need to make sure that 'should'
+        # is only set for files, not directories.  The processing we're doing
+        # here doesn't really matter, because the @should values will be
+        # overridden when we 'retrieve'.
+        munge do |source|
+            unless @parent.uri2obj(source)
+                raise Puppet::Error, "Invalid source %s" % source
+            end
+
+            if ! defined? @stats or @stats.nil?
+                # stupid hack for now; it'll get overriden
+                return source
+            else
+                if @stats[:type] == "directory"
+                    @is = true
+                    return nil
                 else
-                    if @stats[:type] == "directory"
-                        @is = true
-                        return nil
-                    else
-                        return source
-                    end
+                    return source
                 end
             end
+        end
 
-            def sync
+        def sync
+            if @is == :notdescribed
+                self.retrieve # try again
                 if @is == :notdescribed
-                    self.retrieve # try again
-                    if @is == :notdescribed
-                        @parent.log "Could not retreive information on %s" %
-                            @parent.name
-                        return nil
-                    end
-                    if @is == @should
-                        return nil
-                    end
-                end
-
-                unless @stats[:type] == "file"
-                    if @stats[:type] == "directory"
-                            [@parent.name, @is.inspect, @should.inspect]
-                    end
-                    raise Puppet::DevError, "Got told to copy non-file %s" %
+                    @parent.log "Could not retreive information on %s" %
                         @parent.name
+                    return nil
                 end
+                if @is == @should
+                    return nil
+                end
+            end
 
-                unless defined? @source
-                    raise Puppet::DevError, "Somehow source is still undefined"
+            unless @stats[:type] == "file"
+                if @stats[:type] == "directory"
+                        [@parent.name, @is.inspect, @should.inspect]
                 end
+                raise Puppet::DevError, "Got told to copy non-file %s" %
+                    @parent.name
+            end
 
-                sourceobj, path = @parent.uri2obj(@source)
+            unless defined? @source
+                raise Puppet::DevError, "Somehow source is still undefined"
+            end
 
-                begin
-                    contents = sourceobj.server.retrieve(path)
-                rescue NetworkClientError => detail
-                    self.err "Could not retrieve %s: %s" %
-                        [path, detail]
-                    return nil
-                end
+            sourceobj, path = @parent.uri2obj(@source)
 
-                # FIXME It's stupid that this isn't taken care of in the
-                # protocol.
-                unless sourceobj.server.local
-                    contents = CGI.unescape(contents)
-                end
+            begin
+                contents = sourceobj.server.retrieve(path)
+            rescue NetworkClientError => detail
+                self.err "Could not retrieve %s: %s" %
+                    [path, detail]
+                return nil
+            end
 
-                if contents == ""
-                    self.notice "Could not retrieve contents for %s" %
-                        @source
-                end
+            # FIXME It's stupid that this isn't taken care of in the
+            # protocol.
+            unless sourceobj.server.local
+                contents = CGI.unescape(contents)
+            end
 
-                if FileTest.exists?(@parent.name)
-                    # this makes sure we have a copy for posterity
-                    @backed = @parent.handlebackup
-                end
+            if contents == ""
+                self.notice "Could not retrieve contents for %s" %
+                    @source
+            end
 
-                # create the file in a tmp location
-                args = [@parent.name + ".puppettmp", 
-                    File::CREAT | File::WRONLY | File::TRUNC]
+            if FileTest.exists?(@parent.name)
+                # this makes sure we have a copy for posterity
+                @backed = @parent.handlebackup
+            end
 
-                # try to create it with the correct modes to start
-                # we should also be changing our effective uid/gid, but...
-                if @parent.should(:mode) and @parent.should(:mode) != :notfound
-                    args.push @parent.should(:mode)
-                end
+            # create the file in a tmp location
+            args = [@parent.name + ".puppettmp", 
+                File::CREAT | File::WRONLY | File::TRUNC]
 
-                # FIXME we should also change our effective user and group id
+            # try to create it with the correct modes to start
+            # we should also be changing our effective uid/gid, but...
+            if @parent.should(:mode) and @parent.should(:mode) != :absent
+                args.push @parent.should(:mode)
+            end
 
-                begin
-                    File.open(*args) { |f|
-                        f.print contents
-                    }
-                rescue => detail
-                    # since they said they want a backup, let's error out
-                    # if we couldn't make one
-                    raise Puppet::Error, "Could not create %s to %s: %s" %
-                        [@source, @parent.name, detail.message]
-                end
+            # FIXME we should also change our effective user and group id
 
-                if FileTest.exists?(@parent.name)
-                    begin
-                        File.unlink(@parent.name)
-                    rescue => detail
-                        self.err "Could not remove %s for replacing: %s" %
-                            [@parent.name, detail]
-                    end
-                end
+            exists = File.exists?(@parent.name)
+            begin
+                File.open(*args) { |f|
+                    f.print contents
+                }
+            rescue => detail
+                # since they said they want a backup, let's error out
+                # if we couldn't make one
+                raise Puppet::Error, "Could not create %s to %s: %s" %
+                    [@source, @parent.name, detail.message]
+            end
 
+            if FileTest.exists?(@parent.name)
                 begin
-                    File.rename(@parent.name + ".puppettmp", @parent.name)
+                    File.unlink(@parent.name)
                 rescue => detail
-                    self.err "Could not rename tmp %s for replacing: %s" %
+                    self.err "Could not remove %s for replacing: %s" %
                         [@parent.name, detail]
                 end
+            end
+
+            begin
+                File.rename(@parent.name + ".puppettmp", @parent.name)
+            rescue => detail
+                self.err "Could not rename tmp %s for replacing: %s" %
+                    [@parent.name, detail]
+            end
+
+            if @stats.include? :checksum
+                @parent.setchecksum @stats[:checksum]
+            else
+                raise Puppet::DevError, "We're somehow missing the remote checksum"
+            end
 
+            if exists
                 return :file_changed
+            else
+                return :file_created
             end
         end
     end
 end
 
-# $Id: source.rb 745 2005-11-16 22:17:29Z luke $
+# $Id: source.rb 885 2006-02-08 17:44:44Z luke $