xref: /freebsd/stand/lua/menu.lua (revision b1b1f2b8fd862690d4f7c5c2b55f7bd6f7a5e99d)
1088b4f5fSWarner Losh--
2088b4f5fSWarner Losh-- Copyright (c) 2015 Pedro Souza <pedrosouza@freebsd.org>
3088b4f5fSWarner Losh-- All rights reserved.
4088b4f5fSWarner Losh--
5088b4f5fSWarner Losh-- Redistribution and use in source and binary forms, with or without
6088b4f5fSWarner Losh-- modification, are permitted provided that the following conditions
7088b4f5fSWarner Losh-- are met:
8088b4f5fSWarner Losh-- 1. Redistributions of source code must retain the above copyright
9088b4f5fSWarner Losh--    notice, this list of conditions and the following disclaimer.
10088b4f5fSWarner Losh-- 2. Redistributions in binary form must reproduce the above copyright
11088b4f5fSWarner Losh--    notice, this list of conditions and the following disclaimer in the
12088b4f5fSWarner Losh--    documentation and/or other materials provided with the distribution.
13088b4f5fSWarner Losh--
14088b4f5fSWarner Losh-- THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15088b4f5fSWarner Losh-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16088b4f5fSWarner Losh-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17088b4f5fSWarner Losh-- ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18088b4f5fSWarner Losh-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19088b4f5fSWarner Losh-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20088b4f5fSWarner Losh-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21088b4f5fSWarner Losh-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22088b4f5fSWarner Losh-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23088b4f5fSWarner Losh-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24088b4f5fSWarner Losh-- SUCH DAMAGE.
25088b4f5fSWarner Losh--
26088b4f5fSWarner Losh-- $FreeBSD$
27088b4f5fSWarner Losh--
28088b4f5fSWarner Losh
29088b4f5fSWarner Losh
30088b4f5fSWarner Loshlocal menu = {};
31088b4f5fSWarner Losh
32088b4f5fSWarner Loshlocal core = require("core");
33088b4f5fSWarner Loshlocal color = require("color");
34088b4f5fSWarner Loshlocal config = require("config");
35088b4f5fSWarner Loshlocal screen = require("screen");
36088b4f5fSWarner Loshlocal drawer = require("drawer");
37088b4f5fSWarner Losh
38088b4f5fSWarner Loshlocal OnOff;
39088b4f5fSWarner Loshlocal skip;
40088b4f5fSWarner Loshlocal run;
41088b4f5fSWarner Loshlocal autoboot;
42*b1b1f2b8SKyle Evanslocal current_kernel_index = 1;
43088b4f5fSWarner Losh
44088b4f5fSWarner Losh--loader menu tree:
45088b4f5fSWarner Losh--rooted at menu.welcome
46088b4f5fSWarner Losh--submenu declarations:
47088b4f5fSWarner Loshlocal boot_options;
48088b4f5fSWarner Loshlocal welcome;
49088b4f5fSWarner Losh
50088b4f5fSWarner Loshmenu.boot_options = {
51088b4f5fSWarner Losh	-- return to welcome menu
52088b4f5fSWarner Losh	{
53088b4f5fSWarner Losh		entry_type = "return",
54088b4f5fSWarner Losh		name = function()
55088b4f5fSWarner Losh			return "Back to main menu"..color.highlight(" [Backspace]");
56088b4f5fSWarner Losh		end,
57088b4f5fSWarner Losh		alias = {"\08"}
58088b4f5fSWarner Losh	},
59088b4f5fSWarner Losh
60088b4f5fSWarner Losh	-- load defaults
61088b4f5fSWarner Losh	{
62088b4f5fSWarner Losh		entry_type = "entry",
63088b4f5fSWarner Losh		name = function()
64088b4f5fSWarner Losh			return "Load System "..color.highlight("D").."efaults";
65088b4f5fSWarner Losh		end,
66088b4f5fSWarner Losh		func = function()
67088b4f5fSWarner Losh			core.setDefaults()
68088b4f5fSWarner Losh		end,
69088b4f5fSWarner Losh		alias = {"d", "D"}
70088b4f5fSWarner Losh	},
71088b4f5fSWarner Losh
72088b4f5fSWarner Losh	{
73088b4f5fSWarner Losh		entry_type = "separator",
74088b4f5fSWarner Losh		name = function()
75088b4f5fSWarner Losh			return "";
76088b4f5fSWarner Losh		end
77088b4f5fSWarner Losh	},
78088b4f5fSWarner Losh
79088b4f5fSWarner Losh	{
80088b4f5fSWarner Losh		entry_type = "separator",
81088b4f5fSWarner Losh		name = function()
82088b4f5fSWarner Losh			return "Boot Options:";
83088b4f5fSWarner Losh		end
84088b4f5fSWarner Losh	},
85088b4f5fSWarner Losh
86088b4f5fSWarner Losh	-- acpi
87088b4f5fSWarner Losh	{
88088b4f5fSWarner Losh		entry_type = "entry",
89088b4f5fSWarner Losh		name = function()
90088b4f5fSWarner Losh			return OnOff(color.highlight("A").."CPI       :", core.acpi);
91088b4f5fSWarner Losh		end,
92088b4f5fSWarner Losh		func = function()
93088b4f5fSWarner Losh			core.setACPI();
94088b4f5fSWarner Losh		end,
95088b4f5fSWarner Losh		alias = {"a", "A"}
96088b4f5fSWarner Losh	},
97088b4f5fSWarner Losh	-- safe mode
98088b4f5fSWarner Losh	{
99088b4f5fSWarner Losh		entry_type = "entry",
100088b4f5fSWarner Losh		name = function()
101088b4f5fSWarner Losh			return OnOff("Safe "..color.highlight("M").."ode  :", core.sm);
102088b4f5fSWarner Losh		end,
103088b4f5fSWarner Losh		func = function()
104088b4f5fSWarner Losh			core.setSafeMode();
105088b4f5fSWarner Losh		end,
106088b4f5fSWarner Losh		alias = {"m", "M"}
107088b4f5fSWarner Losh	},
108088b4f5fSWarner Losh	-- single user
109088b4f5fSWarner Losh	{
110088b4f5fSWarner Losh		entry_type = "entry",
111088b4f5fSWarner Losh		name = function()
112088b4f5fSWarner Losh			return OnOff(color.highlight("S").."ingle user:", core.su);
113088b4f5fSWarner Losh		end,
114088b4f5fSWarner Losh		func = function()
115088b4f5fSWarner Losh			core.setSingleUser();
116088b4f5fSWarner Losh		end,
117088b4f5fSWarner Losh		alias = {"s", "S"}
118088b4f5fSWarner Losh	},
119088b4f5fSWarner Losh	-- verbose boot
120088b4f5fSWarner Losh	{
121088b4f5fSWarner Losh		entry_type = "entry",
122088b4f5fSWarner Losh		name = function()
123088b4f5fSWarner Losh			return OnOff(color.highlight("V").."erbose    :", core.verbose);
124088b4f5fSWarner Losh		end,
125088b4f5fSWarner Losh		func = function()
126088b4f5fSWarner Losh			core.setVerbose();
127088b4f5fSWarner Losh		end,
128088b4f5fSWarner Losh		alias = {"v", "V"}
129088b4f5fSWarner Losh	},
130088b4f5fSWarner Losh};
131088b4f5fSWarner Losh
132088b4f5fSWarner Loshmenu.welcome = {
133088b4f5fSWarner Losh	-- boot multi user
134088b4f5fSWarner Losh	{
135088b4f5fSWarner Losh		entry_type = "entry",
136088b4f5fSWarner Losh		name = function()
137088b4f5fSWarner Losh			return color.highlight("B").."oot Multi user "..color.highlight("[Enter]");
138088b4f5fSWarner Losh		end,
139088b4f5fSWarner Losh		func = function()
140088b4f5fSWarner Losh			core.setSingleUser(false);
141088b4f5fSWarner Losh			core.boot();
142088b4f5fSWarner Losh		end,
143b458bf0dSKyle Evans		alias = {"b", "B"}
144088b4f5fSWarner Losh	},
145088b4f5fSWarner Losh
146088b4f5fSWarner Losh	-- boot single user
147088b4f5fSWarner Losh	{
148088b4f5fSWarner Losh		entry_type = "entry",
149088b4f5fSWarner Losh		name = function()
150088b4f5fSWarner Losh			return "Boot "..color.highlight("S").."ingle user";
151088b4f5fSWarner Losh		end,
152088b4f5fSWarner Losh		func = function()
153088b4f5fSWarner Losh			core.setSingleUser(true);
154088b4f5fSWarner Losh			core.boot();
155088b4f5fSWarner Losh		end,
156088b4f5fSWarner Losh		alias = {"s", "S"}
157088b4f5fSWarner Losh	},
158088b4f5fSWarner Losh
159088b4f5fSWarner Losh	-- escape to interpreter
160088b4f5fSWarner Losh	{
161088b4f5fSWarner Losh		entry_type = "return",
162088b4f5fSWarner Losh		name = function()
163088b4f5fSWarner Losh			return color.highlight("Esc").."ape to lua interpreter";
164088b4f5fSWarner Losh		end,
165088b4f5fSWarner Losh		alias = {"\027"}
166088b4f5fSWarner Losh	},
167088b4f5fSWarner Losh
168088b4f5fSWarner Losh	-- reboot
169088b4f5fSWarner Losh	{
170088b4f5fSWarner Losh		entry_type = "entry",
171088b4f5fSWarner Losh		name = function()
172088b4f5fSWarner Losh			return color.highlight("R").."eboot";
173088b4f5fSWarner Losh		end,
174088b4f5fSWarner Losh		func = function()
175088b4f5fSWarner Losh			loader.perform("reboot");
176088b4f5fSWarner Losh		end,
177088b4f5fSWarner Losh		alias = {"r", "R"}
178088b4f5fSWarner Losh	},
179088b4f5fSWarner Losh
180088b4f5fSWarner Losh
181088b4f5fSWarner Losh	{
182088b4f5fSWarner Losh		entry_type = "separator",
183088b4f5fSWarner Losh		name = function()
184088b4f5fSWarner Losh			return "";
185088b4f5fSWarner Losh		end
186088b4f5fSWarner Losh	},
187088b4f5fSWarner Losh
188088b4f5fSWarner Losh	{
189088b4f5fSWarner Losh		entry_type = "separator",
190088b4f5fSWarner Losh		name = function()
191088b4f5fSWarner Losh			return "Options:";
192088b4f5fSWarner Losh		end
193088b4f5fSWarner Losh	},
194088b4f5fSWarner Losh
195088b4f5fSWarner Losh	-- kernel options
196088b4f5fSWarner Losh	{
197*b1b1f2b8SKyle Evans		entry_type = "entry",
198088b4f5fSWarner Losh		name = function()
199088b4f5fSWarner Losh			local kernels = core.kernelList();
200088b4f5fSWarner Losh			if #kernels == 0 then
201*b1b1f2b8SKyle Evans				return "Kernel: ";
202088b4f5fSWarner Losh			end
203*b1b1f2b8SKyle Evans
204*b1b1f2b8SKyle Evans			local kernel_name = color.escapef(color.GREEN) ..
205*b1b1f2b8SKyle Evans			    kernels[current_kernel_index] .. color.default();
206*b1b1f2b8SKyle Evans			if (current_kernel_index == 1) then
207*b1b1f2b8SKyle Evans				kernel_name = "default/" .. kernel_name;
208*b1b1f2b8SKyle Evans			end
209*b1b1f2b8SKyle Evans			return color.highlight("K").."ernel: " .. kernel_name ..
210*b1b1f2b8SKyle Evans			    " (" .. current_kernel_index ..
211*b1b1f2b8SKyle Evans			    " of " .. #kernels .. ")";
212088b4f5fSWarner Losh		end,
213*b1b1f2b8SKyle Evans		func = function()
214088b4f5fSWarner Losh
215088b4f5fSWarner Losh			-- dynamically build the kernel menu:
216088b4f5fSWarner Losh			local kernels = core.kernelList();
217*b1b1f2b8SKyle Evans			-- Don't do anything if we don't have multiple kernels
218*b1b1f2b8SKyle Evans			if #kernels <= 1 then
2196a5a7e8aSKyle Evans				return nil;
2206a5a7e8aSKyle Evans			end
221*b1b1f2b8SKyle Evans			current_kernel_index = (current_kernel_index % #kernels)
222*b1b1f2b8SKyle Evans			    + 1;
223*b1b1f2b8SKyle Evans			local current_kernel = kernels[current_kernel_index];
224*b1b1f2b8SKyle Evans			config.reload(current_kernel)
225088b4f5fSWarner Losh		end,
226088b4f5fSWarner Losh		alias = {"k", "K"}
227088b4f5fSWarner Losh	},
228088b4f5fSWarner Losh
229088b4f5fSWarner Losh	-- boot options
230088b4f5fSWarner Losh	{
231088b4f5fSWarner Losh		entry_type = "submenu",
232088b4f5fSWarner Losh		name = function()
233088b4f5fSWarner Losh			return "Boot "..color.highlight("O").."ptions";
234088b4f5fSWarner Losh		end,
235088b4f5fSWarner Losh		submenu = function()
236088b4f5fSWarner Losh			return menu.boot_options;
237088b4f5fSWarner Losh		end,
238088b4f5fSWarner Losh		alias = {"o", "O"}
239088b4f5fSWarner Losh	}
240088b4f5fSWarner Losh
241088b4f5fSWarner Losh};
242088b4f5fSWarner Losh
243088b4f5fSWarner Loshfunction menu.run(m)
244088b4f5fSWarner Losh
245088b4f5fSWarner Losh	if (menu.skip()) then
246088b4f5fSWarner Losh		core.autoboot();
247088b4f5fSWarner Losh		return false;
248088b4f5fSWarner Losh	end
249088b4f5fSWarner Losh
250088b4f5fSWarner Losh	if (m == nil) then
251088b4f5fSWarner Losh		m = menu.welcome;
252088b4f5fSWarner Losh	end
253088b4f5fSWarner Losh
254088b4f5fSWarner Losh	-- redraw screen
255088b4f5fSWarner Losh	screen.clear();
256088b4f5fSWarner Losh	screen.defcursor();
257088b4f5fSWarner Losh	local alias_table = drawer.drawscreen(m);
258088b4f5fSWarner Losh
259088b4f5fSWarner Losh--	menu.autoboot();
260088b4f5fSWarner Losh
261088b4f5fSWarner Losh	cont = true;
262088b4f5fSWarner Losh	while cont do
263abc4f7e7SKyle Evans		local key = io.getchar();
264088b4f5fSWarner Losh
265b458bf0dSKyle Evans		-- Special key behaviors
266fe672a15SKyle Evans		if (key == core.KEY_BACKSPACE) and (m ~= menu.welcome) then
267abc4f7e7SKyle Evans			break
268fe672a15SKyle Evans		elseif (key == core.KEY_ENTER) then
269b458bf0dSKyle Evans			core.boot();
270b458bf0dSKyle Evans			-- Should not return
271abc4f7e7SKyle Evans		end
272abc4f7e7SKyle Evans
273abc4f7e7SKyle Evans		key = string.char(key)
274088b4f5fSWarner Losh		-- check to see if key is an alias
275088b4f5fSWarner Losh		local sel_entry = nil;
276088b4f5fSWarner Losh		for k, v in pairs(alias_table) do
277088b4f5fSWarner Losh			if (key == k) then
278088b4f5fSWarner Losh				sel_entry = v;
279088b4f5fSWarner Losh			end
280088b4f5fSWarner Losh		end
281088b4f5fSWarner Losh
282088b4f5fSWarner Losh		-- if we have an alias do the assigned action:
283088b4f5fSWarner Losh		if(sel_entry ~= nil) then
284088b4f5fSWarner Losh			if (sel_entry.entry_type == "entry") then
285088b4f5fSWarner Losh				-- run function
286088b4f5fSWarner Losh				sel_entry.func();
287088b4f5fSWarner Losh			elseif (sel_entry.entry_type == "submenu") then
288088b4f5fSWarner Losh				-- recurse
289088b4f5fSWarner Losh				cont = menu.run(sel_entry.submenu());
290088b4f5fSWarner Losh			elseif (sel_entry.entry_type == "return") then
291088b4f5fSWarner Losh				-- break recurse
292088b4f5fSWarner Losh				cont = false;
293088b4f5fSWarner Losh			end
294088b4f5fSWarner Losh			-- if we got an alias key the screen is out of date:
295088b4f5fSWarner Losh			screen.clear();
296088b4f5fSWarner Losh			screen.defcursor();
297088b4f5fSWarner Losh			alias_table = drawer.drawscreen(m);
298088b4f5fSWarner Losh		end
299088b4f5fSWarner Losh	end
300088b4f5fSWarner Losh
301088b4f5fSWarner Losh	if (m == menu.welcome) then
302088b4f5fSWarner Losh		screen.defcursor();
303088b4f5fSWarner Losh		print("Exiting menu!");
304088b4f5fSWarner Losh		return false;
305088b4f5fSWarner Losh	end
306088b4f5fSWarner Losh
307088b4f5fSWarner Losh	return true;
308088b4f5fSWarner Loshend
309088b4f5fSWarner Losh
310088b4f5fSWarner Loshfunction menu.skip()
311088b4f5fSWarner Losh	if core.bootserial() then
312088b4f5fSWarner Losh		return true;
313088b4f5fSWarner Losh	end
314088b4f5fSWarner Losh	local c = string.lower(loader.getenv("console") or "");
315088b4f5fSWarner Losh	if (c:match("^efi[ ;]") or c:match("[ ;]efi[ ;]")) ~= nil then
316088b4f5fSWarner Losh		return true;
317088b4f5fSWarner Losh	end
318088b4f5fSWarner Losh
319088b4f5fSWarner Losh	c = string.lower(loader.getenv("beastie_disable") or "");
320088b4f5fSWarner Losh	print("beastie_disable", c);
321088b4f5fSWarner Losh	return c == "yes";
322088b4f5fSWarner Loshend
323088b4f5fSWarner Losh
324088b4f5fSWarner Loshfunction menu.autoboot()
325088b4f5fSWarner Losh	if menu.already_autoboot == true then
326088b4f5fSWarner Losh		return;
327088b4f5fSWarner Losh	end
328088b4f5fSWarner Losh	menu.already_autoboot = true;
329088b4f5fSWarner Losh
330088b4f5fSWarner Losh	local ab = loader.getenv("autoboot_delay");
331088b4f5fSWarner Losh	if ab == "NO" or ab == "no" then
332088b4f5fSWarner Losh		core.boot();
333088b4f5fSWarner Losh	end
334088b4f5fSWarner Losh	ab = tonumber(ab) or 10;
335088b4f5fSWarner Losh
336088b4f5fSWarner Losh	local x = loader.getenv("loader_menu_timeout_x") or 5;
337088b4f5fSWarner Losh	local y = loader.getenv("loader_menu_timeout_y") or 22;
338088b4f5fSWarner Losh
339088b4f5fSWarner Losh	local endtime = loader.time() + ab;
340088b4f5fSWarner Losh	local time;
341088b4f5fSWarner Losh
342088b4f5fSWarner Losh	repeat
343088b4f5fSWarner Losh		time = endtime - loader.time();
344088b4f5fSWarner Losh		screen.setcursor(x, y);
345088b4f5fSWarner Losh		print("Autoboot in "..time.." seconds, hit [Enter] to boot"
346088b4f5fSWarner Losh			      .." or any other key to stop     ");
347088b4f5fSWarner Losh		screen.defcursor();
348088b4f5fSWarner Losh		if io.ischar() then
349088b4f5fSWarner Losh			local ch = io.getchar();
350fe672a15SKyle Evans			if ch == core.KEY_ENTER then
351088b4f5fSWarner Losh				break;
352088b4f5fSWarner Losh			else
353088b4f5fSWarner Losh				-- prevent autoboot when escaping to interpreter
354088b4f5fSWarner Losh				loader.setenv("autoboot_delay", "NO");
355088b4f5fSWarner Losh				-- erase autoboot msg
356088b4f5fSWarner Losh				screen.setcursor(0, y);
357088b4f5fSWarner Losh				print("                                        "
358088b4f5fSWarner Losh					      .."                                        ");
359088b4f5fSWarner Losh				screen.defcursor();
360088b4f5fSWarner Losh				return;
361088b4f5fSWarner Losh			end
362088b4f5fSWarner Losh		end
363088b4f5fSWarner Losh
364088b4f5fSWarner Losh		loader.delay(50000);
365088b4f5fSWarner Losh	until time <= 0
366088b4f5fSWarner Losh	core.boot();
367088b4f5fSWarner Losh
368088b4f5fSWarner Loshend
369088b4f5fSWarner Losh
370088b4f5fSWarner Loshfunction OnOff(str, b)
371088b4f5fSWarner Losh	if (b) then
372088b4f5fSWarner Losh		return str .. color.escapef(color.GREEN).."On"..color.escapef(color.WHITE);
373088b4f5fSWarner Losh	else
374088b4f5fSWarner Losh		return str .. color.escapef(color.RED).."off"..color.escapef(color.WHITE);
375088b4f5fSWarner Losh	end
376088b4f5fSWarner Loshend
377088b4f5fSWarner Losh
378088b4f5fSWarner Loshreturn menu
379