provision.context.inc 2.76 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<?php
// $Id$

/**
 * @file Provision named context base classes.
 */

/**
 * Store and access context objects by alias name.
 *
 * @param $name
 *   A Drush alias name, including leading @.
 * @param $_root_object
 *   Internal use only, set default object returned by d().
15 16 17
 * @param $allow_creation
 *   Defaults to TRUE. Allows creating a new context object with the specified
 *   $name.
18 19
 *
 * @return
20 21
 *   provision_Context object or NULL if it can't be loaded and
 *   $allow_creation == FALSE.
22
 */
23
function & d($name = NULL, $_root_object = FALSE, $allow_creation = TRUE) {
24 25 26 27 28 29 30 31 32 33 34 35
  static $instances = null;
  static $default_instance = '@self';

  if (is_object($name)) {
    return $name;
  }

  if ($name == 'all') {
    return $instances;
  }

  if (is_null($name)) {
36
    $name = $default_instance;
37
  }
38 39 40 41 42 43
  
  if ($_root_object) {
    $default_instance = $name;
  }
  
  $name = provision_normalise_context_name($name);
44

45 46 47 48 49 50 51 52
  if (isset($instances[$name])) {
    return $instances[$name];
  }
  else {
    $instances[$name] = provision_context_factory($name, $allow_creation);
    if (!is_null($instances[$name])) {
      $instances[$name]->method_invoke('init');
      $instances[$name]->type_invoke('init');
53
    }
54
    return $instances[$name];
55 56 57 58 59 60 61 62 63 64 65 66 67
  }
}

/**
 * Simple access layer for drush_sitealias_get_record.
 *
 * Everytime sitealiases are fetched a lot of processing happens, but if the
 * file doesnt exist yet there's a whole lot of unnecesary stuff happening. 
 *
 * We cache the result locally here.
 */
function provision_sitealias_get_record($name) {
  static $cache = array();
68 69
  
  $name = provision_normalise_context_name($name);
70 71 72 73 74 75 76 77 78

  if (!isset($cache[$name])) {
    $cache[$name] = drush_sitealias_get_record($name);
  }

  return $cache[$name];
}

/**
79 80 81 82 83 84 85 86 87 88
 * Create a new context object.
 *
 * @param $name
 *   The name of the context object to instantiate.
 * @param $allow_creation
 *   Defaults to TRUE. Allows creating a new context object with the specified
 *   $name.
 *
 * @return
 *   An instance of the specified context, or NULL if it could not be loaded.
89
 */
90
function provision_context_factory($name, $allow_creation = TRUE) {
91
  // the default type, can also be 'platform' or 'site'
92 93 94
  $type = 'server';

  $record = provision_sitealias_get_record($name);
95
  if (!$allow_creation && empty($record)) {
96
    drush_set_error('PROVISION_MISSING_CONTEXT', dt('Could not find provision alias named: @name' , array('@name' => $name)));
97 98
    return NULL;
  }
99
  $options = array_merge(drush_get_context('stdin'), drush_get_context('options'), drush_get_context('cli'));
100 101 102 103 104 105 106

  if (isset($record['context_type'])) {
    $type = $record['context_type'];
  }
  elseif (isset($options['context_type'])) {
    $type = $options['context_type'];
  }
107
  $classname = "Provision_Context_{$type}";
108 109 110

  return new $classname($name);
}