hosting_db_server.module in Hosting 5

File

db_server/hosting_db_server.module

<?php

function hosting_db_server_hosting_service() {
  return array(
    "db_server" => t("Mysql database server"),
  );
}

/**
 * Implementation of hook_help().
 */
function hosting_db_server_help($section) {
  switch ($section) {
    case 'admin/help/provision#requirements':
      $output .= _hosting_requirements('mysql_user');
      return $output;
      break;
  }
}
function _hosting_mysql_user_requirements() {
  $username = HOSTING_DEFAULT_SCRIPT_USER;
  $command = <<<EOF
     mysql -uroot -pXXXXXXXXX mysql

     mysql> GRANT ALL PRIVILEGES ON *.* TO 'username_here'@'%' IDENTIFIED BY 'mypassword' WITH GRANT OPTION;
     Query OK, 0 rows affected (0.00 sec)

EOF;
  $help['title'] = t('Mysql user account capable of creating new databases.');
  $help['summary'] = t('To be able to create new sites, the provisioning framework will need to be able
     to create new databases and users. It is not recommended using the mysql root password for this,
     but any account with the correct permissions will do.');
  $help['configuration'] = t('Log in to your mysql server as root, and type in the following command:
     <pre>@command_text</pre>', array(
    '@command_text' => $command,
  ));
  return $help;
}
function hosting_get_db_server($hostname, $web_server = null) {
  if (_hosting_valid_ip($hostname)) {
    $ip = $hostname;
    $hostname = gethostbyaddr($hostname);
  }
  else {
    $ip = gethostbyname($hostname);
  }
  $result = db_result(db_query("SELECT nid FROM {node} WHERE title in ('%s', '%s') and type='db_server'", $ip, $hostname));
  if ($result) {
    return node_load($result);
  }
  return false;
}
function hosting_db_server_as_url($nid) {
  $node = node_load($nid);
  return sprintf("%s://%s:%s@%s", $node->db_type, $node->db_user, $node->db_passwd, $node->title);
}
function hosting_db_server_node_info() {
  $types["db_server"] = array(
    "type" => 'db_server',
    "name" => 'Database server',
    "module" => 'hosting_db_server',
    "has_title" => TRUE,
    "title_label" => t('Host name'),
    "description" => hosting_node_help("db_server"),
    "has_body" => 0,
    "body_label" => '',
    "min_word_count" => 0,
  );
  return $types;
}
function hosting_db_server_hosting_feature() {
  $features['db_server'] = array(
    'title' => t('Database servers'),
    'description' => t('Configure and maintain multiple database servers.'),
    'status' => HOSTING_FEATURE_DISABLED,
    'node' => 'db_server',
    'group' => 'experimental',
  );
  return $features;
}
function hosting_db_server_perm() {
  return array(
    'create database server',
    'view database server',
    'edit database server',
    'delete database server',
  );
}
function hosting_db_server_access($op, $node) {
  global $user;
  switch ($op) {
    case 'create':
      return user_access('create database server');
      break;
    case 'update':
      return user_access('edit database server');
      break;
    case 'delete':
      return user_access('delete database server');
      break;
    default:
      break;
  }

  //  return hosting_access($op, $node);
}

/**
 * Small helper function to get web servers.
*/
function _hosting_get_db_servers() {
  $return = array();
  $result = db_query("SELECT nid, title FROM {node} WHERE type='db_server' AND status=1");
  while ($server = db_fetch_object($result)) {
    $return[$server->nid] = $server->title;
  }
  return $return;
}

/**
 * Implementation of hook_form().
 */
function hosting_db_server_form(&$node) {
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Hostname'),
    '#description' => t('The address of the database server to connect to.'),
    '#size' => 30,
    '#default_value' => $node->title,
    '#maxlength' => 64,
    '#weight' => 0,
  );
  $form['db_user'] = array(
    '#type' => 'textfield',
    '#required' => TRUE,
    '#title' => t('Username'),
    '#description' => t('The user that will be used to create users and databases for new sites.'),
    '#size' => 40,
    '#default_value' => $node->db_user,
    '#maxlength' => 64,
    '#weight' => 5,
  );
  if ($node->db_passwd) {
    $passwd_description = t('<strong>You have already set a password for this database server.</strong><br />');
  }
  $form['db_passwd'] = array(
    '#type' => 'password_confirm',
    '#required' => $node->db_passwd ? FALSE : TRUE,
    '#description' => $passwd_description . t('The user account that will be used to create new mysql users and databases for new sites'),
    '#size' => 30,
    '#weight' => 10,
  );
  return $form;
}

/**
 * Implementation of hook_submit().
 */
function hosting_db_server_submit(&$node) {
  if (empty($node->db_passwd) && $node->nid) {
    $old = node_load($node->nid);
    $node->db_passwd = $old->db_passwd;
  }
}

/**
 * Implementation of hook_insert().
 */
function hosting_db_server_insert($node) {
  db_query("INSERT INTO {hosting_db_server} (vid, nid, db_type, db_user, db_passwd) \n      VALUES (%d, %d, '%s', '%s', '%s')", $node->vid, $node->nid, $node->db_type, $node->db_user, $node->db_passwd);
}

/**
 * Implementation of hook_update().
 *
 * As an existing node is being updated in the database, we need to do our own
 * database updates.
 */
function hosting_db_server_update($node) {

  // if this is a new node or we're adding a new revision,
  if ($node->revision) {
    hosting_db_server_insert($node);
  }
  else {
    db_query("UPDATE {hosting_db_server} SET \n                  db_type = '%s', db_user = '%s', db_passwd = '%s'\n              WHERE \n                  vid = %d", $node->db_type, $node->db_user, $node->db_passwd, $node->vid);
  }
}
function hosting_nodeapi_db_server_delete_revision(&$node) {
  db_query('DELETE FROM {hosting_db_server} WHERE vid = %d', $node->vid);
}

/**
 * Implementation of hook_delete().
 */
function hosting_db_server_delete($node) {
  db_query('DELETE FROM {hosting_db_server} WHERE nid = %d', $node->nid);
}

/**
 * Implementation of hook_load().
 */
function hosting_db_server_load($node) {
  $additions = db_fetch_object(db_query('SELECT db_type, db_user, db_passwd FROM {hosting_db_server} WHERE vid = %d', $node->vid));
  return $additions;
}

/**
 * Implementation of hook_view().
 */
function hosting_db_server_view($node, $teaser = FALSE, $page = FALSE) {
  $node = node_prepare($node, $teaser);
  $node->content['info'] = array(
    '#prefix' => '<div id="hosting-dbserver-info">',
    '#suffix' => '</div>',
  );
  $node->content['info']['db_type'] = array(
    '#type' => 'item',
    '#title' => t('Database type'),
    '#value' => $node->db_type,
  );
  $node->content['info']['db_user'] = array(
    '#type' => 'item',
    '#title' => t('Database user'),
    '#value' => filter_xss($node->db_user),
  );
  $node->content['sites_view'] = array(
    '#type' => 'item',
    '#value' => hosting_site_list("db_server", $node->nid),
    '#prefix' => '<div id="hosting-site-list">',
    '#suffix' => '</div>',
    '#weight' => 10,
  );
  return $node;
}
function hosting_db_server_hosting_summary() {
  $summary = array();
  $db_servers = _hosting_get_db_servers();
  $summary['db_servers'] = theme('item_list', array_map('_hosting_node_link', array_keys($db_servers)), t('Database servers'));
  return $summary;
}

Functions

Name	Description
hosting_db_server_access
hosting_db_server_as_url
hosting_db_server_delete	Implementation of hook_delete().
hosting_db_server_form	Implementation of hook_form().
hosting_db_server_help	Implementation of hook_help().
hosting_db_server_hosting_feature
hosting_db_server_hosting_service
hosting_db_server_hosting_summary
hosting_db_server_insert	Implementation of hook_insert().
hosting_db_server_load	Implementation of hook_load().
hosting_db_server_node_info
hosting_db_server_perm
hosting_db_server_submit	Implementation of hook_submit().
hosting_db_server_update	Implementation of hook_update().
hosting_db_server_view	Implementation of hook_view().
hosting_get_db_server
hosting_nodeapi_db_server_delete_revision
_hosting_get_db_servers	Small helper function to get web servers.
_hosting_mysql_user_requirements