S3FileSystem.cpp 56 KB

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