advagg_js_compress.admin.inc in Advanced CSS/JS Aggregation 7.2

Admin page callbacks for the advagg JS compression module.

File

advagg_js_compress/advagg_js_compress.admin.inc

<?php

/**
 * @file
 * Admin page callbacks for the advagg JS compression module.
 */

/**
 * Form builder; Configure advagg settings.
 *
 * @ingroup advagg_forms
 *
 * @see system_settings_form()
 */
function advagg_js_compress_admin_settings_form($form, $form_state) {
  drupal_set_title(t('AdvAgg: JS Compression'));
  $requirements = advagg_js_compress_check_cache_bin();
  advagg_display_message_if_requirements_not_met($requirements);
  $config_path = advagg_admin_config_root_path();
  $form = array();
  if (variable_get('advagg_cache_level', ADVAGG_CACHE_LEVEL) < 0) {
    $form['advagg_devel_msg'] = array(
      '#markup' => '<p>' . t('The settings below will not have any effect because AdvAgg is currently in <a href="@devel">development mode</a>. Once the cache settings have been set to normal or aggressive, JS minification will take place.', array(
        '@devel' => url($config_path . '/advagg', array(
          'fragment' => 'edit-advagg-cache-level',
        )),
      )) . '</p>',
    );
  }
  list($list, $redo_list) = advagg_js_compress_all_js_files_list();
  if (!empty($redo_list)) {
    $form['advagg_js_compressor_batch'] = array(
      '#markup' => '<p>' . t('There are %count js files that need to be minified. <a href="@batch">Click this batch compress link to process these files.</a>', array(
        '@batch' => url($config_path . '/advagg/js-compress/batch'),
        '%count' => count($redo_list),
      )) . '</p>',
    );
    $form['advagg_js_compressor_redo_list'] = array(
      '#type' => 'fieldset',
      '#title' => t('List of files that need to be recompressed'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['advagg_js_compressor_redo_list']['list'] = array(
      '#markup' => '<p><pre><tt>' . print_r($redo_list, TRUE) . '</tt></pre></p>',
    );
  }
  list($options, $description) = advagg_js_compress_configuration();
  $form['advagg_js_compressor'] = array(
    '#type' => 'radios',
    '#title' => t('File Compression: Select a Compressor'),
    '#default_value' => variable_get('advagg_js_compressor', ADVAGG_JS_COMPRESSOR),
    '#options' => $options,
    '#description' => filter_xss($description),
  );
  $form['advagg_js_compress_inline'] = array(
    '#type' => 'radios',
    '#title' => t('Inline Compression: Select a Compressor'),
    '#default_value' => variable_get('advagg_js_compress_inline', ADVAGG_JS_COMPRESS_INLINE),
    '#options' => $options,
    '#description' => filter_xss($description),
  );
  $form['advagg_js_compress_inline_if_not_cacheable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Inline Compression: Use even if this page is not cacheable'),
    '#default_value' => variable_get('advagg_js_compress_inline_if_not_cacheable', ADVAGG_JS_COMPRESS_INLINE_IF_NOT_CACHEABLE),
    '#description' => t('By checking this box, all Inline JavaScript will be compressed regardless of the state of <a href="@link">drupal_page_is_cacheable()</a>. If the C complied version of JSMin is enabled, this option should not slow down page generation that much; if you are using JSMin+ I recommend keeping this disabled.', array(
      '@link' => 'http://api.drupal.org/api/drupal/includes!bootstrap.inc/function/drupal_page_is_cacheable/7',
    )),
    '#states' => array(
      'disabled' => array(
        ':input[name="advagg_js_compress_inline"]' => array(
          'value' => "0",
        ),
      ),
    ),
  );
  if (variable_get('advagg_gzip', ADVAGG_GZIP) || variable_get('advagg_brotli', ADVAGG_BROTLI)) {
    $form['advagg_js_compress_packer'] = array(
      '#type' => 'checkbox',
      '#title' => t('Here there be dragons! Use Packer on non gz/br JS Aggregates.'),
      '#default_value' => variable_get('advagg_js_compress_packer', ADVAGG_JS_COMPRESS_PACKER),
      '#description' => t('If enabled the non gzip/brotli version of JS files will be compressed using the JS Packer. Packer works similar to gz/br, thus using packer on a gzip/brotli file does not give a big improvement in terms of bytes transferred over the wire. WARNING: This has a high chance of breaking your JS. Only Enable on production after testing the non gzip/brotli version locally.'),
      '#states' => array(
        'disabled' => array(
          ':input[name="advagg_js_compressor"]' => array(
            'value' => "0",
          ),
        ),
      ),
    );
  }
  $form['advagg_js_compress_add_license'] = array(
    '#type' => 'radios',
    '#title' => t('Licensing comments'),
    '#default_value' => variable_get('advagg_js_compress_add_license', ADVAGG_JS_COMPRESS_ADD_LICENSE),
    '#description' => t("Stripping everything will produce somewhat better scores in\n   some automated scans but otherwise should not affect your site. Providing a link to the original source and keeping important comments is enabled by default in order to better follow the spirit of the GPL by linking to the original unminified javascript source files."),
    '#options' => array(
      0 => t('Strip everything (smallest files)'),
      1 => t('Provide a link to the original source as a comment'),
      2 => t('Keep important comments if the minifier supports it'),
      3 => t('Do both; try to keep important comments and provide a link'),
    ),
  );
  $options[-1] = t('Default');
  ksort($options);
  $form['per_file_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Per File Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $file_settings = variable_get('advagg_js_compressor_file_settings', array());
  foreach ($list as $row) {
    $dir = dirname($row['data']);
    if (!isset($form['per_file_settings'][$dir])) {
      $form['per_file_settings'][$dir] = array(
        '#type' => 'fieldset',
        '#title' => check_plain($dir),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
    }
    $options_copy = $options;
    if (!empty($row['advagg_js_compress'])) {
      foreach ($row['advagg_js_compress'] as $key => $values) {
        if (!isset($options_copy[$key])) {
          continue;
        }
        if ($values['code'] != 1) {
          unset($options_copy[$key]);
          continue;
        }
        $options_copy[$key] .= " Ratio: {$values['ratio']}";
      }
    }
    $form_api_filename = str_replace(array(
      '/',
      '.',
    ), array(
      '__',
      '--',
    ), $row['data']);
    $form['per_file_settings'][$dir]['advagg_js_compressor_file_settings_' . $form_api_filename] = array(
      '#type' => 'radios',
      '#title' => t('%filename: Select a Compressor', array(
        '%filename' => $row['data'],
      )),
      '#default_value' => isset($file_settings[$form_api_filename]) ? $file_settings[$form_api_filename] : ADVAGG_JS_COMPRESSOR_FILE_SETTINGS,
      '#options' => $options_copy,
    );
    if ($form['per_file_settings'][$dir]['advagg_js_compressor_file_settings_' . $form_api_filename]['#default_value'] != ADVAGG_JS_COMPRESSOR_FILE_SETTINGS) {
      $form['per_file_settings'][$dir]['#collapsed'] = FALSE;
      $form['per_file_settings']['#collapsed'] = FALSE;
    }
  }

  // No js files are found.
  if (empty($list)) {
    $form['per_file_settings']['#description'] = t('No JS files have been aggregated. You need to enable aggregation. No js files where found in the advagg_files table.');
  }

  // Clear the cache bins on submit.
  $form['#submit'][] = 'advagg_js_compress_admin_settings_form_submit';
  return system_settings_form($form);
}

/**
 * Submit callback, clear out the advagg cache bin.
 *
 * Also remove default settings inside of the per_file_settings fieldgroup.
 *
 * @ingroup advagg_forms_callback
 */
function advagg_js_compress_admin_settings_form_submit($form, &$form_state) {
  advagg_cache_clear_admin_submit();

  // Get current defaults.
  $file_settings = variable_get('advagg_js_compressor_file_settings', array());

  // Save per file settings.
  $new_settings = array();
  foreach ($form_state['values'] as $key => $value) {

    // Skip if not advagg_js_compressor_file_settings.
    if (strpos($key, 'advagg_js_compressor_file_settings_') === FALSE) {
      continue;
    }

    // Do not process default settings.
    if ($value == ADVAGG_JS_COMPRESSOR_FILE_SETTINGS) {
      unset($form_state['values'][$key]);
      continue;
    }
    $new_settings[substr($key, 35)] = $value;

    // Do not save this field into its own variable.
    unset($form_state['values'][$key]);
  }
  if (!empty($new_settings) || !empty($file_settings)) {
    if (empty($new_settings)) {
      variable_del('advagg_js_compressor_file_settings');
    }
    else {
      variable_set('advagg_js_compressor_file_settings', $new_settings);
    }
  }
}

Functions

Name	Description
advagg_js_compress_admin_settings_form	Form builder; Configure advagg settings.
advagg_js_compress_admin_settings_form_submit	Submit callback, clear out the advagg cache bin.