aboutsummaryrefslogtreecommitdiffstats
path: root/lclipd.lua
blob: 0d6465683532052b4384fcbbe4bfdc4df8f7c00b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
170
171
172
173
174
175
176
177
178
179
180
181
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
#!/usr/bin/env lua5.3

-- needs xsel, clipnotify
-- luarocks-5.3 install --local luaposix
-- luarocks-5.3 install --local argparse
-- cat .clip_history | dmenu -l 10 | xsel -ib
local string = require("string")
local signal = require("posix.signal")
local argparse = require("argparse")
local sys_stat = require("posix.sys.stat")
local unistd = require("posix.unistd")
local posix_syslog = require("posix.syslog")
local sqlite3 = require("lsqlite3")

local sql_create_table = [=[
create table if not exists lclipd (
    id integer primary key autoincrement,
    content text unique,
    dateAdded integer,
);
]=]

-- TODO
local sql_trigger = [=[
create trigger t_bi_prune before insert on t
begin
    delete from t
    where ID = (
        select ID
        from t as o
        where (select count(ID) from t where GroupID == o.GroupID) > 1
        and Ack != 1
        order by ID
        limit 1
    )
    and (
        select count(ID)
        from t
    ) >= 6;
]=]

local sql_insert = [=[
insert into lclipd (,%s,unixepoch());
]=]

--- Adds LUA_PATH and LUA_CPATH to the current interpreters path.
local function default_luarocks_modules()
    local luarocks_handle = io.popen("luarocks-5.3 path --bin")
    local path_b = false
    local cpath_b = false
    for line in luarocks_handle:lines() do
        local path = string.match(line, "LUA_PATH%s*=%s*('.+')")
        local cpath = string.match(line, "LUA_CPATH%s*=%s*('.+')")
        if path ~= nil then
            package.path = package.path .. ";" .. string.sub(path, 2, -2)
        end
        if cpath ~= nil then
            package.cpath = package.cpath .. ";" .. string.sub(cpath, 2, -2)
        end
    end

    if path_b then os.exit(1) end
    if cpath_b then os.exit(1) end
end
default_luarocks_modules()

local function sleep(n) os.execute("sleep " .. tonumber(n)) end
local function trim(s) return s:gsub("^%s+", ""):gsub("%s+$", "") end

local parser = argparse()
parser:option("-s --hist_size", "history file size", 200)
parser:option("-f --hist_file", "history file location",
              "/home/devi/.clip_history")

--- Log the given string to syslog with the given priority.
-- @param log_str the string passed to the logging facility
-- @param log_priority the priority of the log string
local function log_to_syslog(log_str, log_priority)
    posix_syslog.openlog("clipd",
                         posix_syslog.LOG_NDELAY | posix_syslog.LOG_PID,
                         posix_syslog.LOG_LOCAL0)
    posix_syslog.syslog(log_priority, log_str)
    posix_syslog.closelog()
end

--- Checks to make sure the cliphistory file's permission is 0600.
-- @param clip_hist the history file's path
local function check_clip_hist_perms(clip_hist)
    local uid = unistd.getuid()
    local gid = unistd.getgid()
    for k, v in pairs(sys_stat.stat(clip_hist)) do
        if k == "st_uid" and v ~= uid then
            log_to_syslog(
                "clipboard history file owned by uid other than the clipd uid",
                posix_syslog.LOG_CRIT)
            os.exit(1)
        end
        if k == "st_gid" and v ~= gid then
            log_to_syslog(
                "clipboard history file owned by gid other than the clipd gid",
                posix_syslog.LOG_CRIT)
            os.exit(1)
        end
        if k == "st_mode" and v and (sys_stat.S_IRUSR or sys_stat.S_IWUSR) ~=
            (sys_stat.S_IRUSR or sys_stat.S_IWUSR) then
            log_to_syslog(
                "file permissions are too open. they need to be 0600.",
                posix_syslog.LOG_CRIT)
            os.exit(1)
        end
    end
end

--- Checks to make sure that the pid file for clipd does not exist.
local function check_pid_file()
    local f = sys_stat.stat("/var/run/clipd.pid")
    if f ~= nil then
        log_to_syslog("clipd is already running", posix_syslog.LOG_CRIT)
        os.exit(1)
    end
end

-- FIXME- we cant write to /var/run since we are running as non-root user
--- Writes the pidfile to we can later check to make sure this is the only
-- instance running.
local function write_pid_file()
    local f = io.open("/var/run/clipd.pid", "w")
    if f == nil then
        log_to_syslog("cant open pid file for writing", posix_syslog.LOG_CRIT)
        os.exit(1)
    end
    f.write(unistd.getpid())
end

-- TODO- implement me
local function remove_pid_file() end

--- Get the clipboard content from X or wayland.
local function get_clipboard()
    local wait_for_event_x = io.popen("clipnotify")
    local handle_x = io.popen("xsel -ob")
    local last_clip_entry_x = handle_x:read("*a")

    local wait_for_event_w = io.popen("clipnotify")
    local handle_w = io.popen("xsel -ob")
    local last_clip_entry_w = handle_w:read("*a")

    if last_clip_entry_x ~= "" then
        return last_clip_entry_x
    else
        return last_clip_entry_w
    end
end

--- Get the sqlite DB handle.
local function get_sqlite_handle()
    local tmp_db_name = "/tmp/" ..
                            io.popen(
                                "tr -dc A-Za-z0-9 </dev/urandom | head -c 13"):read(
                                "*a")
    log_to_syslog(tmp_db_name, posix_syslog.LOG_INFO)
    local clipDB = sqlite3.open(tmp_db_name,
                                sqlite3.OPEN_READWRITE + sqlite3.OPEN_CREATE)
    if clipDB == nil then
        log_to_syslog("could not open the database")
        os.exit(1)
    end

    return clipDB
end

--- The clipboard's main loop
-- @param clip_hist path to the clip history file
-- @param clip_hist_size number of entries limit for the clip history file
local function loop(clip_hist, clip_hist_size)
    local clips_table = {}
    local hist_current_count = 0

    local hist_file = io.open(clip_hist, "r")
    if hist_file ~= nil then
        for line in hist_file:lines() do
            if line ~= "\n" and line ~= "" and line ~= "\r\n" and line ~= " " then
                clips_table[line] = true
                hist_current_count = hist_current_count + 1
            end
        end
    end
    hist_file:close()

    while true do
        local wait_for_event = io.popen("clipnotify")
        local handle = io.popen("xsel -ob")
        local last_clip_entry = handle:read("*a")

        if last_clip_entry[-1] == "\n" then
            clips_table[string.sub(last_clip_entry, 0,
                                   string.len(last_clip_entry))] = true
        else
            clips_table[last_clip_entry] = true;
        end
        hist_current_count = hist_current_count + 1

        if hist_current_count >= tonumber(clip_hist_size) then
            table.remove(clips_table, 1)
            hist_current_count = hist_current_count - 1
        end

        hist_file = io.open(clip_hist, "w")
        for k, _ in pairs(clips_table) do
            if clips_table[k] then hist_file:write(trim(k) .. "\n") end
        end
        hist_file:close()

        wait_for_event:close()
        handle:close()
        sleep(.2)
    end
end

--- The entry point
local function main()
    signal.signal(signal.SIGINT, function(signum) os.exit(128 + signum) end)
    local args = parser:parse()
    check_clip_hist_perms(args["hist_file"])
    check_pid_file()
    -- write_pid_file()
    local status, err = pcall(loop(args["hist_file"], args["hist_size"]))
    if ~status then log_to_syslog(err, posix_syslog.LOG_CRIT) end
    remove_pid_file()
end

main()