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

/**
 * 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
27
/**
Kjartan's avatar
Kjartan committed
28
 * @defgroup file File interface
Kjartan's avatar
Kjartan committed
29
 * @{
Dries's avatar
   
Dries committed
30
 * Common file handling functions.
31
 *
32
 * Fields on the file entity:
33
34
35
 * - 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
36
37
 *   the basename of the filepath if the file is renamed to avoid overwriting
 *   an existing file.
38
39
40
41
 * - 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
42
 *   bits are reserved for Drupal core. The least significant bit indicates
43
44
45
46
 *   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.
47
 * - timestamp: UNIX timestamp for the date the file was added to the database.
Dries's avatar
   
Dries committed
48
49
 */

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

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

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

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

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

75
/**
76
77
 * Indicates that the file is permanent and should not be deleted.
 *
78
79
80
81
 * 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.
82
 */
83
const FILE_STATUS_PERMANENT = 1;
84

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

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

/**
 * Returns the scheme of a URI (e.g. a stream).
 *
133
134
 * @param string $uri
 *   A stream, referenced as "scheme://target"  or "data:target".
135
 *
136
 * @return string
137
138
 *   A string containing the name of the scheme, or FALSE if none. For example,
 *   the URI "public://example.txt" would return "public".
139
140
 *
 * @see file_uri_target()
141
142
 */
function file_uri_scheme($uri) {
143
144
145
146
147
148
  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;
149
150
151
}

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

169

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

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

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

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

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

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

228
229
230
231
  return $uri;
}

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

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

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

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

  if (!$scheme) {
313
314
315
316
317
318
319
    // 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.
320
    if (Unicode::substr($uri, 0, 1) == '/') {
321
322
323
324
      return $uri;
    }
    else {
      // If this is not a properly formatted stream, then it is a shipped file.
325
      // Therefore, return the urlencoded URI with the base URL prepended.
326
      return $GLOBALS['base_url'] . '/' . UrlHelper::encodePath($uri);
327
    }
328
  }
329
330
331
  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.
332
333
334
335
336
337
338
339
340
341
342
    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
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
379
/**
 * 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
380
/**
381
 * Checks that the directory exists and is writable.
382
383
384
385
 *
 * Directories need to have execute permissions to be considered a directory by
 * FTP servers, etc.
 *
386
 * @param $directory
387
388
389
 *   A string reference containing the name of a directory path or URI. A
 *   trailing slash will be trimmed from a path.
 * @param $options
390
391
392
 *   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).
393
 *
394
 * @return
395
396
 *   TRUE if the directory exists (or was created) and is writable. FALSE
 *   otherwise.
Dries's avatar
   
Dries committed
397
 */
398
function file_prepare_directory(&$directory, $options = FILE_MODIFY_PERMISSIONS) {
399
400
401
402
  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
403
404
405

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

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

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

/**
437
 * Creates a .htaccess file in the given directory.
Dries's avatar
   
Dries committed
438
 *
439
 * @param string $directory
440
 *   The directory.
441
442
443
444
445
446
447
448
 * @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) {
449
  if (file_uri_scheme($directory)) {
450
    $htaccess_path = file_stream_wrapper_uri_normalize($directory . '/.htaccess');
451
452
  }
  else {
453
    $directory = rtrim($directory, '/\\');
454
    $htaccess_path = $directory . '/.htaccess';
455
  }
456

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

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

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
/**
 * 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);
}

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $filename;
}

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

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

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

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

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

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

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

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

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

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

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

944

Dries's avatar
   
Dries committed
945

946
947
948
/**
 * Moves an uploaded file to a new location.
 *