array( 'default_value' => 'https://auth.api.rackspacecloud.com', 'template_property_input_mapping' => 'account', 'contexts' => array('option', 'input'), ), 'region' => array( 'default_value' => null, 'contexts' => array('option', 'input'), ), 'user' => array( 'default_value' => '', 'template_property_input_mapping' => 'username', 'contexts' => array('option', 'input'), ), 'apikey' => array( 'default_value' => '', 'contexts' => array('option', 'input'), ), 'path' => array( 'default_value' => '', 'template_property_input_mapping' => 'container', 'contexts' => array('option', 'input'), ), ); public function __construct() { parent::__construct('cloudfiles', 'Cloud Files', 'Rackspace Cloud Files', '/images/rackspacecloud-logo.png'); $this->regions = array( 'DFW' => __('Dallas (DFW) (default)', 'updraftplus'), 'SYD' => __('Sydney (SYD)', 'updraftplus'), 'ORD' => __('Chicago (ORD)', 'updraftplus'), 'IAD' => __('Northern Virginia (IAD)', 'updraftplus'), 'HKG' => __('Hong Kong (HKG)', 'updraftplus'), 'LON' => __('London (LON)', 'updraftplus') ); } public function get_client() { return $this->client; } public function get_openstack_service($opts, $useservercerts = false, $disablesslverify = null) { $user = $opts['user']; $apikey = $opts['apikey']; $authurl = $opts['authurl']; $region = (!empty($opts['region'])) ? $opts['region'] : null; updraft_try_include_file('vendor/autoload.php', 'include_once'); // The new authentication APIs don't match the values we were storing before $new_authurl = ('https://lon.auth.api.rackspacecloud.com' == $authurl || 'uk' == $authurl) ? Rackspace::UK_IDENTITY_ENDPOINT : Rackspace::US_IDENTITY_ENDPOINT; if (null === $disablesslverify) $disablesslverify = UpdraftPlus_Options::get_updraft_option('updraft_ssl_disableverify'); if (empty($user) || empty($apikey)) throw new Exception(__('Authorisation failed (check your credentials)', 'updraftplus')); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- Error message to be escaped when caught and printed. $this->log("authentication URL: ".$new_authurl); $client = new Rackspace($new_authurl, array( 'username' => $user, 'apiKey' => $apikey )); $this->client = $client; if ($disablesslverify) { $client->setSslVerification(false); } else { if ($useservercerts) { $client->setConfig(array($client::SSL_CERT_AUTHORITY, 'system')); } else { $client->setSslVerification(UPDRAFTPLUS_DIR.'/includes/cacert.pem', true, 2); } } return $client->objectStoreService('cloudFiles', $region); } /** * Get partial templates of the Rackspace Cloud Files remote storage. * * @return Array an associative array keyed by name of the partial templates */ public function get_partial_templates() { $partial_templates = array(); ob_start(); ?> {{api_key_setting_default_label}} get_id().'_partial_templates', $partial_templates), parent::get_partial_templates()); } /** * This method overrides the parent method and lists the supported features of this remote storage option. * * @return Array - an array of supported features (any features not * mentioned are assumed to not be supported) */ public function get_supported_features() { // This options format is handled via only accessing options via $this->get_options() return array('multi_options', 'config_templates', 'multi_storage', 'conditional_logic'); } /** * This gives the partial template string to the settings page for the CloudFiles settings. * * @return String - the partial template, ready for substitutions to be carried out */ public function get_configuration_middlesection_template() { global $updraftplus; $classes = $this->get_css_classes(); $template_str = ' '.__('US or UK-based Rackspace Account', 'updraftplus').': '.__('Cloud Files Storage Region', 'updraftplus').': '.__('Cloud Files Username', 'updraftplus').': output_settings_field_name_and_id('user', true).' value="{{user}}" />
'.apply_filters('updraft_cloudfiles_apikeysetting', ''.__('To create a new Rackspace API sub-user and API key that has access only to this Rackspace container, use Premium.', 'updraftplus').'').'
'.__('Cloud Files API Key', 'updraftplus').': output_settings_field_name_and_id('apikey', true).' value="{{apikey}}" /> '.apply_filters('updraftplus_cloudfiles_location_description', __('Cloud Files Container', 'updraftplus')).': output_settings_field_name_and_id('path', true).' value="{{path}}" /> '; return $template_str; } /** * Modifies handerbar template options * * @param array $opts handerbar template options * @return Array - Modified handerbar template options */ public function transform_options_for_template($opts) { $opts['regions'] = $this->regions; $opts['region'] = (empty($opts['region'])) ? 'DFW' : $opts['region']; if (isset($opts['apikey'])) { $opts['apikey'] = trim($opts['apikey']); } $opts['authurl'] = !empty($opts['authurl']) ? $opts['authurl'] : ''; return $opts; } /** * Perform a test of user-supplied credentials, and echo the result * * @param Array $posted_settings - settings to test */ public function credentials_test($posted_settings) { if (empty($posted_settings['apikey'])) { /* translators: %s: API key */ echo esc_html(sprintf( /* translators: %s: API key */ __("Failure: No %s was given.", 'updraftplus'), __('API key', 'updraftplus'))); return; } if (empty($posted_settings['user'])) { /* translators: %s: Username */ echo esc_html(sprintf( /* translators: %s: Username */ __("Failure: No %s was given.", 'updraftplus'), __('Username', 'updraftplus'))); return; } $opts = array( 'user' => $posted_settings['user'], 'apikey' => $posted_settings['apikey'], 'authurl' => $posted_settings['authurl'], 'region' => (empty($posted_settings['region'])) ? null : $posted_settings['region'] ); $this->credentials_test_go($opts, $posted_settings['path'], $posted_settings['useservercerts'], $posted_settings['disableverify']); } /** * Check whether options have been set up by the user, or not * * @param Array $opts - the potential options * * @return Boolean */ public function options_exist($opts) { if (is_array($opts) && isset($opts['user']) && '' != $opts['user'] && !empty($opts['apikey'])) return true; return false; } /** * Get the pre configuration template * * @return String - the template */ public function get_pre_configuration_template() { ?> {{#if storage_image_url}} {{storage_long_description}} {{/if}}
{{{mb_substr_existence_label}}} {{{json_last_error_existence_label}}} {{{curl_existence_label}}}

{{{rackspace_text_description}}} {{faq_link_text}}

{{input_account_label}}: {{input_region_label}}: {{input_username_label}}:
{{#> updraft_cloudfiles_apikeysetting}} {{/updraft_cloudfiles_apikeysetting}}
{{input_apikey_label}}: {{input_container_label}}: '; {{{get_template_test_button_html "Rackspace Cloud Files"}}} show_double_warning( ''.__('Warning', 'updraftplus').': '. /* translators: %s: Missing PHP module */ sprintf(__('Your web server\'s PHP installation does not include a required module (%s).', 'updraftplus'), 'mbstring').' '. __('Please contact your web hosting provider\'s support.', 'updraftplus').' '. /* translators: 1: Module description, 2: Required module */ sprintf(__('UpdraftPlus\'s %1$s module requires %2$s.', 'updraftplus'), $this->desc, 'mbstring').' '. __('Please do not file any support requests; there is no alternative.', 'updraftplus'), $this->method, false ), $this->allowed_html_for_content_sanitisation() ); } if (!apply_filters('updraftplus_rackspace_jsonlasterror_exists', function_exists('json_last_error'))) { $json_last_error_existence_label = wp_kses( $updraftplus_admin->show_double_warning( ''.__('Warning', 'updraftplus').': '. /* translators: %s: Module description */ sprintf(__('Your web server\'s PHP installation does not include a required module (%s).', 'updraftplus'), 'json').' '. __('Please contact your web hosting provider\'s support.', 'updraftplus').' '. /* translators: 1: Module description, 2: Required module */ sprintf(__('UpdraftPlus\'s %1$s module requires %2$s.', 'updraftplus'), 'Cloud Files', 'json').' '. __('Please do not file any support requests; there is no alternative.', 'updraftplus'), 'cloudfiles', false ), $this->allowed_html_for_content_sanitisation() ); } $properties = array( 'storage_image_url' => !empty($this->img_url) ? UPDRAFTPLUS_URL.$this->img_url : '', 'storage_long_description' => $this->long_desc, 'api_key_setting_default_label' => __('To create a new Rackspace API sub-user and API key that has access only to this Rackspace container, use Premium.', 'updraftplus'), 'mb_substr_existence_label' => $mb_substr_existence_label, 'json_last_error_existence_label' => $json_last_error_existence_label, 'curl_existence_label' => wp_kses($updraftplus_admin->curl_check($this->long_desc, false, $this->method.' hidden-in-updraftcentral', false), $this->allowed_html_for_content_sanitisation()), 'rackspace_text_description' => wp_kses( sprintf( /* translators: 1: API key URL, 2: instructions URL */ __('Get your API key from your Rackspace Cloud console (read instructions here), then pick a container name to use for storage.', 'updraftplus'), 'https://mycloud.rackspace.com/', 'https://docs.rackspace.com/support/how-to/set-up-an-api-key-cloud-office-control-panel' ).' '.__('This container will be created for you if it does not already exist.', 'updraftplus'), $this->allowed_html_for_content_sanitisation() ), 'faq_link_text' => __('Also, you should read this important FAQ.', 'updraftplus'), 'faq_link_url' => esc_url(apply_filters("updraftplus_com_link", "https://teamupdraft.com/documentation/updraftplus/topics/cloud-storage/rackspace/there-are-extra-files-in-my-rackspace-cloud-files-container?utm_source=udp-plugin&utm_medium=referral&utm_campaign=paac&utm_content=read-important-faq&utm_creative_format=text")), 'input_account_label' => __('US or UK-based Rackspace Account', 'updraftplus'), 'input_account_title' => __('Accounts created at rackspacecloud.com are US accounts; accounts created at rackspace.co.uk are UK accounts.', 'updraftplus'), 'input_account_option_labels' => array( 'https://auth.api.rackspacecloud.com' => __('US (default)', 'updraftplus'), 'https://lon.auth.api.rackspacecloud.com' => __('UK', 'updraftplus'), ), 'input_region_label' => __('Cloud Files Storage Region', 'updraftplus'), 'input_region_option_labels' => $this->regions, 'input_username_label' => __('Cloud Files Username', 'updraftplus'), 'input_username_placeholder' => __('Enter your username', 'updraftplus'), 'input_apikey_label' => __('Cloud Files API Key', 'updraftplus'), 'input_apikey_type' => apply_filters('updraftplus_admin_secret_field_type', 'password'), 'input_apikey_placeholder' => __('Paste your key here', 'updraftplus'), 'input_container_label' => wp_kses(apply_filters('updraftplus_cloudfiles_location_description', __('Cloud Files Container', 'updraftplus')), $this->allowed_html_for_content_sanitisation()), 'input_container_placeholder' => __('Enter your container name', 'updraftplus'), /* translators: %s: Backup method */ 'input_test_label' => sprintf(__('Test %s Settings', 'updraftplus'), $updraftplus->backup_methods[$this->get_id()]), 'updraftplus_premium_url' => $updraftplus->get_url('premium'), ); return wp_parse_args(apply_filters('updraft_'.$this->get_id().'_template_properties', array()), wp_parse_args($properties, $this->get_persistent_variables_and_methods())); } /** * Customize generated field data using legacy mapping values. * * Used by transform_template_properties_to_fields_structure() * to allow child classes to adjust the generated field structure * based on legacy data and field mapping requirements. * * @param array $field Field data. * @param array $template_properties Template properties. * @param string $field_name Field name. * @param array $option Field mapping option. * * @return array */ public function configure_field_from_legacy($field, $template_properties, $field_name, $option) { $prefix = 'input_'.$option['template_property_input_mapping'].'_'; if (empty($field['tooltip']) && isset($template_properties[$prefix.'title'])) $field['tooltip'] = array('text' => $template_properties[$prefix.'title']); return $field; } }