You are here

Home » API reference » Backup and Migrate 8.2 » destinations.s3.inc

class backup_migrate_destination_s3 in Backup and Migrate 8.2

Same name and namespace in other branches
  1. 8.3 includes/destinations.s3.inc \backup_migrate_destination_s3
  2. 6.3 includes/destinations.s3.inc \backup_migrate_destination_s3
  3. 6.2 includes/destinations.s3.inc \backup_migrate_destination_s3
  4. 7.3 includes/destinations.s3.inc \backup_migrate_destination_s3
  5. 7.2 includes/destinations.s3.inc \backup_migrate_destination_s3

A destination for sending database backups to an s3 server.

Hierarchy

Expanded class hierarchy of backup_migrate_destination_s3

1 string reference to 'backup_migrate_destination_s3'
backup_migrate_backup_migrate_destination_types in includes/destinations.inc
Implementation of hook_backup_migrate_destination_types().

File

includes/destinations.s3.inc, line 14
Functions to handle the s3 backup destination.

View source 
class backup_migrate_destination_s3 extends backup_migrate_destination_remote {
  var $supported_ops = array(
    'scheduled backup',
    'manual backup',
    'restore',
    'list files',
    'configure',
    'delete',
  );
  var $s3 = NULL;
  var $cache_files = TRUE;

  /**
   * Save to to the s3 destination.
   */
  function _save_file($file, $settings) {
    if ($s3 = $this
      ->s3_object()) {
      $path = $file
        ->filename();
      if ($s3
        ->putObject($s3
        ->inputFile($file
        ->filepath(), FALSE), $this
        ->get_bucket(), $this
        ->remote_path($file
        ->filename()), S3::ACL_PRIVATE)) {
        return $file;
      }
    }
    return FALSE;
  }

  /**
   * Load from the s3 destination.
   */
  function load_file($file_id) {
    backup_migrate_include('files');
    $file = new backup_file(array(
      'filename' => $file_id,
    ));
    if ($s3 = $this
      ->s3_object()) {
      $data = $s3
        ->getObject($this
        ->get_bucket(), $this
        ->remote_path($file_id), $file
        ->filepath());
      if (!$data->error) {
        return $file;
      }
    }
    return NULL;
  }

  /**
   * Delete from the s3 destination.
   */
  function _delete_file($file_id) {
    if ($s3 = $this
      ->s3_object()) {
      $s3
        ->deleteObject($this
        ->get_bucket(), $this
        ->remote_path($file_id));
    }
  }

  /**
   * List all files from the s3 destination.
   */
  function _list_files() {
    backup_migrate_include('files');
    $files = array();
    if ($s3 = $this
      ->s3_object()) {
      $s3_files = $s3
        ->getBucket($this
        ->get_bucket(), $this
        ->get_subdir());
      foreach ((array) $s3_files as $id => $file) {
        $info = array(
          'filename' => $this
            ->local_path($file['name']),
          'filesize' => $file['size'],
          'filetime' => $file['time'],
        );
        $files[$info['filename']] = new backup_file($info);
      }
    }
    return $files;
  }

  /**
   * Get the form for the settings for this filter.
   */
  function edit_form() {

    // Check for the library.
    $this
      ->s3_object();
    $form = parent::edit_form();
    $form['scheme']['#type'] = 'value';
    $form['scheme']['#value'] = 'https';
    $form['host']['#type'] = 'value';
    $form['host']['#value'] = 's3.amazonaws.com';
    $form['path']['#title'] = 'S3 Bucket';
    $form['path']['#default_value'] = $this
      ->get_bucket();
    $form['path']['#description'] = 'This bucket must already exist. It will not be created for you.';
    $form['user']['#title'] = 'Access Key ID';
    $form['pass']['#title'] = 'Secret Access Key';
    $form['subdir'] = array(
      '#type' => 'textfield',
      '#title' => t('Subdirectory'),
      '#default_value' => $this
        ->get_subdir(),
      '#weight' => 25,
    );
    $form['settings']['#weight'] = 50;
    return $form;
  }

  /**
   * Submit the form for the settings for the s3 destination.
   */
  function edit_form_submit($form, &$form_state) {

    // Append the subdir onto the path.
    if (!empty($form_state['values']['subdir'])) {
      $form_state['values']['path'] .= '/' . trim($form_state['values']['subdir'], '/');
    }
    parent::edit_form_submit($form, $form_state);
  }

  /**
   * Generate a filepath with the correct prefix.
   */
  function remote_path($path) {
    if ($subdir = $this
      ->get_subdir()) {
      $path = $subdir . '/' . $path;
    }
    return $path;
  }

  /**
   * Generate a filepath with the correct prefix.
   */
  function local_path($path) {
    if ($subdir = $this
      ->get_subdir()) {
      $path = str_replace($subdir . '/', '', $path);
    }
    return $path;
  }

  /**
   * Get the bucket which is the first part of the path.
   */
  function get_bucket() {
    $parts = explode('/', @$this->dest_url['path']);
    return $parts[0];
  }

  /**
   * Get the bucket which is the first part of the path.
   */
  function get_subdir() {

    // Support the older style of subdir saving.
    if ($subdir = $this
      ->settings('subdir')) {
      return $subdir;
    }
    $parts = explode('/', @$this->dest_url['path']);
    array_shift($parts);
    return implode('/', array_filter($parts));
  }
  function s3_object() {

    // Try to use libraries module if available to find the path.
    if (function_exists('libraries_get_path')) {
      $library_paths[] = libraries_get_path('s3-php5-curl');
    }
    else {
      $library_paths[] = 'sites/all/libraries/s3-php5-curl';
    }
    $library_paths[] = drupal_get_path('module', 'backup_migrate') . '/includes/s3-php5-curl';
    $library_paths[] = drupal_get_path('module', 'backup_migrate') . '/includes';
    foreach ($library_paths as $path) {
      if (file_exists($path . '/S3.php')) {
        require_once $path . '/S3.php';
        if (!$this->s3 && !empty($this->dest_url['user'])) {
          $this->s3 = new S3($this->dest_url['user'], $this->dest_url['pass']);
        }
        return $this->s3;
      }
    }
    drupal_set_message(t('Due to drupal.org code hosting policies, the S3 library needed to use an S3 destination is no longer distributed with this module. You must download the library from !link and place it in one of these locations: %locations.', array(
      '%locations' => implode(', ', $library_paths),
      '!link' => l('http://undesigned.org.za/2007/10/22/amazon-s3-php-class', 'http://undesigned.org.za/2007/10/22/amazon-s3-php-class'),
    )), 'error', FALSE);
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
backup_migrate_destination::$cache_expire property
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::$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::create_info_file function
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. 1
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_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_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
backup_migrate_destination::list_files function List all the available files in the given destination with their destination specific id.
backup_migrate_destination::load_files_info function Load up the file's metadata from the accompanying .info file if applicable.
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. 3
backup_migrate_destination::save_file_info function Save the file metadata
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_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_remote::get_display_location function The location to display is the url without the password. Overrides backup_migrate_destination::get_display_location
backup_migrate_destination_remote::get_location function The location is a URI so parse it and store the parts. Overrides backup_migrate_destination::get_location
backup_migrate_destination_remote::glue_url function Glue a URLs component parts back into a URL.
backup_migrate_destination_remote::set_location function Return the location with the password. Overrides backup_migrate_destination::set_location
backup_migrate_destination_remote::set_url function Break a URL into it's component parts.
backup_migrate_destination_remote::url function Get a url from the parts.
backup_migrate_destination_s3::$cache_files property Overrides backup_migrate_destination::$cache_files
backup_migrate_destination_s3::$s3 property
backup_migrate_destination_s3::$supported_ops property Overrides backup_migrate_destination::$supported_ops
backup_migrate_destination_s3::edit_form function Get the form for the settings for this filter. Overrides backup_migrate_destination_remote::edit_form
backup_migrate_destination_s3::edit_form_submit function Submit the form for the settings for the s3 destination. Overrides backup_migrate_destination_remote::edit_form_submit
backup_migrate_destination_s3::get_bucket function Get the bucket which is the first part of the path.
backup_migrate_destination_s3::get_subdir function Get the bucket which is the first part of the path.
backup_migrate_destination_s3::load_file function Load from the s3 destination. Overrides backup_migrate_destination::load_file
backup_migrate_destination_s3::local_path function Generate a filepath with the correct prefix.
backup_migrate_destination_s3::remote_path function Generate a filepath with the correct prefix.
backup_migrate_destination_s3::s3_object function
backup_migrate_destination_s3::_delete_file function Delete from the s3 destination. Overrides backup_migrate_destination::_delete_file
backup_migrate_destination_s3::_list_files function List all files from the s3 destination. Overrides backup_migrate_destination::_list_files
backup_migrate_destination_s3::_save_file function Save to to the s3 destination. Overrides backup_migrate_destination::_save_file
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. 3
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::__construct function Constructor, set the basic info pulled from the db or generated programatically. 4