diff options
Diffstat (limited to 'hugo/libraries/Scripts.class.php')
| -rw-r--r-- | hugo/libraries/Scripts.class.php | 244 |
1 files changed, 244 insertions, 0 deletions
diff --git a/hugo/libraries/Scripts.class.php b/hugo/libraries/Scripts.class.php new file mode 100644 index 0000000..a3057d7 --- /dev/null +++ b/hugo/libraries/Scripts.class.php @@ -0,0 +1,244 @@ +<?php +/* vim: set expandtab sw=4 ts=4 sts=4: */ +/** + * JavaScript management + * + * @package PhpMyAdmin + */ +if (! defined('PHPMYADMIN')) { + exit; +} + +/** + * Collects information about which JavaScript + * files and objects are necessary to render + * the page and generates the relevant code. + * + * @package PhpMyAdmin + */ +class PMA_Scripts +{ + /** + * An array of SCRIPT tags + * + * @access private + * @var array of strings + */ + private $_files; + /** + * An array of discrete javascript code snippets + * + * @access private + * @var array of strings + */ + private $_code; + /** + * An array of event names to bind and javascript code + * snippets to fire for the corresponding events + * + * @access private + * @var array + */ + private $_events; + + /** + * Returns HTML code to include javascript file. + * + * @param array $files The list of js file to include + * + * @return string HTML code for javascript inclusion. + */ + private function _includeFiles($files) + { + $dynamic_scripts = ""; + $params = array(); + foreach ($files as $value) { + if (strpos($value['filename'], "?") === false) { + $include = true; + if ($value['conditional_ie'] !== false && PMA_USR_BROWSER_AGENT === 'IE') { + if ($value['conditional_ie'] === true) { + $include = true; + } else if ($value['conditional_ie'] == PMA_USR_BROWSER_VER) { + $include = true; + } else { + $include = false; + } + } + if ($include) { + $params[] = "scripts[]=" . $value['filename']; + } + } else { + $dynamic_scripts .= "<script type='text/javascript' src='js/" . $value['filename'] . "'></script>"; + } + } + $static_scripts = sprintf( + "<script type='text/javascript' src='js/get_scripts.js.php?%s'></script>", + implode("&", $params) + ); + return $static_scripts . $dynamic_scripts; + } + + /** + * Generates new PMA_Scripts objects + * + * @return PMA_Scripts object + */ + public function __construct() + { + $this->_files = array(); + $this->_code = ''; + $this->_events = array(); + + } + + /** + * Adds a new file to the list of scripts + * + * @param string $filename The name of the file to include + * @param bool $conditional_ie Whether to wrap the script tag in + * conditional comments for IE + * + * @return void + */ + public function addFile($filename, $conditional_ie = false) + { + $hash = md5($filename); + if (empty($this->_files[$hash])) { + $has_onload = $this->_eventBlacklist($filename); + $this->_files[$hash] = array( + 'has_onload' => $has_onload, + 'filename' => $filename, + 'conditional_ie' => $conditional_ie + ); + } + } + + /** + * Determines whether to fire up an onload event for a file + * + * @param string $filename The name of the file to be checked + * against the blacklist + * + * @return int 1 to fire up the event, 0 not to + */ + private function _eventBlacklist($filename) + { + if ( strpos($filename, 'jquery') !== false + || strpos($filename, 'codemirror') !== false + || strpos($filename, 'messages.php') !== false + || strpos($filename, 'ajax.js') !== false + || strpos($filename, 'navigation.js') !== false + || strpos($filename, 'get_image.js.php') !== false + || strpos($filename, 'cross_framing_protection.js') !== false + ) { + return 0; + } else { + return 1; + } + } + + /** + * Adds a new code snippet to the code to be executed + * + * @param string $code The JS code to be added + * + * @return void + */ + public function addCode($code) + { + $this->_code .= "$code\n"; + } + + /** + * Adds a new event to the list of events + * + * @param string $event The name of the event to register + * @param string $function The code to execute when the event fires + * E.g: 'function () { doSomething(); }' + * or 'doSomething' + * + * @return void + */ + public function addEvent($event, $function) + { + $this->_events[] = array( + 'event' => $event, + 'function' => $function + ); + } + + /** + * Returns a list with filenames and a flag to indicate + * whether to register onload events for this file + * + * @return array + */ + public function getFiles() + { + $retval = array(); + foreach ($this->_files as $file) { + if (strpos($file['filename'], "?") === false) { + if (! $file['conditional_ie'] || PMA_USR_BROWSER_AGENT == 'IE') { + $retval[] = array( + 'name' => $file['filename'], + 'fire' => $file['has_onload'] + ); + } + } + } + return $retval; + } + + /** + * Renders all the JavaScript file inclusions, code and events + * + * @return string + */ + public function getDisplay() + { + $retval = ''; + + if (count($this->_files) > 0) { + $retval .= $this->_includeFiles( + $this->_files + ); + } + + $code = 'AJAX.scriptHandler'; + foreach ($this->_files as $file) { + $code .= sprintf( + '.add("%s",%d)', + PMA_escapeJsString($file['filename']), + $file['has_onload'] ? 1 : 0 + ); + } + $code .= ';'; + $this->addCode($code); + + $code = '$(function() {'; + foreach ($this->_files as $file) { + if ($file['has_onload']) { + $code .= 'AJAX.fireOnload("'; + $code .= PMA_escapeJsString($file['filename']); + $code .= '");'; + } + } + $code .= '});'; + $this->addCode($code); + + $retval .= '<script type="text/javascript">'; + $retval .= "// <![CDATA[\n"; + $retval .= $this->_code; + foreach ($this->_events as $js_event) { + $retval .= sprintf( + "$(window).bind('%s', %s);\n", + $js_event['event'], + $js_event['function'] + ); + } + $retval .= '// ]]>'; + $retval .= '</script>'; + + return $retval; + } +} |