KTS-4605 Conditional Metadata not working in KTAPI get_metadata(SUP-2537)

PT:2630614 Resolved javascript conflict for large text and conditional fields on the same page. Also fixed the bulk upload pages conditional list constraining on ajax load. Committed by: Charl Joseph Mert Reviewed by: Megan Watson

KTS-4605 Conditional Metadata not working in KTAPI get_metadata(SUP-2537)
PT:2630614 Resolved javascript conflict for large text and conditional fields on the same page. Also fixed the bulk upload pages conditional list constraining on ajax load. Committed by: Charl Joseph Mert Reviewed by: Megan Watson
Charl Joseph Mert
1 parent 638ee683
Showing 6 changed files with 253 additions and 128 deletions
lib/metadata/fieldset.inc.php
lib/metadata/fieldsetregistry.inc.php
plugins/ktcore/KTWidgets.php
plugins/multiselect/BulkUpload.php
presentation/lookAndFeel/knowledgeTree/ajaxConditional.php
resources/js/conditional_selection.js
@@ -186,6 +186,18 @@ class KTFieldset extends KTEntity {
         ), $aOptions);
     }
  
+    function &getConditionalFieldsets($aOptions = null) {
+	$aOptions = KTUtil::meldOptions(
+	    $aOptions,
+	    array('multi' => true,)
+	);
+        return KTEntityUtil::getByDict('KTFieldset', array(
+            'is_conditional' => true,
+            'disabled' => false,
+        ), $aOptions);
+    }
+    
+    
     function &getForDocumentType($oDocumentType, $aOptions = null) {
         $bIds = KTUtil::arrayGet($aOptions, 'ids');
         if (is_object($oDocumentType)) {
@@ -92,7 +92,7 @@ class KTFieldsetRegistry {
      * 
      */
     function getHtmlFields($oFieldset, $idPre = 'metadata_') {
-            $fields = $oFieldset->getFields();
+        $fields = $oFieldset->getFields();
 		$textAreaIds = array();
  
 		foreach($fields as $field) {
@@ -103,7 +103,6 @@ class KTFieldsetRegistry {
  
 		return $textAreaIds;
     }    
-
  
     /*
      * Returns an array of fieldIds which belong to a generic fieldset
@@ -156,6 +155,11 @@ class KTFieldsetRegistry {
             }
  
             foreach ($newfields as $oField) {
+                // If a conditional field hasn't been set up properly this will throw errors.
+                // TODO: display a message indicating that admin must complete the setup. 
+                if (PEAR::isError($oField)) {
+                    continue;
+                }
                 $fname = 'metadata_' . $oField->getId(); 
                 $value = null;
  
@@ -973,7 +973,8 @@ class KTCoreTextAreaWidget extends KTWidget {
         $oTemplate = $oTemplating->loadTemplate('ktcore/forms/widgets/base');
  
       	$this->aJavascript[] = 'thirdpartyjs/jquery/jquery-1.3.2.js';
-        $this->aJavascript[] = 'thirdpartyjs/tinymce/jscripts/tiny_mce/tiny_mce.js';
+      	$this->aJavascript[] = 'thirdpartyjs/jquery/jquery_noconflict.js';
+      	$this->aJavascript[] = 'thirdpartyjs/tinymce/jscripts/tiny_mce/tiny_mce.js';
     	$this->aJavascript[] = 'resources/js/kt_tinymce_init.js';
  
         if (!empty($this->aJavascript)) {
@@ -141,7 +141,8 @@ class InetBulkUploadFolderAction extends KTFolderAction {
 		$aJavascript[] = 'thirdpartyjs/tinymce/jscripts/tiny_mce/tiny_mce.js';
 		$aJavascript[] = 'resources/js/kt_tinymce_init.js';
     	$aJavascript[] = 'thirdpartyjs/tinymce/jscripts/tiny_mce/jquery.tinymce.js';
-
+    	$aJavascript[] = 'resources/js/conditional_selection.js';
+    	
 		$this->oPage->requireJSResources($aJavascript);
  
 		//FIXME: Might really not need to load these styles, will check l8r
@@ -45,6 +45,11 @@ require_once(KT_LIB_DIR . &quot;/util/ktutil.inc&quot;);
 require_once(KT_LIB_DIR . "/dispatcher.inc.php");
 require_once(KT_LIB_DIR . '/widgets/fieldsetDisplay.inc.php');
  
+require_once(KT_LIB_DIR . "/metadata/fieldsetregistry.inc.php");
+require_once(KT_LIB_DIR . "/widgets/widgetfactory.inc.php");
+require_once(KT_LIB_DIR . "/validation/validatorfactory.inc.php");
+
+
 /*
  * example code - tests the frontend behaviour.  remember to check ajaxConditional.php 
  * 
@@ -102,6 +107,82 @@ class AjaxConditionalDispatcher extends KTStandardDispatcher {
  
         return $sWidgets;
     }
+
+    
+    
+    
+    function _getFieldIdForMetadataId($iMetadata) {
+	$sTable = 'metadata_lookup';
+	$sQuery = "SELECT document_field_id FROM " . $sTable . " WHERE id = ?";
+	$aParams = array($iMetadata);
+
+	$res = DBUtil::getOneResultKey(array($sQuery, $aParams), 'document_field_id');
+	if (PEAR::isError($res)) {
+	    return false;
+	}
+	return $res;
+    }
+    
+    //http://localhost/knowledgetree/presentation/lookAndFeel/knowledgeTree/ajaxConditional.php?action=getConditionalData&masterid=6&type=connections
+    //http://localhost/knowledgetree/presentation/lookAndFeel/knowledgeTree/ajaxConditional.php?action=getConditionalData&masterid=6&type=lookups
+    //$type can be lookups or connections
+    function do_getConditionalData(){
+        $iMetadata = $_GET['masterid'];
+        $type = $_GET['type'];
+        
+		$oFReg =& KTFieldsetRegistry::getSingleton();
+		$oFieldSets = KTFieldset::getConditionalFieldsets();
+
+		foreach ($oFieldSets as $oFieldset) {
+            
+    	    $aLookups = array();
+    	    $aConnections = array();
+    
+    	    foreach($oFieldset->getFields() as $oField) {
+    		$c = array();
+    
+    		foreach($oField->getEnabledValues() as $oMetadata) {
+    		    $a = array();
+    		    // print '<pre>';
+    
+    		    $nvals = KTMetadataUtil::getNextValuesForLookup($oMetadata->getId());
+    		    if($nvals) {
+    			foreach($nvals as $i=>$aVals) {
+    			    $a = array_merge($a, $aVals);
+    
+    			    foreach($aVals as $id) {
+    			      $field = $this->_getFieldIdForMetadataId($id);
+    			      // print 'id ' . $id . ' is in field ' . $field . "<br/>";
+    			      if(!in_array($field, $c)) {
+    				$c[] = $field;
+    			      }
+    			    }
+    			}
+    		    }
+    
+    		    $aLookups[$oMetadata->getId()] = $a;
+    		}
+    		$aConnections[$oField->getId()] = $c;
+    	    }
+    
+    	    //exit(0);
+    
+    	    $oJSON = new Services_JSON;
+    	    switch ($type) {
+	            case 'lookups':
+    	            return $oJSON->encode($aLookups);
+    	            break;
+	            case 'connections' :
+	                return $oJSON->encode($aConnections);
+	                break;
+	            default:
+    	            return $oJSON->encode($aLookups);
+    	    }
+    	            
+            return false;
+		}
+    }
+    
 }
  
 $oDispatcher = new AjaxConditionalDispatcher();
-// 'lookups' and 'connections' are produced by the master conditional widget
+// depricated: 'lookups' and 'connections' are produced by the master conditional widget
+// 'lookups' and 'connections' are now dynamically callable via ajax request to get a json response
+
 var NOSELECTION = 'No selection.';
  
 function ConditionalSelection() {
@@ -27,135 +29,159 @@ function getId(elm) {
  
 ConditionalSelection.prototype = {
     'initialize' : function(masterId) {
+	
 	// make clones of the original nodes to keep the options in
 	var fieldLookups = {};
 	var current = {};
+	
+	/*
 	var lookups = eval('lookups_' + masterId);
 	var connections = eval('connections_' + masterId);
-
-	// initialize - build various tables
-	forEach(getElementsByTagAndClassName(null, 'is_conditional_' + masterId),
-		function(elm) {
-		    var fieldId = getId(elm);
-		    for(var i=0; i<elm.options.length; i++) {
-			var oElm = elm.options[i];
-			var lookupId = oElm.id.substring('lookup_'.length);
-			fieldLookups[lookupId] = {'parent':fieldId, 'value':oElm.innerHTML};
-
-			if(oElm.selected && oElm.value) {
-			    current[fieldId] = oElm.value;
-			}
-		    }
-		});
-
-	// the following function are defined inline, as they depend on the
-	// 'lookups' and 'connections' being specified above
-
-	function clearConnected(fieldId) {
-	    if(!fieldId in connections || !connections[fieldId].length) {
-		return;
-	    }
-	    for(var i=0; i<connections[fieldId].length; i++) {
-		var field = $('field_'+connections[fieldId][i]);
-		replaceChildNodes(field, OPTION(null, NOSELECTION));
-		field.disabled = true;
-		clearConnected(connections[fieldId][i]);
-	    }
-	}
+	*/
+	
+	var lookups = null;
+	var connections = null;
+	
+	// Making the conditional selection rules dynamically envokable. This enables conditional metadata fields to be used as ajax loaded dom elements.
+	// Needed for the Bulk Upload metadata page.
+	
+    jQuery.getJSON('presentation/lookAndFeel/knowledgeTree/ajaxConditional.php?action=getConditionalData&masterid=' + masterId + '&type=lookups',
+	    function(json){
+    		lookups = json;
+    		
+    	    jQuery.getJSON('presentation/lookAndFeel/knowledgeTree/ajaxConditional.php?action=getConditionalData&masterid=' + masterId + '&type=connections',
+    		    function(json){
+    	    		connections = json;
+
+    	    		// initialize - build various tables
+    	    		forEach(getElementsByTagAndClassName(null, 'is_conditional_' + masterId),
+    	    			function(elm) {
+    	    			    var fieldId = getId(elm);
+    	    			    for(var i=0; i<elm.options.length; i++) {
+    	    				var oElm = elm.options[i];
+    	    				var lookupId = oElm.id.substring('lookup_'.length);
+    	    				fieldLookups[lookupId] = {'parent':fieldId, 'value':oElm.innerHTML};
+
+    	    				if(oElm.selected && oElm.value) {
+    	    				    current[fieldId] = oElm.value;
+    	    				}
+    	    			    }
+    	    			});
+
+    	    		// the following function are defined inline, as they depend on the
+    	    		// 'lookups' and 'connections' being specified above
+
+    	    		function clearConnected(fieldId) {
+    	    		    if(!fieldId in connections || !connections[fieldId].length) {
+    	    			return;
+    	    		    }
+    	    		    for(var i=0; i<connections[fieldId].length; i++) {
+    	    			var field = $('field_'+connections[fieldId][i]);
+    	    			replaceChildNodes(field, OPTION(null, NOSELECTION));
+    	    			field.disabled = true;
+    	    			clearConnected(connections[fieldId][i]);
+    	    		    }
+    	    		}
+    	    		
+
+    	    		function clearInvalid(fieldId) {
+    	    		    if(!fieldId in connections || !connections[fieldId].length) {
+    	    			return;
+    	    		    }
+    	    		    
+    	    		    var parentField = $('field_'+fieldId);
+    	    		    var selectedId = getId(parentField.options[parentField.selectedIndex]);
+    	    		    var options = lookups[selectedId];
+
+    	    		    if(parentField.options[parentField.selectedIndex].innerHTML == NOSELECTION) {
+    	    			clearConnected(fieldId);
+    	    		    } else {
+    	    			for(var i=0; i<connections[fieldId].length; i++) {
+    	    			    var field = $('field_'+connections[fieldId][i]);
+    	    			    var newOptions = [];
+    	    			    var selected = null;
+
+    	    			    for(var j=0; j<field.options.length; j++) {
+    	    				var opt = field.options[j];
+    	    				if(!(opt.innerHTML != NOSELECTION  && !in_array(options, getId(opt)))) {
+    	    				    newOptions.push(opt);
+    	    				}
+
+    	    				if(j == field.selectedIndex && opt.id && in_array(options, getId(opt))) {
+    	    				    selected = opt.id;
+    	    				}
+    	    			    }
+
+    	    			    field.selectedIndex = 0;
+    	    			    replaceChildNodes(field, null);
+    	    			    
+
+    	    			    for(var j=0; j<newOptions.length; j++) {
+    	    				var opt = newOptions[j];
+    	    				appendChildNodes(field, opt);
+    	    				
+    	    				if(selected != null) {
+    	    				    if(opt.id && opt.id == selected) { // || j == 0 && field.selectedIndex == 0) {
+    	    					field.selectedIndex = j;
+    	    				    }
+    	    				}			    
+    	    			    }
+
+    	    			    if(selected == null) {
+    	    				field.selectedIndex = 0;
+    	    				field.options[0].selected = 'selected';
+    	    			    }
+
+
+    	    			    clearInvalid(connections[fieldId][i]);
+    	    			}
+    	    		    }
+    	    		}
+
+    	    		// instead of clearing here, we remove the non-applicable options
+    	    		// this should handle the case with existing selections
+    	    		clearInvalid(masterId);	
+
+
+    	    		function populateForSelection(selectedId) {
+    	    		    if(selectedId in lookups) {
+    	    			for(var i=0; i<lookups[selectedId].length; i++) {
+    	    			    var lookupId = lookups[selectedId][i];
+    	    			    var lookupInfo = fieldLookups[lookupId];
+    	    			    
+    	    			    var parent = $('field_' + lookupInfo['parent']);
+    	    			    appendChildNodes(parent, 
+    	    					     OPTION({'value':lookupInfo['value'], 'id':'lookup_' + lookupId}, 
+    	    						    lookupInfo['value']));
+    	    			    parent.disabled = false;
+    	    			}
+    	    		    }
+    	    		}
+
+
+    	    		forEach(getElementsByTagAndClassName(null, 'is_conditional_' + masterId), function(elm) {
+    	    			    // check if this field connects to anything else
+    	    			    var fieldId = elm.id.substring('field_'.length);
+    	    			    if(fieldId in connections && connections[fieldId].length) {
+    	    				var controller = true;
+    	    			    }
+
+    	    			    if(controller) {
+    	    				connect(elm, 'onchange', 
+    	    					function() {
+    	    					    var selectedId = elm.options[elm.selectedIndex].id.substring('lookup_'.length);
+    	    					    var touched = [];
+    	    					    clearConnected(fieldId);
+    	    					    populateForSelection(selectedId);
+    	    					});
+    	    			    }
+    	    			});
+
+    	    		//---------- End Inner Functions
+    	    });
+    });
+	
  
-
-	function clearInvalid(fieldId) {
-	    if(!fieldId in connections || !connections[fieldId].length) {
-		return;
-	    }
-	    
-	    var parentField = $('field_'+fieldId);
-	    var selectedId = getId(parentField.options[parentField.selectedIndex]);
-	    var options = lookups[selectedId];
-
-	    if(parentField.options[parentField.selectedIndex].innerHTML == NOSELECTION) {
-		clearConnected(fieldId);
-	    } else {
-		for(var i=0; i<connections[fieldId].length; i++) {
-		    var field = $('field_'+connections[fieldId][i]);
-		    var newOptions = [];
-		    var selected = null;
-
-		    for(var j=0; j<field.options.length; j++) {
-			var opt = field.options[j];
-			if(!(opt.innerHTML != NOSELECTION  && !in_array(options, getId(opt)))) {
-			    newOptions.push(opt);
-			}
-
-			if(j == field.selectedIndex && opt.id && in_array(options, getId(opt))) {
-			    selected = opt.id;
-			}
-		    }
-
-		    field.selectedIndex = 0;
-		    replaceChildNodes(field, null);
-		    
-
-		    for(var j=0; j<newOptions.length; j++) {
-			var opt = newOptions[j];
-			appendChildNodes(field, opt);
-			
-			if(selected != null) {
-			    if(opt.id && opt.id == selected) { // || j == 0 && field.selectedIndex == 0) {
-				field.selectedIndex = j;
-			    }
-			}			    
-		    }
-
-		    if(selected == null) {
-			field.selectedIndex = 0;
-			field.options[0].selected = 'selected';
-		    }
-
-
-		    clearInvalid(connections[fieldId][i]);
-		}
-	    }
-	}
-
-	// instead of clearing here, we remove the non-applicable options
-	// this should handle the case with existing selections
-	clearInvalid(masterId);	
-
-
-	function populateForSelection(selectedId) {
-	    if(selectedId in lookups) {
-		for(var i=0; i<lookups[selectedId].length; i++) {
-		    var lookupId = lookups[selectedId][i];
-		    var lookupInfo = fieldLookups[lookupId];
-		    
-		    var parent = $('field_' + lookupInfo['parent']);
-		    appendChildNodes(parent, 
-				     OPTION({'value':lookupInfo['value'], 'id':'lookup_' + lookupId}, 
-					    lookupInfo['value']));
-		    parent.disabled = false;
-		}
-	    }
-	}
-
-
-	forEach(getElementsByTagAndClassName(null, 'is_conditional_' + masterId), function(elm) {
-		    // check if this field connects to anything else
-		    var fieldId = elm.id.substring('field_'.length);
-		    if(fieldId in connections && connections[fieldId].length) {
-			var controller = true;
-		    }
-
-		    if(controller) {
-			connect(elm, 'onchange', 
-				function() {
-				    var selectedId = elm.options[elm.selectedIndex].id.substring('lookup_'.length);
-				    var touched = [];
-				    clearConnected(fieldId);
-				    populateForSelection(selectedId);
-				});
-		    }
-		});
     }
 }