Bug #13477

Take into account changes in FileUtil in Silverpeas-Core.

Author: mmoqui

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/control/SilverCrawlerSessionController.java

@@ -79,8 +79,8 @@ public class SilverCrawlerSessionController extends AbstractComponentSessionCont
   private File currentPath;
   private File rootPath;
   private List<String> paths;
-  private List<FileDetail> currentResultSearch = new ArrayList<>();
-  private SimpleDateFormat formatter = new SimpleDateFormat("yyyyMMddHHmm");
+  private final List<FileDetail> currentResultSearch = new ArrayList<>();
+  private final SimpleDateFormat formatter = new SimpleDateFormat("yyyyMMddHHmm");
   private UploadReport lastReport;
   private static final Pattern WEIRD_CHARACTERS_REGEX = Pattern.compile("[/\\\\:*?\"<>|]");
 
@@ -144,7 +144,7 @@ public void goToDirectory(String directory) {
     List<String> newPaths = new ArrayList<>();
     currentPath = rootPath;
     for (final String path : paths) {
-      currentPath = FileUtils.getFile(currentPath, FileUtil.verifyTaintedData(path));
+      currentPath = FileUtils.getFile(currentPath, FileUtil.checkTaintedData(path));
       // on ajoute ce répertoire à la liste
       newPaths.add(path);
       if (path.equals(directory)) {
@@ -158,11 +158,7 @@ public void goToDirectory(String directory) {
 
   public Boolean isDownload() {
     // retourne true si l'utilisateur peut télécharger un répertoire complet
-    boolean download = true;
-    if (getSizeMax() == 0) {
-      download = false;
-    }
-    return download;
+    return getSizeMax() != 0;
   }
 
   public Boolean isAllowedNav() {
@@ -185,7 +181,7 @@ public void setCurrentPathFromResult(String path) {
     // mise à jour de la collection des chemins
     paths.clear();
     // décomposer le chemin pour créer le path
-    while (pathFile != null && pathFile.getName().length() > 0) {
+    while (pathFile != null && !pathFile.getName().isEmpty()) {
       paths.add(pathFile.getName());
       pathFile = pathFile.getParentFile();
     }
@@ -224,8 +220,8 @@ public FolderZIPInfo zipFolder(String folderName) {
     long sizeMax = UnitUtil.convertTo(getSizeMax(), MemoryUnit.MB, MemoryUnit.B);
     zipInfo.setMaxiSize(sizeMax);
 
-    long zipSize = 0;
-    String url = "";
+    long zipSize;
+    String url;
 
     // rechercher si la taille du répertoire est < à la taille maxi
     boolean sizeOk = getSize(downloadPath.getPath(), sizeMax);
@@ -267,12 +263,12 @@ public Collection<HistoryDetail> getHistoryByUser(String folderName, String user
 
   public void unindexPath(String folderName) {
     RepositoryIndexer repositoryIndexer = new RepositoryIndexer(getSpaceId(), getComponentId());
-    Path pathRepository = Paths.get(getFullPath(FileUtil.verifyTaintedData(folderName)));
+    Path pathRepository = Paths.get(getFullPath(FileUtil.checkTaintedData(folderName)));
     repositoryIndexer.removePath(pathRepository, getUserId());
   }
 
   public void unindexFile(String fileName) {
-    Path path = Paths.get(currentPath.getPath(), FileUtil.verifyTaintedData(fileName));
+    Path path = Paths.get(currentPath.getPath(), FileUtil.checkTaintedData(fileName));
     RepositoryIndexer repositoryIndexer = new RepositoryIndexer(getSpaceId(), getComponentId());
     repositoryIndexer.removePath(path, getUserId());
   }
@@ -291,13 +287,13 @@ public void indexFile(String fileName) {
 
   public void indexPathSelected(Collection<String> dirToIndex) {
     for (final String name : dirToIndex) {
-      indexPath(FileUtil.verifyTaintedData(name));
+      indexPath(FileUtil.checkTaintedData(name));
     }
   }
 
   public void indexSelectedFiles(Collection<String> fileToIndex) {
     for (final String name : fileToIndex) {
-      indexFile(FileUtil.verifyTaintedData(name));
+      indexFile(FileUtil.checkTaintedData(name));
     }
   }
 
@@ -390,9 +386,9 @@ public boolean isReadWriteActivated() {
   }
 
   /**
-   * Activate/Desactivate read//write access.
+   * Enable/disable read//write access.
    * @param active true to activate read/write access
-   * @throws SilverCrawlerForbiddenActionException
+   * @throws SilverCrawlerForbiddenActionException if the user can change the read/write access.
    */
   public void switchReadWriteAccess(boolean active) throws SilverCrawlerForbiddenActionException {
 
@@ -480,8 +476,10 @@ private boolean checkIsAdmin(final boolean throwException,
       throws SilverCrawlerForbiddenActionException {
     if (!userRoles.contains(SilverpeasRole.ADMIN)) {
       if (throwException) {
-        throw new SilverCrawlerForbiddenActionException("userRoles: " + String.join(", ",
-            userRoles.stream().map(SilverpeasRole::getName).collect(Collectors.toList())));
+        throw new SilverCrawlerForbiddenActionException("userRoles: " +
+            userRoles.stream()
+                .map(SilverpeasRole::getName)
+                .collect(Collectors.joining(", ")));
       } else {
         return true;
       }
@@ -490,10 +488,10 @@ private boolean checkIsAdmin(final boolean throwException,
   }
 
   /**
-   * Remove given subfolder.
+   * Remove the given subfolder.
    * @param folderName name of folder to be removed
    * @param isAdmin flag to indicate if user has admin profile
-   * @throws SilverCrawlerForbiddenActionException
+   * @throws SilverCrawlerForbiddenActionException if the deletion is forbidden or cannot be done.
    */
   public void removeSubFolder(String folderName, boolean isAdmin)
       throws SilverCrawlerForbiddenActionException {
@@ -510,7 +508,7 @@ public void removeSubFolder(String folderName, boolean isAdmin)
     }
 
     // Get Full Path
-    String fullPath = getFullPath(FileUtil.verifyTaintedData(folderName));
+    String fullPath = getFullPath(FileUtil.checkTaintedData(folderName));
 
     FileFolderManager.deleteFolder(fullPath);
   }
@@ -581,7 +579,7 @@ public void removeFile(String fileName, boolean isAdminOrPublisher)
     }
 
     // Get Full Path
-    String fullPath = getFullPath(FileUtil.verifyTaintedData(fileName));
+    String fullPath = getFullPath(FileUtil.checkTaintedData(fileName));
 
     FileFolderManager.deleteFile(fullPath);
   }
@@ -637,8 +635,9 @@ public UploadReport checkLastUpload() {
   }
 
   /**
-   * Process copy from DragAndDrop temp repository to current folder
-   * @return
+   * Processes the files upload by copying the uploaded files by DragAndDrop from the temporary
+   * repository to the current folder.
+   * @return a report about the upload process.
    */
   public UploadReport processLastUpload() {
     for (UploadItem item : lastReport.items) {

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/SilverCrawlerFileServer.java

@@ -52,10 +52,6 @@
 
 import static org.silverpeas.core.web.http.FileResponse.encodeAttachmentFilenameAsUtf8;
 
-/**
- * Class declaration
- * @author
- */
 public class SilverCrawlerFileServer extends SilverpeasAuthenticatedHttpServlet {
 
   private static final long serialVersionUID = 4892517833096053490L;
@@ -73,16 +69,16 @@ public void init(ServletConfig config) {
   }
 
   @Override
-  public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException {
+  public void doGet(HttpServletRequest req, HttpServletResponse res) {
     doPost(req, res);
   }
 
   @Override
-  public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException {
-    String sourceFile = FileUtil.verifyTaintedData(req.getParameter("SourceFile"));
+  public void doPost(HttpServletRequest req, HttpServletResponse res) {
+    String sourceFile = FileUtil.checkTaintedData(req.getParameter("SourceFile"));
     String componentId = req.getParameter("ComponentId");
     String typeUpload = req.getParameter("TypeUpload");
-    String path = FileUtil.verifyTaintedData(req.getParameter("Path"));
+    String path = FileUtil.checkTaintedData(req.getParameter("Path"));
 
     try {
       FileUtil.assertPathNotRelative(sourceFile);
@@ -125,12 +121,11 @@ public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOExc
     }
 
     sendFile(res, fileToSend);
-
     // ajout dans la table des téléchargements
     Statistic.addStat(userId, fileStat, componentId, type);
   }
 
-  private void sendFile(HttpServletResponse response, File file) throws IOException {
+  private void sendFile(HttpServletResponse response, File file) {
     response.setHeader("Content-Length", String.valueOf(file.length()));
     final String normalizedFilename = StringUtil.normalize(file.getName());
     response.setContentType(FileUtil.getMimeType(normalizedFilename));
@@ -145,7 +140,7 @@ private void sendFile(HttpServletResponse response, File file) throws IOExceptio
     }
   }
 
-  private void displayWarningHtmlCode(HttpServletResponse res) throws IOException {
+  private void displayWarningHtmlCode(HttpServletResponse res) {
     LocalizationBundle messages = ResourceLocator.getLocalizationBundle(
         "org.silverpeas.util.peasUtil.multiLang.fileServerBundle");
 

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/CreateFolderHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves parameters
-    String newName = FileUtil.verifyTaintedData(request.getParameter("newName"));
+    String newName = FileUtil.checkTaintedData(request.getParameter("newName"));
 
     // Is User has admin profile
     String userHisghestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/DownloadFolderHandler.java

@@ -39,7 +39,7 @@ public class DownloadFolderHandler extends FunctionHandler {
   public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
     // Get requested folder name
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("FolderName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("FolderName"));
 
     // Store objects in request as attributes
     request.setAttribute("ZipInfo", sessionController.zipFolder(folderName));

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/GoToDirectoryHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Update current Path
-    String newPath = FileUtil.verifyTaintedData(request.getParameter("DirectoryPath"));
+    String newPath = FileUtil.checkTaintedData(request.getParameter("DirectoryPath"));
     sessionController.goToDirectory(newPath);
 
     // redirect to "ViewDirectory" use case

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/IndexPathHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Index requested path
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("FolderName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("FolderName"));
     sessionController.indexPath(folderName);
 
     // redirect to "ViewDirectory" use case

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RemoveFileHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieving files name to be removed
-    String fileName = FileUtil.verifyTaintedData(request.getParameter("FileName"));
+    String fileName = FileUtil.checkTaintedData(request.getParameter("FileName"));
 
     // Is User has admin or publisher profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RemoveFolderHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves folder's name to be removed
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("FolderName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("FolderName"));
 
     // Is User has admin profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RenameFileFormHandler.java

@@ -41,7 +41,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves folder's name to be removed
-    String fileName = FileUtil.verifyTaintedData(request.getParameter("oldName"));
+    String fileName = FileUtil.checkTaintedData(request.getParameter("oldName"));
 
     // Is User has admin or publisher profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RenameFileHandler.java

@@ -40,8 +40,8 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves parameters
-    String fileName = FileUtil.verifyTaintedData(request.getParameter("oldName"));
-    String newName = FileUtil.verifyTaintedData(request.getParameter("newName"));
+    String fileName = FileUtil.checkTaintedData(request.getParameter("oldName"));
+    String newName = FileUtil.checkTaintedData(request.getParameter("newName"));
 
     // Is User has admin or publisher profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RenameFolderFormHandler.java

@@ -41,7 +41,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves folder's name to be removed
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("oldName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("oldName"));
 
     // Is User has admin profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/RenameFolderHandler.java

@@ -40,8 +40,8 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieves parameters
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("oldName"));
-    String newName = FileUtil.verifyTaintedData(request.getParameter("newName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("oldName"));
+    String newName = FileUtil.checkTaintedData(request.getParameter("newName"));
 
     // Is User has admin profile
     String userHighestRole = getUserHighestRole(sessionController);

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/SearchHandler.java

@@ -42,7 +42,7 @@ public class SearchHandler extends FunctionHandler {
   public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
-    String searchResult = FileUtil.verifyTaintedData(request.getParameter("Id"));
+    String searchResult = FileUtil.checkTaintedData(request.getParameter("Id"));
     if (StringUtil.isDefined(searchResult)) {
       sessionController.setCurrentPathFromResult(searchResult);
       // Go back to main page

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/SubDirectoryFromResultHandler.java

@@ -39,7 +39,7 @@ public class SubDirectoryFromResultHandler extends FunctionHandler {
   public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
     // Update current Path
-    String newPath = FileUtil.verifyTaintedData(request.getParameter("DirectoryPath"));
+    String newPath = FileUtil.checkTaintedData(request.getParameter("DirectoryPath"));
     sessionController.setCurrentPathFromResult(newPath);
 
     // redirect to "ViewDirectory" use case

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/SubDirectoryHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Update current Path
-    String newPath = FileUtil.verifyTaintedData(request.getParameter("DirectoryPath"));
+    String newPath = FileUtil.checkTaintedData(request.getParameter("DirectoryPath"));
     sessionController.setCurrentPath(newPath);
 
     // redirect to "ViewDirectory" use case

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/ViewDownloadHistoryFromResultHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieve requested path
-    String fullPath = FileUtil.verifyTaintedData(request.getParameter("Name"));
+    String fullPath = FileUtil.checkTaintedData(request.getParameter("Name"));
 
     // stores objects as request attributes
     request.setAttribute("Downloads", sessionController.getHistoryByFolderFromResult(fullPath));

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/ViewDownloadHistoryHandler.java

@@ -40,7 +40,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
       HttpServletRequest request) throws Exception {
 
     // Retrieve requested name
-    String name = FileUtil.verifyTaintedData(request.getParameter("Name"));
+    String name = FileUtil.checkTaintedData(request.getParameter("Name"));
 
     // stores objects as request attributes
     request.setAttribute("Downloads", sessionController.getHistoryByFolder(name));

silverCrawler/silverCrawler-war/src/main/java/org/silverpeas/components/silvercrawler/servlets/handlers/ViewHistoryByUserHandler.java

@@ -42,7 +42,7 @@ public String getDestination(SilverCrawlerSessionController sessionController,
     // Retrieve parameters
     String userId = request.getParameter("UserId");
     String userName = request.getParameter("UserName");
-    String folderName = FileUtil.verifyTaintedData(request.getParameter("FolderName"));
+    String folderName = FileUtil.checkTaintedData(request.getParameter("FolderName"));
 
     // stores objects as request attributes
     request.setAttribute("DownloadsByUser", sessionController.getHistoryByUser(folderName, userId));