Script.cpp 88 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include <SysUtils.hpp>
  5. #include "Common.h"
  6. #include "Exceptions.h"
  7. #include "TextsCore.h"
  8. #include "Script.h"
  9. #include "Terminal.h"
  10. #include "SessionData.h"
  11. #include "CoreMain.h"
  12. //---------------------------------------------------------------------------
  13. #pragma package(smart_init)
  14. //---------------------------------------------------------------------------
  15. const wchar_t * ToggleNames[] = { L"off", L"on" };
  16. //---------------------------------------------------------------------------
  17. __fastcall TScriptProcParams::TScriptProcParams(const UnicodeString & FullCommand, const UnicodeString & ParamsStr)
  18. {
  19. int P = FSwitchMarks.Pos(L"/");
  20. DebugAssert(P > 0);
  21. if (P > 0)
  22. {
  23. FSwitchMarks.Delete(P, 1);
  24. }
  25. FFullCommand = FullCommand;
  26. FParamsStr = ParamsStr;
  27. Parse(ParamsStr);
  28. }
  29. //---------------------------------------------------------------------------
  30. //---------------------------------------------------------------------------
  31. class TScriptCommands : TStringList
  32. {
  33. public:
  34. typedef void __fastcall (__closure *TCommandProc)(TScriptProcParams * Parameters);
  35. __fastcall TScriptCommands(TScript * Script);
  36. virtual __fastcall ~TScriptCommands();
  37. void __fastcall Execute(const UnicodeString & Command, const UnicodeString & Params);
  38. UnicodeString __fastcall ResolveCommand(const UnicodeString & Command);
  39. void __fastcall Register(const wchar_t * Command,
  40. const UnicodeString Description, const UnicodeString Help, TCommandProc Proc,
  41. int MinParams, int MaxParams, bool Switches);
  42. void __fastcall Register(const wchar_t * Command,
  43. int Description, int Help, TCommandProc Proc,
  44. int MinParams, int MaxParams, bool Switches);
  45. bool __fastcall Info(const UnicodeString Command,
  46. UnicodeString * Description, UnicodeString * Help);
  47. bool __fastcall Enumerate(int Index,
  48. UnicodeString * Command, UnicodeString * Description, UnicodeString * Help);
  49. static int __fastcall FindCommand(TStrings * Commands, const UnicodeString Command,
  50. UnicodeString * Matches = NULL);
  51. static int __fastcall FindCommand(const wchar_t ** Commands, size_t Count,
  52. const UnicodeString Command, UnicodeString * Matches = NULL);
  53. static void __fastcall CheckParams(TOptions * Parameters, bool Switches);
  54. protected:
  55. struct TScriptCommand
  56. {
  57. UnicodeString Description;
  58. UnicodeString Help;
  59. TCommandProc Proc;
  60. int MinParams;
  61. int MaxParams;
  62. bool Switches;
  63. };
  64. TScript * FScript;
  65. };
  66. //---------------------------------------------------------------------------
  67. __fastcall TScriptCommands::TScriptCommands(TScript * Script)
  68. {
  69. FScript = Script;
  70. Sorted = true;
  71. CaseSensitive = false;
  72. }
  73. //---------------------------------------------------------------------------
  74. __fastcall TScriptCommands::~TScriptCommands()
  75. {
  76. for (int Index = 0; Index < Count; Index++)
  77. {
  78. delete reinterpret_cast<TScriptCommand *>(Objects[Index]);
  79. }
  80. }
  81. //---------------------------------------------------------------------------
  82. void __fastcall TScriptCommands::Register(const wchar_t * Command,
  83. const UnicodeString Description, const UnicodeString Help, TCommandProc Proc,
  84. int MinParams, int MaxParams, bool Switches)
  85. {
  86. TScriptCommand * ScriptCommand = new TScriptCommand;
  87. ScriptCommand->Description = Description;
  88. ScriptCommand->Help = Help;
  89. ScriptCommand->Proc = Proc;
  90. ScriptCommand->MinParams = MinParams;
  91. ScriptCommand->MaxParams = MaxParams;
  92. ScriptCommand->Switches = Switches;
  93. AddObject(Command, reinterpret_cast<TObject *>(ScriptCommand));
  94. }
  95. //---------------------------------------------------------------------------
  96. void __fastcall TScriptCommands::Register(const wchar_t * Command,
  97. int Description, int Help, TCommandProc Proc,
  98. int MinParams, int MaxParams, bool Switches)
  99. {
  100. UnicodeString ADescription;
  101. if (Description > 0)
  102. {
  103. ADescription = LoadStr(Description);
  104. }
  105. UnicodeString AHelp;
  106. if (Help > 0)
  107. {
  108. AHelp = LoadStr(Help, 10240);
  109. }
  110. Register(Command, ADescription, AHelp, Proc, MinParams, MaxParams, Switches);
  111. }
  112. //---------------------------------------------------------------------------
  113. bool __fastcall TScriptCommands::Info(const UnicodeString Command,
  114. UnicodeString * Description, UnicodeString * Help)
  115. {
  116. int Index = FindCommand(this, Command);
  117. bool Result = (Index >= 0);
  118. if (Result)
  119. {
  120. TScriptCommand * ScriptCommand = reinterpret_cast<TScriptCommand *>(Objects[Index]);
  121. if (Description != NULL)
  122. {
  123. *Description = ScriptCommand->Description;
  124. }
  125. if (Help != NULL)
  126. {
  127. *Help = ScriptCommand->Help;
  128. }
  129. }
  130. return Result;
  131. }
  132. //---------------------------------------------------------------------------
  133. bool __fastcall TScriptCommands::Enumerate(int Index,
  134. UnicodeString * Command, UnicodeString * Description, UnicodeString * Help)
  135. {
  136. bool Result = (Index < Count);
  137. if (Result)
  138. {
  139. TScriptCommand * ScriptCommand = reinterpret_cast<TScriptCommand *>(Objects[Index]);
  140. if (Command != NULL)
  141. {
  142. *Command = Strings[Index];
  143. }
  144. if (Description != NULL)
  145. {
  146. *Description = ScriptCommand->Description;
  147. }
  148. if (Help != NULL)
  149. {
  150. *Help = ScriptCommand->Help;
  151. }
  152. }
  153. return Result;
  154. }
  155. //---------------------------------------------------------------------------
  156. int __fastcall TScriptCommands::FindCommand(TStrings * Commands,
  157. const UnicodeString Command, UnicodeString * Matches)
  158. {
  159. int Result = Commands->IndexOf(Command);
  160. if (Result < 0)
  161. {
  162. int MatchesCount = 0;
  163. for (int i = 0; i < Commands->Count; i++)
  164. {
  165. if ((Command.Length() <= Commands->Strings[i].Length()) &&
  166. SameText(Command, Commands->Strings[i].SubString(1, Command.Length())))
  167. {
  168. if (Matches != NULL)
  169. {
  170. if (!Matches->IsEmpty())
  171. {
  172. *Matches += L", ";
  173. }
  174. *Matches += Commands->Strings[i];
  175. }
  176. MatchesCount++;
  177. Result = i;
  178. }
  179. }
  180. if (MatchesCount == 0)
  181. {
  182. Result = -1;
  183. }
  184. else if (MatchesCount > 1)
  185. {
  186. Result = -2;
  187. }
  188. }
  189. return Result;
  190. }
  191. //---------------------------------------------------------------------------
  192. int __fastcall TScriptCommands::FindCommand(const wchar_t ** Commands, size_t Count,
  193. const UnicodeString Command, UnicodeString * Matches)
  194. {
  195. int Result;
  196. TStringList * Strings = new TStringList;
  197. try
  198. {
  199. Strings->CaseSensitive = false;
  200. for (unsigned int i = 0; i < Count; i++)
  201. {
  202. Strings->Add(Commands[i]);
  203. }
  204. Result = FindCommand(Strings, Command, Matches);
  205. }
  206. __finally
  207. {
  208. delete Strings;
  209. }
  210. return Result;
  211. }
  212. //---------------------------------------------------------------------------
  213. void __fastcall TScriptCommands::CheckParams(TOptions * Parameters,
  214. bool Switches)
  215. {
  216. UnicodeString Switch;
  217. if (!Switches && Parameters->UnusedSwitch(Switch))
  218. {
  219. throw Exception(FMTLOAD(SCRIPT_UNKNOWN_SWITCH, (Switch)));
  220. }
  221. }
  222. //---------------------------------------------------------------------------
  223. UnicodeString __fastcall TScriptCommands::ResolveCommand(const UnicodeString & Command)
  224. {
  225. UnicodeString Matches;
  226. int Index = FindCommand(this, Command, &Matches);
  227. if (Index >= 0)
  228. {
  229. return Strings[Index];
  230. }
  231. else
  232. {
  233. return UnicodeString();
  234. }
  235. }
  236. //---------------------------------------------------------------------------
  237. // parameters are by purpose passed by (constant) reference.
  238. // because if passed by value (copy), UnicodeString reference is not for some reason
  239. // decreased on exit by exception, leading to memory leak
  240. void __fastcall TScriptCommands::Execute(const UnicodeString & Command, const UnicodeString & Params)
  241. {
  242. UnicodeString Matches;
  243. int Index = FindCommand(this, Command, &Matches);
  244. if (Index == -2)
  245. {
  246. throw Exception(FMTLOAD(SCRIPT_COMMAND_AMBIGUOUS, (Command, Matches)));
  247. }
  248. else if (Index < 0)
  249. {
  250. throw Exception(FMTLOAD(SCRIPT_COMMAND_UNKNOWN, (Command)));
  251. }
  252. TScriptCommand * ScriptCommand = reinterpret_cast<TScriptCommand *>(Objects[Index]);
  253. UnicodeString FullCommand = Strings[Index];
  254. std::unique_ptr<TScriptProcParams> Parameters(new TScriptProcParams(FullCommand, Params));
  255. if (Parameters->ParamCount < ScriptCommand->MinParams)
  256. {
  257. throw Exception(FMTLOAD(SCRIPT_MISSING_PARAMS, (FullCommand)));
  258. }
  259. else if ((ScriptCommand->MaxParams >= 0) && (Parameters->ParamCount > ScriptCommand->MaxParams))
  260. {
  261. throw Exception(FMTLOAD(SCRIPT_TOO_MANY_PARAMS, (FullCommand)));
  262. }
  263. else
  264. {
  265. CheckParams(Parameters.get(), ScriptCommand->Switches);
  266. ScriptCommand->Proc(Parameters.get());
  267. }
  268. }
  269. //---------------------------------------------------------------------------
  270. //---------------------------------------------------------------------------
  271. // keep in sync with Session constructor in .NET
  272. const int BatchSessionReopenTimeout = 2 * MSecsPerSec * SecsPerMin; // 2 mins
  273. //---------------------------------------------------------------------------
  274. __fastcall TScript::TScript(bool LimitedOutput)
  275. {
  276. FLimitedOutput = LimitedOutput;
  277. FTerminal = NULL;
  278. FGroups = false;
  279. FWantsProgress = false;
  280. FInteractive = false;
  281. FIncludeFileMaskOptionUsed = false;
  282. FPendingLogLines = new TStringList();
  283. Init();
  284. }
  285. //---------------------------------------------------------------------------
  286. __fastcall TScript::~TScript()
  287. {
  288. delete FCommands;
  289. delete FPendingLogLines;
  290. }
  291. //---------------------------------------------------------------------------
  292. void __fastcall TScript::Init()
  293. {
  294. FBatch = BatchAbort;
  295. FInteractiveBatch = BatchOff;
  296. FConfirm = false;
  297. FInteractiveConfirm = true;
  298. FSessionReopenTimeout = Configuration->SessionReopenTimeout;
  299. FInteractiveSessionReopenTimeout = FSessionReopenTimeout;
  300. if (FSessionReopenTimeout == 0)
  301. {
  302. FSessionReopenTimeout = BatchSessionReopenTimeout;
  303. }
  304. FEcho = false;
  305. FFailOnNoMatch = false;
  306. FSynchronizeParams = 0;
  307. FOnPrint = NULL;
  308. FOnTerminalSynchronizeDirectory = NULL;
  309. FOnSynchronizeStartStop = NULL;
  310. FSynchronizeMode = -1;
  311. FKeepingUpToDate = false;
  312. FWarnNonDefaultCopyParam = false;
  313. FWarnNonDefaultSynchronizeParams = false;
  314. FCommands = new TScriptCommands(this);
  315. FCommands->Register(L"help", SCRIPT_HELP_DESC, SCRIPT_HELP_HELP, &HelpProc, 0, -1, false);
  316. FCommands->Register(L"man", 0, SCRIPT_HELP_HELP, &HelpProc, 0, -1, false);
  317. // the call command does not have switches itself, but the commands may have
  318. FCommands->Register(L"call", SCRIPT_CALL_DESC2, SCRIPT_CALL_HELP2, &CallProc, 1, -1, true);
  319. FCommands->Register(L"!", 0, SCRIPT_CALL_HELP2, &CallProc, 1, -1, true);
  320. FCommands->Register(L"pwd", SCRIPT_PWD_DESC, SCRIPT_PWD_HELP, &PwdProc, 0, 0, false);
  321. FCommands->Register(L"cd", SCRIPT_CD_DESC, SCRIPT_CD_HELP, &CdProc, 0, 1, false);
  322. FCommands->Register(L"ls", SCRIPT_LS_DESC, SCRIPT_LS_HELP2, &LsProc, 0, 1, false);
  323. FCommands->Register(L"dir", 0, SCRIPT_LS_HELP2, &LsProc, 0, 1, false);
  324. FCommands->Register(L"rm", SCRIPT_RM_DESC, SCRIPT_RM_HELP2, &RmProc, 1, -1, false);
  325. FCommands->Register(L"rmdir", SCRIPT_RMDIR_DESC, SCRIPT_RMDIR_HELP, &RmDirProc, 1, -1, false);
  326. FCommands->Register(L"mv", SCRIPT_MV_DESC, SCRIPT_MV_HELP2, &MvProc, 2, -1, false);
  327. FCommands->Register(L"rename", 0, SCRIPT_MV_HELP2, &MvProc, 2, -1, false);
  328. FCommands->Register(L"cp", SCRIPT_CP_DESC, SCRIPT_CP_HELP, &CpProc, 2, -1, false);
  329. FCommands->Register(L"chmod", SCRIPT_CHMOD_DESC, SCRIPT_CHMOD_HELP2, &ChModProc, 2, -1, false);
  330. FCommands->Register(L"ln", SCRIPT_LN_DESC, SCRIPT_LN_HELP, &LnProc, 2, 2, false);
  331. FCommands->Register(L"symlink", 0, SCRIPT_LN_HELP, &LnProc, 2, 2, false);
  332. FCommands->Register(L"mkdir", SCRIPT_MKDIR_DESC, SCRIPT_MKDIR_HELP, &MkDirProc, 1, 1, false);
  333. FCommands->Register(L"get", SCRIPT_GET_DESC, SCRIPT_GET_HELP8, &GetProc, 0, -1, true);
  334. FCommands->Register(L"recv", 0, SCRIPT_GET_HELP8, &GetProc, 0, -1, true);
  335. FCommands->Register(L"mget", 0, SCRIPT_GET_HELP8, &GetProc, 0, -1, true);
  336. FCommands->Register(L"put", SCRIPT_PUT_DESC, SCRIPT_PUT_HELP8, &PutProc, 0, -1, true);
  337. FCommands->Register(L"send", 0, SCRIPT_PUT_HELP8, &PutProc, 0, -1, true);
  338. FCommands->Register(L"mput", 0, SCRIPT_PUT_HELP8, &PutProc, 0, -1, true);
  339. FCommands->Register(L"option", SCRIPT_OPTION_DESC, SCRIPT_OPTION_HELP7, &OptionProc, -1, 2, false);
  340. FCommands->Register(L"ascii", 0, SCRIPT_OPTION_HELP7, &AsciiProc, 0, 0, false);
  341. FCommands->Register(L"binary", 0, SCRIPT_OPTION_HELP7, &BinaryProc, 0, 0, false);
  342. FCommands->Register(L"synchronize", SCRIPT_SYNCHRONIZE_DESC, SCRIPT_SYNCHRONIZE_HELP7, &SynchronizeProc, 0, -1, true);
  343. FCommands->Register(L"keepuptodate", SCRIPT_KEEPUPTODATE_DESC, SCRIPT_KEEPUPTODATE_HELP5, &KeepUpToDateProc, 0, 2, true);
  344. // the echo command does not have switches actually, but it must handle dashes in its arguments
  345. FCommands->Register(L"echo", SCRIPT_ECHO_DESC, SCRIPT_ECHO_HELP, &EchoProc, -1, -1, true);
  346. FCommands->Register(L"stat", SCRIPT_STAT_DESC, SCRIPT_STAT_HELP, &StatProc, 1, 1, false);
  347. FCommands->Register(L"checksum", SCRIPT_CHECKSUM_DESC, SCRIPT_CHECKSUM_HELP, &ChecksumProc, 2, 2, false);
  348. }
  349. //---------------------------------------------------------------------------
  350. void __fastcall TScript::RequireParams(TScriptProcParams * Parameters, int MinParams)
  351. {
  352. if (Parameters->ParamCount < MinParams)
  353. {
  354. throw Exception(FMTLOAD(SCRIPT_MISSING_PARAMS, (Parameters->FullCommand)));
  355. }
  356. }
  357. //---------------------------------------------------------------------------
  358. void __fastcall TScript::CheckDefaultCopyParam()
  359. {
  360. if (FWarnNonDefaultCopyParam)
  361. {
  362. // started with non-factory settings and still have them, warn
  363. if (HasNonDefaultCopyParams())
  364. {
  365. PrintLine(LoadStr(SCRIPT_NON_DEFAULT_COPY_PARAM));
  366. }
  367. FWarnNonDefaultCopyParam = false;
  368. }
  369. }
  370. //---------------------------------------------------------------------------
  371. bool __fastcall TScript::HasNonDefaultCopyParams()
  372. {
  373. return !(FCopyParam == TCopyParamType());
  374. }
  375. //---------------------------------------------------------------------------
  376. void __fastcall TScript::SetCopyParam(const TCopyParamType & value)
  377. {
  378. FCopyParam.Assign(&value);
  379. FWarnNonDefaultCopyParam = HasNonDefaultCopyParams();
  380. }
  381. //---------------------------------------------------------------------------
  382. void __fastcall TScript::CheckDefaultSynchronizeParams()
  383. {
  384. if (FWarnNonDefaultSynchronizeParams)
  385. {
  386. // as opposite to CheckDefaultCopyParam(), not checking
  387. // current params as we cannot override any of those we accept anyway
  388. PrintLine(LoadStr(SCRIPT_NON_DEFAULT_SYNC_PARAM));
  389. FWarnNonDefaultSynchronizeParams = false;
  390. }
  391. }
  392. //---------------------------------------------------------------------------
  393. void __fastcall TScript::SetSynchronizeParams(int value)
  394. {
  395. const int AcceptedParams =
  396. TTerminal::spExistingOnly | TTerminal::spTimestamp |
  397. TTerminal::spNotByTime | TTerminal::spBySize;
  398. FSynchronizeParams = (value & AcceptedParams);
  399. FWarnNonDefaultSynchronizeParams =
  400. (FSynchronizeParams != (TTerminal::spDefault & AcceptedParams));
  401. }
  402. //---------------------------------------------------------------------------
  403. bool __fastcall TScript::IsTerminalLogging(TTerminal * ATerminal)
  404. {
  405. return (ATerminal != NULL) && ATerminal->Log->Logging;
  406. }
  407. //---------------------------------------------------------------------------
  408. const static UnicodeString ScriptLogFormat(L"Script: %s");
  409. void __fastcall TScript::Log(TLogLineType Type, UnicodeString Str)
  410. {
  411. Str = FORMAT(ScriptLogFormat, (Str));
  412. if (IsTerminalLogging(Terminal))
  413. {
  414. Terminal->Log->Add(Type, Str);
  415. }
  416. else if (Configuration->Logging)
  417. {
  418. FPendingLogLines->AddObject(Str, reinterpret_cast<TObject *>(Type));
  419. }
  420. }
  421. //---------------------------------------------------------------------------
  422. void __fastcall TScript::LogOption(const UnicodeString & LogStr)
  423. {
  424. Log(llInput, LogStr);
  425. }
  426. //---------------------------------------------------------------------------
  427. void __fastcall TScript::LogPendingLines(TTerminal * ATerminal)
  428. {
  429. if (IsTerminalLogging(ATerminal) && (FPendingLogLines->Count > 0))
  430. {
  431. // not using Log(), as we want to log to ATerminal, not Terminal,
  432. // what is different here, as we are called from TManagementScript::Connect()
  433. ATerminal->Log->Add(llMessage, FORMAT(ScriptLogFormat, (L"Retrospectively logging previous script records:")));
  434. for (int Index = 0; Index < FPendingLogLines->Count; Index++)
  435. {
  436. ATerminal->Log->Add(
  437. reinterpret_cast<TLogLineType>(FPendingLogLines->Objects[Index]),
  438. FPendingLogLines->Strings[Index]);
  439. }
  440. FPendingLogLines->Clear();
  441. ATerminal->Log->AddSeparator();
  442. }
  443. }
  444. //---------------------------------------------------------------------------
  445. UnicodeString __fastcall TScript::GetLogCmd(const UnicodeString & FullCommand,
  446. const UnicodeString & /*Command*/, const UnicodeString & /*Params*/)
  447. {
  448. return FullCommand;
  449. }
  450. //---------------------------------------------------------------------------
  451. void __fastcall TScript::StartInteractive()
  452. {
  453. FBatch = FInteractiveBatch;
  454. FConfirm = FInteractiveConfirm;
  455. FSessionReopenTimeout = FInteractiveSessionReopenTimeout;
  456. }
  457. //---------------------------------------------------------------------------
  458. void __fastcall TScript::Command(UnicodeString Cmd)
  459. {
  460. try
  461. {
  462. if (!Cmd.Trim().IsEmpty() && (Cmd[1] != L';') && (Cmd[1] != L'#'))
  463. {
  464. UnicodeString FullCmd = Cmd;
  465. UnicodeString Command;
  466. if (CutToken(Cmd, Command))
  467. {
  468. UnicodeString LogCmd = GetLogCmd(FullCmd, Command, Cmd);
  469. Log(llInput, LogCmd);
  470. if (Configuration->LogProtocol >= 1)
  471. {
  472. UnicodeString DummyLogCmd;
  473. if (DebugAlwaysTrue(CutToken(LogCmd, DummyLogCmd)))
  474. {
  475. std::unique_ptr<TScriptProcParams> Parameters(new TScriptProcParams(FCommands->ResolveCommand(Cmd), LogCmd));
  476. Parameters->LogOptions(LogOption);
  477. }
  478. }
  479. if (FEcho)
  480. {
  481. PrintLine(LogCmd);
  482. }
  483. TTerminal * BeforeGroupTerminal = FGroups ? Terminal : NULL;
  484. if (BeforeGroupTerminal != NULL)
  485. {
  486. BeforeGroupTerminal->ActionLog->BeginGroup(LogCmd);
  487. }
  488. int ASessionReopenTimeout = Configuration->SessionReopenTimeout;
  489. try
  490. {
  491. Configuration->SessionReopenTimeout = FSessionReopenTimeout;
  492. try
  493. {
  494. FCommands->Execute(Command, Cmd);
  495. }
  496. catch(Exception & E)
  497. {
  498. // seemingly duplicate (to the method-level one) catch clause,
  499. // ensures the <failure/> tag is enclosed in <group/> tag
  500. if (!HandleExtendedException(&E))
  501. {
  502. throw;
  503. }
  504. }
  505. }
  506. __finally
  507. {
  508. Configuration->SessionReopenTimeout = ASessionReopenTimeout;
  509. TTerminal * AfterGroupTerminal = FGroups ? Terminal : NULL;
  510. if (AfterGroupTerminal != NULL)
  511. {
  512. // this happens for "open" command
  513. if (AfterGroupTerminal != BeforeGroupTerminal)
  514. {
  515. AfterGroupTerminal->ActionLog->BeginGroup(LogCmd);
  516. }
  517. AfterGroupTerminal->ActionLog->EndGroup();
  518. }
  519. }
  520. }
  521. }
  522. }
  523. catch(Exception & E)
  524. {
  525. if (!HandleExtendedException(&E))
  526. {
  527. throw;
  528. }
  529. }
  530. }
  531. //---------------------------------------------------------------------------
  532. TStrings * __fastcall TScript::CreateFileList(TScriptProcParams * Parameters, int Start,
  533. int End, TFileListType ListType)
  534. {
  535. TStrings * Result = new TStringList();
  536. TStrings * FileLists = NULL;
  537. try
  538. {
  539. try
  540. {
  541. for (int i = Start; i <= End; i++)
  542. {
  543. UnicodeString FileName = Parameters->Param[i];
  544. if (SimpleUnixExcludeTrailingBackslash(FileName) != FileName)
  545. {
  546. PrintLine(LoadStr(SCRIPT_AMBIGUOUS_SLASH_IN_PATH));
  547. }
  548. if (FLAGSET(ListType, fltDirectories))
  549. {
  550. TRemoteFile * File = new TRemoteFile();
  551. File->FileName = FileName;
  552. File->Type = FILETYPE_DIRECTORY;
  553. Result->AddObject(FileName, File);
  554. }
  555. else if (FLAGSET(ListType, fltMask) && TFileMasks::IsMask(FileName))
  556. {
  557. UnicodeString FileDirectory = UnixExtractFilePath(FileName);
  558. UnicodeString Directory = FileDirectory;
  559. if (Directory.IsEmpty())
  560. {
  561. Directory = UnixIncludeTrailingBackslash(FTerminal->CurrentDirectory);
  562. }
  563. TRemoteFileList * FileList = NULL;
  564. if (FileLists != NULL)
  565. {
  566. int Index = FileLists->IndexOf(Directory);
  567. if (Index > 0)
  568. {
  569. FileList = dynamic_cast<TRemoteFileList *>(FileLists->Objects[Index]);
  570. }
  571. }
  572. if (FileList == NULL)
  573. {
  574. FileList = FTerminal->CustomReadDirectoryListing(Directory, false);
  575. if (FileLists == NULL)
  576. {
  577. FileLists = new TStringList();
  578. }
  579. FileLists->AddObject(Directory, FileList);
  580. }
  581. TFileMasks Mask;
  582. Mask.SetMask(UnixExtractFileName(FileName));
  583. bool AnyFound = false;
  584. // Can happen in "batch continue" mode
  585. if (FileList != NULL)
  586. {
  587. for (int i = 0; i < FileList->Count; i++)
  588. {
  589. TRemoteFile * File = FileList->Files[i];
  590. TFileMasks::TParams Params;
  591. Params.Size = File->Size;
  592. Params.Modification = File->Modification;
  593. if (IsRealFile(File->FileName) &&
  594. Mask.Matches(File->FileName, false, UnicodeString(), &Params))
  595. {
  596. Result->AddObject(FileDirectory + File->FileName,
  597. FLAGSET(ListType, fltQueryServer) ? File->Duplicate() : NULL);
  598. AnyFound = true;
  599. }
  600. }
  601. }
  602. if (!AnyFound)
  603. {
  604. NoMatch(Mask.Masks, UnicodeString());
  605. }
  606. }
  607. else
  608. {
  609. TRemoteFile * File = NULL;
  610. if (FLAGSET(ListType, fltQueryServer))
  611. {
  612. FTerminal->ExceptionOnFail = true;
  613. try
  614. {
  615. FTerminal->ReadFile(UnixExcludeTrailingBackslash(FileName), File);
  616. if (!File->HaveFullFileName)
  617. {
  618. File->FullFileName = FileName;
  619. }
  620. }
  621. __finally
  622. {
  623. FTerminal->ExceptionOnFail = false;
  624. }
  625. }
  626. Result->AddObject(FileName, File);
  627. }
  628. }
  629. }
  630. catch(...)
  631. {
  632. FreeFileList(Result);
  633. throw;
  634. }
  635. }
  636. __finally
  637. {
  638. if (FileLists != NULL)
  639. {
  640. for (int i = 0; i < FileLists->Count; i++)
  641. {
  642. delete FileLists->Objects[i];
  643. }
  644. delete FileLists;
  645. }
  646. }
  647. if (FLAGSET(ListType, fltLatest) && (Result->Count > 1))
  648. {
  649. // otherwise we do not have TRemoteFile's
  650. DebugAssert(FLAGSET(ListType, fltQueryServer));
  651. int LatestIndex = 0;
  652. for (int Index = 1; Index < Result->Count; Index++)
  653. {
  654. TRemoteFile * File = dynamic_cast<TRemoteFile *>(Result->Objects[Index]);
  655. if (dynamic_cast<TRemoteFile *>(Result->Objects[LatestIndex])->Modification < File->Modification)
  656. {
  657. LatestIndex = Index;
  658. }
  659. }
  660. TRemoteFile * File = dynamic_cast<TRemoteFile *>(Result->Objects[LatestIndex]);
  661. UnicodeString Path = Result->Strings[LatestIndex];
  662. Result->Delete(LatestIndex);
  663. FreeFiles(Result);
  664. Result->Clear();
  665. Result->AddObject(Path, File);
  666. }
  667. return Result;
  668. }
  669. //---------------------------------------------------------------------------
  670. TStrings * __fastcall TScript::CreateLocalFileList(TScriptProcParams * Parameters,
  671. int Start, int End, TFileListType ListType)
  672. {
  673. TStringList * Result = new TStringList();
  674. try
  675. {
  676. Result->OwnsObjects = true;
  677. UnicodeString LatestFileName;
  678. TDateTime LatestModification; // initialized to 0
  679. for (int i = Start; i <= End; i++)
  680. {
  681. // FindFirstFile called (indirectly) below fails if path ends with slash.
  682. // (it actually won't make a difference functionally as we fall back to adding
  683. // the path as is in "else" branch, but the comment "let it fail later" won't stand)
  684. UnicodeString FileName = ExcludeTrailingBackslash(Parameters->Param[i]);
  685. if (FileName != Parameters->Param[i])
  686. {
  687. PrintLine(LoadStr(SCRIPT_AMBIGUOUS_SLASH_IN_PATH));
  688. }
  689. if (FLAGSET(ListType, fltMask))
  690. {
  691. TSearchRecOwned SearchRec;
  692. int FindAttrs = faReadOnly | faHidden | faSysFile | faDirectory | faArchive;
  693. UnicodeString Error;
  694. bool AnyFound = false;
  695. if (FindFirstUnchecked(FileName, FindAttrs, SearchRec) == 0)
  696. {
  697. UnicodeString Directory = ExtractFilePath(FileName);
  698. do
  699. {
  700. if (SearchRec.IsRealFile())
  701. {
  702. UnicodeString FileName = Directory + SearchRec.Name;
  703. TLocalFile * LocalFile = new TLocalFile;
  704. CopySearchRec(SearchRec, LocalFile->SearchRec);
  705. Result->AddObject(FileName, LocalFile);
  706. if (SearchRec.TimeStamp > LatestModification)
  707. {
  708. LatestFileName = FileName;
  709. LatestModification = SearchRec.TimeStamp;
  710. }
  711. AnyFound = true;
  712. }
  713. }
  714. while (FindNextChecked(SearchRec) == 0);
  715. }
  716. else
  717. {
  718. if (FileName.LastDelimiter(L"?*") == 0)
  719. {
  720. // No match, and it is not a mask, let it fail latter.
  721. // But with -latest, we have to fail straight away
  722. // (so maybe we should fail unconditionally now,
  723. // once we need to have the code in place anyway)
  724. if (FLAGSET(ListType, fltLatest))
  725. {
  726. throw Exception(FMTLOAD(FILE_NOT_EXISTS, (FileName)));
  727. }
  728. Result->Add(FileName);
  729. AnyFound = true;
  730. }
  731. else
  732. {
  733. Error = ListingSysErrorMessage();
  734. }
  735. }
  736. if (!AnyFound)
  737. {
  738. NoMatch(ExtractFileName(FileName), Error);
  739. }
  740. }
  741. else
  742. {
  743. DebugAssert(FLAGCLEAR(ListType, fltLatest));
  744. // this branch is currently never used
  745. Result->Add(FileName);
  746. }
  747. }
  748. if (FLAGSET(ListType, fltLatest))
  749. {
  750. Result->Clear();
  751. if (!LatestFileName.IsEmpty())
  752. {
  753. Result->Add(LatestFileName);
  754. }
  755. }
  756. }
  757. catch(...)
  758. {
  759. delete Result;
  760. throw;
  761. }
  762. return Result;
  763. }
  764. //---------------------------------------------------------------------------
  765. UnicodeString __fastcall TScript::ListingSysErrorMessage()
  766. {
  767. UnicodeString Result;
  768. int LastError = GetLastError();
  769. // System error text for ERROR_FILE_NOT_FOUND is more or less redundant to ours
  770. // SCRIPT_MATCH_NO_MATCH. Also the system error does not look nice/user friendly
  771. // so avoid using it for this frequent case.
  772. if (LastError != ERROR_FILE_NOT_FOUND)
  773. {
  774. Result = SysErrorMessageForError(LastError);
  775. }
  776. return Result;
  777. }
  778. //---------------------------------------------------------------------------
  779. void __fastcall TScript::NoMatch(const UnicodeString & Message)
  780. {
  781. if (FFailOnNoMatch)
  782. {
  783. throw Exception(Message);
  784. }
  785. else
  786. {
  787. PrintLine(Message);
  788. }
  789. }
  790. //---------------------------------------------------------------------------
  791. void __fastcall TScript::NoMatch(const UnicodeString & Mask, const UnicodeString & Error)
  792. {
  793. UnicodeString Message = FMTLOAD(SCRIPT_MATCH_NO_MATCH, (Mask));
  794. if (!Error.IsEmpty())
  795. {
  796. Message += FORMAT(L" (%s)", (Error));
  797. }
  798. NoMatch(Message);
  799. }
  800. //---------------------------------------------------------------------------
  801. void __fastcall TScript::FreeFiles(TStrings * FileList)
  802. {
  803. for (int i = 0; i < FileList->Count; i++)
  804. {
  805. if (FileList->Objects[i] != NULL)
  806. {
  807. TRemoteFile * File = dynamic_cast<TRemoteFile *>(FileList->Objects[i]);
  808. delete File;
  809. }
  810. }
  811. }
  812. //---------------------------------------------------------------------------
  813. void __fastcall TScript::FreeFileList(TStrings * FileList)
  814. {
  815. FreeFiles(FileList);
  816. delete FileList;
  817. }
  818. //---------------------------------------------------------------------------
  819. void __fastcall TScript::ConnectTerminal(TTerminal * ATerminal)
  820. {
  821. ATerminal->Open();
  822. }
  823. //---------------------------------------------------------------------------
  824. void __fastcall TScript::Print(const UnicodeString Str, bool Error)
  825. {
  826. if (FOnPrint != NULL)
  827. {
  828. FOnPrint(this, Str, Error);
  829. }
  830. }
  831. //---------------------------------------------------------------------------
  832. void __fastcall TScript::PrintLine(const UnicodeString Str, bool Error)
  833. {
  834. Log(llOutput, Str);
  835. Print(Str + L"\n", Error);
  836. }
  837. //---------------------------------------------------------------------------
  838. bool __fastcall TScript::HandleExtendedException(Exception * E, TTerminal * ATerminal)
  839. {
  840. bool Result = (OnShowExtendedException != NULL);
  841. if (Result)
  842. {
  843. if (ATerminal == NULL)
  844. {
  845. ATerminal = FTerminal;
  846. }
  847. OnShowExtendedException(ATerminal, E, NULL);
  848. }
  849. return Result;
  850. }
  851. //---------------------------------------------------------------------------
  852. void __fastcall TScript::CheckSession()
  853. {
  854. if (FTerminal == NULL)
  855. {
  856. throw Exception(LoadStr(SCRIPT_NO_SESSION));
  857. }
  858. }
  859. //---------------------------------------------------------------------------
  860. void __fastcall TScript::NotSupported()
  861. {
  862. throw Exception(LoadStr(NOTSUPPORTED));
  863. }
  864. //---------------------------------------------------------------------------
  865. void __fastcall TScript::CheckMultiFilesToOne(TStrings * FileList, const UnicodeString & Target, bool Unix)
  866. {
  867. UnicodeString Name;
  868. if (Unix)
  869. {
  870. Name = UnixExtractFileName(Target);
  871. }
  872. else
  873. {
  874. Name = ExtractFileName(Target);
  875. }
  876. if (!IsFileNameMask(Name) && (FileList->Count > 1))
  877. {
  878. UnicodeString Message =
  879. RemoveEmptyLines(UnformatMessage(FormatMultiFilesToOneConfirmation(Target, Unix)));
  880. PrintLine(Message);
  881. }
  882. }
  883. //---------------------------------------------------------------------------
  884. void __fastcall TScript::CheckParams(TScriptProcParams * Parameters)
  885. {
  886. TScriptCommands::CheckParams(Parameters, false);
  887. }
  888. //---------------------------------------------------------------------------
  889. void __fastcall TScript::TransferParamParams(int & Params, TScriptProcParams * Parameters)
  890. {
  891. Params |= FLAGMASK(!FConfirm, cpNoConfirmation);
  892. if (Parameters->FindSwitch(DELETE_SWITCH))
  893. {
  894. Params |= cpDelete;
  895. }
  896. if (Parameters->FindSwitch(L"resume"))
  897. {
  898. Params |= cpResume;
  899. }
  900. else if (Parameters->FindSwitch(L"append"))
  901. {
  902. Params |= cpAppend;
  903. }
  904. }
  905. //---------------------------------------------------------------------------
  906. void __fastcall TScript::CopyParamParams(TCopyParamType & CopyParam, TScriptProcParams * Parameters)
  907. {
  908. UnicodeString Value;
  909. if (!FWantsProgress)
  910. {
  911. // total size is not visualized, hence it makes no sense to calculate it
  912. CopyParam.CalculateSize = false;
  913. }
  914. if (Parameters->FindSwitch(NOPRESERVETIME_SWITCH))
  915. {
  916. CopyParam.PreserveTime = false;
  917. CopyParam.PreserveTimeDirs = false;
  918. }
  919. if (Parameters->FindSwitch(PRESERVETIME_SWITCH, Value))
  920. {
  921. CopyParam.PreserveTime = true;
  922. if (SameText(Value, PRESERVETIMEDIRS_SWITCH_VALUE))
  923. {
  924. CopyParam.PreserveTimeDirs = true;
  925. }
  926. }
  927. if (Parameters->FindSwitch(NOPERMISSIONS_SWITCH))
  928. {
  929. CopyParam.PreserveRights = false;
  930. }
  931. if (Parameters->FindSwitch(PERMISSIONS_SWITCH, Value))
  932. {
  933. CopyParam.PreserveRights = true;
  934. CopyParam.Rights.Octal = Value;
  935. }
  936. if (Parameters->FindSwitch(SPEED_SWITCH, Value))
  937. {
  938. int CPSLimit;
  939. if (Value.IsEmpty())
  940. {
  941. CPSLimit = 0;
  942. }
  943. else
  944. {
  945. CPSLimit = StrToInt(Value) * 1024;
  946. if (CPSLimit < 0)
  947. {
  948. CPSLimit = 0;
  949. }
  950. }
  951. CopyParam.CPSLimit = CPSLimit;
  952. }
  953. if (Parameters->FindSwitch(TRANSFER_SWITCH, Value))
  954. {
  955. CopyParam.TransferMode = ParseTransferModeName(Value);
  956. }
  957. if (Parameters->FindSwitch(FILEMASK_SWITCH, Value))
  958. {
  959. CopyParam.IncludeFileMask = Value;
  960. if (FIncludeFileMaskOptionUsed)
  961. {
  962. PrintLine(LoadStr(SCRIPT_FILEMASK_INCLUDE_EXCLUDE));
  963. }
  964. }
  965. if (Parameters->FindSwitch(RESUMESUPPORT_SWITCH, Value))
  966. {
  967. int ToggleValue = TScriptCommands::FindCommand(ToggleNames,
  968. LENOF(ToggleNames), Value);
  969. if (ToggleValue >= 0)
  970. {
  971. switch (ToggleValue)
  972. {
  973. case ToggleOff:
  974. CopyParam.ResumeSupport = rsOff;
  975. break;
  976. case ToggleOn:
  977. CopyParam.ResumeSupport = rsOn;
  978. break;
  979. default:
  980. DebugFail();
  981. break;
  982. }
  983. }
  984. else
  985. {
  986. int ThresholdValue;
  987. if (!TryStrToInt(Value, ThresholdValue))
  988. {
  989. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (RESUMESUPPORT_SWITCH, Value)));
  990. }
  991. CopyParam.ResumeSupport = rsSmart;
  992. CopyParam.ResumeThreshold = ThresholdValue * 1024;
  993. }
  994. }
  995. if (Parameters->FindSwitch(NONEWERONLY_SWICH))
  996. {
  997. CopyParam.NewerOnly = false;
  998. }
  999. if (Parameters->FindSwitch(NEWERONLY_SWICH))
  1000. {
  1001. CopyParam.NewerOnly = true;
  1002. }
  1003. std::unique_ptr<TStrings> RawSettings(new TStringList());
  1004. if (Parameters->FindSwitch(RAWTRANSFERSETTINGS_SWITCH, RawSettings.get()))
  1005. {
  1006. std::unique_ptr<TOptionsStorage> OptionsStorage(new TOptionsStorage(RawSettings.get(), false));
  1007. CopyParam.Load(OptionsStorage.get());
  1008. }
  1009. }
  1010. //---------------------------------------------------------------------------
  1011. void __fastcall TScript::ResetTransfer()
  1012. {
  1013. }
  1014. //---------------------------------------------------------------------------
  1015. bool __fastcall TScript::EnsureCommandSessionFallback(
  1016. TFSCapability Capability, TSessionAction & Action)
  1017. {
  1018. bool Result = FTerminal->IsCapable[Capability] ||
  1019. FTerminal->CommandSessionOpened;
  1020. if (!Result)
  1021. {
  1022. try
  1023. {
  1024. ConnectTerminal(FTerminal->CommandSession);
  1025. Result = true;
  1026. }
  1027. catch(Exception & E)
  1028. {
  1029. Action.Rollback(&E);
  1030. HandleExtendedException(&E, FTerminal->CommandSession);
  1031. Result = false;
  1032. }
  1033. }
  1034. return Result;
  1035. }
  1036. //---------------------------------------------------------------------------
  1037. void __fastcall TScript::HelpProc(TScriptProcParams * Parameters)
  1038. {
  1039. UnicodeString Output;
  1040. if (Parameters->ParamCount == 0)
  1041. {
  1042. UnicodeString Command;
  1043. UnicodeString Description;
  1044. int Index = 0;
  1045. while (FCommands->Enumerate(Index, &Command, &Description, NULL))
  1046. {
  1047. if (!Description.IsEmpty())
  1048. {
  1049. Output += FORMAT(L"%-8s %s\n", (Command, Description));
  1050. }
  1051. Index++;
  1052. }
  1053. }
  1054. else
  1055. {
  1056. for (int i = 1; i <= Parameters->ParamCount; i++)
  1057. {
  1058. UnicodeString Help;
  1059. if (FCommands->Info(Parameters->Param[i], NULL, &Help))
  1060. {
  1061. Output += Help;
  1062. }
  1063. else
  1064. {
  1065. throw Exception(FMTLOAD(SCRIPT_COMMAND_UNKNOWN, (Parameters->Param[i])));
  1066. }
  1067. }
  1068. }
  1069. Print(Output);
  1070. }
  1071. //---------------------------------------------------------------------------
  1072. void __fastcall TScript::CallProc(TScriptProcParams * Parameters)
  1073. {
  1074. CheckSession();
  1075. if (!FTerminal->IsCapable[fcAnyCommand] &&
  1076. !FTerminal->IsCapable[fcSecondaryShell])
  1077. {
  1078. NotSupported();
  1079. }
  1080. // this is used only to log failures to open separate shell session,
  1081. // the actual call logging is done in TTerminal::AnyCommand
  1082. TCallSessionAction Action(
  1083. FTerminal->ActionLog, Parameters->ParamsStr, FTerminal->CurrentDirectory);
  1084. if (EnsureCommandSessionFallback(fcAnyCommand, Action))
  1085. {
  1086. Action.Cancel();
  1087. FTerminal->AnyCommand(Parameters->ParamsStr, TerminalCaptureLog);
  1088. }
  1089. }
  1090. //---------------------------------------------------------------------------
  1091. void __fastcall TScript::EchoProc(TScriptProcParams * Parameters)
  1092. {
  1093. PrintLine(Parameters->ParamsStr);
  1094. }
  1095. //---------------------------------------------------------------------------
  1096. void __fastcall TScript::StatProc(TScriptProcParams * Parameters)
  1097. {
  1098. CheckSession();
  1099. UnicodeString Path = UnixExcludeTrailingBackslash(Parameters->Param[1]);
  1100. FTerminal->ExceptionOnFail = true;
  1101. TRemoteFile * File = NULL;
  1102. try
  1103. {
  1104. File = FTerminal->ReadFileListing(Path);
  1105. PrintLine(File->ListingStr);
  1106. }
  1107. __finally
  1108. {
  1109. FTerminal->ExceptionOnFail = false;
  1110. delete File;
  1111. }
  1112. }
  1113. //---------------------------------------------------------------------------
  1114. void __fastcall TScript::ChecksumProc(TScriptProcParams * Parameters)
  1115. {
  1116. CheckSession();
  1117. if (!FTerminal->IsCapable[fcCalculatingChecksum])
  1118. {
  1119. NotSupported();
  1120. }
  1121. UnicodeString Alg = Parameters->Param[1];
  1122. std::unique_ptr<TStrings> Checksums(new TStringList());
  1123. TStrings * FileList = CreateFileList(Parameters, 2, 2, fltQueryServer);
  1124. FTerminal->ExceptionOnFail = true;
  1125. try
  1126. {
  1127. if ((FileList->Count != 1) ||
  1128. DebugNotNull(dynamic_cast<TRemoteFile *>(FileList->Objects[0]))->IsDirectory)
  1129. {
  1130. throw Exception(FMTLOAD(NOT_FILE_ERROR, (FileList->Strings[0])));
  1131. }
  1132. FTerminal->CalculateFilesChecksum(Alg, FileList, Checksums.get(), NULL);
  1133. if (DebugAlwaysTrue(Checksums->Count == 1))
  1134. {
  1135. PrintLine(FORMAT(L"%s %s", (Checksums->Strings[0], FileList->Strings[0])));
  1136. }
  1137. }
  1138. __finally
  1139. {
  1140. FTerminal->ExceptionOnFail = false;
  1141. FreeFileList(FileList);
  1142. }
  1143. }
  1144. //---------------------------------------------------------------------------
  1145. void __fastcall TScript::TerminalCaptureLog(const UnicodeString & AddedLine,
  1146. TCaptureOutputType OutputType)
  1147. {
  1148. if ((OutputType == cotOutput) || (OutputType == cotError))
  1149. {
  1150. PrintLine(AddedLine);
  1151. }
  1152. }
  1153. //---------------------------------------------------------------------------
  1154. void __fastcall TScript::PwdProc(TScriptProcParams * /*Parameters*/)
  1155. {
  1156. CheckSession();
  1157. PrintLine(FTerminal->CurrentDirectory);
  1158. TCwdSessionAction Action(FTerminal->ActionLog, FTerminal->CurrentDirectory);
  1159. }
  1160. //---------------------------------------------------------------------------
  1161. void __fastcall TScript::CdProc(TScriptProcParams * Parameters)
  1162. {
  1163. CheckSession();
  1164. if (Parameters->ParamCount == 0)
  1165. {
  1166. FTerminal->HomeDirectory();
  1167. }
  1168. else
  1169. {
  1170. FTerminal->ChangeDirectory(Parameters->Param[1]);
  1171. }
  1172. PrintLine(FTerminal->CurrentDirectory);
  1173. }
  1174. //---------------------------------------------------------------------------
  1175. void __fastcall TScript::LsProc(TScriptProcParams * Parameters)
  1176. {
  1177. CheckSession();
  1178. UnicodeString Directory;
  1179. TFileMasks Mask;
  1180. bool HaveMask = false;
  1181. if (Parameters->ParamCount > 0)
  1182. {
  1183. Directory = Parameters->Param[1];
  1184. UnicodeString MaskStr = UnixExtractFileName(Directory);
  1185. HaveMask = TFileMasks::IsMask(MaskStr);
  1186. if (HaveMask)
  1187. {
  1188. Mask.SetMask(MaskStr);
  1189. Directory = UnixExtractFilePath(Directory);
  1190. }
  1191. }
  1192. if (Directory.IsEmpty())
  1193. {
  1194. Directory = FTerminal->CurrentDirectory;
  1195. }
  1196. TRemoteFileList * FileList = FTerminal->ReadDirectoryListing(Directory, Mask);
  1197. // on error user may select "skip", then we get NULL
  1198. if (FileList != NULL)
  1199. {
  1200. try
  1201. {
  1202. if (FileList->Count > 0)
  1203. {
  1204. for (int i = 0; i < FileList->Count; i++)
  1205. {
  1206. PrintLine(FileList->Files[i]->ListingStr);
  1207. }
  1208. }
  1209. else
  1210. {
  1211. if (HaveMask)
  1212. {
  1213. NoMatch(Mask.Masks, UnicodeString());
  1214. }
  1215. }
  1216. }
  1217. __finally
  1218. {
  1219. delete FileList;
  1220. }
  1221. }
  1222. }
  1223. //---------------------------------------------------------------------------
  1224. void __fastcall TScript::RmProc(TScriptProcParams * Parameters)
  1225. {
  1226. CheckSession();
  1227. TStrings * FileList = CreateFileList(
  1228. Parameters, 1, Parameters->ParamCount,
  1229. (TFileListType)(fltQueryServer | fltMask));
  1230. try
  1231. {
  1232. FTerminal->DeleteFiles(FileList);
  1233. }
  1234. __finally
  1235. {
  1236. FreeFileList(FileList);
  1237. }
  1238. }
  1239. //---------------------------------------------------------------------------
  1240. void __fastcall TScript::RmDirProc(TScriptProcParams * Parameters)
  1241. {
  1242. CheckSession();
  1243. TStrings * FileList = CreateFileList(Parameters, 1, Parameters->ParamCount, fltDirectories);
  1244. try
  1245. {
  1246. FTerminal->DeleteFiles(FileList);
  1247. }
  1248. __finally
  1249. {
  1250. FreeFileList(FileList);
  1251. }
  1252. }
  1253. //---------------------------------------------------------------------------
  1254. void __fastcall TScript::DoMvOrCp(TScriptProcParams * Parameters, TFSCapability Capability, bool Cp)
  1255. {
  1256. CheckSession();
  1257. if (!FTerminal->IsCapable[Capability])
  1258. {
  1259. NotSupported();
  1260. }
  1261. TStrings * FileList =
  1262. CreateFileList(Parameters, 1, Parameters->ParamCount - 1, TFileListType(fltMask | fltQueryServer));
  1263. try
  1264. {
  1265. DebugAssert(Parameters->ParamCount >= 1);
  1266. UnicodeString Target = Parameters->Param[Parameters->ParamCount];
  1267. UnicodeString TargetDirectory = UnixExtractFilePath(Target);
  1268. UnicodeString FileMask = UnixExtractFileName(Target);
  1269. Target = UnixIncludeTrailingBackslash(TargetDirectory) + FileMask;
  1270. CheckMultiFilesToOne(FileList, Target, true);
  1271. if (Cp)
  1272. {
  1273. FTerminal->CopyFiles(FileList, TargetDirectory, FileMask);
  1274. }
  1275. else
  1276. {
  1277. FTerminal->MoveFiles(FileList, TargetDirectory, FileMask);
  1278. }
  1279. }
  1280. __finally
  1281. {
  1282. FreeFileList(FileList);
  1283. }
  1284. }
  1285. //---------------------------------------------------------------------------
  1286. void __fastcall TScript::MvProc(TScriptProcParams * Parameters)
  1287. {
  1288. DoMvOrCp(Parameters, fcRemoteMove, false);
  1289. }
  1290. //---------------------------------------------------------------------------
  1291. void __fastcall TScript::CpProc(TScriptProcParams * Parameters)
  1292. {
  1293. DoMvOrCp(Parameters, fcRemoteCopy, true);
  1294. }
  1295. //---------------------------------------------------------------------------
  1296. void __fastcall TScript::ChModProc(TScriptProcParams * Parameters)
  1297. {
  1298. CheckSession();
  1299. if (!FTerminal->IsCapable[fcModeChanging])
  1300. {
  1301. NotSupported();
  1302. }
  1303. TStrings * FileList = CreateFileList(Parameters, 2, Parameters->ParamCount,
  1304. fltMask);
  1305. try
  1306. {
  1307. TRemoteProperties Properties;
  1308. Properties.Valid = TValidProperties() << vpRights;
  1309. Properties.Rights.Octal = Parameters->Param[1];
  1310. FTerminal->ChangeFilesProperties(FileList, &Properties);
  1311. }
  1312. __finally
  1313. {
  1314. FreeFileList(FileList);
  1315. }
  1316. }
  1317. //---------------------------------------------------------------------------
  1318. void __fastcall TScript::LnProc(TScriptProcParams * Parameters)
  1319. {
  1320. CheckSession();
  1321. if (!FTerminal->IsCapable[fcSymbolicLink])
  1322. {
  1323. NotSupported();
  1324. }
  1325. DebugAssert(Parameters->ParamCount == 2);
  1326. FTerminal->CreateLink(Parameters->Param[2], Parameters->Param[1], true);
  1327. }
  1328. //---------------------------------------------------------------------------
  1329. void __fastcall TScript::MkDirProc(TScriptProcParams * Parameters)
  1330. {
  1331. CheckSession();
  1332. TRemoteProperties Properties;
  1333. Properties.Valid = TValidProperties() << vpEncrypt;
  1334. Properties.Encrypt = FCopyParam.EncryptNewFiles;
  1335. FTerminal->CreateDirectory(Parameters->Param[1], &Properties);
  1336. }
  1337. //---------------------------------------------------------------------------
  1338. void __fastcall TScript::GetProc(TScriptProcParams * Parameters)
  1339. {
  1340. CheckSession();
  1341. ResetTransfer();
  1342. bool Latest = Parameters->FindSwitch(L"latest");
  1343. CheckDefaultCopyParam();
  1344. TCopyParamType CopyParam = FCopyParam;
  1345. CopyParamParams(CopyParam, Parameters);
  1346. int Params = 0;
  1347. TransferParamParams(Params, Parameters);
  1348. RequireParams(Parameters, 1);
  1349. int LastFileParam = (Parameters->ParamCount == 1 ? 1 : Parameters->ParamCount - 1);
  1350. TStrings * FileList = CreateFileList(Parameters, 1, LastFileParam,
  1351. (TFileListType)(fltQueryServer | fltMask | FLAGMASK(Latest, fltLatest)));
  1352. try
  1353. {
  1354. // For internal use by .NET Session.GetFileToDirectory
  1355. if (Parameters->FindSwitch(L"onlyfile"))
  1356. {
  1357. for (int Index = 0; Index < FileList->Count; Index++)
  1358. {
  1359. TRemoteFile * File = dynamic_cast<TRemoteFile *>(FileList->Objects[Index]);
  1360. if (File->IsDirectory)
  1361. {
  1362. throw Exception(FMTLOAD(NOT_FILE_ERROR, (File->FileName)));
  1363. }
  1364. }
  1365. }
  1366. UnicodeString TargetDirectory;
  1367. if (Parameters->ParamCount == 1)
  1368. {
  1369. TargetDirectory = GetCurrentDir();
  1370. CopyParam.FileMask = L"";
  1371. }
  1372. else
  1373. {
  1374. UnicodeString Target = Parameters->Param[Parameters->ParamCount];
  1375. TargetDirectory = ExtractFilePath(Target);
  1376. if (TargetDirectory.IsEmpty())
  1377. {
  1378. TargetDirectory = GetCurrentDir();
  1379. }
  1380. CopyParam.FileMask = ExtractFileName(Target);
  1381. Target = IncludeTrailingBackslash(TargetDirectory) + CopyParam.FileMask;
  1382. CheckMultiFilesToOne(FileList, Target, false);
  1383. }
  1384. CheckParams(Parameters);
  1385. FTerminal->CopyToLocal(FileList, TargetDirectory, &CopyParam, Params, NULL);
  1386. }
  1387. __finally
  1388. {
  1389. FreeFileList(FileList);
  1390. }
  1391. }
  1392. //---------------------------------------------------------------------------
  1393. void __fastcall TScript::PutProc(TScriptProcParams * Parameters)
  1394. {
  1395. CheckSession();
  1396. ResetTransfer();
  1397. bool Latest = Parameters->FindSwitch(L"latest");
  1398. CheckDefaultCopyParam();
  1399. TCopyParamType CopyParam = FCopyParam;
  1400. CopyParamParams(CopyParam, Parameters);
  1401. int Params = 0;
  1402. TransferParamParams(Params, Parameters);
  1403. RequireParams(Parameters, 1);
  1404. int LastFileParam = (Parameters->ParamCount == 1 ? 1 : Parameters->ParamCount - 1);
  1405. TStrings * FileList =
  1406. CreateLocalFileList(
  1407. Parameters, 1, LastFileParam, (TFileListType)(fltMask | FLAGMASK(Latest, fltLatest)));
  1408. try
  1409. {
  1410. UnicodeString TargetDirectory;
  1411. if (Parameters->ParamCount == 1)
  1412. {
  1413. TargetDirectory = FTerminal->CurrentDirectory;
  1414. CopyParam.FileMask = L"";
  1415. }
  1416. else
  1417. {
  1418. UnicodeString Target = Parameters->Param[Parameters->ParamCount];
  1419. TargetDirectory = UnixExtractFilePath(Target);
  1420. if (TargetDirectory.IsEmpty())
  1421. {
  1422. TargetDirectory = FTerminal->CurrentDirectory;
  1423. }
  1424. CopyParam.FileMask = UnixExtractFileName(Target);
  1425. Target = UnixIncludeTrailingBackslash(TargetDirectory) + CopyParam.FileMask;
  1426. CheckMultiFilesToOne(FileList, Target, true);
  1427. }
  1428. CheckParams(Parameters);
  1429. FTerminal->CopyToRemote(FileList, TargetDirectory, &CopyParam, Params, NULL);
  1430. }
  1431. __finally
  1432. {
  1433. FreeFileList(FileList);
  1434. }
  1435. }
  1436. //---------------------------------------------------------------------------
  1437. TTransferMode __fastcall TScript::ParseTransferModeName(UnicodeString Name)
  1438. {
  1439. DebugAssert((tmBinary == 0) && (tmAscii == 1) && (tmAutomatic == 2));
  1440. int Value = TScriptCommands::FindCommand(TransferModeNames,
  1441. TransferModeNamesCount, Name);
  1442. if (Value < 0)
  1443. {
  1444. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (L"transfer", Name)));
  1445. }
  1446. return (TTransferMode)Value;
  1447. }
  1448. //---------------------------------------------------------------------------
  1449. void __fastcall TScript::OptionImpl(UnicodeString OptionName, UnicodeString ValueName)
  1450. {
  1451. enum { Echo, Batch, Confirm, Transfer, SynchDelete, Exclude, Include, ReconnectTime, FailOnNoMatch };
  1452. static const wchar_t * Names[] = { L"echo", L"batch", L"confirm", L"transfer",
  1453. L"synchdelete", L"exclude", L"include", L"reconnecttime", L"failonnomatch" };
  1454. DebugAssert((BatchOff == 0) && (BatchOn == 1) && (BatchAbort == 2) && (BatchContinue == 3));
  1455. static const wchar_t * BatchModeNames[] = { L"off", L"on", L"abort", L"continue" };
  1456. int Option = -1;
  1457. if (!OptionName.IsEmpty())
  1458. {
  1459. Option = TScriptCommands::FindCommand(Names, LENOF(Names), OptionName);
  1460. if (Option < 0)
  1461. {
  1462. throw Exception(FMTLOAD(SCRIPT_OPTION_UNKNOWN, (OptionName)));
  1463. }
  1464. else
  1465. {
  1466. OptionName = Names[Option];
  1467. }
  1468. }
  1469. #define OPT(OPT) ((Option < 0) || (Option == OPT))
  1470. const wchar_t * ListFormat = L"%-15s %-10s";
  1471. bool SetValue = !ValueName.IsEmpty();
  1472. bool PrintReconnectTime = false;
  1473. if (OPT(Echo))
  1474. {
  1475. if (SetValue)
  1476. {
  1477. int Value = TScriptCommands::FindCommand(ToggleNames, LENOF(ToggleNames), ValueName);
  1478. if (Value < 0)
  1479. {
  1480. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1481. }
  1482. FEcho = (Value == ToggleOn);
  1483. }
  1484. PrintLine(FORMAT(ListFormat, (Names[Echo], ToggleNames[FEcho ? ToggleOn : ToggleOff])));
  1485. }
  1486. if (OPT(Batch))
  1487. {
  1488. if (SetValue)
  1489. {
  1490. int Value = TScriptCommands::FindCommand(BatchModeNames, LENOF(BatchModeNames), ValueName);
  1491. if (Value < 0)
  1492. {
  1493. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1494. }
  1495. FBatch = (TBatchMode)Value;
  1496. FInteractiveBatch = FBatch;
  1497. if (SetValue && (FBatch != BatchOff) && (FSessionReopenTimeout == 0))
  1498. {
  1499. FSessionReopenTimeout = BatchSessionReopenTimeout;
  1500. FInteractiveSessionReopenTimeout = FSessionReopenTimeout;
  1501. PrintReconnectTime = true;
  1502. }
  1503. }
  1504. PrintLine(FORMAT(ListFormat, (Names[Batch], BatchModeNames[FBatch])));
  1505. }
  1506. if (OPT(Confirm))
  1507. {
  1508. if (SetValue)
  1509. {
  1510. int Value = TScriptCommands::FindCommand(ToggleNames, LENOF(ToggleNames), ValueName);
  1511. if (Value < 0)
  1512. {
  1513. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1514. }
  1515. FConfirm = (Value == ToggleOn);
  1516. FInteractiveConfirm = FConfirm;
  1517. }
  1518. PrintLine(FORMAT(ListFormat, (Names[Confirm], ToggleNames[FConfirm ? ToggleOn : ToggleOff])));
  1519. }
  1520. // omit the option in listing
  1521. if (Option == Transfer)
  1522. {
  1523. if (SetValue)
  1524. {
  1525. FCopyParam.TransferMode = ParseTransferModeName(ValueName);
  1526. }
  1527. DebugAssert(FCopyParam.TransferMode < (TTransferMode)TransferModeNamesCount);
  1528. const wchar_t * Value = TransferModeNames[FCopyParam.TransferMode];
  1529. PrintLine(FORMAT(ListFormat, (Names[Transfer], Value)));
  1530. }
  1531. // omit the option in listing
  1532. if (Option == SynchDelete)
  1533. {
  1534. if (SetValue)
  1535. {
  1536. int Value = TScriptCommands::FindCommand(ToggleNames, LENOF(ToggleNames), ValueName);
  1537. if (Value < 0)
  1538. {
  1539. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1540. }
  1541. FSynchronizeParams =
  1542. (FSynchronizeParams & ~TTerminal::spDelete) |
  1543. FLAGMASK(Value == ToggleOn, TTerminal::spDelete);
  1544. }
  1545. PrintLine(FORMAT(ListFormat, (Names[SynchDelete],
  1546. ToggleNames[FLAGSET(FSynchronizeParams, TTerminal::spDelete) ? ToggleOn : ToggleOff])));
  1547. }
  1548. static const wchar_t * Clear = L"clear";
  1549. // omit the option in listing
  1550. if (Option == Include)
  1551. {
  1552. if (SetValue)
  1553. {
  1554. FCopyParam.IncludeFileMask =
  1555. (ValueName == Clear ? UnicodeString() : ValueName);
  1556. FIncludeFileMaskOptionUsed = (ValueName != Clear);
  1557. }
  1558. PrintLine(FORMAT(ListFormat, (Names[Include], FCopyParam.IncludeFileMask.Masks)));
  1559. }
  1560. // omit the option in listing
  1561. if (Option == Exclude)
  1562. {
  1563. if (SetValue)
  1564. {
  1565. // will throw if ValueName already includes IncludeExcludeFileMasksDelimiter
  1566. FCopyParam.IncludeFileMask =
  1567. (ValueName == Clear ? UnicodeString() : UnicodeString(IncludeExcludeFileMasksDelimiter) + ValueName);
  1568. FIncludeFileMaskOptionUsed = (ValueName != Clear);
  1569. }
  1570. PrintLine(FORMAT(ListFormat, (Names[Include], FCopyParam.IncludeFileMask.Masks)));
  1571. }
  1572. if (OPT(ReconnectTime) || PrintReconnectTime)
  1573. {
  1574. if (SetValue && !PrintReconnectTime)
  1575. {
  1576. int Value;
  1577. if (SameText(ValueName, ToggleNames[ToggleOff]))
  1578. {
  1579. Value = 0;
  1580. }
  1581. else
  1582. {
  1583. if (!TryStrToInt(ValueName, Value))
  1584. {
  1585. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1586. }
  1587. else
  1588. {
  1589. Value *= MSecsPerSec;
  1590. }
  1591. }
  1592. FSessionReopenTimeout = Value;
  1593. FInteractiveSessionReopenTimeout = FSessionReopenTimeout;
  1594. }
  1595. if (FSessionReopenTimeout == 0)
  1596. {
  1597. ValueName = ToggleNames[ToggleOff];
  1598. }
  1599. else
  1600. {
  1601. ValueName = IntToStr(FSessionReopenTimeout / MSecsPerSec);
  1602. }
  1603. PrintLine(FORMAT(ListFormat, (Names[ReconnectTime], ValueName)));
  1604. }
  1605. if (OPT(FailOnNoMatch))
  1606. {
  1607. if (SetValue)
  1608. {
  1609. int Value = TScriptCommands::FindCommand(ToggleNames, LENOF(ToggleNames), ValueName);
  1610. if (Value < 0)
  1611. {
  1612. throw Exception(FMTLOAD(SCRIPT_VALUE_UNKNOWN, (ValueName, OptionName)));
  1613. }
  1614. FFailOnNoMatch = (Value == ToggleOn);
  1615. }
  1616. PrintLine(FORMAT(ListFormat, (Names[FailOnNoMatch], ToggleNames[FFailOnNoMatch ? ToggleOn : ToggleOff])));
  1617. }
  1618. #undef OPT
  1619. }
  1620. //---------------------------------------------------------------------------
  1621. void __fastcall TScript::OptionProc(TScriptProcParams * Parameters)
  1622. {
  1623. UnicodeString OptionName;
  1624. UnicodeString ValueName;
  1625. if (Parameters->ParamCount >= 1)
  1626. {
  1627. OptionName = Parameters->Param[1];
  1628. }
  1629. if (Parameters->ParamCount >= 2)
  1630. {
  1631. ValueName = Parameters->Param[2];
  1632. }
  1633. OptionImpl(OptionName, ValueName);
  1634. }
  1635. //---------------------------------------------------------------------------
  1636. void __fastcall TScript::AsciiProc(TScriptProcParams * /*Parameters*/)
  1637. {
  1638. OptionImpl(L"transfer", L"ascii");
  1639. }
  1640. //---------------------------------------------------------------------------
  1641. void __fastcall TScript::BinaryProc(TScriptProcParams * /*Parameters*/)
  1642. {
  1643. OptionImpl(L"transfer", L"binary");
  1644. }
  1645. //---------------------------------------------------------------------------
  1646. void __fastcall TScript::SynchronizeDirectories(TScriptProcParams * Parameters,
  1647. UnicodeString & LocalDirectory, UnicodeString & RemoteDirectory, int FirstParam)
  1648. {
  1649. if (Parameters->ParamCount >= FirstParam)
  1650. {
  1651. LocalDirectory = Parameters->Param[FirstParam];
  1652. }
  1653. else
  1654. {
  1655. LocalDirectory = GetCurrentDir();
  1656. }
  1657. if (Parameters->ParamCount >= FirstParam + 1)
  1658. {
  1659. RemoteDirectory = Parameters->Param[FirstParam + 1];
  1660. }
  1661. else
  1662. {
  1663. RemoteDirectory = FTerminal->CurrentDirectory;
  1664. }
  1665. }
  1666. //---------------------------------------------------------------------------
  1667. UnicodeString __fastcall TScript::SynchronizeFileRecord(
  1668. const UnicodeString & RootDirectory, const TSynchronizeChecklist::TItem * Item, bool Local)
  1669. {
  1670. const TSynchronizeChecklist::TItem::TFileInfo & FileInfo =
  1671. Local ? Item->Local : Item->Remote;
  1672. UnicodeString Path;
  1673. if (Local)
  1674. {
  1675. Path = IncludeTrailingBackslash(FileInfo.Directory) + FileInfo.FileName;
  1676. }
  1677. else
  1678. {
  1679. Path = UnixIncludeTrailingBackslash(FileInfo.Directory) + FileInfo.FileName;
  1680. }
  1681. if (SameText(RootDirectory, Path.SubString(1, RootDirectory.Length())))
  1682. {
  1683. Path[1] = L'.';
  1684. Path.Delete(2, RootDirectory.Length() - 2);
  1685. }
  1686. UnicodeString Result;
  1687. if (Item->IsDirectory)
  1688. {
  1689. if (Local)
  1690. {
  1691. Result = IncludeTrailingBackslash(Path);
  1692. }
  1693. else
  1694. {
  1695. Result = UnixIncludeTrailingBackslash(Path);
  1696. }
  1697. }
  1698. else
  1699. {
  1700. UnicodeString SizeStr = IntToStr(FileInfo.Size);
  1701. UnicodeString ModificationStr =
  1702. ::ModificationStr(FileInfo.Modification, FileInfo.ModificationFmt);
  1703. Result = FORMAT("%s [%s, %s]", (Path, SizeStr, ModificationStr));
  1704. }
  1705. return Result;
  1706. }
  1707. //---------------------------------------------------------------------------
  1708. void __fastcall TScript::SynchronizePreview(
  1709. UnicodeString LocalDirectory, UnicodeString RemoteDirectory,
  1710. TSynchronizeChecklist * Checklist)
  1711. {
  1712. LocalDirectory = IncludeTrailingBackslash(LocalDirectory);
  1713. RemoteDirectory = UnixIncludeTrailingBackslash(RemoteDirectory);
  1714. for (int Index = 0; (Index < Checklist->Count); Index++)
  1715. {
  1716. const TSynchronizeChecklist::TItem * Item = Checklist->Item[Index];
  1717. if (Item->Checked)
  1718. {
  1719. TDifferenceSessionAction Action(FTerminal->ActionLog, Item);
  1720. UnicodeString Message;
  1721. UnicodeString LocalRecord = SynchronizeFileRecord(LocalDirectory, Item, true);
  1722. UnicodeString RemoteRecord = SynchronizeFileRecord(RemoteDirectory, Item, false);
  1723. switch (Item->Action)
  1724. {
  1725. case TSynchronizeChecklist::saUploadNew:
  1726. Message =
  1727. FMTLOAD(SCRIPT_SYNC_UPLOAD_NEW, (LocalRecord));
  1728. break;
  1729. case TSynchronizeChecklist::saDownloadNew:
  1730. Message =
  1731. FMTLOAD(SCRIPT_SYNC_DOWNLOAD_NEW, (RemoteRecord));
  1732. break;
  1733. case TSynchronizeChecklist::saUploadUpdate:
  1734. Message =
  1735. FMTLOAD(SCRIPT_SYNC_UPLOAD_UPDATE,
  1736. (LocalRecord, RemoteRecord));
  1737. break;
  1738. case TSynchronizeChecklist::saDownloadUpdate:
  1739. Message =
  1740. FMTLOAD(SCRIPT_SYNC_DOWNLOAD_UPDATE,
  1741. (RemoteRecord, LocalRecord));
  1742. break;
  1743. case TSynchronizeChecklist::saDeleteRemote:
  1744. Message =
  1745. FMTLOAD(SCRIPT_SYNC_DELETE_REMOTE, (RemoteRecord));
  1746. break;
  1747. case TSynchronizeChecklist::saDeleteLocal:
  1748. Message =
  1749. FMTLOAD(SCRIPT_SYNC_DELETE_LOCAL, (LocalRecord));
  1750. break;
  1751. default:
  1752. DebugFail();
  1753. }
  1754. PrintLine(Message);
  1755. }
  1756. }
  1757. }
  1758. //---------------------------------------------------------------------------
  1759. void __fastcall TScript::SynchronizeProc(TScriptProcParams * Parameters)
  1760. {
  1761. CheckSession();
  1762. ResetTransfer();
  1763. static const wchar_t * ModeNames[] = { L"remote", L"local", L"both" };
  1764. CheckDefaultCopyParam();
  1765. TCopyParamType CopyParam = FCopyParam;
  1766. CopyParamParams(CopyParam, Parameters);
  1767. RequireParams(Parameters, 1);
  1768. if (Parameters->ParamCount > 3)
  1769. {
  1770. throw Exception(FMTLOAD(SCRIPT_TOO_MANY_PARAMS, (L"synchronize")));
  1771. }
  1772. UnicodeString ModeName = Parameters->Param[1];
  1773. DebugAssert(FSynchronizeMode < 0);
  1774. FSynchronizeMode = TScriptCommands::FindCommand(ModeNames, LENOF(ModeNames), ModeName);
  1775. try
  1776. {
  1777. if (FSynchronizeMode < 0)
  1778. {
  1779. throw Exception(FMTLOAD(SCRIPT_OPTION_UNKNOWN, (ModeName)));
  1780. }
  1781. UnicodeString LocalDirectory;
  1782. UnicodeString RemoteDirectory;
  1783. SynchronizeDirectories(Parameters, LocalDirectory, RemoteDirectory, 2);
  1784. CheckDefaultSynchronizeParams();
  1785. int SynchronizeParams = FSynchronizeParams | TTerminal::spNoConfirmation;
  1786. UnicodeString Value;
  1787. if (Parameters->FindSwitch(L"delete"))
  1788. {
  1789. SynchronizeParams |= TTerminal::spDelete;
  1790. }
  1791. if (Parameters->FindSwitch(L"mirror") &&
  1792. (FSynchronizeMode != TTerminal::smBoth))
  1793. {
  1794. SynchronizeParams |= TTerminal::spMirror;
  1795. }
  1796. if (Parameters->FindSwitch(L"criteria", Value))
  1797. {
  1798. enum { None, Time, Size, Either, EitherBoth };
  1799. static const wchar_t * CriteriaNames[] = { L"none", L"time", L"size", L"either", L"both" };
  1800. int Criteria = TScriptCommands::FindCommand(CriteriaNames, LENOF(CriteriaNames), Value);
  1801. switch (Criteria)
  1802. {
  1803. case None:
  1804. SynchronizeParams |= TTerminal::spNotByTime;
  1805. SynchronizeParams &= ~TTerminal::spBySize;
  1806. break;
  1807. case Time:
  1808. SynchronizeParams &= ~(TTerminal::spNotByTime | TTerminal::spBySize);
  1809. break;
  1810. case Size:
  1811. SynchronizeParams |= TTerminal::spNotByTime | TTerminal::spBySize;
  1812. break;
  1813. case Either:
  1814. case EitherBoth:
  1815. SynchronizeParams &= ~TTerminal::spNotByTime;
  1816. SynchronizeParams |= TTerminal::spBySize;
  1817. break;
  1818. }
  1819. }
  1820. bool Preview = Parameters->FindSwitch(L"preview");
  1821. // enforce rules
  1822. if (FSynchronizeMode == TTerminal::smBoth)
  1823. {
  1824. SynchronizeParams &= ~(TTerminal::spNotByTime | TTerminal::spBySize);
  1825. }
  1826. CheckParams(Parameters);
  1827. PrintLine(LoadStr(SCRIPT_SYNCHRONIZE_COLLECTING));
  1828. TSynchronizeChecklist * Checklist =
  1829. FTerminal->SynchronizeCollect(LocalDirectory, RemoteDirectory,
  1830. static_cast<TTerminal::TSynchronizeMode>(FSynchronizeMode),
  1831. &CopyParam, SynchronizeParams, OnTerminalSynchronizeDirectory, NULL);
  1832. try
  1833. {
  1834. bool AnyChecked = false;
  1835. for (int Index = 0; !AnyChecked && (Index < Checklist->Count); Index++)
  1836. {
  1837. AnyChecked = Checklist->Item[Index]->Checked;
  1838. }
  1839. if (AnyChecked)
  1840. {
  1841. if (Preview)
  1842. {
  1843. PrintLine(LoadStr(SCRIPT_SYNCHRONIZE_CHECKLIST));
  1844. SynchronizePreview(LocalDirectory, RemoteDirectory, Checklist);
  1845. }
  1846. else
  1847. {
  1848. PrintLine(LoadStr(SCRIPT_SYNCHRONIZE_SYNCHRONIZING));
  1849. FTerminal->SynchronizeApply(
  1850. Checklist, &CopyParam, SynchronizeParams, OnTerminalSynchronizeDirectory, NULL, NULL, NULL, NULL);
  1851. }
  1852. }
  1853. else
  1854. {
  1855. NoMatch(LoadStr(SCRIPT_SYNCHRONIZE_NODIFFERENCE));
  1856. }
  1857. }
  1858. __finally
  1859. {
  1860. delete Checklist;
  1861. }
  1862. }
  1863. __finally
  1864. {
  1865. FSynchronizeMode = -1;
  1866. }
  1867. }
  1868. //---------------------------------------------------------------------------
  1869. void __fastcall TScript::Synchronize(const UnicodeString LocalDirectory,
  1870. const UnicodeString RemoteDirectory, const TCopyParamType & CopyParam,
  1871. int SynchronizeParams, TSynchronizeChecklist ** Checklist)
  1872. {
  1873. try
  1874. {
  1875. FKeepingUpToDate = true;
  1876. TSynchronizeChecklist * AChecklist =
  1877. FTerminal->SynchronizeCollect(LocalDirectory, RemoteDirectory, TTerminal::smRemote,
  1878. &CopyParam, SynchronizeParams, NULL, NULL);
  1879. try
  1880. {
  1881. if (AChecklist->Count > 0)
  1882. {
  1883. FTerminal->SynchronizeApply(
  1884. AChecklist, &CopyParam, SynchronizeParams, OnTerminalSynchronizeDirectory, NULL, NULL, NULL, NULL);
  1885. }
  1886. }
  1887. __finally
  1888. {
  1889. if (Checklist == NULL)
  1890. {
  1891. delete AChecklist;
  1892. }
  1893. else
  1894. {
  1895. *Checklist = AChecklist;
  1896. }
  1897. }
  1898. // to break line after the last transfer (if any);
  1899. Print(L"");
  1900. FKeepingUpToDate = false;
  1901. }
  1902. catch(Exception & E)
  1903. {
  1904. FKeepingUpToDate = false;
  1905. HandleExtendedException(&E);
  1906. throw;
  1907. }
  1908. }
  1909. //---------------------------------------------------------------------------
  1910. void __fastcall TScript::KeepUpToDateProc(TScriptProcParams * Parameters)
  1911. {
  1912. if (OnSynchronizeStartStop == NULL)
  1913. {
  1914. Abort();
  1915. }
  1916. CheckSession();
  1917. ResetTransfer();
  1918. CheckDefaultCopyParam();
  1919. TCopyParamType CopyParam = FCopyParam;
  1920. CopyParamParams(CopyParam, Parameters);
  1921. UnicodeString LocalDirectory;
  1922. UnicodeString RemoteDirectory;
  1923. SynchronizeDirectories(Parameters, LocalDirectory, RemoteDirectory, 1);
  1924. CheckDefaultSynchronizeParams();
  1925. int SynchronizeParams = FSynchronizeParams | TTerminal::spNoConfirmation |
  1926. TTerminal::spNoRecurse | TTerminal::spUseCache | TTerminal::spDelayProgress |
  1927. TTerminal::spSubDirs;
  1928. if (Parameters->FindSwitch(L"delete"))
  1929. {
  1930. SynchronizeParams |= TTerminal::spDelete;
  1931. }
  1932. CheckParams(Parameters);
  1933. PrintLine(LoadStr(SCRIPT_KEEPING_UP_TO_DATE));
  1934. OnSynchronizeStartStop(this, LocalDirectory, RemoteDirectory, CopyParam, SynchronizeParams);
  1935. }
  1936. //---------------------------------------------------------------------------
  1937. //---------------------------------------------------------------------------
  1938. __fastcall TManagementScript::TManagementScript(TStoredSessionList * StoredSessions,
  1939. bool LimitedOutput) :
  1940. TScript(LimitedOutput)
  1941. {
  1942. DebugAssert(StoredSessions != NULL);
  1943. FOnInput = NULL;
  1944. FOnTerminalPromptUser = NULL;
  1945. FOnShowExtendedException = NULL;
  1946. FOnTerminalQueryUser = NULL;
  1947. FStoredSessions = StoredSessions;
  1948. FTerminalList = new TTerminalList(Configuration);
  1949. FOnQueryCancel = NULL;
  1950. FContinue = true;
  1951. OnTerminalSynchronizeDirectory = TerminalSynchronizeDirectory;
  1952. FCommands->Register(L"exit", SCRIPT_EXIT_DESC, SCRIPT_EXIT_HELP, &ExitProc, 0, 0, false);
  1953. FCommands->Register(L"bye", 0, SCRIPT_EXIT_HELP, &ExitProc, 0, 0, false);
  1954. FCommands->Register(L"open", SCRIPT_OPEN_DESC, SCRIPT_OPEN_HELP10, &OpenProc, 0, -1, true);
  1955. FCommands->Register(L"close", SCRIPT_CLOSE_DESC, SCRIPT_CLOSE_HELP, &CloseProc, 0, 1, false);
  1956. FCommands->Register(L"session", SCRIPT_SESSION_DESC, SCRIPT_SESSION_HELP, &SessionProc, 0, 1, false);
  1957. FCommands->Register(L"lpwd", SCRIPT_LPWD_DESC, SCRIPT_LPWD_HELP, &LPwdProc, 0, 0, false);
  1958. FCommands->Register(L"lcd", SCRIPT_LCD_DESC, SCRIPT_LCD_HELP, &LCdProc, 1, 1, false);
  1959. FCommands->Register(L"lls", SCRIPT_LLS_DESC, SCRIPT_LLS_HELP2, &LLsProc, 0, 1, false);
  1960. }
  1961. //---------------------------------------------------------------------------
  1962. __fastcall TManagementScript::~TManagementScript()
  1963. {
  1964. while (FTerminalList->Count > 0)
  1965. {
  1966. FreeTerminal(FTerminalList->Terminals[0]);
  1967. }
  1968. delete FTerminalList;
  1969. }
  1970. //---------------------------------------------------------------------------
  1971. void __fastcall TManagementScript::FreeTerminal(TTerminal * ATerminal)
  1972. {
  1973. TSessionData * Data = StoredSessions->FindSame(ATerminal->SessionData);
  1974. if (Data != NULL)
  1975. {
  1976. ATerminal->SessionData->RemoteDirectory = ATerminal->CurrentDirectory;
  1977. bool Changed = false;
  1978. if (ATerminal->SessionData->UpdateDirectories)
  1979. {
  1980. Data->RemoteDirectory = ATerminal->SessionData->RemoteDirectory;
  1981. Changed = true;
  1982. }
  1983. if (Changed)
  1984. {
  1985. // only modified, implicit
  1986. StoredSessions->Save(false, false);
  1987. }
  1988. }
  1989. FTerminalList->FreeTerminal(ATerminal);
  1990. }
  1991. //---------------------------------------------------------------------------
  1992. void __fastcall TManagementScript::Input(const UnicodeString Prompt,
  1993. UnicodeString & Str, bool AllowEmpty)
  1994. {
  1995. do
  1996. {
  1997. Str = L"";
  1998. if (FOnInput != NULL)
  1999. {
  2000. FOnInput(this, Prompt, Str);
  2001. }
  2002. else
  2003. {
  2004. Abort();
  2005. }
  2006. }
  2007. while (Str.Trim().IsEmpty() && !AllowEmpty);
  2008. }
  2009. //---------------------------------------------------------------------------
  2010. void __fastcall TManagementScript::PrintProgress(bool First, const UnicodeString Str)
  2011. {
  2012. if (FOnPrintProgress != NULL)
  2013. {
  2014. FOnPrintProgress(this, First, Str);
  2015. }
  2016. }
  2017. //---------------------------------------------------------------------------
  2018. void __fastcall TManagementScript::ResetTransfer()
  2019. {
  2020. TScript::ResetTransfer();
  2021. FLastProgressFile = L"";
  2022. FLastProgressTime = 0;
  2023. FLastProgressEventTime = 0;
  2024. FLastProgressMessage = L"";
  2025. }
  2026. //---------------------------------------------------------------------------
  2027. bool __fastcall TManagementScript::QueryCancel()
  2028. {
  2029. bool Result = false;
  2030. if (OnQueryCancel != NULL)
  2031. {
  2032. OnQueryCancel(this, Result);
  2033. }
  2034. return Result;
  2035. }
  2036. //---------------------------------------------------------------------------
  2037. void __fastcall TManagementScript::TerminalInformation(TTerminal * ATerminal,
  2038. const UnicodeString & Str, bool /*Status*/, int Phase)
  2039. {
  2040. DebugAssert(ATerminal != NULL);
  2041. if ((Phase < 0) && (ATerminal->Status == ssOpening))
  2042. {
  2043. PrintLine(Str);
  2044. }
  2045. }
  2046. //---------------------------------------------------------------------------
  2047. void __fastcall TManagementScript::TerminalPromptUser(TTerminal * ATerminal,
  2048. TPromptKind Kind, UnicodeString Name, UnicodeString Instructions, TStrings * Prompts,
  2049. TStrings * Results, bool & Result, void * Arg)
  2050. {
  2051. // When authentication using stored password fails,
  2052. // do not ask user for another password.
  2053. if ((!ATerminal->StoredCredentialsTried ||
  2054. !IsAuthenticationPrompt(Kind) ||
  2055. (Prompts->Count == 0)) && // allow instructions-only prompts
  2056. (OnTerminalPromptUser != NULL))
  2057. {
  2058. OnTerminalPromptUser(ATerminal, Kind, Name, Instructions, Prompts, Results, Result, Arg);
  2059. }
  2060. }
  2061. //---------------------------------------------------------------------------
  2062. bool __fastcall TManagementScript::Synchronizing()
  2063. {
  2064. return (FKeepingUpToDate || (FSynchronizeMode >= 0));
  2065. }
  2066. //---------------------------------------------------------------------------
  2067. void __fastcall TManagementScript::ShowPendingProgress()
  2068. {
  2069. if (!FSynchronizeIntro.IsEmpty())
  2070. {
  2071. if (Synchronizing())
  2072. {
  2073. PrintLine(FSynchronizeIntro);
  2074. }
  2075. FSynchronizeIntro = L"";
  2076. }
  2077. }
  2078. //---------------------------------------------------------------------------
  2079. void __fastcall TManagementScript::TerminalOperationProgress(
  2080. TFileOperationProgressType & ProgressData)
  2081. {
  2082. if ((ProgressData.Operation == foCopy) ||
  2083. (ProgressData.Operation == foMove))
  2084. {
  2085. if (ProgressData.InProgress && ProgressData.FileInProgress &&
  2086. !ProgressData.FileName.IsEmpty())
  2087. {
  2088. bool DoPrint = false;
  2089. bool First = false;
  2090. UnicodeString ProgressFileName = ProgressData.FileName;
  2091. if (ProgressData.Side == osLocal)
  2092. {
  2093. ProgressFileName = ExcludeTrailingBackslash(ProgressFileName);
  2094. }
  2095. else
  2096. {
  2097. ProgressFileName = UnixExcludeTrailingBackslash(ProgressFileName);
  2098. }
  2099. if (ProgressFileName != FLastProgressFile)
  2100. {
  2101. First = true;
  2102. DoPrint = true;
  2103. ShowPendingProgress();
  2104. }
  2105. time_t Time = time(NULL);
  2106. if ((OnProgress != NULL) && WantsProgress &&
  2107. (DoPrint || (FLastProgressEventTime != Time) || ProgressData.IsTransferDone()))
  2108. {
  2109. FLastProgressEventTime = Time;
  2110. TScriptProgress Progress;
  2111. Progress.Operation = ProgressData.Operation;
  2112. Progress.Side = ProgressData.Side;
  2113. Progress.FileName = ProgressData.FullFileName;
  2114. Progress.Directory = ProgressData.Directory;
  2115. Progress.OverallProgress = ProgressData.OverallProgress();
  2116. Progress.FileProgress = ProgressData.TransferProgress();
  2117. Progress.CPS = ProgressData.CPS();
  2118. Progress.Cancel = false;
  2119. OnProgress(this, Progress);
  2120. if (Progress.Cancel)
  2121. {
  2122. ProgressData.SetCancel(csCancel);
  2123. }
  2124. }
  2125. if (!DoPrint && ((FLastProgressTime != Time) || ProgressData.IsTransferDone()))
  2126. {
  2127. DoPrint = true;
  2128. }
  2129. if (DoPrint)
  2130. {
  2131. UnicodeString FileName;
  2132. if (FLimitedOutput)
  2133. {
  2134. bool Unix = (ProgressData.Side == osRemote);
  2135. FileName = MinimizeName(ProgressFileName, Configuration->ScriptProgressFileNameLimit, Unix);
  2136. }
  2137. else
  2138. {
  2139. FileName = ProgressFileName;
  2140. }
  2141. UnicodeString TransferredSizeStr;
  2142. if (ProgressData.TransferredSize < 1024)
  2143. {
  2144. TransferredSizeStr = FORMAT("%d B", (static_cast<int>(ProgressData.TransferredSize)));
  2145. }
  2146. else
  2147. {
  2148. TransferredSizeStr = FORMAT("%d KB", (static_cast<int>(ProgressData.TransferredSize / 1024)));
  2149. }
  2150. UnicodeString ProgressMessage = FORMAT(L"%-*s | %14s | %6.1f KB/s | %-6.6s | %3d%%",
  2151. (Configuration->ScriptProgressFileNameLimit, FileName,
  2152. TransferredSizeStr,
  2153. static_cast<float>(ProgressData.CPS()) / 1024,
  2154. ProgressData.AsciiTransfer ? L"ascii" : L"binary",
  2155. ProgressData.TransferProgress()));
  2156. if (FLastProgressMessage != ProgressMessage)
  2157. {
  2158. FLastProgressTime = Time;
  2159. PrintProgress(First, ProgressMessage);
  2160. FLastProgressMessage = ProgressMessage;
  2161. FLastProgressFile = ProgressFileName;
  2162. }
  2163. }
  2164. }
  2165. else
  2166. {
  2167. FLastProgressFile = L"";
  2168. }
  2169. }
  2170. if (QueryCancel())
  2171. {
  2172. ProgressData.SetCancel(csCancel);
  2173. }
  2174. }
  2175. //---------------------------------------------------------------------------
  2176. void __fastcall TManagementScript::TerminalOperationFinished(
  2177. TFileOperation Operation, TOperationSide /*Side*/,
  2178. bool /*Temp*/, const UnicodeString & FileName, Boolean Success,
  2179. TOnceDoneOperation & /*OnceDoneOperation*/)
  2180. {
  2181. if (Success &&
  2182. (Operation != foCalculateSize) && (Operation != foCalculateChecksum) &&
  2183. (Operation != foCopy) && (Operation != foMove))
  2184. {
  2185. ShowPendingProgress();
  2186. // For FKeepingUpToDate we should send events to synchronize controller eventually.
  2187. if (Synchronizing() && (Operation == foDelete))
  2188. {
  2189. // Note that this is duplicated with "keep up to date" log.
  2190. PrintLine(FMTLOAD(SCRIPT_SYNCHRONIZE_DELETED, (FileName)));
  2191. }
  2192. else
  2193. {
  2194. PrintLine(FileName);
  2195. }
  2196. }
  2197. }
  2198. //---------------------------------------------------------------------------
  2199. void __fastcall TManagementScript::TerminalSynchronizeDirectory(
  2200. const UnicodeString & LocalDirectory, const UnicodeString & RemoteDirectory,
  2201. bool & Continue, bool Collect, const TSynchronizeOptions *)
  2202. {
  2203. int SynchronizeMode = FSynchronizeMode;
  2204. if (FKeepingUpToDate)
  2205. {
  2206. SynchronizeMode = TTerminal::smRemote;
  2207. }
  2208. UnicodeString Arrow;
  2209. switch (SynchronizeMode)
  2210. {
  2211. case TTerminal::smRemote:
  2212. Arrow = L"=>";
  2213. break;
  2214. case TTerminal::smLocal:
  2215. Arrow = L"<=";
  2216. break;
  2217. case TTerminal::smBoth:
  2218. Arrow = L"<=>";
  2219. break;
  2220. }
  2221. UnicodeString Progress = FMTLOAD(SCRIPT_SYNCHRONIZE, (ExcludeTrailingBackslash(LocalDirectory),
  2222. Arrow, UnixExcludeTrailingBackslash(RemoteDirectory)));
  2223. if (Collect)
  2224. {
  2225. PrintProgress(false, Progress);
  2226. }
  2227. else
  2228. {
  2229. FSynchronizeIntro = Progress;
  2230. }
  2231. if (QueryCancel())
  2232. {
  2233. Continue = false;
  2234. }
  2235. }
  2236. //---------------------------------------------------------------------------
  2237. void __fastcall TManagementScript::TerminalInitializeLog(TObject * Sender)
  2238. {
  2239. TTerminal * ATerminal = dynamic_cast<TTerminal *>(Sender);
  2240. if (DebugAlwaysTrue(ATerminal != NULL))
  2241. {
  2242. LogPendingLines(ATerminal);
  2243. }
  2244. }
  2245. //---------------------------------------------------------------------------
  2246. TTerminal * __fastcall TManagementScript::FindSession(const UnicodeString Index)
  2247. {
  2248. int i = StrToIntDef(Index, -1);
  2249. if ((i <= 0) || (i > FTerminalList->Count))
  2250. {
  2251. throw Exception(FMTLOAD(SCRIPT_SESSION_INDEX_INVALID, (Index)));
  2252. }
  2253. else
  2254. {
  2255. return FTerminalList->Terminals[i - 1];
  2256. }
  2257. }
  2258. //---------------------------------------------------------------------------
  2259. void __fastcall TManagementScript::PrintActiveSession()
  2260. {
  2261. DebugAssert(FTerminal != NULL);
  2262. PrintLine(FMTLOAD(SCRIPT_ACTIVE_SESSION,
  2263. (FTerminalList->IndexOf(FTerminal) + 1, FTerminal->SessionData->SessionName)));
  2264. }
  2265. //---------------------------------------------------------------------------
  2266. bool __fastcall TManagementScript::HandleExtendedException(Exception * E,
  2267. TTerminal * ATerminal)
  2268. {
  2269. bool Result = TScript::HandleExtendedException(E, ATerminal);
  2270. if (ATerminal == NULL)
  2271. {
  2272. ATerminal = FTerminal;
  2273. }
  2274. if ((ATerminal != NULL) && (ATerminal == FTerminal) && (dynamic_cast<EFatal*>(E) != NULL))
  2275. {
  2276. try
  2277. {
  2278. DoClose(ATerminal);
  2279. }
  2280. catch(...)
  2281. {
  2282. // ignore disconnect errors
  2283. }
  2284. }
  2285. return Result;
  2286. }
  2287. //---------------------------------------------------------------------------
  2288. void __fastcall TManagementScript::MaskPasswordInCommandLine(UnicodeString & Command, bool Recurse)
  2289. {
  2290. UnicodeString Url;
  2291. UnicodeString MaskedParamsPre;
  2292. UnicodeString MaskedParamsPost;
  2293. UnicodeString Param;
  2294. UnicodeString RawParam;
  2295. UnicodeString Separator;
  2296. UnicodeString Separator2;
  2297. UnicodeString OptionWithParameters;
  2298. bool AnyMaskedParam = false;
  2299. TOptions Options;
  2300. UnicodeString ACommand = Command;
  2301. bool SubCommands = false;
  2302. while (CutToken(ACommand, Param, &RawParam, &Separator2))
  2303. {
  2304. Options.Add(Param);
  2305. // "Param 1" is the "winscp.exe" or "open"
  2306. if ((Options.ParamCount == 2) && Url.IsEmpty() && !SubCommands)
  2307. {
  2308. Url = Param;
  2309. }
  2310. else
  2311. {
  2312. UnicodeString & MaskedParams = Url.IsEmpty() ? MaskedParamsPre : MaskedParamsPost;
  2313. UnicodeString Switch;
  2314. wchar_t SwitchMark;
  2315. if (Options.WasSwitchAdded(Switch, SwitchMark))
  2316. {
  2317. OptionWithParameters = L"";
  2318. if (TSessionData::IsSensitiveOption(Switch))
  2319. {
  2320. // We should use something like TProgramParams::FormatSwitch here
  2321. RawParam = FORMAT(L"%s%s=%s", (SwitchMark, Switch, PasswordMask));
  2322. AnyMaskedParam = true;
  2323. }
  2324. else if (TSessionData::IsOptionWithParameters(Switch))
  2325. {
  2326. OptionWithParameters = Switch;
  2327. }
  2328. SubCommands = SameText(Switch, COMMAND_SWITCH);
  2329. }
  2330. else
  2331. {
  2332. if (!OptionWithParameters.IsEmpty())
  2333. {
  2334. if (TSessionData::MaskPasswordInOptionParameter(OptionWithParameters, Param))
  2335. {
  2336. RawParam = Param;
  2337. AnyMaskedParam = true;
  2338. }
  2339. }
  2340. if (Recurse && SubCommands)
  2341. {
  2342. UnicodeString Cmd2 = Param;
  2343. UnicodeString Command2;
  2344. if (CutToken(Cmd2, Command2))
  2345. {
  2346. UnicodeString MaskedParam = MaskPasswordInCommand(Param, Command2);
  2347. if (MaskedParam != Param)
  2348. {
  2349. RawParam = AddQuotes(EscapeParam(MaskedParam));
  2350. AnyMaskedParam = true;
  2351. }
  2352. }
  2353. }
  2354. }
  2355. // Separator is empty on the first loop, but so is the MaskedParams
  2356. AddToList(MaskedParams, RawParam, Separator);
  2357. }
  2358. Separator = Separator2;
  2359. }
  2360. if (!Url.IsEmpty() || AnyMaskedParam)
  2361. {
  2362. UnicodeString MaskedUrl;
  2363. if (!Url.IsEmpty())
  2364. {
  2365. bool DefaultsOnly;
  2366. std::unique_ptr<TSessionData> Data(
  2367. StoredSessions->ParseUrl(Url, &Options, DefaultsOnly, NULL, NULL, &MaskedUrl));
  2368. }
  2369. if ((Url != MaskedUrl) || AnyMaskedParam)
  2370. {
  2371. Command = MaskedParamsPre;
  2372. // AddToList is noop, when respective component is empty
  2373. AddToList(Command, AddQuotes(MaskedUrl), L" ");
  2374. AddToList(Command, MaskedParamsPost, L" ");
  2375. }
  2376. }
  2377. }
  2378. //---------------------------------------------------------------------------
  2379. UnicodeString __fastcall TManagementScript::MaskPasswordInCommand(const UnicodeString & FullCommand,
  2380. const UnicodeString & Command)
  2381. {
  2382. UnicodeString Result = FullCommand;
  2383. if (SameText(FCommands->ResolveCommand(Command), L"open") &&
  2384. !Configuration->LogSensitive)
  2385. {
  2386. MaskPasswordInCommandLine(Result, false);
  2387. }
  2388. return Result;
  2389. }
  2390. //---------------------------------------------------------------------------
  2391. UnicodeString __fastcall TManagementScript::GetLogCmd(const UnicodeString & FullCommand,
  2392. const UnicodeString & Command, const UnicodeString & Params)
  2393. {
  2394. UnicodeString Result = MaskPasswordInCommand(FullCommand, Command);
  2395. return TScript::GetLogCmd(Result, Command, Params);
  2396. }
  2397. //---------------------------------------------------------------------------
  2398. void __fastcall TManagementScript::Connect(const UnicodeString Session,
  2399. TOptions * Options, bool CheckParams)
  2400. {
  2401. try
  2402. {
  2403. bool DefaultsOnly;
  2404. TSessionData * Data;
  2405. if (Options->FindSwitch(L"filezilla"))
  2406. {
  2407. UnicodeString Error;
  2408. std::unique_ptr<TStoredSessionList> FilezillaSessionList(
  2409. Configuration->SelectFilezillaSessionsForImport(StoredSessions, Error));
  2410. if (!Error.IsEmpty())
  2411. {
  2412. throw Exception(Error);
  2413. }
  2414. Data = dynamic_cast<TSessionData *>(FilezillaSessionList->FindByName(Session));
  2415. if (Data == NULL)
  2416. {
  2417. throw Exception(FMTLOAD(FILEZILLA_SITE_NOT_EXIST, (Session)));
  2418. }
  2419. else
  2420. {
  2421. Data = Data->Clone();
  2422. }
  2423. }
  2424. else
  2425. {
  2426. if (FStoredSessions->IsFolder(Session) ||
  2427. FStoredSessions->IsWorkspace(Session))
  2428. {
  2429. throw Exception(LoadStr(CANNOT_OPEN_SESSION_FOLDER));
  2430. }
  2431. Data = FStoredSessions->ParseUrl(Session, Options, DefaultsOnly);
  2432. }
  2433. try
  2434. {
  2435. if (CheckParams)
  2436. {
  2437. if (Options->ParamCount > 1)
  2438. {
  2439. throw Exception(FMTLOAD(SCRIPT_TOO_MANY_PARAMS, (L"open")));
  2440. }
  2441. TScriptCommands::CheckParams(Options, false);
  2442. }
  2443. if (!Session.IsEmpty() && !Data->Name.IsEmpty() && (Batch != TScript::BatchOff) && !Interactive)
  2444. {
  2445. std::unique_ptr<TSessionData> DataWithFingerprint(Data->Clone());
  2446. DataWithFingerprint->LookupLastFingerprint();
  2447. DataWithFingerprint->MaskPasswords();
  2448. PrintLine(LoadStr(SCRIPT_SITE_WARNING));
  2449. PrintLine(L"open " + DataWithFingerprint->GenerateOpenCommandArgs(false));
  2450. }
  2451. DebugAssert(Data != NULL);
  2452. if (!Data->CanLogin || DefaultsOnly)
  2453. {
  2454. if (Data->HostName.IsEmpty())
  2455. {
  2456. UnicodeString Value;
  2457. Input(LoadStr(SCRIPT_HOST_PROMPT), Value, false);
  2458. Data->HostName = Value;
  2459. }
  2460. DebugAssert(Data->CanLogin);
  2461. }
  2462. bool WasLogActions = Configuration->LogActions;
  2463. TTerminal * ATerminal = FTerminalList->NewTerminal(Data);
  2464. try
  2465. {
  2466. ATerminal->AutoReadDirectory = false;
  2467. ATerminal->OnInformation = TerminalInformation;
  2468. ATerminal->OnPromptUser = TerminalPromptUser;
  2469. ATerminal->OnShowExtendedException = OnShowExtendedException;
  2470. ATerminal->OnQueryUser = OnTerminalQueryUser;
  2471. ATerminal->OnProgress = TerminalOperationProgress;
  2472. ATerminal->OnFinished = TerminalOperationFinished;
  2473. ATerminal->OnInitializeLog = TerminalInitializeLog;
  2474. ConnectTerminal(ATerminal);
  2475. }
  2476. catch(Exception & E)
  2477. {
  2478. // fatal error, most probably caused by XML logging failure (as it has been turned off),
  2479. // and XML log is required => abort
  2480. if ((dynamic_cast<EFatal *>(&E) != NULL) &&
  2481. WasLogActions && !Configuration->LogActions &&
  2482. Configuration->LogActionsRequired)
  2483. {
  2484. FContinue = false;
  2485. }
  2486. // make sure errors (mainly fatal ones) are associated
  2487. // with this terminal, not the last active one
  2488. bool Handled = HandleExtendedException(&E, ATerminal);
  2489. FTerminalList->FreeTerminal(ATerminal);
  2490. ATerminal = NULL;
  2491. if (!Handled)
  2492. {
  2493. throw;
  2494. }
  2495. }
  2496. if (ATerminal != NULL)
  2497. {
  2498. FTerminal = ATerminal;
  2499. if (!Data->LocalDirectory.IsEmpty())
  2500. {
  2501. try
  2502. {
  2503. DoChangeLocalDirectory(Data->LocalDirectoryExpanded);
  2504. }
  2505. catch(Exception & E)
  2506. {
  2507. if (!HandleExtendedException(&E))
  2508. {
  2509. throw;
  2510. }
  2511. }
  2512. }
  2513. PrintActiveSession();
  2514. }
  2515. }
  2516. __finally
  2517. {
  2518. delete Data;
  2519. }
  2520. }
  2521. catch(Exception & E)
  2522. {
  2523. if (!HandleExtendedException(&E))
  2524. {
  2525. throw;
  2526. }
  2527. }
  2528. }
  2529. //---------------------------------------------------------------------------
  2530. void __fastcall TManagementScript::DoClose(TTerminal * ATerminal)
  2531. {
  2532. int Index = FTerminalList->IndexOf(ATerminal);
  2533. DebugAssert(Index >= 0);
  2534. bool WasActiveTerminal = (FTerminal == ATerminal);
  2535. try
  2536. {
  2537. if (ATerminal->Active)
  2538. {
  2539. ATerminal->Close();
  2540. }
  2541. UnicodeString SessionName = ATerminal->SessionData->SessionName;
  2542. FreeTerminal(ATerminal);
  2543. if (WasActiveTerminal)
  2544. {
  2545. FTerminal = NULL;
  2546. }
  2547. PrintLine(FMTLOAD(SCRIPT_SESSION_CLOSED, (SessionName)));
  2548. }
  2549. __finally
  2550. {
  2551. if (WasActiveTerminal)
  2552. {
  2553. if (FTerminalList->Count > 0)
  2554. {
  2555. if (Index < FTerminalList->Count)
  2556. {
  2557. FTerminal = FTerminalList->Terminals[Index];
  2558. }
  2559. else
  2560. {
  2561. FTerminal = FTerminalList->Terminals[0];
  2562. }
  2563. PrintActiveSession();
  2564. }
  2565. else
  2566. {
  2567. PrintLine(LoadStr(SCRIPT_NO_SESSION));
  2568. }
  2569. }
  2570. }
  2571. }
  2572. //---------------------------------------------------------------------------
  2573. void __fastcall TManagementScript::DoChangeLocalDirectory(UnicodeString Directory)
  2574. {
  2575. if (!SetCurrentDir(ApiPath(Directory)))
  2576. {
  2577. throw EOSExtException(FMTLOAD(CHANGE_DIR_ERROR, (Directory)));
  2578. }
  2579. }
  2580. //---------------------------------------------------------------------------
  2581. void __fastcall TManagementScript::ExitProc(TScriptProcParams * /*Parameters*/)
  2582. {
  2583. FContinue = false;
  2584. }
  2585. //---------------------------------------------------------------------------
  2586. void __fastcall TManagementScript::OpenProc(TScriptProcParams * Parameters)
  2587. {
  2588. Connect(Parameters->ParamCount > 0 ? Parameters->Param[1] : UnicodeString(),
  2589. Parameters, true);
  2590. }
  2591. //---------------------------------------------------------------------------
  2592. void __fastcall TManagementScript::CloseProc(TScriptProcParams * Parameters)
  2593. {
  2594. CheckSession();
  2595. TTerminal * ATerminal;
  2596. if (Parameters->ParamCount == 0)
  2597. {
  2598. ATerminal = FTerminal;
  2599. }
  2600. else
  2601. {
  2602. ATerminal = FindSession(Parameters->Param[1]);
  2603. }
  2604. DoClose(ATerminal);
  2605. }
  2606. //---------------------------------------------------------------------------
  2607. void __fastcall TManagementScript::SessionProc(TScriptProcParams * Parameters)
  2608. {
  2609. CheckSession();
  2610. if (Parameters->ParamCount == 0)
  2611. {
  2612. for (int i = 0; i < FTerminalList->Count; i++)
  2613. {
  2614. PrintLine(FORMAT(L"%3d %s",
  2615. (i + 1, FTerminalList->Terminals[i]->SessionData->SessionName)));
  2616. }
  2617. PrintActiveSession();
  2618. }
  2619. else
  2620. {
  2621. FTerminal = FindSession(Parameters->Param[1]);
  2622. PrintActiveSession();
  2623. }
  2624. }
  2625. //---------------------------------------------------------------------------
  2626. void __fastcall TManagementScript::LPwdProc(TScriptProcParams * /*Parameters*/)
  2627. {
  2628. PrintLine(GetCurrentDir());
  2629. }
  2630. //---------------------------------------------------------------------------
  2631. void __fastcall TManagementScript::LCdProc(TScriptProcParams * Parameters)
  2632. {
  2633. DebugAssert(Parameters->ParamCount == 1);
  2634. DoChangeLocalDirectory(Parameters->Param[1]);
  2635. PrintLine(GetCurrentDir());
  2636. }
  2637. //---------------------------------------------------------------------------
  2638. void __fastcall TManagementScript::LLsProc(TScriptProcParams * Parameters)
  2639. {
  2640. UnicodeString Directory;
  2641. UnicodeString Mask;
  2642. if (Parameters->ParamCount > 0)
  2643. {
  2644. Directory = Parameters->Param[1];
  2645. Mask = ExtractFileName(Directory);
  2646. if (TFileMasks::IsMask(Mask))
  2647. {
  2648. Directory = ExtractFilePath(Directory);
  2649. }
  2650. else
  2651. {
  2652. Mask = L"";
  2653. }
  2654. }
  2655. if (Directory.IsEmpty())
  2656. {
  2657. Directory = GetCurrentDir();
  2658. }
  2659. if (Mask.IsEmpty())
  2660. {
  2661. Mask = L"*.*";
  2662. }
  2663. TSearchRecOwned SearchRec;
  2664. int FindAttrs = faReadOnly | faHidden | faSysFile | faDirectory | faArchive;
  2665. if (FindFirstUnchecked(IncludeTrailingBackslash(Directory) + Mask, FindAttrs, SearchRec) != 0)
  2666. {
  2667. NoMatch(Mask, ListingSysErrorMessage());
  2668. }
  2669. else
  2670. {
  2671. UnicodeString TimeFormat = FixedLenDateTimeFormat(FormatSettings.ShortTimeFormat);
  2672. UnicodeString DateFormat = FixedLenDateTimeFormat(FormatSettings.ShortDateFormat);
  2673. int DateLen = 0;
  2674. int TimeLen = 0;
  2675. bool First = true;
  2676. do
  2677. {
  2678. if (SearchRec.Name != L".")
  2679. {
  2680. TDateTime DateTime = SearchRec.GetLastWriteTime();
  2681. UnicodeString TimeStr = FormatDateTime(TimeFormat, DateTime);
  2682. UnicodeString DateStr = FormatDateTime(DateFormat, DateTime);
  2683. if (First)
  2684. {
  2685. if (TimeLen < TimeStr.Length())
  2686. {
  2687. TimeLen = TimeStr.Length();
  2688. }
  2689. if (DateLen < DateStr.Length())
  2690. {
  2691. DateLen = DateStr.Length();
  2692. }
  2693. First = false;
  2694. }
  2695. UnicodeString SizeStr;
  2696. if (SearchRec.IsDirectory())
  2697. {
  2698. SizeStr = L"<DIR>";
  2699. }
  2700. else
  2701. {
  2702. SizeStr = FORMAT(L"%14.0n", (double(SearchRec.Size)));
  2703. }
  2704. PrintLine(FORMAT(L"%-*s %-*s %-14s %s", (
  2705. DateLen, DateStr, TimeLen, TimeStr, SizeStr, SearchRec.Name)));
  2706. }
  2707. }
  2708. while (FindNextChecked(SearchRec) == 0);
  2709. }
  2710. }
  2711. //---------------------------------------------------------------------------
  2712. void __fastcall TManagementScript::ReflectSettings()
  2713. {
  2714. for (int i = 0; i < FTerminalList->Count; i++)
  2715. {
  2716. FTerminalList->Terminals[i]->ReflectSettings();
  2717. }
  2718. }
  2719. //---------------------------------------------------------------------------