saved searches complete, + title support.

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4583 c91229c3-7414-0410-bfa2-8a42b809f60b

saved searches complete, + title support.
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4583 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent b9e8879e
Showing 5 changed files with 367 additions and 24 deletions
lib/browse/Criteria.inc
plugins/ktcore/KTCorePlugin.php
plugins/ktcore/admin/savedSearch.php
resources/js/constructed_search_postprocess.js
templates/ktcore/boolean_search_edit.smarty
@@ -157,8 +157,16 @@ class BrowseCriterion {
         return "<tr><td>" . $this->headerDisplay() . ": </td><td>" . $this->searchWidget($aRequest) . "</td></tr>\n";
     }
-    function searchWidget ($aRequest) {
-        return "<input type=\"text\" size=\"50\" name=\"" . $this->getWidgetBase() . "\" />";
+    function searchWidget ($aRequest, $aPreValue = null) {
+        if ($aPreValue != null) {
+            // !#@&)*( (*&!@# *(&@!(*&!@#
+            $k = array_keys($aPreValue);
+            $k = $k[0];
+            $preval = $aPreValue[$k];
+            return "<input type=\"text\" size=\"50\" name=\"" . $this->getWidgetBase() . "\" value=\"" . $preval . "\"/>";
+        } else {
+            return "<input type=\"text\" size=\"50\" name=\"" . $this->getWidgetBase() . "\" />";
+        }
     }
     function getWidgetBase () {
@@ -255,12 +263,21 @@ class CreatorCriterion extends BrowseCriterion {
     function folderDisplay($oFolder) {
         return $this->documentDisplay($oFolder);
     }
-    function searchWidget ($aRequest) {
+    function searchWidget ($aRequest, $aPreValue = null) {
+        $preval = null;
+        if ($aPreValue != null) {
+            // !#@&)*( (*&!@# *(&@!(*&!@#
+            $k = array_keys($aPreValue);
+            $k = $k[0];
+            $preval = $aPreValue[$k];
+        }
         $sRet = "<select size=\"1\" name=\"" . $this->getWidgetBase() . "\">\n";
         $aUsers = User::getList();/*ok*/
         $sRet .= "<option value=\"-1\">None</option>\n";
         foreach ($aUsers as $oUser) {
-            $sRet .= "<option value=\"" . $oUser->getID() . "\">" . $oUser->getName() . "</option>\n";
+            $sSelStr = '';
+            if ($preval == $oUser->getId()) { $sSelStr = ' selected="true"'; }
+            $sRet .= "<option value=\"" . $oUser->getID() . "\"" . $sSelStr . ">" . $oUser->getName() . "</option>\n";
         }
         $sRet .= "</select>\n";
         return $sRet;
@@ -274,15 +291,10 @@ class DateCreatedCriterion extends BrowseCriterion {
     function getName() {
         return "created";
     }
-    function searchWidget ($aRequest) {
+    function searchWidget ($aRequest, $aPreValue = null) {
         global $default;
-        //  this is not ideal, but we don't actually have access to the 
-        // dispatcher's oPage object.
-        
-        // even worse, we may _not_ have the items we want.
-        
-        global $main;
+        // IMPORTANT:  this requires the presence of kt3-calendar.js
         $sStartWidget = $this->getWidgetBase() . "_start";
         $sEndWidget = $this->getWidgetBase() . "_end";
@@ -292,8 +304,8 @@ class DateCreatedCriterion extends BrowseCriterion {
         $sToRender .= " &nbsp; Before date: <input type=\"text\" size=\"10\" name=\"" . $sEndWidget . "\" />";
         $sToRender .= "&nbsp;&nbsp;<a href=\"javascript:show_calendar('MainForm." . $sEndWidget . "',null,null,'YYYY-MM-DD', false);\" onmouseover=\"window.status='Date Picker';return true;\" onmouseout=\"window.status='';return true;\"><img src=\"$default->graphicsUrl/calendar/calendar.gif\" name=\"imgCalendar\" width=\"34\" height=\"21\" border=\"0\" alt=\"\"></a>";
         */
-        $sToRender = 'After Date: <span class="kt_calendar_holder"><strong class="kt_calendar_datetext">No Date Selected</strong><input type="hidden" name="' . $sStartWidget . '" class="kt_calendar_value" /> <input type="button" onclick="init_kt_calendar(this);" value="select"></span> &mdash; ';
-        $sToRender .= 'Before Date: <span class="kt_calendar_holder"><strong class="kt_calendar_datetext">No Date Selected</strong><input type="hidden" name="' . $sEndWidget . '" class="kt_calendar_value" /> <input type="button" onclick="init_kt_calendar(this);" value="select"></span><br />';
+        $sToRender = 'After Date: <span class="kt_calendar_holder"><strong class="kt_calendar_datetext">' . $aPreValue[$sStartWidget] . '</strong><input type="hidden" name="' . $sStartWidget . '" class="kt_calendar_value" value="' . $aPreValue[$sStartWidget] . '"/> <input type="button" onclick="init_kt_calendar(this);" value="select"></span> &mdash; ';
+        $sToRender .= 'Before Date: <span class="kt_calendar_holder"><strong class="kt_calendar_datetext">' . $aPreValue[$sStartWidget] . '</strong><input type="hidden" name="' . $sEndWidget . '" class="kt_calendar_value" value="' . $aPreValue[$sEndWidget] . '"/> <input type="button" onclick="init_kt_calendar(this);" value="select"></span><br />';
         return $sToRender;
     }
     function searchSQL ($aRequest) {
@@ -338,12 +350,21 @@ class DocumentTypeCriterion extends BrowseCriterion {
         }
         return "&nbsp;";
     }
-    function searchWidget ($aRequest) {
+    function searchWidget ($aRequest, $aPreValue = null) {
+        $preval = null;
+        if ($aPreValue != null) {
+            // !#@&)*( (*&!@# *(&@!(*&!@#
+            $k = array_keys($aPreValue);
+            $k = $k[0];
+            $preval = $aPreValue[$k];
+        }
         $sRet = "<select size=\"1\" name=\"" . $this->getWidgetBase() . "\">\n";
         $aUsers = DocumentType::getList();/*ok*/
         $sRet .= "<option value=\"-1\">None</option>\n";
         foreach ($aUsers as $oUser) {
-            $sRet .= "<option value=\"" . $oUser->getID() . "\">" . $oUser->getName() . "</option>\n";
+            $sSelStr = '';
+            if ($preval == $oUser->getId()) { $sSelStr = ' selected="true"'; }
+            $sRet .= "<option value=\"" . $oUser->getID() . "\"" . $sSelStr . ">" . $oUser->getName() . "</option>\n";
         }
         $sRet .= "</select>\n";
         return $sRet;
@@ -392,10 +413,17 @@ class GenericMetadataCriterion extends BrowseCriterion {
         return $this->aLookup['field'];
     }
-    function searchWidget ($aRequest) {
+    function searchWidget ($aRequest, $aPreValue = null) {
+        $preval = null;
+        if ($aPreValue != null) {
+            // !#@&)*( (*&!@# *(&@!(*&!@#
+            $k = array_keys($aPreValue);
+            $k = $k[0];
+            $preval = $aPreValue[$k];
+        }
         // If there's no lookup, just use the standard text input
         if ($this->oField->getHasLookup() == false) {
-            return parent::searchWidget($aRequest);
+            return parent::searchWidget($aRequest, $aPreValue);
         }
         $sRet = "<select size=\"1\" name=\"" . $this->getWidgetBase() . "\">\n";
@@ -403,7 +431,9 @@ class GenericMetadataCriterion extends BrowseCriterion {
         $aMetaData = MetaData::getList($aSearch);/*ok*/
         $sRet .= "<option value=\"-1\">None</option>\n";
         foreach ($aMetaData as $oMetaData) {
-            $sRet .= "<option value=\"" . $oMetaData->getName() . "\">" . $oMetaData->getName() . "</option>\n";
+            $sSelStr = '';
+            if ($preval == $oMetaData->getName()) { $sSelStr = ' selected="true"'; }
+            $sRet .= "<option value=\"" . $oMetaData->getName() . "\" " . $sSelStr . ">" . $oMetaData->getName() . "</option>\n";
         }
         $sRet .= "</select>\n";
         return $sRet;
@@ -498,13 +528,23 @@ class WorkflowStateCriterion extends BrowseCriterion {
         return "INNER JOIN $default->workflow_documents_table AS WD ON D.id = WD.document_id";
     }
-    function searchWidget ($aRequest) {
+    function searchWidget ($aRequest, $aPreValue = null) {
+        $preval = null;
+        if ($aPreValue != null) {
+            // !#@&)*( (*&!@# *(&@!(*&!@#
+            $k = array_keys($aPreValue);
+            $k = $k[0];
+            $preval = $aPreValue[$k];
+        }
+        
         $sRet = "<select size=\"1\" name=\"" . $this->getWidgetBase() . "\">\n";
         $aStates = KTWorkflowState::getList("ORDER BY workflow_id");
         $sRet .= "<option value=\"-1\">None</option>\n";
         foreach ($aStates as $oState) {
             $oWorkflow =& KTWorkflow::get($oState->getWorkflowId());
-            $sRet .= "<option value=\"" . $oState->getId() . "\">" . $oWorkflow->getName() . " - " . $oState->getName() . "</option>\n";
+            $sSelStr = '';
+            if ($preval == $oState->getId()) { $sSelStr = ' selected="true"'; }            
+            $sRet .= "<option value=\"" . $oState->getId() . "\"" . $sSelStr . ">" . $oWorkflow->getName() . " - " . $oState->getName() . "</option>\n";
         }
         $sRet .= "</select>\n";
         return $sRet;
@@ -120,7 +120,7 @@ class KTCorePlugin extends KTPlugin {
         $this->registerAdminPage("savedsearch", 'KTSavedSearchDispatcher', 'misc',
             _('Saved searches'),
             _('Manage saved searches - searches available by default to all users.'),
-            'admin/manageHelp.php', null);
+            'admin/savedSearch.php', null);
         // plugins
         $this->registerAdminPage("plugins", 'KTPluginDispatcher', 'plugins',
@@ -9,10 +9,16 @@ require_once(KT_LIB_DIR . &quot;/search/savedsearch.inc.php&quot;);
 class KTSavedSearchDispatcher extends KTStandardDispatcher {
     var $bAutomaticTransaction = true;
+    function check() {
+        $this->oPage->setTitle(_('Manage Saved Searches'));
+        return true;
+    }
+
     function do_main() {
         $oTemplate =& $this->oValidator->validateTemplate('ktcore/search/administration/savedsearches');
         $oTemplate->setData(array(
             'saved_searches' => KTSavedSearch::getList(),
+            'context' => $this,
         ));
         return $oTemplate->render();
     }
@@ -27,6 +33,8 @@ class KTSavedSearchDispatcher extends KTStandardDispatcher {
             "title" => _("Create a new condition"),
             "aCriteria" => $aCriteria,
             "searchButton" => _("Save"),
+            'context' => $this,
+            "sNameTitle" => _('New Stored Search'),
         );
         return $oTemplate->render($aTemplateData);
     }
@@ -34,10 +42,92 @@ class KTSavedSearchDispatcher extends KTStandardDispatcher {
     function do_view() {
     }
+    
+    function do_edit() {
+        $id = KTUtil::arrayGet($_REQUEST, 'fSavedSearchId');
+        $oSearch = KTSavedSearch::get($id);
+        
+        if (PEAR::isError($oSearch) || ($oSearch == false)) {
+            $this->errorRedirectToMain('No Such search');
+        }
+        
+        $aSearch = $oSearch->getSearch();
+        
+        
+        $oTemplating = new KTTemplating;
+        $oTemplate = $oTemplating->loadTemplate("ktcore/boolean_search_edit");
+        
+        $aCriteria = Criteria::getAllCriteria();
+        
+        // we need to help out here, since it gets unpleasant inside the template.
+        foreach ($aSearch['subgroup'] as $isg => $as) {
+            $aSubgroup =& $aSearch['subgroup'][$isg];
+            foreach ($aSubgroup['values'] as $iv => $t) {
+                $datavars =& $aSubgroup['values'][$iv];
+                $datavars['typename'] = $aCriteria[$datavars['type']]->sDisplay;
+                $datavars['widgetval'] = $aCriteria[$datavars['type']]->searchWidget(null, $datavars['data']);
+            }
+        }
+        
+        //$s = '<pre>';
+        //$s .= print_r($aSearch, true);
+        //$s .= '</pre>';
+        //print $s;        
+        
+        $aTemplateData = array(
+            "title" => _("Edit an existing condition"),
+            "aCriteria" => $aCriteria,
+            "searchButton" => _("Update Saved Search"),
+            'aSearch' => $aSearch,
+            'context' => $this,
+            'iSearchId' => $oSearch->getId(),
+            'old_name' => $oSearch->getName(),
+            'sNameTitle' => _('Edit Search'),
+        );
+        return $oTemplate->render($aTemplateData);        
+        
+        //return $s;
+    }
+
+    // XXX: Rename to do_save
+    function do_updateSearch() {
+        $id = KTUtil::arrayGet($_REQUEST, 'fSavedSearchId');
+        $sName = KTUtil::arrayGet($_REQUEST, 'name');
+        $oSearch = KTSavedSearch::get($id);
+        
+        if (PEAR::isError($oSearch) || ($oSearch == false)) {
+            $this->errorRedirectToMain('No Such search');
+        }
+        
+        
+        $datavars = KTUtil::arrayGet($_REQUEST, 'boolean_search');
+        if (!is_array($datavars)) {
+            $datavars = unserialize($datavars);
+        }
+        
+        if (empty($datavars)) {
+            $this->errorRedirectToMain(_('You need to have at least 1 condition.'));
+        }
+
+        //$sName = "Neil's saved search";
+        if (!empty($sName)) {
+            $oSearch->setName($sName);
+        }
+        
+        $oSearch->setSearch($datavars);
+        $res = $oSearch->update();
+        
+        $this->oValidator->notError($res, array(
+            'redirect_to' => 'main',
+            'message' => _('Search not saved'),
+        ));
+        $this->successRedirectToMain(_('Search saved'));
+    }
     // XXX: Rename to do_save
     function do_performSearch() {
         $datavars = KTUtil::arrayGet($_REQUEST, 'boolean_search');
+        $sName = KTUtil::arrayGet($_REQUEST, 'name');
         if (!is_array($datavars)) {
             $datavars = unserialize($datavars);
         }
@@ -46,7 +136,6 @@ class KTSavedSearchDispatcher extends KTStandardDispatcher {
             $this->errorRedirectToMain(_('You need to have at least 1 condition.'));
         }
-        $sName = "Neil's saved search";
         $sNamespace = KTUtil::nameToLocalNamespace('Saved searches', $sName);
         $oSearch = KTSavedSearch::createFromArray(array(
@@ -66,7 +155,7 @@ class KTSavedSearchDispatcher extends KTStandardDispatcher {
     }
 }
-$oDispatcher = new KTSavedSearchDispatcher();
-$oDispatcher->dispatch();
+//$oDispatcher = new KTSavedSearchDispatcher();
+//$oDispatcher->dispatch();
 ?>
+/* Constructed Search Postprocessing.
+ *
+ * In order to make everything as seamless as possible, we do a 
+ * JS based postprocess on the boolean_search pages.
+ *
+ * This needs to do two things:
+ *   - adjust all the input.name elements.
+ *   - push the autoIncrement vars so we don't have modification conflicts.
+ */
+ 
+
+// expects a table row in canonical format, ready for var-modification.
+function processRow(tablerow, parent_table) {
+    var inputs = tablerow.getElementsByTagName('INPUT');
+    
+    // unfortunate note:  if we have > 1 items, we are dealing with a "real" row.
+    //   (1 since select != input, and <input type=button>.
+    //   (not == 2 since we can have arbitrary other items...
+    
+    if (inputs.length > 1) {  // is a "predefined" row.
+        autoIndexCriteria.push(0);
+        var crit_id = autoIndexCriteria.length;
+        var table_id = getBooleanGroupId(parent_table);
+        
+        // we also need "SELECT" items.
+
+        var selects = tablerow.getElementsByTagName('SELECT');
+        
+        if (inputs[0].name != '') {
+            alert('invalid output.');
+            return null;
+        } else {
+            inputs[0].name = 'boolean_search[subgroup]['+table_id+'][values]['+crit_id+'][type]';
+        }
+        
+        // different from constructed_search:  remove the _initial_ INPUT type="hidden, and the button.
+        for (var i=1; i<inputs.length-1; i++) {
+            var obj = inputs[i];
+            obj.name = "boolean_search[subgroup]["+table_id+"][values]["+crit_id+"][data]["+obj.name+"]";
+        }
+        
+        for (var i=0; i<selects.length; i++) {
+            var obj = selects[i];
+            obj.name = "boolean_search[subgroup]["+table_id+"][values]["+crit_id+"][data]["+obj.name+"]";
+        }        
+    }
+    
+}
+
+
+function processSavedSearch() {
+    var boolGroups = getElementsByTagAndClassName('TABLE','advanced-search-form');
+    for (var i=0; i<boolGroups.length; i++) {
+        var boolBody = boolGroups[i].getElementsByTagName('TBODY')[0];  // must be 1.
+        var boolRows = boolBody.getElementsByTagName('TR');
+        for (var j=0; j<boolRows.length; j++) {
+            processRow(boolRows[j], boolGroups[i]);
+        }
+    }    
+}
+
+addLoadEvent(processSavedSearch);
 \ No newline at end of file
+{$context->oPage->requireJSResource("thirdpartyjs/MochiKit/Base.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/MochiKit/DateTime.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/MochiKit/Iter.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/MochiKit/DOM.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/MochiKit/Async.js")}
+{$context->oPage->requireJSResource("resources/js/taillog.js")}
+{$context->oPage->requireJSResource("resources/js/constructed_search.js")}
+{$context->oPage->requireJSResource("resources/js/constructed_search_postprocess.js")}
+
+{$context->oPage->requireJSResource("resources/js/kt3calendar.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/jscalendar-1.0/calendar.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/jscalendar-1.0/lang/calendar-en.js")}
+{$context->oPage->requireJSResource("thirdpartyjs/jscalendar-1.0/calendar-setup.js")}
+
+{$context->oPage->requireCSSResource("thirdpartyjs/jscalendar-1.0/calendar-system.css")}
+
+{capture assign=sJS}
+{literal}
+function testStartup() {
+    simpleLog('INFO','Log initialised.');
+}
+
+addLoadEvent(testStartup);
+{/literal}
+{/capture}
+{$context->oPage->requireJSStandalone($sJS)}
+
+{capture assign=sCSS}
+{literal}
+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; }
+{/literal}
+{/capture}
+{$context->oPage->requireCSSStandalone($sCSS)}
+
+<!-- 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>
+
+{capture assign=defaulttitle}
+{i18n}Boolean Search{/i18n}
+{/capture}
+<h2>{$title|default:$defaulttitle}</h2>
+
+<form method="POST">
+    <input type="hidden" name="action" value="updateSearch" />
+	<input type="hidden" name="fSavedSearchId" value="{$iSearchId}" />
+{if $sNameTitle}
+    {$sNameTitle}: <input type="text" name="name" value="{$old_name}" /> <br />
+{/if}
+
+{capture assign=options}
+<select name="boolean_search[join]"><option value="AND" {if ($aSearch.join == 'AND')} selected="true"{/if}>all</option><option value="OR" {if ($aSearch.join == 'OR')} selected="true"{/if}>any</option></select>
+{/capture}
+
+   <p class="helpText">{i18n arg_options=$options}Return items which match &nbsp;#options# of the <strong>criteria groups</strong> specified.{/i18n}</p>    
+    
+   {foreach item=aSubgroup from=$aSearch.subgroup}
+    
+    <fieldset>
+        <legend>{i18n}Criteria Group{/i18n}</legend>
+
+	{capture assign=options}
+	<select name="boolean_search[subgroup][0][join]"><option value="AND"{if ($aSubgroup.join == 'AND')} selected="true"{/if}>all</option><option value="OR"{if ($aSubgroup.join == 'OR')} selected="true"{/if}>any</option></select>
+	{/capture}
+
+        <p class="helpText">{i18n arg_options=$options}Return items which match &nbsp;#options# of the criteria specified.{/i18n}</p>
+
+        <table class="advanced-search-form">
+		    <thead>
+                <tr>
+                <th>{i18n}Criteria{/i18n}</th>
+                <th>{i18n}Values{/i18n}</th>
+                <th>&nbsp;</th>
+                </tr>			
+			</thead>
+			
+            <tbody>
+			
+			    {foreach item=oSearchCriteria from=$aSubgroup.values}
+				<tr>
+					<td>
+						{$oSearchCriteria.typename} <input type="hidden" name="" value="{$oSearchCriteria.type}"/>
+					</td>
+					<td>
+					    {$oSearchCriteria.widgetval}
+					</td>
+					<td>
+					    <input type="button" value="Remove" onclick="removeCriteria(this)"/>
+					</td>
+				</tr>
+				{/foreach}
+			
+                <tr>
+                    <td><select name="querytype">
+                         {foreach item=oCriteria from=$aCriteria}
+                             <option value="{$oCriteria->getID()}">{$oCriteria->headerDisplay()}</option>
+                        {/foreach}
+                        </select>
+                        </td>
+                    <td><p class="helpText">{i18n}first select a type of query{/i18n}</p></td>
+                    <td><input type="button" value="{i18n}Add{/i18n}" onclick="addNewCriteria(this);" /></td>                    
+                </tr>
+            </tbody>
+        </table>
+
+    </fieldset>
+    
+    {/foreach}
+    
+    <div class="form_actions">
+    
+    <input type="button" value="{i18n}add another set of criteria{/i18n}" onclick="addBooleanGroup(this)" />
+    
+    
+{capture assign=defaultsubmit}
+{i18n}Search{/i18n}
+{/capture}
+    <input type="submit" name="submit" value="{$searchButton|default:$defaultsubmit}" />
+	</div>
+</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>
+-->
+