jgd.drush.inc

<?php

/**
 * @file
 * Drush commands for Jenkins Github Drush.
 */

/**
 * Implements hook_drush_help().
 */
function jgd_drush_help($section) {
  switch ($section) {
    case 'drush:clone-db-prefix':
      return dt('Clones a database to itself, adding a table prefix.');
    case 'drush:drop-prefixed-tables':
      return dt('Drops all tables in a database matching a specified prefix.');
    case 'drush:clone-settings-php':
      return dt('Clone a settings.php file to a new site.');
  }
}

/**
 * Implements hook_drush_command().
 */
function jgd_drush_command() {
  $items['clone-db-prefix'] = array(
    'description' => 'Clones a database to itself, adding a table prefix.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_DATABASE,
    'arguments' => array(
      'prefix' => dt('The database table prefix to use.'),
      'ignored_prefix' => dt('The prefix of tables to not clone, useful if the database has been cloned previously.'),
    ),
    'required-arguments' => 1,
  );
  $items['drop-prefixed-tables'] = array(
    'description' => 'Drops all tables in a database matching a specified prefix.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_DATABASE,
    'arguments' => array(
      'prefix' => dt('The prefix of tables to delete.'),
    ),
  );
  $items['clone-settings-php'] = array(
    'description' => "Clone a settings.php file to this site.",
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
    'arguments' => array(
      'site_alias' => dt('Drush site alias of the site to clone from.'),
      'prefix / suffix' => dt('An optional table prefix or database name suffix to add to the database array in the settings.php file.'),
    ),
    'options' => array(
      'extra-settings' => dt('A string of extra settings to be added to the settings.php file.'),
      'database' => dt('Use a database instead of using tables.'),
    ),
    'required-arguments' => 1,
  );

  return $items;
}

/**
 * Command callback for clone-db-prefix.
 */
function drush_jgd_clone_db_prefix($prefix, $ignored_prefix = NULL) {
  $dt_args['@prefix'] = $prefix;

  if (!drush_confirm(dt('All database tables prefixed with @prefix will be destroyed and recreated. There is no undo. Are you sure you want to proceed?', $dt_args))) {
    return FALSE;
  }

  $creds = drush_get_context('DRUSH_DB_CREDENTIALS');
  $db_name = $creds['name'];

  if (!isset($ignored_prefix)) {
    $ignored_prefix = $prefix;
  }

  $sql = "SHOW TABLES WHERE tables_in_$db_name NOT LIKE :ignored";
  $args = array(':ignored' => db_like($ignored_prefix) . '%');
  $tables = db_query($sql, $args)->fetchCol();

  if (empty($tables)) {
    drush_log(dt('There were no database tables to clone.'), 'error');
    return FALSE;
  }

  dlm($tables);

  try {
    foreach ($tables as $table) {
      $dt_args['@new-table'] = $new_table_name = "$prefix$table";
      $dt_args['@table'] = $table;

      // Drop the existing table, if it's there.
      drush_log(dt('Dropping table @new-table.', $dt_args));
      // We can't use db_drop_table, as it may prefix it again.
      db_query("DROP TABLE IF EXISTS $new_table_name");

      // Create the new table.
      drush_log(dt('Creating table @new-table from @table.', $dt_args));
      db_query("CREATE TABLE $new_table_name LIKE $table");

      // Insert all the data into the new table.
      drush_log(dt('Copying data from @table to @new-table.', $dt_args));
      db_query("INSERT INTO $new_table_name SELECT * FROM $table");

      // If we got this far, we succeeded!
      $dt_args['@successes']++;
    }
  }
  catch (Exception $e) {
    drush_log((string) $e, 'error');
    return FALSE;
  }

  drush_log(dt('Cloned @successes database tables, prefixing with @prefix.', $dt_args), 'completed');
}

function drush_jgd_drop_prefixed_tables($prefix) {
  $dt_args['@prefix'] = $prefix;

  if (!drush_confirm(dt('All database tables prefixed with @prefix will be destroyed. There is no undo. Are you sure you want to proceed?', $dt_args))) {
    return FALSE;
  }

  if (!$prefix) {
    drush_set_error('NO_DB_PREFIX', dt('You must specify a database prefix.'));
    return FALSE;
  }

  $creds = drush_get_context('DRUSH_DB_CREDENTIALS');
  $db_name = $creds['name'];

  $sql = "SHOW TABLES LIKE :prefix";
  $tables = db_query($sql, array(':prefix' => db_like($prefix) . '%'))->fetchCol();

  if (empty($tables)) {
    drush_log(dt('There were no database tables to remove.'), 'status');
    return;
  }

  dlm($tables);

  try {
    // We can't use db_drop_table, as it may prefix the table name again.
    foreach ($tables as $table) {
      db_query("DROP TABLE IF EXISTS $table");
    }
  }
  catch (Exception $e) {
    drush_log((string) $e, 'error');
    return FALSE;
  }

  $dt_args['@count'] = count($tables);
  drush_log(dt('Deleted @count database tables with prefix @prefix.', $dt_args), 'completed');
}

/**
 * Command callback for clone-settings-php.
 */
function drush_jgd_clone_settings_php($site_alias, $prefix = NULL) {
  // Normalize the alias to have a leading @ symbol.
  $dt_args['@alias'] = $site_alias = '@' . ltrim($site_alias, '@');
  $dt_args['@prefix'] = $prefix;

  if (!($source_record = drush_sitealias_get_record($site_alias))) {
    drush_log(dt('No @alias alias was found.', $dt_args), 'error');
    return FALSE;
  }
  dlm($source_record);

  $destination_record = drush_sitealias_get_record('@self');
  dlm($destination_record);

  // Fetch the site's directory.
  $results = drush_invoke_process($site_alias, 'dd', array('%site'), array('pipe' => TRUE), array('integrate' => FALSE));

  // Check to make sure the data we need is in the results.
  if (empty($results['output'])) {
    drush_log(dt('No source settings.php found from alias @alias.', $dt_args), 'error');
    return FALSE;
  }
  $dt_args['@source-settings']
    = $source_settings_path
    = "{$results['output']}/settings.php";

  // If the source settings.php file doesn't exist, log an error and exit.
  if (!file_exists($source_settings_path)) {
    drush_log(dt('No source settings.php found at @source-settings.', $dt_args), 'error');
    return FALSE;
  }

  // If we don't have read perms to the file, log an error and exit.
  if (!($source_settings = file_get_contents($source_settings_path))) {
    drush_log(dt('This command needs read privileges to file @source-settings.', $dt_args), 'error');
    return FALSE;
  }

  // If there's a database prefix, attempt to use it.
  if (isset($prefix)) {
    if (drush_get_option('database')) {
      // Match a new line with spaces and a database option.
      $pattern = "%(\n\ *)'database' => '([a-zA-Z0-9_]+)',%";
      // Replace with the following.
      $replacement = "\${1}'database' => '\${2}$prefix',";
      // Here's the error message if this fails.
      $error_message = 'The database name suffix @prefix was not added to settings.php. You will need to do this by hand.';
    }
    else {
      // Match a new line with spaces and an empty prefix string.
      $pattern = "%(\n\ *)'prefix' => '',%";
      // Replace with the following.
      $replacement = "\${1}'prefix' => '$prefix',";
      // Here's the error message if this fails.
      $error_message = 'The database table prefix @prefix was not added to settings.php. You will need to do this by hand.';
    }
    $destination_settings = preg_replace($pattern, $replacement, $source_settings);
    // If nothing changed, log a warning.
    if ($destination_settings == $source_settings) {
      drush_log(dt($error_message), 'warning');
      // Unset the prefix, so the completed message won't say it was added.
      unset($prefix);
    }
  }
  // Otherwise, the settings are the same.
  else {
    $destination_settings = $source_settings;
  }

  // Remove the http:// or https:// from the front of the string.
  $patterns[] = '%^https?://%i';
  $replacements[] = '';
  // Replace all slashes with dots.
  $patterns[] = '%/%';
  $replacements[] = '.';
  $conf_path = preg_replace($patterns, $replacements, $destination_record['uri']);

  // Check for additional settings to concatenate to the string.
  $extra_settings = drush_get_option('extra-settings', '');

  // If this is drupal multisite, ($conf_path is not 'default'), hardcode the
  // file directory path into settings.php, so that there's no accidental file
  // directory sharing going on.
  if ($conf_path !== 'default') {
    $extra_settings .= "\n\$conf['file_public_path'] = 'sites/$conf_path/files';";
  }

  // If we've got extra
  if (is_string($extra_settings) && !empty($extra_settings)) {
    $destination_settings .= "\n// Added by the Github pull request builder\n";
    $destination_settings .= "$extra_settings\n";
  }

  // TODO: add an option here for a settings destination.
  $dt_args['@dir-destination']
    = $destination_settings_dir
    = "{$destination_record['root']}/sites/$conf_path";
  $dt_args['@destination']
    = $destination_settings_path
    = "$destination_settings_dir/settings.php";

  // Log a warning and confirm continuation if the settings.php file exists.
  if (file_exists($destination_settings_path)) {
    $message = 'The destination settings.php file already exists at @destination.';
    drush_log(dt($message, $dt_args), 'warning');
    if (!drush_confirm('Would you like to continue?')) {
      return FALSE;
    }
  }

  // Create the directory if necessary.
  if (!file_exists($destination_settings_dir)) {
    if (!drush_mkdir($destination_settings_dir)) {
      drush_log(dt('Unable to create directory @dir-destination', $dt_args), 'error');
      return FALSE;
    }
    drush_log(dt('Created directory @dir-destination.', $dt_args), 'success');
  }

  // If we can't create the settings.php file, log an error and quit.
  if (!file_put_contents($destination_settings_path, $destination_settings)) {
    drush_log(dt('Unable to create file @destination.', $dt_args), 'error');
    return FALSE;
  }

  // Winning!
  $message = !isset($prefix) ?
    'Settings from @alias saved to @destination.' :
    'Settings from @alias saved to @destination with database table prefix @prefix.';
  drush_log(dt($message, $dt_args), 'completed');
  // If this is in pipe mode, print the conf directory.
  drush_print_pipe($destination_settings_dir);
}