class backup_migrate_location in Backup and Migrate 8.3

Same name and namespace in other branches

6.3 includes/locations.inc \backup_migrate_location
7.3 includes/locations.inc \backup_migrate_location

A base class for creating locations.

Hierarchy

class \backup_migrate_item
- class \backup_migrate_location

Expanded class hierarchy of backup_migrate_location

File

includes/locations.inc, line 84

View source

class backup_migrate_location extends backup_migrate_item {
  var $db_table = "backup_migrate_destinations";
  var $type_name = "location";
  var $default_values = array(
    'settings' => array(),
  );
  var $singular = 'location';
  var $plural = 'locations';
  var $title_plural = 'Locations';
  var $title_singular = 'Location';
  var $subtype = "";
  var $supported_ops = array();

  /**
   * This function is not supposed to be called. It is just here to help the po extractor out.
   */
  function strings() {

    // Help the pot extractor find these strings.
    t('location');
    t('locations');
    t('Location');
    t('Locations');
  }
  function ops() {
    return $this->supported_ops;
  }

  /**
   * Does this location support the given operation.
   */
  function op($op) {
    $ops = (array) $this
      ->ops();
    return in_array($op, $ops);
  }

  /**
   * Remove the given op from the support list.
   */
  function remove_op($op) {
    $key = array_search($op, $this->supported_ops);
    if ($key !== FALSE) {
      unset($this->supported_ops[$key]);
    }
  }
  function get_name() {
    return @$this->name;
  }
  function set_name($name) {
    return $this->name = $name;
  }
  function set_location($location) {
    $this->location = $location;
  }
  function get_location() {
    return @$this->location;
  }
  function get_display_location() {
    return $this
      ->get_location();
  }
  function settings($key = NULL) {
    $out = $this->settings;
    if ($key) {
      $out = isset($out[$key]) ? $out[$key] : NULL;
    }
    return $out;
  }

  /**
   * Get the type name of this location for display to the user.
   */
  function get_subtype_name() {
    if ($type = $this
      ->get('subtype')) {
      $types = $this
        ->location_types();
      return isset($types[$type]['type_name']) ? $types[$type]['type_name'] : $type;
    }
  }

  /**
   * Get the edit form for the item.
   */
  function edit_form() {
    if (!empty($this->supported_ops)) {
      $form = parent::edit_form();
      $form['subtype'] = array(
        "#type" => "value",
        "#default_value" => $this
          ->get('subtype'),
      );
    }
    else {
      $types = $this
        ->location_types();
      $items = array();

      // If no (valid) node type has been provided, display a node type overview.
      foreach ($types as $key => $type) {
        if (@$type['can_create']) {
          $type_url_str = str_replace('_', '-', $key);
          $out = '<dt>' . l($type['type_name'], BACKUP_MIGRATE_MENU_PATH . "/settings/{$this->type_name}/add/{$type_url_str}", array(
            'attributes' => array(
              'title' => t('Add a new @s location.', array(
                '@s' => $type['type_name'],
              )),
            ),
          )) . '</dt>';
          $out .= '<dd>' . filter_xss_admin($type['description']) . '</dd>';
          $items[] = $out;
        }
      }
      if (count($items)) {
        $output = t('Choose the type of location you would like to create:') . '<dl>' . implode('', $items) . '</dl>';
      }
      else {
        $output = t('No types available.');
      }
      $form['select_type'] = array(
        '#type' => 'markup',
        '#markup' => $output,
      );
    }
    return $form;
  }

  /**
   * Get the available location types.
   */
  function location_types() {
    return backup_migrate_get_location_subtypes();
  }

  /**
   * Get the message to send to the user when confirming the deletion of the item.
   */
  function delete_confirm_message() {
    return t('Are you sure you want to delete the %name?', array(
      '%name' => $this
        ->get_name(),
    ));
  }

  /**
   * Get the columns needed to list the type.
   */
  function get_list_column_info() {
    $out = parent::get_list_column_info();
    $out = array(
      'name' => array(
        'title' => t('Name'),
      ),
      'subtype_name' => array(
        'title' => t('Type'),
      ),
      'display_location' => array(
        'title' => t('Location'),
      ),
    ) + $out;
    return $out;
  }

  /**
   * Get a row of data to be used in a list of items of this type.
   */
  function get_list_row() {
    $out = parent::get_list_row();

    // Supress locations with no actions as there's no value in showing them (and they may confuse new users).
    if (empty($out['actions'])) {
      return NULL;
    }
    return $out;
  }

  /**
   * Get the action links for a location.
   */
  function get_action_links() {
    $out = parent::get_action_links();
    $item_id = $this
      ->get_id();

    // Don't display the download/delete/restore ops if they are not available for this location.
    if ($this
      ->op('list files') && user_access("access backup files")) {
      $out = array(
        'list files' => l(t("list files"), BACKUP_MIGRATE_MENU_PATH . "/{$this->type_name}/list/files/" . $item_id),
      ) + $out;
    }
    if (!$this
      ->op('configure') || !user_access('administer backup and migrate')) {
      unset($out['edit']);
    }
    return $out;
  }

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

  /**
   * Get the form for the settings for this location type.
   */
  function settings_default() {
    return array();
  }

  /**
   * Get the form for the settings for this location.
   */
  function settings_form($form) {
    return $form;
  }

  /**
   * Validate the form for the settings for this location.
   */
  function settings_form_validate($form_values) {
  }

  /**
   * Submit the settings form. Any values returned will be saved.
   */
  function settings_form_submit($form_values) {
    return $form_values;
  }

  /**
   * Get the form for the settings for this filter.
   */
  function backup_settings_default() {
    return array();
  }

  /**
   * Get the form for the settings for this filter.
   */
  function backup_settings_form($settings) {
    return array();
  }

  /**
   * Get the form for the settings for this filter.
   */
  function backup_settings_form_validate($form, &$form_state) {
  }

  /**
   * Submit the settings form. Any values returned will be saved.
   */
  function backup_settings_form_submit($form, &$form_state) {
  }

  /**
   * Get the form for the settings for this filter.
   */
  function restore_settings_default() {
    return array();
  }

  /**
   * Get the form for the settings for this filter.
   */
  function restore_settings_form($settings) {
    return array();
  }

  /**
   * Get the form for the settings for this filter.
   */
  function restore_settings_form_validate($form_values) {
  }

  /**
   * Submit the settings form. Any values returned will be saved.
   */
  function restore_settings_form_submit($form_values) {
    return $form_values;
  }

  /**
   * Create a new location of the correct type.
   */
  function create($params = array()) {
    $out = NULL;
    $types = backup_migrate_get_location_subtypes();

    // Get the type passed in in the params, or if none, check the url for a valid type name.
    // This is to allow new location type to be specified in the path.
    $location_type = !empty($params['subtype']) ? $params['subtype'] : NULL;
    if ($location_type && ($type = @$types[$location_type])) {

      // Include the necessary file if specified by the type.
      if (!empty($type['file'])) {
        require_once './' . $type['file'];
      }
      $out = new $type['class']($params + array(
        'subtype' => $location_type,
      ));
    }
    if (empty($out)) {
      $out = parent::create($params);
    }
    return $out;
  }

  /**
   * 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;
  }

  /**
   * Retrieve a list of filetypes supported by this source/destination.
   */
  function file_types() {
    return array();
  }

}

Members

Name	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_submit	function	Submit the edit form for the item.	6
backup_migrate_item::edit_form_validate	function	Validate the edit form for the item.	5
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.	1
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.	3
backup_migrate_location::backup_settings_form	function	Get the form for the settings for this filter.	3
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::edit_form	function	Get the edit form for the item. Overrides backup_migrate_item::edit_form	4
backup_migrate_location::file_types	function	Retrieve a list of filetypes supported by this source/destination.	3
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_display_location	function		4
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_location	function		3
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::glue_url	function	Glue a URLs component parts back into a URL.	1
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_location	function		3
backup_migrate_location::set_name	function
backup_migrate_location::set_url	function	Break a URL into it's component parts.	1
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::url	function	Get a url from the parts.	1

You are here

class backup_migrate_location in Backup and Migrate 8.3

Hierarchy

File

Members

API Navigation