Move provisionSerivice to an autoload.

Provision/Context.php

@@ -248,7 +248,7 @@ function service($service, $name = null) {
       return $this->{$this->parent_key}->service($service, ($name) ? $name : $this->name);
     }
     else {
-      return new provisionService_null($this->name);
+      return new Provision_Service_null($this->name);
     }
   }
 

Provision/Context/server.php

@@ -15,7 +15,7 @@ class Provision_Context_server extends Provision_Context {
   /**
    * Associative array of services for this server.
    *
-   * @see provisionService
+   * @see Provision_Service
    */
   protected $services = array();
 
@@ -106,7 +106,7 @@ function spawn_service($service, $default = null) {
       }
     }
     else {
-      $this->services[$service] = new provisionService_null($this->name);
+      $this->services[$service] = new Provision_Service_null($this->name);
     }
   }
 

Provision/Service.php

@@ -0,0 +1,323 @@
+<?php
+
+require_once DRUSH_BASE_PATH . '/commands/core/rsync.core.inc';
+
+
+class Provision_Service extends Provision_ChainedState {
+
+  /**
+   * The server this service is associated to
+   */
+  protected $server = '@server_master';
+
+  /**
+   * The context in which this service stores its data
+   *
+   * This is usually an object made from a class derived from the
+   * Provision_Context base class
+   *
+   * @see Provision_Context
+   */
+  public $context;
+
+  protected $service = null;
+  protected $application_name = null;
+
+  protected $has_restart_cmd = FALSE;
+  protected $has_port = FALSE;
+
+  protected $configs = array();
+
+
+  protected $config_cache = array();
+  private $_config = null;
+
+
+  /**
+   * Implement the __call magic method.
+   *
+   * This implementation is really simple. It simply return null if the
+   * method doesn't exist.
+   *
+   * This is used so that we can create methods for drush commands, and
+   * can fail safely.
+   */
+  function __call($name, $args = array()) {
+    return provision::method_invoke($this, $name, $args);
+  }
+
+
+  function init() {
+
+  }
+
+  // All services have the ability to have an associated restart command and listen port.
+  function init_server() {
+    if (!is_null($this->service)) {
+      if ($this->has_port) {
+        $this->server->setProperty($this->service . '_port', $this->default_port());
+      }
+      if ($this->has_restart_cmd) {
+        $this->server->setProperty($this->service . '_restart_cmd', $this->default_restart_cmd());
+      }
+    }
+    return TRUE;
+  }
+
+  function init_platform() {
+
+  }
+
+  function init_site() {
+
+  }
+
+
+  function default_port() {
+    return false;
+  }
+
+  function default_restart_cmd() {
+    return false;
+  }
+
+  /**
+   * Set the currently active configuration object.
+   *
+   * @param $config
+   *   String: Name of config file. The key to the $this->configs array.
+   * @param $data
+   *   Any optional information to be made available to templates. If a string, it will be
+   *   turned into an array with the 'name' property the value of the string.
+   */
+  function config($config, $data = array()) {
+    $this->_config = null;
+
+    if (!isset($this->configs[$config])) {
+      $service = (!is_null($this->application_name)) ? $this->application_name : $this->service;
+      drush_log(dt('%service has no %name config file', array(
+        '%service' => $service,
+        '%name' => $config))
+      );
+      return $this;
+    }
+
+    if (!is_array($data) && is_string($data)) {
+      $data = array('name' => $data);
+    }
+
+    if (!isset($this->config_cache[$this->context->name][$config])) {
+      foreach ((array) $this->configs[$config] as $class) {
+        $this->config_cache[$this->context->name][$config] = new $class($this->context, array_merge($this->config_data($config), $data));
+      }
+    }
+
+    if (isset($this->config_cache[$this->context->name][$config])) {
+      $this->_config = $this->config_cache[$this->context->name][$config];
+    }
+
+    return $this;
+  }
+
+  /**
+   * Unlink the currently active config file.
+   */
+  function unlink() {
+    if (is_object($this->_config)) {
+      $this->_config->unlink();
+    }
+
+    return $this;
+  }
+
+  /**
+   * Write the currently active config file.
+   */
+  function write() {
+    if (is_object($this->_config)) {
+      $this->_config->write();
+    }
+
+    return $this;
+  }
+
+  /**
+   * Set a record on the data store of the currently active config file (if applicable).
+   */
+  function record_set($arg1, $arg2 = null) {
+    if (is_object($this->_config)) {
+      if (is_object($this->_config->store)) {
+        if (is_array($arg1)) {
+          $this->_config->store->records = array_merge($this->_config->store->records, $arg1);
+        }
+        elseif (!is_numeric($arg1)) {
+          if (is_array($arg2)) {
+            if (!isset($this->_config->store->loaded_records[$arg1])
+                || !is_array($this->_config->store->loaded_records[$arg1]))
+            {
+              $this->_config->store->loaded_records[$arg1] = array();
+            }
+            if (!isset($this->_config->store->records[$arg1])
+                || !is_array($this->_config->store->records[$arg1]))
+            {
+              $this->_config->store->records[$arg1] = array();
+            }
+            $this->_config->store->records[$arg1] = array_merge($this->_config->store->loaded_records[$arg1], $this->_config->store->records[$arg1], $arg2);
+          } else {
+            $this->_config->store->records[$arg1] = $arg2;
+          }
+        }
+      }
+    }
+    return $this;
+  }
+
+  /**
+   * Delete a record from the data store of the currently active config file (if applicable).
+   */
+  function record_del($record) {
+    return $this->record_set($record, null);
+  }
+
+  /**
+   * Check if a record exists in the data store of the currently active config file (if applicable).
+   */
+  function record_exists($record) {
+    if (is_object($this->_config)) {
+      if (is_object($this->_config->store)) {
+        return array_key_exists($record, $this->_config->store->merged_records());
+      }
+    }
+    return FALSE;
+  }
+
+  /**
+   * Fetch record(s) from the data store of the currently active config file (if applicable).
+   */
+  function record_get($key = null, $default = null) {
+    if (is_object($this->_config)) {
+      if (is_object($this->_config->store)) {
+        $records = $this->_config->store->merged_records();
+
+        if (is_null($key)) {
+          return $records;
+        }
+
+        if (isset($records[$key])) {
+          return $records[$key];
+        }
+      }
+    }
+    return $default;
+  }
+
+
+  /**
+   * Generate a configuration file.
+   *
+   * This method will fetch the class to instantiate from the internal
+   * $this->configs control array.
+   */
+  function create_config($config, $data = array()) {
+    $this->config($config, $data)->write();
+  }
+
+  /**
+   * Delete a configuration file.
+   * 
+   * This method will fetch the class to instantiate from the internal
+   * $this->configs control array.
+   */
+  function delete_config($config, $data = array()) {
+    $this->config($config, $data)->unlink();
+  }
+
+  /**
+   * Fetch extra information the service wants to pass to he config file classes.
+   */
+  function config_data($config = null, $class = null) {
+    $data = array();
+    // Always pass the server this service is running on to configs.
+    $data['server'] = $this->server;
+
+    if (!is_null($this->application_name)) {
+      // This value may be useful to standardize paths in config files.
+      $data['application_name'] = $this->application_name;
+    }
+    return $data;
+  }
+
+
+  /**
+   * Restart the service using the provided restart command.
+   */
+  function restart() {
+    // Only attempt to restart real services can have restart commands.
+    if (!is_null($this->service) && $this->has_restart_cmd) {
+      $service = (!is_null($this->application_name)) ? $this->application_name : $this->service;
+
+      // Only attempt to restart if the command has been filled in.
+      if ($cmd = $this->server->{"{$this->service}_restart_cmd"}) {
+        if ($this->server->shell_exec($cmd)) {
+          drush_log(dt('%service on %server has been restarted', array(
+            '%service' => $service,
+            '%server' => $this->server->remote_host))
+          );
+
+          return TRUE;
+        }
+        else {
+          drush_log(dt('%service on %server could not be restarted.'.
+            ' Changes might not be available until this has been done. (error: %msg)', array(
+            '%service' => $service,
+            '%server' => $this->server->remote_host, 
+            '%msg' => join("\n", drush_shell_exec_output()))), 'warning');
+        }
+      }
+    }
+    return FALSE;
+  }
+
+  function __construct($server) {
+    $this->server = is_object($server) ? $server : d($server);
+  }
+
+  /**
+   * Set the currently active context of the service.
+   *
+   * @arg mixed $context
+   *    the context to store this services data into. this can be an
+   *    object, or a string in which case the object will be loaded
+   *    dynamically with d()
+   *
+   * @see d()
+   */
+  function setContext($context) {
+    $this->context = is_object($context) ? $context : d($context);
+  }
+
+  /**
+   * Sync filesystem changes to the server hosting this service.
+   */
+  function sync($path = NULL, $additional_options = array()) {
+    return $this->server->sync($path, $additional_options);
+  }
+
+  function fetch($path = NULL) {
+    return $this->server->fetch($path);
+  }
+
+  function verify() {
+    return TRUE;
+  }
+
+  /**
+   * Return service-specific configuration options for help.
+   *
+   * @return
+   *   array('--option' => 'description')
+   */
+  static function option_documentation() {
+    return array();
+  }
+}

Provision/Service/null.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Null service class.
+ *
+ * Not all services are necessary or turned on.
+ * This class ensures that not having a specific service
+ * doesnt result in catastrophic failure.
+ */
+class Provision_Service_null extends Provision_Service {
+
+  function __get($name) {
+    return false;
+  }
+
+  function __call($name, $args) {
+    return false;
+  }
+
+  /**
+   * Null services do not synch files to the remote server,
+   * because they have no associated config files.
+   */
+  function sync() {
+    return null;
+  }
+}

db/db.drush.inc

@@ -33,7 +33,7 @@ function db_drush_help($section) {
 }
 
 
-class provisionService_db extends provisionService {
+class provisionService_db extends Provision_Service {
   protected $service = 'db';
 
   /**

dns/dns.drush.inc

@@ -73,7 +73,7 @@ function dns_provision_services() {
 
 
 
-class provisionService_dns extends provisionService {
+class provisionService_dns extends Provision_Service {
   public $service = 'dns';
   public $slave = null;