class backup_migrate_destination in Backup and Migrate 6.2

A base class for creating destinations.

Hierarchy

• class \backup_migrate_item
  • class \backup_migrate_destination

2 string references to 'backup_migrate_destination'

backup_migrate_crud_types in includes/crud.inc

Return a list of CRUD types in the module.

backup_migrate_destination::edit_form in includes/destinations.inc

Get the edit form for the item.

File

includes/destinations.inc, line 506

class backup_migrate_destination extends backup_migrate_item {
  var $db_table = "backup_migrate_destinations";
  var $type_name = "destination";
  var $default_values = array(
    'settings' => array(),
  );
  var $singular = 'destination';
  var $plural = 'destinations';
  var $cache_files = FALSE;
  var $fetch_time = NULL;
  var $cache_expire = 86400;

  // 24 hours
  var $destination_type = "";
  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('Destination');
    t('Destinations');
    t('destinations');
    t('destination');
  }
  function ops() {
    return $this->supported_ops;
  }

  /**
   * Does this destination 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_type($type) {
    $this->type = $type;
  }
  function set_location($location) {
    $this->location = $location;
  }
  function get_location() {
    return @$this->location;
  }
  function get_display_location() {
    return $this
      ->get_location();
  }
  function file_types() {
    return array();
  }
  function settings($key = NULL) {
    $out = $this->settings;
    if ($key) {
      $out = isset($out[$key]) ? $out[$key] : NULL;
    }
    return $out;
  }

  /**
   * Get the type name of this destination for display to the user.
   */
  function get_destination_type_name() {
    if ($type = $this->destination_type) {
      $types = backup_migrate_get_destination_types();
      return isset($types[$type]['type_name']) ? $types[$type]['type_name'] : $type;
    }
  }

  /**
   * Save the given file to the destination.
   */
  function save_file($file, $settings) {

    // This must be overriden.
    $this
      ->file_cache_clear();
    return $this
      ->_save_file($file, $settings);
  }

  /**
   * Save the given file to the destination.
   */
  function _save_file($file, $settings) {

    // This must be overriden.
    return $file;
  }

  /**
   * Load the file with the given destination specific id and return as a backup_file object.
   */
  function load_file($file_id) {

    // This must be overriden.
    return NULL;
  }

  /**
   * Check if a file exists in the given destination.
   */
  function file_exists($file_id) {

    // Check if the file exists in the list of available files. Actual destination types may have more efficient ways of doing this.
    $files = $this
      ->list_files();
    return isset($files[$file_id]);
  }

  /**
   * List all the available files in the given destination with their destination specific id.
   */
  function list_files() {
    $out = NULL;
    if ($this->cache_files) {
      $out = $this
        ->file_cache_get();
    }
    if ($out === NULL) {
      $out = $this
        ->_list_files();
      if ($this->cache_files) {
        $this
          ->file_cache_set($out);
      }
    }
    return $out;
  }

  /**
   * List all the available files in the given destination with their destination specific id.
   */
  function _list_files() {
    return array();
  }

  /**
   * Cache the file list.
   */
  function file_cache_set($files) {
    cache_set('backup_migrate_file_list:' . $this
      ->get_id(), $files, 'cache', time() + $this->cache_expire);
  }

  /**
   * Retrieve the file list.
   */
  function file_cache_get() {
    backup_migrate_include('files');
    $cache = cache_get('backup_migrate_file_list:' . $this
      ->get_id());
    if (!empty($cache->data) && $cache->created > time() - $this->cache_expire) {
      $this->fetch_time = $cache->created;
      return $cache->data;
    }
    $this->fetch_time = 0;
    return NULL;
  }

  /**
   * Retrieve the file list.
   */
  function file_cache_clear() {
    if ($this->cache_files) {
      $this
        ->file_cache_set(NULL);
    }
  }

  /**
   * Delete the file with the given destination specific id.
   */
  function delete_file($file_id) {
    $this
      ->file_cache_clear();
    $this
      ->_delete_file($file_id);
  }

  /**
   * Delete the file with the given destination specific id.
   */
  function _delete_file($file_id) {

    // This must be overriden.
  }

  /**
   * Get the edit form for the item.
   */
  function edit_form() {
    if (get_class($this) !== 'backup_migrate_destination') {
      $form = parent::edit_form();
      $form['name'] = array(
        "#type" => "textfield",
        "#title" => t("Destination name"),
        "#default_value" => $this
          ->get_name(),
        "#required" => TRUE,
      );
      $form['type'] = array(
        "#type" => "value",
        "#default_value" => $this->destination_type,
      );
    }
    else {
      $types = backup_migrate_get_destination_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 . "/destination/list/add/{$type_url_str}", array(
            'attributes' => array(
              'title' => t('Add a new @s destination.', 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 destination you would like to create:') . '<dl>' . implode('', $items) . '</dl>';
      }
      else {
        $output = t('No destination types available.');
      }
      $form['select_type'] = array(
        '#type' => 'markup',
        '#value' => $output,
      );
    }
    return $form;
  }

  /**
   * 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 destination %name? Backup files already saved to this destination will not be deleted.', 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'),
      ),
      'destination_type_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 destinations 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 destination.
   */
  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 destination.
    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;
  }

  /**
   * Get the action links for a file on a given destination.
   */
  function get_file_links($file_id) {
    $out = array();

    // Don't display the download/delete/restore ops if they are not available for this destination.
    $can_read = $this
      ->can_read_file($file_id);
    $can_delete = $this
      ->can_delete_file($file_id);
    $destination_id = $this
      ->get_id();
    if ($can_read && user_access("access backup files")) {
      $out[] = l(t("download"), BACKUP_MIGRATE_MENU_PATH . "/destination/downloadfile/" . $destination_id . '/' . $file_id);
    }
    if ($can_read && user_access("restore from backup")) {
      $out[] = l(t("restore"), BACKUP_MIGRATE_MENU_PATH . "/destination/list/restorefile/" . $destination_id . '/' . $file_id);
    }
    if ($can_delete && user_access("delete backup files")) {
      $out[] = l(t("delete"), BACKUP_MIGRATE_MENU_PATH . "/destination/list/deletefile/" . $destination_id . '/' . $file_id);
    }
    return $out;
  }

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

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

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

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

  /**
   * Validate the form for the settings for this destination.
   */
  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;
  }

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

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

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

  /**
   * Add the menu items specific to the destination type.
   */
  function get_menu_items() {
    $items = parent::get_menu_items();
    $items[BACKUP_MIGRATE_MENU_PATH . '/destination/list/files'] = array(
      'title' => 'Destination Files',
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'destinations',
        'backup_migrate_ui_destination_display_files',
        TRUE,
      ),
      'access arguments' => array(
        'access backup files',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    $items[BACKUP_MIGRATE_MENU_PATH . '/destination/list/deletefile'] = array(
      'title' => 'Delete File',
      'description' => 'Delete a backup file',
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'destinations',
        'backup_migrate_ui_destination_delete_file',
        TRUE,
      ),
      'access arguments' => array(
        'delete backup files',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    $items['admin/content/backup_migrate/destination/list/restorefile'] = array(
      'title' => 'Restore from backup',
      'description' => 'Restore database from a backup file on the server',
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'destinations',
        'backup_migrate_ui_destination_restore_file',
        TRUE,
      ),
      'access arguments' => array(
        'restore from backup',
      ),
      'type' => MENU_LOCAL_TASK,
    );
    $items[BACKUP_MIGRATE_MENU_PATH . '/destination/downloadfile'] = array(
      'title' => 'Download File',
      'description' => 'Download a backup file',
      'page callback' => 'backup_migrate_menu_callback',
      'page arguments' => array(
        'destinations',
        'backup_migrate_ui_destination_download_file',
        TRUE,
      ),
      'access arguments' => array(
        'access backup files',
      ),
      'type' => MENU_CALLBACK,
    );
    return $items;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
backup_migrate_destination::$cache_expire		property
backup_migrate_destination::$cache_files		property		2
backup_migrate_destination::$db_table		property	Overrides backup_migrate_item::$db_table
backup_migrate_destination::$default_values		property	Overrides backup_migrate_item::$default_values
backup_migrate_destination::$destination_type		property
backup_migrate_destination::$fetch_time		property
backup_migrate_destination::$plural		property	Overrides backup_migrate_item::$plural
backup_migrate_destination::$singular		property	Overrides backup_migrate_item::$singular
backup_migrate_destination::$supported_ops		property		8
backup_migrate_destination::$type_name		property	Overrides backup_migrate_item::$type_name
backup_migrate_destination::backup_settings_default		function	Get the form for the settings for this filter.	1
backup_migrate_destination::backup_settings_form		function	Get the form for the settings for this filter.	1
backup_migrate_destination::backup_settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::backup_settings_form_validate		function	Get the form for the settings for this filter.
backup_migrate_destination::can_delete_file		function	Determine if we can read the given file.
backup_migrate_destination::can_read_file		function	Determine if we can read the given file.	1
backup_migrate_destination::create		function	Create a new destination of the correct type. Overrides backup_migrate_item::create
backup_migrate_destination::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
backup_migrate_destination::delete_file		function	Delete the file with the given destination specific id.	2
backup_migrate_destination::edit_form		function	Get the edit form for the item. Overrides backup_migrate_item::edit_form	4
backup_migrate_destination::file_cache_clear		function	Retrieve the file list.
backup_migrate_destination::file_cache_get		function	Retrieve the file list.
backup_migrate_destination::file_cache_set		function	Cache the file list.
backup_migrate_destination::file_exists		function	Check if a file exists in the given destination.
backup_migrate_destination::file_types		function		1
backup_migrate_destination::get_action_links		function	Get the action links for a destination. Overrides backup_migrate_item::get_action_links
backup_migrate_destination::get_destination_type_name		function	Get the type name of this destination for display to the user.
backup_migrate_destination::get_display_location		function		2
backup_migrate_destination::get_file_links		function	Get the action links for a file on a given destination.
backup_migrate_destination::get_list_column_info		function	Get the columns needed to list the type. Overrides backup_migrate_item::get_list_column_info
backup_migrate_destination::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_destination::get_location		function		1
backup_migrate_destination::get_menu_items		function	Add the menu items specific to the destination type. Overrides backup_migrate_item::get_menu_items
backup_migrate_destination::get_name		function	Get the name of the item. Overrides backup_migrate_item::get_name	1
backup_migrate_destination::list_files		function	List all the available files in the given destination with their destination specific id.	1
backup_migrate_destination::load_file		function	Load the file with the given destination specific id and return as a backup_file object.	5
backup_migrate_destination::op		function	Does this destination support the given operation.
backup_migrate_destination::ops		function
backup_migrate_destination::remove_op		function	Remove the given op from the support list.
backup_migrate_destination::restore_settings_default		function	Get the form for the settings for this filter.
backup_migrate_destination::restore_settings_form		function	Get the form for the settings for this filter.
backup_migrate_destination::restore_settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::restore_settings_form_validate		function	Get the form for the settings for this filter.
backup_migrate_destination::save_file		function	Save the given file to the destination.	5
backup_migrate_destination::settings		function
backup_migrate_destination::settings_default		function	Get the form for the settings for this destination type.
backup_migrate_destination::settings_form		function	Get the form for the settings for this destination.
backup_migrate_destination::settings_form_submit		function	Submit the settings form. Any values returned will be saved.
backup_migrate_destination::settings_form_validate		function	Validate the form for the settings for this destination.	1
backup_migrate_destination::set_location		function		1
backup_migrate_destination::set_name		function
backup_migrate_destination::set_type		function
backup_migrate_destination::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
backup_migrate_destination::_delete_file		function	Delete the file with the given destination specific id.	2
backup_migrate_destination::_list_files		function	List all the available files in the given destination with their destination specific id.	3
backup_migrate_destination::_save_file		function	Save the given file to the destination.	2
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.	4
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_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::item		function	A particular item.
backup_migrate_item::load_row		function	Load an existing item from an database (serialized) array.
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::to_array		function	Return as an array of values.
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