diff --git a/core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php b/core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php new file mode 100644 index 0000000000000000000000000000000000000000..4cf41e08730afb3f423b712f05183b4b8ad926e2 --- /dev/null +++ b/core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php @@ -0,0 +1,35 @@ +<?php + +/** + * @file + * Definition of Drupal\Core\StreamWrapper\PhpStreamWrapperInterface. + */ + +namespace Drupal\Core\StreamWrapper; + +/** + * Defines a generic PHP stream wrapper interface. + * + * @see http://www.php.net/manual/en/class.streamwrapper.php + */ +interface PhpStreamWrapperInterface { + 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(); +} diff --git a/core/lib/Drupal/Core/StreamWrapper/PrivateStream.php b/core/lib/Drupal/Core/StreamWrapper/PrivateStream.php new file mode 100644 index 0000000000000000000000000000000000000000..87316eb4f5f9784c9c05562a140c929a3cacf0b5 --- /dev/null +++ b/core/lib/Drupal/Core/StreamWrapper/PrivateStream.php @@ -0,0 +1,35 @@ +<?php + +/** + * @file + * Definition of Drupal\Core\StreamWrapper\PrivateStream. + */ + +namespace Drupal\Core\StreamWrapper; + +/** + * Drupal private (private://) stream wrapper class. + * + * Provides support for storing privately accessible files with the Drupal file + * interface. + */ +class PrivateStream extends LocalStream { + + /** + * Implements Drupal\Core\StreamWrapper\LocalStream::getDirectoryPath() + */ + public function getDirectoryPath() { + return variable_get('file_private_path', ''); + } + + /** + * Implements Drupal\Core\StreamWrapper\StreamWrapperInterface::getExternalUrl(). + * + * @return string + * Returns the HTML URI of a private file. + */ + function getExternalUrl() { + $path = str_replace('\\', '/', $this->getTarget()); + return url('system/files/' . $path, array('absolute' => TRUE)); + } +} diff --git a/core/lib/Drupal/Core/StreamWrapper/PublicStream.php b/core/lib/Drupal/Core/StreamWrapper/PublicStream.php new file mode 100644 index 0000000000000000000000000000000000000000..207b77a5b651eb16be752c917aa16333e94d9626 --- /dev/null +++ b/core/lib/Drupal/Core/StreamWrapper/PublicStream.php @@ -0,0 +1,35 @@ +<?php + +/** + * @file + * Definition of Drupal\Core\StreamWrapper\PublicStream. + */ + +namespace Drupal\Core\StreamWrapper; + +/** + * Defines a Drupal public (public://) stream wrapper class. + * + * Provides support for storing publicly accessible files with the Drupal file + * interface. + */ +class PublicStream extends LocalStream { + + /** + * Implements Drupal\Core\StreamWrapper\LocalStream::getDirectoryPath() + */ + public function getDirectoryPath() { + return variable_get('file_public_path', conf_path() . '/files'); + } + + /** + * Implements Drupal\Core\StreamWrapper\StreamWrapperInterface::getExternalUrl(). + * + * @return string + * Returns the HTML URI of a public file. + */ + function getExternalUrl() { + $path = str_replace('\\', '/', $this->getTarget()); + return $GLOBALS['base_url'] . '/' . self::getDirectoryPath() . '/' . drupal_encode_path($path); + } +} diff --git a/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php b/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php new file mode 100644 index 0000000000000000000000000000000000000000..15ba2cf1b0744a7289fd561121ef3e298efbd639 --- /dev/null +++ b/core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php @@ -0,0 +1,125 @@ +<?php + +/** + * @file + * Definition of Drupal\Core\StreamWrapper\StreamWrapperInterface. + * + * 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 + */ + +namespace Drupal\Core\StreamWrapper; + +/** + * Defines a Drupal stream wrapper extension. + * + * Extends the StreamWrapperInterface with methods expected by Drupal stream + * wrapper classes. + */ +interface StreamWrapperInterface extends PhpStreamWrapperInterface { + + /** + * Sets the absolute stream resource URI. + * + * This allows you to set the URI. Generally is only called by the factory + * method. + * + * @param string $uri + * A string containing the URI that should be used for this instance. + */ + function setUri($uri); + + /** + * Returns the stream resource URI. + * + * @return string + * 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 string + * Returns a string containing a web accessible URL for the resource. + */ + public function getExternalUrl(); + + /** + * Returns the MIME type of the resource. + * + * @param string $uri + * The URI, path, or filename. + * @param array $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 string + * 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 int $mode + * Integer value for the permissions. Consult PHP chmod() documentation + * for more information. + * + * @return bool + * 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 string + * 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 string $uri + * An optional URI. + * + * @return string + * A string containing the directory name, or FALSE if not applicable. + * + * @see drupal_dirname() + */ + public function dirname($uri = NULL); +} diff --git a/core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php b/core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php new file mode 100644 index 0000000000000000000000000000000000000000..52a63212ffcfb42d040a26149ea84383b9f57fe5 --- /dev/null +++ b/core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php @@ -0,0 +1,32 @@ +<?php + +/** + * @file + * Definition of Drupal\Core\StreamWrapper\TemporaryStream. + */ + +namespace Drupal\Core\StreamWrapper; + +/** + * Defines a Drupal temporary (temporary://) stream wrapper class. + * + * Provides support for storing temporarily accessible files with the Drupal + * file interface. + */ +class TemporaryStream extends LocalStream { + + /** + * Implements Drupal\Core\StreamWrapper\LocalStream::getDirectoryPath() + */ + public function getDirectoryPath() { + return variable_get('file_temporary_path', file_directory_temp()); + } + + /** + * Implements Drupal\Core\StreamWrapper\StreamWrapperInterface::getExternalUrl(). + */ + public function getExternalUrl() { + $path = str_replace('\\', '/', $this->getTarget()); + return url('system/temporary/' . $path, array('absolute' => TRUE)); + } +}