FileStorage.php 8.78 KB
Newer Older
1 2
<?php

3 4
/**
 * @file
5
 * Contains \Drupal\Core\Config\FileStorage.
6 7
 */

8 9
namespace Drupal\Core\Config;

10 11
use Drupal\Component\Serialization\Yaml;
use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
12

13
/**
14
 * Defines the file storage.
15
 */
16
class FileStorage implements StorageInterface {
17

18 19 20 21 22 23 24
  /**
   * The storage collection.
   *
   * @var string
   */
  protected $collection;

25
  /**
26
   * The filesystem path for configuration objects.
27
   *
28
   * @var string
29
   */
30
  protected $directory = '';
31 32

  /**
33
   * Constructs a new FileStorage.
34 35 36
   *
   * @param string $directory
   *   A directory path to use for reading and writing of configuration files.
37 38 39
   * @param string $collection
   *   (optional) The collection to store configuration in. Defaults to the
   *   default collection.
40
   */
41
  public function __construct($directory, $collection = StorageInterface::DEFAULT_COLLECTION) {
42
    $this->directory = $directory;
43
    $this->collection = $collection;
44 45 46
  }

  /**
47
   * Returns the path to the configuration file.
48
   *
49 50
   * @return string
   *   The path to the configuration file.
51
   */
52
  public function getFilePath($name) {
53
    return $this->getCollectionDirectory() . '/' . $name . '.' . static::getFileExtension();
54 55 56 57 58 59 60 61 62 63
  }

  /**
   * Returns the file extension used by the file storage for all configuration files.
   *
   * @return string
   *   The file extension.
   */
  public static function getFileExtension() {
    return 'yml';
64 65
  }

66 67 68 69
  /**
   * Check if the directory exists and create it if not.
   */
  protected function ensureStorage() {
70 71 72 73 74 75
    $dir = $this->getCollectionDirectory();
    $success = file_prepare_directory($dir, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
    // Only create .htaccess file in root directory.
    if ($dir == $this->directory) {
      $success = $success && file_save_htaccess($this->directory, TRUE, TRUE);
    }
76
    if (!$success) {
77
      throw new StorageException('Failed to create config directory ' . $dir);
78 79 80 81
    }
    return $this;
  }

82
  /**
83
   * {@inheritdoc}
84
   */
85 86
  public function exists($name) {
    return file_exists($this->getFilePath($name));
87 88 89
  }

  /**
90
   * Implements Drupal\Core\Config\StorageInterface::read().
91
   *
92
   * @throws \Drupal\Core\Config\UnsupportedDataTypeConfigException
93
   */
94 95
  public function read($name) {
    if (!$this->exists($name)) {
96
      return FALSE;
97
    }
98 99
    $filepath = $this->getFilePath($name);
    $data = file_get_contents($filepath);
100 101 102 103
    try {
      $data = $this->decode($data);
    }
    catch (InvalidDataTypeException $e) {
104
      throw new UnsupportedDataTypeConfigException('Invalid data type in config ' . $name . ', found in file' . $filepath . ' : ' . $e->getMessage());
105
    }
106
    return $data;
107 108
  }

109 110 111 112 113 114 115 116 117 118 119 120 121
  /**
   * {@inheritdoc}
   */
  public function readMultiple(array $names) {
    $list = array();
    foreach ($names as $name) {
      if ($data = $this->read($name)) {
        $list[$name] = $data;
      }
    }
    return $list;
  }

122
  /**
123
   * {@inheritdoc}
124
   */
125
  public function write($name, array $data) {
126 127 128
    try {
      $data = $this->encode($data);
    }
129
    catch (InvalidDataTypeException $e) {
130
      throw new StorageException("Invalid data type in config $name: {$e->getMessage()}");
131 132
    }

133 134
    $target = $this->getFilePath($name);
    $status = @file_put_contents($target, $data);
135
    if ($status === FALSE) {
136
      // Try to make sure the directory exists and try writing again.
137 138 139
      $this->ensureStorage();
      $status = @file_put_contents($target, $data);
    }
140 141
    if ($status === FALSE) {
      throw new StorageException('Failed to write configuration file: ' . $this->getFilePath($name));
142
    }
143 144 145
    else {
      drupal_chmod($target);
    }
146
    return TRUE;
147 148 149
  }

  /**
150
   * {@inheritdoc}
151
   */
152 153
  public function delete($name) {
    if (!$this->exists($name)) {
154 155 156
      $dir = $this->getCollectionDirectory();
      if (!file_exists($dir)) {
        throw new StorageException($dir . '/ not found.');
157 158 159 160
      }
      return FALSE;
    }
    return drupal_unlink($this->getFilePath($name));
161
  }
162

163
  /**
164
   * {@inheritdoc}
165 166 167 168 169 170 171 172 173
   */
  public function rename($name, $new_name) {
    $status = @rename($this->getFilePath($name), $this->getFilePath($new_name));
    if ($status === FALSE) {
      throw new StorageException('Failed to rename configuration file from: ' . $this->getFilePath($name) . ' to: ' . $this->getFilePath($new_name));
    }
    return TRUE;
  }

174
  /**
175
   * {@inheritdoc}
176
   */
177
  public function encode($data) {
178
    return Yaml::encode($data);
179 180 181
  }

  /**
182
   * {@inheritdoc}
183
   */
184
  public function decode($raw) {
185
    $data = Yaml::decode($raw);
186 187 188
    // A simple string is valid YAML for any reason.
    if (!is_array($data)) {
      return FALSE;
189
    }
190
    return $data;
191 192 193
  }

  /**
194
   * {@inheritdoc}
195
   */
196
  public function listAll($prefix = '') {
197
    $dir = $this->getCollectionDirectory();
198
    if (!is_dir($dir)) {
199
      return array();
200
    }
201
    $extension = '.' . static::getFileExtension();
202 203 204 205 206 207

    // glob() directly calls into libc glob(), which is not aware of PHP stream
    // wrappers. Same for \GlobIterator (which additionally requires an absolute
    // realpath() on Windows).
    // @see https://github.com/mikey179/vfsStream/issues/2
    $files = scandir($dir);
208 209 210

    $names = array();
    foreach ($files as $file) {
211 212 213
      if ($file[0] !== '.' && fnmatch($prefix . '*' . $extension, $file)) {
        $names[] = basename($file, $extension);
      }
214 215 216
    }

    return $names;
217
  }
218 219

  /**
220
   * {@inheritdoc}
221 222 223 224 225 226 227 228 229
   */
  public function deleteAll($prefix = '') {
    $success = TRUE;
    $files = $this->listAll($prefix);
    foreach ($files as $name) {
      if (!$this->delete($name) && $success) {
        $success = FALSE;
      }
    }
230 231 232 233 234 235
    if ($success && $this->collection != StorageInterface::DEFAULT_COLLECTION) {
      // Remove empty directories.
      if (!(new \FilesystemIterator($this->getCollectionDirectory()))->valid()) {
        drupal_rmdir($this->getCollectionDirectory());
      }
    }
236 237
    return $success;
  }
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306

  /**
   * {@inheritdoc}
   */
  public function createCollection($collection) {
    return new static(
      $this->directory,
      $collection
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getCollectionName() {
    return $this->collection;
  }

  /**
   * {@inheritdoc}
   */
  public function getAllCollectionNames() {
    $collections = $this->getAllCollectionNamesHelper($this->directory);
    sort($collections);
    return $collections;
  }

  /**
   * Helper function for getAllCollectionNames().
   *
   * If the file storage has the following subdirectory structure:
   *   ./another_collection/one
   *   ./another_collection/two
   *   ./collection/sub/one
   *   ./collection/sub/two
   * this function will return:
   * @code
   *   array(
   *     'another_collection.one',
   *     'another_collection.two',
   *     'collection.sub.one',
   *     'collection.sub.two',
   *   );
   * @endcode
   *
   * @param string $directory
   *   The directory to check for sub directories. This allows this
   *   function to be used recursively to discover all the collections in the
   *   storage.
   *
   * @return array
   *   A list of collection names contained within the provided directory.
   */
  protected function getAllCollectionNamesHelper($directory) {
    $collections = array();
    foreach (new \DirectoryIterator($directory) as $fileinfo) {
      if ($fileinfo->isDir() && !$fileinfo->isDot()) {
        $collection = $fileinfo->getFilename();
        // Recursively call getAllCollectionNamesHelper() to discover if there
        // are subdirectories. Subdirectories represent a dotted collection
        // name.
        $sub_collections = $this->getAllCollectionNamesHelper($directory . '/' . $collection);
        if (!empty($sub_collections)) {
          // Build up the collection name by concatenating the subdirectory
          // names with the current directory name.
          foreach ($sub_collections as $sub_collection) {
            $collections[] = $collection . '.' . $sub_collection;
          }
        }
307
        // Check that the collection is valid by searching it for configuration
308 309
        // objects. A directory without any configuration objects is not a valid
        // collection.
310 311 312 313 314 315
        // @see \Drupal\Core\Config\FileStorage::listAll()
        foreach (scandir($directory . '/' . $collection) as $file) {
          if ($file[0] !== '.' && fnmatch('*.' . $this->getFileExtension(), $file)) {
            $collections[] = $collection;
            break;
          }
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
        }
      }
    }
    return $collections;
  }

  /**
   * Gets the directory for the collection.
   *
   * @return string
   *   The directory for the collection.
   */
  protected function getCollectionDirectory() {
    if ($this->collection == StorageInterface::DEFAULT_COLLECTION) {
      $dir = $this->directory;
    }
    else {
      $dir = $this->directory . '/' . str_replace('.', '/', $this->collection);
    }
    return $dir;
  }

338
}