ExeSessionProcess.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Diagnostics;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Threading;
  7. using Microsoft.Win32;
  8. using Microsoft.Win32.SafeHandles;
  9. using System.Runtime.InteropServices;
  10. using System.Reflection;
  11. using System.Security.Principal;
  12. using System.Security.AccessControl;
  13. namespace WinSCP
  14. {
  15. internal class ExeSessionProcess : IDisposable
  16. {
  17. public event OutputDataReceivedEventHandler OutputDataReceived;
  18. public bool HasExited { get { return _process.HasExited; } }
  19. public int ExitCode { get { return _process.ExitCode; } }
  20. public static ExeSessionProcess CreateForSession(Session session)
  21. {
  22. return new ExeSessionProcess(session, true, null);
  23. }
  24. public static ExeSessionProcess CreateForConsole(Session session, string additionalArguments)
  25. {
  26. return new ExeSessionProcess(session, false, additionalArguments);
  27. }
  28. private ExeSessionProcess(Session session, bool useXmlLog, string additionalArguments)
  29. {
  30. _session = session;
  31. _logger = session.Logger;
  32. _incompleteLine = string.Empty;
  33. using (_logger.CreateCallstack())
  34. {
  35. string executablePath = GetExecutablePath();
  36. _logger.WriteLine("EXE executable path resolved to {0}", executablePath);
  37. string assemblyFilePath = _logger.GetAssemblyFilePath();
  38. FileVersionInfo assemblyVersion = null;
  39. if (assemblyFilePath != null)
  40. {
  41. assemblyVersion = FileVersionInfo.GetVersionInfo(assemblyFilePath);
  42. }
  43. CheckVersion(executablePath, assemblyVersion);
  44. string configSwitch;
  45. if (_session.DefaultConfigurationInternal)
  46. {
  47. configSwitch = "/ini=nul ";
  48. }
  49. else
  50. {
  51. if (!string.IsNullOrEmpty(_session.IniFilePathInternal))
  52. {
  53. configSwitch = string.Format(CultureInfo.InvariantCulture, "/ini=\"{0}\" ", _session.IniFilePathInternal);
  54. }
  55. else
  56. {
  57. configSwitch = "";
  58. }
  59. }
  60. string logSwitch = null;
  61. if (!string.IsNullOrEmpty(_session.SessionLogPath))
  62. {
  63. logSwitch = string.Format(CultureInfo.InvariantCulture, "/log=\"{0}\" ", LogPathEscape(_session.SessionLogPath));
  64. }
  65. string xmlLogSwitch;
  66. if (useXmlLog)
  67. {
  68. xmlLogSwitch = string.Format(CultureInfo.InvariantCulture, "/xmllog=\"{0}\" /xmlgroups /xmllogrequired ", LogPathEscape(_session.XmlLogPath));
  69. }
  70. else
  71. {
  72. xmlLogSwitch = "";
  73. }
  74. string logLevelSwitch = null;
  75. if (_session.DebugLogLevel > 0)
  76. {
  77. logLevelSwitch = string.Format(CultureInfo.InvariantCulture, "/loglevel={0} ", _session.DebugLogLevel);
  78. }
  79. string assemblyVersionStr =
  80. (assemblyVersion == null) ? "unk" :
  81. string.Format(CultureInfo.InvariantCulture, "{0}{1}{2} ", assemblyVersion.ProductMajorPart, assemblyVersion.ProductMinorPart, assemblyVersion.ProductBuildPart);
  82. string assemblyVersionSwitch =
  83. string.Format(CultureInfo.InvariantCulture, "/dotnet={0} ", assemblyVersionStr);
  84. string arguments =
  85. xmlLogSwitch + "/nointeractiveinput " + assemblyVersionSwitch +
  86. configSwitch + logSwitch + logLevelSwitch + _session.AdditionalExecutableArguments;
  87. Tools.AddRawParameters(ref arguments, _session.RawConfiguration, "/rawconfig");
  88. if (!string.IsNullOrEmpty(additionalArguments))
  89. {
  90. arguments += " " + additionalArguments;
  91. }
  92. _process = new Process();
  93. _process.StartInfo.FileName = executablePath;
  94. _process.StartInfo.WorkingDirectory = Path.GetDirectoryName(executablePath);
  95. _process.StartInfo.Arguments = arguments;
  96. _process.StartInfo.UseShellExecute = false;
  97. _process.Exited += ProcessExited;
  98. }
  99. }
  100. private static string LogPathEscape(string path)
  101. {
  102. return Tools.ArgumentEscape(path).Replace("!", "!!");
  103. }
  104. public void Abort()
  105. {
  106. using (_logger.CreateCallstack())
  107. {
  108. lock (_lock)
  109. {
  110. if ((_process != null) && !_process.HasExited)
  111. {
  112. _process.Kill();
  113. }
  114. }
  115. }
  116. }
  117. public void Start()
  118. {
  119. using (_logger.CreateCallstack())
  120. {
  121. InitializeConsole();
  122. InitializeChild();
  123. }
  124. }
  125. private void InitializeChild()
  126. {
  127. using (_logger.CreateCallstack())
  128. {
  129. // The /console is redundant for CreateForConsole
  130. _process.StartInfo.Arguments += string.Format(CultureInfo.InvariantCulture, " /console /consoleinstance={0}", _instanceName);
  131. // When running under IIS in "impersonated" mode, the process starts, but does not do anything.
  132. // Supposedly it "displayes" some invisible error message when starting and hangs.
  133. // Running it "as the user" helps, eventhough it already runs as the user.
  134. // These's probably some difference between "run as" and impersonations
  135. if (!string.IsNullOrEmpty(_session.ExecutableProcessUserName))
  136. {
  137. _logger.WriteLine("Will run process as {0}", _session.ExecutableProcessUserName);
  138. _process.StartInfo.UserName = _session.ExecutableProcessUserName;
  139. _process.StartInfo.Password = _session.ExecutableProcessPassword;
  140. // One of the hints for resolving C0000142 error (see below)
  141. // was setting this property, so that an environment is correctly loaded,
  142. // so DLLs can be found and loaded.
  143. _process.StartInfo.LoadUserProfile = true;
  144. // Without granting both window station and desktop access permissions,
  145. // WinSCP process aborts with C0000142 (DLL Initialization Failed) error,
  146. // when "running as user"
  147. _logger.WriteLine("Granting access to window station");
  148. try
  149. {
  150. IntPtr windowStation = UnsafeNativeMethods.GetProcessWindowStation();
  151. GrantAccess(windowStation, (int)WindowStationRights.AllAccess);
  152. }
  153. catch (Exception e)
  154. {
  155. throw new SessionLocalException(_session, "Error granting access to window station", e);
  156. }
  157. _logger.WriteLine("Granting access to desktop");
  158. try
  159. {
  160. IntPtr desktop = UnsafeNativeMethods.GetThreadDesktop(UnsafeNativeMethods.GetCurrentThreadId());
  161. GrantAccess(desktop, (int)DesktopRights.AllAccess);
  162. }
  163. catch (Exception e)
  164. {
  165. throw new SessionLocalException(_session, "Error granting access to desktop", e);
  166. }
  167. }
  168. _logger.WriteLine("Starting \"{0}\" {1}", _process.StartInfo.FileName, _process.StartInfo.Arguments);
  169. _process.Start();
  170. _logger.WriteLine("Started process {0}", _process.Id);
  171. _thread = new Thread(ProcessEvents);
  172. _thread.IsBackground = true;
  173. _thread.Start();
  174. }
  175. }
  176. // Handles returned by GetProcessWindowStation and GetThreadDesktop should not be closed
  177. internal class NoopSafeHandle : SafeHandle
  178. {
  179. public NoopSafeHandle(IntPtr handle) :
  180. base(handle, false)
  181. {
  182. }
  183. public override bool IsInvalid
  184. {
  185. get { return false; }
  186. }
  187. protected override bool ReleaseHandle()
  188. {
  189. return true;
  190. }
  191. }
  192. private void GrantAccess(IntPtr handle, int accessMask)
  193. {
  194. using (SafeHandle safeHandle = new NoopSafeHandle(handle))
  195. {
  196. GenericSecurity security =
  197. new GenericSecurity(false, ResourceType.WindowObject, safeHandle, AccessControlSections.Access);
  198. security.AddAccessRule(
  199. new GenericAccessRule(new NTAccount(_session.ExecutableProcessUserName), accessMask, AccessControlType.Allow));
  200. security.Persist(safeHandle, AccessControlSections.Access);
  201. }
  202. }
  203. private void ProcessExited(object sender, EventArgs e)
  204. {
  205. _logger.WriteLine("Process {0} exited with exit code {1}", _process.Id, _process.ExitCode);
  206. }
  207. private bool AbortedOrExited()
  208. {
  209. if (_abort)
  210. {
  211. _logger.WriteLine("Aborted");
  212. return true;
  213. }
  214. else if (_process.HasExited)
  215. {
  216. _logger.WriteLine("Exited");
  217. return true;
  218. }
  219. else
  220. {
  221. return false;
  222. }
  223. }
  224. private void ProcessEvents()
  225. {
  226. using (_logger.CreateCallstack())
  227. {
  228. while (!AbortedOrExited())
  229. {
  230. _logger.WriteLineLevel(1, "Waiting for request event");
  231. // Keep in sync with a delay in SessionLogReader.DoRead
  232. if (_requestEvent.WaitOne(100, false))
  233. {
  234. _logger.WriteLineLevel(1, "Got request event");
  235. ProcessEvent();
  236. }
  237. if (_logger.LogLevel >= 1)
  238. {
  239. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "2nd generation collection count: {0}", GC.CollectionCount(2)));
  240. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "Total memory allocated: {0}", GC.GetTotalMemory(false)));
  241. }
  242. }
  243. }
  244. }
  245. private void ProcessEvent()
  246. {
  247. using (_logger.CreateCallstack())
  248. {
  249. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  250. {
  251. switch (commStruct.Event)
  252. {
  253. case ConsoleEvent.Print:
  254. ProcessPrintEvent(commStruct.PrintEvent);
  255. break;
  256. case ConsoleEvent.Input:
  257. ProcessInputEvent(commStruct.InputEvent);
  258. break;
  259. case ConsoleEvent.Choice:
  260. ProcessChoiceEvent(commStruct.ChoiceEvent);
  261. break;
  262. case ConsoleEvent.Title:
  263. ProcessTitleEvent(commStruct.TitleEvent);
  264. break;
  265. case ConsoleEvent.Init:
  266. ProcessInitEvent(commStruct.InitEvent);
  267. break;
  268. case ConsoleEvent.Progress:
  269. ProcessProgressEvent(commStruct.ProgressEvent);
  270. break;
  271. default:
  272. throw new NotImplementedException();
  273. }
  274. }
  275. _responseEvent.Set();
  276. }
  277. }
  278. private void ProcessChoiceEvent(ConsoleChoiceEventStruct e)
  279. {
  280. using (_logger.CreateCallstack())
  281. {
  282. if (e.Timeouting)
  283. {
  284. Thread.Sleep((int)e.Timer);
  285. e.Result = e.Timeouted;
  286. }
  287. else
  288. {
  289. e.Result = e.Break;
  290. }
  291. _logger.WriteLine(
  292. "Options: [{0}], Timer: [{1}], Timeouting: [{2}], Timeouted: [{3}], Break: [{4}], Result: [{5}]",
  293. e.Options, e.Timer, e.Timeouting, e.Timeouted, e.Break, e.Result);
  294. }
  295. }
  296. private void ProcessTitleEvent(ConsoleTitleEventStruct e)
  297. {
  298. using (_logger.CreateCallstack())
  299. {
  300. _logger.WriteLine("Not-supported title event [{0}]", e.Title);
  301. }
  302. }
  303. private void ProcessInputEvent(ConsoleInputEventStruct e)
  304. {
  305. using (_logger.CreateCallstack())
  306. {
  307. while (!AbortedOrExited())
  308. {
  309. lock (_input)
  310. {
  311. if (_input.Count > 0)
  312. {
  313. e.Str = _input[0];
  314. e.Result = true;
  315. _input.RemoveAt(0);
  316. Print(false, false, e.Str + "\n");
  317. return;
  318. }
  319. }
  320. _inputEvent.WaitOne(100, false);
  321. }
  322. }
  323. }
  324. private void Print(bool fromBeginning, bool error, string message)
  325. {
  326. if (fromBeginning && ((message.Length == 0) || (message[0] != '\n')))
  327. {
  328. _lastFromBeginning = message;
  329. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  330. if (OutputDataReceived != null)
  331. {
  332. OutputDataReceived(this, null);
  333. }
  334. }
  335. else
  336. {
  337. if (!string.IsNullOrEmpty(_lastFromBeginning))
  338. {
  339. AddToOutput(_lastFromBeginning, false);
  340. _lastFromBeginning = null;
  341. }
  342. if (fromBeginning && (message.Length > 0) && (message[0] == '\n'))
  343. {
  344. AddToOutput("\n", false);
  345. _lastFromBeginning = message.Substring(1);
  346. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  347. }
  348. else
  349. {
  350. AddToOutput(message, error);
  351. }
  352. }
  353. }
  354. private void AddToOutput(string message, bool error)
  355. {
  356. string[] lines = (_incompleteLine + message).Split(new[] { '\n' });
  357. _incompleteLine = lines[lines.Length - 1];
  358. for (int i = 0; i < lines.Length - 1; ++i)
  359. {
  360. if (OutputDataReceived != null)
  361. {
  362. OutputDataReceived(this, new OutputDataReceivedEventArgs(lines[i], error));
  363. }
  364. }
  365. }
  366. private void ProcessPrintEvent(ConsolePrintEventStruct e)
  367. {
  368. _logger.WriteLineLevel(1, string.Format(CultureInfo.CurrentCulture, "Print: {0}", e.Message));
  369. Print(e.FromBeginning, e.Error, e.Message);
  370. }
  371. private void ProcessInitEvent(ConsoleInitEventStruct e)
  372. {
  373. using (_logger.CreateCallstack())
  374. {
  375. e.InputType = 3; // pipe
  376. e.OutputType = 3; // pipe
  377. e.WantsProgress = _session.WantsProgress;
  378. }
  379. }
  380. private void ProcessProgressEvent(ConsoleProgressEventStruct e)
  381. {
  382. using (_logger.CreateCallstack())
  383. {
  384. _logger.WriteLine(
  385. "File Name [{0}] - Directory [{1}] - Overall Progress [{2}] - File Progress [{3}] - CPS [{4}]",
  386. e.FileName, e.Directory, e.OverallProgress, e.FileProgress, e.CPS);
  387. FileTransferProgressEventArgs args = new FileTransferProgressEventArgs();
  388. switch (e.Operation)
  389. {
  390. case ConsoleProgressEventStruct.ProgressOperation.Copy:
  391. args.Operation = ProgressOperation.Transfer;
  392. break;
  393. default:
  394. throw new ArgumentOutOfRangeException("Unknown progress operation", (Exception)null);
  395. }
  396. switch (e.Side)
  397. {
  398. case ConsoleProgressEventStruct.ProgressSide.Local:
  399. args.Side = ProgressSide.Local;
  400. break;
  401. case ConsoleProgressEventStruct.ProgressSide.Remote:
  402. args.Side = ProgressSide.Remote;
  403. break;
  404. default:
  405. throw new ArgumentOutOfRangeException("Unknown progress side", (Exception)null);
  406. }
  407. args.FileName = e.FileName;
  408. args.Directory = e.Directory;
  409. args.OverallProgress = ((double)e.OverallProgress) / 100;
  410. args.FileProgress = ((double)e.FileProgress) / 100;
  411. args.CPS = (int) e.CPS;
  412. _session.ProcessProgress(args);
  413. }
  414. }
  415. private void InitializeConsole()
  416. {
  417. using (_logger.CreateCallstack())
  418. {
  419. int attempts = 0;
  420. Random random = new Random();
  421. int process = Process.GetCurrentProcess().Id;
  422. do
  423. {
  424. if (attempts > MaxAttempts)
  425. {
  426. throw new SessionLocalException(_session, "Cannot find unique name for event object.");
  427. }
  428. int instanceNumber = random.Next(1000);
  429. _instanceName = string.Format(CultureInfo.InvariantCulture, "_{0}_{1}_{2}", process, GetHashCode(), instanceNumber);
  430. _logger.WriteLine("Trying event {0}", _instanceName);
  431. if (!TryCreateEvent(ConsoleEventRequest + _instanceName, out _requestEvent))
  432. {
  433. _logger.WriteLine("Event {0} is not unique", _instanceName);
  434. _requestEvent.Close();
  435. _requestEvent = null;
  436. }
  437. else
  438. {
  439. _logger.WriteLine("Event {0} is unique", _instanceName);
  440. _responseEvent = CreateEvent(ConsoleEventResponse + _instanceName);
  441. _cancelEvent = CreateEvent(ConsoleEventCancel + _instanceName);
  442. string fileMappingName = ConsoleMapping + _instanceName;
  443. _fileMapping = CreateFileMapping(fileMappingName);
  444. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  445. {
  446. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "File mapping {0} already exists", fileMappingName));
  447. }
  448. if (_fileMapping.IsInvalid)
  449. {
  450. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Cannot create file mapping {0}", fileMappingName));
  451. }
  452. }
  453. ++attempts;
  454. }
  455. while (_requestEvent == null);
  456. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  457. {
  458. commStruct.InitHeader();
  459. }
  460. if (_session.GuardProcessWithJobInternal)
  461. {
  462. string jobName = ConsoleJob + _instanceName;
  463. _job = new Job(_logger, jobName);
  464. }
  465. }
  466. }
  467. private SafeFileHandle CreateFileMapping(string fileMappingName)
  468. {
  469. unsafe
  470. {
  471. IntPtr securityAttributesPtr = IntPtr.Zero;
  472. // We use the EventWaitHandleSecurity only to generate the descriptor binary form
  473. // that does not differ for object types, so we abuse the existing "event handle" implementation,
  474. // not to have to create the file mapping SecurityAttributes via P/Invoke.
  475. // .NET 4 supports MemoryMappedFile and MemoryMappedFileSecurity natively already
  476. EventWaitHandleSecurity security = CreateSecurity((EventWaitHandleRights)FileMappingRights.AllAccess);
  477. if (security != null)
  478. {
  479. SecurityAttributes securityAttributes = new SecurityAttributes();
  480. securityAttributes.nLength = (uint)Marshal.SizeOf(securityAttributes);
  481. byte[] descriptorBinaryForm = security.GetSecurityDescriptorBinaryForm();
  482. byte * buffer = stackalloc byte[descriptorBinaryForm.Length];
  483. for (int i = 0; i < descriptorBinaryForm.Length; i++)
  484. {
  485. buffer[i] = descriptorBinaryForm[i];
  486. }
  487. securityAttributes.lpSecurityDescriptor = (IntPtr)buffer;
  488. int length = Marshal.SizeOf(typeof(SecurityAttributes));
  489. securityAttributesPtr = Marshal.AllocHGlobal(length);
  490. Marshal.StructureToPtr(securityAttributes, securityAttributesPtr, false);
  491. }
  492. return
  493. UnsafeNativeMethods.CreateFileMapping(
  494. new SafeFileHandle(new IntPtr(-1), true), securityAttributesPtr, FileMapProtection.PageReadWrite, 0,
  495. ConsoleCommStruct.Size, fileMappingName);
  496. }
  497. }
  498. private ConsoleCommStruct AcquireCommStruct()
  499. {
  500. return new ConsoleCommStruct(_session, _fileMapping);
  501. }
  502. private bool TryCreateEvent(string name, out EventWaitHandle ev)
  503. {
  504. bool createdNew;
  505. _logger.WriteLine("Creating event {0}", name);
  506. EventWaitHandleSecurity security = CreateSecurity(EventWaitHandleRights.FullControl);
  507. ev = new EventWaitHandle(false, EventResetMode.AutoReset, name, out createdNew, security);
  508. _logger.WriteLine(
  509. "Created event {0} with handle {1} with security {2}, new {3}",
  510. name, ev.SafeWaitHandle.DangerousGetHandle(),
  511. (security != null ? security.GetSecurityDescriptorSddlForm(AccessControlSections.All) : "none"), createdNew);
  512. return createdNew;
  513. }
  514. private EventWaitHandleSecurity CreateSecurity(EventWaitHandleRights eventRights)
  515. {
  516. EventWaitHandleSecurity security = null;
  517. // When "running as user", we have to grant the target user permissions to the objects (events and file mapping) explicitly
  518. if (!string.IsNullOrEmpty(_session.ExecutableProcessUserName))
  519. {
  520. security = new EventWaitHandleSecurity();
  521. IdentityReference si;
  522. try
  523. {
  524. si = new NTAccount(_session.ExecutableProcessUserName);
  525. }
  526. catch (Exception e)
  527. {
  528. throw new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "Error resolving account {0}", _session.ExecutableProcessUserName), e);
  529. }
  530. EventWaitHandleAccessRule rule =
  531. new EventWaitHandleAccessRule(
  532. si, eventRights, AccessControlType.Allow);
  533. security.AddAccessRule(rule);
  534. }
  535. return security;
  536. }
  537. private EventWaitHandle CreateEvent(string name)
  538. {
  539. EventWaitHandle ev;
  540. if (!TryCreateEvent(name, out ev))
  541. {
  542. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Event {0} already exists", name));
  543. }
  544. return ev;
  545. }
  546. private void TestEventClosed(string name)
  547. {
  548. if (_session.TestHandlesClosedInternal)
  549. {
  550. _logger.WriteLine("Testing that event {0} is closed", name);
  551. EventWaitHandle ev;
  552. if (TryCreateEvent(name, out ev))
  553. {
  554. ev.Close();
  555. }
  556. else
  557. {
  558. _logger.WriteLine("Exception: Event {0} was not closed yet", name);
  559. }
  560. }
  561. }
  562. private void AddInput(string str)
  563. {
  564. Type structType = typeof(ConsoleInputEventStruct);
  565. FieldInfo strField = structType.GetField("Str");
  566. object[] attributes = strField.GetCustomAttributes(typeof(MarshalAsAttribute), false);
  567. if (attributes.Length != 1)
  568. {
  569. throw new InvalidOperationException("MarshalAs attribute not found for ConsoleInputEventStruct.Str");
  570. }
  571. MarshalAsAttribute marshalAsAttribute = (MarshalAsAttribute)attributes[0];
  572. if (marshalAsAttribute.SizeConst <= str.Length)
  573. {
  574. throw new SessionLocalException(
  575. _session,
  576. string.Format(CultureInfo.CurrentCulture, "Input [{0}] is too long ({1} limit)", str, marshalAsAttribute.SizeConst));
  577. }
  578. lock (_input)
  579. {
  580. _input.Add(str);
  581. _inputEvent.Set();
  582. }
  583. }
  584. public void ExecuteCommand(string command)
  585. {
  586. using (_logger.CreateCallstack())
  587. {
  588. AddInput(command);
  589. }
  590. }
  591. public void Close()
  592. {
  593. using (_logger.CreateCallstack())
  594. {
  595. int timeout;
  596. #if DEBUG
  597. // in debug build, we expect the winscp.exe to run in tracing mode, being very slow
  598. timeout = 10000;
  599. #else
  600. timeout = 2000;
  601. #endif
  602. _logger.WriteLine("Waiting for process to exit ({0} ms)", timeout);
  603. if (!_process.WaitForExit(timeout))
  604. {
  605. _logger.WriteLine("Killing process");
  606. _process.Kill();
  607. }
  608. }
  609. }
  610. public void Dispose()
  611. {
  612. using (_logger.CreateCallstack())
  613. {
  614. lock (_lock)
  615. {
  616. if (_session.TestHandlesClosedInternal)
  617. {
  618. _logger.WriteLine("Will test that handles are closed");
  619. }
  620. _abort = true;
  621. if (_thread != null)
  622. {
  623. _thread.Join();
  624. _thread = null;
  625. }
  626. if (_process != null)
  627. {
  628. _process.Dispose();
  629. _process = null;
  630. }
  631. if (_requestEvent != null)
  632. {
  633. _requestEvent.Close();
  634. TestEventClosed(ConsoleEventRequest + _instanceName);
  635. }
  636. if (_responseEvent != null)
  637. {
  638. _responseEvent.Close();
  639. TestEventClosed(ConsoleEventResponse + _instanceName);
  640. }
  641. if (_cancelEvent != null)
  642. {
  643. _cancelEvent.Close();
  644. TestEventClosed(ConsoleEventCancel + _instanceName);
  645. }
  646. if (_fileMapping != null)
  647. {
  648. _fileMapping.Dispose();
  649. _fileMapping = null;
  650. if (_session.TestHandlesClosedInternal)
  651. {
  652. _logger.WriteLine("Testing that file mapping is closed");
  653. string fileMappingName = ConsoleMapping + _instanceName;
  654. SafeFileHandle fileMapping = CreateFileMapping(fileMappingName);
  655. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  656. {
  657. _logger.WriteLine("Exception: File mapping {0} was not closed yet", fileMappingName);
  658. }
  659. if (!fileMapping.IsInvalid)
  660. {
  661. fileMapping.Dispose();
  662. }
  663. }
  664. }
  665. if (_inputEvent != null)
  666. {
  667. _inputEvent.Close();
  668. _inputEvent = null;
  669. }
  670. if (_job != null)
  671. {
  672. _job.Dispose();
  673. _job = null;
  674. }
  675. }
  676. }
  677. }
  678. private string GetExecutablePath()
  679. {
  680. using (_logger.CreateCallstack())
  681. {
  682. string executablePath;
  683. if (!string.IsNullOrEmpty(_session.ExecutablePath))
  684. {
  685. executablePath = _session.ExecutablePath;
  686. if (!File.Exists(executablePath))
  687. {
  688. throw new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "{0} does not exists.", executablePath));
  689. }
  690. }
  691. else
  692. {
  693. if (!TryFindExecutableInPath(GetAssemblyPath(), out executablePath) &&
  694. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.CurrentUser), out executablePath) &&
  695. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.LocalMachine), out executablePath) &&
  696. !TryFindExecutableInPath(GetDefaultInstallationPath(), out executablePath))
  697. {
  698. throw new SessionLocalException(_session,
  699. string.Format(CultureInfo.CurrentCulture,
  700. "The {0} executable was not found at location of the assembly ({1}), nor in an installation path. You may use Session.ExecutablePath property to explicitly set path to {0}.",
  701. ExeExecutableFileName, GetAssemblyPath()));
  702. }
  703. }
  704. return executablePath;
  705. }
  706. }
  707. private static string GetDefaultInstallationPath()
  708. {
  709. string programFiles;
  710. if (IntPtr.Size == 8)
  711. {
  712. // In .NET 4 we can use Environment.SpecialFolder.ProgramFilesX86
  713. programFiles = Environment.GetEnvironmentVariable("ProgramFiles(x86)");
  714. }
  715. else
  716. {
  717. programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
  718. }
  719. return Path.Combine(programFiles, "WinSCP");
  720. }
  721. private static string GetInstallationPath(RegistryHive hive)
  722. {
  723. // In .NET 4 we can use RegistryKey.OpenBaseKey(hive, RegistryView.Registry32);
  724. const string uninstallKey = @"Software\Microsoft\Windows\CurrentVersion\Uninstall\winscp3_is1";
  725. const string appPathValue = @"Inno Setup: App Path";
  726. string result = null;
  727. IntPtr data = IntPtr.Zero;
  728. RegistryType type;
  729. uint len = 0;
  730. RegistryFlags flags = RegistryFlags.RegSz | RegistryFlags.SubKeyWow6432Key;
  731. UIntPtr key = (UIntPtr)((uint)hive);
  732. if (UnsafeNativeMethods.RegGetValue(key, uninstallKey, appPathValue, flags, out type, data, ref len) == 0)
  733. {
  734. data = Marshal.AllocHGlobal((int)len);
  735. if (UnsafeNativeMethods.RegGetValue(key, uninstallKey, appPathValue, flags, out type, data, ref len) == 0)
  736. {
  737. result = Marshal.PtrToStringUni(data);
  738. }
  739. }
  740. return result;
  741. }
  742. private bool TryFindExecutableInPath(string path, out string result)
  743. {
  744. if (string.IsNullOrEmpty(path))
  745. {
  746. result = null;
  747. }
  748. else
  749. {
  750. string executablePath = Path.Combine(path, ExeExecutableFileName);
  751. if (File.Exists(executablePath))
  752. {
  753. result = executablePath;
  754. _logger.WriteLine("Executable found in {0}", executablePath);
  755. }
  756. else
  757. {
  758. result = null;
  759. _logger.WriteLine("Executable not found in {0}", executablePath);
  760. }
  761. }
  762. return (result != null);
  763. }
  764. private string GetAssemblyPath()
  765. {
  766. string codeBasePath = _logger.GetAssemblyFilePath();
  767. string path = null;
  768. if (!string.IsNullOrEmpty(codeBasePath))
  769. {
  770. path = Path.GetDirectoryName(codeBasePath);
  771. Debug.Assert(path != null);
  772. }
  773. return path;
  774. }
  775. private void CheckVersion(string exePath, FileVersionInfo assemblyVersion)
  776. {
  777. using (_logger.CreateCallstack())
  778. {
  779. FileVersionInfo version = FileVersionInfo.GetVersionInfo(exePath);
  780. _logger.WriteLine("Version of {0} is {1}, product {2} version is {3}", exePath, version.FileVersion, version.ProductName, version.ProductVersion);
  781. if (_session.DisableVersionCheck)
  782. {
  783. _logger.WriteLine("Version check disabled (not recommended)");
  784. }
  785. else if (assemblyVersion == null)
  786. {
  787. _logger.WriteLine("Assembly version not known, cannot check version");
  788. }
  789. else if (assemblyVersion.ProductVersion != version.ProductVersion)
  790. {
  791. throw new SessionLocalException(
  792. _session, string.Format(CultureInfo.CurrentCulture,
  793. "The version of {0} ({1}) does not match version of this assembly {2} ({3}).",
  794. exePath, version.ProductVersion, _logger.GetAssemblyFilePath(), assemblyVersion.ProductVersion));
  795. }
  796. }
  797. }
  798. public void WriteStatus()
  799. {
  800. string executablePath = GetExecutablePath();
  801. _logger.WriteLine("{0} - exists [{1}]", executablePath, File.Exists(executablePath));
  802. }
  803. private const int MaxAttempts = 10;
  804. private const string ConsoleMapping = "WinSCPConsoleMapping";
  805. private const string ConsoleEventRequest = "WinSCPConsoleEventRequest";
  806. private const string ConsoleEventResponse = "WinSCPConsoleEventResponse";
  807. private const string ConsoleEventCancel = "WinSCPConsoleEventCancel";
  808. private const string ConsoleJob = "WinSCPConsoleJob";
  809. private const string ExeExecutableFileName = "winscp.exe";
  810. private Process _process;
  811. private readonly object _lock = new object();
  812. private readonly Logger _logger;
  813. private readonly Session _session;
  814. private EventWaitHandle _requestEvent;
  815. private EventWaitHandle _responseEvent;
  816. private EventWaitHandle _cancelEvent;
  817. private SafeFileHandle _fileMapping;
  818. private string _instanceName;
  819. private Thread _thread;
  820. private bool _abort;
  821. private string _lastFromBeginning;
  822. private string _incompleteLine;
  823. private readonly List<string> _input = new List<string>();
  824. private AutoResetEvent _inputEvent = new AutoResetEvent(false);
  825. private Job _job;
  826. }
  827. }