Admin page callbacks for the advanced CSS/JS aggregation module.
File
View source
<?php
/**
* @file
* Admin page callbacks for the advanced CSS/JS aggregation module.
*/
/**
* @defgroup advagg_forms Advanced Aggregates Forms
* @{
* Advanced Aggregates administration forms.
*/
/**
* Form builder; Configure advagg settings.
*
* @see system_settings_form()
*/
function advagg_admin_settings_form($form, $form_state) {
drupal_set_title(t('AdvAgg: Configuration'));
advagg_display_message_if_requirements_not_met();
$config_path = advagg_admin_config_root_path();
$options = array(
0 => t('Use default (safe) settings'),
2 => t('Use recommended (optimized) settings'),
4 => t('Use customized settings'),
);
$form['advagg_admin_mode'] = array(
'#type' => 'radios',
'#title' => t('AdvAgg Settings'),
'#default_value' => variable_get('advagg_admin_mode', ADVAGG_ADMIN_MODE),
'#options' => $options,
'#description' => t("Default settings will mirror core as closely as possible. <br>Recommended settings are optimized for speed."),
);
$form['global_container'] = array(
'#type' => 'container',
'#hidden' => TRUE,
'#states' => array(
'visible' => array(
':input[name="advagg_admin_mode"]' => array(
'value' => '4',
),
),
),
);
// Simple checkbox settings.
$form['global_container']['global'] = array(
'#type' => 'fieldset',
'#title' => t('Global Options'),
);
$form['global_container']['global']['advagg_enabled'] = array(
'#type' => 'checkbox',
'#title' => t('Enable advanced aggregation (recommended)'),
'#default_value' => variable_get('advagg_enabled', ADVAGG_ENABLED),
'#description' => t('Uncheck this box to completely disable AdvAgg functionality.'),
'#recommended_value' => TRUE,
);
$form['global_container']['global']['advagg_remote_version_check'] = array(
'#type' => 'checkbox',
'#title' => t('Check remote/github libraries for the latest version'),
'#default_value' => variable_get('advagg_remote_version_check', ADVAGG_REMOTE_VERSION_CHECK),
'#description' => t('This will check for the latest versions of various libraries used by AdvAgg on select admin pages. In some environments you may wish to not do these checks; uncheck this box to disable remote checks.'),
);
$advagg_core_groups_default = variable_get('advagg_core_groups', ADVAGG_CORE_GROUPS);
if (variable_get('advagg_combine_css_media', ADVAGG_COMBINE_CSS_MEDIA) || variable_get('advagg_ie_css_selector_limiter', ADVAGG_IE_CSS_SELECTOR_LIMITER) || module_exists('advagg_bundler') && variable_get('advagg_bundler_active', ADVAGG_BUNDLER_ACTIVE)) {
$advagg_core_groups_default = FALSE;
}
$form['global_container']['global']['advagg_core_groups'] = array(
'#type' => 'checkbox',
'#title' => t('Use cores grouping logic'),
'#default_value' => $advagg_core_groups_default,
'#description' => t('Will group files just like core does.'),
'#recommended_value' => FALSE,
'#states' => array(
'enabled' => array(
'#edit-advagg-combine-css-media' => array(
'checked' => FALSE,
),
'#edit-advagg-ie-css-selector-limiter' => array(
'checked' => FALSE,
),
),
),
);
$form['global_container']['global']['advagg_use_httprl'] = array(
'#type' => 'checkbox',
'#title' => t('Use HTTPRL to generate aggregates (recommended)'),
'#default_value' => module_exists('httprl') ? variable_get('advagg_use_httprl', ADVAGG_USE_HTTPRL) : FALSE,
'#disabled' => module_exists('httprl') ? FALSE : TRUE,
'#description' => t('If <a href="@link">HTTPRL</a> is installed, advagg will use it to generate aggregates on the fly in a background parallel process.', array(
'@link' => 'http://drupal.org/project/httprl',
)),
'#recommended_value' => TRUE,
);
$aggressive_cache_conflicts = advagg_aggressive_cache_conflicts();
if (empty($aggressive_cache_conflicts)) {
$description = t('It appears that there are no incompatible modules, so you should be able to safely use the Aggressive cache.');
}
else {
$description = t('It appears that there might be some incompatible modules. I would test these out before setting the cache to aggressive: %modules', array(
'%modules' => implode(', ', $aggressive_cache_conflicts),
));
}
$options = array(
-1 => t('Development ~ 300ms'),
1 => t('Normal ~ 60ms'),
3 => t('Render Cache ~ 30ms (recommended)'),
5 => t('Aggressive Render Cache ~ 10ms'),
);
$form['global_container']['global']['advagg_cache_level'] = array(
'#type' => 'radios',
'#title' => t('AdvAgg Cache Settings'),
'#default_value' => variable_get('advagg_cache_level', ADVAGG_CACHE_LEVEL),
'#options' => $options,
'#recommended_value' => 3,
'#description' => t("As a reference, core takes about 25 ms to run. Development will scan all files for a change on every page load. Normal and the render cache is fine for all use cases. Aggressive should be fine for most use cases. If your inline css/js changes based off of a variable then the cache hit ratio will be low; if that is the case consider using Drupal.settings for a better cache hit ratio when using the render cache. The aggressive render cache will cache the output from js_alter and css_alter. !description", array(
'@information' => url($config_path . '/advagg/info', array(
'fragment' => 'edit-hooks-implemented',
)),
'!description' => $description,
)),
);
$stream_wrappers = file_get_stream_wrappers();
$prefix = variable_get('advagg_root_dir_prefix', ADVAGG_ROOT_DIR_PREFIX);
if ($prefix !== 'public://' || $stream_wrappers['public']['class'] !== 'DrupalPublicStreamWrapper' || count($stream_wrappers) > 2 || file_default_scheme() !== 'public') {
$stream_wrappers_string = array();
foreach ($stream_wrappers as $key => $values) {
$stream_wrappers_string[] = t("<strong>@key://</strong> uses @class; @description", array(
'@key' => $key,
'@class' => $values['class'],
'@description' => $values['description'],
));
}
$stream_wrappers_string = implode("<br>\n", $stream_wrappers_string);
$form['global_container']['global']['advagg_root_dir_prefix'] = array(
'#type' => 'textfield',
'#title' => t('Stream wrapper for AdvAgg.'),
'#default_value' => $prefix,
'#description' => t("Options:<br>\n!stream_wrappers", array(
'!stream_wrappers' => $stream_wrappers_string,
)),
);
}
$form['global_container']['global']['dev_container'] = array(
'#type' => 'container',
'#states' => array(
'visible' => array(
':input[name="advagg_cache_level"]' => array(
'value' => '-1',
),
),
),
);
// Show msg about advagg css compress.
if (module_exists('advagg_css_compress') && (variable_get('advagg_css_compressor', ADVAGG_CSS_COMPRESSOR) > 0 || variable_get('advagg_css_compress_inline', ADVAGG_CSS_COMPRESS_INLINE))) {
$form['global_container']['global']['dev_container']['advagg_css_compress_msg'] = array(
'#markup' => '<p>' . t('The <a href="@css">AdvAgg CSS Compression module</a> is disabled when in development mode.', array(
'@css' => url($config_path . '/advagg/css-compress'),
)) . '</p>',
);
}
// Show msg about advagg js compress.
if (module_exists('advagg_js_compress') && (variable_get('advagg_js_compressor', ADVAGG_JS_COMPRESSOR) || variable_get('advagg_js_compress_inline', ADVAGG_JS_COMPRESS_INLINE))) {
$form['global_container']['global']['dev_container']['advagg_js_compress_msg'] = array(
'#markup' => '<p>' . t('The <a href="@js">AdvAgg JS Compression module</a> is disabled when in development mode.', array(
'@js' => url($config_path . '/advagg/js-compress'),
)) . '</p>',
);
}
// Show msg about the jquery update compression setting.
if (module_exists('jquery_update')) {
if (variable_get('jquery_update_compression_type', 'min') === 'min') {
$form['global_container']['global']['dev_container']['advagg_jquery_update_development'] = array(
'#markup' => '<p>' . t('You might want to change the <a href="!url">jQuery update compression level</a> to "Development" as well.', array(
'!url' => url('admin/config/development/jquery_update'),
)) . '</p>',
);
}
else {
$form['global_container']['global']['prod_container'] = array(
'#type' => 'container',
'#states' => array(
'visible' => array(
':input[name="advagg_cache_level"]' => array(
'!value' => '-1',
),
),
),
);
$form['global_container']['global']['prod_container']['advagg_jquery_update_development'] = array(
'#markup' => '<p>' . t('You might want to change the <a href="!url">jQuery update compression level</a> to "Production" as well.', array(
'!url' => url('admin/config/development/jquery_update'),
)) . '</p>',
);
}
}
$advagg_resource_hints_dns_prefetch = variable_get('advagg_resource_hints_dns_prefetch', ADVAGG_RESOURCE_HINTS_DNS_PREFETCH);
$advagg_resource_hints_preconnect = variable_get('advagg_resource_hints_preconnect', ADVAGG_RESOURCE_HINTS_PRECONNECT);
$advagg_resource_hints_preload = variable_get('advagg_resource_hints_preload', ADVAGG_RESOURCE_HINTS_PRELOAD);
$form['global_container']['global']['resource_hints'] = array(
'#type' => 'fieldset',
'#title' => t('Resource Hints'),
'#collapsible' => TRUE,
'#collapsed' => $advagg_resource_hints_dns_prefetch || $advagg_resource_hints_preconnect || $advagg_resource_hints_preload ? FALSE : TRUE,
'#description' => t('Preemptively get resources (CSS/JS & sub requests).'),
);
$form['global_container']['global']['resource_hints']['advagg_resource_hints_dns_prefetch'] = array(
'#type' => 'checkbox',
'#title' => t('DNS Prefetch (recommended).'),
'#default_value' => $advagg_resource_hints_dns_prefetch,
'#disabled' => '',
'#description' => t('Start the DNS lookup for external CSS and JavaScript files as soon as possible.'),
'#recommended_value' => TRUE,
);
$form['global_container']['global']['resource_hints']['advagg_resource_hints_preconnect'] = array(
'#type' => 'checkbox',
'#title' => t('Preconnect (recommended).'),
'#default_value' => $advagg_resource_hints_preconnect,
'#disabled' => '',
'#description' => t('Start the connection to external resources before an HTTP request is actually sent to the server.'),
'#recommended_value' => TRUE,
);
$form['global_container']['global']['resource_hints']['advagg_resource_hints_location'] = array(
'#type' => 'radios',
'#title' => t('Location of resource hints.'),
'#default_value' => variable_get('advagg_resource_hints_location', ADVAGG_RESOURCE_HINTS_LOCATION),
'#description' => t('If you have css and/or js files being loaded right after the "charset=utf-8" meta tag, you need to use the "above charset=utf-8" option in order for some of the resource hints to work; Optimizely is an example that would need this other option. Link headers are not supported in every browser.'),
'#recommended_value' => 1,
'#options' => array(
1 => t('Below charset=utf-8 (recommended)'),
3 => t('Above charset=utf-8'),
),
'#states' => array(
'disabled' => array(
'#edit-advagg-resource-hints-dns-prefetch' => array(
'checked' => FALSE,
),
'#edit-advagg-resource-hints-preconnect' => array(
'checked' => FALSE,
),
),
),
);
// Preload Section.
$form['global_container']['global']['resource_hints']['preload']['advagg_resource_hints_preload'] = array(
'#type' => 'checkbox',
'#title' => t('Preload link http headers.'),
'#default_value' => $advagg_resource_hints_preload,
'#disabled' => '',
'#description' => t('Use link http headers to send out preload hints for local and external resources.'),
'#recommended_value' => FALSE,
);
$advagg_resource_hints_preload_settings = advagg_get_resource_hints_preload_settings();
$form['global_container']['global']['resource_hints']['preload']['advagg_resource_hints_preload_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Preload Ordering and Settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('Change the order of what preload items get sent first. Can also control what will be sent and if HTTP/2 push should be used (if your server supports it). If your webserver supports HTTP/2 Push, and it is enabled, the server will send every asset flagged to be pushed to the browser on every request, ignoring the browser cache (not a good thing for repeat visits). More complex server configuration will be needed to make this efficient; no solutions are currently available.'),
'#states' => array(
'invisible' => array(
'#edit-advagg-resource-hints-preload' => array(
'checked' => FALSE,
),
),
),
);
// Build the rows.
foreach ($advagg_resource_hints_preload_settings as $id => $entry) {
// Build the table rows.
$rows[$id] = array(
'data' => array(
// Cell for the cross drag and drop element.
array(
'class' => array(
'entry-cross',
),
),
// Weight item for the tabledrag.
array(
'data' => array(
'#type' => 'weight',
'#title' => t('Weight'),
'#title_display' => 'invisible',
'#default_value' => $entry['#weight'],
'#parents' => array(
'advagg_resource_hints_preload_settings',
$id,
'weight',
),
'#attributes' => array(
'class' => array(
'entry-order-weight',
),
),
),
),
check_plain($entry['title']),
array(
'data' => array(
'#type' => 'checkbox',
'#title' => t('Enable'),
'#title_display' => 'invisible',
'#default_value' => $entry['enabled'],
'#parents' => array(
'advagg_resource_hints_preload_settings',
$id,
'enabled',
),
),
),
array(
'data' => array(
'#type' => 'checkbox',
'#title' => t('HTTP/2 Push'),
'#title_display' => 'invisible',
'#default_value' => $entry['push'],
'#parents' => array(
'advagg_resource_hints_preload_settings',
$id,
'push',
),
),
),
array(
'data' => array(
'#type' => 'checkbox',
'#title' => t('Local'),
'#title_display' => 'invisible',
'#default_value' => $entry['local'],
'#parents' => array(
'advagg_resource_hints_preload_settings',
$id,
'local',
),
),
),
array(
'data' => array(
'#type' => 'checkbox',
'#title' => t('External'),
'#title_display' => 'invisible',
'#default_value' => $entry['external'],
'#parents' => array(
'advagg_resource_hints_preload_settings',
$id,
'external',
),
),
),
),
'class' => array(
'draggable',
),
);
// Build rows of the form elements in the table.
$row_elements[$id] = array(
'weight' => &$rows[$id]['data'][1]['data'],
'enabled' => &$rows[$id]['data'][3]['data'],
'push' => &$rows[$id]['data'][4]['data'],
'local' => &$rows[$id]['data'][5]['data'],
'external' => &$rows[$id]['data'][6]['data'],
);
}
// Add the table to the form.
$form['global_container']['global']['resource_hints']['preload']['advagg_resource_hints_preload_settings']['advagg_table'] = array(
'#theme' => 'table',
// The row form elements need to be processed and build,
// therefore pass them as element children.
'elements' => $row_elements,
'#header' => array(
// We need two empty columns for the weight field and the cross.
array(
'data' => NULL,
'colspan' => 2,
),
t('Name'),
t('Enabled'),
t('HTTP/2 Push'),
t('Local'),
t('External'),
),
'#rows' => $rows,
'#attributes' => array(
'id' => 'entry-order',
),
);
drupal_add_tabledrag('entry-order', 'order', 'sibling', 'entry-order-weight');
$form['global_container']['global']['resource_hints']['preload']['advagg_resource_hints_preload_settings']['advagg_resource_hints_preload_reset'] = array(
'#type' => 'submit',
'#value' => t('Reset'),
'#submit' => array(
'advagg_admin_resource_hints_preload_reset',
),
);
$form['global_container']['global']['resource_hints']['advagg_resource_hints_use_immutable'] = array(
'#type' => 'checkbox',
'#title' => t('Send immutable header for all aggregated files (recommended).'),
'#default_value' => variable_get('advagg_resource_hints_use_immutable', ADVAGG_RESOURCE_HINTS_USE_IMMUTABLE),
'#description' => t('Have Apache send <a href="@url1">Cache-Control: immutable</a> for all aggregated files. Current <a href="@url2">browser support</a>', array(
'@url1' => 'http://bitsup.blogspot.de/2016/05/cache-control-immutable.html',
'@url2' => 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#Browser_compatibility',
)),
'#recommended_value' => TRUE,
);
$form['global_container']['global']['cron'] = array(
'#type' => 'fieldset',
'#title' => t('Cron Options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('Unless you have a good reason to adjust these values you should leave them alone.'),
);
// @codingStandardsIgnoreStart
$short_times = drupal_map_assoc(array(
60 * 15,
// 15 min.
60 * 30,
// 30 min.
60 * 45,
// 45 min.
60 * 60,
// 1 hour.
60 * 60 * 2,
// 2 hours.
60 * 60 * 4,
// 4 hours.
60 * 60 * 6,
// 6 hours.
60 * 60 * 8,
// 8 hours.
60 * 60 * 10,
// 10 hours.
60 * 60 * 12,
// 12 hours.
60 * 60 * 18,
// 18 hours.
60 * 60 * 23,
// 23 hours.
60 * 60 * 24,
// 1 day.
60 * 60 * 24 * 2,
), 'format_interval');
$long_times = drupal_map_assoc(array(
60 * 60 * 24 * 2,
// 2 days.
60 * 60 * 24 * 3,
// 3 days.
60 * 60 * 24 * 4,
// 4 days.
60 * 60 * 24 * 5,
// 5 days.
60 * 60 * 24 * 6,
// 6 days.
60 * 60 * 24 * 7,
// 1 week.
60 * 60 * 24 * 7 * 2,
// 2 weeks.
60 * 60 * 24 * 7 * 3,
// 3 weeks.
60 * 60 * 24 * 30,
// 1 month.
60 * 60 * 24 * 45,
// 1 month 2 weeks.
60 * 60 * 24 * 60,
), 'format_interval');
// @codingStandardsIgnoreEnd
$last_ran = variable_get('advagg_cron_timestamp', 0);
if (!empty($last_ran)) {
$last_ran = t('@time ago', array(
'@time' => format_interval(REQUEST_TIME - $last_ran),
));
}
else {
$last_ran = t('never');
}
$form['global_container']['global']['cron']['advagg_cron_frequency'] = array(
'#type' => 'select',
'#options' => $short_times,
'#title' => 'Minimum amount of time between advagg_cron() runs.',
'#default_value' => variable_get('advagg_cron_frequency', ADVAGG_CRON_FREQUENCY),
'#description' => t('The default value for this is %value. The last time advagg_cron was ran is %time.', array(
'%value' => format_interval(ADVAGG_CRON_FREQUENCY),
'%time' => $last_ran,
)),
);
$form['global_container']['global']['cron']['drupal_stale_file_threshold'] = array(
'#type' => 'select',
'#options' => $long_times,
'#title' => 'Delete aggregates accessed/modified more than a set time ago.',
// @codingStandardsIgnoreLine
'#default_value' => variable_get('drupal_stale_file_threshold', 2592000),
'#description' => t('The default value for this is %value.', array(
'%value' => format_interval(2592000),
)),
);
$form['global_container']['global']['cron']['advagg_remove_missing_files_from_db_time'] = array(
'#type' => 'select',
'#options' => $long_times,
'#title' => 'How long to wait until unaccessed aggregates with missing files are removed from the database.',
'#default_value' => variable_get('advagg_remove_missing_files_from_db_time', ADVAGG_REMOVE_MISSING_FILES_FROM_DB_TIME),
'#description' => t('The default value for this is %value.', array(
'%value' => format_interval(ADVAGG_REMOVE_MISSING_FILES_FROM_DB_TIME),
)),
);
$form['global_container']['global']['cron']['advagg_remove_old_unused_aggregates_time'] = array(
'#type' => 'select',
'#options' => $long_times,
'#title' => 'How long to wait until unaccessed aggregates are removed from the database.',
'#default_value' => variable_get('advagg_remove_old_unused_aggregates_time', ADVAGG_REMOVE_OLD_UNUSED_AGGREGATES_TIME),
'#description' => t('The default value for this is %value.', array(
'%value' => format_interval(ADVAGG_REMOVE_OLD_UNUSED_AGGREGATES_TIME),
)),
);
$form['global_container']['global']['obscure'] = array(
'#type' => 'fieldset',
'#title' => t('Obscure Options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('Some of the more obscure AdvAgg settings. Odds are you do not need to change anything in here.'),
);
$form['global_container']['global']['obscure']['advagg_gzip'] = array(
'#type' => 'checkbox',
'#title' => t('Create .gz files'),
'#default_value' => variable_get('advagg_gzip', ADVAGG_GZIP),
'#description' => t('All aggregated files can be pre-compressed into a .gz file and
served from Apache. This is faster then gzipping the file on each request.'),
);
$form['global_container']['global']['obscure']['advagg_brotli'] = array(
'#type' => 'checkbox',
'#title' => t('Create .br files'),
'#default_value' => variable_get('advagg_brotli', ADVAGG_BROTLI),
'#description' => t('All aggregated files can be pre-compressed into a .br file and
served from Apache. This is faster then brotli compressing the file on each request.'),
);
if (!function_exists('brotli_compress') || !defined('BROTLI_TEXT')) {
$form['global_container']['global']['obscure']['advagg_brotli']['#default_value'] = FALSE;
$form['global_container']['global']['obscure']['advagg_brotli']['#disabled'] = TRUE;
$form['global_container']['global']['obscure']['advagg_brotli']['#description'] .= ' ' . t('The <a href="@url">PHP brotli extension</a> is needed in order to enable this feature.', array(
'@url' => 'https://github.com/kjdev/php-ext-brotli',
));
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
$form['global_container']['global']['obscure']['advagg_brotli']['#description'] .= ' ' . t('If running on windows this is a helpful guide on how to compile <a href="@url">PHP extensions</a>. Also noted that <a href="@iis">IIS has a Brotli extension</a>,', array(
'@url' => 'https://wiki.php.net/internals/windows/stepbystepbuild',
'@iis' => 'https://www.iis.net/downloads/community/2016/03/iis-brotli',
));
}
}
$form['global_container']['global']['obscure']['advagg_ajax_render_alter'] = array(
'#type' => 'checkbox',
'#title' => t('Run advagg_ajax_render_alter()'),
'#default_value' => variable_get('advagg_ajax_render_alter', ADVAGG_AJAX_RENDER_ALTER),
'#description' => t('If disabled, AdvAgg will not alter the aggregates returned by ajax requests.'),
);
$form['global_container']['global']['obscure']['advagg_include_base_url'] = array(
'#type' => 'checkbox',
'#title' => t('Include the base_url variable in the hooks hash array.'),
'#default_value' => variable_get('advagg_include_base_url', ADVAGG_INCLUDE_BASE_URL),
'#description' => t('If you would like a unique set of aggregates for every permutation of the base_url (current value: %value) then enable this setting. <a href="@issue">Read more</a>.', array(
'%value' => $GLOBALS['base_url'],
'@issue' => 'https://www.drupal.org/node/2353811',
)),
);
$form['global_container']['global']['obscure']['advagg_convert_absolute_to_relative_path'] = array(
'#type' => 'checkbox',
'#title' => t('Convert absolute paths to be self references.'),
'#default_value' => variable_get('advagg_convert_absolute_to_relative_path', ADVAGG_CONVERT_ABSOLUTE_TO_RELATIVE_PATH),
'#description' => t('If the src to a CSS/JS file points to this domain, convert the absolute path to a relative path. Will also convert url() references inside of css files. This is generally safe unless the drupal page will be embedded, like it is when used as an iframe.'),
);
$form['global_container']['global']['obscure']['advagg_convert_absolute_to_protocol_relative_path'] = array(
'#type' => 'checkbox',
'#title' => t('Convert absolute paths to be protocol relative paths.'),
'#default_value' => variable_get('advagg_convert_absolute_to_protocol_relative_path', ADVAGG_CONVERT_ABSOLUTE_TO_PROTOCOL_RELATIVE_PATH),
'#description' => t('If the src to a CSS/JS file points starts with http:// or https://, convert it to use a protocol relative path //. Will also convert url() references inside of css files. This is incompatible with IE6 and might cause extra bandwidth usage in IE7 and IE8 in regards to url() statements inside css files. According to <a href="@url">current web browser market share</a> IE 6 is less than 0.2% of the total number of browsers in use and IE 7+8 make up under 5% of browsers in use.', array(
'@url' => 'http://www.w3counter.com/trends',
)),
'#states' => array(
'enabled' => array(
'#edit-advagg-force-https-path' => array(
'checked' => FALSE,
),
),
),
);
$form['global_container']['global']['obscure']['advagg_force_https_path'] = array(
'#type' => 'checkbox',
'#title' => t('Convert http:// to https://.'),
'#default_value' => variable_get('advagg_force_https_path', ADVAGG_FORCE_HTTPS_PATH),
'#description' => t('If the src to a CSS/JS file starts with http:// convert it https://. Will also convert url() references inside of css files.'),
'#states' => array(
'enabled' => array(
'#edit-advagg-convert-absolute-to-protocol-relative-path' => array(
'checked' => FALSE,
),
),
),
);
$form['global_container']['global']['obscure']['advagg_css_absolute_path'] = array(
'#type' => 'checkbox',
'#title' => t('Convert CSS url() to absolute paths if file is outside of the public:// dir.'),
'#default_value' => variable_get('advagg_css_absolute_path', ADVAGG_CSS_ABSOLUTE_PATH),
'#description' => t('Useful for CSS files hosted on S3 where the referenced files inside of url() is not in the same location as the aggregated CSS file.'),
);
$form['global_container']['global']['obscure']['advagg_skip_file_create_url_inside_css'] = array(
'#type' => 'checkbox',
'#title' => t('Do not run CSS url() values through file_create_url().'),
'#default_value' => variable_get('advagg_skip_file_create_url_inside_css', ADVAGG_SKIP_FILE_CREATE_URL_INSIDE_CSS),
'#description' => t('If checked, the processing of url() values within CSS will be handled more like core than the CDN module. This will not convert relative paths in your source CSS to absolute paths in the aggregated CSS.'),
);
$form['global_container']['global']['obscure']['advagg_htaccess_symlinksifownermatch'] = array(
'#type' => 'checkbox',
'#title' => t('Use "Options +SymLinksIfOwnerMatch"'),
'#default_value' => variable_get('advagg_htaccess_symlinksifownermatch', ADVAGG_HTACCESS_SYMLINKSIFOWNERMATCH),
'#description' => t('By default the custom .htaccess files are configured to use "<code>Options +FollowSymLinks</code>". Some hosting companies do not support this so "<code>Options +SymLinksIfOwnerMatch</code>" must be used instead.'),
);
$form['global_container']['global']['obscure']['advagg_disable_on_admin'] = array(
'#type' => 'checkbox',
'#title' => t('Do not use AdvAgg or any aggregation in the admin section.'),
'#default_value' => variable_get('advagg_disable_on_admin', ADVAGG_DISABLE_ON_ADMIN),
'#description' => t('If checked, AdvAgg will not be used in the /admin section as well as any place the admin theme is used.'),
);
$form['global_container']['global']['obscure']['advagg_disable_on_listed_pages'] = array(
'#type' => 'textarea',
'#title' => t('Do not use AdvAgg or any aggregation in the following pages'),
'#default_value' => variable_get('advagg_disable_on_listed_pages', ADVAGG_DISABLE_ON_LISTED_PAGES),
'#description' => t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog.", array(
'%blog' => 'blog',
'%blog-wildcard' => 'blog/*',
)),
);
// Get core htaccess files.
$core_htaccess = advagg_htaccess_rewritebase();
$advagg_htaccess_rewritebase = variable_get('advagg_htaccess_rewritebase', ADVAGG_HTACCESS_REWRITEBASE);
if (!empty($core_htaccess)) {
// Get advagg htaccess files.
list($css_path, $js_path) = advagg_get_root_files_dir();
$advagg_css_htaccess = advagg_htaccess_rewritebase($css_path[1]);
$advagg_js_htaccess = advagg_htaccess_rewritebase($js_path[1]);
// Build best guess dir name.
$core_htaccess_directive = trim(str_ireplace('RewriteBase ', '', $core_htaccess));
$new_dir = str_replace('//', '/', $core_htaccess_directive . '/' . dirname($css_path[1]));
$form['global_container']['global']['obscure']['advagg_htaccess_rewritebase'] = array(
'#type' => 'textfield',
'#title' => t('AdvAgg RewriteBase Directive in .htaccess files.'),
'#default_value' => $advagg_htaccess_rewritebase,
'#description' => t('If gzip and/or brotli files are getting a 307 instead of a 200, this might fix the issue. This Drupal install is using "<code>@core_htaccess</code>" in the webroot .htaccess file. Based off of this and the current location of the advagg css/js directories (@css_path, @js_path) this is the recommended value for this field: <p><code>@best_guess</code><br></p> Current advagg htaccess values:<p><code>@advagg_css_htaccess</code><br><code>@advagg_js_htaccess</code></p> Note that the advagg CSS/JS directories are automatically added onto the end of the given input value.', array(
'@core_htaccess' => $core_htaccess,
'@best_guess' => $new_dir,
'@css_path' => $css_path[1],
'@js_path' => $js_path[1],
'@advagg_css_htaccess' => $advagg_css_htaccess,
'@advagg_js_htaccess' => $advagg_js_htaccess,
)),
);
}
elseif (!empty($advagg_htaccess_rewritebase)) {
list($css_path, $js_path) = advagg_get_root_files_dir();
$advagg_css_htaccess = advagg_htaccess_rewritebase($css_path[1]);
$advagg_js_htaccess = advagg_htaccess_rewritebase($js_path[1]);
// Offer advice if this setting should be disabled.
$form['global_container']['global']['obscure']['advagg_htaccess_rewritebase'] = array(
'#type' => 'textfield',
'#title' => t('AdvAgg RewriteBase Directive in .htaccess files.'),
'#default_value' => $advagg_htaccess_rewritebase,
'#description' => t('This Drupal install is no longer using RewriteBase in the webroot .htaccess file. The recommended value for this field is a blank string (empty) <br>Current advagg htaccess values:<p><code>@advagg_css_htaccess</code><br><code>@advagg_js_htaccess</code></p>', array(
'@advagg_css_htaccess' => $advagg_css_htaccess,
'@advagg_js_htaccess' => $advagg_js_htaccess,
)),
);
}
$form['global_container']['css'] = array(
'#type' => 'fieldset',
'#title' => t('CSS Options'),
);
$form['global_container']['css']['advagg_combine_css_media'] = array(
'#type' => 'checkbox',
'#title' => t('Combine CSS files by using media queries (recommended)'),
'#default_value' => variable_get('advagg_combine_css_media', ADVAGG_COMBINE_CSS_MEDIA),
'#description' => t('Will combine more CSS files together because different CSS media types can be used in the same file by using media queries. Use cores grouping logic needs to be unchecked in order for this to work. Also noted is that due to an issue with IE9, compatibility mode is forced off if this is enabled.'),
'#states' => array(
'disabled' => array(
'#edit-advagg-core-groups' => array(
'checked' => TRUE,
),
),
),
'#recommended_value' => TRUE,
);
$form['global_container']['css']['advagg_ie_css_selector_limiter'] = array(
'#type' => 'checkbox',
'#title' => t('Prevent more than %limit CSS selectors in an aggregated CSS file', array(
'%limit' => variable_get('advagg_ie_css_selector_limiter_value', ADVAGG_IE_CSS_SELECTOR_LIMITER_VALUE),
)),
'#default_value' => variable_get('advagg_ie_css_selector_limiter', ADVAGG_IE_CSS_SELECTOR_LIMITER),
'#description' => t('Internet Explorer before version 10; IE9, IE8, IE7, and IE6 all have 4095 as the limit for the maximum number of css selectors that can be in a file. Enabling this will prevent CSS aggregates from being created that exceed this limit. <a href="@link">More info</a>. Use cores grouping logic needs to be unchecked in order for this to work.', array(
'@link' => 'http://blogs.msdn.com/b/ieinternals/archive/2011/05/14/10164546.aspx',
)),
'#states' => array(
'disabled' => array(
'#edit-advagg-core-groups' => array(
'checked' => TRUE,
),
),
),
'#recommended_value' => FALSE,
);
$form['global_container']['css']['advagg_ie_css_selector_limiter_value'] = array(
'#type' => 'textfield',
'#title' => t('The selector count the IE CSS limiter should use'),
'#default_value' => variable_get('advagg_ie_css_selector_limiter_value', ADVAGG_IE_CSS_SELECTOR_LIMITER_VALUE),
'#description' => t('Internet Explorer before version 10; IE9, IE8, IE7, and IE6 all have 4095 as the limit for the maximum number of css selectors that can be in a file. Use this field to modify the value used; 4095 sometimes may be still be too many with media queries.'),
'#states' => array(
'visible' => array(
'#edit-advagg-ie-css-selector-limiter' => array(
'checked' => TRUE,
),
),
'disabled' => array(
'#edit-advagg-ie-css-selector-limiter' => array(
'checked' => FALSE,
),
),
),
);
$form['global_container']['css']['advagg_css_fix_type'] = array(
'#type' => 'checkbox',
'#title' => t('Fix improperly set type (recommended)'),
'#default_value' => variable_get('advagg_css_fix_type', ADVAGG_CSS_FIX_TYPE),
'#description' => t('If type is external but does not start with http, https, or // change it to be type file. If type is file but it starts with http, https, or // change type to be external. Note that if this is causing issues, odds are you have a double slash when there should be a single; see <a href="@link">this issue</a>', array(
'@link' => 'https://www.drupal.org/node/2336217',
)),
'#recommended_value' => TRUE,
);
$form['global_container']['css']['advagg_css_remove_empty_files'] = array(
'#type' => 'checkbox',
'#title' => t('Remove empty CSS files from aggregates (recommended)'),
'#default_value' => variable_get('advagg_css_remove_empty_files', ADVAGG_CSS_REMOVE_EMPTY_FILES),
'#description' => t('If an empty CSS file ends up being in its own aggregate, that aggregate can end up as a 404.'),
'#recommended_value' => TRUE,
);
$form['global_container']['js'] = array(
'#type' => 'fieldset',
'#title' => t('JS Options'),
);
$form['global_container']['js']['advagg_js_fix_type'] = array(
'#type' => 'checkbox',
'#title' => t('Fix improperly set type (recommended)'),
'#default_value' => variable_get('advagg_js_fix_type', ADVAGG_JS_FIX_TYPE),
'#description' => t('If type is external but does not start with http, https, or // change it to be type file. If type is file but it starts with http, https, or // change type to be external. Note that if this is causing issues, odds are you have a double slash when there should be a single; see <a href="@link">this issue</a>', array(
'@link' => 'https://www.drupal.org/node/2336217',
)),
'#recommended_value' => TRUE,
);
$form['global_container']['js']['advagg_js_remove_empty_files'] = array(
'#type' => 'checkbox',
'#title' => t('Remove empty JS files from aggregates (recommended)'),
'#default_value' => variable_get('advagg_js_remove_empty_files', ADVAGG_JS_REMOVE_EMPTY_FILES),
'#description' => t('If an empty JS file ends up being in its own aggregate, that aggregate can end up as a 404.'),
'#recommended_value' => TRUE,
);
$form['global_container']['js']['advagg_scripts_scope_anywhere'] = array(
'#type' => 'checkbox',
'#title' => t('Allow for JS to be added to blocks and views'),
'#default_value' => variable_get('advagg_scripts_scope_anywhere', ADVAGG_SCRIPTS_SCOPE_ANYWHERE),
'#description' => t('The scope key when using drupal_add_js and friends can be used to insert script tags throughout the html body. To see possible insertion points set <code>@theme_debug</code> in your settings.php file and view the page source while looking for @comment html comments. Some example scopes: <p><code>!example</code></p>', array(
'@theme_debug' => '$conf[\'theme_debug\'] = TRUE;',
'@comment' => '<!-- AdvAgg * tag -->',
'!example' => "page_top:prefix<br />block:prefix:system:powered-by<br />view:suffix:frontpage:page",
)),
);
// Clear the cache bins on submit.
$form['#submit'][] = 'advagg_admin_settings_form_submit';
return system_settings_form($form);
}
/**
* Form builder; Do advagg operations.
*/
function advagg_admin_operations_form($form, $form_state) {
drupal_set_title(t('AdvAgg: Operations'));
advagg_display_message_if_requirements_not_met();
// Explain what can be done on this page.
$form['tip'] = array(
'#markup' => '<p>' . t('This is a collection of commands to control the cache and to manage testing of this module. In general this page is useful when troubleshooting some aggregation issues. For normal operations, you do not need to do anything on this page below the Smart Cache Flush. There are no configuration options here.') . '</p>',
);
// Buttons to do stuff.
// AdvAgg smart cache flushing.
$form['smart_flush'] = array(
'#type' => 'fieldset',
'#title' => t('Smart Cache Flush'),
'#description' => t('Scan all files referenced in aggregated files. If any of them have changed, clear that cache so the changes will go out.'),
);
$form['smart_flush']['advagg_flush'] = array(
'#type' => 'submit',
'#value' => t('Flush AdvAgg Cache'),
'#submit' => array(
'advagg_admin_flush_cache_button',
),
);
// Set/Remove Bypass Cookie.
$form['bypass'] = array(
'#type' => 'fieldset',
'#title' => t('Aggregation Bypass Cookie'),
'#description' => t('This will set or remove a cookie that disables aggregation for a set period of time.'),
);
$bypass_length = drupal_map_assoc(array(
60 * 60 * 6,
60 * 60 * 12,
60 * 60 * 24,
60 * 60 * 24 * 2,
60 * 60 * 24 * 7,
60 * 60 * 24 * 30,
60 * 60 * 24 * 365,
), 'format_interval');
$form['bypass']['timespan'] = array(
'#type' => 'select',
'#title' => 'Bypass length',
'#options' => $bypass_length,
);
$form['bypass']['submit'] = array(
'#type' => 'submit',
'#value' => t('Toggle The "aggregation bypass cookie" For This Browser'),
'#attributes' => array(
'onclick' => 'javascript:return advagg_toggle_cookie()',
),
'#submit' => array(
'advagg_admin_toggle_bypass_cookie',
),
);
// Add in aggregation bypass cookie javascript.
$form['#attached']['js'][] = array(
'data' => array(
'advagg' => array(
'key' => drupal_hmac_base64('advagg_cookie', drupal_get_private_key() . drupal_get_hash_salt() . variable_get('cron_key', 'drupal')),
),
),
'type' => 'setting',
);
$form['#attached']['js'][] = drupal_get_path('module', 'advagg') . '/advagg.admin.js';
// Regenerate .htaccess files.
if (variable_get('advagg_htaccess_check_generate', ADVAGG_HTACCESS_CHECK_GENERATE)) {
list($css_path, $js_path) = advagg_get_root_files_dir();
$form['htaccess'] = array(
'#type' => 'fieldset',
'#title' => t('Regenerate .htaccess files'),
'#description' => t('<code>@advagg_css_htaccess</code><br><code>@advagg_js_htaccess</code>', array(
'@advagg_css_htaccess' => $css_path[1] . '/.htaccess',
'@advagg_js_htaccess' => $js_path[1] . '/.htaccess',
)),
);
$form['htaccess']['advagg_regenerate_htaccess'] = array(
'#type' => 'submit',
'#value' => t('Recreate htaccess files'),
'#submit' => array(
'advagg_admin_regenerate_htaccess_button',
),
);
}
// Tasks run by cron.
$form['cron'] = array(
'#type' => 'fieldset',
'#title' => t('Cron Maintenance Tasks'),
'#description' => t('The following 7 operations are ran on cron but you can run them manually here.'),
);
$form['cron']['smart_file_flush'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Clear All Stale Files'),
'#description' => t('Remove all stale files. Scan all files in the advagg_css/js directories and remove the ones that have not been accessed in the last 30 days.'),
);
$form['cron']['smart_file_flush']['advagg_flush_stale_files'] = array(
'#type' => 'submit',
'#value' => t('Remove All Stale Files'),
'#submit' => array(
'advagg_admin_flush_stale_files_button',
),
);
$form['cron']['delete_empty_aggregates'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete empty aggregates'),
'#description' => t('Delete all aggregates that have no content so that they can be regenerated.'),
);
$form['cron']['delete_empty_aggregates']['advagg_delete_empty_aggregates'] = array(
'#type' => 'submit',
'#value' => t('Delete empty aggregates'),
'#submit' => array(
'advagg_delete_empty_aggregates_button',
),
);
$form['cron']['delete_orphaned_aggregates'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete orphaned aggregates'),
'#description' => t('Scan CSS/JS advagg dir and remove file if there is no associated db record.'),
);
$form['cron']['delete_orphaned_aggregates']['advagg_delete_orphaned_aggregates'] = array(
'#type' => 'submit',
'#value' => t('Delete orphaned aggregates'),
'#submit' => array(
'advagg_admin_delete_orphaned_aggregates_button',
),
);
$form['cron']['remove_missing_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Clear Missing Files From Database'),
'#description' => t('Scan for missing files and remove the associated entries in the database.'),
);
$form['cron']['remove_missing_files']['advagg_remove_missing_files_from_db'] = array(
'#type' => 'submit',
'#value' => t('Clear Missing Files From Database'),
'#submit' => array(
'advagg_admin_remove_missing_files_from_db_button',
),
);
$form['cron']['remove_old_aggregates'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete Unused Aggregates From Database'),
'#description' => t('Delete aggregates that have not been accessed in the last 6 weeks.'),
);
$form['cron']['remove_old_aggregates']['advagg_remove_old_unused_aggregates'] = array(
'#type' => 'submit',
'#value' => t('Delete Unused Aggregates From Database'),
'#submit' => array(
'advagg_admin_remove_old_unused_aggregates_button',
),
);
$form['cron']['cleanup_semaphore_table'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete Orphaned Semaphore Locks'),
'#description' => t('Delete orphaned/expired advagg locks from the semaphore database table.'),
);
$form['cron']['cleanup_semaphore_table']['advagg_cleanup_semaphore_table'] = array(
'#type' => 'submit',
'#value' => t('Delete Orphaned Semaphore Locks'),
'#submit' => array(
'advagg_admin_cleanup_semaphore_table_button',
),
);
$form['cron']['cleanup_temp_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete leftover temporary files'),
'#description' => t('Delete old temporary files from the filesystem.'),
);
$form['cron']['cleanup_temp_files']['advagg_remove_temp_files'] = array(
'#type' => 'submit',
'#value' => t('Delete leftover temporary files'),
'#submit' => array(
'advagg_admin_cleanup_temp_files_button',
),
);
if (module_exists('locale')) {
$form['cron']['refresh_locale_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Refresh all locale files'),
'#description' => t('Run all js files in the advagg_files table through locale_js_alter; loop for each enabled language.'),
);
$form['cron']['refresh_locale_files']['advagg_refresh_all_locale_files'] = array(
'#type' => 'submit',
'#value' => t('Refresh all locale files'),
'#submit' => array(
'advagg_admin_refresh_locale_files_button',
),
);
}
// Hide drastic measures as they should not be done unless you really need it.
$form['drastic_measures'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Drastic Measures'),
'#description' => t('The options below should normally never need to be done.'),
);
$form['drastic_measures']['dumb_cache_flush'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Clear All Caches'),
'#description' => t('Remove all entries from the advagg cache bins. Useful if you suspect a cache is not getting cleared.'),
);
$form['drastic_measures']['dumb_cache_flush']['advagg_flush_all_caches'] = array(
'#type' => 'submit',
'#value' => t('Clear All Caches'),
'#submit' => array(
'advagg_admin_clear_all_caches_button',
),
);
$form['drastic_measures']['dumb_file_flush'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Clear All Files'),
'#description' => t('Remove all generated files. Useful if you think some of the generated files got corrupted and thus need to be deleted.'),
);
$form['drastic_measures']['dumb_file_flush']['advagg_flush_all_files'] = array(
'#type' => 'submit',
'#value' => t('Remove All Generated Files'),
'#submit' => array(
'advagg_admin_clear_all_files_button',
),
);
$form['drastic_measures']['force_change'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Force new aggregates'),
'#description' => t('Force the creation of all new aggregates by incrementing a global counter. Current value of counter: %value. This is useful if a CDN has cached an aggregate incorrectly as it will force new ones to be used even if nothing else has changed.', array(
'%value' => advagg_get_global_counter(),
)),
);
$form['drastic_measures']['force_change']['increment_global_counter'] = array(
'#type' => 'submit',
'#value' => t('Increment Global Counter'),
'#submit' => array(
'advagg_admin_increment_global_counter',
),
);
$form['drastic_measures']['rescan_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Rescan all files'),
'#description' => t('Force rescan all files and clear the cache. Useful if a css/js change from a deployment did not work.'),
);
$form['drastic_measures']['rescan_files']['reset_mtime'] = array(
'#type' => 'submit',
'#value' => t('Reset All mtime Values'),
'#submit' => array(
'advagg_admin_reset_mtime',
),
);
$form['drastic_measures']['remove_empty_advagg_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Remove deleted files in the advagg_files table'),
'#description' => t('Remove entries in the advagg_files table that have a filesize of 0 and delete the javascript_parsed variable. This gets around the grace period that the cron cleanup does.'),
);
$form['drastic_measures']['remove_empty_advagg_files']['advagg_admin_remove_empty_advagg_files'] = array(
'#type' => 'submit',
'#value' => t('Remove deleted files from advagg_files'),
'#submit' => array(
'advagg_admin_remove_empty_advagg_files',
),
);
$form['drastic_measures']['reset_advagg_files'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Reset the AdvAgg Files table'),
'#description' => t('Truncate the advagg_files table and delete the javascript_parsed variable. This may cause some 404s for CSS/JS assets for a short amount of time (seconds). Useful if you really want to reset some stuff. Might be best to put the site into maintenance mode before doing this.'),
);
$form['drastic_measures']['reset_advagg_files']['truncate_advagg_files'] = array(
'#type' => 'submit',
'#value' => t('Truncate advagg_files'),
'#submit' => array(
'advagg_admin_truncate_advagg_files',
),
);
$form['drastic_measures']['clear_base_file'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Delete all aggregates containing this base file.'),
'#description' => t('Pinpoint clearing of all aggregates that contain a file.'),
);
$form['drastic_measures']['clear_base_file']['filename'] = array(
'#type' => 'textfield',
'#size' => 170,
'#maxlength' => 256,
'#default_value' => '',
'#title' => t('Filename'),
);
$form['drastic_measures']['clear_base_file']['submit'] = array(
'#type' => 'submit',
'#value' => t('Delete Select Aggregates'),
'#validate' => array(
'advagg_admin_clear_file_aggregate_validate',
),
'#submit' => array(
'advagg_admin_clear_file_aggregate_submit',
),
'#ajax' => array(
'callback' => 'advagg_admin_clear_file_aggregate_callback',
'wrapper' => 'advagg-clear-file-aggregate-ajax',
'effect' => 'fade',
),
);
$types = array(
'css',
'js',
);
$css_file = '';
$js_file = '';
foreach ($types as $type) {
// Get valid filename.
$results = db_select('advagg_files', 'af')->fields('af', array(
'filename',
))
->condition('filetype', $type)
->orderBy('filename', 'ASC')
->execute();
while ($row = $results->fetchAssoc()) {
if (empty($css_file) && $type === 'css') {
$css_file = $row['filename'];
break;
}
if (empty($js_file) && $type === 'js') {
$js_file = $row['filename'];
break;
}
}
}
$form['drastic_measures']['clear_base_file']['tip'] = array(
'#markup' => '<p>' . t('Takes input like "@css_file" or "@advagg_js"', array(
'@css_file' => $css_file,
'@advagg_js' => $js_file,
)) . '</p>',
);
$form['drastic_measures']['clear_base_file']['wrapper'] = array(
'#markup' => "<div id='advagg-clear-file-aggregate-ajax'></div>",
);
return $form;
}
/**
* Form builder; Show info about advagg and advagg settings.
*
* @see system_settings_form()
*/
function advagg_admin_info_form($form, $form_state) {
drupal_set_title(t('AdvAgg: Information'));
advagg_display_message_if_requirements_not_met();
// Explain what can be done on this page.
$form['tip'] = array(
'#markup' => '<p>' . t('This page provides debugging information. There are no configuration options here.') . '</p>',
);
// Get all hooks and variables.
drupal_theme_initialize();
$core_hooks = theme_get_registry();
$advagg_hooks = advagg_hooks_implemented();
list(, $js_path) = advagg_get_root_files_dir();
// Output html process functions hooks.
$form['theme_info'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Hook Theme Info'),
);
$data = implode("\n", $core_hooks['html']['process functions']);
$form['theme_info']['advagg_theme_info'] = array(
'#markup' => '<pre>' . $data . '</pre>',
);
$form['render_info'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Hook Render Info'),
);
$element_info = array();
$element_info['scripts'] = element_info('scripts');
$element_info['styles'] = element_info('styles');
$output = '';
foreach ($element_info as $type => &$values) {
$output .= $type . ":\n";
foreach ($values as $key => &$value) {
if ($key === '#items' || $key === '#type') {
continue;
}
if (empty($value)) {
$output .= ' ' . $key . ' - ' . str_replace(array(
"\r",
"\n",
), '', (string) var_export($value, TRUE)) . "\n";
}
elseif (is_array($value)) {
$output .= ' ' . $key . ' - ' . implode(', ', $value) . "\n";
}
else {
$output .= ' ' . $key . ' - ' . print_r($value, TRUE) . "\n";
}
}
}
$form['render_info']['advagg_render_info'] = array(
'#markup' => '<pre>' . $output . '</pre>',
);
// Get all parent css and js files.
$types = array(
'css',
'js',
);
$css_file = '';
foreach ($types as $type) {
$form[$type] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('@type files', array(
'@type' => drupal_strtoupper($type),
)),
);
// Get filename, filename_hash, and changes.
$results = db_select('advagg_files', 'af')->fields('af', array(
'filename',
'filename_hash',
'changes',
))
->condition('filetype', $type)
->orderBy('filename', 'ASC')
->execute();
while ($row = $results->fetchAssoc()) {
if (empty($css_file) && $type === 'css') {
$css_file = basename($row['filename']);
}
$form[$type][$row['filename_hash']] = array(
'#markup' => '<div>' . format_plural($row['changes'], 'changed 1 time - %file<br />', 'changed %changes times - %file<br /></div>', array(
'%changes' => $row['changes'],
'%file' => $row['filename'],
)),
);
}
}
// Display as module -> hook instead of hook -> module.
ksort($advagg_hooks);
$module_hooks = array();
foreach ($advagg_hooks as $hook => $values) {
if (!empty($values)) {
foreach ($values as $module_name) {
if (!isset($module_hooks[$module_name])) {
$module_hooks[$module_name] = array();
}
$module_hooks[$module_name][] = $hook;
}
}
else {
$module_hooks['not in use'][] = $hook;
}
}
ksort($module_hooks);
// Output all advagg hooks implemented.
foreach ($module_hooks as $hook => $values) {
if (empty($values)) {
$form['modules_implementing_advagg'][$hook] = array(
'#markup' => '<div><strong>' . check_plain($hook) . ':</strong> 0</div>',
);
}
else {
$form['modules_implementing_advagg'][$hook] = array(
'#markup' => '<div><strong>' . check_plain($hook) . ':</strong> ' . count($values) . '<br /> ' . filter_xss(implode('<br /> ', $values), array(
'br',
)) . '</div>',
);
}
}
$form['modules_implementing_advagg'] += array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Modules implementing AdvAgg CSS/JS hooks'),
);
// Output all advagg hooks implemented.
foreach ($advagg_hooks as $hook => $values) {
if (empty($values)) {
$form['hooks_implemented'][$hook] = array(
'#markup' => '<div><strong>' . check_plain($hook) . ':</strong> 0</div>',
);
}
else {
$form['hooks_implemented'][$hook] = array(
'#markup' => '<div><strong>' . check_plain($hook) . ':</strong> ' . count($values) . '<br /> ' . filter_xss(implode('<br /> ', $values), array(
'br',
)) . '</div>',
);
}
}
$form['hooks_implemented'] += array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('AdvAgg CSS/JS hooks implemented by modules'),
);
// Output what is used inside of the advagg_get_current_hooks_hash() function.
$form['hooks_variables_hash'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Hooks And Variables Used In Hash'),
);
$form['hooks_variables_hash']['description'] = array(
'#markup' => t('Current Value: %value. Below is the listing of variables and hooks used to generate the 3rd hash of an aggregates filename.', array(
'%value' => advagg_get_current_hooks_hash(),
)),
);
$form['hooks_variables_hash']['output'] = array(
// @ignore production_php
'#markup' => '<pre>' . print_r(advagg_current_hooks_hash_array(), TRUE) . '</pre>',
);
// Get info about a file.
$form['get_info_about_agg'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#title' => t('Get detailed info about an aggregate file'),
);
$form['get_info_about_agg']['filename'] = array(
'#type' => 'textfield',
'#size' => 170,
'#maxlength' => 256,
'#default_value' => '',
'#title' => t('Filename'),
);
$form['get_info_about_agg']['submit'] = array(
'#type' => 'submit',
'#value' => t('Lookup Details'),
'#submit' => array(
'advagg_admin_get_file_info_submit',
),
'#validate' => array(
'advagg_admin_get_file_info_validate',
),
'#ajax' => array(
'callback' => 'advagg_admin_get_file_info_callback',
'wrapper' => 'advagg-file-info-ajax',
'effect' => 'fade',
),
);
module_load_include('install', 'advagg', 'advagg');
$first_file_path = advagg_s3fs_evaluate_no_rewrite_cssjs(FALSE) ? $js_path[0] : $js_path[1];
$form['get_info_about_agg']['tip'] = array(
'#markup' => '<p>' . t('Takes input like "@css_file" or a full aggregate name like "@advagg_js"', array(
'@css_file' => $css_file,
'@advagg_js' => advagg_install_get_first_advagg_file($first_file_path, 'js'),
)) . '</p>',
);
$form['get_info_about_agg']['wrapper'] = array(
'#markup' => "<div id='advagg-file-info-ajax'></div>",
);
return $form;
}
/**
* Add various advagg settings to the system_performance_settings form.
*/
function advagg_admin_system_performance_settings_form(&$form, $form_state) {
$msg = t('NOTE: If you wish to bypass aggregation for a set amount of time, you can go to the <a href="@operations">AdvAgg operations</a> page and press the "aggregation bypass cookie" button.', array(
'@operations' => url('admin/config/development/performance/advagg/operations'),
));
$msg .= ' ';
if (user_access('bypass advanced aggregation')) {
$msg .= t('You can also selectively bypass aggregation by adding <code>@code</code> to the URL of any page.', array(
'@code' => '?advagg=0',
));
}
else {
$msg .= t('You do not have the <a href="@permission">bypass advanced aggregation permission</a> so adding <code>@code</code> to the URL will not work at this time for you; either grant this permission to your user role or use the bypass cookie if you wish to selectively bypass aggregation.', array(
'@permission' => url('admin/people/permissions', array(
'fragment' => 'module-advagg',
)),
'@code' => '?advagg=0',
));
}
if (is_callable('omega_extension_enabled') && is_callable('omega_theme_get_setting') && omega_extension_enabled('development') && omega_theme_get_setting('omega_livereload', TRUE)) {
$msg .= ' ' . t('The omega theme is in development mode and livereload is also enabled. This setting combination disables CSS aggregation. If you wish to have CSS aggregation turned on, go to the <a href="@url">theme settings page</a>, select the Omega theme/subtheme and turn off LiveReload and/or turn off the Development extension.', array(
'@url' => url('admin/appearance/settings'),
));
}
$form['bandwidth_optimization']['advagg_note'] = array(
'#markup' => $msg,
);
}
/**
* @} End of "defgroup advagg_forms".
*/
/**
* @defgroup advagg_forms_callback AdvAgg forms callbacks and validation.
* @{
* Functions that handle user input from forms.
*/
/**
* Clear out the advagg cache bin when the save configuration button is pressed.
*/
function advagg_admin_settings_form_submit($form, &$form_state) {
// Remove non variables.
if (isset($form_state['values']['advagg_resource_hints_preload_reset'])) {
unset($form_state['values']['advagg_resource_hints_preload_reset']);
}
// Reset this form to defaults or recommended values; also show what changed.
advagg_set_admin_form_defaults_recommended($form_state, 'advagg_admin_mode');
// Sort and fix values before saving to the db.
foreach ($form_state['values']['advagg_resource_hints_preload_settings'] as &$entry) {
if (isset($entry['weight'])) {
$entry['#weight'] = $entry['weight'];
unset($entry['weight']);
}
ksort($entry);
}
uasort($form_state['values']['advagg_resource_hints_preload_settings'], 'element_sort');
// Make sure .htaccess file exists in the advagg dir.
if (isset($form_state['values']['advagg_resource_hints_use_immutable']) && variable_get('advagg_resource_hints_use_immutable', ADVAGG_RESOURCE_HINTS_USE_IMMUTABLE) != $form_state['values']['advagg_resource_hints_use_immutable'] && variable_get('advagg_htaccess_check_generate', ADVAGG_HTACCESS_CHECK_GENERATE)) {
// Set variable.
variable_set('advagg_resource_hints_use_immutable', $form_state['values']['advagg_resource_hints_use_immutable']);
unset($form_state['values']['advagg_resource_hints_use_immutable']);
// Get paths to .htaccess file.
list($css_path, $js_path) = advagg_get_root_files_dir();
$files['css'] = $css_path[0] . '/.htaccess';
$files['js'] = $js_path[0] . '/.htaccess';
// Make the advagg_htaccess_check_generate() function available.
module_load_include('inc', 'advagg', 'advagg.missing');
// Generate new .htaccess files in advagg dirs.
foreach ($files as $type => $uri) {
advagg_htaccess_check_generate(array(
$uri => $type,
), $type, TRUE);
}
}
// Alter htaccess if needed.
if (isset($form_state['values']['advagg_htaccess_rewritebase']) && variable_get('advagg_htaccess_rewritebase', ADVAGG_HTACCESS_REWRITEBASE) != $form_state['values']['advagg_htaccess_rewritebase'] && variable_get('advagg_htaccess_check_generate', ADVAGG_HTACCESS_CHECK_GENERATE)) {
// Set variable.
variable_set('advagg_htaccess_rewritebase', trim($form_state['values']['advagg_htaccess_rewritebase']));
unset($form_state['values']['advagg_htaccess_rewritebase']);
// Get paths to .htaccess file.
list($css_path, $js_path) = advagg_get_root_files_dir();
$files['css'] = $css_path[0] . '/.htaccess';
$files['js'] = $js_path[0] . '/.htaccess';
// Make the advagg_htaccess_check_generate() function available.
module_load_include('inc', 'advagg', 'advagg.missing');
// Generate new .htaccess files in advagg dirs.
foreach ($files as $type => $uri) {
advagg_htaccess_check_generate(array(
$uri => $type,
), $type, TRUE);
}
}
if (variable_get('advagg_htaccess_symlinksifownermatch', ADVAGG_HTACCESS_SYMLINKSIFOWNERMATCH) != $form_state['values']['advagg_htaccess_symlinksifownermatch'] && variable_get('advagg_htaccess_check_generate', ADVAGG_HTACCESS_CHECK_GENERATE)) {
list($css_path, $js_path) = advagg_get_root_files_dir();
$files['css'] = $css_path[0] . '/.htaccess';
$files['js'] = $js_path[0] . '/.htaccess';
// Make the advagg_htaccess_check_generate() function available.
module_load_include('inc', 'advagg', 'advagg.missing');
// Push out new setting.
variable_set('advagg_htaccess_symlinksifownermatch', $form_state['values']['advagg_htaccess_symlinksifownermatch']);
unset($form_state['values']['advagg_htaccess_symlinksifownermatch']);
foreach ($files as $type => $uri) {
advagg_htaccess_check_generate(array(
$uri => $type,
), $type, TRUE);
}
}
// Clear caches.
advagg_cache_clear_admin_submit();
}
/**
* Set or remove the AdvAggDisabled cookie.
*/
function advagg_admin_toggle_bypass_cookie($form, &$form_state) {
$cookie_name = 'AdvAggDisabled';
$key = drupal_hmac_base64('advagg_cookie', drupal_get_private_key() . drupal_get_hash_salt() . variable_get('cron_key', 'drupal'));
// If the cookie does exist then remove it.
if (!empty($_COOKIE[$cookie_name]) && $_COOKIE[$cookie_name] == $key) {
setcookie($cookie_name, '', -1, $GLOBALS['base_path'], '.' . $_SERVER['HTTP_HOST']);
unset($_COOKIE[$cookie_name]);
drupal_set_message(t('AdvAgg Bypass Cookie Removed.'));
}
else {
// Cookie will last for 12 hours.
setcookie($cookie_name, $key, REQUEST_TIME + $form_state['values']['timespan'], $GLOBALS['base_path'], '.' . $_SERVER['HTTP_HOST']);
$_COOKIE[$cookie_name] = $key;
drupal_set_message(t('AdvAgg Bypass Cookie Set for %time.', array(
'%time' => format_interval($form_state['values']['timespan']),
)));
}
}
/**
* Display file info in a drupal message.
*/
function advagg_admin_get_file_info_submit($form, &$form_state) {
// @codingStandardsIgnoreLine
if (!empty($form_state['input']['ajax_page_state'])) {
return;
}
$info = advagg_admin_get_file_info($form_state['values']['filename']);
if (module_exists('httprl')) {
$output = httprl_pr($info);
}
else {
$output = '<pre>' . check_plain(print_r($info, TRUE)) . '</pre>';
}
// @ignore security_dsm
drupal_set_message($output);
}
/**
* Display file info via ajax callback.
*/
function advagg_admin_get_file_info_callback($form, &$form_state) {
if (!empty($form_state['values']['error'])) {
return '<div id="advagg-file-info-ajax"></div>';
}
$info = advagg_admin_get_file_info($form_state['values']['filename']);
if (empty($info)) {
form_set_error('filename', t('Please input a valid aggregate filename.'));
return '<div id="advagg-file-info-ajax"></div>';
}
else {
if (module_exists('httprl')) {
$output = httprl_pr($info);
}
else {
$output = '<pre>' . print_r($info, TRUE) . '</pre>';
}
return '<div id="advagg-file-info-ajax">' . $output . '</div>';
}
}
/**
* Verify that the filename is correct.
*/
function advagg_admin_get_file_info_validate($form, &$form_state) {
if (empty($form_state['values']['filename'])) {
form_set_error('filename', t('Please input an aggregate filename.'));
$form_state['values']['error'] = TRUE;
}
}
/**
* Get detailed info about the given filename.
*
* @param string $filename
* Name of file to lookup.
*
* @return array
* Returns an array of detailed info about this file.
*/
function advagg_admin_get_file_info($filename) {
module_load_include('inc', 'advagg', 'advagg.missing');
module_load_include('inc', 'advagg', 'advagg');
// Strip quotes and trim.
$filename = trim(str_replace(array(
'"',
"'",
), '', $filename));
$data = advagg_get_hashes_from_filename(basename($filename));
$output = array();
if (is_array($data)) {
list($type, $aggregate_filenames_hash, $aggregate_contents_hash) = $data;
// Get a list of files.
$files = advagg_get_files_from_hashes($type, $aggregate_filenames_hash, $aggregate_contents_hash);
if (empty($files)) {
list($css_path, $js_path) = advagg_get_root_files_dir();
// Skip if the file exists.
if ($type === 'css') {
$uri = $css_path[0] . '/' . $filename;
}
elseif ($type === 'js') {
$uri = $js_path[0] . '/' . $filename;
}
if (file_exists($uri)) {
$atime = advagg_get_atime($aggregate_filenames_hash, $aggregate_contents_hash, $uri);
if (REQUEST_TIME - $atime > variable_get('drupal_stale_file_threshold', 2592000)) {
$files = t('This is an old aggregate, it should be deleted on the next cron run.');
}
else {
$files = t('This is an old aggregate, it should be deleted on the cron run after !time.', array(
'!time' => format_interval(variable_get('drupal_stale_file_threshold', 2592000) - (REQUEST_TIME - $atime)),
));
}
}
else {
$files = t('This aggregate file no longer exists.');
}
}
$data['files'] = $files;
// Get detailed info on each file.
$files_info_filenames = array();
foreach ($data['files'] as $filename => &$info) {
$files_info_filenames[] = $filename;
}
unset($info);
// Get filesystem data.
$files_info = advagg_get_info_on_files($files_info_filenames);
foreach ($data['files'] as $filename => &$info) {
$info += $files_info[$filename];
if (module_exists('advagg_bundler')) {
$bundler = advagg_bundler_analysis($filename);
$info['group_hash'] = $bundler['group_hash'];
}
}
unset($info);
$output = $data;
}
else {
$results = db_select('advagg_files', 'af')->fields('af')
->condition('filename', '%' . db_like($filename), 'LIKE')
->execute();
while ($row = $results->fetchAssoc()) {
$row += advagg_get_info_on_file($row['filename']);
if (module_exists('advagg_bundler')) {
$bundler = advagg_bundler_analysis($row['filename']);
$row['group_hash'] = $bundler['group_hash'];
}
$output[] = $row;
}
}
return $output;
}
/**
* Reset the advagg_resource_hints_preload_settings variable.
*/
function advagg_admin_resource_hints_preload_reset() {
variable_del('advagg_resource_hints_preload_settings');
}
/**
* Recreate the advagg htaccess files.
*/
function advagg_admin_regenerate_htaccess_button() {
// Get paths to .htaccess file.
list($css_path, $js_path) = advagg_get_root_files_dir();
$files['css'] = $css_path[0] . '/.htaccess';
$files['js'] = $js_path[0] . '/.htaccess';
// Make the advagg_htaccess_check_generate() function available.
module_load_include('inc', 'advagg', 'advagg.missing');
// Generate new .htaccess files in advagg dirs.
$errors = array();
foreach ($files as $type => $uri) {
$errors += advagg_htaccess_check_generate(array(
$uri => $type,
), $type, TRUE);
}
if (empty($errors)) {
drupal_set_message(t('The .htaccess files have been regenerated.'));
}
else {
drupal_set_message(t('The .htaccess files failed to be regenerated. @errors', array(
'@errors' => implode(', ', $errors),
)));
}
}
/**
* Perform a smart flush.
*/
function advagg_admin_flush_cache_button() {
// Clear the libraries cache.
if (function_exists('libraries_flush_caches')) {
$cache_tables = libraries_flush_caches();
foreach ($cache_tables as $table) {
cache_clear_all('*', $table, TRUE);
}
}
// Run the command.
module_load_include('inc', 'advagg', 'advagg.cache');
$flushed = advagg_push_new_changes();
if (variable_get('advagg_cache_level', ADVAGG_CACHE_LEVEL) >= 0) {
// Display a simple message if not in Development mode.
drupal_set_message(t('Advagg Cache Cleared'));
}
else {
list($css_path) = advagg_get_root_files_dir();
$parts_uri = $css_path[1] . '/parts';
// Report back the results.
foreach ($flushed as $filename => $data) {
if (strpos($filename, $parts_uri) === 0) {
// Do not report on css files manged in the parts directory.
unset($flushed[$filename]);
continue;
}
$ext = pathinfo($filename, PATHINFO_EXTENSION);
drupal_set_message(t('The file %filename has changed. %db_usage aggregates are using this file. %db_count db cache entries and all %type full cache entries have been flushed from the cache bins. Trigger: <code>@changes</code>', array(
'%filename' => $filename,
'%db_usage' => $data[0],
'%db_count' => $data[1],
'@changes' => print_r($data[2], TRUE),
'%type' => $ext,
)));
}
if (empty($flushed)) {
drupal_set_message(t('No changes found. Nothing was cleared.'));
return;
}
}
}
/**
* Clear out all advagg cache bins.
*/
function advagg_admin_clear_all_caches_button() {
// Clear the libraries cache.
if (function_exists('libraries_flush_caches')) {
$cache_tables = libraries_flush_caches();
foreach ($cache_tables as $table) {
cache_clear_all('*', $table, TRUE);
}
}
// Run the command.
module_load_include('inc', 'advagg', 'advagg.cache');
advagg_flush_all_cache_bins();
// Report back the results.
drupal_set_message(t('All AdvAgg cache bins have been cleared.'));
// Clear it again at the end of the request to be sure.
drupal_register_shutdown_function('advagg_flush_all_cache_bins', FALSE);
drupal_register_shutdown_function('advagg_push_new_changes');
}
/**
* Clear out all advagg aggregated files.
*/
function advagg_admin_clear_all_files_button() {
// Run the command.
module_load_include('inc', 'advagg', 'advagg.cache');
list($css_files, $js_files) = advagg_remove_all_aggregated_files();
// Report back the results.
drupal_set_message(t('All AdvAgg files have been deleted. %css_count CSS files and %js_count JS files have been removed.', array(
'%css_count' => count($css_files),
'%js_count' => count($js_files),
)));
}
/**
* Clear out all stale advagg aggregated files.
*/
function advagg_admin_flush_stale_files_button() {
// Run the command.
module_load_include('inc', 'advagg', 'advagg.cache');
list($css_files, $js_files) = advagg_delete_stale_aggregates();
// Report back the results.
if (count($css_files) > 0 || count($js_files) > 0) {
drupal_set_message(t('All stale aggregates have been deleted. %css_count CSS files and %js_count JS files have been removed.', array(
'%css_count' => count($css_files),
'%js_count' => count($js_files),
)));
}
else {
drupal_set_message(t('No stale aggregates found. Nothing was deleted.'));
}
}
/**
* Delete all empty advagg aggregated files.
*/
function advagg_delete_empty_aggregates_button() {
// Run the command.
module_load_include('inc', 'advagg', 'advagg.cache');
list($css_files, $js_files) = advagg_delete_empty_aggregates();
// Report back the results.
if (count($css_files) > 0 || count($js_files) > 0) {
drupal_set_message(t('All empty aggregates have been deleted. %css_count CSS files and %js_count JS files have been removed.', array(
'%css_count' => count($css_files),
'%js_count' => count($js_files),
)));
}
else {
drupal_set_message(t('No empty aggregates found. Nothing was deleted.'));
}
}
/**
* Clear out all advagg cache bins and increment the counter.
*/
function advagg_admin_increment_global_counter() {
// Clear out the cache.
advagg_admin_clear_all_caches_button();
// Increment counter.
module_load_include('inc', 'advagg', 'advagg.cache');
$new_value = advagg_increment_global_counter();
drupal_set_message(t('Global counter is now set to %new_value', array(
'%new_value' => $new_value,
)));
}
/**
* Clear out all advagg cache bins and increment the counter.
*/
function advagg_admin_reset_mtime() {
// Reset mtime.
db_update('advagg_files')->fields(array(
'mtime' => 0,
))
->execute();
drupal_set_message(t('All files have been rescanned.'));
// Smart cache clear.
advagg_admin_flush_cache_button();
// Clear out the cache.
advagg_admin_clear_all_caches_button();
}
/**
* Remove filesize zero files from the advagg_files table and clear caches.
*/
function advagg_admin_remove_empty_advagg_files() {
// Remove dead files from the advagg_files table.
db_delete('advagg_files')->condition('filesize', 0)
->execute();
variable_del('javascript_parsed');
drupal_set_message(t('All empty files in the advagg_files table have been removed.'));
// Clear out the cache.
advagg_admin_clear_all_caches_button();
}
/**
* Truncate the advagg_files table and clear caches.
*/
function advagg_admin_truncate_advagg_files() {
// Truncate advagg_files table.
db_truncate('advagg_files')->execute();
variable_del('javascript_parsed');
drupal_set_message(t('All files from the advagg_files table have been removed.'));
// Clear out the cache.
advagg_admin_clear_all_caches_button();
}
/**
* Scan CSS/JS advagg dir and remove file if there is no associated db record.
*/
function advagg_admin_delete_orphaned_aggregates_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Remove aggregates that include missing files.
$deleted = advagg_delete_orphaned_aggregates();
if (empty($deleted[0]) && empty($deleted[1])) {
drupal_set_message(t('All files have an associated db record; nothing was deleted.'));
}
else {
drupal_set_message(t('Some files had no associated db record and could be safely deleted from the file system. @raw', array(
'@raw' => print_r($deleted[1], TRUE),
)));
}
}
/**
* Scan for missing files and remove the associated entries in the database.
*/
function advagg_admin_remove_missing_files_from_db_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Remove aggregates that include missing files.
$deleted = advagg_remove_missing_files_from_db();
if (empty($deleted)) {
drupal_set_message(t('No missing files found or they could not be safely cleared out of the database.'));
}
else {
drupal_set_message(t('Some missing files were found and could be safely cleared out of the database. <pre> @raw </pre>', array(
'@raw' => print_r($deleted, TRUE),
)));
}
}
/**
* Delete aggregates that have not been accessed in the last 6 weeks.
*/
function advagg_admin_remove_old_unused_aggregates_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Remove unused aggregates.
$count = advagg_remove_old_unused_aggregates();
if (empty($count)) {
drupal_set_message(t('No old and unused aggregates found. Nothing was deleted.'));
}
else {
drupal_set_message(t('Some old and unused aggregates were found. A total of %count database entries were removed.', array(
'%count' => $count,
)));
}
}
/**
* Delete orphaned/expired advagg locks from the semaphore database table.
*/
function advagg_admin_cleanup_semaphore_table_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Delete orphaned/expired advagg locks from the semaphore database table.
$count = advagg_cleanup_semaphore_table();
if (empty($count)) {
drupal_set_message(t('No orphaned advagg semaphore database table locks discovered. Nothing was deleted.'));
}
else {
drupal_set_message(format_plural($count, '1 orphaned advagg semaphore database table lock was found. A total of 1 database entry was removed.', 'Some orphaned advagg semaphore database table locks were found. A total of @count database entries were removed.'));
}
}
/**
* Delete orphaned/expired advagg locks from the semaphore database table.
*/
function advagg_admin_refresh_locale_files_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Refresh all locale files.
$locale_files = advagg_refresh_all_locale_files();
if (empty($locale_files)) {
drupal_set_message(t('No locale files are being used.'));
}
else {
drupal_set_message(t('The following locale files are being used: <pre>@files</pre>', array(
'@files' => print_r($locale_files, TRUE),
)));
}
}
/**
* Delete leftover temp files.
*/
function advagg_admin_cleanup_temp_files_button() {
module_load_include('inc', 'advagg', 'advagg.cache');
// Delete orphaned/expired advagg locks from the semaphore database table.
$count = advagg_remove_temp_files();
if (empty($count)) {
drupal_set_message(t('No leftover temp files found. Nothing was deleted.'));
}
else {
drupal_set_message(format_plural($count, '1 leftover temp files from advagg was found. A total of 1 temp files was removed.', 'Some leftover temp files from advagg were found. A total of @count temp files were removed.'));
}
}
/**
* Verify that the filename is correct.
*/
function advagg_admin_clear_file_aggregate_validate($form, &$form_state) {
if (empty($form_state['values']['filename'])) {
form_set_error('filename', t('Please input a filename.'));
$form_state['values']['error'] = TRUE;
}
}
/**
* Display what files where deleted in a drupal message.
*/
function advagg_admin_clear_file_aggregate_submit($form, &$form_state) {
// @codingStandardsIgnoreLine
if (!empty($form_state['input']['ajax_page_state'])) {
return;
}
$info = advagg_admin_clear_file_aggregates($form_state['values']['filename']);
if (module_exists('httprl')) {
$output = httprl_pr($info);
}
else {
$output = '<pre>' . check_plain(print_r($info, TRUE)) . '</pre>';
}
// @ignore security_dsm
drupal_set_message($output);
}
/**
* Display what files where deleted via ajax callback.
*/
function advagg_admin_clear_file_aggregate_callback($form, &$form_state) {
if (!empty($form_state['values']['error'])) {
return '<div id="advagg-clear-file-aggregate-ajax"></div>';
}
$info = advagg_admin_clear_file_aggregates($form_state['values']['filename']);
if (empty($info)) {
form_set_error('filename', t('Please input a valid filename.'));
return '<div id="advagg-clear-file-aggregate-ajax"></div>';
}
else {
if (module_exists('httprl')) {
$output = httprl_pr($info);
}
else {
$output = '<pre>' . print_r($info, TRUE) . '</pre>';
}
return '<div id="advagg-clear-file-aggregate-ajax">' . $output . '</div>';
}
}
/**
* Remove the aggregates that contain the given filename.
*
* @param string $filename
* Name of file to lookup. Can be a comma separated list.
* @param bool $dry_run
* If TRUE, return the regex search string.
*
* @return array
* Returns an array of the parent file and what children where deleted.
*/
function advagg_admin_clear_file_aggregates($filename, $dry_run = FALSE) {
module_load_include('inc', 'advagg', 'advagg.cache');
list($css_path, $js_path) = advagg_get_root_files_dir();
$space = ADVAGG_SPACE;
$output = array();
$options = array(
'callback' => 'file_unmanaged_delete',
);
if ($dry_run) {
$options = array();
}
// Strip quotes and trim.
$filenames = array_map('trim', explode(',', trim(str_replace(array(
'"',
"'",
), '', $filename))));
foreach ($filenames as $filename) {
$results = db_select('advagg_files', 'af')->fields('af')
->condition('filename', $filename)
->execute();
while ($row = $results->fetchAssoc()) {
// Get aggregates that use this file.
$row['aggregates_using_file'] = advagg_get_aggregates_using_file($row['filename_hash']);
// Get dir and other info from file.
if ($row['filetype'] === 'css') {
$dirname = $css_path[0];
$basename_prefix = "{$row['filetype']}";
}
if ($row['filetype'] === 'js') {
$dirname = $js_path[0];
$basename_prefix = "{$row['filetype']}";
}
// Build regex search string for file_scan_directory().
$regex_search = array();
foreach ($row['aggregates_using_file'] as $values) {
$regex_search[] = preg_quote("{$basename_prefix}{$space}{$values['aggregate_filenames_hash']}{$space}") . '.*';
}
$regex_search = array_unique($regex_search);
$regex_search_string = '/(' . implode('|', $regex_search) . ')/';
$files = file_scan_directory($dirname, $regex_search_string, $options);
// List what files were deleted.
$row['aggregates_deleted'] = array();
$files_deleted = array_keys($files);
if (!empty($files_deleted)) {
$row['aggregates_deleted'][] = $files_deleted;
}
$output[$filename] = $row['aggregates_deleted'];
}
}
return $output;
}
/**
* @} End of "defgroup advagg_forms_callback".
*/Functions
| Title | Deprecated | Summary |
|---|---|---|
| advagg_admin_cleanup_semaphore_table_button | Delete orphaned/expired advagg locks from the semaphore database table. | |
| advagg_admin_cleanup_temp_files_button | Delete leftover temp files. | |
| advagg_admin_clear_all_caches_button | Clear out all advagg cache bins. | |
| advagg_admin_clear_all_files_button | Clear out all advagg aggregated files. | |
| advagg_admin_clear_file_aggregates | Remove the aggregates that contain the given filename. | |
| advagg_admin_clear_file_aggregate_callback | Display what files where deleted via ajax callback. | |
| advagg_admin_clear_file_aggregate_submit | Display what files where deleted in a drupal message. | |
| advagg_admin_clear_file_aggregate_validate | Verify that the filename is correct. | |
| advagg_admin_delete_orphaned_aggregates_button | Scan CSS/JS advagg dir and remove file if there is no associated db record. | |
| advagg_admin_flush_cache_button | Perform a smart flush. | |
| advagg_admin_flush_stale_files_button | Clear out all stale advagg aggregated files. | |
| advagg_admin_get_file_info | Get detailed info about the given filename. | |
| advagg_admin_get_file_info_callback | Display file info via ajax callback. | |
| advagg_admin_get_file_info_submit | Display file info in a drupal message. | |
| advagg_admin_get_file_info_validate | Verify that the filename is correct. | |
| advagg_admin_increment_global_counter | Clear out all advagg cache bins and increment the counter. | |
| advagg_admin_info_form | Form builder; Show info about advagg and advagg settings. | |
| advagg_admin_operations_form | Form builder; Do advagg operations. | |
| advagg_admin_refresh_locale_files_button | Delete orphaned/expired advagg locks from the semaphore database table. | |
| advagg_admin_regenerate_htaccess_button | Recreate the advagg htaccess files. | |
| advagg_admin_remove_empty_advagg_files | Remove filesize zero files from the advagg_files table and clear caches. | |
| advagg_admin_remove_missing_files_from_db_button | Scan for missing files and remove the associated entries in the database. | |
| advagg_admin_remove_old_unused_aggregates_button | Delete aggregates that have not been accessed in the last 6 weeks. | |
| advagg_admin_reset_mtime | Clear out all advagg cache bins and increment the counter. | |
| advagg_admin_resource_hints_preload_reset | Reset the advagg_resource_hints_preload_settings variable. | |
| advagg_admin_settings_form | Form builder; Configure advagg settings. | |
| advagg_admin_settings_form_submit | Clear out the advagg cache bin when the save configuration button is pressed. | |
| advagg_admin_system_performance_settings_form | Add various advagg settings to the system_performance_settings form. | |
| advagg_admin_toggle_bypass_cookie | Set or remove the AdvAggDisabled cookie. | |
| advagg_admin_truncate_advagg_files | Truncate the advagg_files table and clear caches. | |
| advagg_delete_empty_aggregates_button | Delete all empty advagg aggregated files. |