ExeSessionProcess.cs 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943
  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. if (_requestEvent.WaitOne(100, false))
  232. {
  233. _logger.WriteLineLevel(1, "Got request event");
  234. ProcessEvent();
  235. }
  236. if (_logger.LogLevel >= 1)
  237. {
  238. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "2nd generation collection count: {0}", GC.CollectionCount(2)));
  239. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "Total memory allocated: {0}", GC.GetTotalMemory(false)));
  240. }
  241. }
  242. }
  243. }
  244. private void ProcessEvent()
  245. {
  246. using (_logger.CreateCallstack())
  247. {
  248. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  249. {
  250. switch (commStruct.Event)
  251. {
  252. case ConsoleEvent.Print:
  253. ProcessPrintEvent(commStruct.PrintEvent);
  254. break;
  255. case ConsoleEvent.Input:
  256. ProcessInputEvent(commStruct.InputEvent);
  257. break;
  258. case ConsoleEvent.Choice:
  259. ProcessChoiceEvent(commStruct.ChoiceEvent);
  260. break;
  261. case ConsoleEvent.Title:
  262. ProcessTitleEvent(commStruct.TitleEvent);
  263. break;
  264. case ConsoleEvent.Init:
  265. ProcessInitEvent(commStruct.InitEvent);
  266. break;
  267. case ConsoleEvent.Progress:
  268. ProcessProgressEvent(commStruct.ProgressEvent);
  269. break;
  270. default:
  271. throw new NotImplementedException();
  272. }
  273. }
  274. _responseEvent.Set();
  275. }
  276. }
  277. private void ProcessChoiceEvent(ConsoleChoiceEventStruct e)
  278. {
  279. using (_logger.CreateCallstack())
  280. {
  281. if (e.Timeouting)
  282. {
  283. Thread.Sleep((int)e.Timer);
  284. e.Result = e.Timeouted;
  285. }
  286. else
  287. {
  288. e.Result = e.Break;
  289. }
  290. _logger.WriteLine(
  291. "Options: [{0}], Timer: [{1}], Timeouting: [{2}], Timeouted: [{3}], Break: [{4}], Result: [{5}]",
  292. e.Options, e.Timer, e.Timeouting, e.Timeouted, e.Break, e.Result);
  293. }
  294. }
  295. private void ProcessTitleEvent(ConsoleTitleEventStruct e)
  296. {
  297. using (_logger.CreateCallstack())
  298. {
  299. _logger.WriteLine("Not-supported title event [{0}]", e.Title);
  300. }
  301. }
  302. private void ProcessInputEvent(ConsoleInputEventStruct e)
  303. {
  304. using (_logger.CreateCallstack())
  305. {
  306. while (!AbortedOrExited())
  307. {
  308. lock (_input)
  309. {
  310. if (_input.Count > 0)
  311. {
  312. e.Str = _input[0];
  313. e.Result = true;
  314. _input.RemoveAt(0);
  315. Print(false, false, e.Str + "\n");
  316. return;
  317. }
  318. }
  319. _inputEvent.WaitOne(100, false);
  320. }
  321. }
  322. }
  323. private void Print(bool fromBeginning, bool error, string message)
  324. {
  325. if (fromBeginning && ((message.Length == 0) || (message[0] != '\n')))
  326. {
  327. _lastFromBeginning = message;
  328. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  329. if (OutputDataReceived != null)
  330. {
  331. OutputDataReceived(this, null);
  332. }
  333. }
  334. else
  335. {
  336. if (!string.IsNullOrEmpty(_lastFromBeginning))
  337. {
  338. AddToOutput(_lastFromBeginning, false);
  339. _lastFromBeginning = null;
  340. }
  341. if (fromBeginning && (message.Length > 0) && (message[0] == '\n'))
  342. {
  343. AddToOutput("\n", false);
  344. _lastFromBeginning = message.Substring(1);
  345. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  346. }
  347. else
  348. {
  349. AddToOutput(message, error);
  350. }
  351. }
  352. }
  353. private void AddToOutput(string message, bool error)
  354. {
  355. string[] lines = (_incompleteLine + message).Split(new[] { '\n' });
  356. _incompleteLine = lines[lines.Length - 1];
  357. for (int i = 0; i < lines.Length - 1; ++i)
  358. {
  359. if (OutputDataReceived != null)
  360. {
  361. OutputDataReceived(this, new OutputDataReceivedEventArgs(lines[i], error));
  362. }
  363. }
  364. }
  365. private void ProcessPrintEvent(ConsolePrintEventStruct e)
  366. {
  367. _logger.WriteLineLevel(1, string.Format(CultureInfo.CurrentCulture, "Print: {0}", e.Message));
  368. Print(e.FromBeginning, e.Error, e.Message);
  369. }
  370. private void ProcessInitEvent(ConsoleInitEventStruct e)
  371. {
  372. using (_logger.CreateCallstack())
  373. {
  374. e.InputType = 3; // pipe
  375. e.OutputType = 3; // pipe
  376. e.WantsProgress = _session.WantsProgress;
  377. }
  378. }
  379. private void ProcessProgressEvent(ConsoleProgressEventStruct e)
  380. {
  381. using (_logger.CreateCallstack())
  382. {
  383. _logger.WriteLine(
  384. "File Name [{0}] - Directory [{1}] - Overall Progress [{2}] - File Progress [{3}] - CPS [{4}]",
  385. e.FileName, e.Directory, e.OverallProgress, e.FileProgress, e.CPS);
  386. FileTransferProgressEventArgs args = new FileTransferProgressEventArgs();
  387. switch (e.Operation)
  388. {
  389. case ConsoleProgressEventStruct.ProgressOperation.Copy:
  390. args.Operation = ProgressOperation.Transfer;
  391. break;
  392. default:
  393. throw new ArgumentOutOfRangeException("Unknown progress operation", (Exception)null);
  394. }
  395. switch (e.Side)
  396. {
  397. case ConsoleProgressEventStruct.ProgressSide.Local:
  398. args.Side = ProgressSide.Local;
  399. break;
  400. case ConsoleProgressEventStruct.ProgressSide.Remote:
  401. args.Side = ProgressSide.Remote;
  402. break;
  403. default:
  404. throw new ArgumentOutOfRangeException("Unknown progress side", (Exception)null);
  405. }
  406. args.FileName = e.FileName;
  407. args.Directory = e.Directory;
  408. args.OverallProgress = ((double)e.OverallProgress) / 100;
  409. args.FileProgress = ((double)e.FileProgress) / 100;
  410. args.CPS = (int) e.CPS;
  411. _session.ProcessProgress(args);
  412. }
  413. }
  414. private void InitializeConsole()
  415. {
  416. using (_logger.CreateCallstack())
  417. {
  418. int attempts = 0;
  419. Random random = new Random();
  420. int process = Process.GetCurrentProcess().Id;
  421. do
  422. {
  423. if (attempts > MaxAttempts)
  424. {
  425. throw new SessionLocalException(_session, "Cannot find unique name for event object.");
  426. }
  427. int instanceNumber = random.Next(1000);
  428. _instanceName = string.Format(CultureInfo.InvariantCulture, "_{0}_{1}_{2}", process, GetHashCode(), instanceNumber);
  429. _logger.WriteLine("Trying event {0}", _instanceName);
  430. if (!TryCreateEvent(ConsoleEventRequest + _instanceName, out _requestEvent))
  431. {
  432. _logger.WriteLine("Event {0} is not unique", _instanceName);
  433. _requestEvent.Close();
  434. _requestEvent = null;
  435. }
  436. else
  437. {
  438. _logger.WriteLine("Event {0} is unique", _instanceName);
  439. _responseEvent = CreateEvent(ConsoleEventResponse + _instanceName);
  440. _cancelEvent = CreateEvent(ConsoleEventCancel + _instanceName);
  441. string fileMappingName = ConsoleMapping + _instanceName;
  442. _fileMapping = CreateFileMapping(fileMappingName);
  443. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  444. {
  445. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "File mapping {0} already exists", fileMappingName));
  446. }
  447. if (_fileMapping.IsInvalid)
  448. {
  449. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Cannot create file mapping {0}", fileMappingName));
  450. }
  451. }
  452. ++attempts;
  453. }
  454. while (_requestEvent == null);
  455. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  456. {
  457. commStruct.InitHeader();
  458. }
  459. if (_session.GuardProcessWithJobInternal)
  460. {
  461. string jobName = ConsoleJob + _instanceName;
  462. _job = new Job(_logger, jobName);
  463. }
  464. }
  465. }
  466. private SafeFileHandle CreateFileMapping(string fileMappingName)
  467. {
  468. unsafe
  469. {
  470. IntPtr securityAttributesPtr = IntPtr.Zero;
  471. // We use the EventWaitHandleSecurity only to generate the descriptor binary form
  472. // that does not differ for object types, so we abuse the existing "event handle" implementation,
  473. // not to have to create the file mapping SecurityAttributes via P/Invoke.
  474. // .NET 4 supports MemoryMappedFile and MemoryMappedFileSecurity natively already
  475. EventWaitHandleSecurity security = CreateSecurity((EventWaitHandleRights)FileMappingRights.AllAccess);
  476. if (security != null)
  477. {
  478. SecurityAttributes securityAttributes = new SecurityAttributes();
  479. securityAttributes.nLength = (uint)Marshal.SizeOf(securityAttributes);
  480. byte[] descriptorBinaryForm = security.GetSecurityDescriptorBinaryForm();
  481. byte * buffer = stackalloc byte[descriptorBinaryForm.Length];
  482. for (int i = 0; i < descriptorBinaryForm.Length; i++)
  483. {
  484. buffer[i] = descriptorBinaryForm[i];
  485. }
  486. securityAttributes.lpSecurityDescriptor = (IntPtr)buffer;
  487. int length = Marshal.SizeOf(typeof(SecurityAttributes));
  488. securityAttributesPtr = Marshal.AllocHGlobal(length);
  489. Marshal.StructureToPtr(securityAttributes, securityAttributesPtr, false);
  490. }
  491. return
  492. UnsafeNativeMethods.CreateFileMapping(
  493. new SafeFileHandle(new IntPtr(-1), true), securityAttributesPtr, FileMapProtection.PageReadWrite, 0,
  494. ConsoleCommStruct.Size, fileMappingName);
  495. }
  496. }
  497. private ConsoleCommStruct AcquireCommStruct()
  498. {
  499. return new ConsoleCommStruct(_session, _fileMapping);
  500. }
  501. private bool TryCreateEvent(string name, out EventWaitHandle ev)
  502. {
  503. bool createdNew;
  504. _logger.WriteLine("Creating event {0}", name);
  505. EventWaitHandleSecurity security = CreateSecurity(EventWaitHandleRights.FullControl);
  506. ev = new EventWaitHandle(false, EventResetMode.AutoReset, name, out createdNew, security);
  507. _logger.WriteLine(
  508. "Created event {0} with handle {1} with security {2}, new {3}",
  509. name, ev.SafeWaitHandle.DangerousGetHandle(),
  510. (security != null ? security.GetSecurityDescriptorSddlForm(AccessControlSections.All) : "none"), createdNew);
  511. return createdNew;
  512. }
  513. private EventWaitHandleSecurity CreateSecurity(EventWaitHandleRights eventRights)
  514. {
  515. EventWaitHandleSecurity security = null;
  516. // When "running as user", we have to grant the target user permissions to the objects (events and file mapping) explicitly
  517. if (!string.IsNullOrEmpty(_session.ExecutableProcessUserName))
  518. {
  519. security = new EventWaitHandleSecurity();
  520. IdentityReference si;
  521. try
  522. {
  523. si = new NTAccount(_session.ExecutableProcessUserName);
  524. }
  525. catch (Exception e)
  526. {
  527. throw new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "Error resolving account {0}", _session.ExecutableProcessUserName), e);
  528. }
  529. EventWaitHandleAccessRule rule =
  530. new EventWaitHandleAccessRule(
  531. si, eventRights, AccessControlType.Allow);
  532. security.AddAccessRule(rule);
  533. }
  534. return security;
  535. }
  536. private EventWaitHandle CreateEvent(string name)
  537. {
  538. EventWaitHandle ev;
  539. if (!TryCreateEvent(name, out ev))
  540. {
  541. throw new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Event {0} already exists", name));
  542. }
  543. return ev;
  544. }
  545. private void TestEventClosed(string name)
  546. {
  547. if (_session.TestHandlesClosedInternal)
  548. {
  549. _logger.WriteLine("Testing that event {0} is closed", name);
  550. EventWaitHandle ev;
  551. if (TryCreateEvent(name, out ev))
  552. {
  553. ev.Close();
  554. }
  555. else
  556. {
  557. _logger.WriteLine("Exception: Event {0} was not closed yet", name);
  558. }
  559. }
  560. }
  561. private void AddInput(string str)
  562. {
  563. Type structType = typeof(ConsoleInputEventStruct);
  564. FieldInfo strField = structType.GetField("Str");
  565. object[] attributes = strField.GetCustomAttributes(typeof(MarshalAsAttribute), false);
  566. if (attributes.Length != 1)
  567. {
  568. throw new InvalidOperationException("MarshalAs attribute not found for ConsoleInputEventStruct.Str");
  569. }
  570. MarshalAsAttribute marshalAsAttribute = (MarshalAsAttribute)attributes[0];
  571. if (marshalAsAttribute.SizeConst <= str.Length)
  572. {
  573. throw new SessionLocalException(
  574. _session,
  575. string.Format(CultureInfo.CurrentCulture, "Input [{0}] is too long ({1} limit)", str, marshalAsAttribute.SizeConst));
  576. }
  577. lock (_input)
  578. {
  579. _input.Add(str);
  580. _inputEvent.Set();
  581. }
  582. }
  583. public void ExecuteCommand(string command)
  584. {
  585. using (_logger.CreateCallstack())
  586. {
  587. AddInput(command);
  588. }
  589. }
  590. public void Close()
  591. {
  592. using (_logger.CreateCallstack())
  593. {
  594. int timeout;
  595. #if DEBUG
  596. // in debug build, we expect the winscp.exe to run in tracing mode, being very slow
  597. timeout = 10000;
  598. #else
  599. timeout = 2000;
  600. #endif
  601. _logger.WriteLine("Waiting for process to exit ({0} ms)", timeout);
  602. if (!_process.WaitForExit(timeout))
  603. {
  604. _logger.WriteLine("Killing process");
  605. _process.Kill();
  606. }
  607. }
  608. }
  609. public void Dispose()
  610. {
  611. using (_logger.CreateCallstack())
  612. {
  613. lock (_lock)
  614. {
  615. if (_session.TestHandlesClosedInternal)
  616. {
  617. _logger.WriteLine("Will test that handles are closed");
  618. }
  619. _abort = true;
  620. if (_thread != null)
  621. {
  622. _thread.Join();
  623. _thread = null;
  624. }
  625. if (_process != null)
  626. {
  627. _process.Dispose();
  628. _process = null;
  629. }
  630. if (_requestEvent != null)
  631. {
  632. _requestEvent.Close();
  633. TestEventClosed(ConsoleEventRequest + _instanceName);
  634. }
  635. if (_responseEvent != null)
  636. {
  637. _responseEvent.Close();
  638. TestEventClosed(ConsoleEventResponse + _instanceName);
  639. }
  640. if (_cancelEvent != null)
  641. {
  642. _cancelEvent.Close();
  643. TestEventClosed(ConsoleEventCancel + _instanceName);
  644. }
  645. if (_fileMapping != null)
  646. {
  647. _fileMapping.Dispose();
  648. _fileMapping = null;
  649. if (_session.TestHandlesClosedInternal)
  650. {
  651. _logger.WriteLine("Testing that file mapping is closed");
  652. string fileMappingName = ConsoleMapping + _instanceName;
  653. SafeFileHandle fileMapping = CreateFileMapping(fileMappingName);
  654. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  655. {
  656. _logger.WriteLine("Exception: File mapping {0} was not closed yet", fileMappingName);
  657. }
  658. if (!fileMapping.IsInvalid)
  659. {
  660. fileMapping.Dispose();
  661. }
  662. }
  663. }
  664. if (_inputEvent != null)
  665. {
  666. _inputEvent.Close();
  667. _inputEvent = null;
  668. }
  669. if (_job != null)
  670. {
  671. _job.Dispose();
  672. _job = null;
  673. }
  674. }
  675. }
  676. }
  677. private string GetExecutablePath()
  678. {
  679. using (_logger.CreateCallstack())
  680. {
  681. string executablePath;
  682. if (!string.IsNullOrEmpty(_session.ExecutablePath))
  683. {
  684. executablePath = _session.ExecutablePath;
  685. if (!File.Exists(executablePath))
  686. {
  687. throw new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "{0} does not exists.", executablePath));
  688. }
  689. }
  690. else
  691. {
  692. if (!TryFindExecutableInPath(GetAssemblyPath(), out executablePath) &&
  693. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.CurrentUser), out executablePath) &&
  694. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.LocalMachine), out executablePath) &&
  695. !TryFindExecutableInPath(GetDefaultInstallationPath(), out executablePath))
  696. {
  697. throw new SessionLocalException(_session,
  698. string.Format(CultureInfo.CurrentCulture,
  699. "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}.",
  700. ExeExecutableFileName, GetAssemblyPath()));
  701. }
  702. }
  703. return executablePath;
  704. }
  705. }
  706. private static string GetDefaultInstallationPath()
  707. {
  708. string programFiles;
  709. if (IntPtr.Size == 8)
  710. {
  711. // In .NET 4 we can use Environment.SpecialFolder.ProgramFilesX86
  712. programFiles = Environment.GetEnvironmentVariable("ProgramFiles(x86)");
  713. }
  714. else
  715. {
  716. programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
  717. }
  718. return Path.Combine(programFiles, "WinSCP");
  719. }
  720. private static string GetInstallationPath(RegistryHive hive)
  721. {
  722. // In .NET 4 we can use RegistryKey.OpenBaseKey(hive, RegistryView.Registry32);
  723. const string uninstallKey = @"Software\Microsoft\Windows\CurrentVersion\Uninstall\winscp3_is1";
  724. const string appPathValue = @"Inno Setup: App Path";
  725. string result = null;
  726. IntPtr data = IntPtr.Zero;
  727. RegistryType type;
  728. uint len = 0;
  729. RegistryFlags flags = RegistryFlags.RegSz | RegistryFlags.SubKeyWow6432Key;
  730. UIntPtr key = (UIntPtr)((uint)hive);
  731. if (UnsafeNativeMethods.RegGetValue(key, uninstallKey, appPathValue, flags, out type, data, ref len) == 0)
  732. {
  733. data = Marshal.AllocHGlobal((int)len);
  734. if (UnsafeNativeMethods.RegGetValue(key, uninstallKey, appPathValue, flags, out type, data, ref len) == 0)
  735. {
  736. result = Marshal.PtrToStringUni(data);
  737. }
  738. }
  739. return result;
  740. }
  741. private bool TryFindExecutableInPath(string path, out string result)
  742. {
  743. if (string.IsNullOrEmpty(path))
  744. {
  745. result = null;
  746. }
  747. else
  748. {
  749. string executablePath = Path.Combine(path, ExeExecutableFileName);
  750. if (File.Exists(executablePath))
  751. {
  752. result = executablePath;
  753. _logger.WriteLine("Executable found in {0}", executablePath);
  754. }
  755. else
  756. {
  757. result = null;
  758. _logger.WriteLine("Executable not found in {0}", executablePath);
  759. }
  760. }
  761. return (result != null);
  762. }
  763. private string GetAssemblyPath()
  764. {
  765. string codeBasePath = _logger.GetAssemblyFilePath();
  766. string path = null;
  767. if (!string.IsNullOrEmpty(codeBasePath))
  768. {
  769. path = Path.GetDirectoryName(codeBasePath);
  770. Debug.Assert(path != null);
  771. }
  772. return path;
  773. }
  774. private void CheckVersion(string exePath, FileVersionInfo assemblyVersion)
  775. {
  776. using (_logger.CreateCallstack())
  777. {
  778. FileVersionInfo version = FileVersionInfo.GetVersionInfo(exePath);
  779. _logger.WriteLine("Version of {0} is {1}, product {2} version is {3}", exePath, version.FileVersion, version.ProductName, version.ProductVersion);
  780. if (_session.DisableVersionCheck)
  781. {
  782. _logger.WriteLine("Version check disabled (not recommended)");
  783. }
  784. else if (assemblyVersion == null)
  785. {
  786. _logger.WriteLine("Assembly version not known, cannot check version");
  787. }
  788. else if (assemblyVersion.ProductVersion != version.ProductVersion)
  789. {
  790. throw new SessionLocalException(
  791. _session, string.Format(CultureInfo.CurrentCulture,
  792. "The version of {0} ({1}) does not match version of this assembly {2} ({3}).",
  793. exePath, version.ProductVersion, _logger.GetAssemblyFilePath(), assemblyVersion.ProductVersion));
  794. }
  795. }
  796. }
  797. public void WriteStatus()
  798. {
  799. string executablePath = GetExecutablePath();
  800. _logger.WriteLine("{0} - exists [{1}]", executablePath, File.Exists(executablePath));
  801. }
  802. private const int MaxAttempts = 10;
  803. private const string ConsoleMapping = "WinSCPConsoleMapping";
  804. private const string ConsoleEventRequest = "WinSCPConsoleEventRequest";
  805. private const string ConsoleEventResponse = "WinSCPConsoleEventResponse";
  806. private const string ConsoleEventCancel = "WinSCPConsoleEventCancel";
  807. private const string ConsoleJob = "WinSCPConsoleJob";
  808. private const string ExeExecutableFileName = "winscp.exe";
  809. private Process _process;
  810. private readonly object _lock = new object();
  811. private readonly Logger _logger;
  812. private readonly Session _session;
  813. private EventWaitHandle _requestEvent;
  814. private EventWaitHandle _responseEvent;
  815. private EventWaitHandle _cancelEvent;
  816. private SafeFileHandle _fileMapping;
  817. private string _instanceName;
  818. private Thread _thread;
  819. private bool _abort;
  820. private string _lastFromBeginning;
  821. private string _incompleteLine;
  822. private readonly List<string> _input = new List<string>();
  823. private AutoResetEvent _inputEvent = new AutoResetEvent(false);
  824. private Job _job;
  825. }
  826. }