SftpFileSystem.cpp 70 KB

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