stream_wrappers.inc 22.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<?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
15
 * delimiter is in general just ":", not "://".  Because of this PHP limitation
16 17
 * and for consistency Drupal will only accept URIs of form "scheme://target".
 *
18 19
 * @see http://www.faqs.org/rfcs/rfc3986.html
 * @see http://bugs.php.net/bug.php?id=47070
20 21
 */

22 23
/**
 * Stream wrapper bit flags that are the basis for composite types.
24 25 26
 *
 * Note that 0x0002 is skipped, because it was the value of a constant that has
 * since been removed.
27 28 29 30 31
 */

/**
 * Stream wrapper bit flag -- a filter that matches all wrappers.
 */
32
define('STREAM_WRAPPERS_ALL', 0x0000);
33 34 35 36

/**
 * Stream wrapper bit flag -- refers to a local file system location.
 */
37
define('STREAM_WRAPPERS_LOCAL', 0x0001);
38 39 40 41

/**
 * Stream wrapper bit flag -- wrapper is readable (almost always true).
 */
42
define('STREAM_WRAPPERS_READ', 0x0004);
43 44 45 46

/**
 * Stream wrapper bit flag -- wrapper is writeable.
 */
47
define('STREAM_WRAPPERS_WRITE', 0x0008);
48 49 50 51

/**
 * Stream wrapper bit flag -- exposed in the UI and potentially web accessible.
 */
52
define('STREAM_WRAPPERS_VISIBLE', 0x0010);
53 54 55 56 57 58 59 60 61

/**
 * 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.
 */
62
define('STREAM_WRAPPERS_HIDDEN', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE);
63

64 65 66 67 68
/**
 * Stream wrapper type flag -- hidden, readable and writeable using local files.
 */
define('STREAM_WRAPPERS_LOCAL_HIDDEN', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_HIDDEN);

69 70 71
/**
 * Stream wrapper type flag -- visible, readable and writeable.
 */
72
define('STREAM_WRAPPERS_WRITE_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE | STREAM_WRAPPERS_VISIBLE);
73 74 75 76

/**
 * Stream wrapper type flag -- visible and read-only.
 */
77
define('STREAM_WRAPPERS_READ_VISIBLE', STREAM_WRAPPERS_READ | STREAM_WRAPPERS_VISIBLE);
78

79 80 81 82 83 84 85 86 87
/**
 * 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);

88 89 90
/**
 * Stream wrapper type flag -- visible, readable and writeable using local files.
 */
91
define('STREAM_WRAPPERS_LOCAL_NORMAL', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_NORMAL);
92

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/**
 * 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.
169
   *
170 171 172 173 174 175 176 177 178 179 180 181 182 183
   * @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.
184
   *
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
   * @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();
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

  /**
   * 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);
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
}


/**
 * 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.
260
   * @TODO: Review this method name in D8 per http://drupal.org/node/701358
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
   *
   * @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;
  }

281
  /**
282 283 284 285 286 287 288 289 290 291 292 293 294 295
   * 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.
296
   */
297
  protected function getTarget($uri = NULL) {
298 299 300 301 302 303 304 305 306 307
    if (!isset($uri)) {
      $uri = $this->uri;
    }

    list($scheme, $target) = explode('://', $uri, 2);

    // Remove erroneous leading or trailing, forward-slashes and backslashes.
    return trim($target, '\/');
  }

308 309 310 311 312
  /**
   * Base implementation of getMimeType().
   */
  static function getMimeType($uri, $mapping = NULL) {
    if (!isset($mapping)) {
313 314 315 316
      // The default file map, defined in file.mimetypes.inc is quite big.
      // We only load it when necessary.
      include_once DRUPAL_ROOT . '/includes/file.mimetypes.inc';
      $mapping = file_mimetype_mapping();
317 318 319
    }

    $extension = '';
320
    $file_parts = explode('.', drupal_basename($uri));
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

    // 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) {
344 345 346 347 348
    $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;
349 350 351
  }

  /**
352
   * Base implementation of realpath().
353 354
   */
  function realpath() {
355
    return $this->getLocalPath();
356 357 358
  }

  /**
359
   * Returns the canonical absolute path of the URI, if possible.
360
   *
361 362 363 364 365 366 367 368 369 370
   * @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.
371 372 373 374 375
   */
  protected function getLocalPath($uri = NULL) {
    if (!isset($uri)) {
      $uri = $this->uri;
    }
376
    $path = $this->getDirectoryPath() . '/' . $this->getTarget($uri);
377 378 379
    $realpath = realpath($path);
    if (!$realpath) {
      // This file does not yet exist.
380
      $realpath = realpath(dirname($path)) . '/' . drupal_basename($path);
381 382 383 384 385 386
    }
    $directory = realpath($this->getDirectoryPath());
    if (!$realpath || !$directory || strpos($realpath, $directory) !== 0) {
      return FALSE;
    }
    return $realpath;
387 388 389 390 391 392
  }

  /**
   * Support for fopen(), file_get_contents(), file_put_contents() etc.
   *
   * @param $uri
393
   *   A string containing the URI to the file to open.
394 395 396 397
   * @param $mode
   *   The file mode ("r", "wb" etc.).
   * @param $options
   *   A bit mask of STREAM_USE_PATH and STREAM_REPORT_ERRORS.
398
   * @param $opened_path
399
   *   A string containing the path actually opened.
400
   *
401 402
   * @return
   *   Returns TRUE if file was opened successfully.
403
   *
404 405 406 407 408 409 410
   * @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);

411
    if ((bool) $this->handle && $options & STREAM_USE_PATH) {
412
      $opened_path = $path;
413 414
    }

415
    return (bool) $this->handle;
416 417 418 419 420 421 422 423 424 425 426 427
  }

  /**
   * 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).
428
   *
429 430
   * @return
   *   Always returns TRUE at the present time.
431
   *
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
   * @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.
447
   *
448 449
   * @return
   *   The string that was read, or FALSE in case of an error.
450
   *
451 452 453 454 455 456 457 458 459 460 461
   * @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.
462
   *
463 464
   * @return
   *   The number of bytes written (integer).
465
   *
466 467 468 469 470 471 472 473 474 475 476
   * @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.
477
   *
478 479 480 481 482 483 484 485 486 487 488 489 490
   * @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.
491
   *
492 493
   * @return
   *   TRUE on success.
494
   *
495 496 497
   * @see http://php.net/manual/en/streamwrapper.stream-seek.php
   */
  public function stream_seek($offset, $whence) {
498 499 500
    // 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);
501 502 503 504 505 506 507
  }

  /**
   * Support for fflush().
   *
   * @return
   *   TRUE if data was successfully stored (or there was no data to store).
508
   *
509 510 511 512 513 514 515 516 517 518 519
   * @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.
520
   *
521 522 523 524 525 526 527 528 529 530 531 532
   * @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.
533
   *
534 535 536 537 538 539 540 541 542 543 544
   * @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.
545
   *
546 547 548 549 550 551 552 553 554 555
   * @see http://php.net/manual/en/streamwrapper.stream-close.php
   */
  public function stream_close() {
    return fclose($this->handle);
  }

  /**
   * Support for unlink().
   *
   * @param $uri
556
   *   A string containing the URI to the resource to delete.
557
   *
558 559
   * @return
   *   TRUE if resource was successfully deleted.
560
   *
561 562 563 564
   * @see http://php.net/manual/en/streamwrapper.unlink.php
   */
  public function unlink($uri) {
    $this->uri = $uri;
565
    return drupal_unlink($this->getLocalPath());
566 567 568 569 570 571
  }

  /**
   * Support for rename().
   *
   * @param $from_uri,
572
   *   The URI to the file to rename.
573
   * @param $to_uri
574
   *   The new URI for file.
575
   *
576 577
   * @return
   *   TRUE if file was successfully renamed.
578
   *
579 580 581 582 583 584
   * @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));
  }

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
  /**
   * 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;
  }

612 613 614 615
  /**
   * Support for mkdir().
   *
   * @param $uri
616
   *   A string containing the URI to the directory to create.
617 618 619 620
   * @param $mode
   *   Permission flags - see mkdir().
   * @param $options
   *   A bit mask of STREAM_REPORT_ERRORS and STREAM_MKDIR_RECURSIVE.
621
   *
622 623
   * @return
   *   TRUE if directory was successfully created.
624
   *
625 626 627 628
   * @see http://php.net/manual/en/streamwrapper.mkdir.php
   */
  public function mkdir($uri, $mode, $options) {
    $this->uri = $uri;
629
    $recursive = (bool) ($options & STREAM_MKDIR_RECURSIVE);
630 631 632
    if ($recursive) {
      // $this->getLocalPath() fails if $uri has multiple levels of directories
      // that do not yet exist.
633
      $localpath = $this->getDirectoryPath() . '/' . $this->getTarget($uri);
634 635 636 637
    }
    else {
      $localpath = $this->getLocalPath($uri);
    }
638
    if ($options & STREAM_REPORT_ERRORS) {
639
      return mkdir($localpath, $mode, $recursive);
640 641
    }
    else {
642
      return @mkdir($localpath, $mode, $recursive);
643 644 645 646 647 648 649
    }
  }

  /**
   * Support for rmdir().
   *
   * @param $uri
650
   *   A string containing the URI to the directory to delete.
651 652
   * @param $options
   *   A bit mask of STREAM_REPORT_ERRORS.
653
   *
654 655
   * @return
   *   TRUE if directory was successfully removed.
656
   *
657 658 659 660 661
   * @see http://php.net/manual/en/streamwrapper.rmdir.php
   */
  public function rmdir($uri, $options) {
    $this->uri = $uri;
    if ($options & STREAM_REPORT_ERRORS) {
662
      return drupal_rmdir($this->getLocalPath());
663 664
    }
    else {
665
      return @drupal_rmdir($this->getLocalPath());
666 667 668 669 670 671 672
    }
  }

  /**
   * Support for stat().
   *
   * @param $uri
673
   *   A string containing the URI to get information about.
674 675
   * @param $flags
   *   A bit mask of STREAM_URL_STAT_LINK and STREAM_URL_STAT_QUIET.
676
   *
677 678 679
   * @return
   *   An array with file status, or FALSE in case of an error - see fstat()
   *   for a description of this array.
680
   *
681 682 683 684
   * @see http://php.net/manual/en/streamwrapper.url-stat.php
   */
  public function url_stat($uri, $flags) {
    $this->uri = $uri;
685 686 687 688 689
    $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);
690 691
    }
    else {
692
      return stat($path);
693 694 695 696 697 698 699
    }
  }

  /**
   * Support for opendir().
   *
   * @param $uri
700
   *   A string containing the URI to the directory to open.
701 702
   * @param $options
   *   Unknown (parameter is not documented in PHP Manual).
703
   *
704 705
   * @return
   *   TRUE on success.
706
   *
707 708 709 710 711 712
   * @see http://php.net/manual/en/streamwrapper.dir-opendir.php
   */
  public function dir_opendir($uri, $options) {
    $this->uri = $uri;
    $this->handle = opendir($this->getLocalPath());

713
    return (bool) $this->handle;
714 715 716 717 718 719 720
  }

  /**
   * Support for readdir().
   *
   * @return
   *   The next filename, or FALSE if there are no more files in the directory.
721
   *
722 723 724 725 726 727 728 729 730 731 732
   * @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.
733
   *
734 735 736
   * @see http://php.net/manual/en/streamwrapper.dir-rewinddir.php
   */
  public function dir_rewinddir() {
737 738 739 740 741
    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;
742 743 744 745 746 747 748
  }

  /**
   * Support for closedir().
   *
   * @return
   *   TRUE on success.
749
   *
750 751 752
   * @see http://php.net/manual/en/streamwrapper.dir-closedir.php
   */
  public function dir_closedir() {
753 754 755 756
    closedir($this->handle);
    // We do not really have a way to signal a failure as closedir() does not
    // have a return value.
    return TRUE;
757 758 759 760 761 762 763 764 765 766 767 768 769 770
  }
}

/**
 * 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() {
771
    return variable_get('file_public_path', conf_path() . '/files');
772 773 774 775 776 777 778 779
  }

  /**
   * Overrides getExternalUrl().
   *
   * Return the HTML URI of a public file.
   */
  function getExternalUrl() {
780
    $path = str_replace('\\', '/', $this->getTarget());
781
    return $GLOBALS['base_url'] . '/' . self::getDirectoryPath() . '/' . drupal_encode_path($path);
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
  }
}


/**
 * 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() {
799
    return variable_get('file_private_path', '');
800 801 802 803 804 805 806 807
  }

  /**
   * Overrides getExternalUrl().
   *
   * Return the HTML URI of a private file.
   */
  function getExternalUrl() {
808
    $path = str_replace('\\', '/', $this->getTarget());
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
    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() {
826
    return variable_get('file_temporary_path', file_directory_temp());
827 828 829 830 831 832
  }

  /**
   * Overrides getExternalUrl().
   */
  public function getExternalUrl() {
833
    $path = str_replace('\\', '/', $this->getTarget());
834
    return url('system/temporary/' . $path, array('absolute' => TRUE));
835 836
  }
}