Added exportation solution via CMS_HOOK_EXPORT.

Updated blocks settings for demo example project.
2015-11-10 10:30:10 +01:00
parent 6b3ff6f980 420051cd14
commit a5973c9c8a
18 changed files with 519 additions and 25 deletions
--- a/modules/node/cms_node_api.e
+++ b/modules/node/cms_node_api.e
@@ -330,6 +330,14 @@ feature -- Access: Node
 			end
 		end

+	nodes_of_type (a_node_type: CMS_CONTENT_TYPE): LIST [CMS_NODE]
+			-- List of nodes of type `a_node_type'.
+		do
+			Result := node_storage.nodes_of_type (a_node_type)
+		ensure
+			expected_type: across Result as ic all ic.item.content_type.same_string (a_node_type.name) end
+		end
+
 feature -- Access: page/book outline

 	children (a_node: CMS_NODE): detachable LIST [CMS_NODE]
--- a/modules/node/cms_node_module.e
+++ b/modules/node/cms_node_module.e
@@ -25,6 +25,10 @@ inherit

 	CMS_RECENT_CHANGES_HOOK

+	CMS_HOOK_EXPORT
+
+	CMS_EXPORT_NODE_UTILITIES
+
 create
 	make

@@ -230,6 +234,7 @@ feature -- Hooks
 			a_response.hooks.subscribe_to_menu_system_alter_hook (Current)
 			a_response.hooks.subscribe_to_block_hook (Current)
 			a_response.hooks.subscribe_to_response_alter_hook (Current)
+			a_response.hooks.subscribe_to_export_hook (Current)

 				-- Module specific hook, if available.
 			a_response.hooks.subscribe_to_hook (Current, {CMS_RECENT_CHANGES_HOOK})
@@ -353,4 +358,69 @@ feature -- Hooks
 			end
 		end

+	export_to (a_export_id_list: detachable ITERABLE [READABLE_STRING_GENERAL]; a_export_parameters: CMS_EXPORT_PARAMETERS; a_response: CMS_RESPONSE)
+			-- Export data identified by `a_export_id_list',
+			-- or export all data if `a_export_id_list' is Void.
+		local
+			l_node_type: CMS_CONTENT_TYPE
+			n: CMS_NODE
+			p: PATH
+			d: DIRECTORY
+			f: PLAIN_TEXT_FILE
+			lst: LIST [CMS_NODE]
+		do
+			if attached node_api as l_node_api then
+				across
+					l_node_api.node_types as types_ic
+				loop
+					l_node_type := types_ic.item
+					if
+						l_node_type.name.same_string_general ("page") and then
+						(	a_export_id_list = Void
+							or else across a_export_id_list as ic some ic.item.same_string (l_node_type.name) end
+						)
+					then
+
+							-- For now, handle only page from this node module.
+						lst := l_node_api.nodes_of_type (l_node_type)
+						a_export_parameters.log ("Exporting " + lst.count.out + " nodes of type " + l_node_type.name)
+						across
+							lst as ic
+						loop
+							n := l_node_api.full_node (ic.item)
+							a_export_parameters.log (l_node_type.name + " #" + n.id.out)
+							p := a_export_parameters.location.extended ("nodes").extended (l_node_type.name).extended (n.id.out)
+							create d.make_with_path (p.parent)
+							if not d.exists then
+								d.recursive_create_dir
+							end
+							create f.make_with_path (p)
+							if not f.exists or else f.is_access_writable then
+								f.open_write
+								if attached {CMS_PAGE} n as l_page then
+									f.put_string (json_to_string (page_node_to_json (l_page)))
+								else
+									f.put_string (json_to_string (node_to_json (n)))
+								end
+								f.close
+							end
+						end
+					end
+				end
+			end
+		end
+
+	page_node_to_json (a_page: CMS_PAGE): JSON_OBJECT
+		local
+			j: JSON_OBJECT
+		do
+			Result := node_to_json (a_page)
+			if attached a_page.parent as l_parent_page then
+				create j.make_empty
+				j.put_string (l_parent_page.content_type, "type")
+				j.put_integer (l_parent_page.id, "nid")
+				Result.put (j, "parent")
+			end
+		end
+
 end
--- a/modules/node/export/cms_export_node_utilities.e
+++ b/modules/node/export/cms_export_node_utilities.e
@@ -0,0 +1,55 @@
+note
+	description: "[
+				Routines usefull during node exportation (see {CMS_HOOK_EXPORT}).
+			]"
+	date: "$Date$"
+	revision: "$Revision$"
+
+class
+	CMS_EXPORT_NODE_UTILITIES
+	
+inherit
+	CMS_EXPORT_JSON_UTILITIES
+	
+feature -- Access
+	
+	node_to_json (n: CMS_NODE): JSON_OBJECT
+		local
+			jo,j_author: JSON_OBJECT
+		do
+			create Result.make_empty
+			Result.put_string (n.content_type, "type")
+			Result.put_integer (n.id, "nid")
+			Result.put_integer (n.revision, "revision")
+			Result.put_string (n.title, "title")
+			put_date_into_json (n.creation_date, "creation_date", Result)
+			put_date_into_json (n.modification_date, "modification_date", Result)
+			put_date_into_json (n.publication_date, "publication_date", Result)
+			Result.put_integer (n.status, "status")
+			if attached n.author as u then
+				create j_author.make
+				j_author.put_integer (u.id, "uid")
+				j_author.put_string (u.name, "name")
+				Result.put (j_author, "author")
+			end
+			create jo.make_empty
+			if attached n.format as l_format then
+				jo.put_string (l_format, "format")
+			end
+			if attached n.summary as s then
+				jo.put_string (s, "summary")
+			end
+			if attached n.content as s then
+				jo.put_string (s, "content")
+			end
+			Result.put (jo, "data")
+			if attached n.link as lnk then
+				create jo.make_empty
+				jo.put_string (lnk.title, "title")
+				jo.put_string (lnk.location, "location")
+				jo.put_integer (lnk.weight, "weight")
+				Result.put (jo, "link")
+			end
+		end
+
+end
--- a/modules/node/node-safe.ecf
+++ b/modules/node/node-safe.ecf
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-14-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-14-0 http://www.eiffel.com/developers/xml/configuration-1-14-0.xsd" name="node" uuid="C7114DD4-FA92-4AE5-A209-0FFC45E44257" library_target="node">
+<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-15-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-15-0 http://www.eiffel.com/developers/xml/configuration-1-15-0.xsd" name="node" uuid="C7114DD4-FA92-4AE5-A209-0FFC45E44257" library_target="node">
 	<target name="node">
 		<root all_classes="true"/>
 		<file_rule>
@@ -7,7 +7,7 @@
 			<exclude>/CVS$</exclude>
 			<exclude>/.svn$</exclude>
 		</file_rule>
-		<option warning="true" full_class_checking="false" is_attached_by_default="true" void_safety="all" syntax="transitional">
+		<option warning="true" full_class_checking="false" is_attached_by_default="true" is_obsolete_routine_type="true" void_safety="all" syntax="transitional">
 			<assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/>
 		</option>
 		<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
@@ -17,6 +17,7 @@
 		<library name="error" location="$ISE_LIBRARY\contrib\library\utility\general\error\error-safe.ecf"/>
 		<library name="http" location="$ISE_LIBRARY\contrib\library\network\protocol\http\http-safe.ecf"/>
 		<library name="http_authorization" location="$ISE_LIBRARY\contrib\library\web\authentication\http_authorization\http_authorization-safe.ecf" readonly="false"/>
+		<library name="json" location="$ISE_LIBRARY\contrib\library\text\parser\json\library\json-safe.ecf"/>
 		<library name="text_filter" location="$ISE_LIBRARY\unstable\library\text\text_filter\text_filter-safe.ecf"/>
 		<library name="time" location="$ISE_LIBRARY\library\time\time-safe.ecf"/>
 		<library name="wsf" location="$ISE_LIBRARY\contrib\library\web\framework\ewf\wsf\wsf-safe.ecf"/>
--- a/modules/node/node.ecf
+++ b/modules/node/node.ecf
@@ -17,6 +17,7 @@
 		<library name="error" location="$ISE_LIBRARY\contrib\library\utility\general\error\error.ecf"/>
 		<library name="http" location="$ISE_LIBRARY\contrib\library\network\protocol\http\http.ecf"/>
 		<library name="http_authorization" location="$ISE_LIBRARY\contrib\library\network\authentication\http_authorization\http_authorization.ecf" readonly="false"/>
+		<library name="json" location="$ISE_LIBRARY\contrib\library\text\parser\json\library\json.ecf"/>
 		<library name="text_filter" location="$ISE_LIBRARY\unstable\library\text\text_filter\text_filter.ecf"/>
 		<library name="time" location="$ISE_LIBRARY\library\time\time.ecf"/>
 		<library name="wsf" location="$ISE_LIBRARY\contrib\library\web\framework\ewf\wsf\wsf.ecf"/>
--- a/modules/node/persistence/cms_node_storage_i.e
+++ b/modules/node/persistence/cms_node_storage_i.e
@@ -127,6 +127,26 @@ feature -- Access
 		deferred
 		end

+	nodes_of_type (a_node_type: CMS_CONTENT_TYPE): LIST [CMS_NODE]
+			-- List of nodes of type `a_node_type'.
+			--| Redefine to optimize!
+		do
+			Result := nodes
+			from
+				Result.start
+			until
+				Result.after
+			loop
+				if Result.item.content_type.same_string (a_node_type.name) then
+					Result.forth
+				else
+					Result.remove
+				end
+			end
+		ensure
+			expected_type: across Result as ic all ic.item.content_type.same_string (a_node_type.name) end
+		end
+
 feature -- Access: outline

 	children (a_node: CMS_NODE): detachable LIST [CMS_NODE]
--- a/modules/node/persistence/cms_node_storage_sql.e
+++ b/modules/node/persistence/cms_node_storage_sql.e
@@ -12,6 +12,9 @@ inherit
 	CMS_PROXY_STORAGE_SQL

 	CMS_NODE_STORAGE_I
+		redefine
+			nodes_of_type
+		end

 	CMS_STORAGE_SQL_I

@@ -264,6 +267,33 @@ feature -- Access
 --			end
 		end

+	nodes_of_type (a_node_type: CMS_CONTENT_TYPE): LIST [CMS_NODE]
+			-- <Precursor>
+		local
+			l_parameters: STRING_TABLE [detachable ANY]
+		do
+			create {ARRAYED_LIST [CMS_NODE]} Result.make (0)
+
+			error_handler.reset
+			write_information_log (generator + ".nodes_of_type")
+			create l_parameters.make (1)
+			l_parameters.put (a_node_type.name, "node_type")
+
+			from
+				sql_query (sql_select_nodes_of_type, l_parameters)
+				sql_start
+			until
+				sql_after
+			loop
+				if attached fetch_node as l_node then
+					check expected_node_type: l_node.content_type.same_string (a_node_type.name) end
+					Result.force (l_node)
+				end
+				sql_forth
+			end
+			sql_finalize
+		end
+
 feature -- Access: outline

 	children (a_node: CMS_NODE): detachable LIST [CMS_NODE]
@@ -495,6 +525,10 @@ feature {NONE} -- Queries
 			-- SQL Query to retrieve all nodes.
 			--| note: {CMS_NODE_API}.trashed = -1

+	sql_select_nodes_of_type: STRING = "SELECT nid, revision, type, title, summary, content, format, author, publish, created, changed, status FROM nodes WHERE status != -1 AND type=:node_type ;"
+			-- SQL Query to retrieve all nodes of type :node_type.
+			--| note: {CMS_NODE_API}.trashed = -1		
+
 	sql_select_node_revisions: STRING = "SELECT nodes.nid, node_revisions.revision, nodes.type, node_revisions.title, node_revisions.summary, node_revisions.content, node_revisions.format, node_revisions.author, nodes.publish, nodes.created, node_revisions.changed, node_revisions.status FROM nodes INNER JOIN node_revisions ON nodes.nid = node_revisions.nid WHERE nodes.nid = :nid AND node_revisions.revision < :revision ORDER BY node_revisions.revision DESC;"
 			-- SQL query to get node revisions (missing the latest one).