New feature: add Google Custom Search into gsearch folder

git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@133 b3834d28-1941-0410-a4f8-b48e95affb8f

api/export_gcs.php

@@ -16,7 +16,11 @@ if(!$userservice->isAdmin($userservice->getCurrentUserId())) {
     die(T_('You are not allowed to do this action (admin access)'));
 }*/
 
-
+// Check if queried format is xml
+if (isset($_REQUEST['xml']) && (trim($_REQUEST['xml']) == 1))
+    $xml = true;
+else
+    $xml = false;
 
 // Check to see if a tag was specified.
 if (isset($_REQUEST['tag']) && (trim($_REQUEST['tag']) != ''))
@@ -31,10 +35,25 @@ $currentuser = $userservice->getCurrentUser();
 $currentusername = $currentuser[$userservice->getFieldName('username')];
 
 // Set up the plain file and output all the posts.
+header('Content-Type: text/plain');
+if(!$xml) {
     header('Content-Type: text/plain');
     foreach($bookmarks['bookmarks'] as $row) {
 	echo $row['bAddress']."\n";
     }
-
+} else {
+    header('Content-Type: application/xml');
+    echo '<GoogleCustomizations>'."\n";
+    echo '  <Annotations>'."\n";
+    foreach($bookmarks['bookmarks'] as $row) {
+	if(substr($row['bAddress'], 0, 7) == "http://") {
+	    echo '    <Annotation about="'.filter($row['bAddress']).'">'."\n";
+	    echo '      <Label name="include"/>'."\n";
+	    echo '    </Annotation>'."\n";
+	}
+    }
+    echo '  </Annotations>'."\n";
+    echo '</GoogleCustomizations>'."\n";
+}
 
 ?>

config.inc.php.example

@@ -9,7 +9,7 @@
 #### System ####
 $sitename           = 'SemanticScuttle'; #The name of this site.
 $welcomeMessage     = 'Welcome to SemanticScuttle! More than a social bookmarking tool.'; # The welcome message of this site
-$root               = NULL; # Set to NULL to autodetect the root url of the website
+$root               = NULL; # Set to NULL to autodetect the root url of the website. If your installation is into a subdirectory like "www.example.com/semanticscuttle/" then replace NULL by your address (between "" and with final '/');
 $locale             = 'en_GB'; #locale used in /locales/ {de_DE  en_GB  fr_FR  ...}
 $usecache           = false; # use cache ? {true,false}
 $dir_cache          = dirname(__FILE__) .'/cache/'; # directory where cache files will be stored
@@ -77,6 +77,7 @@ $maxSizeMenuBlock = 7; # maximum number of items (tags) appearing into menu box
 
 ### Other ###
 $sizeSearchHistory = 10; # number of users' searches that are saved {1..10[Default]..-1[Unlimited]}
+$enableGoogleCustomSearch = true; #Enable Google Search Engine into "gsearch/" folder
 
 include_once('debug.inc.php');
 ?>

constants.inc.php

@@ -13,8 +13,7 @@ define('PAGE_BOOKMARKS', "bookmarks");
 
 // Miscellanous
 
-// INSTALLATION_ID is based on directory  path and used as prefix (in session and cookie) to prevent mutual login for different installations on the same host server
+// INSTALLATION_ID is based on directory DB and used as prefix (in session and cookie) to prevent mutual login for different installations on the same host server
-//define('INSTALLATION_ID', md5(dirname(realpath('.'))));
 define('INSTALLATION_ID', md5($GLOBALS['dbname'].$GLOBALS['tableprefix']));
 
 ?>

gsearch/context.php

@@ -0,0 +1,20 @@
+<?php require_once('../header.inc.php');?>
+
+<!--?xml version="1.0" encoding="UTF-8" ?-->
+<GoogleCustomizations>
+    <CustomSearchEngine>
+        <Title><?php echo $GLOBALS['sitename'] ?></Title>
+        <Description><?php echo $GLOBALS['welcomeMessage'] ?></Description>
+        <Context>
+           <BackgroundLabels>
+             <Label name="include" mode="FILTER" />
+          </BackgroundLabels>
+        </Context>
+        <LookAndFeel nonprofit="false">
+        </LookAndFeel>
+    </CustomSearchEngine>
+
+    <Include type="Annotations" href="<?php echo $GLOBALS['root'];?>api/export_gcs.php?xml=1" />
+
+
+</GoogleCustomizations>

gsearch/index.php

@@ -0,0 +1,36 @@
+<?php require_once('../header.inc.php');
+
+if($GLOBALS['enableGoogleCustomSearch']==false) {
+    echo "Google Custom Search disabled. You can enable it into the config.inc.php file.";
+    die;
+}
+?>
+
+<html>
+<title><?php echo $GLOBALS['sitename'] ?></title>
+<body>
+<center>
+<br />
+
+<!-- Google CSE Search Box Begins  -->
+<form id="cref" action="http://www.google.com/cse">
+  <input type="hidden" name="cref" value="<?php echo $GLOBALS['root']?>gsearch/context.php" />
+  <input type="text" name="q" size="40" />
+  <input type="submit" name="sa" value="Search" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cref"></script>
+<!-- Google CSE Search Box Ends -->
+<small>Based on <a href="http://www.google.com/coop/cse/">Google Custom Search</a> over this <a href="../api/export_gcs.php">list of websites</a> from <?php echo $GLOBALS['sitename'] ?>.</small>
+
+
+<!--
+To refresh manually Google Custom Search Engine, goes to: http://www.google.com/coop/cse/cref
+-->
+
+
+
+</center>
+</body>
+</html>
+
+

upgrade.txt

@@ -37,5 +37,7 @@
 	$sizeSearchHistory = 10;
   - add sidebar block index line:
 	$index_sidebar_blocks = array('search','menu','users','popular');
+  - add line:
+	$enableGoogleCustomSearch = true;