/**
* Create Cleaner settings form.
*
* @return array
* Form of the cleaner settings page.
*/
function hook_cleaner_settings()
{
// Add CSS to the admin settings page.
drupal_add_css(drupal_get_path('module', 'cleaner') . '/cleaner.css');
$form = array();
$yes_no = array(t('No'), t('Yes'));
$inline = array('class' => array('container-inline'));
$interval = array(0 => t('Every time')) + Cleaner::$intervals;
$form['cleaner_cron'] = array('#type' => 'radios', '#title' => t('Run interval'), '#options' => $interval, '#default_value' => variable_get('cleaner_cron', 3600), '#description' => t('This is how often the options below will occur. The actions will occur on the next Cron run after this interval expires. "Every time" means on every Cron run.'), '#attributes' => $inline);
$form['cleaner_clear_cache'] = array('#type' => 'radios', '#options' => $yes_no, '#title' => t('Clean up cache'), '#default_value' => variable_get('cleaner_clear_cache', 0), '#description' => Cleaner::cleanerGetCacheTablesTable(), '#attributes' => $inline);
$form['cleaner_empty_watchdog'] = array('#type' => 'radios', '#options' => $yes_no, '#title' => t('Clean up Watchdog'), '#default_value' => variable_get('cleaner_empty_watchdog', 0), '#description' => t('There is a standard setting for controlling Watchdog contents. This is more useful for test sites.'), '#attributes' => $inline);
$cookie = session_get_cookie_params();
$select = db_select('sessions', 's')->fields('s', array('timestamp'))->condition('timestamp', REQUEST_TIME - $cookie['lifetime'], '<');
$count = $select->execute()->rowCount();
$form['cleaner_clean_sessions'] = array('#type' => 'radios', '#options' => $yes_no, '#title' => t('Clean up Sessions table'), '#default_value' => variable_get('cleaner_clean_sessions', 0), '#description' => t('The sessions table can quickly become full with old, abandoned sessions. This will delete all sessions older than @interval (as set by your site administrator). There are currently @count such sessions.', array('@interval' => format_interval($cookie['lifetime']), '@count' => $count)), '#attributes' => $inline);
$form['cleaner_clean_cssdir'] = array('#type' => 'radios', '#options' => $yes_no, '#title' => t('Clean up CSS files'), '#default_value' => variable_get('cleaner_clean_cssdir', 0), '#description' => t('The CSS directory can become full with stale and outdated cache files. This will delete all CSS cache files but the latest.'), '#attributes' => $inline);
$form['cleaner_clean_jsdir'] = array('#type' => 'radios', '#options' => $yes_no, '#title' => t('Clean up JS files'), '#default_value' => variable_get('cleaner_clean_jsdir', 0), '#description' => t('The JS directory can become full with stale and outdated cache files. This will delete all JS cache files but the latest.'), '#attributes' => $inline);
// We can only offer OPTIMIZE to MySQL users.
if (db_driver() == 'mysql') {
$form['cleaner_optimize_db'] = array('#type' => 'radios', '#options' => $yes_no + array('2' => 'Local only'), '#title' => t('Optimize tables with "overhead" space'), '#default_value' => variable_get('cleaner_optimize_db', 0), '#description' => t('The module will compress (optimize) all database tables with unused space. <strong>NOTE</strong>: During an optimization, the table will locked against any other activity; on a high vloume site, this may be undesirable. "Local only" means do not replicate the optimization (if it is being done).'), '#attributes' => $inline);
} else {
// If not MySQL, delete(reset) the variable.
variable_del('cleaner_optimize_db');
}
return array('cleaner' => $form);
}
/**
* Set the database timzone offset.
*
* Setting the db timezone to UTC is done to ensure consistency in date
* handling whether or not the database can do proper timezone conversion.
*
* Views filters that not exposed are cached and won't set the timezone
* so views date filters should add 'cacheable' => 'no' to their
* definitions to ensure that the database timezone gets set properly
* when the query is executed.
*
* @param string $offset
* An offset value to set the database timezone to. This will only
* set a fixed offset, not a timezone, so any value other than
* '+00:00' should be used with caution.
*/
function set_db_timezone($offset = '+00:00')
{
static $already_set = FALSE;
$type = db_driver();
if (!$already_set) {
switch ($type) {
case 'mysql':
case 'mysqli':
db_query("SET @@session.time_zone = '{$offset}'");
break;
case 'pgsql':
db_query("SET TIME ZONE INTERVAL '{$offset}' HOUR TO MINUTE");
break;
case 'sqlsrv':
// Issue #1201342, This is the wrong way to set the timezone, this
// still needs to be fixed. In the meantime, commenting this out makes
// SQLSRV functional.
// db_query('TimeZone.setDefault(TimeZone.getTimeZone("GMT"))');
break;
}
$already_set = TRUE;
}
}
/**
* MySQL tables optimizing handler.
*
* @param int $opt
* Operation flag.
*/
public static function cleanerMysqlOptimizing($opt = 0)
{
$db_type = db_driver();
// Make sure the db type hasn't changed.
if ($db_type == 'mysql') {
// Gathering tables list.
$list = array();
foreach (db_query("SHOW TABLE STATUS") as $table) {
if ($table->Data_free) {
$list[] = $table->Name;
}
}
if (!empty($list)) {
// Run optimization timer.
timer_start('cleaner_db_optimization');
// Execute optimize query.
$query = 'OPTIMIZE ' . ($opt == 2 ? 'LOCAL ' : '');
$query .= 'TABLE {' . implode('}, {', $list) . '}';
db_query($query);
// Write a log about successful optimization into the watchdog.
self::cleanerLog('Optimized tables: !opts. This required !time seconds.', array('!opts' => implode(', ', $list), '!time' => number_format(timer_read('cleaner_db_optimization') / 1000, 3)));
} else {
// Write a log about thing that optimization process is
// no tables which can to be optimized.
self::cleanerLog('There is no tables which can to be optimized.', array(), WATCHDOG_NOTICE);
}
} else {
// Write a log about thing that optimization process isn't allowed
// for non-MySQL databases into the watchdog.
self::cleanerLog('Database type (!type) not allowed to be optimized.', array('!type' => $db_type), WATCHDOG_ERROR);
}
}
