Skip to content

Commit

Permalink
Fixed issue #18128 : Broken javascript on welcome page (#2381)
Browse files Browse the repository at this point in the history 
Fixed issue : Invalid var in 1st page
Dev: cleaner separation between js tayloring for qid and out of qid
Dev: review pageTailorInfo to avoid empty varused
Dev: optimisation of pageTailorInfo adapatation : do it only once, and not once by qid.
Dev: fix name of variables : $allJsVarsUsed is globally used for all question
Dev: Avoid issue with debug set and null pageTailorInfo
Dev: survey listing page (and some other) don't launch StartProcessingPage
  • Loading branch information
@Shnoulle
Shnoulle committed Jul 25, 2022
1 parent 57deeab commit 98eb80d
Showing 1 changed file with 65 additions and 36 deletions.
101 changes: 65 additions & 36 deletions application/helpers/expressions/em_manager_helper.php
View file
Expand Up @@ -162,9 +162,18 @@ class LimeExpressionManager
private $pageRelevanceInfo;

/**
*
* @var array
*/
* @var array|null $pageTailorInfo
* Array of array of information about HTML id to update with javascript function
* [[
* 'questionNum' : question number
* 'num' : internal number of javascript function
* 'id' : id of HTML element
* 'raw' : Raw Expression
* 'result' :
* 'vars' : var used in javascript function
* 'js' : final javascript function
* ]]
*/
private $pageTailorInfo;
/**
* internally set to true (1) for survey.php so get group-specific logging but keep javascript variable namings consistent on the page.
Expand Down Expand Up @@ -6892,6 +6901,7 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)

$jsParts = [];
$inputParts = [];
/* string[] all needed variable for LEMalias2varName and LEMvarNameAttr */
$allJsVarsUsed = [];
$rowdividList = []; // list of subquestions needing relevance entries
/* All function for expression manager */
Expand Down Expand Up @@ -6953,24 +6963,25 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
}
}
}
$pageRelevanceInfo[] = array(
'qid' => 0,
'gseq' => $LEM->currentGroupSeq,
'eqn' => '',
'result' => true,
'numJsVars' => 0,
'relevancejs' => '',
'relevanceVars' => '',
'jsResultVar' => '',
'type' => '',
'hidden' => false,
'hasErrors' => false,
);
}

/**
* @var array[] the javascript and related variable,
* reconstruct from $LEM->pageTailorInfoto get questionId as key
**/
$pageTailorInfo = array();
if (is_array($LEM->pageTailorInfo)) {
foreach ($LEM->pageTailorInfo as $tailors) {
if (is_array($tailors)) {
foreach ($tailors as $tailor) {
$pageTailorInfo[$tailor['questionNum']][] = $tailor;
}
}
}
}
$valEqns = [];
$relEqns = [];
$relChangeVars = [];

$dynamicQinG = []; // array of questions, per group, that might affect group-level visibility in all-in-one mode
$GalwaysRelevant = []; // checks whether a group is always relevant (e.g. has at least one question that is always shown)
if (is_array($pageRelevanceInfo)) {
Expand All @@ -6986,17 +6997,13 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
$valParts = []; // validation
$relJsVarsUsed = []; // vars used in relevance and tailoring
$valJsVarsUsed = []; // vars used in validations
foreach ($LEM->pageTailorInfo as $tailor) {
if (is_array($tailor)) {
foreach ($tailor as $sub) {
if ($sub['questionNum'] == $arg['qid']) {
$tailorParts[] = $sub['js'];
$vars = explode('|', $sub['vars']);
if (is_array($vars)) {
$allJsVarsUsed = array_merge($allJsVarsUsed, $vars);
$relJsVarsUsed = array_merge($relJsVarsUsed, $vars);
}
}
if (!empty($pageTailorInfo[$arg['qid']])) {
foreach ($pageTailorInfo[$arg['qid']] as $tailor) {
$tailorParts[] = $tailor['js'];
$vars = array_filter(explode('|', $tailor['vars']));
if (!empty($vars)) {
$allJsVarsUsed = array_merge($allJsVarsUsed, $vars);
$relJsVarsUsed = array_merge($relJsVarsUsed, $vars);
}
}
}
Expand Down Expand Up @@ -7038,7 +7045,7 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
// Process relevance for question $arg['qid'];
$relevance = $arg['relevancejs'];
$relChangeVars[] = " relChange" . $arg['qid'] . "=false;\n"; // detect change in relevance status
if ($arg['qid'] && ($relevance == '' || $relevance == '1' || ($arg['result'] == true && $arg['numJsVars'] == 0)) && count($tailorParts) == 0 && count($subqParts) == 0 && count($subqValidations) == 0 && count($validationEqns) == 0) {
if (($relevance == '' || $relevance == '1' || ($arg['result'] == true && $arg['numJsVars'] == 0)) && count($tailorParts) == 0 && count($subqParts) == 0 && count($subqValidations) == 0 && count($validationEqns) == 0) {
// Only show constitutively true relevances if there is tailoring that should be done.
// After we can assign var with EM and change again relevance : then doing it second time (see bug #08315).
$relParts[] = "$('#relevance" . $arg['qid'] . "').val('1'); // always true\n";
Expand Down Expand Up @@ -7313,10 +7320,8 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
// Launch updated event after update value to allow equation update propagation
$relParts[] = " $('#" . substr($jsResultVar, 1, -1) . "').val($.trim($('#question" . $arg['qid'] . " .em_equation').text())).trigger('updated');\n";
}
if ($arg['qid']) {
$relParts[] = " relChange" . $arg['qid'] . "=true;\n"; // any change to this value should trigger a propagation of changess
$relParts[] = " $('#relevance" . $arg['qid'] . "').val('1');\n";
}
$relParts[] = " relChange" . $arg['qid'] . "=true;\n"; // any change to this value should trigger a propagation of changess
$relParts[] = " $('#relevance" . $arg['qid'] . "').val('1');\n";

$relParts[] = "}\n";
if (!($relevance == '' || $relevance == '1' || ($arg['result'] == true && $arg['numJsVars'] == 0))) {
Expand All @@ -7331,10 +7336,10 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
$relParts[] = " if ($('#relevance" . $arg['qid'] . "').val()=='1') { relChange" . $arg['qid'] . "=true; }\n"; // only propagate changes if changing from relevant to irrelevant
$relParts[] = " $('#relevance" . $arg['qid'] . "').val('0');\n";
$relParts[] = "}\n";
} elseif ($arg['qid']) {
} else {
// Second time : now if relevance is true: Group is allways visible (see bug #08315).
$relParts[] = "$('#relevance" . $arg['qid'] . "').val('1'); // always true\n";
if ($arg['qid'] && !($arg['hidden'] && $arg['type'] == Question::QT_ASTERISK_EQUATION)) { // Equation question type don't update visibility of group if hidden ( child of bug #08315).
if (!($arg['hidden'] && $arg['type'] == Question::QT_ASTERISK_EQUATION)) { // Equation question type don't update visibility of group if hidden ( child of bug #08315).
$GalwaysRelevant[$arg['gseq']] = true;
}
}
Expand Down Expand Up @@ -7518,8 +7523,32 @@ public static function GetRelevanceAndTailoringJavaScript($bReturnArray = false)
}
}
}

/* Tailoring out of question scope */
if (!empty($pageTailorInfo[0])) {
$jsParts[] = "LEMrel0(sgqa);\n";
}
$jsParts[] = "\n}\n";
/* ailoring out of question scope for global action */
if (!empty($pageTailorInfo[0])) {
$tailorParts = [];
$tailorJsVarsUsed = [];
foreach ($pageTailorInfo[0] as $tailor) {
$tailorParts[] = $tailor['js'];
$vars = array_filter(explode('|', $tailor['vars']));
if (!empty($vars)) {
$tailorJsVarsUsed = array_unique(array_merge($tailorJsVarsUsed, $vars));
}
}
$allJsVarsUsed = array_merge($allJsVarsUsed, $tailorJsVarsUsed);
$globalJS = "function LEMrel0(sgqa){\n";
$globalJS .= " var UsesVars = ' " . implode(' ', $tailorJsVarsUsed) . " ';\n";
$globalJS .= " if (typeof sgqa !== 'undefined' && !LEMregexMatch('/ java' + sgqa + ' /', UsesVars)) {\n";
$globalJS .= " return;\n";
$globalJS .= " }\n";
$globalJS .= implode("", $tailorParts);
$globalJS .= "}\n";
$relEqns[] = $globalJS;
}

$jsParts[] = implode("\n", $relEqns);
$jsParts[] = implode("\n", $valEqns);
Expand Down

0 comments on commit 98eb80d

Please sign in to comment.