diff --git a/pom.xml b/pom.xml index 02f8f6df3..1afa6dcf4 100644 --- a/pom.xml +++ b/pom.xml @@ -290,6 +290,12 @@ 1.3.2 + + com.google.guava + guava + 18.0 + + javax.servlet diff --git a/src/main/java/org/owasp/webgoat/plugins/Plugin.java b/src/main/java/org/owasp/webgoat/plugins/Plugin.java index e96b56108..7018d697e 100644 --- a/src/main/java/org/owasp/webgoat/plugins/Plugin.java +++ b/src/main/java/org/owasp/webgoat/plugins/Plugin.java @@ -10,7 +10,6 @@ import java.io.File; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; -import java.nio.file.Paths; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -117,13 +116,8 @@ public class Plugin { public void rewritePaths(Path pluginTarget) { try { - for (Map.Entry html : solutionLanguageFiles.entrySet()) { - byte[] htmlFileAsBytes = Files.readAllBytes(Paths.get(html.getValue().toURI())); - String htmlFile = new String(htmlFileAsBytes); - htmlFile = htmlFile.replaceAll("lesson_solutions/" + this.lesson.getSimpleName() + "_files", pluginTarget.getFileName().toString() + "/lessons/plugin/" + this.lesson.getSimpleName() + "/lessonSolutions/en/" + this.lesson.getSimpleName() + "_files"); - Files.write(Paths.get(html.getValue().toURI()), htmlFile.getBytes(), CREATE, - TRUNCATE_EXISTING); - } + PluginFileUtils.replaceInFiles(this.lesson.getSimpleName() + "_files", pluginTarget.getFileName().toString() + "/plugin/" + this.lesson.getSimpleName() + "/lessonSolutions/en/" + this.lesson.getSimpleName() + "_files", solutionLanguageFiles.values()); + PluginFileUtils.replaceInFiles(this.lesson.getSimpleName() + "_files", pluginTarget.getFileName().toString() + "/plugin/" + this.lesson.getSimpleName() + "/lessonPlans/en/" + this.lesson.getSimpleName() + "_files", lessonPlansLanguageFiles.values()); } catch (IOException e) { throw new PluginLoadingFailure("Unable to rewrite the paths in the solutions", e); } diff --git a/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java b/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java index a3b26a34b..bf8bd6e36 100644 --- a/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java +++ b/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java @@ -1,11 +1,17 @@ package org.owasp.webgoat.plugins; +import com.google.common.base.Preconditions; + +import java.io.File; import java.io.IOException; import java.nio.file.DirectoryStream; import java.nio.file.Files; import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardOpenOption; import java.util.ArrayList; +import java.util.Collection; import java.util.List; public class PluginFileUtils { @@ -25,21 +31,42 @@ public class PluginFileUtils { } public static Path createDirsIfNotExists(Path p) throws IOException { - if ( Files.notExists(p)) { + if (Files.notExists(p)) { Files.createDirectories(p); } return p; } - - public static List getFilesInDirectory( Path directory) throws IOException { - List files = new ArrayList<>(); - DirectoryStream dirStream; - dirStream = Files.newDirectoryStream(directory); - for (Path entry : dirStream) { - files.add(entry); - } - dirStream.close(); - return files; + + public static List getFilesInDirectory(Path directory) throws IOException { + List files = new ArrayList<>(); + DirectoryStream dirStream; + dirStream = Files.newDirectoryStream(directory); + for (Path entry : dirStream) { + files.add(entry); + } + dirStream.close(); + return files; + } + + public static void replaceInFiles(String replace, String with, Collection files) throws IOException { + Preconditions.checkNotNull(replace); + Preconditions.checkNotNull(with); + Preconditions.checkNotNull(files); + + for (File file : files) { + replaceInFile(replace, with, Paths.get(file.toURI())); + } + } + + public static void replaceInFile(String replace, String with, Path file) throws IOException { + Preconditions.checkNotNull(replace); + Preconditions.checkNotNull(with); + Preconditions.checkNotNull(file); + + byte[] fileAsBytes = Files.readAllBytes(file); + String fileAsString = new String(fileAsBytes); + fileAsString = fileAsString.replaceAll(replace, with); + Files.write(file, fileAsString.getBytes(), StandardOpenOption.TRUNCATE_EXISTING); } } diff --git a/src/main/java/org/owasp/webgoat/session/Course.java b/src/main/java/org/owasp/webgoat/session/Course.java index aac3517b3..7c7a5c674 100644 --- a/src/main/java/org/owasp/webgoat/session/Course.java +++ b/src/main/java/org/owasp/webgoat/session/Course.java @@ -5,16 +5,13 @@ import org.owasp.webgoat.lessons.AbstractLesson; import org.owasp.webgoat.lessons.Category; import org.owasp.webgoat.plugins.GlobalProperties; import org.owasp.webgoat.plugins.Plugin; -import org.owasp.webgoat.plugins.PluginFileUtils; import org.owasp.webgoat.plugins.PluginsLoader; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.servlet.ServletContext; - import java.io.File; import java.io.IOException; -import java.nio.file.Path; import java.nio.file.Paths; import java.util.ArrayList; import java.util.Collections; @@ -22,7 +19,6 @@ import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Map; -import java.util.Set; /** * ************************************************************************************************* diff --git a/src/test/java/org/owasp/webgoat/plugins/PluginTest.java b/src/test/java/org/owasp/webgoat/plugins/PluginTest.java index aac20ba77..4225a3bda 100644 --- a/src/test/java/org/owasp/webgoat/plugins/PluginTest.java +++ b/src/test/java/org/owasp/webgoat/plugins/PluginTest.java @@ -26,11 +26,11 @@ public class PluginTest { List allLines = Files.readAllLines(htmlFile, StandardCharsets.UTF_8); assertThat(allLines, - hasItem(containsString("lessons/plugin/TestPlugin/lessonSolutions/en/TestPlugin_files/image001.png"))); + hasItem(containsString("plugin/TestPlugin/lessonSolutions/en/TestPlugin_files/image001.png"))); } @Test - public void shouldNotRewriteOtherLinksStartingWithLesson_solutions() throws Exception { + public void shouldNotRewriteOtherLinks() throws Exception { Path tmpDir = PluginTestHelper.createTmpDir(); Path pluginSourcePath = PluginTestHelper.pathForLoading(); Plugin plugin = PluginTestHelper.createPluginFor(TestPlugin.class); @@ -40,6 +40,6 @@ public class PluginTest { List allLines = Files.readAllLines(htmlFile, StandardCharsets.UTF_8); assertThat(allLines, - hasItem(containsString("lesson_solutions/Unknown_files/image001.png"))); + hasItem(containsString("Unknown_files/image001.png"))); } } \ No newline at end of file diff --git a/src/test/resources/org/owasp/webgoat/plugins/lessonSolutions/rewrite_test.html b/src/test/resources/org/owasp/webgoat/plugins/lessonSolutions/rewrite_test.html index aaeb3600b..dde467046 100644 --- a/src/test/resources/org/owasp/webgoat/plugins/lessonSolutions/rewrite_test.html +++ b/src/test/resources/org/owasp/webgoat/plugins/lessonSolutions/rewrite_test.html @@ -5,7 +5,7 @@ - - + + \ No newline at end of file