Merge pull request #1306 from scm-manager/bugfix/markdown_detection

Fix detection of markdown files for files having content does not sta…

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 ### Fixed
+- Fix detection of markdown files for files having content does not start with '#' ([#1306](https://github.com/scm-manager/scm-manager/pull/1306))
 - Fix broken markdown rendering ([#1303](https://github.com/scm-manager/scm-manager/pull/1303))
 - JWT token timeout is now handled properly ([#1297](https://github.com/scm-manager/scm-manager/pull/1297))
 - Fix text-overflow in danger zone ([#1298](https://github.com/scm-manager/scm-manager/pull/1298))

scm-ui/ui-webapp/src/repos/sources/containers/SourcesView.tsx

@@ -87,7 +87,7 @@ class SourcesView extends React.Component<Props, State> {
     const basePath = this.createBasePath();
     if (contentType.startsWith("image/")) {
       return <ImageViewer file={file} />;
-    } else if (contentType.includes("markdown")) {
+    } else if (contentType.includes("markdown") || (language && language.toLowerCase() === "markdown")) {
       return <SwitchableMarkdownViewer file={file} basePath={basePath} />;
     } else if (language) {
       return <SourcecodeViewer file={file} language={language} />;

scm-webapp/pom.xml

@@ -315,7 +315,7 @@
     <dependency>
       <groupId>com.github.sdorra</groupId>
       <artifactId>spotter-core</artifactId>
-      <version>2.1.2</version>
+      <version>3.0.0</version>
     </dependency>
 
     <dependency>

scm-webapp/src/main/java/sonia/scm/api/v2/ContentTypeResolver.java

@@ -0,0 +1,51 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2;
+
+import com.github.sdorra.spotter.ContentType;
+import com.github.sdorra.spotter.ContentTypeDetector;
+import com.github.sdorra.spotter.Language;
+
+public final class ContentTypeResolver {
+
+  private static final ContentTypeDetector PATH_BASED = ContentTypeDetector.builder()
+    .defaultPathBased().boost(Language.MARKDOWN)
+    .bestEffortMatch();
+
+  private static final ContentTypeDetector PATH_AND_CONTENT_BASED = ContentTypeDetector.builder()
+    .defaultPathAndContentBased().boost(Language.MARKDOWN)
+    .bestEffortMatch();
+
+  private ContentTypeResolver() {
+  }
+
+  public static ContentType resolve(String path) {
+    return PATH_BASED.detect(path);
+  }
+
+  public static ContentType resolve(String path, byte[] contentPrefix) {
+    return PATH_AND_CONTENT_BASED.detect(path, contentPrefix);
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ContentResource.java

@@ -25,7 +25,6 @@
 package sonia.scm.api.v2.resources;
 
 import com.github.sdorra.spotter.ContentType;
-import com.github.sdorra.spotter.ContentTypes;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -34,6 +33,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import sonia.scm.NotFoundException;
+import sonia.scm.api.v2.ContentTypeResolver;
 import sonia.scm.repository.NamespaceAndName;
 import sonia.scm.repository.api.RepositoryService;
 import sonia.scm.repository.api.RepositoryServiceFactory;
@@ -204,7 +204,7 @@ public class ContentResource {
   }
 
   private void appendContentHeader(String path, byte[] head, Response.ResponseBuilder responseBuilder) {
-    ContentType contentType = ContentTypes.detect(path, head);
+    ContentType contentType = ContentTypeResolver.resolve(path, head);
     responseBuilder.header("Content-Type", contentType.getRaw());
     contentType.getLanguage().ifPresent(
       language -> responseBuilder.header(ProgrammingLanguages.HEADER, ProgrammingLanguages.getValue(language))

scm-webapp/src/main/java/sonia/scm/api/v2/resources/DiffResultToDiffResultDtoMapper.java

@@ -24,10 +24,10 @@
 
 package sonia.scm.api.v2.resources;
 
-import com.github.sdorra.spotter.ContentTypes;
 import com.github.sdorra.spotter.Language;
 import com.google.inject.Inject;
 import de.otto.edison.hal.Links;
+import sonia.scm.api.v2.ContentTypeResolver;
 import sonia.scm.repository.Repository;
 import sonia.scm.repository.api.DiffFile;
 import sonia.scm.repository.api.DiffLine;
@@ -120,7 +120,7 @@ class DiffResultToDiffResultDtoMapper {
     dto.setOldRevision(file.getOldRevision());
 
 
-    Optional<Language> language = ContentTypes.detect(path).getLanguage();
+    Optional<Language> language = ContentTypeResolver.resolve(path).getLanguage();
     language.ifPresent(value -> dto.setLanguage(ProgrammingLanguages.getValue(value)));
 
     List<DiffResultDto.HunkDto> hunks = new ArrayList<>();

scm-webapp/src/test/java/sonia/scm/api/v2/ContentTypeResolverTest.java

@@ -0,0 +1,65 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2;
+
+import com.github.sdorra.spotter.ContentType;
+import com.github.sdorra.spotter.Language;
+import org.junit.jupiter.api.Test;
+
+import java.nio.charset.StandardCharsets;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ContentTypeResolverTest {
+
+  @Test
+  void shouldResolveMarkdown() {
+    String content = String.join("\n",
+      "% Markdown content",
+      "% Which does not start with markdown"
+    );
+    ContentType contentType = ContentTypeResolver.resolve("somedoc.md", content.getBytes(StandardCharsets.UTF_8));
+    assertThat(contentType.getLanguage()).contains(Language.MARKDOWN);
+  }
+
+  @Test
+  void shouldResolveMarkdownWithoutContent() {
+    ContentType contentType = ContentTypeResolver.resolve("somedoc.md");
+    assertThat(contentType.getLanguage()).contains(Language.MARKDOWN);
+  }
+
+  @Test
+  void shouldResolveMarkdownEvenWithDotsInFilename() {
+    ContentType contentType = ContentTypeResolver.resolve("somedoc.1.1.md");
+    assertThat(contentType.getLanguage()).contains(Language.MARKDOWN);
+  }
+
+  @Test
+  void shouldResolveDockerfile() {
+    ContentType contentType = ContentTypeResolver.resolve("Dockerfile");
+    assertThat(contentType.getLanguage()).contains(Language.DOCKERFILE);
+  }
+
+}