Bug fixes and improvements for the show command with different text files

Author: sedwards2009

extraterm/src/mimetype_detector/MimeTypeDetector.jest.ts

@@ -25,7 +25,10 @@ describe.each([
   // Random binary data.
   ["Random", "random.bin", "application/octet-stream"],
   // Part of a linux lib.so file.
-  ["LibSo", "libso.bin", "application/octet-stream"]
+  ["LibSo", "libso.bin", "application/octet-stream"],
+  ["Shell Script", "foo.sh", "text/plain"],
+  ["Fish shell script", "foo.fish", "text/plain"],
+  ["ini file", "foo.ini", "text/plain"],
 ])("", (name: string, filename: string, mimeType: string) => {
   test(`${name} => ${mimeType}`, () => {
     const result = MimeTypeDetector.detect(null, readTestFile(filename));

extraterm/src/mimetype_detector/MimeTypeDetector.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Simon Edwards <[email protected]>
+ * Copyright 2016-2019 Simon Edwards <[email protected]>
  *
  * This source code is licensed under the MIT license which is detailed in the LICENSE.txt file.
  */
@@ -170,6 +170,7 @@ const modeInfo: ModeInfo[] = [
   {name: "Rust", mime: "text/x-rustsrc", mode: "rust", ext: ["rs"]},
   {name: "SAS", mime: "text/x-sas", mode: "sas", ext: ["sas"]},
   {name: "Sass", mime: "text/x-sass", mode: "sass", ext: ["sass"]},
+  {name: "scad", mime: "application/x-scad", mode: "text", ext: ["scad"]},
   {name: "Scala", mime: "text/x-scala", mode: "clike", ext: ["scala"]},
   {name: "Scheme", mime: "text/x-scheme", mode: "scheme", ext: ["scm", "ss"]},
   {name: "SCSS", mime: "text/x-scss", mode: "css", ext: ["scss"]},

extraterm/src/render_process/DownloadApplicationModeHandler.ts

@@ -54,7 +54,7 @@ enum DownloadHandlerState {
 
 const MAX_CHUNK_BYTES = 3 * 1024;
 const invalidBodyRegex = /[^\n\rA-Za-z0-9/+:=]/;
-
+const ONE_KILOBYTE = 1024;
 
 class DownloadSession {
 
@@ -69,6 +69,7 @@ class DownloadSession {
 
   onCreatedBulkFile: Event<BulkFileHandle>;
   private _onCreatedBulkFileEventEmitter = new EventEmitter<BulkFileHandle>();
+  private _createdEventFired = false;
 
   constructor(private _emulator: TermApi.EmulatorApi, private _broker: BulkFileBroker) {
     this._log = getLogger("DownloadApplicationModeHandler DownloadSession", this);
@@ -130,14 +131,24 @@ class DownloadSession {
       this._fileHandle = this._broker.createWriteableBulkFileHandle(metadata, filesize);
       this._fileHandle.ref();
       this._availableWriteBufferSizeChangedDisposable = this._fileHandle.onAvailableWriteBufferSizeChange(this._handleAvailableWriteBufferSizeChange.bind(this));
-      this._onCreatedBulkFileEventEmitter.fire(this._fileHandle);
 
       this._state = DownloadHandlerState.BODY;
       return this._handleBody("");
     }
     return {action: TermApi.ApplicationModeResponseAction.CONTINUE};
   }
 
+  private _fireOnCreatedEvent(force=false): void {
+    if (this._fileHandle == null || this._createdEventFired) {
+      return;
+    }
+
+    if (force || this._fileHandle.getAvailableSize() >= ONE_KILOBYTE) {
+      this._onCreatedBulkFileEventEmitter.fire(this._fileHandle);
+      this._createdEventFired = true;
+    }
+  }
+
   private _closeFileHandle(success: boolean): void {
      if (this._fileHandle !== null) {
       this._fileHandle.close(success);
@@ -160,6 +171,7 @@ class DownloadSession {
       if (invalidBodyRegex.test(chunk)) {
         this._log.warn("Chunk contains illegal characters. Aborting.");
         this._state = DownloadHandlerState.ERROR;
+        this._fireOnCreatedEvent(true);
         this._closeFileHandle(false);
         return {action: TermApi.ApplicationModeResponseAction.ABORT, remainingData: this._encodedDataBuffer};
       }
@@ -177,6 +189,7 @@ class DownloadSession {
         if (chunk.charAt(1) !== ":" || chunk.charAt(lastColonIndex) !== ":" || (commandChar !== "D" && commandChar !== "E")) {
           this._log.warn("Data chunk is malformed. Aborting.");
           this._state = DownloadHandlerState.ERROR;
+          this._fireOnCreatedEvent(true);
           this._closeFileHandle(false);
           return {action: TermApi.ApplicationModeResponseAction.ABORT, remainingData: this._encodedDataBuffer};
         }
@@ -196,6 +209,7 @@ class DownloadSession {
         if (this._previousHash.toString("hex") !== hashHex) {
           this._log.warn("Data chunk hash is incorrect.");
           this._state = DownloadHandlerState.ERROR;
+          this._fireOnCreatedEvent(true);
           this._closeFileHandle(false);
           return {action: TermApi.ApplicationModeResponseAction.ABORT, remainingData: this._encodedDataBuffer};
         }
@@ -211,6 +225,8 @@ class DownloadSession {
 
     this._flushBuffer();
 
+    this._fireOnCreatedEvent();
+
     if (this._state === DownloadHandlerState.BODY && this._fileHandle.getAvailableWriteBufferSize() <= 0) {
       return {action: TermApi.ApplicationModeResponseAction.PAUSE};
     }
@@ -272,6 +288,7 @@ class DownloadSession {
     }
 
     if (this._decodedDataBuffers.length === 0 && this._state === DownloadHandlerState.COMPLETE) {
+      this._fireOnCreatedEvent(true);
       this._closeFileHandle(true);
     }
   }
@@ -280,6 +297,7 @@ class DownloadSession {
     let response: TermApi.ApplicationModeResponse = null;
 
     this._flushBuffer();
+    this._fireOnCreatedEvent(true);
 
     if (this._state !== DownloadHandlerState.COMPLETE) {
       this._state = DownloadHandlerState.ERROR;

extraterm/src/render_process/Terminal.ts

@@ -1284,14 +1284,8 @@ export class EtTerminal extends ThemeableElementBase implements AcceptsKeybindin
   private _handleShowFile(bulkFileHandle: BulkFileHandle): void {
     const isDownload = bulkFileHandle.getMetadata()["download"] === "true";
     const {mimeType, charset} = BulkFileUtils.guessMimetype(bulkFileHandle);
-    if (mimeType == null || isDownload) {
-      this._appendMimeViewer("application/octet-stream", bulkFileHandle);
-    } else {
-      const newViewer = this._appendMimeViewer(mimeType, bulkFileHandle);
-      if (newViewer == null) {
-        this._appendMimeViewer("application/octet-stream", bulkFileHandle);
-      }
-    }
+    this._appendMimeViewer(mimeType == null || isDownload ? "application/octet-stream" : mimeType,
+      bulkFileHandle);
   }
 
   private _appendMimeViewer(mimeType: string, bulkFileHandle: BulkFileHandle): ViewerElement {
@@ -1318,7 +1312,7 @@ export class EtTerminal extends ThemeableElementBase implements AcceptsKeybindin
 
   private _createMimeViewer(mimeType: string, bulkFileHandle: BulkFileHandle): ViewerElement {
     let tag: string = null;
-    const candidates = viewerClasses.filter( (viewerClass) => viewerClass.supportsMimeType(mimeType) );
+    const candidates = this._findViewersForMimeType(mimeType);
     if (candidates.length !== 0) {
       tag = candidates[0].TAG_NAME;
     } else {
@@ -1340,6 +1334,27 @@ export class EtTerminal extends ThemeableElementBase implements AcceptsKeybindin
     return dataViewer;
   }
 
+  private _findViewersForMimeType(mimeType: string): SupportsMimeTypes[] {
+    const candidates = this._findViewersForMimeTypeStrict(mimeType);
+    if (candidates.length !== 0) {
+      return candidates;
+    }
+
+    if (mimeType.startsWith("text/")) {
+      const textCandidates = this._findViewersForMimeTypeStrict("text/plain");
+      if (textCandidates.length !== 0) {
+        return textCandidates;
+      }
+    }
+
+    return this._findViewersForMimeTypeStrict("application/octet-stream");
+  }
+
+  private _findViewersForMimeTypeStrict(mimeType: string): SupportsMimeTypes[] {
+    return viewerClasses.filter( viewerClass => viewerClass.supportsMimeType(mimeType) );
+  }
+
+
   private _getNextTag(): string {
     let tag  = this._nextTag;
     if (tag === null) {

extraterm/src/testfiles/foo.fish

@@ -0,0 +1,2 @@
+#!/bin/fish
+echo "A fish script"

extraterm/src/testfiles/foo.ini

@@ -0,0 +1,2 @@
+[Section]
+key = value

extraterm/src/testfiles/foo.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "A shell script"