S3FileSystem.cpp 55 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #define NE_LFS
  5. #define WINSCP
  6. #define NEED_LIBS3
  7. #include "S3FileSystem.h"
  8. #include "SessionData.h"
  9. #include "Interface.h"
  10. #include "Common.h"
  11. #include "Exceptions.h"
  12. #include "Terminal.h"
  13. #include "TextsCore.h"
  14. #include "HelpCore.h"
  15. #include "NeonIntf.h"
  16. #include <ne_request.h>
  17. #include <StrUtils.hpp>
  18. //---------------------------------------------------------------------------
  19. #pragma package(smart_init)
  20. //---------------------------------------------------------------------------
  21. #define StrFromS3(S) StrFromNeon(S)
  22. #define StrToS3(S) StrToNeon(S)
  23. //---------------------------------------------------------------------------
  24. #define FILE_OPERATION_LOOP_TERMINAL FTerminal
  25. //---------------------------------------------------------------------------
  26. static std::unique_ptr<TCriticalSection> LibS3Section(TraceInitPtr(new TCriticalSection()));
  27. //---------------------------------------------------------------------------
  28. UTF8String LibS3Delimiter(L"/");
  29. //---------------------------------------------------------------------------
  30. UnicodeString __fastcall S3LibVersion()
  31. {
  32. return FORMAT(L"%s.%s", (LIBS3_VER_MAJOR, LIBS3_VER_MINOR));
  33. }
  34. //---------------------------------------------------------------------------
  35. UnicodeString __fastcall S3LibDefaultHostName()
  36. {
  37. return UnicodeString(S3_DEFAULT_HOSTNAME);
  38. }
  39. //---------------------------------------------------------------------------
  40. UnicodeString __fastcall S3LibDefaultRegion()
  41. {
  42. return StrFromS3(S3_DEFAULT_REGION);
  43. }
  44. //---------------------------------------------------------------------------
  45. //---------------------------------------------------------------------------
  46. const int TS3FileSystem::S3MultiPartChunkSize = 5 * 1024 * 1024;
  47. //---------------------------------------------------------------------------
  48. TS3FileSystem::TS3FileSystem(TTerminal * ATerminal) :
  49. TCustomFileSystem(ATerminal),
  50. FActive(false),
  51. FResponseIgnore(false)
  52. {
  53. FFileSystemInfo.ProtocolBaseName = L"S3";
  54. FFileSystemInfo.ProtocolName = FFileSystemInfo.ProtocolBaseName;
  55. S3_create_request_context(&FRequestContext);
  56. S3_set_request_context_session_callback(FRequestContext, LibS3SessionCallback, this);
  57. S3_set_request_context_ssl_callback(FRequestContext, LibS3SslCallback, this);
  58. S3_set_request_context_response_data_callback(FRequestContext, LibS3ResponseDataCallback, this);
  59. }
  60. //---------------------------------------------------------------------------
  61. __fastcall TS3FileSystem::~TS3FileSystem()
  62. {
  63. S3_destroy_request_context(FRequestContext);
  64. FRequestContext = NULL;
  65. UnregisterFromNeonDebug(FTerminal);
  66. }
  67. //---------------------------------------------------------------------------
  68. void __fastcall TS3FileSystem::Open()
  69. {
  70. FTlsVersionStr = L"";
  71. FNeonSession = NULL;
  72. FCurrentDirectory = L"";
  73. RequireNeon(FTerminal);
  74. FTerminal->Information(LoadStr(STATUS_CONNECT), true);
  75. TSessionData * Data = FTerminal->SessionData;
  76. FSessionInfo.LoginTime = Now();
  77. FLibS3Protocol = (Data->Ftps != ftpsNone) ? S3ProtocolHTTPS : S3ProtocolHTTP;
  78. UnicodeString AccessKeyId = Data->UserNameExpanded;
  79. if (AccessKeyId.IsEmpty())
  80. {
  81. if (!FTerminal->PromptUser(Data, pkUserName, LoadStr(S3_ACCESS_KEY_ID_TITLE), L"",
  82. LoadStr(S3_ACCESS_KEY_ID_PROMPT), true, 0, AccessKeyId))
  83. {
  84. // note that we never get here actually
  85. throw Exception(L"");
  86. }
  87. }
  88. FAccessKeyId = UTF8String(AccessKeyId);
  89. UnicodeString SecretAccessKey = UTF8String(Data->Password);
  90. if (SecretAccessKey.IsEmpty())
  91. {
  92. if (!FTerminal->PromptUser(Data, pkPassword, LoadStr(S3_SECRET_ACCESS_KEY_TITLE), L"",
  93. LoadStr(S3_SECRET_ACCESS_KEY_PROMPT), false, 0, SecretAccessKey))
  94. {
  95. // note that we never get here actually
  96. throw Exception(L"");
  97. }
  98. }
  99. FSecretAccessKey = UTF8String(SecretAccessKey);
  100. FHostName = UTF8String(Data->HostNameExpanded);
  101. FTimeout = Data->Timeout;
  102. RegisterForNeonDebug(FTerminal);
  103. UpdateNeonDebugMask();
  104. {
  105. TGuard Guard(LibS3Section.get());
  106. S3_initialize(NULL, S3_INIT_ALL, NULL);
  107. }
  108. FActive = false;
  109. try
  110. {
  111. TryOpenDirectory(ROOTDIRECTORY);
  112. }
  113. catch (Exception & E)
  114. {
  115. LibS3Deinitialize();
  116. FTerminal->Closed();
  117. FTerminal->FatalError(&E, LoadStr(CONNECTION_FAILED));
  118. }
  119. FActive = true;
  120. }
  121. //---------------------------------------------------------------------------
  122. struct TLibS3CallbackData
  123. {
  124. TLibS3CallbackData()
  125. {
  126. Status = (S3Status)-1;
  127. }
  128. TS3FileSystem * FileSystem;
  129. S3Status Status;
  130. UnicodeString RegionDetail;
  131. UnicodeString EndpointDetail;
  132. UnicodeString ErrorMessage;
  133. UnicodeString ErrorDetails;
  134. };
  135. //---------------------------------------------------------------------------
  136. TS3FileSystem * TS3FileSystem::GetFileSystem(void * CallbackData)
  137. {
  138. return static_cast<TLibS3CallbackData *>(CallbackData)->FileSystem;
  139. }
  140. //---------------------------------------------------------------------------
  141. void TS3FileSystem::LibS3SessionCallback(ne_session_s * Session, void * CallbackData)
  142. {
  143. TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
  144. TSessionData * Data = FileSystem->FTerminal->SessionData;
  145. InitNeonSession(
  146. Session, Data->ProxyMethod, Data->ProxyHost, Data->ProxyPort,
  147. Data->ProxyUsername, Data->ProxyPassword, FileSystem->FTerminal);
  148. SetNeonTlsInit(Session, FileSystem->InitSslSession);
  149. // Data->Timeout is propagated via timeoutMs parameter of functions like S3_list_service
  150. FileSystem->FNeonSession = Session;
  151. }
  152. //------------------------------------------------------------------------------
  153. void TS3FileSystem::InitSslSession(ssl_st * Ssl, ne_session * /*Session*/)
  154. {
  155. // See also CAsyncSslSocketLayer::InitSSLConnection
  156. SetupSsl(Ssl, FTerminal->SessionData->MinTlsVersion, FTerminal->SessionData->MaxTlsVersion);
  157. }
  158. //---------------------------------------------------------------------------
  159. int TS3FileSystem::LibS3SslCallback(int Failures, const ne_ssl_certificate_s * Certificate, void * CallbackData)
  160. {
  161. TNeonCertificateData Data;
  162. RetrieveNeonCertificateData(Failures, Certificate, Data);
  163. TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
  164. return FileSystem->VerifyCertificate(Data) ? NE_OK : NE_ERROR;
  165. }
  166. //---------------------------------------------------------------------------
  167. // Similar to TWebDAVFileSystem::VerifyCertificate
  168. bool TS3FileSystem::VerifyCertificate(TNeonCertificateData Data)
  169. {
  170. FSessionInfo.CertificateFingerprint = Data.Fingerprint;
  171. bool Result;
  172. if (FTerminal->SessionData->FingerprintScan)
  173. {
  174. Result = false;
  175. }
  176. else
  177. {
  178. FTerminal->LogEvent(CertificateVerificationMessage(Data));
  179. UnicodeString SiteKey = TSessionData::FormatSiteKey(FTerminal->SessionData->HostNameExpanded, FTerminal->SessionData->PortNumber);
  180. Result =
  181. FTerminal->VerifyCertificate(HttpsCertificateStorageKey, SiteKey, Data.Fingerprint, Data.Subject, Data.Failures);
  182. if (!Result)
  183. {
  184. UnicodeString Message;
  185. Result = NeonWindowsValidateCertificateWithMessage(Data, Message);
  186. FTerminal->LogEvent(Message);
  187. }
  188. FSessionInfo.Certificate = CertificateSummary(Data, FTerminal->SessionData->HostNameExpanded);
  189. if (!Result)
  190. {
  191. Result = FTerminal->ConfirmCertificate(FSessionInfo, Data.Failures, HttpsCertificateStorageKey, true);
  192. }
  193. if (Result)
  194. {
  195. CollectTLSSessionInfo();
  196. }
  197. }
  198. return Result;
  199. }
  200. //------------------------------------------------------------------------------
  201. void TS3FileSystem::CollectTLSSessionInfo()
  202. {
  203. // See also TFTPFileSystem::Open().
  204. // Have to cache the value as the connection (the neon HTTP session, not "our" session)
  205. // can be closed at the time we need it in CollectUsage().
  206. UnicodeString Message = NeonTlsSessionInfo(FNeonSession, FSessionInfo, FTlsVersionStr);
  207. FTerminal->LogEvent(Message);
  208. }
  209. //---------------------------------------------------------------------------
  210. S3Status TS3FileSystem::LibS3ResponsePropertiesCallback(const S3ResponseProperties * /*Properties*/, void * /*CallbackData*/)
  211. {
  212. // TODO
  213. return S3StatusOK;
  214. }
  215. //---------------------------------------------------------------------------
  216. void TS3FileSystem::LibS3ResponseDataCallback(const char * Data, size_t Size, void * CallbackData)
  217. {
  218. TS3FileSystem * FileSystem = static_cast<TS3FileSystem *>(CallbackData);
  219. if (FileSystem->FTerminal->Log->Logging && !FileSystem->FResponseIgnore)
  220. {
  221. UnicodeString Content = UnicodeString(UTF8String(Data, Size)).Trim();
  222. FileSystem->FResponse += Content;
  223. }
  224. }
  225. //---------------------------------------------------------------------------
  226. void TS3FileSystem::LibS3ResponseCompleteCallback(S3Status Status, const S3ErrorDetails * Error, void * CallbackData)
  227. {
  228. TLibS3CallbackData & Data = *static_cast<TLibS3CallbackData *>(CallbackData);
  229. TS3FileSystem * FileSystem = Data.FileSystem;
  230. Data.Status = Status;
  231. Data.RegionDetail = L"";
  232. Data.EndpointDetail = L"";
  233. Data.ErrorMessage = L"";
  234. Data.ErrorDetails = L"";
  235. if (Error != NULL)
  236. {
  237. if (Error->message != NULL)
  238. {
  239. Data.ErrorMessage = StrFromS3(Error->message);
  240. FileSystem->FTerminal->LogEvent(Data.ErrorMessage);
  241. }
  242. UnicodeString ErrorDetails;
  243. if (Error->resource != NULL)
  244. {
  245. AddToList(ErrorDetails, FMTLOAD(S3_ERROR_RESOURCE, (StrFromS3(Error->resource))), L"\n");
  246. }
  247. if (Error->furtherDetails != NULL)
  248. {
  249. AddToList(ErrorDetails, FMTLOAD(S3_ERROR_FURTHER_DETAILS, (StrFromS3(Error->furtherDetails))), L"\n");
  250. }
  251. if (Error->extraDetailsCount)
  252. {
  253. UnicodeString ExtraDetails;
  254. for (int I = 0; I < Error->extraDetailsCount; I++)
  255. {
  256. UnicodeString DetailName = StrFromS3(Error->extraDetails[I].name);
  257. UnicodeString DetailValue = StrFromS3(Error->extraDetails[I].value);
  258. if (SameText(DetailName, L"Region"))
  259. {
  260. Data.RegionDetail = DetailValue;
  261. }
  262. else if (SameText(DetailName, L"Endpoint"))
  263. {
  264. Data.EndpointDetail = DetailValue;
  265. }
  266. AddToList(ExtraDetails, FORMAT(L"%s: %s", (DetailName, DetailValue)), L", ");
  267. }
  268. AddToList(ErrorDetails, LoadStr(S3_ERROR_EXTRA_DETAILS) + ExtraDetails, L"\n");
  269. }
  270. if (!ErrorDetails.IsEmpty())
  271. {
  272. FileSystem->FTerminal->LogEvent(ErrorDetails);
  273. Data.ErrorDetails = ErrorDetails;
  274. }
  275. }
  276. if (!FileSystem->FResponse.IsEmpty())
  277. {
  278. FileSystem->FTerminal->Log->Add(llOutput, FileSystem->FResponse);
  279. }
  280. }
  281. //---------------------------------------------------------------------------
  282. void TS3FileSystem::RequestInit(TLibS3CallbackData & Data)
  283. {
  284. Data.FileSystem = this;
  285. FResponse = L"";
  286. }
  287. //---------------------------------------------------------------------------
  288. void TS3FileSystem::CheckLibS3Error(const TLibS3CallbackData & Data, bool FatalOnConnectError)
  289. {
  290. if (Data.Status != S3StatusOK)
  291. {
  292. UnicodeString Error, Details;
  293. bool FatalCandidate = false;
  294. switch (Data.Status)
  295. {
  296. case S3StatusAbortedByCallback:
  297. Error = LoadStr(USER_TERMINATED);
  298. break;
  299. case S3StatusErrorAccessDenied:
  300. Error = LoadStr(S3_STATUS_ACCESS_DENIED);
  301. break;
  302. case S3StatusErrorSignatureDoesNotMatch: // While it can mean an implementation fault, it will typically mean a wrong secure key.
  303. case S3StatusErrorInvalidAccessKeyId:
  304. Error = LoadStr(AUTHENTICATION_FAILED);
  305. break;
  306. case S3StatusNameLookupError:
  307. Error = ReplaceStr(LoadStr(NET_TRANSL_HOST_NOT_EXIST2), L"%HOST%", FTerminal->SessionData->HostNameExpanded);
  308. FatalCandidate = true;
  309. break;
  310. case S3StatusFailedToConnect:
  311. Error = LoadStr(CONNECTION_FAILED);
  312. FatalCandidate = true;
  313. break;
  314. case S3StatusConnectionFailed:
  315. FatalCandidate = true;
  316. break;
  317. }
  318. if (!Error.IsEmpty())
  319. {
  320. Details = Data.ErrorMessage;
  321. AddToList(Details, Data.ErrorDetails, L"\n");
  322. }
  323. else
  324. {
  325. if (!Data.ErrorMessage.IsEmpty())
  326. {
  327. Error = Data.ErrorMessage;
  328. }
  329. else
  330. {
  331. // only returns name of the S3 status code symbol, like S3StatusErrorAccountProblem,
  332. // not something we should really display to an user, but still better than an internal error code
  333. Error = S3_get_status_name(Data.Status);
  334. }
  335. Details = Data.ErrorDetails;
  336. }
  337. Error = MainInstructions(Error);
  338. if (FatalCandidate && FatalOnConnectError)
  339. {
  340. throw EFatal(NULL, Error, Details);
  341. }
  342. else
  343. {
  344. throw ExtException(Error, Details);
  345. }
  346. }
  347. }
  348. //---------------------------------------------------------------------------
  349. void TS3FileSystem::LibS3Deinitialize()
  350. {
  351. TGuard Guard(LibS3Section.get());
  352. S3_deinitialize();
  353. }
  354. //---------------------------------------------------------------------------
  355. UnicodeString TS3FileSystem::GetFolderKey(const UnicodeString & Key)
  356. {
  357. return Key + L"/";
  358. }
  359. //---------------------------------------------------------------------------
  360. void TS3FileSystem::ParsePath(UnicodeString Path, UnicodeString & BucketName, UnicodeString & Key)
  361. {
  362. if (DebugAlwaysTrue(Path.SubString(1, 1) == L"/"))
  363. {
  364. Path.Delete(1, 1);
  365. }
  366. int P = Path.Pos(L"/");
  367. UnicodeString Result;
  368. if (P == 0)
  369. {
  370. BucketName = Path;
  371. Key = L"";
  372. }
  373. else
  374. {
  375. BucketName = Path.SubString(0, P - 1);
  376. Key = Path.SubString(P + 1, Path.Length() - P);
  377. }
  378. }
  379. //---------------------------------------------------------------------------
  380. struct TLibS3BucketContext : S3BucketContext
  381. {
  382. // These keep data that that we point the native S3BucketContext fields to
  383. UTF8String HostNameBuf;
  384. UTF8String BucketNameBuf;
  385. UTF8String AuthRegionBuf;
  386. };
  387. //---------------------------------------------------------------------------
  388. struct TLibS3ListBucketCallbackData : TLibS3CallbackData
  389. {
  390. TRemoteFileList * FileList;
  391. int KeyCount;
  392. UTF8String NextMarker;
  393. bool IsTruncated;
  394. };
  395. //---------------------------------------------------------------------------
  396. TLibS3BucketContext TS3FileSystem::GetBucketContext(const UnicodeString & BucketName)
  397. {
  398. TLibS3BucketContext Result;
  399. bool First = true;
  400. bool Retry = false;
  401. do
  402. {
  403. TRegions::const_iterator I;
  404. I = FRegions.find(BucketName);
  405. UnicodeString Region;
  406. if (I != FRegions.end())
  407. {
  408. Region = I->second;
  409. }
  410. else
  411. {
  412. Region = FTerminal->SessionData->S3DefaultRegion;
  413. if (First)
  414. {
  415. FTerminal->LogEvent(FORMAT(L"Unknown bucket \"%s\", will detect its region (and service endpoint)", (BucketName)));
  416. First = false;
  417. }
  418. Retry = true;
  419. }
  420. I = FHostNames.find(BucketName);
  421. UnicodeString HostName;
  422. if (I != FHostNames.end())
  423. {
  424. HostName = I->second;
  425. }
  426. else
  427. {
  428. HostName = UnicodeString(FHostName);
  429. }
  430. Result.HostNameBuf = UTF8String(HostName);
  431. Result.hostName = Result.HostNameBuf.c_str();
  432. Result.BucketNameBuf = UTF8String(BucketName);
  433. Result.bucketName = Result.BucketNameBuf.c_str();
  434. Result.protocol = FLibS3Protocol;
  435. Result.uriStyle = S3UriStyleVirtualHost;
  436. Result.accessKeyId = FAccessKeyId.c_str();
  437. Result.secretAccessKey = FSecretAccessKey.c_str();
  438. Result.securityToken = NULL;
  439. Result.AuthRegionBuf = UTF8String(Region);
  440. Result.authRegion = Result.AuthRegionBuf.c_str();
  441. if (Retry)
  442. {
  443. std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
  444. TLibS3ListBucketCallbackData Data;
  445. DoListBucket(UnicodeString(), FileList.get(), 1, Result, Data);
  446. Retry = false;
  447. UnicodeString EndpointDetail = Data.EndpointDetail;
  448. if ((Data.Status == S3StatusErrorAuthorizationHeaderMalformed) &&
  449. (Region != Data.RegionDetail))
  450. {
  451. FTerminal->LogEvent(FORMAT("Will use region \"%s\" for bucket \"%s\" from now on.", (Data.RegionDetail, BucketName)));
  452. FRegions.insert(std::make_pair(BucketName, Data.RegionDetail));
  453. Result.AuthRegionBuf = UTF8String(Data.RegionDetail);
  454. Result.authRegion = Result.AuthRegionBuf.c_str();
  455. }
  456. // happens with newly created buckets (and happens before the region redirect)
  457. else if ((Data.Status == S3StatusErrorTemporaryRedirect) && !Data.EndpointDetail.IsEmpty())
  458. {
  459. UnicodeString Endpoint = Data.EndpointDetail;
  460. if (SameText(Endpoint.SubString(1, BucketName.Length() + 1), BucketName + L"."))
  461. {
  462. Endpoint.Delete(1, BucketName.Length() + 1);
  463. }
  464. if (HostName != Endpoint)
  465. {
  466. FTerminal->LogEvent(FORMAT("Will use endpoint \"%s\" for bucket \"%s\" from now on.", (Endpoint, BucketName)));
  467. FHostNames.insert(std::make_pair(BucketName, Endpoint));
  468. Retry = true;
  469. }
  470. }
  471. }
  472. }
  473. while (Retry);
  474. return Result;
  475. }
  476. //---------------------------------------------------------------------------
  477. #define CreateResponseHandlerCustom(PropertiesCallback) { &PropertiesCallback, &LibS3ResponseCompleteCallback }
  478. #define CreateResponseHandler() CreateResponseHandlerCustom(LibS3ResponsePropertiesCallback)
  479. //---------------------------------------------------------------------------
  480. void __fastcall TS3FileSystem::Close()
  481. {
  482. DebugAssert(FActive);
  483. LibS3Deinitialize();
  484. FTerminal->Closed();
  485. FActive = false;
  486. UnregisterFromNeonDebug(FTerminal);
  487. }
  488. //---------------------------------------------------------------------------
  489. bool __fastcall TS3FileSystem::GetActive()
  490. {
  491. return FActive;
  492. }
  493. //---------------------------------------------------------------------------
  494. void __fastcall TS3FileSystem::CollectUsage()
  495. {
  496. // noop
  497. }
  498. //---------------------------------------------------------------------------
  499. const TSessionInfo & __fastcall TS3FileSystem::GetSessionInfo()
  500. {
  501. return FSessionInfo;
  502. }
  503. //---------------------------------------------------------------------------
  504. const TFileSystemInfo & __fastcall TS3FileSystem::GetFileSystemInfo(bool /*Retrieve*/)
  505. {
  506. return FFileSystemInfo;
  507. }
  508. //---------------------------------------------------------------------------
  509. bool __fastcall TS3FileSystem::TemporaryTransferFile(const UnicodeString & /*FileName*/)
  510. {
  511. return false;
  512. }
  513. //---------------------------------------------------------------------------
  514. bool __fastcall TS3FileSystem::GetStoredCredentialsTried()
  515. {
  516. // if we have one, we always try it
  517. return !FTerminal->SessionData->Password.IsEmpty();
  518. }
  519. //---------------------------------------------------------------------------
  520. UnicodeString __fastcall TS3FileSystem::GetUserName()
  521. {
  522. return UnicodeString(FAccessKeyId);
  523. }
  524. //---------------------------------------------------------------------------
  525. void __fastcall TS3FileSystem::Idle()
  526. {
  527. // noop
  528. }
  529. //---------------------------------------------------------------------------
  530. UnicodeString __fastcall TS3FileSystem::AbsolutePath(const UnicodeString Path, bool /*Local*/)
  531. {
  532. if (UnixIsAbsolutePath(Path))
  533. {
  534. return Path;
  535. }
  536. else
  537. {
  538. return ::AbsolutePath(FCurrentDirectory, Path);
  539. }
  540. }
  541. //---------------------------------------------------------------------------
  542. bool __fastcall TS3FileSystem::IsCapable(int Capability) const
  543. {
  544. DebugAssert(FTerminal);
  545. switch (Capability)
  546. {
  547. // Only to make double-click on file edit/open the file,
  548. // instead of trying to open it as directory
  549. case fcResolveSymlink:
  550. case fcRemoteCopy:
  551. case fcRename:
  552. case fcRemoteMove:
  553. case fcMoveToQueue:
  554. case fsSkipTransfer:
  555. return true;
  556. case fcPreservingTimestampUpload:
  557. case fcCheckingSpaceAvailable:
  558. case fsParallelTransfers:
  559. case fcUserGroupListing:
  560. case fcModeChanging:
  561. case fcModeChangingUpload:
  562. case fcGroupChanging:
  563. case fcOwnerChanging:
  564. case fcAnyCommand:
  565. case fcShellAnyCommand:
  566. case fcHardLink:
  567. case fcSymbolicLink:
  568. case fcTextMode:
  569. case fcNativeTextMode:
  570. case fcNewerOnlyUpload:
  571. case fcTimestampChanging:
  572. case fcLoadingAdditionalProperties:
  573. case fcIgnorePermErrors:
  574. case fcCalculatingChecksum:
  575. case fcSecondaryShell:
  576. case fcGroupOwnerChangingByID:
  577. case fcRemoveCtrlZUpload:
  578. case fcRemoveBOMUpload:
  579. case fcPreservingTimestampDirs:
  580. case fcResumeSupport:
  581. case fcChangePassword:
  582. case fcLocking:
  583. return false;
  584. default:
  585. DebugFail();
  586. return false;
  587. }
  588. }
  589. //---------------------------------------------------------------------------
  590. UnicodeString __fastcall TS3FileSystem::GetCurrentDirectory()
  591. {
  592. return FCurrentDirectory;
  593. }
  594. //---------------------------------------------------------------------------
  595. void __fastcall TS3FileSystem::DoStartup()
  596. {
  597. FTerminal->SetExceptionOnFail(true);
  598. // retrieve initialize working directory to save it as home directory
  599. ReadCurrentDirectory();
  600. FTerminal->SetExceptionOnFail(false);
  601. }
  602. //---------------------------------------------------------------------------
  603. void __fastcall TS3FileSystem::LookupUsersGroups()
  604. {
  605. DebugFail();
  606. }
  607. //---------------------------------------------------------------------------
  608. void __fastcall TS3FileSystem::ReadCurrentDirectory()
  609. {
  610. if (FCachedDirectoryChange.IsEmpty())
  611. {
  612. FCurrentDirectory = FCurrentDirectory.IsEmpty() ? UnicodeString(L"/") : FCurrentDirectory;
  613. }
  614. else
  615. {
  616. FCurrentDirectory = FCachedDirectoryChange;
  617. FCachedDirectoryChange = L"";
  618. }
  619. }
  620. //---------------------------------------------------------------------------
  621. void __fastcall TS3FileSystem::HomeDirectory()
  622. {
  623. ChangeDirectory(L"/");
  624. }
  625. //---------------------------------------------------------------------------
  626. void __fastcall TS3FileSystem::AnnounceFileListOperation()
  627. {
  628. // noop
  629. }
  630. //---------------------------------------------------------------------------
  631. void TS3FileSystem::TryOpenDirectory(const UnicodeString & Directory)
  632. {
  633. FTerminal->LogEvent(FORMAT(L"Trying to open directory \"%s\".", (Directory)));
  634. std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
  635. ReadDirectoryInternal(Directory, FileList.get(), 1, UnicodeString());
  636. }
  637. //---------------------------------------------------------------------------
  638. void __fastcall TS3FileSystem::ChangeDirectory(const UnicodeString ADirectory)
  639. {
  640. UnicodeString Path = AbsolutePath(ADirectory, false);
  641. // to verify existence of directory try to open it
  642. TryOpenDirectory(Path);
  643. // if open dir did not fail, directory exists -> success.
  644. FCachedDirectoryChange = Path;
  645. }
  646. //---------------------------------------------------------------------------
  647. void __fastcall TS3FileSystem::CachedChangeDirectory(const UnicodeString Directory)
  648. {
  649. FCachedDirectoryChange = UnixExcludeTrailingBackslash(Directory);
  650. }
  651. //---------------------------------------------------------------------------
  652. TRemoteToken TS3FileSystem::MakeRemoteToken(const char * OwnerId, const char * OwnerDisplayName)
  653. {
  654. TRemoteToken Result;
  655. Result.Name = StrFromS3(OwnerDisplayName);
  656. if (Result.Name.IsEmpty())
  657. {
  658. Result.Name = StrFromS3(OwnerId);
  659. }
  660. return Result;
  661. }
  662. //---------------------------------------------------------------------------
  663. struct TLibS3ListServiceCallbackData : TLibS3CallbackData
  664. {
  665. TRemoteFileList * FileList;
  666. UnicodeString FileName; // filter for buckets
  667. };
  668. //---------------------------------------------------------------------------
  669. S3Status TS3FileSystem::LibS3ListServiceCallback(
  670. const char * OwnerId, const char * OwnerDisplayName, const char * BucketName,
  671. int64_t /*CreationDate*/, void * CallbackData)
  672. {
  673. TLibS3ListServiceCallbackData & Data = *static_cast<TLibS3ListServiceCallbackData *>(CallbackData);
  674. UnicodeString FileName = StrFromS3(BucketName);
  675. if (Data.FileName.IsEmpty() || (Data.FileName == FileName))
  676. {
  677. std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
  678. File->Terminal = Data.FileSystem->FTerminal;
  679. File->FileName = StrFromS3(BucketName);
  680. File->Type = FILETYPE_DIRECTORY;
  681. File->Owner = Data.FileSystem->MakeRemoteToken(OwnerId, OwnerDisplayName);
  682. File->ModificationFmt = mfNone;
  683. Data.FileList->AddFile(File.release());
  684. }
  685. return S3StatusOK;
  686. }
  687. //---------------------------------------------------------------------------
  688. S3Status TS3FileSystem::LibS3ListBucketCallback(
  689. int IsTruncated, const char * NextMarker, int ContentsCount, const S3ListBucketContent * Contents,
  690. int CommonPrefixesCount, const char ** CommonPrefixes, void * CallbackData)
  691. {
  692. TLibS3ListBucketCallbackData & Data = *static_cast<TLibS3ListBucketCallbackData *>(CallbackData);
  693. Data.IsTruncated = IsTruncated;
  694. // This is being called in chunks, not once for all data in a response.
  695. Data.KeyCount += ContentsCount;
  696. Data.NextMarker = StrFromS3(NextMarker);
  697. for (int Index = 0; Index < ContentsCount; Index++)
  698. {
  699. const S3ListBucketContent * Content = &Contents[Index];
  700. UnicodeString FileName = UnixExtractFileName(StrFromS3(Content->key));
  701. if (!FileName.IsEmpty())
  702. {
  703. std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
  704. File->Terminal = Data.FileSystem->FTerminal;
  705. File->FileName = FileName;
  706. File->Type = FILETYPE_DEFAULT;
  707. File->Modification = UnixToDateTime(Content->lastModified, dstmWin);
  708. File->Size = Content->size;
  709. File->Owner = Data.FileSystem->MakeRemoteToken(Content->ownerId, Content->ownerDisplayName);
  710. Data.FileList->AddFile(File.release());
  711. }
  712. else
  713. {
  714. // We needs this to distinguish empty and non-existing folders, see comments in ReadDirectoryInternal.
  715. Data.FileList->AddFile(new TRemoteParentDirectory(Data.FileSystem->FTerminal));
  716. }
  717. }
  718. for (int Index = 0; Index < CommonPrefixesCount; Index++)
  719. {
  720. std::unique_ptr<TRemoteFile> File(new TRemoteFile(NULL));
  721. File->Terminal = Data.FileSystem->FTerminal;
  722. File->FileName = UnixExtractFileName(UnixExcludeTrailingBackslash(StrFromS3(CommonPrefixes[Index])));
  723. File->Type = FILETYPE_DIRECTORY;
  724. File->ModificationFmt = mfNone;
  725. Data.FileList->AddFile(File.release());
  726. }
  727. return S3StatusOK;
  728. }
  729. //---------------------------------------------------------------------------
  730. void TS3FileSystem::DoListBucket(
  731. const UnicodeString & Prefix, TRemoteFileList * FileList, int MaxKeys, const TLibS3BucketContext & BucketContext,
  732. TLibS3ListBucketCallbackData & Data)
  733. {
  734. S3ListBucketHandler ListBucketHandler = { CreateResponseHandler(), &LibS3ListBucketCallback };
  735. RequestInit(Data);
  736. Data.KeyCount = 0;
  737. Data.FileList = FileList;
  738. Data.IsTruncated = false;
  739. S3_list_bucket(
  740. &BucketContext, StrToS3(Prefix), StrToS3(Data.NextMarker),
  741. LibS3Delimiter.c_str(), MaxKeys, FRequestContext, FTimeout, &ListBucketHandler, &Data);
  742. }
  743. //---------------------------------------------------------------------------
  744. void TS3FileSystem::ReadDirectoryInternal(
  745. const UnicodeString & APath, TRemoteFileList * FileList, int MaxKeys, const UnicodeString & FileName)
  746. {
  747. UnicodeString Path = AbsolutePath(APath, false);
  748. if (IsUnixRootPath(Path))
  749. {
  750. DebugAssert(FileList != NULL);
  751. S3ListServiceHandler ListServiceHandler = { CreateResponseHandler(), &LibS3ListServiceCallback };
  752. TLibS3ListServiceCallbackData Data;
  753. RequestInit(Data);
  754. Data.FileSystem = this;
  755. Data.FileList = FileList;
  756. Data.FileName = FileName;
  757. S3_list_service(
  758. FLibS3Protocol, FAccessKeyId.c_str(), FSecretAccessKey.c_str(), 0, FHostName.c_str(),
  759. NULL, MaxKeys, FRequestContext, FTimeout, &ListServiceHandler, &Data);
  760. CheckLibS3Error(Data);
  761. }
  762. else
  763. {
  764. UnicodeString BucketName, Prefix;
  765. ParsePath(Path, BucketName, Prefix);
  766. if (!Prefix.IsEmpty())
  767. {
  768. Prefix = GetFolderKey(Prefix);
  769. }
  770. Prefix += FileName;
  771. TLibS3BucketContext BucketContext = GetBucketContext(BucketName);
  772. TLibS3ListBucketCallbackData Data;
  773. bool Continue;
  774. do
  775. {
  776. DoListBucket(Prefix, FileList, MaxKeys, BucketContext, Data);
  777. CheckLibS3Error(Data);
  778. Continue = false;
  779. if (Data.IsTruncated && ((MaxKeys == 0) || (Data.KeyCount < MaxKeys)))
  780. {
  781. bool Cancel = false;
  782. FTerminal->DoReadDirectoryProgress(FileList->Count, false, Cancel);
  783. if (!Cancel)
  784. {
  785. Continue = true;
  786. }
  787. }
  788. } while (Continue);
  789. // Listing bucket root directory will report an error if the bucket does not exist.
  790. // But there won't be any prefix/ entry, so no ".." entry is created, so we have to add it explicitly
  791. if (Prefix.IsEmpty())
  792. {
  793. FileList->AddFile(new TRemoteParentDirectory(FTerminal));
  794. }
  795. else
  796. {
  797. // We do not get any error, when the "prefix" does not exist. But when prefix does exist, there's at least
  798. // prefix/ entry (translated to ..). If there's none, it means that the path does not exist.
  799. // When called from DoReadFile (FileName is set), leaving error handling to the caller.
  800. if ((FileList->Count == 0) && FileName.IsEmpty())
  801. {
  802. throw Exception(FMTLOAD(FILE_NOT_EXISTS, (APath)));
  803. }
  804. }
  805. }
  806. }
  807. //---------------------------------------------------------------------------
  808. void __fastcall TS3FileSystem::ReadDirectory(TRemoteFileList * FileList)
  809. {
  810. TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
  811. ReadDirectoryInternal(FileList->Directory, FileList, 0, UnicodeString());
  812. }
  813. //---------------------------------------------------------------------------
  814. void __fastcall TS3FileSystem::ReadSymlink(TRemoteFile * /*SymlinkFile*/,
  815. TRemoteFile *& /*File*/)
  816. {
  817. // we never set SymLink flag, so we should never get here
  818. DebugFail();
  819. }
  820. //---------------------------------------------------------------------------
  821. void TS3FileSystem::DoReadFile(const UnicodeString & FileName, TRemoteFile *& File)
  822. {
  823. UnicodeString FileNameOnly = UnixExtractFileName(FileName);
  824. std::unique_ptr<TRemoteFileList> FileList(new TRemoteFileList());
  825. ReadDirectoryInternal(UnixExtractFileDir(FileName), FileList.get(), 1, FileNameOnly);
  826. TRemoteFile * AFile = FileList->FindFile(FileNameOnly);
  827. if (AFile != NULL)
  828. {
  829. File = AFile->Duplicate();
  830. }
  831. else
  832. {
  833. File = NULL;
  834. }
  835. }
  836. //---------------------------------------------------------------------------
  837. void __fastcall TS3FileSystem::ReadFile(const UnicodeString FileName,
  838. TRemoteFile *& File)
  839. {
  840. TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
  841. DoReadFile(FileName, File);
  842. if (File == NULL)
  843. {
  844. throw Exception(FMTLOAD(FILE_NOT_EXISTS, (FileName)));
  845. }
  846. }
  847. //---------------------------------------------------------------------------
  848. void __fastcall TS3FileSystem::DeleteFile(const UnicodeString AFileName,
  849. const TRemoteFile * File, int Params, TRmSessionAction & Action)
  850. {
  851. UnicodeString FileName = AbsolutePath(AFileName, false);
  852. bool Dir = FTerminal->DeleteContentsIfDirectory(FileName, File, Params, Action);
  853. UnicodeString BucketName, Key;
  854. ParsePath(FileName, BucketName, Key);
  855. TLibS3BucketContext BucketContext = GetBucketContext(BucketName);
  856. S3ResponseHandler ResponseHandler = CreateResponseHandler();
  857. TLibS3CallbackData Data;
  858. RequestInit(Data);
  859. if (Key.IsEmpty())
  860. {
  861. S3_delete_bucket(
  862. BucketContext.protocol, BucketContext.uriStyle, BucketContext.accessKeyId, BucketContext.secretAccessKey,
  863. BucketContext.securityToken, BucketContext.hostName, BucketContext.bucketName, BucketContext.authRegion,
  864. FRequestContext, FTimeout, &ResponseHandler, &Data);
  865. }
  866. else
  867. {
  868. if (Dir)
  869. {
  870. Key = GetFolderKey(Key);
  871. }
  872. S3_delete_object(&BucketContext, StrToS3(Key), FRequestContext, FTimeout, &ResponseHandler, &Data);
  873. }
  874. CheckLibS3Error(Data);
  875. }
  876. //---------------------------------------------------------------------------
  877. void __fastcall TS3FileSystem::RenameFile(const UnicodeString FileName, const TRemoteFile * File,
  878. const UnicodeString NewName)
  879. {
  880. CopyFile(FileName, File, NewName);
  881. TRmSessionAction DummyAction(FTerminal->ActionLog, FileName);
  882. DeleteFile(FileName, File, dfForceDelete, DummyAction);
  883. DummyAction.Cancel();
  884. }
  885. //---------------------------------------------------------------------------
  886. void __fastcall TS3FileSystem::CopyFile(const UnicodeString AFileName, const TRemoteFile * File,
  887. const UnicodeString ANewName)
  888. {
  889. if (DebugAlwaysTrue(File != NULL) && File->IsDirectory)
  890. {
  891. throw Exception(LoadStr(DUPLICATE_FOLDER_NOT_SUPPORTED));
  892. }
  893. UnicodeString FileName = AbsolutePath(AFileName, false);
  894. UnicodeString NewName = AbsolutePath(ANewName, false);
  895. UnicodeString SourceBucketName, SourceKey;
  896. ParsePath(FileName, SourceBucketName, SourceKey);
  897. DebugAssert(!SourceKey.IsEmpty()); // it's not a folder, so it cannot be a bucket or root
  898. UnicodeString DestBucketName, DestKey;
  899. ParsePath(NewName, DestBucketName, DestKey);
  900. if (DestKey.IsEmpty())
  901. {
  902. throw Exception(LoadStr(MISSING_TARGET_BUCKET));
  903. }
  904. TLibS3BucketContext BucketContext = GetBucketContext(DestBucketName);
  905. BucketContext.BucketNameBuf = SourceBucketName;
  906. BucketContext.bucketName = BucketContext.BucketNameBuf.c_str();
  907. S3ResponseHandler ResponseHandler = CreateResponseHandler();
  908. TLibS3CallbackData Data;
  909. RequestInit(Data);
  910. S3_copy_object(
  911. &BucketContext, StrToS3(SourceKey), StrToS3(DestBucketName), StrToS3(DestKey),
  912. NULL, NULL, 0, NULL, FRequestContext, FTimeout, &ResponseHandler, &Data);
  913. CheckLibS3Error(Data);
  914. }
  915. //---------------------------------------------------------------------------
  916. void __fastcall TS3FileSystem::CreateDirectory(const UnicodeString ADirName)
  917. {
  918. TOperationVisualizer Visualizer(FTerminal->UseBusyCursor);
  919. UnicodeString DirName = UnixExcludeTrailingBackslash(AbsolutePath(ADirName, false));
  920. UnicodeString BucketName, Key;
  921. ParsePath(DirName, BucketName, Key);
  922. TLibS3CallbackData Data;
  923. RequestInit(Data);
  924. if (Key.IsEmpty())
  925. {
  926. S3ResponseHandler ResponseHandler = CreateResponseHandler();
  927. // Not using GetBucketContext here, as the bucket does not exist, so we have to explicitly use S3DefaultRegion
  928. S3_create_bucket(
  929. FLibS3Protocol, FAccessKeyId.c_str(), FSecretAccessKey.c_str(), NULL, FHostName.c_str(), StrToS3(BucketName),
  930. StrToS3(FTerminal->SessionData->S3DefaultRegion), S3CannedAclPrivate, NULL, FRequestContext, FTimeout,
  931. &ResponseHandler, &Data);
  932. }
  933. else
  934. {
  935. Key = GetFolderKey(Key);
  936. TLibS3BucketContext BucketContext = GetBucketContext(BucketName);
  937. S3PutObjectHandler PutObjectHandler = { CreateResponseHandler(), NULL };
  938. S3_put_object(&BucketContext, StrToS3(Key), 0, NULL, FRequestContext, FTimeout, &PutObjectHandler, &Data);
  939. }
  940. CheckLibS3Error(Data);
  941. }
  942. //---------------------------------------------------------------------------
  943. void __fastcall TS3FileSystem::CreateLink(const UnicodeString FileName,
  944. const UnicodeString PointTo, bool /*Symbolic*/)
  945. {
  946. DebugFail();
  947. }
  948. //---------------------------------------------------------------------------
  949. void __fastcall TS3FileSystem::ChangeFileProperties(const UnicodeString FileName,
  950. const TRemoteFile * /*File*/, const TRemoteProperties * /*Properties*/,
  951. TChmodSessionAction & /*Action*/)
  952. {
  953. DebugFail();
  954. }
  955. //---------------------------------------------------------------------------
  956. bool __fastcall TS3FileSystem::LoadFilesProperties(TStrings * /*FileList*/)
  957. {
  958. DebugFail();
  959. return false;
  960. }
  961. //---------------------------------------------------------------------------
  962. void __fastcall TS3FileSystem::CalculateFilesChecksum(const UnicodeString & /*Alg*/,
  963. TStrings * /*FileList*/, TStrings * /*Checksums*/,
  964. TCalculatedChecksumEvent /*OnCalculatedChecksum*/)
  965. {
  966. DebugFail();
  967. }
  968. //---------------------------------------------------------------------------
  969. void __fastcall TS3FileSystem::CustomCommandOnFile(const UnicodeString FileName,
  970. const TRemoteFile * /*File*/, UnicodeString Command, int /*Params*/, TCaptureOutputEvent /*OutputEvent*/)
  971. {
  972. DebugFail();
  973. }
  974. //---------------------------------------------------------------------------
  975. void __fastcall TS3FileSystem::AnyCommand(const UnicodeString Command,
  976. TCaptureOutputEvent /*OutputEvent*/)
  977. {
  978. DebugFail();
  979. }
  980. //---------------------------------------------------------------------------
  981. TStrings * __fastcall TS3FileSystem::GetFixedPaths()
  982. {
  983. return NULL;
  984. }
  985. //---------------------------------------------------------------------------
  986. void __fastcall TS3FileSystem::SpaceAvailable(const UnicodeString Path,
  987. TSpaceAvailable & /*ASpaceAvailable*/)
  988. {
  989. DebugFail();
  990. }
  991. //---------------------------------------------------------------------------
  992. void __fastcall TS3FileSystem::CopyToRemote(
  993. TStrings * FilesToCopy, const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  994. int Params, TFileOperationProgressType * OperationProgress, TOnceDoneOperation & OnceDoneOperation)
  995. {
  996. Params &= ~cpAppend;
  997. FTerminal->DoCopyToRemote(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfPreCreateDir, OnceDoneOperation);
  998. }
  999. //---------------------------------------------------------------------------
  1000. void TS3FileSystem::ConfirmOverwrite(
  1001. const UnicodeString & SourceFullFileName, UnicodeString & TargetFileName,
  1002. TFileOperationProgressType * OperationProgress, const TOverwriteFileParams * FileParams,
  1003. const TCopyParamType * CopyParam, int Params)
  1004. {
  1005. int Answers = qaYes | qaNo | qaCancel | qaYesToAll | qaNoToAll;
  1006. std::vector<TQueryButtonAlias> Aliases;
  1007. Aliases.push_back(TQueryButtonAlias::CreateYesToAllGrouppedWithYes());
  1008. Aliases.push_back(TQueryButtonAlias::CreateNoToAllGrouppedWithNo());
  1009. TQueryParams QueryParams(qpNeverAskAgainCheck);
  1010. QueryParams.Aliases = &Aliases[0];
  1011. QueryParams.AliasesCount = Aliases.size();
  1012. unsigned int Answer;
  1013. {
  1014. TSuspendFileOperationProgress Suspend(OperationProgress);
  1015. Answer =
  1016. FTerminal->ConfirmFileOverwrite(
  1017. SourceFullFileName, TargetFileName, FileParams, Answers, &QueryParams,
  1018. ReverseOperationSide(OperationProgress->Side),
  1019. CopyParam, Params, OperationProgress);
  1020. }
  1021. switch (Answer)
  1022. {
  1023. case qaYes:
  1024. // noop
  1025. break;
  1026. case qaNo:
  1027. throw ESkipFile();
  1028. default:
  1029. DebugFail();
  1030. case qaCancel:
  1031. OperationProgress->SetCancelAtLeast(csCancel);
  1032. Abort();
  1033. break;
  1034. }
  1035. }
  1036. //---------------------------------------------------------------------------
  1037. struct TLibS3TransferObjectDataCallbackData : TLibS3CallbackData
  1038. {
  1039. UnicodeString FileName;
  1040. TStream * Stream;
  1041. TFileOperationProgressType * OperationProgress;
  1042. std::auto_ptr<Exception> Exception;
  1043. };
  1044. //---------------------------------------------------------------------------
  1045. struct TLibS3PutObjectDataCallbackData : TLibS3TransferObjectDataCallbackData
  1046. {
  1047. RawByteString ETag;
  1048. };
  1049. //---------------------------------------------------------------------------
  1050. int TS3FileSystem::LibS3PutObjectDataCallback(int BufferSize, char * Buffer, void * CallbackData)
  1051. {
  1052. TLibS3PutObjectDataCallbackData & Data = *static_cast<TLibS3PutObjectDataCallbackData *>(CallbackData);
  1053. return Data.FileSystem->PutObjectData(BufferSize, Buffer, Data);
  1054. }
  1055. //---------------------------------------------------------------------------
  1056. bool TS3FileSystem::ShouldCancelTransfer(TLibS3TransferObjectDataCallbackData & Data)
  1057. {
  1058. bool Result = (Data.OperationProgress->Cancel != csContinue);
  1059. if (Result)
  1060. {
  1061. if (Data.OperationProgress->ClearCancelFile())
  1062. {
  1063. Data.Exception.reset(new ESkipFile());
  1064. }
  1065. else
  1066. {
  1067. Data.Exception.reset(new EAbort(L""));
  1068. }
  1069. }
  1070. return Result;
  1071. }
  1072. //---------------------------------------------------------------------------
  1073. int TS3FileSystem::PutObjectData(int BufferSize, char * Buffer, TLibS3PutObjectDataCallbackData & Data)
  1074. {
  1075. int Result;
  1076. if (ShouldCancelTransfer(Data))
  1077. {
  1078. Result = -1;
  1079. }
  1080. else
  1081. {
  1082. TFileOperationProgressType * OperationProgress = Data.OperationProgress;
  1083. try
  1084. {
  1085. FILE_OPERATION_LOOP_BEGIN
  1086. {
  1087. Result = Data.Stream->Read(Buffer, BufferSize);
  1088. }
  1089. FILE_OPERATION_LOOP_END(FMTLOAD(READ_ERROR, (Data.FileName)));
  1090. OperationProgress->AddTransferred(Result);
  1091. }
  1092. catch (Exception & E)
  1093. {
  1094. Data.Exception.reset(CloneException(&E));
  1095. Result = -1;
  1096. }
  1097. }
  1098. return Result;
  1099. }
  1100. //---------------------------------------------------------------------------
  1101. struct TLibS3MultipartInitialCallbackData : TLibS3CallbackData
  1102. {
  1103. RawByteString UploadId;
  1104. };
  1105. //---------------------------------------------------------------------------
  1106. S3Status TS3FileSystem::LibS3MultipartInitialCallback(const char * UploadId, void * CallbackData)
  1107. {
  1108. TLibS3MultipartInitialCallbackData & Data = *static_cast<TLibS3MultipartInitialCallbackData *>(CallbackData);
  1109. Data.UploadId = UploadId;
  1110. return S3StatusOK;
  1111. }
  1112. //---------------------------------------------------------------------------
  1113. struct TLibS3MultipartCommitPutObjectDataCallbackData : TLibS3CallbackData
  1114. {
  1115. RawByteString Message;
  1116. int Remaining;
  1117. };
  1118. //---------------------------------------------------------------------------
  1119. S3Status TS3FileSystem::LibS3MultipartResponsePropertiesCallback(
  1120. const S3ResponseProperties * Properties, void * CallbackData)
  1121. {
  1122. S3Status Result = LibS3ResponsePropertiesCallback(Properties, CallbackData);
  1123. TLibS3PutObjectDataCallbackData & Data = *static_cast<TLibS3PutObjectDataCallbackData *>(CallbackData);
  1124. Data.ETag = Properties->eTag;
  1125. return Result;
  1126. }
  1127. //---------------------------------------------------------------------------
  1128. int TS3FileSystem::LibS3MultipartCommitPutObjectDataCallback(int BufferSize, char * Buffer, void * CallbackData)
  1129. {
  1130. TLibS3MultipartCommitPutObjectDataCallbackData & Data =
  1131. *static_cast<TLibS3MultipartCommitPutObjectDataCallbackData *>(CallbackData);
  1132. int Result = 0;
  1133. if (Data.Remaining > 0)
  1134. {
  1135. Result = std::min(BufferSize, Data.Remaining);
  1136. memcpy(Buffer, Data.Message.c_str() + Data.Message.Length() - Data.Remaining, Result);
  1137. Data.Remaining -= Result;
  1138. }
  1139. return Result;
  1140. }
  1141. //---------------------------------------------------------------------------
  1142. void __fastcall TS3FileSystem::Source(
  1143. TLocalFileHandle & Handle, const UnicodeString & TargetDir, UnicodeString & DestFileName,
  1144. const TCopyParamType * CopyParam, int Params,
  1145. TFileOperationProgressType * OperationProgress, unsigned int /*Flags*/,
  1146. TUploadSessionAction & Action, bool & /*ChildError*/)
  1147. {
  1148. UnicodeString DestFullName = TargetDir + DestFileName;
  1149. TRemoteFile * RemoteFile = NULL;
  1150. try
  1151. {
  1152. // Should not throw on non-existing file by purpose (mainly not to get an exception while debugging)
  1153. DoReadFile(DestFullName, RemoteFile);
  1154. }
  1155. catch (...)
  1156. {
  1157. // Pointless, as there's no persistent connection.
  1158. if (!FTerminal->Active)
  1159. {
  1160. throw;
  1161. }
  1162. }
  1163. if (RemoteFile != NULL)
  1164. {
  1165. TOverwriteFileParams FileParams;
  1166. FileParams.SourceSize = Handle.Size;
  1167. FileParams.SourceTimestamp = Handle.Modification;
  1168. FileParams.DestSize = RemoteFile->Size;
  1169. FileParams.DestTimestamp = TDateTime();
  1170. FileParams.DestPrecision = mfNone;
  1171. delete RemoteFile;
  1172. ConfirmOverwrite(Handle.FileName, DestFileName, OperationProgress, &FileParams, CopyParam, Params);
  1173. }
  1174. DestFullName = TargetDir + DestFileName;
  1175. // only now, we know the final destination
  1176. // (not really true as we do not support changing file name on overwrite dialog)
  1177. Action.Destination(DestFullName);
  1178. UnicodeString BucketName, Key;
  1179. ParsePath(DestFullName, BucketName, Key);
  1180. TLibS3BucketContext BucketContext = GetBucketContext(BucketName);
  1181. int Parts = std::max(1, static_cast<int>((Handle.Size + S3MultiPartChunkSize - 1) / S3MultiPartChunkSize));
  1182. bool Multipart = (Parts > 1);
  1183. RawByteString MultipartUploadId;
  1184. TLibS3MultipartCommitPutObjectDataCallbackData MultipartCommitPutObjectDataCallbackData;
  1185. if (Multipart)
  1186. {
  1187. FTerminal->LogEvent(FORMAT(L"Initiating multipart upload (%d parts)", (Parts)));
  1188. FILE_OPERATION_LOOP_BEGIN
  1189. {
  1190. TLibS3MultipartInitialCallbackData Data;
  1191. RequestInit(Data);
  1192. S3MultipartInitialHandler Handler = { CreateResponseHandler(), &LibS3MultipartInitialCallback };
  1193. S3_initiate_multipart(&BucketContext, StrToS3(Key), 0, &Handler, FRequestContext, FTimeout, &Data);
  1194. CheckLibS3Error(Data, true);
  1195. MultipartUploadId = Data.UploadId;
  1196. }
  1197. FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
  1198. FTerminal->LogEvent(FORMAT(L"Initiated multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
  1199. MultipartCommitPutObjectDataCallbackData.Message += "<CompleteMultipartUpload>\n";
  1200. }
  1201. try
  1202. {
  1203. TLibS3PutObjectDataCallbackData Data;
  1204. __int64 Position = 0;
  1205. std::unique_ptr<TStream> Stream(new TSafeHandleStream(reinterpret_cast<THandle>(Handle.Handle)));
  1206. for (int Part = 1; Part <= Parts; Part++)
  1207. {
  1208. FILE_OPERATION_LOOP_BEGIN
  1209. {
  1210. DebugAssert(Stream->Position == OperationProgress->TransferredSize);
  1211. // If not, it's chunk retry and we have to undo the unsuccessful chunk upload
  1212. if (Position < Stream->Position)
  1213. {
  1214. Stream->Position = Position;
  1215. OperationProgress->AddTransferred(Position - OperationProgress->TransferredSize);
  1216. }
  1217. RequestInit(Data);
  1218. Data.FileName = Handle.FileName;
  1219. Data.Stream = Stream.get();
  1220. Data.OperationProgress = OperationProgress;
  1221. Data.Exception.reset(NULL);
  1222. if (Multipart)
  1223. {
  1224. S3PutObjectHandler UploadPartHandler =
  1225. { CreateResponseHandlerCustom(LibS3MultipartResponsePropertiesCallback), LibS3PutObjectDataCallback };
  1226. int PartLength = std::min(S3MultiPartChunkSize, static_cast<int>(Stream->Size - Stream->Position));
  1227. FTerminal->LogEvent(FORMAT(L"Uploading part %d [%s]", (Part, IntToStr(PartLength))));
  1228. S3_upload_part(
  1229. &BucketContext, StrToS3(Key), NULL, &UploadPartHandler, Part, MultipartUploadId.c_str(),
  1230. PartLength, FRequestContext, FTimeout, &Data);
  1231. }
  1232. else
  1233. {
  1234. S3PutObjectHandler PutObjectHandler = { CreateResponseHandler(), LibS3PutObjectDataCallback };
  1235. S3_put_object(&BucketContext, StrToS3(Key), Handle.Size, NULL, FRequestContext, FTimeout, &PutObjectHandler, &Data);
  1236. }
  1237. // The "exception" was already seen by the user, its presence mean an accepted abort of the operation.
  1238. if (Data.Exception.get() == NULL)
  1239. {
  1240. CheckLibS3Error(Data, true);
  1241. }
  1242. Position = Stream->Position;
  1243. if (Multipart)
  1244. {
  1245. RawByteString PartCommitTag =
  1246. RawByteString::Format(" <Part><PartNumber>%d</PartNumber><ETag>%s</ETag></Part>\n", ARRAYOFCONST((Part, Data.ETag)));
  1247. MultipartCommitPutObjectDataCallbackData.Message += PartCommitTag;
  1248. }
  1249. }
  1250. FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
  1251. if (Data.Exception.get() != NULL)
  1252. {
  1253. RethrowException(Data.Exception.get());
  1254. }
  1255. }
  1256. Stream.reset(NULL);
  1257. if (Multipart)
  1258. {
  1259. MultipartCommitPutObjectDataCallbackData.Message += "</CompleteMultipartUpload>\n";
  1260. FTerminal->LogEvent(FORMAT(L"Committing multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
  1261. FTerminal->LogEvent(UnicodeString(MultipartCommitPutObjectDataCallbackData.Message));
  1262. FILE_OPERATION_LOOP_BEGIN
  1263. {
  1264. RequestInit(MultipartCommitPutObjectDataCallbackData);
  1265. MultipartCommitPutObjectDataCallbackData.Remaining = MultipartCommitPutObjectDataCallbackData.Message.Length();
  1266. S3MultipartCommitHandler MultipartCommitHandler =
  1267. { CreateResponseHandler(), &LibS3MultipartCommitPutObjectDataCallback, NULL };
  1268. S3_complete_multipart_upload(
  1269. &BucketContext, StrToS3(Key), &MultipartCommitHandler, MultipartUploadId.c_str(),
  1270. MultipartCommitPutObjectDataCallbackData.Remaining,
  1271. FRequestContext, FTimeout, &MultipartCommitPutObjectDataCallbackData);
  1272. CheckLibS3Error(MultipartCommitPutObjectDataCallbackData, true);
  1273. }
  1274. FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (Handle.FileName)), (folAllowSkip | folRetryOnFatal));
  1275. // to skip abort, in case we ever add any code before the catch, that can throw
  1276. MultipartUploadId = RawByteString();
  1277. }
  1278. }
  1279. catch (Exception & E)
  1280. {
  1281. if (!MultipartUploadId.IsEmpty())
  1282. {
  1283. FTerminal->LogEvent(FORMAT(L"Aborting multipart upload (%s - %d parts)", (UnicodeString(MultipartUploadId), Parts)));
  1284. try
  1285. {
  1286. TLibS3CallbackData Data;
  1287. RequestInit(Data);
  1288. S3AbortMultipartUploadHandler AbortMultipartUploadHandler = { CreateResponseHandler() };
  1289. S3_abort_multipart_upload(
  1290. &BucketContext, StrToS3(Key), MultipartUploadId.c_str(),
  1291. FTimeout, &AbortMultipartUploadHandler, FRequestContext, &Data);
  1292. }
  1293. catch (...)
  1294. {
  1295. // swallow
  1296. }
  1297. }
  1298. throw;
  1299. }
  1300. }
  1301. //---------------------------------------------------------------------------
  1302. void __fastcall TS3FileSystem::CopyToLocal(
  1303. TStrings * FilesToCopy, const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  1304. int Params, TFileOperationProgressType * OperationProgress, TOnceDoneOperation & OnceDoneOperation)
  1305. {
  1306. Params &= ~cpAppend;
  1307. FTerminal->DoCopyToLocal(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfNone, OnceDoneOperation);
  1308. }
  1309. //---------------------------------------------------------------------------
  1310. struct TLibS3GetObjectDataCallbackData : TLibS3TransferObjectDataCallbackData
  1311. {
  1312. };
  1313. //---------------------------------------------------------------------------
  1314. S3Status TS3FileSystem::LibS3GetObjectDataCallback(int BufferSize, const char * Buffer, void * CallbackData)
  1315. {
  1316. TLibS3GetObjectDataCallbackData & Data = *static_cast<TLibS3GetObjectDataCallbackData *>(CallbackData);
  1317. return Data.FileSystem->GetObjectData(BufferSize, Buffer, Data);
  1318. }
  1319. //---------------------------------------------------------------------------
  1320. S3Status TS3FileSystem::GetObjectData(int BufferSize, const char * Buffer, TLibS3GetObjectDataCallbackData & Data)
  1321. {
  1322. S3Status Result = S3StatusOK;
  1323. if (ShouldCancelTransfer(Data))
  1324. {
  1325. Result = S3StatusAbortedByCallback;
  1326. }
  1327. else
  1328. {
  1329. TFileOperationProgressType * OperationProgress = Data.OperationProgress;
  1330. try
  1331. {
  1332. FILE_OPERATION_LOOP_BEGIN
  1333. {
  1334. Data.Stream->Write(Buffer, BufferSize);
  1335. }
  1336. FILE_OPERATION_LOOP_END(FMTLOAD(WRITE_ERROR, (Data.FileName)));
  1337. OperationProgress->AddTransferred(BufferSize);
  1338. }
  1339. catch (Exception & E)
  1340. {
  1341. Data.Exception.reset(CloneException(&E));
  1342. Result = S3StatusAbortedByCallback;
  1343. }
  1344. }
  1345. return Result;
  1346. }
  1347. //---------------------------------------------------------------------------
  1348. void __fastcall TS3FileSystem::Sink(
  1349. const UnicodeString & FileName, const TRemoteFile * File,
  1350. const UnicodeString & TargetDir, UnicodeString & DestFileName, int Attrs,
  1351. const TCopyParamType * CopyParam, int Params, TFileOperationProgressType * OperationProgress,
  1352. unsigned int /*Flags*/, TDownloadSessionAction & Action)
  1353. {
  1354. UnicodeString DestFullName = TargetDir + DestFileName;
  1355. if (FileExists(ApiPath(DestFullName)))
  1356. {
  1357. __int64 Size;
  1358. __int64 MTime;
  1359. FTerminal->OpenLocalFile(DestFullName, GENERIC_READ, NULL, NULL, NULL, &MTime, NULL, &Size);
  1360. TOverwriteFileParams FileParams;
  1361. FileParams.SourceSize = File->Size;
  1362. FileParams.SourceTimestamp = File->Modification; // noop
  1363. FileParams.DestSize = Size;
  1364. FileParams.DestTimestamp = UnixToDateTime(MTime, FTerminal->SessionData->DSTMode);
  1365. ConfirmOverwrite(FileName, DestFileName, OperationProgress, &FileParams, CopyParam, Params);
  1366. }
  1367. UnicodeString BucketName, Key;
  1368. ParsePath(FileName, BucketName, Key);
  1369. TLibS3BucketContext BucketContext = GetBucketContext(BucketName);
  1370. UnicodeString ExpandedDestFullName = ExpandUNCFileName(DestFullName);
  1371. Action.Destination(ExpandedDestFullName);
  1372. FILE_OPERATION_LOOP_BEGIN
  1373. {
  1374. HANDLE LocalHandle;
  1375. if (!FTerminal->CreateLocalFile(DestFullName, OperationProgress, &LocalHandle, FLAGSET(Params, cpNoConfirmation)))
  1376. {
  1377. throw ESkipFile();
  1378. }
  1379. std::unique_ptr<TStream> Stream(new TSafeHandleStream(reinterpret_cast<THandle>(LocalHandle)));
  1380. bool DeleteLocalFile = true;
  1381. try
  1382. {
  1383. TLibS3GetObjectDataCallbackData Data;
  1384. FILE_OPERATION_LOOP_BEGIN
  1385. {
  1386. RequestInit(Data);
  1387. Data.FileName = FileName;
  1388. Data.Stream = Stream.get();
  1389. Data.OperationProgress = OperationProgress;
  1390. Data.Exception.reset(NULL);
  1391. TAutoFlag ResponseIgnoreSwitch(FResponseIgnore);
  1392. S3GetObjectHandler GetObjectHandler = { CreateResponseHandler(), LibS3GetObjectDataCallback };
  1393. S3_get_object(
  1394. &BucketContext, StrToS3(Key), NULL, Stream->Position, 0, FRequestContext, FTimeout, &GetObjectHandler, &Data);
  1395. // The "exception" was already seen by the user, its presence mean an accepted abort of the operation.
  1396. if (Data.Exception.get() == NULL)
  1397. {
  1398. CheckLibS3Error(Data, true);
  1399. }
  1400. }
  1401. FILE_OPERATION_LOOP_END_EX(FMTLOAD(TRANSFER_ERROR, (FileName)), (folAllowSkip | folRetryOnFatal));
  1402. if (Data.Exception.get() != NULL)
  1403. {
  1404. RethrowException(Data.Exception.get());
  1405. }
  1406. DeleteLocalFile = false;
  1407. if (CopyParam->PreserveTime)
  1408. {
  1409. FTerminal->UpdateTargetTime(LocalHandle, File->Modification, FTerminal->SessionData->DSTMode);
  1410. }
  1411. }
  1412. __finally
  1413. {
  1414. CloseHandle(LocalHandle);
  1415. if (DeleteLocalFile)
  1416. {
  1417. FILE_OPERATION_LOOP_BEGIN
  1418. {
  1419. THROWOSIFFALSE(Sysutils::DeleteFile(ApiPath(DestFullName)));
  1420. }
  1421. FILE_OPERATION_LOOP_END(FMTLOAD(DELETE_LOCAL_FILE_ERROR, (DestFullName)));
  1422. }
  1423. }
  1424. }
  1425. FILE_OPERATION_LOOP_END(FMTLOAD(TRANSFER_ERROR, (FileName)));
  1426. FTerminal->UpdateTargetAttrs(DestFullName, File, CopyParam, Attrs);
  1427. }
  1428. //---------------------------------------------------------------------------
  1429. void __fastcall TS3FileSystem::GetSupportedChecksumAlgs(TStrings * /*Algs*/)
  1430. {
  1431. // NOOP
  1432. }
  1433. //---------------------------------------------------------------------------
  1434. void __fastcall TS3FileSystem::LockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  1435. {
  1436. DebugFail();
  1437. }
  1438. //---------------------------------------------------------------------------
  1439. void __fastcall TS3FileSystem::UnlockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  1440. {
  1441. DebugFail();
  1442. }
  1443. //---------------------------------------------------------------------------
  1444. void __fastcall TS3FileSystem::UpdateFromMain(TCustomFileSystem * /*AMainFileSystem*/)
  1445. {
  1446. // noop
  1447. }
  1448. //------------------------------------------------------------------------------
  1449. void __fastcall TS3FileSystem::ClearCaches()
  1450. {
  1451. FRegions.clear();
  1452. FHostNames.clear();
  1453. }
  1454. //------------------------------------------------------------------------------