From b08b869b1c2b7714bcff0e165abd4032f0e997fe Mon Sep 17 00:00:00 2001
From: Brad Shuttleworth <brad@knowledgetree.com>
Date: Fri, 30 Sep 2005 15:19:29 +0000
Subject: [PATCH] first layer of the Boolean Search AJAX UI.

---
 presentation/lookAndFeel/knowledgeTree/js/constructed_search.js     | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 presentation/lookAndFeel/knowledgeTree/js/taillog.js                |  20 ++++++++++++++++++++
 presentation/lookAndFeel/knowledgeTree/search/ajaxBooleanSearch.php |  49 +++++++++++++++++++++++++++++++++++++++++++++++++
 presentation/lookAndFeel/knowledgeTree/search/booleanSearch.php     |  46 ++++++++++++++++++++++++++++++++++++++++++++++
 presentation/lookAndFeel/knowledgeTree/search/booleanSearchUtil.inc | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 templates/ktcore/boolean_search.smarty                              |  87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 6 files changed, 508 insertions(+), 0 deletions(-)
 create mode 100644 presentation/lookAndFeel/knowledgeTree/js/constructed_search.js
 create mode 100644 presentation/lookAndFeel/knowledgeTree/js/taillog.js
 create mode 100644 presentation/lookAndFeel/knowledgeTree/search/ajaxBooleanSearch.php
 create mode 100644 presentation/lookAndFeel/knowledgeTree/search/booleanSearch.php
 create mode 100644 presentation/lookAndFeel/knowledgeTree/search/booleanSearchUtil.inc
 create mode 100644 templates/ktcore/boolean_search.smarty

diff --git a/presentation/lookAndFeel/knowledgeTree/js/constructed_search.js b/presentation/lookAndFeel/knowledgeTree/js/constructed_search.js
new file mode 100644
index 0000000..65cd7c8
--- /dev/null
+++ b/presentation/lookAndFeel/knowledgeTree/js/constructed_search.js
@@ -0,0 +1,165 @@
+// simple event stacking.
+// i don't like Mochikit's one.
+
+function attachToElementEvent(elem, event_name, func) {
+    // catch IE (grumble)
+    if (elem.attachEvent) {
+        elem.attachEvent('on'+event_name, func);
+    } else {
+        elem.addEventListener(event_name, func, false);
+    }
+}
+
+function removeFromElementEvent(elem, event_name, func) {
+    // catch IE (grumble)
+    if (elem.detachEvent) {
+        elem.detachEvent('on'+event_name, func);
+    } else {
+        elem.removeEventListener(event_name, func, false);
+    }
+}
+
+// quick and dirty helper - find the nearest parent item matching tagName. 
+// FIXME steal the klass or tagName logic from MochiK.
+function breadcrumbFind(elem, tagName) {
+    var stopTag = 'BODY';
+    var currentTag = elem.tagName;
+    var currentElem = elem;
+    while ((currentTag != stopTag) && (currentTag != tagName)) {
+        currentElem = currentElem.parentNode;
+        currentTag = currentElem.tagName;
+    }
+    if (currentTag == tagName) { 
+        return currentElem; 
+    } else {
+        return null;
+    }
+}
+
+var autoIndexCriteria = Array();
+
+// initiate the criteria creation process.
+function addNewCriteria(add_button) {
+    var parent_row = breadcrumbFind(add_button, 'TR');
+    simpleLog('DEBUG','addNewCriteria found parent row: '+parent_row);
+    var select_source = parent_row.getElementsByTagName('select');
+    if (select_source.length == 0) {
+        simpleLog('ERROR','addNewCriteria found no criteria specification source.: '+parent_row);
+    } else {
+        var select = select_source[0];
+    }
+    var notify_source = parent_row.getElementsByTagName('p');    
+    if (notify_source.length == 0) {
+        simpleLog('ERROR','addNewCriteria found no message storage in row: '+parent_row);
+    } else {
+        var notify_message = notify_source[0];
+    }
+
+
+    // make this one identifiable.
+    autoIndexCriteria.push(0);
+    var critId = autoIndexCriteria.length;
+
+    // ok, warn the user that we're loading the item.
+    replaceChildNodes(notify_message, 'loading...');
+    var newCriteriaText = scrapeText(select.options[select.selectedIndex])+' '; // FIXME insert the "input" here.
+    replaceChildNodes(select.parentNode, newCriteriaText, INPUT({'type':'hidden', 'name':'boolean_search['+critId+'][\'type\']','value':select.value}));           // works thanks to DOM co-ercion.
+    createAdditionalCriteriaOption();
+    var removeButton = INPUT({'type':'button', 'value':'Remove'});
+    attachToElementEvent(removeButton, 'click', partial(removeCriteria, removeButton));
+    add_button.parentNode.replaceChild(removeButton, add_button);
+
+    
+    // fetch.
+    var dest_cell = notify_message.parentNode;
+    var targeturl='ajaxBooleanSearch.php?action=getNewCriteria&type='+select.value+'&critId='+critId;
+    simpleLog('DEBUG','addNewCriteria initiating request to: '+targeturl);
+    
+    var deferred = doSimpleXMLHttpRequest(targeturl); 
+    deferred.addCallbacks(partial(do_addNewCriteria, dest_cell, critId), handleAjaxError);
+}
+
+
+// FIXME multi-select items using PHP array[] syntax won't work.  we'd need to:
+//          - check for the presence of [ or ].  if so, use everything before [ as
+//            the key, and append everything after [.
+// actually replace the contents of the specified td with the responseText.
+function do_addNewCriteria(destination_cell, crit_id, req) { 
+    simpleLog('DEBUG','replacing content of cell with: \n'+req.responseText);
+    destination_cell.innerHTML = req.responseText; 
+    // whatever was passed in almost certainly has the wrong name, but that's what
+    // will be expected in the backend.  
+    // wrap it so we don't get clashes.
+
+    var inputs = destination_cell.getElementsByTagName('INPUT');
+    var selects = destination_cell.getElementsByTagName('SELECT');
+
+    for (var i=0; i<inputs.length; i++) {
+        var obj = inputs[i];
+        obj.name = "boolean_search["+crit_id+"]['data']['"+obj.name+"']";
+    }
+    for (var i=0; i<selects.length; i++) {
+        var obj = selects[i];
+        obj.name = "boolean_search["+crit_id+"]['data']['"+obj.name+"']";
+    }
+    simpleLog('DEBUG','criteria addition complete.');
+}
+function handleAjaxError(err) {
+    simpleLog('ERROR','ajax error: '+err);
+}
+
+
+function removeCriteria(removeButton) {
+    var parent_row = breadcrumbFind(removeButton, 'TR');
+    if (parent_row == null) {
+        simpleLog('ERROR','removeCriteria found no effective parent row.');
+    } else {
+        parent_row.parentNode.removeChild(parent_row);
+    }
+    simpleLog('DEBUG','criteria removed.');
+}
+
+function createAdditionalCriteriaOption() {
+    var tbody = getSearchContainer();
+    if (tbody == null) {
+        simpleLog('ERROR','createAdditionalCriteriaOption: No criteria table found.');
+        return null;        
+    }
+    
+    // now we need to instantiate the selection stuff.
+    // to do this we find a hidden div in the page which contains the container types...
+    var master_div = getElement('search-criteria-container');
+    if (master_div == null) {
+        simpleLog('ERROR','createAdditionalCriteriaOption: No criteria types identified within the request.');
+        return null;        
+    }    
+    
+    // clone, and append.
+    var clonedObject = master_div.getElementsByTagName('select')[0].cloneNode(true);
+    var select_entry = TD(null, clonedObject);
+    var notification_entry = TD(null, createDOM('P',{'class':'helpText'},'first select a type of query'));
+    var add_button = INPUT({'type':'button', 'value':'Add'});
+    attachToElementEvent(add_button, 'click', partial(addNewCriteria, add_button));
+    var add_entry = TD(null, add_button);
+    tbody.appendChild(TR(null, select_entry, notification_entry, add_entry));
+}
+
+function getSearchContainer() {
+    var container = getElement('advanced-search-form');
+    if (container == null) {
+        simpleLog('ERROR','No criteria table found.');
+        return null;
+    } else {
+        var innerContainer = container.getElementsByTagName('TBODY');
+    }
+
+    if (innerContainer.length == 0) {
+        simpleLog('ERROR','No criteria tbody found.');
+        return null;
+    } else {
+        var container = innerContainer[0];
+        delete innerContainer;
+    }
+    return container;
+}
+
diff --git a/presentation/lookAndFeel/knowledgeTree/js/taillog.js b/presentation/lookAndFeel/knowledgeTree/js/taillog.js
new file mode 100644
index 0000000..9d81740
--- /dev/null
+++ b/presentation/lookAndFeel/knowledgeTree/js/taillog.js
@@ -0,0 +1,20 @@
+/* 
+// once site is in production, rather use:
+
+function simpleLog(severity, item) { ; }
+
+*/
+
+// inline logger
+function simpleLog(severity,item) {
+    var logTable = getElement('brad-log');
+    if (logTable == null) return ;
+
+    // we have a table, do the log.
+    newRow = createDOM('TR', {'class':'logtable','valign':'top'},
+        TD({'class':'severity-'+severity}, severity),
+        TD({'class':'timestamp'},toISOTime(new Date())),
+        TD({'class':'explanation'}, item)
+    );
+    logTable.getElementsByTagName('tbody')[0].appendChild(newRow);
+}
diff --git a/presentation/lookAndFeel/knowledgeTree/search/ajaxBooleanSearch.php b/presentation/lookAndFeel/knowledgeTree/search/ajaxBooleanSearch.php
new file mode 100644
index 0000000..0da47a0
--- /dev/null
+++ b/presentation/lookAndFeel/knowledgeTree/search/ajaxBooleanSearch.php
@@ -0,0 +1,49 @@
+<?php
+require_once("../../../../config/dmsDefaults.php");
+require_once(KT_DIR . "/presentation/Html.inc");
+require_once(KT_LIB_DIR . "/templating/templating.inc.php");
+
+require_once(KT_LIB_DIR . "/database/dbutil.inc");
+require_once(KT_LIB_DIR . "/util/ktutil.inc");
+require_once(KT_LIB_DIR . "/dispatcher.inc.php");
+$sectionName = "General";
+require_once(KT_DIR . "/presentation/webpageTemplate.inc");
+
+require_once(KT_LIB_DIR . "/browse/Criteria.inc");
+
+/*
+ * example code - tests the frontend behaviour.  remember to check ajaxConditional.php 
+ * 
+ */
+
+class AjaxBooleanSearchDispatcher extends KTDispatcher {
+
+    function handle_output($data) {
+        return $data;
+    }
+    
+    function do_getNewCriteria() {
+        $criteriaType = KTUtil::arrayGet($_REQUEST, 'type');
+        if (empty($criteriaType)) {
+            return 'AJAX Error:  no criteria type specified.';
+        } 
+        $critObj = Criteria::getCriterionByNumber($criteriaType);
+        if (PEAR::isError($critObj)) {
+           return 'AJAX Error:  failed to initialise critiria of type "'.$type.'".';
+        }
+        // NBM:  there appears to be no reason to take $aRequest into searchWidget...
+        $noRequest = array();
+        return $critObj->searchWidget($noRequest);
+    }
+
+    function do_main() {
+        return "Ajax Error.  ajaxBooleanSearch::do_main should not be reachable."; 
+    }
+    
+    
+}
+
+$oDispatcher = new AjaxBooleanSearchDispatcher();
+$oDispatcher->dispatch();
+
+?>
diff --git a/presentation/lookAndFeel/knowledgeTree/search/booleanSearch.php b/presentation/lookAndFeel/knowledgeTree/search/booleanSearch.php
new file mode 100644
index 0000000..a4aa28a
--- /dev/null
+++ b/presentation/lookAndFeel/knowledgeTree/search/booleanSearch.php
@@ -0,0 +1,46 @@
+<?php
+
+// boilerplate includes
+require_once("../../../../config/dmsDefaults.php");
+require_once(KT_DIR . "/presentation/Html.inc");
+require_once(KT_LIB_DIR . "/templating/templating.inc.php");
+require_once(KT_LIB_DIR . "/database/dbutil.inc");
+require_once(KT_LIB_DIR . "/util/ktutil.inc");
+require_once(KT_LIB_DIR . "/dispatcher.inc.php");
+require_once(KT_LIB_DIR . "/browse/Criteria.inc");
+
+// specific includes
+
+$sectionName = "General";
+require_once(KT_DIR . "/presentation/webpageTemplate.inc");
+
+/*
+ * example code - tests the frontend behaviour.  remember to check ajaxConditional.php 
+ * 
+ */
+
+class BooleanSearchDispatcher extends KTStandardDispatcher {
+   function do_main() {
+        $oTemplating = new KTTemplating;
+        $oTemplate = $oTemplating->loadTemplate("ktcore/boolean_search");
+        
+        $aCriteria = Criteria::getAllCriteria();
+        
+        $aTemplateData = array(
+            "aCriteria" => $aCriteria,
+        );
+        return $oTemplate->render($aTemplateData);
+    }
+
+    function handleOutput($data) {
+        global $main;
+        $main->bFormDisabled = true;
+        $main->setCentralPayload($data);
+        $main->render();
+    }
+}
+
+$oDispatcher = new BooleanSearchDispatcher();
+$oDispatcher->dispatch();
+
+?>
diff --git a/presentation/lookAndFeel/knowledgeTree/search/booleanSearchUtil.inc b/presentation/lookAndFeel/knowledgeTree/search/booleanSearchUtil.inc
new file mode 100644
index 0000000..ae7fdfb
--- /dev/null
+++ b/presentation/lookAndFeel/knowledgeTree/search/booleanSearchUtil.inc
@@ -0,0 +1,141 @@
+<?php
+/**
+ * $Id$
+ *
+ * Business logic related to Boolean Search.  This allows client-side construction
+ * of complex searches.
+ *
+ * Copyright (c) 2005 Jam Warehouse http://www.jamwarehouse.com
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * @version $Revision$
+ * @author Brad Shuttleworth, Jam Warehouse (Pty) Ltd, South Africa
+ * @package search
+ */
+
+/*   getBooleanSearchResults.
+ *
+ *   What gets passed in from the Ajax generated environment looks as follows:
+ *     boolean_search[x] = array();           // x is a client-side generated index for the criterion.
+ *     boolean_search[x]["type"] = Criterion::getID; // straight out, so none of this "bumpf".
+ *     boolean_search[x]["data"] = array();
+ *     boolean_search[x]["data"][y] = value; // where "y" is whatever-the-hell each thing is. essentially, pass boolean_search[x]["data"] as $aRequest;. 
+ */
+
+function getBooleanSearchResults($aOrigReq, $iStartIndex) {
+    global $default;
+
+    $sRefreshMessage = "<table><tr><td align=\"center\">" . _("If your browser displays a 'Warning: Page has Expired' message when you attempt to return to these search results, please click your browser's 'Refresh' button") . "</td></tr></table>";
+
+    $aReq = array();
+    foreach ($aOrigReq as $k => $v) {
+        if (searchCriteria($k) === 1) {
+            $v = trim($v);
+            if ($v === "") {
+                continue;
+            }
+            if ($v === "-1") {
+                continue;
+            }
+            $aReq[$k] = $v;
+        }
+    }
+
+    $aIDs = array_unique(array_map("criteriaNumber", array_keys($aReq)));
+    $aSQL = array();
+    $aJoinSQL = array();
+    foreach ($aIDs as $iID) {
+        $oCriterion =& Criteria::getCriterionByNumber($iID);
+        $res = $oCriterion->searchSQL($aReq);
+        if (!is_null($res)) {
+            $aSQL[] = $res;
+        }
+        $res = $oCriterion->searchJoinSQL();
+        if (!is_null($res)) {
+            $aJoinSQL[] = $res;
+        }
+    }
+    $aCritParams = array();
+    $aCritQueries = array();
+    foreach ($aSQL as $sSQL) {
+        if (is_array($sSQL)) {
+            $aCritQueries[] = $sSQL[0];
+            $aCritParams = array_merge($aCritParams , $sSQL[1]);
+        } else {
+            $aCritQueries[] = $sSQL;
+        }
+    }
+
+    if (count($aCritQueries) == 0) {
+        return "No search criteria were specified";
+    }
+
+    $sSQLSearchString = join(" AND ", $aCritQueries);
+    $sJoinSQL = join(" ", $aJoinSQL);
+
+    $sToSearch = KTUtil::arrayGet($aOrigReq, 'fToSearch', 'Live');
+
+    $sQuery = DBUtil::compactQuery("
+SELECT
+    F.name AS folder_name, F.id AS folder_id, D.id AS document_id,
+    D.name AS document_name, D.filename AS file_name, COUNT(D.id) AS doc_count, 'View' AS view
+FROM
+    $default->documents_table AS D
+    INNER JOIN $default->folders_table AS F ON D.folder_id = F.id
+    $sJoinSQL
+    INNER JOIN $default->search_permissions_table AS SDUL ON SDUL.document_id = D.id
+    INNER JOIN $default->status_table AS SL on D.status_id=SL.id
+WHERE
+	(F.is_public OR
+    SDUL.user_id = ?)
+    AND SL.name = ?
+    AND ($sSQLSearchString)
+GROUP BY D.id
+ORDER BY doc_count DESC");
+
+    $aParams = array();
+    $aParams[] = $_SESSION["userID"];
+    $aParams[] = $sToSearch;
+    $aParams = array_merge($aParams, $aCritParams);
+
+    //var_dump(DBUtil::getResultArray(array($sQuery, $aParams)));
+    //exit(0);
+
+    $aColumns = array("folder_name", "file_name", "document_name", "doc_count", "view");
+    $aColumnTypes = array(3,3,3,1,3);
+    $aColumnHeaders = array("<font color=\"ffffff\"><img src=$default->graphicsUrl/widgets/dfolder.gif>" . _("Folder") . "</font>", "<font color=\"ffffff\">" . _("Name") . "</font>", "<font color=\"ffffff\">" . _("Title") . "</font>", "<font color=\"ffffff\">" . _("Matches") . "</font>", "<font color=\"ffffff\">" . _("View") . "</font>");
+    $aLinkURLs = array("$default->rootUrl/control.php?action=browse","$default->rootUrl/control.php?action=viewDocument", "$default->rootUrl/control.php?action=viewDocument", null, "$default->rootUrl/control.php?action=downloadDocument");
+    $aDBQueryStringColumns = array("document_id","folder_id");
+    $aQueryStringVariableNames = array("fDocumentID", "fFolderID");
+
+    $oPatternBrowse = & new PatternBrowseableSearchResults(array($sQuery, $aParams), 10, $aColumns, $aColumnTypes, $aColumnHeaders, $aLinkURLs, $aDBQueryStringColumns, $aQueryStringVariableNames);
+    $oPatternBrowse->setStartIndex($iStartIndex);
+    $oPatternBrowse->setSearchText("");
+    $oPatternBrowse->setRememberValues($aReq);
+    $sForSearch = "<input type=\"hidden\" name=\"fForSearch\" value=\"1\" />";
+
+    return renderHeading(_("Advanced Search")) . $oPatternBrowse->render() . $sForSearch . $sRefreshMessage;
+}
+
+function dealWithAdvancedSearch($aReq, $iStartIndex) {
+    global $main;
+    $oPatternCustom = & new PatternCustom();
+    $oPatternCustom->setHtml(getAdvancedSearchResults($aReq, $iStartIndex));
+    $main->setCentralPayload($oPatternCustom);				                                
+    $main->render();
+}
+
+?>
diff --git a/templates/ktcore/boolean_search.smarty b/templates/ktcore/boolean_search.smarty
new file mode 100644
index 0000000..2254a56
--- /dev/null
+++ b/templates/ktcore/boolean_search.smarty
@@ -0,0 +1,87 @@
+<!-- NBM: FIX THE TEMPLATING SYSTEM -->
+
+<script language="javascript" src="/thirdpartyjs/MochiKit/Base.js"> </script>
+<script language="javascript" src="/thirdpartyjs/MochiKit/DateTime.js"> </script>
+<script language="javascript" src="/thirdpartyjs/MochiKit/Iter.js"> </script>
+<script language="javascript" src="/thirdpartyjs/MochiKit/DOM.js"> </script>
+<script language="javascript" src="/thirdpartyjs/MochiKit/Async.js"> </script>
+<script language="javascript" src="/presentation/lookAndFeel/knowledgeTree/js/taillog.js"> </script>
+<script language="javascript" src="/presentation/lookAndFeel/knowledgeTree/js/constructed_search.js"> </script>
+
+{literal}
+
+<script type="text/javascript">
+function testStartup() {
+    simpleLog('INFO','Log initialised.');
+}
+
+addLoadEvent(testStartup);
+</script>
+
+<style>
+
+fieldset { border: 1px dotted #999; }
+legend { border: 1px dotted #999;}
+
+.helpText { color: #666; }
+
+/*   logging support */
+#brad-log thead th { border-bottom: 1px solid black; }
+#brad-log {font-size: smaller; }
+#brad-log .severity-INFO { color: blue; font-weight: bold; }
+#brad-log .severity-DEBUG { color: green; font-weight: bold; }
+#brad-log .severity-ERROR { color: red; font-weight: bold; }
+#brad-log .explanation { font-family: monospace; white-space: pre; }
+
+</style>
+
+{/literal}
+
+<!-- this is bad, but we really don't need a roundtrip -->
+<div style="display: none" id="search-criteria-container">
+    <select name="querytype">
+        {foreach item=oCriteria from=$aCriteria}
+        <option value="{$oCriteria->getID()}">{$oCriteria->headerDisplay()}</option>
+        {/foreach}
+    </select>
+</div>
+
+<h2>Advanced Search</h2>
+
+<form>
+    <fieldset>
+        <legend>Hello World.</legend>
+
+        <p class="helpText">Return items which match &nbsp;<select name="boolean_condition"><option value="AND">all</option><option value="OR">any</option></select> of the criteria specified.</p>
+
+        <table id="advanced-search-form">
+            <tbody>
+                <tr>
+                    <td><select name="querytype">
+                         {foreach item=oCriteria from=$aCriteria}
+                             <option value="{$oCriteria->getID()}">{$oCriteria->headerDisplay()}</option>
+                        {/foreach}
+                        </select>
+                        </td>
+                    <td><p class="helpText">first select a type of query</p></td>
+                    <td><input type="button" value="Add" onclick="addNewCriteria(this);" /></td>                    
+                </tr>
+            </tbody>
+        </table>
+
+    </fieldset>
+</form>
+<!--
+<table id="brad-log" width="100%">
+<thead>
+    <tr>
+        <th width="10%">Severity</th>
+        <th width="10%">Time</th>
+        <th>Entry</th>
+    </tr>
+</thead>
+<tbody>
+   
+</tbody>
+</table>
+-->
\ No newline at end of file
--
libgit2 0.21.4