Files
duplicati/Duplicati/Library/Backend/S3/S3UI.cs
T
kenneth.skovhede@gmail.com 7edf074cbd An S3 issue fix.
Fixed issue #215.
If the user chooses EU buckets, bucketnames that are not valid hostname labels will be rejected.
If the user does not choose EU buckets, a warning is displayed for bucketnames that are not valid hostname labels, and the setup is switched to the path-style calling method.

Fixed issue #214.
There were multiple issues with entering a bucket/folder type path, those should now be resolved.

Fixed issue #212.
The UI and commandline now supports Reduced Redundancy Storage.

git-svn-id: https://duplicati.googlecode.com/svn/trunk@430 59da171f-624f-0410-aa54-27559c288bec
2010-06-19 23:29:47 +00:00

485 lines
19 KiB
C#

#region Disclaimer / License
// Copyright (C) 2010, Kenneth Skovhede
// http://www.hexad.dk, opensource@hexad.dk
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Text;
using System.Windows.Forms;
namespace Duplicati.Library.Backend
{
public partial class S3UI : UserControl
{
private const string ACCESS_ID = "AccessID";
private const string ACCESS_KEY = "AccessKey";
private const string BUCKET_NAME = "Bucketname";
private const string EUROBUCKET = "UseEuroBucket";
private const string RRS = "UseRRS";
private const string SUBDOMAIN = "UseSubdomainStrategy";
private const string SERVER_URL = "ServerUrl";
private const string PREFIX = "Prefix";
private const string HASTESTED = "UI: HasTested";
private const string HASCREATEDBUCKET = "UI: Has created bucket";
private const string HASSUGGESTEDPREFIX = "UI: Has suggested prefix";
private const string HASSUGGESTEDLOWERCASE = "UI: Has suggested lowercase";
private const string HASWARNEDINVALIDBUCKETNAME = "UI: Has warned invalid bucket name";
private const string S3_PATH = "s3.amazonaws.com";
private const string LOGIN_PAGE = "http://aws.amazon.com/s3";
private IDictionary<string, string> m_options;
private IDictionary<string, string> m_applicationSettings;
private bool m_hasTested;
private bool m_hasCreatedbucket = false;
private bool m_hasSuggestedPrefix = false;
private bool m_hasSuggestedLowerCase = false;
private bool m_hasWarnedInvalidBucketname = false;
public S3UI(IDictionary<string, string> applicationSettings, IDictionary<string, string> options)
: this()
{
m_options = options;
m_applicationSettings = applicationSettings;
}
private S3UI()
{
InitializeComponent();
}
internal bool Save(bool validate)
{
Save();
if (!validate)
return true;
if (!ValidateForm(true))
return false;
if (!m_hasTested)
switch (MessageBox.Show(this, Interface.CommonStrings.ConfirmTestConnectionQuestion, Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question))
{
case DialogResult.Yes:
TestConnection_Click(null, null);
if (!m_hasTested)
return false;
break;
case DialogResult.No:
break;
default: //Cancel
return false;
}
Save();
Dictionary<string, string> tmp = new Dictionary<string, string>();
foreach (Core.ComboBoxItemPair<string> x in AWS_ID.Items)
tmp[x.ToString()] = x.Value;
tmp[AWS_ID.Text] = AWS_KEY.Text;
S3CommonOptions.EncodeAccounts(tmp, m_applicationSettings);
return true;
}
private void Save()
{
m_options.Clear();
m_options[HASTESTED] = m_hasTested.ToString();
m_options[HASCREATEDBUCKET] = m_hasCreatedbucket.ToString();
m_options[HASSUGGESTEDPREFIX] = m_hasSuggestedPrefix.ToString();
m_options[HASSUGGESTEDLOWERCASE] = m_hasSuggestedLowerCase.ToString();
m_options[HASWARNEDINVALIDBUCKETNAME] = m_hasWarnedInvalidBucketname.ToString();
m_options[ACCESS_ID] = AWS_ID.Text;
m_options[ACCESS_KEY] = AWS_KEY.Text;
m_options[BUCKET_NAME] = BucketName.Text;
m_options[EUROBUCKET] = UseEuroBuckets.Checked.ToString();
m_options[RRS] = UseRRS.Checked.ToString();
string bucketname = BucketName.Text;
int ix = bucketname.IndexOf("/");
if (ix > 0)
{
m_options[PREFIX] = bucketname.Substring(ix + 1);
m_options[BUCKET_NAME] = bucketname.Substring(0, ix);
}
else
{
m_options[PREFIX] = "";
m_options[BUCKET_NAME] = bucketname;
}
bucketname = m_options[BUCKET_NAME];
m_options[SUBDOMAIN] = (bucketname.ToLower() == bucketname && S3.IsValidHostname(bucketname)).ToString();
}
void S3UI_Load(object sender, EventArgs args)
{
AWS_ID.Items.Clear();
foreach (KeyValuePair<string, string> x in S3CommonOptions.ExtractAccounts(m_applicationSettings))
AWS_ID.Items.Add(new Core.ComboBoxItemPair<string>(x.Key, x.Value));
if (m_options.ContainsKey(ACCESS_ID))
AWS_ID.Text = m_options[ACCESS_ID];
if (m_options.ContainsKey(ACCESS_KEY))
AWS_KEY.Text = m_options[ACCESS_KEY];
if (m_options.ContainsKey(BUCKET_NAME))
BucketName.Text = m_options[BUCKET_NAME];
if (m_options.ContainsKey(PREFIX) && !string.IsNullOrEmpty(m_options[PREFIX]))
BucketName.Text += "/" + m_options[PREFIX];
bool b;
if (m_options.ContainsKey(EUROBUCKET))
{
if (!bool.TryParse(m_options[EUROBUCKET], out b))
b = false;
}
else
{
b = S3CommonOptions.ExtractDefaultEUBuckets(m_applicationSettings);
}
UseEuroBuckets.Checked = b;
if (m_options.ContainsKey(RRS))
{
if (!bool.TryParse(m_options[RRS], out b))
b = false;
}
else
{
b = S3CommonOptions.ExtractDefaultRRS(m_applicationSettings);
}
UseRRS.Checked = b;
if (!m_options.ContainsKey(HASTESTED) || !bool.TryParse(m_options[HASTESTED], out m_hasTested))
m_hasTested = false;
if (!m_options.ContainsKey(HASCREATEDBUCKET) || !bool.TryParse(m_options[HASCREATEDBUCKET], out m_hasCreatedbucket))
m_hasCreatedbucket = false;
if (!m_options.ContainsKey(HASSUGGESTEDPREFIX) || !bool.TryParse(m_options[HASSUGGESTEDPREFIX], out m_hasSuggestedPrefix))
m_hasSuggestedPrefix = false;
if (!m_options.ContainsKey(HASSUGGESTEDLOWERCASE) || !bool.TryParse(m_options[HASSUGGESTEDLOWERCASE], out m_hasSuggestedLowerCase))
m_hasSuggestedLowerCase = false;
if (!m_options.ContainsKey(HASWARNEDINVALIDBUCKETNAME) || !bool.TryParse(m_options[HASWARNEDINVALIDBUCKETNAME], out m_hasWarnedInvalidBucketname))
m_hasWarnedInvalidBucketname = false;
}
/// <summary>
/// Mono has a problem with non-existing buckets
/// </summary>
/// <returns>True if the bucket is created, false otherwise</returns>
private bool EnsureBucketForMono()
{
try
{
if (m_hasCreatedbucket)
return true;
//The problem should be fixed in any version after 2.4.2.3
if (Core.Utility.IsMono && Core.Utility.MonoVersion <= new Version(2, 4, 2, 3))
{
switch (MessageBox.Show(this, Strings.S3UI.MonoRequiresExistingBucket, Application.ProductName, MessageBoxButtons.YesNoCancel))
{
case DialogResult.Yes: //Create it
CreateBucket.PerformClick();
if (!m_hasCreatedbucket)
return false;
break;
case DialogResult.No: //Ignore
break;
default:
return false;
}
}
}
catch (Exception ex)
{
MessageBox.Show(this, string.Format(Interface.CommonStrings.ConnectionFailure, ex.Message), Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error);
return false;
}
return true;
}
private bool ValidateForm(bool checkForBucket)
{
if (AWS_ID.Text.Trim().Length <= 0)
{
MessageBox.Show(this, Strings.S3UI.EmptyAWSIDError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
return false;
}
if (AWS_KEY.Text.Trim().Length <= 0)
{
MessageBox.Show(this, Strings.S3UI.EmptyAWSKeyError , Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
return false;
}
if (BucketName.Text.Trim().Length <= 0)
{
MessageBox.Show(this, Strings.S3UI.EmptyBucketnameError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
return false;
}
if (!m_hasSuggestedPrefix && !BucketName.Text.ToLower().StartsWith(AWS_ID.Text.ToLower()))
{
DialogResult res = MessageBox.Show(this, Strings.S3UI.BucketnameNotPrefixedWarning, Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Warning);
if (res == DialogResult.Yes)
BucketName.Text = AWS_ID.Text.ToLower() + "-" + BucketName.Text;
else if (res == DialogResult.No)
m_hasSuggestedPrefix = true;
else if (res == DialogResult.Cancel)
return false;
}
string bucketname;
string prefix;
if (BucketName.Text.Contains("/"))
{
bucketname = BucketName.Text.Substring(0, BucketName.Text.IndexOf("/"));
prefix = BucketName.Text.Substring(BucketName.Text.IndexOf("/") + 1);
}
else
{
bucketname = BucketName.Text;
prefix = null;
}
if (!m_hasSuggestedLowerCase && bucketname.ToLower() != bucketname)
{
string reason = UseEuroBuckets.Checked ?
Strings.S3UI.EuroBucketsRequireLowerCaseError :
Strings.S3UI.NewS3RequiresLowerCaseError;
DialogResult res = MessageBox.Show(this, string.Format(Strings.S3UI.BucketnameCaseWarning, reason), Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Warning);
if (res == DialogResult.Yes)
{
bucketname = bucketname.ToLower();
BucketName.Text = bucketname + "/" + prefix;
}
else if (res == DialogResult.Cancel || UseEuroBuckets.Checked)
{
return false;
}
else if (res == DialogResult.No)
m_hasSuggestedLowerCase = true;
}
if (!S3.IsValidHostname(bucketname))
{
if (UseEuroBuckets.Checked)
{
MessageBox.Show(this, string.Format(Strings.S3UI.HostnameInvalidWithEuBucketOptionError, bucketname), Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error);
return false;
}
else
{
if (!m_hasWarnedInvalidBucketname && MessageBox.Show(this, string.Format(Strings.S3UI.HostnameInvalidWarning, bucketname), Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Warning) != DialogResult.Yes)
return false;
}
m_hasWarnedInvalidBucketname = true;
}
if (checkForBucket)
return EnsureBucketForMono();
else
return true;
}
private void SignUpLink_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
{
Duplicati.GUI.UrlUtillity.OpenUrl(LOGIN_PAGE);
}
private void TestConnection_Click(object sender, EventArgs e)
{
if (ValidateForm(true))
{
Cursor c = this.Cursor;
try
{
this.Cursor = Cursors.WaitCursor;
Save();
Dictionary<string, string> options = new Dictionary<string, string>();
string destination = GetConfiguration(m_options, options);
S3 s3 = new S3(destination, options);
s3.Test();
MessageBox.Show(this, Interface.CommonStrings.ConnectionSuccess, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
m_hasTested = true;
m_hasCreatedbucket = true; //If the test succeeds, the bucket exists
}
catch (Interface.FolderMissingException)
{
switch (MessageBox.Show(this, Strings.S3UI.CreateMissingBucket, Application.ProductName, MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question))
{
case DialogResult.Yes:
CreateBucket.PerformClick();
TestConnection.PerformClick();
return;
default:
return;
}
}
catch (Exception ex)
{
MessageBox.Show(this, string.Format(Interface.CommonStrings.ConnectionFailure, ex.Message), Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error);
}
finally
{
this.Cursor = c;
}
}
}
private void AWS_ID_TextChanged(object sender, EventArgs e)
{
m_hasTested = false;
}
private void AWS_KEY_TextChanged(object sender, EventArgs e)
{
m_hasTested = false;
}
private void BucketName_TextChanged(object sender, EventArgs e)
{
m_hasTested = false;
m_hasCreatedbucket = false;
m_hasSuggestedPrefix = false;
m_hasSuggestedLowerCase = false;
m_hasWarnedInvalidBucketname = false;
}
private void UseEuroBuckets_CheckedChanged(object sender, EventArgs e)
{
m_hasTested = false;
m_hasWarnedInvalidBucketname = false;
}
private void AWS_ID_SelectedIndexChanged(object sender, EventArgs e)
{
if (AWS_ID.SelectedItem as Core.ComboBoxItemPair<string> != null)
AWS_KEY.Text = (AWS_ID.SelectedItem as Core.ComboBoxItemPair<string>).Value;
}
public static string GetConfiguration(IDictionary<string, string> guiOptions, IDictionary<string, string> commandlineOptions)
{
if (guiOptions.ContainsKey(ACCESS_ID) && !string.IsNullOrEmpty(guiOptions[ACCESS_ID]))
commandlineOptions["aws_access_key_id"] = guiOptions[ACCESS_ID];
if (guiOptions.ContainsKey(ACCESS_KEY) && !string.IsNullOrEmpty(guiOptions[ACCESS_KEY]))
commandlineOptions["aws_secret_access_key"] = guiOptions[ACCESS_KEY];
bool useEuroBucket;
bool useSubDomain;
bool useRRS;
if (!guiOptions.ContainsKey(EUROBUCKET) || !bool.TryParse(guiOptions[EUROBUCKET], out useEuroBucket))
useEuroBucket = false;
if (!guiOptions.ContainsKey(RRS) || !bool.TryParse(guiOptions[RRS], out useRRS))
useRRS = false;
if (!guiOptions.ContainsKey(SUBDOMAIN) || !bool.TryParse(guiOptions[SUBDOMAIN], out useSubDomain))
useSubDomain = false;
if (!guiOptions.ContainsKey(BUCKET_NAME))
throw new Exception(string.Format(Interface.CommonStrings.ConfigurationIsMissingItemError, BUCKET_NAME));
string bucketName = guiOptions[BUCKET_NAME];
string host = guiOptions.ContainsKey(SERVER_URL) ? guiOptions[SERVER_URL] : "";
string prefix = guiOptions.ContainsKey(PREFIX) ? guiOptions[PREFIX] : "";
if (string.IsNullOrEmpty(host))
{
if (useEuroBucket || useSubDomain)
host = bucketName + "." + S3_PATH;
else
host = S3_PATH;
}
if (useRRS)
commandlineOptions[S3.RRS_OPTION] = "";
if (useEuroBucket || useSubDomain)
return "s3://" + host + "/" + (string.IsNullOrEmpty(prefix) ? "" : prefix);
else
return "s3://" + host + "/" + bucketName + (string.IsNullOrEmpty(prefix) ? "" : "/" + prefix);
}
public static string PageTitle
{
get { return Strings.S3UI.PageTitle; }
}
public static string PageDescription
{
get { return Strings.S3UI.PageDescription; }
}
private void CreateBucket_Click(object sender, EventArgs e)
{
if (ValidateForm(false))
{
Cursor c = this.Cursor;
try
{
this.Cursor = Cursors.WaitCursor;
Save();
Dictionary<string, string> options = new Dictionary<string, string>();
string destination = GetConfiguration(m_options, options);
S3 s3 = new S3(destination, options);
s3.CreateFolder();
MessageBox.Show(this, Interface.CommonStrings.FolderCreated, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Information);
m_hasTested = true;
m_hasCreatedbucket = true;
}
catch (Exception ex)
{
MessageBox.Show(this, string.Format(Interface.CommonStrings.ConnectionFailure, ex.Message), Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Error);
}
this.Cursor = c;
}
}
}
}