Merge pull request #305 from nmav/compression
[project/luci.git] / applications / luci-app-ddns / luasrc / tools / ddns.lua
1 -- Copyright 2014 Christian Schoenebeck <christian dot schoenebeck at gmail dot com>
2 -- Licensed to the public under the Apache License 2.0.
3
4 module("luci.tools.ddns", package.seeall)
5
6 local NX   = require "nixio"
7 local NXFS = require "nixio.fs"
8 local OPKG = require "luci.model.ipkg"
9 local UCI  = require "luci.model.uci"
10 local SYS  = require "luci.sys"
11 local UTIL = require "luci.util"
12
13 -- function to calculate seconds from given interval and unit
14 function calc_seconds(interval, unit)
15         if not tonumber(interval) then
16                 return nil
17         elseif unit == "days" then
18                 return (tonumber(interval) * 86400)     -- 60 sec * 60 min * 24 h
19         elseif unit == "hours" then
20                 return (tonumber(interval) * 3600)      -- 60 sec * 60 min
21         elseif unit == "minutes" then
22                 return (tonumber(interval) * 60)        -- 60 sec
23         elseif unit == "seconds" then
24                 return tonumber(interval)
25         else
26                 return nil
27         end
28 end
29
30 -- check if IPv6 supported by OpenWrt
31 function check_ipv6()
32         return NXFS.access("/proc/net/ipv6_route")
33            and NXFS.access("/usr/sbin/ip6tables")
34 end
35
36 -- check if Wget with SSL support or cURL installed
37 function check_ssl()
38         if (SYS.call([[ grep -iq "\+ssl" /usr/bin/wget 2>/dev/null ]]) == 0) then
39                 return true
40         else
41                 return NXFS.access("/usr/bin/curl")
42         end
43 end
44
45 -- check if Wget with SSL or cURL with proxy support installed
46 function check_proxy()
47         -- we prefere GNU Wget for communication
48         if (SYS.call([[ grep -iq "\+ssl" /usr/bin/wget 2>/dev/null ]]) == 0) then
49                 return true
50
51         -- if not installed cURL must support proxy
52         elseif NXFS.access("/usr/bin/curl") then
53                 return (SYS.call([[ grep -iq all_proxy /usr/lib/libcurl.so* 2>/dev/null ]]) == 0)
54
55         -- only BusyBox Wget is installed
56         else
57                 return NXFS.access("/usr/bin/wget")
58         end
59 end
60
61 -- check if BIND host installed
62 function check_bind_host()
63         return NXFS.access("/usr/bin/host")
64 end
65
66 -- convert epoch date to given format
67 function epoch2date(epoch, format)
68         if not format or #format < 2 then
69                 local uci = UCI.cursor()
70                 format    = uci:get("ddns", "global", "date_format") or "%F %R"
71                 uci:unload("ddns")
72         end
73         format = format:gsub("%%n", "<br />")   -- replace newline
74         format = format:gsub("%%t", "    ")     -- replace tab
75         return os.date(format, epoch)
76 end
77
78 -- read lastupdate from [section].update file
79 function get_lastupd(section)
80         local uci     = UCI.cursor()
81         local run_dir = uci:get("ddns", "global", "run_dir") or "/var/run/ddns"
82         local etime   = tonumber(NXFS.readfile("%s/%s.update" % { run_dir, section } ) or 0 )
83         uci:unload("ddns")
84         return etime
85 end
86
87 -- read PID from run file and verify if still running
88 function get_pid(section)
89         local uci     = UCI.cursor()
90         local run_dir = uci:get("ddns", "global", "run_dir") or "/var/run/ddns"
91         local pid     = tonumber(NXFS.readfile("%s/%s.pid" % { run_dir, section } ) or 0 )
92         if pid > 0 and not NX.kill(pid, 0) then
93                 pid = 0
94         end
95         uci:unload("ddns")
96         return pid
97 end
98
99 -- compare versions using "<=" "<" ">" ">=" "=" "<<" ">>"
100 function ipkg_ver_compare(ver1, comp, ver2)
101         if not ver1 or not (#ver1 > 0)
102         or not ver2 or not (#ver2 > 0)
103         or not comp or not (#comp > 0) then
104                 return nil
105         end
106         return (tonumber(SYS.call(
107                 [[opkg compare-versions "]] .. ver1 .. [[" "]] .. comp .. [[" "]] .. ver2 .. [["]]
108                 )) == 1)
109 end
110
111 -- read version information for given package if installed
112 function ipkg_ver_installed(pkg)
113         if not pkg then
114                 return nil
115         end
116         -- opkg list-installed [pkg] | cut -d " " -f 3 - return version as sting
117         local ver = SYS.exec([[opkg list-installed ]] .. pkg .. [[ | cut -d " " -f 3 ]])
118         if (#ver > 0) then
119                 return ver
120         end
121         return nil
122 end
123
124 -- replacement of build-in read of UCI option
125 -- modified AbstractValue.cfgvalue(self, section) from cbi.lua
126 -- needed to read from other option then current value definition
127 function read_value(self, section, option)
128         local value
129         if self.tag_error[section] then
130                 value = self:formvalue(section)
131         else
132                 value = self.map:get(section, option)
133         end
134
135         if not value then
136                 return nil
137         elseif not self.cast or self.cast == type(value) then
138                 return value
139         elseif self.cast == "string" then
140                 if type(value) == "table" then
141                         return value[1]
142                 end
143         elseif self.cast == "table" then
144                 return { value }
145         end
146 end
147
148 -- replacement of build-in Flag.parse of cbi.lua
149 -- modified to mark section as changed if value changes
150 -- current parse did not do this, but it is done AbstaractValue.parse()
151 function flag_parse(self, section)
152         local fexists = self.map:formvalue(
153                 luci.cbi.FEXIST_PREFIX .. self.config .. "." .. section .. "." .. self.option)
154
155         if fexists then
156                 local fvalue = self:formvalue(section) and self.enabled or self.disabled
157                 local cvalue = self:cfgvalue(section)
158                 if fvalue ~= self.default or (not self.optional and not self.rmempty) then
159                         self:write(section, fvalue)
160                 else
161                         self:remove(section)
162                 end
163                 if (fvalue ~= cvalue) then self.section.changed = true end
164         else
165                 self:remove(section)
166                 self.section.changed = true
167         end
168 end
169
170 -----------------------------------------------------------------------------
171 -- copied from https://svn.nmap.org/nmap/nselib/url.lua
172 -- @author Diego Nehab
173 -- @author Eddie Bell <ejlbell@gmail.com>
174 --[[
175     URI parsing, composition and relative URL resolution
176     LuaSocket toolkit.
177     Author: Diego Nehab
178     RCS ID: $Id: url.lua,v 1.37 2005/11/22 08:33:29 diego Exp $
179     parse_query and build_query added For nmap (Eddie Bell <ejlbell@gmail.com>)
180 ]]--
181 ---
182 -- Parses a URL and returns a table with all its parts according to RFC 2396.
183 --
184 -- The following grammar describes the names given to the URL parts.
185 -- <code>
186 -- <url> ::= <scheme>://<authority>/<path>;<params>?<query>#<fragment>
187 -- <authority> ::= <userinfo>@<host>:<port>
188 -- <userinfo> ::= <user>[:<password>]
189 -- <path> :: = {<segment>/}<segment>
190 -- </code>
191 --
192 -- The leading <code>/</code> in <code>/<path></code> is considered part of
193 -- <code><path></code>.
194 -- @param url URL of request.
195 -- @param default Table with default values for each field.
196 -- @return A table with the following fields, where RFC naming conventions have
197 --   been preserved:
198 --     <code>scheme</code>, <code>authority</code>, <code>userinfo</code>,
199 --     <code>user</code>, <code>password</code>, <code>host</code>,
200 --     <code>port</code>, <code>path</code>, <code>params</code>,
201 --     <code>query</code>, and <code>fragment</code>.
202 -----------------------------------------------------------------------------
203 function parse_url(url) --, default)
204         -- initialize default parameters
205         local parsed = {}
206 --      for i,v in base.pairs(default or parsed) do
207 --              parsed[i] = v
208 --      end
209
210         -- remove whitespace
211 --      url = string.gsub(url, "%s", "")
212         -- get fragment
213         url = string.gsub(url, "#(.*)$",
214                 function(f)
215                         parsed.fragment = f
216                         return ""
217                 end)
218         -- get scheme. Lower-case according to RFC 3986 section 3.1.
219         url = string.gsub(url, "^([%w][%w%+%-%.]*)%:",
220                 function(s)
221                         parsed.scheme = string.lower(s);
222                         return ""
223                 end)
224         -- get authority
225         url = string.gsub(url, "^//([^/]*)",
226                 function(n)
227                         parsed.authority = n
228                         return ""
229                 end)
230         -- get query stringing
231         url = string.gsub(url, "%?(.*)",
232                 function(q)
233                         parsed.query = q
234                         return ""
235                 end)
236         -- get params
237         url = string.gsub(url, "%;(.*)",
238                 function(p)
239                         parsed.params = p
240                         return ""
241                 end)
242         -- path is whatever was left
243         parsed.path = url
244
245         local authority = parsed.authority
246         if not authority then
247                 return parsed
248         end
249         authority = string.gsub(authority,"^([^@]*)@",
250                 function(u)
251                         parsed.userinfo = u;
252                         return ""
253                 end)
254         authority = string.gsub(authority, ":([0-9]*)$",
255                 function(p)
256                         if p ~= "" then
257                                 parsed.port = p
258                         end;
259                         return ""
260                 end)
261         if authority ~= "" then
262                 parsed.host = authority
263         end
264
265         local userinfo = parsed.userinfo
266         if not userinfo then
267                 return parsed
268         end
269         userinfo = string.gsub(userinfo, ":([^:]*)$",
270                 function(p)
271                         parsed.password = p;
272                         return ""
273                 end)
274         parsed.user = userinfo
275         return parsed
276 end