123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908 |
- //---------------------------------------------------------------------------
- #define NO_WIN32_LEAN_AND_MEAN
- #include <vcl.h>
- #pragma hdrstop
- #include "TerminalManager.h"
- #include <Authenticate.h>
- #include "CustomScpExplorer.h"
- #include "NonVisual.h"
- #include "WinConfiguration.h"
- #include "Tools.h"
- #include <Common.h>
- #include <CoreMain.h>
- #include <GUITools.h>
- #include <TextsWin.h>
- #include <TextsCore.h>
- #include <Progress.h>
- #include <Exceptions.h>
- #include <VCLCommon.h>
- #include <WinApi.h>
- #include <PuttyTools.h>
- #include <HelpWin.h>
- #include <System.IOUtils.hpp>
- #include <StrUtils.hpp>
- //---------------------------------------------------------------------------
- #pragma package(smart_init)
- //---------------------------------------------------------------------------
- TTerminalManager * TTerminalManager::FInstance = NULL;
- //---------------------------------------------------------------------------
- __fastcall TManagedTerminal::TManagedTerminal(TSessionData * SessionData,
- TConfiguration * Configuration) :
- TTerminal(SessionData, Configuration),
- LocalExplorerState(NULL), RemoteExplorerState(NULL),
- ReopenStart(0), DirectoryLoaded(Now()), TerminalThread(NULL), Disconnected(false)
- {
- StateData = new TSessionData(L"");
- StateData->Assign(SessionData);
- StateData->LocalDirectory = ::ExpandFileName(StateData->LocalDirectory);
- }
- //---------------------------------------------------------------------------
- __fastcall TManagedTerminal::~TManagedTerminal()
- {
- delete StateData;
- delete LocalExplorerState;
- delete RemoteExplorerState;
- }
- //---------------------------------------------------------------------------
- //---------------------------------------------------------------------------
- TTerminalManager * __fastcall TTerminalManager::Instance(bool ForceCreation)
- {
- if (!FInstance && ForceCreation)
- {
- FInstance = new TTerminalManager();
- }
- return FInstance;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DestroyInstance()
- {
- DebugAssert(FInstance);
- SAFE_DESTROY(FInstance);
- }
- //---------------------------------------------------------------------------
- __fastcall TTerminalManager::TTerminalManager() :
- TTerminalList(Configuration)
- {
- FQueueSection = new TCriticalSection();
- FActiveTerminal = NULL;
- FScpExplorer = NULL;
- FDestroying = false;
- FTerminalPendingAction = tpNull;
- FDirectoryReadingStart = 0;
- FAuthenticateForm = NULL;
- FTaskbarList = NULL;
- FAuthenticating = 0;
- FMainThread = GetCurrentThreadId();
- FChangeSection.reset(new TCriticalSection());
- FPendingConfigurationChange = 0;
- FKeepAuthenticateForm = false;
- FApplicationsEvents.reset(new TApplicationEvents(Application));
- FApplicationsEvents->OnException = ApplicationException;
- FApplicationsEvents->OnShowHint = ApplicationShowHint;
- FApplicationsEvents->OnMessage = ApplicationMessage;
- FApplicationsEvents->OnModalBegin = ApplicationModalBegin;
- FApplicationsEvents->OnModalEnd = ApplicationModalEnd;
- DebugAssert(WinConfiguration->OnMasterPasswordPrompt == NULL);
- WinConfiguration->OnMasterPasswordPrompt = MasterPasswordPrompt;
- InitTaskbarButtonCreatedMessage();
- DebugAssert(Configuration && !Configuration->OnChange);
- Configuration->OnChange = ConfigurationChange;
- FOnLastTerminalClosed = NULL;
- FOnTerminalListChanged = NULL;
- FTerminalList = new TStringList();
- FQueues = new TList();
- FTerminationMessages = new TStringList();
- std::unique_ptr<TSessionData> DummyData(new TSessionData(L""));
- FLocalTerminal = CreateTerminal(DummyData.get());
- SetupTerminal(FLocalTerminal);
- }
- //---------------------------------------------------------------------------
- __fastcall TTerminalManager::~TTerminalManager()
- {
- FreeAll();
- DebugAssert(!ScpExplorer);
- DebugAssert(Configuration->OnChange == ConfigurationChange);
- Configuration->OnChange = NULL;
- FApplicationsEvents.reset(NULL);
- DebugAssert(WinConfiguration->OnMasterPasswordPrompt == MasterPasswordPrompt);
- WinConfiguration->OnMasterPasswordPrompt = NULL;
- delete FLocalTerminal;
- delete FQueues;
- delete FTerminationMessages;
- delete FTerminalList;
- CloseAutheticateForm();
- delete FQueueSection;
- ReleaseTaskbarList();
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetQueueConfiguration(TTerminalQueue * Queue)
- {
- Queue->TransfersLimit = GUIConfiguration->QueueTransfersLimit;
- Queue->KeepDoneItemsFor =
- (GUIConfiguration->QueueKeepDoneItems ? GUIConfiguration->QueueKeepDoneItemsFor : 0);
- }
- //---------------------------------------------------------------------------
- TTerminalQueue * __fastcall TTerminalManager::NewQueue(TTerminal * Terminal)
- {
- TTerminalQueue * Queue = new TTerminalQueue(Terminal, Configuration);
- SetQueueConfiguration(Queue);
- Queue->Enabled = WinConfiguration->EnableQueueByDefault;
- Queue->OnQueryUser = TerminalQueryUser;
- Queue->OnPromptUser = TerminalPromptUser;
- Queue->OnShowExtendedException = TerminalShowExtendedException;
- Queue->OnEvent = QueueEvent;
- return Queue;
- }
- //---------------------------------------------------------------------------
- TManagedTerminal * __fastcall TTerminalManager::CreateManagedTerminal(TSessionData * Data)
- {
- return new TManagedTerminal(Data, Configuration);
- }
- //---------------------------------------------------------------------------
- TTerminal * __fastcall TTerminalManager::CreateTerminal(TSessionData * Data)
- {
- return CreateManagedTerminal(Data);
- }
- //---------------------------------------------------------------------------
- TManagedTerminal * __fastcall TTerminalManager::GetTerminal(int Index)
- {
- return DebugNotNull(dynamic_cast<TManagedTerminal *>(TTerminalList::Terminals[Index]));
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetupTerminal(TTerminal * Terminal)
- {
- Terminal->OnQueryUser = TerminalQueryUser;
- Terminal->OnPromptUser = TerminalPromptUser;
- Terminal->OnDisplayBanner = TerminalDisplayBanner;
- Terminal->OnShowExtendedException = TerminalShowExtendedException;
- Terminal->OnProgress = OperationProgress;
- Terminal->OnFinished = OperationFinished;
- Terminal->OnDeleteLocalFile = DeleteLocalFile;
- Terminal->OnReadDirectoryProgress = TerminalReadDirectoryProgress;
- Terminal->OnInformation = TerminalInformation;
- Terminal->OnCustomCommand = TerminalCustomCommand;
- }
- //---------------------------------------------------------------------------
- TManagedTerminal * __fastcall TTerminalManager::DoNewTerminal(TSessionData * Data)
- {
- TManagedTerminal * Terminal = DebugNotNull(dynamic_cast<TManagedTerminal *>(TTerminalList::NewTerminal(Data)));
- try
- {
- FQueues->Add(NewQueue(Terminal));
- FTerminationMessages->Add(L"");
- SetupTerminal(Terminal);
- }
- catch(...)
- {
- if (Terminal != NULL)
- {
- FreeTerminal(Terminal);
- }
- throw;
- }
- return Terminal;
- }
- //---------------------------------------------------------------------------
- TTerminal * __fastcall TTerminalManager::NewTerminal(TSessionData * Data)
- {
- TTerminal * Terminal = DoNewTerminal(Data);
- DoTerminalListChanged();
- return Terminal;
- }
- //---------------------------------------------------------------------------
- TManagedTerminal * __fastcall TTerminalManager::NewManagedTerminal(TSessionData * Data)
- {
- return DebugNotNull(dynamic_cast<TManagedTerminal *>(NewTerminal(Data)));
- }
- //---------------------------------------------------------------------------
- TManagedTerminal * __fastcall TTerminalManager::NewTerminals(TList * DataList)
- {
- TManagedTerminal * Result = NULL;
- for (int Index = 0; Index < DataList->Count; Index++)
- {
- TSessionData * Data = reinterpret_cast<TSessionData *>(DataList->Items[Index]);
- TManagedTerminal * Terminal = DoNewTerminal(Data);
- // When opening workspace/folder, keep the sessions open, even if they fail to connect.
- // We cannot detect a folder here, so we "guess" it by a session set size.
- // After all, no one will have a folder with a one session only (while a workspace with one session is likely).
- // And when when opening a folder with a one session only, it's not that big problem, if we treat it the same way
- // as when opening the session only.
- // Also closing a workspace session will remove the session from the workspace.
- // While closing a folder session won't remove the session from the folder.
- Terminal->Permanent = Data->IsWorkspace || (DataList->Count > 1);
- if (Index == 0)
- {
- Result = Terminal;
- }
- }
- DoTerminalListChanged();
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::FreeActiveTerminal()
- {
- if (FTerminalPendingAction == tpNull)
- {
- DebugAssert(ActiveTerminal);
- FreeTerminal(ActiveTerminal);
- }
- else
- {
- DebugAssert(FTerminalPendingAction == ::tpNone);
- FTerminalPendingAction = tpFree;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DoConnectTerminal(TTerminal * Terminal, bool Reopen, bool AdHoc)
- {
- TManagedTerminal * ManagedTerminal = dynamic_cast<TManagedTerminal *>(Terminal);
- // it must be managed terminal, unless it is secondary terminal (of managed terminal)
- DebugAssert((ManagedTerminal != NULL) || (dynamic_cast<TSecondaryTerminal *>(Terminal) != NULL));
- // particularly when we are reconnecting RemoteDirectory of managed terminal
- // hold the last used remote directory as opposite to session data, which holds
- // the default remote directory.
- // make sure the last used directory is used, but the default is preserved too
- UnicodeString OrigRemoteDirectory = Terminal->SessionData->RemoteDirectory;
- try
- {
- TTerminalThread * TerminalThread = new TTerminalThread(Terminal);
- TerminalThread->AllowAbandon = (Terminal == FActiveTerminal);
- try
- {
- if (ManagedTerminal != NULL)
- {
- Terminal->SessionData->RemoteDirectory = ManagedTerminal->StateData->RemoteDirectory;
- if ((double)ManagedTerminal->ReopenStart == 0)
- {
- ManagedTerminal->ReopenStart = Now();
- }
- ManagedTerminal->Disconnected = false;
- DebugAssert(ManagedTerminal->TerminalThread == NULL);
- ManagedTerminal->TerminalThread = TerminalThread;
- }
- TNotifyEvent OnIdle;
- ((TMethod*)&OnIdle)->Code = TerminalThreadIdle;
- TerminalThread->OnIdle = OnIdle;
- if (Reopen)
- {
- TerminalThread->TerminalReopen();
- }
- else
- {
- TerminalThread->TerminalOpen();
- }
- }
- __finally
- {
- TerminalThread->OnIdle = NULL;
- if (!TerminalThread->Release())
- {
- if (!AdHoc && (DebugAlwaysTrue(Terminal == FActiveTerminal)))
- {
- // terminal was abandoned, must create a new one to replace it
- Terminal = ManagedTerminal = CreateManagedTerminal(new TSessionData(L""));
- SetupTerminal(Terminal);
- OwnsObjects = false;
- Items[ActiveTerminalIndex] = Terminal;
- OwnsObjects = true;
- FActiveTerminal = ManagedTerminal;
- // Can be NULL, when opening the first session from command-line
- if (FScpExplorer != NULL)
- {
- FScpExplorer->ReplaceTerminal(ManagedTerminal);
- }
- }
- // Now we do not have any reference to an abandoned terminal, so we can safely allow the thread
- // to complete its task and destroy the terminal afterwards.
- TerminalThread->Terminate();
- // When abandoning cancelled terminal, DoInformation(Phase = 0) does not make it to TerminalInformation handler.
- if (DebugAlwaysTrue(FAuthenticating > 0))
- {
- FKeepAuthenticateForm = false;
- AuthenticatingDone();
- }
- }
- else
- {
- if (ManagedTerminal != NULL)
- {
- ManagedTerminal->TerminalThread = NULL;
- }
- }
- }
- }
- __finally
- {
- Terminal->SessionData->RemoteDirectory = OrigRemoteDirectory;
- if (Terminal->Active && (ManagedTerminal != NULL))
- {
- ManagedTerminal->ReopenStart = 0;
- ManagedTerminal->Permanent = true;
- }
- }
- if (DebugAlwaysTrue(Terminal->Active) && !Reopen && GUIConfiguration->QueueBootstrap)
- {
- FindQueueForTerminal(Terminal)->AddItem(new TBootstrapQueueItem());
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::CloseAutheticateForm()
- {
- SAFE_DESTROY(FAuthenticateForm);
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::ConnectTerminal(TTerminal * Terminal)
- {
- bool Result = true;
- // were it an active terminal, it would allow abandoning, what this API cannot deal with
- DebugAssert(Terminal != FActiveTerminal);
- try
- {
- DoConnectTerminal(Terminal, false, false);
- }
- catch (Exception & E)
- {
- ShowExtendedExceptionEx(Terminal, &E);
- Result = false;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalThreadIdle(void * /*Data*/, TObject * /*Sender*/)
- {
- Application->ProcessMessages();
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::ConnectActiveTerminalImpl(bool Reopen)
- {
- TTerminalPendingAction Action;
- bool Result;
- do
- {
- Action = tpNull;
- Result = false;
- try
- {
- DebugAssert(ActiveTerminal);
- DoConnectTerminal(ActiveTerminal, Reopen, false);
- if (ScpExplorer)
- {
- DebugAssert(ActiveTerminal->Status == ssOpened);
- TerminalReady();
- }
- WinConfiguration->ClearTemporaryLoginData();
- Result = true;
- }
- catch (Exception & E)
- {
- DebugAssert(FTerminalPendingAction == tpNull);
- FTerminalPendingAction = ::tpNone;
- try
- {
- DebugAssert(ActiveTerminal != NULL);
- ActiveTerminal->ShowExtendedException(&E);
- Action = FTerminalPendingAction;
- }
- __finally
- {
- FTerminalPendingAction = tpNull;
- }
- }
- }
- while (Action == tpReconnect);
- if (Action == tpFree)
- {
- DisconnectActiveTerminalIfPermanentFreeOtherwise();
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DisconnectActiveTerminalIfPermanentFreeOtherwise()
- {
- if (ActiveTerminal->Permanent)
- {
- DisconnectActiveTerminal();
- }
- else
- {
- FreeActiveTerminal();
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::ConnectActiveTerminal()
- {
- ActiveTerminal->CollectUsage();
- // add only stored sessions to the jump list,
- // ad-hoc session cannot be reproduced from just a session name
- if (StoredSessions->FindSame(ActiveTerminal->SessionData) != NULL)
- {
- WinConfiguration->AddSessionToJumpList(ActiveTerminal->SessionData->SessionName);
- }
- FAuthenticationCancelled = false;
- bool Result = ConnectActiveTerminalImpl(false);
- UnicodeString DateStamp = StandardDatestamp();
- if (Result)
- {
- if (Configuration->Usage->Get(L"OpenedSessionsFailedLastDate") == DateStamp)
- {
- Configuration->Usage->Inc(L"OpenedSessionsFailedRecovered");
- }
- }
- else
- {
- Configuration->Usage->Inc(L"OpenedSessionsFailed");
- Configuration->Usage->Set(L"OpenedSessionsFailedLastDate", DateStamp);
- if (FAuthenticationCancelled)
- {
- Configuration->Usage->Inc(L"OpenedSessionsFailedAfterCancel");
- }
- }
- if (Result && WinConfiguration->AutoOpenInPutty && CanOpenInPutty())
- {
- try
- {
- OpenInPutty();
- }
- catch(Exception & E)
- {
- ShowExtendedExceptionEx(NULL, &E);
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DisconnectActiveTerminal()
- {
- DebugAssert(ActiveTerminal);
- if (ActiveTerminal->Active)
- {
- ActiveTerminal->Close();
- }
- int Index = IndexOf(ActiveTerminal);
- TTerminalQueue * OldQueue;
- TTerminalQueue * NewQueue;
- OldQueue = reinterpret_cast<TTerminalQueue *>(FQueues->Items[Index]);
- NewQueue = this->NewQueue(ActiveTerminal);
- FQueues->Items[Index] = NewQueue;
- ScpExplorer->Queue = NewQueue;
- delete OldQueue;
- dynamic_cast<TManagedTerminal *>(ActiveTerminal)->Disconnected = true;
- if (ScpExplorer != NULL)
- {
- TerminalReady(); // in case it was never connected
- ScpExplorer->TerminalDisconnected();
- }
- // disconnecting duplidate session removes need to distinguish the only connected session with short path
- DoTerminalListChanged();
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ReconnectActiveTerminal()
- {
- DebugAssert(ActiveTerminal);
- if (ScpExplorer)
- {
- if (ScpExplorer->Terminal == ActiveTerminal)
- {
- ScpExplorer->UpdateTerminal(ActiveTerminal);
- }
- }
- try
- {
- if (FTerminalPendingAction == tpNull)
- {
- ConnectActiveTerminalImpl(true);
- }
- else
- {
- FTerminalPendingAction = tpReconnect;
- }
- }
- catch(...)
- {
- DisconnectActiveTerminal();
- throw;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::FreeAll()
- {
- FDestroying = true;
- try
- {
- while (Count)
- {
- FreeTerminal(Terminals[0]);
- }
- }
- __finally
- {
- FDestroying = false;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::FreeTerminal(TTerminal * Terminal)
- {
- try
- {
- // we want the Login dialog to open on auto-workspace name,
- // as set in TCustomScpExplorerForm::FormClose
- if (!FDestroying || !WinConfiguration->AutoSaveWorkspace)
- {
- if (StoredSessions->FindSame(Terminal->SessionData) != NULL)
- {
- WinConfiguration->LastStoredSession = Terminal->SessionData->Name;
- }
- }
- if (ScpExplorer != NULL)
- {
- ScpExplorer->TerminalRemoved(Terminal);
- }
- if (Terminal->Active)
- {
- Terminal->Close();
- }
- }
- __finally
- {
- int Index = IndexOf(Terminal);
- Extract(Terminal);
- TTerminalQueue * Queue;
- Queue = reinterpret_cast<TTerminalQueue *>(FQueues->Items[Index]);
- FQueues->Delete(Index);
- FTerminationMessages->Delete(Index);
- if (ActiveTerminal && (Terminal == ActiveTerminal))
- {
- if ((Count > 0) && !FDestroying)
- {
- ActiveTerminal = Terminals[Index < Count ? Index : Index - 1];
- }
- else
- {
- ActiveTerminal = NULL;
- }
- }
- else
- {
- SaveTerminal(Terminal);
- }
- // only now all references to/from queue (particularly events to explorer)
- // are cleared
- delete Queue;
- delete Terminal;
- DoTerminalListChanged();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetScpExplorer(TCustomScpExplorerForm * value)
- {
- if (ScpExplorer != value)
- {
- // changing explorer is not supported yet
- DebugAssert(!ScpExplorer || !value);
- FScpExplorer = value;
- if (FScpExplorer)
- {
- FScpExplorer->Terminal = ActiveTerminal;
- FScpExplorer->Queue = ActiveQueue;
- FOnLastTerminalClosed = FScpExplorer->LastTerminalClosed;
- FOnTerminalListChanged = FScpExplorer->TerminalListChanged;
- UpdateTaskbarList();
- }
- else
- {
- FOnLastTerminalClosed = NULL;
- FOnTerminalListChanged = NULL;
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetActiveTerminal(TManagedTerminal * value)
- {
- DoSetActiveTerminal(value, false);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetActiveTerminalWithAutoReconnect(TManagedTerminal * value)
- {
- DoSetActiveTerminal(value, true);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DoSetActiveTerminal(TManagedTerminal * value, bool AutoReconnect)
- {
- if (ActiveTerminal != value)
- {
- // here used to be call to TCustomScpExporer::UpdateSessionData (now UpdateTerminal)
- // but it seems to be duplicate to call from TCustomScpExporer::TerminalChanging
- TTerminal * PActiveTerminal = ActiveTerminal;
- FActiveTerminal = value;
- // moved from else block of next if (ActiveTerminal) statement
- // so ScpExplorer can update its caption
- UpdateAppTitle();
- if (ScpExplorer)
- {
- if (ActiveTerminal && ((ActiveTerminal->Status == ssOpened) || dynamic_cast<TManagedTerminal *>(ActiveTerminal)->Disconnected))
- {
- TerminalReady();
- }
- else
- {
- ScpExplorer->Terminal = NULL;
- ScpExplorer->Queue = NULL;
- }
- }
- if (PActiveTerminal && !PActiveTerminal->Active)
- {
- SaveTerminal(PActiveTerminal);
- }
- if (ActiveTerminal)
- {
- int Index = ActiveTerminalIndex;
- if (!ActiveTerminal->Active && !FTerminationMessages->Strings[Index].IsEmpty())
- {
- UnicodeString Message = FTerminationMessages->Strings[Index];
- FTerminationMessages->Strings[Index] = L"";
- if (AutoReconnect)
- {
- ReconnectActiveTerminal();
- }
- else
- {
- Exception * E = new ESshFatal(NULL, Message);
- try
- {
- // finally show pending terminal message,
- // this gives user also possibility to reconnect
- ActiveTerminal->ShowExtendedException(E);
- }
- __finally
- {
- delete E;
- }
- }
- }
- }
- else
- {
- if (OnLastTerminalClosed)
- {
- OnLastTerminalClosed(this);
- }
- }
- if ((ActiveTerminal != NULL) && !ActiveTerminal->Active &&
- !dynamic_cast<TManagedTerminal *>(ActiveTerminal)->Disconnected)
- {
- ConnectActiveTerminal();
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::QueueStatusUpdated()
- {
- UpdateAppTitle();
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::ShouldDisplayQueueStatusOnAppTitle()
- {
- bool Result = IsApplicationMinimized();
- if (!Result && (ScpExplorer != NULL))
- {
- HWND Window = GetActiveWindow();
- Window = GetAncestor(Window, GA_ROOTOWNER);
- Result = (ScpExplorer->Handle != Window);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TTerminalManager::GetAppProgressTitle()
- {
- UnicodeString Result;
- UnicodeString QueueProgressTitle;
- UnicodeString ProgressTitle = !FProgressTitle.IsEmpty() ? FProgressTitle : ScpExplorer->GetProgressTitle();
- if (!FForegroundProgressTitle.IsEmpty())
- {
- Result = FForegroundProgressTitle;
- }
- else if (!ProgressTitle.IsEmpty() && !ForegroundTask())
- {
- Result = ProgressTitle;
- }
- else if (ShouldDisplayQueueStatusOnAppTitle() &&
- !(QueueProgressTitle = ScpExplorer->GetQueueProgressTitle()).IsEmpty())
- {
- Result = QueueProgressTitle;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::UpdateAppTitle()
- {
- if (ScpExplorer)
- {
- TForm * MainForm = GetMainForm();
- if (MainForm != ScpExplorer)
- {
- // triggers caption update for some forms
- MainForm->Perform(WM_MANAGES_CAPTION, 0, 0);
- }
- UnicodeString NewTitle = FormatMainFormCaption(GetActiveTerminalTitle(false));
- UnicodeString ProgressTitle = GetAppProgressTitle();
- if (!ProgressTitle.IsEmpty())
- {
- NewTitle = ProgressTitle + L" - " + NewTitle;
- }
- else if (ActiveTerminal && (ScpExplorer != NULL))
- {
- UnicodeString Path = ScpExplorer->PathForCaption();
- if (!Path.IsEmpty())
- {
- NewTitle = Path + L" - " + NewTitle;
- }
- }
- // Not updating MainForm here, as for all other possible main forms, this code is actually not what we want.
- // And they all update their title on their own (some using GetAppProgressTitle()).
- ScpExplorer->Caption = NewTitle;
- ScpExplorer->ApplicationTitleChanged();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SaveTerminal(TTerminal * Terminal)
- {
- TSessionData * Data = StoredSessions->FindSame(Terminal->SessionData);
- if (Data != NULL)
- {
- TManagedTerminal * ManagedTerminal = dynamic_cast<TManagedTerminal *>(Terminal);
- DebugAssert(ManagedTerminal != NULL);
- bool Changed = false;
- if (Terminal->SessionData->UpdateDirectories)
- {
- Data->CopyDirectoriesStateData(ManagedTerminal->StateData);
- Changed = true;
- }
- if (Changed)
- {
- // modified only, implicit
- StoredSessions->Save(false, false);
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::HandleException(Exception * E)
- {
- // can be null for example when exception is thrown on login dialog
- if (ActiveTerminal != NULL)
- {
- ActiveTerminal->ShowExtendedException(E);
- }
- else
- {
- ShowExtendedException(E);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ApplicationException(TObject * /*Sender*/,
- Exception * E)
- {
- HandleException(E);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ApplicationShowHint(UnicodeString & HintStr,
- bool & /*CanShow*/, THintInfo & HintInfo)
- {
- HintInfo.HintData = HintInfo.HintControl;
- if (HasLabelHintPopup(HintInfo.HintControl, HintStr))
- {
- // Hack for transfer setting labels.
- // Should be converted to something like HintLabel()
- HintInfo.HideTimeout = 100000; // "almost" never
- }
- else if (dynamic_cast<TProgressBar *>(HintInfo.HintControl) != NULL)
- {
- // Hint is forcibly hidden in TProgressForm::FormHide
- HintInfo.HideTimeout = 100000; // "almost" never
- HintInfo.ReshowTimeout = 500; // updated each 0.5s
- }
- else
- {
- int HintMaxWidth = 300;
- TControl * ScaleControl = HintInfo.HintControl;
- if (DebugAlwaysFalse(HintInfo.HintControl == NULL) ||
- (GetParentForm(HintInfo.HintControl) == NULL))
- {
- ScaleControl = ScpExplorer;
- }
- HintMaxWidth = ScaleByTextHeight(ScaleControl, HintMaxWidth);
- HintInfo.HintMaxWidth = HintMaxWidth;
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::HandleMouseWheel(WPARAM WParam, LPARAM LParam)
- {
- // WORKAROUND This is no longer necessary on Windows 10 (except for WM_WANTS_MOUSEWHEEL_INACTIVE part)
- bool Result = false;
- if (Application->Active)
- {
- TPoint Point(LOWORD(LParam), HIWORD(LParam));
- TWinControl * Control = FindVCLWindow(Point);
- if (Control != NULL)
- {
- TCustomForm * Form = GetParentForm(Control);
- // Only case we expect the parent form to be NULL is on the Find/Replace dialog,
- // which is owned by VCL's internal TRedirectorWindow.
- DebugAssert((Form != NULL) || (Control->ClassName() == L"TRedirectorWindow"));
- if (Form != NULL)
- {
- // Send it only to windows we tested it with.
- // Though we should sooner or later remove this test and pass it to all our windows.
- if (Form->Active && (Form->Perform(WM_WANTS_MOUSEWHEEL, 0, 0) == 1))
- {
- SendMessage(Control->Handle, WM_MOUSEWHEEL, WParam, LParam);
- Result = true;
- }
- else if (!Form->Active && (Form->Perform(WM_WANTS_MOUSEWHEEL_INACTIVE, 0, 0) == 1))
- {
- TWinControl * Control2;
- // FindVCLWindow stops on window level, when the window is not active? or when there's a modal window over it?
- // (but in any case, when we have operation running on top of Synchronization checklist).
- // WORKAROUND: The while loop does what AllLevels parameter of ControlAtPos should do, but it's broken.
- // Based on (now removed) Embarcadero QC 82143.
- while ((Control2 = dynamic_cast<TWinControl *>(Control->ControlAtPos(Control->ScreenToClient(Point), false, true))) != NULL)
- {
- Control = Control2;
- }
- SendMessage(Control->Handle, WM_MOUSEWHEEL, WParam, LParam);
- Result = true;
- }
- }
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ApplicationMessage(TMsg & Msg, bool & Handled)
- {
- if (Msg.message == FTaskbarButtonCreatedMessage)
- {
- CreateTaskbarList();
- }
- if (Msg.message == WM_MOUSEWHEEL)
- {
- Handled = HandleMouseWheel(Msg.wParam, Msg.lParam);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ApplicationModalBegin(TObject * /*Sender*/)
- {
- NonVisualDataModule->StartBusy();
- if (ScpExplorer != NULL)
- {
- ScpExplorer->SuspendWindowLock();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ApplicationModalEnd(TObject * /*Sender*/)
- {
- NonVisualDataModule->EndBusy();
- if (ScpExplorer != NULL)
- {
- ScpExplorer->ResumeWindowLock();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::InitTaskbarButtonCreatedMessage()
- {
- // XE6 VCL already handles TaskbarButtonCreated, but does not call ChangeWindowMessageFilterEx.
- // So we keep our implementation.
- // See also https://stackoverflow.com/q/14614823/850848#14618587
- FTaskbarButtonCreatedMessage = RegisterWindowMessage(L"TaskbarButtonCreated");
- HINSTANCE User32Library = LoadLibrary(L"user32.dll");
- ChangeWindowMessageFilterExProc ChangeWindowMessageFilterEx =
- (ChangeWindowMessageFilterExProc)GetProcAddress(User32Library, "ChangeWindowMessageFilterEx");
- if (ChangeWindowMessageFilterEx != NULL)
- {
- // without this we won't get TaskbarButtonCreated, when app is running elevated
- ChangeWindowMessageFilterEx(
- Application->Handle, FTaskbarButtonCreatedMessage, MSGFLT_ALLOW, NULL);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::CreateTaskbarList()
- {
- ReleaseTaskbarList();
- if(SUCCEEDED(CoCreateInstance(CLSID_TaskbarList, NULL, CLSCTX_ALL,
- IID_ITaskbarList3, (void **) &FTaskbarList)))
- {
- if (ScpExplorer != NULL)
- {
- UpdateTaskbarList();
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ReleaseTaskbarList()
- {
- if (FTaskbarList != NULL)
- {
- FTaskbarList->Release();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::UpdateTaskbarList()
- {
- ScpExplorer->UpdateTaskbarList(FTaskbarList);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DeleteLocalFile(const UnicodeString FileName, bool Alternative, int & Deleted)
- {
- Deleted = RecursiveDeleteFileChecked(FileName, (WinConfiguration->DeleteToRecycleBin != Alternative));
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalQueryUser(TObject * Sender,
- const UnicodeString Query, TStrings * MoreMessages, unsigned int Answers,
- const TQueryParams * Params, unsigned int & Answer, TQueryType Type, void * /*Arg*/)
- {
- UnicodeString HelpKeyword;
- TMessageParams MessageParams(Params);
- UnicodeString AQuery = Query;
- if (Params != NULL)
- {
- HelpKeyword = Params->HelpKeyword;
- if (FLAGSET(Params->Params, qpFatalAbort))
- {
- AQuery = FMTLOAD(WARN_FATAL_ERROR, (AQuery));
- if (!MessageParams.TimerMessage.IsEmpty())
- {
- MessageParams.TimerMessage = FMTLOAD(WARN_FATAL_ERROR, (MessageParams.TimerMessage));
- }
- }
- }
- if (ScpExplorer)
- {
- Answer = ScpExplorer->MoreMessageDialog(AQuery, MoreMessages, Type, Answers,
- HelpKeyword, &MessageParams, dynamic_cast<TTerminal *>(Sender));
- }
- else
- {
- Answer = MoreMessageDialog(AQuery, MoreMessages, Type, Answers, HelpKeyword,
- &MessageParams);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::AuthenticateFormCancel(TObject * Sender)
- {
- TAuthenticateForm * Form = dynamic_cast<TAuthenticateForm *>(Sender);
- DebugAssert(Form != NULL);
- TManagedTerminal * ManagedTerminal = dynamic_cast<TManagedTerminal *>(Form->Terminal);
- // will be null e.g. for background transfers
- if (ManagedTerminal != NULL)
- {
- TTerminalThread * TerminalThread = ManagedTerminal->TerminalThread;
- // can be NULL for reconnects from transfers
- if ((TerminalThread != NULL) && !TerminalThread->Cancelling)
- {
- Form->Log(LoadStr(AUTH_CANCELLING));
- TerminalThread->Cancel();
- }
- }
- FAuthenticationCancelled = true;
- }
- //---------------------------------------------------------------------------
- TAuthenticateForm * __fastcall TTerminalManager::MakeAuthenticateForm(
- TTerminal * Terminal)
- {
- TAuthenticateForm * Dialog = SafeFormCreate<TAuthenticateForm>();
- Dialog->Init(Terminal);
- DebugAssert(Dialog->OnCancel == NULL);
- Dialog->OnCancel = AuthenticateFormCancel;
- return Dialog;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::FileNameInputDialogInitializeRenameBaseName(
- TObject * /*Sender*/, TInputDialogData * Data)
- {
- EditSelectBaseName(Data->Edit->Handle);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalPromptUser(
- TTerminal * Terminal, TPromptKind Kind, UnicodeString Name, UnicodeString Instructions,
- TStrings * Prompts, TStrings * Results, bool & Result, void * /*Arg*/)
- {
- if (((Kind == pkPrompt) || (Kind == pkFileName)) && (FAuthenticateForm == NULL) &&
- (Terminal->Status != ssOpening))
- {
- DebugAssert(Instructions.IsEmpty());
- DebugAssert(Prompts->Count == 1);
- DebugAssert(FLAGSET(int(Prompts->Objects[0]), pupEcho));
- UnicodeString AResult = Results->Strings[0];
- TInputDialogInitialize InputDialogInitialize = NULL;
- if ((Kind == pkFileName) && !WinConfiguration->RenameWholeName)
- {
- InputDialogInitialize = FileNameInputDialogInitializeRenameBaseName;
- }
- Result = InputDialog(Name, Prompts->Strings[0], AResult, L"", NULL, false, InputDialogInitialize);
- if (Result)
- {
- Results->Strings[0] = AResult;
- }
- }
- else
- {
- TAuthenticateForm * AuthenticateForm = FAuthenticateForm;
- if (AuthenticateForm == NULL)
- {
- AuthenticateForm = MakeAuthenticateForm(Terminal);
- }
- try
- {
- Result = AuthenticateForm->PromptUser(Kind, Name, Instructions, Prompts, Results,
- (FAuthenticateForm != NULL), Terminal->StoredCredentialsTried);
- }
- __finally
- {
- if (FAuthenticateForm == NULL)
- {
- delete AuthenticateForm;
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalDisplayBanner(
- TTerminal * Terminal, UnicodeString SessionName,
- const UnicodeString & Banner, bool & NeverShowAgain, int Options, unsigned int & Params)
- {
- DebugAssert(FAuthenticateForm != NULL);
- TAuthenticateForm * AuthenticateForm = FAuthenticateForm;
- if (AuthenticateForm == NULL)
- {
- AuthenticateForm = MakeAuthenticateForm(Terminal);
- }
- try
- {
- AuthenticateForm->Banner(Banner, NeverShowAgain, Options, Params);
- }
- __finally
- {
- if (FAuthenticateForm == NULL)
- {
- delete AuthenticateForm;
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalShowExtendedException(
- TTerminal * Terminal, Exception * E, void * /*Arg*/)
- {
- if (ScpExplorer)
- {
- ScpExplorer->ShowExtendedException(Terminal, E);
- }
- else
- {
- ShowExtendedExceptionEx(Terminal, E);
- }
- }
- //---------------------------------------------------------------------------
- static TDateTime DirectoryReadingProgressDelay(0, 0, 1, 500);
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalReadDirectoryProgress(
- TObject * /*Sender*/, int Progress, int ResolvedLinks, bool & Cancel)
- {
- if (Progress == 0)
- {
- if (ScpExplorer != NULL)
- {
- // See also TCustomScpExplorerForm::RemoteDirViewBusy
- ScpExplorer->LockWindow();
- }
- FDirectoryReadingStart = Now();
- if (!FProgressTitle.IsEmpty() || !FForegroundProgressTitle.IsEmpty())
- {
- FProgressTitle = L"";
- FForegroundProgressTitle = L"";
- UpdateAppTitle();
- }
- // Reset "was ESC ever pressed?" state
- GetAsyncKeyState(VK_ESCAPE);
- }
- else if (Progress < 0)
- {
- if (Progress == -2)
- {
- // cancelled
- if (ScpExplorer != NULL)
- {
- ScpExplorer->ReadDirectoryCancelled();
- }
- }
- else
- {
- if (ScpExplorer != NULL)
- {
- ScpExplorer->UnlockWindow();
- }
- FProgressTitle = L"";
- FForegroundProgressTitle = L"";
- UpdateAppTitle();
- }
- }
- else
- {
- // If the least significant bit is set,
- // the key was pressed after the previous call to GetAsyncKeyState.
- int KeyState = GetAsyncKeyState(VK_ESCAPE);
- if (FLAGSET(KeyState, 0x01))
- {
- Cancel = true;
- }
- if ((Now() - FDirectoryReadingStart) >= DirectoryReadingProgressDelay)
- {
- // 4 is arbitrary number
- FForegroundProgressTitle =
- FMTLOAD(ResolvedLinks >= 4 ? DIRECTORY_READING_AND_RESOLVING_PROGRESS : DIRECTORY_READING_PROGRESS,
- (Progress));
- UpdateAppTitle();
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalCustomCommand(
- TTerminal * /*Terminal*/, const UnicodeString & Command, bool & Handled)
- {
- // Implementation has to be thread-safe
- Handled = CopyCommandToClipboard(Command);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::AuthenticatingDone()
- {
- FAuthenticating--;
- if (FAuthenticating == 0)
- {
- BusyEnd(FBusyToken);
- FBusyToken = NULL;
- }
- if (!FKeepAuthenticateForm)
- {
- CloseAutheticateForm();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalInformation(
- TTerminal * Terminal, const UnicodeString & Str, bool /*Status*/, int Phase)
- {
- if (Phase == 1)
- {
- if (FAuthenticating == 0)
- {
- FBusyToken = BusyStart();
- }
- FAuthenticating++;
- }
- else if (Phase == 0)
- {
- DebugAssert(FAuthenticating > 0);
- AuthenticatingDone();
- }
- else
- {
- if (FAuthenticating > 0)
- {
- bool ShowPending = false;
- if (FAuthenticateForm == NULL)
- {
- FAuthenticateForm = MakeAuthenticateForm(Terminal);
- ShowPending = true;
- }
- FAuthenticateForm->Log(Str);
- if (ShowPending)
- {
- FAuthenticateForm->ShowAsModal();
- }
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::OperationFinished(::TFileOperation Operation,
- TOperationSide Side, bool Temp, const UnicodeString & FileName, bool Success,
- TOnceDoneOperation & OnceDoneOperation)
- {
- DebugAssert(ScpExplorer);
- ScpExplorer->OperationFinished(Operation, Side, Temp, FileName, Success,
- OnceDoneOperation);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::OperationProgress(
- TFileOperationProgressType & ProgressData)
- {
- UpdateAppTitle();
- DebugAssert(ScpExplorer);
- ScpExplorer->OperationProgress(ProgressData);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::QueueEvent(TTerminalQueue * Queue, TQueueEvent Event)
- {
- TGuard Guard(FQueueSection);
- FQueueEvents.push_back(std::make_pair(Queue, Event));
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DoConfigurationChange()
- {
- DebugAssert(Configuration);
- DebugAssert(Configuration == WinConfiguration);
- TTerminalQueue * Queue;
- for (int Index = 0; Index < Count; Index++)
- {
- DebugAssert(Terminals[Index]->Log);
- Terminals[Index]->Log->ReflectSettings();
- Terminals[Index]->ActionLog->ReflectSettings();
- Queue = reinterpret_cast<TTerminalQueue *>(FQueues->Items[Index]);
- SetQueueConfiguration(Queue);
- }
- if (ScpExplorer)
- {
- ScpExplorer->ConfigurationChanged();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::ConfigurationChange(TObject * /*Sender*/)
- {
- if (FMainThread == GetCurrentThreadId())
- {
- DoConfigurationChange();
- }
- else
- {
- TGuard Guard(FChangeSection.get());
- FPendingConfigurationChange++;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::TerminalReady()
- {
- ScpExplorer->Terminal = ActiveTerminal;
- ScpExplorer->Queue = ActiveQueue;
- ScpExplorer->TerminalReady();
- }
- //---------------------------------------------------------------------------
- TStrings * __fastcall TTerminalManager::GetTerminalList()
- {
- FTerminalList->Clear();
- for (int i = 0; i < Count; i++)
- {
- TManagedTerminal * Terminal = Terminals[i];
- UnicodeString Name = GetTerminalTitle(Terminal, true);
- FTerminalList->AddObject(Name, Terminal);
- }
- return FTerminalList;
- }
- //---------------------------------------------------------------------------
- int __fastcall TTerminalManager::GetActiveTerminalIndex()
- {
- return ActiveTerminal ? IndexOf(ActiveTerminal) : -1;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SetActiveTerminalIndex(int value)
- {
- ActiveTerminal = Terminals[value];
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TTerminalManager::GetTerminalShortPath(TTerminal * Terminal)
- {
- UnicodeString Result = UnixExtractFileName(Terminal->CurrentDirectory);
- if (Result.IsEmpty())
- {
- Result = Terminal->CurrentDirectory;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TTerminalManager::GetTerminalTitle(TTerminal * Terminal, bool Unique)
- {
- UnicodeString Result = Terminal->SessionData->SessionName;
- if (Unique)
- {
- int Index = IndexOf(Terminal);
- // not for background transfer sessions and disconnected sessions
- if ((Index >= 0) && Terminal->Active)
- {
- for (int Index2 = 0; Index2 < Count; Index2++)
- {
- UnicodeString Name = Terminals[Index2]->SessionData->SessionName;
- if ((Terminals[Index2] != Terminal) &&
- Terminals[Index2]->Active &&
- SameText(Name, Result))
- {
- UnicodeString Path = GetTerminalShortPath(Terminal);
- if (!Path.IsEmpty())
- {
- Result = FORMAT(L"%s (%s)", (Result, Path));
- }
- break;
- }
- }
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- UnicodeString __fastcall TTerminalManager::GetActiveTerminalTitle(bool Unique)
- {
- UnicodeString Result;
- if (ActiveTerminal != NULL)
- {
- Result = GetTerminalTitle(ActiveTerminal, Unique);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- TTerminalQueue * __fastcall TTerminalManager::GetActiveQueue()
- {
- TTerminalQueue * Result = NULL;
- if (ActiveTerminal != NULL)
- {
- Result = reinterpret_cast<TTerminalQueue *>(FQueues->Items[ActiveTerminalIndex]);
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::CycleTerminals(bool Forward)
- {
- if (Count > 0)
- {
- int Index = ActiveTerminalIndex;
- Index += Forward ? 1 : -1;
- if (Index < 0)
- {
- Index = Count-1;
- }
- else if (Index >= Count)
- {
- Index = 0;
- }
- ActiveTerminalIndex = Index;
- }
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::CanOpenInPutty()
- {
- return (ActiveTerminal != NULL) && !GUIConfiguration->PuttyPath.Trim().IsEmpty();
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::OpenInPutty()
- {
- Configuration->Usage->Inc(L"OpenInPutty");
- TSessionData * Data = NULL;
- try
- {
- // Is NULL on the first session when called from ConnectActiveTerminal()
- // due to WinConfiguration->AutoOpenInPutty
- if (ScpExplorer != NULL)
- {
- Data = ScpExplorer->CloneCurrentSessionData();
- }
- else
- {
- Data = new TSessionData(L"");
- DebugAssert(ActiveTerminal != NULL);
- Data->Assign(ActiveTerminal->SessionData);
- ActiveTerminal->UpdateSessionCredentials(Data);
- }
- // putty does not support resolving environment variables in session settings
- Data->ExpandEnvironmentVariables();
- if (ActiveTerminal->TunnelLocalPortNumber != 0)
- {
- Data->ConfigureTunnel(ActiveTerminal->TunnelLocalPortNumber);
- }
- OpenSessionInPutty(GUIConfiguration->PuttyPath, Data);
- }
- __finally
- {
- delete Data;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::NewSession(bool /*FromSite*/, const UnicodeString & SessionUrl, bool ReloadSessions, TForm * LinkedForm)
- {
- if (ReloadSessions)
- {
- StoredSessions->Reload();
- }
- UnicodeString DownloadFile; // unused
- std::unique_ptr<TObjectList> DataList(new TObjectList());
- GetLoginData(SessionUrl, NULL, DataList.get(), DownloadFile, true, LinkedForm);
- if (DataList->Count > 0)
- {
- ActiveTerminal = NewTerminals(DataList.get());
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::Idle(bool SkipCurrentTerminal)
- {
- if (FPendingConfigurationChange > 0) // optimization
- {
- bool Changed = false;
- {
- TGuard Guard(FChangeSection.get());
- if (DebugAlwaysTrue(FPendingConfigurationChange > 0))
- {
- FPendingConfigurationChange--;
- Changed = true;
- }
- }
- if (Changed)
- {
- DoConfigurationChange();
- }
- }
- for (int Index = 0; Index < Count; Index++)
- {
- TTerminal * Terminal = Terminals[Index];
- try
- {
- if (!SkipCurrentTerminal || (Terminal != ActiveTerminal))
- {
- TManagedTerminal * ManagedTerminal = dynamic_cast<TManagedTerminal *>(Terminal);
- DebugAssert(ManagedTerminal != NULL);
- // make sure Idle is called on the thread that runs the terminal
- if (ManagedTerminal->TerminalThread != NULL)
- {
- ManagedTerminal->TerminalThread->Idle();
- }
- else
- {
- if (Terminal->Active)
- {
- Terminal->Idle();
- }
- }
- if (Terminal->Active)
- {
- DebugAssert(Index < FQueues->Count);
- if (Index < FQueues->Count)
- {
- reinterpret_cast<TTerminalQueue *>(FQueues->Items[Index])->Idle();
- }
- }
- }
- }
- catch(Exception & E)
- {
- if (Terminal == ActiveTerminal)
- {
- // throw further, so that the exception is handled in proper place
- // (particularly in broken-transfer reconnect handler, bug 72)
- throw;
- }
- else
- {
- // we may not have inactive terminal, unless there is a explorer,
- // also Idle is called from explorer anyway
- DebugAssert(ScpExplorer != NULL);
- if (ScpExplorer != NULL)
- {
- ScpExplorer->InactiveTerminalException(Terminal, &E);
- }
- if (!Terminal->Active)
- {
- // if session is lost, save the error message and rethrow it
- // once the terminal gets activated
- FTerminationMessages->Strings[Index] = E.Message;
- }
- }
- }
- }
- TTerminalQueue * QueueWithEvent;
- TQueueEvent QueueEvent;
- do
- {
- QueueWithEvent = NULL;
- {
- TGuard Guard(FQueueSection);
- if (!FQueueEvents.empty())
- {
- QueueWithEvent = FQueueEvents[0].first;
- QueueEvent = FQueueEvents[0].second;
- FQueueEvents.erase(FQueueEvents.begin());
- }
- }
- if (QueueWithEvent != NULL)
- {
- int Index = FQueues->IndexOf(QueueWithEvent);
- // the session may not exist anymore
- if (Index >= 0)
- {
- TManagedTerminal * Terminal = Terminals[Index];
- // we can hardly have a queue event without explorer
- DebugAssert(ScpExplorer != NULL);
- if (ScpExplorer != NULL)
- {
- ScpExplorer->QueueEvent(Terminal, QueueWithEvent, QueueEvent);
- }
- }
- }
- }
- while (QueueWithEvent != NULL);
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::MasterPasswordPrompt()
- {
- if (GetCurrentThreadId() == MainThreadID)
- {
- if (!DoMasterPasswordDialog())
- {
- Abort();
- }
- }
- else
- {
- // this can happen only when we keep cancelling all master password prompts
- // as long as the sessing finally connects (session password has to be
- // explictly typed in), and background transfer is started
- Abort();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::Move(TTerminal * Source, TTerminal * Target)
- {
- int SourceIndex = IndexOf(Source);
- int TargetIndex = IndexOf(Target);
- TTerminalList::Move(SourceIndex, TargetIndex);
- FQueues->Move(SourceIndex, TargetIndex);
- DoTerminalListChanged();
- // when there are indexed sessions with the same name,
- // the index may change when reordering the sessions
- UpdateAppTitle();
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::DoTerminalListChanged()
- {
- if (OnTerminalListChanged)
- {
- OnTerminalListChanged(this);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TTerminalManager::SaveWorkspace(TList * DataList)
- {
- for (int Index = 0; Index < Count; Index++)
- {
- TManagedTerminal * ManagedTerminal = dynamic_cast<TManagedTerminal *>(Terminals[Index]);
- TSessionData * Data = StoredSessions->SaveWorkspaceData(ManagedTerminal->StateData, Index);
- DataList->Add(Data);
- }
- }
- //---------------------------------------------------------------------------
- TTerminal * __fastcall TTerminalManager::FindActiveTerminalForSite(TSessionData * Data)
- {
- TTerminal * Result = NULL;
- for (int Index = 0; (Result == NULL) && (Index < Count); Index++)
- {
- TTerminal * Terminal = Terminals[Index];
- if (Terminal->Active &&
- Terminal->SessionData->IsSameSite(Data))
- {
- Result = Terminal;
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- TTerminalQueue * __fastcall TTerminalManager::FindQueueForTerminal(TTerminal * Terminal)
- {
- int Index = IndexOf(Terminal);
- return reinterpret_cast<TTerminalQueue *>(FQueues->Items[Index]);
- }
- //---------------------------------------------------------------------------
- TRemoteFile * __fastcall TTerminalManager::CheckRights(
- TTerminal * Terminal, const UnicodeString & EntryType, const UnicodeString & FileName, bool & WrongRights)
- {
- std::unique_ptr<TRemoteFile> FileOwner;
- TRemoteFile * File;
- try
- {
- Terminal->LogEvent(FORMAT(L"Checking %s \"%s\"...", (LowerCase(EntryType), FileName)));
- Terminal->ReadFile(FileName, File);
- FileOwner.reset(File);
- int ForbiddenRights = TRights::rfGroupWrite | TRights::rfOtherWrite;
- if ((File->Rights->Number & ForbiddenRights) != 0)
- {
- Terminal->LogEvent(FORMAT(L"%s \"%s\" exists, but has incorrect permissions %s.", (EntryType, FileName, File->Rights->Octal)));
- WrongRights = true;
- }
- else
- {
- Terminal->LogEvent(FORMAT(L"%s \"%s\" exists and has correct permissions %s.", (EntryType, FileName, File->Rights->Octal)));
- }
- }
- catch (Exception & E)
- {
- }
- return FileOwner.release();
- }
- //---------------------------------------------------------------------------
- bool __fastcall TTerminalManager::UploadPublicKey(
- TTerminal * Terminal, TSessionData * Data, UnicodeString & FileName)
- {
- std::unique_ptr<TOpenDialog> OpenDialog(new TOpenDialog(Application));
- OpenDialog->Title = LoadStr(LOGIN_PUBLIC_KEY_TITLE);
- OpenDialog->Filter = LoadStr(LOGIN_PUBLIC_KEY_FILTER);
- OpenDialog->DefaultExt = PuttyKeyExt;
- OpenDialog->FileName = FileName;
- bool Result = OpenDialog->Execute();
- if (Result)
- {
- Configuration->Usage->Inc(L"PublicKeyInstallation");
- FileName = OpenDialog->FileName;
- bool AutoReadDirectory;
- bool ExceptionOnFail;
- UnicodeString TemporaryDir;
- const UnicodeString SshFolder = L".ssh";
- const UnicodeString AuthorizedKeysFile = L"authorized_keys";
- UnicodeString AuthorizedKeysFilePath = FORMAT(L"%s/%s", (SshFolder, AuthorizedKeysFile));
- VerifyAndConvertKey(FileName, ssh2only, false);
- UnicodeString Comment;
- UnicodeString Line = GetPublicKeyLine(FileName, Comment);
- bool AdHocTerminal = (Terminal == NULL);
- std::unique_ptr<TTerminal> TerminalOwner;
- if (AdHocTerminal)
- {
- DebugAssert(Data != NULL);
- TAutoFlag KeepAuthenticateFormFlag(FKeepAuthenticateForm);
- try
- {
- TerminalOwner.reset(CreateTerminal(Data));
- Terminal = TerminalOwner.get();
- SetupTerminal(Terminal);
- Terminal->OnProgress = NULL;
- Terminal->OnFinished = NULL;
- DoConnectTerminal(Terminal, false, true);
- }
- catch (Exception & E)
- {
- CloseAutheticateForm();
- throw;
- }
- }
- bool Installed = false;
- bool WrongRights = false;
- AutoReadDirectory = Terminal->AutoReadDirectory;
- ExceptionOnFail = Terminal->ExceptionOnFail;
- try
- {
- Terminal->AutoReadDirectory = false;
- Terminal->ExceptionOnFail = true;
- UnicodeString SshImplementation = Terminal->GetSessionInfo().SshImplementation;
- UnicodeString NotOpenSSHMessage = FMTLOAD(LOGIN_NOT_OPENSSH, (SshImplementation));
- if (IsOpenSSH(SshImplementation) ||
- (MessageDialog(NotOpenSSHMessage, qtConfirmation, qaOK | qaCancel, HELP_LOGIN_AUTHORIZED_KEYS) == qaOK))
- {
- Terminal->Log->AddSeparator();
- Terminal->LogEvent(FORMAT(L"Adding public key line to \"%s\" file:\n%s", (AuthorizedKeysFilePath, Line)));
- // Ad-hoc terminal
- if (FAuthenticateForm != NULL)
- {
- FAuthenticateForm->Log(FMTLOAD(LOGIN_PUBLIC_KEY_UPLOAD, (Comment)));
- }
- UnicodeString SshFolderAbsolutePath = UnixIncludeTrailingBackslash(Terminal->GetHomeDirectory()) + SshFolder;
- std::unique_ptr<TRemoteFile> SshFolderFile(CheckRights(Terminal, L"Folder", SshFolderAbsolutePath, WrongRights));
- if (SshFolderFile.get() == NULL)
- {
- TRights SshFolderRights;
- SshFolderRights.Number = TRights::rfUserRead | TRights::rfUserWrite | TRights::rfUserExec;
- TRemoteProperties SshFolderProperties;
- SshFolderProperties.Rights = SshFolderRights;
- SshFolderProperties.Valid = TValidProperties() << vpRights;
- Terminal->LogEvent(FORMAT(L"Trying to create \"%s\" folder with permissions %s...", (SshFolder, SshFolderRights.Octal)));
- Terminal->CreateDirectory(SshFolderAbsolutePath, &SshFolderProperties);
- }
- TemporaryDir = ExcludeTrailingBackslash(WinConfiguration->TemporaryDir());
- if (!ForceDirectories(ApiPath(TemporaryDir)))
- {
- throw EOSExtException(FMTLOAD(CREATE_TEMP_DIR_ERROR, (TemporaryDir)));
- }
- UnicodeString TemporaryAuthorizedKeysFile = IncludeTrailingBackslash(TemporaryDir) + AuthorizedKeysFile;
- UnicodeString AuthorizedKeysFileAbsolutePath = UnixIncludeTrailingBackslash(SshFolderAbsolutePath) + AuthorizedKeysFile;
- bool Updated = true;
- TCopyParamType CopyParam; // Use factory defaults
- CopyParam.ResumeSupport = rsOff; // not to break the permissions
- CopyParam.PreserveTime = false; // not needed
- UnicodeString AuthorizedKeys;
- std::unique_ptr<TRemoteFile> AuthorizedKeysFileFile(CheckRights(Terminal, L"File", AuthorizedKeysFileAbsolutePath, WrongRights));
- if (AuthorizedKeysFileFile.get() != NULL)
- {
- AuthorizedKeysFileFile->FullFileName = AuthorizedKeysFileAbsolutePath;
- std::unique_ptr<TStrings> Files(new TStringList());
- Files->AddObject(AuthorizedKeysFileAbsolutePath, AuthorizedKeysFileFile.get());
- Terminal->LogEvent(FORMAT(L"Downloading current \"%s\" file...", (AuthorizedKeysFile)));
- Terminal->CopyToLocal(Files.get(), TemporaryDir, &CopyParam, cpNoConfirmation, NULL);
- // Overload with Encoding parameter work incorrectly, when used on a file without BOM
- AuthorizedKeys = TFile::ReadAllText(TemporaryAuthorizedKeysFile);
- std::unique_ptr<TStrings> AuthorizedKeysLines(TextToStringList(AuthorizedKeys));
- int P = Line.Pos(L" ");
- if (DebugAlwaysTrue(P > 0))
- {
- P = PosEx(L" ", Line, P + 1);
- }
- UnicodeString Prefix = Line.SubString(1, P); // including the space
- for (int Index = 0; Index < AuthorizedKeysLines->Count; Index++)
- {
- if (StartsStr(Prefix, AuthorizedKeysLines->Strings[Index]))
- {
- Terminal->LogEvent(FORMAT(L"\"%s\" file already contains public key line:\n%s", (AuthorizedKeysFile, AuthorizedKeysLines->Strings[Index])));
- Updated = false;
- }
- }
- if (Updated)
- {
- Terminal->LogEvent(FORMAT(L"\"%s\" file does not contain the public key line yet.", (AuthorizedKeysFile)));
- if (!EndsStr(L"\n", AuthorizedKeys))
- {
- Terminal->LogEvent(FORMAT(L"Adding missing trailing new line to \"%s\" file...", (AuthorizedKeysFile)));
- AuthorizedKeys += L"\n";
- }
- }
- }
- else
- {
- Terminal->LogEvent(FORMAT(L"Creating new \"%s\" file...", (AuthorizedKeysFile)));
- CopyParam.PreserveRights = true;
- CopyParam.Rights.Number = TRights::rfUserRead | TRights::rfUserWrite;
- }
- if (Updated)
- {
- AuthorizedKeys += Line + L"\n";
- // Overload without Encoding parameter uses TEncoding::UTF8, but does not write BOM, what we want
- TFile::WriteAllText(TemporaryAuthorizedKeysFile, AuthorizedKeys);
- std::unique_ptr<TStrings> Files(new TStringList());
- Files->Add(TemporaryAuthorizedKeysFile);
- Terminal->LogEvent(FORMAT(L"Uploading updated \"%s\" file...", (AuthorizedKeysFile)));
- Terminal->CopyToRemote(Files.get(), SshFolderAbsolutePath, &CopyParam, cpNoConfirmation, NULL);
- }
- Installed = true;
- }
- }
- __finally
- {
- Terminal->AutoReadDirectory = AutoReadDirectory;
- Terminal->ExceptionOnFail = ExceptionOnFail;
- if (!TemporaryDir.IsEmpty())
- {
- RecursiveDeleteFile(ExcludeTrailingBackslash(TemporaryDir), false);
- }
- CloseAutheticateForm(); // When uploading from Login dialog
- }
- if (Installed)
- {
- Terminal->LogEvent(L"Public key installation done.");
- if (AdHocTerminal)
- {
- TerminalOwner.reset(NULL);
- }
- else
- {
- Terminal->Log->AddSeparator();
- }
- UnicodeString Message = FMTLOAD(LOGIN_PUBLIC_KEY_UPLOADED, (Comment));
- if (WrongRights)
- {
- Message += L"\n\n" + FMTLOAD(LOGIN_PUBLIC_KEY_PERMISSIONS, (AuthorizedKeysFilePath));
- }
- MessageDialog(Message, qtInformation, qaOK, HELP_LOGIN_AUTHORIZED_KEYS);
- }
- }
- return Result;
- }
|