Merge pull request #573 from alexarchambault/dot-scala-rights

More strict workspace dir rights checks, rename it from .scala to .scala-build

Author: alexarchambault

build.sc

@@ -13,7 +13,8 @@ import $file.project.settings, settings.{
   ScalaCliCrossSbtModule,
   ScalaCliScalafixModule,
   localRepoResourcePath,
-  platformExecutableJarExtension
+  platformExecutableJarExtension,
+  workspaceDirName
 }
 import $file.project.deps, deps.customRepositories
 
@@ -265,6 +266,8 @@ class Build(val crossScalaVersion: String)
          |  def defaultScalaVersion = "${Scala.defaultUser}"
          |  def defaultScala212Version = "${Scala.scala212}"
          |  def defaultScala213Version = "${Scala.scala213}"
+         |
+         |  def workspaceDirName = "$workspaceDirName"
          |}
          |""".stripMargin
     if (!os.isFile(dest) || os.read(dest) != code)
@@ -433,6 +436,7 @@ trait CliIntegrationBase extends SbtModule with ScalaCliPublishModule with HasTe
            |  def dockerAlpineTestImage = "${Docker.alpineTestImage}"
            |  def mostlyStaticDockerfile = "${mostlyStaticDockerfile.toString.replace("\\", "\\\\")}"
            |  def cs = "${settings.cs().replace("\\", "\\\\")}"
+           |  def workspaceDirName = "$workspaceDirName"
            |}
            |""".stripMargin
       if (!os.isFile(dest) || os.read(dest) != code)
@@ -443,10 +447,10 @@ trait CliIntegrationBase extends SbtModule with ScalaCliPublishModule with HasTe
 
     def test(args: String*) = T.command {
       val res            = super.test(args: _*)()
-      val dotScalaInRoot = os.pwd / ".scala"
+      val dotScalaInRoot = os.pwd / workspaceDirName
       assert(
         !os.isDir(dotScalaInRoot),
-        s"Expected .scala ($dotScalaInRoot) not to have been created"
+        s"Expected $workspaceDirName ($dotScalaInRoot) not to have been created"
       )
       res
     }

modules/bloop-rifle/src/main/scala/scala/build/bloop/BloopServer.scala

@@ -153,10 +153,10 @@ object BloopServer {
     val bloopInfo = ensureBloopRunning(config, threads.startServerChecks, logger)
 
     logger.debug("Opening BSP connection with bloop")
-    Files.createDirectories(workspace.resolve(".scala/.bloop"))
+    Files.createDirectories(workspace.resolve(".bloop"))
     val conn = BloopRifle.bsp(
       config,
-      workspace.resolve(".scala"),
+      workspace,
       logger
     )
     logger.debug(s"Bloop BSP connection waiting at ${conn.address}")
@@ -207,7 +207,7 @@ object BloopServer {
       clientName,
       clientVersion,
       Constants.bspVersion,
-      workspace.resolve(".scala").toUri.toASCIIString,
+      workspace.toUri.toASCIIString,
       new bsp4j.BuildClientCapabilities(List("scala", "java").asJava)
     )
     val bloopExtraParams = new BloopExtraBuildParams

modules/build/src/main/scala/scala/build/Build.scala

@@ -272,7 +272,7 @@ object Build {
         resourceFilePath <- os.walk(resourceDirPath).filter(os.isFile(_))
         relativeResourcePath = resourceFilePath.relativeTo(resourceDirPath)
         // dismiss files generated by scala-cli
-        if !relativeResourcePath.startsWith(os.rel / ".scala")
+        if !relativeResourcePath.startsWith(os.rel / Constants.workspaceDirName)
       } {
         val destPath = b.output / relativeResourcePath
         os.copy(
@@ -335,7 +335,7 @@ object Build {
   }
 
   def classesRootDir(root: os.Path, projectName: String): os.Path =
-    root / ".scala" / projectName / "classes"
+    root / Constants.workspaceDirName / projectName / "classes"
   def classesDir(root: os.Path, projectName: String, scope: Scope): os.Path =
     classesRootDir(root, projectName) / scope.name
 
@@ -380,7 +380,7 @@ object Build {
       bloopConfig,
       "scala-cli",
       Constants.version,
-      inputs.workspace.toNIO,
+      (inputs.workspace / Constants.workspaceDirName).toNIO,
       classesDir0.toNIO,
       buildClient,
       threads.bloop,
@@ -443,7 +443,7 @@ object Build {
       bloopConfig,
       "scala-cli",
       Constants.version,
-      inputs.workspace.toNIO,
+      (inputs.workspace / Constants.workspaceDirName).toNIO,
       classesDir0.toNIO,
       buildClient,
       threads.bloop,
@@ -610,7 +610,7 @@ object Build {
     value(validate(logger, options))
 
     val project = Project(
-      directory = inputs.workspace / ".scala",
+      directory = inputs.workspace / Constants.workspaceDirName,
       workspace = inputs.workspace,
       classesDir = classesDir0,
       scalaCompiler = scalaCompiler,
@@ -868,7 +868,7 @@ object Build {
     bloopServer: bloop.BloopServer
   ): Either[BuildException, Option[Build]] = either {
     val jmhProjectName = inputs.projectName + "_jmh"
-    val jmhOutputDir   = inputs.workspace / ".scala" / jmhProjectName
+    val jmhOutputDir   = inputs.workspace / Constants.workspaceDirName / jmhProjectName
     os.remove.all(jmhOutputDir)
     val jmhSourceDir   = jmhOutputDir / "sources"
     val jmhResourceDir = jmhOutputDir / "resources"

modules/build/src/main/scala/scala/build/Inputs.scala

@@ -7,8 +7,10 @@ import java.security.MessageDigest
 import java.util.zip.{ZipEntry, ZipInputStream}
 
 import scala.annotation.tailrec
+import scala.build.internal.Constants
 import scala.build.options.Scope
 import scala.build.preprocessing.ScopePath
+import scala.util.Properties
 import scala.util.matching.Regex
 
 final case class Inputs(
@@ -103,7 +105,7 @@ final case class Inputs(
     else copy(elements = elements ++ extraElements)
 
   def generatedSrcRoot(scope: Scope): os.Path =
-    workspace / ".scala" / projectName / "src_generated" / scope.name
+    workspace / Constants.workspaceDirName / projectName / "src_generated" / scope.name
 
   private def inHomeDir(directories: Directories): Inputs =
     copy(
@@ -118,9 +120,15 @@ final case class Inputs(
       if (os.exists(p)) Some(p)
       else if (p.segmentCount <= 0) None
       else existingParent(p / os.up)
+    def reallyOwnedByUser(p: os.Path): Boolean =
+      if (Properties.isWin)
+        p.toIO.canWrite() // Wondering if there's a better way to do that…
+      else
+        os.owner(p) == os.owner(os.home) &&
+        p.toIO.canWrite()
     val canWrite = existingParent(workspace)
-      .map(_.toIO.canWrite()) // Wondering if there's a better way to do that…
-      .getOrElse(true)
+      .map(reallyOwnedByUser)
+      .getOrElse(false)
     if (canWrite) this
     else inHomeDir(directories)
   }

modules/build/src/main/scala/scala/build/bsp/BspImpl.scala

@@ -317,7 +317,7 @@ final class BspImpl(
       bloopRifleConfig,
       "scala-cli",
       Constants.version,
-      inputs.workspace.toNIO,
+      (inputs.workspace / Constants.workspaceDirName).toNIO,
       classesDir.toNIO,
       localClient,
       threads.buildThreads.bloop,

modules/build/src/main/scala/scala/build/bsp/HasGeneratedSources.scala

@@ -3,6 +3,7 @@ package scala.build.bsp
 import ch.epfl.scala.{bsp4j => b}
 
 import scala.build.GeneratedSource
+import scala.build.internal.Constants
 import scala.build.options.Scope
 
 trait HasGeneratedSources {
@@ -59,6 +60,13 @@ object HasGeneratedSources {
     var targetUriOpt: Option[String] = None
   ) {
     targetUriOpt =
-      Some((bloopWorkspace / ".scala").toIO.toURI.toASCIIString.stripSuffix("/") + "/?id=" + name)
+      Some(
+        (bloopWorkspace / Constants.workspaceDirName)
+          .toIO
+          .toURI
+          .toASCIIString
+          .stripSuffix("/") +
+          "/?id=" + name
+      )
   }
 }

modules/build/src/main/scala/scala/build/options/ScalaNativeOptions.scala

@@ -21,7 +21,7 @@ final case class ScalaNativeOptions(
 ) {
 
   def nativeWorkDir(root: os.Path, projectName: String): os.Path =
-    root / ".scala" / projectName / "native"
+    root / Constants.workspaceDirName / projectName / "native"
 
   def finalVersion = version.map(_.trim).filter(_.nonEmpty).getOrElse(Constants.scalaNativeVersion)
 

modules/cli/src/main/scala/scala/cli/ScalaCli.scala

@@ -8,6 +8,7 @@ import java.io.{ByteArrayOutputStream, PrintStream}
 import java.nio.charset.StandardCharsets
 import java.nio.file.InvalidPathException
 
+import scala.build.internal.Constants
 import scala.cli.commands._
 import scala.cli.internal.Argv0
 import scala.cli.launcher.{LauncherCli, LauncherOptions}
@@ -117,7 +118,7 @@ object ScalaCli extends CommandsEntryPoint {
     catch {
       case e: Throwable if !isCI =>
         val workspace = CurrentParams.workspaceOpt.getOrElse(os.pwd)
-        val dir       = workspace / ".scala" / "stacktraces"
+        val dir       = workspace / Constants.workspaceDirName / "stacktraces"
         os.makeDir.all(dir)
         import java.time.Instant
 

modules/cli/src/main/scala/scala/cli/commands/Clean.scala

@@ -2,6 +2,7 @@ package scala.cli.commands
 
 import caseapp._
 
+import scala.build.internal.Constants
 import scala.build.{Inputs, Os}
 import scala.cli.CurrentParams
 
@@ -21,7 +22,7 @@ object Clean extends ScalaCommand[CleanOptions] {
       case Right(i) => i
     }
     CurrentParams.workspaceOpt = Some(inputs.workspace)
-    val workDir       = inputs.workspace / ".scala"
+    val workDir       = inputs.workspace / Constants.workspaceDirName
     val (_, bspEntry) = options.bspFile.bspDetails(inputs.workspace)
 
     val logger = options.logging.logger

modules/cli/src/main/scala/scala/cli/commands/SetupIde.scala

@@ -92,7 +92,8 @@ object SetupIde extends ScalaCommand[SetupIdeOptions] {
       value(downloadDeps(inputs, options.buildOptions, logger))
 
     val (bspName, bspJsonDestination) = options.bspFile.bspDetails(inputs.workspace)
-    val scalaCliBspJsonDestination    = inputs.workspace / ".scala" / "ide-options.json"
+    val scalaCliBspJsonDestination =
+      inputs.workspace / Constants.workspaceDirName / "ide-options.json"
 
     // Ensure the path to the CLI is absolute
     val absolutePathToScalaCli: String = {