You are here

Home » API reference » Backup and Migrate 7.3 » sources.filesource.inc

class backup_migrate_destination_filesource in Backup and Migrate 7.3

Same name and namespace in other branches
  1. 8.3 includes/sources.filesource.inc \backup_migrate_destination_filesource
  2. 6.3 includes/sources.filesource.inc \backup_migrate_destination_filesource

A destination type for saving locally to the server.

Hierarchy

Expanded class hierarchy of backup_migrate_destination_filesource

1 string reference to 'backup_migrate_destination_filesource'
backup_migrate_backup_migrate_source_subtypes in includes/sources.inc
Implements hook_backup_migrate_source_subtypes().

File

includes/sources.filesource.inc, line 13
A destination type for saving locally to the server.

View source 
class backup_migrate_destination_filesource extends backup_migrate_source {
  public $supported_ops = array(
    'restore',
    'configure',
    'delete',
    'source',
  );

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

  /**
   * Declares the current files directory as a backup source..
   */
  public function sources() {
    $out = array();
    $out['files'] = backup_migrate_create_destination('filesource', array(
      'machine_name' => 'files',
      'location' => 'public://',
      'name' => t('Public Files Directory'),
      'show_in_list' => FALSE,
    ));
    if (variable_get('file_private_path', FALSE)) {
      $out['files_private'] = backup_migrate_create_destination('filesource', array(
        'machine_name' => 'files',
        'location' => 'private://',
        'name' => t('Private Files Directory'),
        'show_in_list' => FALSE,
      ));
    }
    return $out;
  }

  /**
   * Gets 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 back up. Use a relative path to pick a path relative to your Drupal root directory. The web server must be able to read from this path.'),
    );
    return $form;
  }

  /**
   * Returns a list of backup filetypes.
   */
  public function file_types() {
    return array(
      "tar" => array(
        "extension" => "tar",
        "filemime" => "application/x-tar",
        "backup" => TRUE,
        "restore" => TRUE,
      ),
    );
  }

  /**
   * Gets the form for the settings for this destination.
   *
   * Return the default directories whose data can be ignored. These directories
   * contain info which can be easily reproducted. Also exclude the backup and
   * migrate folder to prevent exponential bloat.
   */
  public function backup_settings_default() {
    return array(
      'exclude_filepaths' => "backup_migrate\nstyles\ncss\njs\nctools\nless\nlanguages\nadvagg_css\nadvagg_js",
    );
  }

  /**
   * Get the form for the backup settings for this destination.
   */
  public function backup_settings_form($settings) {
    $form['exclude_filepaths'] = array(
      "#type" => "textarea",
      "#multiple" => TRUE,
      "#title" => t("Exclude the following files or directories"),
      "#default_value" => isset($settings['exclude_filepaths']) ? $settings['exclude_filepaths'] : '',
      "#description" => t("A list of files or directories to be excluded from backups. Add one path per line relative to the directory being backed up."),
    );
    return $form;
  }

  /**
   * Backup from this source.
   */
  public function backup_to_file($file, $settings) {
    if ($out = $this
      ->_backup_to_file_cli($file, $settings)) {
      return $out;
    }
    else {
      return $this
        ->_backup_to_file_php($file, $settings);
    }
  }

  /**
   * Backup from this source.
   */
  public function _backup_to_file_php($file, $settings) {
    if ($this
      ->check_libs()) {
      $excluded = $this
        ->get_excluded_paths($settings);
      $files = $this
        ->get_files_to_backup($this
        ->get_realpath(), $settings, $excluded);
      if ($files) {
        $file
          ->push_type('tar');
        $gz = new Archive_Tar($file
          ->filepath(), FALSE);
        $gz
          ->addModify($files, '', $this
          ->get_realpath());
        return $file;
      }
      backup_migrate_backup_fail('No files available.', array(), $settings);
      return FALSE;
    }
    return FALSE;
  }

  /**
   * Backup from this source.
   */
  public function _backup_to_file_cli($file, $settings) {
    if (!empty($settings->filters['use_cli']) && function_exists('backup_migrate_exec') && function_exists('escapeshellarg')) {
      $excluded = $this
        ->get_excluded_paths($settings);
      $exclude = array();
      foreach ($excluded as $path) {
        $exclude[] = '--exclude=' . escapeshellarg($path);
      }
      $exclude = implode(' ', $exclude);

      // Create a symlink in a temp directory so we can rename the file in the
      // archive.
      $temp = backup_migrate_temp_directory();
      $file
        ->push_type('tar');
      backup_migrate_exec("tar --dereference -C %input -rf %output {$exclude} .", array(
        '%output' => $file
          ->filepath(),
        '%input' => $this
          ->get_realpath(),
        '%temp' => $temp,
      ));
      return $file;
    }
    return FALSE;
  }

  /**
   * Restore to this source.
   */
  public function restore_from_file($file, &$settings) {
    if ($out = $this
      ->_restore_from_file_cli($file, $settings)) {
      return $out;
    }
    else {
      return $this
        ->_restore_from_file_php($file, $settings);
    }
  }

  /**
   * Restore to this source.
   */
  public function _restore_from_file_php($file, &$settings) {
    if ($this
      ->check_libs()) {
      $from = $file
        ->pop_type();
      $temp = backup_migrate_temp_directory();
      $tar = new Archive_Tar($from
        ->filepath());
      $tar
        ->extractModify($temp, $file->name);

      // Older B&M Files format included a base 'files' directory.
      if (file_exists($temp . '/files')) {
        $temp = $temp . '/files';
      }
      if (file_exists($temp . '/' . $file->name . '/files')) {
        $temp = $temp . '/files';
      }

      // Move the files from the temp directory.
      _backup_migrate_move_files($temp, $this
        ->get_realpath());
      return $file;
    }
    return FALSE;
  }

  /**
   * Restore to this source.
   */
  public function _restore_from_file_cli($file, &$settings) {
    if (!empty($settings->filters['use_cli']) && function_exists('backup_migrate_exec')) {
      $temp = backup_migrate_temp_directory();
      backup_migrate_exec("tar -C %temp -xf %input", array(
        '%input' => $file
          ->filepath(),
        '%temp' => $temp,
      ));

      // Older B&M Files format included a base 'files' directory.
      if (file_exists($temp . '/files')) {
        $temp = $temp . '/files';
      }
      if (file_exists($temp . '/' . $file->name . '/files')) {
        $temp = $temp . '/files';
      }

      // Move the files from the temp directory.
      backup_migrate_exec("mv -rf %temp/* %output", array(
        '%output' => $this
          ->get_realpath(),
        '%temp' => $temp,
      ));
      return $file;
    }
    return FALSE;
  }

  /**
   * Gets a list of files to backup from the given set if dirs.
   *
   * Exclude any that match the array $exclude.
   */
  public function get_files_to_backup($dir, $settings, $exclude = array()) {
    $out = $errors = array();
    if (!file_exists($dir)) {
      backup_migrate_backup_fail('Directory %dir does not exist.', array(
        '%dir' => $dir,
      ), $settings);
      return FALSE;
    }
    if ($handle = @opendir($dir)) {
      while (($file = readdir($handle)) !== FALSE) {
        if ($file != '.' && $file != '..' && !in_array($file, $exclude)) {
          $real = realpath($dir . '/' . $file);

          // If the path is not excluded.
          if (!in_array($real, $exclude)) {
            if (is_dir($real)) {
              $subdir = $this
                ->get_files_to_backup($real, $settings, $exclude);

              // If there was an error reading the subdirectory then abort the
              // backup.
              if ($subdir === FALSE) {
                closedir($handle);
                return FALSE;
              }

              // If the directory is empty, add an empty directory.
              if (count($subdir) == 0) {
                $out[] = $real;
              }
              $out = array_merge($out, $subdir);
            }
            else {
              if (is_readable($real)) {
                $out[] = $real;
              }
              else {
                $errors[] = $dir . '/' . $file;
              }
            }
          }
        }
      }
      closedir($handle);
    }
    else {
      backup_migrate_backup_fail('Could not open directory %dir', array(
        '%dir' => $dir,
      ), $settings);
      return FALSE;
    }

    // Alert the user to any errors there might have been.
    if ($errors) {
      if (count($errors < 5)) {
        $filesmsg = t('The following files: !files', array(
          '!files' => theme('item_list', array(
            'items' => $errors,
          )),
        ));
      }
      else {
        $filesmsg = t('!count files', array(
          '!count' => count($errors),
        ));
      }
      if (empty($settings->filters['ignore_errors'])) {
        backup_migrate_backup_fail('The backup could not be completed because !files could not be read. If you want to skip unreadable files use the \'Ignore Errors\' setting under \'Advanced Options\' in \'Advanced Backup\' or in your schedule settings profile.', array(
          '!files' => $filesmsg,
        ), 'error');
        $out = FALSE;
      }
      else {
        backup_migrate_backup_fail('!files could not be read and were skipped', array(
          '!files' => $filesmsg,
        ), 'error');
      }
    }
    return $out;
  }

  /**
   * Breaks the excluded paths string into a usable list of paths.
   */
  public function get_excluded_paths($settings) {
    $base_dir = $this
      ->get_realpath() . '/';
    $paths = empty($settings->filters['exclude_filepaths']) ? '' : $settings->filters['exclude_filepaths'];
    $out = explode("\n", $paths);
    foreach ($out as $key => $val) {
      $path = trim($val, "/ \t\r\n");

      // If the path specified is a stream url or absolute path add the
      // normalized version.
      if ($real = drupal_realpath($path)) {
        $out[$key] = $real;
      }
      elseif ($real = drupal_realpath($base_dir . $path)) {
        $out[$key] = $real;
      }
      else {
        $out[$key] = $path;
      }
    }
    return $out;
  }

  /**
   * Checks that the required libraries are installed.
   */
  public function check_libs() {
    $result = TRUE;

    // Drupal 7 has Archive_Tar built in so there should be no need to include
    // anything here.
    return $result;
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
backup_migrate_destination_filesource::$supported_ops public property Overrides backup_migrate_location::$supported_ops 1
backup_migrate_destination_filesource::backup_settings_default public function Gets the form for the settings for this destination. Overrides backup_migrate_location::backup_settings_default 1
backup_migrate_destination_filesource::backup_settings_form public function Get the form for the backup settings for this destination. Overrides backup_migrate_location::backup_settings_form
backup_migrate_destination_filesource::backup_to_file public function Backup from this source.
backup_migrate_destination_filesource::check_libs public function Checks that the required libraries are installed.
backup_migrate_destination_filesource::edit_form public function Gets the form for the settings for the files destination. Overrides backup_migrate_location::edit_form
backup_migrate_destination_filesource::file_types public function Returns a list of backup filetypes. Overrides backup_migrate_location::file_types 1
backup_migrate_destination_filesource::get_excluded_paths public function Breaks the excluded paths string into a usable list of paths.
backup_migrate_destination_filesource::get_files_to_backup public function Gets a list of files to backup from the given set if dirs.
backup_migrate_destination_filesource::get_realpath public function Get the file location.
backup_migrate_destination_filesource::restore_from_file public function Restore to this source.
backup_migrate_destination_filesource::sources public function Declares the current files directory as a backup source.. 1
backup_migrate_destination_filesource::type_name public function 1
backup_migrate_destination_filesource::_backup_to_file_cli public function Backup from this source. 1
backup_migrate_destination_filesource::_backup_to_file_php public function Backup from this source. 1
backup_migrate_destination_filesource::_restore_from_file_cli public function Restore to this source. 1
backup_migrate_destination_filesource::_restore_from_file_php public function Restore to this source. 1
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::edit_form_submit public function Submit the edit form for the item. 5
backup_migrate_item::edit_form_validate public function Validate the edit form for the item. 4
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_menu_items public function Get the menu items for manipulating this type. 2
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::$default_values public property Overrides backup_migrate_item::$default_values 1
backup_migrate_location::$subtype public property
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::can_read_file public function Determine if we can read the given file. 1
backup_migrate_location::create public function Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::delete_confirm_message public function Get the message to send to the user when confirming the deletion of the item. Overrides backup_migrate_item::delete_confirm_message 1
backup_migrate_location::get_action_links public function Get the action links for a location. Overrides backup_migrate_item::get_action_links 1
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::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::settings_default public function Get the form for the settings for this location type. 1
backup_migrate_location::settings_form public function Get the form for the settings for this location. 1
backup_migrate_location::settings_form_submit public function Submit the settings form. Any values returned will be saved. 1
backup_migrate_location::settings_form_validate public function Validate the form for the settings for this location. 1
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.
backup_migrate_source::$db_table public property Overrides backup_migrate_location::$db_table
backup_migrate_source::$plural public property Overrides backup_migrate_location::$plural
backup_migrate_source::$singular public property Overrides backup_migrate_location::$singular
backup_migrate_source::$title_plural public property Overrides backup_migrate_location::$title_plural
backup_migrate_source::$title_singular public property Overrides backup_migrate_location::$title_singular
backup_migrate_source::$type_name public property Overrides backup_migrate_location::$type_name
backup_migrate_source::location_types public function Get the available location types. Overrides backup_migrate_location::location_types
backup_migrate_source::strings public function This function is not supposed to be called. Overrides backup_migrate_location::strings