Joomla! Issue Tracker | Joomla! CMS #40185 - [4.3] debug bar loads twice

No Code Attached Yet bug

Closed
25 Mar 2023
Medium
Build: 4.3-dev
# 40185

heelc29
24 Mar 2023

Steps to reproduce the issue

enable debug mode

Expected result

Only one debug bar should be present

Actual result

Two debug bars are present

System information (as much as possible)

J4.3.0-rc1 (Atum Template)

Additional comments

I've already found out that it has something to do with the guided tours model

joomla-cms/administrator/modules/mod_guidedtours/tmpl/default.php

Line 78 in 280c0b8

    
           <button type="button" class="dropdown-item text-center" data-bs-toggle="modal" data-bs-target="#modGuidedTours-modal">

add the mobile status menu

joomla-cms/administrator/templates/atum/html/layouts/status.php

Lines 30 to 38 in 280c0b8

    
           if (strpos($out, 'data-bs-toggle="modal"') !== false) { 
        
               $dom = new \DOMDocument(); 
        
               $dom->loadHTML('<?xml encoding="utf-8" ?>' . $out); 
        
               $els = $dom->getElementsByTagName('a'); 
        
               $moduleCollapsedHtml[] = $dom->saveHTML($els[0]); //$els[0]->nodeValue; 
        
           } else { 
        
               $moduleCollapsedHtml[] = $out; 
        
           }

Output:

<div class="header-dd-item dropdown-item" data-item="1">
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
    <?xml encoding="utf-8" ?>
    <html>
        <body>
            <div class="header-item-content dropdown header-tours d-none d-sm-block">
                <button class="dropdown-toggle d-flex align-items-center ps-0 py-0" data-bs-toggle="dropdown" type="button" title="Take a Tour">
                    <div class="header-item-icon">
                        <span class="icon-map-signs" aria-hidden="true"></span>
                    </div>
                    <div class="header-item-text">
                        Take a Tour        
                    </div>
                    <span class="icon-angle-down" aria-hidden="true"></span>
                </button>
                <div class="dropdown-menu dropdown-menu-end">
                    <button type="button" class="button-start-guidedtour dropdown-item" data-id="3">
                        <span class="icon-map-signs" aria-hidden="true"></span>How to create articles?
                    </button>
                    [...]
                    <button type="button" class="dropdown-item text-center" data-bs-toggle="modal" data-bs-target="#modGuidedTours-modal">
                        Show all tours
                    </button>
                </div>
            </div>
        </body>
    </html>
</div>

As you can see, the div elements contain a second body node which probably causes this behavior.

joomla-cms/plugins/system/debug/debug.php

Line 370 in 280c0b8

    
           echo str_replace('</body>', $debugBarRenderer->renderHead() . $debugBarRenderer->render() . '</body>', $contents);

heelc29 - open - 24 Mar 2023

joomla-cms-bot - change - 24 Mar 2023

Labels

Added: No Code Attached Yet

joomla-cms-bot - labeled - 24 Mar 2023

obuisard - comment - 24 Mar 2023

In trying to replicate the issue, all seems alright under PHP 7.4 or 8.0.
All gets loose on PHP 8.1 and higher.

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/40185.}

heelc29 - comment - 25 Mar 2023

In trying to replicate the issue, all seems alright under PHP 7.4 or 8.0. All gets loose on PHP 8.1 and higher.

@obuisard I can also reproduce in PHP 7.2 and 8.0

Fedik - comment - 25 Mar 2023

I cannot reproduce it on php 8.1
What "DOM/XML API Version" and "libxml Version" your php have? Maybe it something from that.

DOM/XML API Version: 20031129
libxml Version: 2.9.14

Fedik - comment - 25 Mar 2023

I found, that it related to DOMDocument behavior https://www.php.net/manual/en/domdocument.savehtml.php#85165
We probably should avoid it here, somehow.

Fedik - change - 25 Mar 2023

Labels

Added: bug

Fedik - labeled - 25 Mar 2023

heelc29 - comment - 25 Mar 2023

What "DOM/XML API Version" and "libxml Version" your php have? Maybe it something from that.

dom	version
DOM/XML API Version	20031129
libxml Version	2.9.12

Fedik - comment - 25 Mar 2023

@heelc29 Can you please try change the code to

if ($els[0]) {
  $moduleCollapsedHtml[] = $dom->saveHTML($els[0]); //$els[0]->nodeValue;
}

Whether it works for you?

I think I found, that when element not found it export whole Document

joomdonation - comment - 25 Mar 2023

@Fedik Yes, that seems to fix the issue. But anyone really understands what we are trying to do with this block of code https://github.com/joomla/joomla-cms/blob/4.3-dev/administrator/templates/atum/html/layouts/status.php#L30-L38 ? In case the a tag is not found, should we add module output to $moduleCollapsedHtml array, something like ?

if ($els->length > 0) {
	$moduleCollapsedHtml[] = $dom->saveHTML($els[0]); //$els[0]->nodeValue;
} else {
	$moduleCollapsedHtml[] = $out;
}

Fedik - comment - 25 Mar 2023

~~No, that will not work,~~ or maybe will, no idea :)
That code is extracting bootstrap toggler in this strange way, and skipping it if there is none.

joomdonation - comment - 25 Mar 2023

Yes, strange/buggy code. Seems it wants to find a tag which has data-bs-toggle="modal". If found, only add a tag to $moduleCollapsedHtml, if not, add the whole module output to $moduleCollapsedHtml array, but who knows :)

Anyway, your code fixed the reported issue. So please make PR.

brianteeman - comment - 25 Mar 2023

iirc that is for the mobile views

heelc29 - comment - 25 Mar 2023

But anyone really understands what we are trying to do with this block of code

I think it's used for the multilangstatus module ... to not add the $modalHTML twice (normal and collapsed)

joomla-cms/administrator/modules/mod_multilangstatus/tmpl/default.php

Lines 40 to 48 in 280c0b8

    
           <a data-bs-target="#multiLangModal" class="header-item-content multilanguage" title="<?php echo Text::_('MOD_MULTILANGSTATUS'); ?>" data-bs-toggle="modal" role="button"> 
        
               <div class="header-item-icon"> 
        
                   <span class="icon-language" aria-hidden="true"></span> 
        
               </div> 
        
               <div class="header-item-text"> 
        
                   <?php echo Text::_('MOD_MULTILANGSTATUS'); ?> 
        
               </div> 
        
           </a> 
        
           <?php echo $modalHTML; ?>

Fedik - close - 25 Mar 2023

Fedik - comment - 25 Mar 2023

Please test #40194

Fedik - change - 25 Mar 2023

Status	New	⇒	Closed
Closed_Date	0000-00-00 00:00:00	⇒	2023-03-25 14:59:26
Closed_By		⇒	Fedik

Add a Comment

Older
Newer

Joomla! Issue Tracker - CMS

[#40185] - [4.3] debug bar loads twice

Steps to reproduce the issue

Expected result

Actual result

System information (as much as possible)

Additional comments

Add a Comment

	if (strpos($out, 'data-bs-toggle="modal"') !== false) {
	$dom = new \DOMDocument();
	$dom->loadHTML('<?xml encoding="utf-8" ?>' . $out);
	$els = $dom->getElementsByTagName('a');

	$moduleCollapsedHtml[] = $dom->saveHTML($els[0]); //$els[0]->nodeValue;
	} else {
	$moduleCollapsedHtml[] = $out;
	}

	<a data-bs-target="#multiLangModal" class="header-item-content multilanguage" title="<?php echo Text::_('MOD_MULTILANGSTATUS'); ?>" data-bs-toggle="modal" role="button">
	<div class="header-item-icon">
	<span class="icon-language" aria-hidden="true"></span>
	</div>
	<div class="header-item-text">
	<?php echo Text::_('MOD_MULTILANGSTATUS'); ?>
	</div>
	</a>
	<?php echo $modalHTML; ?>