/* * SonarQube * Copyright (C) 2009-2024 SonarSource SA * mailto:info AT sonarsource DOT com * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 3 of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ package org.sonar.scanner.bootstrap; import org.apache.commons.lang.StringUtils; import org.sonar.api.CoreProperties; import org.sonar.api.impl.utils.DefaultTempFolder; import org.sonar.api.utils.System2; import org.sonar.api.utils.TempFolder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import static org.sonar.core.util.FileUtils.deleteQuietly; import org.springframework.context.annotation.Bean; 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.attribute.BasicFileAttributes; import java.util.concurrent.TimeUnit; public class GlobalTempFolderProvider { private static final Logger LOG = LoggerFactory.getLogger(GlobalTempFolderProvider.class); private static final long CLEAN_MAX_AGE = TimeUnit.DAYS.toMillis(21); static final String TMP_NAME_PREFIX = ".sonartmp_"; private System2 system; public GlobalTempFolderProvider() { this(new System2()); } GlobalTempFolderProvider(System2 system) { this.system = system; } @Bean("GlobalTempFolder") public TempFolder provide(ScannerProperties scannerProps) { String workingPathName = StringUtils.defaultIfBlank(scannerProps.property(CoreProperties.GLOBAL_WORKING_DIRECTORY), CoreProperties.GLOBAL_WORKING_DIRECTORY_DEFAULT_VALUE); Path workingPath = Paths.get(workingPathName); if (!workingPath.isAbsolute()) { Path home = findSonarHome(scannerProps); workingPath = home.resolve(workingPath).normalize(); } try { cleanTempFolders(workingPath); } catch (IOException e) { LOG.error(String.format("failed to clean global working directory: %s", workingPath), e); } Path tempDir = createTempFolder(workingPath); return new DefaultTempFolder(tempDir.toFile(), true); } private static Path createTempFolder(Path workingPath) { try { Path realPath = workingPath; if (Files.isSymbolicLink(realPath)) { realPath = realPath.toRealPath(); } Files.createDirectories(realPath); } catch (IOException e) { throw new IllegalStateException("Failed to create working path: " + workingPath, e); } try { return Files.createTempDirectory(workingPath, TMP_NAME_PREFIX); } catch (IOException e) { throw new IllegalStateException("Failed to create temporary folder in " + workingPath, e); } } private Path findSonarHome(ScannerProperties props) { String home = props.property("sonar.userHome"); if (home != null) { return Paths.get(home).toAbsolutePath(); } home = system.envVariable("SONAR_USER_HOME"); if (home != null) { return Paths.get(home).toAbsolutePath(); } home = system.property("user.home"); return Paths.get(home, ".sonar").toAbsolutePath(); } private static void cleanTempFolders(Path path) throws IOException { if (path.toFile().exists()) { try (DirectoryStream stream = Files.newDirectoryStream(path, new CleanFilter())) { for (Path p : stream) { deleteQuietly(p.toFile()); } } } } private static class CleanFilter implements DirectoryStream.Filter { @Override public boolean accept(Path path) throws IOException { if (!path.toFile().exists()) { return false; } if (!path.getFileName().toString().startsWith(TMP_NAME_PREFIX)) { return false; } long threshold = System.currentTimeMillis() - CLEAN_MAX_AGE; // we could also check the timestamp in the name, instead BasicFileAttributes attrs; try { attrs = Files.readAttributes(path, BasicFileAttributes.class); } catch (IOException ioe) { LOG.error(String.format("Couldn't read file attributes for %s : ", path), ioe); return false; } long creationTime = attrs.creationTime().toMillis(); return creationTime < threshold; } } }