file.inc 35.1 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
2
// $Id$
Kjartan's avatar
Kjartan committed
3

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

Kjartan's avatar
Kjartan committed
9
/**
Kjartan's avatar
Kjartan committed
10
 * @defgroup file File interface
Kjartan's avatar
Kjartan committed
11
 * @{
Dries's avatar
   
Dries committed
12
 * Common file handling functions.
Dries's avatar
   
Dries committed
13
14
15
16
 */

define('FILE_DOWNLOADS_PUBLIC', 1);
define('FILE_DOWNLOADS_PRIVATE', 2);
Dries's avatar
   
Dries committed
17
18
define('FILE_CREATE_DIRECTORY', 1);
define('FILE_MODIFY_PERMISSIONS', 2);
Dries's avatar
   
Dries committed
19
20
21
define('FILE_EXISTS_RENAME', 0);
define('FILE_EXISTS_REPLACE', 1);
define('FILE_EXISTS_ERROR', 2);
Dries's avatar
   
Dries committed
22

23
/**
Dries's avatar
Dries committed
24
 * A files status can be one of two values: temporary or permanent. The status
25
26
27
28
29
30
31
32
33
34
 * for each file Drupal manages is stored in the {files} tables. If the status
 * is temporary Drupal's file garbage collection will delete the file and
 * remove it from the files table after a set period of time.
 *
 * If you wish to add custom statuses for use by contrib modules please expand as
 * binary flags and consider the first 8 bits reserved. (0,1,2,4,8,16,32,64,128)
 */
define('FILE_STATUS_TEMPORARY', 0);
define('FILE_STATUS_PERMANENT', 1);

Dries's avatar
   
Dries committed
35
36
/**
 * Create the download path to a file.
Dries's avatar
   
Dries committed
37
 *
38
39
 * @param $path A string containing the path of the file to generate URL for.
 * @return A string containing a URL that can be used to download the file.
Dries's avatar
   
Dries committed
40
41
 */
function file_create_url($path) {
Dries's avatar
Dries committed
42
  // Strip file_directory_path from $path. We only include relative paths in urls.
43
  if (strpos($path, file_directory_path() .'/') === 0) {
44
    $path = trim(substr($path, strlen(file_directory_path())), '\\/');
Kjartan's avatar
Kjartan committed
45
  }
46
  switch (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC)) {
Dries's avatar
   
Dries committed
47
    case FILE_DOWNLOADS_PUBLIC:
48
      return $GLOBALS['base_url'] .'/'. file_directory_path() .'/'. str_replace('\\', '/', $path);
Dries's avatar
   
Dries committed
49
    case FILE_DOWNLOADS_PRIVATE:
50
      return url('system/files/'. $path, array('absolute' => TRUE));
Dries's avatar
   
Dries committed
51
52
53
54
  }
}

/**
55
56
 * Make sure the destination is a complete path and resides in the file system
 * directory, if it is not prepend the file system directory.
Dries's avatar
   
Dries committed
57
 *
58
59
60
61
62
 * @param $dest A string containing the path to verify. If this value is
 *   omitted, Drupal's 'files' directory will be used.
 * @return A string containing the path to file, with file system directory
 *   appended if necessary, or FALSE if the path is invalid (i.e. outside the
 *   configured 'files' or temp directories).
Dries's avatar
   
Dries committed
63
64
 */
function file_create_path($dest = 0) {
65
  $file_path = file_directory_path();
Dries's avatar
   
Dries committed
66
  if (!$dest) {
67
    return $file_path;
Dries's avatar
   
Dries committed
68
  }
69
  // file_check_location() checks whether the destination is inside the Drupal files directory.
70
  if (file_check_location($dest, $file_path)) {
Dries's avatar
   
Dries committed
71
72
    return $dest;
  }
73
  // check if the destination is instead inside the Drupal temporary files directory.
74
  else if (file_check_location($dest, file_directory_temp())) {
75
76
    return $dest;
  }
77
  // Not found, try again with prefixed directory path.
78
79
  else if (file_check_location($file_path .'/'. $dest, $file_path)) {
    return $file_path .'/'. $dest;
80
81
82
  }
  // File not found.
  return FALSE;
Dries's avatar
   
Dries committed
83
84
85
}

/**
86
87
 * Check that the directory exists and is writable. Directories need to
 * have execute permissions to be considered a directory by FTP servers, etc.
Dries's avatar
   
Dries committed
88
 *
89
90
91
92
93
 * @param $directory A string containing the name of a directory path.
 * @param $mode A Boolean value to indicate if the directory should be created
 *   if it does not exist or made writable if it is read-only.
 * @param $form_item An optional string containing the name of a form item that
 *   any errors will be attached to. This is useful for settings forms that
94
 *   require the user to specify a writable directory. If it can't be made to
95
 *   work, a form error will be set preventing them from saving the settings.
96
 * @return FALSE when directory not found, or TRUE when directory exists.
Dries's avatar
   
Dries committed
97
 */
Dries's avatar
   
Dries committed
98
function file_check_directory(&$directory, $mode = 0, $form_item = NULL) {
Dries's avatar
   
Dries committed
99
  $directory = rtrim($directory, '/\\');
Dries's avatar
   
Dries committed
100
101
102

  // Check if directory exists.
  if (!is_dir($directory)) {
103
    if (($mode & FILE_CREATE_DIRECTORY) && @mkdir($directory)) {
104
      drupal_set_message(t('The directory %directory has been created.', array('%directory' => $directory)));
105
      @chmod($directory, 0775); // Necessary for non-webserver users.
Dries's avatar
   
Dries committed
106
107
108
    }
    else {
      if ($form_item) {
109
        form_set_error($form_item, t('The directory %directory does not exist.', array('%directory' => $directory)));
Dries's avatar
   
Dries committed
110
      }
111
      return FALSE;
Dries's avatar
   
Dries committed
112
113
114
115
116
    }
  }

  // Check to see if the directory is writable.
  if (!is_writable($directory)) {
117
    if (($mode & FILE_MODIFY_PERMISSIONS) && @chmod($directory, 0775)) {
118
      drupal_set_message(t('The permissions of directory %directory have been changed to make it writable.', array('%directory' => $directory)));
Dries's avatar
   
Dries committed
119
120
    }
    else {
121
      form_set_error($form_item, t('The directory %directory is not writable', array('%directory' => $directory)));
122
      watchdog('file system', 'The directory %directory is not writable, because it does not have the correct permissions set.', array('%directory' => $directory), WATCHDOG_ERROR);
123
      return FALSE;
Dries's avatar
   
Dries committed
124
125
126
    }
  }

127
  if ((file_directory_path() == $directory || file_directory_temp() == $directory) && !is_file("$directory/.htaccess")) {
128
    $htaccess_lines = "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\nOptions None\nOptions +FollowSymLinks";
Gerhard Killesreiter's avatar
Gerhard Killesreiter committed
129
    if (($fp = fopen("$directory/.htaccess", 'w')) && fputs($fp, $htaccess_lines)) {
130
      fclose($fp);
131
      chmod($directory .'/.htaccess', 0664);
132
133
    }
    else {
134
135
136
      $variables = array('%directory' => $directory, '!htaccess' => '<br />'. nl2br(check_plain($htaccess_lines)));
      form_set_error($form_item, t("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('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);
137
138
139
    }
  }

140
  return TRUE;
Dries's avatar
   
Dries committed
141
142
143
144
145
}

/**
 * Checks path to see if it is a directory, or a dir/file.
 *
146
147
 * @param $path A string containing a file path. This will be set to the
 *   directory's path.
148
 * @return If the directory is not in a Drupal writable directory, FALSE is
149
 *   returned. Otherwise, the base name of the path is returned.
Dries's avatar
   
Dries committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 */
function file_check_path(&$path) {
  // Check if path is a directory.
  if (file_check_directory($path)) {
    return '';
  }

  // Check if path is a possible dir/file.
  $filename = basename($path);
  $path = dirname($path);
  if (file_check_directory($path)) {
    return $filename;
  }

164
  return FALSE;
Dries's avatar
   
Dries committed
165
166
167
168
169
170
171
172
}

/**
 * Check if a file is really located inside $directory. Should be used to make
 * sure a file specified is really located within the directory to prevent
 * exploits.
 *
 * @code
173
 *   // Returns FALSE:
Dries's avatar
   
Dries committed
174
175
176
177
178
179
180
 *   file_check_location('/www/example.com/files/../../../etc/passwd', '/www/example.com/files');
 * @endcode
 *
 * @param $source A string set to the file to check.
 * @param $directory A string where the file should be located.
 * @return 0 for invalid path or the real path of the source.
 */
181
function file_check_location($source, $directory = '') {
182
183
184
185
186
187
188
189
  $check = realpath($source);
  if ($check) {
    $source = $check;
  }
  else {
    // This file does not yet exist
    $source = realpath(dirname($source)) .'/'. basename($source);
  }
190
  $directory = realpath($directory);
Dries's avatar
   
Dries committed
191
192
193
194
195
196
197
  if ($directory && strpos($source, $directory) !== 0) {
    return 0;
  }
  return $source;
}

/**
Dries's avatar
   
Dries committed
198
 * Copies a file to a new location. This is a powerful function that in many ways
Dries's avatar
   
Dries committed
199
200
201
 * performs like an advanced version of copy().
 * - Checks if $source and $dest are valid and readable/writable.
 * - Performs a file copy if $source is not equal to $dest.
Dries's avatar
   
Dries committed
202
203
 * - If file already exists in $dest either the call will error out, replace the
 *   file or rename the file based on the $replace parameter.
Dries's avatar
   
Dries committed
204
205
206
207
208
 *
 * @param $source A string specifying the file location of the original file.
 *   This parameter will contain the resulting destination filename in case of
 *   success.
 * @param $dest A string containing the directory $source should be copied to.
209
 *   If this value is omitted, Drupal's 'files' directory will be used.
Dries's avatar
   
Dries committed
210
211
212
 * @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 unique
213
214
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 * @return True for success, FALSE for failure.
Dries's avatar
   
Dries committed
215
 */
Dries's avatar
   
Dries committed
216
function file_copy(&$source, $dest = 0, $replace = FILE_EXISTS_RENAME) {
Dries's avatar
   
Dries committed
217
218
219
220
221
222
  $dest = file_create_path($dest);

  $directory = $dest;
  $basename = file_check_path($directory);

  // Make sure we at least have a valid directory.
223
  if ($basename === FALSE) {
224
    $source = is_object($source) ? $source->filepath : $source;
225
    drupal_set_message(t('The selected file %file could not be uploaded, because the destination %directory is not properly configured.', array('%file' => $source, '%directory' => $dest)), 'error');
226
    watchdog('file system', 'The selected file %file could not be uploaded, because the destination %directory could not be found, or because its permissions do not allow the file to be written.', array('%file' => $source, '%directory' => $dest), WATCHDOG_ERROR);
Dries's avatar
   
Dries committed
227
228
229
230
231
232
    return 0;
  }

  // Process a file upload object.
  if (is_object($source)) {
    $file = $source;
Dries's avatar
   
Dries committed
233
    $source = $file->filepath;
Dries's avatar
   
Dries committed
234
    if (!$basename) {
Dries's avatar
   
Dries committed
235
      $basename = $file->filename;
Dries's avatar
   
Dries committed
236
237
238
239
240
    }
  }

  $source = realpath($source);
  if (!file_exists($source)) {
241
    drupal_set_message(t('The selected file %file could not be copied, because no file by that name exists. Please check that you supplied the correct filename.', array('%file' => $source)), 'error');
Dries's avatar
   
Dries committed
242
243
244
    return 0;
  }

245
  // If the destination file is not specified then use the filename of the source file.
Dries's avatar
   
Dries committed
246
  $basename = $basename ? $basename : basename($source);
Steven Wittens's avatar
Steven Wittens committed
247
  $dest = $directory .'/'. $basename;
Dries's avatar
   
Dries committed
248

Dries's avatar
   
Dries committed
249
250
251
252
  // Make sure source and destination filenames are not the same, makes no sense
  // to copy it if they are. In fact copying the file will most likely result in
  // a 0 byte file. Which is bad. Real bad.
  if ($source != realpath($dest)) {
253
254
255
    if (!$dest = file_destination($dest, $replace)) {
      drupal_set_message(t('The selected file %file could not be copied, because a file by that name already exists in the destination.', array('%file' => $source)), 'error');
      return FALSE;
Dries's avatar
   
Dries committed
256
    }
Dries's avatar
   
Dries committed
257

258
    if (!@copy($source, $dest)) {
259
      drupal_set_message(t('The selected file %file could not be copied.', array('%file' => $source)), 'error');
Dries's avatar
   
Dries committed
260
261
      return 0;
    }
262
263

    // Give everyone read access so that FTP'd users or
264
    // non-webserver users can see/read these files,
Dries's avatar
Dries committed
265
    // and give group write permissions so group members
266
    // can alter files uploaded by the webserver.
267
    @chmod($dest, 0664);
Dries's avatar
   
Dries committed
268
269
  }

270
  if (isset($file) && is_object($file)) {
Dries's avatar
   
Dries committed
271
272
    $file->filename = $basename;
    $file->filepath = $dest;
Dries's avatar
   
Dries committed
273
274
275
276
277
    $source = $file;
  }
  else {
    $source = $dest;
  }
Dries's avatar
   
Dries committed
278

Dries's avatar
   
Dries committed
279
280
281
  return 1; // Everything went ok.
}

282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/**
 * Determines the destination path for a file depending on how replacement of
 * existing files should be handled.
 *
 * @param $destination A string specifying the desired path.
 * @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
 *     unique
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 * @return The destination file path or FALSE if the file already exists and
 *   FILE_EXISTS_ERROR was specified.
 */
function file_destination($destination, $replace) {
  if (file_exists($destination)) {
    switch ($replace) {
      case FILE_EXISTS_RENAME:
        $basename = basename($destination);
        $directory = dirname($destination);
        $destination = file_create_filename($basename, $directory);
        break;

      case FILE_EXISTS_ERROR:
305
        drupal_set_message(t('The selected file %file could not be copied, because a file by that name already exists in the destination.', array('%file' => $destination)), 'error');
306
307
308
309
310
311
        return FALSE;
    }
  }
  return $destination;
}

Dries's avatar
   
Dries committed
312
313
314
315
316
317
318
319
320
321
322
/**
 * Moves a file to a new location.
 * - Checks if $source and $dest are valid and readable/writable.
 * - Performs a file move if $source is not equal to $dest.
 * - If file already exists in $dest either the call will error out, replace the
 *   file or rename the file based on the $replace parameter.
 *
 * @param $source A string specifying the file location of the original file.
 *   This parameter will contain the resulting destination filename in case of
 *   success.
 * @param $dest A string containing the directory $source should be copied to.
323
 *   If this value is omitted, Drupal's 'files' directory will be used.
Dries's avatar
   
Dries committed
324
325
326
 * @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 unique
327
328
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 * @return True for success, FALSE for failure.
Dries's avatar
   
Dries committed
329
330
 */
function file_move(&$source, $dest = 0, $replace = FILE_EXISTS_RENAME) {
Dries's avatar
   
Dries committed
331
332
  $path_original = is_object($source) ? $source->filepath : $source;

Dries's avatar
   
Dries committed
333
  if (file_copy($source, $dest, $replace)) {
Dries's avatar
   
Dries committed
334
335
336
    $path_current = is_object($source) ? $source->filepath : $source;

    if ($path_original == $path_current || file_delete($path_original)) {
Dries's avatar
   
Dries committed
337
338
      return 1;
    }
339
    drupal_set_message(t('The removal of the original file %file has failed.', array('%file' => $path_original)), 'error');
Dries's avatar
   
Dries committed
340
341
342
343
  }
  return 0;
}

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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
 * Munge the filename as needed for security purposes. For instance the file
 * name "exploit.php.pps" would become "exploit.php_.pps".
 *
 * @param $filename The name of a file to modify.
 * @param $extensions A space separated list of extensions that should not
 *   be altered.
 * @param $alerts Whether alerts (watchdog, drupal_set_message()) should be
 *   displayed.
 * @return $filename The potentially modified $filename.
 */
function file_munge_filename($filename, $extensions, $alerts = TRUE) {
  $original = $filename;

  // Allow potentially insecure uploads for very savvy users and admin
  if (!variable_get('allow_insecure_uploads', 0)) {
    $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) {
      $new_filename .= '.'. $filename_part;
      if (!in_array($filename_part, $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
        $new_filename .= '_';
      }
    }
    $filename = $new_filename .'.'. $final_extension;

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

  return $filename;
}

/**
 * Undo the effect of upload_munge_filename().
 *
 * @param $filename string filename
 * @return string
 */
function file_unmunge_filename($filename) {
  return str_replace('_.', '.', $filename);
}

397
398
399
400
401
402
403
404
/**
 * Create a full file path from a directory and filename. If a file with the
 * specified name already exists, an alternative will be used.
 *
 * @param $basename string filename
 * @param $directory string directory
 * @return
 */
Dries's avatar
   
Dries committed
405
function file_create_filename($basename, $directory) {
Steven Wittens's avatar
Steven Wittens committed
406
  $dest = $directory .'/'. $basename;
Dries's avatar
   
Dries committed
407
408
409
410
411
412
413
414
415
416
417
418
419

  if (file_exists($dest)) {
    // Destination file already exists, generate an alternative.
    if ($pos = strrpos($basename, '.')) {
      $name = substr($basename, 0, $pos);
      $ext = substr($basename, $pos);
    }
    else {
      $name = $basename;
    }

    $counter = 0;
    do {
Steven Wittens's avatar
Steven Wittens committed
420
      $dest = $directory .'/'. $name .'_'. $counter++ . $ext;
Dries's avatar
   
Dries committed
421
422
423
424
425
426
    } while (file_exists($dest));
  }

  return $dest;
}

427
428
429
430
/**
 * Delete a file.
 *
 * @param $path A string containing a file path.
431
 * @return TRUE for success, FALSE for failure.
432
 */
433
434
function file_delete($path) {
  if (is_file($path)) {
Dries's avatar
   
Dries committed
435
    return unlink($path);
436
  }
Dries's avatar
   
Dries committed
437
438
}

439
440
441
442
443
444
445
446
447
448
449
450
451
452
/**
 * Determine the total amount of disk space used by a single user's files, or
 * the filesystem as a whole.
 *
 * @param $uid An optional, user id. A NULL value returns the total space used
 *   by all files.
 */
function file_space_used($uid = NULL) {
  if (is_null($uid)) {
    return db_result(db_query('SELECT SUM(filesize) FROM {files} WHERE uid = %d', $uid));
  }
  return db_result(db_query('SELECT SUM(filesize) FROM {files}'));
}

Dries's avatar
   
Dries committed
453
454
455
456
/**
 * Saves a file upload to a new location. The source file is validated as a
 * proper upload and handled as such.
 *
Dries's avatar
Dries committed
457
 * The file will be added to the files table as a temporary file. Temporary files
458
 * are periodically cleaned. To make the file permanent file call
459
 * file_set_status() to change its status.
460
461
462
463
464
465
466
467
468
469
 *
 * @param $source
 *   A string specifying the name of the upload field to save.
 * @param $validators
 *   An optional, associative array of callback functions used to validate the
 *   file. The keys are function names and the values arrays of callback
 *   parameters which will be passed in after the user and file objects. The
 *   functions should return an array of error messages, an empty array
 *   indicates that the file passed validation. The functions will be called in
 *   the order specified.
470
471
472
 * @param $dest
 *   A string containing the directory $source should be copied to. If this is
 *   not provided or is not writable, the temporary directory will be used.
473
474
475
476
477
478
 * @param $replace
 *   A boolean indicating whether an existing file of the same name in the
 *   destination directory should overwritten. A false value will generate a
 *   new, unique filename in the destination directory.
 * @return
 *   An object containing the file information, or 0 in the event of an error.
Dries's avatar
   
Dries committed
479
 */
480
481
482
483
484
485
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
523
524
function file_save_upload($source, $validators = array(), $dest = FALSE, $replace = FILE_EXISTS_RENAME) {
  global $user;
  static $upload_cache;

  // Add in our check of the the file name length.
  $validators['file_validate_name_length'] = array();

  // Return cached objects without processing since the file will have
  // already been processed and the paths in _FILES will be invalid.
  if (isset($upload_cache[$source])) {
    return $upload_cache[$source];
  }

  // If a file was uploaded, process it.
  if (isset($_FILES['files']) && $_FILES['files']['name'][$source] && is_uploaded_file($_FILES['files']['tmp_name'][$source])) {
    // Check for file upload errors and return FALSE if a
    // lower level system error occurred.
    switch ($_FILES['files']['error'][$source]) {
      // @see http://php.net/manual/en/features.file-upload.errors.php
      case UPLOAD_ERR_OK:
        break;

      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
        drupal_set_message(t('The file %file could not be saved, because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $source, '%maxsize' => format_size(file_upload_max_size()))), 'error');
        return 0;

      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
        drupal_set_message(t('The file %file could not be saved, because the upload did not complete.', array('%file' => $source)), 'error');
        return 0;

        // Unknown error
      default:
        drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $source)), 'error');
        return 0;
    }

    // Build the list of non-munged extensions.
    // @todo: this should not be here. we need to figure out the right place.
    $extensions = '';
    foreach ($user->roles as $rid => $name) {
      $extensions .= ' '. variable_get("upload_extensions_$rid",
      variable_get('upload_extensions_default', 'jpg jpeg gif png txt html doc xls pdf ppt pps odt ods odp'));
    }
525

526
527
528
529
530
531
532
533
534
535
536
537
538
    // Begin building file object.
    $file = new stdClass();
    $file->filename = file_munge_filename(trim(basename($_FILES['files']['name'][$source]), '.'), $extensions);
    $file->filepath = $_FILES['files']['tmp_name'][$source];
    $file->filemime = $_FILES['files']['type'][$source];

    // Rename potentially executable files, to help prevent exploits.
    if (preg_match('/\.(php|pl|py|cgi|asp|js)$/i', $file->filename) && (substr($file->filename, -4) != '.txt')) {
      $file->filemime = 'text/plain';
      $file->filepath .= '.txt';
      $file->filename .= '.txt';
    }

539
540
541
542
    // If the destination is not provided, or is not writable, then use the
    // temporary directory.
    if (empty($dest) || file_check_path($dest) === FALSE) {
      $dest = file_directory_temp();
543
    }
544

545
    $file->source = $source;
546
    $file->destination = file_destination(file_create_path($dest .'/'. $file->filename), FILE_EXISTS_RENAME);
547
548
549
550
551
552
553
    $file->filesize = $_FILES['files']['size'][$source];

    // Call the validation functions.
    $errors = array();
    foreach ($validators as $function => $args) {
      array_unshift($args, $file);
      $errors = array_merge($errors, call_user_func_array($function, $args));
Dries's avatar
   
Dries committed
554
555
    }

556
557
    // Check for validation errors.
    if (!empty($errors)) {
558
      $message = t('The selected file %name could not be uploaded.', array('%name' => $file->filename));
559
560
561
562
      if (count($errors) > 1) {
        $message .= '<ul><li>'. implode('</li><li>', $errors) .'</li></ul>';
      }
      else {
563
        $message .= ' '. array_pop($errors);
Dries's avatar
   
Dries committed
564
      }
565
566
      form_set_error($source, $message);
      return 0;
Dries's avatar
   
Dries committed
567
    }
568
569
570
571
572
573

    // Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary directory.
    // This overcomes open_basedir restrictions for future file operations.
    $file->filepath = $file->destination;
    if (!move_uploaded_file($_FILES['files']['tmp_name'][$source], $file->filepath)) {
      form_set_error($source, t('File upload error. Could not move uploaded file.'));
574
      watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination', $file->filepath));
575
576
577
578
      return 0;
    }

    // If we made it this far it's safe to record this file in the database.
579
580
581
582
    $file->uid = $user->uid;
    $file->status = FILE_STATUS_TEMPORARY;
    $file->timestamp = time();
    drupal_write_record('files', $file);
583
584
585
586

    // Add file to the cache.
    $upload_cache[$source] = $file;
    return $file;
Dries's avatar
   
Dries committed
587
588
589
590
  }
  return 0;
}

591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/**
 * Check for files with names longer than we can store in the database.
 *
 * @param $file
 *   A Drupal file object.
 * @return
 *   An array. If the file name is too long, it will contain an error message.
 */
function file_validate_name_length($file) {
  $errors = array();

  if (strlen($file->filename) > 255) {
    $errors[] = t('Its name exceeds the 255 characters limit. Please rename the file and try again.');
  }
  return $errors;
}

/**
 * Check that the filename ends with an allowed extension. This check is not
 * enforced for the user #1.
 *
 * @param $file
 *   A Drupal file object.
 * @param $extensions
 *   A string with a space separated
 * @return
617
 *   An array. If the file extension is not allowed, it will contain an error message.
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 */
function file_validate_extensions($file, $extensions) {
  global $user;

  $errors = array();

  // Bypass validation for uid  = 1.
  if ($user->uid != 1) {
    $regex = '/\.('. ereg_replace(' +', '|', preg_quote($extensions)) .')$/i';
    if (!preg_match($regex, $file->filename)) {
      $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', array('%files-allowed' => $extensions));
    }
  }
  return $errors;
}

/**
 * Check that the file's size is below certain limits. This check is not
 * enforced for the user #1.
 *
 * @param $file
 *   A Drupal file object.
 * @param $file_limit
 *   An integer specifying the maximum file size in bytes. Zero indicates that
 *   no limit should be enforced.
 * @param $$user_limit
 *   An integer specifying the maximum number of bytes the user is allowed. Zero
 *   indicates that no limit should be enforced.
 * @return
647
 *   An array. If the file size exceeds limits, it will contain an error message.
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 */
function file_validate_size($file, $file_limit = 0, $user_limit = 0) {
  global $user;

  $errors = array();

  // Bypass validation for uid  = 1.
  if ($user->uid != 1) {
    if ($file_limit && $file->filesize > $file_limit) {
      $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->filesize), '%maxsize' => format_size($file_limit)));
    }

    $total_size = file_space_used($user->uid) + $file->filesize;
    if ($user_limit && $total_size > $user_limit) {
      $errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', array('%filesize' => format_size($file->filesize), '%quota' => format_size($user_limit)));
    }
  }
  return $errors;
}

/**
 * Check that the file is recognized by image_get_info() as an image.
 *
 * @param $file
 *   A Drupal file object.
 * @return
 *   An array. If the file is not an image, it will contain an error message.
 */
function file_validate_is_image(&$file) {
  $errors = array();

  $info = image_get_info($file->filepath);
  if (!$info || empty($info['extension'])) {
    $errors[] = t('Only JPEG, PNG and GIF images are allowed.');
  }

  return $errors;
}

/**
 * If the file is an image verify that its dimensions are within the specified
 * maximum and minimum dimensions. Non-image files will be ignored.
 *
 * @param $file
 *   A Drupal file object. This function may resize the file affecting its size.
 * @param $maximum_dimensions
 *   An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If
 *   an image toolkit is installed the image will be resized down to these
 *   dimensions. A value of 0 indicates no restriction on size, so resizing
 *   will be attempted.
 * @param $minimum_dimensions
 *   An optional string in the form WIDTHxHEIGHT. This will check that the image
 *   meets a minimum size. A value of 0 indicates no restriction.
 * @return
 *   An array. If the file is an image and did not meet the requirements, it
 *   will contain an error message.
 */
function file_validate_image_resolution(&$file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
  $errors = array();

  // Check first that the file is an image.
  if ($info = image_get_info($file->filepath)) {
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
      if ($info['width'] > $width || $info['height'] > $height) {
        // Try to resize the image to fit the dimensions.
        if (image_get_toolkit() && image_scale($file->filepath, $file->filepath, $width, $height)) {
          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));

          // Clear the cached filesize and refresh the image information.
          clearstatcache();
          $info = image_get_info($file->filepath);
          $file->filesize = $info['file_size'];
        }
        else {
          $errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
732
      if ($info['width'] < $width || $info['height'] < $height) {
733
734
735
736
737
738
739
740
        $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
      }
    }
  }

  return $errors;
}

741
/**
742
 * Save a string to the specified destination.
743
 *
744
745
746
747
748
 * @param $data A string containing the contents of the file.
 * @param $dest A string containing the destination location.
 * @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 unique
749
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
750
751
752
 *
 * @return A string containing the resulting filename or 0 on error
 */
753
function file_save_data($data, $dest, $replace = FILE_EXISTS_RENAME) {
754
  $temp = file_directory_temp();
755
756
  // On Windows, tempnam() requires an absolute path, so we use realpath().
  $file = tempnam(realpath($temp), 'file');
Dries's avatar
   
Dries committed
757
  if (!$fp = fopen($file, 'wb')) {
758
    drupal_set_message(t('The file could not be created.'), 'error');
759
760
761
762
763
    return 0;
  }
  fwrite($fp, $data);
  fclose($fp);

764
  if (!file_move($file, $dest, $replace)) {
765
766
767
768
769
770
    return 0;
  }

  return $file;
}

771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
/**
 * Set the status of a file.
 *
 * @param file A Drupal file object
 * @param status A status value to set the file to.
 * @return FALSE on failure, TRUE on success and $file->status will contain the
 *     status.
 */
function file_set_status(&$file, $status) {
  if (db_query('UPDATE {files} SET status = %d WHERE fid = %d', $status, $file->fid)) {
    $file->status = $status;
    return TRUE;
  }
  return FALSE;
}

Dries's avatar
   
Dries committed
787
788
789
790
791
792
793
794
795
796
797
/**
 * Transfer file using http to client. Pipes a file through Drupal to the
 * client.
 *
 * @param $source File to transfer.
 * @param $headers An array of http headers to send along with file.
 */
function file_transfer($source, $headers) {
  ob_end_clean();

  foreach ($headers as $header) {
Dries's avatar
Dries committed
798
799
800
801
    // To prevent HTTP header injection, we delete new lines that are
    // not followed by a space or a tab.
    // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
    $header = preg_replace('/\r?\n(?!\t| )/', '', $header);
802
    drupal_set_header($header);
Dries's avatar
   
Dries committed
803
804
805
806
807
  }

  $source = file_create_path($source);

  // Transfer file in 1024 byte chunks to save memory usage.
808
809
810
811
812
813
814
815
  if ($fd = fopen($source, 'rb')) {
    while (!feof($fd)) {
      print fread($fd, 1024);
    }
    fclose($fd);
  }
  else {
    drupal_not_found();
Dries's avatar
   
Dries committed
816
817
818
819
820
  }
  exit();
}

/**
821
 * Call modules that implement hook_file_download() to find out if a file is
822
823
824
825
 * accessible and what headers it should be transferred with. If a module
 * returns -1 drupal_access_denied() will be returned. If one or more modules
 * returned headers the download will start with the returned headers. If no
 * modules respond drupal_not_found() will be returned.
Dries's avatar
   
Dries committed
826
827
 */
function file_download() {
828
  // Merge remainder of arguments from GET['q'], into relative file path.
829
830
831
  $args = func_get_args();
  $filepath = implode('/', $args);

832
  // Maintain compatibility with old ?file=paths saved in node bodies.
833
834
835
  if (isset($_GET['file'])) {
    $filepath =  $_GET['file'];
  }
836
837
838
839

  if (file_exists(file_create_path($filepath))) {
    $headers = module_invoke_all('file_download', $filepath);
    if (in_array(-1, $headers)) {
840
      return drupal_access_denied();
841
842
    }
    if (count($headers)) {
843
      file_transfer($filepath, $headers);
Dries's avatar
   
Dries committed
844
845
    }
  }
846
  return drupal_not_found();
Dries's avatar
   
Dries committed
847
848
}

849

Dries's avatar
   
Dries committed
850
/**
851
852
853
854
 * Finds all files that match a given mask in a given directory.
 * Directories and files beginning with a period are excluded; this
 * prevents hidden files and directories (such as SVN working directories)
 * from being scanned.
Dries's avatar
   
Dries committed
855
 *
Dries's avatar
Dries committed
856
 * @param $dir
857
 *   The base directory for the scan, without trailing slash.
Dries's avatar
Dries committed
858
859
860
861
862
863
864
865
866
867
 * @param $mask
 *   The regular expression of the files to find.
 * @param $nomask
 *   An array of files/directories to ignore.
 * @param $callback
 *   The callback function to call for each match.
 * @param $recurse
 *   When TRUE, the directory scan will recurse the entire tree
 *   starting at the provided directory.
 * @param $key
868
 *   The key to be used for the returned array of files. Possible
Dries's avatar
Dries committed
869
870
871
 *   values are "filename", for the path starting with $dir,
 *   "basename", for the basename of the file, and "name" for the name
 *   of the file without an extension.
872
873
874
 * @param $min_depth
 *   Minimum depth of directories to return files from.
 * @param $depth
875
 *   Current depth of recursion. This parameter is only used internally and should not be passed.
Dries's avatar
Dries committed
876
877
878
879
880
 *
 * @return
 *   An associative array (keyed on the provided key) of objects with
 *   "path", "basename", and "name" members corresponding to the
 *   matching files.
Dries's avatar
   
Dries committed
881
 */
882
function file_scan_directory($dir, $mask, $nomask = array('.', '..', 'CVS'), $callback = 0, $recurse = TRUE, $key = 'filename', $min_depth = 0, $depth = 0) {
Dries's avatar
Dries committed
883
  $key = (in_array($key, array('filename', 'basename', 'name')) ? $key : 'filename');
Dries's avatar
   
Dries committed
884
  $files = array();
Dries's avatar
Dries committed
885

Dries's avatar
   
Dries committed
886
887
  if (is_dir($dir) && $handle = opendir($dir)) {
    while ($file = readdir($handle)) {
888
      if (!in_array($file, $nomask) && $file[0] != '.') {
Dries's avatar
   
Dries committed
889
        if (is_dir("$dir/$file") && $recurse) {
890
891
          // Give priority to files in this folder by merging them in after any subdirectory files.
          $files = array_merge(file_scan_directory("$dir/$file", $mask, $nomask, $callback, $recurse, $key, $min_depth, $depth + 1), $files);
Dries's avatar
   
Dries committed
892
        }
893
        elseif ($depth >= $min_depth && ereg($mask, $file)) {
894
          // Always use this match over anything already set in $files with the same $$key.
Dries's avatar
Dries committed
895
896
897
898
899
900
901
          $filename = "$dir/$file";
          $basename = basename($file);
          $name = substr($basename, 0, strrpos($basename, '.'));
          $files[$$key] = new stdClass();
          $files[$$key]->filename = $filename;
          $files[$$key]->basename = $basename;
          $files[$$key]->name = $name;
Dries's avatar
   
Dries committed
902
          if ($callback) {
Dries's avatar
Dries committed
903
            $callback($filename);
Dries's avatar
   
Dries committed
904
905
906
907
          }
        }
      }
    }
Dries's avatar
Dries committed
908

Dries's avatar
   
Dries committed
909
910
    closedir($handle);
  }
Dries's avatar
Dries committed
911

Dries's avatar
   
Dries committed
912
913
914
  return $files;
}

915
916
/**
 * Determine the default temporary directory.
917
918
 *
 * @return A string containing a temp directory.
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 */
function file_directory_temp() {
  $temporary_directory = variable_get('file_directory_temp', NULL);

  if (is_null($temporary_directory)) {
    $directories = array();

    // Has PHP been set with an upload_tmp_dir?
    if (ini_get('upload_tmp_dir')) {
      $directories[] = ini_get('upload_tmp_dir');
    }

    // Operating system specific dirs.
    if (substr(PHP_OS, 0, 3) == 'WIN') {
      $directories[] = 'c:\\windows\\temp';
      $directories[] = 'c:\\winnt\\temp';
      $path_delimiter = '\\';
    }
    else {
      $directories[] = '/tmp';
      $path_delimiter = '/';
    }

    foreach ($directories as $directory) {
      if (!$temporary_directory && is_dir($directory)) {
        $temporary_directory = $directory;
      }
    }

    // if a directory has been found, use it, otherwise default to 'files/tmp' or 'files\\tmp';
949
    $temporary_directory = $temporary_directory ? $temporary_directory : file_directory_path() . $path_delimiter .'tmp';
950
951
952
953
954
955
956
957
    variable_set('file_directory_temp', $temporary_directory);
  }

  return $temporary_directory;
}

/**
 * Determine the default 'files' directory.
958
959
 *
 * @return A string containing the path to Drupal's 'files' directory.
960
961
 */
function file_directory_path() {
962
  return variable_get('file_directory_path', conf_path() .'/files');
963
964
}

965
966
967
968
/**
 * Determine the maximum file upload size by querying the PHP settings.
 *
 * @return
Dries's avatar
   
Dries committed
969
 *   A file size limit in bytes based on the PHP upload_max_filesize and post_max_size
970
971
972
 */
function file_upload_max_size() {
  static $max_size = -1;
973

974
  if ($max_size < 0) {
975
    $upload_max = parse_size(ini_get('upload_max_filesize'));
976
    $post_max = parse_size(ini_get('post_max_size'));
977
978
979
980
    $max_size = ($upload_max < $post_max) ? $upload_max : $post_max;
  }
  return $max_size;
}