provision.drush.inc 7.42 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
<?php
/**
 * Drush commands
 *
 *
 * This module provides a framework for a Drupal site to manage and install new Drupal sites, using the command line
 * Drush utility. 
 *
 * It allows for pluggable 'provisioning modules' that can extend and modify the tasks that are taken during installation.
 *
 * Each site has the following commands that can be run on it.
 *
 * Implemented : 
 *   install - Install a new Drupal site. The install command uses 3 separate hooks to do it's job, 
 *              namely hook_provision_pre_install(), hook_provision_install() and hook_provision_post_install()
 *   verify  - Recreate all configuration files, to be in synch with changes in the front end. And test that they are correct.
 *   stats   - Return an associated array of site statistics. (implemented in provision_stats module, is thus optional)
 *   import  - Import the details of an already existing site into the provisioning framework.
 *             This command inspects the settings.php and generates the site.php file that the framework uses for configuration.
 *   backup  - Generates a tarball containing the sites directory, the site data configuration and the database dump.
 *             This allows the tarball to act as a 'site package', which can be redeployed on other installations,
 *             or used for an upgrade.
 *   disable - Disable an installed Drupal site. Changes the virtual host config file so that it redirects to provision_disabled_site_redirect_url
 *   enable  - Re-enable a site that has already been disabled. Recreates the virtual host file.
 *   delete -  Generates a back up of the site, and then removes all references to it.
 *   restore - Revert to a previous backup of the site.
 *   cron - Run cron process for a site
 *
 *   upgrade - Accepts a site package (backup) as argument, and redeploys it, running the upgrade processes on it.
 *             Uses hook_provision_pre_upgrade(), hook_provision_upgrade() and hook_provision_post_upgrade() hooks,
 *             and allows clean roll back if any errors occur. Will include stringent checking of module versions,
 *             and allow unit tests to be run.
33
 * Not implemented yet :
34 35 36
 *   rename  - Change the url of a site. This requires moving of files, and numerous other issues.
 */

37 38 39
// Do not allow the program to be run as the root user. ever
$name = posix_getpwuid(posix_geteuid());
if ($name['name'] == 'root') {
40
  return drush_set_error('PROVISION_IS_ROOT', dt('You are running the provision script as the root user. Exiting'));
41 42
}

43 44 45 46
/**
 * @defgroup provisiondrush Command line interface for Provision.
 * @{
 */
47 48
include_once('provision.inc');
include_once('provision.path.inc');
49 50 51 52 53

/**
 * Implementation of hook_drush_command().
 */
function provision_drush_command() {
54

55
  $items['provision install'] = array(
56 57
    'arguments' => array('domain.com' => dt('The domain of the site to install.')),
    'description' => dt('Provision a new site using the provided data.'),
58
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
59 60 61
  );

  $items['provision import'] = array(
62 63
    'arguments' => array('domain.com' => dt('The domain of the site to import.')),
    'description' => dt('Turn an already running site into a provisioned site.'),
64
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
65 66 67
  );

  $items['provision update'] = array(
68
    'arguments' => array('domain.com' => dt('The domain of the site to update.')),
69
    'description' => dt('Run any outstanding updates on the site.'),
70
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
71 72 73
  );
  
  $items['provision backup'] = array(
74 75
    'arguments' => array('domain.com' => dt('The domain of the site to back up.')),
    'optional arguments' => array('backup-file' => dt('The file to save the backup to. This will be a gzipped tarball.')),
76
    'description' => dt('Generate a back up for the site.'),
77
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
78 79 80
  );
  
  $items['provision enable'] = array(
81
    'arguments' => array('domain.com' => dt('The domain of the site to enable (only if enabled).')),
82
    'description' => 'Enable a disabled site.',
83
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
84 85
  );
  $items['provision disable'] = array(
86
    'arguments' => array('domain.com' => dt('The domain of the site to disable (only if disabled).')),    
87
    'description' => 'Disable a site.',
88
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
89 90 91
  );

  $items['provision verify'] = array(
92 93
    'arguments' => array('domain.com' => dt('The domain of the site to verify).')),    
    'description' => 'Verify that the provisioning framework is correctly installed.',
94
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT, 
95 96 97 98
  );
 
  $items['provision restore'] = array(
    'description' => 'Restore the site to a previous backup. This will also generate a backup of the site as it was.',
99
    'arguments' => array('domain.com' => dt('The domain of the site to be restored'),
100
      'site_backup.tar.gz' => dt('The backup to restore the site to.')),
101
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
102 103 104 105 106 107
  );

  $items['provision deploy'] = array(
    'description' => 'Deploy an existing backup to a new url.',
    'arguments' => array('domain.com' => dt('The domain to deploy the site package to.'),
      'site_backup.tar.gz' => dt('The backup to deploy.')),
108
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
109
  );
110 111 112 113 114

  $items['provision migrate'] = array(
    'description' => 'Migrate a site between platforms.',
    'arguments' => array('domain.com' => dt('The domain to migrate. Any outstanding updates will be run.'),
      '/path/to/platform' => dt('The platform to migrate the site to.')),
115
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
116
  );
117 118
 
  $items['provision delete'] = array(
119
    'description' => 'Delete a site.',
120
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
121 122 123 124
  );

  $items['provision cron'] = array(
    'description' => 'Run cron process for site.',
125
    'arguments' => array('domain.com' => dt('The domain of the site to be processed')),
126
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
127 128 129 130 131 132
  );
 
  return $items;
}


133 134 135 136
/**
 * Generate a provision.settings.php file to configure provision
 */
function _provision_generate_config() {
137
  drush_log(dt("Generating drushrc.php file"));
138
  provision_path("chmod", drush_get_option('docroot_path') . '/drushrc.php', 0600,
139 140 141 142
     dt('Changed permissions of drushrc.php to @confirm'),
      dt('Could not change permissions of drushrc.php to @confirm'));

  provision_save_platform_data();
143
  provision_path("chmod", drush_get_option('docroot_path') . '/drushrc.php', 0400,
144 145 146 147 148 149 150 151 152
    dt('Changed permissions of drushrc.php to @confirm'),
    dt('Could not change permissions of drushrc.php to @confirm'));
  return TRUE;
}



function _provision_default_restart_cmd() {
  $command = '/usr/sbin/apachectl'; # a proper default for most of the world
153 154 155 156 157 158 159 160 161 162
  foreach (explode(':', $_SERVER['PATH']) as $path) {
    $options[] = "$path/apache2ctl";
    $options[] = "$path/apachectl";
  }
  # try to detect the apache restart command
  $options[] = '/usr/local/sbin/apachectl'; # freebsd
  $options[] = '/usr/sbin/apache2ctl'; # debian + apache2
  $options[] = $command;

  foreach ($options as $test) {
163 164
    if (is_executable($test)) {
      $command = $test;
165
      break;
166 167 168 169 170 171
    }
  }

  return "sudo $command graceful";
}

172
function _provision_default_web_group() {
173
  $info = posix_getgrgid(posix_getgid());
174 175 176 177 178 179
  $common_groups = array(
    'httpd',
    'www-data', 
    'apache',
    'nogroup',
    'nobody',
180
    $info['name']);
181 182 183 184 185 186 187 188 189 190

  foreach ($common_groups as $group) {
    if (provision_posix_groupname($group)) {
      return $group;
      break;
    }
  }
  return null;
}