Renamed module name to google_search (custom_search)

Clean code. Updated google custom search to handle quota limit and no query submit. Updated encoding issues for input searches: like "void safe" and "void + safe".
2015-10-14 11:51:59 -03:00
parent 454d92f85b
commit 9263f31521
18 changed files with 435 additions and 256 deletions
--- a/modules/google_search/Readme.md
+++ b/modules/google_search/Readme.md
@@ -0,0 +1 @@
+Google Custom Search Module.
--- a/modules/google_search/google_search.ecf
+++ b/modules/google_search/google_search.ecf
@@ -0,0 +1,18 @@
+<?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="google_search" uuid="054E9C5C-ACCB-4A4D-B825-6C574AEC30A9" library_target="google_search">
+	<target name="google_search">
+		<root all_classes="true"/>
+		<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
+		<library name="cms" location="$ISE_LIBRARY\unstable\library\web\cms\cms-safe.ecf" readonly="false"/>
+		<library name="cms_app_env" location="$ISE_LIBRARY\unstable\library\web\cms\library\app_env\app_env-safe.ecf" readonly="false"/>
+		<library name="cms_config" location="$ISE_LIBRARY\unstable\library\web\cms\library\configuration\config-safe.ecf"/>
+		<library name="error" location="$ISE_LIBRARY\contrib\library\utility\general\error\error-safe.ecf"/>
+		<library name="google_cse" location="..\..\library\gcse\gcse-safe.ecf"/>
+		<library name="http" location="$ISE_LIBRARY\contrib\library\network\protocol\http\http-safe.ecf"/>
+		<library name="net" location="$ISE_LIBRARY\library\net\net-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"/>
+		<library name="wsf_encoder" location="$ISE_LIBRARY\contrib\library\web\framework\ewf\text\encoder\encoder-safe.ecf"/>
+		<cluster name="src" location="src\" recursive="true"/>
+	</target>
+</system>
--- a/modules/google_search/site/config/google_search.json
+++ b/modules/google_search/site/config/google_search.json
@@ -0,0 +1,6 @@
+{
+    "gcse": {
+     		"cx":"",
+     		"secret_key":""
+     }	
+}
--- a/modules/google_search/site/templates/block_search.tpl
+++ b/modules/google_search/site/templates/block_search.tpl
@@ -0,0 +1,40 @@
+<section>
+  <header>
+    <h2>Results for <kbd>{$result.current_page.search_terms/}</kbd></h2>
+  </header>
+  
+  <!-- list of results -->
+  <ol start="{$result.current_page.start_index/}">
+  
+    <!-- Item result -->
+    {foreach from="$result.items" item="item"}
+    <li>
+      <article>
+        <header>
+          <h3>
+            <cite>
+              <a href="{$item.link/}">{$item.title/}</a>
+            </cite>
+          </h3>
+        </header>
+        <blockquote cite="{$item.link/}">
+          <p>{$item.html_snippet/}</p>
+          <footer>
+            <p><abbr title="Uniform Resource Locator">Source</abbr> <a href="{$item.link/}">{$item.display_link/}</a></p>
+          </footer>
+        </blockquote>
+      </article>
+    </li>
+    {/foreach} 
+
+    
+  </ol>  
+  <ul class="cms-page-links">
+      {if isset="$result.previous_page"}
+        <li><a href="{$site_url/}gcse/?q={$result.previous_page.search_terms/}&amp;start={$result.previous_page.start_index/}&amp;num={$result.previous_page.count/}">Previous</a></li>
+      {/if}
+      {if isset="$result.next_page"}
+        <li><a href="{$site_url/}gcse/?q={$result.next_page.search_terms/}&amp;start={$result.next_page.start_index/}&amp;num={$result.next_page.count/}">Next</a></li>
+      {/if}
+  </ul>
+</section>
--- a/modules/google_search/src/google_custom_search_module.e
+++ b/modules/google_search/src/google_custom_search_module.e
@@ -0,0 +1,150 @@
+note
+	description: "[
+			Module providing Google Custom Search functionality.
+		]"
+	date: "$Date: 2015-10-09 20:50:01 -0300 (vi. 09 de oct. de 2015) $"
+	revision: "$Revision: 97982 $"
+
+class
+	GOOGLE_CUSTOM_SEARCH_MODULE
+
+inherit
+
+	CMS_MODULE
+
+	CMS_HOOK_BLOCK_HELPER
+
+	SHARED_EXECUTION_ENVIRONMENT
+		export
+			{NONE} all
+		end
+
+	REFACTORING_HELPER
+
+	SHARED_LOGGER
+
+create
+	make
+
+feature {NONE} -- Initialization
+
+	make
+			-- Create current module
+		do
+			version := "1.0"
+			description := "Google custome search module"
+			package := "search"
+		end
+
+feature -- Access
+
+	name: STRING = "google_search"
+			-- <Precursor>
+
+feature -- Router
+
+	setup_router (a_router: WSF_ROUTER; a_api: CMS_API)
+			-- Router configuration.
+		do
+			a_router.handle ("/gcse", create {WSF_URI_AGENT_HANDLER}.make (agent handle_search (a_api, ?, ?)), a_router.methods_head_get)
+		end
+
+feature -- Recaptcha
+
+	gcse_secret_key (api: CMS_API): detachable READABLE_STRING_8
+			-- Get recaptcha security key.
+		local
+			utf: UTF_CONVERTER
+		do
+			if attached api.module_configuration (Current, Void) as cfg then
+				if
+					attached cfg.text_item ("gcse.secret_key") as l_recaptcha_key and then
+					not l_recaptcha_key.is_empty
+				then
+					Result := utf.utf_32_string_to_utf_8_string_8 (l_recaptcha_key)
+				end
+			end
+		end
+
+	gcse_cx_key (api: CMS_API): detachable READABLE_STRING_8
+			-- Get recaptcha security key.
+		local
+			utf: UTF_CONVERTER
+		do
+			if attached api.module_configuration (Current, Void) as cfg then
+				if
+					attached cfg.text_item ("gcse.cx") as l_recaptcha_key and then
+					not l_recaptcha_key.is_empty
+				then
+					Result := utf.utf_32_string_to_utf_8_string_8 (l_recaptcha_key)
+				end
+			end
+		end
+
+feature -- Handler
+
+	handle_search (api: CMS_API; req: WSF_REQUEST; res: WSF_RESPONSE)
+		local
+			r: CMS_RESPONSE
+			l_parameters:GCSE_QUERY_PARAMETERS
+			l_search: GCSE_API
+		do
+				-- TODO handle errors!!!
+			write_debug_log (generator + ".handle_search")
+			create {GENERIC_VIEW_CMS_RESPONSE} r.make (req, res, api)
+			if
+				attached {WSF_STRING} req.query_parameter ("q") as l_query and then
+				not l_query.value.is_empty
+			then
+				if
+					attached gcse_cx_key (api) as l_cx and then
+					attached gcse_secret_key (api) as l_key
+				then
+					create l_parameters.make (l_key, l_cx, l_query.url_encoded_value )
+					if
+						attached {WSF_STRING} req.query_parameter ("start") as l_index and then
+					  	attached {WSF_STRING} req.query_parameter ("num") as l_num
+					then
+						l_parameters.set_start (l_index.value)
+						l_parameters.set_num (l_num.value)
+					end
+					create l_search.make (l_parameters)
+					l_search.search
+					if
+						attached l_search.last_result as l_result and then
+					    l_result.status = 200
+					then
+						if attached template_block (Current, "search", r) as l_tpl_block then
+							l_tpl_block.set_value (l_result, "result")
+							r.add_block (l_tpl_block, "content")
+						end
+					else
+							-- Quota limit (403 status code) or not results.
+						google_search_site (req, r,  l_query)
+					end
+				else
+						-- If no key are provided, at least output google search result page.
+					google_search_site (req, r,  l_query)
+				end
+			else
+				r.add_message ("No query submitted", Void)
+			end
+			r.execute
+		end
+
+feature {NONE} -- Helper
+
+	google_search_site (req: WSF_REQUEST; res: CMS_RESPONSE; query: WSF_STRING)
+			-- Workaround to output google search result page
+			-- If no key are provided or if GCSE reached the quota limit.
+		local
+			l_url_encoder: URL_ENCODER
+		do
+			create l_url_encoder
+			if req.is_https then
+				res.set_redirection ("https://www.google.com/search?sitesearch=" + l_url_encoder.general_encoded_string (res.absolute_url ("", Void)) + "&q=" + query.url_encoded_value)
+			else
+				res.set_redirection ("http://www.google.com/search?sitesearch=" + l_url_encoder.general_encoded_string (res.absolute_url ("", Void)) + "&q=" + query.url_encoded_value)
+			end
+		end
+end