SessionInfo.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include <stdio.h>
  5. #include <lmcons.h>
  6. #define SECURITY_WIN32
  7. #include <sspi.h>
  8. #include <secext.h>
  9. #include "Common.h"
  10. #include "SessionInfo.h"
  11. #include "Exceptions.h"
  12. #include "TextsCore.h"
  13. #include "CoreMain.h"
  14. #include "Script.h"
  15. #include <System.IOUtils.hpp>
  16. //---------------------------------------------------------------------------
  17. #pragma package(smart_init)
  18. //---------------------------------------------------------------------------
  19. UnicodeString __fastcall DoXmlEscape(UnicodeString Str, bool NewLine)
  20. {
  21. for (int i = 1; i <= Str.Length(); i++)
  22. {
  23. UnicodeString Repl;
  24. switch (Str[i])
  25. {
  26. case L'\x00': // \0 Is not valid in XML anyway
  27. case L'\x01':
  28. case L'\x02':
  29. case L'\x03':
  30. case L'\x04':
  31. case L'\x05':
  32. case L'\x06':
  33. case L'\x07':
  34. case L'\x08':
  35. // \n is handled below
  36. case L'\x0B':
  37. case L'\x0C':
  38. // \r is handled below
  39. case L'\x0E':
  40. case L'\x0F':
  41. case L'\x10':
  42. case L'\x11':
  43. case L'\x12':
  44. case L'\x13':
  45. case L'\x14':
  46. case L'\x15':
  47. case L'\x16':
  48. case L'\x17':
  49. case L'\x18':
  50. case L'\x19':
  51. case L'\x1A':
  52. case L'\x1B':
  53. case L'\x1C':
  54. case L'\x1D':
  55. case L'\x1E':
  56. case L'\x1F':
  57. Repl = L"#x" + ByteToHex((unsigned char)Str[i]) + L";";
  58. break;
  59. case L'&':
  60. Repl = L"amp;";
  61. break;
  62. case L'>':
  63. Repl = L"gt;";
  64. break;
  65. case L'<':
  66. Repl = L"lt;";
  67. break;
  68. case L'"':
  69. Repl = L"quot;";
  70. break;
  71. case L'\n':
  72. if (NewLine)
  73. {
  74. Repl = L"#10;";
  75. }
  76. break;
  77. case L'\r':
  78. Str.Delete(i, 1);
  79. i--;
  80. break;
  81. }
  82. if (!Repl.IsEmpty())
  83. {
  84. Str[i] = L'&';
  85. Str.Insert(Repl, i + 1);
  86. i += Repl.Length();
  87. }
  88. }
  89. return Str;
  90. }
  91. //---------------------------------------------------------------------------
  92. UnicodeString __fastcall XmlEscape(UnicodeString Str)
  93. {
  94. return DoXmlEscape(Str, false);
  95. }
  96. //---------------------------------------------------------------------------
  97. UnicodeString __fastcall XmlAttributeEscape(UnicodeString Str)
  98. {
  99. return DoXmlEscape(Str, true);
  100. }
  101. //---------------------------------------------------------------------------
  102. //---------------------------------------------------------------------------
  103. #pragma warn -inl
  104. class TSessionActionRecord
  105. {
  106. public:
  107. __fastcall TSessionActionRecord(TActionLog * Log, TLogAction Action) :
  108. FLog(Log),
  109. FAction(Action),
  110. FState(Opened),
  111. FRecursive(false),
  112. FErrorMessages(NULL),
  113. FNames(new TStringList()),
  114. FValues(new TStringList()),
  115. FFileList(NULL),
  116. FFile(NULL)
  117. {
  118. FLog->AddPendingAction(this);
  119. }
  120. __fastcall ~TSessionActionRecord()
  121. {
  122. delete FErrorMessages;
  123. delete FNames;
  124. delete FValues;
  125. delete FFileList;
  126. delete FFile;
  127. }
  128. void __fastcall Restart()
  129. {
  130. FState = Opened;
  131. FRecursive = false;
  132. delete FErrorMessages;
  133. FErrorMessages = NULL;
  134. delete FFileList;
  135. FFileList = NULL;
  136. delete FFile;
  137. FFile = NULL;
  138. FNames->Clear();
  139. FValues->Clear();
  140. }
  141. bool __fastcall Record()
  142. {
  143. bool Result = (FState != Opened);
  144. if (Result)
  145. {
  146. if (FLog->FLogging && (FState != Cancelled))
  147. {
  148. const wchar_t * Name = ActionName();
  149. UnicodeString Attrs;
  150. if (FRecursive)
  151. {
  152. Attrs = L" recursive=\"true\"";
  153. }
  154. FLog->AddIndented(FORMAT(L"<%s%s>", (Name, Attrs)));
  155. for (int Index = 0; Index < FNames->Count; Index++)
  156. {
  157. UnicodeString Value = FValues->Strings[Index];
  158. if (Value.IsEmpty())
  159. {
  160. FLog->AddIndented(FORMAT(L" <%s />", (FNames->Strings[Index])));
  161. }
  162. else
  163. {
  164. FLog->AddIndented(FORMAT(L" <%s value=\"%s\" />",
  165. (FNames->Strings[Index], XmlAttributeEscape(Value))));
  166. }
  167. }
  168. if (FFileList != NULL)
  169. {
  170. FLog->AddIndented(L" <files>");
  171. for (int Index = 0; Index < FFileList->Count; Index++)
  172. {
  173. TRemoteFile * File = FFileList->Files[Index];
  174. RecordFile(L" ", File, true);
  175. }
  176. FLog->AddIndented(L" </files>");
  177. }
  178. if (FFile != NULL)
  179. {
  180. RecordFile(L" ", FFile, false);
  181. }
  182. if (FState == RolledBack)
  183. {
  184. if (FErrorMessages != NULL)
  185. {
  186. FLog->AddIndented(L" <result success=\"false\">");
  187. FLog->AddMessages(L" ", FErrorMessages);
  188. FLog->AddIndented(L" </result>");
  189. }
  190. else
  191. {
  192. FLog->AddIndented(L" <result success=\"false\" />");
  193. }
  194. }
  195. else
  196. {
  197. FLog->AddIndented(L" <result success=\"true\" />");
  198. }
  199. FLog->AddIndented(FORMAT(L"</%s>", (Name)));
  200. }
  201. delete this;
  202. }
  203. return Result;
  204. }
  205. void __fastcall Commit()
  206. {
  207. Close(Committed);
  208. }
  209. void __fastcall Rollback(Exception * E)
  210. {
  211. DebugAssert(FErrorMessages == NULL);
  212. FErrorMessages = ExceptionToMoreMessages(E);
  213. Close(RolledBack);
  214. }
  215. void __fastcall Cancel()
  216. {
  217. Close(Cancelled);
  218. }
  219. void __fastcall FileName(const UnicodeString & FileName)
  220. {
  221. Parameter(L"filename", FileName);
  222. }
  223. void __fastcall Destination(const UnicodeString & Destination)
  224. {
  225. Parameter(L"destination", Destination);
  226. }
  227. void __fastcall Rights(const TRights & Rights)
  228. {
  229. Parameter(L"permissions", Rights.Text);
  230. }
  231. void __fastcall Modification(const TDateTime & DateTime)
  232. {
  233. Parameter(L"modification", StandardTimestamp(DateTime));
  234. }
  235. void __fastcall Recursive()
  236. {
  237. FRecursive = true;
  238. }
  239. void __fastcall Command(const UnicodeString & Command)
  240. {
  241. Parameter(L"command", Command);
  242. }
  243. void __fastcall AddOutput(UnicodeString Output, bool StdError)
  244. {
  245. const wchar_t * Name = (StdError ? L"erroroutput" : L"output");
  246. int Index = FNames->IndexOf(Name);
  247. if (Index >= 0)
  248. {
  249. FValues->Strings[Index] = FValues->Strings[Index] + L"\r\n" + Output;
  250. }
  251. else
  252. {
  253. Parameter(Name, Output);
  254. }
  255. }
  256. void __fastcall ExitCode(int ExitCode)
  257. {
  258. Parameter(L"exitcode", IntToStr(ExitCode));
  259. }
  260. void __fastcall Checksum(const UnicodeString & Alg, const UnicodeString & Checksum)
  261. {
  262. Parameter(L"algorithm", Alg);
  263. Parameter(L"checksum", Checksum);
  264. }
  265. void __fastcall Cwd(const UnicodeString & Path)
  266. {
  267. Parameter(L"cwd", Path);
  268. }
  269. void __fastcall FileList(TRemoteFileList * FileList)
  270. {
  271. if (FFileList == NULL)
  272. {
  273. FFileList = new TRemoteFileList();
  274. }
  275. FileList->DuplicateTo(FFileList);
  276. }
  277. void __fastcall File(TRemoteFile * File)
  278. {
  279. if (FFile != NULL)
  280. {
  281. delete FFile;
  282. }
  283. FFile = File->Duplicate(true);
  284. }
  285. void __fastcall SynchronizeChecklistItem(const TSynchronizeChecklist::TItem * Item)
  286. {
  287. UnicodeString Action;
  288. bool RecordLocal = false;
  289. bool RecordRemote = false;
  290. switch (Item->Action)
  291. {
  292. case TSynchronizeChecklist::saUploadNew:
  293. Action = L"uploadnew";
  294. RecordLocal = true;
  295. break;
  296. case TSynchronizeChecklist::saDownloadNew:
  297. Action = L"downloadnew";
  298. RecordRemote = true;
  299. break;
  300. case TSynchronizeChecklist::saUploadUpdate:
  301. Action = L"uploadupdate";
  302. RecordLocal = true;
  303. RecordRemote = true;
  304. break;
  305. case TSynchronizeChecklist::saDownloadUpdate:
  306. Action = L"downloadupdate";
  307. RecordLocal = true;
  308. RecordRemote = true;
  309. break;
  310. case TSynchronizeChecklist::saDeleteRemote:
  311. Action = L"deleteremote";
  312. RecordRemote = true;
  313. break;
  314. case TSynchronizeChecklist::saDeleteLocal:
  315. Action = L"deletelocal";
  316. RecordLocal = true;
  317. break;
  318. default:
  319. DebugFail();
  320. break;
  321. }
  322. Parameter(L"action", Action);
  323. if (RecordLocal)
  324. {
  325. UnicodeString FileName = TPath::Combine(Item->Local.Directory, Item->Local.FileName);
  326. SynchronizeChecklistItemFileInfo(FileName, Item->IsDirectory, Item->Local);
  327. }
  328. if (RecordRemote)
  329. {
  330. UnicodeString FileName = UnixCombinePaths(Item->Remote.Directory, Item->Remote.FileName);
  331. SynchronizeChecklistItemFileInfo(FileName, Item->IsDirectory, Item->Remote);
  332. }
  333. }
  334. protected:
  335. enum TState { Opened, Committed, RolledBack, Cancelled };
  336. inline void __fastcall Close(TState State)
  337. {
  338. DebugAssert(FState == Opened);
  339. FState = State;
  340. FLog->RecordPendingActions();
  341. }
  342. const wchar_t * __fastcall ActionName()
  343. {
  344. switch (FAction)
  345. {
  346. case laUpload: return L"upload";
  347. case laDownload: return L"download";
  348. case laTouch: return L"touch";
  349. case laChmod: return L"chmod";
  350. case laMkdir: return L"mkdir";
  351. case laRm: return L"rm";
  352. case laMv: return L"mv";
  353. case laCp: return L"cp";
  354. case laCall: return L"call";
  355. case laLs: return L"ls";
  356. case laStat: return L"stat";
  357. case laChecksum: return L"checksum";
  358. case laCwd: return L"cwd";
  359. case laDifference: return L"difference";
  360. default: DebugFail(); return L"";
  361. }
  362. }
  363. void __fastcall Parameter(const UnicodeString & Name, const UnicodeString & Value = L"")
  364. {
  365. FNames->Add(Name);
  366. FValues->Add(Value);
  367. }
  368. void __fastcall RecordFile(const UnicodeString & Indent, TRemoteFile * File, bool IncludeFileName)
  369. {
  370. FLog->AddIndented(Indent + L"<file>");
  371. FLog->AddIndented(Indent + FORMAT(L" <filename value=\"%s\" />", (XmlAttributeEscape(File->FileName))));
  372. FLog->AddIndented(Indent + FORMAT(L" <type value=\"%s\" />", (XmlAttributeEscape(towupper(File->Type)))));
  373. if (!File->IsDirectory)
  374. {
  375. FLog->AddIndented(Indent + FORMAT(L" <size value=\"%s\" />", (IntToStr(File->Size))));
  376. }
  377. if (File->ModificationFmt != mfNone)
  378. {
  379. FLog->AddIndented(Indent + FORMAT(L" <modification value=\"%s\" />", (StandardTimestamp(File->Modification))));
  380. }
  381. if (!File->Rights->Unknown)
  382. {
  383. FLog->AddIndented(Indent + FORMAT(L" <permissions value=\"%s\" />", (XmlAttributeEscape(File->Rights->Text))));
  384. }
  385. if (File->Owner.IsSet)
  386. {
  387. FLog->AddIndented(Indent + FORMAT(L" <owner value=\"%s\" />", (XmlAttributeEscape(File->Owner.DisplayText))));
  388. }
  389. if (File->Group.IsSet)
  390. {
  391. FLog->AddIndented(Indent + FORMAT(L" <group value=\"%s\" />", (XmlAttributeEscape(File->Group.DisplayText))));
  392. }
  393. FLog->AddIndented(Indent + L"</file>");
  394. }
  395. void __fastcall SynchronizeChecklistItemFileInfo(
  396. const UnicodeString & AFileName, bool IsDirectory, const TSynchronizeChecklist::TItem::TFileInfo FileInfo)
  397. {
  398. Parameter(L"type", (IsDirectory ? L'D' : L'-'));
  399. FileName(AFileName);
  400. if (!IsDirectory)
  401. {
  402. Parameter(L"size", IntToStr(FileInfo.Size));
  403. }
  404. if (FileInfo.ModificationFmt != mfNone)
  405. {
  406. Modification(FileInfo.Modification);
  407. }
  408. }
  409. private:
  410. TActionLog * FLog;
  411. TLogAction FAction;
  412. TState FState;
  413. bool FRecursive;
  414. TStrings * FErrorMessages;
  415. TStrings * FNames;
  416. TStrings * FValues;
  417. TRemoteFileList * FFileList;
  418. TRemoteFile * FFile;
  419. };
  420. #pragma warn .inl
  421. //---------------------------------------------------------------------------
  422. //---------------------------------------------------------------------------
  423. __fastcall TSessionAction::TSessionAction(TActionLog * Log, TLogAction Action)
  424. {
  425. FCancelled = false;
  426. if (Log->FLogging)
  427. {
  428. FRecord = new TSessionActionRecord(Log, Action);
  429. }
  430. else
  431. {
  432. FRecord = NULL;
  433. }
  434. }
  435. //---------------------------------------------------------------------------
  436. __fastcall TSessionAction::~TSessionAction()
  437. {
  438. if (FRecord != NULL)
  439. {
  440. TSessionActionRecord * Record = FRecord;
  441. FRecord = NULL;
  442. Record->Commit();
  443. }
  444. }
  445. //---------------------------------------------------------------------------
  446. void __fastcall TSessionAction::Restart()
  447. {
  448. if (FRecord != NULL)
  449. {
  450. FRecord->Restart();
  451. }
  452. }
  453. //---------------------------------------------------------------------------
  454. void __fastcall TSessionAction::Rollback(Exception * E)
  455. {
  456. if (FRecord != NULL)
  457. {
  458. TSessionActionRecord * Record = FRecord;
  459. FRecord = NULL;
  460. Record->Rollback(E);
  461. }
  462. }
  463. //---------------------------------------------------------------------------
  464. void __fastcall TSessionAction::Cancel()
  465. {
  466. if (FRecord != NULL)
  467. {
  468. TSessionActionRecord * Record = FRecord;
  469. FRecord = NULL;
  470. FCancelled = true;
  471. Record->Cancel();
  472. }
  473. }
  474. //---------------------------------------------------------------------------
  475. bool __fastcall TSessionAction::IsValid()
  476. {
  477. return !FCancelled;
  478. }
  479. //---------------------------------------------------------------------------
  480. //---------------------------------------------------------------------------
  481. __fastcall TFileSessionAction::TFileSessionAction(TActionLog * Log, TLogAction Action) :
  482. TSessionAction(Log, Action)
  483. {
  484. }
  485. //---------------------------------------------------------------------------
  486. __fastcall TFileSessionAction::TFileSessionAction(
  487. TActionLog * Log, TLogAction Action, const UnicodeString & AFileName) :
  488. TSessionAction(Log, Action)
  489. {
  490. FileName(AFileName);
  491. }
  492. //---------------------------------------------------------------------------
  493. void __fastcall TFileSessionAction::FileName(const UnicodeString & FileName)
  494. {
  495. if (FRecord != NULL)
  496. {
  497. FRecord->FileName(FileName);
  498. }
  499. }
  500. //---------------------------------------------------------------------------
  501. //---------------------------------------------------------------------------
  502. __fastcall TFileLocationSessionAction::TFileLocationSessionAction(
  503. TActionLog * Log, TLogAction Action) :
  504. TFileSessionAction(Log, Action)
  505. {
  506. }
  507. //---------------------------------------------------------------------------
  508. __fastcall TFileLocationSessionAction::TFileLocationSessionAction(
  509. TActionLog * Log, TLogAction Action, const UnicodeString & FileName) :
  510. TFileSessionAction(Log, Action, FileName)
  511. {
  512. }
  513. //---------------------------------------------------------------------------
  514. void __fastcall TFileLocationSessionAction::Destination(const UnicodeString & Destination)
  515. {
  516. if (FRecord != NULL)
  517. {
  518. FRecord->Destination(Destination);
  519. }
  520. }
  521. //---------------------------------------------------------------------------
  522. //---------------------------------------------------------------------------
  523. __fastcall TUploadSessionAction::TUploadSessionAction(TActionLog * Log) :
  524. TFileLocationSessionAction(Log, laUpload)
  525. {
  526. }
  527. //---------------------------------------------------------------------------
  528. //---------------------------------------------------------------------------
  529. __fastcall TDownloadSessionAction::TDownloadSessionAction(TActionLog * Log) :
  530. TFileLocationSessionAction(Log, laDownload)
  531. {
  532. }
  533. //---------------------------------------------------------------------------
  534. //---------------------------------------------------------------------------
  535. __fastcall TChmodSessionAction::TChmodSessionAction(
  536. TActionLog * Log, const UnicodeString & FileName) :
  537. TFileSessionAction(Log, laChmod, FileName)
  538. {
  539. }
  540. //---------------------------------------------------------------------------
  541. void __fastcall TChmodSessionAction::Recursive()
  542. {
  543. if (FRecord != NULL)
  544. {
  545. FRecord->Recursive();
  546. }
  547. }
  548. //---------------------------------------------------------------------------
  549. __fastcall TChmodSessionAction::TChmodSessionAction(
  550. TActionLog * Log, const UnicodeString & FileName, const TRights & ARights) :
  551. TFileSessionAction(Log, laChmod, FileName)
  552. {
  553. Rights(ARights);
  554. }
  555. //---------------------------------------------------------------------------
  556. void __fastcall TChmodSessionAction::Rights(const TRights & Rights)
  557. {
  558. if (FRecord != NULL)
  559. {
  560. FRecord->Rights(Rights);
  561. }
  562. }
  563. //---------------------------------------------------------------------------
  564. __fastcall TTouchSessionAction::TTouchSessionAction(
  565. TActionLog * Log, const UnicodeString & FileName, const TDateTime & Modification) :
  566. TFileSessionAction(Log, laTouch, FileName)
  567. {
  568. if (FRecord != NULL)
  569. {
  570. FRecord->Modification(Modification);
  571. }
  572. }
  573. //---------------------------------------------------------------------------
  574. __fastcall TMkdirSessionAction::TMkdirSessionAction(
  575. TActionLog * Log, const UnicodeString & FileName) :
  576. TFileSessionAction(Log, laMkdir, FileName)
  577. {
  578. }
  579. //---------------------------------------------------------------------------
  580. __fastcall TRmSessionAction::TRmSessionAction(
  581. TActionLog * Log, const UnicodeString & FileName) :
  582. TFileSessionAction(Log, laRm, FileName)
  583. {
  584. }
  585. //---------------------------------------------------------------------------
  586. void __fastcall TRmSessionAction::Recursive()
  587. {
  588. if (FRecord != NULL)
  589. {
  590. FRecord->Recursive();
  591. }
  592. }
  593. //---------------------------------------------------------------------------
  594. __fastcall TMvSessionAction::TMvSessionAction(TActionLog * Log,
  595. const UnicodeString & FileName, const UnicodeString & ADestination) :
  596. TFileLocationSessionAction(Log, laMv, FileName)
  597. {
  598. Destination(ADestination);
  599. }
  600. //---------------------------------------------------------------------------
  601. __fastcall TCpSessionAction::TCpSessionAction(TActionLog * Log,
  602. const UnicodeString & FileName, const UnicodeString & ADestination) :
  603. TFileLocationSessionAction(Log, laCp, FileName)
  604. {
  605. Destination(ADestination);
  606. }
  607. //---------------------------------------------------------------------------
  608. __fastcall TCallSessionAction::TCallSessionAction(TActionLog * Log,
  609. const UnicodeString & Command, const UnicodeString & Destination) :
  610. TSessionAction(Log, laCall)
  611. {
  612. if (FRecord != NULL)
  613. {
  614. FRecord->Command(Command);
  615. FRecord->Destination(Destination);
  616. }
  617. }
  618. //---------------------------------------------------------------------------
  619. void __fastcall TCallSessionAction::AddOutput(const UnicodeString & Output, bool StdError)
  620. {
  621. if (FRecord != NULL)
  622. {
  623. FRecord->AddOutput(Output, StdError);
  624. }
  625. }
  626. //---------------------------------------------------------------------------
  627. void __fastcall TCallSessionAction::ExitCode(int ExitCode)
  628. {
  629. if (FRecord != NULL)
  630. {
  631. FRecord->ExitCode(ExitCode);
  632. }
  633. }
  634. //---------------------------------------------------------------------------
  635. __fastcall TLsSessionAction::TLsSessionAction(TActionLog * Log,
  636. const UnicodeString & Destination) :
  637. TSessionAction(Log, laLs)
  638. {
  639. if (FRecord != NULL)
  640. {
  641. FRecord->Destination(Destination);
  642. }
  643. }
  644. //---------------------------------------------------------------------------
  645. void __fastcall TLsSessionAction::FileList(TRemoteFileList * FileList)
  646. {
  647. if (FRecord != NULL)
  648. {
  649. FRecord->FileList(FileList);
  650. }
  651. }
  652. //---------------------------------------------------------------------------
  653. //---------------------------------------------------------------------------
  654. __fastcall TStatSessionAction::TStatSessionAction(TActionLog * Log, const UnicodeString & FileName) :
  655. TFileSessionAction(Log, laStat, FileName)
  656. {
  657. }
  658. //---------------------------------------------------------------------------
  659. void __fastcall TStatSessionAction::File(TRemoteFile * File)
  660. {
  661. if (FRecord != NULL)
  662. {
  663. FRecord->File(File);
  664. }
  665. }
  666. //---------------------------------------------------------------------------
  667. //---------------------------------------------------------------------------
  668. __fastcall TChecksumSessionAction::TChecksumSessionAction(TActionLog * Log) :
  669. TFileSessionAction(Log, laChecksum)
  670. {
  671. }
  672. //---------------------------------------------------------------------------
  673. void __fastcall TChecksumSessionAction::Checksum(const UnicodeString & Alg, const UnicodeString & Checksum)
  674. {
  675. if (FRecord != NULL)
  676. {
  677. FRecord->Checksum(Alg, Checksum);
  678. }
  679. }
  680. //---------------------------------------------------------------------------
  681. //---------------------------------------------------------------------------
  682. __fastcall TCwdSessionAction::TCwdSessionAction(TActionLog * Log, const UnicodeString & Path) :
  683. TSessionAction(Log, laCwd)
  684. {
  685. if (FRecord != NULL)
  686. {
  687. FRecord->Cwd(Path);
  688. }
  689. }
  690. //---------------------------------------------------------------------------
  691. //---------------------------------------------------------------------------
  692. __fastcall TDifferenceSessionAction::TDifferenceSessionAction(TActionLog * Log, const TSynchronizeChecklist::TItem * Item) :
  693. TSessionAction(Log, laDifference)
  694. {
  695. if (FRecord != NULL)
  696. {
  697. FRecord->SynchronizeChecklistItem(Item);
  698. }
  699. }
  700. //---------------------------------------------------------------------------
  701. //---------------------------------------------------------------------------
  702. TSessionInfo::TSessionInfo()
  703. {
  704. LoginTime = Now();
  705. CertificateVerifiedManually = false;
  706. }
  707. //---------------------------------------------------------------------------
  708. TFileSystemInfo::TFileSystemInfo()
  709. {
  710. memset(&IsCapable, false, sizeof(IsCapable));
  711. }
  712. //---------------------------------------------------------------------------
  713. //---------------------------------------------------------------------------
  714. FILE * __fastcall OpenFile(UnicodeString LogFileName, TDateTime Started, TSessionData * SessionData, bool Append, UnicodeString & NewFileName)
  715. {
  716. FILE * Result;
  717. UnicodeString ANewFileName = GetExpandedLogFileName(LogFileName, Started, SessionData);
  718. Result = _wfopen(ApiPath(ANewFileName).c_str(), (Append ? L"ab" : L"wb"));
  719. if (Result != NULL)
  720. {
  721. setvbuf(Result, NULL, _IONBF, BUFSIZ);
  722. NewFileName = ANewFileName;
  723. }
  724. else
  725. {
  726. throw ECRTExtException(FMTLOAD(LOG_OPENERROR, (ANewFileName)));
  727. }
  728. return Result;
  729. }
  730. //---------------------------------------------------------------------------
  731. //---------------------------------------------------------------------------
  732. const wchar_t *LogLineMarks = L"<>!.*";
  733. __fastcall TSessionLog::TSessionLog(TSessionUI* UI, TDateTime Started, TSessionData * SessionData,
  734. TConfiguration * Configuration)
  735. {
  736. FCriticalSection = new TCriticalSection;
  737. FLogging = false;
  738. FConfiguration = Configuration;
  739. FParent = NULL;
  740. FUI = UI;
  741. FSessionData = SessionData;
  742. FStarted = Started;
  743. FFile = NULL;
  744. FCurrentLogFileName = L"";
  745. FCurrentFileName = L"";
  746. FClosed = false;
  747. }
  748. //---------------------------------------------------------------------------
  749. __fastcall TSessionLog::~TSessionLog()
  750. {
  751. FClosed = true;
  752. ReflectSettings();
  753. DebugAssert(FFile == NULL);
  754. delete FCriticalSection;
  755. }
  756. //---------------------------------------------------------------------------
  757. void __fastcall TSessionLog::SetParent(TSessionLog * Parent, const UnicodeString & Name)
  758. {
  759. FParent = Parent;
  760. FName = Name;
  761. }
  762. //---------------------------------------------------------------------------
  763. void __fastcall TSessionLog::DoAddToParent(TLogLineType Type, const UnicodeString & Line)
  764. {
  765. DebugAssert(FParent != NULL);
  766. FParent->Add(Type, Line);
  767. }
  768. //---------------------------------------------------------------------------
  769. void __fastcall TSessionLog::DoAddToSelf(TLogLineType Type, const UnicodeString & Line)
  770. {
  771. if (LogToFile())
  772. {
  773. if (FFile == NULL)
  774. {
  775. OpenLogFile();
  776. }
  777. if (FFile != NULL)
  778. {
  779. UnicodeString Timestamp = FormatDateTime(L" yyyy-mm-dd hh:nn:ss.zzz ", Now());
  780. UTF8String UtfLine = UTF8String(UnicodeString(LogLineMarks[Type]) + Timestamp + Line + L"\r\n");
  781. for (int Index = 1; Index <= UtfLine.Length(); Index++)
  782. {
  783. if ((UtfLine[Index] == '\n') &&
  784. ((Index == 1) || (UtfLine[Index - 1] != '\r')))
  785. {
  786. UtfLine.Insert('\r', Index);
  787. }
  788. }
  789. int Writting = UtfLine.Length();
  790. CheckSize(Writting);
  791. FCurrentFileSize += fwrite(UtfLine.c_str(), 1, Writting, (FILE *)FFile);
  792. }
  793. }
  794. }
  795. //---------------------------------------------------------------------------
  796. UnicodeString __fastcall TSessionLog::LogPartFileName(const UnicodeString & BaseName, int Index)
  797. {
  798. UnicodeString Result;
  799. if (Index >= 1)
  800. {
  801. Result = FORMAT(L"%s.%d", (BaseName, Index));
  802. }
  803. else
  804. {
  805. Result = BaseName;
  806. }
  807. return Result;
  808. }
  809. //---------------------------------------------------------------------------
  810. void __fastcall TSessionLog::CheckSize(__int64 Addition)
  811. {
  812. __int64 MaxSize = FConfiguration->LogMaxSize;
  813. if ((MaxSize > 0) && (FCurrentFileSize + Addition >= MaxSize))
  814. {
  815. // Before we close it
  816. UnicodeString BaseName = FCurrentFileName;
  817. CloseLogFile();
  818. FCurrentFileSize = 0;
  819. int Index = 0;
  820. while (FileExists(LogPartFileName(BaseName, Index + 1)))
  821. {
  822. Index++;
  823. }
  824. int MaxCount = FConfiguration->LogMaxCount;
  825. do
  826. {
  827. UnicodeString LogPart = LogPartFileName(BaseName, Index);
  828. if ((MaxCount > 0) && (Index >= MaxCount))
  829. {
  830. DeleteFileChecked(LogPart);
  831. }
  832. else
  833. {
  834. THROWOSIFFALSE(RenameFile(LogPart, LogPartFileName(BaseName, Index + 1)));
  835. }
  836. Index--;
  837. }
  838. while (Index >= 0);
  839. OpenLogFile();
  840. }
  841. }
  842. //---------------------------------------------------------------------------
  843. void __fastcall TSessionLog::DoAdd(TLogLineType Type, UnicodeString Line,
  844. void __fastcall (__closure *f)(TLogLineType Type, const UnicodeString & Line))
  845. {
  846. UnicodeString Prefix;
  847. if (!FName.IsEmpty())
  848. {
  849. Prefix = L"[" + FName + L"] ";
  850. }
  851. while (!Line.IsEmpty())
  852. {
  853. f(Type, Prefix + CutToChar(Line, L'\n', false));
  854. }
  855. }
  856. //---------------------------------------------------------------------------
  857. void __fastcall TSessionLog::Add(TLogLineType Type, const UnicodeString & Line)
  858. {
  859. DebugAssert(FConfiguration);
  860. if (Logging)
  861. {
  862. try
  863. {
  864. if (FParent != NULL)
  865. {
  866. DoAdd(Type, Line, DoAddToParent);
  867. }
  868. else
  869. {
  870. TGuard Guard(FCriticalSection);
  871. DoAdd(Type, Line, DoAddToSelf);
  872. }
  873. }
  874. catch (Exception &E)
  875. {
  876. // We failed logging, turn it off and notify user.
  877. FConfiguration->Logging = false;
  878. try
  879. {
  880. throw ExtException(&E, MainInstructions(LoadStr(LOG_GEN_ERROR)));
  881. }
  882. catch (Exception &E)
  883. {
  884. AddException(&E);
  885. FUI->HandleExtendedException(&E);
  886. }
  887. }
  888. }
  889. }
  890. //---------------------------------------------------------------------------
  891. void __fastcall TSessionLog::AddException(Exception * E)
  892. {
  893. if (E != NULL)
  894. {
  895. Add(llException, ExceptionLogString(E));
  896. }
  897. }
  898. //---------------------------------------------------------------------------
  899. void __fastcall TSessionLog::ReflectSettings()
  900. {
  901. TGuard Guard(FCriticalSection);
  902. FLogging =
  903. !FClosed &&
  904. ((FParent != NULL) || FConfiguration->Logging);
  905. // if logging to file was turned off or log file was changed -> close current log file
  906. if ((FFile != NULL) &&
  907. (!LogToFile() || (FCurrentLogFileName != FConfiguration->LogFileName)))
  908. {
  909. CloseLogFile();
  910. }
  911. if (FFile != NULL)
  912. {
  913. CheckSize(0);
  914. }
  915. }
  916. //---------------------------------------------------------------------------
  917. bool __fastcall TSessionLog::LogToFile()
  918. {
  919. return Logging && FConfiguration->LogToFile && (FParent == NULL);
  920. }
  921. //---------------------------------------------------------------------------
  922. void __fastcall TSessionLog::CloseLogFile()
  923. {
  924. if (FFile != NULL)
  925. {
  926. fclose((FILE *)FFile);
  927. FFile = NULL;
  928. }
  929. FCurrentLogFileName = L"";
  930. FCurrentFileName = L"";
  931. }
  932. //---------------------------------------------------------------------------
  933. void __fastcall TSessionLog::OpenLogFile()
  934. {
  935. try
  936. {
  937. DebugAssert(FFile == NULL);
  938. DebugAssert(FConfiguration != NULL);
  939. FCurrentLogFileName = FConfiguration->LogFileName;
  940. FFile = OpenFile(FCurrentLogFileName, FStarted, FSessionData, FConfiguration->LogFileAppend, FCurrentFileName);
  941. TSearchRec SearchRec;
  942. if (FileSearchRec(FCurrentFileName, SearchRec))
  943. {
  944. FCurrentFileSize = SearchRec.Size;
  945. }
  946. else
  947. {
  948. FCurrentFileSize = 0;
  949. }
  950. }
  951. catch (Exception & E)
  952. {
  953. // We failed logging to file, turn it off and notify user.
  954. FCurrentLogFileName = L"";
  955. FCurrentFileName = L"";
  956. FConfiguration->LogFileName = UnicodeString();
  957. try
  958. {
  959. throw ExtException(&E, MainInstructions(LoadStr(LOG_GEN_ERROR)));
  960. }
  961. catch (Exception & E)
  962. {
  963. AddException(&E);
  964. // not to deadlock with TSessionLog::ReflectSettings invoked by FConfiguration->LogFileName setter above
  965. TUnguard Unguard(FCriticalSection);
  966. FUI->HandleExtendedException(&E);
  967. }
  968. }
  969. // in case we are appending and the existing log file is already too large
  970. if (FFile != NULL)
  971. {
  972. CheckSize(0);
  973. }
  974. }
  975. //---------------------------------------------------------------------------
  976. void __fastcall TSessionLog::AddSystemInfo()
  977. {
  978. AddStartupInfo(true);
  979. }
  980. //---------------------------------------------------------------------------
  981. void __fastcall TSessionLog::AddStartupInfo()
  982. {
  983. AddStartupInfo(false);
  984. }
  985. //---------------------------------------------------------------------------
  986. void __fastcall TSessionLog::AddStartupInfo(bool System)
  987. {
  988. TSessionData * Data = (System ? NULL : FSessionData);
  989. if (Logging)
  990. {
  991. if (FParent != NULL)
  992. {
  993. // do not add session info for secondary session
  994. // (this should better be handled in the TSecondaryTerminal)
  995. }
  996. else
  997. {
  998. DoAddStartupInfo(Data);
  999. }
  1000. }
  1001. }
  1002. //---------------------------------------------------------------------------
  1003. UnicodeString __fastcall TSessionLog::GetTlsVersionName(TTlsVersion TlsVersion)
  1004. {
  1005. switch (TlsVersion)
  1006. {
  1007. default:
  1008. DebugFail();
  1009. case ssl2:
  1010. return "SSLv2";
  1011. case ssl3:
  1012. return "SSLv3";
  1013. case tls10:
  1014. return "TLSv1.0";
  1015. case tls11:
  1016. return "TLSv1.1";
  1017. case tls12:
  1018. return "TLSv1.2";
  1019. case tls13:
  1020. return "TLSv1.3";
  1021. }
  1022. }
  1023. //---------------------------------------------------------------------------
  1024. UnicodeString __fastcall TSessionLog::LogSensitive(const UnicodeString & Str)
  1025. {
  1026. if (FConfiguration->LogSensitive && !Str.IsEmpty())
  1027. {
  1028. return NormalizeString(Str);
  1029. }
  1030. else
  1031. {
  1032. return BooleanToEngStr(!Str.IsEmpty());
  1033. }
  1034. }
  1035. //---------------------------------------------------------------------------
  1036. UnicodeString __fastcall TSessionLog::GetCmdLineLog()
  1037. {
  1038. UnicodeString Result = CmdLine;
  1039. if (!Configuration->LogSensitive)
  1040. {
  1041. TManagementScript Script(StoredSessions, false);
  1042. Script.MaskPasswordInCommandLine(Result, true);
  1043. }
  1044. return Result;
  1045. }
  1046. //---------------------------------------------------------------------------
  1047. template <typename T>
  1048. UnicodeString __fastcall EnumName(T Value, UnicodeString Names)
  1049. {
  1050. int N = int(Value);
  1051. do
  1052. {
  1053. UnicodeString Name = CutToChar(Names, L';', true);
  1054. if (N == 0)
  1055. {
  1056. return Name;
  1057. }
  1058. N--;
  1059. }
  1060. while ((N >= 0) && !Names.IsEmpty());
  1061. return L"(unknown)";
  1062. }
  1063. //---------------------------------------------------------------------------
  1064. #define ADSTR(S) DoAdd(llMessage, S, DoAddToSelf);
  1065. #define ADF(S, F) ADSTR(FORMAT(S, F));
  1066. //---------------------------------------------------------------------------
  1067. void __fastcall TSessionLog::DoAddStartupInfo(TSessionData * Data)
  1068. {
  1069. if (Data == NULL)
  1070. {
  1071. AddSeparator();
  1072. ADSTR(GetEnvironmentInfo());
  1073. THierarchicalStorage * Storage = FConfiguration->CreateConfigStorage();
  1074. try
  1075. {
  1076. ADF(L"Configuration: %s", (Storage->Source));
  1077. }
  1078. __finally
  1079. {
  1080. delete Storage;
  1081. }
  1082. wchar_t UserName[UNLEN + 1];
  1083. unsigned long UserNameSize = LENOF(UserName);
  1084. if (DebugAlwaysFalse(!GetUserNameEx(NameSamCompatible, UserName, &UserNameSize)))
  1085. {
  1086. wcscpy(UserName, L"<Failed to retrieve username>");
  1087. }
  1088. UnicodeString LogStr;
  1089. if (FConfiguration->LogProtocol <= -1)
  1090. {
  1091. LogStr = L"Reduced";
  1092. }
  1093. else if (FConfiguration->LogProtocol <= 0)
  1094. {
  1095. LogStr = L"Normal";
  1096. }
  1097. else if (FConfiguration->LogProtocol == 1)
  1098. {
  1099. LogStr = L"Debug 1";
  1100. }
  1101. else if (FConfiguration->LogProtocol >= 2)
  1102. {
  1103. LogStr = L"Debug 2";
  1104. }
  1105. if (FConfiguration->LogSensitive)
  1106. {
  1107. LogStr += L", Logging passwords";
  1108. }
  1109. if (FConfiguration->LogMaxSize > 0)
  1110. {
  1111. LogStr += FORMAT(L", Rotating after: %s", (SizeToStr(FConfiguration->LogMaxSize)));
  1112. if (FConfiguration->LogMaxCount > 0)
  1113. {
  1114. LogStr += FORMAT(L", Keeping at most %d logs", (FConfiguration->LogMaxCount));
  1115. }
  1116. }
  1117. ADF(L"Log level: %s", (LogStr));
  1118. ADF(L"Local account: %s", (UserName));
  1119. ADF(L"Working directory: %s", (GetCurrentDir()));
  1120. ADF(L"Process ID: %d", (int(GetCurrentProcessId())));
  1121. ADF(L"Ancestor processes: %s", (GetAncestorProcessNames()));
  1122. ADF(L"Command-line: %s", (GetCmdLineLog()));
  1123. if (FConfiguration->ActualLogProtocol >= 1)
  1124. {
  1125. AddOptions(GetGlobalOptions());
  1126. }
  1127. ADF(L"Time zone: %s", (GetTimeZoneLogString()));
  1128. if (!AdjustClockForDSTEnabled())
  1129. {
  1130. ADSTR(L"Warning: System option \"Automatically adjust clock for Daylight Saving Time\" is disabled, timestamps will not be represented correctly");
  1131. }
  1132. ADF(L"Login time: %s", (FormatDateTime(L"dddddd tt", Now())));
  1133. AddSeparator();
  1134. }
  1135. else
  1136. {
  1137. ADF(L"Session name: %s (%s)", (Data->SessionName, Data->Source));
  1138. UnicodeString AddressFamily;
  1139. if (Data->AddressFamily != afAuto)
  1140. {
  1141. AddressFamily = FORMAT(L"%s, ", (Data->AddressFamily == afIPv4 ? L"IPv4" : L"IPv6"));
  1142. }
  1143. UnicodeString HostName = Data->HostNameExpanded;
  1144. if (!Data->HostNameSource.IsEmpty())
  1145. {
  1146. HostName = FORMAT(L"%s [%s]", (HostName, Data->HostNameSource));
  1147. }
  1148. ADF(L"Host name: %s (%sPort: %d)", (HostName, AddressFamily, Data->PortNumber));
  1149. UnicodeString UserName = Data->UserNameExpanded;
  1150. if (!Data->UserNameSource.IsEmpty())
  1151. {
  1152. UserName = FORMAT(L"%s [%s]", (UserName, Data->UserNameSource));
  1153. }
  1154. ADF(L"User name: %s (Password: %s, Key file: %s, Passphrase: %s)",
  1155. (UserName, LogSensitive(Data->Password),
  1156. LogSensitive(Data->PublicKeyFile), LogSensitive(Data->Passphrase)));
  1157. if (Data->UsesSsh)
  1158. {
  1159. ADF(L"Tunnel: %s", (BooleanToEngStr(Data->Tunnel)));
  1160. if (Data->Tunnel)
  1161. {
  1162. ADF(L"Tunnel: Host name: %s (Port: %d)", (Data->TunnelHostName, Data->TunnelPortNumber));
  1163. ADF(L"Tunnel: User name: %s (Password: %s, Key file: %s)",
  1164. (Data->TunnelUserName,
  1165. LogSensitive(Data->TunnelPassword),
  1166. LogSensitive(Data->TunnelPublicKeyFile)));
  1167. ADF(L"Tunnel: Local port number: %d", (Data->TunnelLocalPortNumber));
  1168. }
  1169. }
  1170. ADF(L"Transfer Protocol: %s", (Data->FSProtocolStr));
  1171. if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
  1172. {
  1173. TPingType PingType;
  1174. int PingInterval;
  1175. if (Data->FSProtocol == fsFTP)
  1176. {
  1177. PingType = Data->FtpPingType;
  1178. PingInterval = Data->FtpPingInterval;
  1179. }
  1180. else
  1181. {
  1182. PingType = Data->PingType;
  1183. PingInterval = Data->PingInterval;
  1184. }
  1185. ADF(L"Ping type: %s, Ping interval: %d sec; Timeout: %d sec",
  1186. (EnumName(PingType, PingTypeNames), PingInterval, Data->Timeout));
  1187. ADF(L"Disable Nagle: %s",
  1188. (BooleanToEngStr(Data->TcpNoDelay)));
  1189. }
  1190. ADF(L"Proxy: %s",
  1191. ((Data->FtpProxyLogonType != 0) ?
  1192. FORMAT(L"FTP proxy %d", (Data->FtpProxyLogonType)) :
  1193. EnumName(Data->ProxyMethod, ProxyMethodNames)));
  1194. if ((Data->FtpProxyLogonType != 0) || (Data->ProxyMethod != ::pmNone))
  1195. {
  1196. ADF(L"HostName: %s (Port: %d); Username: %s; Passwd: %s",
  1197. (Data->ProxyHost, Data->ProxyPort,
  1198. Data->ProxyUsername, LogSensitive(Data->ProxyPassword)));
  1199. if (Data->ProxyMethod == pmTelnet)
  1200. {
  1201. ADF(L"Telnet command: %s", (Data->ProxyTelnetCommand));
  1202. }
  1203. if (Data->ProxyMethod == pmCmd)
  1204. {
  1205. ADF(L"Local command: %s", (Data->ProxyLocalCommand));
  1206. }
  1207. }
  1208. if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
  1209. {
  1210. ADF(L"Send buffer: %d", (Data->SendBuf));
  1211. }
  1212. if (Data->UsesSsh && !Data->SourceAddress.IsEmpty())
  1213. {
  1214. ADF(L"Source address: %s", (Data->SourceAddress));
  1215. }
  1216. if (Data->UsesSsh)
  1217. {
  1218. ADF(L"Compression: %s", (BooleanToEngStr(Data->Compression)));
  1219. ADF(L"Bypass authentication: %s",
  1220. (BooleanToEngStr(Data->SshNoUserAuth)));
  1221. ADF(L"Try agent: %s; Agent forwarding: %s; KI: %s; GSSAPI: %s",
  1222. (BooleanToEngStr(Data->TryAgent), BooleanToEngStr(Data->AgentFwd),
  1223. BooleanToEngStr(Data->AuthKI), BooleanToEngStr(Data->AuthGSSAPI)));
  1224. if (Data->AuthGSSAPI)
  1225. {
  1226. ADF(L"GSSAPI: KEX: %s; Forwarding: %s; Libs: %s; Custom: %s",
  1227. (BooleanToEngStr(Data->AuthGSSAPIKEX), BooleanToEngStr(Data->GSSAPIFwdTGT), Data->GssLibList, Data->GssLibCustom));
  1228. }
  1229. ADF(L"Ciphers: %s; Ssh2DES: %s",
  1230. (Data->CipherList, BooleanToEngStr(Data->Ssh2DES)));
  1231. ADF(L"KEX: %s", (Data->KexList));
  1232. UnicodeString Bugs;
  1233. for (int Index = 0; Index < BUG_COUNT; Index++)
  1234. {
  1235. AddToList(Bugs, EnumName(Data->Bug[(TSshBug)Index], AutoSwitchNames), L",");
  1236. }
  1237. ADF(L"SSH Bugs: %s", (Bugs));
  1238. ADF(L"Simple channel: %s", (BooleanToEngStr(Data->SshSimple)));
  1239. ADF(L"Return code variable: %s; Lookup user groups: %s",
  1240. ((Data->DetectReturnVar ? UnicodeString(L"Autodetect") : Data->ReturnVar),
  1241. EnumName(Data->LookupUserGroups, AutoSwitchNames)));
  1242. ADF(L"Shell: %s", ((Data->Shell.IsEmpty()? UnicodeString(L"default") : Data->Shell)));
  1243. ADF(L"EOL: %s, UTF: %s", (EnumName(Data->EOLType, EOLTypeNames), EnumName(Data->NotUtf, NotAutoSwitchNames))); // NotUtf duplicated in FTP branch
  1244. ADF(L"Clear aliases: %s, Unset nat.vars: %s, Resolve symlinks: %s; Follow directory symlinks: %s",
  1245. (BooleanToEngStr(Data->ClearAliases), BooleanToEngStr(Data->UnsetNationalVars),
  1246. BooleanToEngStr(Data->ResolveSymlinks), BooleanToEngStr(Data->FollowDirectorySymlinks)));
  1247. ADF(L"LS: %s, Ign LS warn: %s, Scp1 Comp: %s; Exit code 1 is error: %s",
  1248. (Data->ListingCommand,
  1249. BooleanToEngStr(Data->IgnoreLsWarnings),
  1250. BooleanToEngStr(Data->Scp1Compatibility),
  1251. BooleanToEngStr(Data->ExitCode1IsError)));
  1252. }
  1253. if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly))
  1254. {
  1255. UnicodeString Bugs;
  1256. for (int Index = 0; Index < SFTP_BUG_COUNT; Index++)
  1257. {
  1258. AddToList(Bugs, EnumName(Data->SFTPBug[(TSftpBug)Index], AutoSwitchNames), L",");
  1259. }
  1260. ADF(L"SFTP Bugs: %s", (Bugs));
  1261. ADF(L"SFTP Server: %s", ((Data->SftpServer.IsEmpty()? UnicodeString(L"default") : Data->SftpServer)));
  1262. if (Data->SFTPRealPath != asAuto)
  1263. {
  1264. ADF(L"SFTP Real Path: %s", (EnumName(Data->SFTPRealPath, AutoSwitchNames)));
  1265. }
  1266. }
  1267. bool FtpsOn = false;
  1268. if (Data->FSProtocol == fsFTP)
  1269. {
  1270. ADF(L"UTF: %s", (EnumName(Data->NotUtf, NotAutoSwitchNames))); // duplicated in UsesSsh branch
  1271. UnicodeString Ftps;
  1272. switch (Data->Ftps)
  1273. {
  1274. case ftpsImplicit:
  1275. Ftps = L"Implicit TLS/SSL";
  1276. FtpsOn = true;
  1277. break;
  1278. case ftpsExplicitSsl:
  1279. Ftps = L"Explicit SSL/TLS";
  1280. FtpsOn = true;
  1281. break;
  1282. case ftpsExplicitTls:
  1283. Ftps = L"Explicit TLS/SSL";
  1284. FtpsOn = true;
  1285. break;
  1286. default:
  1287. DebugAssert(Data->Ftps == ftpsNone);
  1288. Ftps = L"None";
  1289. break;
  1290. }
  1291. // kind of hidden option, so do not reveal it unless it is set
  1292. if (Data->FtpTransferActiveImmediately != asAuto)
  1293. {
  1294. ADF(L"Transfer active immediately: %s", (EnumName(Data->FtpTransferActiveImmediately, AutoSwitchNames)));
  1295. }
  1296. ADF(L"FTPS: %s [Client certificate: %s]",
  1297. (Ftps, LogSensitive(Data->TlsCertificateFile)));
  1298. ADF(L"FTP: Passive: %s [Force IP: %s]; MLSD: %s [List all: %s]; HOST: %s",
  1299. (BooleanToEngStr(Data->FtpPasvMode),
  1300. EnumName(Data->FtpForcePasvIp, AutoSwitchNames),
  1301. EnumName(Data->FtpUseMlsd, AutoSwitchNames),
  1302. EnumName(Data->FtpListAll, AutoSwitchNames),
  1303. EnumName(Data->FtpHost, AutoSwitchNames)));
  1304. if (Data->FtpWorkFromCwd != asAuto)
  1305. {
  1306. ADF(L"FTP: Relative paths: %s", (EnumName(Data->FtpWorkFromCwd, AutoSwitchNames)));
  1307. }
  1308. }
  1309. if (Data->FSProtocol == fsWebDAV)
  1310. {
  1311. FtpsOn = (Data->Ftps != ftpsNone);
  1312. ADF(L"HTTPS: %s [Client certificate: %s]",
  1313. (BooleanToEngStr(FtpsOn), LogSensitive(Data->TlsCertificateFile)));
  1314. ADF(L"WebDAV: Tolerate non-encoded: %s", (BooleanToEngStr(Data->WebDavLiberalEscaping)));
  1315. }
  1316. if (Data->FSProtocol == fsS3)
  1317. {
  1318. FtpsOn = (Data->Ftps != ftpsNone);
  1319. ADF(L"HTTPS: %s", (BooleanToEngStr(FtpsOn)));
  1320. ADF(L"S3: URL Style: %s", (EnumName(Data->S3UrlStyle, L"Virtual Host;Path")));
  1321. if (!Data->S3DefaultRegion.IsEmpty())
  1322. {
  1323. ADF(L"S3: Default region: %s", (Data->S3DefaultRegion));
  1324. }
  1325. if (!Data->S3SessionToken.IsEmpty())
  1326. {
  1327. ADF(L"S3: Session token: %s", (Data->S3SessionToken));
  1328. }
  1329. }
  1330. if (FtpsOn)
  1331. {
  1332. if (Data->FSProtocol == fsFTP)
  1333. {
  1334. ADF(L"Session reuse: %s", (BooleanToEngStr(Data->SslSessionReuse)));
  1335. }
  1336. ADF(L"TLS/SSL versions: %s-%s", (GetTlsVersionName(Data->MinTlsVersion), GetTlsVersionName(Data->MaxTlsVersion)));
  1337. }
  1338. ADF(L"Local directory: %s, Remote directory: %s, Update: %s, Cache: %s",
  1339. ((Data->LocalDirectory.IsEmpty() ? UnicodeString(L"default") : Data->LocalDirectory),
  1340. (Data->RemoteDirectory.IsEmpty() ? UnicodeString(L"home") : Data->RemoteDirectory),
  1341. BooleanToEngStr(Data->UpdateDirectories),
  1342. BooleanToEngStr(Data->CacheDirectories)));
  1343. ADF(L"Cache directory changes: %s, Permanent: %s",
  1344. (BooleanToEngStr(Data->CacheDirectoryChanges),
  1345. BooleanToEngStr(Data->PreserveDirectoryChanges)));
  1346. ADF(L"Recycle bin: Delete to: %s, Overwritten to: %s, Bin path: %s",
  1347. (BooleanToEngStr(Data->DeleteToRecycleBin),
  1348. BooleanToEngStr(Data->OverwrittenToRecycleBin),
  1349. Data->RecycleBinPath));
  1350. if (Data->TrimVMSVersions || Data->VMSAllRevisions)
  1351. {
  1352. ADF(L"Trim VMS versions: %s; VMS all revisions: %s",
  1353. (BooleanToEngStr(Data->TrimVMSVersions), BooleanToEngStr(Data->VMSAllRevisions)));
  1354. }
  1355. UnicodeString TimeInfo;
  1356. if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly) || (Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsWebDAV))
  1357. {
  1358. AddToList(TimeInfo, FORMAT(L"DST mode: %s", (EnumName(Data->DSTMode, DSTModeNames))), L";");
  1359. }
  1360. if ((Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsFTP))
  1361. {
  1362. int TimeDifferenceMin = TimeToMinutes(Data->TimeDifference);
  1363. AddToList(TimeInfo, FORMAT(L"Timezone offset: %dh %dm", ((TimeDifferenceMin / MinsPerHour), (TimeDifferenceMin % MinsPerHour))), L";");
  1364. }
  1365. ADSTR(TimeInfo);
  1366. if (Data->FSProtocol == fsWebDAV)
  1367. {
  1368. ADF(L"Compression: %s",
  1369. (BooleanToEngStr(Data->Compression)));
  1370. }
  1371. if ((Data->FSProtocol == fsFTP) && !Data->FtpPasvMode)
  1372. {
  1373. if (!Configuration->ExternalIpAddress.IsEmpty() || Configuration->HasLocalPortNumberLimits())
  1374. {
  1375. AddSeparator();
  1376. ADF(L"FTP active mode interface: %s:%d-%d", (DefaultStr(Configuration->ExternalIpAddress, L"<system address>"), Configuration->LocalPortNumberMin, Configuration->LocalPortNumberMax));
  1377. }
  1378. }
  1379. AddSeparator();
  1380. }
  1381. }
  1382. //---------------------------------------------------------------------------
  1383. void __fastcall TSessionLog::AddOption(const UnicodeString & LogStr)
  1384. {
  1385. ADSTR(LogStr);
  1386. }
  1387. //---------------------------------------------------------------------------
  1388. void __fastcall TSessionLog::AddOptions(TOptions * Options)
  1389. {
  1390. Options->LogOptions(AddOption);
  1391. }
  1392. //---------------------------------------------------------------------------
  1393. #undef ADF
  1394. #undef ADSTR
  1395. //---------------------------------------------------------------------------
  1396. void __fastcall TSessionLog::AddSeparator()
  1397. {
  1398. Add(llMessage, L"--------------------------------------------------------------------------");
  1399. }
  1400. //---------------------------------------------------------------------------
  1401. //---------------------------------------------------------------------------
  1402. __fastcall TActionLog::TActionLog(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
  1403. TConfiguration * Configuration)
  1404. {
  1405. DebugAssert(UI != NULL);
  1406. DebugAssert(SessionData != NULL);
  1407. Init(UI, Started, SessionData, Configuration);
  1408. }
  1409. //---------------------------------------------------------------------------
  1410. __fastcall TActionLog::TActionLog(TDateTime Started, TConfiguration * Configuration)
  1411. {
  1412. Init(NULL, Started, NULL, Configuration);
  1413. // not associated with session, so no need to waiting for anything
  1414. ReflectSettings();
  1415. }
  1416. //---------------------------------------------------------------------------
  1417. void __fastcall TActionLog::Init(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
  1418. TConfiguration * Configuration)
  1419. {
  1420. FCriticalSection = new TCriticalSection;
  1421. FConfiguration = Configuration;
  1422. FUI = UI;
  1423. FSessionData = SessionData;
  1424. FStarted = Started;
  1425. FFile = NULL;
  1426. FCurrentLogFileName = L"";
  1427. FCurrentFileName = L"";
  1428. FLogging = false;
  1429. FClosed = false;
  1430. FFailed = false;
  1431. FPendingActions = new TList();
  1432. FIndent = L" ";
  1433. FInGroup = false;
  1434. FEnabled = true;
  1435. }
  1436. //---------------------------------------------------------------------------
  1437. __fastcall TActionLog::~TActionLog()
  1438. {
  1439. DebugAssert(FPendingActions->Count == 0);
  1440. delete FPendingActions;
  1441. FClosed = true;
  1442. ReflectSettings();
  1443. DebugAssert(FFile == NULL);
  1444. delete FCriticalSection;
  1445. }
  1446. //---------------------------------------------------------------------------
  1447. void __fastcall TActionLog::Add(const UnicodeString & Line)
  1448. {
  1449. DebugAssert(FConfiguration);
  1450. if (FLogging)
  1451. {
  1452. TGuard Guard(FCriticalSection);
  1453. if (FFile == NULL)
  1454. {
  1455. OpenLogFile();
  1456. }
  1457. if (FFile != NULL)
  1458. {
  1459. try
  1460. {
  1461. UTF8String UtfLine = UTF8String(Line);
  1462. size_t Written =
  1463. fwrite(UtfLine.c_str(), 1, UtfLine.Length(), (FILE *)FFile);
  1464. if (Written != static_cast<size_t>(UtfLine.Length()))
  1465. {
  1466. throw ECRTExtException(L"");
  1467. }
  1468. #ifdef _DEBUG
  1469. #endif
  1470. Written =
  1471. fwrite("\n", 1, 1, (FILE *)FFile);
  1472. if (Written != 1)
  1473. {
  1474. throw ECRTExtException(L"");
  1475. }
  1476. }
  1477. catch (Exception &E)
  1478. {
  1479. FCriticalSection->Release();
  1480. // avoid endless loop when trying to close tags when closing log, when logging has failed
  1481. if (!FFailed)
  1482. {
  1483. FFailed = true;
  1484. // We failed logging, turn it off and notify user.
  1485. FConfiguration->LogActions = false;
  1486. if (FConfiguration->LogActionsRequired)
  1487. {
  1488. throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
  1489. }
  1490. else
  1491. {
  1492. try
  1493. {
  1494. throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
  1495. }
  1496. catch (Exception &E)
  1497. {
  1498. if (FUI != NULL)
  1499. {
  1500. FUI->HandleExtendedException(&E);
  1501. }
  1502. }
  1503. }
  1504. }
  1505. }
  1506. }
  1507. }
  1508. }
  1509. //---------------------------------------------------------------------------
  1510. void __fastcall TActionLog::AddIndented(const UnicodeString & Line)
  1511. {
  1512. Add(FIndent + Line);
  1513. }
  1514. //---------------------------------------------------------------------------
  1515. void __fastcall TActionLog::AddFailure(TStrings * Messages)
  1516. {
  1517. AddIndented(L"<failure>");
  1518. AddMessages(L" ", Messages);
  1519. AddIndented(L"</failure>");
  1520. }
  1521. //---------------------------------------------------------------------------
  1522. void __fastcall TActionLog::AddFailure(Exception * E)
  1523. {
  1524. TStrings * Messages = ExceptionToMoreMessages(E);
  1525. if (Messages != NULL)
  1526. {
  1527. try
  1528. {
  1529. AddFailure(Messages);
  1530. }
  1531. __finally
  1532. {
  1533. delete Messages;
  1534. }
  1535. }
  1536. }
  1537. //---------------------------------------------------------------------------
  1538. void __fastcall TActionLog::AddMessages(UnicodeString Indent, TStrings * Messages)
  1539. {
  1540. for (int Index = 0; Index < Messages->Count; Index++)
  1541. {
  1542. AddIndented(
  1543. FORMAT(Indent + L"<message>%s</message>", (XmlEscape(Messages->Strings[Index]))));
  1544. }
  1545. }
  1546. //---------------------------------------------------------------------------
  1547. void __fastcall TActionLog::ReflectSettings()
  1548. {
  1549. TGuard Guard(FCriticalSection);
  1550. bool ALogging =
  1551. !FClosed && FConfiguration->LogActions && Enabled;
  1552. if (ALogging && !FLogging)
  1553. {
  1554. FLogging = true;
  1555. Add(L"<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  1556. UnicodeString SessionName =
  1557. (FSessionData != NULL) ? XmlAttributeEscape(FSessionData->SessionName) : UnicodeString(L"nosession");
  1558. Add(FORMAT(L"<session xmlns=\"http://winscp.net/schema/session/1.0\" name=\"%s\" start=\"%s\">",
  1559. (SessionName, StandardTimestamp())));
  1560. }
  1561. else if (!ALogging && FLogging)
  1562. {
  1563. if (FInGroup)
  1564. {
  1565. EndGroup();
  1566. }
  1567. // do not try to close the file, if it has not been opened, to avoid recursion
  1568. if (FFile != NULL)
  1569. {
  1570. Add(L"</session>");
  1571. }
  1572. CloseLogFile();
  1573. FLogging = false;
  1574. }
  1575. }
  1576. //---------------------------------------------------------------------------
  1577. void __fastcall TActionLog::CloseLogFile()
  1578. {
  1579. if (FFile != NULL)
  1580. {
  1581. fclose((FILE *)FFile);
  1582. FFile = NULL;
  1583. }
  1584. FCurrentLogFileName = L"";
  1585. FCurrentFileName = L"";
  1586. }
  1587. //---------------------------------------------------------------------------
  1588. void __fastcall TActionLog::OpenLogFile()
  1589. {
  1590. try
  1591. {
  1592. DebugAssert(FFile == NULL);
  1593. DebugAssert(FConfiguration != NULL);
  1594. FCurrentLogFileName = FConfiguration->ActionsLogFileName;
  1595. FFile = OpenFile(FCurrentLogFileName, FStarted, FSessionData, false, FCurrentFileName);
  1596. }
  1597. catch (Exception & E)
  1598. {
  1599. // We failed logging to file, turn it off and notify user.
  1600. FCurrentLogFileName = L"";
  1601. FCurrentFileName = L"";
  1602. FConfiguration->LogActions = false;
  1603. if (FConfiguration->LogActionsRequired)
  1604. {
  1605. throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
  1606. }
  1607. else
  1608. {
  1609. try
  1610. {
  1611. throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
  1612. }
  1613. catch (Exception & E)
  1614. {
  1615. if (FUI != NULL)
  1616. {
  1617. // not to deadlock with TSessionLog::ReflectSettings invoked by FConfiguration->LogFileName setter above
  1618. TUnguard Unguard(FCriticalSection);
  1619. FUI->HandleExtendedException(&E);
  1620. }
  1621. }
  1622. }
  1623. }
  1624. }
  1625. //---------------------------------------------------------------------------
  1626. void __fastcall TActionLog::AddPendingAction(TSessionActionRecord * Action)
  1627. {
  1628. FPendingActions->Add(Action);
  1629. }
  1630. //---------------------------------------------------------------------------
  1631. void __fastcall TActionLog::RecordPendingActions()
  1632. {
  1633. while ((FPendingActions->Count > 0) &&
  1634. static_cast<TSessionActionRecord *>(FPendingActions->Items[0])->Record())
  1635. {
  1636. FPendingActions->Delete(0);
  1637. }
  1638. }
  1639. //---------------------------------------------------------------------------
  1640. void __fastcall TActionLog::BeginGroup(UnicodeString Name)
  1641. {
  1642. DebugAssert(!FInGroup);
  1643. FInGroup = true;
  1644. DebugAssert(FIndent == L" ");
  1645. AddIndented(FORMAT(L"<group name=\"%s\" start=\"%s\">",
  1646. (XmlAttributeEscape(Name), StandardTimestamp())));
  1647. FIndent = L" ";
  1648. }
  1649. //---------------------------------------------------------------------------
  1650. void __fastcall TActionLog::EndGroup()
  1651. {
  1652. DebugAssert(FInGroup);
  1653. FInGroup = false;
  1654. DebugAssert(FIndent == L" ");
  1655. FIndent = L" ";
  1656. // this is called from ReflectSettings that in turn is called when logging fails,
  1657. // so do not try to close the group, if it has not been opened, to avoid recursion
  1658. if (FFile != NULL)
  1659. {
  1660. AddIndented(L"</group>");
  1661. }
  1662. }
  1663. //---------------------------------------------------------------------------
  1664. void __fastcall TActionLog::SetEnabled(bool value)
  1665. {
  1666. if (Enabled != value)
  1667. {
  1668. FEnabled = value;
  1669. ReflectSettings();
  1670. }
  1671. }