You are here

Home » API reference » Backup and Migrate 6.3 » locations.inc

class backup_migrate_location_remote in Backup and Migrate 6.3

Same name and namespace in other branches
  1. 8.3 includes/locations.inc \backup_migrate_location_remote
  2. 7.3 includes/locations.inc \backup_migrate_location_remote

A base class for creating locations.

Hierarchy

Expanded class hierarchy of backup_migrate_location_remote

File

includes/locations.inc, line 422

View source 
class backup_migrate_location_remote extends backup_migrate_location {

  /**
   * The location is a URI so parse it and store the parts.
   */
  function get_location() {
    return $this
      ->url(FALSE);
  }

  /**
   * The location to display is the url without the password.
   */
  function get_display_location() {
    return $this
      ->url(TRUE);
  }

  /**
   * Return the location with the password.
   */
  function set_location($location) {
    $this->location = $location;
    $this
      ->set_url($location);
  }

  /**
   * Get a url from the parts.
   */
  function url($hide_password = TRUE) {
    return $this
      ->glue_url($this->dest_url, $hide_password);
  }

  /**
   * Glue a URLs component parts back into a URL.
   */
  function glue_url($parts, $hide_password = TRUE) {

    // Obscure the password if we need to.
    $parts['pass'] = $hide_password ? "" : $parts['pass'];

    // Assemble the URL.
    $out = "";
    $out .= $parts['scheme'] . '://';
    $out .= $parts['user'] ? urlencode($parts['user']) : '';
    $out .= $parts['user'] && $parts['pass'] ? ":" . urlencode($parts['pass']) : '';
    $out .= $parts['user'] || $parts['pass'] ? "@" : "";
    $out .= $parts['host'];
    $out .= !empty($parts['port']) ? ':' . $parts['port'] : '';
    $out .= "/" . $parts['path'];
    return $out;
  }

  /**
   * Break a URL into it's component parts.
   */
  function set_url($url) {
    $parts = (array) parse_url($url);
    $parts['user'] = urldecode(@$parts['user']);
    $parts['pass'] = urldecode(@$parts['pass']);
    $parts['path'] = urldecode(@$parts['path']);
    $parts['path'] = ltrim(@$parts['path'], "/");
    $this->dest_url = $parts;
  }

  /**
   * location configuration callback.
   */
  function edit_form() {
    $form = parent::edit_form();
    $form['scheme'] = array(
      "#type" => "select",
      "#title" => t("Scheme"),
      "#default_value" => @$this->dest_url['scheme'] ? $this->dest_url['scheme'] : 'mysql',
      "#required" => TRUE,
      "#options" => array(
        $GLOBALS['db_type'] => $GLOBALS['db_type'],
      ),
      "#weight" => 0,
    );
    $form['host'] = array(
      "#type" => "textfield",
      "#title" => t("Host"),
      "#default_value" => @$this->dest_url['host'] ? $this->dest_url['host'] : 'localhost',
      "#required" => TRUE,
      "#weight" => 10,
    );
    $form['path'] = array(
      "#type" => "textfield",
      "#title" => t("Path"),
      "#default_value" => @$this->dest_url['path'],
      "#required" => TRUE,
      "#weight" => 20,
    );
    $form['user'] = array(
      "#type" => "textfield",
      "#title" => t("Username"),
      "#default_value" => @$this->dest_url['user'],
      "#required" => TRUE,
      "#weight" => 30,
    );
    $form['pass'] = array(
      "#type" => "password",
      "#title" => t("Password"),
      "#default_value" => @$this->dest_url['pass'],
      '#description' => '',
      "#weight" => 40,
    );
    if (@$this->dest_url['pass']) {
      $form['old_password'] = array(
        "#type" => "value",
        "#value" => @$this->dest_url['pass'],
      );
      $form['pass']["#description"] .= t(' You do not need to enter a password unless you wish to change the currently saved password.');
    }
    return $form;
  }

  /**
   * Submit the configuration form. Glue the url together and add the old password back if a new one was not specified.
   */
  function edit_form_submit($form, &$form_state) {
    $form_state['values']['pass'] = $form_state['values']['pass'] ? $form_state['values']['pass'] : $form_state['values']['old_password'];
    $form_state['values']['location'] = $this
      ->glue_url($form_state['values'], FALSE);
    parent::edit_form_submit($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
backup_migrate_item::$settings_path property
backup_migrate_item::$show_in_list property
backup_migrate_item::$storage property
backup_migrate_item::all_items function Get all of the given items.
backup_migrate_item::decode_db_row function Decode a loaded db row (unserialize necessary fields).
backup_migrate_item::delete function Delete the item from the database.
backup_migrate_item::edit_form_validate function Validate the edit form for the item. 4
backup_migrate_item::export function Return as an exported array of values.
backup_migrate_item::from_array function Load an existing item from an array.
backup_migrate_item::generate_id function Return a random (very very likely unique) string id for a new item.
backup_migrate_item::get function Get the member with the given key.
backup_migrate_item::get_actions function Get the rendered action links for a destination.
backup_migrate_item::get_default_values function Get the default values for standard parameters. 2
backup_migrate_item::get_id function Get the primary id for this item (if any is set).
backup_migrate_item::get_list function Get a table of all items of this type. 1
backup_migrate_item::get_list_header function Get header for a lost of this type.
backup_migrate_item::get_machine_name_field function Get the machine name field name from the schema.
backup_migrate_item::get_menu_items function Get the menu items for manipulating this type. 2
backup_migrate_item::get_primary_key function Get the primary key field title from the schema.
backup_migrate_item::get_schema function Get the schema for the item type.
backup_migrate_item::get_serialized_fields function Return the fields which must be serialized before saving to the db.
backup_migrate_item::get_settings_path function Get the columns needed to list the type.
backup_migrate_item::item function A particular item.
backup_migrate_item::item_exists function A particular item.
backup_migrate_item::load_row function Load an existing item from an database (serialized) array.
backup_migrate_item::revert_confirm_message function Get the message to send to the user when confirming the deletion of the item.
backup_migrate_item::save function Save the item to the database.
backup_migrate_item::set_id function Set the primary id for this item (if any is set).
backup_migrate_item::show_in_list function Get the columns needed to list the type.
backup_migrate_item::to_array function Return as an array of values. 1
backup_migrate_item::unique_id function Make sure this item has a unique id. Should only be called for new items or the item will collide with itself.
backup_migrate_item::_merge_defaults function Merge parameters with the given defaults.
backup_migrate_item::__construct function Constructor, set the basic info pulled from the db or generated programatically. 4
backup_migrate_location::$db_table property Overrides backup_migrate_item::$db_table 2
backup_migrate_location::$default_values property Overrides backup_migrate_item::$default_values 1
backup_migrate_location::$plural property Overrides backup_migrate_item::$plural 2
backup_migrate_location::$singular property Overrides backup_migrate_item::$singular 2
backup_migrate_location::$subtype property
backup_migrate_location::$supported_ops property 3
backup_migrate_location::$title_plural property Overrides backup_migrate_item::$title_plural 2
backup_migrate_location::$title_singular property Overrides backup_migrate_item::$title_singular 2
backup_migrate_location::$type_name property Overrides backup_migrate_item::$type_name 2
backup_migrate_location::backup_settings_default function Get the form for the settings for this filter. 2
backup_migrate_location::backup_settings_form function Get the form for the settings for this filter. 2
backup_migrate_location::backup_settings_form_submit function Submit the settings form. Any values returned will be saved.
backup_migrate_location::backup_settings_form_validate function Get the form for the settings for this filter.
backup_migrate_location::can_read_file function Determine if we can read the given file. 1
backup_migrate_location::create function Create a new location of the correct type. Overrides backup_migrate_item::create
backup_migrate_location::delete_confirm_message 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::file_types function Retrieve a list of filetypes supported by this source/destination. 2
backup_migrate_location::get_action_links function Get the action links for a location. Overrides backup_migrate_item::get_action_links 1
backup_migrate_location::get_list_column_info function Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_location::get_list_row 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 function Get the name of the item. Overrides backup_migrate_item::get_name 1
backup_migrate_location::get_subtype_name function Get the type name of this location for display to the user.
backup_migrate_location::location_types function Get the available location types. 1
backup_migrate_location::op function Does this location support the given operation.
backup_migrate_location::ops function
backup_migrate_location::remove_op function Remove the given op from the support list.
backup_migrate_location::restore_settings_default function Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form function Get the form for the settings for this filter.
backup_migrate_location::restore_settings_form_submit function Submit the settings form. Any values returned will be saved.
backup_migrate_location::restore_settings_form_validate function Get the form for the settings for this filter.
backup_migrate_location::settings function
backup_migrate_location::settings_default function Get the form for the settings for this location type. 1
backup_migrate_location::settings_form function Get the form for the settings for this location. 1
backup_migrate_location::settings_form_submit function Submit the settings form. Any values returned will be saved. 1
backup_migrate_location::settings_form_validate function Validate the form for the settings for this location. 1
backup_migrate_location::set_name function
backup_migrate_location::strings function This function is not supposed to be called. It is just here to help the po extractor out. Overrides backup_migrate_item::strings 2
backup_migrate_location_remote::edit_form function location configuration callback. Overrides backup_migrate_location::edit_form
backup_migrate_location_remote::edit_form_submit function Submit the configuration form. Glue the url together and add the old password back if a new one was not specified. Overrides backup_migrate_item::edit_form_submit
backup_migrate_location_remote::get_display_location function The location to display is the url without the password. Overrides backup_migrate_location::get_display_location
backup_migrate_location_remote::get_location function The location is a URI so parse it and store the parts. Overrides backup_migrate_location::get_location
backup_migrate_location_remote::glue_url function Glue a URLs component parts back into a URL. Overrides backup_migrate_location::glue_url
backup_migrate_location_remote::set_location function Return the location with the password. Overrides backup_migrate_location::set_location
backup_migrate_location_remote::set_url function Break a URL into it's component parts. Overrides backup_migrate_location::set_url
backup_migrate_location_remote::url function Get a url from the parts. Overrides backup_migrate_location::url