provision_drupal.drush.inc 12.2 KB
Newer Older
1
<?php
2
// $Id$
3 4 5 6 7 8 9 10
/**
 * @file
 * Drupal specific functions for the provisioning framework.
 *
 * This module is responsible for the creation and maintenance of the drupal settings.php file, the sites directory structure
 * and all the install api code. 
 */

11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
define('PROVISION_BACKUP_PATH_NOT_FOUND', 'PROVISION_BACKUP_PATH_NOT_FOUND');
define('PROVISION_BACKUP_FAILED', 'PROVISION_BACKUP_FAILED');
define('PROVISION_DRUPAL_INSTALL_FAILED', 'PROVISION_DRUPAL_INSTALL_FAILED');
define('PROVISION_DRUPAL_UPDATE_FAILED', 'PROVISION_DRUPAL_UPDATE_FAILED');
define('PROVISION_DRUPAL_INSTALL_MISSING_REQUIREMENTS', 'PROVISION_DRUPAL_INSTALL_MISSING_REQUIREMENTS');
define('PROVISION_DRUPAL_SITE_INSTALLED', 'PROVISION_DRUPAL_SITE_INSTALLED');
define('PROVISION_DRUPAL_SITE_NOT_FOUND', 'PROVISION_DRUPAL_SITE_NOT_FOUND');
define('PROVISION_CONFIG_NOT_VALID', 'PROVISION_CONFIG_NOT_VALID');
define('PROVISION_REQUIRES_URL', 'PROVISION_REQUIRES_URL');

function provision_drupal_drush_help($section) {
  switch ($section) {
    case 'error:PROVISION_CONFIG_NOT_VALID' : 
      return dt('Config file could not be loaded.');
    case 'error:PROVISION_DRUPAL_SITE_INSTALLED' : 
      return dt('Site has already been installed.');
    case 'error:PROVISION_DRUPAL_SITE_NOT_FOUND' : 
      return dt('Site was not found.');
    case 'error:PROVISION_DRUPAL_INSTALL_FAILED' : 
      return dt('Could not complete Drupal installation.');
    case 'error:PROVISION_DRUPAL_UPDATE_FAILED' : 
      return dt('Could not complete Drupal update.');
    case 'error:PROVISION_BACKUP_PATH_NOT_FOUND' :
      return dt("Backup directory does not exist.");
    case 'error:PROVISION_DRUPAL_INSTALL_MISSING_REQUIREMENTS' :
      return dt("Could not meet the requirements for installing the drupal profile");
    case 'error:PROVISION_REQUIRES_URL' : 
      return dt('You need to specify the URL argument for this command');
  }

}

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
 * Initialize the platform / site
 *
 * This function is executed by provision_invoke, and is responsible
 * for populating the $data context array
 */
function provision_drupal_provision_init(&$data, $url = NULL) {
  if ($url) {
    define('PROVISION_ACTIVE_URL', $url);
    $data = provision_get_site_data($url); // load the existing site's context into the system.
  }
  define('PROVISION_CONTEXT_SITE', ($url) ? TRUE : FALSE);
  define('PROVISION_CONTEXT_PLATFORM', !PROVISION_CONTEXT_SITE);
}

/**
 * Finalize the platform / site
 *
 * This will run only if there were no errors in any of the previous hooks,
 * and will allow us to cache the successful settings to the site.php/ drushrc.php
 * files for future runs.
 */
function provision_drupal_provision_finalize(&$data, $url = NULL) {
  if (PROVISION_CONTEXT_SITE) {
Adrian Rossouw's avatar
Adrian Rossouw committed
67 68 69
    if ($data['installed']) {
      provision_save_site_data($data, $url);
    }
70 71 72 73 74 75 76 77 78 79 80 81
  }
  else {
    _provision_generate_config();
  }
}

/**
 * Some commands need to have a url to operate on.
 *  This prints out a message to that effect.
 */
function _provision_drupal_url_required() {
  if (PROVISION_CONTEXT_PLATFORM) {
82
    drush_set_error(PROVISION_REQUIRES_URL);
83 84 85 86 87 88 89 90 91 92 93
  }
}

/**
 * Validate a site exists, ie: has a settings.php file
 *
 * This will return an error for sites that haven't been created yet
 */
function _provision_drupal_valid_site() {
  if (PROVISION_CONTEXT_SITE) {
    if (!_provision_drupal_site_exists(PROVISION_ACTIVE_URL)) {
94
      drush_set_error(PROVISION_DRUPAL_SITE_NOT_FOUND);
95 96
    }
  }
97 98
}

99 100 101 102 103 104 105 106 107 108 109 110
/**
 * Test to see if the site settings.php exists
 *
 * @param url
 *   The url of the site to check
 * @return
 *   If the file exists, return TRUE, else return FALSE.
 */
function _provision_drupal_site_exists($url) {
  return file_exists("sites/$url/settings.php");
}

111 112 113 114 115 116 117 118 119

/**
 * Validate a site has been installed, by checking it's site.php file. 
 *
 * This will return an error for sites that haven't been installed yet
 */
function _provision_drupal_valid_installed_site() {
  if (PROVISION_CONTEXT_SITE) {
    if (!_provision_drupal_site_installed(PROVISION_ACTIVE_URL)) {
120
      drush_set_error(PROVISION_DRUPAL_SITE_NOT_FOUND);
121 122 123 124 125 126 127
    }
  }
}

function _provision_drupal_valid_not_installed_site() {
  if (PROVISION_CONTEXT_SITE) {
    if (_provision_drupal_site_installed(PROVISION_ACTIVE_URL)) {
128
      drush_set_error(PROVISION_DRUPAL_SITE_INSTALLED);
Adrian Rossouw's avatar
Adrian Rossouw committed
129 130 131
    }
  }
}
132 133

/**
134
 * Test to see if the site has a site.php and has it set to 'installed'
135
 */
136 137 138 139 140
function _provision_drupal_site_installed($url) {
  if (_provision_drupal_site_exists($url)) {
    if ($data = provision_load_site_data($url)) {
      return isset($data['installed']) ? $data['installed'] : FALSE;
    }
141
  }
142
  return FALSE;
143 144
}

145 146 147 148 149 150 151
/**
 * The default template to use while generating config files.
 *
 * @return
 *   The default template for the config file
 */
function _provision_drupal_default_template() {
152
  return file_get_contents(dirname(__FILE__) .'/provision_drupal_settings.tpl.php');
153 154 155 156 157 158 159 160 161 162 163
}

/**
 * Generate a settings file for the site.
 *
 * @param url
 *   The url of the site being invoked.
 * @param data
 *   A reference to the associated array containing the data for the site. This needs to be a reference, 
 *   because the modules might provide additional information about the site.
 */
164
function _provision_drupal_create_settings_file(&$data, $url = NULL) {
165
  drush_log(dt("Generate settings.php file"));
166
  if (provision_path("exists", "sites/$url/settings.php")) {
167
    provision_path("chmod", "sites/$url/settings.php", 0640,
168 169
      dt('Changed permissions of settings.php to @confirm'),
      dt('Could not change permissions of settings.php to @confirm'));
170 171
  }

172 173 174 175 176 177 178
  $data['extra_config'] = "# Extra configuration from modules:\n";
  foreach (drush_command_implements('provision_drupal_config') as $module) {
    $data['extra_config'] .= "# -- $module settings --\n";
    $data['extra_config'] .= module_invoke($module, 'provision_drupal_config', $url, $data) . "\n";
  }


179
  $fp = fopen("sites/$url/settings.php", "w");
180
  $text =  _provision_drupal_default_template();
181
  fwrite($fp, "<?php\n". provision_render_config($text, $data));
182
  fclose($fp);
183

184
  # Change the permissions of the file
185
  provision_path("chmod", "sites/$url/settings.php", 0440,
186 187
    dt('Changed permissions of settings.php to @confirm'),
    dt('Could not change permissions of settings.php to @confirm'));
188 189
  $group = $data['web_group'] ? $data['web_group'] : PROVISION_WEB_GROUP;
  provision_path("chgrp", "sites/$url/settings.php", $group,
190 191
    dt('Change group ownership of settings.php to @confirm'),
    dt('Could not change group ownership of settings.php to @confirm'));
192 193 194 195 196 197 198
}

/**
 * Create the directories needed to host a drupal site
 * 
 * Also maintains permissions on existing directories.
 */
199
function _provision_drupal_create_directories($url, $profile = NULL) {  
200
  $paths = array(
201
    "sites/$url"                 => 0755,
202
    "sites/$url/files"           => 02770,
203 204 205
    "sites/$url/files/tmp"       => 02770,
    "sites/$url/files/images"    => 02770,
    "sites/$url/files/pictures"  => 02770,
206 207 208 209 210 211 212 213
    "sites/$url/themes"          => 0755,
    "sites/$url/modules"         => 0755,  
  );
  $grps = array(
    "sites/$url/files",
    "sites/$url/files/tmp",
    "sites/$url/files/images",
    "sites/$url/files/pictures",
214 215 216 217
  );

  foreach ($paths as $path => $perm) {
    if (!is_dir($path)) {
218
      provision_path("mkdir", $path, TRUE, 
219 220
        dt("Created <code>@path</code>"),
        dt("Could not create <code>@path</code>"),
221
        DRUSH_PERM_ERROR);
222
    }
223 224

    provision_path("chmod", $path, $perm, 
225 226
      dt("Changed permissions of <code>@path</code> to @confirm"),
      dt("Could not change permissions <code>@path</code> to @confirm"),
227
      DRUSH_PERM_ERROR);
228 229 230
  }
  foreach ($grps as $path) {
      provision_path("chown", $path, PROVISION_SCRIPT_USER, 
231 232
      dt("Changed ownership of <code>@path</code>"),
      dt("Could not change ownership <code>@path</code>"),
233
      DRUSH_PERM_ERROR );
234
    provision_path("chgrp", $path, PROVISION_WEB_GROUP,
235 236
      dt("Changed group ownership of <code>@path</code>"),
      dt("Could not change group ownership <code>@path</code>"));
237 238 239
  }
}

240 241 242
/**
 * Runs an external script to reload all the various drupal caches
 */
243
function _provision_drupal_rebuild_caches(&$data, $url = NULL) {
244
  if (PROVISION_CONTEXT_SITE) {
245
    provision_internal_init($url);
246
    provision_platform_include($data, dirname(__FILE__), 'clear');
247
  }
Adrian Rossouw's avatar
Adrian Rossouw committed
248 249
}

250

251 252 253 254 255 256
/**
 * Find available profiles on this platform.
 */
function _provision_find_profiles() {
  include_once('includes/install.inc');

257
  if (!$dir = opendir("./profiles")) {
258
    drush_log(dt("Cannot find profiles directory"), 'error');
259 260 261
    return FALSE;
  }
  while (FALSE !== ($name = readdir($dir))) {
262
    $languages = array();
263 264 265 266 267 268 269 270
    $file = "./profiles/$name/$name.profile";
    if ($name == '..' || $name == '.' || !file_exists($file)) {
      continue;
    }
    $profile = new stdClass();
    $profile->name = $name;
    $profile->filename = $file;

271 272 273 274 275
    require_once($profile->filename);
    $func = $profile->name . "_profile_details";
    if (function_exists($func)) {
      $profile->info =  $func();
    }
276

277
    $languages['en'] = 1;
278
    // Find languages available
279
    $files = array_keys(drush_scan_directory('./profiles/' . $name . '/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE, 'filepath'));
280 281 282 283 284
    if (is_array($files)) {
      foreach ($files as $file) {
        if (preg_match('!(/|\.)([^\./]+)\.po$!', $file, $langcode)) {
          $languages[$langcode[2]] = 1; // use the language name as an index to weed out duplicates
        }
285 286
      }
    }
Adrian Rossouw's avatar
Adrian Rossouw committed
287
    $profile->info['languages'] = array_keys($languages);
anarcat's avatar
anarcat committed
288
    $return[$name] = $profile;
289
    drush_log(dt('found install profile %name', array('%name' => $name)));
290
  }
291

292 293 294 295
  return $return;

}

296
function provision_drupal_find_sites() {
297 298 299
  if ($dir = opendir("./sites")) {
    while (FALSE !== ($subdir = readdir($dir))) {
      $file = "./sites/$subdir/settings.php";
300
      if (file_exists("$file") && ($subdir != 'default') && !is_link("./sites/$subdir")) {
301 302 303
        $sites[$subdir] = $file;
      }
    }
304
    closedir($dir);
305
  } else {
306
    drush_log(dt("Cannot find sites directory"), 'error');
307
    $sites = FALSE;
308 309
  }
  return $sites;
310 311
}

Adrian Rossouw's avatar
Adrian Rossouw committed
312 313
function _provision_drupal_get_cvs_versions($files) {
  foreach ($files as $modulename => $file) {
314 315 316
      $project = array();
      $project['filename'] = $file->filename;
      $project['name'] = $file->name;
317
      $file->info['description'] = str_replace("\n", "", $file->info['description']);
318 319 320 321 322
      if (empty($project['project'])) {
        $project['project'] = cvs_deploy_get_project_name($project);
      }
      _cvs_deploy_version_alter($file->info['version'], $project);
      $name = ($project['project']) ? $project['project'] : $modulename;
Adrian Rossouw's avatar
Adrian Rossouw committed
323
      $files[$name] = $file; 
324
  }
325

Adrian Rossouw's avatar
Adrian Rossouw committed
326
  return $files;
327
}
328

329 330 331
/**
 * Create and remove symlinks for each of the possible domain aliases of an existing site
 */
332
function _provision_drupal_maintain_aliases($data, $url) {
333
  if (PROVISION_CONTEXT_SITE) {
334
    $old_aliases = array();
335 336 337 338 339 340 341 342 343 344 345 346 347 348
    if ($old_data = provision_load_site_data($url)) {
      if (is_array($old_data['aliases'])) {
         // Flip the array to make it easier to remove duplicates
        $old_aliases = array_flip($old_data['aliases']);
      }
    }
   
    if (is_array($data['aliases'])) {
      foreach($data['aliases'] as $alias) {
        if (isset($old_aliases[$alias])) {
          // We have already created an alias for this site.
          unset($old_aliases[$alias]);
        }
        provision_path("symlink", $url, PROVISION_DOCROOT_PATH . "/sites/" . $alias, 
349 350
          dt("Created symlink for alias @alias", array("@alias" => $alias)), 
          dt("Could not create symlink for alias @alias", array("@alias" => $alias)));
351
      }
352 353
      // Delete existing aliases that are no longer present
      _provision_drupal_delete_aliases(array_keys($old_aliases));
354 355 356 357 358 359 360 361 362 363
    }
  }
}

/**
 * Delete a list of aliases
 */
function _provision_drupal_delete_aliases($aliases) {
  foreach ($aliases as $alias) {
    provision_path("unlink", PROVISION_DOCROOT_PATH . "/sites/" . $alias, TRUE,
364 365
          dt("Removed symlink for alias @alias", array("@alias" => $alias)), 
          dt("Could not remove symlink for alias @alias", array("@alias" => $alias)));
366 367
  }
}
368

369 370 371
function provision_drupal_install_log($ret) {
  foreach ($ret as $info) {
    if (!$info['success']) {
372
      drush_set_error(PROVISION_DRUPAL_INSTALL_FAILED);
373
    }
374
    drush_log($info['query'], ($info['success']) ? 'success' : 'error');
375 376
  }
}
377