provision_drupal.drush.inc 11.7 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
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');
  }

}

33
34
35
36
37
38
/**
 * Initialize the platform / site
 *
 * This function is executed by provision_invoke, and is responsible
 * for populating the $data context array
 */
39
function provision_drupal_provision_init($url = NULL) {
40

41
  if ($url) {
42
43
44
45
46
47
    drush_set_option('uri' , 'http://' . $url);
    provision_load_site_data($url);
    drush_set_default('site_url', $url);
    drush_set_default('profile', 'default');
    drush_set_default('language', 'en');
    drush_set_default('aliases', array());
48
  }
49

50
51
52
53
54
55
56
57
58
59
60
  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.
 */
61
function provision_drupal_provision_finalize($url = NULL) {
62

63
  if (PROVISION_CONTEXT_SITE) {
64
65
    if (drush_get_option('installed')) {
      drush_set_option('site_url', drush_get_option('site_url'), 'site');
66
      drush_set_option('site_id', drush_get_option('site_id'), 'site');
67
      provision_save_site_data($url);
Adrian Rossouw's avatar
Adrian Rossouw committed
68
    }
69
70
71
72
73
74
75
76
77
78
79
80
  }
  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) {
81
    drush_set_error('PROVISION_REQUIRES_URL');
82
83
84
85
86
87
88
89
90
91
  }
}

/**
 * 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) {
92
    if (!_provision_drupal_site_exists(drush_get_option('site_url'))) {
93
      drush_set_error('PROVISION_DRUPAL_SITE_NOT_FOUND');
94
95
    }
  }
96
97
}

98
99
100
101
102
103
104
105
106
107
108
109
/**
 * 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");
}

110
111
112
113
114
115
116
117

/**
 * 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) {
118
    if (!_provision_drupal_site_installed(drush_get_option('site_url'))) {
119
      drush_set_error('PROVISION_DRUPAL_SITE_NOT_FOUND');
120
121
122
123
124
125
    }
  }
}

function _provision_drupal_valid_not_installed_site() {
  if (PROVISION_CONTEXT_SITE) {
126
    if (_provision_drupal_site_installed(drush_get_option('site_url'))) {
127
      drush_set_error('PROVISION_DRUPAL_SITE_INSTALLED');
Adrian Rossouw's avatar
Adrian Rossouw committed
128
129
130
    }
  }
}
131
132

/**
133
 * Test to see if the site has a site.php and has it set to 'installed'
134
 */
135
136
function _provision_drupal_site_installed($url) {
  if (_provision_drupal_site_exists($url)) {
137
138
    provision_load_site_data($url);
    return drush_get_option('installed');
139
  }
140
  return FALSE;
141
142
}

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

/**
 * 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.
 */
162
163
164
165
166
167
168
169
170
171
function _provision_drupal_create_settings_file($url = NULL) {
  $options = drush_get_merged_options();

  $options['extra_config'] = "# Extra configuration from modules:\n";
  foreach (drush_command_implements('provision_drupal_config') as $module) {
    $options['extra_config'] .= "# -- $module settings --\n";
    $options['extra_config'] .= module_invoke($module, 'provision_drupal_config', $url) . "\n";
  }


172
  drush_log(dt("Generate settings.php file"));
173
  if (provision_path("exists", "sites/$url/settings.php")) {
174
    provision_path("chmod", "sites/$url/settings.php", 0640,
175
176
      dt('Changed permissions of settings.php to @confirm'),
      dt('Could not change permissions of settings.php to @confirm'));
177
178
  }

179
  $fp = fopen("sites/$url/settings.php", "w");
180
  $text =  _provision_drupal_default_template();
181
  fwrite($fp, "<?php\n". provision_render_config($text, $options));
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

  provision_path("chgrp", "sites/$url/settings.php", drush_get_option('web_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
  }
  foreach ($grps as $path) {
230
      provision_path("chown", $path, drush_get_option('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, drush_get_option('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($url = NULL) {
244
  if (PROVISION_CONTEXT_SITE) {
245
246
    #drush_bootstrap(DRUSH_BOOTSTRAP_DRUPAL_FULL);

247
    provision_platform_include(dirname(__FILE__), 'clear');
248
  }
Adrian Rossouw's avatar
Adrian Rossouw committed
249
250
}

251

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

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

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

278
    $languages['en'] = 1;
279
    // Find languages available
280
    $files = array_keys(drush_scan_directory('./profiles/' . $name . '/translations', '\.po$', array('.', '..', 'CVS'), 0, FALSE, 'filepath'));
Adrian Rossouw's avatar
Adrian Rossouw committed
281
    $files = array_merge($files, array_keys(drush_scan_directory('./profiles/' . $name , '\.po$', array('.', '..', 'CVS'), 0, FALSE, 'filepath')));
282
283
284
285
286
    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
        }
287
288
      }
    }
Adrian Rossouw's avatar
Adrian Rossouw committed
289
    $profile->info['languages'] = array_keys($languages);
anarcat's avatar
anarcat committed
290
    $return[$name] = $profile;
291
    drush_log(dt('found install profile %name', array('%name' => $name)));
292
  }
293

294
295
296
297
  return $return;

}

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

Adrian Rossouw's avatar
Adrian Rossouw committed
314
315
function _provision_drupal_get_cvs_versions($files) {
  foreach ($files as $modulename => $file) {
316
317
318
      $project = array();
      $project['filename'] = $file->filename;
      $project['name'] = $file->name;
319
      $file->info['description'] = str_replace("\n", "", $file->info['description']);
320
321
322
323
324
      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
325
      $files[$name] = $file; 
326
  }
327

Adrian Rossouw's avatar
Adrian Rossouw committed
328
  return $files;
329
}
330

331
332
333
/**
 * Create and remove symlinks for each of the possible domain aliases of an existing site
 */
334
function _provision_drupal_maintain_aliases($url) {
335
  if (PROVISION_CONTEXT_SITE) {
336
337
338
339
340
341
    $old_aliases = drush_get_option('aliases', array(), 'site');
    /**
     * First we remove all the old aliases
     */
    if (is_array($old_aliases)) {
      _provision_drupal_delete_aliases($old_aliases);
342
    }
343
344
345
346
347
348


    $aliases = drush_get_option('aliases');
    if (is_array($aliases)) {
      foreach($aliases as $alias) {
        provision_path("symlink", $url, drush_get_option('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
354
355
356
357
358
359
360
      }
    }
  }
}

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

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