lsyncd/lsyncd.lua

289 lines
7.9 KiB
Lua
Raw Normal View History

2010-10-16 18:21:01 +00:00
------------------------------------------------------------------------------
2010-10-19 10:20:27 +00:00
-- lsyncd.lua Live (Mirror) Syncing Demon
--
-- License: GPLv2 (see COPYING) or any later version
--
-- Authors: Axel Kittenberger <axkibe@gmail.com>
--
-- This is the "runner" part of lsyncd. It containts all its high-level logic.
-- It works closely together with the lsyncd core in lsyncd.c. This means it
-- cannot be runned directly from the standard lua interpreter.
2010-10-16 18:21:01 +00:00
------------------------------------------------------------------------------
2010-10-18 17:09:59 +00:00
----
2010-10-19 10:20:27 +00:00
-- A security measurement.
2010-10-18 17:09:59 +00:00
-- Core will exit if version ids mismatch.
2010-10-19 21:56:00 +00:00
if lsyncd_version ~= nil then
2010-10-22 08:37:15 +00:00
-- checks if the runner is being loaded twice
2010-10-20 18:33:17 +00:00
print("You cannot use the lsyncd runner as configuration file!")
2010-10-19 21:56:00 +00:00
os.exit(-1)
end
2010-10-18 17:09:59 +00:00
lsyncd_version = "2.0b1"
2010-10-21 12:37:27 +00:00
----
-- Shortcuts (which user is supposed to be able to use them as well)
2010-10-22 12:58:57 +00:00
--
2010-10-22 10:35:26 +00:00
log = lsyncd.log
exec = lsyncd.exec
2010-10-20 18:33:17 +00:00
2010-10-17 15:24:55 +00:00
----
2010-10-22 12:58:57 +00:00
-- Table of all root directories to sync,
-- filled during initialization.
--
-- [#] {
-- actions = actions,
-- source = source_dir,
-- targetident = target_identifier,
-- target = link to target directory
-- }
--
2010-10-18 17:09:59 +00:00
origins = {}
2010-10-17 15:24:55 +00:00
----
2010-10-21 12:37:27 +00:00
-- a array of all targets
--
-- structure:
-- [#] {
2010-10-22 08:37:15 +00:00
-- .ident .. the identifier of target (like string "host:dir")
-- for lsyncd this passed competly opaquely to the
-- action handlers
-- .delays = [#) { .. the delays stack
-- .atype .. enum, kind of action
-- .wd .. watch descriptor id this origins from TODO needed?
2010-10-22 12:58:57 +00:00
-- .attend .. link to atttender that raised this delay.
-- .filename .. filename or nil (=dir itself)
2010-10-22 08:37:15 +00:00
-- (.movepeer) .. for MOVEFROM/MOVETO link to other delay
-- }
2010-10-21 12:37:27 +00:00
-- }
2010-10-22 12:58:57 +00:00
--
2010-10-18 17:09:59 +00:00
targets = {}
2010-10-17 15:24:55 +00:00
-----
-- all watches
2010-10-21 12:37:27 +00:00
--
-- structure:
-- [wd] = {
2010-10-22 12:58:57 +00:00
-- .wd .. the watch descriptor (TODO needed?)
-- .syncs = [#] { list of stuff to sync to
-- .origin .. link to origin
-- .path .. relative path of dir
-- .parent .. link to parent directory in watches
-- or nil for origin
-- }
2010-10-21 12:37:27 +00:00
-- }
--
2010-10-18 17:09:59 +00:00
watches = {}
2010-10-17 15:24:55 +00:00
2010-10-22 08:34:41 +00:00
-- TODO
collapse_table = {
[ATTRIB] = { [ATTRIB] = ATTRIB, [MODIFY] = MODIFY, [CREATE] = CREATE, [DELETE] = DELETE },
[MODIFY] = { [ATTRIB] = MODIFY, [MODIFY] = MODIFY, [CREATE] = CREATE, [DELETE] = DELETE },
[CREATE] = { [ATTRIB] = CREATE, [MODIFY] = CREATE, [CREATE] = CREATE, [DELETE] = DELETE },
[DELETE] = { [ATTRIB] = DELETE, [MODIFY] = DELETE, [CREATE] = MODIFY, [DELETE] = DELETE },
}
-----
-- TODO
local function delay_action(atype, target, time, wd, odir, path)
-- TODO
end
2010-10-16 18:21:01 +00:00
----
-- Adds watches for a directory including all subdirectories.
--
2010-10-22 12:58:57 +00:00
-- @param origin link to origins[] entry
-- @param path relative path of this dir to origin
2010-10-21 12:37:27 +00:00
-- @param parent link to parent directory in watches[]
2010-10-18 09:02:51 +00:00
--
2010-10-22 12:58:57 +00:00
local function attend_dir(origin, path, parent)
local op = origin.source .. path
2010-10-17 15:24:55 +00:00
-- register watch and receive watch descriptor
local wd = lsyncd.add_watch(op);
if wd < 0 then
-- failed adding the watch
2010-10-22 12:58:57 +00:00
log(ERROR, "Failure adding watch "..op.." -> ignored ")
2010-10-17 15:24:55 +00:00
return
end
2010-10-21 12:37:27 +00:00
local thiswatch = watches[wd]
if thiswatch == nil then
2010-10-17 15:24:55 +00:00
-- new watch
2010-10-22 12:58:57 +00:00
thiswatch = {wd = wd, syncs = {} }
2010-10-21 12:37:27 +00:00
watches[wd] = thiswatch
2010-10-17 15:24:55 +00:00
end
2010-10-22 12:58:57 +00:00
local sync = { origin = origin, path = path, parent = parent }
table.insert(thiswatch.syncs, sync)
-- warmstart?
if origin.actions.startup == nil then
delay_action(CREATE, target, nil, wd, origin, path)
end
2010-10-16 18:21:01 +00:00
2010-10-17 15:24:55 +00:00
-- register all subdirectories
2010-10-21 12:37:27 +00:00
local subdirs = lsyncd.sub_dirs(op);
for i, dirname in ipairs(subdirs) do
2010-10-22 12:58:57 +00:00
attend_dir(origin, path..dirname.."/", thiswatch)
2010-10-16 18:21:01 +00:00
end
end
2010-10-16 10:26:48 +00:00
2010-10-17 15:24:55 +00:00
----
-- Called from core on init or restart after user configuration.
--
function lsyncd_initialize()
2010-10-21 12:37:27 +00:00
-- makes sure the user gave lsyncd anything to do
if #origins == 0 then
log(ERROR, "nothing to watch. Use directory(SOURCEDIR, TARGET) in your config file.");
lsyncd.terminate(-1) -- ERRNO
end
2010-10-22 12:58:57 +00:00
-- set to true if at least one origin has a startup function
local have_startup = false
2010-10-21 12:37:27 +00:00
-- runs through the origins table filled by user calling directory()
2010-10-22 12:58:57 +00:00
for i, origin in ipairs(origins) do
2010-10-18 09:02:51 +00:00
-- resolves source to be an absolute path
2010-10-22 12:58:57 +00:00
local asrc = lsyncd.real_dir(origin.source)
2010-10-21 12:37:27 +00:00
if asrc == nil then
2010-10-22 12:58:57 +00:00
print("Cannot resolve source path: ", origin.source)
2010-10-21 12:37:27 +00:00
lsyncd.terminate(-1) -- ERRNO
2010-10-18 09:02:51 +00:00
end
2010-10-22 12:58:57 +00:00
origin.source = asrc
2010-10-18 09:02:51 +00:00
-- appends the target on target lists
2010-10-22 12:58:57 +00:00
local target = { ident = origin.targetident, delays = {} }
2010-10-17 15:24:55 +00:00
table.insert(targets, target)
2010-10-22 12:58:57 +00:00
origin.target = target
if origin.actions.startup ~= nil then
have_startup = true
end
2010-10-18 09:02:51 +00:00
-- and add the dir watch inclusively all subdirs
2010-10-22 12:58:57 +00:00
attend_dir(origin, "", nil)
2010-10-17 15:24:55 +00:00
end
2010-10-22 10:35:26 +00:00
2010-10-22 12:58:57 +00:00
if have_startup then
log(NORMAL, "--- startup ---")
local pids = { }
for i, origin in ipairs(origins) do
local pid
if origin.actions.startup ~= nil then
local pid = origin.actions.startup(origin.source, origin.targetident)
table.insert(pids, pid)
end
2010-10-22 10:35:26 +00:00
end
2010-10-22 12:58:57 +00:00
lsyncd.wait_pids(pids, "startup_collector")
log(NORMAL, "--- Entering normal operation with "..#watches.." monitored directories ---")
else
log(NORMAL, "--- Warmstart into normal operation with "..#watches.." monitored directories ---")
2010-10-22 10:35:26 +00:00
end
2010-10-17 15:24:55 +00:00
end
2010-10-19 10:12:11 +00:00
----
2010-10-21 12:37:27 +00:00
-- Called by core to query soonest alarm.
2010-10-19 10:12:11 +00:00
--
-- @return two variables.
-- number -1 means ... alarm is in the past.
-- 0 means ... no alarm, core can in untimed sleep
-- 1 means ... alarm time specified.
-- times ... the alarm time (only read if number is 1)
function lsyncd_get_alarm()
return 0, 0
end
2010-10-17 15:24:55 +00:00
2010-10-20 13:01:26 +00:00
-----
2010-10-21 12:37:27 +00:00
-- A list of names of the event types the core sends.
2010-10-20 13:01:26 +00:00
--
local event_names = {
2010-10-22 08:37:15 +00:00
[ATTRIB ] = "Attrib",
[MODIFY ] = "Modify",
[CREATE ] = "Create",
[DELETE ] = "Delete",
[MOVE ] = "Move",
[MOVEFROM ] = "MoveFrom",
[MOVETO ] = "MoveTo",
2010-10-20 10:25:34 +00:00
}
-----
-- Called by core on inotify event
--
2010-10-20 13:01:26 +00:00
-- @param etype enum (ATTRIB, MODIFY, CREATE, DELETE, MOVE)
-- @param wd watch descriptor (matches lsyncd.add_watch())
-- @param filename string filename without path
-- @param filename2
2010-10-20 10:25:34 +00:00
--
2010-10-22 08:34:41 +00:00
function lsyncd_event(etype, wd, isdir, filename, filename2)
local ftype;
if isdir then
ftype = "directory"
else
ftype = "file"
end
-- TODO comment out to safe performance
2010-10-20 13:01:26 +00:00
if filename2 == nil then
2010-10-22 12:58:57 +00:00
log(DEBUG, "got event "..event_names[etype].." of "..ftype.." "..filename)
2010-10-20 13:01:26 +00:00
else
2010-10-22 12:58:57 +00:00
log(DEBUG, "got event "..event_names[etype].." of "..ftype.." "..filename.." to "..filename2)
2010-10-21 12:37:27 +00:00
end
-- looks up the watch descriptor id
local w = watches[wd]
if w == nil then
log(NORMAL, "event belongs to unknown or deleted watch descriptor.")
return
end
-- works through all possible source->target pairs
2010-10-22 12:58:57 +00:00
for i, sync in ipairs(w.syncs) do
if isdir and eypte == CREATE then
attend_dir(sync.origin, sync.path..filename.."/", w)
2010-10-22 08:34:41 +00:00
end
2010-10-21 12:37:27 +00:00
end
end
-----
-- Called by the core for every child process that
-- finished in startup phase
--
-- Parameters are pid and exitcode of child process
--
-- Can return either a new pid if one other child process
-- has been spawned as replacement (e.g. retry) or 0 if
-- finished/ok.
--
2010-10-22 10:40:59 +00:00
function startup_collector(pid, exitcode)
2010-10-21 12:37:27 +00:00
if exitcode ~= 0 then
log(ERROR, "Startup process", pid, " failed")
lsyncd.terminate(-1) -- ERRNO
2010-10-20 13:01:26 +00:00
end
2010-10-21 12:37:27 +00:00
return 0
2010-10-20 10:25:34 +00:00
end
2010-10-21 12:37:27 +00:00
2010-10-17 15:24:55 +00:00
------------------------------------------------------------------------------
-- lsyncd user interface
------------------------------------------------------------------------------
----
2010-10-22 10:35:26 +00:00
-- Adds one directory (incl. subdir) to be synchronized.
2010-10-21 12:37:27 +00:00
-- Users primary configuration device.
2010-10-18 09:02:51 +00:00
--
2010-10-22 08:34:41 +00:00
-- @param TODO
--
2010-10-22 10:40:59 +00:00
function sync(source_dir, target_identifier, actions)
2010-10-22 12:58:57 +00:00
local o = { actions = actions,
source = source_dir,
targetident = target_identifier,
}
2010-10-18 09:02:51 +00:00
table.insert(origins, o)
2010-10-22 10:35:26 +00:00
return
2010-10-17 15:24:55 +00:00
end
2010-10-19 16:40:49 +00:00
----
-- Called by core when an overflow happened.
function default_overflow()
2010-10-20 18:33:17 +00:00
log(ERROR, "--- OVERFLOW on inotify event queue ---")
2010-10-19 16:40:49 +00:00
lsyncd.terminate(-1) -- TODO reset instead.
end
overflow = default_overflow