Merge pull request #4263 from MDoerner/ParserFileHandlingFix

More safety around handling the temp files in the parser

Author: retailcoder

Rubberduck.API/VBA/Parser.cs

@@ -97,7 +97,7 @@ internal Parser(object vbe) : this()
             _state = new RubberduckParserState(_vbe, projectRepository, declarationFinderFactory, _vbeEvents);
             _state.StateChanged += _state_StateChanged;
 
-            var sourceFileHandler = _vbe.SourceFileHandler;
+            var sourceFileHandler = _vbe.TempSourceFileHandler;
             var vbeVersion = double.Parse(_vbe.Version, CultureInfo.InvariantCulture);
             var predefinedCompilationConstants = new VBAPredefinedCompilationConstants(vbeVersion);
             var typeLibProvider = new TypeLibWrapperProvider(projectRepository);

Rubberduck.Main/Root/RubberduckIoCInstaller.cs

@@ -886,7 +886,7 @@ private void RegisterConstantVbeAndAddIn(IWindsorContainer container)
             container.Register(Component.For<ICommandBars>().Instance(_vbe.CommandBars));
             container.Register(Component.For<IUiContextProvider>().Instance(UiContextProvider.Instance()).LifestyleSingleton());
             container.Register(Component.For<IVBEEvents>().Instance(VBEEvents.Initialize(_vbe)).LifestyleSingleton());
-            container.Register(Component.For<ISourceFileHandler>().Instance(_vbe.SourceFileHandler));
+            container.Register(Component.For<ITempSourceFileHandler>().Instance(_vbe.TempSourceFileHandler));
         }
 
         private void RegisterHotkeyFactory(IWindsorContainer container)

Rubberduck.Parsing/VBA/Parsing/ModuleParser.cs

@@ -99,7 +99,7 @@ private ModuleParseResults ParseInternal(QualifiedModuleName module, Cancellatio
 
             Logger.Trace($"ParseTaskID {taskId} begins attributes pass.");
             var (attributesParseTree, attributesTokenStream) = AttributesPassResults(module, cancellationToken);
-            var attributesRewriter = _moduleRewriterFactory.AttributesRewriter(module, attributesTokenStream ?? codePaneTokenStream);
+            var attributesRewriter = _moduleRewriterFactory.AttributesRewriter(module, attributesTokenStream);
             Logger.Trace($"ParseTaskID {taskId} finished attributes pass.");
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -153,7 +153,7 @@ private IEnumerable<CommentNode> QualifyAndUnionComments(QualifiedModuleName qua
         private (IParseTree tree, ITokenStream tokenStream) AttributesPassResults(QualifiedModuleName module, CancellationToken token)
         {
             token.ThrowIfCancellationRequested();
-            var code = _attributesSourceCodeProvider.SourceCode(module) ?? string.Empty;
+            var code = _attributesSourceCodeProvider.SourceCode(module);
             token.ThrowIfCancellationRequested();
             var attributesParseResults = _parser.Parse(module.ComponentName, module.ProjectId, code, token, CodeKind.AttributesCode);
             return attributesParseResults;

Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

@@ -82,7 +82,7 @@
     <Compile Include="SourceCodeHandling\CodePaneSourceCodeHandler.cs" />
     <Compile Include="SourceCodeHandling\ISourceCodeHandler.cs" />
     <Compile Include="SourceCodeHandling\ISourceCodeProvider.cs" />
-    <Compile Include="SourceCodeHandling\ISourceFileHandler.cs" />
+    <Compile Include="SourceCodeHandling\ITempSourceFileHandler.cs" />
     <Compile Include="CommandBarLocation.cs" />
     <Compile Include="SafeComWrappers\Abstract\HostApplicationBase.cs" />
     <Compile Include="SafeComWrappers\Abstract\ISafeComWrapper.cs" />

Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponent.cs

@@ -20,7 +20,7 @@ public interface IVBComponent : ISafeComWrapper, IEquatable<IVBComponent>
         IWindow DesignerWindow();
         void Activate();
         void Export(string path);
-        string ExportAsSourceFile(string folder, bool tempFile = false);
+        string ExportAsSourceFile(string folder, bool tempFile = false, bool specialCaseDocumentModules = true);
         int FileCount { get; }
         string GetFileName(short index);
         IVBProject ParentProject { get; }

Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBE.cs

@@ -25,6 +25,6 @@ public interface IVBE : ISafeComWrapper, IEquatable<IVBE>
 
         bool IsInDesignMode { get; }
         int ProjectsCount { get; }
-        ISourceFileHandler SourceFileHandler { get; }
+        ITempSourceFileHandler TempSourceFileHandler { get; }
     }
 }

Rubberduck.VBEEditor/SourceCodeHandling/CodePaneSourceCodeHandler.cs

@@ -22,7 +22,7 @@ public string SourceCode(QualifiedModuleName module)
 
             using (var codeModule = component.CodeModule)
             {
-                return codeModule.Content();
+                return codeModule.Content() ?? string.Empty;
             }
         }
 

Rubberduck.VBEEditor/SourceCodeHandling/ISourceFileHandler.cs renamed to Rubberduck.VBEEditor/SourceCodeHandling/ITempSourceFileHandler.cs

@@ -2,10 +2,10 @@
 
 namespace Rubberduck.VBEditor.SourceCodeHandling
 {
-    public interface ISourceFileHandler
+    public interface ITempSourceFileHandler
     {
         string Export(IVBComponent component);
-        void Import(IVBComponent component, string fileName);
+        void ImportAndCleanUp(IVBComponent component, string fileName);
 
         string Read(IVBComponent component);
     }

Rubberduck.VBEEditor/SourceCodeHandling/SourceFileHandlerSourceCodeHandlerAdapter.cs

@@ -7,12 +7,12 @@ namespace Rubberduck.VBEditor.SourceCodeHandling
     public class SourceFileHandlerSourceCodeHandlerAdapter : ISourceCodeHandler
     {
         private readonly IProjectsProvider _projectsProvider;
-        private readonly ISourceFileHandler _sourceFileHandler;
+        private readonly ITempSourceFileHandler _tempSourceFileHandler;
 
-        public SourceFileHandlerSourceCodeHandlerAdapter(ISourceFileHandler sourceFileHandler, IProjectsProvider projectsProvider)
+        public SourceFileHandlerSourceCodeHandlerAdapter(ITempSourceFileHandler tempSourceFileHandler, IProjectsProvider projectsProvider)
         {
             _projectsProvider = projectsProvider;
-            _sourceFileHandler = sourceFileHandler;
+            _tempSourceFileHandler = tempSourceFileHandler;
         }
 
         public string SourceCode(QualifiedModuleName module)
@@ -23,7 +23,7 @@ public string SourceCode(QualifiedModuleName module)
                 return string.Empty;
             }
 
-            return _sourceFileHandler.Read(component);
+            return _tempSourceFileHandler.Read(component) ?? string.Empty;
         }
 
         public void SubstituteCode(QualifiedModuleName module, string newCode)
@@ -40,9 +40,14 @@ public void SubstituteCode(QualifiedModuleName module, string newCode)
                 return;
             }
 
-            var file = _sourceFileHandler.Export(component);
-            File.WriteAllText(file, newCode);
-            _sourceFileHandler.Import(component, file);
+            var fileName = _tempSourceFileHandler.Export(component);
+            if (fileName == null || !File.Exists(fileName))
+            {
+                return;
+            }
+            File.WriteAllText(fileName, newCode);
+            _tempSourceFileHandler.ImportAndCleanUp(component, fileName);
+
         }
     }
 }

Rubberduck.VBEditor.VB6/SourceFileHandler.cs renamed to Rubberduck.VBEditor.VB6/ExternalFileTempSourceFileHandlerEmulator.cs

@@ -1,37 +1,32 @@
 using System.IO;
 using System.Text;
-using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VBEditor.SourceCodeHandling;
 
 namespace Rubberduck.VBEditor.VB6
 {
-    public class SourceFileHandler : ISourceFileHandler
+    public class ExternalFileTempSourceFileHandlerEmulator : ITempSourceFileHandler
     {
         public string Export(IVBComponent component)
         {
             // VB6 source code is already external, and should be in the first associated file.
             return component.GetFileName(1);            
         }
 
-        public void Import(IVBComponent component, string fileName)
+        public void ImportAndCleanUp(IVBComponent component, string fileName)
         {
             // VB6 source code can be written directly in-place, without needing to import it, hence no-op.
         }
 
         public string Read(IVBComponent component)
         {
             var fileName = Export(component);
-            if (fileName == null)
+            if (fileName == null || !File.Exists(fileName))
             {
                 return null;
             }
 
-            var encoding = component.QualifiedModuleName.ComponentType == ComponentType.Document
-                ? Encoding.UTF8
-                : Encoding.Default;
-
-            return File.ReadAllText(fileName, encoding);
+            return File.ReadAllText(fileName, Encoding.Default);
         }        
     }
 }