API Only: Allow site nodes to specify "install_method", allowing something other than automated Drupal profile.

Work in progress pushed to branches 'decouple-install' in hosting and provision projects.

Patches attached for easy visibility.

I was able to get a site node to run a verify task successfully, create the database and permissions, and write all the sites/x.com/ folders and files.

For some reason, however, I cannot `drush sqlc` or access the site. There must be some other step deep down in the install hooks

Lot's of lessons learned:

Much overlap between install and verify already.

We probably don't want to use verify as the "creation" step. It's too tricky to determine if it exists or not. A rollback hook would be in place for verify to destroy, which would be bad if the site already exists.

I think the way forward here would be to have a new "Create" task and we move all of the files/directory creation stuff to that.

That would align well with the "Create Site" form. We can add a "[ ] Install Drupal" checkbox that gets passed to the Create Task. If it's checked we either do the install within the create task or we trigger a separate install task.

There's still much more work to do here. We don't have a HOSTING_SITE_INSTALLED status for example. In the patches, the site's end up queued.

The first verify run on a blank drupal7 platform gets the message:

Could not find a Drupal settings.php file at sites/default/settings.php.

Had a stroke of inspiration this morning and tracked down the code that actually triggers the drupal profile install, and wrapped it with a drush option.

It worked. I ended up with what appeared in the Aegir front-end as a fully installed site but really the install profile never ran. This is great, because the database exists and I was able to visit install.php to manually install Drupal.

In this code space we can do more, like import an existing SQL dump, copy data from another site, or even, install wordpress.

I'm still thinking about where to go from here.

I got it to work! I devised a new "install_method" property on site_nodes when, if set to anything other than "profile", will skip the drupal profile install.

This means module authors can use node_load() or entity alter hooks to set $node->install_method to something else, then check for the drush option "site_install_method" in their hooks.

As an additional feature, I check for install_method = 'manual' and if it is set, it will set "login_link" to http;//domain/install.php!

The point of this is to make it possible to do alternate things on Aegir Site Install like import an SQL dump, or copy data from another site.

With this patch, the normal behavior stays the same. You must implement a hook_node_load() to add the property "install_method" to change the existing default behavior.

I'm scaling back the scope of this issue to a simple change that introduces no changes to the existing behavior or UI.

Hopefully the change is small enough to include in the next 3.x release.

The new "install_method" property in this patch allows other systems to create Aegir Site nodes and to modify what happens after the codebase and services are setup..

This is currently impossible to do because there are no hooks or checks in place to alter the behavior:

// From provision/platform/install.provision.inc
function drush_provision_drupal_provision_install() {
 
   drush_bootstrap(DRUSH_BOOTSTRAP_DRUPAL_SITE);
 
    // call a backend task to do the actual installation.
    $result = provision_backend_invoke(d()->name, "provision-install-backend", array(), array('client_email' => drush_get_option('client_email')));
}

After this patch, you can write custom Drupal code that does this:

function mymodule_node_load() {
  $site_node->install_method = 'my_script'
}

function mymodule_post_hosting_install_task($task, $data) {
  if ($task->ref->install_method == 'my_script') {

      // Run a custom drush install
      shell_exec("drush @{$task->ref->hosting_context} site-install somethingelse --crazy-option")

      // Run whatever you want
      $output = shell_exec('/usr/local/bin/launch_supersite');

      // Save data back to front-end if you want to.
     $task->ref->my_script_results = $output;
  }
}

Since $site_node->install_method is not "profile", it will not run the drupal profile.

We are going to include this patch in the next release of DevShop (still on Aegir 3.x), I'll report back here on how that goes..

New patches make "install_method" a true site context option property thing.

This way, reinstall task retains the install_method.

Updated from latest 7.x-3.x branch.

New patches attached, branches in both provision and hosting modules: 2754069-decouple-install

Note "alternate" branches and patches removed to reduce confusion.

TODO (but should not block committing):

1. Add API docs on how to create alternate install methods.
2. Add "Install Method" selector to sites from DevShop.

JamesK: The code looks for a string in $site_node->install_method. If you set that property with a hook_node_load() or alter hook, then add this drush hook: (taken from devshop)

/**
 * Implementation of drush_hook_post_provision_install()
 *
 * This function handles all of the alternative environment install methods.
 */
function drush_devshop_provision_post_provision_install() {

  // Install Method: Clone
  // Sync from a drush alias.
  drush_log('Installing environment with method: ' . d()->install_method , 'devshop_log');
  if (d()->install_method == 'clone') {
    drush_log(dt('Environment Clone initiated...'), 'devshop_log');
    $clone_source = d()->environment_settings['install_method']['clone_source'];

    // If "clone_source" is set to "_other", use the drush alias in "clone_source_drush".
    if ($clone_source == '_other') {
      $source = d()->environment_settings['install_method']['clone_source_drush'];
    }
    elseif (!empty($clone_source)) {
      $source = d()->environment_settings['install_method']['clone_source'];
    }
    else {
      return drush_set_error('DEVSHOP_ERROR', dt('Install_method"clone_source" was not set.'));
    }

    $destination = d()->name;
    $command = "drush provision-sync $source $destination --database --files --update-uri --disable-rollback-backup --updatedb --cache-clear --registry-rebuild";
    devshop_drush_process($command, NULL, 'Cloning site from ' . d($source)->uri);
    devshop_drush_process('drush cc drush', NULL, 'Clearing drush caches');
//    devshop_drush_process_cache_clear($destination);
  }

  // Install Method: import
  elseif (d()->install_method == 'import') {


    // If import source is a mysql URL:
    $path_or_url = d()->environment_settings['install_method']['import'];
    $url = parse_url($path_or_url);
    if ($url['scheme'] == 'mysql') {

      // Dump the file
      $temp_file_name = tempnam('/tmp', 'devshop_remote_db.sql.');
      $db_name = ltrim($url['path'], '/');
      $command = "mysqldump -u{$url['user']} -p{$url['pass']} -h{$url['host']} {$db_name}  --result-file={$temp_file_name}";
      devshop_drush_process($command, NULL, dt('Saving database file...'));

      $file_to_import = $temp_file_name;
    }

    // If file exists but is not readable, alert the user.
    elseif (file_exists($path_or_url) && !is_readable($path_or_url)){
      return drush_set_error('DEVSHOP_IMPORT_ERROR', dt('Unable to import SQL file @path: not readable.'));
    }

    // If file exists and is readable, set it as the file to import.
    elseif (file_exists($path_or_url) && is_readable($path_or_url)){
      $file_to_import = $path_or_url;
    }

    // Import the file
    $alias = d()->name;
    $command = "drush {$alias} sqlq 'SOURCE {$file_to_import}'";
    devshop_drush_process($command, NULL, dt('Importing database file...'));
    devshop_drush_process('drush cc drush', NULL, 'Clearing drush caches');
    devshop_drush_process_cache_clear($alias);
    devshop_drush_process("drush {$alias} sqlq 'SHOW TABLES'", NULL, dt('Show Tables'));
  }
}

I'm exploring how to best include this in core aegir, but it's a dramatic shift, so if we can allow it in core, then let aegir contrib handle alternate install methods, that would probably be best.

I've found a few more issues with this.

Some code depends on the "installed" drush option, which is only set if the drupal profile install method is used.

I've created a branch that replaces drush_get_option('installed') with _provision_drupal_site_exists().

Tests pass, I'm merging!