phpmyadmin/libraries/Scripts.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * JavaScript management
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Collects information about which JavaScript
  14  * files and objects are necessary to render
  15  * the page and generates the relevant code.
  16  *
  17  * @package PhpMyAdmin
  18  */
  19 class PMA_Scripts
  20 {
  21     /**
  22      * An array of SCRIPT tags
  23      *
  24      * @access private
  25      * @var array of strings
  26      */
  27     private $_files;
  28     /**
  29      * An array of discrete javascript code snippets
  30      *
  31      * @access private
  32      * @var array of strings
  33      */
  34     private $_code;
  35     /**
  36      * An array of event names to bind and javascript code
  37      * snippets to fire for the corresponding events
  38      *
  39      * @access private
  40      * @var array
  41      */
  42     private $_events;
  43
  44     /**
  45      * Returns HTML code to include javascript file.
  46      *
  47      * @param array $files The list of js file to include
  48      *
  49      * @return string HTML code for javascript inclusion.
  50      */
  51     private function _includeFiles($files)
  52     {
  53         $dynamic_scripts = "";
  54         $params = array();
  55         foreach ($files as $value) {
  56             if (strpos($value['filename'], "?") === false) {
  57                 $include = true;
  58                 if ($value['conditional_ie'] !== false && PMA_USR_BROWSER_AGENT === 'IE') {
  59                     if ($value['conditional_ie'] === true) {
  60                         $include = true;
  61                     } else if ($value['conditional_ie'] == PMA_USR_BROWSER_VER) {
  62                         $include = true;
  63                     } else {
  64                         $include = false;
  65                     }
  66                 }
  67                 if ($include) {
  68                     $params[] = "scripts[]=" . $value['filename'];
  69                 }
  70             } else {
  71                 $dynamic_scripts .= "<script type='text/javascript' src='js/" . $value['filename'] . "'></script>";
  72             }
  73         }
  74         $static_scripts = sprintf(
  75             "<script type='text/javascript' src='js/get_scripts.js.php?%s'></script>",
  76             implode("&", $params)
  77         );
  78         return $static_scripts . $dynamic_scripts;
  79     }
  80
  81     /**
  82      * Generates new PMA_Scripts objects
  83      *
  84      * @return PMA_Scripts object
  85      */
  86     public function __construct()
  87     {
  88         $this->_files  = array();
  89         $this->_code   = '';
  90         $this->_events = array();
  91
  92     }
  93
  94     /**
  95      * Adds a new file to the list of scripts
  96      *
  97      * @param string $filename       The name of the file to include
  98      * @param bool   $conditional_ie Whether to wrap the script tag in
  99      *                               conditional comments for IE
 100      *
 101      * @return void
 102      */
 103     public function addFile($filename, $conditional_ie = false)
 104     {
 105         $hash = md5($filename);
 106         if (empty($this->_files[$hash])) {
 107             $has_onload = $this->_eventBlacklist($filename);
 108             $this->_files[$hash] = array(
 109                 'has_onload' => $has_onload,
 110                 'filename' => $filename,
 111                 'conditional_ie' => $conditional_ie
 112             );
 113         }
 114     }
 115
 116     /**
 117      * Determines whether to fire up an onload event for a file
 118      *
 119      * @param string $filename The name of the file to be checked
 120      *                         against the blacklist
 121      *
 122      * @return int 1 to fire up the event, 0 not to
 123      */
 124     private function _eventBlacklist($filename)
 125     {
 126         if (   strpos($filename, 'jquery') !== false
 127             || strpos($filename, 'codemirror') !== false
 128             || strpos($filename, 'messages.php') !== false
 129             || strpos($filename, 'ajax.js') !== false
 130             || strpos($filename, 'navigation.js') !== false
 131             || strpos($filename, 'get_image.js.php') !== false
 132         ) {
 133             return 0;
 134         } else {
 135             return 1;
 136         }
 137     }
 138
 139     /**
 140      * Adds a new code snippet to the code to be executed
 141      *
 142      * @param string $code The JS code to be added
 143      *
 144      * @return void
 145      */
 146     public function addCode($code)
 147     {
 148         $this->_code .= "$code\n";
 149     }
 150
 151     /**
 152      * Adds a new event to the list of events
 153      *
 154      * @param string $event    The name of the event to register
 155      * @param string $function The code to execute when the event fires
 156      *                         E.g: 'function () { doSomething(); }'
 157      *                         or 'doSomething'
 158      *
 159      * @return void
 160      */
 161     public function addEvent($event, $function)
 162     {
 163         $this->_events[] = array(
 164             'event' => $event,
 165             'function' => $function
 166         );
 167     }
 168
 169     /**
 170      * Returns a list with filenames and a flag to indicate
 171      * whether to register onload events for this file
 172      *
 173      * @return array
 174      */
 175     public function getFiles()
 176     {
 177         $retval = array();
 178         foreach ($this->_files as $file) {
 179             if (strpos($file['filename'], "?") === false) {
 180                 if (! $file['conditional_ie'] || PMA_USR_BROWSER_AGENT == 'IE') {
 181                     $retval[] = array(
 182                         'name' => $file['filename'],
 183                         'fire' => $file['has_onload']
 184                     );
 185                 }
 186             }
 187         }
 188         return $retval;
 189     }
 190
 191     /**
 192      * Renders all the JavaScript file inclusions, code and events
 193      *
 194      * @return string
 195      */
 196     public function getDisplay()
 197     {
 198         $retval = '';
 199
 200         if (count($this->_files) > 0) {
 201             $retval .= $this->_includeFiles(
 202                 $this->_files
 203             );
 204         }
 205
 206         $code = 'AJAX.scriptHandler';
 207         foreach ($this->_files as $file) {
 208             $code .= sprintf(
 209                 '.add("%s",%d)',
 210                 PMA_escapeJsString($file['filename']),
 211                 $file['has_onload'] ? 1 : 0
 212             );
 213         }
 214         $code .= ';';
 215         $this->addCode($code);
 216
 217         $code = '$(function() {';
 218         foreach ($this->_files as $file) {
 219             if ($file['has_onload']) {
 220                 $code .= 'AJAX.fireOnload("';
 221                 $code .= PMA_escapeJsString($file['filename']);
 222                 $code .= '");';
 223             }
 224         }
 225         $code .= '});';
 226         $this->addCode($code);
 227
 228         $retval .= '<script type="text/javascript">';
 229         $retval .= "// <![CDATA[\n";
 230         $retval .= $this->_code;
 231         foreach ($this->_events as $js_event) {
 232             $retval .= sprintf(
 233                 "$(window).bind('%s', %s);\n",
 234                 $js_event['event'],
 235                 $js_event['function']
 236             );
 237         }
 238         $retval .= '// ]]>';
 239         $retval .= '</script>';
 240
 241         return $retval;
 242     }
 243 }