provision.config.inc 10.5 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

// $Id$

/**
 * Provision configuration generation classes.
 */

class provisionConfig {
drumm's avatar
drumm committed
10 11 12 13
  /**
   * Template file, a PHP file which will have access to $this and variables
   * as defined in $data.
   */
14
  public $template = null;
drumm's avatar
drumm committed
15 16 17 18

  /**
   * Associate array of variables to make available to the template.
   */
19
  public $data = array();
drumm's avatar
drumm committed
20 21 22 23 24 25

  /**
   * A provisionEnvironment object thie configuration relates to.
   *
   * @var provisionEnvironment
   */
26
  public $owner = null;
drumm's avatar
drumm committed
27 28 29 30

  /**
   * If set, replaces file name in log messages.
   */
31
  public $description = null;
drumm's avatar
drumm committed
32 33 34 35

  /**
   * Octal Unix mode for permissons of the created file.
   */
36
  protected $mode = NULL;
drumm's avatar
drumm committed
37 38 39 40

  /**
   * Unix group name for the created file.
   */
41
  protected $group = NULL;
42

Adrian Rossouw's avatar
Adrian Rossouw committed
43 44 45 46 47 48 49 50
  /**
   * An optional data store class to instantiate for this config.
   */
  protected $data_store_class = NULL;

  /**
   * The data store.
   */
51
  public $store = NULL;
Adrian Rossouw's avatar
Adrian Rossouw committed
52

drumm's avatar
drumm committed
53 54 55 56
  /**
   * Forward $this->... to $this->owner->...
   * object.
   */
57
  function __get($name) {
58 59
    if (isset($this->owner)) {
      return $this->owner->$name;
60 61
    }
  }
drumm's avatar
drumm committed
62 63 64 65 66 67 68 69 70 71 72

  /**
   * Constructor, overriding not recommended.
   *
   * @param $owner
   *   An alias name for d(), the provisionEnvironment that this configuration
   *   is relevant to.
   * @param $data
   *   An associative array to potentiall manipulate in process() and make
   *   available as variables to the template.
   */
73
  function __construct($owner, $data = array()) {
74 75 76
    if (is_null($this->template)) {
      throw(exception);
    }
77

78 79
    // Accept both a reference and an alias name for the owner.
    $this->owner = is_object($owner) ? $owner : d($owner);
80

81
    if (sizeof($data)) {
82
      $this->data = $data;
83
    }
Adrian Rossouw's avatar
Adrian Rossouw committed
84 85 86 87 88 89 90
    //$this->parsed_data = $this->parse();
    //$this->data = array_merge($this->parsed_data, $this->data);

    
    if (!is_null($this->data_store_class) && class_exists($this->data_store_class)) {
      $class = $this->data_store_class;
      $this->store = new $class($owner, $data);
91

Adrian Rossouw's avatar
Adrian Rossouw committed
92 93
    }

drumm's avatar
drumm committed
94 95
  }

96 97 98 99 100 101 102
  /**
   * Parse the existing config to load data
   *
   * This is called in the constructor, and should take care of
   * opening the file and parsing it into the data array.
   */
  function parse() {
103
    return array();
104 105
  }

106
  /**
drumm's avatar
drumm committed
107
   * Process and add to $data before writing the configuration.
108
   *
drumm's avatar
drumm committed
109
   * This is a stub to be implemented by subclasses.
110
   */
111
  function process() {
112 113 114
    if (is_object($this->store)) {
      $this->data['records'] = array_filter(array_merge($this->store->loaded_records, $this->store->records));
    }
115 116 117
    return true;
  }

118
  /**
drumm's avatar
drumm committed
119
   * The filename where the configuration is written.
120
   * 
drumm's avatar
drumm committed
121
   * This is a stub to be implemented by subclasses.
122
   */
123 124 125 126
  function filename() {
    return false;
  }

drumm's avatar
drumm committed
127 128 129
  /**
   * Load template from filename().
   */
130
  private function load_template() {
Adrian Rossouw's avatar
Adrian Rossouw committed
131 132
    $class_name = get_class($this);

133 134 135
    $reflect = new reflectionObject($this);

    if (isset($this->template)) {
Adrian Rossouw's avatar
Adrian Rossouw committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149
      while ($class_name) {
        // Iterate through the config file's parent classes until we
        // find the template file to use.
        $reflect = new reflectionClass($class_name);
        $base_dir = dirname($reflect->getFilename());

        $file = $base_dir . '/' . $this->template;

        if (file_exists($file) && is_readable($file)) {
          drush_log("Template loaded: $file");
          return file_get_contents($file);
        }

        $class_name = get_parent_class($class_name);
150
      }
Adrian Rossouw's avatar
Adrian Rossouw committed
151 152 153

    } 

154 155 156
    return false;
  }

drumm's avatar
drumm committed
157 158 159 160
  /**
   * Render template, making variables available from $variables associative
   * array.
   */
161 162 163 164 165 166 167 168 169 170 171
  private function render_template($template, $variables) {
    drush_errors_off();
    extract($variables, EXTR_SKIP);  // Extract the variables to a local namespace
    ob_start();                      // Start output buffering
    eval('?>'. $template);                 // Generate content
    $contents = ob_get_contents();   // Get the contents of the buffer
    ob_end_clean();                  // End buffering and discard
    drush_errors_on();
    return $contents;                // Return the contents
  }

drumm's avatar
drumm committed
172 173 174 175 176 177 178 179 180 181
  /**
   * Write out this configuration.
   *
   * 1. Make sure parent directory exists and is writable.
   * 2. Load template with load_template().
   * 3. Process $data with process().
   * 4. Make existing file writable if necessary and possible.
   * 5. Render template with $this and $data and write out to filename().
   * 6. If $mode and/or $group are set, apply them for the new file.
   */
182 183
  function write() {
    $filename = $this->filename();
drumm's avatar
drumm committed
184
    // Make directory structure if it does not exist.
185 186
    if (!provision_file()->exists(dirname($filename))->status()) {
      provision_file()->mkdir(dirname($filename))
drumm's avatar
drumm committed
187 188 189 190
        ->succeed('Created directory @path.')
        ->fail('Could not create directory @path.');
    }

191 192 193 194 195
    if ($filename && is_writeable(dirname($filename))) {
      // manipulate data before passing to template.
      $this->process();

      if ($template = $this->load_template()) {
196
        // Make sure we can write to the file
197 198
        if (!is_null($this->mode) && !($this->mode & 0200) && provision_file()->exists($filename)->status()) {
          provision_file()->chmod($filename, $this->mode | 0200)
199 200 201 202
            ->succeed('Changed permissions of @path to @perm')
            ->fail('Could not change permissions of @path to @perm');
        }

Adrian Rossouw's avatar
Adrian Rossouw committed
203
        $this->file_put_contents($filename, $this->render_template($template, $this->data));
204 205 206

        // Change the permissions of the file if needed
        if (!is_null($this->mode)) {
207
          provision_file()->chmod($filename, $this->mode)
208 209 210 211
            ->succeed('Changed permissions of @path to @perm')
            ->fail('Could not change permissions of @path to @perm');
        }
        if (!is_null($this->group)) {
212
          provision_file()->chgrp($filename, $this->group)
213 214
            ->succeed('Change group ownership of @path to @gid')
            ->fail('Could not change group ownership of @path to @gid');
215 216 217 218 219
        }
      }
    }
  }

Adrian Rossouw's avatar
Adrian Rossouw committed
220 221 222 223 224 225
  // allow overriding w.r.t locking
  function file_put_contents($filename, $text) {
    provision_file()->file_put_contents($filename, $text)
      ->succeed('Generated config ' . (empty($this->description) ? $filename : $this->description), 'success');
  }

drumm's avatar
drumm committed
226 227 228
  /**
   * Remove configuration file as specified by filename().
   */
229
  function unlink() {
230
    provision_file()->unlink($this->filename())->status();
231
  }
232
  
233
}
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250

/**
 * Specialized class to handle the creation of drushrc.php files.
 *
 * This is based on the drush_save_config code, but has been abstracted
 * for our purposes.
 */ 
class provisionConfig_drushrc extends provisionConfig {
  public $template = 'provision_drushrc.tpl.php';
  public $description = 'Drush configuration file';
  protected $mode = 0400;
  protected $context_name = 'drush';

  function filename() {
    return _drush_config_file($this->context_name);
  }

251 252
  function __construct($owner, $data = array()) {
    parent::__construct($owner, $data);
253 254
    $this->load_data();
  }
255

256
  function load_data() {
257 258 259 260 261 262 263 264 265 266 267
    // we fetch the context to pass into the template based on the context name
    $this->data = array_merge(drush_get_context($this->context_name), $this->data);
  }

  function process() {
    unset($this->data['context-path']);
    unset($this->data['config-file']);
    $this->data['option_keys'] = array_keys($this->data);
  }
}

268 269 270
/**
 * Class to write an alias records.
 */
271
class provisionConfig_drushrc_alias extends provisionConfig_drushrc {
drumm's avatar
drumm committed
272 273
  public $template = 'provision_drushrc_alias.tpl.php';

274
  /**
drumm's avatar
drumm committed
275 276 277 278
   * @param $name
   *   String '\@name' for named context.
   * @param $options
   *   Array of string option names to save.
279
   */
280 281
  function __construct($owner, $data = array()) {
    parent::__construct($owner, $data);
drumm's avatar
drumm committed
282
    $this->data = array(
283
      'aliasname' => ltrim($owner, '@'),
284
      'options' => $data,
drumm's avatar
drumm committed
285
    );
286 287 288
  }

  function filename() {
drumm's avatar
drumm committed
289
    return drush_server_home() . '/.drush/' . $this->data['aliasname'] . '.alias.drushrc.php'; 
290 291 292
  }
}

293 294 295 296 297 298 299 300
/**
 * Server level config for drushrc.php files.
 */
class provisionConfig_drushrc_server extends provisionConfig_drushrc {
  protected $context_name = 'user';
  public $description = 'Server drush configuration';
}

301 302 303 304 305 306
/**
 * Class for writing $platform/drushrc.php files.
 */
class provisionConfig_drushrc_platform extends provisionConfig_drushrc {
  protected $context_name = 'drupal';
  public $description = 'Platform Drush configuration file';
307 308 309 310

  function filename() {
    return $this->root . '/drushrc.php';
  }
311 312 313 314 315 316 317 318 319
}

/**
 * Class for writing $platform/sites/$url/drushrc.php files.
 */
class provisionConfig_drushrc_site extends provisionConfig_drushrc {
  protected $context_name = 'site';
  public $template = 'provision_drushrc_site.tpl.php';
  public $description = 'Site Drush configuration file';
320 321 322 323

  function filename() {
    return $this->site_path . '/drushrc.php';
  }
324 325
}

Adrian Rossouw's avatar
Adrian Rossouw committed
326 327 328 329 330 331 332 333 334

class provisionConfig_data_store extends provisionConfig {
  public $template = 'data_store.tpl.php';
  public $key = 'record';

  private $locked = FALSE;
  protected $fp = null;

  public $records = array();
335
  public $loaded_records = array();
Adrian Rossouw's avatar
Adrian Rossouw committed
336

337
  protected $mode = 0700;
Adrian Rossouw's avatar
Adrian Rossouw committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351


  function __construct($owner, $data = array()) {
    parent::__construct($owner, $data);

    $this->load_data();
  }

  function __destruct() {
    // release the file lock if we have it.
    $this->close();
  }

  function open() {
352 353
    if (!is_resource($this->fp)) {
      $this->fp = fopen($this->filename(), "w+");
Adrian Rossouw's avatar
Adrian Rossouw committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
    }
  }

  function lock() {
    if (!$this->locked) {
      $this->open();
      flock($this->fp, LOCK_EX);

      // Do one last load before setting our locked status.
      $this->load_data();
      $this->locked = TRUE;
    }
  }

  function file_put_contents($filename, $text) {
    $this->lock();
    fwrite($this->fp, $text);
    fflush($this->fp);
  }

  function unlock() {
375
    if ($this->locked && is_resource($this->fp)) {
Adrian Rossouw's avatar
Adrian Rossouw committed
376 377 378 379 380 381
      flock($this->fp, LOCK_UN);
      $this->locked = FALSE;
    }
  }

  function close() {
382
    if (is_resource($this->fp)) {
Adrian Rossouw's avatar
Adrian Rossouw committed
383 384 385 386 387 388 389 390 391 392
      fclose($this->fp);
    }
  }

  function load_data() {
    if (!$this->locked) {
      // Once we have the lock we dont need to worry about it changing
      // from under us.
      if (file_exists($this->filename()) && is_readable($this->filename())) {
        include($this->filename());
393 394 395 396
        $data_key = $this->key;
        if (isset(${$data_key}) && is_array(${$data_key})) {
          $this->loaded_records = ${$data_key};
        }
Adrian Rossouw's avatar
Adrian Rossouw committed
397 398 399 400 401
      }
    }
  }

  function process() {
402
    $this->data['records'] = array_filter(array_merge($this->loaded_records, $this->records));
Adrian Rossouw's avatar
Adrian Rossouw committed
403 404
  }
}