file.inc 56.6 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Kjartan's avatar
Kjartan committed
2

Dries's avatar
   
Dries committed
3
4
5
6
7
/**
 * @file
 * API for handling file uploads and server file management.
 */

8
9
use Drupal\Core\StreamWrapper\LocalStream;
use Drupal\Component\PhpStorage\MTimeProtectedFastFileStorage;
10
use Drupal\Component\Utility\String;
11
use Drupal\Core\StreamWrapper\PublicStream;
12

13
/**
webchick's avatar
webchick committed
14
 * Stream wrapper bit flags that are the basis for composite types.
15
 *
webchick's avatar
webchick committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 * 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;

45
46
47
48
49
50
51
52
53
54
55

/**
 * Default mode for new directories. See drupal_chmod().
 */
const FILE_CHMOD_DIRECTORY = 0775;

/**
 * Default mode for new files. See drupal_chmod().
 */
const FILE_CHMOD_FILE = 0664;

webchick's avatar
webchick committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/**
 * 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.
92
 */
webchick's avatar
webchick committed
93
define('STREAM_WRAPPERS_LOCAL_NORMAL', STREAM_WRAPPERS_LOCAL | STREAM_WRAPPERS_NORMAL);
94

Kjartan's avatar
Kjartan committed
95
/**
Kjartan's avatar
Kjartan committed
96
 * @defgroup file File interface
Kjartan's avatar
Kjartan committed
97
 * @{
Dries's avatar
   
Dries committed
98
 * Common file handling functions.
99
 *
100
 * Fields on the file entity:
101
102
103
 * - fid: File ID
 * - uid: The {users}.uid of the user who is associated with the file.
 * - filename: Name of the file with no path components. This may differ from
104
105
 *   the basename of the filepath if the file is renamed to avoid overwriting
 *   an existing file.
106
107
108
109
 * - uri: URI of the file.
 * - filemime: The file's MIME type.
 * - filesize: The size of the file in bytes.
 * - status: A bitmapped field indicating the status of the file. The first 8
110
 *   bits are reserved for Drupal core. The least significant bit indicates
111
112
 *   temporary (0) or permanent (1). Temporary files older than
 *   DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during cron runs.
113
 * - timestamp: UNIX timestamp for the date the file was added to the database.
Dries's avatar
 
Dries committed
114
115
 */

116
/**
117
 * Flag used by file_prepare_directory() -- create directory if not present.
118
 */
119
const FILE_CREATE_DIRECTORY = 1;
120
121

/**
122
 * Flag used by file_prepare_directory() -- file permissions may be changed.
123
 */
124
const FILE_MODIFY_PERMISSIONS = 2;
125
126

/**
127
 * Flag for dealing with existing files: Appends number until name is unique.
128
 */
129
const FILE_EXISTS_RENAME = 0;
130
131
132
133

/**
 * Flag for dealing with existing files: Replace the existing file.
 */
134
const FILE_EXISTS_REPLACE = 1;
135
136
137
138

/**
 * Flag for dealing with existing files: Do nothing and return FALSE.
 */
139
const FILE_EXISTS_ERROR = 2;
Dries's avatar
 
Dries committed
140

141
/**
142
143
144
145
146
 * Indicates that the file is permanent and should not be deleted.
 *
 * Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed
 * during cron runs, but permanent files will not be removed during the file
 * garbage collection process.
147
 */
148
const FILE_STATUS_PERMANENT = 1;
149

150
/**
151
 * Provides Drupal stream wrapper registry.
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 *
 * 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.
 *
 * Provide a facility for managing and querying user-defined stream wrappers
 * in PHP. PHP's internal stream_get_wrappers() doesn't return the class
 * registered to handle a stream, which we need to be able to find the handler
 * for class instantiation.
 *
 * If a module registers a scheme that is already registered with PHP, the
 * existing scheme will be unregistered and replaced with the specified class.
 *
 * A stream is referenced as "scheme://target".
 *
166
167
168
169
 * The optional $filter parameter can be used to retrieve only the stream
 * wrappers that are appropriate for particular usage. For example, this returns
 * only stream wrappers that use local file storage:
 * @code
170
 *   $local_stream_wrappers = file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL);
171
172
173
174
175
176
177
178
179
 * @endcode
 *
 * The $filter parameter can only filter to types containing a particular flag.
 * In some cases, you may want to filter to types that do not contain a
 * particular flag. For example, you may want to retrieve all stream wrappers
 * that are not writable, or all stream wrappers that are not local. PHP's
 * array_diff_key() function can be used to help with this. For example, this
 * returns only stream wrappers that do not use local file storage:
 * @code
180
 *   $remote_stream_wrappers = array_diff_key(file_get_stream_wrappers(STREAM_WRAPPERS_ALL), file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL));
181
182
 * @endcode
 *
183
 * @param $filter
184
185
186
187
188
189
 *   (Optional) Filters out all types except those with an on bit for each on
 *   bit in $filter. For example, if $filter is STREAM_WRAPPERS_WRITE_VISIBLE,
 *   which is equal to (STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE |
 *   STREAM_WRAPPERS_VISIBLE), then only stream wrappers with all three of these
 *   bits set are returned. Defaults to STREAM_WRAPPERS_ALL, which returns all
 *   registered stream wrappers.
190
 *
191
 * @return
192
193
194
195
196
 *   An array keyed by scheme, with values containing an array of information
 *   about the stream wrapper, as returned by hook_stream_wrappers(). If $filter
 *   is omitted or set to STREAM_WRAPPERS_ALL, the entire Drupal stream wrapper
 *   registry is returned. Otherwise only the stream wrappers whose 'type'
 *   bitmask has an on bit for each bit specified in $filter are returned.
197
 *
198
199
200
 * @see hook_stream_wrappers()
 * @see hook_stream_wrappers_alter()
 */
201
202
function file_get_stream_wrappers($filter = STREAM_WRAPPERS_ALL) {
  $wrappers_storage = &drupal_static(__FUNCTION__);
203

204
  if (!isset($wrappers_storage)) {
205
206
207
208
209
210
211
212
213
    $wrappers = array();
    $container = \Drupal::getContainer();
    if (is_object($container) && $container->has('module_handler')) {
      $wrappers = \Drupal::moduleHandler()->invokeAll('stream_wrappers');
      foreach ($wrappers as $scheme => $info) {
        // Add defaults.
        $wrappers[$scheme] += array('type' => STREAM_WRAPPERS_NORMAL);
      }
      \Drupal::moduleHandler()->alter('stream_wrappers', $wrappers);
214
    }
215
216
217
    $existing = stream_get_wrappers();
    foreach ($wrappers as $scheme => $info) {
      // We only register classes that implement our interface.
webchick's avatar
webchick committed
218
      if (in_array('Drupal\Core\StreamWrapper\StreamWrapperInterface', class_implements($info['class']), TRUE)) {
219
220
221
222
223
224
225
226
        // Record whether we are overriding an existing scheme.
        if (in_array($scheme, $existing, TRUE)) {
          $wrappers[$scheme]['override'] = TRUE;
          stream_wrapper_unregister($scheme);
        }
        else {
          $wrappers[$scheme]['override'] = FALSE;
        }
227
228
        if (($info['type'] & STREAM_WRAPPERS_LOCAL) == STREAM_WRAPPERS_LOCAL) {
          stream_wrapper_register($scheme, $info['class']);
229
230
        }
        else {
231
          stream_wrapper_register($scheme, $info['class'], STREAM_IS_URL);
232
        }
233
      }
234
235
236
237
238
      // Pre-populate the static cache with the filters most typically used.
      $wrappers_storage[STREAM_WRAPPERS_ALL][$scheme] = $wrappers[$scheme];
      if (($info['type'] & STREAM_WRAPPERS_WRITE_VISIBLE) == STREAM_WRAPPERS_WRITE_VISIBLE) {
        $wrappers_storage[STREAM_WRAPPERS_WRITE_VISIBLE][$scheme] = $wrappers[$scheme];
      }
239
240
    }
  }
241
242
243
244
245

  if (!isset($wrappers_storage[$filter])) {
    $wrappers_storage[$filter] = array();
    foreach ($wrappers_storage[STREAM_WRAPPERS_ALL] as $scheme => $info) {
      // Bit-wise filter.
246
      if (($info['type'] & $filter) == $filter) {
247
248
249
250
251
252
        $wrappers_storage[$filter][$scheme] = $info;
      }
    }
  }

  return $wrappers_storage[$filter];
253
254
255
256
257
258
259
}

/**
 * Returns the stream wrapper class name for a given scheme.
 *
 * @param $scheme
 *   Stream scheme.
260
 *
261
262
263
264
265
266
267
268
269
270
271
272
273
 * @return
 *   Return string if a scheme has a registered handler, or FALSE.
 */
function file_stream_wrapper_get_class($scheme) {
  $wrappers = file_get_stream_wrappers();
  return empty($wrappers[$scheme]) ? FALSE : $wrappers[$scheme]['class'];
}

/**
 * Returns the scheme of a URI (e.g. a stream).
 *
 * @param $uri
 *   A stream, referenced as "scheme://target".
274
 *
275
276
277
 * @return
 *   A string containing the name of the scheme, or FALSE if none. For example,
 *   the URI "public://example.txt" would return "public".
278
279
 *
 * @see file_uri_target()
280
281
 */
function file_uri_scheme($uri) {
282
283
  $position = strpos($uri, '://');
  return $position ? substr($uri, 0, $position) : FALSE;
284
285
286
}

/**
287
 * Checks that the scheme of a stream URI is valid.
288
289
290
291
292
293
294
 *
 * Confirms that there is a registered stream handler for the provided scheme
 * and that it is callable. This is useful if you want to confirm a valid
 * scheme without creating a new instance of the registered handler.
 *
 * @param $scheme
 *   A URI scheme, a stream is referenced as "scheme://target".
295
 *
296
297
298
299
300
 * @return
 *   Returns TRUE if the string is the name of a validated stream,
 *   or FALSE if the scheme does not have a registered handler.
 */
function file_stream_wrapper_valid_scheme($scheme) {
301
  return $scheme && class_exists(file_stream_wrapper_get_class($scheme));
302
303
}

304

305
/**
306
 * Returns the part of a URI after the schema.
307
308
309
 *
 * @param $uri
 *   A stream, referenced as "scheme://target".
310
 *
311
312
313
314
 * @return
 *   A string containing the target (path), or FALSE if none.
 *   For example, the URI "public://sample/test.txt" would return
 *   "sample/test.txt".
315
316
 *
 * @see file_uri_scheme()
317
318
 */
function file_uri_target($uri) {
319
320
321
322
  $data = explode('://', $uri, 2);

  // Remove erroneous leading or trailing, forward-slashes and backslashes.
  return count($data) == 2 ? trim($data[1], '\/') : FALSE;
323
324
}

325
/**
326
 * Gets the default file stream implementation.
327
328
329
330
331
 *
 * @return
 *   'public', 'private' or any other file scheme defined as the default.
 */
function file_default_scheme() {
332
  return \Drupal::config('system.file')->get('default_scheme');
333
334
}

335
336
337
338
339
340
341
342
343
344
345
/**
 * Normalizes a URI by making it syntactically correct.
 *
 * A stream is referenced as "scheme://target".
 *
 * The following actions are taken:
 * - Remove trailing slashes from target
 * - Trim erroneous leading slashes from target. e.g. ":///" becomes "://".
 *
 * @param $uri
 *   String reference containing the URI to normalize.
346
 *
347
348
 * @return
 *   The normalized URI.
349
350
351
352
 */
function file_stream_wrapper_uri_normalize($uri) {
  $scheme = file_uri_scheme($uri);

353
  if (file_stream_wrapper_valid_scheme($scheme)) {
354
355
    $target = file_uri_target($uri);

356
357
358
    if ($target !== FALSE) {
      $uri = $scheme . '://' . $target;
    }
359
  }
360

361
362
363
364
  return $uri;
}

/**
365
 * Returns a reference to the stream wrapper class responsible for a given URI.
366
367
368
369
370
371
 *
 * The scheme determines the stream wrapper class that should be
 * used by consulting the stream wrapper registry.
 *
 * @param $uri
 *   A stream, referenced as "scheme://target".
372
 *
373
374
375
376
 * @return
 *   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
webchick's avatar
webchick committed
377
 *   (Drupal\Core\StreamWrapper\PrivateStream).
378
379
 */
function file_stream_wrapper_get_instance_by_uri($uri) {
380
381
382
383
384
385
386
  if ($scheme = file_uri_scheme($uri)) {
    $class = file_stream_wrapper_get_class($scheme);
    if (class_exists($class)) {
      $instance = new $class();
      $instance->setUri($uri);
      return $instance;
    }
387
  }
388
  return FALSE;
389
390
391
}

/**
392
 * Returns a reference to the stream wrapper class responsible for a scheme.
393
394
395
396
397
398
399
400
401
402
403
 *
 * This helper method returns a stream instance using a scheme. That is, the
 * passed string does not contain a "://". For example, "public" is a scheme
 * but "public://" is a URI (stream). This is because the later contains both
 * a scheme and target despite target being empty.
 *
 * Note: the instance URI will be initialized to "scheme://" so that you can
 * make the customary method calls as if you had retrieved an instance by URI.
 *
 * @param $scheme
 *   If the stream was "public://target", "public" would be the scheme.
404
 *
405
 * @return \Drupal\Core\StreamWrapper\StreamWrapperInterface
406
407
 *   Returns a new stream wrapper object appropriate for the given $scheme.
 *   For example, for the public scheme a stream wrapper object
webchick's avatar
webchick committed
408
 *   (Drupal\Core\StreamWrapper\PublicStream).
409
410
411
412
413
 *   FALSE is returned if no registered handler could be found.
 */
function file_stream_wrapper_get_instance_by_scheme($scheme) {
  $class = file_stream_wrapper_get_class($scheme);
  if (class_exists($class)) {
414
    $instance = new $class();
415
416
417
418
419
420
421
422
    $instance->setUri($scheme . '://');
    return $instance;
  }
  else {
    return FALSE;
  }
}

Dries's avatar
 
Dries committed
423
/**
424
 * Creates a web-accessible URL for a stream to an external or local file.
Dries's avatar
   
Dries committed
425
 *
426
 * Compatibility: normal paths and stream wrappers.
Dries's avatar
   
Dries committed
427
 *
428
 * There are two kinds of local files:
429
430
431
 * - "managed files", i.e. those stored by a Drupal-compatible stream wrapper.
 *   These are files that have either been uploaded by users or were generated
 *   automatically (for example through CSS aggregation).
432
433
434
 * - "shipped files", i.e. those outside of the files directory, which ship as
 *   part of Drupal core or contributed modules or themes.
 *
435
 * @param $uri
436
437
 *   The URI to a file for which we need an external URL, or the path to a
 *   shipped file.
438
 *
439
 * @return
440
 *   A string containing a URL that may be used to access the file.
441
442
443
 *   If the provided string already contains a preceding 'http', 'https', or
 *   '/', nothing is done and the same string is returned. If a stream wrapper
 *   could not be found to generate an external URL, then FALSE is returned.
444
445
 *
 * @see http://drupal.org/node/515192
446
 * @see file_url_transform_relative()
Dries's avatar
 
Dries committed
447
 */
448
function file_create_url($uri) {
449
450
  // Allow the URI to be altered, e.g. to serve a file from a CDN or static
  // file server.
451
  \Drupal::moduleHandler()->alter('file_url', $uri);
452

453
454
455
  $scheme = file_uri_scheme($uri);

  if (!$scheme) {
456
457
458
459
460
461
462
463
464
465
466
467
    // Allow for:
    // - root-relative URIs (e.g. /foo.jpg in http://example.com/foo.jpg)
    // - protocol-relative URIs (e.g. //bar.jpg, which is expanded to
    //   http://example.com/bar.jpg by the browser when viewing a page over
    //   HTTP and to https://example.com/bar.jpg when viewing a HTTPS page)
    // Both types of relative URIs are characterized by a leading slash, hence
    // we can use a single check.
    if (drupal_substr($uri, 0, 1) == '/') {
      return $uri;
    }
    else {
      // If this is not a properly formatted stream, then it is a shipped file.
468
469
      // Therefore, return the urlencoded URI with the base URL prepended.
      return $GLOBALS['base_url'] . '/' . drupal_encode_path($uri);
470
    }
471
472
  }
  elseif ($scheme == 'http' || $scheme == 'https') {
473
474
    // Check for HTTP so that we don't have to implement getExternalUrl() for
    // the HTTP wrapper.
475
476
477
478
479
480
481
482
483
484
485
    return $uri;
  }
  else {
    // Attempt to return an external URL using the appropriate wrapper.
    if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
      return $wrapper->getExternalUrl();
    }
    else {
      return FALSE;
    }
  }
Dries's avatar
 
Dries committed
486
487
}

488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
/**
 * Transforms an absolute URL of a local file to a relative URL.
 *
 * May be useful to prevent problems on multisite set-ups and prevent mixed
 * content errors when using HTTPS + HTTP.
 *
 * @param string $file_url
 *   A file URL of a local file as generated by file_create_url().
 *
 * @return string
 *   If the file URL indeed pointed to a local file and was indeed absolute,
 *   then the transformed, relative URL to the local file. Otherwise: the
 *   original value of $file_url.
 *
 * @see file_create_url()
 */
function file_url_transform_relative($file_url) {
  // Unfortunately, we pretty much have to duplicate Symfony's
  // Request::getHttpHost() method because Request::getPort() may return NULL
  // instead of a port number.
  $http_host = '';
  $request = \Drupal::request();
  $host = $request->getHost();
  $scheme = $request->getScheme();
  $port = $request->getPort() ?: 80;
  if (('http' == $scheme && $port == 80) || ('https' == $scheme && $port == 443)) {
    $http_host = $host;
  }
  else {
    $http_host = $host . ':' . $port;
  }

  return preg_replace('|^https?://' . $http_host . '|', '', $file_url);
}

Dries's avatar
 
Dries committed
523
/**
524
 * Checks that the directory exists and is writable.
525
526
527
528
 *
 * Directories need to have execute permissions to be considered a directory by
 * FTP servers, etc.
 *
529
 * @param $directory
530
531
532
 *   A string reference containing the name of a directory path or URI. A
 *   trailing slash will be trimmed from a path.
 * @param $options
533
534
535
 *   A bitmask to indicate if the directory should be created if it does
 *   not exist (FILE_CREATE_DIRECTORY) or made writable if it is read-only
 *   (FILE_MODIFY_PERMISSIONS).
536
 *
537
 * @return
538
539
 *   TRUE if the directory exists (or was created) and is writable. FALSE
 *   otherwise.
Dries's avatar
 
Dries committed
540
 */
541
function file_prepare_directory(&$directory, $options = FILE_MODIFY_PERMISSIONS) {
542
543
544
545
  if (!file_stream_wrapper_valid_scheme(file_uri_scheme($directory))) {
    // Only trim if we're not dealing with a stream.
    $directory = rtrim($directory, '/\\');
  }
Dries's avatar
   
Dries committed
546
547
548

  // Check if directory exists.
  if (!is_dir($directory)) {
549
550
    // Let mkdir() recursively create directories and use the default directory
    // permissions.
551
    if ($options & FILE_CREATE_DIRECTORY) {
552
      return @drupal_mkdir($directory, NULL, TRUE);
Dries's avatar
   
Dries committed
553
    }
554
    return FALSE;
Dries's avatar
   
Dries committed
555
  }
556
557
558
  // The directory exists, so check to see if it is writable.
  $writable = is_writable($directory);
  if (!$writable && ($options & FILE_MODIFY_PERMISSIONS)) {
559
    return drupal_chmod($directory);
Dries's avatar
   
Dries committed
560
561
  }

562
  return $writable;
Dries's avatar
 
Dries committed
563
564
565
}

/**
566
 * Creates a .htaccess file in each Drupal files directory if it is missing.
Dries's avatar
 
Dries committed
567
 */
568
function file_ensure_htaccess() {
569
  file_save_htaccess('public://', FALSE);
570
  $private_path = \Drupal::config('system.file')->get('path.private');
571
  if (!empty($private_path)) {
572
    file_save_htaccess('private://', TRUE);
573
  }
574
  file_save_htaccess('temporary://', TRUE);
575
  file_save_htaccess(config_get_config_directory(), TRUE);
576
  file_save_htaccess(config_get_config_directory(CONFIG_STAGING_DIRECTORY), TRUE);
Dries's avatar
 
Dries committed
577
578
579
}

/**
580
 * Creates a .htaccess file in the given directory.
Dries's avatar
 
Dries committed
581
 *
582
 * @param $directory
583
584
585
586
 *   The directory.
 * @param $private
 *   FALSE indicates that $directory should be an open and public directory.
 *   The default is TRUE which indicates a private and protected directory.
587
588
589
590
 *
 * @return bool
 *   TRUE if the .htaccess file could be created or existed already, FALSE
 *   otherwise.
Dries's avatar
 
Dries committed
591
 */
592
function file_save_htaccess($directory, $private = TRUE) {
593
  if (file_uri_scheme($directory)) {
594
    $htaccess_path = file_stream_wrapper_uri_normalize($directory . '/.htaccess');
595
596
  }
  else {
597
    $directory = rtrim($directory, '/\\');
598
    $htaccess_path = $directory . '/.htaccess';
599
  }
600
601
602

  if (file_exists($htaccess_path)) {
    // Short circuit if the .htaccess file already exists.
603
    return TRUE;
604
605
606
607
  }

  if ($private) {
    // Private .htaccess file.
608
    $htaccess_lines = MTimeProtectedFastFileStorage::HTACCESS;
609
610
611
612
613
614
615
  }
  else {
    // Public .htaccess file.
    $htaccess_lines = "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\nOptions None\nOptions +FollowSymLinks";
  }

  // Write the .htaccess file.
616
617
  if (file_exists($directory) && is_writable($directory) && file_put_contents($htaccess_path, $htaccess_lines)) {
    return drupal_chmod($htaccess_path, 0444);
618
619
  }
  else {
620
    $variables = array('%directory' => $directory, '!htaccess' => '<br />' . nl2br(String::checkPlain($htaccess_lines)));
621
    watchdog('security', "Security warning: Couldn't write .htaccess file. Please create a .htaccess file in your %directory directory which contains the following lines: <code>!htaccess</code>", $variables, WATCHDOG_ERROR);
622
    return FALSE;
Dries's avatar
 
Dries committed
623
624
625
  }
}

626
/**
627
 * Determines whether the URI has a valid scheme for file API operations.
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 *
 * There must be a scheme and it must be a Drupal-provided scheme like
 * 'public', 'private', 'temporary', or an extension provided with
 * hook_stream_wrappers().
 *
 * @param $uri
 *   The URI to be tested.
 *
 * @return
 *   TRUE if the URI is allowed.
 */
function file_valid_uri($uri) {
  // Assert that the URI has an allowed scheme. Barepaths are not allowed.
  $uri_scheme = file_uri_scheme($uri);
642
  if (!file_stream_wrapper_valid_scheme($uri_scheme)) {
643
644
645
646
647
    return FALSE;
  }
  return TRUE;
}

648
/**
649
 * Copies a file to a new location without invoking the file API.
Dries's avatar
 
Dries committed
650
 *
651
652
653
654
655
 * This is a powerful function that in many ways performs like an advanced
 * version of copy().
 * - Checks if $source and $destination are valid and readable/writable.
 * - If file already exists in $destination either the call will error out,
 *   replace the file or rename the file based on the $replace parameter.
656
 * - If the $source and $destination are equal, the behavior depends on the
657
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
658
 *   will rename the file until the $destination is unique.
659
660
661
662
 * - Provides a fallback using realpaths if the move fails using stream
 *   wrappers. This can occur because PHP's copy() function does not properly
 *   support streams if safe_mode or open_basedir are enabled. See
 *   https://bugs.php.net/bug.php?id=60456
663
664
 *
 * @param $source
665
 *   A string specifying the filepath or URI of the source file.
666
 * @param $destination
667
 *   A URI containing the destination that $source should be copied to. The
668
669
 *   URI may be a bare filepath (without a scheme). If this value is omitted,
 *   Drupal's default files scheme will be used, usually "public://".
670
671
672
673
 * @param $replace
 *   Replace behavior when the destination file already exists:
 *   - FILE_EXISTS_REPLACE - Replace the existing file.
 *   - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
674
 *       unique.
675
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
676
 *
677
678
 * @return
 *   The path to the new file, or FALSE in the event of an error.
679
 *
680
 * @see file_copy()
Dries's avatar
 
Dries committed
681
 */
682
function file_unmanaged_copy($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
683
684
  $original_source = $source;

685
  // Assert that the source file actually exists.
686
  if (!file_exists($source)) {
687
    // @todo Replace drupal_set_message() calls with exceptions instead.
688
    drupal_set_message(t('The specified file %file could not be copied because no file by that name exists. Please check that you supplied the correct filename.', array('%file' => $original_source)), 'error');
689
690
691
692
693
694
    if (($realpath = drupal_realpath($original_source)) !== FALSE) {
      watchdog('file', 'File %file (%realpath) could not be copied because it does not exist.', array('%file' => $original_source, '%realpath' => $realpath));
    }
    else {
      watchdog('file', 'File %file could not be copied because it does not exist.', array('%file' => $original_source));
    }
695
696
    return FALSE;
  }
Dries's avatar
 
Dries committed
697

698
699
  // Build a destination URI if necessary.
  if (!isset($destination)) {
700
    $destination = file_build_uri(drupal_basename($source));
701
  }
Dries's avatar
 
Dries committed
702
703


704
705
706
  // Prepare the destination directory.
  if (file_prepare_directory($destination)) {
    // The destination is already a directory, so append the source basename.
707
    $destination = file_stream_wrapper_uri_normalize($destination . '/' . drupal_basename($source));
708
709
710
711
712
713
  }
  else {
    // Perhaps $destination is a dir/file?
    $dirname = drupal_dirname($destination);
    if (!file_prepare_directory($dirname)) {
      // The destination is not valid.
714
715
      watchdog('file', 'File %file could not be copied because the destination directory %destination is not configured correctly.', array('%file' => $original_source, '%destination' => $dirname));
      drupal_set_message(t('The specified file %file could not be copied because the destination directory is not properly configured. This may be caused by a problem with file or directory permissions. More information is available in the system log.', array('%file' => $original_source)), 'error');
716
717
718
      return FALSE;
    }
  }
719

720
721
  // Determine whether we can perform this operation based on overwrite rules.
  $destination = file_destination($destination, $replace);
722
  if ($destination === FALSE) {
723
    drupal_set_message(t('The file %file could not be copied because a file by that name already exists in the destination directory.', array('%file' => $original_source)), 'error');
724
    watchdog('file', 'File %file could not be copied because a file by that name already exists in the destination directory (%destination)', array('%file' => $original_source, '%destination' => $destination));
725
    return FALSE;
Dries's avatar
 
Dries committed
726
  }
727
728

  // Assert that the source and destination filenames are not the same.
729
730
731
  $real_source = drupal_realpath($source);
  $real_destination = drupal_realpath($destination);
  if ($source == $destination || ($real_source !== FALSE) && ($real_source == $real_destination)) {
732
    drupal_set_message(t('The specified file %file was not copied because it would overwrite itself.', array('%file' => $source)), 'error');
733
    watchdog('file', 'File %file could not be copied because it would overwrite itself.', array('%file' => $source));
734
    return FALSE;
Dries's avatar
 
Dries committed
735
  }
736
737
738
  // Make sure the .htaccess files are present.
  file_ensure_htaccess();
  // Perform the copy operation.
739
  if (!@copy($source, $destination)) {
740
741
742
743
744
745
    // If the copy failed and realpaths exist, retry the operation using them
    // instead.
    if ($real_source === FALSE || $real_destination === FALSE || !@copy($real_source, $real_destination)) {
      watchdog('file', 'The specified file %file could not be copied to %destination.', array('%file' => $source, '%destination' => $destination), WATCHDOG_ERROR);
      return FALSE;
    }
Dries's avatar
 
Dries committed
746
  }
Dries's avatar
   
Dries committed
747

748
749
  // Set the permissions on the new file.
  drupal_chmod($destination);
750
751

  return $destination;
Dries's avatar
 
Dries committed
752
753
}

754
/**
755
 * Constructs a URI to Drupal's default files location given a relative path.
756
757
 */
function file_build_uri($path) {
758
  $uri = file_default_scheme() . '://' . $path;
759
760
761
  return file_stream_wrapper_uri_normalize($uri);
}

762
/**
763
 * Determines the destination path for a file.
764
 *
765
 * @param $destination
766
 *   A string specifying the desired final URI or filepath.
767
768
 * @param $replace
 *   Replace behavior when the destination file already exists.
769
 *   - FILE_EXISTS_REPLACE - Replace the existing file.
770
 *   - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
771
 *       unique.
772
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
773
 *
774
 * @return
775
776
 *   The destination filepath, or FALSE if the file already exists
 *   and FILE_EXISTS_ERROR is specified.
777
778
779
780
 */
function file_destination($destination, $replace) {
  if (file_exists($destination)) {
    switch ($replace) {
781
782
783
784
      case FILE_EXISTS_REPLACE:
        // Do nothing here, we want to overwrite the existing file.
        break;

785
      case FILE_EXISTS_RENAME:
786
        $basename = drupal_basename($destination);
787
        $directory = drupal_dirname($destination);
788
789
790
791
        $destination = file_create_filename($basename, $directory);
        break;

      case FILE_EXISTS_ERROR:
792
        // Error reporting handled by calling function.
793
794
795
796
797
798
        return FALSE;
    }
  }
  return $destination;
}

799
/**
800
 * Moves a file to a new location without database changes or hook invocation.
Dries's avatar
   
Dries committed
801
 *
802
 * @param $source
803
 *   A string specifying the filepath or URI of the original file.
804
 * @param $destination
805
806
807
 *   A string containing the destination that $source should be moved to.
 *   This must be a stream wrapper URI. If this value is omitted, Drupal's
 *   default files scheme will be used, usually "public://".
808
809
810
811
 * @param $replace
 *   Replace behavior when the destination file already exists:
 *   - FILE_EXISTS_REPLACE - Replace the existing file.
 *   - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
812
 *       unique.
813
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
814
 *
815
 * @return
816
 *   The URI of the moved file, or FALSE in the event of an error.
817
 *
818
 * @see file_move()
Dries's avatar
   
Dries committed
819
 */
820
821
822
function file_unmanaged_move($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  $filepath = file_unmanaged_copy($source, $destination, $replace);
  if ($filepath == FALSE || file_unmanaged_delete($source) == FALSE) {
823
    return FALSE;
Dries's avatar
 
Dries committed
824
  }
825
  return $filepath;
Dries's avatar
 
Dries committed
826
827
}

828
/**
829
 * Modifies a filename as needed for security purposes.
830
 *
831
832
833
834
835
836
837
838
839
840
841
 * Munging a file name prevents unknown file extensions from masking exploit
 * files. When web servers such as Apache decide how to process a URL request,
 * they use the file extension. If the extension is not recognized, Apache
 * skips that extension and uses the previous file extension. For example, if
 * the file being requested is exploit.php.pps, and Apache does not recognize
 * the '.pps' extension, it treats the file as PHP and executes it. To make
 * this file name safe for Apache and prevent it from executing as PHP, the
 * .php extension is "munged" into .php_, making the safe file name
 * exploit.php_.pps.
 *
 * Specifically, this function adds an underscore to all extensions that are
842
 * between 2 and 5 characters in length, internal to the file name, and not
843
844
 * included in $extensions.
 *
845
846
847
 * Function behavior is also controlled by the configuration
 * 'system.file:allow_insecure_uploads'. If it evaluates to TRUE, no alterations
 * will be made, if it evaluates to FALSE, the filename is 'munged'. *
848
 * @param $filename
849
 *   File name to modify.
850
 * @param $extensions
851
 *   A space-separated list of extensions that should not be altered.
852
 * @param $alerts
853
854
855
 *   If TRUE, drupal_set_message() will be called to display a message if the
 *   file name was changed.
 *
856
 * @return string
857
 *   The potentially modified $filename.
858
859
860
861
862
 */
function file_munge_filename($filename, $extensions, $alerts = TRUE) {
  $original = $filename;

  // Allow potentially insecure uploads for very savvy users and admin
863
  if (!\Drupal::config('system.file')->get('allow_insecure_uploads')) {
864
865
866
    // Remove any null bytes. See http://php.net/manual/en/security.filesystem.nullbytes.php
    $filename = str_replace(chr(0), '', $filename);

867
868
869
870
871
872
873
874
875
876
877
878
    $whitelist = array_unique(explode(' ', trim($extensions)));

    // Split the filename up by periods. The first part becomes the basename
    // the last part the final extension.
    $filename_parts = explode('.', $filename);
    $new_filename = array_shift($filename_parts); // Remove file basename.
    $final_extension = array_pop($filename_parts); // Remove final extension.

    // Loop through the middle parts of the name and add an underscore to the
    // end of each section that could be a file extension but isn't in the list
    // of allowed extensions.
    foreach ($filename_parts as $filename_part) {
879
      $new_filename .= '.' . $filename_part;
880
881
882
883
      if (!in_array($filename_part, $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
        $new_filename .= '_';
      }
    }
884
    $filename = $new_filename . '.' . $final_extension;
885
886
887
888
889
890
891
892
893
894

    if ($alerts && $original != $filename) {
      drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $filename)));
    }
  }

  return $filename;
}

/**
895
 * Undoes the effect of file_munge_filename().
896
 *
897
898
 * @param $filename
 *   String with the filename to be unmunged.
899
 *
900
901
 * @return
 *   An unmunged filename string.
902
903
904
905
906
 */
function file_unmunge_filename($filename) {
  return str_replace('_.', '.', $filename);
}

907
/**
908
 * Creates a full file path from a directory and filename.
909
910
911
 *
 * If a file with the specified name already exists, an alternative will be
 * used.
912
 *
913
914
915
 * @param $basename
 *   String filename
 * @param $directory
916
 *   String containing the directory or parent URI.
917
 *
918
 * @return
919
920
 *   File path consisting of $directory and a unique filename based off
 *   of $basename.
921
 */
Dries's avatar
   
Dries committed
922
function file_create_filename($basename, $directory) {
923
924
925
  // Strip control characters (ASCII value < 32). Though these are allowed in
  // some filesystems, not many applications handle them well.
  $basename = preg_replace('/[\x00-\x1F]/u', '_', $basename);
926
927
928
929
  if (substr(PHP_OS, 0, 3) == 'WIN') {
    // These characters are not allowed in Windows filenames
    $basename = str_replace(array(':', '*', '?', '"', '<', '>', '|'), '_', $basename);
  }
930

931
932
933
934
935
936
937
938
939
  // A URI or path may already have a trailing slash or look like "public://".
  if (substr($directory, -1) == '/') {
    $separator = '';
  }
  else {
    $separator = '/';
  }

  $destination = $directory . $separator . $basename;
Dries's avatar
   
Dries committed
940

941
  if (file_exists($destination)) {
Dries's avatar
   
Dries committed
942
    // Destination file already exists, generate an alternative.
943
944
    $pos = strrpos($basename, '.');
    if ($pos !== FALSE) {
Dries's avatar
   
Dries committed
945
946
947
948
949
      $name = substr($basename, 0, $pos);
      $ext = substr($basename, $pos);
    }
    else {
      $name = $basename;
950
      $ext = '';
Dries's avatar
   
Dries committed
951
952
953
954
    }

    $counter = 0;
    do {
955
      $destination = $directory . $separator . $name . '_' . $counter++ . $ext;
956
    } while (file_exists($destination));
Dries's avatar
   
Dries committed
957
958
  }

959
  return $destination;
Dries's avatar
   
Dries committed
960
961
}

962
/**
963
 * Deletes a file and its database record.
964
 *
965
966
967
 * Instead of directly deleting a file, it is strongly recommended to delete
 * file usages instead. That will automatically mark the file as temporary and
 * remove it during cleanup.
968
 *
969
970
 * @param $fid
 *   The file id.
971
 *
972
 * @see file_unmanaged_delete()
973
 * @see \Drupal\file\FileUsage\FileUsageBase::delete()
974
 */
975
976
977
function file_delete($fid) {
  return file_delete_multiple(array($fid));
}
978

979
980
981
982
983
984
985
986
987
988
989
/**
 * Deletes files.
 *
 * Instead of directly deleting a file, it is strongly recommended to delete
 * file usages instead. That will automatically mark the file as temporary and
 * remove it during cleanup.
 *
 * @param $fid
 *   The file id.
 *
 * @see file_unmanaged_delete()
990
 * @see \Drupal\file\FileUsage\FileUsageBase::delete()
991
992
993
 */
function file_delete_multiple(array $fids) {
  entity_delete_multiple('file', $fids);
994
995
996
}

/**
997
 * Deletes a file without database changes or hook invocations.
998
999
1000
 *
 * This function should be used when the file to be deleted does not have an
 * entry recorded in the files table.
1001
 *
1002
 * @param $path
1003
 *   A string containing a file path or (streamwrapper) URI.
1004
 *
1005
1006
1007
 * @return
 *   TRUE for success or path does not exist, or FALSE in the event of an
 *   error.
1008
 *
1009
 * @see file_delete()
1010
 * @see file_unmanaged_delete_recursive()
1011
 */
1012
function file_unmanaged_delete($path) {
1013
  if (is_dir($path)) {
1014
    watchdog('file', '%path is a directory and cannot be removed using file_unmanaged_delete().', array('%path' => $path), WATCHDOG_ERROR);
1015
1016
    return FALSE;
  }
1017
  if (is_file($path)) {
1018
    return drupal_unlink($path);
1019
  }
1020
  // Return TRUE for non-existent file, but log that nothing was actually
1021
  // deleted, as the current state is the intended result.
1022
  if (!file_exists($path)) {
1023
    watchdog('file', 'The file %path was not deleted because it does not exist.', array('%path' => $path), WATCHDOG_NOTICE);
1024
1025
    return TRUE;
  }
1026
1027
  // We cannot handle anything other than files and directories. Log an error
  // for everything else (sockets, symbolic links, etc).
1028
  watchdog('file', 'The file %path is not of a recognized type so it was not deleted.', array('%path' => $path), WATCHDOG_ERROR);
1029
  return FALSE;
Dries's avatar
 
Dries committed
1030
1031
}

1032
/**
1033
 * Deletes all files and directories in the specified filepath recursively.
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 *
 * If the specified path is a directory then the function will call itself
 * recursively to process the contents. Once the contents have been removed the
 * directory will also be removed.
 *
 * If the specified path is a file then it will be passed to
 * file_unmanaged_delete().
 *
 * Note that this only deletes visible files with write permission.
 *
 * @param $path
1045
 *   A string containing either an URI or a file or directory path.
1046
1047
1048
1049
 * @param $callback
 *   (optional) Callback function to run on each file prior to deleting it and
 *   on each directory prior to traversing it. For example, can be used to
 *   modify permissions.