provision.drush.inc 15.7 KB
Newer Older
1 2
<?php
/**
3 4
 * @file
 * Provisoon Drush commands.
5 6 7
 *
 *
 * This module provides a framework for a Drupal site to manage and install new Drupal sites, using the command line
8
 * Drush utility.
9 10 11 12 13
 *
 * 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.
 *
14
 * Implemented :
15 16
 *   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().
17 18 19 20 21 22 23 24 25
 *   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.
26 27
 *   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
28 29
 *   restore - Revert to a previous backup of the site.
 *
30
 *   deploy  - Accepts a site package (backup) as argument, and redeploys it, running the upgrade processes on it.
31 32 33
 *             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.
34 35 36 37
 *   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.
 *
38
 *   login_reset - Generate a one-time login reset URL.
39 40
 */

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

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

53
/**
54
 * Implements hook_drush_init().
55 56 57 58 59 60
 *
 * This will abort any process running drush if the load is critical.
 *
 * @see provision_load_critical()
 */
function provision_drush_init() {
61 62
  $hash_name = drush_get_option('#name') ? '#name' : 'name';
  d(drush_get_option($hash_name, '@self', 'alias'), TRUE);
63 64
  $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
  $items['provision-save'] = array(
drumm's avatar
drumm committed
75 76 77 78 79 80
    'description' => dt('Save Drush alias'),
    'arguments' => array(
      '@context_name' => 'Context to save',
    ),
    'options' => array_merge(array(
      '--context_type' => 'server, platform, or site; default server',
81
      '--delete' => 'Remove the alias.',
82
    ), Provision_Context_server::option_documentation(), Provision_Context_platform::option_documentation(), Provision_Context_site::option_documentation()),
83 84
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
  );
85
  $items['provision-install'] = array(
86
    'description' => dt('Provision a new site using the provided data.'),
87 88 89
    'examples' => array(
      'drush @site provision-install' => 'Install the site as defined by the site Drush alias generated with provision-save.',
    ),
90
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
91 92
  );

93 94 95 96 97 98
  $items['provision-install-backend'] = array(
    'description' => dt('Provision a new site using the provided data.'),
    'hidden' => TRUE,
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_SITE
  );

99
  $items['provision-import'] = array(
100
    'description' => dt('Turn an already running site into a provisioned site.'),
101 102 103
    'examples' => array(
      'drush @site provision-import' => 'Import the site as defined by the site Drush alias generated with provision-save.',
    ),
104
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
105 106
  );

107
  $items['provision-backup'] = array(
108
    'optional arguments' => array('backup-file' => dt('The file to save the backup to. This will be a gzipped tarball.')),
109
    'description' => dt('Generate a back up for the site.'),
110 111 112
    'examples' => array(
      'drush @site provision-backup' => 'Back up the site as defined by the site Drush alias generated with provision-save.',
    ),
113
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
114
  );
115

116
  $items['provision-enable'] = array(
117
    'description' => 'Enable a disabled site.',
118 119 120
    'examples' => array(
      'drush @site provision-enable' => 'Enable the site as defined by the site Drush alias generated with provision-save.',
    ),
121
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
122
  );
123
  $items['provision-disable'] = array(
124
    'arguments' => array('domain.com' => dt('The domain of the site to disable (only if disabled).')),
125
    'description' => 'Disable a site.',
126 127 128
    'examples' => array(
      'drush @site provision-disable' => 'Disable the site as defined by the site Drush alias generated with provision-save.',
    ),
129
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
130 131
  );

132 133
  $items['provision-lock'] = array(
    'description' => 'Lock a platform from having any other sites provisioned on it.',
134 135 136
    'examples' => array(
      'drush @platform provision-lock' => 'Lock the platform as defined by the platform Drush alias generated with provision-save.',
    ),
137 138 139 140 141
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );

  $items['provision-unlock'] = array(
    'description' => 'Unlock a platform so that sites can be provisioned on it.',
142 143 144
    'examples' => array(
      'drush @platform provision-unlock' => 'Unlock the platform as defined by the platform Drush alias generated with provision-save.',
    ),
145 146 147
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );

148
  $items['provision-verify'] = array(
149
    'arguments' => array('domain.com' => dt('The domain of the site to verify).')),
150
    'description' => 'Verify that the provisioning framework is correctly installed.',
151 152 153 154 155
    'examples' => array(
      'drush @site provision-verify' => 'Verify the site as defined by the site Drush alias generated with provision-save.',
      'drush @platform provision-verify' => 'Verify the platform as defined by the platform Drush alias generated with provision-save.',
    ),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH 
156
  );
157

158
  $items['provision-restore'] = array(
159
    'description' => 'Restore the site to a previous backup. This will also generate a backup of the site as it was.',
160
    'arguments' => array(
161
      'site_backup.tar.gz' => dt('The backup to restore the site to.')),
162 163 164
    'examples' => array(
      'drush @site provision-restore ~/backups/some_site.tar.gz' => 'Restore the site to the backup in ~/backups/some_site.tar.gz.',
    ),
165
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
166 167
  );

168
  $items['provision-deploy'] = array(
169
    'description' => 'Deploy an existing backup to a new url.',
170
    'arguments' => array(
171
      'site_backup.tar.gz' => dt('The backup to deploy.')),
172 173 174
    'examples' => array(
      'drush @site provision-deploy ~/backups/some_site.tar.gz' => 'Deploy the site as defined by the site Drush alias, from the backup in ~/backups/some_site.tar.gz.',
    ),
175
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
176
  );
177

178
  $items['provision-migrate'] = array(
179
    'description' => 'Migrate a site between platforms.',
180 181 182 183 184
    'arguments' => array(
      '@platform_name' => dt('The Drush alias of the platform.')),
    'examples' => array(
      'drush @site provision-migrate @platform_name' => 'Migrate the site as defined by the Drush alias, to the platform as defined by the platform\'s Drush alias',
    ),
185
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
186
  );
187

188
  $items['provision-clone'] = array(
189
    'description' => 'Clone a site between platforms.',
190 191 192 193 194 195
    'arguments' => array(
      '@new_site' => dt('The Drush alias of the new site as generated by provision-save.'),
      '@platform_name' => dt('The Drush alias of the platform to clone the site onto.')),
    'examples' => array(
      'drush @site provision-clone @new_site @platform_name' => 'Clone the original site to the new site on a platform',
    ),
196 197
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );
198

199
  $items['provision-delete'] = array(
200
    'description' => 'Delete a site.',
201 202 203
    'examples' => array(
      'drush @site provision-delete' => 'Delete the site as defined by the site Drush alias generated with provision-save.',
    ),
204
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH
205 206
  );

207
  $items['provision-login_reset'] = array(
208
    'description' => 'Generate a one-time login reset URL.',
209
    'examples' => array(
210
      'drush @site provision-login_reset' => 'Generate a one-time login reset URL for the site as defined by the site Drush alias generated with provision-save.',
211
    ),
212 213
    'bootstrap' => DRUSH_BOOTSTRAP_DRUPAL_ROOT
  );
214

215 216 217
  $items['provision-backup_delete'] = array(
    'description' => 'Delete a backup file.',
    'arguments' => array('backup-file' => dt('The backup file to delete. This will be a gzipped tarball.')),
218 219 220
    'examples' => array(
      'drush @site provision-backup_delete /path/to/site_backup.tgz' => 'Delete a backup of this site as defined by the site Drush alias generated with provision-save.',
    ),
221
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH
222

223
  );
224

225
  $items['hostmaster-migrate'] = array(
226 227 228 229
    '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'),
230 231
      '/path/to/platform' => dt('The platform to migrate the site to.'),
      '--makefile' => dt('The optional makefile to use instead of aegir.')
232 233 234
    ),
  );

235 236 237 238
  $items['hostmaster-install'] = array(
    'description' => dt('Install and verify the Hostmaster frontend.'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
    'arguments' => array(
anarcat's avatar
anarcat committed
239
      'example.com' => dt('The URL of the site to install, optional (default: %host).', array('%host' => provision_fqdn())),
240
    ),
anarcat's avatar
anarcat committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    'options' => array
    (
     'http_service_type' => dt('Webserver type to configure (default: %webserver)', array('%webserver' => 'apache')),
     'drush_make_version' => dt('Drush make version to install, if not present (default: %drush_make', array('%drush_make' => '6.x-2.3')),
     'aegir_db_host' => dt('Database host to connect to (default: %host)', array('%host' => 'localhost')),
     'aegir_db_user' => dt('Database user to connect as (default: %user)', array('%user' => 'root')),
     'aegir_db_pass' => dt('Database password to use'),
     'client_email' => dt('Email of the first client to create in the frontend'),
     'client_name' => dt('Name of the first client to create in the frontend (default: %user)', array('%user' => 'admin')),
     'makefile' => dt('The makefile used to create the hostmaster platform (default: %makefile)', array('%makefile' => dirname(__FILE__). '/aegir.make')),
     'aegir_host' => dt('Fully qualified domain name of the local server (default: %fqdn)', array('%fqdn' => provision_fqdn())),
     'script_user' => dt('User to run the backend as (default: %user)', array('%user' => provision_current_user())),
     'web_group' => dt('Group the webserver is running as (default: %group)', array('%group' => _provision_default_web_group())),
     'version' => dt('The version of this released. (default: %version)', array('%version' => provision_version())),
     'aegir_root' => dt('Install aegir in this home directory (default: %home). Do not change unless you know what you are doing.', array('%home' => drush_server_home())),
     ),
257
  );
258

259 260 261 262 263
  $items['backend-parse'] = array(
    'description' => dt('Parse the output of --backend commands to a human readable form'),
    'bootstrap' => DRUSH_BOOTSTRAP_DRUSH,
  );

264 265 266
  return $items;
}

267 268 269
function drush_provision_save($alias = NULL) {
  if (drush_get_option('delete', FALSE)) {
    // remove an existing alias
270
    $config = new Provision_Config_Drushrc_Alias($alias);
271 272 273
    $config->unlink();
  }
  else {
274
    // trigger additional logic that should happen only on save.
275
    d($alias)->type_invoke('save');
276
    // create or update the record
277
    d($alias)->write_alias();
278
  }
drumm's avatar
drumm committed
279 280
}

281
function drush_provision_verify() {
282
  d()->command_invoke('verify');
283 284
}

285
function _provision_default_web_group() {
286
  $info = posix_getgrgid(posix_getgid());
287
  $common_groups = array(
288
    'www',
289
    'httpd',
290
    'www-data',
291
    'apache',
drumm's avatar
drumm committed
292
    'webservd',
293 294
    'nogroup',
    'nobody',
295
    $info['name']);
296 297 298 299 300 301 302

  foreach ($common_groups as $group) {
    if (provision_posix_groupname($group)) {
      return $group;
      break;
    }
  }
303
  return NULL;
304 305
}

306 307 308 309 310 311 312
/**
 * 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:
313
 *
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
 * 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.
 *
330 331 332 333 334
 * People wishing to extend this to other platforms should look at
 * suggestions at:
 *
 * http://groups.google.com/group/sage-devel/browse_thread/thread/d65209f7ad6057fc
 *
335 336 337 338 339
 * @see provision_load_critical()
 * @todo implement for other systems than Linux
 */
function provision_count_cpus() {
  $ncpus = FALSE;
340 341 342 343 344 345 346
  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));
      }
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
    }
  }
  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()
 */
369
function provision_load_critical($load = NULL, $threshold = NULL) {
370 371 372 373 374 375
  if (is_null($load)) {
    $load = sys_getloadavg();
  }
  if (is_null($threshold)) {
    if ($ncpus = provision_count_cpus()) {
      $threshold = $ncpus * 5;
376 377
    }
    else {
378 379 380 381 382 383
      // can't determine the number of CPU, we hardcode at load 10
      $threshold = 10;
    }
  }
  return ($load[0] > $threshold);
}