provision.drush.inc 11.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?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 : 
14 15
 *   install - Install a new Drupal site. The install command uses 3 separate hooks to do its job,
 *             namely hook_pre_provision_install(), hook_provision_install() and hook_post_provision_install().
16 17 18 19 20 21 22 23 24
 *   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.
25 26
 *   delete  - In a site context: generates a back up of the site, and then removes all references to it.
 *             In a platform context: removes the platform and its vhost config from the server if no sites are currently running on it
27 28
 *   restore - Revert to a previous backup of the site.
 *
29
 *   deploy  - Accepts a site package (backup) as argument, and redeploys it, running the upgrade processes on it.
30 31 32
 *             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 34 35 36
 *   lock    - Lock a platform so that sites cannot be provisioned on it. This does not disable or delete the platform
 *             nor any sites currently provisioned on it.
 *   unlock  - Unlock a platform so that sites can be provisioned on it.
 *
37 38
 *   login_reset - Generate a one-time login reset URL.
 *
39
 * Not implemented yet :
40 41 42
 *   rename  - Change the url of a site. This requires moving of files, and numerous other issues.
 */

43 44 45
// Do not allow the program to be run as the root user. ever
$name = posix_getpwuid(posix_geteuid());
if ($name['name'] == 'root') {
46
  return drush_set_error('PROVISION_IS_ROOT', dt('You are running the provision script as the root user. Exiting'));
47 48
}

49 50 51 52
/**
 * @defgroup provisiondrush Command line interface for Provision.
 * @{
 */
53
include_once('provision.inc');
54

55 56 57 58 59 60 61 62 63 64
/**
 * implementation of hook_drush_init().
 *
 * This will abort any process running drush if the load is critical.
 *
 * @see provision_load_critical()
 */
function provision_drush_init() {
  $load = sys_getloadavg();
  if (provision_load_critical($load)) {
65
    drush_set_error('PROVISION_OVERLOAD', dt("load on system too heavy (@load), aborting", array('@load' => join(" ", $load))));
66 67 68 69
    exit(1);
  }
}

70 71 72 73
/**
 * Implementation of hook_drush_command().
 */
function provision_drush_command() {
74

75
  $items['provision-install'] = array(
76 77
    'arguments' => array('domain.com' => dt('The domain of the site to install.')),
    'description' => dt('Provision a new site using the provided data.'),
78
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
79 80
  );

81
  $items['provision-import'] = array(
82 83
    'arguments' => array('domain.com' => dt('The domain of the site to import.')),
    'description' => dt('Turn an already running site into a provisioned site.'),
84
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
85 86
  );

87
  $items['provision-backup'] = array(
88 89
    '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.')),
90
    'description' => dt('Generate a back up for the site.'),
91
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
92 93
  );
  
94
  $items['provision-enable'] = array(
95
    'arguments' => array('domain.com' => dt('The domain of the site to enable (only if enabled).')),
96
    'description' => 'Enable a disabled site.',
97
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
98
  );
99
  $items['provision-disable'] = array(
100
    'arguments' => array('domain.com' => dt('The domain of the site to disable (only if disabled).')),    
101
    'description' => 'Disable a site.',
102
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
103 104
  );

105 106 107 108 109 110 111 112 113 114
  $items['provision-lock'] = array(
    'description' => 'Lock a platform from having any other sites provisioned on it.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );

  $items['provision-unlock'] = array(
    'description' => 'Unlock a platform so that sites can be provisioned on it.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );

115
  $items['provision-verify'] = array(
116 117
    'arguments' => array('domain.com' => dt('The domain of the site to verify).')),    
    'description' => 'Verify that the provisioning framework is correctly installed.',
118
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT, 
119 120
  );
 
121
  $items['provision-restore'] = array(
122
    'description' => 'Restore the site to a previous backup. This will also generate a backup of the site as it was.',
123
    'arguments' => array('domain.com' => dt('The domain of the site to be restored'),
124
      'site_backup.tar.gz' => dt('The backup to restore the site to.')),
125
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
126 127
  );

128
  $items['provision-deploy'] = array(
129 130 131
    '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.')),
132
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
133
  );
134

135
  $items['provision-migrate'] = array(
136 137 138
    '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.')),
139
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
140
  );
141

142
  $items['provision-clone'] = array(
143 144 145 146 147 148
    'description' => 'Clone a site between platforms.',
    'arguments' => array('domain.com' => dt('The domain to clone. Any outstanding updates will be run.'),
      'new.domain.com' => dt('The new domain name to use.'),
      '/path/to/platform' => dt('The platform to clone the site to.')),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );
149
 
150
  $items['provision-delete'] = array(
151
    'description' => 'Delete a site.',
152
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
153 154
  );

155
  $items['provision-login_reset'] = array(
156 157 158 159 160
    'description' => 'Generate a one-time login reset URL.',
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );
  

161
  $items['hostmaster-migrate'] = array(
162 163 164 165 166 167 168 169
    'description' => dt('Migrate an instance of the Hostmaster front end to a new platform'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT,
    'arguments' => array(
      'example.com' => dt('The name of the site to migrate'),
      '/path/to/platform' => dt('The platform to migrate the site to.')
    ),
  );

170
  $items['hostmaster-make'] = array(
171 172 173 174 175 176 177 178
    'description' => dt('Build a platform containing the Hostmaster user interface for provision.'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
    'arguments' => array(
      '/path/to/platform' => dt('The path to create the platform in.')
    ),
  );

  
179
  $items['hostmaster-pause'] = array(
180 181 182 183 184
    'description' => dt('Prepare the site to be migrated to a new platform.'),
    'arguments' => array(
      'example.com' => dt('The url of the site being migrated.')),
  );

185
  $items['hostmaster-resume'] = array(
186 187 188 189 190 191
    'description' => dt('Complete the migration of the site to a new platform.'),
    'arguments' => array(
      'example.com' => dt('The url of the site being migrated.')),
  );


192 193 194 195
  return $items;
}


196 197 198 199
function drush_provision_hostmaster_make($platform) {
  drush_backend_invoke('make', array(dirname(__FILE__) . '/aegir.make', $platform));
}

200 201
function _provision_default_restart_cmd() {
  $command = '/usr/sbin/apachectl'; # a proper default for most of the world
202 203 204 205 206 207 208 209 210 211
  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) {
212 213
    if (is_executable($test)) {
      $command = $test;
214
      break;
215 216 217 218 219 220
    }
  }

  return "sudo $command graceful";
}

221
function _provision_default_web_group() {
222
  $info = posix_getgrgid(posix_getgid());
223 224 225 226 227 228
  $common_groups = array(
    'httpd',
    'www-data', 
    'apache',
    'nogroup',
    'nobody',
229
    $info['name']);
230 231 232 233 234 235 236 237 238 239

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

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
/**
 * determine the number of CPU on the machine
 *
 * This tries a best guess at the number of CPUs running on the system. This is
 * useful for calculating sane load threshold.
 *
 * On Linux, this parses /proc/cpuinfo and looks for lines like this:
 * 
 * processor	: 0
 * ...
 * processor	: 1
 * processor	: n
 *
 * The number of CPUs on the system is n+1, we just count the number of lines.
 *
 * Other systems remain to be implemented, and would be best implemetend
 * through a PECL (or similar) extension that would use the POSIX sysconf
 * interface, as such:
 *
 * ncpus = sysconf(_SC_NPROCESSORS_ONLN);
 *
 * If no method can be found to figure out the number of CPUs, this will return
 * FALSE.
 *
264 265 266 267 268
 * People wishing to extend this to other platforms should look at
 * suggestions at:
 *
 * http://groups.google.com/group/sage-devel/browse_thread/thread/d65209f7ad6057fc
 *
269 270 271 272 273
 * @see provision_load_critical()
 * @todo implement for other systems than Linux
 */
function provision_count_cpus() {
  $ncpus = FALSE;
274 275 276 277 278 279 280
  if (file_exists("/proc/cpuinfo")) {
    # this should work on Linux with a /proc filesystem
    $cpuinfo = file_get_contents("/proc/cpuinfo");
    if ($cpuinfo !== FALSE) {
      if (preg_match_all("/^processor.*:.*[0-9]+$/m", $cpuinfo, $matches)) {
        $ncpus = count(array_pop($matches));
      }
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    }
  }
  return $ncpus;
}

/**
 * determine if overall load of the machine is critical
 *
 * We use the "average system load" of the system as a metric, as available
 * through 'uptime' or in PHP sys_getloadavg() since 5.1. The load is usually
 * defined as "the number of processes in the system run queue"
 *
 * It's not a really reliable metric, but it's the best shot we've got without
 * getting into real specific details about I/O, CPU or memory load that are
 * going to be even tougher to evaluate.
 *
 * We base our evaluation on the number of CPUs on the servers. If there are
 * more than 5 processes waiting per CPU, we abort completely. If we ignore the
 * number of available CPUs, we assume a critical limit is a load of 10.
 *
 * @see sys_getloadavg()
 */
function provision_load_critical($load = null, $threshold = null) {
  if (is_null($load)) {
    $load = sys_getloadavg();
  }
  if (is_null($threshold)) {
    if ($ncpus = provision_count_cpus()) {
      $threshold = $ncpus * 5;
    } else {
      // can't determine the number of CPU, we hardcode at load 10
      $threshold = 10;
    }
  }
  return ($load[0] > $threshold);
}
317