Class: Chef::Provider::File

Inherits:
Chef::Provider show all
Includes:
Mixin::Checksum
Defined in:
lib/chef/provider/file.rb

Direct Known Subclasses

CookbookFile, Directory, RemoteFile, Template

Instance Attribute Summary

Attributes inherited from Chef::Provider

#current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::Checksum

#checksum

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #cookbook_name, #initialize, #node, #resource_collection

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Constructor Details

This class inherits a constructor from Chef::Provider

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Mixin::RecipeDefinitionDSLCore

Instance Method Details

#action_createObject


139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/chef/provider/file.rb', line 139

def action_create
  assert_enclosing_directory_exists!
  unless ::File.exists?(@new_resource.path)
    ::File.open(@new_resource.path, "w+") {|f| f.write @new_resource.content }
    @new_resource.updated_by_last_action(true)
    Chef::Log.info("#{@new_resource} created file #{@new_resource.path}")
  else
    set_content unless @new_resource.content.nil?
  end
  set_owner unless @new_resource.owner.nil?
  set_group unless @new_resource.group.nil?
  set_mode unless @new_resource.mode.nil?
end

#action_create_if_missingObject


153
154
155
156
157
158
159
# File 'lib/chef/provider/file.rb', line 153

def action_create_if_missing
  if ::File.exists?(@new_resource.path)
    Chef::Log.debug("File #{@new_resource.path} exists, taking no action.")
  else
    action_create
  end
end

#action_deleteObject


161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/chef/provider/file.rb', line 161

def action_delete
  if ::File.exists?(@new_resource.path)
    if ::File.writable?(@new_resource.path)
      backup unless ::File.symlink?(@new_resource.path)
      ::File.delete(@new_resource.path)
      Chef::Log.info("#{@new_resource} deleted file at #{@new_resource.path}")
      @new_resource.updated_by_last_action(true)
    else
      raise "Cannot delete #{@new_resource} at #{@new_resource_path}!"
    end
  end
end

#action_touchObject


174
175
176
177
178
179
180
# File 'lib/chef/provider/file.rb', line 174

def action_touch
  action_create
  time = Time.now
  ::File.utime(time, time, @new_resource.path)
  Chef::Log.info("#{@new_resource} updated atime and mtime to #{time}")
  @new_resource.updated_by_last_action(true)
end

#backup(file = nil) ⇒ Object


182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/chef/provider/file.rb', line 182

def backup(file=nil)
  file ||= @new_resource.path
  if @new_resource.backup != false && @new_resource.backup > 0 && ::File.exist?(file)
    time = Time.now
    savetime = time.strftime("%Y%m%d%H%M%S")
    backup_filename = "#{@new_resource.path}.chef-#{savetime}"
    backup_filename = backup_filename.sub(/^([A-Za-z]:)/, "") #strip drive letter on Windows
    # if :file_backup_path is nil, we fallback to the old behavior of
    # keeping the backup in the same directory. We also need to to_s it
    # so we don't get a type error around implicit to_str conversions.
    prefix = Chef::Config[:file_backup_path].to_s
    backup_path = ::File.join(prefix, backup_filename)
    FileUtils.mkdir_p(::File.dirname(backup_path)) if Chef::Config[:file_backup_path]
    FileUtils.cp(file, backup_path, :preserve => true)
    Chef::Log.info("#{@new_resource} backed up to #{backup_path}")

    # Clean up after the number of backups
    slice_number = @new_resource.backup
    backup_files = Dir[::File.join(prefix, ".#{@new_resource.path}.chef-*")].sort { |a,b| b <=> a }
    if backup_files.length >= @new_resource.backup
      remainder = backup_files.slice(slice_number..-1)
      remainder.each do |backup_to_delete|
        FileUtils.rm(backup_to_delete)
        Chef::Log.info("#{@new_resource} removed backup at #{backup_to_delete}")
      end
    end
  end
end

#compare_contentObject

Compare the content of a file. Returns true if they are the same, false if they are not.


59
60
61
# File 'lib/chef/provider/file.rb', line 59

def compare_content
  checksum(@current_resource.path) == new_resource_content_checksum
end

#compare_groupObject

Compares the group of a file. Returns true if they are the same, false if they are not.


99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/chef/provider/file.rb', line 99

def compare_group
  return false if @new_resource.group.nil?

  @set_group_id = case @new_resource.group
  when /^\d+$/, Integer
    @new_resource.group.to_i
  else
    Etc.getgrnam(@new_resource.group).gid
  end

  @set_group_id == @current_resource.group
end

#compare_modeObject


121
122
123
124
125
126
127
128
# File 'lib/chef/provider/file.rb', line 121

def compare_mode
  case @new_resource.mode
  when /^\d+$/, Integer
    octal_mode(@new_resource.mode) == octal_mode(@current_resource.mode)
  else
    false
  end
end

#compare_ownerObject

Compare the ownership of a file. Returns true if they are the same, false if they are not.


74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/chef/provider/file.rb', line 74

def compare_owner
  return false if @new_resource.owner.nil?

  @set_user_id = case @new_resource.owner
  when /^\d+$/, Integer
    @new_resource.owner.to_i
  else
    # This raises an ArgumentError if you can't find the user
    Etc.getpwnam(@new_resource.owner).uid
  end

  @set_user_id == @current_resource.owner
end

#load_current_resourceObject


45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/chef/provider/file.rb', line 45

def load_current_resource
  @current_resource = Chef::Resource::File.new(@new_resource.name)
  @new_resource.path.gsub!(/\\/, "/") # for Windows
  @current_resource.path(@new_resource.path)
  if ::File.exist?(@current_resource.path) && ::File.readable?(@current_resource.path)
    cstats = ::File.stat(@current_resource.path)
    @current_resource.owner(cstats.uid)
    @current_resource.group(cstats.gid)
    @current_resource.mode(octal_mode(cstats.mode))
  end
  @current_resource
end

#set_contentObject

Set the content of the file, assuming it is not set correctly already.


64
65
66
67
68
69
70
71
# File 'lib/chef/provider/file.rb', line 64

def set_content
  unless compare_content
    backup @new_resource.path if ::File.exists?(@new_resource.path)
    ::File.open(@new_resource.path, "w") {|f| f.write @new_resource.content }
    Chef::Log.info("#{@new_resource} contents updated")
    @new_resource.updated_by_last_action(true)
  end
end

#set_groupObject


112
113
114
115
116
117
118
119
# File 'lib/chef/provider/file.rb', line 112

def set_group
  unless compare_group
    @set_group_id = negative_complement(@set_group_id)
    ::File.chown(nil, @set_group_id, @new_resource.path)
    Chef::Log.info("#{@new_resource} group changed to #{@set_group_id}")
    @new_resource.updated_by_last_action(true)
  end
end

#set_modeObject


130
131
132
133
134
135
136
137
# File 'lib/chef/provider/file.rb', line 130

def set_mode
  unless compare_mode && @new_resource.mode != nil
    # CHEF-174, bad mojo around treating integers as octal.  If a string is passed, we try to do the "right" thing
    ::File.chmod(octal_mode(@new_resource.mode), @new_resource.path)
    Chef::Log.info("#{@new_resource} mode changed to #{sprintf("%o" % octal_mode(@new_resource.mode))}")
    @new_resource.updated_by_last_action(true)
  end
end

#set_ownerObject

Set the ownership on the file, assuming it is not set correctly already.


89
90
91
92
93
94
95
96
# File 'lib/chef/provider/file.rb', line 89

def set_owner
  unless compare_owner
    @set_user_id = negative_complement(@set_user_id)
    ::File.chown(@set_user_id, nil, @new_resource.path)
    Chef::Log.info("#{@new_resource} owner changed to #{@set_user_id}")
    @new_resource.updated_by_last_action(true)
  end
end