xref: /freebsd/stand/lua/menu.lua (revision 39006570a401ef5fb6d7d8029089fb11280bfd24)
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;
42b1b1f2b8SKyle 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]");
561666dfc0SKyle Evans		end
57088b4f5fSWarner Losh	},
58088b4f5fSWarner Losh
59088b4f5fSWarner Losh	-- load defaults
60088b4f5fSWarner Losh	{
61088b4f5fSWarner Losh		entry_type = "entry",
62088b4f5fSWarner Losh		name = function()
63088b4f5fSWarner Losh			return "Load System "..color.highlight("D").."efaults";
64088b4f5fSWarner Losh		end,
65088b4f5fSWarner Losh		func = function()
66088b4f5fSWarner Losh			core.setDefaults()
67088b4f5fSWarner Losh		end,
68088b4f5fSWarner Losh		alias = {"d", "D"}
69088b4f5fSWarner Losh	},
70088b4f5fSWarner Losh
71088b4f5fSWarner Losh	{
72088b4f5fSWarner Losh		entry_type = "separator",
73088b4f5fSWarner Losh		name = function()
74088b4f5fSWarner Losh			return "";
75088b4f5fSWarner Losh		end
76088b4f5fSWarner Losh	},
77088b4f5fSWarner Losh
78088b4f5fSWarner Losh	{
79088b4f5fSWarner Losh		entry_type = "separator",
80088b4f5fSWarner Losh		name = function()
81088b4f5fSWarner Losh			return "Boot Options:";
82088b4f5fSWarner Losh		end
83088b4f5fSWarner Losh	},
84088b4f5fSWarner Losh
85088b4f5fSWarner Losh	-- acpi
86088b4f5fSWarner Losh	{
87088b4f5fSWarner Losh		entry_type = "entry",
88088b4f5fSWarner Losh		name = function()
89088b4f5fSWarner Losh			return OnOff(color.highlight("A").."CPI       :", core.acpi);
90088b4f5fSWarner Losh		end,
91088b4f5fSWarner Losh		func = function()
92088b4f5fSWarner Losh			core.setACPI();
93088b4f5fSWarner Losh		end,
94088b4f5fSWarner Losh		alias = {"a", "A"}
95088b4f5fSWarner Losh	},
96088b4f5fSWarner Losh	-- safe mode
97088b4f5fSWarner Losh	{
98088b4f5fSWarner Losh		entry_type = "entry",
99088b4f5fSWarner Losh		name = function()
100088b4f5fSWarner Losh			return OnOff("Safe "..color.highlight("M").."ode  :", core.sm);
101088b4f5fSWarner Losh		end,
102088b4f5fSWarner Losh		func = function()
103088b4f5fSWarner Losh			core.setSafeMode();
104088b4f5fSWarner Losh		end,
105088b4f5fSWarner Losh		alias = {"m", "M"}
106088b4f5fSWarner Losh	},
107088b4f5fSWarner Losh	-- single user
108088b4f5fSWarner Losh	{
109088b4f5fSWarner Losh		entry_type = "entry",
110088b4f5fSWarner Losh		name = function()
111088b4f5fSWarner Losh			return OnOff(color.highlight("S").."ingle user:", core.su);
112088b4f5fSWarner Losh		end,
113088b4f5fSWarner Losh		func = function()
114088b4f5fSWarner Losh			core.setSingleUser();
115088b4f5fSWarner Losh		end,
116088b4f5fSWarner Losh		alias = {"s", "S"}
117088b4f5fSWarner Losh	},
118088b4f5fSWarner Losh	-- verbose boot
119088b4f5fSWarner Losh	{
120088b4f5fSWarner Losh		entry_type = "entry",
121088b4f5fSWarner Losh		name = function()
122088b4f5fSWarner Losh			return OnOff(color.highlight("V").."erbose    :", core.verbose);
123088b4f5fSWarner Losh		end,
124088b4f5fSWarner Losh		func = function()
125088b4f5fSWarner Losh			core.setVerbose();
126088b4f5fSWarner Losh		end,
127088b4f5fSWarner Losh		alias = {"v", "V"}
128088b4f5fSWarner Losh	},
129088b4f5fSWarner Losh};
130088b4f5fSWarner Losh
131088b4f5fSWarner Loshmenu.welcome = {
132088b4f5fSWarner Losh	-- boot multi user
133088b4f5fSWarner Losh	{
134088b4f5fSWarner Losh		entry_type = "entry",
135088b4f5fSWarner Losh		name = function()
136088b4f5fSWarner Losh			return color.highlight("B").."oot Multi user "..color.highlight("[Enter]");
137088b4f5fSWarner Losh		end,
138088b4f5fSWarner Losh		func = function()
139088b4f5fSWarner Losh			core.setSingleUser(false);
140088b4f5fSWarner Losh			core.boot();
141088b4f5fSWarner Losh		end,
142b458bf0dSKyle Evans		alias = {"b", "B"}
143088b4f5fSWarner Losh	},
144088b4f5fSWarner Losh
145088b4f5fSWarner Losh	-- boot single user
146088b4f5fSWarner Losh	{
147088b4f5fSWarner Losh		entry_type = "entry",
148088b4f5fSWarner Losh		name = function()
149088b4f5fSWarner Losh			return "Boot "..color.highlight("S").."ingle user";
150088b4f5fSWarner Losh		end,
151088b4f5fSWarner Losh		func = function()
152088b4f5fSWarner Losh			core.setSingleUser(true);
153088b4f5fSWarner Losh			core.boot();
154088b4f5fSWarner Losh		end,
155088b4f5fSWarner Losh		alias = {"s", "S"}
156088b4f5fSWarner Losh	},
157088b4f5fSWarner Losh
158088b4f5fSWarner Losh	-- escape to interpreter
159088b4f5fSWarner Losh	{
160088b4f5fSWarner Losh		entry_type = "return",
161088b4f5fSWarner Losh		name = function()
162e9084012SKyle Evans			return color.highlight("Esc").."ape to loader prompt";
163088b4f5fSWarner Losh		end,
164*39006570SKyle Evans		alias = {core.KEYSTR_ESCAPE}
165088b4f5fSWarner Losh	},
166088b4f5fSWarner Losh
167088b4f5fSWarner Losh	-- reboot
168088b4f5fSWarner Losh	{
169088b4f5fSWarner Losh		entry_type = "entry",
170088b4f5fSWarner Losh		name = function()
171088b4f5fSWarner Losh			return color.highlight("R").."eboot";
172088b4f5fSWarner Losh		end,
173088b4f5fSWarner Losh		func = function()
174088b4f5fSWarner Losh			loader.perform("reboot");
175088b4f5fSWarner Losh		end,
176088b4f5fSWarner Losh		alias = {"r", "R"}
177088b4f5fSWarner Losh	},
178088b4f5fSWarner Losh
179088b4f5fSWarner Losh
180088b4f5fSWarner Losh	{
181088b4f5fSWarner Losh		entry_type = "separator",
182088b4f5fSWarner Losh		name = function()
183088b4f5fSWarner Losh			return "";
184088b4f5fSWarner Losh		end
185088b4f5fSWarner Losh	},
186088b4f5fSWarner Losh
187088b4f5fSWarner Losh	{
188088b4f5fSWarner Losh		entry_type = "separator",
189088b4f5fSWarner Losh		name = function()
190088b4f5fSWarner Losh			return "Options:";
191088b4f5fSWarner Losh		end
192088b4f5fSWarner Losh	},
193088b4f5fSWarner Losh
194088b4f5fSWarner Losh	-- kernel options
195088b4f5fSWarner Losh	{
196b1b1f2b8SKyle Evans		entry_type = "entry",
197088b4f5fSWarner Losh		name = function()
198088b4f5fSWarner Losh			local kernels = core.kernelList();
199088b4f5fSWarner Losh			if #kernels == 0 then
200b1b1f2b8SKyle Evans				return "Kernel: ";
201088b4f5fSWarner Losh			end
202b1b1f2b8SKyle Evans
203b1b1f2b8SKyle Evans			local kernel_name = color.escapef(color.GREEN) ..
204b1b1f2b8SKyle Evans			    kernels[current_kernel_index] .. color.default();
205b1b1f2b8SKyle Evans			if (current_kernel_index == 1) then
206b1b1f2b8SKyle Evans				kernel_name = "default/" .. kernel_name;
207b1b1f2b8SKyle Evans			end
208b1b1f2b8SKyle Evans			return color.highlight("K").."ernel: " .. kernel_name ..
209b1b1f2b8SKyle Evans			    " (" .. current_kernel_index ..
210b1b1f2b8SKyle Evans			    " of " .. #kernels .. ")";
211088b4f5fSWarner Losh		end,
212b1b1f2b8SKyle Evans		func = function()
213088b4f5fSWarner Losh
214088b4f5fSWarner Losh			-- dynamically build the kernel menu:
215088b4f5fSWarner Losh			local kernels = core.kernelList();
216b1b1f2b8SKyle Evans			-- Don't do anything if we don't have multiple kernels
217b1b1f2b8SKyle Evans			if #kernels <= 1 then
2186a5a7e8aSKyle Evans				return nil;
2196a5a7e8aSKyle Evans			end
220b1b1f2b8SKyle Evans			current_kernel_index = (current_kernel_index % #kernels)
221b1b1f2b8SKyle Evans			    + 1;
222b1b1f2b8SKyle Evans			local current_kernel = kernels[current_kernel_index];
223b1b1f2b8SKyle Evans			config.reload(current_kernel)
224088b4f5fSWarner Losh		end,
225088b4f5fSWarner Losh		alias = {"k", "K"}
226088b4f5fSWarner Losh	},
227088b4f5fSWarner Losh
228088b4f5fSWarner Losh	-- boot options
229088b4f5fSWarner Losh	{
230088b4f5fSWarner Losh		entry_type = "submenu",
231088b4f5fSWarner Losh		name = function()
232088b4f5fSWarner Losh			return "Boot "..color.highlight("O").."ptions";
233088b4f5fSWarner Losh		end,
234088b4f5fSWarner Losh		submenu = function()
235088b4f5fSWarner Losh			return menu.boot_options;
236088b4f5fSWarner Losh		end,
237088b4f5fSWarner Losh		alias = {"o", "O"}
238088b4f5fSWarner Losh	}
239088b4f5fSWarner Losh
240088b4f5fSWarner Losh};
241088b4f5fSWarner Losh
242088b4f5fSWarner Loshfunction menu.run(m)
243088b4f5fSWarner Losh
244088b4f5fSWarner Losh	if (menu.skip()) then
245088b4f5fSWarner Losh		core.autoboot();
246088b4f5fSWarner Losh		return false;
247088b4f5fSWarner Losh	end
248088b4f5fSWarner Losh
249088b4f5fSWarner Losh	if (m == nil) then
250088b4f5fSWarner Losh		m = menu.welcome;
251088b4f5fSWarner Losh	end
252088b4f5fSWarner Losh
253088b4f5fSWarner Losh	-- redraw screen
254088b4f5fSWarner Losh	screen.clear();
255088b4f5fSWarner Losh	screen.defcursor();
256088b4f5fSWarner Losh	local alias_table = drawer.drawscreen(m);
257088b4f5fSWarner Losh
258088b4f5fSWarner Losh--	menu.autoboot();
259088b4f5fSWarner Losh
260088b4f5fSWarner Losh	cont = true;
261088b4f5fSWarner Losh	while cont do
262abc4f7e7SKyle Evans		local key = io.getchar();
263088b4f5fSWarner Losh
264b458bf0dSKyle Evans		-- Special key behaviors
265fe672a15SKyle Evans		if (key == core.KEY_BACKSPACE) and (m ~= menu.welcome) then
266abc4f7e7SKyle Evans			break
267fe672a15SKyle Evans		elseif (key == core.KEY_ENTER) then
268b458bf0dSKyle Evans			core.boot();
269b458bf0dSKyle Evans			-- Should not return
270abc4f7e7SKyle Evans		end
271abc4f7e7SKyle Evans
272abc4f7e7SKyle Evans		key = string.char(key)
273088b4f5fSWarner Losh		-- check to see if key is an alias
274088b4f5fSWarner Losh		local sel_entry = nil;
275088b4f5fSWarner Losh		for k, v in pairs(alias_table) do
276088b4f5fSWarner Losh			if (key == k) then
277088b4f5fSWarner Losh				sel_entry = v;
278088b4f5fSWarner Losh			end
279088b4f5fSWarner Losh		end
280088b4f5fSWarner Losh
281088b4f5fSWarner Losh		-- if we have an alias do the assigned action:
282088b4f5fSWarner Losh		if(sel_entry ~= nil) then
283088b4f5fSWarner Losh			if (sel_entry.entry_type == "entry") then
284088b4f5fSWarner Losh				-- run function
285088b4f5fSWarner Losh				sel_entry.func();
286088b4f5fSWarner Losh			elseif (sel_entry.entry_type == "submenu") then
287088b4f5fSWarner Losh				-- recurse
288088b4f5fSWarner Losh				cont = menu.run(sel_entry.submenu());
289088b4f5fSWarner Losh			elseif (sel_entry.entry_type == "return") then
290088b4f5fSWarner Losh				-- break recurse
291088b4f5fSWarner Losh				cont = false;
292088b4f5fSWarner Losh			end
293088b4f5fSWarner Losh			-- if we got an alias key the screen is out of date:
294088b4f5fSWarner Losh			screen.clear();
295088b4f5fSWarner Losh			screen.defcursor();
296088b4f5fSWarner Losh			alias_table = drawer.drawscreen(m);
297088b4f5fSWarner Losh		end
298088b4f5fSWarner Losh	end
299088b4f5fSWarner Losh
300088b4f5fSWarner Losh	if (m == menu.welcome) then
301088b4f5fSWarner Losh		screen.defcursor();
302088b4f5fSWarner Losh		print("Exiting menu!");
303088b4f5fSWarner Losh		return false;
304088b4f5fSWarner Losh	end
305088b4f5fSWarner Losh
306088b4f5fSWarner Losh	return true;
307088b4f5fSWarner Loshend
308088b4f5fSWarner Losh
309088b4f5fSWarner Loshfunction menu.skip()
310088b4f5fSWarner Losh	if core.bootserial() then
311088b4f5fSWarner Losh		return true;
312088b4f5fSWarner Losh	end
313088b4f5fSWarner Losh	local c = string.lower(loader.getenv("console") or "");
314088b4f5fSWarner Losh	if (c:match("^efi[ ;]") or c:match("[ ;]efi[ ;]")) ~= nil then
315088b4f5fSWarner Losh		return true;
316088b4f5fSWarner Losh	end
317088b4f5fSWarner Losh
318088b4f5fSWarner Losh	c = string.lower(loader.getenv("beastie_disable") or "");
319088b4f5fSWarner Losh	print("beastie_disable", c);
320088b4f5fSWarner Losh	return c == "yes";
321088b4f5fSWarner Loshend
322088b4f5fSWarner Losh
323088b4f5fSWarner Loshfunction menu.autoboot()
324088b4f5fSWarner Losh	if menu.already_autoboot == true then
325088b4f5fSWarner Losh		return;
326088b4f5fSWarner Losh	end
327088b4f5fSWarner Losh	menu.already_autoboot = true;
328088b4f5fSWarner Losh
329088b4f5fSWarner Losh	local ab = loader.getenv("autoboot_delay");
330088b4f5fSWarner Losh	if ab == "NO" or ab == "no" then
331088b4f5fSWarner Losh		core.boot();
332088b4f5fSWarner Losh	end
333088b4f5fSWarner Losh	ab = tonumber(ab) or 10;
334088b4f5fSWarner Losh
335088b4f5fSWarner Losh	local x = loader.getenv("loader_menu_timeout_x") or 5;
336088b4f5fSWarner Losh	local y = loader.getenv("loader_menu_timeout_y") or 22;
337088b4f5fSWarner Losh
338088b4f5fSWarner Losh	local endtime = loader.time() + ab;
339088b4f5fSWarner Losh	local time;
340088b4f5fSWarner Losh
341088b4f5fSWarner Losh	repeat
342088b4f5fSWarner Losh		time = endtime - loader.time();
343088b4f5fSWarner Losh		screen.setcursor(x, y);
344088b4f5fSWarner Losh		print("Autoboot in "..time.." seconds, hit [Enter] to boot"
345088b4f5fSWarner Losh			      .." or any other key to stop     ");
346088b4f5fSWarner Losh		screen.defcursor();
347088b4f5fSWarner Losh		if io.ischar() then
348088b4f5fSWarner Losh			local ch = io.getchar();
349fe672a15SKyle Evans			if ch == core.KEY_ENTER then
350088b4f5fSWarner Losh				break;
351088b4f5fSWarner Losh			else
352088b4f5fSWarner Losh				-- prevent autoboot when escaping to interpreter
353088b4f5fSWarner Losh				loader.setenv("autoboot_delay", "NO");
354088b4f5fSWarner Losh				-- erase autoboot msg
355088b4f5fSWarner Losh				screen.setcursor(0, y);
356088b4f5fSWarner Losh				print("                                        "
357088b4f5fSWarner Losh					      .."                                        ");
358088b4f5fSWarner Losh				screen.defcursor();
359088b4f5fSWarner Losh				return;
360088b4f5fSWarner Losh			end
361088b4f5fSWarner Losh		end
362088b4f5fSWarner Losh
363088b4f5fSWarner Losh		loader.delay(50000);
364088b4f5fSWarner Losh	until time <= 0
365088b4f5fSWarner Losh	core.boot();
366088b4f5fSWarner Losh
367088b4f5fSWarner Loshend
368088b4f5fSWarner Losh
369088b4f5fSWarner Loshfunction OnOff(str, b)
370088b4f5fSWarner Losh	if (b) then
371088b4f5fSWarner Losh		return str .. color.escapef(color.GREEN).."On"..color.escapef(color.WHITE);
372088b4f5fSWarner Losh	else
373088b4f5fSWarner Losh		return str .. color.escapef(color.RED).."off"..color.escapef(color.WHITE);
374088b4f5fSWarner Losh	end
375088b4f5fSWarner Loshend
376088b4f5fSWarner Losh
377088b4f5fSWarner Loshreturn menu
378