provision.inc 8.67 KB
Newer Older
1
<?php
2
// $Id$
3

4 5 6 7 8 9 10 11 12
/**
 * @file
 * The provisioning framework API.
 *
 * API functions that are used by the provisioning framework to provide structure to the provisioning modules.
 *
 * @see errorhandling
 * @see logging
 * @see sitedata
13
 * @see provisionvalues
14 15
 */

16 17
drush_errors_on();

18 19 20 21 22 23 24 25 26 27 28 29
/**
 * @defgroup sitedata Site data management utility functions.
 * @{
 * The provision framework maintains a site.php file in the sites directory, to maintain additional
 * information from the front end, as well as providing a change history of setting changes. 
 *
 * These functions load, save and manage changes made to the site data. This data has diagnostic and infrastructure
 * values, that allow sites to be more easily moved between different provisioned platforms.
 */


/**
30
 * Save modified options to the drushrc.php file
31
 */
32
function provision_save_server_data() {
33
  if (!drush_get_error()) {
34
    $config = new provisionConfig_drushrc_server(d()->name);
35
    $config->write();
36
  }
37 38
}

39 40 41 42 43

function provision_save_site_data() {
  if (!drush_get_error()) {
    $config = new provisionConfig_drushrc_site(d()->name);
    $config->write();
44
    provision_drupal_sync_site();
45 46 47 48 49 50 51 52 53 54 55
  }
}


/**
 * Save modified options to the drushrc.php file
 */
function provision_save_platform_data() {
  if (!drush_get_error()) {
    $config = new provisionConfig_drushrc_platform(d()->name);
    $config->write();
56
    provision_drupal_sync_site();
57 58 59 60
  }
}


61 62 63 64
/**
 * @} End of "defgroup sitedata".
 */

65 66 67 68
/**
 * Remove files or directories, recursively
 *
 * This was taken from imagecache.module, with slight modifications:
69
 * - carry error codes along the way (returns TRUE only if all operations return TRUE)
70 71 72 73
 * - remove any type of files encountered (not just links, files and dirs)
 * - safety checking since we don't necessarly trust the removed files
 */
function _provision_recursive_delete($path) {
anarcat's avatar
anarcat committed
74
  $ret = 1;
75 76
  if (is_dir($path)) {
    $d = dir($path);
77
    while (($entry = $d->read()) !== FALSE) {
78 79
      if ($entry == '.' || $entry == '..') continue;
      $entry_path = $path .'/'. $entry;
80
      if (_provision_file_check_location($entry_path, $path)) {
81
        $ret = _provision_recursive_delete($entry_path);
82 83
      } 
      else {
84 85 86 87
        $ret = 0;
      }
    }

88
    $rm = provision_file()->rmdir($path)
89 90 91
      ->succeed('Deleting @path directory successful.')
      ->fail('Deleting @path directory failed.')
      ->status();
92 93 94 95

    $ret = $ret && $rm;
  }
  else {
96
    $rm = provision_file()->unlink($path)
97 98
      ->fail('Deleting @path file failed.')
      ->status();
anarcat's avatar
anarcat committed
99
    $ret = $ret && $rm;
100 101 102 103
  }
  return $ret;
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
function _provision_file_check_location($source, $directory = '') {
  $check = realpath($source);
  if ($check) {
    $source = $check;
  }
  else {
    // This file does not yet exist
    $source = realpath(dirname($source)) .'/'. basename($source);
  }
  $directory = realpath($directory);
  if ($directory && strpos($source, $directory) !== 0) {
    return 0;
  }
  return $source;
}

120 121
/**
 * Wrapper around drush_shell_exec to provide sprintf functionality with some more safety.
122 123 124
 *
 * @TODO: fix this so we can get error codes and the return values. drush_shell_exec is too
 *        limited
125 126 127 128
 */
function provision_shell_exec() {
  $args = func_get_args();
  
129
  //do not change the command itself, just the parameters.
130 131 132
  for ($x = 1; $x < sizeof($args); $x++) {
    $args[$x] = escapeshellcmd($args[$x]);
  }
133
  $command = call_user_func_array('sprintf', $args);
134
  drush_log($command); 
135
  return drush_shell_exec($command);
136 137
}

138
/**
139
 * Check whether a user is a member of a group.
140
 *
141 142 143 144 145 146 147
 * @param user
 *   username or user id of user.
 * @param group
 *   groupname or group id of group.
 *
 * @return
 *   Boolean. True if user does belong to group, 
148
 *   and FALSE if the user does not belong to the group, or either the user or group do not exist.
149
 */
150 151 152 153 154 155 156 157
function provision_user_in_group($user, $group) {
  // TODO: make these singletons with static variables for caching.
  $user = provision_posix_username($user);
  $group = provision_posix_groupname($group);
  if ($user && $group) {
    $info = posix_getgrnam($group);
    if (in_array($user, $info['members'])) {
      return TRUE;
158 159
    }
  }
160
  return FALSE;
161 162 163 164 165 166
}

/**
 * Return the valid system username for $user.
 *
 * @return
167
 *   Returns the username if found, otherwise returns FALSE
168 169 170
 */
function provision_posix_username($user) {
  // TODO: make these singletons with static variables for caching.
171
  // we do this both ways, so that the function returns NULL if no such user was found.
172 173 174 175
  if (is_numeric($user)) {
    $info = posix_getpwuid($user);
    $user = $info['name'];
  }
176
  else {
177 178 179 180 181 182 183 184 185 186
    $info = posix_getpwnam($user);
    $user = $info['name'];
  }
  return $user;
}

/**
 * Return the valid system groupname for $group.
 *
 * @return
187
 *   Returns the groupname if found, otherwise returns FALSE
188 189 190
 */
function provision_posix_groupname($group) {
  // TODO: make these singletons with static variables for caching.
191
  // we do this both ways, so that the function returns NULL if no such user was found.
192
  if (is_numeric($group)) {
193 194 195 196 197 198
    $info = posix_getgrgid($group);
    $group = $info['name'];
  }
  else {
    $info = posix_getgrnam($group);
    $group = $info['name'];
199
  }
200
  return $group;
201
}
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
function provision_password($length = 10) {
  // This variable contains the list of allowable characters for the
  // password. Note that the number 0 and the letter 'O' have been
  // removed to avoid confusion between the two. The same is true
  // of 'I', 1, and 'l'.
  $allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';

  // Zero-based count of characters in the allowable list:
  $len = strlen($allowable_characters) - 1;

  // Declare the password as a blank string.
  $pass = '';

  // Loop the number of times specified by $length.
  for ($i = 0; $i < $length; $i++) {

    // Each iteration, pick a random character from the
    // allowable string and append it to the password:
    $pass .= $allowable_characters[mt_rand(0, $len)];
  }

  return $pass;
}
226

227 228 229 230 231 232 233 234 235 236 237 238 239
/**
 * This is a helper function which changes deeply nested objects into arrays
 *
 * This helps get past the face that objects are not simple to work with, or
 * save in context files.
 *
 * This function 'misuses' a side effect of the json_decode function's second
 * parameter. As this is done in C, and the structures we are manipulating
 * aren't that large, it should be performant enough.
 */
function _scrub_object($input) {
  return json_decode(json_encode($input), TRUE);
}
240 241 242 243 244 245 246

/**
 * Execute a command against a specific context object.
 */
function provision_backend_invoke($target, $command, $arguments = array(), $options = array(), $mode = 'GET') {
  return drush_backend_invoke_args('@' . ltrim($target, '@') . ' ' . $command, $arguments, $options + array('root' => null, 'uri' => null), $mode);
}
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 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 317 318 319 320 321 322 323 324 325 326 327


/**
 * A base class for the service and file handling classes that implements chaining of methods.
 */
class provisionChainedState {
  protected $last_status;
  protected $tokens;

  /**
   * Clear internal state
   */
  protected function _clear_state() {
    $this->last_status = NULL;
    $this->tokens = NULL;
  }

  /**
   * Return the status of the last operation.
   *
   * @return
   *   TRUE or FALSE for success or failure; NULL if there was not a previous
   *   operation.
   */
  function status() {
    return $this->last_status;
  }

  /**
   * Log a notice into the logging system, if the last operation completed
   * succesfully.
   * 
   * @param $message
   *   The message to log, a string.
   */
  function succeed($message) {
    if ($this->last_status === TRUE) {
      drush_log(dt($message, $this->tokens), 'message');      
    }

    return $this;
  }

  /**
   * Log a notice into the logging system, if the last operation did not
   * complete succesfully.
   * 
   * @param $message
   *   Log this as a error to the logging system, if the $error_codes parameter
   *   has been set, otherwise, log this as a warning. If the operation
   *   specifies an additional reason for the operation failing, it will be
   *   appended to this message.
   *
   * @param error_codes
   *   Generate these system level errors using the provision error bitmasks.
   */
  function fail($message, $error_codes = NULL) {
    if (!empty($this->tokens['@reason'])) {
      $message .= ' (@reason)';
    }
    if ($this->last_status === FALSE) {
      if (is_null($error_codes)) {
        // Trigger a warning
        drush_log(dt($message, $this->tokens), 'warning');
      }
      else {
        // Trigger a sysem halting error
        drush_set_error($error_codes, dt($message, $this->tokens));
      }
    }

    return $this;
  }
}

include_once('provision.environment.inc');
include_once('provision.service.inc');
include_once('provision.file.inc');
include_once('provision.config.inc');