| Dir : /proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/incron.py |
"""
Management of incron, the inotify cron
==============================================
The incron state module allows for user incrontabs to be cleanly managed.
Incron declarations require a number of parameters. The parameters needed
to be declared: ``path``, ``mask``, and ``cmd``. The ``user`` whose incrontab is to be edited
also needs to be defined.
When making changes to an existing incron job, the ``path`` declaration is the unique
factor, so if an existing cron that looks like this:
.. code-block:: yaml
Watch for modifications in /home/user:
incron.present:
- user: root
- path: /home/user
- mask:
- IN_MODIFY
- cmd: 'echo "$$ $@"'
Is changed to this:
.. code-block:: yaml
Watch for modifications and access in /home/user:
incron.present:
- user: root
- path: /home/user
- mask:
- IN_MODIFY
- IN_ACCESS
- cmd: 'echo "$$ $@"'
Then the existing cron will be updated, but if the cron command is changed,
then a new cron job will be added to the user's crontab.
.. versionadded:: 0.17.0
"""
import logging
log = logging.getLogger(__name__)
def _check_cron(user, path, mask, cmd):
"""
Return the changes
"""
arg_mask = mask.split(",")
arg_mask.sort()
lst = __salt__["incron.list_tab"](user)
if cmd.endswith("\n"):
cmd = cmd[:-1]
for cron in lst["crons"]:
if path == cron["path"] and cron["cmd"] == cmd:
cron_mask = cron["mask"].split(",")
cron_mask.sort()
if cron_mask == arg_mask:
return "present"
if any([x in cron_mask for x in arg_mask]):
return "update"
return "absent"
def _get_cron_info():
"""
Returns the proper group owner and path to the incron directory
"""
owner = "root"
if __grains__["os"] == "FreeBSD":
group = "wheel"
crontab_dir = "/var/spool/incron"
elif __grains__["os"] == "OpenBSD":
group = "crontab"
crontab_dir = "/var/spool/incron"
elif __grains__.get("os_family") == "Solaris":
group = "root"
crontab_dir = "/var/spool/incron"
else:
group = "root"
crontab_dir = "/var/spool/incron"
return owner, group, crontab_dir
def present(name, path, mask, cmd, user="root"):
"""
Verifies that the specified incron job is present for the specified user.
For more advanced information about what exactly can be set in the cron
timing parameters, check your incron system's documentation. Most Unix-like
systems' incron documentation can be found via the incrontab man page:
``man 5 incrontab``.
name
Unique comment describing the entry
path
The path that should be watched
user
The name of the user who's crontab needs to be modified, defaults to
the root user
mask
The mask of events that should be monitored for
cmd
The cmd that should be executed
"""
mask = ",".join(mask)
ret = {"changes": {}, "comment": "", "name": name, "result": True}
if __opts__["test"]:
status = _check_cron(user, path, mask, cmd)
ret["result"] = None
if status == "absent":
ret["comment"] = f"Incron {name} is set to be added"
elif status == "present":
ret["result"] = True
ret["comment"] = f"Incron {name} already present"
elif status == "update":
ret["comment"] = f"Incron {name} is set to be updated"
return ret
data = __salt__["incron.set_job"](user=user, path=path, mask=mask, cmd=cmd)
if data == "present":
ret["comment"] = f"Incron {name} already present"
return ret
if data == "new":
ret["comment"] = f"Incron {name} added to {user}'s incrontab"
ret["changes"] = {user: name}
return ret
if data == "updated":
ret["comment"] = f"Incron {name} updated"
ret["changes"] = {user: name}
return ret
ret["comment"] = "Incron {} for user {} failed to commit with error \n{}".format(
name, user, data
)
ret["result"] = False
return ret
def absent(name, path, mask, cmd, user="root"):
"""
Verifies that the specified incron job is absent for the specified user; only
the name is matched when removing a incron job.
name
Unique comment describing the entry
path
The path that should be watched
user
The name of the user who's crontab needs to be modified, defaults to
the root user
mask
The mask of events that should be monitored for
cmd
The cmd that should be executed
"""
mask = ",".join(mask)
ret = {"name": name, "result": True, "changes": {}, "comment": ""}
if __opts__["test"]:
status = _check_cron(user, path, mask, cmd)
ret["result"] = None
if status == "absent":
ret["result"] = True
ret["comment"] = f"Incron {name} is absent"
elif status == "present" or status == "update":
ret["comment"] = f"Incron {name} is set to be removed"
return ret
data = __salt__["incron.rm_job"](user=user, path=path, mask=mask, cmd=cmd)
if data == "absent":
ret["comment"] = f"Incron {name} already absent"
return ret
if data == "removed":
ret["comment"] = f"Incron {name} removed from {user}'s crontab"
ret["changes"] = {user: name}
return ret
ret["comment"] = "Incron {} for user {} failed to commit with error {}".format(
name, user, data
)
ret["result"] = False
return ret