You are here

class backup_migrate_destination_ftp in Backup and Migrate 7.3

Same name and namespace in other branches
  1. 8.2 includes/destinations.ftp.inc \backup_migrate_destination_ftp
  2. 8.3 includes/destinations.ftp.inc \backup_migrate_destination_ftp
  3. 6.3 includes/destinations.ftp.inc \backup_migrate_destination_ftp
  4. 6.2 includes/destinations.ftp.inc \backup_migrate_destination_ftp
  5. 7.2 includes/destinations.ftp.inc \backup_migrate_destination_ftp

A destination for sending database backups to an FTP server.

Hierarchy

Expanded class hierarchy of backup_migrate_destination_ftp

1 string reference to 'backup_migrate_destination_ftp'
backup_migrate_backup_migrate_destination_subtypes in includes/destinations.inc
Implements hook_backup_migrate_destination_subtypes().

File

includes/destinations.ftp.inc, line 13
Functions to handle the FTP backup destination.

View source
class backup_migrate_destination_ftp extends backup_migrate_destination_remote {
  public $supported_ops = array(
    'scheduled backup',
    'manual backup',
    'remote backup',
    'restore',
    'list files',
    'configure',
    'delete',
  );
  public $ftp = NULL;

  /**
   * Save to the ftp destination.
   */
  public function _save_file($file, $settings) {
    $ftp = $this
      ->ftp_object();
    if (drupal_ftp_file_to_ftp($file
      ->filepath(), $file
      ->filename(), '.', $ftp)) {
      return $file;
    }
    return FALSE;
  }

  /**
   * Load from the ftp destination.
   */
  public function load_file($file_id) {
    require_once dirname(__FILE__) . '/files.inc';
    $file = new backup_file(array(
      'filename' => $file_id,
    ));
    $this
      ->ftp_object();
    if (drupal_ftp_ftp_to_file($file
      ->filepath(), $file_id, '.', $this->ftp)) {
      return $file;
    }
    return FALSE;
  }

  /**
   * Delete from the ftp destination.
   */
  public function _delete_file($file_id) {
    $this
      ->ftp_object();
    drupal_ftp_delete_file($file_id, $this->ftp);
  }

  /**
   *
   */
  public function _list_files() {
    require_once dirname(__FILE__) . '/files.inc';
    $files = array();
    $this
      ->ftp_object();
    $ftp_files = (array) drupal_ftp_file_list('.', $this->ftp);
    foreach ($ftp_files as $file) {
      $files[$file['filename']] = new backup_file($file);
    }
    return $files;
  }

  /**
   * Get the form for the settings for this filter.
   */
  public function edit_form() {
    $form = parent::edit_form();
    $form['scheme']['#type'] = 'value';
    $form['scheme']['#value'] = 'ftp';
    $form['port'] = array(
      "#type" => "textfield",
      "#title" => t("Port"),
      "#default_value" => @$this->dest_url['port'] ? $this->dest_url['port'] : '21',
      "#weight" => 15,
    );
    $form['pasv'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use PASV transfers'),
      '#default_value' => $this
        ->get_pasv(),
      '#weight' => 50,
    );
    return $form;
  }

  /**
   *
   */
  public function set_pasv($value) {
    $this->settings['pasv'] = (bool) $value;
  }

  /**
   *
   */
  public function get_pasv() {
    return isset($this->settings['pasv']) ? $this->settings['pasv'] : FALSE;
  }

  /**
   *
   */
  public function ftp_object() {
    if (!$this->ftp) {
      $this->dest_url['port'] = empty($this->dest_url['port']) ? '21' : $this->dest_url['port'];
      $this->dest_url['pasv'] = $this
        ->get_pasv();
      $this->ftp = drupal_ftp_ftp_object($this->dest_url['host'], $this->dest_url['port'], $this->dest_url['user'], $this->dest_url['pass'], $this->dest_url['path'], $this->dest_url['pasv']);
    }
    return $this->ftp;
  }

}

Members

Namesort descending 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::can_read_file public function Determine if we can read the given file. Overrides backup_migrate_location::can_read_file 1
backup_migrate_destination::confirm_destination public function Check that a destination is valid. 1
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_ftp::$ftp public property
backup_migrate_destination_ftp::$supported_ops public property Overrides backup_migrate_destination::$supported_ops
backup_migrate_destination_ftp::edit_form public function Get the form for the settings for this filter. Overrides backup_migrate_destination_remote::edit_form
backup_migrate_destination_ftp::ftp_object public function
backup_migrate_destination_ftp::get_pasv public function
backup_migrate_destination_ftp::load_file public function Load from the ftp destination. Overrides backup_migrate_destination::load_file
backup_migrate_destination_ftp::set_pasv public function
backup_migrate_destination_ftp::_delete_file public function Delete from the ftp destination. Overrides backup_migrate_destination::_delete_file
backup_migrate_destination_ftp::_list_files public function List all the available files in the given destination. Overrides backup_migrate_destination::_list_files
backup_migrate_destination_ftp::_save_file public function Save to the ftp destination. Overrides backup_migrate_destination::_save_file
backup_migrate_destination_remote::edit_form_submit public function Submit the configuration form. Overrides backup_migrate_item::edit_form_submit 1
backup_migrate_destination_remote::get_display_location public function The location to display is the url without the password. Overrides backup_migrate_location::get_display_location
backup_migrate_destination_remote::get_location public function The location is a URI so parse it and store the parts. Overrides backup_migrate_location::get_location
backup_migrate_destination_remote::set_location public function Return the location with the password. Overrides backup_migrate_location::set_location
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_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_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_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_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_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.