' . t('You can use built-in JavaScript libraries that are registered by existing modules, or add custom Javascript libraries as uploaded files or external URLs.') . '
'; + $output .= '' . t('In addition, you can load a library in every page load. Deselecting a library does not prevent it from loading when required by the system. Some libraries, such as jQuery, are included in every page load.') . '
'; + return $output; + case 'admin/config/system/javascript-libraries': + $output .= '' . t('To include libraries in every page load, select them from the list below. The jQuery and jQuery once libraries are included by default.') . '
'; + return $output; + case 'admin/config/system/javascript-libraries/custom': + $output .= '' . t('To load the JavaScript library on every page load, move it to the head or footer region. Not applicable to administrative pages.') . '
'; + return $output; + case 'admin/config/system/javascript-libraries/custom/add': + $output .= '' . t('Use this page to add a JavaScript library or custom script to your site.') . '
'; + $output .= '' . t('Adding JavaScript with malicious content can compromise your site, make it difficult to use, or degrade site performance. Only upload or use external files that have been verified.') . '
'; + return $output; + case 'admin/config/system/javascript-libraries/custom/%/edit': + $output .= '' . t('Use this page to manage a JavaScript library or custom script in your site.') . '
'; + $output .= '' . t('Adding JavaScript with malicious content can compromise your site, make it difficult to use, or degrade site performance. Only upload or use external files that have been verified.') . '
'; + return $output; + } +} + +/** + * API function - load one custom library by ID. + */ +function javascript_libraries_custom_load($id) { + $custom = variable_get('javascript_libraries_custom_libraries', array()); + if (isset($custom[$id])) { + return $custom[$id]; + } + return FALSE; +} + +/** + * API function - delete one custom library by ID. + */ +function javascript_libraries_custom_delete($id) { + $library = javascript_libraries_custom_load($id); + switch ($library['type']) { + case 'external': + // Nothing to do. + break; + case 'file': + // Delete associated file. + $file = file_load($library['fid']); + file_usage_delete($file, 'javascript_libraries'); + file_delete($file); + break; + } + $custom = variable_get('javascript_libraries_custom_libraries', array()); + unset($custom[$library['id']]); + variable_set('javascript_libraries_custom_libraries', $custom); +} +function javascript_libraries_js_cache_clear() { + // Change query-strings on css/js files to enforce reload for all users. + _drupal_flush_css_js(); + drupal_clear_js_cache(); +} + +/** + * Determines if a URL is a valid external JavaScript library URL. + * + * @param $url + * The URL to check. + * + * @return + * TRUE if the URL is a valid external JavaScript library URL, or FALSE if it + * isn't. + */ +function javascript_libraries_valid_external_url($url) { + // The URL must begin with http:// or https:// and must end in ".js" or + // ".txt". + $parts = parse_url($url); + return $parts && ($parts['scheme'] == 'http' || $parts['scheme'] == 'https') && $parts['host'] && preg_match('@/.+\.(js|txt)$@i', $parts['path']); +} +/** + * Implements hook_cron(). + */ +function javascript_libraries_cron() { + // Force an update once per day. + $last = variable_get('javascript_libraries_last_sync', 0); + if (REQUEST_TIME > $last + 86400) { + $custom = variable_get('javascript_libraries_custom_libraries', array()); + foreach ($custom as $library) { + // Get/build local cached versions of external scripts. + if ($library['type'] == 'external' && !empty($library['cache'])) { + javascript_libraries_cache($library['uri'], TRUE); + } + } + variable_set('javascript_libraries_last_sync', REQUEST_TIME); + } +} +/** + * Implements hook_theme(). + */ +function javascript_libraries_theme() { + return array( + 'javascript_libraries_library_fieldset' => array( + 'file' => 'javascript_libraries.admin.inc', + 'render element' => 'form', + ), + 'javascript_libraries_custom_form' => array( + 'file' => 'javascript_libraries.admin.inc', + 'render element' => 'form', + ), + ); +} +/** + * Implements hook_flush_caches(). + */ +function javascript_libraries_flush_caches() { + variable_del('javascript_libraries_last_sync'); + javascript_libraries_cron(); +} +/** + * Implements hook_form_FORM_ID_alter(). + */ +function javascript_libraries_form_block_admin_configure_alter(&$form, &$form_state) { + + $module = $form['module']['#value']; + $delta = $form['delta']['#value']; + $settings = variable_get('javascript_libraries_block_settings', array()); + $form['actions']['#weight'] = 100; + $path = drupal_get_path('module', 'javascript_libraries'); + + $custom = variable_get('javascript_libraries_custom_libraries', array()); + $options = array(); + foreach ($custom as $key => $library) { + if ($library['scope'] != 'disabled') { + continue; + } + $options[$key] = $library['name']; + } + $form['visibility']['javascript_libraries'] = array( + '#type' => 'fieldset', + '#title' => t('JavaScript libraries'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#group' => 'visibility', + '#description' => t('Specify which custom libraries should be loaded in the footer on pages where this block is visible.'), + '#tree' => TRUE, + '#weight' => 50, + '#attached' => array( + 'js' => array( + 'vertical-tabs' => $path . '/js/javascript_libraries.vertical-tabs.js', + ), + ), + ); + $form['visibility']['javascript_libraries']['custom'] = array( + '#type' => 'checkboxes', + '#title' => empty($options) ? t('No libraries available') : t('Available libraries'), + '#options' => $options, + '#default_value' => empty($settings[$module][$delta]) ? array() : $settings[$module][$delta], + '#description' => t('Only select libraries here if you have set one or more of the visibility settings for this block. If this block shows on all pages, use the JavaScript libraries configuration page instead. Only libraries listed there as disabled may be loaded for specific blocks.', array('!url' => url('admin/config/system/javascript-libraries/custom'))), + ); + if(!empty($options)) { + $form['visibility']['javascript_libraries']['scope'] = array( + '#type' => 'select', + '#title' => t('Scope for available libraries'), + '#default_value' => !empty($settings[$module][$delta]['scope']) ? $settings[$module][$delta]['scope'] : 'footer', + '#options' => array( + 'header' => t('Header'), + 'footer' => t('Footer') + ) + ); + } + $form['#submit'][] = 'javascript_libraries_form_block_admin_configure_submit'; +} +/** + * Form submit function for block_admin_configure. + */ +function javascript_libraries_form_block_admin_configure_submit(&$form, &$form_state) { + $module = $form['module']['#value']; + $delta = $form['delta']['#value']; + $settings = variable_get('javascript_libraries_block_settings', array()); + $enabled = array_filter($form_state['values']['javascript_libraries']['custom']); + $settings[$module][$delta] = $enabled; + $settings[$module][$delta]['scope'] = $form_state['values']['javascript_libraries']['scope']; + variable_set('javascript_libraries_block_settings', $settings); +} +/** + * Implements hook_block_view_alter(). + */ +function javascript_libraries_block_view_alter(&$data, $block) { + if (user_access('view the administration theme') && path_is_admin(current_path())) { + // Don't load any custom JS when administrators are viewing an admin page. + return; + } + $module = $block->module; + $delta = $block->delta; + $settings = variable_get('javascript_libraries_block_settings', array()); + if (!empty($settings[$module][$delta])) { + if(!is_array($data['content'])){ + $content = $data['content']; + $data['content'] = array('#type' => 'markup', '#markup' => $content); + } + foreach ($settings[$module][$delta] as $id) { + $library = javascript_libraries_custom_load($id); + // Only libraries that are not otherwise loaded will be loaded for this block. + if (!empty($library) && $library['scope'] == 'disabled') { + $data['content']['#attached']['js'][] = array( + 'data' => file_create_url($library['uri']), + 'scope' => !empty($settings[$module][$delta]['scope']) ? $settings[$module][$delta]['scope'] : 'footer', + ); + } + } + } +} +/** * Form builder function for page callback. */ function javascript_libraries_default_form($form, &$form_state) { diff --git a/javascript_libraries.module b/javascript_libraries.module index 417c9a5..aa48334 100644 --- a/javascript_libraries.module +++ b/javascript_libraries.module @@ -4,182 +4,34 @@ * @file * Toggle the inclusion of Drupal system libraries. Upload and reference custom libraries as well. */ - -/** - * Implements hook_menu(). - */ -function javascript_libraries_menu() { - $items = array(); - - $items['admin/config/system/javascript-libraries'] = array( - 'title' => 'JavaScript libraries', - 'description' => 'Manage Drupal and custom JavaScript libraries.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('javascript_libraries_default_form'), - 'access arguments' => array('administer site configuration'), - 'file' => 'javascript_libraries.admin.inc', - ); - - $items['admin/config/system/javascript-libraries/default'] = array( - 'title' => 'Built-in', - 'weight' => -5, - 'type' => MENU_DEFAULT_LOCAL_TASK, - ); - - $items['admin/config/system/javascript-libraries/custom'] = array( - 'title' => 'Custom', - 'description' => 'Manage Drupal and custom javascript libraries', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('javascript_libraries_custom_form'), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_LOCAL_TASK, - 'file' => 'javascript_libraries.admin.inc', - ); - - $items['admin/config/system/javascript-libraries/custom/add'] = array( - 'title' => 'Add JavaScript', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('javascript_libraries_edit_form', array()), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_LOCAL_ACTION, - 'file' => 'javascript_libraries.admin.inc', - ); - - $items['admin/config/system/javascript-libraries/custom/%javascript_libraries_custom/edit'] = array( - 'title' => 'Edit JavaScript library', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('javascript_libraries_edit_form', 5), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_VISIBLE_IN_BREADCRUMB, - 'file' => 'javascript_libraries.admin.inc', - ); - - $items['admin/config/system/javascript-libraries/custom/%javascript_libraries_custom/delete'] = array( - 'title' => 'Edit JavaScript library', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('javascript_libraries_delete_form', 5), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_VISIBLE_IN_BREADCRUMB, - 'file' => 'javascript_libraries.admin.inc', - ); - - return $items; -} - -/** - * Implements hook_help() - */ -function javascript_libraries_help($path, $arg) { - $output = ''; - switch($path) { - case 'admin/help#javascript_libraries': - $output .= '' . t('You can use built-in JavaScript libraries that are registered by existing modules, or add custom Javascript libraries as uploaded files or external URLs.') . '
'; - $output .= '' . t('In addition, you can load a library in every page load. Deselecting a library does not prevent it from loading when required by the system. Some libraries, such as jQuery, are included in every page load.') . '
'; - return $output; - case 'admin/config/system/javascript-libraries': - $output .= '' . t('To include libraries in every page load, select them from the list below. The jQuery and jQuery once libraries are included by default.') . '
'; - return $output; - case 'admin/config/system/javascript-libraries/custom': - $output .= '' . t('To load the JavaScript library on every page load, move it to the head or footer region. Not applicable to administrative pages.') . '
'; - return $output; - case 'admin/config/system/javascript-libraries/custom/add': - $output .= '' . t('Use this page to add a JavaScript library or custom script to your site.') . '
'; - $output .= '' . t('Adding JavaScript with malicious content can compromise your site, make it difficult to use, or degrade site performance. Only upload or use external files that have been verified.') . '
'; - return $output; - case 'admin/config/system/javascript-libraries/custom/%/edit': - $output .= '' . t('Use this page to manage a JavaScript library or custom script in your site.') . '
'; - $output .= '' . t('Adding JavaScript with malicious content can compromise your site, make it difficult to use, or degrade site performance. Only upload or use external files that have been verified.') . '
'; - return $output; - } -} - -/** - * API function - load one custom library by ID. - */ -function javascript_libraries_custom_load($id) { - $custom = variable_get('javascript_libraries_custom_libraries', array()); - if (isset($custom[$id])) { - return $custom[$id]; - } - return FALSE; -} - -/** - * API function - delete one custom library by ID. - */ -function javascript_libraries_custom_delete($id) { - $library = javascript_libraries_custom_load($id); - switch ($library['type']) { - case 'external': - // Nothing to do. - break; - case 'file': - // Delete associated file. - $file = file_load($library['fid']); - file_usage_delete($file, 'javascript_libraries'); - file_delete($file); - break; - } - $custom = variable_get('javascript_libraries_custom_libraries', array()); - unset($custom[$library['id']]); - variable_set('javascript_libraries_custom_libraries', $custom); -} - -function javascript_libraries_js_cache_clear() { - // Change query-strings on css/js files to enforce reload for all users. - _drupal_flush_css_js(); - drupal_clear_js_cache(); -} - -/** - * Determines if a URL is a valid external JavaScript library URL. - * - * @param $url - * The URL to check. - * - * @return - * TRUE if the URL is a valid external JavaScript library URL, or FALSE if it - * isn't. - */ -function javascript_libraries_valid_external_url($url) { - // The URL must begin with http:// or https:// and must end in ".js" or - // ".txt". - $parts = parse_url($url); - return $parts && ($parts['scheme'] == 'http' || $parts['scheme'] == 'https') && $parts['host'] && preg_match('@/.+\.(js|txt)$@i', $parts['path']); -} - -/** - * Implements hook_cron(). - */ -function javascript_libraries_cron() { - // Force an update once per day. - $last = variable_get('javascript_libraries_last_sync', 0); - if (REQUEST_TIME > $last + 86400) { - $custom = variable_get('javascript_libraries_custom_libraries', array()); - foreach ($custom as $library) { - // Get/build local cached versions of external scripts. - if ($library['type'] == 'external' && !empty($library['cache'])) { - javascript_libraries_cache($library['uri'], TRUE); - } - } - variable_set('javascript_libraries_last_sync', REQUEST_TIME); - } -} - /** - * Implements hook_theme(). + * Implements hook_hook_info(). */ -function javascript_libraries_theme() { - return array( - 'javascript_libraries_library_fieldset' => array( - 'file' => 'javascript_libraries.admin.inc', - 'render element' => 'form', +function javascript_libraries_hook_info() { + $hooks = array( + 'menu' => array( + 'group' => 'admin', + ), + 'help' => array( + 'group' => 'admin', + ), + 'cron' => array( + 'group' => 'admin', + ), + 'theme' => array( + 'group' => 'admin', ), - 'javascript_libraries_custom_form' => array( - 'file' => 'javascript_libraries.admin.inc', - 'render element' => 'form', + 'flush_caches' => array( + 'group' => 'admin', + ), + 'form_block_admin_configure_alter' => array( + 'group' => 'admin', + ), + 'block_view_alter' => array( + 'group' => 'admin', ), ); + return $hooks; } /** @@ -273,15 +125,6 @@ function javascript_libraries_library() { return $libraries; } - -/** - * Implements hook_flush_caches(). - */ -function javascript_libraries_flush_caches() { - variable_del('javascript_libraries_last_sync'); - javascript_libraries_cron(); -} - /** * Download/Synchronize/Cache tracking code file locally. * @@ -334,7 +177,6 @@ function javascript_libraries_cache($uri, $sync_cached_file = FALSE) { } return FALSE; } - /** * More atomic replacement for file_unmanaged_save_data(). * @@ -358,118 +200,4 @@ function javascript_libraries_file_unmanaged_save_data($data, $destination) { return @rename($destination_tmp, $destination); } return FALSE; -} - -/** - * Implements hook_block_view_alter(). - */ -function javascript_libraries_block_view_alter(&$data, $block) { - if (user_access('view the administration theme') && path_is_admin(current_path())) { - // Don't load any custom JS when administrators are viewing an admin page. - return; - } - $module = $block->module; - $delta = $block->delta; - $options = array(); - $options['scope'] = 'footer'; - $settings = variable_get('javascript_libraries_block_settings', array()); - if (!empty($settings[$module][$delta])) { - foreach ($settings[$module][$delta] as $id) { - $library = javascript_libraries_custom_load($id); - // Only libraries that are not otherwise loaded will be loaded for this block. - if (!empty($library) && $library['scope'] == 'disabled') { - // Use a script loader inline to avoid breaking block cache, since - // drupal_add_js() won't run when the cached version is served. - $inline = javascript_libraries_add_inline(file_create_url($library['uri'])); - // Use #suffix if content is a renderable array; otherwise append the - // output string. - if (is_array($data['content'])) { - $data['content']['#suffix'] = $inline; - } - elseif (is_string($data['content'])) { - $data['content'] .= $inline; - } - } - } - } -} - -/** - * Add script loader inline to attach a script to markup that will be cached. - * - * @param $url - * URL of the script to be loaded. - * @return string - * Inline javascript to load the script. - */ -function javascript_libraries_add_inline($url) { - $script = <<