ACF mvc.lua example - Revision history

Sertonix: update cgit to gitlab links

2023-08-25T20:56:49Z

update cgit to gitlab links

← Older revision		Revision as of 20:56, 25 August 2023
Line 10:		Line 10:
	Get the mvc.lua module from the git repository.		Get the mvc.lua module from the git repository.

	wget ~~http~~://~~git~~.alpinelinux.org/~~cgit~~/acf-core/~~plain~~/lua/mvc.lua		wget https://gitlab.alpinelinux.org/acf/acf-core/-/blob/master/lua/mvc.lua

	== Create a model and controller ==		== Create a model and controller ==
Line 274:		Line 274:

	* Web application		* Web application
	** Application - [~~http~~://~~git~~.alpinelinux.org~~/cgit~~/acf/acf-core/~~tree~~/~~www~~/~~cgi-bin~~/~~acf~~ acf]		** Application - [https://gitlab.alpinelinux.org/acf/acf-core/-/blob/master/lua/mvc.lua acf]
	** Controller - [~~http~~://~~git~~.alpinelinux.org~~/cgit~~/acf/acf-core/~~tree~~/~~app~~/~~acf_www-controller~~.lua acf_www-controller.lua]		** Controller - [https://gitlab.alpinelinux.org/acf/acf-core/-/blob/master/lua/mvc.lua acf_www-controller.lua]
	* acf-cli		* acf-cli
	** Application - [~~http~~://~~git~~.alpinelinux.org~~/cgit~~/acf/acf-core/~~tree~~/~~bin~~/~~acf-cli~~ acf-cli]		** Application - [https://gitlab.alpinelinux.org/acf/acf-core/-/blob/master/lua/mvc.lua acf-cli]
	** Controller - [~~http~~://~~git~~.alpinelinux.org~~/cgit~~/acf/acf-core/~~tree~~/~~app~~/~~acf_cli-controller~~.lua acf_cli-controller.lua]		** Controller - [https://gitlab.alpinelinux.org/acf/acf-core/-/blob/master/lua/mvc.lua acf_cli-controller.lua]

	=== Use the New method ===		=== Use the New method ===

Zcrayfish: Removed a hyperlink to a hypothetical URL.

2021-12-20T21:18:30Z

Removed a hyperlink to a hypothetical URL.

← Older revision		Revision as of 21:18, 20 December 2021
Line 166:		Line 166:
	echo "GUEST=hostname/edithostname" > /etc/acf/app/test/hostname.roles		echo "GUEST=hostname/edithostname" > /etc/acf/app/test/hostname.roles

	The new action should now be visible by browsing to ''https://IP-of-host/cgi-bin/acf/test/hostname/edithostname''. Obviously you might want to reconsider providing GUEST access to this action, because this allows unauthenticated users to modify your hostname.		The new action should now be visible by browsing to ''<nowiki>https://IP-of-host/cgi-bin/acf/test/hostname/edithostname</nowiki>''. Obviously you might want to reconsider providing GUEST access to this action, because this allows unauthenticated users to modify your hostname.

	3. Add the new hostname action to the ACF menu. Edit "/etc/acf/app/test/hostname.menu" file and add a menu item:		3. Add the new hostname action to the ACF menu. Edit "/etc/acf/app/test/hostname.menu" file and add a menu item:

Ttrask: Add explanation of how the web app and acf-cli use the dispatch method with application-specific controllers

2016-08-03T21:50:09Z

Add explanation of how the web app and acf-cli use the dispatch method with application-specific controllers

← Older revision		Revision as of 21:50, 3 August 2016
Line 270:		Line 270:
	hostname: Hostname must be 16 characters or less		hostname: Hostname must be 16 characters or less
	alpine:~#		alpine:~#

			You can further customize the application by creating your own application-specific controller. This is how the web interface and the acf-cli application are written. In both cases, a simple application is written to load not just an mvc:new() reference, but an application-specific controller to wrap the mvc:new() object. The dispatch function is then called on the application-specific controller object, which can override any function in mvc.lua to add a customized implementation. For example, both applications override the handle_clientdata function to customize the way input data is provided in the clientdata structure, and the web interface-specific controller contains a lot of code to handle features such as menus, templates, skins, authentication, redirection, ... The best way to understand this is to just read the code.

			* Web application
			** Application - [http://git.alpinelinux.org/cgit/acf/acf-core/tree/www/cgi-bin/acf acf]
			** Controller - [http://git.alpinelinux.org/cgit/acf/acf-core/tree/app/acf_www-controller.lua acf_www-controller.lua]
			* acf-cli
			** Application - [http://git.alpinelinux.org/cgit/acf/acf-core/tree/bin/acf-cli acf-cli]
			** Controller - [http://git.alpinelinux.org/cgit/acf/acf-core/tree/app/acf_cli-controller.lua acf_cli-controller.lua]

	=== Use the New method ===		=== Use the New method ===

Ttrask: Remove obsolete example and changes to view_resolver

2016-04-30T01:50:36Z

Remove obsolete example and changes to view_resolver

Show changes

Ttrask: Added example of MVC app using new method

2016-04-30T01:42:16Z

Added example of MVC app using new method

@@ Line 179: / Line 179: @@
 . Use the ''dispatch'' function. This is the method used by the web interface and the acf-cli application. The action to be dispatched is passed in a string format ''/prefix/controller/action'' and the input values are passed in as a clientinfo table. Output is determined by the view.
-. Use the ''new'' function to load the desired controller and then directly call the controller actions. For handling forms and user input, the application will call the action once to retrieve the form cfe, then fill in the desired input values into the cfe and call the action again to submit the form and perform the desired action. The MVC application is responsible for any user interaction and display of the results.
+. Use the ''new'' function to load the desired controller and then directly call the controller actions or model functions. Using the controller actions requires use of the clientdata structure to pass parameters. For calling the model functions, the application will call the get function to retrieve the form cfe, fill in the desired input values into the cfe, and then call the set function to submit the form and perform the desired action. The MVC application is responsible for any user interaction and display of the results.
 === Use the Dispatch method ===
@@ Line 272: / Line 272: @@
 === Use the New method ===
-Todo
+==== test_new ====

Ttrask: Add example of MVC application using dispatch method

2016-04-30T01:11:17Z

Add example of MVC application using dispatch method

@@ Line 21: / Line 21: @@
   mymodule.edithostname = function (self)
-          return self.handle_form(self, self.model.get_hostname, self.model.set_hostname, self.clientdata, "Edit", "Edit Hostname", "Hostname Updated")
+          return self.handle_form(self, self.model.get_hostname, self.model.set_hostname, self.clientdata, "Update", "Edit Hostname", "Hostname Updated")
   end
@@ Line 154: / Line 154: @@
   result["value"]["hostname"]["value"] = "test"
-Note that the first case read the existing hostname and the second case updated it. The output of the acf-cli application is a serialized version of the cfe form, which is good for testing but not too useful in real life.
+Note that the action string passed to acf-cli is of the form "/prefix/controller/action". The prefix is the path within /etc/acf/app where the controller may be found, so "/test/" for our case. The controller is determined from the controller file name, so "hostname" for our case. And, the action corresponds to the function within the controller to call, so "edithostname" for our case. Also note that, in the two examples above, the first case reads the existing hostname and the second case updates it. The output of the acf-cli application is a serialized version of the cfe form, which is good for testing but not too useful in real life.
 == Enable the package in the ACF web interface ==
@@ Line 177: / Line 177: @@
 You have two options for creating an MVC based application of your own.
-. Use the ''dispatch'' function. This is the method used by the web interface and the acf-cli application. The action to be dispatched is passed in a string format ''/prefix/controller/action'' and the input values are passed in as a clientinfo table. Output is written to stdout.
+. Use the ''dispatch'' function. This is the method used by the web interface and the acf-cli application. The action to be dispatched is passed in a string format ''/prefix/controller/action'' and the input values are passed in as a clientinfo table. Output is determined by the view.
 . Use the ''new'' function to load the desired controller and then directly call the controller actions. For handling forms and user input, the application will call the action once to retrieve the form cfe, then fill in the desired input values into the cfe and call the action again to submit the form and perform the desired action. The MVC application is responsible for any user interaction and display of the results.
 === Use the Dispatch method ===
-Todo
+==== test_dispatch ====
 === Use the New method ===

Fab: Reverted edits by RuthHughes (talk) to last revision by Ttrask

2016-03-07T12:30:24Z

Reverted edits by RuthHughes (talk) to last revision by Ttrask

Show changes

RuthHughes: minor updates

2016-03-07T03:10:46Z

minor updates

Show changes

Ttrask: Minor changes

2015-03-09T14:59:12Z

Minor changes

← Older revision		Revision as of 14:59, 9 March 2015
Line 4:		Line 4:


	For this example, we will assume you have root access on the linux box you are running on (preferably an ~~alpine~~ box!)		For this example, we will assume you have root access on the linux box you are running on (preferably an Alpine Linux box!)

	== Get the mvc.lua module ==		== Get the mvc.lua module ==
Line 14:		Line 14:
	== Create a model and controller ==		== Create a model and controller ==

	Create a file '''hostname-controller.lua''', defining the functions that an "end user" could run. We will only create one action, edithostname, which will be used to read and update the hostname. Since the action makes changes to the system, it naturally takes ~~for~~ form of a 'form':		Create a file '''hostname-controller.lua''', defining the functions that an "end user" could run. We will only create one action, edithostname, which will be used to read and update the hostname. Since the action makes changes to the system, it naturally takes the form of a 'form':

	=== hostname-controller.lua ===		=== hostname-controller.lua ===
Line 21:		Line 21:

	mymodule.edithostname = function (self)		mymodule.edithostname = function (self)
	return self.handle_form(self, self.model.get_hostname, self.model.~~update_hostname~~, self.clientdata, "Edit", "Edit Hostname", "Hostname Updated")		return self.handle_form(self, self.model.get_hostname, self.model.set_hostname, self.clientdata, "Edit", "Edit Hostname", "Hostname Updated")
	end		end

	return mymodule		return mymodule

	Create a file '''hostname-model.lua''', defining the model functions to get and ~~update~~ the hostname. We return a cfe table for each function including the form with the one entry for hostname:		Create a file '''hostname-model.lua''', defining the model functions to get and set the hostname. We return a cfe table for each function including the form with the one entry for hostname:

	=== hostname-model.lua ===		=== hostname-model.lua ===
Line 34:		Line 34:
	-- Create a cfe defining the form for editing the hostname and containing the current value		-- Create a cfe defining the form for editing the hostname and containing the current value
	mymodule.get_hostname = function(self, clientdata)		mymodule.get_hostname = function(self, clientdata)
	local retval = {}		local retval = cfe({ type="group", value={}, label="Hostname" })

			-- Warning - io.popen has security risks, never pass user data to io.popen
	local f = io.popen ("/bin/hostname")		local f = io.popen ("/bin/hostname")
	local n = f:read("*a") or "none"		local n = f:read("*a") or "none"
Line 41:		Line 42:
	n=string.gsub(n, "\n$", "")		n=string.gsub(n, "\n$", "")

	retval.hostname = cfe({ value=n, label="Hostname" })		retval.value.hostname = cfe({ value=n, label="Hostname" })

	return ~~cfe({ type="group", value=~~retval~~, label="Hostname" })~~		return retval
	end		end

	-- ~~Update~~ the hostname from the value contained in the cfe created by get_hostname		-- Set the hostname from the value contained in the cfe created by get_hostname
	mymodule.~~update_hostname~~ = function(self, hostnameform, action)		mymodule.set_hostname = function(self, hostnameform, action)
	local success = true		local success = true

Line 56:		Line 57:
	elseif (#hostnameform.value.hostname.value > 16) then		elseif (#hostnameform.value.hostname.value > 16) then
	success = false		success = false
	hostnameform.value.hostname.errtxt = "Hostname must be less ~~than 16 chars~~"		hostnameform.value.hostname.errtxt = "Hostname must be 16 characters or less"
	elseif (string.find(hostnameform.value.hostname.value, "[^%w%_%-]")) then		elseif (string.find(hostnameform.value.hostname.value, "[^%w%_%-]")) then
	success = false		success = false
Line 62:		Line 63:
	end		end

	-- If it is, set the hostname		-- If it is valid, set the hostname
	if ( success ) then		if ( success ) then
	local f = io.open("/etc/hostname", "w")		local f = io.open("/etc/hostname", "w")
Line 69:		Line 70:
	f:close()		f:close()
	end		end
			-- Warning - io.popen has security risks, never pass user data to io.popen
	f = io.popen ("/bin/hostname -F /etc/hostname")		f = io.popen ("/bin/hostname -F /etc/hostname")
	f:close()		f:close()
	else		else
	hostnameform.errtxt = "Failed to ~~update~~ hostname"		hostnameform.errtxt = "Failed to set hostname"
	end		end

Line 90:		Line 92:
	local form = m.get_hostname()		local form = m.get_hostname()
	form.value.hostname.value = arg[1] or ""		form.value.hostname.value = arg[1] or ""
	form = m.~~update_hostname~~(nil, form)		form = m.set_hostname(nil, form)

	if form.errtxt then		if form.errtxt then

Ttrask: Start on the MVC application section

2013-10-03T03:48:34Z

Start on the MVC application section

← Older revision		Revision as of 03:48, 3 October 2013
Line 173:		Line 173:

	== Make an MVC based application ==		== Make an MVC based application ==
			You have two options for creating an MVC based application of your own.

			1. Use the ''dispatch'' function. This is the method used by the web interface and the acf-cli application. The action to be dispatched is passed in a string format ''/prefix/controller/action'' and the input values are passed in as a clientinfo table. Output is written to stdout.

			2. Use the ''new'' function to load the desired controller and then directly call the controller actions. For handling forms and user input, the application will call the action once to retrieve the form cfe, then fill in the desired input values into the cfe and call the action again to submit the form and perform the desired action. The MVC application is responsible for any user interaction and display of the results.

			=== Use the Dispatch method ===
			Todo

			=== Use the New method ===
			Todo



			{{Obsolete}}
	4. Create a dispatch wrapper program, named '''helloworld.lua''' in the current directory:		4. Create a dispatch wrapper program, named '''helloworld.lua''' in the current directory: