1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269 |
- //---------------------------------------------------------------------------
- #include <vcl.h>
- #pragma hdrstop
- #define NE_LFS
- #define WINSCP
- #define NEED_LIBS3
- #include "S3FileSystem.h"
- #include "SessionData.h"
- #include "Interface.h"
- #include "Common.h"
- #include "Exceptions.h"
- #include "Terminal.h"
- #include "TextsCore.h"
- #include "HelpCore.h"
- #include "NeonIntf.h"
- #include <ne_request.h>
- #include <StrUtils.hpp>
- #include <limits>
- //---------------------------------------------------------------------------
- #pragma package(smart_init)
- //---------------------------------------------------------------------------
- #define StrFromS3(S) StrFromNeon(S)
- #define StrToS3(S) StrToNeon(S)
- //---------------------------------------------------------------------------
- #define FILE_OPERATION_LOOP_TERMINAL FTerminal
- //---------------------------------------------------------------------------
- #define AWS_ACCESS_KEY_ID L"AWS_ACCESS_KEY_ID"
- #define AWS_SECRET_ACCESS_KEY L"AWS_SECRET_ACCESS_KEY"
- #define AWS_SESSION_TOKEN L"AWS_SESSION_TOKEN"
- #define AWS_CONFIG_FILE L"AWS_CONFIG_FILE"
- #define AWS_PROFILE L"AWS_PROFILE"
- #define AWS_PROFILE_DEFAULT L"default"
- //---------------------------------------------------------------------------
- static std::unique_ptr<TCriticalSection> LibS3Section(TraceInitPtr(new TCriticalSection()));
- //---------------------------------------------------------------------------
- UTF8String LibS3Delimiter(L"/");
- //---------------------------------------------------------------------------
- UnicodeString __fastcall S3LibVersion()
- {
- return FORMAT(L"%s.%s", (LIBS3_VER_MAJOR, LIBS3_VER_MINOR));
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall S3LibDefaultHostName()
- {
- return UnicodeString(S3_DEFAULT_HOSTNAME);
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall S3LibDefaultRegion()
- {
- return StrFromS3(S3_DEFAULT_REGION);
- }
- //---------------------------------------------------------------------------
- UnicodeString S3ConfigFileName;
- TDateTime S3ConfigTimestamp;
- std::unique_ptr<TCustomIniFile> S3ConfigFile;
- UnicodeString S3Profile;
- //---------------------------------------------------------------------------
- static void NeedS3Config()
- {
- TGuard Guard(LibS3Section.get());
- if (S3Profile.IsEmpty())
- {
- S3Profile = GetEnvironmentVariable(AWS_PROFILE);
- if (S3Profile.IsEmpty())
- {
- S3Profile = AWS_PROFILE_DEFAULT;
- }
- }
- if (S3ConfigFileName.IsEmpty())
- {
- S3ConfigFileName = GetEnvironmentVariable(AWS_CONFIG_FILE);
- UnicodeString ProfilePath = GetShellFolderPath(CSIDL_PROFILE);
- UnicodeString DefaultConfigFileName = IncludeTrailingBackslash(ProfilePath) + L".aws\\credentials";
- // "aws" cli really prefers the default location over location specified by AWS_CONFIG_FILE
- if (FileExists(DefaultConfigFileName))
- {
- S3ConfigFileName = DefaultConfigFileName;
- }
- }
- TDateTime Timestamp;
- FileAge(S3ConfigFileName, Timestamp);
- if (S3ConfigTimestamp != Timestamp)
- {
- S3ConfigTimestamp = Timestamp;
- // TMemIniFile silently ignores empty paths or non-existing files
- S3ConfigFile.reset(new TMemIniFile(S3ConfigFileName));
- }
- }
- //---------------------------------------------------------------------------
- TStrings * GetS3Profiles()
- {
- NeedS3Config();
- // S3 allegedly treats the section case-sensitivelly, but our GetS3ConfigValue (ReadString) does not,
- // so consistently we return case-insensitive list.
- std::unique_ptr<TStrings> Result(new TStringList());
- if (S3ConfigFile.get() != NULL)
- {
- S3ConfigFile->ReadSections(Result.get());
- int Index = 0;
- while (Index < Result->Count)
- {
- UnicodeString Section = Result->Strings[Index];
- if (S3ConfigFile->ReadString(Section, AWS_ACCESS_KEY_ID, EmptyStr).IsEmpty() &&
- S3ConfigFile->ReadString(Section, AWS_SECRET_ACCESS_KEY, EmptyStr).IsEmpty() &&
- S3ConfigFile->ReadString(Section, AWS_SESSION_TOKEN, EmptyStr).IsEmpty())
- {
- Result->Delete(Index);
- }
- else
- {
- Index++;
- }
- }
- }
- return Result.release();
- }
- //---------------------------------------------------------------------------
- UnicodeString GetS3ConfigValue(const UnicodeString & Profile, const UnicodeString & Name, UnicodeString * Source)
- {
- UnicodeString Result;
- UnicodeString ASource;
- TGuard Guard(LibS3Section.get());
- try
- {
- if (Profile.IsEmpty())
- {
- Result = GetEnvironmentVariable(Name);
- }
- if (!Result.IsEmpty())
- {
- ASource = FORMAT(L"%%%s%%", (Name));
- }
- else
- {
- NeedS3Config();
- if (S3ConfigFile.get() != NULL)
- {
- UnicodeString AProfile = DefaultStr(Profile, S3Profile);
- Result = S3ConfigFile->ReadString(AProfile, Name, EmptyStr);
- if (!Result.IsEmpty())
- {
- ASource = FORMAT(L"%s/%s", (ExtractFileName(S3ConfigFile->FileName), AProfile));
- }
- }
- }
- }
- catch (Exception & E)
- {
- throw ExtException(&E, MainInstructions(LoadStr(S3_CONFIG_ERROR)));
- }
- if (Source != NULL)
- {
- *Source = ASource;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- UnicodeString S3EnvUserName(const UnicodeString & Profile, UnicodeString * Source)
- {
- return GetS3ConfigValue(Profile, AWS_ACCESS_KEY_ID, Source);
- }
- //---------------------------------------------------------------------------
- UnicodeString S3EnvPassword(const UnicodeString & Profile, UnicodeString * Source)
- {
- return GetS3ConfigValue(Profile, AWS_SECRET_ACCESS_KEY, Source);
- }
- //---------------------------------------------------------------------------
- UnicodeString S3EnvSessionToken(const UnicodeString & Profile, UnicodeString * Source)
- {
- return GetS3ConfigValue(Profile, AWS_SESSION_TOKEN, Source);
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- const int TS3FileSystem::S3MinMultiPartChunkSize = 5 * 1024 * 1024;
- const int TS3FileSystem::S3MaxMultiPartChunks = 10000;
- //---------------------------------------------------------------------------
- TS3FileSystem::TS3FileSystem(TTerminal * ATerminal) :
- TCustomFileSystem(ATerminal),
- FActive(false),
- FResponseIgnore(false)
- {
- FFileSystemInfo.ProtocolBaseName = L"S3";
- FFileSystemInfo.ProtocolName = FFileSystemInfo.ProtocolBaseName;
- S3_create_request_context(&FRequestContext);
- S3_set_request_context_session_callback(FRequestContext, LibS3SessionCallback, this);
- S3_set_request_context_ssl_callback(FRequestContext, LibS3SslCallback, this);
- S3_set_request_context_response_data_callback(FRequestContext, LibS3ResponseDataCallback, this);
- }
- //---------------------------------------------------------------------------
- __fastcall TS3FileSystem::~TS3FileSystem()
- {
- S3_destroy_request_context(FRequestContext);
- FRequestContext = NULL;
- UnregisterFromNeonDebug(FTerminal);
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::Open()
- {
- FTlsVersionStr = L"";
- FNeonSession = NULL;
- FCurrentDirectory = L"";
- FAuthRegion = DefaultStr(FTerminal->SessionData->S3DefaultRegion, S3LibDefaultRegion());
- RequireNeon(FTerminal);
- FTerminal->Information(LoadStr(STATUS_CONNECT), true);
- TSessionData * Data = FTerminal->SessionData;
- FSessionInfo.LoginTime = Now();
- FSessionInfo.CertificateVerifiedManually = false;
- FLibS3Protocol = (Data->Ftps != ftpsNone) ? S3ProtocolHTTPS : S3ProtocolHTTP;
- UnicodeString S3Profile;
- if (Data->S3CredentialsEnv)
- {
- S3Profile = FTerminal->SessionData->S3Profile;
- }
- if (!S3Profile.IsEmpty() && !FTerminal->SessionData->FingerprintScan)
- {
- std::unique_ptr<TStrings> S3Profiles(GetS3Profiles());
- if (S3Profiles->IndexOf(S3Profile) < 0)
- {
- throw Exception(MainInstructions(FMTLOAD(S3_PROFILE_NOT_EXIST, (S3Profile))));
- }
- }
- UnicodeString AccessKeyId = Data->UserNameExpanded;
- if (AccessKeyId.IsEmpty() && !FTerminal->SessionData->FingerprintScan)
- {
- if (!FTerminal->PromptUser(Data, pkUserName, LoadStr(S3_ACCESS_KEY_ID_TITLE), L"",
- LoadStr(S3_ACCESS_KEY_ID_PROMPT), true, 0, AccessKeyId))
- {
- // note that we never get here actually
- throw Exception(L"");
- }
- }
- FAccessKeyId = UTF8String(AccessKeyId);
- if (FAccessKeyId.Length() > S3_MAX_ACCESS_KEY_ID_LENGTH)
- {
- FAccessKeyId.SetLength(S3_MAX_ACCESS_KEY_ID_LENGTH);
- }
- UnicodeString Password = Data->Password;
- if (Password.IsEmpty() && Data->S3CredentialsEnv)
- {
- UnicodeString PasswordSource;
- Password = S3EnvPassword(S3Profile, &PasswordSource);
- if (!Password.IsEmpty())
- {
- FTerminal->LogEvent(FORMAT(L"Password (secret access key) read from %s", (PasswordSource)));
- }
- }
- UnicodeString SecretAccessKey = UTF8String(NormalizeString(Password));
- if (SecretAccessKey.IsEmpty() && !FTerminal->SessionData->FingerprintScan)
- {
- if (!FTerminal->PromptUser(Data, pkPassword, LoadStr(S3_SECRET_ACCESS_KEY_TITLE), L"",
- LoadStr(S3_SECRET_ACCESS_KEY_PROMPT), false, 0, SecretAccessKey))
- {
- // note that we never get here actually
- throw Exception(L"");
- }
- }
- FSecretAccessKey = UTF8String(SecretAccessKey);
- UnicodeString SessionToken = Data->S3SessionToken;
- if (SessionToken.IsEmpty() && Data->S3CredentialsEnv)
- {
- UnicodeString SessionTokenSource;
- SessionToken = S3EnvSessionToken(S3Profile, &SessionTokenSource);
- if (!SessionToken.IsEmpty())
- {
- FTerminal->LogEvent(FORMAT(L"Session token read from %s", (SessionTokenSource)));
- }
- }
- FSecurityTokenBuf = UTF8String(SessionToken);
- FSecurityToken = static_cast<const char *>(FSecurityTokenBuf.data());
- FHostName = UTF8String(Data->HostNameExpanded);
- FPortSuffix = UTF8String();
- int ADefaultPort = FTerminal->SessionData->GetDefaultPort();
- DebugAssert((ADefaultPort == HTTPSPortNumber) || (ADefaultPort == HTTPPortNumber));
- if (FTerminal->SessionData->PortNumber != ADefaultPort)
- {
- FPortSuffix = UTF8String(FORMAT(L":%d", (FTerminal->SessionData->PortNumber)));
- }
- FTimeout = Data->Timeout;
- RegisterForNeonDebug(FTerminal);
- UpdateNeonDebugMask();
- {
- TGuard Guard(LibS3Section.get());
- S3_initialize(NULL, S3_INIT_ALL, NULL);
- }
- if (IsGoogleCloud())
- {
- FTerminal->LogEvent(L"Google Cloud detected.");
- }
- FActive = false;
- try
- {
- UnicodeString Path = Data->RemoteDirectory;
- if (IsUnixRootPath(Path))
- {
- Path = ROOTDIRECTORY;
- }
- TryOpenDirectory(Path);
- }
- catch (Exception & E)
- {
- LibS3Deinitialize();
- FTerminal->Closed();
- FTerminal->FatalError(&E, LoadStr(CONNECTION_FAILED));
- }
- FActive = true;
- }
- //---------------------------------------------------------------------------
- struct TLibS3CallbackData
- {
- TLibS3CallbackData()
- {
- Status = (S3Status)-1;
- }
- TS3FileSystem * FileSystem;
- S3Status Status;
- UnicodeString RegionDetail;
- UnicodeString EndpointDetail;
- UnicodeString ErrorMessage;
- UnicodeString ErrorDetails;
- };
- //---------------------------------------------------------------------------
- TS3FileSystem * TS3FileSystem::GetFileSystem(void * CallbackData)
- {
- return static_cast<TLibS3CallbackData *>(CallbackData)->FileSystem;
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::LibS3SessionCallback(ne_session_s * Session, void * CallbackData)
- {
- TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
- TSessionData * Data = FileSystem->FTerminal->SessionData;
- InitNeonSession(
- Session, Data->ProxyMethod, Data->ProxyHost, Data->ProxyPort,
- Data->ProxyUsername, Data->ProxyPassword, FileSystem->FTerminal);
- SetNeonTlsInit(Session, FileSystem->InitSslSession);
- ne_set_session_flag(Session, SE_SESSFLAG_SNDBUF, Data->SendBuf);
- // Data->Timeout is propagated via timeoutMs parameter of functions like S3_list_service
- FileSystem->FNeonSession = Session;
- }
- //------------------------------------------------------------------------------
- void TS3FileSystem::InitSslSession(ssl_st * Ssl, ne_session * /*Session*/)
- {
- SetupSsl(Ssl, FTerminal->SessionData->MinTlsVersion, FTerminal->SessionData->MaxTlsVersion);
- }
- //---------------------------------------------------------------------------
- int TS3FileSystem::LibS3SslCallback(int Failures, const ne_ssl_certificate_s * Certificate, void * CallbackData)
- {
- TNeonCertificateData Data;
- RetrieveNeonCertificateData(Failures, Certificate, Data);
- TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
- return FileSystem->VerifyCertificate(Data) ? NE_OK : NE_ERROR;
- }
- //---------------------------------------------------------------------------
- bool TS3FileSystem::VerifyCertificate(TNeonCertificateData Data)
- {
- bool Result =
- FTerminal->VerifyOrConfirmHttpCertificate(
- FTerminal->SessionData->HostNameExpanded, FTerminal->SessionData->PortNumber, Data, true, FSessionInfo);
- if (Result)
- {
- CollectTLSSessionInfo();
- }
- return Result;
- }
- //------------------------------------------------------------------------------
- void TS3FileSystem::CollectTLSSessionInfo()
- {
- // See also TFTPFileSystem::Open().
- // Have to cache the value as the connection (the neon HTTP session, not "our" session)
- // can be closed at the time we need it in CollectUsage().
- UnicodeString Message = NeonTlsSessionInfo(FNeonSession, FSessionInfo, FTlsVersionStr);
- FTerminal->LogEvent(0, Message);
- }
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3ResponsePropertiesCallback(const S3ResponseProperties * /*Properties*/, void * /*CallbackData*/)
- {
- // TODO
- return S3StatusOK;
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::LibS3ResponseDataCallback(const char * Data, size_t Size, void * CallbackData)
- {
- TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
- if (FileSystem->FTerminal->Log->Logging && !FileSystem->FResponseIgnore)
- {
- UnicodeString Content = UnicodeString(UTF8String(Data, Size)).Trim();
- FileSystem->FResponse += Content;
- }
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::LibS3ResponseCompleteCallback(S3Status Status, const S3ErrorDetails * Error, void * CallbackData)
- {
- TLibS3CallbackData & Data = *static_cast<TLibS3CallbackData *>(CallbackData);
- TS3FileSystem * FileSystem = Data.FileSystem;
- Data.Status = Status;
- Data.RegionDetail = L"";
- Data.EndpointDetail = L"";
- Data.ErrorMessage = L"";
- Data.ErrorDetails = L"";
- if (Error != NULL)
- {
- if (Error->message != NULL)
- {
- Data.ErrorMessage = StrFromS3(Error->message);
- FileSystem->FTerminal->LogEvent(Data.ErrorMessage);
- }
- UnicodeString ErrorDetails;
- if (Error->resource != NULL)
- {
- AddToList(ErrorDetails, FMTLOAD(S3_ERROR_RESOURCE, (StrFromS3(Error->resource))), L"\n");
- }
- if (Error->furtherDetails != NULL)
- {
- AddToList(ErrorDetails, FMTLOAD(S3_ERROR_FURTHER_DETAILS, (StrFromS3(Error->furtherDetails))), L"\n");
- }
- if (Error->extraDetailsCount)
- {
- UnicodeString ExtraDetails;
- for (int I = 0; I < Error->extraDetailsCount; I++)
- {
- UnicodeString DetailName = StrFromS3(Error->extraDetails[I].name);
- UnicodeString DetailValue = StrFromS3(Error->extraDetails[I].value);
- if (SameText(DetailName, L"Region"))
- {
- Data.RegionDetail = DetailValue;
- }
- else if (SameText(DetailName, L"Endpoint"))
- {
- Data.EndpointDetail = DetailValue;
- }
- AddToList(ExtraDetails, FORMAT(L"%s: %s", (DetailName, DetailValue)), L", ");
- }
- AddToList(ErrorDetails, LoadStr(S3_ERROR_EXTRA_DETAILS) + ExtraDetails, L"\n");
- }
- if (!ErrorDetails.IsEmpty())
- {
- FileSystem->FTerminal->LogEvent(ErrorDetails);
- Data.ErrorDetails = ErrorDetails;
- }
- }
- if (!FileSystem->FResponse.IsEmpty() && (FileSystem->FTerminal->Configuration->ActualLogProtocol >= 0))
- {
- FileSystem->FTerminal->Log->Add(llOutput, FileSystem->FResponse);
- }
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::RequestInit(TLibS3CallbackData & Data)
- {
- Data.FileSystem = this;
- FResponse = L"";
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::CheckLibS3Error(const TLibS3CallbackData & Data, bool FatalOnConnectError)
- {
- if (Data.Status != S3StatusOK)
- {
- UnicodeString Error, Details;
- bool FatalCandidate = false;
- switch (Data.Status)
- {
- case S3StatusAbortedByCallback:
- Error = LoadStr(USER_TERMINATED);
- break;
- case S3StatusErrorAccessDenied:
- Error = LoadStr(S3_STATUS_ACCESS_DENIED);
- break;
- case S3StatusErrorSignatureDoesNotMatch: // While it can mean an implementation fault, it will typically mean a wrong secure key.
- case S3StatusErrorInvalidAccessKeyId:
- Error = LoadStr(AUTHENTICATION_FAILED);
- break;
- case S3StatusNameLookupError:
- Error = ReplaceStr(LoadStr(NET_TRANSL_HOST_NOT_EXIST2), L"%HOST%", FTerminal->SessionData->HostNameExpanded);
- FatalCandidate = true;
- break;
- case S3StatusFailedToConnect:
- Error = LoadStr(CONNECTION_FAILED);
- FatalCandidate = true;
- break;
- case S3StatusConnectionFailed:
- case S3StatusErrorSlowDown:
- FatalCandidate = true;
- break;
- }
- if (!Error.IsEmpty())
- {
- Details = Data.ErrorMessage;
- AddToList(Details, Data.ErrorDetails, L"\n");
- }
- else
- {
- if (!Data.ErrorMessage.IsEmpty())
- {
- Error = Data.ErrorMessage;
- }
- else
- {
- // only returns name of the S3 status code symbol, like S3StatusErrorAccountProblem,
- // not something we should really display to an user, but still better than an internal error code
- Error = S3_get_status_name(Data.Status);
- }
- Details = Data.ErrorDetails;
- }
- Error = MainInstructions(Error);
- if (FatalCandidate && FatalOnConnectError)
- {
- std::unique_ptr<Exception> E(new Exception(Error));
- throw EFatal(E.get(), Details);
- }
- else
- {
- throw ExtException(Error, Details);
- }
- }
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::LibS3Deinitialize()
- {
- TGuard Guard(LibS3Section.get());
- S3_deinitialize();
- }
- //---------------------------------------------------------------------------
- UnicodeString TS3FileSystem::GetFolderKey(const UnicodeString & Key)
- {
- return Key + L"/";
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::ParsePath(UnicodeString Path, UnicodeString & BucketName, UnicodeString & Key)
- {
- if (DebugAlwaysTrue(Path.SubString(1, 1) == L"/"))
- {
- Path.Delete(1, 1);
- }
- int P = Path.Pos(L"/");
- UnicodeString Result;
- if (P == 0)
- {
- BucketName = Path;
- Key = L"";
- }
- else
- {
- BucketName = Path.SubString(0, P - 1);
- Key = Path.SubString(P + 1, Path.Length() - P);
- }
- }
- //---------------------------------------------------------------------------
- struct TLibS3BucketContext : S3BucketContext
- {
- // These keep data that we point the native S3BucketContext fields to
- UTF8String HostNameBuf;
- UTF8String BucketNameBuf;
- UTF8String AuthRegionBuf;
- };
- //---------------------------------------------------------------------------
- struct TLibS3ListBucketCallbackData : TLibS3CallbackData
- {
- TRemoteFileList * FileList;
- bool Any;
- int KeyCount;
- UTF8String NextMarker;
- bool IsTruncated;
- };
- //---------------------------------------------------------------------------
- TLibS3BucketContext TS3FileSystem::GetBucketContext(const UnicodeString & BucketName, const UnicodeString & Prefix)
- {
- TLibS3BucketContext Result;
- bool First = true;
- bool Retry = false;
- do
- {
- TRegions::const_iterator I;
- I = FRegions.find(BucketName);
- UnicodeString Region;
- if (I != FRegions.end())
- {
- Region = I->second;
- }
- else
- {
- Region = FAuthRegion;
- if (First)
- {
- FTerminal->LogEvent(FORMAT(L"Unknown bucket \"%s\", will detect its region (and service endpoint)", (BucketName)));
- First = false;
- }
- Retry = true;
- }
- S3UriStyle UriStyle = S3UriStyle(FTerminal->SessionData->S3UrlStyle);
- I = FHostNames.find(BucketName);
- UnicodeString HostName;
- if (I != FHostNames.end())
- {
- HostName = I->second;
- if (SameText(HostName.SubString(1, BucketName.Length() + 1), BucketName + L"."))
- {
- HostName.Delete(1, BucketName.Length() + 1);
- // Even when using path-style URL Amazon seems to redirect us to bucket hostname and
- // we need to switch to virtual host style URL (without bucket name in the path)
- UriStyle = S3UriStyleVirtualHost;
- }
- }
- else
- {
- HostName = UnicodeString(FHostName);
- }
- Result.HostNameBuf = UTF8String(HostName + UnicodeString(FPortSuffix));
- Result.hostName = Result.HostNameBuf.c_str();
- Result.BucketNameBuf = UTF8String(BucketName);
- Result.bucketName = Result.BucketNameBuf.c_str();
- Result.protocol = FLibS3Protocol;
- Result.uriStyle = UriStyle;
- Result.accessKeyId = FAccessKeyId.c_str();
- Result.secretAccessKey = FSecretAccessKey.c_str();
- Result.securityToken = FSecurityToken;
- Result.AuthRegionBuf = UTF8String(Region);
- if (Result.AuthRegionBuf.Length() > S3_MAX_REGION_LENGTH)
- {
- Result.AuthRegionBuf.SetLength(S3_MAX_REGION_LENGTH);
- }
- Result.authRegion = Result.AuthRegionBuf.c_str();
- if (Retry)
- {
- std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
- TLibS3ListBucketCallbackData Data;
- // Using prefix for which we need the bucket, as the account may have access to that prefix only (using "Condition" in policy)
- DoListBucket(Prefix, FileList.get(), 1, Result, Data);
- Retry = false;
- UnicodeString EndpointDetail = Data.EndpointDetail;
- if ((Data.Status == S3StatusErrorAuthorizationHeaderMalformed) &&
- (Region != Data.RegionDetail))
- {
- FTerminal->LogEvent(FORMAT("Will use region \"%s\" for bucket \"%s\" from now on.", (Data.RegionDetail, BucketName)));
- FRegions.insert(std::make_pair(BucketName, Data.RegionDetail));
- Result.AuthRegionBuf = UTF8String(Data.RegionDetail);
- Result.authRegion = Result.AuthRegionBuf.c_str();
- }
- // happens with newly created buckets (and happens before the region redirect)
- else if (((Data.Status == S3StatusErrorTemporaryRedirect) || (Data.Status == S3StatusErrorPermanentRedirect)) &&
- !Data.EndpointDetail.IsEmpty())
- {
- UnicodeString Endpoint = Data.EndpointDetail;
- if (HostName != Endpoint)
- {
- FTerminal->LogEvent(FORMAT("Will use endpoint \"%s\" for bucket \"%s\" from now on.", (Endpoint, BucketName)));
- FHostNames.insert(std::make_pair(BucketName, Endpoint));
- Retry = true;
- }
- }
- // Minio
- else if (Data.Status == S3StatusOK)
- {
- FTerminal->LogEvent(FORMAT("Will keep using region \"%s\" for bucket \"%s\" from now on.", (FAuthRegion, BucketName)));
- FRegions.insert(std::make_pair(BucketName, FAuthRegion));
- }
- }
- }
- while (Retry);
- return Result;
- }
- //---------------------------------------------------------------------------
- #define CreateResponseHandlerCustom(PropertiesCallback) { &PropertiesCallback, &LibS3ResponseCompleteCallback }
- #define CreateResponseHandler() CreateResponseHandlerCustom(LibS3ResponsePropertiesCallback)
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::Close()
- {
- DebugAssert(FActive);
- LibS3Deinitialize();
- FTerminal->Closed();
- FActive = false;
- UnregisterFromNeonDebug(FTerminal);
- }
- //---------------------------------------------------------------------------
- bool __fastcall TS3FileSystem::GetActive()
- {
- return FActive;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CollectUsage()
- {
- // noop
- }
- //---------------------------------------------------------------------------
- const TSessionInfo & __fastcall TS3FileSystem::GetSessionInfo()
- {
- return FSessionInfo;
- }
- //---------------------------------------------------------------------------
- const TFileSystemInfo & __fastcall TS3FileSystem::GetFileSystemInfo(bool /*Retrieve*/)
- {
- return FFileSystemInfo;
- }
- //---------------------------------------------------------------------------
- bool __fastcall TS3FileSystem::TemporaryTransferFile(const UnicodeString & /*FileName*/)
- {
- return false;
- }
- //---------------------------------------------------------------------------
- bool __fastcall TS3FileSystem::GetStoredCredentialsTried()
- {
- // if we have one, we always try it
- return !FTerminal->SessionData->Password.IsEmpty();
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TS3FileSystem::GetUserName()
- {
- return UnicodeString(FAccessKeyId);
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::Idle()
- {
- // noop
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TS3FileSystem::AbsolutePath(const UnicodeString Path, bool /*Local*/)
- {
- if (UnixIsAbsolutePath(Path))
- {
- return Path;
- }
- else
- {
- return ::AbsolutePath(FCurrentDirectory, Path);
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TS3FileSystem::IsCapable(int Capability) const
- {
- DebugAssert(FTerminal);
- switch (Capability)
- {
- // Only to make double-click on file edit/open the file,
- // instead of trying to open it as directory
- case fcResolveSymlink:
- case fcRemoteCopy:
- case fcRename:
- case fcRemoteMove:
- case fcMoveToQueue:
- case fcSkipTransfer:
- case fcParallelTransfers:
- case fcLoadingAdditionalProperties:
- case fcAclChangingFiles:
- case fcMoveOverExistingFile:
- return true;
- case fcPreservingTimestampUpload:
- case fcCheckingSpaceAvailable:
- case fcUserGroupListing:
- case fcModeChanging:
- case fcModeChangingUpload:
- case fcGroupChanging:
- case fcOwnerChanging:
- case fcAnyCommand:
- case fcShellAnyCommand:
- case fcHardLink:
- case fcSymbolicLink:
- case fcTextMode:
- case fcNativeTextMode:
- case fcNewerOnlyUpload:
- case fcTimestampChanging:
- case fcIgnorePermErrors:
- case fcCalculatingChecksum:
- case fcSecondaryShell:
- case fcGroupOwnerChangingByID:
- case fcRemoveCtrlZUpload:
- case fcRemoveBOMUpload:
- case fcPreservingTimestampDirs:
- case fcResumeSupport:
- case fcChangePassword:
- case fcLocking:
- case fcTransferOut:
- case fcTransferIn:
- case fcParallelFileTransfers:
- return false;
- default:
- DebugFail();
- return false;
- }
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TS3FileSystem::GetCurrentDirectory()
- {
- return FCurrentDirectory;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::DoStartup()
- {
- // Capabilities of S3 protocol are fixed
- FTerminal->SaveCapabilities(FFileSystemInfo);
- FTerminal->SetExceptionOnFail(true);
- // retrieve initialize working directory to save it as home directory
- ReadCurrentDirectory();
- FTerminal->SetExceptionOnFail(false);
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::LookupUsersGroups()
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ReadCurrentDirectory()
- {
- if (FCachedDirectoryChange.IsEmpty())
- {
- FCurrentDirectory = FCurrentDirectory.IsEmpty() ? UnicodeString(L"/") : FCurrentDirectory;
- }
- else
- {
- FCurrentDirectory = FCachedDirectoryChange;
- FCachedDirectoryChange = L"";
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::HomeDirectory()
- {
- ChangeDirectory(L"/");
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::AnnounceFileListOperation()
- {
- // noop
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::TryOpenDirectory(const UnicodeString & Directory)
- {
- FTerminal->LogEvent(FORMAT(L"Trying to open directory \"%s\".", (Directory)));
- std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
- ReadDirectoryInternal(Directory, FileList.get(), -1, UnicodeString());
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ChangeDirectory(const UnicodeString ADirectory)
- {
- UnicodeString Path = AbsolutePath(ADirectory, false);
- // to verify existence of directory try to open it
- TryOpenDirectory(Path);
- // if open dir did not fail, directory exists -> success.
- FCachedDirectoryChange = Path;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CachedChangeDirectory(const UnicodeString Directory)
- {
- FCachedDirectoryChange = UnixExcludeTrailingBackslash(Directory);
- }
- //---------------------------------------------------------------------------
- TRemoteToken TS3FileSystem::MakeRemoteToken(const char * OwnerId, const char * OwnerDisplayName)
- {
- TRemoteToken Result;
- Result.Name = StrFromS3(OwnerDisplayName);
- if (Result.Name.IsEmpty())
- {
- Result.Name = StrFromS3(OwnerId);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- struct TLibS3ListServiceCallbackData : TLibS3CallbackData
- {
- TRemoteFileList * FileList;
- UnicodeString FileName; // filter for buckets
- };
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3ListServiceCallback(
- const char * OwnerId, const char * OwnerDisplayName, const char * BucketName,
- int64_t /*CreationDate*/, void * CallbackData)
- {
- TLibS3ListServiceCallbackData & Data = *static_cast<TLibS3ListServiceCallbackData *>(CallbackData);
- UnicodeString FileName = StrFromS3(BucketName);
- if (Data.FileName.IsEmpty() || (Data.FileName == FileName))
- {
- std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
- TTerminal * Terminal = Data.FileSystem->FTerminal;
- File->Terminal = Terminal;
- File->FileName = StrFromS3(BucketName);
- File->Type = FILETYPE_DIRECTORY;
- File->Owner = Data.FileSystem->MakeRemoteToken(OwnerId, OwnerDisplayName);
- File->ModificationFmt = mfNone;
- if (Terminal->IsValidFile(File.get()))
- {
- Data.FileList->AddFile(File.release());
- }
- }
- return S3StatusOK;
- }
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3ListBucketCallback(
- int IsTruncated, const char * NextMarker, int ContentsCount, const S3ListBucketContent * Contents,
- int CommonPrefixesCount, const char ** CommonPrefixes, void * CallbackData)
- {
- TLibS3ListBucketCallbackData & Data = *static_cast<TLibS3ListBucketCallbackData *>(CallbackData);
- Data.IsTruncated = IsTruncated;
- // This is being called in chunks, not once for all data in a response.
- Data.KeyCount += ContentsCount;
- Data.NextMarker = StrFromS3(NextMarker);
- TTerminal * Terminal = Data.FileSystem->FTerminal;
- for (int Index = 0; Index < ContentsCount; Index++)
- {
- Data.Any = true;
- const S3ListBucketContent * Content = &Contents[Index];
- UnicodeString FileName = UnixExtractFileName(StrFromS3(Content->key));
- if (!FileName.IsEmpty())
- {
- std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
- File->Terminal = Terminal;
- File->FileName = FileName;
- File->Type = FILETYPE_DEFAULT;
- #define ISO8601_FORMAT "%04d-%02d-%02dT%02d:%02d:%02d"
- int Year = 0;
- int Month = 0;
- int Day = 0;
- int Hour = 0;
- int Min = 0;
- int Sec = 0;
- // The libs3's parseIso8601Time uses mktime, so returns a local time, which we would have to complicatedly restore,
- // Doing own parting instead as it's easier.
- // Keep is sync with WebDAV
- int Filled =
- sscanf(Content->lastModifiedStr, ISO8601_FORMAT, &Year, &Month, &Day, &Hour, &Min, &Sec);
- if (Filled == 6)
- {
- TDateTime Modification =
- EncodeDateVerbose((unsigned short)Year, (unsigned short)Month, (unsigned short)Day) +
- EncodeTimeVerbose((unsigned short)Hour, (unsigned short)Min, (unsigned short)Sec, 0);
- File->Modification = ConvertTimestampFromUTC(Modification);
- File->ModificationFmt = mfFull;
- }
- else
- {
- File->ModificationFmt = mfNone;
- }
- File->Size = Content->size;
- File->Owner = Data.FileSystem->MakeRemoteToken(Content->ownerId, Content->ownerDisplayName);
- if (Terminal->IsValidFile(File.get()))
- {
- Data.FileList->AddFile(File.release());
- }
- }
- }
- for (int Index = 0; Index < CommonPrefixesCount; Index++)
- {
- Data.Any = true;
- UnicodeString CommonPrefix = StrFromS3(CommonPrefixes[Index]);
- UnicodeString FileName = UnixExtractFileName(UnixExcludeTrailingBackslash(CommonPrefix));
- // Have seen prefixes like "/" or "path/subpath//"
- if (!FileName.IsEmpty())
- {
- std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
- File->Terminal = Data.FileSystem->FTerminal;
- File->FileName = FileName;
- File->Type = FILETYPE_DIRECTORY;
- File->ModificationFmt = mfNone;
- if (Terminal->IsValidFile(File.get()))
- {
- Data.FileList->AddFile(File.release());
- }
- }
- }
- return S3StatusOK;
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::DoListBucket(
- const UnicodeString & Prefix, TRemoteFileList * FileList, int MaxKeys, const TLibS3BucketContext & BucketContext,
- TLibS3ListBucketCallbackData & Data)
- {
- S3ListBucketHandler ListBucketHandler = { CreateResponseHandler(), &LibS3ListBucketCallback };
- RequestInit(Data);
- Data.Any = false;
- Data.KeyCount = 0;
- Data.FileList = FileList;
- Data.IsTruncated = false;
- S3_list_bucket(
- &BucketContext, StrToS3(Prefix), StrToS3(Data.NextMarker),
- LibS3Delimiter.c_str(), MaxKeys, FRequestContext, FTimeout, &ListBucketHandler, &Data);
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::HandleNonBucketStatus(TLibS3CallbackData & Data, bool & Retry)
- {
- if ((Data.Status == S3StatusErrorAuthorizationHeaderMalformed) &&
- (FAuthRegion != Data.RegionDetail))
- {
- FTerminal->LogEvent(FORMAT("Will use authentication region \"%s\" from now on.", (Data.RegionDetail)));
- FAuthRegion = Data.RegionDetail;
- Retry = true;
- }
- }
- //---------------------------------------------------------------------------
- bool TS3FileSystem::IsGoogleCloud()
- {
- return SameText(L"storage.googleapis.com", FTerminal->SessionData->HostNameExpanded);
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::ReadDirectoryInternal(
- const UnicodeString & APath, TRemoteFileList * FileList, int MaxKeys, const UnicodeString & FileName)
- {
- UnicodeString Path = UnixExcludeTrailingBackslash(AbsolutePath(APath, false));
- int AMaxKeys = (MaxKeys == -1) ? 1 : MaxKeys;
- if (IsUnixRootPath(Path))
- {
- DebugAssert(FileList != NULL);
- TLibS3ListServiceCallbackData Data;
- Data.FileList = FileList;
- Data.FileName = FileName;
- bool Retry;
- do
- {
- RequestInit(Data);
- S3ListServiceHandler ListServiceHandler = { CreateResponseHandler(), &LibS3ListServiceCallback };
- Retry = false;
- if ((FTerminal->SessionData->S3MaxKeys == asOff) ||
- ((FTerminal->SessionData->S3MaxKeys == asAuto) && IsGoogleCloud()))
- {
- if (AMaxKeys != 0)
- {
- FTerminal->LogEvent(1, L"Not limiting keys.");
- AMaxKeys = 0;
- }
- }
- S3_list_service(
- FLibS3Protocol, FAccessKeyId.c_str(), FSecretAccessKey.c_str(), FSecurityToken, (FHostName + FPortSuffix).c_str(),
- StrToS3(FAuthRegion), AMaxKeys, FRequestContext, FTimeout, &ListServiceHandler, &Data);
- HandleNonBucketStatus(Data, Retry);
- }
- while (Retry);
- CheckLibS3Error(Data);
- }
- else
- {
- UnicodeString BucketName, Prefix;
- ParsePath(Path, BucketName, Prefix);
- if (!Prefix.IsEmpty())
- {
- Prefix = GetFolderKey(Prefix);
- }
- Prefix += FileName;
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Prefix);
- TLibS3ListBucketCallbackData Data;
- bool Continue;
- do
- {
- DoListBucket(Prefix, FileList, AMaxKeys, BucketContext, Data);
- CheckLibS3Error(Data);
- Continue = false;
- if (Data.IsTruncated)
- {
- // We have report that with max-keys=1, server can return IsTruncated response with no keys,
- // so we would loop infinitelly. For now, if we do GET request only to check for bucket/folder existence (MaxKeys == -1),
- // we are happy with a successfull response and never loop, even if IsTruncated.
- if ((MaxKeys == 0) ||
- ((MaxKeys > 0) && (Data.KeyCount < MaxKeys)))
- {
- bool Cancel = false;
- FTerminal->DoReadDirectoryProgress(FileList->Count, false, Cancel);
- if (!Cancel)
- {
- Continue = true;
- }
- }
- }
- } while (Continue);
- // Listing bucket root directory will report an error if the bucket does not exist.
- // But there won't be any prefix/ entry, so if the bucket is ampty, the Data.Any is false.
- // But when listing a prefix, we do not get any error, when the "prefix" does not exist.
- // But when the prefix does exist, there's at least the prefix/ entry. If there's none, it means that the path does not exist.
- // Even an empty-named entry/subprefix (which are ignored for other purposes) still indicate that the prefix exists.
- if (Prefix.IsEmpty() || Data.Any)
- {
- FileList->AddFile(new TRemoteParentDirectory(FTerminal));
- }
- else
- {
- // When called from DoReadFile (FileName is set), leaving error handling to the caller.
- if (FileName.IsEmpty())
- {
- throw Exception(FMTLOAD(FILE_NOT_EXISTS, (APath)));
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ReadDirectory(TRemoteFileList * FileList)
- {
- TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
- ReadDirectoryInternal(FileList->Directory, FileList, 0, UnicodeString());
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ReadSymlink(TRemoteFile * /*SymlinkFile*/,
- TRemoteFile *& /*File*/)
- {
- // we never set SymLink flag, so we should never get here
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::DoReadFile(const UnicodeString & FileName, TRemoteFile *& File)
- {
- UnicodeString FileNameOnly = UnixExtractFileName(FileName);
- std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
- ReadDirectoryInternal(UnixExtractFileDir(FileName), FileList.get(), 1, FileNameOnly);
- TRemoteFile * AFile = FileList->FindFile(FileNameOnly);
- if (AFile != NULL)
- {
- File = AFile->Duplicate();
- }
- else
- {
- File = NULL;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ReadFile(const UnicodeString FileName,
- TRemoteFile *& File)
- {
- TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
- DoReadFile(FileName, File);
- if (File == NULL)
- {
- throw Exception(FMTLOAD(FILE_NOT_EXISTS, (FileName)));
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::DeleteFile(const UnicodeString AFileName,
- const TRemoteFile * File, int Params, TRmSessionAction & Action)
- {
- UnicodeString FileName = AbsolutePath(AFileName, false);
- bool Dir = FTerminal->DeleteContentsIfDirectory(FileName, File, Params, Action);
- UnicodeString BucketName, Key;
- ParsePath(FileName, BucketName, Key);
- if (!Key.IsEmpty() && Dir)
- {
- Key = GetFolderKey(Key);
- }
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- S3ResponseHandler ResponseHandler = CreateResponseHandler();
- TLibS3CallbackData Data;
- RequestInit(Data);
- if (Key.IsEmpty())
- {
- S3_delete_bucket(
- BucketContext.protocol, BucketContext.uriStyle, BucketContext.accessKeyId, BucketContext.secretAccessKey,
- BucketContext.securityToken, BucketContext.hostName, BucketContext.bucketName, BucketContext.authRegion,
- FRequestContext, FTimeout, &ResponseHandler, &Data);
- CheckLibS3Error(Data);
- }
- else
- {
- S3_delete_object(&BucketContext, StrToS3(Key), FRequestContext, FTimeout, &ResponseHandler, &Data);
- try
- {
- CheckLibS3Error(Data);
- }
- catch (...)
- {
- if (FTerminal->Active && Dir && !FTerminal->FileExists(AFileName))
- {
- // Amazon silently ignores attempts to delete non existing folders,
- // But Google Cloud fails that.
- FTerminal->LogEvent(L"Folder does not exist anymore, it was probably only virtual");
- }
- else
- {
- throw;
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::RenameFile(const UnicodeString FileName, const TRemoteFile * File,
- const UnicodeString NewName)
- {
- if (DebugAlwaysTrue(File != NULL) && File->IsDirectory)
- {
- throw Exception(LoadStr(NOTSUPPORTED));
- }
- CopyFile(FileName, File, NewName);
- TRmSessionAction DummyAction(FTerminal->ActionLog, FileName);
- DeleteFile(FileName, File, dfForceDelete, DummyAction);
- DummyAction.Cancel();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CopyFile(const UnicodeString AFileName, const TRemoteFile * File,
- const UnicodeString ANewName)
- {
- if (DebugAlwaysTrue(File != NULL) && File->IsDirectory)
- {
- throw Exception(LoadStr(DUPLICATE_FOLDER_NOT_SUPPORTED));
- }
- UnicodeString FileName = AbsolutePath(AFileName, false);
- UnicodeString NewName = AbsolutePath(ANewName, false);
- UnicodeString SourceBucketName, SourceKey;
- ParsePath(FileName, SourceBucketName, SourceKey);
- DebugAssert(!SourceKey.IsEmpty()); // it's not a folder, so it cannot be a bucket or root
- UnicodeString DestBucketName, DestKey;
- ParsePath(NewName, DestBucketName, DestKey);
- if (DestKey.IsEmpty())
- {
- throw Exception(LoadStr(MISSING_TARGET_BUCKET));
- }
- TLibS3BucketContext BucketContext = GetBucketContext(DestBucketName, DestKey);
- BucketContext.BucketNameBuf = SourceBucketName;
- BucketContext.bucketName = BucketContext.BucketNameBuf.c_str();
- S3ResponseHandler ResponseHandler = CreateResponseHandler();
- TLibS3CallbackData Data;
- RequestInit(Data);
- S3_copy_object(
- &BucketContext, StrToS3(SourceKey), StrToS3(DestBucketName), StrToS3(DestKey),
- NULL, NULL, 0, NULL, FRequestContext, FTimeout, &ResponseHandler, &Data);
- CheckLibS3Error(Data);
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CreateDirectory(const UnicodeString & ADirName, bool /*Encrypt*/)
- {
- TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
- UnicodeString DirName = UnixExcludeTrailingBackslash(AbsolutePath(ADirName, false));
- UnicodeString BucketName, Key;
- ParsePath(DirName, BucketName, Key);
- if (Key.IsEmpty())
- {
- S3ResponseHandler ResponseHandler = CreateResponseHandler();
- // Not using GetBucketContext here, as the bucket does not exist
- UTF8String RegionBuf;
- char * Region = NULL;
- if (!FTerminal->SessionData->S3DefaultRegion.IsEmpty() &&
- (FTerminal->SessionData->S3DefaultRegion != S3LibDefaultRegion()))
- {
- RegionBuf = UTF8String(FTerminal->SessionData->S3DefaultRegion);
- Region = RegionBuf.c_str();
- }
- TLibS3CallbackData Data;
- bool Retry;
- do
- {
- RequestInit(Data);
- Retry = false;
- S3_create_bucket(
- FLibS3Protocol, FAccessKeyId.c_str(), FSecretAccessKey.c_str(), FSecurityToken,
- (FHostName + FPortSuffix).c_str(), StrToS3(BucketName),
- StrToS3(FAuthRegion), S3CannedAclPrivate, Region, FRequestContext, FTimeout, &ResponseHandler, &Data);
- HandleNonBucketStatus(Data, Retry);
- }
- while (Retry);
- CheckLibS3Error(Data);
- }
- else
- {
- Key = GetFolderKey(Key);
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- S3PutObjectHandler PutObjectHandler = { CreateResponseHandler(), NULL };
- TLibS3CallbackData Data;
- RequestInit(Data);
- S3_put_object(&BucketContext, StrToS3(Key), 0, NULL, FRequestContext, FTimeout, &PutObjectHandler, &Data);
- CheckLibS3Error(Data);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CreateLink(const UnicodeString FileName,
- const UnicodeString PointTo, bool /*Symbolic*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- struct TS3FileProperties
- {
- char OwnerId[S3_MAX_GRANTEE_USER_ID_SIZE];
- char OwnerDisplayName[S3_MAX_GRANTEE_DISPLAY_NAME_SIZE];
- int AclGrantCount;
- S3AclGrant AclGrants[S3_MAX_ACL_GRANT_COUNT];
- };
- //---------------------------------------------------------------------------
- static TRights::TRightLevel S3PermissionToRightLevel(S3Permission Permission)
- {
- TRights::TRightLevel Result;
- switch (Permission)
- {
- case S3PermissionRead: Result = TRights::rlS3Read; break;
- case S3PermissionWrite: Result = TRights::rlS3Write; break;
- case S3PermissionReadACP: Result = TRights::rlS3ReadACP; break;
- case S3PermissionWriteACP: Result = TRights::rlS3WriteACP; break;
- default: DebugFail(); Result = TRights::rlNone; break;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- bool TS3FileSystem::ParsePathForPropertiesRequests(
- const UnicodeString & Path, const TRemoteFile * File, UnicodeString & BucketName, UnicodeString & Key)
- {
- UnicodeString FileName = AbsolutePath(Path, false);
- ParsePath(FileName, BucketName, Key);
- bool Result = !Key.IsEmpty();
- if (Result && File->IsDirectory)
- {
- Key = GetFolderKey(Key);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- bool TS3FileSystem::DoLoadFileProperties(
- const UnicodeString & AFileName, const TRemoteFile * File, TS3FileProperties & Properties)
- {
- UnicodeString BucketName, Key;
- bool Result = ParsePathForPropertiesRequests(AFileName, File, BucketName, Key);
- if (Result)
- {
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- S3ResponseHandler ResponseHandler = CreateResponseHandler();
- TLibS3CallbackData Data;
- RequestInit(Data);
- S3_get_acl(
- &BucketContext, StrToS3(Key), Properties.OwnerId, Properties.OwnerDisplayName,
- &Properties.AclGrantCount, Properties.AclGrants,
- FRequestContext, FTimeout, &ResponseHandler, &Data);
- CheckLibS3Error(Data);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- typedef std::vector<S3AclGrant> TAclGrantsVector;
- static void AddAclGrant(
- TRights::TRightGroup Group, unsigned short & Permissions, TAclGrantsVector & AclGrants,
- const S3AclGrant & AclGrantTemplate, S3Permission Permission)
- {
- TRights::TRightLevel Level = S3PermissionToRightLevel(Permission);
- TRights::TFlag Flag = TRights::CalculateFlag(Group, Level);
- if (FLAGSET(Permissions, Flag))
- {
- S3AclGrant AclGrant(AclGrantTemplate);
- AclGrant.permission = Permission;
- AclGrants.push_back(AclGrant);
- Permissions -= static_cast<short int>(Flag);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ChangeFileProperties(const UnicodeString FileName,
- const TRemoteFile * File, const TRemoteProperties * Properties,
- TChmodSessionAction & /*Action*/)
- {
- TValidProperties ValidProperties = Properties->Valid;
- if (DebugAlwaysTrue(ValidProperties.Contains(vpRights)))
- {
- ValidProperties >> vpRights;
- DebugAssert(!Properties->AddXToDirectories);
- TS3FileProperties FileProperties;
- if (DebugAlwaysTrue(!File->IsDirectory) &&
- DebugAlwaysTrue(DoLoadFileProperties(FileName, File, FileProperties)))
- {
- TAclGrantsVector NewAclGrants;
- unsigned short Permissions = File->Rights->Combine(Properties->Rights);
- for (int GroupI = TRights::rgFirst; GroupI <= TRights::rgLast; GroupI++)
- {
- TRights::TRightGroup Group = static_cast<TRights::TRightGroup>(GroupI);
- S3AclGrant NewAclGrant;
- memset(&NewAclGrant, 0, sizeof(NewAclGrant));
- if (Group == TRights::rgUser)
- {
- NewAclGrant.granteeType = S3GranteeTypeCanonicalUser;
- DebugAssert(sizeof(NewAclGrant.grantee.canonicalUser.id) == sizeof(FileProperties.OwnerId));
- strcpy(NewAclGrant.grantee.canonicalUser.id, FileProperties.OwnerId);
- }
- else if (Group == TRights::rgS3AllAwsUsers)
- {
- NewAclGrant.granteeType = S3GranteeTypeAllAwsUsers;
- }
- else if (DebugAlwaysTrue(Group == TRights::rgS3AllUsers))
- {
- NewAclGrant.granteeType = S3GranteeTypeAllUsers;
- }
- unsigned short AllGroupPermissions =
- TRights::CalculatePermissions(Group, TRights::rlS3Read, TRights::rlS3ReadACP, TRights::rlS3WriteACP);
- if (FLAGSET(Permissions, AllGroupPermissions))
- {
- NewAclGrant.permission = S3PermissionFullControl;
- NewAclGrants.push_back(NewAclGrant);
- Permissions -= AllGroupPermissions;
- }
- else
- {
- #define ADD_ACL_GRANT(PERM) AddAclGrant(Group, Permissions, NewAclGrants, NewAclGrant, PERM)
- ADD_ACL_GRANT(S3PermissionRead);
- ADD_ACL_GRANT(S3PermissionWrite);
- ADD_ACL_GRANT(S3PermissionReadACP);
- ADD_ACL_GRANT(S3PermissionWriteACP);
- }
- }
- DebugAssert(Permissions == 0);
- // Preserve unrecognized permissions
- for (int Index = 0; Index < FileProperties.AclGrantCount; Index++)
- {
- S3AclGrant & AclGrant = FileProperties.AclGrants[Index];
- unsigned short Permission = AclGrantToPermissions(AclGrant, FileProperties);
- if (Permission == 0)
- {
- NewAclGrants.push_back(AclGrant);
- }
- }
- UnicodeString BucketName, Key;
- if (DebugAlwaysTrue(ParsePathForPropertiesRequests(FileName, File, BucketName, Key)))
- {
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- S3ResponseHandler ResponseHandler = CreateResponseHandler();
- TLibS3CallbackData Data;
- RequestInit(Data);
- S3_set_acl(
- &BucketContext, StrToS3(Key), FileProperties.OwnerId, FileProperties.OwnerDisplayName,
- NewAclGrants.size(), &NewAclGrants[0],
- FRequestContext, FTimeout, &ResponseHandler, &Data);
- CheckLibS3Error(Data);
- }
- }
- }
- DebugAssert(ValidProperties.Empty());
- }
- //---------------------------------------------------------------------------
- unsigned short TS3FileSystem::AclGrantToPermissions(S3AclGrant & AclGrant, const TS3FileProperties & Properties)
- {
- TRights::TRightGroup RightGroup = static_cast<TRights::TRightGroup>(-1);
- if (AclGrant.granteeType == S3GranteeTypeCanonicalUser)
- {
- if (strcmp(Properties.OwnerId, AclGrant.grantee.canonicalUser.id) == 0)
- {
- RightGroup = TRights::rgUser;
- }
- else
- {
- FTerminal->LogEvent(1, FORMAT(L"Unspported permission for canonical user %s", (StrFromS3(Properties.OwnerId))));
- }
- }
- else if (AclGrant.granteeType == S3GranteeTypeAllAwsUsers)
- {
- RightGroup = TRights::rgS3AllAwsUsers;
- }
- else if (AclGrant.granteeType == S3GranteeTypeAllUsers)
- {
- RightGroup = TRights::rgS3AllUsers;
- }
- unsigned short Result;
- if (RightGroup < 0)
- {
- Result = 0;
- }
- else
- {
- if (AclGrant.permission == S3PermissionFullControl)
- {
- Result = TRights::CalculatePermissions(RightGroup, TRights::rlS3Read, TRights::rlS3ReadACP, TRights::rlS3WriteACP);
- }
- else
- {
- DebugAssert(AclGrant.permission != S3PermissionWrite);
- TRights::TRightLevel RightLevel = S3PermissionToRightLevel(AclGrant.permission);
- if (RightLevel == TRights::rlNone)
- {
- Result = 0;
- }
- else
- {
- Result = TRights::CalculateFlag(RightGroup, RightLevel);
- }
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::LoadFileProperties(const UnicodeString AFileName, const TRemoteFile * File, void * Param)
- {
- bool & Result = *static_cast<bool *>(Param);
- TS3FileProperties Properties;
- Result = DoLoadFileProperties(AFileName, File, Properties);
- if (Result)
- {
- bool AdditionalRights;
- unsigned short Permissions = 0;
- for (int Index = 0; Index < Properties.AclGrantCount; Index++)
- {
- S3AclGrant & AclGrant = Properties.AclGrants[Index];
- unsigned short Permission = AclGrantToPermissions(AclGrant, Properties);
- if (Permission == 0)
- {
- AdditionalRights = true;
- }
- else
- {
- Permissions |= Permission;
- }
- }
- UnicodeString Delimiter(L",");
- UnicodeString HumanRights;
- for (int GroupI = TRights::rgFirst; GroupI <= TRights::rgLast; GroupI++)
- {
- TRights::TRightGroup Group = static_cast<TRights::TRightGroup>(GroupI);
- #define RIGHT_LEVEL_SET(LEVEL) FLAGSET(Permissions, TRights::CalculateFlag(Group, TRights::LEVEL))
- bool ReadRight = RIGHT_LEVEL_SET(rlS3Read);
- bool WriteRight = DebugAlwaysFalse(RIGHT_LEVEL_SET(rlS3Write));
- bool ReadACPRight = RIGHT_LEVEL_SET(rlS3ReadACP);
- bool WriteACPRight = RIGHT_LEVEL_SET(rlS3WriteACP);
- UnicodeString Desc;
- if (ReadRight && ReadACPRight && WriteACPRight)
- {
- Desc = L"F";
- }
- else if (ReadRight)
- {
- Desc = L"R";
- if (ReadACPRight || WriteACPRight || WriteRight)
- {
- Desc += L"+";
- }
- }
- if (!Desc.IsEmpty())
- {
- UnicodeString GroupDesc;
- switch (Group)
- {
- case TRights::rgUser: GroupDesc = L"O"; break;
- case TRights::rgS3AllAwsUsers: GroupDesc = L"U"; break;
- case TRights::rgS3AllUsers: GroupDesc = L"E"; break;
- default: DebugFail(); break;
- }
- if (!GroupDesc.IsEmpty())
- {
- Desc = GroupDesc + L":" + Desc;
- AddToList(HumanRights, Desc, Delimiter);
- }
- }
- }
- if (AdditionalRights)
- {
- AddToList(HumanRights, L"+", Delimiter);
- }
- File->Rights->Number = Permissions;
- File->Rights->SetTextOverride(HumanRights);
- Result = true;
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TS3FileSystem::LoadFilesProperties(TStrings * FileList)
- {
- bool Result = false;
- FTerminal->BeginTransaction();
- try
- {
- FTerminal->ProcessFiles(FileList, foGetProperties, LoadFileProperties, &Result);
- }
- __finally
- {
- FTerminal->EndTransaction();
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CalculateFilesChecksum(
- const UnicodeString & DebugUsedArg(Alg), TStrings * DebugUsedArg(FileList), TCalculatedChecksumEvent,
- TFileOperationProgressType *, bool DebugUsedArg(FirstLevel))
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CustomCommandOnFile(const UnicodeString FileName,
- const TRemoteFile * /*File*/, UnicodeString Command, int /*Params*/, TCaptureOutputEvent /*OutputEvent*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::AnyCommand(const UnicodeString Command,
- TCaptureOutputEvent /*OutputEvent*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- TStrings * __fastcall TS3FileSystem::GetFixedPaths()
- {
- return NULL;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::SpaceAvailable(const UnicodeString Path,
- TSpaceAvailable & /*ASpaceAvailable*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CopyToRemote(
- TStrings * FilesToCopy, const UnicodeString TargetDir, const TCopyParamType * CopyParam,
- int Params, TFileOperationProgressType * OperationProgress, TOnceDoneOperation & OnceDoneOperation)
- {
- Params &= ~cpAppend;
- FTerminal->DoCopyToRemote(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfPreCreateDir, OnceDoneOperation);
- }
- //---------------------------------------------------------------------------
- void TS3FileSystem::ConfirmOverwrite(
- const UnicodeString & SourceFullFileName, UnicodeString & TargetFileName,
- TFileOperationProgressType * OperationProgress, const TOverwriteFileParams * FileParams,
- const TCopyParamType * CopyParam, int Params)
- {
- int Answers = qaYes | qaNo | qaCancel | qaYesToAll | qaNoToAll;
- std::vector<TQueryButtonAlias> Aliases;
- Aliases.push_back(TQueryButtonAlias::CreateYesToAllGrouppedWithYes());
- Aliases.push_back(TQueryButtonAlias::CreateNoToAllGrouppedWithNo());
- TQueryParams QueryParams(qpNeverAskAgainCheck);
- QueryParams.Aliases = &Aliases[0];
- QueryParams.AliasesCount = Aliases.size();
- unsigned int Answer;
- {
- TSuspendFileOperationProgress Suspend(OperationProgress);
- Answer =
- FTerminal->ConfirmFileOverwrite(
- SourceFullFileName, TargetFileName, FileParams, Answers, &QueryParams,
- ReverseOperationSide(OperationProgress->Side),
- CopyParam, Params, OperationProgress);
- }
- switch (Answer)
- {
- case qaYes:
- // noop
- break;
- case qaNo:
- throw ESkipFile();
- default:
- DebugFail();
- case qaCancel:
- OperationProgress->SetCancelAtLeast(csCancel);
- Abort();
- break;
- }
- }
- //---------------------------------------------------------------------------
- struct TLibS3TransferObjectDataCallbackData : TLibS3CallbackData
- {
- UnicodeString FileName;
- TStream * Stream;
- TFileOperationProgressType * OperationProgress;
- std::unique_ptr<Exception> Exception;
- };
- //---------------------------------------------------------------------------
- struct TLibS3PutObjectDataCallbackData : TLibS3TransferObjectDataCallbackData
- {
- RawByteString ETag;
- };
- //---------------------------------------------------------------------------
- int TS3FileSystem::LibS3PutObjectDataCallback(int BufferSize, char * Buffer, void * CallbackData)
- {
- TLibS3PutObjectDataCallbackData & Data = *static_cast<TLibS3PutObjectDataCallbackData *>(CallbackData);
- return Data.FileSystem->PutObjectData(BufferSize, Buffer, Data);
- }
- //---------------------------------------------------------------------------
- bool TS3FileSystem::ShouldCancelTransfer(TLibS3TransferObjectDataCallbackData & Data)
- {
- bool Result = (Data.OperationProgress->Cancel != csContinue);
- if (Result)
- {
- if (Data.OperationProgress->ClearCancelFile())
- {
- Data.Exception.reset(new ESkipFile());
- }
- else
- {
- Data.Exception.reset(new EAbort(L""));
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- int TS3FileSystem::PutObjectData(int BufferSize, char * Buffer, TLibS3PutObjectDataCallbackData & Data)
- {
- int Result;
- if (ShouldCancelTransfer(Data))
- {
- Result = -1;
- }
- else
- {
- TFileOperationProgressType * OperationProgress = Data.OperationProgress;
- try
- {
- FILE_OPERATION_LOOP_BEGIN
- {
- Result = Data.Stream->Read(Buffer, BufferSize);
- }
- FILE_OPERATION_LOOP_END(FMTLOAD(READ_ERROR, (Data.FileName)));
- OperationProgress->ThrottleToCPSLimit(Result);
- OperationProgress->AddTransferred(Result);
- }
- catch (Exception & E)
- {
- Data.Exception.reset(CloneException(&E));
- Result = -1;
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- struct TLibS3MultipartInitialCallbackData : TLibS3CallbackData
- {
- RawByteString UploadId;
- };
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3MultipartInitialCallback(const char * UploadId, void * CallbackData)
- {
- TLibS3MultipartInitialCallbackData & Data = *static_cast<TLibS3MultipartInitialCallbackData *>(CallbackData);
- Data.UploadId = UploadId;
- return S3StatusOK;
- }
- //---------------------------------------------------------------------------
- struct TLibS3MultipartCommitPutObjectDataCallbackData : TLibS3CallbackData
- {
- RawByteString Message;
- int Remaining;
- };
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3MultipartResponsePropertiesCallback(
- const S3ResponseProperties * Properties, void * CallbackData)
- {
- S3Status Result = LibS3ResponsePropertiesCallback(Properties, CallbackData);
- TLibS3PutObjectDataCallbackData & Data = *static_cast<TLibS3PutObjectDataCallbackData *>(CallbackData);
- Data.ETag = Properties->eTag;
- return Result;
- }
- //---------------------------------------------------------------------------
- int TS3FileSystem::LibS3MultipartCommitPutObjectDataCallback(int BufferSize, char * Buffer, void * CallbackData)
- {
- TLibS3MultipartCommitPutObjectDataCallbackData & Data =
- *static_cast<TLibS3MultipartCommitPutObjectDataCallbackData *>(CallbackData);
- int Result = 0;
- if (Data.Remaining > 0)
- {
- Result = std::min(BufferSize, Data.Remaining);
- memcpy(Buffer, Data.Message.c_str() + Data.Message.Length() - Data.Remaining, Result);
- Data.Remaining -= Result;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::Source(
- TLocalFileHandle & Handle, const UnicodeString & TargetDir, UnicodeString & DestFileName,
- const TCopyParamType * CopyParam, int Params,
- TFileOperationProgressType * OperationProgress, unsigned int /*Flags*/,
- TUploadSessionAction & Action, bool & /*ChildError*/)
- {
- UnicodeString DestFullName = TargetDir + DestFileName;
- TRemoteFile * RemoteFile = NULL;
- try
- {
- // Should not throw on non-existing file by purpose (mainly not to get an exception while debugging)
- DoReadFile(DestFullName, RemoteFile);
- }
- catch (...)
- {
- // Pointless, as there's no persistent connection.
- if (!FTerminal->Active)
- {
- throw;
- }
- }
- if (RemoteFile != NULL)
- {
- TOverwriteFileParams FileParams;
- FileParams.SourceSize = Handle.Size;
- FileParams.SourceTimestamp = Handle.Modification;
- FileParams.DestSize = RemoteFile->Size;
- FileParams.DestTimestamp = TDateTime();
- FileParams.DestPrecision = mfNone;
- delete RemoteFile;
- ConfirmOverwrite(Handle.FileName, DestFileName, OperationProgress, &FileParams, CopyParam, Params);
- }
- DestFullName = TargetDir + DestFileName;
- // only now, we know the final destination
- // (not really true as we do not support changing file name on overwrite dialog)
- Action.Destination(DestFullName);
- UnicodeString BucketName, Key;
- ParsePath(DestFullName, BucketName, Key);
- if (Key.IsEmpty())
- {
- throw Exception(LoadStr(MISSING_TARGET_BUCKET));
- }
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- UTF8String ContentType = UTF8String(FTerminal->Configuration->GetFileMimeType(Handle.FileName));
- S3PutProperties PutProperties =
- {
- (ContentType.IsEmpty() ? NULL : ContentType.c_str()),
- NULL,
- NULL,
- NULL,
- NULL,
- -1,
- S3CannedAclPrivate,
- 0,
- NULL,
- 0
- };
- int Parts = std::min(S3MaxMultiPartChunks, std::max(1, static_cast<int>((Handle.Size + S3MinMultiPartChunkSize - 1) / S3MinMultiPartChunkSize)));
- int ChunkSize = std::max(S3MinMultiPartChunkSize, static_cast<int>((Handle.Size + Parts - 1) / Parts));
- DebugAssert((ChunkSize == S3MinMultiPartChunkSize) || (Handle.Size > static_cast<__int64>(S3MaxMultiPartChunks) * S3MinMultiPartChunkSize));
- bool Multipart = (Parts > 1);
- RawByteString MultipartUploadId;
- TLibS3MultipartCommitPutObjectDataCallbackData MultipartCommitPutObjectDataCallbackData;
- if (Multipart)
- {
- FTerminal->LogEvent(FORMAT(L"Initiating multipart upload (%d parts - chunk size %s)", (Parts, IntToStr(ChunkSize))));
- FILE_OPERATION_LOOP_BEGIN
- {
- TLibS3MultipartInitialCallbackData Data;
- RequestInit(Data);
- S3MultipartInitialHandler Handler = { CreateResponseHandler(), &LibS3MultipartInitialCallback };
- S3_initiate_multipart(&BucketContext, StrToS3(Key), &PutProperties, &Handler, FRequestContext, FTimeout, &Data);
- CheckLibS3Error(Data, true);
- MultipartUploadId = Data.UploadId;
- }
- FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
- FTerminal->LogEvent(FORMAT(L"Initiated multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
- MultipartCommitPutObjectDataCallbackData.Message += "<CompleteMultipartUpload>\n";
- }
- try
- {
- TLibS3PutObjectDataCallbackData Data;
- __int64 Position = 0;
- std::unique_ptr<TStream> Stream(new TSafeHandleStream(reinterpret_cast<THandle>(Handle.Handle)));
- for (int Part = 1; Part <= Parts; Part++)
- {
- FILE_OPERATION_LOOP_BEGIN
- {
- DebugAssert(Stream->Position == OperationProgress->TransferredSize);
- // If not, it's chunk retry and we have to undo the unsuccessful chunk upload
- if (Position < Stream->Position)
- {
- Stream->Position = Position;
- OperationProgress->AddTransferred(Position - OperationProgress->TransferredSize);
- }
- RequestInit(Data);
- Data.FileName = Handle.FileName;
- Data.Stream = Stream.get();
- Data.OperationProgress = OperationProgress;
- Data.Exception.reset(NULL);
- if (Multipart)
- {
- S3PutObjectHandler UploadPartHandler =
- { CreateResponseHandlerCustom(LibS3MultipartResponsePropertiesCallback), LibS3PutObjectDataCallback };
- __int64 Remaining = Stream->Size - Stream->Position;
- int RemainingInt = static_cast<int>(std::min(static_cast<__int64>(std::numeric_limits<int>::max()), Remaining));
- int PartLength = std::min(ChunkSize, RemainingInt);
- FTerminal->LogEvent(FORMAT(L"Uploading part %d [%s]", (Part, IntToStr(PartLength))));
- S3_upload_part(
- &BucketContext, StrToS3(Key), &PutProperties, &UploadPartHandler, Part, MultipartUploadId.c_str(),
- PartLength, FRequestContext, FTimeout, &Data);
- }
- else
- {
- S3PutObjectHandler PutObjectHandler = { CreateResponseHandler(), LibS3PutObjectDataCallback };
- S3_put_object(&BucketContext, StrToS3(Key), Handle.Size, &PutProperties, FRequestContext, FTimeout, &PutObjectHandler, &Data);
- }
- // The "exception" was already seen by the user, its presence mean an accepted abort of the operation.
- if (Data.Exception.get() == NULL)
- {
- CheckLibS3Error(Data, true);
- }
- Position = Stream->Position;
- if (Multipart)
- {
- RawByteString PartCommitTag =
- RawByteString::Format(" <Part><PartNumber>%d</PartNumber><ETag>%s</ETag></Part>\n", ARRAYOFCONST((Part, Data.ETag)));
- MultipartCommitPutObjectDataCallbackData.Message += PartCommitTag;
- }
- }
- FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
- if (Data.Exception.get() != NULL)
- {
- RethrowException(Data.Exception.get());
- }
- }
- Stream.reset(NULL);
- if (Multipart)
- {
- MultipartCommitPutObjectDataCallbackData.Message += "</CompleteMultipartUpload>\n";
- FTerminal->LogEvent(FORMAT(L"Committing multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
- FTerminal->LogEvent(UnicodeString(MultipartCommitPutObjectDataCallbackData.Message));
- FILE_OPERATION_LOOP_BEGIN
- {
- RequestInit(MultipartCommitPutObjectDataCallbackData);
- MultipartCommitPutObjectDataCallbackData.Remaining = MultipartCommitPutObjectDataCallbackData.Message.Length();
- S3MultipartCommitHandler MultipartCommitHandler =
- { CreateResponseHandler(), &LibS3MultipartCommitPutObjectDataCallback, NULL };
- S3_complete_multipart_upload(
- &BucketContext, StrToS3(Key), &MultipartCommitHandler, MultipartUploadId.c_str(),
- MultipartCommitPutObjectDataCallbackData.Remaining,
- FRequestContext, FTimeout, &MultipartCommitPutObjectDataCallbackData);
- CheckLibS3Error(MultipartCommitPutObjectDataCallbackData, true);
- }
- FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
- // to skip abort, in case we ever add any code before the catch, that can throw
- MultipartUploadId = RawByteString();
- }
- }
- catch (Exception & E)
- {
- if (!MultipartUploadId.IsEmpty())
- {
- FTerminal->LogEvent(FORMAT(L"Aborting multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
- try
- {
- TLibS3CallbackData Data;
- RequestInit(Data);
- S3AbortMultipartUploadHandler AbortMultipartUploadHandler = { CreateResponseHandler() };
- S3_abort_multipart_upload(
- &BucketContext, StrToS3(Key), MultipartUploadId.c_str(),
- FTimeout, &AbortMultipartUploadHandler, FRequestContext, &Data);
- }
- catch (...)
- {
- // swallow
- }
- }
- throw;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::CopyToLocal(
- TStrings * FilesToCopy, const UnicodeString TargetDir, const TCopyParamType * CopyParam,
- int Params, TFileOperationProgressType * OperationProgress, TOnceDoneOperation & OnceDoneOperation)
- {
- Params &= ~cpAppend;
- FTerminal->DoCopyToLocal(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfNone, OnceDoneOperation);
- }
- //---------------------------------------------------------------------------
- struct TLibS3GetObjectDataCallbackData : TLibS3TransferObjectDataCallbackData
- {
- };
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::LibS3GetObjectDataCallback(int BufferSize, const char * Buffer, void * CallbackData)
- {
- TLibS3GetObjectDataCallbackData & Data = *static_cast<TLibS3GetObjectDataCallbackData *>(CallbackData);
- return Data.FileSystem->GetObjectData(BufferSize, Buffer, Data);
- }
- //---------------------------------------------------------------------------
- S3Status TS3FileSystem::GetObjectData(int BufferSize, const char * Buffer, TLibS3GetObjectDataCallbackData & Data)
- {
- S3Status Result = S3StatusOK;
- if (ShouldCancelTransfer(Data))
- {
- Result = S3StatusAbortedByCallback;
- }
- else
- {
- TFileOperationProgressType * OperationProgress = Data.OperationProgress;
- try
- {
- FILE_OPERATION_LOOP_BEGIN
- {
- Data.Stream->Write(Buffer, BufferSize);
- }
- FILE_OPERATION_LOOP_END(FMTLOAD(WRITE_ERROR, (Data.FileName)));
- OperationProgress->ThrottleToCPSLimit(BufferSize);
- OperationProgress->AddTransferred(BufferSize);
- }
- catch (Exception & E)
- {
- Data.Exception.reset(CloneException(&E));
- Result = S3StatusAbortedByCallback;
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::Sink(
- const UnicodeString & FileName, const TRemoteFile * File,
- const UnicodeString & TargetDir, UnicodeString & DestFileName, int Attrs,
- const TCopyParamType * CopyParam, int Params, TFileOperationProgressType * OperationProgress,
- unsigned int /*Flags*/, TDownloadSessionAction & Action)
- {
- UnicodeString DestFullName = TargetDir + DestFileName;
- if (FileExists(ApiPath(DestFullName)))
- {
- __int64 Size;
- __int64 MTime;
- FTerminal->OpenLocalFile(DestFullName, GENERIC_READ, NULL, NULL, NULL, &MTime, NULL, &Size);
- TOverwriteFileParams FileParams;
- FileParams.SourceSize = File->Size;
- FileParams.SourceTimestamp = File->Modification; // noop
- FileParams.DestSize = Size;
- FileParams.DestTimestamp = UnixToDateTime(MTime, FTerminal->SessionData->DSTMode);
- ConfirmOverwrite(FileName, DestFileName, OperationProgress, &FileParams, CopyParam, Params);
- }
- UnicodeString BucketName, Key;
- ParsePath(FileName, BucketName, Key);
- TLibS3BucketContext BucketContext = GetBucketContext(BucketName, Key);
- UnicodeString ExpandedDestFullName = ExpandUNCFileName(DestFullName);
- Action.Destination(ExpandedDestFullName);
- FILE_OPERATION_LOOP_BEGIN
- {
- HANDLE LocalHandle;
- if (!FTerminal->CreateLocalFile(DestFullName, OperationProgress, &LocalHandle, FLAGSET(Params, cpNoConfirmation)))
- {
- throw ESkipFile();
- }
- std::unique_ptr<TStream> Stream(new TSafeHandleStream(reinterpret_cast<THandle>(LocalHandle)));
- bool DeleteLocalFile = true;
- try
- {
- TLibS3GetObjectDataCallbackData Data;
- FILE_OPERATION_LOOP_BEGIN
- {
- RequestInit(Data);
- Data.FileName = FileName;
- Data.Stream = Stream.get();
- Data.OperationProgress = OperationProgress;
- Data.Exception.reset(NULL);
- TAutoFlag ResponseIgnoreSwitch(FResponseIgnore);
- S3GetObjectHandler GetObjectHandler = { CreateResponseHandler(), LibS3GetObjectDataCallback };
- S3_get_object(
- &BucketContext, StrToS3(Key), NULL, Stream->Position, 0, FRequestContext, FTimeout, &GetObjectHandler, &Data);
- // The "exception" was already seen by the user, its presence mean an accepted abort of the operation.
- if (Data.Exception.get() == NULL)
- {
- CheckLibS3Error(Data, true);
- }
- }
- FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (FileName)), (folAllowSkip | folRetryOnFatal));
- if (Data.Exception.get() != NULL)
- {
- RethrowException(Data.Exception.get());
- }
- DeleteLocalFile = false;
- if (CopyParam->PreserveTime)
- {
- FTerminal->UpdateTargetTime(LocalHandle, File->Modification, FTerminal->SessionData->DSTMode);
- }
- }
- __finally
- {
- CloseHandle(LocalHandle);
- if (DeleteLocalFile)
- {
- FTerminal->DoDeleteLocalFile(DestFullName);
- }
- }
- }
- FILE_OPERATION_LOOP_END(FMTLOAD(TRANSFER_ERROR, (FileName)));
- FTerminal->UpdateTargetAttrs(DestFullName, File, CopyParam, Attrs);
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::GetSupportedChecksumAlgs(TStrings * /*Algs*/)
- {
- // NOOP
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::LockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::UnlockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
- {
- DebugFail();
- }
- //---------------------------------------------------------------------------
- void __fastcall TS3FileSystem::UpdateFromMain(TCustomFileSystem * /*AMainFileSystem*/)
- {
- // noop
- }
- //------------------------------------------------------------------------------
- void __fastcall TS3FileSystem::ClearCaches()
- {
- FRegions.clear();
- FHostNames.clear();
- }
- //------------------------------------------------------------------------------
|