hosting_site.nodeapi.inc in Hosting 7.4

Site nodeapi implementations.

File

site/hosting_site.nodeapi.inc

<?php

/**
 * @file
 * Site nodeapi implementations.
 */

/**
 * Implements hook_node_info().
 */
function hosting_site_node_info() {
  $types["site"] = array(
    "type" => 'site',
    "name" => 'Site',
    'base' => 'hosting_site',
    "has_title" => TRUE,
    "title_label" => 'Domain name',
    "description" => hosting_node_help("site"),
    "has_body" => 0,
    "body_label" => '',
    "min_word_count" => 0,
  );
  return $types;
}

/**
 * Implements hook_view().
 */
function hosting_site_view($node, $view_mode, $langcode = NULL) {
  hosting_set_breadcrumb($node);
  drupal_set_title(hosting_site_canonical_url($node));
  hosting_platform_view($node, 'full');
  if ($node->site_status == HOSTING_SITE_ENABLED) {
    $node->content['info']['link'] = array(
      '#markup' => _hosting_site_goto_link($node),
      '#weight' => -10,
    );
  }
  if (is_numeric($node->client)) {
    $node->content['info']['client'] = array(
      '#type' => 'item',
      '#title' => t('Client'),
      '#markup' => _hosting_node_link($node->client),
      '#weight' => 5,
    );
  }
  $node->content['info']['verified'] = array(
    '#type' => 'item',
    '#title' => t('Verified'),
    '#markup' => hosting_format_interval($node->verified),
    '#weight' => -9,
  );
  $node->content['info']['platform'] = array(
    '#type' => 'item',
    '#title' => t('Platform'),
    '#markup' => _hosting_node_link($node->platform),
  );
  if ($node->profile) {
    $node->content['info']['profile'] = array(
      '#type' => 'item',
      '#title' => t('Install profile'),
      '#markup' => _hosting_node_link($node->profile),
    );
  }
  if ($node->site_language) {
    $node->content['info']['site_language'] = array(
      '#type' => 'item',
      '#title' => t('Language'),
      '#markup' => _hosting_language_name($node->site_language),
    );
  }
  if ($node->nid) {
    $node->content['info']['status'] = array(
      '#type' => 'item',
      '#title' => t('Status'),
      '#markup' => _hosting_site_status($node),
    );
  }
  if ($node->db_server) {
    $node->content['info']['db_server'] = array(
      '#type' => 'item',
      '#title' => t('Database server'),
      '#markup' => _hosting_node_link($node->db_server),
    );
  }
  if ($node->db_name) {
    $node->content['info']['db_name'] = array(
      '#type' => 'item',
      '#title' => t('Database name'),
      '#markup' => check_plain($node->db_name),
    );
  }
  if ($node->nid) {
    $node->content['tasks_view'] = array(
      '#type' => 'container',
      '#children' => hosting_task_table($node),
      '#attributes' => array(
        'id' => 'hosting-task-list',
      ),
      '#weight' => 10,
    );
    $settings['hostingTaskRefresh'] = array(
      'nid' => $node->nid,
      'changed' => $node->changed,
    );
    drupal_add_js($settings, array(
      'type' => 'setting',
      'scope' => JS_DEFAULT,
    ));
    drupal_add_js(drupal_get_path('module', 'hosting_task') . '/hosting_task.js');
  }

  // Show files directory.
  $node->content['info']['file_public_path'] = array(
    '#type' => 'item',
    '#title' => t('Public Files'),
    '#markup' => check_plain($node->file_public_path),
  );
  $node->content['info']['#attributes']['id'] = 'hosting-info-panel';
  $node->content['info']['#attributes']['class'][] = 'hosting-panel';
  $node->content['tasks_view']['#attributes']['id'] = 'hosting-tasks-panel';
  $node->content['tasks_view']['#attributes']['class'][] = 'hosting-panel';
  return $node;
}

/**
 * Implements hook_field_extra_fields().
 */
function hosting_site_field_extra_fields() {
  $return['node']['site'] = array(
    'display' => array(
      'info' => array(
        'label' => t('Aegir Site Information'),
        'description' => t('Detailed information about this site.'),
        'weight' => 0,
      ),
      'tasks_view' => array(
        'label' => t('Aegir Site Tasks'),
        'description' => t('List of available tasks.'),
        'weight' => 1,
      ),
    ),
  );
  return $return;
}

/**
 * Implements hook_entity_property_info().
 */
function hosting_site_entity_property_info() {
  $info['node']['bundles']['site']['properties'] = array(
    'client' => array(
      'label' => t('Client'),
      'description' => t('The client that owns the site.'),
      'type' => 'node',
      'bundle' => 'client',
    ),
    'db_server' => array(
      'label' => t('Database server'),
      'description' => t('The database server for the site.'),
      'type' => 'node',
      'bundle' => 'server',
    ),
    'db_name' => array(
      'label' => t('Database name'),
      'description' => t('The name of the database on the database server for the site.'),
      'type' => 'text',
    ),
    'platform' => array(
      'label' => t('Platform'),
      'description' => t('The platform the site is on.'),
      'type' => 'node',
      'bundle' => 'platform',
    ),
    'profile' => array(
      'label' => t('Profile'),
      'description' => t('The install profile used to install the site.'),
      'type' => 'node',
      'bundle' => 'package',
    ),
    'site_language' => array(
      'label' => t('Site language'),
      'description' => t('The language of the site.'),
      'type' => 'text',
    ),
    'last_cron' => array(
      'label' => t('Last cron run time'),
      'description' => t('The date of the last cron run time for the site.'),
      'type' => 'date',
    ),
    'cron_key' => array(
      'label' => t('Cron key'),
      'description' => t('The cron key for the site.'),
      'type' => 'text',
    ),
    'site_status' => array(
      'label' => t('Site status'),
      'description' => t('The status of the site, e.g. enabled, deleted etc.'),
      'type' => 'integer',
      'options list' => 'hosting_site_status_codes_labels',
    ),
    'verified' => array(
      'label' => t('Last verification time'),
      'description' => t('The date of the time the site was verified.'),
      'type' => 'date',
    ),
    'file_public_path' => array(
      'label' => t('Site public files path'),
      'description' => t('The path used for the file_public_path setting in the site.'),
      'type' => 'text',
    ),
    'file_private_path' => array(
      'label' => t('Site private files path'),
      'description' => t('The path used for the file_private_path setting in the site.'),
      'type' => 'text',
    ),
    'file_temporary_path' => array(
      'label' => t('Site temporary files path'),
      'description' => t('The path used for the file_temporary_path setting in the site.'),
      'type' => 'text',
    ),
  );
  return $info;
}

/**
 * Implements hook_nodeapi_delete_revision().
 */
function hosting_nodeapi_site_delete_revision(&$node) {
  db_delete('hosting_site')
    ->condition('vid', $node->vid)
    ->execute();
}

/**
 * Implements hook_delete().
 */
function hosting_site_delete($node) {
  db_delete('hosting_site')
    ->condition('nid', $node->nid)
    ->execute();
  db_delete('hosting_package_instance')
    ->condition('rid', $node->nid)
    ->execute();
  hosting_context_delete($node->nid);
  hosting_task_delete_related_tasks($node->nid);
}

/**
 * Implements hook_nodeapi().
 */
function hosting_site_nodeapi_site_presave(&$node) {
  $node->title = hosting_site_get_domain($node->title);
}

/**
 * Implements hook_insert().
 */
function hosting_site_insert(&$node) {
  $client = hosting_get_client($node->client);
  $node->client = $client->nid;
  $node->site_language = isset($node->site_language) ? $node->site_language : 'en';

  // If the cron_key is set use it, otherwise generate a new one.
  $node->cron_key = isset($node->cron_key) ? $node->cron_key : '';

  // Ensure that the last_cron value is set.
  $node->last_cron = isset($node->last_cron) ? $node->last_cron : 0;

  // Provide a dummy profile, e.g. for hosting-import.
  $node->profile = isset($node->profile) ? $node->profile : 0;

  // If platform NID is not defined, but platform data is available,
  // create the platform.
  if (empty($node->platform) && !empty($node->platform_node) && !empty($node->platform_node->publish_path)) {

    // If a platform exists for the given path, use that.
    $existing_platform_nid = db_select('hosting_platform', 'p')
      ->condition('publish_path', $node->platform_node->publish_path)
      ->condition('status', HOSTING_PLATFORM_ENABLED)
      ->fields('p', array(
      'nid',
    ))
      ->execute()
      ->fetchField();

    // Use the existing platform NID.
    if ($existing_platform_nid) {
      $node->platform = $existing_platform_nid;
    }
    else {

      // If platform_status hasn't been explicitly set,
      // assume platform status matches site status:
      // If developer creates a site node that's disabled,
      // the platform should be too.
      if (!isset($node->platform_node->platform_status) && isset($node->site_status)) {
        $node->platform_node->platform_status = $node->site_status;
      }

      // If web_server hasn't been explicity set, use hostmaster's web server.
      if (!isset($node->platform_node->web_server)) {
        $hostmaster = hosting_context_load('hostmaster');
        $hostmaster_platform = node_load($hostmaster->platform);
        $node->platform_node->web_server = $hostmaster_platform->web_server;
      }

      // If platform title has not been set, generate one from the site title.
      if (empty($node->platform_node->title)) {
        $node->platform_node->title = 'platform_' . preg_replace("/[!\\W]/", "", $node->title);
      }

      // If platform UID has not been set, use site UID.
      if (empty($node->platform_node->uid)) {
        $node->platform_node->uid = $node->uid;
      }
      $node->platform_node->type = 'platform';

      // Don't queue a verify task on save. Site verify now runs platform verify first.
      $node->platform_node->no_verify = TRUE;
      if ($node->platform_node = node_submit($node->platform_node)) {
        node_save($node->platform_node);
      }
      $node->platform = $node->platform_node->nid;
    }

    // If db_server hasn't been explicity set, use hostmaster's web server.
    if (!isset($node->db_server)) {
      $hostmaster = hosting_context_load('hostmaster');
      $node->db_server = $hostmaster->db_server;
    }
  }

  // If there is no platform NID and no publish path, throw an exception.
  if (empty($node->platform) && empty($node->platform_node->publish_path)) {
    throw new Exception('Site nodes require either platform or platform_node->publish_path property');
  }
  $id = db_insert('hosting_site')
    ->fields(array(
    'vid' => $node->vid,
    'nid' => $node->nid,
    'client' => $node->client,
    'db_server' => $node->db_server,
    'db_name' => isset($node->db_name) ? $node->db_name : '',
    'platform' => $node->platform,
    'profile' => $node->profile,
    'language' => $node->site_language,
    'last_cron' => $node->last_cron,
    'cron_key' => $node->cron_key,
    'status' => isset($node->site_status) ? $node->site_status : HOSTING_SITE_QUEUED,
    'verified' => isset($node->verified) ? $node->verified : 0,
    'file_public_path' => $node->file_public_path ?: '',
    'file_private_path' => $node->file_private_path ?: '',
    'file_temporary_path' => $node->file_temporary_path ?: '',
  ))
    ->execute();
}

/**
 * Implements hook_node_insert().
 */
function hosting_site_node_insert($node) {
  if ($node->type == "site") {
    if (empty($node->old_vid)) {
      hosting_context_register($node->nid, isset($node->hosting_name) ? $node->hosting_name : $node->title);
      if (isset($node->import)) {
        hosting_add_task($node->nid, 'import');
      }
      else {
        hosting_add_task($node->nid, 'install');
      }
    }
  }
}

/**
 * Implements hook_update().
 */
function hosting_site_update(&$node) {

  // If this is a new node or we're adding a new revision.
  if (!empty($node->revision)) {
    hosting_site_insert($node);
  }
  else {
    $client = hosting_get_client($node->client);
    $node->client = $client->nid;
    if ($node->site_status == HOSTING_SITE_DELETED) {
      $node->no_verify = TRUE;
    }
    db_update('hosting_site')
      ->fields(array(
      'client' => $node->client,
      'db_server' => $node->db_server,
      'db_name' => $node->db_name,
      'platform' => $node->platform,
      'last_cron' => $node->last_cron,
      'cron_key' => $node->cron_key,
      'status' => $node->site_status,
      'profile' => (int) $node->profile,
      'language' => $node->site_language,
      'verified' => $node->verified,
      'file_public_path' => $node->file_public_path,
      'file_private_path' => $node->file_private_path,
      'file_temporary_path' => $node->file_temporary_path,
    ))
      ->condition('vid', $node->vid)
      ->execute();

    // If platform_node is passed in the site node, save it.
    if (isset($node->platform_node->nid)) {
      node_save($node->platform_node);
    }
  }
}

/**
 * Implements hook_node_update().
 */
function hosting_site_node_update($node) {
  if ($node->type == "site") {
    if (empty($node->no_verify)) {
      hosting_add_task($node->nid, 'verify');
    }
  }
}

/**
 * Implements hook_load().
 */
function hosting_site_load($nodes) {
  foreach ($nodes as $nid => &$node) {
    $additions = db_query('SELECT  client, db_server, db_name, platform, profile, web_server,
        publish_path,
        language AS site_language,
        last_cron,
        cron_key,
        s.status AS site_status,
        file_public_path,
        file_private_path,
        file_temporary_path,
        p.status AS platform_status,
        s.verified,
        p.verified as platform_verified,
        p.git_root,
        p.git_remote,
        p.git_reference,
        p.git_docroot
      FROM {hosting_site} s
        LEFT JOIN {hosting_platform} p ON s.platform = p.nid
      WHERE s.vid = :vid', array(
      ':vid' => $node->vid,
    ))
      ->fetch();
    foreach ($additions as $property => &$value) {
      $node->{$property} = is_numeric($value) ? (int) $value : $value;
    }
  }

  // Create a "servers" array based on our two base servers.
  $node->servers['http'] = node_load($node->web_server);
  $node->servers['db'] = node_load($node->db_server);

  // Set default files paths if they are empty.
  $node->file_public_path = $node->file_public_path ?: 'sites/' . $node->title . '/files';
  $node->file_private_path = $node->file_private_path ?: 'sites/' . $node->title . '/private/files';
  $node->file_temporary_path = $node->file_temporary_path ?: 'sites/' . $node->title . '/private/temp';

  // Load default install_command, deploy_command, and test_command properties
  $node->commands = hosting_find_deploy_commands($node);
}

/**
 * Load deploy command from site source code.
 *
 * Possible sources:
 *   1. Platform defaults: hosting_platform_load() (To be migrated to the devshop/platform class)
 *   2. Platform composer.json: extra.devshop.commands.$COMMAND_NAME
 *   3. Platform X.yml (@TODO).
 *   4. Site {hosting_site_commands}: SQL table in control site stores site-specific command overrides. (@TODO)
 *
 * Each source provides a command for each "phase". If subsequent sources provide
 * a command for a phase, it will override the earlier one.
 *
 * Examples:
 *
 * Composer Platform: Development Site.
 *
 *   1. Platform composer.json defines default composer install command. in `extra.devshop.commands.build`: composer install --no-dev --no-suggest --no-progress
 *   2. Site gets created with "install" option that overrides platform "install", which gets saved to {hosting_site_commands} entry: composer install --dev.
 *
 * @TODO: Move to drupal/provision once hosting requires drupal/provision.
 */
function hosting_find_deploy_commands($node) {
  $composer_json_path = $node->git_root . DIRECTORY_SEPARATOR . 'composer.json';
  if (file_exists($composer_json_path)) {
    $composer_data = json_decode(file_get_contents($composer_json_path), TRUE);
    $commands = isset($composer_data['extra']['devshop']['commands']) ? $composer_data['extra']['devshop']['commands'] : array();
  }
  else {
    $commands = array();
  }
  return $commands;

  // @TODO: Look for site command overrides. Remember platform nodes run this too
}

Functions

Name	Description
hosting_find_deploy_commands	Load deploy command from site source code.
hosting_nodeapi_site_delete_revision	Implements hook_nodeapi_delete_revision().
hosting_site_delete	Implements hook_delete().
hosting_site_entity_property_info	Implements hook_entity_property_info().
hosting_site_field_extra_fields	Implements hook_field_extra_fields().
hosting_site_insert	Implements hook_insert().
hosting_site_load	Implements hook_load().
hosting_site_nodeapi_site_presave	Implements hook_nodeapi().
hosting_site_node_info	Implements hook_node_info().
hosting_site_node_insert	Implements hook_node_insert().
hosting_site_node_update	Implements hook_node_update().
hosting_site_update	Implements hook_update().
hosting_site_view	Implements hook_view().