SftpFileSystem.cpp 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include "SftpFileSystem.h"
  5. #include <sftp.h>
  6. #include "PuttyIntf.h"
  7. #include "Common.h"
  8. #include "Interface.h"
  9. #include "Terminal.h"
  10. #include "TextsCore.h"
  11. #include <memory>
  12. //---------------------------------------------------------------------------
  13. #pragma package(smart_init)
  14. //---------------------------------------------------------------------------
  15. // additional constants for SFTP protocol not defined in Putty's sftp.h
  16. #define SSH_FXP_READLINK 19
  17. #define SSH_FXP_SYMLINK 20
  18. #define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
  19. #define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
  20. #define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
  21. #define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
  22. #define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
  23. #define SSH_FILEXFER_TYPE_REGULAR 1
  24. #define SSH_FILEXFER_TYPE_DIRECTORY 2
  25. #define SSH_FILEXFER_TYPE_SYMLINK 3
  26. #define SSH_FILEXFER_TYPE_SPECIAL 4
  27. #define SSH_FILEXFER_TYPE_UNKNOWN 5
  28. #define SSH_FXF_TEXT 0x00000040
  29. //---------------------------------------------------------------------------
  30. const int SFTPMinVersion = 2;
  31. const int SFTPMaxVersion = 4;
  32. const int SFTPNoMessageNumber = -1;
  33. const int asOK = 1 << SSH_FX_OK;
  34. const int asEOF = 1 << SSH_FX_EOF;
  35. const int asOpUnsupported = 1 << SSH_FX_OP_UNSUPPORTED;
  36. //---------------------------------------------------------------------------
  37. #define GET_32BIT(cp) \
  38. (((unsigned long)(unsigned char)(cp)[0] << 24) | \
  39. ((unsigned long)(unsigned char)(cp)[1] << 16) | \
  40. ((unsigned long)(unsigned char)(cp)[2] << 8) | \
  41. ((unsigned long)(unsigned char)(cp)[3]))
  42. #define PUT_32BIT(cp, value) { \
  43. (cp)[0] = (unsigned char)((value) >> 24); \
  44. (cp)[1] = (unsigned char)((value) >> 16); \
  45. (cp)[2] = (unsigned char)((value) >> 8); \
  46. (cp)[3] = (unsigned char)(value); }
  47. #define THROW_SKIP_FILE_NULL THROW_SKIP_FILE(NULL, "")
  48. //---------------------------------------------------------------------------
  49. #define SFTP_PACKET_ALLOC_DELTA 256
  50. //---------------------------------------------------------------------------
  51. class TSFTPPacket
  52. {
  53. public:
  54. TSFTPPacket()
  55. {
  56. Init();
  57. }
  58. TSFTPPacket(const TSFTPPacket & Source)
  59. {
  60. Init();
  61. *this = Source;
  62. }
  63. TSFTPPacket(unsigned char AType)
  64. {
  65. Init();
  66. ChangeType(AType);
  67. }
  68. ~TSFTPPacket()
  69. {
  70. delete FData;
  71. if (FReservedBy) FReservedBy->UnreserveResponse(this);
  72. }
  73. void ChangeType(unsigned char AType)
  74. {
  75. FPosition = 0;
  76. FLength = 0;
  77. Capacity = 0;
  78. FType = AType;
  79. AddByte(FType);
  80. if (FType != SSH_FXP_INIT)
  81. {
  82. FMessageNumber = (FMessageCounter << 8) + FType;
  83. FMessageCounter++;
  84. AddCardinal(FMessageNumber);
  85. }
  86. }
  87. void AddByte(unsigned char Value)
  88. {
  89. Add(&Value, sizeof(Value));
  90. }
  91. void AddCardinal(unsigned long Value)
  92. {
  93. unsigned char Buf[4];
  94. PUT_32BIT(Buf, Value);
  95. Add(&Buf, sizeof(Buf));
  96. }
  97. void AddInt64(__int64 Value)
  98. {
  99. AddCardinal((unsigned long)(Value >> 32));
  100. AddCardinal((unsigned long)(Value & 0xFFFFFFFF));
  101. }
  102. void AddData(const void * Data, int ALength)
  103. {
  104. AddCardinal(ALength);
  105. Add(Data, ALength);
  106. }
  107. void AddString(const AnsiString Value)
  108. {
  109. AddCardinal(Value.Length());
  110. Add(Value.c_str(), Value.Length());
  111. }
  112. void AddProperties(const TRemoteProperties * Properties,
  113. unsigned short BaseRights, bool IsDirectory, int Version)
  114. {
  115. int Flags = 0;
  116. if (Properties)
  117. {
  118. if (Properties->Valid.Contains(vpOwner) || Properties->Valid.Contains(vpGroup))
  119. {
  120. Flags |= SSH_FILEXFER_ATTR_OWNERGROUP;
  121. }
  122. if (Properties->Valid.Contains(vpRights))
  123. {
  124. Flags |= SSH_FILEXFER_ATTR_PERMISSIONS;
  125. }
  126. }
  127. AddCardinal(Flags);
  128. if (Version >= 4)
  129. {
  130. AddByte((unsigned char)(IsDirectory ? SSH_FILEXFER_TYPE_DIRECTORY : SSH_FILEXFER_TYPE_REGULAR));
  131. }
  132. if (Properties)
  133. {
  134. if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
  135. {
  136. assert(Version >= 4);
  137. AddString(Properties->Valid.Contains(vpOwner) ?
  138. Properties->Owner : AnsiString());
  139. AddString(Properties->Valid.Contains(vpGroup) ?
  140. Properties->Group : AnsiString());
  141. }
  142. if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
  143. {
  144. TRights Rights = BaseRights;
  145. Rights |= Properties->Rights.NumberSet;
  146. Rights &= (unsigned short)~Properties->Rights.NumberUnset;
  147. if (IsDirectory && Properties->AddXToDirectories)
  148. {
  149. Rights.AddExecute();
  150. }
  151. AddCardinal(Rights);
  152. }
  153. }
  154. }
  155. char GetByte()
  156. {
  157. assert(FPosition <= FLength - sizeof(char));
  158. char Result = FData[FPosition];
  159. FPosition++;
  160. return Result;
  161. }
  162. unsigned long GetCardinal()
  163. {
  164. unsigned long Result;
  165. assert(FPosition <= FLength - sizeof(Result));
  166. Result = GET_32BIT(FData + FPosition);
  167. FPosition += sizeof(Result);
  168. return Result;
  169. }
  170. __int64 GetInt64()
  171. {
  172. __int64 Hi = GetCardinal();
  173. __int64 Lo = GetCardinal();
  174. return (Hi << 32) + Lo;
  175. }
  176. AnsiString GetString()
  177. {
  178. AnsiString Result;
  179. unsigned long Len = GetCardinal();
  180. Result.SetLength(Len);
  181. assert(FLength >= Len && FPosition <= FLength - Len);
  182. memcpy(Result.c_str(), FData + FPosition, Len);
  183. FPosition += Len;
  184. return Result;
  185. }
  186. void GetFile(TRemoteFile * File, int Version)
  187. {
  188. assert(File);
  189. unsigned int Flags;
  190. AnsiString ListingStr;
  191. if (Type != SSH_FXP_ATTRS)
  192. {
  193. File->FileName = GetString();
  194. if (Version < 4)
  195. {
  196. ListingStr = GetString();
  197. }
  198. }
  199. Flags = GetCardinal();
  200. if (Version >= 4)
  201. {
  202. char FXType = GetByte();
  203. char Types[] = "-DLSU";
  204. if (FXType < 1 || FXType > (char)strlen(Types))
  205. {
  206. throw Exception(FMTLOAD(SFTP_UNKNOWN_FILE_TYPE, (int(FXType))));
  207. }
  208. File->Type = Types[FXType-1];
  209. }
  210. if (Flags & SSH_FILEXFER_ATTR_SIZE)
  211. {
  212. File->Size = GetInt64();
  213. }
  214. if (Flags & SSH_FILEXFER_ATTR_UIDGID)
  215. {
  216. assert(Version < 4);
  217. GetCardinal(); // skip UID
  218. GetCardinal(); // skip GUID
  219. }
  220. if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
  221. {
  222. assert(Version >= 4);
  223. File->Owner = GetString();
  224. File->Group = GetString();
  225. }
  226. if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
  227. {
  228. unsigned long Permissions = GetCardinal();
  229. if (Type == SSH_FXP_ATTRS || Version >= 4)
  230. {
  231. File->Rights->Number = (unsigned short)(Permissions & 0777);
  232. if (Version < 4)
  233. {
  234. File->Type = (Permissions & 0040000 ? FILETYPE_DIRECTORY : '-');
  235. }
  236. }
  237. }
  238. if (Version < 4)
  239. {
  240. if (Flags & SSH_FILEXFER_ATTR_ACMODTIME)
  241. {
  242. File->LastAccess = UnixToDateTime(GetCardinal());
  243. File->Modification = UnixToDateTime(GetCardinal());
  244. }
  245. }
  246. else
  247. {
  248. if (Flags & SSH_FILEXFER_ATTR_ACCESSTIME)
  249. {
  250. File->LastAccess = UnixToDateTime((unsigned long)GetInt64());
  251. }
  252. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  253. {
  254. GetCardinal(); // skip access time subseconds
  255. }
  256. if (Flags & SSH_FILEXFER_ATTR_CREATETIME)
  257. {
  258. GetInt64(); // skip create time
  259. }
  260. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  261. {
  262. GetCardinal(); // skip create time subseconds
  263. }
  264. if (Flags & SSH_FILEXFER_ATTR_MODIFYTIME)
  265. {
  266. File->Modification = UnixToDateTime((unsigned long)GetInt64());
  267. }
  268. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  269. {
  270. GetCardinal(); // skip modification time subseconds
  271. }
  272. }
  273. if ((Version < 4) && (Type != SSH_FXP_ATTRS))
  274. {
  275. // update permissions and user/group name
  276. // modification time and filename is ignored
  277. File->ListingStr = ListingStr;
  278. }
  279. // TODO: read extended attributes (Flags & SSH_FILEXFER_ATTR_EXTENDED)
  280. // Format: Count=Cardinal, Count*(Name=String, Value=String)
  281. }
  282. void DataUpdated(int ALength)
  283. {
  284. FPosition = 0;
  285. FLength = ALength;
  286. FType = GetByte();
  287. if (FType != SSH_FXP_VERSION)
  288. {
  289. FMessageNumber = GetCardinal();
  290. }
  291. else
  292. {
  293. FMessageNumber = SFTPNoMessageNumber;
  294. }
  295. }
  296. TSFTPPacket & operator = (const TSFTPPacket & Source)
  297. {
  298. Capacity = 0;
  299. Add(Source.Data, Source.Length);
  300. DataUpdated(Source.Length);
  301. FPosition = Source.FPosition;
  302. return *this;
  303. }
  304. __property unsigned int Length = { read = FLength };
  305. __property char * Data = { read = FData };
  306. __property char * NextData = { read = GetNextData };
  307. __property char * Content = { read = GetContent };
  308. __property unsigned int ContentLength = { read = GetContentLength };
  309. __property unsigned int Capacity = { read = FCapacity, write = SetCapacity };
  310. __property unsigned char Type = { read = FType };
  311. __property unsigned char RequestType = { read = GetRequestType };
  312. __property unsigned int MessageNumber = { read = FMessageNumber, write = FMessageNumber };
  313. __property TSFTPFileSystem * ReservedBy = { read = FReservedBy, write = FReservedBy };
  314. __property AnsiString TypeName = { read = GetTypeName };
  315. private:
  316. char * FData;
  317. unsigned int FLength;
  318. unsigned int FCapacity;
  319. unsigned int FPosition;
  320. unsigned char FType;
  321. unsigned int FMessageNumber;
  322. TSFTPFileSystem * FReservedBy;
  323. static int FMessageCounter;
  324. void Init()
  325. {
  326. FData = NULL;
  327. FCapacity = 0;
  328. FLength = 0;
  329. FPosition = 0;
  330. FMessageNumber = SFTPNoMessageNumber;
  331. FType = -1;
  332. FReservedBy = NULL;
  333. }
  334. unsigned char GetRequestType()
  335. {
  336. if (FMessageNumber != SFTPNoMessageNumber)
  337. {
  338. return (unsigned char)(FMessageNumber & 0xFF);
  339. }
  340. else
  341. {
  342. assert(Type == SSH_FXP_VERSION);
  343. return SSH_FXP_INIT;
  344. }
  345. }
  346. void Add(const void * AData, int ALength)
  347. {
  348. if (Length + ALength > Capacity)
  349. {
  350. Capacity = Length + ALength + SFTP_PACKET_ALLOC_DELTA;
  351. }
  352. memcpy(FData + Length, AData, ALength);
  353. FLength += ALength;
  354. }
  355. void SetCapacity(unsigned int ACapacity)
  356. {
  357. if (ACapacity != Capacity)
  358. {
  359. FCapacity = ACapacity;
  360. if (FCapacity > 0)
  361. {
  362. char * NData = new char[FCapacity];
  363. if (FData)
  364. {
  365. memcpy(NData, FData, (FLength < FCapacity ? FLength : FCapacity));
  366. delete FData;
  367. }
  368. FData = NData;
  369. }
  370. else
  371. {
  372. if (FData) delete FData;
  373. FData = NULL;
  374. }
  375. if (FLength > FCapacity) FLength = FCapacity;
  376. }
  377. }
  378. AnsiString GetTypeName() const
  379. {
  380. #define TYPE_CASE(TYPE) case TYPE: return #TYPE
  381. switch (Type) {
  382. TYPE_CASE(SSH_FXP_INIT);
  383. TYPE_CASE(SSH_FXP_VERSION);
  384. TYPE_CASE(SSH_FXP_OPEN);
  385. TYPE_CASE(SSH_FXP_CLOSE);
  386. TYPE_CASE(SSH_FXP_READ);
  387. TYPE_CASE(SSH_FXP_WRITE);
  388. TYPE_CASE(SSH_FXP_LSTAT);
  389. TYPE_CASE(SSH_FXP_FSTAT);
  390. TYPE_CASE(SSH_FXP_SETSTAT);
  391. TYPE_CASE(SSH_FXP_FSETSTAT);
  392. TYPE_CASE(SSH_FXP_OPENDIR);
  393. TYPE_CASE(SSH_FXP_READDIR);
  394. TYPE_CASE(SSH_FXP_REMOVE);
  395. TYPE_CASE(SSH_FXP_MKDIR);
  396. TYPE_CASE(SSH_FXP_RMDIR);
  397. TYPE_CASE(SSH_FXP_REALPATH);
  398. TYPE_CASE(SSH_FXP_STAT);
  399. TYPE_CASE(SSH_FXP_RENAME);
  400. TYPE_CASE(SSH_FXP_READLINK);
  401. TYPE_CASE(SSH_FXP_SYMLINK);
  402. TYPE_CASE(SSH_FXP_STATUS);
  403. TYPE_CASE(SSH_FXP_HANDLE);
  404. TYPE_CASE(SSH_FXP_DATA);
  405. TYPE_CASE(SSH_FXP_NAME);
  406. TYPE_CASE(SSH_FXP_ATTRS);
  407. TYPE_CASE(SSH_FXP_EXTENDED);
  408. TYPE_CASE(SSH_FXP_EXTENDED_REPLY);
  409. default:
  410. return FORMAT("Unknown message (%d)", (int(Type)));
  411. }
  412. }
  413. char * GetContent()
  414. {
  415. return Data + sizeof(Byte) + (FType != SSH_FXP_VERSION ? sizeof(Cardinal) : 0);
  416. }
  417. unsigned int GetContentLength()
  418. {
  419. return Length - sizeof(Byte) - (FType != SSH_FXP_VERSION ? sizeof(Cardinal) : 0);
  420. }
  421. char * GetNextData()
  422. {
  423. return FPosition < FLength ? FData + FPosition : NULL;
  424. }
  425. };
  426. //---------------------------------------------------------------------------
  427. int TSFTPPacket::FMessageCounter = 0;
  428. //===========================================================================
  429. struct TOpenRemoteFileParams
  430. {
  431. int LocalFileAttrs;
  432. AnsiString RemoteFileName;
  433. TFileOperationProgressType * OperationProgress;
  434. const TCopyParamType * CopyParam;
  435. int Params;
  436. bool Resume;
  437. AnsiString RemoteFileHandle; // output
  438. };
  439. struct TSinkFileParams
  440. {
  441. AnsiString TargetDir;
  442. const TCopyParamType * CopyParam;
  443. int Params;
  444. TFileOperationProgressType * OperationProgress;
  445. bool Skipped;
  446. };
  447. //===========================================================================
  448. __fastcall TSFTPFileSystem::TSFTPFileSystem(TTerminal * ATerminal):
  449. TCustomFileSystem(ATerminal)
  450. {
  451. FPacketReservations = new TList();
  452. FPacketNumbers = VarArrayCreate(OPENARRAY(int, (0, 1)), varInteger);
  453. FPreviousLoggedPacket = 0;
  454. FNotLoggedPackets = 0;
  455. FBusy = 0;
  456. FAvoidBusy = false;
  457. }
  458. //---------------------------------------------------------------------------
  459. __fastcall TSFTPFileSystem::~TSFTPFileSystem()
  460. {
  461. delete FPacketReservations;
  462. }
  463. //---------------------------------------------------------------------------
  464. AnsiString __fastcall TSFTPFileSystem::GetProtocolName() const
  465. {
  466. return FMTLOAD(SFTP_PROTOCOL_NAME, (FVersion));
  467. }
  468. //---------------------------------------------------------------------------
  469. bool __fastcall TSFTPFileSystem::IsCapable(int Capability) const
  470. {
  471. assert(FTerminal);
  472. switch (Capability) {
  473. case fcUserGroupListing:
  474. case fcAnyCommand:
  475. case fcHardLink:
  476. return false;
  477. case fcOwnerChanging:
  478. case fcGroupChanging:
  479. return (FVersion >= 4);
  480. case fcSymbolicLink:
  481. case fcResolveSymlink:
  482. return (FVersion >= 3);
  483. case fcModeChanging:
  484. return true;
  485. case fcTextMode:
  486. return (FVersion >= 4) ||
  487. strcmp(GetEOL(), EOLToStr(FTerminal->Configuration->LocalEOLType)) != 0;
  488. default:
  489. assert(false);
  490. return false;
  491. }
  492. }
  493. //---------------------------------------------------------------------------
  494. struct TUnicodeEmitParams
  495. {
  496. WideString Buffer;
  497. int Pos;
  498. int Len;
  499. };
  500. //---------------------------------------------------------------------------
  501. extern "C" void UnicodeEmit(void * AParams, long int Output)
  502. {
  503. if (Output == 0xFFFFL) // see Putty's charset\internal.h
  504. {
  505. throw Exception(LoadStr(DECODE_UTF_ERROR));
  506. }
  507. TUnicodeEmitParams * Params = (TUnicodeEmitParams *)AParams;
  508. if (Params->Pos >= Params->Len)
  509. {
  510. Params->Len += 50;
  511. Params->Buffer.SetLength(Params->Len);
  512. }
  513. Params->Buffer[Params->Pos + 1] = (wchar_t)Output;
  514. Params->Pos++;
  515. }
  516. //---------------------------------------------------------------------------
  517. AnsiString __fastcall TSFTPFileSystem::DecodeUTF(const AnsiString UTF)
  518. {
  519. charset_state State;
  520. char * Str;
  521. TUnicodeEmitParams Params;
  522. AnsiString Result;
  523. State.s0 = 0;
  524. Str = UTF.c_str();
  525. Params.Pos = 0;
  526. Params.Len = UTF.Length();
  527. Params.Buffer.SetLength(Params.Len);
  528. while (*Str)
  529. {
  530. read_utf8(NULL, (unsigned char)*Str, &State, UnicodeEmit, &Params);
  531. Str++;
  532. }
  533. Params.Buffer.SetLength(Params.Pos);
  534. return Params.Buffer;
  535. }
  536. //---------------------------------------------------------------------------
  537. inline void __fastcall TSFTPFileSystem::BusyStart()
  538. {
  539. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  540. {
  541. Busy(true);
  542. }
  543. FBusy++;
  544. assert(FBusy < 10);
  545. }
  546. //---------------------------------------------------------------------------
  547. inline void __fastcall TSFTPFileSystem::BusyEnd()
  548. {
  549. assert(FBusy > 0);
  550. FBusy--;
  551. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  552. {
  553. Busy(false);
  554. }
  555. }
  556. //---------------------------------------------------------------------------
  557. void __fastcall TSFTPFileSystem::SendPacket(const TSFTPPacket * Packet)
  558. {
  559. BusyStart();
  560. try
  561. {
  562. if (FTerminal->IsLogging())
  563. {
  564. if ((FPreviousLoggedPacket != SSH_FXP_READ &&
  565. FPreviousLoggedPacket != SSH_FXP_WRITE) ||
  566. (Packet->Type != FPreviousLoggedPacket))
  567. {
  568. if (FNotLoggedPackets)
  569. {
  570. FTerminal->LogEvent(FORMAT("%d skipped SSH_FXP_WRITE, SSH_FXP_READ and SSH_FXP_STATUS packets.",
  571. (FNotLoggedPackets)));
  572. FNotLoggedPackets = 0;
  573. }
  574. FTerminal->Log->Add(llInput, FORMAT("Type: %s, Size: %d, Number: %d",
  575. (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
  576. FPreviousLoggedPacket = Packet->Type;
  577. }
  578. else
  579. {
  580. FNotLoggedPackets++;
  581. }
  582. }
  583. char LenBuf[4];
  584. PUT_32BIT(LenBuf, Packet->Length);
  585. FTerminal->Send(LenBuf, sizeof(LenBuf));
  586. FTerminal->Send(Packet->Data, Packet->Length);
  587. }
  588. __finally
  589. {
  590. BusyEnd();
  591. }
  592. }
  593. //---------------------------------------------------------------------------
  594. unsigned long __fastcall TSFTPFileSystem::GotStatusPacket(TSFTPPacket * Packet,
  595. int AllowStatus)
  596. {
  597. unsigned long Code = Packet->GetCardinal();
  598. static int Messages[] = {
  599. SFTP_STATUS_OK,
  600. SFTP_STATUS_EOF,
  601. SFTP_STATUS_NO_SUCH_FILE,
  602. SFTP_STATUS_PERMISSION_DENIED,
  603. SFTP_STATUS_FAILURE,
  604. SFTP_STATUS_BAD_MESSAGE,
  605. SFTP_STATUS_NO_CONNECTION,
  606. SFTP_STATUS_CONNECTION_LOST,
  607. SFTP_STATUS_OP_UNSUPPORTED,
  608. SFTP_STATUS_INVALID_HANDLE,
  609. SFTP_STATUS_NO_SUCH_PATH,
  610. SFTP_STATUS_FILE_ALREADY_EXISTS,
  611. SFTP_STATUS_WRITE_PROTECT,
  612. SFTP_STATUS_NO_MEDIA,
  613. };
  614. int Message;
  615. FTerminal->Log->Add(llOutput, FORMAT("Status/error code: %d", ((int)Code)));
  616. if ((AllowStatus & (0x01 << Code)) == 0)
  617. {
  618. if (Code >= sizeof(Messages) / sizeof(*Messages))
  619. {
  620. Message = SFTP_STATUS_UNKNOWN;
  621. }
  622. else
  623. {
  624. Message = Messages[Code];
  625. }
  626. AnsiString ServerMessage;
  627. AnsiString LanguageTag;
  628. if (FVersion >= 3)
  629. {
  630. ServerMessage = DecodeUTF(Packet->GetString());
  631. LanguageTag = Packet->GetString();
  632. }
  633. else
  634. {
  635. ServerMessage = LoadStr(SFTP_SERVER_MESSAGE_UNSUPPORTED);
  636. }
  637. if (LanguageTag.IsEmpty())
  638. {
  639. LanguageTag = "?";
  640. }
  641. if (FTerminal->IsLogging())
  642. {
  643. FTerminal->LogEvent(FORMAT("Error status: %d, Message: %d, Server: %s, Language: %s ",
  644. (int(Code), (int)Packet->MessageNumber, ServerMessage, LanguageTag)));
  645. }
  646. FTerminal->TerminalError(NULL, FMTLOAD(SFTP_ERROR_FORMAT,
  647. (LoadStr(Message), int(Code), ServerMessage, LanguageTag, int(Packet->RequestType))));
  648. return 0;
  649. }
  650. else
  651. {
  652. return Code;
  653. }
  654. }
  655. //---------------------------------------------------------------------------
  656. void __fastcall TSFTPFileSystem::RemoveReservation(int Reservation)
  657. {
  658. for (int Index = Reservation+1; Index < FPacketReservations->Count; Index++)
  659. {
  660. FPacketNumbers.PutElement(FPacketNumbers.GetElement(Index), Index-1);
  661. }
  662. TSFTPPacket * Packet = (TSFTPPacket *)FPacketReservations->Items[Reservation];
  663. if (Packet)
  664. {
  665. assert(Packet->ReservedBy == this);
  666. Packet->ReservedBy = NULL;
  667. }
  668. FPacketReservations->Delete(Reservation);
  669. }
  670. //---------------------------------------------------------------------------
  671. int __fastcall TSFTPFileSystem::ReceivePacket(TSFTPPacket * Packet,
  672. int ExpectedType, int AllowStatus)
  673. {
  674. int Result = SSH_FX_OK;
  675. BusyStart();
  676. try
  677. {
  678. int Reservation = FPacketReservations->IndexOf(Packet);
  679. if (Reservation < 0 || Packet->Capacity == 0)
  680. {
  681. bool IsReserved;
  682. do
  683. {
  684. IsReserved = false;
  685. assert(Packet);
  686. char LenBuf[4];
  687. FTerminal->Receive(LenBuf, sizeof(LenBuf));
  688. int Length = GET_32BIT(LenBuf);
  689. Packet->Capacity = Length;
  690. FTerminal->Receive(Packet->Data, Length);
  691. Packet->DataUpdated(Length);
  692. if (FTerminal->IsLogging())
  693. {
  694. if ((FPreviousLoggedPacket != SSH_FXP_READ &&
  695. FPreviousLoggedPacket != SSH_FXP_WRITE) ||
  696. (Packet->Type != SSH_FXP_STATUS))
  697. {
  698. if (FNotLoggedPackets)
  699. {
  700. FTerminal->LogEvent(FORMAT("%d skipped SSH_FXP_WRITE, SSH_FXP_READ and SSH_FXP_STATUS packets.",
  701. (FNotLoggedPackets)));
  702. FNotLoggedPackets = 0;
  703. }
  704. FTerminal->Log->Add(llOutput, FORMAT("Type: %s, Size: %d, Number: %d",
  705. (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
  706. }
  707. else
  708. {
  709. FNotLoggedPackets++;
  710. }
  711. }
  712. if (Reservation < 0 ||
  713. Packet->MessageNumber != (unsigned long)FPacketNumbers.GetElement(Reservation))
  714. {
  715. TSFTPPacket * ReservedPacket;
  716. unsigned long MessageNumber;
  717. for (int Index = 0; Index < FPacketReservations->Count; Index++)
  718. {
  719. MessageNumber = FPacketNumbers.GetElement(Index);
  720. if (MessageNumber == Packet->MessageNumber)
  721. {
  722. ReservedPacket = (TSFTPPacket *)FPacketReservations->Items[Index];
  723. IsReserved = true;
  724. if (ReservedPacket)
  725. {
  726. *ReservedPacket = *Packet;
  727. }
  728. else
  729. {
  730. RemoveReservation(Index);
  731. }
  732. break;
  733. }
  734. }
  735. }
  736. }
  737. while (IsReserved);
  738. }
  739. if (ExpectedType >= 0)
  740. {
  741. if (Packet->Type == SSH_FXP_STATUS)
  742. {
  743. Result = GotStatusPacket(Packet, (AllowStatus >= 0 ? AllowStatus : asOK));
  744. }
  745. else if (ExpectedType != Packet->Type)
  746. {
  747. FTerminal->FatalError(FMTLOAD(SFTP_INVALID_TYPE, ((int)Packet->Type)));
  748. }
  749. }
  750. if (Reservation >= 0)
  751. {
  752. // order might have changed, when reserved, but not longer needed packet
  753. // was receive in above loop
  754. Reservation = FPacketReservations->IndexOf(Packet);
  755. assert(Reservation >= 0);
  756. assert(Packet->MessageNumber == (unsigned long)FPacketNumbers.GetElement(Reservation));
  757. RemoveReservation(Reservation);
  758. }
  759. }
  760. __finally
  761. {
  762. BusyEnd();
  763. }
  764. return Result;
  765. }
  766. //---------------------------------------------------------------------------
  767. void __fastcall TSFTPFileSystem::ReserveResponse(const TSFTPPacket * Packet,
  768. TSFTPPacket * Response)
  769. {
  770. assert(FPacketReservations->IndexOf(Response) < 0);
  771. // mark response as not received yet
  772. Response->Capacity = 0;
  773. Response->ReservedBy = this;
  774. FPacketReservations->Add(Response);
  775. if (FPacketReservations->Count >= FPacketNumbers.ArrayHighBound())
  776. {
  777. FPacketNumbers.ArrayRedim(FPacketReservations->Count + 10);
  778. }
  779. FPacketNumbers.PutElement(Packet->MessageNumber, FPacketReservations->Count - 1);
  780. }
  781. //---------------------------------------------------------------------------
  782. void __fastcall TSFTPFileSystem::UnreserveResponse(TSFTPPacket * Response)
  783. {
  784. int Reservation = FPacketReservations->IndexOf(Response);
  785. if (Reservation >= 0)
  786. {
  787. FPacketReservations->Items[Reservation] = NULL;
  788. }
  789. }
  790. //---------------------------------------------------------------------------
  791. int __fastcall TSFTPFileSystem::ReceiveResponse(
  792. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  793. int AllowStatus)
  794. {
  795. int Result;
  796. unsigned int MessageNumber = Packet->MessageNumber;
  797. TSFTPPacket * AResponse = (Response ? Response : new TSFTPPacket());
  798. try
  799. {
  800. Result = ReceivePacket(AResponse, ExpectedType, AllowStatus);
  801. if (MessageNumber != AResponse->MessageNumber)
  802. {
  803. FTerminal->FatalError(FMTLOAD(SFTP_MESSAGE_NUMBER,
  804. ((int)AResponse->MessageNumber, (int)MessageNumber)));
  805. }
  806. }
  807. __finally
  808. {
  809. if (!Response) delete AResponse;
  810. }
  811. return Result;
  812. }
  813. //---------------------------------------------------------------------------
  814. int __fastcall TSFTPFileSystem::SendPacketAndReceiveResponse(
  815. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  816. int AllowStatus)
  817. {
  818. int Result;
  819. BusyStart();
  820. try
  821. {
  822. SendPacket(Packet);
  823. Result = ReceiveResponse(Packet, Response, ExpectedType, AllowStatus);
  824. }
  825. __finally
  826. {
  827. BusyEnd();
  828. }
  829. return Result;
  830. }
  831. //---------------------------------------------------------------------------
  832. bool __fastcall inline TSFTPFileSystem::IsAbsolutePath(const AnsiString Path)
  833. {
  834. return !Path.IsEmpty() && Path[1] == '/';
  835. }
  836. //---------------------------------------------------------------------------
  837. AnsiString __fastcall TSFTPFileSystem::RealPath(const AnsiString Path)
  838. {
  839. try
  840. {
  841. TSFTPPacket Packet(SSH_FXP_REALPATH);
  842. Packet.AddString(Path);
  843. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_NAME);
  844. if (Packet.GetCardinal() != 1)
  845. {
  846. FTerminal->FatalError(LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  847. }
  848. AnsiString RealDir = Packet.GetString();
  849. // ignore rest of SSH_FXP_NAME packet
  850. return RealDir;
  851. }
  852. catch(Exception & E)
  853. {
  854. if (FTerminal->Active)
  855. {
  856. throw ExtException(&E, FMTLOAD(SFTP_REALPATH_ERROR, (Path)));
  857. }
  858. else
  859. {
  860. throw;
  861. }
  862. }
  863. }
  864. //---------------------------------------------------------------------------
  865. AnsiString __fastcall TSFTPFileSystem::RealPath(const AnsiString Path,
  866. const AnsiString BaseDir)
  867. {
  868. AnsiString APath;
  869. if (IsAbsolutePath(Path))
  870. {
  871. APath = Path;
  872. }
  873. else
  874. {
  875. if (!BaseDir.IsEmpty())
  876. {
  877. APath = UnixIncludeTrailingBackslash(BaseDir);
  878. }
  879. if (!Path.IsEmpty())
  880. {
  881. APath = APath + Path;
  882. }
  883. if (APath.IsEmpty()) APath = UnixIncludeTrailingBackslash(".");
  884. }
  885. return RealPath(APath);
  886. }
  887. //---------------------------------------------------------------------------
  888. AnsiString __fastcall inline TSFTPFileSystem::LocalCanonify(const AnsiString Path)
  889. {
  890. // TODO: improve (handle .. etc.)
  891. if (IsAbsolutePath(Path)) return Path;
  892. else
  893. {
  894. return UnixIncludeTrailingBackslash(FCurrentDirectory) + Path;
  895. }
  896. }
  897. //---------------------------------------------------------------------------
  898. AnsiString __fastcall inline TSFTPFileSystem::Canonify(AnsiString Path)
  899. {
  900. // inspired by canonify() from PSFTP.C
  901. AnsiString Result;
  902. Path = LocalCanonify(Path);
  903. try
  904. {
  905. Result = RealPath(Path);
  906. }
  907. catch(...)
  908. {
  909. if (FTerminal->Active)
  910. {
  911. AnsiString APath = UnixExcludeTrailingBackslash(Path);
  912. AnsiString Name = UnixExtractFileName(APath);
  913. if (Name == "." || Name == "..")
  914. {
  915. Result = Path;
  916. }
  917. else
  918. {
  919. AnsiString FPath = UnixExcludeTrailingBackslash(UnixExtractFilePath(Path));
  920. try
  921. {
  922. Result = RealPath(FPath);
  923. Result = UnixIncludeTrailingBackslash(Result) + Name;
  924. }
  925. catch(...)
  926. {
  927. if (FTerminal->Active)
  928. {
  929. Result = Path;
  930. }
  931. else
  932. {
  933. throw;
  934. }
  935. }
  936. }
  937. }
  938. else
  939. {
  940. throw;
  941. }
  942. }
  943. return Result;
  944. }
  945. //---------------------------------------------------------------------------
  946. AnsiString __fastcall TSFTPFileSystem::GetHomeDirectory()
  947. {
  948. if (FHomeDirectory.IsEmpty())
  949. {
  950. FHomeDirectory = RealPath(".");
  951. }
  952. return FHomeDirectory;
  953. }
  954. //---------------------------------------------------------------------------
  955. TRemoteFile * __fastcall TSFTPFileSystem::LoadFile(TSFTPPacket * Packet,
  956. TRemoteFile * ALinkedByFile)
  957. {
  958. TRemoteFile * File = new TRemoteFile(ALinkedByFile);
  959. try
  960. {
  961. File->Terminal = FTerminal;
  962. Packet->GetFile(File, FVersion);
  963. }
  964. catch(...)
  965. {
  966. delete File;
  967. throw;
  968. }
  969. return File;
  970. }
  971. //---------------------------------------------------------------------------
  972. void __fastcall TSFTPFileSystem::SetCurrentDirectory(AnsiString value)
  973. {
  974. assert(false);
  975. }
  976. //---------------------------------------------------------------------------
  977. AnsiString __fastcall TSFTPFileSystem::GetCurrentDirectory()
  978. {
  979. return FCurrentDirectory;
  980. }
  981. //---------------------------------------------------------------------------
  982. void __fastcall TSFTPFileSystem::DoStartup()
  983. {
  984. TSFTPPacket Packet(SSH_FXP_INIT);
  985. Packet.AddCardinal(SFTPMaxVersion);
  986. try
  987. {
  988. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_VERSION);
  989. }
  990. catch(Exception &E)
  991. {
  992. FTerminal->FatalError(&E, LoadStr(SFTP_INITIALIZE_ERROR));
  993. }
  994. FVersion = Packet.GetCardinal();
  995. FTerminal->LogEvent(FORMAT("SFTP version %d negotiated.", (FVersion)));
  996. if (FVersion < SFTPMinVersion || FVersion > SFTPMaxVersion)
  997. {
  998. FTerminal->FatalError(FMTLOAD(SFTP_VERSION_NOT_SUPPORTED,
  999. (FVersion, SFTPMinVersion, SFTPMaxVersion)));
  1000. }
  1001. if (FVersion >= 3)
  1002. {
  1003. FEOL = "\r\n";
  1004. AnsiString ExtensionName;
  1005. AnsiString ExtensionData;
  1006. while (Packet.NextData)
  1007. {
  1008. ExtensionName = Packet.GetString();
  1009. ExtensionData = Packet.GetString();
  1010. if (ExtensionName == "newline")
  1011. {
  1012. FEOL = ExtensionData;
  1013. AnsiString EOLHex;
  1014. for (int i = 0; i < FEOL.Length(); i++)
  1015. {
  1016. EOLHex += IntToHex(FEOL[i+1], 2);
  1017. }
  1018. FTerminal->LogEvent(FORMAT("Server requests EOL sequence %s.", (EOLHex)));
  1019. if (FEOL.Length() < 1 || FEOL.Length() > 2)
  1020. {
  1021. FTerminal->FatalError(FMTLOAD(SFTP_INVALID_EOL, (EOLHex)));
  1022. }
  1023. }
  1024. else
  1025. {
  1026. FTerminal->LogEvent(FORMAT("Unknown server extension %s=%s",
  1027. (ExtensionName, ExtensionData)));
  1028. }
  1029. }
  1030. Packet.ChangeType(SSH_FXP_EXTENDED);
  1031. Packet.AddString("[email protected]");
  1032. int Status = SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS,
  1033. asOK | asOpUnsupported);
  1034. if (Status == SSH_FX_OK)
  1035. {
  1036. FTerminal->LogEvent("Server recognises WinSCP.");
  1037. }
  1038. else
  1039. {
  1040. FTerminal->LogEvent("Server does not recognise WinSCP.");
  1041. }
  1042. }
  1043. }
  1044. //---------------------------------------------------------------------------
  1045. char * __fastcall TSFTPFileSystem::GetEOL() const
  1046. {
  1047. if (FVersion >= 4)
  1048. {
  1049. assert(!FEOL.IsEmpty());
  1050. return FEOL.c_str();
  1051. }
  1052. else
  1053. {
  1054. return EOLToStr(FTerminal->SessionData->EOLType);
  1055. }
  1056. }
  1057. //---------------------------------------------------------------------------
  1058. void __fastcall TSFTPFileSystem::LookupUserGroups()
  1059. {
  1060. assert(false);
  1061. }
  1062. //---------------------------------------------------------------------------
  1063. void __fastcall TSFTPFileSystem::ReadCurrentDirectory()
  1064. {
  1065. if (!FDirectoryToChangeTo.IsEmpty())
  1066. {
  1067. FCurrentDirectory = FDirectoryToChangeTo;
  1068. FDirectoryToChangeTo = "";
  1069. }
  1070. else if (FCurrentDirectory.IsEmpty())
  1071. {
  1072. // this happens only after startup when default remote directory is not specified
  1073. FCurrentDirectory = GetHomeDirectory();
  1074. }
  1075. }
  1076. //---------------------------------------------------------------------------
  1077. void __fastcall TSFTPFileSystem::HomeDirectory()
  1078. {
  1079. ChangeDirectory(GetHomeDirectory());
  1080. }
  1081. //---------------------------------------------------------------------------
  1082. void __fastcall TSFTPFileSystem::TryOpenDirectory(const AnsiString Directory)
  1083. {
  1084. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  1085. Packet.AddString(Directory);
  1086. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  1087. AnsiString Handle = Packet.GetString();
  1088. Packet.ChangeType(SSH_FXP_CLOSE);
  1089. Packet.AddString(Handle);
  1090. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1091. }
  1092. //---------------------------------------------------------------------------
  1093. void __fastcall TSFTPFileSystem::ChangeDirectory(const AnsiString Directory)
  1094. {
  1095. AnsiString Path, Current;
  1096. Current = !FDirectoryToChangeTo.IsEmpty() ? FDirectoryToChangeTo : FCurrentDirectory;
  1097. Path = RealPath(Directory, Current);
  1098. // to verify existence of directory try to open it (SSH_FXP_REALPATH succeeds
  1099. // for invalid paths on some systems, like CygWin)
  1100. TryOpenDirectory(Path);
  1101. // if open dir did not fail, directory exists -> success.
  1102. FDirectoryToChangeTo = Path;
  1103. }
  1104. //---------------------------------------------------------------------------
  1105. void __fastcall TSFTPFileSystem::ReadDirectory(TRemoteFileList * FileList)
  1106. {
  1107. assert(FileList && !FileList->Directory.IsEmpty());
  1108. AnsiString Directory = LocalCanonify(FileList->Directory);
  1109. FTerminal->LogEvent(FORMAT("Listing directory \"%s\".", (Directory)));
  1110. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  1111. Packet.AddString(Directory);
  1112. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  1113. AnsiString Handle = Packet.GetString();
  1114. FileList->Clear();
  1115. TSFTPPacket Response;
  1116. try
  1117. {
  1118. bool isEOF = false;
  1119. int Total = 0;
  1120. TRemoteFile * File;
  1121. Packet.ChangeType(SSH_FXP_READDIR);
  1122. Packet.AddString(Handle);
  1123. SendPacket(&Packet);
  1124. do
  1125. {
  1126. ReceiveResponse(&Packet, &Response);
  1127. if (Response.Type == SSH_FXP_NAME)
  1128. {
  1129. TSFTPPacket ListingPacket = Response;
  1130. Packet.ChangeType(SSH_FXP_READDIR);
  1131. Packet.AddString(Handle);
  1132. SendPacket(&Packet);
  1133. ReserveResponse(&Packet, &Response);
  1134. unsigned int Count = ListingPacket.GetCardinal();
  1135. for (unsigned long Index = 0; Index < Count; Index++)
  1136. {
  1137. File = LoadFile(&ListingPacket, NULL);
  1138. FileList->AddFile(File);
  1139. Total++;
  1140. }
  1141. }
  1142. else if (Response.Type == SSH_FXP_STATUS)
  1143. {
  1144. isEOF = (GotStatusPacket(&Response, asEOF) == SSH_FX_EOF);
  1145. }
  1146. else
  1147. {
  1148. FTerminal->FatalError(FMTLOAD(SFTP_INVALID_TYPE, ((int)Response.Type)));
  1149. }
  1150. }
  1151. while (!isEOF);
  1152. if (Total == 0)
  1153. {
  1154. // Empty file list -> probably "permision denied", we
  1155. // at least get link to parent directory ("..")
  1156. try
  1157. {
  1158. FTerminal->ExceptionOnFail = true;
  1159. try
  1160. {
  1161. File = NULL;
  1162. FTerminal->ReadFile(
  1163. UnixIncludeTrailingBackslash(FileList->Directory) + PARENTDIRECTORY, File);
  1164. }
  1165. __finally
  1166. {
  1167. FTerminal->ExceptionOnFail = false;
  1168. }
  1169. }
  1170. catch(Exception &E)
  1171. {
  1172. if (E.InheritsFrom(__classid(EFatal))) throw;
  1173. else File = NULL;
  1174. }
  1175. // on some systems even getting ".." fails, we create dummy ".." instead
  1176. bool Failure = (File == NULL);
  1177. if (Failure)
  1178. {
  1179. File = new TRemoteFile();
  1180. File->FileName = PARENTDIRECTORY;
  1181. File->Modification = Now();
  1182. File->Type = FILETYPE_DIRECTORY;
  1183. }
  1184. assert(File && File->IsParentDirectory);
  1185. FileList->AddFile(File);
  1186. if (Failure)
  1187. {
  1188. throw Exception(FMTLOAD(EMPTY_DIRECTORY, (FileList->Directory)));
  1189. }
  1190. }
  1191. }
  1192. __finally
  1193. {
  1194. if (FTerminal->Active)
  1195. {
  1196. Packet.ChangeType(SSH_FXP_CLOSE);
  1197. Packet.AddString(Handle);
  1198. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1199. }
  1200. }
  1201. }
  1202. //---------------------------------------------------------------------------
  1203. void __fastcall TSFTPFileSystem::ReadSymlink(TRemoteFile * SymlinkFile,
  1204. TRemoteFile *& File)
  1205. {
  1206. assert(SymlinkFile && SymlinkFile->IsSymLink);
  1207. assert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
  1208. AnsiString FileName = LocalCanonify(SymlinkFile->FileName);
  1209. TSFTPPacket ReadLinkPacket(SSH_FXP_READLINK);
  1210. ReadLinkPacket.AddString(FileName);
  1211. SendPacket(&ReadLinkPacket);
  1212. ReserveResponse(&ReadLinkPacket, &ReadLinkPacket);
  1213. // send second request before reading response to first one
  1214. // (performance benefit)
  1215. TSFTPPacket AttrsPacket(SSH_FXP_STAT);
  1216. AttrsPacket.AddString(FileName);
  1217. SendPacket(&AttrsPacket);
  1218. ReserveResponse(&AttrsPacket, &AttrsPacket);
  1219. ReceiveResponse(&ReadLinkPacket, &ReadLinkPacket, SSH_FXP_NAME);
  1220. if (ReadLinkPacket.GetCardinal() != 1)
  1221. {
  1222. FTerminal->FatalError(LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  1223. }
  1224. SymlinkFile->LinkTo = ReadLinkPacket.GetString();
  1225. ReceiveResponse(&AttrsPacket, &AttrsPacket, SSH_FXP_ATTRS);
  1226. File = LoadFile(&AttrsPacket, SymlinkFile);
  1227. File->FileName = UnixExtractFileName(SymlinkFile->FileName);
  1228. }
  1229. //---------------------------------------------------------------------------
  1230. void __fastcall TSFTPFileSystem::ReadFile(const AnsiString FileName,
  1231. TRemoteFile *& File)
  1232. {
  1233. CustomReadFile(FileName, File, SSH_FXP_LSTAT);
  1234. }
  1235. //---------------------------------------------------------------------------
  1236. bool __fastcall inline TSFTPFileSystem::RemoteFileExists(const AnsiString FullPath,
  1237. TRemoteFile ** File)
  1238. {
  1239. bool Result;
  1240. try
  1241. {
  1242. TRemoteFile * AFile;
  1243. ReadFile(FullPath, AFile);
  1244. Result = true;
  1245. if (File)
  1246. {
  1247. *File = AFile;
  1248. }
  1249. else
  1250. {
  1251. delete AFile;
  1252. }
  1253. }
  1254. catch(...)
  1255. {
  1256. if (!FTerminal->Active)
  1257. {
  1258. throw;
  1259. }
  1260. Result = false;
  1261. }
  1262. return Result;
  1263. }
  1264. //---------------------------------------------------------------------------
  1265. void __fastcall TSFTPFileSystem::CustomReadFile(const AnsiString FileName,
  1266. TRemoteFile *& File, char Type, TRemoteFile * ALinkedByFile)
  1267. {
  1268. TSFTPPacket Packet(Type);
  1269. Packet.AddString(LocalCanonify(FileName));
  1270. if (FVersion >= 4)
  1271. {
  1272. Packet.AddCardinal(SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_PERMISSIONS |
  1273. SSH_FILEXFER_ATTR_ACCESSTIME | SSH_FILEXFER_ATTR_MODIFYTIME |
  1274. SSH_FILEXFER_ATTR_OWNERGROUP);
  1275. }
  1276. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_ATTRS);
  1277. File = LoadFile(&Packet, ALinkedByFile);
  1278. File->FileName = UnixExtractFileName(FileName);
  1279. }
  1280. //---------------------------------------------------------------------------
  1281. void __fastcall TSFTPFileSystem::DeleteFile(const AnsiString FileName,
  1282. const TRemoteFile * File, bool Recursive)
  1283. {
  1284. char Type;
  1285. AnsiString RealFileName = LocalCanonify(FileName);
  1286. if (File && File->IsDirectory && !File->IsSymLink)
  1287. {
  1288. if (Recursive)
  1289. {
  1290. FTerminal->ProcessDirectory(FileName, FTerminal->DeleteFile, &Recursive);
  1291. }
  1292. Type = SSH_FXP_RMDIR;
  1293. }
  1294. else
  1295. {
  1296. Type = SSH_FXP_REMOVE;
  1297. }
  1298. TSFTPPacket Packet(Type);
  1299. Packet.AddString(RealFileName);
  1300. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1301. }
  1302. //---------------------------------------------------------------------------
  1303. void __fastcall TSFTPFileSystem::RenameFile(const AnsiString FileName,
  1304. const AnsiString NewName)
  1305. {
  1306. TSFTPPacket Packet(SSH_FXP_RENAME);
  1307. AnsiString RealName = LocalCanonify(FileName);
  1308. Packet.AddString(RealName);
  1309. Packet.AddString(UnixExtractFilePath(RealName) + NewName);
  1310. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1311. }
  1312. //---------------------------------------------------------------------------
  1313. void __fastcall TSFTPFileSystem::CreateDirectory(const AnsiString DirName,
  1314. const TRemoteProperties * Properties)
  1315. {
  1316. TSFTPPacket Packet(SSH_FXP_MKDIR);
  1317. Packet.AddString(Canonify(DirName));
  1318. Packet.AddProperties(Properties, 0, true, FVersion);
  1319. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1320. }
  1321. //---------------------------------------------------------------------------
  1322. void __fastcall TSFTPFileSystem::CreateLink(const AnsiString FileName,
  1323. const AnsiString PointTo, bool Symbolic)
  1324. {
  1325. assert(Symbolic); // only symlinks are supported by SFTP
  1326. assert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
  1327. TSFTPPacket Packet(SSH_FXP_SYMLINK);
  1328. Packet.AddString(PointTo);
  1329. Packet.AddString(Canonify(FileName));
  1330. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1331. }
  1332. //---------------------------------------------------------------------------
  1333. void __fastcall TSFTPFileSystem::ChangeFileProperties(const AnsiString FileName,
  1334. const TRemoteFile * /*File*/, const TRemoteProperties * Properties)
  1335. {
  1336. assert(Properties);
  1337. TRemoteFile * File;
  1338. AnsiString RealFileName = LocalCanonify(FileName);
  1339. ReadFile(RealFileName, File);
  1340. try
  1341. {
  1342. assert(File);
  1343. if (File->IsDirectory && Properties->Recursive)
  1344. {
  1345. FTerminal->ProcessDirectory(FileName, FTerminal->ChangeFileProperties,
  1346. (void*)Properties);
  1347. }
  1348. TSFTPPacket Packet(SSH_FXP_SETSTAT);
  1349. Packet.AddString(RealFileName);
  1350. Packet.AddProperties(Properties, *File->Rights, File->IsDirectory, FVersion);
  1351. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  1352. }
  1353. __finally
  1354. {
  1355. delete File;
  1356. }
  1357. }
  1358. //---------------------------------------------------------------------------
  1359. void __fastcall TSFTPFileSystem::AnyCommand(const AnsiString /*Command*/)
  1360. {
  1361. assert(false);
  1362. }
  1363. //---------------------------------------------------------------------------
  1364. // transfer protocol
  1365. //---------------------------------------------------------------------------
  1366. void __fastcall TSFTPFileSystem::CopyToRemote(TStrings * FilesToCopy,
  1367. const AnsiString TargetDir, const TCopyParamType * CopyParam,
  1368. int Params, TFileOperationProgressType * OperationProgress,
  1369. bool & DisconnectWhenComplete)
  1370. {
  1371. assert(FilesToCopy && OperationProgress);
  1372. AnsiString FileName, FileNameOnly;
  1373. AnsiString FullTargetDir = UnixIncludeTrailingBackslash(TargetDir);
  1374. int Index = 0;
  1375. while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
  1376. {
  1377. bool Success = false;
  1378. FileName = FilesToCopy->Strings[Index];
  1379. FileNameOnly = ExtractFileName(FileName);
  1380. assert(!FAvoidBusy);
  1381. FAvoidBusy = true;
  1382. try
  1383. {
  1384. try
  1385. {
  1386. if (FTerminal->SessionData->CacheDirectories)
  1387. {
  1388. FTerminal->DirectoryModified(TargetDir, false);
  1389. if (DirectoryExists(FileName))
  1390. {
  1391. FTerminal->DirectoryModified(UnixIncludeTrailingBackslash(TargetDir)+
  1392. FileNameOnly, true);
  1393. }
  1394. }
  1395. SFTPSource(FileName, FullTargetDir, CopyParam, Params, OperationProgress);
  1396. Success = true;
  1397. }
  1398. catch(EScpSkipFile & E)
  1399. {
  1400. SUSPEND_OPERATION (
  1401. if (!FTerminal->HandleException(&E)) throw;
  1402. );
  1403. }
  1404. catch(...)
  1405. {
  1406. throw;
  1407. }
  1408. }
  1409. __finally
  1410. {
  1411. FAvoidBusy = false;
  1412. OperationProgress->Finish(FileNameOnly, Success, DisconnectWhenComplete);
  1413. }
  1414. Index++;
  1415. }
  1416. }
  1417. //---------------------------------------------------------------------------
  1418. void __fastcall TSFTPFileSystem::SFTPConfirmOverwrite(const AnsiString FileName,
  1419. TFileOperationProgressType * OperationProgress)
  1420. {
  1421. if (OperationProgress->NoToAll)
  1422. {
  1423. THROW_SKIP_FILE_NULL;
  1424. }
  1425. else
  1426. {
  1427. AnsiString QuestionFmt = LoadStr(FILE_OVERWRITE);
  1428. int Answer;
  1429. SUSPEND_OPERATION
  1430. (
  1431. Answer = FTerminal->DoQueryUser(
  1432. FORMAT(QuestionFmt, (FileName)),
  1433. qaYes | qaNo | qaAbort | qaYesToAll | qaNoToAll, qpNeverAskAgainCheck);
  1434. );
  1435. switch (Answer) {
  1436. case qaNeverAskAgain:
  1437. FTerminal->Configuration->ConfirmOverwriting = false;
  1438. case qaYesToAll:
  1439. OperationProgress->YesToAll = true;
  1440. case qaYes:
  1441. // file overwriting was confirmed, try to open file
  1442. // second time, now without exclusive flag (SSH_FXF_EXCL)
  1443. break;
  1444. case qaAbort:
  1445. if (!OperationProgress->Cancel)
  1446. {
  1447. OperationProgress->Cancel = csCancel;
  1448. }
  1449. Abort();
  1450. break;
  1451. case qaNoToAll:
  1452. OperationProgress->NoToAll = true;
  1453. case qaNo:
  1454. THROW_SKIP_FILE_NULL;
  1455. }
  1456. }
  1457. }
  1458. //---------------------------------------------------------------------------
  1459. bool TSFTPFileSystem::SFTPConfirmResume(const AnsiString DestFileName,
  1460. bool PartialBiggerThanSource, TFileOperationProgressType * OperationProgress)
  1461. {
  1462. bool ResumeTransfer;
  1463. assert(OperationProgress);
  1464. if (PartialBiggerThanSource)
  1465. {
  1466. int Answer;
  1467. SUSPEND_OPERATION
  1468. (
  1469. Answer = FTerminal->DoQueryUser(
  1470. FMTLOAD(PARTIAL_BIGGER_THAN_SOURCE, (DestFileName)), NULL,
  1471. qaOK | qaAbort, 0, qtWarning);
  1472. )
  1473. if (Answer == qaAbort)
  1474. {
  1475. if (!OperationProgress->Cancel)
  1476. {
  1477. OperationProgress->Cancel = csCancel;
  1478. }
  1479. Abort();
  1480. }
  1481. ResumeTransfer = false;
  1482. }
  1483. else
  1484. {
  1485. int Answer;
  1486. SUSPEND_OPERATION
  1487. (
  1488. Answer = FTerminal->DoQueryUser(
  1489. FMTLOAD(RESUME_TRANSFER, (DestFileName)), qaYes | qaNo | qaAbort, 0);
  1490. );
  1491. switch (Answer) {
  1492. case qaYes:
  1493. ResumeTransfer = true;
  1494. break;
  1495. case qaNo:
  1496. ResumeTransfer = false;
  1497. break;
  1498. case qaAbort:
  1499. if (!OperationProgress->Cancel)
  1500. {
  1501. OperationProgress->Cancel = csCancel;
  1502. }
  1503. Abort();
  1504. break;
  1505. }
  1506. }
  1507. return ResumeTransfer;
  1508. }
  1509. //---------------------------------------------------------------------------
  1510. void __fastcall TSFTPFileSystem::SFTPSource(const AnsiString FileName,
  1511. const AnsiString TargetDir, const TCopyParamType * CopyParam, int Params,
  1512. TFileOperationProgressType * OperationProgress)
  1513. {
  1514. FTerminal->LogEvent(FORMAT("File: \"%s\"", (FileName)));
  1515. OperationProgress->SetFile(FileName);
  1516. TOpenRemoteFileParams OpenParams;
  1517. HANDLE File;
  1518. unsigned long MTime, ATime;
  1519. __int64 Size;
  1520. FTerminal->OpenLocalFile(FileName, GENERIC_READ, &OpenParams.LocalFileAttrs,
  1521. &File, NULL, &MTime, &ATime, &Size);
  1522. if (OpenParams.LocalFileAttrs & faDirectory)
  1523. {
  1524. SFTPDirectorySource(IncludeTrailingBackslash(FileName), TargetDir,
  1525. OpenParams.LocalFileAttrs, CopyParam, Params, OperationProgress);
  1526. }
  1527. else
  1528. try
  1529. {
  1530. // File is regular file (not directory)
  1531. assert(File);
  1532. AnsiString DestFileName = CopyParam->ChangeFileName(ExtractFileName(FileName), osLocal);
  1533. AnsiString DestFullName = LocalCanonify(TargetDir + DestFileName);
  1534. AnsiString DestPartinalFullName;
  1535. bool ResumeAllowed;
  1536. bool ResumeTransfer = false;
  1537. bool DestFileExists = false;
  1538. __int64 ResumeOffset;
  1539. FTerminal->LogEvent(FORMAT("Copying \"%s\" to remote directory started.", (FileName)));
  1540. OperationProgress->SetLocalSize(Size);
  1541. // Suppose same data size to transfer as to read
  1542. // (not true with ASCII transfer)
  1543. OperationProgress->SetTransferSize(OperationProgress->LocalSize);
  1544. OperationProgress->TransferingFile = false;
  1545. // Will we use ASCII of BINARY file tranfer?
  1546. OperationProgress->SetAsciiTransfer(CopyParam->UseAsciiTransfer(FileName));
  1547. FTerminal->LogEvent(
  1548. AnsiString((OperationProgress->AsciiTransfer ? "Ascii" : "Binary")) +
  1549. " transfer mode selected.");
  1550. ResumeAllowed = !OperationProgress->AsciiTransfer &&
  1551. CopyParam->AllowResume(OperationProgress->LocalSize);
  1552. OperationProgress->SetResumeStatus(ResumeAllowed ? rsEnabled : rsDisabled);
  1553. if (ResumeAllowed)
  1554. {
  1555. DestPartinalFullName = DestFullName + FTerminal->Configuration->PartialExt;
  1556. FTerminal->LogEvent("Checking existence of file.");
  1557. DestFileExists = RemoteFileExists(DestFullName);
  1558. TRemoteFile * File;
  1559. FTerminal->LogEvent("Checking existence of partially transfered file.");
  1560. if (RemoteFileExists(DestPartinalFullName, &File))
  1561. {
  1562. ResumeOffset = File->Size;
  1563. delete File;
  1564. ResumeTransfer = SFTPConfirmResume(DestFileName,
  1565. ResumeOffset > OperationProgress->LocalSize, OperationProgress);
  1566. if (!ResumeTransfer)
  1567. {
  1568. DeleteFile(DestPartinalFullName);
  1569. }
  1570. else
  1571. {
  1572. FTerminal->LogEvent("Resuming file transfer.");
  1573. }
  1574. }
  1575. else
  1576. {
  1577. // partial upload file does not exists, check for full file
  1578. if (DestFileExists && FTerminal->Configuration->ConfirmOverwriting &&
  1579. !OperationProgress->YesToAll && !(Params & cpNoConfirmation))
  1580. {
  1581. SFTPConfirmOverwrite(DestFileName, OperationProgress);
  1582. }
  1583. }
  1584. }
  1585. OpenParams.RemoteFileName = ResumeAllowed ? DestPartinalFullName : DestFullName;
  1586. OpenParams.Resume = ResumeAllowed;
  1587. OpenParams.OperationProgress = OperationProgress;
  1588. OpenParams.CopyParam = CopyParam;
  1589. OpenParams.Params = Params;
  1590. FTerminal->LogEvent("Opening remote file.");
  1591. FTerminal->FileOperationLoop(SFTPOpenRemote, OperationProgress, true,
  1592. FMTLOAD(SFTP_CREATE_FILE_ERROR, (OpenParams.RemoteFileName)),
  1593. &OpenParams);
  1594. bool DeleteFileAfter = true;
  1595. try
  1596. {
  1597. if (ResumeTransfer)
  1598. {
  1599. FileSeek((THandle)File, ResumeOffset, 0);
  1600. OperationProgress->AddResumed(ResumeOffset);
  1601. }
  1602. TSFTPPacket DataPacket;
  1603. bool Eof;
  1604. do
  1605. {
  1606. // Buffer for one block of data
  1607. TFileBuffer BlockBuf;
  1608. FILE_OPERATION_LOOP(FileName,
  1609. FMTLOAD(READ_ERROR, (FileName)),
  1610. BlockBuf.LoadFile(File, OperationProgress->StaticBlockSize(), false);
  1611. );
  1612. Eof = (BlockBuf.Size == 0);
  1613. if (!Eof)
  1614. {
  1615. OperationProgress->AddLocalyUsed(BlockBuf.Size);
  1616. // We do ASCII transfer: convert EOL of current block
  1617. if (OperationProgress->AsciiTransfer)
  1618. {
  1619. assert(!ResumeTransfer && !ResumeAllowed);
  1620. __int64 PrevBufSize = BlockBuf.Size;
  1621. BlockBuf.ConvertEOL(FTerminal->Configuration->LocalEOLType,
  1622. GetEOL());
  1623. // update transfer size with difference arised from EOL conversion
  1624. OperationProgress->SetTransferSize(OperationProgress->TransferSize -
  1625. PrevBufSize + BlockBuf.Size);
  1626. }
  1627. FILE_OPERATION_LOOP(OpenParams.RemoteFileName,
  1628. FMTLOAD(WRITE_ERROR, (OpenParams.RemoteFileName)),
  1629. DataPacket.ChangeType(SSH_FXP_WRITE);
  1630. DataPacket.AddString(OpenParams.RemoteFileHandle);
  1631. DataPacket.AddInt64(OperationProgress->TransferedSize);
  1632. DataPacket.AddData(BlockBuf.Data, BlockBuf.Size);
  1633. SendPacketAndReceiveResponse(&DataPacket, &DataPacket, SSH_FXP_STATUS);
  1634. );
  1635. OperationProgress->AddTransfered(BlockBuf.Size);
  1636. if (OperationProgress->Cancel == csCancel)
  1637. {
  1638. Abort();
  1639. }
  1640. }
  1641. }
  1642. while (!Eof);
  1643. DeleteFileAfter = false;
  1644. }
  1645. __finally
  1646. {
  1647. if (FTerminal->Active)
  1648. {
  1649. FILE_OPERATION_LOOP(DestFileName,
  1650. FMTLOAD(SFTP_CLOSE_FILE_ERROR, (DestFileName)),
  1651. TSFTPPacket CloseRequest(SSH_FXP_CLOSE);
  1652. CloseRequest.AddString(OpenParams.RemoteFileHandle);
  1653. SendPacketAndReceiveResponse(&CloseRequest, NULL, SSH_FXP_STATUS);
  1654. );
  1655. // delete file if transfer was not completed and resuming is not allowed
  1656. if (DeleteFileAfter && !ResumeAllowed)
  1657. {
  1658. DeleteFile(OpenParams.RemoteFileName);
  1659. }
  1660. }
  1661. }
  1662. // originally this was before CLOSE (last __finally statement),
  1663. // on VShell it failed
  1664. if (ResumeAllowed)
  1665. {
  1666. FILE_OPERATION_LOOP(DestFileName,
  1667. FMTLOAD(RENAME_AFTER_RESUME_ERROR,
  1668. (UnixExtractFileName(OpenParams.RemoteFileName), DestFileName)),
  1669. if (DestFileExists)
  1670. {
  1671. DeleteFile(DestFullName);
  1672. DestFileExists = false;
  1673. }
  1674. RenameFile(OpenParams.RemoteFileName, DestFileName);
  1675. );
  1676. }
  1677. if (CopyParam->PreserveTime)
  1678. {
  1679. FILE_OPERATION_LOOP(DestFileName,
  1680. FMTLOAD(CHANGE_PROPERTIES_ERROR, (DestFileName)),
  1681. TSFTPPacket Packet(SSH_FXP_SETSTAT);
  1682. Packet.AddString(DestFullName);
  1683. if (FVersion >= 4)
  1684. {
  1685. Packet.AddCardinal(SSH_FILEXFER_ATTR_ACCESSTIME |
  1686. SSH_FILEXFER_ATTR_MODIFYTIME);
  1687. Packet.AddByte(SSH_FILEXFER_TYPE_REGULAR);
  1688. Packet.AddInt64(ATime);
  1689. Packet.AddInt64(MTime);
  1690. }
  1691. else
  1692. {
  1693. Packet.AddCardinal(SSH_FILEXFER_ATTR_ACMODTIME);
  1694. Packet.AddCardinal(ATime);
  1695. Packet.AddCardinal(MTime);
  1696. }
  1697. SendPacketAndReceiveResponse(&Packet, NULL, SSH_FXP_STATUS);
  1698. );
  1699. }
  1700. }
  1701. __finally
  1702. {
  1703. CloseHandle(File);
  1704. }
  1705. /* TODO : Delete also read-only files. */
  1706. /* TODO : Show error message on failure. */
  1707. if (Params & cpDelete) Sysutils::DeleteFile(FileName);
  1708. }
  1709. //---------------------------------------------------------------------------
  1710. int __fastcall TSFTPFileSystem::SFTPOpenRemote(void * AOpenParams, void * /*Param2*/)
  1711. {
  1712. TOpenRemoteFileParams * OpenParams = (TOpenRemoteFileParams *)AOpenParams;
  1713. assert(OpenParams);
  1714. TFileOperationProgressType * OperationProgress = OpenParams->OperationProgress;
  1715. TSFTPPacket OpenRequest;
  1716. int OpenType = 0;
  1717. bool Success = false;
  1718. do
  1719. {
  1720. try
  1721. {
  1722. OpenRequest.ChangeType(SSH_FXP_OPEN);
  1723. if (FTerminal->Configuration->ConfirmOverwriting &&
  1724. !OpenType && !OperationProgress->YesToAll && !OpenParams->Resume &&
  1725. !(OpenParams->Params & cpNoConfirmation))
  1726. {
  1727. OpenType |= SSH_FXF_EXCL;
  1728. }
  1729. else
  1730. {
  1731. OpenType &= ~SSH_FXF_EXCL;
  1732. }
  1733. if (!OpenParams->Resume)
  1734. {
  1735. OpenType |= SSH_FXF_TRUNC;
  1736. }
  1737. if ((FVersion >= 4) && OpenParams->OperationProgress->AsciiTransfer)
  1738. {
  1739. OpenType |= SSH_FXF_TEXT;
  1740. }
  1741. OpenRequest.AddString(OpenParams->RemoteFileName);
  1742. OpenRequest.AddCardinal(SSH_FXF_WRITE | SSH_FXF_CREAT | OpenType );
  1743. OpenRequest.AddCardinal(
  1744. OpenParams->CopyParam->PreserveRights ? SSH_FILEXFER_ATTR_PERMISSIONS : 0);
  1745. if (FVersion >= 4)
  1746. {
  1747. OpenRequest.AddByte(SSH_FILEXFER_TYPE_REGULAR);
  1748. }
  1749. if (OpenParams->CopyParam->PreserveRights)
  1750. {
  1751. OpenRequest.AddCardinal(
  1752. OpenParams->CopyParam->RemoteFileRights(OpenParams->LocalFileAttrs));
  1753. }
  1754. SendPacketAndReceiveResponse(&OpenRequest, &OpenRequest, SSH_FXP_HANDLE);
  1755. OpenParams->RemoteFileHandle = OpenRequest.GetString();
  1756. Success = true;
  1757. }
  1758. catch(Exception & E)
  1759. {
  1760. if (OpenType && FTerminal->Active)
  1761. {
  1762. // When exclusive opening of file fails, try to detect if file exists.
  1763. // When file exists, failure was probably caused by 'permission denied'
  1764. // or similar error. In this case throw original exception.
  1765. try
  1766. {
  1767. TRemoteFile * File;
  1768. AnsiString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
  1769. ReadFile(RealFileName, File);
  1770. // file exists (otherwise exception was thrown)
  1771. assert(File);
  1772. SAFE_DESTROY(File);
  1773. }
  1774. catch(...)
  1775. {
  1776. if (!FTerminal->Active)
  1777. {
  1778. throw;
  1779. }
  1780. else
  1781. {
  1782. throw E;
  1783. }
  1784. }
  1785. // confirmation duplicated in SFTPSource for resumable file transfers.
  1786. SFTPConfirmOverwrite(UnixExtractFileName(OpenParams->RemoteFileName),
  1787. OperationProgress);
  1788. }
  1789. else
  1790. {
  1791. throw;
  1792. }
  1793. }
  1794. }
  1795. while (!Success);
  1796. return 0;
  1797. }
  1798. //---------------------------------------------------------------------------
  1799. void __fastcall TSFTPFileSystem::SFTPDirectorySource(const AnsiString DirectoryName,
  1800. const AnsiString TargetDir, int Attrs, const TCopyParamType * CopyParam,
  1801. int Params, TFileOperationProgressType * OperationProgress)
  1802. {
  1803. AnsiString DestDirectoryName = CopyParam->ChangeFileName(
  1804. ExtractFileName(ExcludeTrailingBackslash(DirectoryName)), osLocal);
  1805. AnsiString DestFullName = UnixIncludeTrailingBackslash(TargetDir + DestDirectoryName);
  1806. OperationProgress->SetFile(DirectoryName);
  1807. try
  1808. {
  1809. TryOpenDirectory(DestFullName);
  1810. }
  1811. catch(...)
  1812. {
  1813. if (FTerminal->Active)
  1814. {
  1815. // opening directory failed, it probably does not exists, try to
  1816. // create it
  1817. TRemoteProperties Properties;
  1818. if (CopyParam->PreserveRights)
  1819. {
  1820. Properties.Valid = TValidProperties() << vpRights;
  1821. Properties.Rights = CopyParam->RemoteFileRights(Attrs);
  1822. }
  1823. FTerminal->CreateDirectory(DestFullName, &Properties);
  1824. }
  1825. else
  1826. {
  1827. throw;
  1828. }
  1829. }
  1830. int FindAttrs = faReadOnly | faHidden | faSysFile | faDirectory | faArchive;
  1831. TSearchRec SearchRec;
  1832. bool FindOK;
  1833. FILE_OPERATION_LOOP (DirectoryName, FMTLOAD(LIST_DIR_ERROR, (DirectoryName)),
  1834. FindOK = (bool)(FindFirst(DirectoryName + "*.*",
  1835. FindAttrs, SearchRec) == 0);
  1836. );
  1837. while (FindOK && !OperationProgress->Cancel)
  1838. {
  1839. AnsiString FileName = DirectoryName + SearchRec.Name;
  1840. try
  1841. {
  1842. if ((SearchRec.Name != ".") && (SearchRec.Name != ".."))
  1843. {
  1844. SFTPSource(FileName, DestFullName, CopyParam, Params, OperationProgress);
  1845. }
  1846. }
  1847. catch (EScpSkipFile &E)
  1848. {
  1849. // If ESkipFile occurs, just log it and continue with next file
  1850. SUSPEND_OPERATION (
  1851. if (FTerminal->DoQueryUser(FMTLOAD(COPY_ERROR, (FileName)), E.Message,
  1852. qaOK | qaAbort, 0) == qaAbort)
  1853. {
  1854. OperationProgress->Cancel = csCancel;
  1855. }
  1856. if (!FTerminal->HandleException(&E)) throw;
  1857. );
  1858. }
  1859. FILE_OPERATION_LOOP (DirectoryName, FMTLOAD(LIST_DIR_ERROR, (DirectoryName)),
  1860. FindOK = (FindNext(SearchRec) == 0);
  1861. );
  1862. };
  1863. FindClose(SearchRec);
  1864. /* TODO : Delete also read-only directories. */
  1865. /* TODO : Show error message on failure. */
  1866. if ((Params & cpDelete) && !OperationProgress->Cancel) RemoveDir(DirectoryName);
  1867. }
  1868. //---------------------------------------------------------------------------
  1869. void __fastcall TSFTPFileSystem::CopyToLocal(TStrings * FilesToCopy,
  1870. const AnsiString TargetDir, const TCopyParamType * CopyParam,
  1871. int Params, TFileOperationProgressType * OperationProgress,
  1872. bool & DisconnectWhenComplete)
  1873. {
  1874. assert(FilesToCopy && OperationProgress);
  1875. AnsiString FileName, FileNameOnly;
  1876. AnsiString FullTargetDir = IncludeTrailingBackslash(TargetDir);
  1877. const TRemoteFile * File;
  1878. bool Success;
  1879. int Index = 0;
  1880. while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
  1881. {
  1882. Success = false;
  1883. FileName = FilesToCopy->Strings[Index];
  1884. FileNameOnly = UnixExtractFileName(FileName);
  1885. File = (TRemoteFile *)FilesToCopy->Objects[Index];
  1886. assert(!FAvoidBusy);
  1887. FAvoidBusy = true;
  1888. try
  1889. {
  1890. try
  1891. {
  1892. SFTPSink(LocalCanonify(FileName), File, FullTargetDir, CopyParam,
  1893. Params, OperationProgress);
  1894. Success = true;
  1895. }
  1896. catch(EScpSkipFile & E)
  1897. {
  1898. SUSPEND_OPERATION (
  1899. if (!FTerminal->HandleException(&E)) throw;
  1900. );
  1901. }
  1902. /*catch(...)
  1903. {
  1904. throw;
  1905. } */
  1906. }
  1907. __finally
  1908. {
  1909. FAvoidBusy = false;
  1910. OperationProgress->Finish(FileNameOnly, Success, DisconnectWhenComplete);
  1911. }
  1912. Index++;
  1913. }
  1914. }
  1915. //---------------------------------------------------------------------------
  1916. void __fastcall TSFTPFileSystem::SFTPSink(const AnsiString FileName,
  1917. const TRemoteFile * File, const AnsiString TargetDir,
  1918. const TCopyParamType * CopyParam, int Params,
  1919. TFileOperationProgressType * OperationProgress)
  1920. {
  1921. assert(File);
  1922. FTerminal->LogEvent(FORMAT("File: \"%s\"", (FileName)));
  1923. AnsiString OnlyFileName = UnixExtractFileName(FileName);
  1924. OperationProgress->SetFile(OnlyFileName);
  1925. AnsiString DestFileName = CopyParam->ChangeFileName(OnlyFileName, osRemote);
  1926. AnsiString DestFullName = TargetDir + DestFileName;
  1927. if (File->IsDirectory)
  1928. {
  1929. FILE_OPERATION_LOOP (DestFullName, FMTLOAD(NOT_DIRECTORY_ERROR, (DestFullName)),
  1930. int Attrs = FileGetAttr(DestFullName);
  1931. if ((Attrs & faDirectory) == 0) EXCEPTION;
  1932. );
  1933. FILE_OPERATION_LOOP (DestFullName, FMTLOAD(CREATE_DIR_ERROR, (DestFullName)),
  1934. if (!ForceDirectories(DestFullName)) EXCEPTION;
  1935. );
  1936. TSinkFileParams SinkFileParams;
  1937. SinkFileParams.TargetDir = IncludeTrailingBackslash(DestFullName);
  1938. SinkFileParams.CopyParam = CopyParam;
  1939. SinkFileParams.Params = Params;
  1940. SinkFileParams.OperationProgress = OperationProgress;
  1941. SinkFileParams.Skipped = false;
  1942. FTerminal->ProcessDirectory(FileName, SFTPSinkFile, &SinkFileParams);
  1943. // Do not delete directory if some of its files were skip.
  1944. // Throw "skip file" for the directory to avoid attempt to deletion
  1945. // of any parent directory
  1946. if ((Params & cpDelete) && SinkFileParams.Skipped)
  1947. {
  1948. THROW_SKIP_FILE_NULL;
  1949. }
  1950. }
  1951. else
  1952. {
  1953. FTerminal->LogEvent(FORMAT("Copying \"%s\" to local directory started.", (FileName)));
  1954. AnsiString DestPartinalFullName;
  1955. bool ResumeAllowed;
  1956. bool ResumeTransfer = false;
  1957. //bool DestFileExists = false;
  1958. __int64 ResumeOffset;
  1959. // Will we use ASCII of BINARY file tranfer?
  1960. OperationProgress->SetAsciiTransfer(CopyParam->UseAsciiTransfer(DestFileName));
  1961. FTerminal->LogEvent(AnsiString((OperationProgress->AsciiTransfer ? "Ascii" : "Binary")) +
  1962. " transfer mode selected.");
  1963. // Suppose same data size to transfer as to write
  1964. // (not true with ASCII transfer)
  1965. OperationProgress->SetTransferSize(File->Size);
  1966. OperationProgress->SetLocalSize(OperationProgress->TransferSize);
  1967. // resume has no sense for drag&drop downloads, because files are downloaded
  1968. // to temp directory, but anyway TTerminal does know this, so the condition
  1969. // placement is currently wrong.
  1970. ResumeAllowed = ((Params & cpDragDrop) == 0) &&
  1971. !OperationProgress->AsciiTransfer &&
  1972. CopyParam->AllowResume(OperationProgress->TransferSize);
  1973. OperationProgress->SetResumeStatus(ResumeAllowed ? rsEnabled : rsDisabled);
  1974. int Attrs;
  1975. FILE_OPERATION_LOOP (DestFullName, FMTLOAD(NOT_FILE_ERROR, (DestFullName)),
  1976. Attrs = FileGetAttr(DestFullName);
  1977. if ((Attrs >= 0) && (Attrs & faDirectory)) EXCEPTION;
  1978. );
  1979. OperationProgress->TransferingFile = false; // not set with SFTP protocol
  1980. HANDLE LocalHandle = NULL;
  1981. TStream * FileStream = NULL;
  1982. bool DeleteLocalFile = false;
  1983. AnsiString RemoteHandle;
  1984. AnsiString LocalFileName = DestFullName;
  1985. try
  1986. {
  1987. if (ResumeAllowed)
  1988. {
  1989. DestPartinalFullName = DestFullName + FTerminal->Configuration->PartialExt;
  1990. LocalFileName = DestPartinalFullName;
  1991. FTerminal->LogEvent("Checking existence of partially transfered file.");
  1992. if (FileExists(DestPartinalFullName))
  1993. {
  1994. FTerminal->OpenLocalFile(DestPartinalFullName, GENERIC_WRITE,
  1995. NULL, &LocalHandle, NULL, NULL, NULL, &ResumeOffset);
  1996. ResumeTransfer = SFTPConfirmResume(DestFileName,
  1997. ResumeOffset > OperationProgress->TransferSize, OperationProgress);
  1998. if (!ResumeTransfer)
  1999. {
  2000. CloseHandle(LocalHandle);
  2001. LocalHandle = NULL;
  2002. Sysutils::DeleteFile(DestPartinalFullName);
  2003. }
  2004. else
  2005. {
  2006. FTerminal->LogEvent("Resuming file transfer.");
  2007. FileSeek((THandle)LocalHandle, ResumeOffset, 0);
  2008. OperationProgress->AddResumed(ResumeOffset);
  2009. }
  2010. }
  2011. }
  2012. if (Attrs >= 0 && FTerminal->Configuration->ConfirmOverwriting &&
  2013. !OperationProgress->YesToAll && !ResumeTransfer &&
  2014. !(Params & cpNoConfirmation))
  2015. {
  2016. FTerminal->LogEvent("Checking existence of file.");
  2017. SFTPConfirmOverwrite(DestFileName, OperationProgress);
  2018. }
  2019. // if not resuming, create new empty file
  2020. if (!ResumeTransfer)
  2021. {
  2022. // Create file
  2023. FILE_OPERATION_LOOP (DestFullName, FMTLOAD(CREATE_FILE_ERROR, (DestFullName)),
  2024. LocalHandle = CreateFile(LocalFileName.c_str(), GENERIC_WRITE, 0, NULL,
  2025. CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
  2026. if (LocalHandle == INVALID_HANDLE_VALUE) EXCEPTION;
  2027. );
  2028. }
  2029. assert(LocalHandle);
  2030. DeleteLocalFile = true;
  2031. FTerminal->LogEvent("Opening remote file.");
  2032. FILE_OPERATION_LOOP (FileName, FMTLOAD(SFTP_OPEN_FILE_ERROR, (FileName)),
  2033. TSFTPPacket Packet;
  2034. Packet.ChangeType(SSH_FXP_OPEN);
  2035. Packet.AddString(FileName);
  2036. int OpenType = SSH_FXF_READ;
  2037. if ((FVersion >= 4) && OperationProgress->AsciiTransfer)
  2038. {
  2039. OpenType |= SSH_FXF_TEXT;
  2040. }
  2041. Packet.AddCardinal(OpenType);
  2042. Packet.AddCardinal(0); // no attrs
  2043. if (FVersion >= 4)
  2044. {
  2045. Packet.AddCardinal(SSH_FILEXFER_TYPE_REGULAR);
  2046. }
  2047. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  2048. RemoteHandle = Packet.GetString();
  2049. );
  2050. FileStream = new THandleStream((THandle)LocalHandle);
  2051. TSFTPPacket DataPacket;
  2052. bool Eof = false;
  2053. while (!Eof)
  2054. {
  2055. // Buffer for one block of data
  2056. TFileBuffer BlockBuf;
  2057. unsigned long BlockSize = OperationProgress->StaticBlockSize();
  2058. FILE_OPERATION_LOOP(FileName,
  2059. FMTLOAD(READ_ERROR, (FileName)),
  2060. DataPacket.ChangeType(SSH_FXP_READ);
  2061. DataPacket.AddString(RemoteHandle);
  2062. DataPacket.AddInt64(OperationProgress->TransferedSize);
  2063. DataPacket.AddCardinal(BlockSize);
  2064. SendPacketAndReceiveResponse(&DataPacket, &DataPacket,
  2065. SSH_FXP_DATA, asEOF);
  2066. if (DataPacket.Type == SSH_FXP_STATUS)
  2067. {
  2068. // must be SSH_FX_EOF, any other status packet would raise exception
  2069. Eof = true;
  2070. }
  2071. );
  2072. if (!Eof)
  2073. {
  2074. unsigned long DataLen = DataPacket.GetCardinal();
  2075. assert(DataLen <= BlockSize);
  2076. BlockBuf.Insert(0, DataPacket.NextData, DataLen);
  2077. OperationProgress->AddTransfered(DataLen);
  2078. if (OperationProgress->AsciiTransfer)
  2079. {
  2080. assert(!ResumeTransfer && !ResumeAllowed);
  2081. unsigned int PrevBlockSize = BlockBuf.Size;
  2082. BlockBuf.ConvertEOL(GetEOL(),
  2083. FTerminal->Configuration->LocalEOLType);
  2084. OperationProgress->SetLocalSize(
  2085. OperationProgress->LocalSize - PrevBlockSize + BlockBuf.Size);
  2086. }
  2087. FILE_OPERATION_LOOP (
  2088. DestFullName, FMTLOAD(WRITE_ERROR, (LocalFileName)),
  2089. BlockBuf.WriteToStream(FileStream, BlockBuf.Size);
  2090. );
  2091. OperationProgress->AddLocalyUsed(BlockBuf.Size);
  2092. if (OperationProgress->Cancel == csCancel)
  2093. {
  2094. Abort();
  2095. }
  2096. }
  2097. };
  2098. if (CopyParam->PreserveTime)
  2099. {
  2100. FILETIME AcTime = DateTimeToFileTime(File->LastAccess);
  2101. FILETIME WrTime = DateTimeToFileTime(File->Modification);
  2102. SetFileTime(LocalHandle, NULL, &AcTime, &WrTime);
  2103. }
  2104. CloseHandle(LocalHandle);
  2105. LocalHandle = NULL;
  2106. if (ResumeAllowed)
  2107. {
  2108. FILE_OPERATION_LOOP(DestFileName,
  2109. FMTLOAD(RENAME_AFTER_RESUME_ERROR,
  2110. (ExtractFileName(DestPartinalFullName), DestFileName)),
  2111. if (FileExists(DestFullName))
  2112. {
  2113. if (!Sysutils::DeleteFile(DestFullName)) EXCEPTION;
  2114. }
  2115. if (!Sysutils::RenameFile(DestPartinalFullName, DestFullName))
  2116. {
  2117. EXCEPTION;
  2118. }
  2119. );
  2120. }
  2121. DeleteLocalFile = false;
  2122. }
  2123. __finally
  2124. {
  2125. if (LocalHandle) CloseHandle(LocalHandle);
  2126. if (FileStream) delete FileStream;
  2127. if (DeleteLocalFile && (!ResumeAllowed || OperationProgress->LocalyUsed == 0))
  2128. {
  2129. Sysutils::DeleteFile(LocalFileName);
  2130. }
  2131. if (FTerminal->Active && !RemoteHandle.IsEmpty())
  2132. {
  2133. FILE_OPERATION_LOOP(FileName,
  2134. FMTLOAD(SFTP_CLOSE_FILE_ERROR, (DestFileName)),
  2135. TSFTPPacket CloseRequest(SSH_FXP_CLOSE);
  2136. CloseRequest.AddString(RemoteHandle);
  2137. SendPacketAndReceiveResponse(&CloseRequest, NULL, SSH_FXP_STATUS);
  2138. );
  2139. }
  2140. }
  2141. }
  2142. if (Params & cpDelete)
  2143. {
  2144. // If file is directory, do not delete it recursively, because it should be
  2145. // empty already. If not, it should not be deleted (some files were
  2146. // skipped or some new files were copied to it, while we were downloading)
  2147. bool Recursive = false;
  2148. FTerminal->DeleteFile(FileName, File, &Recursive);
  2149. }
  2150. }
  2151. //---------------------------------------------------------------------------
  2152. void __fastcall TSFTPFileSystem::SFTPSinkFile(AnsiString FileName,
  2153. const TRemoteFile * File, void * Param)
  2154. {
  2155. TSinkFileParams * Params = (TSinkFileParams *)Param;
  2156. assert(Params->OperationProgress);
  2157. try
  2158. {
  2159. SFTPSink(FileName, File, Params->TargetDir, Params->CopyParam,
  2160. Params->Params, Params->OperationProgress);
  2161. }
  2162. catch(EScpSkipFile & E)
  2163. {
  2164. TFileOperationProgressType * OperationProgress = Params->OperationProgress;
  2165. Params->Skipped = true;
  2166. SUSPEND_OPERATION (
  2167. if (!FTerminal->HandleException(&E)) throw;
  2168. );
  2169. if (OperationProgress->Cancel)
  2170. {
  2171. Abort();
  2172. }
  2173. }
  2174. }