db.drush.inc 9.79 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
// $Id$
/**
 * @file
 *    Mysql provisioning module.
 *
 * The goal of this module is to create mysql databases and user accounts, for sites that are about to be created.
 * It uses the provision API to tie into the right places in the site creation work flow.
 */

Adrian Rossouw's avatar
Adrian Rossouw committed
11 12
include_once(dirname(__FILE__) . '/../provision.service.inc');

13
function db_provision_services() {
drumm's avatar
drumm committed
14
  return array('db' => NULL);
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
}

function db_drush_exit() {
  // determine how to close it too.
  provision_service('db')->close();
}

function db_drush_help($section) {
  switch ($section) {
    case 'error:PROVISION_CREATE_DB_FAILED' :
      return dt('Unable to create new databases.');
    case 'error:PROVISION_DROP_DB_FAILED' :
      return dt('Unable to drop database.');
  }
}


class provisionService_db extends provisionService {
drumm's avatar
drumm committed
33 34 35 36 37 38
  static function option_documentation() {
    return array(
      '--master_db' => 'server with db: Master database connection info, {type}://{user}:{password}@{host}',
    );
  }

39
  function init() {
40
    $this->setProperty('master_db');
drumm's avatar
drumm committed
41
    $this->creds = array_map('urldecode', parse_url($this->master_db));
42

43
    return TRUE;
44 45
  }

46
  function verify() { 
47
    if (d()->type === 'server') {
48 49 50 51 52 53 54
      $this->connect();
      if ($this->can_create_database()) {
        drush_log(dt('Provision can create new databases.'), 'message');
      }
      else {
        drush_set_error('PROVISION_CREATE_DB_FAILED');
      }
55 56 57
    }
  }

58 59 60 61 62 63 64 65 66 67
  /**
   * Find a viable database name, based on available information.
   *
   * This function exists solely to work past mysql's database name restrictions.
   * As mysql also does not have the ability to rename databases, it is completely
   * possible that sites will be running with derivative names on the same server,
   * until the upgrade / restore process is completed.
   *
   * TODO: abstract this properly.
   */ 
68
  function suggest_db_name() {
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
    if ($sid = drush_get_option('site_id')) {
      $suggest_base = drush_get_option('aegir_db_prefix', 'site_') . $sid;
    }
    elseif ($name = drush_get_option('db_name')) {
      // consider the verified database name if no site id was provided
      //
      // we strip out eventual _N suffixes before finding a new db name
      // this is necessary because we may already have gone through this
      // process (in a migration) and had a _N suffix added
      $suggest_base = preg_replace('/_\d+$/', '', $name);
    }
    else {
      // This is a last option, and not ideal: base the db name on the
      // site name
      //
      // Provision only users will trigger this mostly.
85
      $suggest_base = substr(str_replace(array('.', '-'), '' , ereg_replace('^www\.', '', drush_get_option('uri'))), 0, 14);
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    }
    $suggest[] = $suggest_base;
    for ($i = 0; $i < 100; $i++) {
      $suggest[] = $suggest_base .'_'. $i;
    }

    foreach ($suggest as $option) {
      if (!$this->database_exists($option)) {
        return $option;
      }
    }

    drush_set_error('PROVISION_CREATE_DB_FAILED', dt("Could not find a free database names after 100 attempts"));
    return false;

  }


  /**
   * Generate a new mysql database and user account for the specified credentials
   */
107 108
  function create_site_database() {
    $creds = $this->generate_site_credentials();
109 110 111
    extract($creds);
    
    if (!$this->can_create_database()) {
112 113 114
      drush_set_error('PROVISION_CREATE_DB_FAILED');
      drush_log("Database could not be created.", 'error');
      return FALSE;
115 116 117 118
    }

    drush_log(dt("Granting privileges to %user@%client on %database", array('%user' => $db_user, '%client' => $db_grant_host, '%database' => $db_name)));
    if (!$this->grant($db_name, $db_user, $db_passwd, $db_grant_host)) {
mig5's avatar
mig5 committed
119
      drush_set_error('PROVISION_CREATE_DB_FAILED', dt("Could not create database user @user", array('@user' => $db_user)));
120
    }
121 122 123
    if (d()->platform->web_server->remote_host !== $db_grant_host) {
      drush_log(dt("Granting privileges to %user@%client on %database", array('%user' => $db_user, '%client' => d()->platform->web_server->remote_host, '%database' => $db_name)));
      if (!$this->grant($db_name, $db_user, $db_passwd, d()->platform->web_server->remote_host)) {
124 125 126
        drush_set_error('PROVISION_CREATE_DB_FAILED', dt("Could not create database user @user", array('@user' => $db_user)));
      }
    }
127

128
    $this->create_database($db_name);
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
    $status = $this->database_exists($db_name);

    if ($status) {
      drush_log(dt('Created @name database', array("@name" => $db_name)), 'success');
    }
    else {
      drush_set_error('PROVISION_CREATE_DB_FAILED', dt("Could not create @name database", array("@name" => $db_name)));
    }
    return $status; 
  }


  
  /**
   * Remove the database and user account for the supplied credentials
   */
Adrian Rossouw's avatar
Adrian Rossouw committed
145 146 147 148
  function destroy_site_database($creds = array()) {
    if (!sizeof($creds)) {
      $creds = $this->fetch_site_credentials();
    }
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    extract($creds);

    if ( $this->database_exists($db_name) ) {
      drush_log(dt("Dropping database @dbname", array('@dbname' => $db_name)));
      if (!$this->drop_database($db_name)) {
        drush_log(dt("Failed to drop database @dbname", array('@dbname' => $db_name)), 'warning');
      }
    }
    
    if ( $this->database_exists($db_name) ) {
     drush_set_error('PROVISION_DROP_DB_FAILED');
     return FALSE;
    }
    
    drush_log(dt("Revoking privileges of %user@%client from %database", array('%user' => $db_user, '%client' => $db_grant_host, '%database' => $db_name)));
    if (!$this->revoke($db_name, $db_user, $db_grant_host)) {
      drush_log(dt("Failed to revoke user privileges"), 'warning');
    }
  }


Adrian Rossouw's avatar
Adrian Rossouw committed
170 171 172 173
  function import_site_database($dump_file = null) {
    if (is_null($dump_file)) {
      $dump_file = d()->root . '/sites/' . d()->uri . '/database.sql';
    }
174 175 176

    $creds = $this->fetch_site_credentials();

177 178 179 180
    $exists = provision_service('file')->exists($dump_file)
      ->succeed('Found database dump at @path.')
      ->fail('No database dump was found at @path.', 'PROVISION_DB_DUMP_NOT_FOUND')
      ->status();
181
    if ($exists) {
182 183 184 185
      $readable = provision_service('file')->readable($dump_file)
        ->succeed('Database dump at @path is readable')
        ->fail('The database dump at @path could not be read.', 'PROVISION_DB_DUMP_NOT_READABLE')
        ->status();
186 187 188 189 190 191
      if ($readable) {
        $this->import_dump($dump_file, $creds);
      }
    }
  }

192
  function generate_site_credentials() {
193 194
    $creds = array();
    // replace with service type 
195
    $db_type = drush_get_option('db_type', 'mysql');
196 197 198 199 200 201 202
    // As of Drupal 7 there is no more mysqli type
    if (drush_drupal_major_version() >= 7) {
      $db_type = ($db_type == 'mysqli') ? 'mysql' : $db_type;
    }

    //TODO - this should not be here at all
    $creds['db_type'] = drush_set_option('db_type', $db_type, 'site');
203
    $creds['db_host'] = drush_set_option('db_host', $this->remote_host, 'site');
204
    $creds['db_passwd'] = drush_set_option('db_passwd', provision_password(), 'site');
205
    $creds['db_name'] = drush_set_option('db_name', $this->suggest_db_name(), 'site');
206
    $creds['db_user'] = drush_set_option('db_user', $creds['db_name'], 'site');
207 208 209 210 211
    $creds['db_grant_host'] = $this->grant_host();

    return $creds;
  }

212
  function fetch_site_credentials() {
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
    $creds = array();

    $keys = array('db_type', 'db_user', 'db_name', 'db_host', 'db_passwd');
    foreach ($keys as $key) {
      $creds[$key] = drush_get_option($key, '', 'site');
    }

    $creds['db_grant_host'] = $this->grant_host();
    return $creds;
  }

  function database_exists($name) {
    return FALSE;
  }

  function drop_database($name) {
    return FALSE;
  }

  function create_database($name) {
    return FALSE;
  }

  function can_create_database() { 
    return FALSE;
  }

  function grant($name, $username, $password, $host = '') {
    return FALSE;
  }

  function revoke($name, $username, $host = '') {
    return FALSE;
  }

  function import_dump($dump_file, $creds) {
    return FALSE;
  }

252
  function generate_dump() {
253 254 255
    return FALSE;
  }

256
  function grant_host() {
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    return 'localhost';
  }
}

/**
 * Indicates the place holders that should be replaced in _db_query_callback().
 */
define('PROVISION_QUERY_REGEXP', '/(%d|%s|%%|%f|%b)/');



// simple wrapper class for PDO based db services

class provisionService_db_pdo extends provisionService_db {
  public $conn;
  protected $creds;
  private $dsn;

275 276
  function init() {
    parent::init();
277
    $this->dsn = sprintf("%s:host=%s", $this->PDO_type,  $this->creds['host']);
278 279 280 281
  }

  function connect() {
    try {
282
      $this->conn = new PDO($this->dsn, $this->creds['user'], $this->creds['pass']);
283 284 285 286 287 288 289 290 291 292
    }
    catch (PDOException $e) {
      return drush_set_error('PROVISION_DB_CONNECT_FAIL', $e->getMessage());
    }
  } 

  function close() {
    $this->conn = null;
  }

293
  function query($query) {
294 295 296 297 298 299 300
    $args = func_get_args();
    array_shift($args);
    if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax
      $args = $args[0];
    }
    $this->query_callback($args, TRUE);
    $query = preg_replace_callback(PROVISION_QUERY_REGEXP, array($this, 'query_callback'), $query);
301
    
302 303 304
    try {
      $result = $this->conn->query($query);
    }
305
    catch (PDOException $e) {
306 307 308 309 310 311 312 313
      drush_log($e->getMessage(), 'warning');
      return FALSE;
    } 

    return $result;

  }

314
  function query_callback($match, $init = FALSE) {
315 316 317 318 319 320 321 322 323 324
    static $args = NULL;
    if ($init) {
      $args = $match;
      return;
    }

    switch ($match[1]) {
      case '%d': // We must use type casting to int to convert FALSE/NULL/(TRUE?)
        return (int) array_shift($args); // We don't need db_escape_string as numbers are db-safe
      case '%s':
325
        return substr($this->conn->quote(array_shift($args)), 1, -1);
326 327 328 329 330 331 332 333 334 335 336
      case '%%':
        return '%';
      case '%f':
        return (float) array_shift($args);
      case '%b': // binary data
        return $this->conn->quote(array_shift($args));
    }

  }
}