SessionInfo.cpp 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713
  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"Parent process: %s", (GetAncestorProcessName()));
  1122. ADF(L"Command-line: %s", (GetCmdLineLog()));
  1123. if (FConfiguration->LogProtocol >= 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. ADF(L"Host name: %s (%sPort: %d)", (Data->HostNameExpanded, AddressFamily, Data->PortNumber));
  1144. ADF(L"User name: %s (Password: %s, Key file: %s, Passphrase: %s)",
  1145. (Data->UserNameExpanded, LogSensitive(Data->Password),
  1146. LogSensitive(Data->PublicKeyFile), LogSensitive(Data->Passphrase)));
  1147. if (Data->UsesSsh)
  1148. {
  1149. ADF(L"Tunnel: %s", (BooleanToEngStr(Data->Tunnel)));
  1150. if (Data->Tunnel)
  1151. {
  1152. ADF(L"Tunnel: Host name: %s (Port: %d)", (Data->TunnelHostName, Data->TunnelPortNumber));
  1153. ADF(L"Tunnel: User name: %s (Password: %s, Key file: %s)",
  1154. (Data->TunnelUserName,
  1155. LogSensitive(Data->TunnelPassword),
  1156. LogSensitive(Data->TunnelPublicKeyFile)));
  1157. ADF(L"Tunnel: Local port number: %d", (Data->TunnelLocalPortNumber));
  1158. }
  1159. }
  1160. ADF(L"Transfer Protocol: %s", (Data->FSProtocolStr));
  1161. if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
  1162. {
  1163. TPingType PingType;
  1164. int PingInterval;
  1165. if (Data->FSProtocol == fsFTP)
  1166. {
  1167. PingType = Data->FtpPingType;
  1168. PingInterval = Data->FtpPingInterval;
  1169. }
  1170. else
  1171. {
  1172. PingType = Data->PingType;
  1173. PingInterval = Data->PingInterval;
  1174. }
  1175. ADF(L"Ping type: %s, Ping interval: %d sec; Timeout: %d sec",
  1176. (EnumName(PingType, PingTypeNames), PingInterval, Data->Timeout));
  1177. ADF(L"Disable Nagle: %s",
  1178. (BooleanToEngStr(Data->TcpNoDelay)));
  1179. }
  1180. ADF(L"Proxy: %s",
  1181. ((Data->FtpProxyLogonType != 0) ?
  1182. FORMAT(L"FTP proxy %d", (Data->FtpProxyLogonType)) :
  1183. EnumName(Data->ProxyMethod, ProxyMethodNames)));
  1184. if ((Data->FtpProxyLogonType != 0) || (Data->ProxyMethod != ::pmNone))
  1185. {
  1186. ADF(L"HostName: %s (Port: %d); Username: %s; Passwd: %s",
  1187. (Data->ProxyHost, Data->ProxyPort,
  1188. Data->ProxyUsername, LogSensitive(Data->ProxyPassword)));
  1189. if (Data->ProxyMethod == pmTelnet)
  1190. {
  1191. ADF(L"Telnet command: %s", (Data->ProxyTelnetCommand));
  1192. }
  1193. if (Data->ProxyMethod == pmCmd)
  1194. {
  1195. ADF(L"Local command: %s", (Data->ProxyLocalCommand));
  1196. }
  1197. }
  1198. if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
  1199. {
  1200. ADF(L"Send buffer: %d", (Data->SendBuf));
  1201. }
  1202. if (Data->UsesSsh && !Data->SourceAddress.IsEmpty())
  1203. {
  1204. ADF(L"Source address: %s", (Data->SourceAddress));
  1205. }
  1206. if (Data->UsesSsh)
  1207. {
  1208. ADF(L"SSH protocol version: %s; Compression: %s",
  1209. (Data->SshProtStr, BooleanToEngStr(Data->Compression)));
  1210. ADF(L"Bypass authentication: %s",
  1211. (BooleanToEngStr(Data->SshNoUserAuth)));
  1212. ADF(L"Try agent: %s; Agent forwarding: %s; TIS/CryptoCard: %s; KI: %s; GSSAPI: %s",
  1213. (BooleanToEngStr(Data->TryAgent), BooleanToEngStr(Data->AgentFwd), BooleanToEngStr(Data->AuthTIS),
  1214. BooleanToEngStr(Data->AuthKI), BooleanToEngStr(Data->AuthGSSAPI)));
  1215. if (Data->AuthGSSAPI)
  1216. {
  1217. ADF(L"GSSAPI: KEX: %s; Forwarding: %s; Libs: %s; Custom: %s",
  1218. (BooleanToEngStr(Data->AuthGSSAPIKEX), BooleanToEngStr(Data->GSSAPIFwdTGT), Data->GssLibList, Data->GssLibCustom));
  1219. }
  1220. ADF(L"Ciphers: %s; Ssh2DES: %s",
  1221. (Data->CipherList, BooleanToEngStr(Data->Ssh2DES)));
  1222. ADF(L"KEX: %s", (Data->KexList));
  1223. UnicodeString Bugs;
  1224. for (int Index = 0; Index < BUG_COUNT; Index++)
  1225. {
  1226. AddToList(Bugs, EnumName(Data->Bug[(TSshBug)Index], AutoSwitchNames), L",");
  1227. }
  1228. ADF(L"SSH Bugs: %s", (Bugs));
  1229. ADF(L"Simple channel: %s", (BooleanToEngStr(Data->SshSimple)));
  1230. ADF(L"Return code variable: %s; Lookup user groups: %s",
  1231. ((Data->DetectReturnVar ? UnicodeString(L"Autodetect") : Data->ReturnVar),
  1232. EnumName(Data->LookupUserGroups, AutoSwitchNames)));
  1233. ADF(L"Shell: %s", ((Data->Shell.IsEmpty()? UnicodeString(L"default") : Data->Shell)));
  1234. ADF(L"EOL: %s, UTF: %s", (EnumName(Data->EOLType, EOLTypeNames), EnumName(Data->NotUtf, NotAutoSwitchNames))); // NotUtf duplicated in FTP branch
  1235. ADF(L"Clear aliases: %s, Unset nat.vars: %s, Resolve symlinks: %s; Follow directory symlinks: %s",
  1236. (BooleanToEngStr(Data->ClearAliases), BooleanToEngStr(Data->UnsetNationalVars),
  1237. BooleanToEngStr(Data->ResolveSymlinks), BooleanToEngStr(Data->FollowDirectorySymlinks)));
  1238. ADF(L"LS: %s, Ign LS warn: %s, Scp1 Comp: %s; Exit code 1 is error: %s",
  1239. (Data->ListingCommand,
  1240. BooleanToEngStr(Data->IgnoreLsWarnings),
  1241. BooleanToEngStr(Data->Scp1Compatibility),
  1242. BooleanToEngStr(Data->ExitCode1IsError)));
  1243. }
  1244. if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly))
  1245. {
  1246. UnicodeString Bugs;
  1247. for (int Index = 0; Index < SFTP_BUG_COUNT; Index++)
  1248. {
  1249. AddToList(Bugs, EnumName(Data->SFTPBug[(TSftpBug)Index], AutoSwitchNames), L",");
  1250. }
  1251. ADF(L"SFTP Bugs: %s", (Bugs));
  1252. ADF(L"SFTP Server: %s", ((Data->SftpServer.IsEmpty()? UnicodeString(L"default") : Data->SftpServer)));
  1253. }
  1254. bool FtpsOn = false;
  1255. if (Data->FSProtocol == fsFTP)
  1256. {
  1257. ADF(L"UTF: %s", (EnumName(Data->NotUtf, NotAutoSwitchNames))); // duplicated in UsesSsh branch
  1258. UnicodeString Ftps;
  1259. switch (Data->Ftps)
  1260. {
  1261. case ftpsImplicit:
  1262. Ftps = L"Implicit TLS/SSL";
  1263. FtpsOn = true;
  1264. break;
  1265. case ftpsExplicitSsl:
  1266. Ftps = L"Explicit SSL/TLS";
  1267. FtpsOn = true;
  1268. break;
  1269. case ftpsExplicitTls:
  1270. Ftps = L"Explicit TLS/SSL";
  1271. FtpsOn = true;
  1272. break;
  1273. default:
  1274. DebugAssert(Data->Ftps == ftpsNone);
  1275. Ftps = L"None";
  1276. break;
  1277. }
  1278. // kind of hidden option, so do not reveal it unless it is set
  1279. if (Data->FtpTransferActiveImmediately != asAuto)
  1280. {
  1281. ADF(L"Transfer active immediately: %s", (EnumName(Data->FtpTransferActiveImmediately, AutoSwitchNames)));
  1282. }
  1283. ADF(L"FTPS: %s [Client certificate: %s]",
  1284. (Ftps, LogSensitive(Data->TlsCertificateFile)));
  1285. ADF(L"FTP: Passive: %s [Force IP: %s]; MLSD: %s [List all: %s]; HOST: %s",
  1286. (BooleanToEngStr(Data->FtpPasvMode),
  1287. EnumName(Data->FtpForcePasvIp, AutoSwitchNames),
  1288. EnumName(Data->FtpUseMlsd, AutoSwitchNames),
  1289. EnumName(Data->FtpListAll, AutoSwitchNames),
  1290. EnumName(Data->FtpHost, AutoSwitchNames)));
  1291. }
  1292. if (Data->FSProtocol == fsWebDAV)
  1293. {
  1294. FtpsOn = (Data->Ftps != ftpsNone);
  1295. ADF(L"HTTPS: %s [Client certificate: %s]",
  1296. (BooleanToEngStr(FtpsOn), LogSensitive(Data->TlsCertificateFile)));
  1297. ADF(L"WebDAV: Tolerate non-encoded: %s", (BooleanToEngStr(Data->WebDavLiberalEscaping)));
  1298. }
  1299. if (Data->FSProtocol == fsS3)
  1300. {
  1301. FtpsOn = (Data->Ftps != ftpsNone);
  1302. ADF(L"HTTPS: %s", (BooleanToEngStr(FtpsOn)));
  1303. ADF(L"S3: URL Style: %s", (EnumName(Data->S3UrlStyle, L"Virtual Host;Path")));
  1304. if (!Data->S3DefaultRegion.IsEmpty())
  1305. {
  1306. ADF(L"S3: Default region: %s", (Data->S3DefaultRegion));
  1307. }
  1308. if (!Data->S3SessionToken.IsEmpty())
  1309. {
  1310. ADF(L"S3: Session token: %s", (Data->S3SessionToken));
  1311. }
  1312. }
  1313. if (FtpsOn)
  1314. {
  1315. if (Data->FSProtocol == fsFTP)
  1316. {
  1317. ADF(L"Session reuse: %s", (BooleanToEngStr(Data->SslSessionReuse)));
  1318. }
  1319. ADF(L"TLS/SSL versions: %s-%s", (GetTlsVersionName(Data->MinTlsVersion), GetTlsVersionName(Data->MaxTlsVersion)));
  1320. }
  1321. ADF(L"Local directory: %s, Remote directory: %s, Update: %s, Cache: %s",
  1322. ((Data->LocalDirectory.IsEmpty() ? UnicodeString(L"default") : Data->LocalDirectory),
  1323. (Data->RemoteDirectory.IsEmpty() ? UnicodeString(L"home") : Data->RemoteDirectory),
  1324. BooleanToEngStr(Data->UpdateDirectories),
  1325. BooleanToEngStr(Data->CacheDirectories)));
  1326. ADF(L"Cache directory changes: %s, Permanent: %s",
  1327. (BooleanToEngStr(Data->CacheDirectoryChanges),
  1328. BooleanToEngStr(Data->PreserveDirectoryChanges)));
  1329. ADF(L"Recycle bin: Delete to: %s, Overwritten to: %s, Bin path: %s",
  1330. (BooleanToEngStr(Data->DeleteToRecycleBin),
  1331. BooleanToEngStr(Data->OverwrittenToRecycleBin),
  1332. Data->RecycleBinPath));
  1333. if (Data->TrimVMSVersions)
  1334. {
  1335. ADF(L"Trim VMS versions: %s",
  1336. (BooleanToEngStr(Data->TrimVMSVersions)));
  1337. }
  1338. UnicodeString TimeInfo;
  1339. if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly) || (Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsWebDAV))
  1340. {
  1341. AddToList(TimeInfo, FORMAT(L"DST mode: %s", (EnumName(Data->DSTMode, DSTModeNames))), L";");
  1342. }
  1343. if ((Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsFTP))
  1344. {
  1345. int TimeDifferenceMin = TimeToMinutes(Data->TimeDifference);
  1346. AddToList(TimeInfo, FORMAT(L"Timezone offset: %dh %dm", ((TimeDifferenceMin / MinsPerHour), (TimeDifferenceMin % MinsPerHour))), L";");
  1347. }
  1348. ADSTR(TimeInfo);
  1349. if (Data->FSProtocol == fsWebDAV)
  1350. {
  1351. ADF(L"Compression: %s",
  1352. (BooleanToEngStr(Data->Compression)));
  1353. }
  1354. AddSeparator();
  1355. }
  1356. }
  1357. //---------------------------------------------------------------------------
  1358. void __fastcall TSessionLog::AddOption(const UnicodeString & LogStr)
  1359. {
  1360. ADSTR(LogStr);
  1361. }
  1362. //---------------------------------------------------------------------------
  1363. void __fastcall TSessionLog::AddOptions(TOptions * Options)
  1364. {
  1365. Options->LogOptions(AddOption);
  1366. }
  1367. //---------------------------------------------------------------------------
  1368. #undef ADF
  1369. #undef ADSTR
  1370. //---------------------------------------------------------------------------
  1371. void __fastcall TSessionLog::AddSeparator()
  1372. {
  1373. Add(llMessage, L"--------------------------------------------------------------------------");
  1374. }
  1375. //---------------------------------------------------------------------------
  1376. //---------------------------------------------------------------------------
  1377. __fastcall TActionLog::TActionLog(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
  1378. TConfiguration * Configuration)
  1379. {
  1380. DebugAssert(UI != NULL);
  1381. DebugAssert(SessionData != NULL);
  1382. Init(UI, Started, SessionData, Configuration);
  1383. }
  1384. //---------------------------------------------------------------------------
  1385. __fastcall TActionLog::TActionLog(TDateTime Started, TConfiguration * Configuration)
  1386. {
  1387. Init(NULL, Started, NULL, Configuration);
  1388. // not associated with session, so no need to waiting for anything
  1389. ReflectSettings();
  1390. }
  1391. //---------------------------------------------------------------------------
  1392. void __fastcall TActionLog::Init(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
  1393. TConfiguration * Configuration)
  1394. {
  1395. FCriticalSection = new TCriticalSection;
  1396. FConfiguration = Configuration;
  1397. FUI = UI;
  1398. FSessionData = SessionData;
  1399. FStarted = Started;
  1400. FFile = NULL;
  1401. FCurrentLogFileName = L"";
  1402. FCurrentFileName = L"";
  1403. FLogging = false;
  1404. FClosed = false;
  1405. FFailed = false;
  1406. FPendingActions = new TList();
  1407. FIndent = L" ";
  1408. FInGroup = false;
  1409. FEnabled = true;
  1410. }
  1411. //---------------------------------------------------------------------------
  1412. __fastcall TActionLog::~TActionLog()
  1413. {
  1414. DebugAssert(FPendingActions->Count == 0);
  1415. delete FPendingActions;
  1416. FClosed = true;
  1417. ReflectSettings();
  1418. DebugAssert(FFile == NULL);
  1419. delete FCriticalSection;
  1420. }
  1421. //---------------------------------------------------------------------------
  1422. void __fastcall TActionLog::Add(const UnicodeString & Line)
  1423. {
  1424. DebugAssert(FConfiguration);
  1425. if (FLogging)
  1426. {
  1427. TGuard Guard(FCriticalSection);
  1428. if (FFile == NULL)
  1429. {
  1430. OpenLogFile();
  1431. }
  1432. if (FFile != NULL)
  1433. {
  1434. try
  1435. {
  1436. UTF8String UtfLine = UTF8String(Line);
  1437. size_t Written =
  1438. fwrite(UtfLine.c_str(), 1, UtfLine.Length(), (FILE *)FFile);
  1439. if (Written != static_cast<size_t>(UtfLine.Length()))
  1440. {
  1441. throw ECRTExtException(L"");
  1442. }
  1443. #ifdef _DEBUG
  1444. #endif
  1445. Written =
  1446. fwrite("\n", 1, 1, (FILE *)FFile);
  1447. if (Written != 1)
  1448. {
  1449. throw ECRTExtException(L"");
  1450. }
  1451. }
  1452. catch (Exception &E)
  1453. {
  1454. FCriticalSection->Release();
  1455. // avoid endless loop when trying to close tags when closing log, when logging has failed
  1456. if (!FFailed)
  1457. {
  1458. FFailed = true;
  1459. // We failed logging, turn it off and notify user.
  1460. FConfiguration->LogActions = false;
  1461. if (FConfiguration->LogActionsRequired)
  1462. {
  1463. throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
  1464. }
  1465. else
  1466. {
  1467. try
  1468. {
  1469. throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
  1470. }
  1471. catch (Exception &E)
  1472. {
  1473. if (FUI != NULL)
  1474. {
  1475. FUI->HandleExtendedException(&E);
  1476. }
  1477. }
  1478. }
  1479. }
  1480. }
  1481. }
  1482. }
  1483. }
  1484. //---------------------------------------------------------------------------
  1485. void __fastcall TActionLog::AddIndented(const UnicodeString & Line)
  1486. {
  1487. Add(FIndent + Line);
  1488. }
  1489. //---------------------------------------------------------------------------
  1490. void __fastcall TActionLog::AddFailure(TStrings * Messages)
  1491. {
  1492. AddIndented(L"<failure>");
  1493. AddMessages(L" ", Messages);
  1494. AddIndented(L"</failure>");
  1495. }
  1496. //---------------------------------------------------------------------------
  1497. void __fastcall TActionLog::AddFailure(Exception * E)
  1498. {
  1499. TStrings * Messages = ExceptionToMoreMessages(E);
  1500. if (Messages != NULL)
  1501. {
  1502. try
  1503. {
  1504. AddFailure(Messages);
  1505. }
  1506. __finally
  1507. {
  1508. delete Messages;
  1509. }
  1510. }
  1511. }
  1512. //---------------------------------------------------------------------------
  1513. void __fastcall TActionLog::AddMessages(UnicodeString Indent, TStrings * Messages)
  1514. {
  1515. for (int Index = 0; Index < Messages->Count; Index++)
  1516. {
  1517. AddIndented(
  1518. FORMAT(Indent + L"<message>%s</message>", (XmlEscape(Messages->Strings[Index]))));
  1519. }
  1520. }
  1521. //---------------------------------------------------------------------------
  1522. void __fastcall TActionLog::ReflectSettings()
  1523. {
  1524. TGuard Guard(FCriticalSection);
  1525. bool ALogging =
  1526. !FClosed && FConfiguration->LogActions && Enabled;
  1527. if (ALogging && !FLogging)
  1528. {
  1529. FLogging = true;
  1530. Add(L"<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  1531. UnicodeString SessionName =
  1532. (FSessionData != NULL) ? XmlAttributeEscape(FSessionData->SessionName) : UnicodeString(L"nosession");
  1533. Add(FORMAT(L"<session xmlns=\"http://winscp.net/schema/session/1.0\" name=\"%s\" start=\"%s\">",
  1534. (SessionName, StandardTimestamp())));
  1535. }
  1536. else if (!ALogging && FLogging)
  1537. {
  1538. if (FInGroup)
  1539. {
  1540. EndGroup();
  1541. }
  1542. // do not try to close the file, if it has not been opened, to avoid recursion
  1543. if (FFile != NULL)
  1544. {
  1545. Add(L"</session>");
  1546. }
  1547. CloseLogFile();
  1548. FLogging = false;
  1549. }
  1550. }
  1551. //---------------------------------------------------------------------------
  1552. void __fastcall TActionLog::CloseLogFile()
  1553. {
  1554. if (FFile != NULL)
  1555. {
  1556. fclose((FILE *)FFile);
  1557. FFile = NULL;
  1558. }
  1559. FCurrentLogFileName = L"";
  1560. FCurrentFileName = L"";
  1561. }
  1562. //---------------------------------------------------------------------------
  1563. void __fastcall TActionLog::OpenLogFile()
  1564. {
  1565. try
  1566. {
  1567. DebugAssert(FFile == NULL);
  1568. DebugAssert(FConfiguration != NULL);
  1569. FCurrentLogFileName = FConfiguration->ActionsLogFileName;
  1570. FFile = OpenFile(FCurrentLogFileName, FStarted, FSessionData, false, FCurrentFileName);
  1571. }
  1572. catch (Exception & E)
  1573. {
  1574. // We failed logging to file, turn it off and notify user.
  1575. FCurrentLogFileName = L"";
  1576. FCurrentFileName = L"";
  1577. FConfiguration->LogActions = false;
  1578. if (FConfiguration->LogActionsRequired)
  1579. {
  1580. throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
  1581. }
  1582. else
  1583. {
  1584. try
  1585. {
  1586. throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
  1587. }
  1588. catch (Exception & E)
  1589. {
  1590. if (FUI != NULL)
  1591. {
  1592. // not to deadlock with TSessionLog::ReflectSettings invoked by FConfiguration->LogFileName setter above
  1593. TUnguard Unguard(FCriticalSection);
  1594. FUI->HandleExtendedException(&E);
  1595. }
  1596. }
  1597. }
  1598. }
  1599. }
  1600. //---------------------------------------------------------------------------
  1601. void __fastcall TActionLog::AddPendingAction(TSessionActionRecord * Action)
  1602. {
  1603. FPendingActions->Add(Action);
  1604. }
  1605. //---------------------------------------------------------------------------
  1606. void __fastcall TActionLog::RecordPendingActions()
  1607. {
  1608. while ((FPendingActions->Count > 0) &&
  1609. static_cast<TSessionActionRecord *>(FPendingActions->Items[0])->Record())
  1610. {
  1611. FPendingActions->Delete(0);
  1612. }
  1613. }
  1614. //---------------------------------------------------------------------------
  1615. void __fastcall TActionLog::BeginGroup(UnicodeString Name)
  1616. {
  1617. DebugAssert(!FInGroup);
  1618. FInGroup = true;
  1619. DebugAssert(FIndent == L" ");
  1620. AddIndented(FORMAT(L"<group name=\"%s\" start=\"%s\">",
  1621. (XmlAttributeEscape(Name), StandardTimestamp())));
  1622. FIndent = L" ";
  1623. }
  1624. //---------------------------------------------------------------------------
  1625. void __fastcall TActionLog::EndGroup()
  1626. {
  1627. DebugAssert(FInGroup);
  1628. FInGroup = false;
  1629. DebugAssert(FIndent == L" ");
  1630. FIndent = L" ";
  1631. // this is called from ReflectSettings that in turn is called when logging fails,
  1632. // so do not try to close the group, if it has not been opened, to avoid recursion
  1633. if (FFile != NULL)
  1634. {
  1635. AddIndented(L"</group>");
  1636. }
  1637. }
  1638. //---------------------------------------------------------------------------
  1639. void __fastcall TActionLog::SetEnabled(bool value)
  1640. {
  1641. if (Enabled != value)
  1642. {
  1643. FEnabled = value;
  1644. ReflectSettings();
  1645. }
  1646. }