<?php

/*

* This file is part of the DebugBar package.

*

* (c) 2013 Maxime Bouroumeau-Fuseau

*

* For the full copyright and license information, please view the LICENSE

* file that was distributed with this source code.

*/

namespace DebugBar;

use DebugBar\DataCollector\AssetProvider;

use DebugBar\DataCollector\Renderable;

/**

* Renders the debug bar using the client side javascript implementation

*

* Generates all the needed initialization code of controls

*/

class JavascriptRenderer

{

const INITIALIZE_CONSTRUCTOR = 2;

const INITIALIZE_CONTROLS = 4;

const REPLACEABLE_TAG = "{--DEBUGBAR_OB_START_REPLACE_ME--}";

const RELATIVE_PATH = 'path';

const RELATIVE_URL = 'url';

protected $debugBar;

protected $baseUrl;

protected $basePath;

protected $cssVendors = array(

'fontawesome' => 'vendor/font-awesome/css/font-awesome.min.css',

'highlightjs' => 'vendor/highlightjs/styles/github.css'

);

protected $jsVendors = array(

'jquery' => 'vendor/jquery/dist/jquery.min.js',

'highlightjs' => 'vendor/highlightjs/highlight.pack.js'

);

protected $includeVendors = true;

protected $cssFiles = array('debugbar.css', 'widgets.css', 'openhandler.css');

protected $jsFiles = array('debugbar.js', 'widgets.js', 'openhandler.js');

protected $additionalAssets = array();

protected $javascriptClass = 'PhpDebugBar.DebugBar';

protected $variableName = 'phpdebugbar';

protected $enableJqueryNoConflict = true;

protected $useRequireJs = false;

protected $theme = null;

protected $hideEmptyTabs = null;

protected $initialization;

protected $controls = array();

protected $ignoredCollectors = array();

protected $ajaxHandlerClass = 'PhpDebugBar.AjaxHandler';

protected $ajaxHandlerBindToFetch = false;

protected $ajaxHandlerBindToJquery = false;

protected $ajaxHandlerBindToXHR = true;

protected $ajaxHandlerAutoShow = true;

protected $ajaxHandlerEnableTab = false;

protected $deferDatasets = false;

protected $openHandlerClass = 'PhpDebugBar.OpenHandler';

protected $openHandlerUrl;

protected $cspNonce;

/**

* @param \DebugBar\DebugBar $debugBar

* @param string $baseUrl

* @param string $basePath

*/

public function __construct(DebugBar $debugBar, $baseUrl = null, $basePath = null)

{

$this->debugBar = $debugBar;

if ($basePath === null) {

$basePath = __DIR__ . DIRECTORY_SEPARATOR . 'Resources';

}

$this->basePath = $basePath;

if ($baseUrl === null) {

if ($basePath && str_contains($basePath, '/vendor/')) {

$baseUrl = strstr($basePath, '/vendor/');

} else {

$baseUrl = '/vendor/php-debugbar/php-debugbar/src/DebugBar/Resources';

}

}

$this->baseUrl = $baseUrl;

// bitwise operations cannot be done in class definition :(

$this->initialization = self::INITIALIZE_CONSTRUCTOR | self::INITIALIZE_CONTROLS;

}

/**

* Sets options from an array

*

* Options:

* - base_path

* - base_url

* - include_vendors

* - javascript_class

* - variable_name

* - initialization

* - enable_jquery_noconflict

* - controls

* - disable_controls

* - ignore_collectors

* - ajax_handler_classname

* - ajax_handler_bind_to_jquery

* - ajax_handler_auto_show

* - open_handler_classname

* - open_handler_url

*

* @param array $options [description]

*/

public function setOptions(array $options)

{

if (array_key_exists('base_path', $options)) {

$this->setBasePath($options['base_path']);

}

if (array_key_exists('base_url', $options)) {

$this->setBaseurl(/sitelet?url=https%3A%2F%2Fgithub.com%2FPeterMead%2Fphp-debugbar%2Fblob%2Fmaster%2Fsrc%2FDebugBar%2F%24options%5B%26%23039%3Bbase_url%26%23039%3B%5D);

}

if (array_key_exists('include_vendors', $options)) {

$this->setIncludeVendors($options['include_vendors']);

}

if (array_key_exists('javascript_class', $options)) {

$this->setJavascriptClass($options['javascript_class']);

}

if (array_key_exists('variable_name', $options)) {

$this->setVariableName($options['variable_name']);

}

if (array_key_exists('initialization', $options)) {

$this->setInitialization($options['initialization']);

}

if (array_key_exists('enable_jquery_noconflict', $options)) {

$this->setEnableJqueryNoConflict($options['enable_jquery_noconflict']);

}

if (array_key_exists('use_requirejs', $options)) {

$this->setUseRequireJs($options['use_requirejs']);

}

if (array_key_exists('theme', $options)) {

$this->setTheme($options['theme']);

}

if (array_key_exists('hide_empty_tabs', $options)) {

$this->setHideEmptyTabs($options['hide_empty_tabs']);

}

if (array_key_exists('controls', $options)) {

foreach ($options['controls'] as $name => $control) {

$this->addControl($name, $control);

}

}

if (array_key_exists('disable_controls', $options)) {

foreach ((array) $options['disable_controls'] as $name) {

$this->disableControl($name);

}

}

if (array_key_exists('ignore_collectors', $options)) {

foreach ((array) $options['ignore_collectors'] as $name) {

$this->ignoreCollector($name);

}

}

if (array_key_exists('ajax_handler_classname', $options)) {

$this->setAjaxHandlerClass($options['ajax_handler_classname']);

}

if (array_key_exists('ajax_handler_bind_to_jquery', $options)) {

$this->setBindAjaxHandlerToJquery($options['ajax_handler_bind_to_jquery']);

}

if (array_key_exists('ajax_handler_auto_show', $options)) {

$this->setAjaxHandlerAutoShow($options['ajax_handler_auto_show']);

}

if (array_key_exists('ajax_handler_enable_tab', $options)) {

$this->setAjaxHandlerEnableTab($options['ajax_handler_enable_tab']);

}

if (array_key_exists('defer_datasets', $options)) {

$this->setDeferDatasets($options['defer_datasets']);

}

if (array_key_exists('open_handler_classname', $options)) {

$this->setOpenHandlerClass($options['open_handler_classname']);

}

if (array_key_exists('open_handler_url', $options)) {

$this->setOpenHandlerurl(/sitelet?url=https%3A%2F%2Fgithub.com%2FPeterMead%2Fphp-debugbar%2Fblob%2Fmaster%2Fsrc%2FDebugBar%2F%24options%5B%26%23039%3Bopen_handler_url%26%23039%3B%5D);

}

if (array_key_exists('csp_nonce', $options)) {

$this->setCspNonce($options['csp_nonce']);

}

}

/**

* Sets the path which assets are relative to

*

* @param string $path

*/

public function setBasePath($path)

{

$this->basePath = $path;

return $this;

}

/**

* Returns the path which assets are relative to

*

* @return string

*/

public function getBasePath()

{

return $this->basePath;

}

/**

* Sets the base URL from which assets will be served

*

* @param string $url

*/

public function setBaseurl(/sitelet?url=https%3A%2F%2Fgithub.com%2FPeterMead%2Fphp-debugbar%2Fblob%2Fmaster%2Fsrc%2FDebugBar%2F%24url)

{

$this->baseUrl = $url;

return $this;

}

/**

* Returns the base URL from which assets will be served

*

* @return string

*/

public function getBaseurl()

{

return $this->baseUrl;

}

/**

* Whether to include vendor assets

*

* You can only include js or css vendors using

* setIncludeVendors('css') or setIncludeVendors('js')

*

* @param boolean $enabled

*/

public function setIncludeVendors($enabled = true)

{

if (is_string($enabled)) {

$enabled = array($enabled);

}

$this->includeVendors = $enabled;

if (!$enabled || (is_array($enabled) && !in_array('js', $enabled))) {

// no need to call jQuery.noConflict() if we do not include our own version

$this->enableJqueryNoConflict = false;

}

return $this;

}

/**

* Checks if vendors assets are included

*

* @return boolean

*/

public function areVendorsIncluded()

{

return $this->includeVendors !== false;

}

/**

* Disable a specific vendor's assets.

*

* @param string $name "jquery", "fontawesome", "highlightjs"

*

* @return void

*/

public function disableVendor($name)

{

if (array_key_exists($name, $this->cssVendors)) {

unset($this->cssVendors[$name]);

}

if (array_key_exists($name, $this->jsVendors)) {

unset($this->jsVendors[$name]);

}

}

/**

* Sets the javascript class name

*

* @param string $className

*/

public function setJavascriptClass($className)

{

$this->javascriptClass = $className;

return $this;

}

/**

* Returns the javascript class name

*

* @return string

*/

public function getJavascriptClass()

{

return $this->javascriptClass;

}

/**

* Sets the variable name of the class instance

*

* @param string $name

*/

public function setVariableName($name)

{

$this->variableName = $name;

return $this;

}

/**

* Returns the variable name of the class instance

*

* @return string

*/

public function getVariableName()

{

return $this->variableName;

}

/**

* Sets what should be initialized

*

* - INITIALIZE_CONSTRUCTOR: only initializes the instance

* - INITIALIZE_CONTROLS: initializes the controls and data mapping

* - INITIALIZE_CONSTRUCTOR | INITIALIZE_CONTROLS: initialize everything (default)

*

* @param integer $init

*/

public function setInitialization($init)

{

$this->initialization = $init;

return $this;

}

/**

* Returns what should be initialized

*

* @return integer

*/

public function getInitialization()

{

return $this->initialization;

}

/**

* Sets whether to call jQuery.noConflict()

*

* @param boolean $enabled

*/

public function setEnableJqueryNoConflict($enabled = true)

{

$this->enableJqueryNoConflict = $enabled;

return $this;

}

/**

* Checks if jQuery.noConflict() will be called

*

* @return boolean

*/

public function isJqueryNoConflictEnabled()

{

return $this->enableJqueryNoConflict;

}

/**

* Sets whether to use RequireJS or not

*

* @param boolean $enabled

* @return $this

*/

public function setUseRequireJs($enabled = true)

{

$this->useRequireJs = $enabled;

return $this;

}

/**

* Checks if RequireJS is used

*

* @return boolean

*/

public function isRequireJsUsed()

{

return $this->useRequireJs;

}

/**

* Sets the default theme

*

* @param boolean $hide

* @return $this

*/

public function setTheme($theme='auto')

{

$this->theme = $theme;

return $this;

}

/**

* Sets whether to hide empty tabs or not

*

* @param boolean $hide

* @return $this

*/

public function setHideEmptyTabs($hide = true)

{

$this->hideEmptyTabs = $hide;

return $this;

}

/**

* Checks if empty tabs are hidden or not

*

* @return boolean

*/

public function areEmptyTabsHidden()

{

return $this->hideEmptyTabs;

}

/**

* Adds a control to initialize

*

* Possible options:

* - icon: icon name

* - tooltip: string

* - widget: widget class name

* - title: tab title

* - map: a property name from the data to map the control to

* - default: a js string, default value of the data map

*

* "icon" or "widget" are at least needed

*

* @param string $name

* @param array $options

*/

public function addControl($name, array $options)

{

if (count(array_intersect(array_keys($options), array('icon', 'widget', 'tab', 'indicator'))) === 0) {

throw new DebugBarException("Not enough options for control '$name'");

}

$this->controls[$name] = $options;

return $this;

}

/**

* Disables a control

*

* @param string $name

*/

public function disableControl($name)

{

$this->controls[$name] = null;

return $this;

}

/**

* Returns the list of controls

*

* This does not include controls provided by collectors

*

* @return array

*/

public function getControls()

{

return $this->controls;

}

/**

* Ignores widgets provided by a collector

*

* @param string $name

*/

public function ignoreCollector($name)

{

$this->ignoredCollectors[] = $name;

return $this;

}

/**

* Returns the list of ignored collectors

*

* @return array

*/

public function getIgnoredCollectors()

{

return $this->ignoredCollectors;

}

/**

* Sets the class name of the ajax handler

*

* Set to false to disable

*

* @param string $className

*/

public function setAjaxHandlerClass($className)

{

$this->ajaxHandlerClass = $className;

return $this;

}

/**

* Returns the class name of the ajax handler

*

* @return string

*/

public function getAjaxHandlerClass()

{

return $this->ajaxHandlerClass;

}

/**

* Sets whether to call bindToFetch() on the ajax handler

*

* @param boolean $bind

*/

public function setBindAjaxHandlerToFetch($bind = true)

{

$this->ajaxHandlerBindToFetch = $bind;

return $this;

}

/**

* Checks whether bindToFetch() will be called on the ajax handler

*

* @return boolean

*/

public function isAjaxHandlerBoundToFetch()

{

return $this->ajaxHandlerBindToFetch;

}

/**

* Sets whether to call bindToJquery() on the ajax handler

*

* @param boolean $bind

* @deprecated use setBindAjaxHandlerToXHR

*/

public function setBindAjaxHandlerToJquery($bind = true)

{

$this->ajaxHandlerBindToJquery = $bind;

return $this;

}

/**

* Checks whether bindToJquery() will be called on the ajax handler

*

* @return boolean

* @deprecated use isAjaxHandlerBoundToXHR

*/

public function isAjaxHandlerBoundToJquery()

{

return $this->ajaxHandlerBindToJquery;

}

/**

* Sets whether to call bindToXHR() on the ajax handler

*

* @param boolean $bind

*/

public function setBindAjaxHandlerToXHR($bind = true)

{

$this->ajaxHandlerBindToXHR = $bind;

return $this;

}

/**

* Checks whether bindToXHR() will be called on the ajax handler

*

* @return boolean

*/

public function isAjaxHandlerBoundToXHR()

{

return $this->ajaxHandlerBindToXHR;

}

/**

* Sets whether new ajax debug data will be immediately shown. Setting to false could be useful

* if there are a lot of tracking events cluttering things.

*

* @param boolean $autoShow

*/

public function setAjaxHandlerAutoShow($autoShow = true)

{

$this->ajaxHandlerAutoShow = $autoShow;

return $this;

}

/**

* Checks whether the ajax handler will immediately show new ajax requests.

*

* @return boolean

*/

public function isAjaxHandlerAutoShow()

{

return $this->ajaxHandlerAutoShow;

}

/**

* Sets whether new ajax debug data will be shown in a separate tab instead of dropdown.

*

* @param boolean $enabled

*/

public function setAjaxHandlerEnableTab($enabled = true)

{

$this->ajaxHandlerEnableTab = $enabled;

return $this;

}

/**

* Check if the Ajax Handler History tab is enabled

*

* @return boolean

*/

public function isAjaxHandlerTabEnabled()

{

return $this->ajaxHandlerEnableTab;

}

/**

* Sets whether datasets are directly loaded or deferred

*

* @param boolean $enabled

*/

public function setDeferDatasets($defer = true)

{

$this->deferDatasets = $defer;

return $this;

}

/**

* Check if the datasets are deffered

*

* @return boolean

*/

public function areDatasetsDeferred()

{

return $this->deferDatasets;

}

/**

* Sets the class name of the js open handler

*

* @param string $className

*/

public function setOpenHandlerClass($className)

{

$this->openHandlerClass = $className;

return $this;

}

/**

* Returns the class name of the js open handler

*

* @return string

*/

public function getOpenHandlerClass()

{

return $this->openHandlerClass;

}

/**

* Sets the url of the open handler

*

* @param string $url

*/

public function setOpenHandlerurl(/sitelet?url=https%3A%2F%2Fgithub.com%2FPeterMead%2Fphp-debugbar%2Fblob%2Fmaster%2Fsrc%2FDebugBar%2F%24url)

{

$this->openHandlerUrl = $url;

return $this;

}

/**

* Returns the url for the open handler

*

* @return string

*/

public function getOpenHandlerurl()

{

return $this->openHandlerUrl;

}

/**

* Sets the CSP Nonce (or remove it by setting to null)

*

* @param string|null $nonce

* @return $this

*/

public function setCspNonce($nonce = null)

{

$this->cspNonce = $nonce;

return $this;

}

/**

* Get the CSP Nonce

*

* @return string|null

*/

public function getCspNonce()

{

return $this->cspNonce;

}

/**

* Add assets stored in files to render in the head

*

* @param array $cssFiles An array of filenames

* @param array $jsFiles An array of filenames

* @param string $basePath Base path of those files

* @param string $baseUrl Base url of those files

* @return $this

*/

public function addAssets($cssFiles, $jsFiles, $basePath = null, $baseUrl = null)

{

$this->additionalAssets[] = array(

'base_path' => $basePath,

'base_url' => $baseUrl,

'css' => (array) $cssFiles,

'js' => (array) $jsFiles

);

return $this;

}

/**

* Add inline assets to render inline in the head. Ideally, you should store static assets in

* files that you add with the addAssets function. However, adding inline assets is useful when

* integrating with 3rd-party libraries that require static assets that are only available in an

* inline format.

*

* The inline content arrays require special string array keys: they are used to deduplicate

* content. This is particularly useful if multiple instances of the same asset end up being

* added. Inline assets from all collectors are merged together into the same array, so these

* content IDs effectively deduplicate the inline assets.

*

* @param array $inlineCss An array map of content ID to inline CSS content (not including <style> tag)

* @param array $inlineJs An array map of content ID to inline JS content (not including <script> tag)

* @param array $inlineHead An array map of content ID to arbitrary inline HTML content (typically

* <style>/<script> tags); it must be embedded within the <head> element

* @return $this

*/

public function addInlineAssets($inlineCss, $inlineJs, $inlineHead)

{

$this->additionalAssets[] = array(

'inline_css' => (array) $inlineCss,

'inline_js' => (array) $inlineJs,

'inline_head' => (array) $inlineHead

);

return $this;

}

/**

* Returns the list of asset files

*

* @param string $type 'css', 'js', 'inline_css', 'inline_js', 'inline_head', or null for all

* @param string $relativeTo The type of path to which filenames must be relative (path, url or null)

* @return array

*/

public function getAssets($type = null, $relativeTo = self::RELATIVE_PATH)

{

$cssFiles = $this->cssFiles;

$jsFiles = $this->jsFiles;

$inlineCss = array();

$inlineJs = array();

$inlineHead = array();

if ($this->includeVendors !== false) {

if ($this->includeVendors === true || in_array('css', $this->includeVendors)) {

$cssFiles = array_merge($this->cssVendors, $cssFiles);

}

if ($this->includeVendors === true || in_array('js', $this->includeVendors)) {

$jsFiles = array_merge($this->jsVendors, $jsFiles);

}

}

if ($relativeTo) {

$root = $this->getRelativeRoot($relativeTo, $this->basePath, $this->baseUrl);

$cssFiles = $this->makeUriRelativeTo($cssFiles, $root);

$jsFiles = $this->makeUriRelativeTo($jsFiles, $root);

}

$additionalAssets = $this->additionalAssets;

// finds assets provided by collectors

foreach ($this->debugBar->getCollectors() as $collector) {

if (($collector instanceof AssetProvider) && !in_array($collector->getName(), $this->ignoredCollectors)) {

$additionalAssets[] = $collector->getAssets();

}

}

foreach ($additionalAssets as $assets) {

$basePath = isset($assets['base_path']) ? $assets['base_path'] : '';

$baseUrl = isset($assets['base_url']) ? $assets['base_url'] : '';

$root = $this->getRelativeRoot($relativeTo,

$this->makeUriRelativeTo($basePath, $this->basePath),

$this->makeUriRelativeTo($baseUrl, $this->baseUrl));

if (isset($assets['css'])) {

$cssFiles = array_merge($cssFiles, $this->makeUriRelativeTo((array) $assets['css'], $root));

}

if (isset($assets['js'])) {

$jsFiles = array_merge($jsFiles, $this->makeUriRelativeTo((array) $assets['js'], $root));

}

if (isset($assets['inline_css'])) {

$inlineCss = array_merge($inlineCss, (array) $assets['inline_css']);

}

if (isset($assets['inline_js'])) {

$inlineJs = array_merge($inlineJs, (array) $assets['inline_js']);

}

if (isset($assets['inline_head'])) {

$inlineHead = array_merge($inlineHead, (array) $assets['inline_head']);

}

}

// Deduplicate files

$cssFiles = array_unique($cssFiles);

$jsFiles = array_unique($jsFiles);

return $this->filterAssetArray(array($cssFiles, $jsFiles, $inlineCss, $inlineJs, $inlineHead), $type ?? '');

}

/**

* Returns the correct base according to the type

*

* @param string $relativeTo

* @param string $basePath

* @param string $baseUrl

* @return string

*/

protected function getRelativeRoot($relativeTo, $basePath, $baseUrl)

{

if ($relativeTo === self::RELATIVE_PATH) {

return $basePath;

}

if ($relativeTo === self::RELATIVE_URL) {

return $baseUrl;

}

return null;

}

/**

* Makes a URI relative to another

*

* @param string|array $uri

* @param string $root

* @return string

*/

protected function makeUriRelativeTo($uri, $root)

{

if (!$root) {

return $uri;

}

if (is_array($uri)) {

$uris = array();

foreach ($uri as $u) {

$uris[] = $this->makeUriRelativeTo($u, $root);

}

return $uris;

}

$uri = $uri ?? '';

if (substr($uri, 0, 1) === '/' || preg_match('/^([a-zA-Z]+:\/\/|[a-zA-Z]:\/|[a-zA-Z]:\\\)/', $uri)) {

return $uri;

}

return rtrim($root, '/') . "/$uri";

}

/**

* Filters a tuple of (css, js, inline_css, inline_js, inline_head) assets according to $type

*

* @param array $array

* @param string $type 'css', 'js', 'inline_css', 'inline_js', 'inline_head', or null for all

* @return array

*/

protected function filterAssetArray($array, $type = '')

{

$types = array('css', 'js', 'inline_css', 'inline_js', 'inline_head');

$typeIndex = array_search(strtolower($type ?? ''), $types);

return $typeIndex !== false ? $array[$typeIndex] : $array;

}

/**

* Returns an array where all items are Assetic AssetCollection:

* - The first one contains the CSS files

* - The second one contains the JS files

* - The third one contains arbitrary inline HTML (typically composed of <script>/<style>

* elements); it must be embedded within the <head> element

*

* @param string $type Optionally return only 'css', 'js', or 'inline_head' collection

* @return array|\Assetic\Asset\AssetCollection

*/

public function getAsseticCollection($type = null)

{

$types = array('css', 'js', 'inline_head');

$typeIndex = array_search(strtolower($type), $types);

list($cssFiles, $jsFiles, $inlineCss, $inlineJs, $inlineHead) = $this->getAssets();

$collections = array(

$this->createAsseticCollection($cssFiles, $inlineCss),

$this->createAsseticCollection($jsFiles, $inlineJs),

$this->createAsseticCollection(null, $inlineHead)

);

return $typeIndex !== false ? $collections[$typeIndex] : $collections;

}

/**

* Create an Assetic AssetCollection with the given content.

* Filenames will be converted to absolute path using

* the base path.

*

* @param array|null $files Array of asset filenames.

* @param array|null $content Array of inline asset content.

* @return \Assetic\Asset\AssetCollection

*/

protected function createAsseticCollection($files = null, $content = null)

{

$assets = array();

if ($files) {

foreach ($files as $file) {

$assets[] = new \Assetic\Asset\FileAsset($file);

}

}

if ($content) {

foreach ($content as $item) {

$assets[] = new \Assetic\Asset\StringAsset($item);

}

}

return new \Assetic\Asset\AssetCollection($assets);

}

/**

* Write all CSS assets to standard output or in a file

*

* @param string $targetFilename

*/

public function dumpCssAssets($targetFilename = null)

{

$this->dumpAssets($this->getAssets('css'), $this->getAssets('inline_css'), $targetFilename);

}

/**

* Write all JS assets to standard output or in a file

*

* @param string $targetFilename

*/

public function dumpJsAssets($targetFilename = null)

{

$this->dumpAssets($this->getAssets('js'), $this->getAssets('inline_js'), $targetFilename, $this->useRequireJs);

}

/**

* Write all inline HTML header assets to standard output or in a file (only returns assets not

* already returned by dumpCssAssets or dumpJsAssets)

*

* @param string $targetFilename

*/

public function dumpHeadAssets($targetFilename = null)

{

$this->dumpAssets(null, $this->getAssets('inline_head'), $targetFilename);

}

/**

* Write assets to standard output or in a file

*