123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617 |
- //---------------------------------------------------------------------------
- #include <vcl.h>
- #pragma hdrstop
- #include <stdio.h>
- #include <lmcons.h>
- #define SECURITY_WIN32
- #include <sspi.h>
- #include <secext.h>
- #include "Common.h"
- #include "SessionInfo.h"
- #include "Exceptions.h"
- #include "TextsCore.h"
- #include "CoreMain.h"
- #include "Script.h"
- //---------------------------------------------------------------------------
- #pragma package(smart_init)
- //---------------------------------------------------------------------------
- UnicodeString __fastcall DoXmlEscape(UnicodeString Str, bool NewLine)
- {
- for (int i = 1; i <= Str.Length(); i++)
- {
- UnicodeString Repl;
- switch (Str[i])
- {
- case L'\x00': // \0 Is not valid in XML anyway
- case L'\x01':
- case L'\x02':
- case L'\x03':
- case L'\x04':
- case L'\x05':
- case L'\x06':
- case L'\x07':
- case L'\x08':
- // \n is handled below
- case L'\x0B':
- case L'\x0C':
- // \r is handled below
- case L'\x0E':
- case L'\x0F':
- case L'\x10':
- case L'\x11':
- case L'\x12':
- case L'\x13':
- case L'\x14':
- case L'\x15':
- case L'\x16':
- case L'\x17':
- case L'\x18':
- case L'\x19':
- case L'\x1A':
- case L'\x1B':
- case L'\x1C':
- case L'\x1D':
- case L'\x1E':
- case L'\x1F':
- Repl = L"#x" + ByteToHex((unsigned char)Str[i]) + L";";
- break;
- case L'&':
- Repl = L"amp;";
- break;
- case L'>':
- Repl = L"gt;";
- break;
- case L'<':
- Repl = L"lt;";
- break;
- case L'"':
- Repl = L"quot;";
- break;
- case L'\n':
- if (NewLine)
- {
- Repl = L"#10;";
- }
- break;
- case L'\r':
- Str.Delete(i, 1);
- i--;
- break;
- }
- if (!Repl.IsEmpty())
- {
- Str[i] = L'&';
- Str.Insert(Repl, i + 1);
- i += Repl.Length();
- }
- }
- return Str;
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall XmlEscape(UnicodeString Str)
- {
- return DoXmlEscape(Str, false);
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall XmlAttributeEscape(UnicodeString Str)
- {
- return DoXmlEscape(Str, true);
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- #pragma warn -inl
- class TSessionActionRecord
- {
- public:
- __fastcall TSessionActionRecord(TActionLog * Log, TLogAction Action) :
- FLog(Log),
- FAction(Action),
- FState(Opened),
- FRecursive(false),
- FErrorMessages(NULL),
- FNames(new TStringList()),
- FValues(new TStringList()),
- FFileList(NULL),
- FFile(NULL)
- {
- FLog->AddPendingAction(this);
- }
- __fastcall ~TSessionActionRecord()
- {
- delete FErrorMessages;
- delete FNames;
- delete FValues;
- delete FFileList;
- delete FFile;
- }
- void __fastcall Restart()
- {
- FState = Opened;
- FRecursive = false;
- delete FErrorMessages;
- FErrorMessages = NULL;
- delete FFileList;
- FFileList = NULL;
- delete FFile;
- FFile = NULL;
- FNames->Clear();
- FValues->Clear();
- }
- bool __fastcall Record()
- {
- bool Result = (FState != Opened);
- if (Result)
- {
- if (FLog->FLogging && (FState != Cancelled))
- {
- const wchar_t * Name = ActionName();
- UnicodeString Attrs;
- if (FRecursive)
- {
- Attrs = L" recursive=\"true\"";
- }
- FLog->AddIndented(FORMAT(L"<%s%s>", (Name, Attrs)));
- for (int Index = 0; Index < FNames->Count; Index++)
- {
- UnicodeString Value = FValues->Strings[Index];
- if (Value.IsEmpty())
- {
- FLog->AddIndented(FORMAT(L" <%s />", (FNames->Strings[Index])));
- }
- else
- {
- FLog->AddIndented(FORMAT(L" <%s value=\"%s\" />",
- (FNames->Strings[Index], XmlAttributeEscape(Value))));
- }
- }
- if (FFileList != NULL)
- {
- FLog->AddIndented(L" <files>");
- for (int Index = 0; Index < FFileList->Count; Index++)
- {
- TRemoteFile * File = FFileList->Files[Index];
- RecordFile(L" ", File, true);
- }
- FLog->AddIndented(L" </files>");
- }
- if (FFile != NULL)
- {
- RecordFile(L" ", FFile, false);
- }
- if (FState == RolledBack)
- {
- if (FErrorMessages != NULL)
- {
- FLog->AddIndented(L" <result success=\"false\">");
- FLog->AddMessages(L" ", FErrorMessages);
- FLog->AddIndented(L" </result>");
- }
- else
- {
- FLog->AddIndented(L" <result success=\"false\" />");
- }
- }
- else
- {
- FLog->AddIndented(L" <result success=\"true\" />");
- }
- FLog->AddIndented(FORMAT(L"</%s>", (Name)));
- }
- delete this;
- }
- return Result;
- }
- void __fastcall Commit()
- {
- Close(Committed);
- }
- void __fastcall Rollback(Exception * E)
- {
- DebugAssert(FErrorMessages == NULL);
- FErrorMessages = ExceptionToMoreMessages(E);
- Close(RolledBack);
- }
- void __fastcall Cancel()
- {
- Close(Cancelled);
- }
- void __fastcall FileName(const UnicodeString & FileName)
- {
- Parameter(L"filename", FileName);
- }
- void __fastcall Destination(const UnicodeString & Destination)
- {
- Parameter(L"destination", Destination);
- }
- void __fastcall Rights(const TRights & Rights)
- {
- Parameter(L"permissions", Rights.Text);
- }
- void __fastcall Modification(const TDateTime & DateTime)
- {
- Parameter(L"modification", StandardTimestamp(DateTime));
- }
- void __fastcall Recursive()
- {
- FRecursive = true;
- }
- void __fastcall Command(const UnicodeString & Command)
- {
- Parameter(L"command", Command);
- }
- void __fastcall AddOutput(UnicodeString Output, bool StdError)
- {
- const wchar_t * Name = (StdError ? L"erroroutput" : L"output");
- int Index = FNames->IndexOf(Name);
- if (Index >= 0)
- {
- FValues->Strings[Index] = FValues->Strings[Index] + L"\r\n" + Output;
- }
- else
- {
- Parameter(Name, Output);
- }
- }
- void __fastcall ExitCode(int ExitCode)
- {
- Parameter(L"exitcode", IntToStr(ExitCode));
- }
- void __fastcall Checksum(const UnicodeString & Alg, const UnicodeString & Checksum)
- {
- Parameter(L"algorithm", Alg);
- Parameter(L"checksum", Checksum);
- }
- void __fastcall Cwd(const UnicodeString & Path)
- {
- Parameter(L"cwd", Path);
- }
- void __fastcall FileList(TRemoteFileList * FileList)
- {
- if (FFileList == NULL)
- {
- FFileList = new TRemoteFileList();
- }
- FileList->DuplicateTo(FFileList);
- }
- void __fastcall File(TRemoteFile * File)
- {
- if (FFile != NULL)
- {
- delete FFile;
- }
- FFile = File->Duplicate(true);
- }
- protected:
- enum TState { Opened, Committed, RolledBack, Cancelled };
- inline void __fastcall Close(TState State)
- {
- DebugAssert(FState == Opened);
- FState = State;
- FLog->RecordPendingActions();
- }
- const wchar_t * __fastcall ActionName()
- {
- switch (FAction)
- {
- case laUpload: return L"upload";
- case laDownload: return L"download";
- case laTouch: return L"touch";
- case laChmod: return L"chmod";
- case laMkdir: return L"mkdir";
- case laRm: return L"rm";
- case laMv: return L"mv";
- case laCp: return L"cp";
- case laCall: return L"call";
- case laLs: return L"ls";
- case laStat: return L"stat";
- case laChecksum: return L"checksum";
- case laCwd: return L"cwd";
- default: DebugFail(); return L"";
- }
- }
- void __fastcall Parameter(const UnicodeString & Name, const UnicodeString & Value = L"")
- {
- FNames->Add(Name);
- FValues->Add(Value);
- }
- void __fastcall RecordFile(const UnicodeString & Indent, TRemoteFile * File, bool IncludeFileName)
- {
- FLog->AddIndented(Indent + L"<file>");
- FLog->AddIndented(Indent + FORMAT(L" <filename value=\"%s\" />", (XmlAttributeEscape(File->FileName))));
- FLog->AddIndented(Indent + FORMAT(L" <type value=\"%s\" />", (XmlAttributeEscape(File->Type))));
- if (!File->IsDirectory)
- {
- FLog->AddIndented(Indent + FORMAT(L" <size value=\"%s\" />", (IntToStr(File->Size))));
- }
- if (File->ModificationFmt != mfNone)
- {
- FLog->AddIndented(Indent + FORMAT(L" <modification value=\"%s\" />", (StandardTimestamp(File->Modification))));
- }
- if (!File->Rights->Unknown)
- {
- FLog->AddIndented(Indent + FORMAT(L" <permissions value=\"%s\" />", (XmlAttributeEscape(File->Rights->Text))));
- }
- if (File->Owner.IsSet)
- {
- FLog->AddIndented(Indent + FORMAT(L" <owner value=\"%s\" />", (XmlAttributeEscape(File->Owner.DisplayText))));
- }
- if (File->Group.IsSet)
- {
- FLog->AddIndented(Indent + FORMAT(L" <group value=\"%s\" />", (XmlAttributeEscape(File->Group.DisplayText))));
- }
- FLog->AddIndented(Indent + L"</file>");
- }
- private:
- TActionLog * FLog;
- TLogAction FAction;
- TState FState;
- bool FRecursive;
- TStrings * FErrorMessages;
- TStrings * FNames;
- TStrings * FValues;
- TRemoteFileList * FFileList;
- TRemoteFile * FFile;
- };
- #pragma warn .inl
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TSessionAction::TSessionAction(TActionLog * Log, TLogAction Action)
- {
- if (Log->FLogging)
- {
- FRecord = new TSessionActionRecord(Log, Action);
- }
- else
- {
- FRecord = NULL;
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TSessionAction::~TSessionAction()
- {
- if (FRecord != NULL)
- {
- Commit();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionAction::Restart()
- {
- if (FRecord != NULL)
- {
- FRecord->Restart();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionAction::Commit()
- {
- if (FRecord != NULL)
- {
- TSessionActionRecord * Record = FRecord;
- FRecord = NULL;
- Record->Commit();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionAction::Rollback(Exception * E)
- {
- if (FRecord != NULL)
- {
- TSessionActionRecord * Record = FRecord;
- FRecord = NULL;
- Record->Rollback(E);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionAction::Cancel()
- {
- if (FRecord != NULL)
- {
- TSessionActionRecord * Record = FRecord;
- FRecord = NULL;
- Record->Cancel();
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TFileSessionAction::TFileSessionAction(TActionLog * Log, TLogAction Action) :
- TSessionAction(Log, Action)
- {
- }
- //---------------------------------------------------------------------------
- __fastcall TFileSessionAction::TFileSessionAction(
- TActionLog * Log, TLogAction Action, const UnicodeString & AFileName) :
- TSessionAction(Log, Action)
- {
- FileName(AFileName);
- }
- //---------------------------------------------------------------------------
- void __fastcall TFileSessionAction::FileName(const UnicodeString & FileName)
- {
- if (FRecord != NULL)
- {
- FRecord->FileName(FileName);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TFileLocationSessionAction::TFileLocationSessionAction(
- TActionLog * Log, TLogAction Action) :
- TFileSessionAction(Log, Action)
- {
- }
- //---------------------------------------------------------------------------
- __fastcall TFileLocationSessionAction::TFileLocationSessionAction(
- TActionLog * Log, TLogAction Action, const UnicodeString & FileName) :
- TFileSessionAction(Log, Action, FileName)
- {
- }
- //---------------------------------------------------------------------------
- void __fastcall TFileLocationSessionAction::Destination(const UnicodeString & Destination)
- {
- if (FRecord != NULL)
- {
- FRecord->Destination(Destination);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TUploadSessionAction::TUploadSessionAction(TActionLog * Log) :
- TFileLocationSessionAction(Log, laUpload)
- {
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TDownloadSessionAction::TDownloadSessionAction(TActionLog * Log) :
- TFileLocationSessionAction(Log, laDownload)
- {
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TChmodSessionAction::TChmodSessionAction(
- TActionLog * Log, const UnicodeString & FileName) :
- TFileSessionAction(Log, laChmod, FileName)
- {
- }
- //---------------------------------------------------------------------------
- void __fastcall TChmodSessionAction::Recursive()
- {
- if (FRecord != NULL)
- {
- FRecord->Recursive();
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TChmodSessionAction::TChmodSessionAction(
- TActionLog * Log, const UnicodeString & FileName, const TRights & ARights) :
- TFileSessionAction(Log, laChmod, FileName)
- {
- Rights(ARights);
- }
- //---------------------------------------------------------------------------
- void __fastcall TChmodSessionAction::Rights(const TRights & Rights)
- {
- if (FRecord != NULL)
- {
- FRecord->Rights(Rights);
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TTouchSessionAction::TTouchSessionAction(
- TActionLog * Log, const UnicodeString & FileName, const TDateTime & Modification) :
- TFileSessionAction(Log, laTouch, FileName)
- {
- if (FRecord != NULL)
- {
- FRecord->Modification(Modification);
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TMkdirSessionAction::TMkdirSessionAction(
- TActionLog * Log, const UnicodeString & FileName) :
- TFileSessionAction(Log, laMkdir, FileName)
- {
- }
- //---------------------------------------------------------------------------
- __fastcall TRmSessionAction::TRmSessionAction(
- TActionLog * Log, const UnicodeString & FileName) :
- TFileSessionAction(Log, laRm, FileName)
- {
- }
- //---------------------------------------------------------------------------
- void __fastcall TRmSessionAction::Recursive()
- {
- if (FRecord != NULL)
- {
- FRecord->Recursive();
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TMvSessionAction::TMvSessionAction(TActionLog * Log,
- const UnicodeString & FileName, const UnicodeString & ADestination) :
- TFileLocationSessionAction(Log, laMv, FileName)
- {
- Destination(ADestination);
- }
- //---------------------------------------------------------------------------
- __fastcall TCpSessionAction::TCpSessionAction(TActionLog * Log,
- const UnicodeString & FileName, const UnicodeString & ADestination) :
- TFileLocationSessionAction(Log, laCp, FileName)
- {
- Destination(ADestination);
- }
- //---------------------------------------------------------------------------
- __fastcall TCallSessionAction::TCallSessionAction(TActionLog * Log,
- const UnicodeString & Command, const UnicodeString & Destination) :
- TSessionAction(Log, laCall)
- {
- if (FRecord != NULL)
- {
- FRecord->Command(Command);
- FRecord->Destination(Destination);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TCallSessionAction::AddOutput(const UnicodeString & Output, bool StdError)
- {
- if (FRecord != NULL)
- {
- FRecord->AddOutput(Output, StdError);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TCallSessionAction::ExitCode(int ExitCode)
- {
- if (FRecord != NULL)
- {
- FRecord->ExitCode(ExitCode);
- }
- }
- //---------------------------------------------------------------------------
- __fastcall TLsSessionAction::TLsSessionAction(TActionLog * Log,
- const UnicodeString & Destination) :
- TSessionAction(Log, laLs)
- {
- if (FRecord != NULL)
- {
- FRecord->Destination(Destination);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TLsSessionAction::FileList(TRemoteFileList * FileList)
- {
- if (FRecord != NULL)
- {
- FRecord->FileList(FileList);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TStatSessionAction::TStatSessionAction(TActionLog * Log, const UnicodeString & FileName) :
- TFileSessionAction(Log, laStat, FileName)
- {
- }
- //---------------------------------------------------------------------------
- void __fastcall TStatSessionAction::File(TRemoteFile * File)
- {
- if (FRecord != NULL)
- {
- FRecord->File(File);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TChecksumSessionAction::TChecksumSessionAction(TActionLog * Log) :
- TFileSessionAction(Log, laChecksum)
- {
- }
- //---------------------------------------------------------------------------
- void __fastcall TChecksumSessionAction::Checksum(const UnicodeString & Alg, const UnicodeString & Checksum)
- {
- if (FRecord != NULL)
- {
- FRecord->Checksum(Alg, Checksum);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TCwdSessionAction::TCwdSessionAction(TActionLog * Log, const UnicodeString & Path) :
- TSessionAction(Log, laCwd)
- {
- if (FRecord != NULL)
- {
- FRecord->Cwd(Path);
- }
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- TSessionInfo::TSessionInfo()
- {
- LoginTime = Now();
- CertificateVerifiedManually = false;
- }
- //---------------------------------------------------------------------------
- TFileSystemInfo::TFileSystemInfo()
- {
- memset(&IsCapable, false, sizeof(IsCapable));
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- FILE * __fastcall OpenFile(UnicodeString LogFileName, TDateTime Started, TSessionData * SessionData, bool Append, UnicodeString & NewFileName)
- {
- FILE * Result;
- UnicodeString ANewFileName = GetExpandedLogFileName(LogFileName, Started, SessionData);
- Result = _wfopen(ApiPath(ANewFileName).c_str(), (Append ? L"ab" : L"wb"));
- if (Result != NULL)
- {
- setvbuf(Result, NULL, _IONBF, BUFSIZ);
- NewFileName = ANewFileName;
- }
- else
- {
- throw ECRTExtException(FMTLOAD(LOG_OPENERROR, (ANewFileName)));
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- const wchar_t *LogLineMarks = L"<>!.*";
- __fastcall TSessionLog::TSessionLog(TSessionUI* UI, TDateTime Started, TSessionData * SessionData,
- TConfiguration * Configuration)
- {
- FCriticalSection = new TCriticalSection;
- FLogging = false;
- FConfiguration = Configuration;
- FParent = NULL;
- FUI = UI;
- FSessionData = SessionData;
- FStarted = Started;
- FFile = NULL;
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- FClosed = false;
- }
- //---------------------------------------------------------------------------
- __fastcall TSessionLog::~TSessionLog()
- {
- FClosed = true;
- ReflectSettings();
- DebugAssert(FFile == NULL);
- delete FCriticalSection;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::SetParent(TSessionLog * Parent, const UnicodeString & Name)
- {
- FParent = Parent;
- FName = Name;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::DoAddToParent(TLogLineType Type, const UnicodeString & Line)
- {
- DebugAssert(FParent != NULL);
- FParent->Add(Type, Line);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::DoAddToSelf(TLogLineType Type, const UnicodeString & Line)
- {
- if (LogToFile())
- {
- if (FFile == NULL)
- {
- OpenLogFile();
- }
- if (FFile != NULL)
- {
- UnicodeString Timestamp = FormatDateTime(L" yyyy-mm-dd hh:nn:ss.zzz ", Now());
- UTF8String UtfLine = UTF8String(UnicodeString(LogLineMarks[Type]) + Timestamp + Line + L"\r\n");
- for (int Index = 1; Index <= UtfLine.Length(); Index++)
- {
- if ((UtfLine[Index] == '\n') &&
- ((Index == 1) || (UtfLine[Index - 1] != '\r')))
- {
- UtfLine.Insert('\r', Index);
- }
- }
- int Writting = UtfLine.Length();
- CheckSize(Writting);
- FCurrentFileSize += fwrite(UtfLine.c_str(), 1, Writting, (FILE *)FFile);
- }
- }
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TSessionLog::LogPartFileName(const UnicodeString & BaseName, int Index)
- {
- UnicodeString Result;
- if (Index >= 1)
- {
- Result = FORMAT(L"%s.%d", (BaseName, Index));
- }
- else
- {
- Result = BaseName;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::CheckSize(__int64 Addition)
- {
- __int64 MaxSize = FConfiguration->LogMaxSize;
- if ((MaxSize > 0) && (FCurrentFileSize + Addition >= MaxSize))
- {
- // Before we close it
- UnicodeString BaseName = FCurrentFileName;
- CloseLogFile();
- FCurrentFileSize = 0;
- int Index = 0;
- while (FileExists(LogPartFileName(BaseName, Index + 1)))
- {
- Index++;
- }
- int MaxCount = FConfiguration->LogMaxCount;
- do
- {
- UnicodeString LogPart = LogPartFileName(BaseName, Index);
- if ((MaxCount > 0) && (Index >= MaxCount))
- {
- DeleteFileChecked(LogPart);
- }
- else
- {
- THROWOSIFFALSE(RenameFile(LogPart, LogPartFileName(BaseName, Index + 1)));
- }
- Index--;
- }
- while (Index >= 0);
- OpenLogFile();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::DoAdd(TLogLineType Type, UnicodeString Line,
- void __fastcall (__closure *f)(TLogLineType Type, const UnicodeString & Line))
- {
- UnicodeString Prefix;
- if (!FName.IsEmpty())
- {
- Prefix = L"[" + FName + L"] ";
- }
- while (!Line.IsEmpty())
- {
- f(Type, Prefix + CutToChar(Line, L'\n', false));
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::Add(TLogLineType Type, const UnicodeString & Line)
- {
- DebugAssert(FConfiguration);
- if (Logging)
- {
- try
- {
- if (FParent != NULL)
- {
- DoAdd(Type, Line, DoAddToParent);
- }
- else
- {
- TGuard Guard(FCriticalSection);
- DoAdd(Type, Line, DoAddToSelf);
- }
- }
- catch (Exception &E)
- {
- // We failed logging, turn it off and notify user.
- FConfiguration->Logging = false;
- try
- {
- throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
- }
- catch (Exception &E)
- {
- AddException(&E);
- FUI->HandleExtendedException(&E);
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddException(Exception * E)
- {
- if (E != NULL)
- {
- Add(llException, ExceptionLogString(E));
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::ReflectSettings()
- {
- TGuard Guard(FCriticalSection);
- FLogging =
- !FClosed &&
- ((FParent != NULL) || FConfiguration->Logging);
- // if logging to file was turned off or log file was changed -> close current log file
- if ((FFile != NULL) &&
- (!LogToFile() || (FCurrentLogFileName != FConfiguration->LogFileName)))
- {
- CloseLogFile();
- }
- if (FFile != NULL)
- {
- CheckSize(0);
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TSessionLog::LogToFile()
- {
- return Logging && FConfiguration->LogToFile && (FParent == NULL);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::CloseLogFile()
- {
- if (FFile != NULL)
- {
- fclose((FILE *)FFile);
- FFile = NULL;
- }
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::OpenLogFile()
- {
- try
- {
- DebugAssert(FFile == NULL);
- DebugAssert(FConfiguration != NULL);
- FCurrentLogFileName = FConfiguration->LogFileName;
- FFile = OpenFile(FCurrentLogFileName, FStarted, FSessionData, FConfiguration->LogFileAppend, FCurrentFileName);
- TSearchRec SearchRec;
- if (FileSearchRec(FCurrentFileName, SearchRec))
- {
- FCurrentFileSize = SearchRec.Size;
- }
- else
- {
- FCurrentFileSize = 0;
- }
- }
- catch (Exception & E)
- {
- // We failed logging to file, turn it off and notify user.
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- FConfiguration->LogFileName = UnicodeString();
- try
- {
- throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
- }
- catch (Exception & E)
- {
- AddException(&E);
- // not to deadlock with TSessionLog::ReflectSettings invoked by FConfiguration->LogFileName setter above
- TUnguard Unguard(FCriticalSection);
- FUI->HandleExtendedException(&E);
- }
- }
- // in case we are appending and the existing log file is already too large
- if (FFile != NULL)
- {
- CheckSize(0);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddSystemInfo()
- {
- AddStartupInfo(true);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddStartupInfo()
- {
- AddStartupInfo(false);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddStartupInfo(bool System)
- {
- TSessionData * Data = (System ? NULL : FSessionData);
- if (Logging)
- {
- if (FParent != NULL)
- {
- // do not add session info for secondary session
- // (this should better be handled in the TSecondaryTerminal)
- }
- else
- {
- DoAddStartupInfo(Data);
- }
- }
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TSessionLog::GetTlsVersionName(TTlsVersion TlsVersion)
- {
- switch (TlsVersion)
- {
- default:
- DebugFail();
- case ssl2:
- return "SSLv2";
- case ssl3:
- return "SSLv3";
- case tls10:
- return "TLSv1.0";
- case tls11:
- return "TLSv1.1";
- case tls12:
- return "TLSv1.2";
- }
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TSessionLog::LogSensitive(const UnicodeString & Str)
- {
- if (FConfiguration->LogSensitive && !Str.IsEmpty())
- {
- return Str;
- }
- else
- {
- return BooleanToEngStr(!Str.IsEmpty());
- }
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TSessionLog::GetCmdLineLog()
- {
- UnicodeString Result = CmdLine;
- if (!Configuration->LogSensitive)
- {
- TManagementScript Script(StoredSessions, false);
- Script.MaskPasswordInCommandLine(Result, true);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- template <typename T>
- UnicodeString __fastcall EnumName(T Value, UnicodeString Names)
- {
- int N = int(Value);
- do
- {
- UnicodeString Name = CutToChar(Names, L';', true);
- if (N == 0)
- {
- return Name;
- }
- N--;
- }
- while ((N >= 0) && !Names.IsEmpty());
- return L"(unknown)";
- }
- //---------------------------------------------------------------------------
- #define ADSTR(S) DoAdd(llMessage, S, DoAddToSelf);
- #define ADF(S, F) ADSTR(FORMAT(S, F));
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::DoAddStartupInfo(TSessionData * Data)
- {
- if (Data == NULL)
- {
- AddSeparator();
- UnicodeString OS = WindowsVersionLong();
- AddToList(OS, WindowsProductName(), L" - ");
- ADF(L"WinSCP %s (OS %s)", (FConfiguration->VersionStr, OS));
- THierarchicalStorage * Storage = FConfiguration->CreateConfigStorage();
- try
- {
- ADF(L"Configuration: %s", (Storage->Source));
- }
- __finally
- {
- delete Storage;
- }
- wchar_t UserName[UNLEN + 1];
- unsigned long UserNameSize = LENOF(UserName);
- if (DebugAlwaysFalse(!GetUserNameEx(NameSamCompatible, UserName, &UserNameSize)))
- {
- wcscpy(UserName, L"<Failed to retrieve username>");
- }
- UnicodeString LogStr;
- if (FConfiguration->LogProtocol <= -1)
- {
- LogStr = L"Reduced";
- }
- else if (FConfiguration->LogProtocol <= 0)
- {
- LogStr = L"Normal";
- }
- else if (FConfiguration->LogProtocol == 1)
- {
- LogStr = L"Debug 1";
- }
- else if (FConfiguration->LogProtocol >= 2)
- {
- LogStr = L"Debug 2";
- }
- if (FConfiguration->LogSensitive)
- {
- LogStr += L", Logging passwords";
- }
- if (FConfiguration->LogMaxSize > 0)
- {
- LogStr += FORMAT(L", Rotating after: %s", (SizeToStr(FConfiguration->LogMaxSize)));
- if (FConfiguration->LogMaxCount > 0)
- {
- LogStr += FORMAT(L", Keeping at most %d logs", (FConfiguration->LogMaxCount));
- }
- }
- ADF(L"Log level: %s", (LogStr));
- ADF(L"Local account: %s", (UserName));
- ADF(L"Working directory: %s", (GetCurrentDir()));
- ADF(L"Process ID: %d", (int(GetCurrentProcessId())));
- ADF(L"Command-line: %s", (GetCmdLineLog()));
- if (FConfiguration->LogProtocol >= 1)
- {
- AddOptions(GetGlobalOptions());
- }
- ADF(L"Time zone: %s", (GetTimeZoneLogString()));
- if (!AdjustClockForDSTEnabled())
- {
- ADSTR(L"Warning: System option \"Automatically adjust clock for Daylight Saving Time\" is disabled, timestamps will not be represented correctly");
- }
- ADF(L"Login time: %s", (FormatDateTime(L"dddddd tt", Now())));
- AddSeparator();
- }
- else
- {
- ADF(L"Session name: %s (%s)", (Data->SessionName, Data->Source));
- ADF(L"Host name: %s (Port: %d)", (Data->HostNameExpanded, Data->PortNumber));
- ADF(L"User name: %s (Password: %s, Key file: %s, Passphrase: %s)",
- (Data->UserNameExpanded, LogSensitive(NormalizeString(Data->Password)),
- LogSensitive(Data->PublicKeyFile), LogSensitive(Data->Passphrase)));
- if (Data->UsesSsh)
- {
- ADF(L"Tunnel: %s", (BooleanToEngStr(Data->Tunnel)));
- if (Data->Tunnel)
- {
- ADF(L"Tunnel: Host name: %s (Port: %d)", (Data->TunnelHostName, Data->TunnelPortNumber));
- ADF(L"Tunnel: User name: %s (Password: %s, Key file: %s)",
- (Data->TunnelUserName,
- LogSensitive(Data->TunnelPassword),
- LogSensitive(Data->TunnelPublicKeyFile)));
- ADF(L"Tunnel: Local port number: %d", (Data->TunnelLocalPortNumber));
- }
- }
- ADF(L"Transfer Protocol: %s", (Data->FSProtocolStr));
- if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
- {
- TPingType PingType;
- int PingInterval;
- if (Data->FSProtocol == fsFTP)
- {
- PingType = Data->FtpPingType;
- PingInterval = Data->FtpPingInterval;
- }
- else
- {
- PingType = Data->PingType;
- PingInterval = Data->PingInterval;
- }
- ADF(L"Ping type: %s, Ping interval: %d sec; Timeout: %d sec",
- (EnumName(PingType, PingTypeNames), PingInterval, Data->Timeout));
- ADF(L"Disable Nagle: %s",
- (BooleanToEngStr(Data->TcpNoDelay)));
- }
- ADF(L"Proxy: %s",
- ((Data->FtpProxyLogonType != 0) ?
- FORMAT(L"FTP proxy %d", (Data->FtpProxyLogonType)) :
- EnumName(Data->ProxyMethod, ProxyMethodNames)));
- if ((Data->FtpProxyLogonType != 0) || (Data->ProxyMethod != ::pmNone))
- {
- ADF(L"HostName: %s (Port: %d); Username: %s; Passwd: %s",
- (Data->ProxyHost, Data->ProxyPort,
- Data->ProxyUsername, LogSensitive(Data->ProxyPassword)));
- if (Data->ProxyMethod == pmTelnet)
- {
- ADF(L"Telnet command: %s", (Data->ProxyTelnetCommand));
- }
- if (Data->ProxyMethod == pmCmd)
- {
- ADF(L"Local command: %s", (Data->ProxyLocalCommand));
- }
- }
- if (Data->UsesSsh || (Data->FSProtocol == fsFTP))
- {
- ADF(L"Send buffer: %d", (Data->SendBuf));
- }
- if (Data->UsesSsh)
- {
- ADF(L"SSH protocol version: %s; Compression: %s",
- (Data->SshProtStr, BooleanToEngStr(Data->Compression)));
- ADF(L"Bypass authentication: %s",
- (BooleanToEngStr(Data->SshNoUserAuth)));
- ADF(L"Try agent: %s; Agent forwarding: %s; TIS/CryptoCard: %s; KI: %s; GSSAPI: %s",
- (BooleanToEngStr(Data->TryAgent), BooleanToEngStr(Data->AgentFwd), BooleanToEngStr(Data->AuthTIS),
- BooleanToEngStr(Data->AuthKI), BooleanToEngStr(Data->AuthGSSAPI)));
- if (Data->AuthGSSAPI)
- {
- ADF(L"GSSAPI: Forwarding: %s; Libs: %s; Custom: %s",
- (BooleanToEngStr(Data->GSSAPIFwdTGT), Data->GssLibList, Data->GssLibCustom));
- }
- ADF(L"Ciphers: %s; Ssh2DES: %s",
- (Data->CipherList, BooleanToEngStr(Data->Ssh2DES)));
- ADF(L"KEX: %s", (Data->KexList));
- UnicodeString Bugs;
- for (int Index = 0; Index < BUG_COUNT; Index++)
- {
- AddToList(Bugs, EnumName(Data->Bug[(TSshBug)Index], AutoSwitchNames), L",");
- }
- ADF(L"SSH Bugs: %s", (Bugs));
- ADF(L"Simple channel: %s", (BooleanToEngStr(Data->SshSimple)));
- ADF(L"Return code variable: %s; Lookup user groups: %s",
- ((Data->DetectReturnVar ? UnicodeString(L"Autodetect") : Data->ReturnVar),
- EnumName(Data->LookupUserGroups, AutoSwitchNames)));
- ADF(L"Shell: %s", ((Data->Shell.IsEmpty()? UnicodeString(L"default") : Data->Shell)));
- ADF(L"EOL: %s, UTF: %s", (EnumName(Data->EOLType, EOLTypeNames), EnumName(Data->NotUtf, NotAutoSwitchNames))); // NotUtf duplicated in FTP branch
- ADF(L"Clear aliases: %s, Unset nat.vars: %s, Resolve symlinks: %s; Follow directory symlinks: %s",
- (BooleanToEngStr(Data->ClearAliases), BooleanToEngStr(Data->UnsetNationalVars),
- BooleanToEngStr(Data->ResolveSymlinks), BooleanToEngStr(Data->FollowDirectorySymlinks)));
- ADF(L"LS: %s, Ign LS warn: %s, Scp1 Comp: %s",
- (Data->ListingCommand,
- BooleanToEngStr(Data->IgnoreLsWarnings),
- BooleanToEngStr(Data->Scp1Compatibility)));
- }
- if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly))
- {
- UnicodeString Bugs;
- for (int Index = 0; Index < SFTP_BUG_COUNT; Index++)
- {
- AddToList(Bugs, EnumName(Data->SFTPBug[(TSftpBug)Index], AutoSwitchNames), L",");
- }
- ADF(L"SFTP Bugs: %s", (Bugs));
- ADF(L"SFTP Server: %s", ((Data->SftpServer.IsEmpty()? UnicodeString(L"default") : Data->SftpServer)));
- }
- bool FtpsOn = false;
- if (Data->FSProtocol == fsFTP)
- {
- ADF(L"UTF: %s", (EnumName(Data->NotUtf, NotAutoSwitchNames))); // duplicated in UsesSsh branch
- UnicodeString Ftps;
- switch (Data->Ftps)
- {
- case ftpsImplicit:
- Ftps = L"Implicit TLS/SSL";
- FtpsOn = true;
- break;
- case ftpsExplicitSsl:
- Ftps = L"Explicit SSL/TLS";
- FtpsOn = true;
- break;
- case ftpsExplicitTls:
- Ftps = L"Explicit TLS/SSL";
- FtpsOn = true;
- break;
- default:
- DebugAssert(Data->Ftps == ftpsNone);
- Ftps = L"None";
- break;
- }
- // kind of hidden option, so do not reveal it unless it is set
- if (Data->FtpTransferActiveImmediately != asAuto)
- {
- ADF(L"Transfer active immediately: %s", (EnumName(Data->FtpTransferActiveImmediately, AutoSwitchNames)));
- }
- ADF(L"FTPS: %s [Client certificate: %s]",
- (Ftps, LogSensitive(Data->TlsCertificateFile)));
- ADF(L"FTP: Passive: %s [Force IP: %s]; MLSD: %s [List all: %s]; HOST: %s",
- (BooleanToEngStr(Data->FtpPasvMode),
- EnumName(Data->FtpForcePasvIp, AutoSwitchNames),
- EnumName(Data->FtpUseMlsd, AutoSwitchNames),
- EnumName(Data->FtpListAll, AutoSwitchNames),
- EnumName(Data->FtpHost, AutoSwitchNames)));
- }
- if (Data->FSProtocol == fsWebDAV)
- {
- FtpsOn = (Data->Ftps != ftpsNone);
- ADF(L"HTTPS: %s [Client certificate: %s]",
- (BooleanToEngStr(FtpsOn), LogSensitive(Data->TlsCertificateFile)));
- }
- if (Data->FSProtocol == fsS3)
- {
- FtpsOn = (Data->Ftps != ftpsNone);
- ADF(L"HTTPS: %s", (BooleanToEngStr(FtpsOn)));
- if (!Data->S3DefaultRegion.IsEmpty())
- {
- ADF(L"S3: Default region: %s", (Data->S3DefaultRegion));
- }
- }
- if (FtpsOn)
- {
- if (Data->FSProtocol == fsFTP)
- {
- ADF(L"Session reuse: %s", (BooleanToEngStr(Data->SslSessionReuse)));
- }
- ADF(L"TLS/SSL versions: %s-%s", (GetTlsVersionName(Data->MinTlsVersion), GetTlsVersionName(Data->MaxTlsVersion)));
- }
- ADF(L"Local directory: %s, Remote directory: %s, Update: %s, Cache: %s",
- ((Data->LocalDirectory.IsEmpty() ? UnicodeString(L"default") : Data->LocalDirectory),
- (Data->RemoteDirectory.IsEmpty() ? UnicodeString(L"home") : Data->RemoteDirectory),
- BooleanToEngStr(Data->UpdateDirectories),
- BooleanToEngStr(Data->CacheDirectories)));
- ADF(L"Cache directory changes: %s, Permanent: %s",
- (BooleanToEngStr(Data->CacheDirectoryChanges),
- BooleanToEngStr(Data->PreserveDirectoryChanges)));
- ADF(L"Recycle bin: Delete to: %s, Overwritten to: %s, Bin path: %s",
- (BooleanToEngStr(Data->DeleteToRecycleBin),
- BooleanToEngStr(Data->OverwrittenToRecycleBin),
- Data->RecycleBinPath));
- if (Data->TrimVMSVersions)
- {
- ADF(L"Trim VMS versions: %s",
- (BooleanToEngStr(Data->TrimVMSVersions)));
- }
- UnicodeString TimeInfo;
- if ((Data->FSProtocol == fsSFTP) || (Data->FSProtocol == fsSFTPonly) || (Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsWebDAV))
- {
- AddToList(TimeInfo, FORMAT(L"DST mode: %s", (EnumName(Data->DSTMode, DSTModeNames))), L";");
- }
- if ((Data->FSProtocol == fsSCPonly) || (Data->FSProtocol == fsFTP))
- {
- int TimeDifferenceMin = TimeToMinutes(Data->TimeDifference);
- AddToList(TimeInfo, FORMAT(L"Timezone offset: %dh %dm", ((TimeDifferenceMin / MinsPerHour), (TimeDifferenceMin % MinsPerHour))), L";");
- }
- ADSTR(TimeInfo);
- if (Data->FSProtocol == fsWebDAV)
- {
- ADF(L"Compression: %s",
- (BooleanToEngStr(Data->Compression)));
- }
- AddSeparator();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddOption(const UnicodeString & LogStr)
- {
- ADSTR(LogStr);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddOptions(TOptions * Options)
- {
- Options->LogOptions(AddOption);
- }
- //---------------------------------------------------------------------------
- #undef ADF
- #undef ADSTR
- //---------------------------------------------------------------------------
- void __fastcall TSessionLog::AddSeparator()
- {
- Add(llMessage, L"--------------------------------------------------------------------------");
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- __fastcall TActionLog::TActionLog(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
- TConfiguration * Configuration)
- {
- DebugAssert(UI != NULL);
- DebugAssert(SessionData != NULL);
- Init(UI, Started, SessionData, Configuration);
- }
- //---------------------------------------------------------------------------
- __fastcall TActionLog::TActionLog(TDateTime Started, TConfiguration * Configuration)
- {
- Init(NULL, Started, NULL, Configuration);
- // not associated with session, so no need to waiting for anything
- ReflectSettings();
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::Init(TSessionUI * UI, TDateTime Started, TSessionData * SessionData,
- TConfiguration * Configuration)
- {
- FCriticalSection = new TCriticalSection;
- FConfiguration = Configuration;
- FUI = UI;
- FSessionData = SessionData;
- FStarted = Started;
- FFile = NULL;
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- FLogging = false;
- FClosed = false;
- FFailed = false;
- FPendingActions = new TList();
- FIndent = L" ";
- FInGroup = false;
- FEnabled = true;
- }
- //---------------------------------------------------------------------------
- __fastcall TActionLog::~TActionLog()
- {
- DebugAssert(FPendingActions->Count == 0);
- delete FPendingActions;
- FClosed = true;
- ReflectSettings();
- DebugAssert(FFile == NULL);
- delete FCriticalSection;
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::Add(const UnicodeString & Line)
- {
- DebugAssert(FConfiguration);
- if (FLogging)
- {
- TGuard Guard(FCriticalSection);
- if (FFile == NULL)
- {
- OpenLogFile();
- }
- if (FFile != NULL)
- {
- try
- {
- UTF8String UtfLine = UTF8String(Line);
- size_t Written =
- fwrite(UtfLine.c_str(), 1, UtfLine.Length(), (FILE *)FFile);
- if (Written != static_cast<size_t>(UtfLine.Length()))
- {
- throw ECRTExtException(L"");
- }
- #ifdef _DEBUG
- #endif
- Written =
- fwrite("\n", 1, 1, (FILE *)FFile);
- if (Written != 1)
- {
- throw ECRTExtException(L"");
- }
- }
- catch (Exception &E)
- {
- FCriticalSection->Release();
- // avoid endless loop when trying to close tags when closing log, when logging has failed
- if (!FFailed)
- {
- FFailed = true;
- // We failed logging, turn it off and notify user.
- FConfiguration->LogActions = false;
- if (FConfiguration->LogActionsRequired)
- {
- throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
- }
- else
- {
- try
- {
- throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
- }
- catch (Exception &E)
- {
- if (FUI != NULL)
- {
- FUI->HandleExtendedException(&E);
- }
- }
- }
- }
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::AddIndented(const UnicodeString & Line)
- {
- Add(FIndent + Line);
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::AddFailure(TStrings * Messages)
- {
- AddIndented(L"<failure>");
- AddMessages(L" ", Messages);
- AddIndented(L"</failure>");
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::AddFailure(Exception * E)
- {
- TStrings * Messages = ExceptionToMoreMessages(E);
- if (Messages != NULL)
- {
- try
- {
- AddFailure(Messages);
- }
- __finally
- {
- delete Messages;
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::AddMessages(UnicodeString Indent, TStrings * Messages)
- {
- for (int Index = 0; Index < Messages->Count; Index++)
- {
- AddIndented(
- FORMAT(Indent + L"<message>%s</message>", (XmlEscape(Messages->Strings[Index]))));
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::ReflectSettings()
- {
- TGuard Guard(FCriticalSection);
- bool ALogging =
- !FClosed && FConfiguration->LogActions && Enabled;
- if (ALogging && !FLogging)
- {
- FLogging = true;
- Add(L"<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
- UnicodeString SessionName =
- (FSessionData != NULL) ? XmlAttributeEscape(FSessionData->SessionName) : UnicodeString(L"nosession");
- Add(FORMAT(L"<session xmlns=\"http://winscp.net/schema/session/1.0\" name=\"%s\" start=\"%s\">",
- (SessionName, StandardTimestamp())));
- }
- else if (!ALogging && FLogging)
- {
- if (FInGroup)
- {
- EndGroup();
- }
- // do not try to close the file, if it has not been opened, to avoid recursion
- if (FFile != NULL)
- {
- Add(L"</session>");
- }
- CloseLogFile();
- FLogging = false;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::CloseLogFile()
- {
- if (FFile != NULL)
- {
- fclose((FILE *)FFile);
- FFile = NULL;
- }
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::OpenLogFile()
- {
- try
- {
- DebugAssert(FFile == NULL);
- DebugAssert(FConfiguration != NULL);
- FCurrentLogFileName = FConfiguration->ActionsLogFileName;
- FFile = OpenFile(FCurrentLogFileName, FStarted, FSessionData, false, FCurrentFileName);
- }
- catch (Exception & E)
- {
- // We failed logging to file, turn it off and notify user.
- FCurrentLogFileName = L"";
- FCurrentFileName = L"";
- FConfiguration->LogActions = false;
- if (FConfiguration->LogActionsRequired)
- {
- throw EFatal(&E, LoadStr(LOG_FATAL_ERROR));
- }
- else
- {
- try
- {
- throw ExtException(&E, LoadStr(LOG_GEN_ERROR));
- }
- catch (Exception & E)
- {
- if (FUI != NULL)
- {
- // not to deadlock with TSessionLog::ReflectSettings invoked by FConfiguration->LogFileName setter above
- TUnguard Unguard(FCriticalSection);
- FUI->HandleExtendedException(&E);
- }
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::AddPendingAction(TSessionActionRecord * Action)
- {
- FPendingActions->Add(Action);
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::RecordPendingActions()
- {
- while ((FPendingActions->Count > 0) &&
- static_cast<TSessionActionRecord *>(FPendingActions->Items[0])->Record())
- {
- FPendingActions->Delete(0);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::BeginGroup(UnicodeString Name)
- {
- DebugAssert(!FInGroup);
- FInGroup = true;
- DebugAssert(FIndent == L" ");
- AddIndented(FORMAT(L"<group name=\"%s\" start=\"%s\">",
- (XmlAttributeEscape(Name), StandardTimestamp())));
- FIndent = L" ";
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::EndGroup()
- {
- DebugAssert(FInGroup);
- FInGroup = false;
- DebugAssert(FIndent == L" ");
- FIndent = L" ";
- // this is called from ReflectSettings that in turn is called when logging fails,
- // so do not try to close the group, if it has not been opened, to avoid recursion
- if (FFile != NULL)
- {
- AddIndented(L"</group>");
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TActionLog::SetEnabled(bool value)
- {
- if (Enabled != value)
- {
- FEnabled = value;
- ReflectSettings();
- }
- }
|