summaryrefslogtreecommitdiffstats
path: root/kamailio-model.lua
blob: fb31f306a034062bf7d1c4ec78d4ebbd9599525a (plain)
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
module(..., package.seeall)

-- Load libraries
require("posix")
require("modelfunctions")
require("fs")
require("format")
require("validator")

-- Set variables
local processname = "kamailio"
local packagename = "kamailio"
local baseurl = "/etc/kamailio"
local kamctlrc_file = "/etc/kamailio/kamctlrc"

local path = "PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin "
local env
local con
local DBENGINE

-- ################################################################################
-- DATABASE FUNCTIONS

local function assert (v, m)
	if not v then
		m = m or "Assertion failed!"
		error(m, 0)
	end
	return v, m
end

-- Escape special characters in sql statements
local escape = function(sql)
	sql = sql or ""
	return string.gsub(sql, "'", "''")
end

local databaseconnect = function()
	if not con then
		-- parse the kamctlrc file
		local config = format.parse_ini_file(fs.read_file(kamctlrc_file), "") or {}
		if not config.DBENGINE then
			error("Database engine not specified, please setup one in the config script "..kamctlrc_file)
		end

		-- create environment object
		if config.DBENGINE == "MYSQL" or config.DBENGINE == "mysql" or config.DBENGINE == "MySQL" then
			error("MYSQL database not supported")
		elseif config.DBENGINE == "PGSQL" or config.DBENGINE == "pgsql" or config.DBENGINE == "postgres" or config.DBENGINE == "postgresql" or config.DBENGINE == "POSTGRESQL" then
			require("luasql.postgres")
			env = assert (luasql.postgres())
			DBENGINE = "PGSQL"
		elseif config.DBENGINE == "ORACLE" or config.DBENGINE == "oracle" or config.DBENGINE == "Oracle" then
			error("ORACLE database not supported")
		elseif config.DBENGINE == "DBTEXT" or config.DBENGINE == "dbtext" or config.DBENGINE == "textdb" then
			error("DBTEXT database not supported")
		elseif config.DBENGINE == "DB_BERKELEY" or config.DBENGINE == "db_berkeley" or config.DBENGINE == "BERKELEY" or config.DBENGINE == "berkeley" then
			error("BERKELEY database not supported")
		else
			error("Unknown database engine "..config.DBENGINE)
		end

		-- connect to data source
		con = assert(env:connect(config.DBNAME or "", config.DBRWUSER or "", config.DBRWPW or "", config.DBHOST, config.DBPORT))
		return true
	end
	return false
end

local databasedisconnect = function()
	if env then
		env:close()
		env = nil
	end
	if con then
		con:close()
		con = nil
	end
end

local runsqlcommand = function(sql)
logevent(sql)
        assert(con:execute(sql))
end

local getselectresponse = function(sql)
	local retval = {}
logevent(sql)
	local cur = assert (con:execute(sql))
	local row = cur:fetch ({}, "a")
	while row do
		local tmp = {}
		for name,val in pairs(row) do
			tmp[name] = val
		end
		retval[#retval + 1] = tmp
		row = cur:fetch (row, "a")
	end
	cur:close()
	return retval
end

local listtables = function()
	local result = {}
	if DBENGINE == "PGSQL" then
		local tab = getselectresponse("SELECT tablename, schemaname FROM pg_tables WHERE tablename !~* 'pg_*' ORDER BY schemaname, tablename ASC")
		for i,t in ipairs(tab) do
				result[#result+1] = {schema=t.schemaname, table=t.tablename}
		end
	else
		-- untested
		result = con:tables()
	end
	return result
end

<<<<<<< HEAD
local listcolumns = function(table, schema)
	local result = {}
	if DBENGINE == "PGSQL" then
		local col
		if schema then
			col = getselectresponse("SELECT column_name AS field FROM information_schema.columns WHERE table_schema='"..schema.."' AND table_name='"..table.."' ORDER BY ordinal_position")
		else
			col = getselectresponse("SELECT column_name AS field FROM information_schema.columns WHERE table_name='"..table.."' ORDER BY ordinal_position")
		end
			
=======
local listcolumns = function(table)
	local result = {}
	if DBENGINE == "PGSQL" then
		local col = getselectresponse("SELECT a.attname AS field FROM pg_class c, pg_attribute a, pg_type t WHERE c.relname = '"..table.."' AND a.attnum > 0 AND a.attrelid = c.oid AND a.atttypid = t.oid ORDER BY a.attnum")
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
		for i,c in ipairs(col) do
			result[#result+1] = c.field
		end
	end
	return result
end

-- ################################################################################
-- LOCAL FUNCTIONS

local is_valid_filename = function(filename)
	local dirname = posix.dirname(filename)
	return validator.is_valid_filename(filename) and string.match(dirname, baseurl) and not string.match(dirname, "%.%.")
end

local function validate_user(user)
	local success = true
	if user.value.username.value == "" then
		user.value.username.errtxt = "Cannot be empty"
		success = false
	end
	if user.value.password.value == "" then
		user.value.password.errtxt = "Cannot be empty"
		success = false
	end
	if user.value.password.value ~= user.value.password_confirm.value then
		user.value.password_confirm.errtxt = "Must match password"
		success = false
	end
	return success, user
end

-- ################################################################################
-- PUBLIC FUNCTIONS

function startstop_service(action)
	return modelfunctions.startstop_service(processname, action)
end

function getstatus()
	return modelfunctions.getstatus(processname, packagename, "Kamailio Status")
end

function get_filedetails(filename)
	return modelfunctions.getfiledetails(filename, is_valid_filename)
end

function update_filedetails(filedetails)
	return modelfunctions.setfiledetails(filedetails, is_valid_filename)
end

function reloadplan()
	local cmd = path .. " sercmd mi_dg dp_reload"
	local f = io.popen(cmd)
	local result = f:read("*a")
	f:close()
	return cfe({value=result, label="Reloading Dial Plan Result"})
end

function list_files()
	local retval = {}
	for file in fs.find(null, baseurl) do
		local details = fs.stat(file)
		if details.type == "regular" then
			details.filename = file
			table.insert(retval, details)
		end
	end
	table.sort(retval, function(a,b) return a.filename < b.filename end)
	return cfe({ type="structure", value=retval, label="List of Kamailio files" })
end

local function parse_db_show(table)
	local cmd = path .. "kamctl db show "..(table or "")
	local f = io.popen(cmd)
	-- These settings work for Postgres and DBTEXT database
	local delimiter = "\'?%s*[,|]%s*\'?"
	local results = {}
	local errtxt
	for line in f:lines() do
		if #results == 0 and string.match(line, "^ERROR:") then
			errtxt = line
			results = nil
			break
		end
		if string.match(line, "^[+-]+$") then
			results = {}
		else
			local words = format.string_to_table(line, delimiter)
			if words and #words > 0 then
				results[#results+1] = words
			end
		end
	end
	f:close()
	return results, errtxt
end

function list_users()
	-- Database format: id | username | domain | password | email_address | ha1 | ha1b | rpid
	local results = {}
	local r, errtxt
	r, errtxt = parse_db_show("subscriber")
	for i,words in ipairs(r or {}) do
		if #words > 1 then
			local temp = {username = words[2],
				--domain = words[3],
				password = words[4],
				--email_address = words[5]
			}
			results[#results+1] = temp
		end
	end
	table.sort(results, function(a,b) return a.username < b.username end)
	return cfe({type="list", value=results, label="Kamailio Users"})
end

function get_new_user()
	local user = {}
	user.username = cfe({label="User Name"})
	user.password = cfe({label="Password"})
	user.password_confirm = cfe({label="Password (confirm)"})
	--user.email_address = cfe({label="E-mail Address"})
	return cfe({type="group", value=user, label="Kamailio User"})
end

function create_new_user(user)
	local success = validate_user(user)
	if success then
		local cmd = path .. "kamctl add "..format.escapespecialcharacters(user.value.username.value).." "..format.escapespecialcharacters(user.value.password.value)
		--if user.value.email_address.value ~= "" then
		--	cmd = cmd.." "..format.escapespecialcharacters(user.value.email_address.value)
		--end
		local f = io.popen(cmd)
		user.descr = f:read("*a")
		f:close()
	else
		user.errtxt = "Failed to create new user"
	end

	return user
end

function delete_user(username)
	local cmd = path .. "kamctl rm "..format.escapespecialcharacters(username)
	local f = io.popen(cmd)
	local result = f:read("*a")
	f:close()
	return cfe({value=result, label="Delete User Result"})
end

function get_user(username)
	local user = get_new_user()
	user.value.username.value = username
	user.value.username.errtxt = "Invalid user"
	local users = list_users()
	for i,u in ipairs(users.value) do
		if u.username == username then
			user.value.username.errtxt = nil
			break
		end
	end
	return user
end

function update_user(user)
	local success = validate_user(user)
	if success then
		local cmd = path .. "kamctl passwd "..format.escapespecialcharacters(user.value.username.value).." "..format.escapespecialcharacters(user.value.password.value)
		local f = io.popen(cmd)
		user.descr = f:read("*a")
		f:close()
	else
		user.errtxt = "Failed to update user"
	end

	return user
end

function list_tables()
	local retval = {}
        local errtxt
	-- Get the devices from the DB
	local res, err = pcall(function()
		local connected = databaseconnect()
		retval = listtables()
		if connected then databasedisconnect() end
	end)
	if not res and err then
		errtxt = err
	end
	
	return cfe({ type="list", value=retval, label="List of Database Tables", errtxt=errtxt })
end

<<<<<<< HEAD
function list_table_entries(req_table)
	local retval = {}
	-- split up the schema from the table
	local schema, table 
	schema, table = string.match(req_table, "(.+)%.(.+)")
	-- if there's no schema with it then grab the req_table value
	if not schema then
		table = req_table
	end
	retval.table = cfe({ value=req_table or "", label="Table" })
=======
function list_table_entries(table)
	local retval = {}
	retval.table = cfe({ value=table or "", label="Table" })
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
	retval.fields = cfe({ type="list", value={}, label="List of Table Fields" })
	retval.entries = cfe({ type="structure", value={}, label="List of Database Entries" })
        local errtxt
	-- Get the devices from the DB
	local res, err = pcall(function()
		local connected = databaseconnect()
		local tables = listtables()
		retval.table.errtxt = "Table does not exist"
		errtxt = "Table does not exist"
		for i,t in ipairs(tables) do
<<<<<<< HEAD
			if t.table == table then
				retval.table.errtxt = nil
				errtxt = nil
				-- if there's a schema, include it in the select statement
				if schema then
					retval.entries.value = getselectresponse("SELECT * FROM "..schema.."."..table) or {}
				else
					retval.entries.value = getselectresponse("SELECT * FROM "..table) or {}
				end
				retval.fields.value = listcolumns(table, schema) or {}
=======
			if t == table then
				retval.table.errtxt = nil
				errtxt = nil
				retval.entries.value = getselectresponse("SELECT * FROM "..table.." ORDER BY id ASC") or {}
				retval.fields.value = listcolumns(table) or {}
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
			end
		end
		if connected then databasedisconnect() end
	end)
	if not res and err then
		errtxt = err
	end
<<<<<<< HEAD
	return cfe({ type="group", value=retval, label="Database Table Entries", errtxt=errtxt })
end

function get_table_entry(req_table, id)
	local retval = {}
	-- split up the schema from the table
	local schema, table 
	schema, table = string.match(req_table, "(.+)%.(.+)")
	-- if there's no schema with it then grab the req_table value
	if not schema then
		table = req_table
	end
	retval.table = cfe({ value=req_table or "", label="Table", errtxt="Table does not exist", seq=0 })
	local errtxt = "Table does not exist"
	if req_table and req_table ~= "" then
=======
	
	return cfe({ type="group", value=retval, label="Database Table Entries", errtxt=errtxt })
end

function get_table_entry(table, id)
	local retval = {}
	retval.table = cfe({ value=table or "", label="Table", errtxt="Table does not exist", seq=0 })
	local errtxt = "Table does not exist"
	if table and table ~= "" then
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
		local res, err = pcall(function()
			local connected = databaseconnect()
			local tables = listtables()
			for i,t in ipairs(tables) do
<<<<<<< HEAD
				if t.table == table then
=======
				if t == table then
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
					retval.table.errtxt = nil
					errtxt = nil
					break
				end
			end
			if not errtxt then
<<<<<<< HEAD
				local fields = listcolumns(table, schema)
=======
				local fields = listcolumns(table)
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
				for i,f in ipairs(fields) do
					retval[f] = cfe({ label=f, seq=i })
				end
				if id and id ~= "" then
<<<<<<< HEAD
					local entry
					if schema then
						entry = getselectresponse("SELECT * FROM "..schema.."."..table.." WHERE id='"..escape(id).."'")
					else
						entry = getselectresponse("SELECT * FROM "..table.." WHERE id='"..escape(id).."'")
					end
=======
					local entry = getselectresponse("SELECT * FROM "..table.." WHERE id='"..escape(id).."'")
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
					if entry and #entry > 0 then
						for n,v in pairs(entry[1]) do
							if retval[n] then retval[n].value = v end
						end
					end
				end
			end
			if connected then databasedisconnect() end
		end)
		if not res and err then
			errtxt = err
		end
	end

	return cfe({ type="group", value=retval, label="Database Table Entry", errtxt=errtxt })
end

function create_table_entry(entry)
        return update_table_entry(entry, true)
end
	
function update_table_entry(entry, create)
	local success = true
	local errtxt
	-- Validate the settings
	-- relying on get_table_entry to do the validation of table
	if entry.value.table.value == "" or entry.value.table.errtxt then
		success = false
		entry.value.table.errtxt = "Table does not exist"
	end
	if not create then
		if not entry.value.id then
			success = false
		elseif not entry.value.id.value or entry.value.id.value == "" then
			success = false
			entry.value.id.errtxt = "Invalid id"
		end
	end
	if success then
        	local res, err = pcall(function()
			local connected = databaseconnect()
			local tables = listtables()
<<<<<<< HEAD
			local schema, tablename
			schema, tablename = string.match(entry.value.table.value, "(.+)%.(.+)")
			success = false
			if not schema then
				tablename = entry.value.table.value
			end
			entry.value.table.errtxt = "Table does not exist"
			for i,t in ipairs(tables) do
				if t.table == tablename then
=======
			success = false
			entry.value.table.errtxt = "Table does not exist"
			for i,t in ipairs(tables) do
				if t == entry.value.table.value then
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
					success = true
					entry.value.table.errtxt = nil
					break
				end
			end
			if success and not create then
				local sql = "SELECT * FROM "..entry.value.table.value.." WHERE id='"..escape(entry.value.id.value).."'"
				local tmp = getselectresponse(sql)
				if not tmp or #tmp == 0 then
					success = false
					errtxt = "Entry does not exist"
				end
			end
			if success then
				local names = {}
				local values = {}
				for n,v in pairs(entry.value) do
					if n ~= "table" and n ~= "id" then
<<<<<<< HEAD
						--- !!! HACK !!! ---
						--- Fix for DISTributary Phone System Tool: ASHP 
						--- 
						--- Need to allow for insertion of NULL rather than
						--- simply '' so that integers and booleans can be
						--- added with empty values.
						---- ----------- ---
						if n == "role_id" or n == "seq" then
							if v.value == "" then
								v.value = "0"
							end
						end
=======
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
						names[#names+1] = n
						values[#values+1] = escape(v.value)
					end
				end
				if create then
					sql = "INSERT INTO "..entry.value.table.value.." ("..table.concat(names, ", ")..") VALUES('"..table.concat(values, "', '").."')"
				else
					sql = "UPDATE "..entry.value.table.value.." SET ("..table.concat(names, ", ")..") = ('"..table.concat(values, "', '").."') WHERE id='"..escape(entry.value.id.value).."'"
				end
				runsqlcommand(sql)
			end
			if connected then databasedisconnect() end
		end)
		if not res and err then
			success = false
			errtxt = err
		end
	end
	if not success then
		if create then
			entry.errtxt = errtxt or "Failed to create entry"
		else
			entry.errtxt = errtxt or "Failed to save entry"
		end
	end
	return entry
end

<<<<<<< HEAD
function delete_table_entry(req_table, id)
	local result = ""
	local errtxt
	-- split up the schema from the table
	local schema, table 
	schema, table = string.match(req_table, "(.+)%.(.+)")
	-- if there's no schema with it then grab the req_table value
	if not schema then
		table = req_table
	end
	if not req_table or req_table == "" then
=======
function delete_table_entry(table, id)
	local result = ""
	local errtxt
	if not table or table == "" then
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
		errtxt = "Invalid table"
	elseif not id or id == "" then
		errtxt = "Invalid entry"
	else
	       	local res, err = pcall(function()
			local connected = databaseconnect()
			errtxt = "Invalid table"
			local tables = listtables()
			for i,t in ipairs(tables) do
<<<<<<< HEAD
				if t.table == table then
=======
				if t == table then
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
					errtxt = nil
					break
				end
			end
			if not errtxt then
<<<<<<< HEAD
				local sql
				if schema then
					sql = "DELETE FROM "..schema.."."..table.." WHERE id='"..escape(id).."'"
				else
					sql = "DELETE FROM "..table.." WHERE id='"..escape(id).."'"
				end
=======
				local sql = "DELETE FROM "..table.." WHERE id='"..escape(id).."'"
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
				runsqlcommand(sql)
				result = "Entry Deleted"
			end
			if connected then databasedisconnect() end
		end)
		if not res and err then
			errtxt = err
		end
	end

	return cfe({ value=result, errtxt=errtxt, label="Delete Entry Result" })
end

function create_database()
	local cmd = path.."echo -e 'y\ny\n' | "..path.."kamdbctl create 2>&1"
	local f = io.popen(cmd)
	local result = f:read("*a")
	return cfe({ value=result, label="Create database result" })
end

function search_database(id, value, comparison)
	local errtxt
	retval = {}
	retval.id = cfe({type="select", value=id or "", label="Table.Column", option={}, seq=1})
	retval.comparison = cfe({type="select", value=comparison or "=", label="Comparison", option={"=", "!=", "~", "!~", "~*", "!*~"}, seq=2})
	retval.value = cfe({label="Value", value=value or "", descr="Value or SQL regular expression", seq=3})
        local res, err = pcall(function()
		local connected = databaseconnect()
		local tables = listtables() or {}
		for i,t in ipairs(tables) do
<<<<<<< HEAD
			local columns = listcolumns(t.table) or {}
			for i,c in ipairs(columns) do
				retval.id.option[#retval.id.option + 1] = t.table.."."..c
=======
			local columns = listcolumns(t) or {}
			for i,c in ipairs(columns) do
				retval.id.option[#retval.id.option + 1] = t.."."..c
>>>>>>> e19ee215667692e70cb4788dca4151e23aa73b96
			end
		end
		-- Get the rows from the DB
		if id and modelfunctions.validateselect(retval.id) and modelfunctions.validateselect(retval.comparison) then
			retval.result = cfe({type="structure", value={}, label="List of Rows", seq=4 })
			local table, column = string.match(id, "^([^.]*)%.(.*)")
			if table then
				local sql = "SELECT * FROM "..table.." WHERE "..column..comparison.."'"..value.."'"
				retval.result.value = getselectresponse(sql)
			end
		end
		if connected then databasedisconnect() end
	end)
	if not res and err then
		errtxt = err
	end
	return cfe({type="group", value=retval, label="Database Search", errtxt=errtxt})
end