Index: includes/common.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/common.inc,v retrieving revision 1.811 diff -u -r1.811 common.inc --- includes/common.inc 26 Oct 2008 18:06:38 -0000 1.811 +++ includes/common.inc 27 Oct 2008 17:12:46 -0000 @@ -25,6 +25,21 @@ define('SAVED_DELETED', 3); /** + * The weight of JavaScript libraries being added to the page. + */ +define('JS_WEIGHT_LIBRARY', -10); + +/** + * The default weight of JavaScript being added to the page. + */ +define('JS_WEIGHT_DEFAULT', 0); + +/** + * The weight of theme JavaScript code being added to the page. + */ +define('JS_WEIGHT_THEME', 10); + +/** * Set content for a specified region. * * @param $region @@ -2059,7 +2074,7 @@ * reference to an existing file or as inline code. The following actions can be * performed using this function: * - * - Add a file ('core', 'module' and 'theme'): + * - Add a file ('file'): * Adds a reference to a JavaScript file to the page. JavaScript files * are placed in a certain order, from 'core' first, to 'module' and finally * 'theme' so that files, that are added later, can override previously added @@ -2078,33 +2093,45 @@ * Examples: * @code * drupal_add_js('misc/collapse.js'); - * drupal_add_js('misc/collapse.js', 'module'); + * drupal_add_js('misc/collapse.js', 'file'); * drupal_add_js('$(document).ready(function(){alert("Hello!");});', - * array('type' => 'inline', 'scope' => 'footer') + * array('type' => 'inline', 'scope' => 'footer', 'weight' => 5) * ); * @endcode * * @param $data * (optional) If given, the value depends on the $options parameter: - * - 'core', 'module' or 'theme': Path to the file relative to base_path(). + * - 'file': Path to the file relative to base_path(). * - 'inline': The JavaScript code that should be placed in the given scope. * - 'setting': An array with configuration options as associative array. The - * array is directly placed in Drupal.settings. You might want to wrap your - * actual configuration settings in another variable to prevent the pollution - * of the Drupal.settings namespace. + * array is directly placed in Drupal.settings. You might want to wrap + * your actual configuration settings in another variable to prevent + * the pollution of the Drupal.settings namespace. * @param $options * (optional) A string defining the type of JavaScript that is being added - * in the $data parameter ('core', 'module', 'theme', 'setting', 'inline'), - * or an array which can have any or all of the following keys (these are - * not valid with type => 'setting'): + * in the $data parameter ('file', 'setting', 'inline'), or an array which + * can have any or all of the following keys (these are not valid when the + * type is 'setting'): * - type * The type of JavaScript that should be added to the page. Allowed - * values are 'core', 'module', 'theme', 'inline' and 'setting'. Defaults - * to 'module'. + * values are 'file', 'inline' and 'setting'. Defaults to 'file'. * - scope * The location in which you want to place the script. Possible * values are 'header' and 'footer'. If your theme implements different * locations, however, you can also use these. Defaults to 'header'. + * - weight + * A number defining the order in which the JavaScript is added to the + * page. In some cases, the order in which the JavaScript is presented + * on the page is very important. Behaviors, for example, require + * registration before being put to use. + * + * Possible constants are JS_WEIGHT_LIBRARY, which is commonly used + * for any JavaScript libraries or jQuery plugins, JS_WEIGHT_DEFAULT, + * which is commonly used for any module-layer JavaScript, or + * JS_WEIGHT_THEME, which is commonly used for any theme-layer + * JavaScript. If you need to invoke a JavaScript file before any + * other module's JavaScript, for example, you would use + * JS_WEIGHT_DEFAULT - 1. Defaults to JS_WEIGHT_DEFAULT. * - defer * If set to TRUE, the defer attribute is set on the \n"; break; case 'inline': - foreach ($data as $info) { - $output .= '\n"; + foreach ($data as $weight => $settings) { + foreach ($settings as $info) { + $output .= '\n"; + } } break; - default: + case 'file': // If JS preprocessing is off, we still need to output the scripts. // Additionally, go through any remaining scripts if JS preprocessing is on and output the non-cached ones. - foreach ($data as $path => $info) { - if (!$info['preprocess'] || !$is_writable || !$preprocess_js) { - $no_preprocess[$type] .= '\n"; - } - else { - $files[$path] = $info; + foreach ($data as $weight => $paths) { + foreach ($paths as $path => $info) { + if (!$info['preprocess'] || !$is_writable || !$preprocess_js) { + $no_preprocess .= '\n"; + } + else { + $files[$path] = $info; + } } } } @@ -2288,9 +2332,7 @@ // Keep the order of JS files consistent as some are preprocessed and others are not. // Make sure any inline or JS setting variables appear last after libraries have loaded. - $output = $preprocessed . implode('', $no_preprocess) . $output; - - return $output; + return $preprocessed . $no_preprocess . $output; } /** @@ -2403,7 +2445,10 @@ function drupal_add_tabledrag($table_id, $action, $relationship, $group, $subgroup = NULL, $source = NULL, $hidden = TRUE, $limit = 0) { static $js_added = FALSE; if (!$js_added) { - drupal_add_js('misc/tabledrag.js', 'core'); + // Add the table drag JavaScript to the page before the module JavaScript + // to ensure that table drag behaviors are registered before any module + // uses it. + drupal_add_js('misc/tabledrag.js', array('weight' => JS_WEIGHT_DEFAULT - 1)); $js_added = TRUE; } Index: includes/batch.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/batch.inc,v retrieving revision 1.26 diff -u -r1.26 batch.inc --- includes/batch.inc 22 Oct 2008 19:39:36 -0000 1.26 +++ includes/batch.inc 27 Oct 2008 17:12:45 -0000 @@ -84,7 +84,7 @@ // error messages. Only safe strings should be passed in to batch_set(). $current_set = _batch_current_set(); drupal_set_title($current_set['title'], PASS_THROUGH); - drupal_add_js('misc/progress.js', array('type' => 'core', 'cache' => FALSE)); + drupal_add_js('misc/progress.js', array('cache' => FALSE)); $url = url($batch['url'], array('query' => array('id' => $batch['id']))); $js_setting = array( @@ -95,7 +95,7 @@ ), ); drupal_add_js($js_setting, 'setting'); - drupal_add_js('misc/batch.js', array('type' => 'core', 'cache' => FALSE)); + drupal_add_js('misc/batch.js', array('cache' => FALSE)); $output = '
'; return $output; Index: includes/form.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/form.inc,v retrieving revision 1.298 diff -u -r1.298 form.inc --- includes/form.inc 27 Oct 2008 10:34:09 -0000 1.298 +++ includes/form.inc 27 Oct 2008 17:12:46 -0000 @@ -1879,7 +1879,7 @@ // Adding the same javascript settings twice will cause a recursion error, // we avoid the problem by checking if the javascript has already been added. if (isset($element['#ahah']['path']) && isset($element['#ahah']['event']) && !isset($js_added[$element['#id']])) { - drupal_add_js('misc/jquery.form.js'); + drupal_add_js('misc/jquery.form.js', array('weight' => JS_WEIGHT_LIBRARY)); drupal_add_js('misc/ahah.js'); $ahah_binding = array( @@ -1905,7 +1905,7 @@ // Add progress.js if we're doing a bar display. if ($ahah_binding['progress']['type'] == 'bar') { - drupal_add_js('misc/progress.js'); + drupal_add_js('misc/progress.js', array('cache' => FALSE)); } drupal_add_js(array('ahah' => array($element['#id'] => $ahah_binding)), 'setting'); Index: includes/theme.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/theme.inc,v retrieving revision 1.446 diff -u -r1.446 theme.inc --- includes/theme.inc 26 Oct 2008 18:06:38 -0000 1.446 +++ includes/theme.inc 27 Oct 2008 17:12:46 -0000 @@ -158,7 +158,7 @@ // Add scripts used by this theme. foreach ($final_scripts as $script) { - drupal_add_js($script, 'theme'); + drupal_add_js($script, array('weight' => JS_WEIGHT_THEME)); } $theme_engine = NULL; Index: modules/node/node.admin.inc =================================================================== RCS file: /cvs/drupal/drupal/modules/node/node.admin.inc,v retrieving revision 1.27 diff -u -r1.27 node.admin.inc --- modules/node/node.admin.inc 12 Oct 2008 04:30:06 -0000 1.27 +++ modules/node/node.admin.inc 27 Oct 2008 17:12:46 -0000 @@ -254,7 +254,7 @@ $form['filters']['buttons']['reset'] = array('#type' => 'submit', '#value' => t('Reset')); } - drupal_add_js('misc/form.js', 'core'); + drupal_add_js('misc/form.js'); return $form; } Index: modules/simpletest/simpletest.module =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/simpletest.module,v retrieving revision 1.22 diff -u -r1.22 simpletest.module --- modules/simpletest/simpletest.module 26 Oct 2008 18:06:39 -0000 1.22 +++ modules/simpletest/simpletest.module 27 Oct 2008 17:12:46 -0000 @@ -199,15 +199,15 @@ } function theme_simpletest_test_table($table) { - drupal_add_css(drupal_get_path('module', 'simpletest') . '/simpletest.css'); - drupal_add_js(drupal_get_path('module', 'simpletest') . '/simpletest.js', 'module'); - // Create header for test selection table. $header = array( theme('table_select_header_cell'), array('data' => t('Test'), 'class' => 'simpletest_test'), array('data' => t('Description'), 'class' => 'simpletest_description'), ); + drupal_add_css(drupal_get_path('module', 'simpletest') . '/simpletest.css'); + drupal_add_js(drupal_get_path('module', 'simpletest') . '/simpletest.js'); + // Define the images used to expand/collapse the test groups. $js = array( Index: modules/locale/locale.module =================================================================== RCS file: /cvs/drupal/drupal/modules/locale/locale.module,v retrieving revision 1.230 diff -u -r1.230 locale.module --- modules/locale/locale.module 22 Oct 2008 19:39:36 -0000 1.230 +++ modules/locale/locale.module 27 Oct 2008 17:12:46 -0000 @@ -523,17 +523,19 @@ $files = $new_files = FALSE; foreach ($javascript as $scope) { - foreach ($scope as $type => $data) { + foreach ($scope as $type => $weight) { if ($type != 'setting' && $type != 'inline') { - foreach ($data as $filepath => $info) { - $files = TRUE; - if (!in_array($filepath, $parsed)) { - // Don't parse our own translations files. - if (substr($filepath, 0, strlen($dir)) != $dir) { - locale_inc_callback('_locale_parse_js_file', $filepath); - watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath)); - $parsed[] = $filepath; - $new_files = TRUE; + foreach ($weight as $data) { + foreach ($data as $filepath => $info) { + $files = TRUE; + if (!in_array($filepath, $parsed)) { + // Don't parse our own translations files. + if (substr($filepath, 0, strlen($dir)) != $dir) { + locale_inc_callback('_locale_parse_js_file', $filepath); + watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath)); + $parsed[] = $filepath; + $new_files = TRUE; + } } } } @@ -566,7 +568,7 @@ // Add the translation JavaScript file to the page. if ($files && !empty($language->javascript)) { - drupal_add_js($dir . '/' . $language->language . '_' . $language->javascript . '.js', 'core'); + drupal_add_js($dir . '/' . $language->language . '_' . $language->javascript . '.js'); } } Index: modules/user/user.admin.inc =================================================================== RCS file: /cvs/drupal/drupal/modules/user/user.admin.inc,v retrieving revision 1.30 diff -u -r1.30 user.admin.inc --- modules/user/user.admin.inc 19 Oct 2008 21:19:02 -0000 1.30 +++ modules/user/user.admin.inc 27 Oct 2008 17:12:46 -0000 @@ -83,7 +83,7 @@ ); } - drupal_add_js('misc/form.js', 'core'); + drupal_add_js('misc/form.js'); return $form; } Index: modules/user/user.module =================================================================== RCS file: /cvs/drupal/drupal/modules/user/user.module,v retrieving revision 1.930 diff -u -r1.930 user.module --- modules/user/user.module 26 Oct 2008 18:06:39 -0000 1.930 +++ modules/user/user.module 27 Oct 2008 17:12:46 -0000 @@ -2160,7 +2160,7 @@ global $user; // Only need to do once per page. if (!$complete) { - drupal_add_js(drupal_get_path('module', 'user') . '/user.js', 'module'); + drupal_add_js(drupal_get_path('module', 'user') . '/user.js'); drupal_add_js(array( 'password' => array( Index: modules/system/system.admin.inc =================================================================== RCS file: /cvs/drupal/drupal/modules/system/system.admin.inc,v retrieving revision 1.102 diff -u -r1.102 system.admin.inc --- modules/system/system.admin.inc 16 Oct 2008 20:23:08 -0000 1.102 +++ modules/system/system.admin.inc 27 Oct 2008 17:12:46 -0000 @@ -1528,7 +1528,7 @@ * @see system_date_time_settings_submit() */ function system_date_time_settings() { - drupal_add_js(drupal_get_path('module', 'system') . '/system.js', 'module'); + drupal_add_js(drupal_get_path('module', 'system') . '/system.js'); drupal_add_js(array('dateTime' => array('lookup' => url('admin/settings/date-time/lookup'))), 'setting'); // Date settings: @@ -1736,7 +1736,7 @@ if (!variable_get('clean_url', 0)) { if (strpos(request_uri(), '?q=') !== FALSE) { - drupal_add_js(drupal_get_path('module', 'system') . '/system.js', 'module'); + drupal_add_js(drupal_get_path('module', 'system') . '/system.js'); $form['clean_url']['#description'] .= ' ' . t('Before enabling clean URLs, you must perform a test to determine if your server is properly configured. If you are able to see this page again after clicking the "Run the clean URL test" link, the test has succeeded and the radio buttons above will be available. If instead you are directed to a "Page not found" error, you will need to change the configuration of your server. The handbook page on Clean URLs has additional troubleshooting information.', array('@handbook' => 'http://drupal.org/node/15365')) . ''; Index: modules/simpletest/tests/common.test =================================================================== RCS file: /cvs/drupal/drupal/modules/simpletest/tests/common.test,v retrieving revision 1.10 diff -u -r1.10 common.test --- modules/simpletest/tests/common.test 26 Oct 2008 18:06:39 -0000 1.10 +++ modules/simpletest/tests/common.test 27 Oct 2008 17:12:46 -0000 @@ -307,6 +307,11 @@ */ class JavaScriptTestCase extends DrupalWebTestCase { /** + * Store configured value for JavaScript preprocessing. + */ + var $preprocess_js; + + /** * Implementation of getInfo(). */ function getInfo() { @@ -316,34 +321,48 @@ 'group' => t('System') ); } - + /** * Implementation of setUp(). */ function setUp() { // Reset drupal_add_js() before each test. drupal_add_js(NULL, NULL, TRUE); + // Disable Preprocessing + $this->preprocess_js = variable_get('preprocess_js', 0); + variable_set('preprocess_js', 0); + // Enable locale in test enviornment. + parent::setUp('locale'); } - + + /** + * Implementation of tearDown() + */ + function tearDown() { + // Restore configured value for JavaScript preprocessing. + variable_set('preprocess_js', $this->preprocess_js); + parent::tearDown(); + } + /** * Test default JavaScript is empty. */ function testDefault() { $this->assertEqual(array(), drupal_add_js(), t('Default JavaScript is empty.')); } - + /** * Test adding a JavaScript file. */ function testAddFile() { drupal_add_js('misc/collapse.js'); $javascript = drupal_add_js(); - $this->assertTrue(array_key_exists('misc/jquery.js', $javascript['header']['core']), t('jQuery is added when a file is added.')); - $this->assertTrue(array_key_exists('misc/drupal.js', $javascript['header']['core']), t('Drupal.js is added when file is added.')); - $this->assertTrue(array_key_exists('misc/collapse.js', $javascript['header']['module']), t('JavaScript files are correctly added.')); + $this->assertTrue(array_key_exists('misc/jquery.js', $javascript['header']['file'][JS_WEIGHT_LIBRARY]), t('jQuery is added when a file is added.')); + $this->assertTrue(array_key_exists('misc/drupal.js', $javascript['header']['file'][JS_WEIGHT_LIBRARY]), t('Drupal.js is added when file is added.')); + $this->assertTrue(array_key_exists('misc/collapse.js', $javascript['header']['file'][JS_WEIGHT_DEFAULT]), t('JavaScript files are correctly added.')); $this->assertEqual(base_path(), $javascript['header']['setting'][0]['basePath'], t('Base path JavaScript setting is correctly set.')); } - + /** * Test adding settings. */ @@ -353,7 +372,7 @@ $this->assertEqual(280342800, $javascript['header']['setting'][1]['dries'], t('JavaScript setting is set correctly.')); $this->assertEqual('rocks', $javascript['header']['setting'][1]['drupal'], t('The other JavaScript setting is set correctly.')); } - + /** * Test drupal_get_js() for JavaScript settings. */ @@ -364,16 +383,16 @@ $this->assertTrue(strpos($javascript, 'testSetting') > 0, t('Rendered JavaScript header returns custom setting.')); $this->assertTrue(strpos($javascript, 'misc/jquery.js') > 0, t('Rendered JavaScript header includes jQuery.')); } - + /** * Test to see if resetting the JavaScript empties the cache. */ function testReset() { drupal_add_js('misc/collapse.js'); - drupal_add_js(NULL, NULL, TRUE); + drupal_add_js(NULL, NULL, TRUE); $this->assertEqual(array(), drupal_add_js(), t('Resetting the JavaScript correctly empties the cache.')); } - + /** * Test adding inline scripts. */ @@ -381,10 +400,10 @@ $inline = '$(document).ready(function(){});'; drupal_add_js($inline, array('type' => 'inline', 'scope' => 'footer')); $javascript = drupal_add_js(); - $this->assertTrue(array_key_exists('misc/jquery.js', $javascript['header']['core']), t('jQuery is added when inline scripts are added.')); - $this->assertEqual($inline, $javascript['footer']['inline'][0]['code'], t('Inline JavaScript is correctly added to the footer.')); + $this->assertTrue(array_key_exists('misc/jquery.js', $javascript['header']['file'][JS_WEIGHT_LIBRARY]), t('jQuery is added when inline scripts are added.')); + $this->assertEqual($inline, $javascript['footer']['inline'][JS_WEIGHT_DEFAULT][0]['code'], t('Inline JavaScript is correctly added to the footer.')); } - + /** * Test drupal_get_js() with a footer scope. */ @@ -394,14 +413,23 @@ $javascript = drupal_get_js('footer'); $this->assertTrue(strpos($javascript, $inline) > 0, t('Rendered JavaScript footer returns the inline code.')); } - + /** * Test drupal_add_js() sets preproccess to false when cache is set to false. */ function testNoCache() { drupal_add_js('misc/collapse.js', array('cache' => FALSE)); $javascript = drupal_add_js(); - $this->assertTrue(!$javascript['header']['module']['misc/collapse.js']['preprocess'], t('Setting cache to FALSE sets proprocess to FALSE when adding JavaScript.')); + $this->assertFalse($javascript['header']['file'][JS_WEIGHT_DEFAULT]['misc/collapse.js']['preprocess'], t('Setting cache to FALSE sets proprocess to FALSE when adding JavaScript.')); + } + + /** + * Test adding a JavaScript file with a different weight. + */ + function testDifferentWeight() { + drupal_add_js('misc/collapse.js', array('weight' => JS_WEIGHT_THEME)); + $javascript = drupal_add_js(); + $this->assertTrue(array_key_exists('misc/collapse.js', $javascript['header']['file'][JS_WEIGHT_THEME]), t('Adding a JavaScript file with a different weight.')); } } Index: modules/color/color.module =================================================================== RCS file: /cvs/drupal/drupal/modules/color/color.module,v retrieving revision 1.49 diff -u -r1.49 color.module --- modules/color/color.module 26 Oct 2008 18:06:38 -0000 1.49 +++ modules/color/color.module 27 Oct 2008 17:12:46 -0000 @@ -154,7 +154,7 @@ // Add Farbtastic color picker. drupal_add_css('misc/farbtastic/farbtastic.css', array('preprocess' => FALSE)); - drupal_add_js('misc/farbtastic/farbtastic.js'); + drupal_add_js('misc/farbtastic/farbtastic.js', array('weight' => JS_WEIGHT_LIBRARY)); // Add custom CSS and JS. drupal_add_css($base . '/color.css', array('preprocess' => FALSE));