class backup_migrate_destination_files in Backup and Migrate 7.3

A destination type for saving locally to the server.

Hierarchy

• class \backup_migrate_item
  • class \backup_migrate_location
    • class \backup_migrate_destination
      • class \backup_migrate_destination_files

1 string reference to 'backup_migrate_destination_files'

backup_migrate_backup_migrate_destination_subtypes in includes/destinations.inc

Implements hook_backup_migrate_destination_subtypes().

File

includes/destinations.file.inc, line 13

A destination type for saving locally to the server.

class backup_migrate_destination_files extends backup_migrate_destination {
  public $supported_ops = array(
    'scheduled backup',
    'manual backup',
    'local backup',
    'restore',
    'list files',
    'configure',
    'delete',
  );

  /**
   *
   */
  public function type_name() {
    return t("Server Directory");
  }

  /**
   * Get the file location.
   */
  public function get_realpath() {
    if ($realpath = drupal_realpath($this
      ->get_location())) {
      return $realpath;
    }
    return $this
      ->get_location();
  }

  /**
   * File save destination callback.
   */
  public function _save_file($file, $settings) {
    if ($this
      ->confirm_destination() && ($dir = $this
      ->get_location())) {
      $filepath = rtrim($dir, "/") . "/" . $file
        ->filename();

      // Allow files to be overwritten by the filesystem.
      $replace_method = $settings->append_timestamp == 2 ? FILE_EXISTS_REPLACE : FILE_EXISTS_RENAME;

      // Copy the file if there are multiple destinations.
      if (count($settings
        ->get_destinations()) > 1) {
        file_unmanaged_copy($file
          ->filepath(), $filepath, $replace_method);
      }
      else {
        file_unmanaged_move($file
          ->filepath(), $filepath, $replace_method);
      }

      // chmod, chown and chgrp the file if needed.
      if ($chmod = $this
        ->settings('chmod')) {
        if (!@drupal_chmod($filepath, octdec($chmod))) {
          _backup_migrate_message('Unable to set the file mode for: @file', array(
            '@file' => $filepath,
          ), 'error');
        }
      }
      if ($chgrp = $this
        ->settings('chgrp')) {
        if (!@chgrp($filepath, $chgrp)) {
          _backup_migrate_message('Unable to set the file group for: @file', array(
            '@file' => $filepath,
          ), 'error');
        }
      }
      return $file;
    }
  }

  /**
   * Determine if we can read the given file.
   */
  public function can_read_file($file_id) {
    return $this
      ->op('restore') && is_readable($this
      ->get_filepath($file_id));
  }

  /**
   * File load destination callback.
   */
  public function load_file($file_id) {
    $filepath = $this
      ->get_filepath($file_id);
    if (file_exists($filepath)) {
      require_once dirname(__FILE__) . '/files.inc';
      return new backup_file(array(
        'filepath' => $filepath,
      ));
    }
  }

  /**
   * Get the file object for the given file.
   */
  public function get_file($file_id) {
    $files = $this
      ->list_files();
    if (isset($files[$file_id])) {
      isset($files[$file_id]);
    }
    return NULL;
  }

  /**
   * File list destination callback.
   */
  public function _list_files() {
    $files = array();
    if ($dir = $this
      ->get_realpath()) {
      if ($handle = @opendir($dir)) {
        require_once dirname(__FILE__) . '/files.inc';
        while (FALSE !== ($file = readdir($handle))) {
          if (substr($file, 0, 1) !== '.') {
            $filepath = $dir . "/" . $file;
            $files[$file] = new backup_file(array(
              'filepath' => $filepath,
            ));
          }
        }
      }
    }
    return $files;
  }

  /**
   * File delete destination callback.
   */
  public function _delete_file($file_id) {
    $filepath = $this
      ->get_filepath($file_id);
    file_unmanaged_delete($filepath);
  }

  /**
   * Get the filepath from the given file id.
   */
  public function get_filepath($file_id) {
    if ($dir = $this
      ->get_realpath()) {
      $filepath = rtrim($dir, '/') . '/' . $file_id;
      return $filepath;
    }
    return FALSE;
  }

  /**
   * Get the form for the settings for the files destination.
   */
  public function edit_form() {
    $form = parent::edit_form();
    $form['location'] = array(
      "#type" => "textfield",
      "#title" => t("Directory path"),
      "#default_value" => $this
        ->get_location(),
      "#required" => TRUE,
      "#description" => t('Enter the path to the directory to save the backups to. Use a relative path to pick a path relative to your Drupal root directory. The web server must be able to write to this path.'),
    );
    $form['settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Advanced Settings'),
      '#tree' => TRUE,
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    if (function_exists('chmod')) {
      $form['settings']['chmod'] = array(
        '#type' => 'textfield',
        '#title' => t('Change file mode (chmod)'),
        '#size' => 5,
        '#default_value' => $this
          ->settings('chmod'),
        '#description' => t('If you enter a value here, backup files will be chmoded with the mode you specify. Specify the mode in octal form (e.g. 644 or 0644) or leave blank to disable this feature.'),
      );
    }
    if (function_exists('chgrp')) {
      $form['settings']['chgrp'] = array(
        '#type' => 'textfield',
        '#title' => t('Change file group (chgrp)'),
        '#size' => 5,
        '#default_value' => $this
          ->settings('chgrp'),
        '#description' => t('If you enter a value here, backup files will be chgrped to the group you specify. Leave blank to disable this feature.'),
      );
    }
    return $form;
  }

  /**
   * Validate the form for the settings for the files destination.
   */
  public function edit_form_validate($form, &$form_state) {
    $values = $form_state['values'];
    if (isset($values['settings']['chmod']) && !empty($values['settings']['chmod']) && !preg_match('/0?[0-7]{3}/', $values['settings']['chmod'])) {
      form_set_error('chmod', t('You must enter a valid chmod octal value (e.g. 644 or 0644) in the change mode field, or leave it blank.'));
    }
    parent::edit_form_validate($form, $form_state);
  }

  /**
   * Submit the form for the settings for the files destination.
   */
  public function edit_form_submit($form, &$form_state) {

    // Add a 0 to the start of a 3 digit file mode to make it proper PHP encoded octal.
    if (strlen($form_state['values']['settings']['chmod']) == 3) {
      $form_state['values']['settings']['chmod'] = '0' . $form_state['values']['settings']['chmod'];
    }
    parent::edit_form_submit($form, $form_state);
  }

  /**
   * Check that a destination is valid.
   */
  public function confirm_destination() {
    if ($dir = $this
      ->get_location()) {
      return $this
        ->check_dir($dir);
    }
    return FALSE;
  }

  /**
   * Prepare the destination directory for the backups.
   */
  public function check_dir($directory) {
    if (!file_prepare_directory($directory, FILE_CREATE_DIRECTORY)) {

      // Unable to create destination directory.
      _backup_migrate_message("Unable to create or write to the save directory '%directory'. Please check the file permissions of that directory and try again.", array(
        '%directory' => $directory,
      ), "error");
      return FALSE;
    }

    // If the destination directory is within the webroot, then secure it as best we can.
    if ($this
      ->dir_in_webroot($directory)) {
      $directory = $this
        ->check_web_dir($directory);
    }
    return $directory;
  }

  /**
   * Check that a web accessible directory has been properly secured, othewise attempt to secure it.
   */
  public function check_web_dir($directory) {

    // Check if the file has already been tested.
    if (is_file($directory . '/tested.txt')) {
      return $directory;
    }
    else {
      file_create_htaccess($directory, TRUE);

      // Check the user agent to make sure we're not responding to a request from drupal itself.
      // That should prevent infinite loops which could be caused by poormanscron in some circumstances.
      if (strpos($_SERVER['HTTP_USER_AGENT'], 'Drupal') !== FALSE) {
        return FALSE;
      }

      // Check to see if the destination is publicly accessible.
      $test_contents = "this file should not be publicly accessible";

      // Create the the text.txt file if it's not already there.
      if (!is_file($directory . '/test.txt') || file_get_contents($directory . '/test.txt') != $test_contents) {
        if ($fp = fopen($directory . '/test.txt', 'w')) {
          @fputs($fp, $test_contents);
          fclose($fp);
        }
        else {
          $message = t("Security notice: Backup and Migrate was unable to write a test text file to the destination directory %directory, and is therefore unable to check the security of the backup destination. Backups to the server will be disabled until the destination becomes writable and secure.", array(
            '%directory' => $directory,
          ));
          drupal_set_message($message, "error");
          return FALSE;
        }
      }

      // Attempt to read the test file via http. This may fail for other
      // reasons, so it's not a bullet-proof check.
      if ($this
        ->test_file_readable_remotely($directory . '/test.txt', $test_contents)) {
        $message = t("Security notice: Backup and Migrate will not save backup files to the server because the destination directory is publicly accessible. If you want to save files to the server, please secure the '%directory' directory", array(
          '%directory' => $directory,
        ));
        drupal_set_message($message, "error");
        unlink($directory . '/test.txt');
        return FALSE;
      }

      // Directory tested OK, so we mark it as tested.
      if ($fp = fopen($directory . '/tested.txt', 'w')) {
        $contents = t('The presence of this file indicates that this directory has been tested as safe to use as a destination for Backup and Migrate. If you change the permissions of this directory or change your web server settings, please delete this file so that the directory can be checked again.');
        @fputs($fp, $contents);
        fclose($fp);
      }
      return $directory;
    }
  }

  /**
   * Check if the given directory is within the webroot and is therefore web accessible.
   */
  public function dir_in_webroot($directory) {
    $real_dir = drupal_realpath($directory);
    $real_root = drupal_realpath(DRUPAL_ROOT);
    if ($real_dir == $real_root || strpos($real_dir, $real_root . '/') === 0) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Check if a file can be read remotely via http.
   */
  public function test_file_readable_remotely($directory, $contents) {
    $real_dir = drupal_realpath($directory);
    $real_root = drupal_realpath(DRUPAL_ROOT);
    if ($real_dir && $real_root) {

      // Get the root relative path.
      $path = substr($real_dir, strlen($real_root));
      $url = $GLOBALS['base_url'] . str_replace('\\', '/', $path);
      $result = drupal_http_request($url);
      if (!empty($result->data) && strpos($result->data, $contents) !== FALSE) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_destination::$cache_expire	public	property	24 hours, i.e. 24 * 60 * 60 seconds.
backup_migrate_destination::$cache_files	public	property		1
backup_migrate_destination::$db_table	public	property	Overrides backup_migrate_location::$db_table
backup_migrate_destination::$default_values	public	property	Overrides backup_migrate_location::$default_values
backup_migrate_destination::$destination_type	public	property
backup_migrate_destination::$fetch_time	public	property
backup_migrate_destination::$plural	public	property	Overrides backup_migrate_location::$plural
backup_migrate_destination::$singular	public	property	Overrides backup_migrate_location::$singular
backup_migrate_destination::$title_plural	public	property	Overrides backup_migrate_location::$title_plural
backup_migrate_destination::$title_singular	public	property	Overrides backup_migrate_location::$title_singular
backup_migrate_destination::$type_name	public	property	Overrides backup_migrate_location::$type_name
backup_migrate_destination::$weight	public	property		1
backup_migrate_destination::can_delete_file	public	function	Determine if we can read the given file.
backup_migrate_destination::count_files	public	function	Count all the available files in the given destination.
backup_migrate_destination::create_info_file	public	function	Create an ini file and write the meta data.
backup_migrate_destination::delete_confirm_message	public	function	Get a message to send to the user when confirming the deletion of the item. Overrides backup_migrate_location::delete_confirm_message
backup_migrate_destination::delete_file	public	function	Delete the file with the given destination specific id.
backup_migrate_destination::file_cache_clear	public	function	Retrieve the file list.
backup_migrate_destination::file_cache_get	public	function	Retrieve the file list.
backup_migrate_destination::file_cache_set	public	function	Cache the file list.
backup_migrate_destination::file_exists	public	function	Check if the file exists in the list of available files.
backup_migrate_destination::get_action_links	public	function	Get the action links for a destination. Overrides backup_migrate_location::get_action_links
backup_migrate_destination::get_file_links	public	function	Get the action links for a file on a given destination.
backup_migrate_destination::get_menu_items	public	function	Add the menu items specific to the destination type. Overrides backup_migrate_item::get_menu_items
backup_migrate_destination::get_remote	public	function	Get a boolean representing if the destination is remote or local.
backup_migrate_destination::list_files	public	function	List all the available files in the given destination.
backup_migrate_destination::load_files_info	public	function	Load up the file's metadata from the accompanying .info file if applicable.
backup_migrate_destination::save_file	public	function	Save the given file to the destination.	3
backup_migrate_destination::save_file_info	public	function	Save the file metadata.
backup_migrate_destination::settings_default	public	function	Get the form for the settings for this destination type. Overrides backup_migrate_location::settings_default
backup_migrate_destination::settings_form	public	function	Get the form for the settings for this destination. Overrides backup_migrate_location::settings_form
backup_migrate_destination::settings_form_submit	public	function	Submit the settings form. Any values returned will be saved. Overrides backup_migrate_location::settings_form_submit
backup_migrate_destination::settings_form_validate	public	function	Validate the form for the settings for this destination. Overrides backup_migrate_location::settings_form_validate	1
backup_migrate_destination::strings	public	function	This function is not supposed to be called. Overrides backup_migrate_location::strings
backup_migrate_destination::_file_info_file	public	function	Create the info file object.
backup_migrate_destination::_file_info_filename	public	function	Determine the file name of the info file for a file.
backup_migrate_destination_files::$supported_ops	public	property	Overrides backup_migrate_destination::$supported_ops	2
backup_migrate_destination_files::can_read_file	public	function	Determine if we can read the given file. Overrides backup_migrate_destination::can_read_file
backup_migrate_destination_files::check_dir	public	function	Prepare the destination directory for the backups.
backup_migrate_destination_files::check_web_dir	public	function	Check that a web accessible directory has been properly secured, othewise attempt to secure it.
backup_migrate_destination_files::confirm_destination	public	function	Check that a destination is valid. Overrides backup_migrate_destination::confirm_destination
backup_migrate_destination_files::dir_in_webroot	public	function	Check if the given directory is within the webroot and is therefore web accessible.
backup_migrate_destination_files::edit_form	public	function	Get the form for the settings for the files destination. Overrides backup_migrate_destination::edit_form
backup_migrate_destination_files::edit_form_submit	public	function	Submit the form for the settings for the files destination. Overrides backup_migrate_item::edit_form_submit
backup_migrate_destination_files::edit_form_validate	public	function	Validate the form for the settings for the files destination. Overrides backup_migrate_item::edit_form_validate
backup_migrate_destination_files::get_file	public	function	Get the file object for the given file.
backup_migrate_destination_files::get_filepath	public	function	Get the filepath from the given file id.
backup_migrate_destination_files::get_realpath	public	function	Get the file location.
backup_migrate_destination_files::load_file	public	function	File load destination callback. Overrides backup_migrate_destination::load_file
backup_migrate_destination_files::test_file_readable_remotely	public	function	Check if a file can be read remotely via http.
backup_migrate_destination_files::type_name	public	function
backup_migrate_destination_files::_delete_file	public	function	File delete destination callback. Overrides backup_migrate_destination::_delete_file
backup_migrate_destination_files::_list_files	public	function	File list destination callback. Overrides backup_migrate_destination::_list_files
backup_migrate_destination_files::_save_file	public	function	File save destination callback. Overrides backup_migrate_destination::_save_file
backup_migrate_item::$settings_path	public	property
backup_migrate_item::$show_in_list	public	property
backup_migrate_item::$storage	public	property
backup_migrate_item::all_items	public	function	Get all of the given items.
backup_migrate_item::decode_db_row	public	function	Decode a loaded db row (unserialize necessary fields).
backup_migrate_item::delete	public	function	Delete the item from the database.
backup_migrate_item::export	public	function	Return as an exported array of values.
backup_migrate_item::from_array	public	function	Load an existing item from an array.
backup_migrate_item::generate_id	public	function	Return a random (very very likely unique) string id for a new item.
backup_migrate_item::get	public	function	Get the member with the given key.
backup_migrate_item::get_actions	public	function	Get the rendered action links for a destination.
backup_migrate_item::get_default_values	public	function	Get the default values for standard parameters.	2
backup_migrate_item::get_id	public	function	Get the primary id for this item (if any is set).
backup_migrate_item::get_list	public	function	Get a table of all items of this type.	1
backup_migrate_item::get_list_header	public	function	Get header for a lost of this type.
backup_migrate_item::get_machine_name_field	public	function	Get the machine name field name from the schema.
backup_migrate_item::get_primary_key	public	function	Get the primary key field title from the schema.
backup_migrate_item::get_schema	public	function	Get the schema for the item type.
backup_migrate_item::get_serialized_fields	public	function	Return the fields which must be serialized before saving to the db.
backup_migrate_item::get_settings_path	public	function	Get the columns needed to list the type.	1
backup_migrate_item::item	public	function	A particular item.
backup_migrate_item::item_exists	public	function	A particular item.
backup_migrate_item::load_row	public	function	Load an existing item from an database (serialized) array.
backup_migrate_item::revert_confirm_message	public	function	The message to send to the user when confirming the deletion of the item.
backup_migrate_item::save	public	function	Save the item to the database.
backup_migrate_item::set_id	public	function	Set the primary id for this item (if any is set).
backup_migrate_item::show_in_list	public	function	Get the columns needed to list the type.
backup_migrate_item::to_array	public	function	Return as an array of values.	1
backup_migrate_item::unique_id	public	function	Make sure this item has a unique id.
backup_migrate_item::_merge_defaults	public	function	Merge parameters with the given defaults.
backup_migrate_item::__construct	public	function	Set the basic info pulled from the db or generated programatically.	5
backup_migrate_location::$subtype	public	property
backup_migrate_location::backup_settings_default	public	function	Get the form for the settings for this filter.	3
backup_migrate_location::backup_settings_form	public	function	Get the form for the settings for this filter.	3
backup_migrate_location::backup_settings_form_submit	public	function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::backup_settings_form_validate	public	function	Get the form for the settings for this filter.
backup_migrate_location::create	public	function	Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::file_types	public	function	Retrieve a list of filetypes supported by this source/destination.	3
backup_migrate_location::get_display_location	public	function		3
backup_migrate_location::get_list_column_info	public	function	Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_location::get_list_row	public	function	Get a row of data to be used in a list of items of this type. Overrides backup_migrate_item::get_list_row	1
backup_migrate_location::get_location	public	function		3
backup_migrate_location::get_name	public	function	Get the name of the item. Overrides backup_migrate_item::get_name
backup_migrate_location::get_subtype_name	public	function	Get the type name of this location for display to the user.
backup_migrate_location::glue_url	public	function	Glue a URLs component parts back into a URL.
backup_migrate_location::location_types	public	function	Get the available location types.	1
backup_migrate_location::op	public	function	Does this location support the given operation.
backup_migrate_location::ops	public	function
backup_migrate_location::remove_op	public	function	Remove the given op from the support list.
backup_migrate_location::restore_settings_default	public	function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form	public	function	Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form_submit	public	function	Submit the settings form. Any values returned will be saved.
backup_migrate_location::restore_settings_form_validate	public	function	Get the form for the settings for this filter.
backup_migrate_location::settings	public	function
backup_migrate_location::set_location	public	function		3
backup_migrate_location::set_name	public	function
backup_migrate_location::set_url	public	function	Break a URL into it's component parts.
backup_migrate_location::url	public	function	Get a url from the parts.