From 53692e5ff6e29dfa2ba7dd7304705f4bb4bddbc4 Mon Sep 17 00:00:00 2001
From: webchick <webchick@24967.no-reply.drupal.org>
Date: Sat, 10 Mar 2012 12:20:23 -0800
Subject: [PATCH] BAH. I hate my life.
---
core/includes/file.inc | 84 +-
core/includes/stream_wrappers.inc | 836 ------------------
core/modules/simpletest/tests/file.test | 9 +-
.../modules/simpletest/tests/file_test.module | 6 +-
core/modules/system/system.api.php | 16 +-
core/modules/system/system.module | 6 +-
6 files changed, 95 insertions(+), 862 deletions(-)
delete mode 100644 core/includes/stream_wrappers.inc
diff --git a/core/includes/file.inc b/core/includes/file.inc
index 7ce02b69c076..2771f62cab9f 100644
--- a/core/includes/file.inc
+++ b/core/includes/file.inc
@@ -5,14 +5,78 @@
* API for handling file uploads and server file management.
*/
+use Drupal\Core\StreamWrapper\LocalStream;
+
/**
- * Manually include stream wrapper code.
+ * Stream wrapper bit flags that are the basis for composite types.
*
- * Stream wrapper code is included here because there are cases where
- * File API is needed before a bootstrap, or in an alternate order (e.g.
- * maintenance theme).
+ * Note that 0x0002 is skipped, because it was the value of a constant that has
+ * since been removed.
+ */
+
+/**
+ * Stream wrapper bit flag -- a filter that matches all wrappers.
+ */
+const STREAM_WRAPPERS_ALL = 0x0000;
+
+/**
+ * Stream wrapper bit flag -- refers to a local file system location.
+ */
+const STREAM_WRAPPERS_LOCAL = 0x0001;
+
+/**
+ * Stream wrapper bit flag -- wrapper is readable (almost always true).
+ */
+const STREAM_WRAPPERS_READ = 0x0004;
+
+/**
+ * Stream wrapper bit flag -- wrapper is writeable.
+ */
+const STREAM_WRAPPERS_WRITE = 0x0008;
+
+/**
+ * Stream wrapper bit flag -- exposed in the UI and potentially web accessible.
+ */
+const STREAM_WRAPPERS_VISIBLE = 0x0010;
+
+/**
+ * Composite stream wrapper bit flags that are usually used as the types.
+ */
+
+/**
+ * Stream wrapper type flag -- not visible in the UI or accessible via web,
+ * but readable and writable. E.g. the temporary directory for uploads.
+ */
+define('STREAM_WRAPPERS_HIDDEN', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE);
+
+/**
+ * Stream wrapper type flag -- hidden, readable and writeable using local files.
+ */
+define('STREAM_WRAPPERS_LOCAL_HIDDEN', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_HIDDEN);
+
+/**
+ * Stream wrapper type flag -- visible, readable and writeable.
+ */
+define('STREAM_WRAPPERS_WRITE_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE | STREAM_WRAPPERS_VISIBLE);
+
+/**
+ * Stream wrapper type flag -- visible and read-only.
+ */
+define('STREAM_WRAPPERS_READ_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_VISIBLE);
+
+/**
+ * Stream wrapper type flag -- the default when 'type' is omitted from
+ * hook_stream_wrappers(). This does not include STREAM_WRAPPERS_LOCAL,
+ * because PHP grants a greater trust level to local files (for example, they
+ * can be used in an "include" statement, regardless of the "allow_url_include"
+ * setting), so stream wrappers need to explicitly opt-in to this.
+ */
+define('STREAM_WRAPPERS_NORMAL', STREAM_WRAPPERS_WRITE_VISIBLE);
+
+/**
+ * Stream wrapper type flag -- visible, readable and writeable using local files.
*/
-require_once DRUPAL_ROOT . '/core/includes/stream_wrappers.inc';
+define('STREAM_WRAPPERS_LOCAL_NORMAL', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_NORMAL);
/**
* @defgroup file File interface
@@ -133,7 +197,7 @@ function file_get_stream_wrappers($filter = STREAM_WRAPPERS_ALL) {
$existing = stream_get_wrappers();
foreach ($wrappers as $scheme => $info) {
// We only register classes that implement our interface.
- if (in_array('DrupalStreamWrapperInterface', class_implements($info['class']), TRUE)) {
+ if (in_array('Drupal\Core\StreamWrapper\StreamWrapperInterface', class_implements($info['class']), TRUE)) {
// Record whether we are overriding an existing scheme.
if (in_array($scheme, $existing, TRUE)) {
$wrappers[$scheme]['override'] = TRUE;
@@ -302,7 +366,7 @@ function file_stream_wrapper_uri_normalize($uri) {
* Returns a new stream wrapper object appropriate for the given URI or FALSE
* if no registered handler could be found. For example, a URI of
* "private://example.txt" would return a new private stream wrapper object
- * (DrupalPrivateStreamWrapper).
+ * (Drupal\Core\StreamWrapper\PrivateStream).
*/
function file_stream_wrapper_get_instance_by_uri($uri) {
$scheme = file_uri_scheme($uri);
@@ -334,7 +398,7 @@ function file_stream_wrapper_get_instance_by_uri($uri) {
* @return
* Returns a new stream wrapper object appropriate for the given $scheme.
* For example, for the public scheme a stream wrapper object
- * (DrupalPublicStreamWrapper).
+ * (Drupal\Core\StreamWrapper\PublicStream).
* FALSE is returned if no registered handler could be found.
*/
function file_stream_wrapper_get_instance_by_scheme($scheme) {
@@ -2122,7 +2186,7 @@ function file_get_mimetype($uri, $mapping = NULL) {
else {
// getMimeType() is not implementation specific, so we can directly
// call it without an instance.
- return DrupalLocalStreamWrapper::getMimeType($uri, $mapping);
+ return LocalStream::getMimeType($uri, $mapping);
}
}
@@ -2235,7 +2299,7 @@ function drupal_unlink($uri, $context = NULL) {
*
* @todo This function is deprecated, and should be removed wherever possible.
*
- * @see DrupalStreamWrapperInterface::realpath()
+ * @see Drupal\Core\StreamWrapper\StreamWrapperInterface::realpath()
* @see http://php.net/manual/function.realpath.php
* @ingroup php_wrappers
*/
diff --git a/core/includes/stream_wrappers.inc b/core/includes/stream_wrappers.inc
deleted file mode 100644
index 0edcee13f8b0..000000000000
--- a/core/includes/stream_wrappers.inc
+++ /dev/null
@@ -1,836 +0,0 @@
-<?php
-
-/**
- * @file
- * Drupal stream wrapper interface.
- *
- * Provides a Drupal interface and classes to implement PHP stream wrappers for
- * public, private, and temporary files.
- *
- * A stream wrapper is an abstraction of a file system that allows Drupal to
- * use the same set of methods to access both local files and remote resources.
- *
- * Note that PHP 5.2 fopen() only supports URIs of the form "scheme://target"
- * despite the fact that according to RFC 3986 a URI's scheme component
- * delimiter is in general just ":", not "://". Because of this PHP limitation
- * and for consistency Drupal will only accept URIs of form "scheme://target".
- *
- * @see http://www.faqs.org/rfcs/rfc3986.html
- * @see http://bugs.php.net/bug.php?id=47070
- */
-
-/**
- * Stream wrapper bit flags that are the basis for composite types.
- *
- * Note that 0x0002 is skipped, because it was the value of a constant that has
- * since been removed.
- */
-
-/**
- * Stream wrapper bit flag -- a filter that matches all wrappers.
- */
-const STREAM_WRAPPERS_ALL = 0x0000;
-
-/**
- * Stream wrapper bit flag -- refers to a local file system location.
- */
-const STREAM_WRAPPERS_LOCAL = 0x0001;
-
-/**
- * Stream wrapper bit flag -- wrapper is readable (almost always true).
- */
-const STREAM_WRAPPERS_READ = 0x0004;
-
-/**
- * Stream wrapper bit flag -- wrapper is writeable.
- */
-const STREAM_WRAPPERS_WRITE = 0x0008;
-
-/**
- * Stream wrapper bit flag -- exposed in the UI and potentially web accessible.
- */
-const STREAM_WRAPPERS_VISIBLE = 0x0010;
-
-/**
- * Composite stream wrapper bit flags that are usually used as the types.
- */
-
-/**
- * Stream wrapper type flag -- not visible in the UI or accessible via web,
- * but readable and writable. E.g. the temporary directory for uploads.
- */
-define('STREAM_WRAPPERS_HIDDEN', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE);
-
-/**
- * Stream wrapper type flag -- hidden, readable and writeable using local files.
- */
-define('STREAM_WRAPPERS_LOCAL_HIDDEN', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_HIDDEN);
-
-/**
- * Stream wrapper type flag -- visible, readable and writeable.
- */
-define('STREAM_WRAPPERS_WRITE_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE | STREAM_WRAPPERS_VISIBLE);
-
-/**
- * Stream wrapper type flag -- visible and read-only.
- */
-define('STREAM_WRAPPERS_READ_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_VISIBLE);
-
-/**
- * Stream wrapper type flag -- the default when 'type' is omitted from
- * hook_stream_wrappers(). This does not include STREAM_WRAPPERS_LOCAL,
- * because PHP grants a greater trust level to local files (for example, they
- * can be used in an "include" statement, regardless of the "allow_url_include"
- * setting), so stream wrappers need to explicitly opt-in to this.
- */
-define('STREAM_WRAPPERS_NORMAL', STREAM_WRAPPERS_WRITE_VISIBLE);
-
-/**
- * Stream wrapper type flag -- visible, readable and writeable using local files.
- */
-define('STREAM_WRAPPERS_LOCAL_NORMAL', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_NORMAL);
-
-/**
- * Generic PHP stream wrapper interface.
- *
- * @see http://www.php.net/manual/en/class.streamwrapper.php
- */
-interface StreamWrapperInterface {
- public function stream_open($uri, $mode, $options, &$opened_url);
- public function stream_close();
- public function stream_lock($operation);
- public function stream_read($count);
- public function stream_write($data);
- public function stream_eof();
- public function stream_seek($offset, $whence);
- public function stream_flush();
- public function stream_tell();
- public function stream_stat();
- public function unlink($uri);
- public function rename($from_uri, $to_uri);
- public function mkdir($uri, $mode, $options);
- public function rmdir($uri, $options);
- public function url_stat($uri, $flags);
- public function dir_opendir($uri, $options);
- public function dir_readdir();
- public function dir_rewinddir();
- public function dir_closedir();
-}
-
-/**
- * Drupal stream wrapper extension.
- *
- * Extend the StreamWrapperInterface with methods expected by Drupal stream
- * wrapper classes.
- */
-interface DrupalStreamWrapperInterface extends StreamWrapperInterface {
- /**
- * Set the absolute stream resource URI.
- *
- * This allows you to set the URI. Generally is only called by the factory
- * method.
- *
- * @param $uri
- * A string containing the URI that should be used for this instance.
- */
- function setUri($uri);
-
- /**
- * Returns the stream resource URI.
- *
- * @return
- * Returns the current URI of the instance.
- */
- public function getUri();
-
- /**
- * Returns a web accessible URL for the resource.
- *
- * This function should return a URL that can be embedded in a web page
- * and accessed from a browser. For example, the external URL of
- * "youtube://xIpLd0WQKCY" might be
- * "http://www.youtube.com/watch?v=xIpLd0WQKCY".
- *
- * @return
- * Returns a string containing a web accessible URL for the resource.
- */
- public function getExternalUrl();
-
- /**
- * Returns the MIME type of the resource.
- *
- * @param $uri
- * The URI, path, or filename.
- * @param $mapping
- * An optional map of extensions to their mimetypes, in the form:
- * - 'mimetypes': a list of mimetypes, keyed by an identifier,
- * - 'extensions': the mapping itself, an associative array in which
- * the key is the extension and the value is the mimetype identifier.
- *
- * @return
- * Returns a string containing the MIME type of the resource.
- */
- public static function getMimeType($uri, $mapping = NULL);
-
- /**
- * Changes permissions of the resource.
- *
- * PHP lacks this functionality and it is not part of the official stream
- * wrapper interface. This is a custom implementation for Drupal.
- *
- * @param $mode
- * Integer value for the permissions. Consult PHP chmod() documentation
- * for more information.
- *
- * @return
- * Returns TRUE on success or FALSE on failure.
- */
- public function chmod($mode);
-
- /**
- * Returns canonical, absolute path of the resource.
- *
- * Implementation placeholder. PHP's realpath() does not support stream
- * wrappers. We provide this as a default so that individual wrappers may
- * implement their own solutions.
- *
- * @return
- * Returns a string with absolute pathname on success (implemented
- * by core wrappers), or FALSE on failure or if the registered
- * wrapper does not provide an implementation.
- */
- public function realpath();
-
- /**
- * Gets the name of the directory from a given path.
- *
- * This method is usually accessed through drupal_dirname(), which wraps
- * around the normal PHP dirname() function, which does not support stream
- * wrappers.
- *
- * @param $uri
- * An optional URI.
- *
- * @return
- * A string containing the directory name, or FALSE if not applicable.
- *
- * @see drupal_dirname()
- */
- public function dirname($uri = NULL);
-}
-
-
-/**
- * Drupal stream wrapper base class for local files.
- *
- * This class provides a complete stream wrapper implementation. URIs such as
- * "public://example.txt" are expanded to a normal filesystem path such as
- * "sites/default/files/example.txt" and then PHP filesystem functions are
- * invoked.
- *
- * DrupalLocalStreamWrapper implementations need to implement at least the
- * getDirectoryPath() and getExternalUrl() methods.
- */
-abstract class DrupalLocalStreamWrapper implements DrupalStreamWrapperInterface {
- /**
- * Stream context resource.
- *
- * @var Resource
- */
- public $context;
-
- /**
- * A generic resource handle.
- *
- * @var Resource
- */
- public $handle = NULL;
-
- /**
- * Instance URI (stream).
- *
- * A stream is referenced as "scheme://target".
- *
- * @var String
- */
- protected $uri;
-
- /**
- * Gets the path that the wrapper is responsible for.
- * @TODO: Review this method name in D8 per http://drupal.org/node/701358
- *
- * @return
- * String specifying the path.
- */
- abstract function getDirectoryPath();
-
- /**
- * Base implementation of setUri().
- */
- function setUri($uri) {
- $this->uri = $uri;
- }
-
- /**
- * Base implementation of getUri().
- */
- function getUri() {
- return $this->uri;
- }
-
- /**
- * Returns the local writable target of the resource within the stream.
- *
- * This function should be used in place of calls to realpath() or similar
- * functions when attempting to determine the location of a file. While
- * functions like realpath() may return the location of a read-only file, this
- * method may return a URI or path suitable for writing that is completely
- * separate from the URI used for reading.
- *
- * @param $uri
- * Optional URI.
- *
- * @return
- * Returns a string representing a location suitable for writing of a file,
- * or FALSE if unable to write to the file such as with read-only streams.
- */
- protected function getTarget($uri = NULL) {
- if (!isset($uri)) {
- $uri = $this->uri;
- }
-
- list($scheme, $target) = explode('://', $uri, 2);
-
- // Remove erroneous leading or trailing, forward-slashes and backslashes.
- return trim($target, '\/');
- }
-
- /**
- * Base implementation of getMimeType().
- */
- static function getMimeType($uri, $mapping = NULL) {
- if (!isset($mapping)) {
- // The default file map, defined in file.mimetypes.inc is quite big.
- // We only load it when necessary.
- include_once DRUPAL_ROOT . '/core/includes/file.mimetypes.inc';
- $mapping = file_mimetype_mapping();
- }
-
- $extension = '';
- $file_parts = explode('.', drupal_basename($uri));
-
- // Remove the first part: a full filename should not match an extension.
- array_shift($file_parts);
-
- // Iterate over the file parts, trying to find a match.
- // For my.awesome.image.jpeg, we try:
- // - jpeg
- // - image.jpeg, and
- // - awesome.image.jpeg
- while ($additional_part = array_pop($file_parts)) {
- $extension = strtolower($additional_part . ($extension ? '.' . $extension : ''));
- if (isset($mapping['extensions'][$extension])) {
- return $mapping['mimetypes'][$mapping['extensions'][$extension]];
- }
- }
-
- return 'application/octet-stream';
- }
-
- /**
- * Base implementation of chmod().
- */
- function chmod($mode) {
- $output = @chmod($this->getLocalPath(), $mode);
- // We are modifying the underlying file here, so we have to clear the stat
- // cache so that PHP understands that URI has changed too.
- clearstatcache();
- return $output;
- }
-
- /**
- * Base implementation of realpath().
- */
- function realpath() {
- return $this->getLocalPath();
- }
-
- /**
- * Returns the canonical absolute path of the URI, if possible.
- *
- * @param string $uri
- * (optional) The stream wrapper URI to be converted to a canonical
- * absolute path. This may point to a directory or another type of file.
- *
- * @return string|false
- * If $uri is not set, returns the canonical absolute path of the URI
- * previously set by the DrupalStreamWrapperInterface::setUri() function.
- * If $uri is set and valid for this class, returns its canonical absolute
- * path, as determined by the realpath() function. If $uri is set but not
- * valid, returns FALSE.
- */
- protected function getLocalPath($uri = NULL) {
- if (!isset($uri)) {
- $uri = $this->uri;
- }
- $path = $this->getDirectoryPath() . '/' . $this->getTarget($uri);
- $realpath = realpath($path);
- if (!$realpath) {
- // This file does not yet exist.
- $realpath = realpath(dirname($path)) . '/' . drupal_basename($path);
- }
- $directory = realpath($this->getDirectoryPath());
- if (!$realpath || !$directory || strpos($realpath, $directory) !== 0) {
- return FALSE;
- }
- return $realpath;
- }
-
- /**
- * Support for fopen(), file_get_contents(), file_put_contents() etc.
- *
- * @param $uri
- * A string containing the URI to the file to open.
- * @param $mode
- * The file mode ("r", "wb" etc.).
- * @param $options
- * A bit mask of STREAM_USE_PATH and STREAM_REPORT_ERRORS.
- * @param $opened_path
- * A string containing the path actually opened.
- *
- * @return
- * Returns TRUE if file was opened successfully.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-open.php
- */
- public function stream_open($uri, $mode, $options, &$opened_path) {
- $this->uri = $uri;
- $path = $this->getLocalPath();
- $this->handle = ($options & STREAM_REPORT_ERRORS) ? fopen($path, $mode) : @fopen($path, $mode);
-
- if ((bool) $this->handle && $options & STREAM_USE_PATH) {
- $opened_path = $path;
- }
-
- return (bool) $this->handle;
- }
-
- /**
- * Support for flock().
- *
- * @param $operation
- * One of the following:
- * - LOCK_SH to acquire a shared lock (reader).
- * - LOCK_EX to acquire an exclusive lock (writer).
- * - LOCK_UN to release a lock (shared or exclusive).
- * - LOCK_NB if you don't want flock() to block while locking (not
- * supported on Windows).
- *
- * @return
- * Always returns TRUE at the present time.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-lock.php
- */
- public function stream_lock($operation) {
- if (in_array($operation, array(LOCK_SH, LOCK_EX, LOCK_UN, LOCK_NB))) {
- return flock($this->handle, $operation);
- }
-
- return TRUE;
- }
-
- /**
- * Support for fread(), file_get_contents() etc.
- *
- * @param $count
- * Maximum number of bytes to be read.
- *
- * @return
- * The string that was read, or FALSE in case of an error.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-read.php
- */
- public function stream_read($count) {
- return fread($this->handle, $count);
- }
-
- /**
- * Support for fwrite(), file_put_contents() etc.
- *
- * @param $data
- * The string to be written.
- *
- * @return
- * The number of bytes written (integer).
- *
- * @see http://php.net/manual/en/streamwrapper.stream-write.php
- */
- public function stream_write($data) {
- return fwrite($this->handle, $data);
- }
-
- /**
- * Support for feof().
- *
- * @return
- * TRUE if end-of-file has been reached.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-eof.php
- */
- public function stream_eof() {
- return feof($this->handle);
- }
-
- /**
- * Support for fseek().
- *
- * @param $offset
- * The byte offset to got to.
- * @param $whence
- * SEEK_SET, SEEK_CUR, or SEEK_END.
- *
- * @return
- * TRUE on success.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-seek.php
- */
- public function stream_seek($offset, $whence) {
- // fseek returns 0 on success and -1 on a failure.
- // stream_seek 1 on success and 0 on a failure.
- return !fseek($this->handle, $offset, $whence);
- }
-
- /**
- * Support for fflush().
- *
- * @return
- * TRUE if data was successfully stored (or there was no data to store).
- *
- * @see http://php.net/manual/en/streamwrapper.stream-flush.php
- */
- public function stream_flush() {
- return fflush($this->handle);
- }
-
- /**
- * Support for ftell().
- *
- * @return
- * The current offset in bytes from the beginning of file.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-tell.php
- */
- public function stream_tell() {
- return ftell($this->handle);
- }
-
- /**
- * Support for fstat().
- *
- * @return
- * An array with file status, or FALSE in case of an error - see fstat()
- * for a description of this array.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-stat.php
- */
- public function stream_stat() {
- return fstat($this->handle);
- }
-
- /**
- * Support for fclose().
- *
- * @return
- * TRUE if stream was successfully closed.
- *
- * @see http://php.net/manual/en/streamwrapper.stream-close.php
- */
- public function stream_close() {
- return fclose($this->handle);
- }
-
- /**
- * Support for unlink().
- *
- * @param $uri
- * A string containing the uri to the resource to delete.
- *
- * @return
- * TRUE if resource was successfully deleted.
- *
- * @see http://php.net/manual/en/streamwrapper.unlink.php
- */
- public function unlink($uri) {
- $this->uri = $uri;
- return drupal_unlink($this->getLocalPath());
- }
-
- /**
- * Support for rename().
- *
- * @param $from_uri,
- * The uri to the file to rename.
- * @param $to_uri
- * The new uri for file.
- *
- * @return
- * TRUE if file was successfully renamed.
- *
- * @see http://php.net/manual/en/streamwrapper.rename.php
- */
- public function rename($from_uri, $to_uri) {
- return rename($this->getLocalPath($from_uri), $this->getLocalPath($to_uri));
- }
-
- /**
- * Gets the name of the directory from a given path.
- *
- * This method is usually accessed through drupal_dirname(), which wraps
- * around the PHP dirname() function because it does not support stream
- * wrappers.
- *
- * @param $uri
- * A URI or path.
- *
- * @return
- * A string containing the directory name.
- *
- * @see drupal_dirname()
- */
- public function dirname($uri = NULL) {
- list($scheme, $target) = explode('://', $uri, 2);
- $target = $this->getTarget($uri);
- $dirname = dirname($target);
-
- if ($dirname == '.') {
- $dirname = '';
- }
-
- return $scheme . '://' . $dirname;
- }
-
- /**
- * Support for mkdir().
- *
- * @param $uri
- * A string containing the URI to the directory to create.
- * @param $mode
- * Permission flags - see mkdir().
- * @param $options
- * A bit mask of STREAM_REPORT_ERRORS and STREAM_MKDIR_RECURSIVE.
- *
- * @return
- * TRUE if directory was successfully created.
- *
- * @see http://php.net/manual/en/streamwrapper.mkdir.php
- */
- public function mkdir($uri, $mode, $options) {
- $this->uri = $uri;
- $recursive = (bool) ($options & STREAM_MKDIR_RECURSIVE);
- if ($recursive) {
- // $this->getLocalPath() fails if $uri has multiple levels of directories
- // that do not yet exist.
- $localpath = $this->getDirectoryPath() . '/' . $this->getTarget($uri);
- }
- else {
- $localpath = $this->getLocalPath($uri);
- }
- if ($options & STREAM_REPORT_ERRORS) {
- return mkdir($localpath, $mode, $recursive);
- }
- else {
- return @mkdir($localpath, $mode, $recursive);
- }
- }
-
- /**
- * Support for rmdir().
- *
- * @param $uri
- * A string containing the URI to the directory to delete.
- * @param $options
- * A bit mask of STREAM_REPORT_ERRORS.
- *
- * @return
- * TRUE if directory was successfully removed.
- *
- * @see http://php.net/manual/en/streamwrapper.rmdir.php
- */
- public function rmdir($uri, $options) {
- $this->uri = $uri;
- if ($options & STREAM_REPORT_ERRORS) {
- return drupal_rmdir($this->getLocalPath());
- }
- else {
- return @drupal_rmdir($this->getLocalPath());
- }
- }
-
- /**
- * Support for stat().
- *
- * @param $uri
- * A string containing the URI to get information about.
- * @param $flags
- * A bit mask of STREAM_URL_STAT_LINK and STREAM_URL_STAT_QUIET.
- *
- * @return
- * An array with file status, or FALSE in case of an error - see fstat()
- * for a description of this array.
- *
- * @see http://php.net/manual/en/streamwrapper.url-stat.php
- */
- public function url_stat($uri, $flags) {
- $this->uri = $uri;
- $path = $this->getLocalPath();
- // Suppress warnings if requested or if the file or directory does not
- // exist. This is consistent with PHP's plain filesystem stream wrapper.
- if ($flags & STREAM_URL_STAT_QUIET || !file_exists($path)) {
- return @stat($path);
- }
- else {
- return stat($path);
- }
- }
-
- /**
- * Support for opendir().
- *
- * @param $uri
- * A string containing the URI to the directory to open.
- * @param $options
- * Unknown (parameter is not documented in PHP Manual).
- *
- * @return
- * TRUE on success.
- *
- * @see http://php.net/manual/en/streamwrapper.dir-opendir.php
- */
- public function dir_opendir($uri, $options) {
- $this->uri = $uri;
- $this->handle = opendir($this->getLocalPath());
-
- return (bool) $this->handle;
- }
-
- /**
- * Support for readdir().
- *
- * @return
- * The next filename, or FALSE if there are no more files in the directory.
- *
- * @see http://php.net/manual/en/streamwrapper.dir-readdir.php
- */
- public function dir_readdir() {
- return readdir($this->handle);
- }
-
- /**
- * Support for rewinddir().
- *
- * @return
- * TRUE on success.
- *
- * @see http://php.net/manual/en/streamwrapper.dir-rewinddir.php
- */
- public function dir_rewinddir() {
- rewinddir($this->handle);
- // We do not really have a way to signal a failure as rewinddir() does not
- // have a return value and there is no way to read a directory handler
- // without advancing to the next file.
- return TRUE;
- }
-
- /**
- * Support for closedir().
- *
- * @return
- * TRUE on success.
- *
- * @see http://php.net/manual/en/streamwrapper.dir-closedir.php
- */
- public function dir_closedir() {
- closedir($this->handle);
- // We do not really have a way to signal a failure as closedir() does not
- // have a return value.
- return TRUE;
- }
-}
-
-/**
- * Drupal public (public://) stream wrapper class.
- *
- * Provides support for storing publicly accessible files with the Drupal file
- * interface.
- */
-class DrupalPublicStreamWrapper extends DrupalLocalStreamWrapper {
- /**
- * Implements abstract public function getDirectoryPath()
- */
- public function getDirectoryPath() {
- return variable_get('file_public_path', conf_path() . '/files');
- }
-
- /**
- * Overrides getExternalUrl().
- *
- * Return the HTML URI of a public file.
- */
- function getExternalUrl() {
- $path = str_replace('\\', '/', $this->getTarget());
- return $GLOBALS['base_url'] . '/' . self::getDirectoryPath() . '/' . drupal_encode_path($path);
- }
-}
-
-
-/**
- * Drupal private (private://) stream wrapper class.
- *
- * Provides support for storing privately accessible files with the Drupal file
- * interface.
- *
- * Extends DrupalPublicStreamWrapper.
- */
-class DrupalPrivateStreamWrapper extends DrupalLocalStreamWrapper {
- /**
- * Implements abstract public function getDirectoryPath()
- */
- public function getDirectoryPath() {
- return variable_get('file_private_path', '');
- }
-
- /**
- * Overrides getExternalUrl().
- *
- * Return the HTML URI of a private file.
- */
- function getExternalUrl() {
- $path = str_replace('\\', '/', $this->getTarget());
- return url('system/files/' . $path, array('absolute' => TRUE));
- }
-}
-
-/**
- * Drupal temporary (temporary://) stream wrapper class.
- *
- * Provides support for storing temporarily accessible files with the Drupal
- * file interface.
- *
- * Extends DrupalPublicStreamWrapper.
- */
-class DrupalTemporaryStreamWrapper extends DrupalLocalStreamWrapper {
- /**
- * Implements abstract public function getDirectoryPath()
- */
- public function getDirectoryPath() {
- return variable_get('file_temporary_path', file_directory_temp());
- }
-
- /**
- * Overrides getExternalUrl().
- */
- public function getExternalUrl() {
- $path = str_replace('\\', '/', $this->getTarget());
- return url('system/temporary/' . $path, array('absolute' => TRUE));
- }
-}
diff --git a/core/modules/simpletest/tests/file.test b/core/modules/simpletest/tests/file.test
index a226b2ec2f8a..ecc04f8b4cd7 100644
--- a/core/modules/simpletest/tests/file.test
+++ b/core/modules/simpletest/tests/file.test
@@ -2714,7 +2714,7 @@ class StreamWrapperTest extends DrupalWebTestCase {
// Check the dummy scheme.
$this->assertEqual($this->classname, file_stream_wrapper_get_class($this->scheme), t('Got correct class name for dummy scheme.'));
// Check core's scheme.
- $this->assertEqual('DrupalPublicStreamWrapper', file_stream_wrapper_get_class('public'), t('Got correct class name for public scheme.'));
+ $this->assertEqual('Drupal\Core\StreamWrapper\PublicStream', file_stream_wrapper_get_class('public'), t('Got correct class name for public scheme.'));
}
/**
@@ -2725,7 +2725,7 @@ class StreamWrapperTest extends DrupalWebTestCase {
$this->assertEqual($this->classname, get_class($instance), t('Got correct class type for dummy scheme.'));
$instance = file_stream_wrapper_get_instance_by_scheme('public');
- $this->assertEqual('DrupalPublicStreamWrapper', get_class($instance), t('Got correct class type for public scheme.'));
+ $this->assertEqual('Drupal\Core\StreamWrapper\PublicStream', get_class($instance), t('Got correct class type for public scheme.'));
}
/**
@@ -2736,13 +2736,14 @@ class StreamWrapperTest extends DrupalWebTestCase {
$this->assertEqual($this->classname, get_class($instance), t('Got correct class type for dummy URI.'));
$instance = file_stream_wrapper_get_instance_by_uri('public://foo');
- $this->assertEqual('DrupalPublicStreamWrapper', get_class($instance), t('Got correct class type for public URI.'));
+ $this->assertEqual('Drupal\Core\StreamWrapper\PublicStream', get_class($instance), t('Got correct class type for public URI.'));
// Test file_uri_target().
$this->assertEqual(file_uri_target('public://foo/bar.txt'), 'foo/bar.txt', t('Got a valid stream target from public://foo/bar.txt.'));
$this->assertFalse(file_uri_target('foo/bar.txt'), t('foo/bar.txt is not a valid stream.'));
- // Test file_build_uri() and DrupalLocalStreamWrapper::getDirectoryPath().
+ // Test file_build_uri() and
+ // Drupal\Core\StreamWrapper\LocalStream::getDirectoryPath().
$this->assertEqual(file_build_uri('foo/bar.txt'), 'public://foo/bar.txt', t('Expected scheme was added.'));
$this->assertEqual(file_stream_wrapper_get_instance_by_scheme('public')->getDirectoryPath(), variable_get('file_public_path'), t('Expected default directory path was returned.'));
$this->assertEqual(file_stream_wrapper_get_instance_by_scheme('temporary')->getDirectoryPath(), variable_get('file_temporary_path'), t('Expected temporary directory path was returned.'));
diff --git a/core/modules/simpletest/tests/file_test.module b/core/modules/simpletest/tests/file_test.module
index 6fcda9570892..8a9a84a5e7c1 100644
--- a/core/modules/simpletest/tests/file_test.module
+++ b/core/modules/simpletest/tests/file_test.module
@@ -8,6 +8,8 @@
* calling file_test_get_calls() or file_test_set_return().
*/
+use Drupal\Core\StreamWrapper\LocalStream;
+use Drupal\Core\StreamWrapper\PublicStream;
const FILE_URL_TEST_CDN_1 = 'http://cdn1.example.com';
const FILE_URL_TEST_CDN_2 = 'http://cdn2.example.com';
@@ -423,7 +425,7 @@ function file_test_file_mimetype_mapping_alter(&$mapping) {
*
* Dummy stream wrapper implementation (dummy://).
*/
-class DrupalDummyStreamWrapper extends DrupalLocalStreamWrapper {
+class DrupalDummyStreamWrapper extends LocalStream {
function getDirectoryPath() {
return variable_get('stream_public_path', 'sites/default/files');
}
@@ -454,7 +456,7 @@ function getExternalUrl() {
*
* Basically just the public scheme but not returning a local file for realpath.
*/
-class DrupalDummyRemoteStreamWrapper extends DrupalPublicStreamWrapper {
+class DrupalDummyRemoteStreamWrapper extends PublicStream {
function realpath() {
return FALSE;
}
diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php
index 907b7b5f18a5..eac29fefcf2b 100644
--- a/core/modules/system/system.api.php
+++ b/core/modules/system/system.api.php
@@ -2207,11 +2207,11 @@ function hook_modules_uninstalled($modules) {
* then keyed by the following values:
* - 'name' A short string to name the wrapper.
* - 'class' A string specifying the PHP class that implements the
- * DrupalStreamWrapperInterface interface.
+ * Drupal\Core\StreamWrapper\StreamWrapperInterface interface.
* - 'description' A string with a short description of what the wrapper does.
* - 'type' (Optional) A bitmask of flags indicating what type of streams this
* wrapper will access - local or remote, readable and/or writeable, etc.
- * Many shortcut constants are defined in stream_wrappers.inc. Defaults to
+ * Many shortcut constants are defined in file.inc. Defaults to
* STREAM_WRAPPERS_NORMAL which includes all of these bit flags:
* - STREAM_WRAPPERS_READ
* - STREAM_WRAPPERS_WRITE
@@ -2225,31 +2225,33 @@ function hook_stream_wrappers() {
return array(
'public' => array(
'name' => t('Public files'),
- 'class' => 'DrupalPublicStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\PublicStream',
'description' => t('Public local files served by the webserver.'),
'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
),
'private' => array(
'name' => t('Private files'),
- 'class' => 'DrupalPrivateStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\PrivateStream',
'description' => t('Private local files served by Drupal.'),
'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
),
'temp' => array(
'name' => t('Temporary files'),
- 'class' => 'DrupalTempStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\TemporaryStream',
'description' => t('Temporary local files for upload and previews.'),
'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
),
'cdn' => array(
'name' => t('Content delivery network files'),
- 'class' => 'MyModuleCDNStreamWrapper',
+ // @todo: Fix the name of this class when we decide on module PSR-0 usage.
+ 'class' => 'MyModuleCDNStream',
'description' => t('Files served by a content delivery network.'),
// 'type' can be omitted to use the default of STREAM_WRAPPERS_NORMAL
),
'youtube' => array(
'name' => t('YouTube video'),
- 'class' => 'MyModuleYouTubeStreamWrapper',
+ // @todo: Fix the name of this class when we decide on module PSR-0 usage.
+ 'class' => 'MyModuleYouTubeStream',
'description' => t('Video streamed from YouTube.'),
// A module implementing YouTube integration may decide to support using
// the YouTube API for uploading video, but here, we assume that this
diff --git a/core/modules/system/system.module b/core/modules/system/system.module
index 72b1629bc8b7..14e73f5a45a4 100644
--- a/core/modules/system/system.module
+++ b/core/modules/system/system.module
@@ -1679,13 +1679,13 @@ function system_stream_wrappers() {
$wrappers = array(
'public' => array(
'name' => t('Public files'),
- 'class' => 'DrupalPublicStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\PublicStream',
'description' => t('Public local files served by the webserver.'),
'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
),
'temporary' => array(
'name' => t('Temporary files'),
- 'class' => 'DrupalTemporaryStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\TemporaryStream',
'description' => t('Temporary local files for upload and previews.'),
'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
),
@@ -1695,7 +1695,7 @@ function system_stream_wrappers() {
if (variable_get('file_private_path', FALSE)) {
$wrappers['private'] = array(
'name' => t('Private files'),
- 'class' => 'DrupalPrivateStreamWrapper',
+ 'class' => 'Drupal\Core\StreamWrapper\PrivateStream',
'description' => t('Private local files served by Drupal.'),
'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
);
--
GitLab