From 6ec0353201435e0d0d7d32820d8ba600b4ca7b5b Mon Sep 17 00:00:00 2001 From: "Daniel F. Dickinson" Date: Thu, 2 Aug 2018 09:39:48 -0400 Subject: modules: Make luci-base sufficient to use luci apps Per the discussion in https://github.com/openwrt/luci/issues/869, make luci-base sufficient to login, logout, and review and apply or revert uci changes. This allows most luci-app-xxx to work without having luci-mod-admin-full installed. It has been tested with some apps and not luci-mod-admin-full, as well as with luci-mod-admin-full (to make sure the usual case doesn't break). Instead of creating a new module namespace (e.g. 'Base') we reduce the opportunities for breakage by having luci-base take over the 'shell' of the 'Administration' (admin/....) namespace. Since admin is assumed by all current building LuCI components (including Freifunk), this doesn't introduce the 'Administration' tab into any situation where it would not already be present (but includes it where it was before). We also add a "Component not installed" page to avoid fatal errors and backtrace when e.g. luci-mod-admin-full is not installed. Signed-off-by: Daniel F. Dickinson --- .../luci-base/luasrc/controller/admin/index.lua | 82 ++++++++++++++++ modules/luci-base/luasrc/controller/admin/uci.lua | 109 +++++++++++++++++++++ modules/luci-base/luasrc/dispatcher.lua | 11 ++- .../luci-base/luasrc/view/admin_uci/changelog.htm | 66 +++++++++++++ .../luci-base/luasrc/view/admin_uci/changes.htm | 45 +++++++++ modules/luci-base/luasrc/view/admin_uci/revert.htm | 33 +++++++ .../luasrc/view/empty_node_placeholder.htm | 11 +++ 7 files changed, 352 insertions(+), 5 deletions(-) create mode 100644 modules/luci-base/luasrc/controller/admin/index.lua create mode 100644 modules/luci-base/luasrc/controller/admin/uci.lua create mode 100644 modules/luci-base/luasrc/view/admin_uci/changelog.htm create mode 100644 modules/luci-base/luasrc/view/admin_uci/changes.htm create mode 100644 modules/luci-base/luasrc/view/admin_uci/revert.htm create mode 100644 modules/luci-base/luasrc/view/empty_node_placeholder.htm (limited to 'modules/luci-base/luasrc') diff --git a/modules/luci-base/luasrc/controller/admin/index.lua b/modules/luci-base/luasrc/controller/admin/index.lua new file mode 100644 index 0000000000..39e6e573b1 --- /dev/null +++ b/modules/luci-base/luasrc/controller/admin/index.lua @@ -0,0 +1,82 @@ +-- Copyright 2008 Steven Barth +-- Licensed to the public under the Apache License 2.0. + +module("luci.controller.admin.index", package.seeall) + +function index() + function toplevel_page(page, preflookup, preftarget) + if preflookup and preftarget then + if lookup(preflookup) then + page.target = preftarget + end + end + + if not page.target then + page.target = firstchild() + end + end + + local root = node() + if not root.target then + root.target = alias("admin") + root.index = true + end + + local page = node("admin") + page.title = _("Administration") + page.order = 10 + page.sysauth = "root" + page.sysauth_authenticator = "htmlauth" + page.ucidata = true + page.index = true + toplevel_page(page, "admin/status/overview", alias("admin", "status")) + + -- Empty menu tree to be populated by addons and modules + + page = node("admin", "status") + page.title = _("Status") + page.order = 10 + page.index = true + -- overview is from mod-admin-full + toplevel_page(page, "admin/status/overview", alias("admin", "status", "overview")) + + page = node("admin", "system") + page.title = _("System") + page.order = 20 + page.index = true + -- system/system is from mod-admin-full + toplevel_page(page, "admin/system/system", alias("admin", "system", "system")) + + -- Only used if applications add items + page = node("admin", "services") + page.title = _("Services") + page.order = 40 + page.index = true + toplevel_page(page, false, false) + + -- Even for mod-admin-full network just uses first submenu item as landing + page = node("admin", "network") + page.title = _("Network") + page.order = 50 + page.index = true + toplevel_page(page, false, false) + + -- Logout is last + entry({"admin", "logout"}, call("action_logout"), _("Logout"), 999) +end + +function action_logout() + local dsp = require "luci.dispatcher" + local utl = require "luci.util" + local sid = dsp.context.authsession + + if sid then + utl.ubus("session", "destroy", { ubus_rpc_session = sid }) + + luci.http.header("Set-Cookie", "sysauth=%s; expires=%s; path=%s/" %{ + sid, 'Thu, 01 Jan 1970 01:00:00 GMT', dsp.build_url() + }) + end + + luci.http.redirect(dsp.build_url()) +end diff --git a/modules/luci-base/luasrc/controller/admin/uci.lua b/modules/luci-base/luasrc/controller/admin/uci.lua new file mode 100644 index 0000000000..1d955dd982 --- /dev/null +++ b/modules/luci-base/luasrc/controller/admin/uci.lua @@ -0,0 +1,109 @@ +-- Copyright 2008 Steven Barth +-- Copyright 2010-2015 Jo-Philipp Wich +-- Licensed to the public under the Apache License 2.0. + +module("luci.controller.admin.uci", package.seeall) + +function index() + local redir = luci.http.formvalue("redir", true) + or table.concat(luci.dispatcher.context.request, "/") + + entry({"admin", "uci"}, nil, _("Configuration")) + entry({"admin", "uci", "changes"}, post_on({ trigger_apply = true }, "action_changes"), _("Changes"), 40).query = {redir=redir} + entry({"admin", "uci", "revert"}, post("action_revert"), _("Revert"), 30).query = {redir=redir} + + local node + local authen = function(checkpass, allowed_users) + return "root", luci.http.formvalue("sid") + end + + node = entry({"admin", "uci", "apply_rollback"}, post("action_apply_rollback"), nil) + node.cors = true + node.sysauth_authenticator = authen + + node = entry({"admin", "uci", "apply_unchecked"}, post("action_apply_unchecked"), nil) + node.cors = true + node.sysauth_authenticator = authen + + node = entry({"admin", "uci", "confirm"}, call("action_confirm"), nil) + node.cors = true + node.sysauth = false +end + + +function action_changes() + local uci = require "luci.model.uci" + local changes = uci:changes() + + luci.template.render("admin_uci/changes", { + changes = next(changes) and changes, + timeout = timeout, + trigger_apply = luci.http.formvalue("trigger_apply") and true or false + }) +end + +function action_revert() + local uci = require "luci.model.uci" + local changes = uci:changes() + + -- Collect files to be reverted + local r, tbl + for r, tbl in pairs(changes) do + uci:revert(r) + end + + luci.template.render("admin_uci/revert", { + changes = next(changes) and changes, + trigger_revert = true + }) +end + + +local function ubus_state_to_http(errstr) + local map = { + ["Invalid command"] = 400, + ["Invalid argument"] = 400, + ["Method not found"] = 404, + ["Entry not found"] = 404, + ["No data"] = 204, + ["Permission denied"] = 403, + ["Timeout"] = 504, + ["Not supported"] = 500, + ["Unknown error"] = 500, + ["Connection failed"] = 503 + } + + local code = map[errstr] or 200 + local msg = errstr or "OK" + + luci.http.status(code, msg) + + if code ~= 204 then + luci.http.prepare_content("text/plain") + luci.http.write(msg) + end +end + +function action_apply_rollback() + local uci = require "luci.model.uci" + local token, errstr = uci:apply(true) + if token then + luci.http.prepare_content("application/json") + luci.http.write_json({ token = token }) + else + ubus_state_to_http(errstr) + end +end + +function action_apply_unchecked() + local uci = require "luci.model.uci" + local _, errstr = uci:apply(false) + ubus_state_to_http(errstr) +end + +function action_confirm() + local uci = require "luci.model.uci" + local token = luci.http.formvalue("token") + local _, errstr = uci:confirm(token) + ubus_state_to_http(errstr) +end diff --git a/modules/luci-base/luasrc/dispatcher.lua b/modules/luci-base/luasrc/dispatcher.lua index 6cf2712eb4..09d5d72846 100644 --- a/modules/luci-base/luasrc/dispatcher.lua +++ b/modules/luci-base/luasrc/dispatcher.lua @@ -741,11 +741,12 @@ function _firstchild() end end - assert(lowest ~= nil, - "The requested node contains no childs, unable to redispatch") - - path[#path+1] = lowest - dispatch(path) + if lowest == nil then + require "luci.template".render("empty_node_placeholder") + else + path[#path+1] = lowest + dispatch(path) + end end function firstchild() diff --git a/modules/luci-base/luasrc/view/admin_uci/changelog.htm b/modules/luci-base/luasrc/view/admin_uci/changelog.htm new file mode 100644 index 0000000000..8a162c88b6 --- /dev/null +++ b/modules/luci-base/luasrc/view/admin_uci/changelog.htm @@ -0,0 +1,66 @@ +<%# + Copyright 2010 Jo-Philipp Wich + Licensed to the public under the Apache License 2.0. +-%> + +<% export("uci_changelog", function(changes) -%> +
+ <%:Legend:%> +
+
  <%:Section added%>
+
  <%:Section removed%>
+
  <%:Option changed%>
+
  <%:Option removed%>
+
+
+
+ +
<% + local util = luci.util + local tpl = { + ["add-3"] = "uci add %0 %3 # =%2", + ["set-3"] = "uci set %0.%2=%3", + ["set-4"] = "uci set %0.%2.%3=%4", + ["remove-2"] = "uci del %0.%2", + ["remove-3"] = "uci del %0.%2.%3", + ["order-3"] = "uci reorder %0.%2=%3", + ["list-add-4"] = "uci add_list %0.%2.%3=%4", + ["list-del-4"] = "uci del_list %0.%2.%3=%4", + ["rename-3"] = "uci rename %0.%2=%3", + ["rename-4"] = "uci rename %0.%2.%3=%4" + } + + local conf, deltas + for conf, deltas in util.kspairs(changes) do + write("

# /etc/config/%s

" % conf) + + local _, delta, added + for _, delta in pairs(deltas) do + local t = tpl["%s-%d" %{ delta[1], #delta }] + + write(t:gsub("%%(%d)", function(n) + if n == "0" then + return conf + elseif n == "2" then + if added and delta[2] == added[1] then + return "@%s[-1]" % added[2] + else + return delta[2] + end + elseif n == "4" then + return util.shellquote(delta[4]) + else + return delta[tonumber(n)] + end + end)) + + if delta[1] == "add" then + added = { delta[2], delta[3] } + end + end + + write("
") + end + %>
+
+<%- end) %> diff --git a/modules/luci-base/luasrc/view/admin_uci/changes.htm b/modules/luci-base/luasrc/view/admin_uci/changes.htm new file mode 100644 index 0000000000..43bd7c23fb --- /dev/null +++ b/modules/luci-base/luasrc/view/admin_uci/changes.htm @@ -0,0 +1,45 @@ +<%# + Copyright 2008 Steven Barth + Copyright 2008-2018 Jo-Philipp Wich + Licensed to the public under the Apache License 2.0. +-%> + +<%+header%> + +<%- + local node, redir_url = luci.dispatcher.lookup(luci.http.formvalue("redir")) + export("redirect", redir_url or url("admin/uci/changes")) + + include("admin_uci/changelog") +-%> + +

<%:Configuration%> / <%:Changes%>

+ +<% if changes then %> + <%- uci_changelog(changes) -%> +<% else %> +

<%:There are no pending changes!%>

+<% end %> + + + +
+ <% if redir_url then %> +
+ +
+ <% end %> + +
"> + + " /> + +
+
"> + + " /> + +
+
+ +<%+footer%> diff --git a/modules/luci-base/luasrc/view/admin_uci/revert.htm b/modules/luci-base/luasrc/view/admin_uci/revert.htm new file mode 100644 index 0000000000..d8fd3de01e --- /dev/null +++ b/modules/luci-base/luasrc/view/admin_uci/revert.htm @@ -0,0 +1,33 @@ +<%# + Copyright 2008 Steven Barth + Copyright 2008-2018 Jo-Philipp Wich + Licensed to the public under the Apache License 2.0. +-%> + +<%+header%> + +<%- + local node, redir_url = luci.dispatcher.lookup(luci.http.formvalue("redir")) + export("redirect", redir_url or url("admin/uci/changes")) + + include("admin_uci/changelog") +-%> + +

<%:Configuration%> / <%:Revert%>

+ +<% if changes then %> +

<%:The following changes have been reverted%>:

+ <%- uci_changelog(changes) -%> +<% else %> +

<%:There are no pending changes to revert!%>

+<% end %> + +<% if redir_url then %> +
+
+ +
+
+<% end %> + +<%+footer%> diff --git a/modules/luci-base/luasrc/view/empty_node_placeholder.htm b/modules/luci-base/luasrc/view/empty_node_placeholder.htm new file mode 100644 index 0000000000..b7e276b960 --- /dev/null +++ b/modules/luci-base/luasrc/view/empty_node_placeholder.htm @@ -0,0 +1,11 @@ +<%# + Copyright 2010 Jo-Philipp Wich + Copyright 2018 Daniel F. Dickinson + Licensed to the public under the Apache License 2.0. +-%> + +<%+header%> + +

Component not present.

+ +<%+footer%> -- cgit v1.2.3