#!/usr/bin/env lua

-- Prosody IM

-- Copyright (C) 2008-2010 Matthew Wild

-- Copyright (C) 2008-2010 Waqas Hussain

--

-- This project is MIT/X11 licensed. Please see the

-- COPYING file in the source package for more information.

--

-- prosodyctl - command-line controller for Prosody XMPP server

-- Will be modified by configure script if run --

CFG_SOURCEDIR=CFG_SOURCEDIR or os.getenv("PROSODY_SRCDIR");

CFG_CONFIGDIR=CFG_CONFIGDIR or os.getenv("PROSODY_CFGDIR");

CFG_PLUGINDIR=CFG_PLUGINDIR or os.getenv("PROSODY_PLUGINDIR");

CFG_DATADIR=CFG_DATADIR or os.getenv("PROSODY_DATADIR");

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

local function is_relative(path)

	local path_sep = package.config:sub(1,1);

	return ((path_sep == "/" and path:sub(1,1) ~= "/")

		or (path_sep == "\\" and (path:sub(1,1) ~= "/" and path:sub(2,3) ~= ":\\")))

end

-- Tell Lua where to find our libraries

if CFG_SOURCEDIR then

	local function filter_relative_paths(path)

		if is_relative(path) then return ""; end

	end

	local function sanitise_paths(paths)

		return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));

	end

	package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);

	package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);

end

-- Substitute ~ with path to home directory in data path

if CFG_DATADIR then

	if os.getenv("HOME") then

		CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));

	end

end

-----------

-- Check before first require, to preempt the probable failure

if _VERSION < "Lua 5.2" then

	io.stderr:write("Prosody is no longer compatible with Lua 5.1\n")

	io.stderr:write("See https://prosody.im/doc/depends#lua for more information\n")

	return os.exit(1);

end

if not pcall(require, "prosody.loader") then

	pcall(require, "loader");

end

local startup = require "prosody.util.startup";

startup.prosodyctl();

-----------

local configmanager = require "prosody.core.configmanager";

local modulemanager = require "prosody.core.modulemanager"

local prosodyctl = require "prosody.util.prosodyctl"

local socket = require "socket"

local dependencies = require "prosody.util.dependencies";

local lfs = dependencies.softreq "lfs";

-----------------------

local parse_args = require "prosody.util.argparse".parse;

local human_io = require "prosody.util.human.io";

local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;

local show_usage = prosodyctl.show_usage;

local read_password = human_io.read_password;

local call_luarocks = prosodyctl.call_luarocks;

local error_messages = prosodyctl.error_messages;

local jid_split = require "prosody.util.jid".prepped_split;

local prosodyctl_timeout = (configmanager.get("*", "prosodyctl_timeout") or 5) * 2;

-----------------------

local commands = {};

local command = table.remove(arg, 1);

local only_help = { short_params = { h = "help"; ["?"] = "help" } }

function commands.install(arg)

	local opts = parse_args(arg, only_help);

	if opts.help or not arg[1] then

		show_usage([[install]], [[Installs a prosody/luarocks plugin]]);

		return opts.help and 0 or 1;

	end

	-- TODO finalize config option name

	local server = opts.server or configmanager.get("*", "plugin_server");

	if not (arg[1]:match("^https://") or lfs.attributes(arg[1]) or server) then

		show_warning("There is no 'plugin_server' option in the configuration file");

		-- see https://prosody.im/doc/TODO documentation

		-- #1602

		return 1;

	end

	show_message("Installing %s in %s", arg[1], prosody.paths.installer);

	local ret = call_luarocks("install", arg[1], server);

	if ret == 0 and arg[1]:match("^mod_") then

		prosodyctl.show_module_configuration_help(arg[1]);

	end

	return ret;

end

function commands.remove(arg)

	local opts = parse_args(arg, only_help);

	if opts.help or not arg[1] then

		show_usage([[remove]], [[Removes a module installed in the working directory's plugins folder]]);

		return opts.help and 0 or 1;

	end

	show_message("Removing %s from %s", arg[1], prosody.paths.installer);

	local ret = call_luarocks("remove", arg[1]);

	return ret;

end

function commands.list(arg)

	local opts = parse_args(arg, only_help);

	if opts.help then

		show_usage([[list]], [[Shows installed rocks]]);

		return 0;

	end

	local server = opts.server or configmanager.get("*", "plugin_server");

	if opts.outdated then

		-- put this back for luarocks

		arg[1] = "--outdated";

		if not server then

			show_warning("There is no 'plugin_server' option in the configuration file, but this is needed for 'list --outdated' to work.");

			return 1;

		end

	end

	local ret = call_luarocks("list", arg[1], server);

	return ret;

end

function commands.adduser(arg)

	local opts = parse_args(arg, only_help);

	if opts.help or not arg[1] then

		show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);

		return opts.help and 0 or 1;

	end

	local user, host = jid_split(arg[1]);

	if not user and host then

		show_message [[Failed to understand JID, please supply the JID you want to create]]

		show_usage [[adduser user@host]]

		return 1;

	end

	if not host then

		show_message [[Please specify a JID, including a host. e.g. alice@example.com]];

		return 1;

	end

	if not prosody.hosts[host] then

		show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)

		show_warning("The user will not be able to log in until this is changed.");

		prosody.hosts[host] = startup.make_host(host); --luacheck: ignore 122

	end

	if prosodyctl.user_exists{ user = user, host = host } then

		show_message [[That user already exists]];

		return 1;

	end

	local password = read_password();

	if not password then return 1; end

	local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };

	if ok then return 0; end

	show_message(error_messages[msg])

	return 1;

end

function commands.passwd(arg)

	local opts = parse_args(arg, only_help);

	if opts.help or not arg[1] then

		show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);

		return opts.help and 0 or 1;

	end

	local user, host = jid_split(arg[1]);

	if not user and host then

		show_message [[Failed to understand JID, please supply the JID you want to set the password for]]

		show_usage [[passwd user@host]]

		return 1;

	end

	if not host then

		show_message [[Please specify a JID, including a host. e.g. alice@example.com]];

		return 1;

	end

	if not prosody.hosts[host] then

		show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)

		show_warning("The user will not be able to log in until this is changed.");

		prosody.hosts[host] = startup.make_host(host); --luacheck: ignore 122

	end

	if not prosodyctl.user_exists { user = user, host = host } then

		show_message [[That user does not exist, use prosodyctl adduser to create a new user]]

		return 1;

	end

	local password = read_password();

	if not password then return 1; end

	local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };

	if ok then return 0; end

	show_message(error_messages[msg])

	return 1;

end

function commands.deluser(arg)

	local opts = parse_args(arg, only_help);

	if opts.help or not arg[1] then

		show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);

		return opts.help and 0 or 1;

	end

	local user, host = jid_split(arg[1]);

	if not user and host then

		show_message [[Failed to understand JID, please supply the JID to the user account you want to delete]]

		show_usage [[deluser user@host]]

		return 1;

	end

	if not host then

		show_message [[Please specify a JID, including a host. e.g. alice@example.com]];

		return 1;

	end

	if not prosody.hosts[host] then

		show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)

		prosody.hosts[host] = startup.make_host(host); --luacheck: ignore 122

	end

	if not prosodyctl.user_exists { user = user, host = host } then

		show_message [[That user does not exist on this server]]

		return 1;

	end

	local ok, msg = prosodyctl.deluser { user = user, host = host };

	if ok then return 0; end

	show_message(error_messages[msg])

	return 1;

end

local function has_init_system() --> which

	lfs = lfs or require"lfs";

	if lfs.attributes("/etc/systemd") then

		return "systemd";

	elseif lfs.attributes("/etc/init.d/prosody") then

		return "rc.d";

	end

end

local function service_command_warning(service_command)

	if prosody.installed and configmanager.get("*", "prosodyctl_service_warnings") ~= false then

		show_warning("WARNING: Use of prosodyctl start/stop/restart/reload is not recommended");

		show_warning("         if Prosody is managed by an init system - use that directly instead.");

		local init = has_init_system()

		if init == "systemd" then

			show_warning("         e.g. systemctl %s prosody", service_command);

		elseif init == "rc.d" then

			show_warning("         e.g. /etc/init.d/prosody %s", service_command);

		end

		show_warning("");

	end

end

function commands.start(arg)

	local opts = parse_args(arg, only_help);

	if opts.help then

		show_usage([[start]], [[Start Prosody]]);

		return 0;

	end

	service_command_warning("start");

	local ok, ret = prosodyctl.isrunning();

	if not ok then

		show_message(error_messages[ret]);

		return 1;

	end

	if ret then

		--luacheck: ignore 421/ret

		local ok, ret = prosodyctl.getpid();

		if not ok then

			show_message("Couldn't get running Prosody's PID");

			show_message(error_messages[ret]);

			return 1;

		end

		show_message("Prosody is already running with PID %s", ret or "(unknown)");

		return 1;

	end

	--luacheck: ignore 411/ret

	local lua;

	do

		local i = 0;

		repeat

			i = i - 1;

		until arg[i-1] == nil

		lua = arg[i];

	end

	local ok, ret = prosodyctl.start(prosody.paths.source, lua);

	if ok then

		local daemonize = configmanager.get("*", "daemonize");

		if daemonize == nil then

			daemonize = prosody.installed;

		end

		if daemonize then

			local i=1;

			while true do

				local ok, running = prosodyctl.isrunning();

				if ok and running then

					break;

				elseif i == 5 then

					show_message("Still waiting...");

				elseif i >= prosodyctl_timeout then

					show_message("Prosody is still not running. Please give it some time or check your log files for errors.");

					return 2;

				end

				socket.sleep(0.5);

				i = i + 1;

			end

			show_message("Started");

		end

		return 0;

	end

	show_message("Failed to start Prosody");

	show_message(error_messages[ret])

	return 1;

end

function commands.status(arg)

	local opts = parse_args(arg, only_help);

	if opts.help then

		show_usage([[status]], [[Reports the running status of Prosody]]);

		return 0;

	end

	local ok, ret = prosodyctl.isrunning();

	if not ok then

		show_message(error_messages[ret]);

		return 1;

	end

	if ret then

		--luacheck: ignore 421/ret

		local ok, ret = prosodyctl.getpid();

		if not ok then

			show_message("Couldn't get running Prosody's PID");

			show_message(error_messages[ret]);

			return 1;

		end

		show_message("Prosody is running with PID %s", ret or "(unknown)");

		return 0;

	else

		show_message("Prosody is not running");

		if not prosody.switched_user and prosody.current_uid ~= 0 then

			print("\nNote:")

			print(" You will also see this if prosodyctl is not running under");

			print(" the same user account as Prosody. Try running as root (e.g. ");

			print(" with 'sudo' in front) to gain access to Prosody's real status.");

		end

		return 2

	end

end

function commands.stop(arg)

	local opts = parse_args(arg, only_help);

	if opts.help then

		show_usage([[stop]], [[Stop a running Prosody server]]);

		return 0;

	end

	service_command_warning("stop");

	if not prosodyctl.isrunning() then

		show_message("Prosody is not running");

		return 1;

	end

	local ok, ret = prosodyctl.stop();

	if ok then

		local i=1;

		while true do

			local ok, running = prosodyctl.isrunning();

			if ok and not running then

				break;

			elseif i == 5 then

				show_message("Still waiting...");

			elseif i >= prosodyctl_timeout then

				show_message("Prosody is still running. Please give it some time or check your log files for errors.");

				return 2;

			end

			socket.sleep(0.5);

			i = i + 1;

		end

		show_message("Stopped");

		return 0;

	end

	show_message(error_messages[ret]);

	return 1;

end

function commands.restart(arg)

	local opts = parse_args(arg, only_help);

	if opts.help then