file.inc 52.3 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
use Drupal\Component\Utility\UrlHelper;
9
use Drupal\Component\PhpStorage\FileStorage;
10
use Drupal\Component\Utility\Bytes;
11
use Drupal\Component\Utility\String;
12
use Drupal\Core\Site\Settings;
13
use Drupal\Core\StreamWrapper\PublicStream;
14
use Drupal\Core\StreamWrapper\StreamWrapperInterface;
15
16
17
18
19
20
21
22
23
24
25

/**
 * 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;

Kjartan's avatar
Kjartan committed
26
/**
Kjartan's avatar
Kjartan committed
27
 * @defgroup file File interface
Kjartan's avatar
Kjartan committed
28
 * @{
Dries's avatar
   
Dries committed
29
 * Common file handling functions.
30
 *
31
 * Fields on the file entity:
32
33
34
 * - 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
35
36
 *   the basename of the filepath if the file is renamed to avoid overwriting
 *   an existing file.
37
38
39
40
 * - 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
41
 *   bits are reserved for Drupal core. The least significant bit indicates
42
43
44
45
 *   temporary (0) or permanent (1). Temporary files will be removed during
 *   cron runs if they are older than the configuration value
 *   "system.file.temporary_maximum_age", and if clean-up is enabled. Permanent
 *   files will not be removed.
46
 * - timestamp: UNIX timestamp for the date the file was added to the database.
Dries's avatar
   
Dries committed
47
48
 */

49
/**
50
 * Flag used by file_prepare_directory() -- create directory if not present.
51
 */
52
const FILE_CREATE_DIRECTORY = 1;
53
54

/**
55
 * Flag used by file_prepare_directory() -- file permissions may be changed.
56
 */
57
const FILE_MODIFY_PERMISSIONS = 2;
58
59

/**
60
 * Flag for dealing with existing files: Appends number until name is unique.
61
 */
62
const FILE_EXISTS_RENAME = 0;
63
64
65
66

/**
 * Flag for dealing with existing files: Replace the existing file.
 */
67
const FILE_EXISTS_REPLACE = 1;
68
69
70
71

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

74
/**
75
76
 * Indicates that the file is permanent and should not be deleted.
 *
77
78
79
80
 * Temporary files older than the system.file.temporary_maximum_age
 * configuration value will be, if clean-up not disabled, removed during cron
 * runs, but permanent files will not be removed during the file garbage
 * collection process.
81
 */
82
const FILE_STATUS_PERMANENT = 1;
83

84
/**
85
 * Provides Drupal stream wrapper registry.
86
 *
87
 * @param int $filter
88
 *   (Optional) Filters out all types except those with an on bit for each on
89
90
91
92
93
94
95
96
 *   bit in $filter. For example, if $filter is
 *   StreamWrapperInterface::WRITE_VISIBLE, which is equal to
 *   (StreamWrapperInterface::READ | StreamWrapperInterface::WRITE |
 *   StreamWrapperInterface::VISIBLE), then only stream wrappers with all three
 *   of these bits set are returned. Defaults to StreamWrapperInterface::ALL,
 *   which returns all registered stream wrappers.
 *
 * @return array
97
98
 *   An array keyed by scheme, with values containing an array of information
 *   about the stream wrapper, as returned by hook_stream_wrappers(). If $filter
99
100
101
102
 *   is omitted or set to StreamWrapperInterface::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.
103
 *
104
 * @see hook_stream_wrappers_alter()
105
106
107
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('stream_wrapper_manager')->getWrappers().
108
 */
109
110
function file_get_stream_wrappers($filter = StreamWrapperInterface::ALL) {
  return \Drupal::service('stream_wrapper_manager')->getWrappers($filter);
111
112
113
114
115
}

/**
 * Returns the stream wrapper class name for a given scheme.
 *
116
 * @param string $scheme
117
 *   Stream scheme.
118
 *
119
 * @return string|bool
120
 *   Return string if a scheme has a registered handler, or FALSE.
121
122
123
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('stream_wrapper_manager')->getClass().
124
125
 */
function file_stream_wrapper_get_class($scheme) {
126
  return \Drupal::service('stream_wrapper_manager')->getClass($scheme);
127
128
129
130
131
}

/**
 * Returns the scheme of a URI (e.g. a stream).
 *
132
133
 * @param string $uri
 *   A stream, referenced as "scheme://target"  or "data:target".
134
 *
135
 * @return string
136
137
 *   A string containing the name of the scheme, or FALSE if none. For example,
 *   the URI "public://example.txt" would return "public".
138
139
 *
 * @see file_uri_target()
140
141
 */
function file_uri_scheme($uri) {
142
143
144
145
146
147
  if (preg_match('/^([\w\-]+):\/\/|^(data):/', $uri, $matches)) {
    // The scheme will always be the last element in the matches array.
    return array_pop($matches);
  }

  return FALSE;
148
149
150
}

/**
151
 * Checks that the scheme of a stream URI is valid.
152
153
154
155
156
 *
 * 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.
 *
157
 * @param string $scheme
158
 *   A URI scheme, a stream is referenced as "scheme://target".
159
 *
160
 * @return bool
161
162
163
164
 *   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) {
165
  return $scheme && class_exists(file_stream_wrapper_get_class($scheme));
166
167
}

168

169
/**
170
 * Returns the part of a URI after the schema.
171
 *
172
173
 * @param string $uri
 *   A stream, referenced as "scheme://target" or "data:target".
174
 *
175
 * @return string|bool
176
177
178
 *   A string containing the target (path), or FALSE if none.
 *   For example, the URI "public://sample/test.txt" would return
 *   "sample/test.txt".
179
180
 *
 * @see file_uri_scheme()
181
182
 */
function file_uri_target($uri) {
183
184
185
  // Remove the scheme from the URI and remove erroneous leading or trailing,
  // forward-slashes and backslashes.
  $target = trim(preg_replace('/^[\w\-]+:\/\/|^data:/', '', $uri), '\/');
186

187
188
  // If nothing was replaced, the URI doesn't have a valid scheme.
  return $target !== $uri ? $target : FALSE;
189
190
}

191
/**
192
 * Gets the default file stream implementation.
193
 *
194
 * @return string
195
196
197
 *   'public', 'private' or any other file scheme defined as the default.
 */
function file_default_scheme() {
198
  return \Drupal::config('system.file')->get('default_scheme');
199
200
}

201
202
203
204
205
206
207
208
209
/**
 * 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 "://".
 *
210
 * @param string $uri
211
 *   String reference containing the URI to normalize.
212
 *
213
 * @return string
214
 *   The normalized URI.
215
216
217
218
 */
function file_stream_wrapper_uri_normalize($uri) {
  $scheme = file_uri_scheme($uri);

219
  if (file_stream_wrapper_valid_scheme($scheme)) {
220
221
    $target = file_uri_target($uri);

222
223
224
    if ($target !== FALSE) {
      $uri = $scheme . '://' . $target;
    }
225
  }
226

227
228
229
230
  return $uri;
}

/**
231
 * Returns a reference to the stream wrapper class responsible for a given URI.
232
233
234
235
 *
 * The scheme determines the stream wrapper class that should be
 * used by consulting the stream wrapper registry.
 *
236
 * @param string $uri
237
 *   A stream, referenced as "scheme://target".
238
 *
239
 * @return \Drupal\Core\StreamWrapper\StreamWrapperInterface|bool
240
241
242
 *   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
243
 *   (Drupal\Core\StreamWrapper\PrivateStream).
244
245
246
 *
 * * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('stream_wrapper_manager')->getViaUri().
247
248
 */
function file_stream_wrapper_get_instance_by_uri($uri) {
249
  return \Drupal::service('stream_wrapper_manager')->getViaUri($uri);
250
251
252
}

/**
253
 * Returns a reference to the stream wrapper class responsible for a scheme.
254
255
256
257
258
259
260
261
262
 *
 * 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.
 *
263
 * @param string $scheme
264
 *   If the stream was "public://target", "public" would be the scheme.
265
 *
266
 * @return \Drupal\Core\StreamWrapper\StreamWrapperInterface|bool
267
268
 *   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
269
 *   (Drupal\Core\StreamWrapper\PublicStream).
270
 *   FALSE is returned if no registered handler could be found.
271
272
273
 *
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('stream_wrapper_manager')->getViaScheme().
274
275
 */
function file_stream_wrapper_get_instance_by_scheme($scheme) {
276
  return \Drupal::service('stream_wrapper_manager')->getViaScheme($scheme);
277
278
}

Dries's avatar
   
Dries committed
279
/**
280
 * Creates a web-accessible URL for a stream to an external or local file.
Dries's avatar
   
Dries committed
281
 *
282
 * Compatibility: normal paths and stream wrappers.
Dries's avatar
   
Dries committed
283
 *
284
 * There are two kinds of local files:
285
286
287
 * - "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).
288
289
290
 * - "shipped files", i.e. those outside of the files directory, which ship as
 *   part of Drupal core or contributed modules or themes.
 *
291
 * @param string $uri
292
293
 *   The URI to a file for which we need an external URL, or the path to a
 *   shipped file.
294
 *
295
 * @return string
296
 *   A string containing a URL that may be used to access the file.
297
298
299
 *   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.
300
301
 *
 * @see http://drupal.org/node/515192
302
 * @see file_url_transform_relative()
Dries's avatar
   
Dries committed
303
 */
304
function file_create_url($uri) {
305
306
  // Allow the URI to be altered, e.g. to serve a file from a CDN or static
  // file server.
307
  \Drupal::moduleHandler()->alter('file_url', $uri);
308

309
310
311
  $scheme = file_uri_scheme($uri);

  if (!$scheme) {
312
313
314
315
316
317
318
319
320
321
322
323
    // 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.
324
      // Therefore, return the urlencoded URI with the base URL prepended.
325
      return $GLOBALS['base_url'] . '/' . UrlHelper::encodePath($uri);
326
    }
327
  }
328
329
330
  elseif ($scheme == 'http' || $scheme == 'https' || $scheme == 'data') {
    // Check for HTTP and data URI-encoded URLs so that we don't have to
    // implement getExternalUrl() for the HTTP and data schemes.
331
332
333
334
335
336
337
338
339
340
341
    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
342
343
}

344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/**
 * 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
379
/**
380
 * Checks that the directory exists and is writable.
381
382
383
384
 *
 * Directories need to have execute permissions to be considered a directory by
 * FTP servers, etc.
 *
385
 * @param $directory
386
387
388
 *   A string reference containing the name of a directory path or URI. A
 *   trailing slash will be trimmed from a path.
 * @param $options
389
390
391
 *   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).
392
 *
393
 * @return
394
395
 *   TRUE if the directory exists (or was created) and is writable. FALSE
 *   otherwise.
Dries's avatar
   
Dries committed
396
 */
397
function file_prepare_directory(&$directory, $options = FILE_MODIFY_PERMISSIONS) {
398
399
400
401
  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
402
403
404

  // Check if directory exists.
  if (!is_dir($directory)) {
405
406
    // Let mkdir() recursively create directories and use the default directory
    // permissions.
407
    if ($options & FILE_CREATE_DIRECTORY) {
408
      return @drupal_mkdir($directory, NULL, TRUE);
Dries's avatar
   
Dries committed
409
    }
410
    return FALSE;
Dries's avatar
   
Dries committed
411
  }
412
413
414
  // The directory exists, so check to see if it is writable.
  $writable = is_writable($directory);
  if (!$writable && ($options & FILE_MODIFY_PERMISSIONS)) {
415
    return drupal_chmod($directory);
Dries's avatar
   
Dries committed
416
417
  }

418
  return $writable;
Dries's avatar
   
Dries committed
419
420
421
}

/**
422
 * Creates a .htaccess file in each Drupal files directory if it is missing.
Dries's avatar
   
Dries committed
423
 */
424
function file_ensure_htaccess() {
425
  file_save_htaccess('public://', FALSE);
426
  $private_path = \Drupal::config('system.file')->get('path.private');
427
  if (!empty($private_path)) {
428
    file_save_htaccess('private://', TRUE);
429
  }
430
  file_save_htaccess('temporary://', TRUE);
431
  file_save_htaccess(config_get_config_directory(), TRUE);
432
  file_save_htaccess(config_get_config_directory(CONFIG_STAGING_DIRECTORY), TRUE);
Dries's avatar
   
Dries committed
433
434
435
}

/**
436
 * Creates a .htaccess file in the given directory.
Dries's avatar
   
Dries committed
437
 *
438
 * @param string $directory
439
 *   The directory.
440
441
442
443
444
445
446
447
 * @param bool $private
 *   (Optional) FALSE indicates that $directory should be a web-accessible
 *   directory. Defaults to TRUE which indicates a private directory.
 * @param bool $force_overwrite
 *   (Optional) Set to TRUE to attempt to overwrite the existing .htaccess file
 *   if one is already present. Defaults to FALSE.
 */
function file_save_htaccess($directory, $private = TRUE, $force_overwrite = FALSE) {
448
  if (file_uri_scheme($directory)) {
449
    $htaccess_path = file_stream_wrapper_uri_normalize($directory . '/.htaccess');
450
451
  }
  else {
452
    $directory = rtrim($directory, '/\\');
453
    $htaccess_path = $directory . '/.htaccess';
454
  }
455

456
  if (file_exists($htaccess_path) && !$force_overwrite) {
457
    // Short circuit if the .htaccess file already exists.
458
    return TRUE;
459
  }
460
  $htaccess_lines = file_htaccess_lines($private);
461
462

  // Write the .htaccess file.
463
464
  if (file_exists($directory) && is_writable($directory) && file_put_contents($htaccess_path, $htaccess_lines)) {
    return drupal_chmod($htaccess_path, 0444);
465
466
  }
  else {
467
    $variables = array('%directory' => $directory, '!htaccess' => '<br />' . nl2br(String::checkPlain($htaccess_lines)));
468
    \Drupal::logger('security')->error("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);
469
    return FALSE;
Dries's avatar
   
Dries committed
470
471
472
  }
}

473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
/**
 * Returns the standard .htaccess lines that Drupal writes to file directories.
 *
 * @param bool $private
 *   (Optional) Set to FALSE to return the .htaccess lines for a web-accessible
 *   public directory. The default is TRUE, which returns the .htaccess lines
 *   for a private directory that should not be web-accessible.
 *
 * @return string
 *   The desired contents of the .htaccess file.
 *
 * @see file_create_htaccess()
 */
function file_htaccess_lines($private = TRUE) {
  return FileStorage::htaccessLines($private);
}

490
/**
491
 * Determines whether the URI has a valid scheme for file API operations.
492
493
494
495
496
497
498
499
500
501
502
503
 *
 * 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) {
504
  // Assert that the URI has an allowed scheme. Bare paths are not allowed.
505
  $uri_scheme = file_uri_scheme($uri);
506
  if (!file_stream_wrapper_valid_scheme($uri_scheme)) {
507
508
509
510
511
    return FALSE;
  }
  return TRUE;
}

512
/**
513
 * Copies a file to a new location without invoking the file API.
Dries's avatar
   
Dries committed
514
 *
515
516
517
518
519
 * 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.
520
 * - If the $source and $destination are equal, the behavior depends on the
521
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
522
 *   will rename the file until the $destination is unique.
523
524
 * - Provides a fallback using realpaths if the move fails using stream
 *   wrappers. This can occur because PHP's copy() function does not properly
525
 *   support streams if open_basedir is enabled. See
526
 *   https://bugs.php.net/bug.php?id=60456
527
528
 *
 * @param $source
529
 *   A string specifying the filepath or URI of the source file.
530
 * @param $destination
531
 *   A URI containing the destination that $source should be copied to. The
532
533
 *   URI may be a bare filepath (without a scheme). If this value is omitted,
 *   Drupal's default files scheme will be used, usually "public://".
534
535
536
537
 * @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
538
 *       unique.
539
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
540
 *
541
542
 * @return
 *   The path to the new file, or FALSE in the event of an error.
543
 *
544
 * @see file_copy()
Dries's avatar
   
Dries committed
545
 */
546
function file_unmanaged_copy($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
547
  $original_source = $source;
548
  $logger = \Drupal::logger('file');
549

550
  // Assert that the source file actually exists.
551
  if (!file_exists($source)) {
552
    // @todo Replace drupal_set_message() calls with exceptions instead.
553
    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');
554
    if (($realpath = drupal_realpath($original_source)) !== FALSE) {
555
      $logger->notice('File %file (%realpath) could not be copied because it does not exist.', array('%file' => $original_source, '%realpath' => $realpath));
556
557
    }
    else {
558
      $logger->notice('File %file could not be copied because it does not exist.', array('%file' => $original_source));
559
    }
560
561
    return FALSE;
  }
Dries's avatar
   
Dries committed
562

563
564
  // Build a destination URI if necessary.
  if (!isset($destination)) {
565
    $destination = file_build_uri(drupal_basename($source));
566
  }
Dries's avatar
   
Dries committed
567
568


569
570
571
  // Prepare the destination directory.
  if (file_prepare_directory($destination)) {
    // The destination is already a directory, so append the source basename.
572
    $destination = file_stream_wrapper_uri_normalize($destination . '/' . drupal_basename($source));
573
574
575
576
577
578
  }
  else {
    // Perhaps $destination is a dir/file?
    $dirname = drupal_dirname($destination);
    if (!file_prepare_directory($dirname)) {
      // The destination is not valid.
579
      $logger->notice('File %file could not be copied because the destination directory %destination is not configured correctly.', array('%file' => $original_source, '%destination' => $dirname));
580
      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');
581
582
583
      return FALSE;
    }
  }
584

585
586
  // Determine whether we can perform this operation based on overwrite rules.
  $destination = file_destination($destination, $replace);
587
  if ($destination === FALSE) {
588
    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');
589
    $logger->notice('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));
590
    return FALSE;
Dries's avatar
   
Dries committed
591
  }
592
593

  // Assert that the source and destination filenames are not the same.
594
595
596
  $real_source = drupal_realpath($source);
  $real_destination = drupal_realpath($destination);
  if ($source == $destination || ($real_source !== FALSE) && ($real_source == $real_destination)) {
597
    drupal_set_message(t('The specified file %file was not copied because it would overwrite itself.', array('%file' => $source)), 'error');
598
    $logger->notice('File %file could not be copied because it would overwrite itself.', array('%file' => $source));
599
    return FALSE;
Dries's avatar
   
Dries committed
600
  }
601
602
603
  // Make sure the .htaccess files are present.
  file_ensure_htaccess();
  // Perform the copy operation.
604
  if (!@copy($source, $destination)) {
605
606
607
    // 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)) {
608
      $logger->error('file', 'The specified file %file could not be copied to %destination.', array('%file' => $source, '%destination' => $destination));
609
610
      return FALSE;
    }
Dries's avatar
   
Dries committed
611
  }
Dries's avatar
   
Dries committed
612

613
614
  // Set the permissions on the new file.
  drupal_chmod($destination);
615
616

  return $destination;
Dries's avatar
   
Dries committed
617
618
}

619
/**
620
 * Constructs a URI to Drupal's default files location given a relative path.
621
622
 */
function file_build_uri($path) {
623
  $uri = file_default_scheme() . '://' . $path;
624
625
626
  return file_stream_wrapper_uri_normalize($uri);
}

627
/**
628
 * Determines the destination path for a file.
629
 *
630
 * @param $destination
631
 *   A string specifying the desired final URI or filepath.
632
633
 * @param $replace
 *   Replace behavior when the destination file already exists.
634
 *   - FILE_EXISTS_REPLACE - Replace the existing file.
635
 *   - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
636
 *       unique.
637
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
638
 *
639
 * @return
640
641
 *   The destination filepath, or FALSE if the file already exists
 *   and FILE_EXISTS_ERROR is specified.
642
643
644
645
 */
function file_destination($destination, $replace) {
  if (file_exists($destination)) {
    switch ($replace) {
646
647
648
649
      case FILE_EXISTS_REPLACE:
        // Do nothing here, we want to overwrite the existing file.
        break;

650
      case FILE_EXISTS_RENAME:
651
        $basename = drupal_basename($destination);
652
        $directory = drupal_dirname($destination);
653
654
655
656
        $destination = file_create_filename($basename, $directory);
        break;

      case FILE_EXISTS_ERROR:
657
        // Error reporting handled by calling function.
658
659
660
661
662
663
        return FALSE;
    }
  }
  return $destination;
}

664
/**
665
 * Moves a file to a new location without database changes or hook invocation.
Dries's avatar
   
Dries committed
666
 *
667
 * @param $source
668
 *   A string specifying the filepath or URI of the original file.
669
 * @param $destination
670
671
672
 *   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://".
673
674
675
676
 * @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
677
 *       unique.
678
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
679
 *
680
 * @return
681
 *   The URI of the moved file, or FALSE in the event of an error.
682
 *
683
 * @see file_move()
Dries's avatar
   
Dries committed
684
 */
685
686
687
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) {
688
    return FALSE;
Dries's avatar
   
Dries committed
689
  }
690
  return $filepath;
Dries's avatar
   
Dries committed
691
692
}

693
/**
694
 * Modifies a filename as needed for security purposes.
695
 *
696
697
698
699
700
701
702
703
704
705
706
 * 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
707
 * between 2 and 5 characters in length, internal to the file name, and not
708
709
 * included in $extensions.
 *
710
711
712
 * 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'. *
713
 * @param $filename
714
 *   File name to modify.
715
 * @param $extensions
716
 *   A space-separated list of extensions that should not be altered.
717
 * @param $alerts
718
719
720
 *   If TRUE, drupal_set_message() will be called to display a message if the
 *   file name was changed.
 *
721
 * @return string
722
 *   The potentially modified $filename.
723
724
725
726
727
 */
function file_munge_filename($filename, $extensions, $alerts = TRUE) {
  $original = $filename;

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

732
    $whitelist = array_unique(explode(' ', strtolower(trim($extensions))));
733
734
735
736
737
738
739
740
741
742
743

    // 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) {
744
      $new_filename .= '.' . $filename_part;
745
      if (!in_array(strtolower($filename_part), $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
746
747
748
        $new_filename .= '_';
      }
    }
749
    $filename = $new_filename . '.' . $final_extension;
750
751
752
753
754
755
756
757
758
759

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

  return $filename;
}

/**
760
 * Undoes the effect of file_munge_filename().
761
 *
762
763
 * @param $filename
 *   String with the filename to be unmunged.
764
 *
765
766
 * @return
 *   An unmunged filename string.
767
768
769
770
771
 */
function file_unmunge_filename($filename) {
  return str_replace('_.', '.', $filename);
}

772
/**
773
 * Creates a full file path from a directory and filename.
774
775
776
 *
 * If a file with the specified name already exists, an alternative will be
 * used.
777
 *
778
779
780
 * @param $basename
 *   String filename
 * @param $directory
781
 *   String containing the directory or parent URI.
782
 *
783
 * @return
784
785
 *   File path consisting of $directory and a unique filename based off
 *   of $basename.
786
 */
Dries's avatar
   
Dries committed
787
function file_create_filename($basename, $directory) {
788
789
790
  // 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);
791
792
793
794
  if (substr(PHP_OS, 0, 3) == 'WIN') {
    // These characters are not allowed in Windows filenames
    $basename = str_replace(array(':', '*', '?', '"', '<', '>', '|'), '_', $basename);
  }
795

796
797
798
799
800
801
802
803
804
  // 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
805

806
  if (file_exists($destination)) {
Dries's avatar
   
Dries committed
807
    // Destination file already exists, generate an alternative.
808
809
    $pos = strrpos($basename, '.');
    if ($pos !== FALSE) {
Dries's avatar
   
Dries committed
810
811
812
813
814
      $name = substr($basename, 0, $pos);
      $ext = substr($basename, $pos);
    }
    else {
      $name = $basename;
815
      $ext = '';
Dries's avatar
   
Dries committed
816
817
818
819
    }

    $counter = 0;
    do {
820
      $destination = $directory . $separator . $name . '_' . $counter++ . $ext;
821
    } while (file_exists($destination));
Dries's avatar
   
Dries committed
822
823
  }

824
  return $destination;
Dries's avatar
   
Dries committed
825
826
}

827
/**
828
 * Deletes a file and its database record.
829
 *
830
831
832
 * 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.
833
 *
834
835
 * @param $fid
 *   The file id.
836
 *
837
 * @see file_unmanaged_delete()
838
 * @see \Drupal\file\FileUsage\FileUsageBase::delete()
839
 */
840
841
842
function file_delete($fid) {
  return file_delete_multiple(array($fid));
}
843

844
845
846
847
848
849
850
851
852
853
854
/**
 * 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()
855
 * @see \Drupal\file\FileUsage\FileUsageBase::delete()
856
857
858
 */
function file_delete_multiple(array $fids) {
  entity_delete_multiple('file', $fids);
859
860
861
}

/**
862
 * Deletes a file without database changes or hook invocations.
863
864
865
 *
 * This function should be used when the file to be deleted does not have an
 * entry recorded in the files table.
866
 *
867
 * @param $path
868
 *   A string containing a file path or (streamwrapper) URI.
869
 *
870
871
872
 * @return
 *   TRUE for success or path does not exist, or FALSE in the event of an
 *   error.
873
 *
874
 * @see file_delete()
875
 * @see file_unmanaged_delete_recursive()
876
 */
877
function file_unmanaged_delete($path) {
878
879
880
  if (is_file($path)) {
    return drupal_unlink($path);
  }
881
  $logger = \Drupal::logger('file');
882
  if (is_dir($path)) {
883
    $logger->error('%path is a directory and cannot be removed using file_unmanaged_delete().', array('%path' => $path));
884
885
    return FALSE;
  }
886
  // Return TRUE for non-existent file, but log that nothing was actually
887
  // deleted, as the current state is the intended result.
888
  if (!file_exists($path)) {
889
    $logger->notice('The file %path was not deleted because it does not exist.', array('%path' => $path));
890
891
    return TRUE;
  }
892
893
  // We cannot handle anything other than files and directories. Log an error
  // for everything else (sockets, symbolic links, etc).
894
  $logger->error('The file %path is not of a recognized type so it was not deleted.', array('%path' => $path));
895
  return FALSE;
Dries's avatar
   
Dries committed
896
897
}

898
/**
899
 * Deletes all files and directories in the specified filepath recursively.
900
901
902
903
904
905
906
907
908
909
910
 *
 * 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
911
 *   A string containing either an URI or a file or directory path.
912
913
914
915
 * @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.
916
 *
917
 * @return
918
 *   TRUE for success or if path does not exist, FALSE in the event of an
919
920
921
922
 *   error.
 *
 * @see file_unmanaged_delete()
 */
923
924
925
926
function file_unmanaged_delete_recursive($path, $callback = NULL) {
  if (isset($callback)) {
    call_user_func($callback, $path);
  }
927
928
929
930
931
932
933
  if (is_dir($path)) {
    $dir = dir($path);
    while (($entry = $dir->read()) !== FALSE) {
      if ($entry == '.' || $entry == '..') {
        continue;
      }
      $entry_path = $path . '/' . $entry;
934
      file_unmanaged_delete_recursive($entry_path, $callback);
935
    }
936
    $dir->close();
937
938

    return drupal_rmdir($path);
939
940
941
942
  }
  return file_unmanaged_delete($path);
}

943

Dries's avatar
   
Dries committed
944

945
946
947
/**
 * Moves an uploaded file to a new location.
 *
948
949
 * PHP's move_uploaded_file() does not properly support streams if open_basedir
 * is enabled, so this function fills that gap.
950
951
952
953
954
955
956
957
958
959
960
961
 *
 * Compatibility: normal paths and stream wrappers.