function file_check_directory

Check that directory exists and is writable.

Parameters

$directory Path to extract and verify directory for.:

$mode Try to create the directory if it does not exist.:

$form_item Optional name for a field item to attach potential errors to.:

Return value

False when directory not found, or true when directory exists.

Related topics

File

includes/file.inc, line 80

API for handling file uploads and server file management.

Code

function file_check_directory(&$directory, $mode = 0, $form_item = NULL) {
  $directory = rtrim($directory, '/\\');

  // Check if directory exists.
  if (!is_dir($directory)) {
    if ($mode & FILE_CREATE_DIRECTORY && @mkdir($directory, 0760)) {
      drupal_set_message(t('Created directory %directory.', array(
        '%directory' => theme('placeholder', $directory),
      )));
    }
    else {
      if ($form_item) {
        form_set_error($form_item, t('The directory %directory does not exist.', array(
          '%directory' => theme('placeholder', $directory),
        )));
      }
      return false;
    }
  }

  // Check to see if the directory is writable.
  if (!is_writable($directory)) {
    if ($mode & FILE_MODIFY_PERMISSIONS && @chmod($directory, 0760)) {
      drupal_set_message(t('Modified permissions on directory %directory.', array(
        '%directory' => theme('placeholder', $directory),
      )));
    }
    else {
      form_set_error($form_item, t('The directory %directory is not writable.', array(
        '%directory' => theme('placeholder', $directory),
      )));
      return false;
    }
  }
  if ((variable_get('file_directory_temp', FILE_DIRECTORY_TEMP) == $directory || variable_get('file_directory_path', 'files') == $directory) && !is_file("{$directory}/.htaccess")) {
    $htaccess_lines = "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\nOptions None\n<IfModule mod_rewrite.c>\n  RewriteEngine off\n</IfModule>";
    if (($fp = fopen("{$directory}/.htaccess", 'w')) && fputs($fp, $htaccess_lines)) {
      fclose($fp);
    }
    else {
      $message = 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>", array(
        '%directory' => theme('placeholder', $directory),
        '%htaccess' => '<br />' . str_replace("\n", '<br />', check_plain($htaccess_lines)),
      ));
      form_set_error($form_item, $message);
      watchdog('security', $message, WATCHDOG_ERROR);
    }
  }
  return true;
}