Class: Chef::Daemon

Inherits:
Object show all
Defined in:
lib/chef/daemon.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.nameObject

Returns the value of attribute name



26
27
28
# File 'lib/chef/daemon.rb', line 26

def name
  @name
end

Class Method Details

._change_privilege(user, group = user) ⇒ Object

Change privileges of the process to be the specified user and group

Parameters

user<String>

The user to change the process to.

group<String>

The group to change the process to.

Alternatives

If group is left out, the user will be used (changing to user:user)



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/chef/daemon.rb', line 144

def _change_privilege(user, group=user)
  uid, gid = Process.euid, Process.egid

  begin
    target_uid = Etc.getpwnam(user).uid
  rescue ArgumentError => e
    Chef::Application.fatal!("Failed to get UID for user #{user}, does it exist? #{e.message}")
    return false
  end
   
  begin
    target_gid = Etc.getgrnam(group).gid
  rescue ArgumentError => e
    Chef::Application.fatal!("Failed to get GID for group #{group}, does it exist? #{e.message}")
    return false
  end

  if (uid != target_uid) or (gid != target_gid)
    Process.initgroups(user, target_gid)
    Process::GID.change_privilege(target_gid)
    Process::UID.change_privilege(target_uid)
  end
  true
rescue Errno::EPERM => e
  Chef::Application.fatal!("Permission denied when trying to change #{uid}:#{gid} to #{target_uid}:#{target_gid}. #{e.message}")
end

.change_privilegeObject

Change process user/group to those specified in Chef::Config



123
124
125
126
127
128
129
130
131
132
133
# File 'lib/chef/daemon.rb', line 123

def change_privilege
  Dir.chdir("/")

  if Chef::Config[:user] and Chef::Config[:group]
    Chef::Log.info("About to change privilege to #{Chef::Config[:user]}:#{Chef::Config[:group]}")
    _change_privilege(Chef::Config[:user], Chef::Config[:group])
  elsif Chef::Config[:user]
    Chef::Log.info("About to change privilege to #{Chef::Config[:user]}")
    _change_privilege(Chef::Config[:user])
  end
end

.daemonize(name) ⇒ Object

Daemonize the current process, managing pidfiles and process uid/gid

Parameters

name<String>

The name to be used for the pid file



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/chef/daemon.rb', line 33

def daemonize(name)
  @name = name
  pid = pid_from_file
  unless running?
    remove_pid_file()
    Chef::Log.info("Daemonizing..")
    begin
      exit if fork
      Process.setsid
      exit if fork
      Chef::Log.info("Forked, in #{Process.pid}. Priveleges: #{Process.euid} #{Process.egid}")
      File.umask Chef::Config[:umask]
      $stdin.reopen("/dev/null")
      $stdout.reopen("/dev/null", "a")
      $stderr.reopen($stdout)
      save_pid_file
      at_exit { remove_pid_file }
    rescue NotImplementedError => e
      Chef::Application.fatal!("There is no fork: #{e.message}")
    end
  else
    Chef::Application.fatal!("Chef is already running pid #{pid}")
  end
end

.pid_fileObject

Gets the pid file for @name

Returns

String

Location of the pid file for @name



81
82
83
# File 'lib/chef/daemon.rb', line 81

def pid_file
   Chef::Config[:pid_file] or "/tmp/#{@name}.pid"
end

.pid_from_fileObject

Suck the pid out of pid_file

Returns

Integer

The PID from pid_file

nil

Returned if the pid_file does not exist.



92
93
94
95
96
# File 'lib/chef/daemon.rb', line 92

def pid_from_file
  File.read(pid_file).chomp.to_i
rescue Errno::ENOENT, Errno::EACCES
  nil
end

.remove_pid_fileObject

Delete the PID from the filesystem



117
118
119
# File 'lib/chef/daemon.rb', line 117

def remove_pid_file
  FileUtils.rm(pid_file) if File.exists?(pid_file)
end

.running?Boolean

Check if Chef is running based on the pid_file

Returns

Boolean

True if Chef is running False if Chef is not running

Returns:

  • (Boolean)


64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/chef/daemon.rb', line 64

def running?
  if pid_from_file.nil?
    false
  else
    Process.kill(0, pid_from_file)
    true
  end
rescue Errno::ESRCH, Errno::ENOENT
  false
rescue Errno::EACCES => e
  Chef::Application.fatal!("You don't have access to the PID file at #{pid_file}: #{e.message}")
end

.save_pid_fileObject

Store the PID on the filesystem This uses the Chef::Config option, or “/tmp/name.pid” otherwise



101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/chef/daemon.rb', line 101

def save_pid_file
  file = pid_file
  begin
    FileUtils.mkdir_p(File.dirname(file))
  rescue Errno::EACCES => e
    Chef::Application.fatal!("Failed store pid in #{File.dirname(file)}, permission denied: #{e.message}")
  end

  begin
    File.open(file, "w") { |f| f.write(Process.pid.to_s) }
  rescue Errno::EACCES => e
    Chef::Application.fatal!("Couldn't write to pidfile #{file}, permission denied: #{e.message}")
  end
end