Changed the way search modules get integrated with the theme via a new region "search".

Improved current module for google search 2.0.

examples/demo/site/modules/google_search_20/config/google_search_20.json

@@ -1,5 +0,0 @@
-{
-    "gcse": {
-     		"cx":""
-     }	
-}

examples/demo/site/modules/google_search_20/config/google_search_20.json-dist

@@ -1,5 +1,5 @@
 {
     "gcse": {
-     		"cx":""
+     		"search_engine_id":""
           }	
 }

examples/demo/site/modules/google_search_20/templates/block_gcse_search_form.tpl

@@ -0,0 +1,6 @@
+<form action="{$site_url/}gcse20" class="search-form" id="search-form">
+	<div class="form-group has-feedback">
+		<input type="search" class="form-control" name="q" id="search-query" placeholder="search" value="{htmlentities}{$cms_search_query/}{/htmlentities}" >
+		<span class="glyphicon glyphicon-search form-control-feedback"></span>
+	</div>
+</form>

examples/demo/site/themes/bootstrap/page.tpl

@@ -37,17 +37,14 @@
           {$page.primary_nav/}
       {/if}
     </div> 
+	{if isset="$page.regions.search"}
 	<!-- Page search -->
 	<div class="row">
 		<div class="col-md-2 col-md-offset-9">
-			<form action="{$site_url/}gcse20" class="search-form" id="gcse_search_form">
+			{$page.regions.search/}
-				<div class="form-group has-feedback">
-					<input type="search" class="form-control" name="q" id="gcse_search" placeholder="search" value="{htmlentities}{$cms_search_query/}{/htmlentities}" >
-					<span class="glyphicon glyphicon-search form-control-feedback"></span>
-				</div>
-			</form>
 		</div>
 	</div>
+	{/if}
     <!-- General Page Content -->
     <div id='content' class='row-fluid'>
 		<!-- Left Sidebar sidebar_first -->

examples/demo/site/themes/bootstrap/search.tpl

@@ -0,0 +1,6 @@
+			<form action="{$site_url/}search" class="search-form" id="search-form">
+				<div class="form-group has-feedback">
+					<input type="search" class="form-control" name="q" id="search-query" placeholder="search" value="{htmlentities}{$cms_search_query/}{/htmlentities}" >
+					<span class="glyphicon glyphicon-search form-control-feedback"></span>
+				</div>
+			</form>

examples/demo/site/themes/bootstrap/theme.info

@@ -4,6 +4,7 @@ author=jvelilla
 version=0.1
 regions[page_top] = Top
 regions[header] = Header
+regions[search] = Search
 regions[content] = Content
 regions[highlighted] = Highlighted
 regions[help] = Help

modules/google_search_20/Readme.md

@@ -1,5 +1,13 @@
 Google Custom Search Module 2.0.
 
-https://developers.google.com/custom-search/docs/element
+# Based on Google Custom Search Engine (CSE)
-The current solution is based on
+- https://developers.google.com/custom-search/docs/element
-Results only <gcse:searchresults-only>
+- Search form provides a parameter `q` for the search query.
+- Results are displayed in associated page /gcse2 (using <gcse:searchresults-only> )
+
+# Settings
+- edit the `site/modules/google_search_20/config/google_search_20.json` file, and set the value `gcse.search_engine_id`.
+
+# How to get a Custom Search engine ID?
+- See https://support.google.com/customsearch/answer/2649143?hl=en
+- https://cse.google.com/all

modules/google_search_20/site/config/google_search_20.json-dist

@@ -0,0 +1,5 @@
+{
+    "gcse": {
+     		"search_engine_id":""
+          }	
+}

modules/google_search_20/site/templates/block_gcse_search_form.tpl

@@ -0,0 +1,6 @@
+<form action="{$site_url/}gcse20" class="search-form" id="search-form">
+	<div class="form-group has-feedback">
+		<input type="search" class="form-control" name="q" id="search-query" placeholder="search" value="{htmlentities}{$cms_search_query/}{/htmlentities}" >
+		<span class="glyphicon glyphicon-search form-control-feedback"></span>
+	</div>
+</form>

modules/google_search_20/site/templates/block_gcse_search_results.tpl

@@ -1,6 +1,6 @@
 <section>
   <header>
-    <h2>Results for <kbd>{$result.current_page.search_terms/}</kbd></h2>
+    <h2>Results for <kbd>{$cms_search_query/}</kbd></h2>
   </header>
   
    <gcse:searchresults-only></gcse:searchresults-only>

modules/google_search_20/src/google_custom_search_module_20.e

@@ -9,7 +9,6 @@ class
 	GOOGLE_CUSTOM_SEARCH_MODULE_20
 
 inherit
-
 	CMS_MODULE
 		redefine
 			setup_hooks
@@ -19,7 +18,7 @@ inherit
 
 	REFACTORING_HELPER
 
-	CMS_HOOK_RESPONSE_ALTER
+	CMS_HOOK_BLOCK
 
 	CMS_HOOK_BLOCK_HELPER
 
@@ -64,13 +63,13 @@ feature -- Router
 feature -- GCSE Keys
 
 	gcse_cx_key (api: CMS_API): detachable READABLE_STRING_8
-			-- Get google custom search cx key.
+			-- Get google custom search engine id.
 		local
 			utf: UTF_CONVERTER
 		do
 			if attached api.module_configuration (Current, Void) as cfg then
 				if
-					attached cfg.text_item ("gcse.cx") as l_gcse_cx_key and then
+					attached cfg.text_item ("gcse.search_engine_id") as l_gcse_cx_key and then
 					not l_gcse_cx_key.is_empty
 				then
 					Result := utf.utf_32_string_to_utf_8_string_8 (l_gcse_cx_key)
@@ -83,6 +82,8 @@ feature -- Handler
 	handle_search (api: CMS_API; req: WSF_REQUEST; res: WSF_RESPONSE)
 		local
 			r: CMS_RESPONSE
+			l_script: STRING
+			b: CMS_CONTENT_BLOCK
 		do
 			write_debug_log (generator + ".handle_search")
 			create {GENERIC_VIEW_CMS_RESPONSE} r.make (req, res, api)
@@ -95,9 +96,16 @@ feature -- Handler
 				then
 					r.set_value (l_query.value, "cms_search_query")
 					if
-						attached smarty_template_block (Current, "search", api) as l_tpl_block
+						attached smarty_template_block (Current, "gcse_search_results", api) as l_tpl_block
 					then
 						r.add_block (l_tpl_block, "content")
+
+						if attached gcse_cx_key (api) as l_ctx then
+							create l_script.make_from_string (gcse_20_script)
+							l_script.replace_substring_all ("#CX_VALUE", l_ctx)
+							create b.make_raw ("gcse2_js", Void, "<script>%N" + l_script + "%N</script>", Void)
+							r.add_block (b, "footer")
+						end
 					end
 				end
 			else
@@ -106,7 +114,6 @@ feature -- Handler
 			r.execute
 		end
 
-
 feature -- Hooks configuration
 
 	setup_hooks (a_hooks: CMS_HOOK_CORE_MANAGER)
@@ -115,18 +122,25 @@ feature -- Hooks configuration
 			auto_subscribe_to_hooks (a_hooks)
 		end
 
-	response_alter (a_response: CMS_RESPONSE)
+	block_list: ITERABLE [like {CMS_BLOCK}.name]
-			-- <Precursor>
-		local
-			l_script: STRING
 		do
-			if attached gcse_cx_key (a_response.api) as l_ctx then
+			Result := <<"gcse_search_form">>
-				create l_script.make_from_string (gcse_20_script)
-				l_script.replace_substring_all ("#CX_VALUE", l_ctx)
-				a_response.add_javascript_content (l_script)
-			end
 		end
 
+	get_block_view (a_block_id: READABLE_STRING_8; a_response: CMS_RESPONSE)
+		do
+			if a_block_id.is_case_insensitive_equal_general ("gcse_search_form") then
+				if a_response.request.is_get_request_method then
+					if attached smarty_template_block (Current, a_block_id, a_response.api) as l_tpl_block then
+						a_response.add_block (l_tpl_block, "search")
+					else
+						debug ("cms")
+							a_response.add_warning_message ("Error with block [" + a_block_id + "]")
+						end
+					end
+				end
+			end
+		end
 
 feature {NONE} -- Implementation
 
@@ -134,9 +148,9 @@ feature {NONE} -- Implementation
 			  (function() {
 			    var cx = '#CX_VALUE';
 			    var gcse = document.createElement('script'); gcse.type = 'text/javascript'; gcse.async = true;
-			    gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+			    gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
-			        '//www.google.com/cse/cse.js?cx=' + cx;
+			    var s = document.getElementsByTagName('script')[0]; 
-			    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(gcse, s);
+			    s.parentNode.insertBefore(gcse, s);
 			  })();
 			]"
 end