-
Notifications
You must be signed in to change notification settings - Fork 841
/
Config.hs
1285 lines (1229 loc) · 51.7 KB
/
Config.hs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedRecordDot #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TypeFamilies #-}
-- | The general Stack configuration that starts everything off. This should be
-- smart to fallback if there is no stack.yaml, instead relying on whatever
-- files are available.
--
-- If there is no stack.yaml, and there is a cabal.config, we read in those
-- constraints, and if there's a cabal.sandbox.config, we read any constraints
-- from there and also find the package database from there, etc. And if there's
-- nothing, we should probably default to behaving like cabal, possibly with
-- spitting out a warning that "you should run `stk init` to make things
-- better".
module Stack.Config
( loadConfig
, loadConfigYaml
, packagesParser
, getImplicitGlobalProjectDir
, getSnapshots
, makeConcreteSnapshot
, getRawSnapshot
, checkOwnership
, getInContainer
, getInNixShell
, defaultConfigYaml
, getProjectConfig
, withBuildConfig
, withNewLogFunc
, determineStackRootAndOwnership
) where
import Control.Monad.Extra ( firstJustM )
import Data.Aeson.Types ( Value )
import Data.Aeson.WarningParser
( WithJSONWarnings (..), logJSONWarnings )
import Data.Array.IArray ( (!), (//) )
import qualified Data.ByteString as S
import Data.ByteString.Builder ( byteString )
import Data.Coerce ( coerce )
import qualified Data.Either.Extra as EE
import qualified Data.IntMap as IntMap
import qualified Data.Map as Map
import qualified Data.Map.Merge.Strict as MS
import qualified Data.Monoid
import Data.Monoid.Map ( MonoidMap (..) )
import qualified Data.Set as Set
import qualified Data.Text as T
import qualified Data.Yaml as Yaml
import qualified Distribution.PackageDescription as PD
import Distribution.System
( Arch (..), OS (..), Platform (..), buildPlatform )
import qualified Distribution.Text ( simpleParse )
import Distribution.Version ( simplifyVersionRange )
import qualified Hpack
import GHC.Conc ( getNumProcessors )
import Network.HTTP.StackClient
( httpJSON, parseUrlThrow, getResponseBody )
import Options.Applicative ( Parser, help, long, metavar, strOption )
import Pantry ( loadSnapshot )
import Path
( PathException (..), (</>), parent, parseAbsDir
, parseAbsFile, parseRelDir, stripProperPrefix
)
import Path.Extra ( toFilePathNoTrailingSep )
import Path.Find ( findInParents )
import Path.IO
( XdgDirectory (..), canonicalizePath, doesFileExist
, ensureDir, forgivingAbsence, getAppUserDataDir
, getCurrentDir, getXdgDir, resolveDir, resolveDir'
, resolveFile, resolveFile'
)
import RIO.List ( unzip, intersperse )
import RIO.Process
( HasProcessContext (..), ProcessContext, augmentPathMap
, envVarsL
, mkProcessContext
)
import RIO.Time ( toGregorian )
import Stack.Build.Haddock ( shouldHaddockDeps )
import Stack.Config.Build ( buildOptsFromMonoid )
import Stack.Config.Docker ( dockerOptsFromMonoid )
import Stack.Config.Nix ( nixOptsFromMonoid )
import Stack.Constants
( defaultGlobalConfigPath, defaultUserConfigPath
, implicitGlobalProjectDir, inContainerEnvVar
, inNixShellEnvVar, osIsWindows, pantryRootEnvVar
, platformVariantEnvVar, relDirBin, relDirStackWork
, relFileReadmeTxt, relFileStorage, relDirPantry
, relDirPrograms, relDirStackProgName, relDirUpperPrograms
, stackDeveloperModeDefault, stackDotYaml, stackProgName
, stackRootEnvVar, stackWorkEnvVar, stackXdgEnvVar
)
import qualified Stack.Constants as Constants
import Stack.Lock ( lockCachedWanted )
import Stack.Prelude
import Stack.SourceMap ( additionalDepPackage, mkProjectPackage )
import Stack.Storage.Project ( initProjectStorage )
import Stack.Storage.User ( initUserStorage )
import Stack.Storage.Util ( handleMigrationException )
import Stack.Types.AllowNewerDeps ( AllowNewerDeps (..) )
import Stack.Types.ApplyGhcOptions ( ApplyGhcOptions (..) )
import Stack.Types.ApplyProgOptions ( ApplyProgOptions (..) )
import Stack.Types.Build.Exception
( BuildException (..), BuildPrettyException (..) )
import Stack.Types.BuildConfig ( BuildConfig (..) )
import Stack.Types.BuildOpts ( BuildOpts (..) )
import Stack.Types.ColorWhen ( ColorWhen (..) )
import Stack.Types.Compiler ( defaultCompilerRepository )
import Stack.Types.Config
( Config (..), HasConfig (..), askLatestSnapshotUrl
, configProjectRoot, stackRootL, workDirL
)
import Stack.Types.Config.Exception
( ConfigException (..), ConfigPrettyException (..)
, ParseAbsolutePathException (..)
)
import Stack.Types.ConfigMonoid
( ConfigMonoid (..), parseConfigMonoid )
import Stack.Types.Casa ( CasaOptsMonoid (..) )
import Stack.Types.Docker ( DockerOpts (..), DockerOptsMonoid (..) )
import Stack.Types.DumpLogs ( DumpLogs (..) )
import Stack.Types.GlobalOpts ( GlobalOpts (..) )
import Stack.Types.MsysEnvironment
( MsysEnvironment (..), msysEnvArch )
import Stack.Types.Nix ( NixOpts (..) )
import Stack.Types.Platform
( PlatformVariant (..), platformOnlyRelDir )
import Stack.Types.Project ( Project (..) )
import qualified Stack.Types.Project as Project ( Project (..) )
import Stack.Types.ProjectAndConfigMonoid
( ProjectAndConfigMonoid (..), parseProjectAndConfigMonoid )
import Stack.Types.ProjectConfig ( ProjectConfig (..) )
import Stack.Types.PvpBounds ( PvpBounds (..), PvpBoundsType (..) )
import Stack.Types.Runner
( HasRunner (..), Runner (..), globalOptsL, terminalL )
import Stack.Types.Snapshot ( AbstractSnapshot (..), Snapshots (..) )
import Stack.Types.SourceMap
( CommonPackage (..), DepPackage (..), ProjectPackage (..)
, SMWanted (..)
)
import Stack.Types.StackYamlLoc ( StackYamlLoc (..) )
import Stack.Types.UnusedFlags ( FlagSource (..), UnusedFlags (..) )
import Stack.Types.Version
( IntersectingVersionRange (..), VersionCheck (..)
, stackVersion, withinRange
)
import System.Console.ANSI ( hNowSupportsANSI, setSGRCode )
import System.Environment ( getEnvironment, lookupEnv )
import System.Info.ShortPathName ( getShortPathName )
import System.PosixCompat.Files ( fileOwner, getFileStatus )
import System.Posix.User ( getEffectiveUserID )
-- | Get the location of the implicit global project directory.
getImplicitGlobalProjectDir :: HasConfig env => RIO env (Path Abs Dir)
getImplicitGlobalProjectDir = view $ stackRootL . to implicitGlobalProjectDir
-- | Download the 'Snapshots' value from stackage.org.
getSnapshots :: HasConfig env => RIO env Snapshots
getSnapshots = do
latestUrlText <- askLatestSnapshotUrl
latestUrl <- parseUrlThrow (T.unpack latestUrlText)
logDebug $ "Downloading snapshot versions file from " <> display latestUrlText
result <- httpJSON latestUrl
logDebug "Done downloading and parsing snapshot versions file"
pure $ getResponseBody result
-- | Turn an 'AbstractSnapshot' into a 'RawSnapshotLocation'.
makeConcreteSnapshot ::
HasConfig env
=> AbstractSnapshot
-> RIO env RawSnapshotLocation
makeConcreteSnapshot (ASSnapshot s) = pure s
makeConcreteSnapshot as = do
s <-
case as of
ASGlobal -> do
fp <- getImplicitGlobalProjectDir <&> (</> stackDotYaml)
iopc <- loadConfigYaml (parseProjectAndConfigMonoid (parent fp)) fp
ProjectAndConfigMonoid project _ <- liftIO iopc
pure project.snapshot
ASLatestNightly ->
RSLSynonym . Nightly . (.nightly) <$> getSnapshots
ASLatestLTSMajor x -> do
snapshots <- getSnapshots
case IntMap.lookup x snapshots.lts of
Nothing -> throwIO $ NoLTSWithMajorVersion x
Just y -> pure $ RSLSynonym $ LTS x y
ASLatestLTS -> do
snapshots <- getSnapshots
if IntMap.null snapshots.lts
then throwIO NoLTSFound
else let (x, y) = IntMap.findMax snapshots.lts
in pure $ RSLSynonym $ LTS x y
prettyInfoL
[ flow "Selected snapshot:"
, style Current (fromString $ T.unpack $ textDisplay s) <> "."
]
pure s
-- | Get the raw snapshot from the global options.
getRawSnapshot :: HasConfig env => RIO env (Maybe RawSnapshot)
getRawSnapshot = do
mASnapshot <- view $ globalOptsL . to (.snapshot)
forM mASnapshot $ \aSnapshot -> do
concrete <- makeConcreteSnapshot aSnapshot
loc <- completeSnapshotLocation concrete
loadSnapshot loc
-- | Get the latest snapshot available.
getLatestSnapshot :: HasConfig env => RIO env RawSnapshotLocation
getLatestSnapshot = do
snapshots <- getSnapshots
let mlts = uncurry LTS <$>
listToMaybe (reverse (IntMap.toList snapshots.lts))
pure $ RSLSynonym $ fromMaybe (Nightly snapshots.nightly) mlts
-- Interprets ConfigMonoid options.
configFromConfigMonoid ::
(HasRunner env, HasTerm env)
=> Path Abs Dir -- ^ Stack root, e.g. ~/.stack
-> Path Abs File
-- ^ User-specific global configuration file.
-> Maybe AbstractSnapshot
-> ProjectConfig (Project, Path Abs File)
-> ConfigMonoid
-> (Config -> RIO env a)
-> RIO env a
configFromConfigMonoid
stackRoot
userGlobalConfigFile
snapshot
project
configMonoid
inner
= do
-- If --stack-work is passed, prefer it. Otherwise, if STACK_WORK
-- is set, use that. If neither, use the default ".stack-work"
mstackWorkEnv <- liftIO $ lookupEnv stackWorkEnvVar
let mproject =
case project of
PCProject pair -> Just pair
PCGlobalProject -> Nothing
PCNoProject _deps -> Nothing
allowLocals =
case project of
PCProject _ -> True
PCGlobalProject -> True
PCNoProject _ -> False
configWorkDir0 <-
let parseStackWorkEnv x =
catch
(parseRelDir x)
( \e -> case e of
InvalidRelDir _ ->
prettyThrowIO $ StackWorkEnvNotRelativeDir x
_ -> throwIO e
)
in maybe (pure relDirStackWork) (liftIO . parseStackWorkEnv) mstackWorkEnv
let workDir = fromFirst configWorkDir0 configMonoid.workDir
-- The history of the URL below is as follows:
--
-- * Before Stack 1.3.0 it was
-- https://www.stackage.org/download/snapshots.json.
-- * From Stack 1.3.0 to 2.15.3 it was
-- https://s3.amazonaws.com/haddock.stackage.org/snapshots.json. The
-- change was made because S3 was expected to have greater uptime than
-- stackage.org.
-- * In early 2024, the Stackage project was handed over to the Haskell
-- Foundation. Following that handover, the URL below was considered
-- the most reliable source of the file in question.
latestSnapshot = fromFirst
"https://stackage-haddock.haskell.org/snapshots.json"
configMonoid.latestSnapshot
clConnectionCount = fromFirst 8 configMonoid.connectionCount
hideTHLoading = fromFirstTrue configMonoid.hideTHLoading
prefixTimestamps = fromFirst False configMonoid.prefixTimestamps
ghcVariant = getFirst configMonoid.ghcVariant
compilerRepository = fromFirst
defaultCompilerRepository
configMonoid.compilerRepository
ghcBuild = getFirst configMonoid.ghcBuild
installGHC = fromFirstTrue configMonoid.installGHC
skipGHCCheck = fromFirstFalse configMonoid.skipGHCCheck
skipMsys = fromFirstFalse configMonoid.skipMsys
defMsysEnvironment = case platform of
Platform I386 Windows -> Just MINGW32
Platform X86_64 Windows -> Just MINGW64
_ -> Nothing
extraIncludeDirs = configMonoid.extraIncludeDirs
extraLibDirs = configMonoid.extraLibDirs
customPreprocessorExts = configMonoid.customPreprocessorExts
overrideGccPath = getFirst configMonoid.overrideGccPath
-- Only place in the codebase where platform is hard-coded. In theory in
-- the future, allow it to be configured.
(Platform defArch defOS) = buildPlatform
arch = fromMaybe defArch
$ getFirst configMonoid.arch >>= Distribution.Text.simpleParse
os = defOS
platform = Platform arch os
requireStackVersion = simplifyVersionRange
configMonoid.requireStackVersion.intersectingVersionRange
compilerCheck = fromFirst MatchMinor configMonoid.compilerCheck
msysEnvironment <- case defMsysEnvironment of
-- Ignore the configuration setting if there is no default for the
-- platform.
Nothing -> pure Nothing
Just defMsysEnv -> do
let msysEnv = fromFirst defMsysEnv configMonoid.msysEnvironment
if msysEnvArch msysEnv == arch
then pure $ Just msysEnv
else prettyThrowM $ BadMsysEnvironment msysEnv arch
platformVariant <- liftIO $
maybe PlatformVariantNone PlatformVariant <$> lookupEnv platformVariantEnvVar
let build = buildOptsFromMonoid configMonoid.buildOpts
docker <-
dockerOptsFromMonoid (fmap fst mproject) snapshot configMonoid.dockerOpts
nix <- nixOptsFromMonoid configMonoid.nixOpts os
systemGHC <-
case (getFirst configMonoid.systemGHC, nix.enable) of
(Just False, True) ->
throwM NixRequiresSystemGhc
_ ->
pure
(fromFirst
(docker.enable || nix.enable)
configMonoid.systemGHC)
when (isJust ghcVariant && systemGHC) $
throwM ManualGHCVariantSettingsAreIncompatibleWithSystemGHC
rawEnv <- liftIO getEnvironment
pathsEnv <- either throwM pure
$ augmentPathMap (map toFilePath configMonoid.extraPath)
(Map.fromList (map (T.pack *** T.pack) rawEnv))
origEnv <- mkProcessContext pathsEnv
let processContextSettings _ = pure origEnv
localProgramsBase <- case getFirst configMonoid.localProgramsBase of
Nothing -> getDefaultLocalProgramsBase stackRoot platform origEnv
Just path -> pure path
let localProgramsFilePath = toFilePath localProgramsBase
when (osIsWindows && ' ' `elem` localProgramsFilePath) $ do
ensureDir localProgramsBase
-- getShortPathName returns the long path name when a short name does not
-- exist.
shortLocalProgramsFilePath <-
liftIO $ getShortPathName localProgramsFilePath
prettyWarn $
"[S-8432]"
<> line
<> fillSep
( [ flow "Stack's 'programs' path is"
, style File (fromString localProgramsFilePath) <> "."
, flow "It contains a space character. This will prevent \
\building with GHC 9.4.1 or later."
]
<> [ flow "It also has no alternative short ('8 dot 3') name. \
\This will cause problems with packages that use the \
\GNU project's 'configure' shell script."
| ' ' `elem` shortLocalProgramsFilePath
]
)
<> blankLine
<> fillSep
[ flow "To avoid sucn problems, use the"
, style Shell "local-programs-path"
, flow "non-project specific configuration option to specify an \
\alternative space-free path."
]
<> line
platformOnlyDir <-
runReaderT platformOnlyRelDir (platform, platformVariant)
let localPrograms = localProgramsBase </> platformOnlyDir
localBin <-
case getFirst configMonoid.localBinPath of
Nothing -> do
localDir <- getAppUserDataDir "local"
pure $ localDir </> relDirBin
Just userPath ->
(case mproject of
-- Not in a project
Nothing -> resolveDir' userPath
-- Resolves to the project dir and appends the user path if it is
-- relative
Just (_, configYaml) -> resolveDir (parent configYaml) userPath)
-- TODO: Either catch specific exceptions or add a
-- parseRelAsAbsDirMaybe utility and use it along with
-- resolveDirMaybe.
`catchAny`
const (throwIO (NoSuchDirectory userPath))
fileWatchHook <-
case getFirst configMonoid.fileWatchHook of
Nothing -> pure Nothing
Just userPath ->
( case mproject of
-- Not in a project
Nothing -> Just <$> resolveFile' userPath
-- Resolves to the project dir and appends the user path if it is
-- relative
Just (_, configYaml) ->
Just <$> resolveFile (parent configYaml) userPath
)
-- TODO: Either catch specific exceptions or add a
-- parseRelAsAbsFileMaybe utility and use it along with
-- resolveFileMaybe.
`catchAny`
const (throwIO (NoSuchFile userPath))
jobs <-
case getFirst configMonoid.jobs of
Nothing -> liftIO getNumProcessors
Just i -> pure i
let concurrentTests =
fromFirst True configMonoid.concurrentTests
templateParams = configMonoid.templateParameters
scmInit = getFirst configMonoid.scmInit
cabalConfigOpts = coerce configMonoid.cabalConfigOpts
ghcOptionsByName = coerce configMonoid.ghcOptionsByName
ghcOptionsByCat = coerce configMonoid.ghcOptionsByCat
setupInfoLocations = configMonoid.setupInfoLocations
setupInfoInline = configMonoid.setupInfoInline
pvpBounds =
fromFirst (PvpBounds PvpBoundsNone False) configMonoid.pvpBounds
modifyCodePage = fromFirstTrue configMonoid.modifyCodePage
rebuildGhcOptions =
fromFirstFalse configMonoid.rebuildGhcOptions
applyGhcOptions =
fromFirst AGOLocals configMonoid.applyGhcOptions
applyProgOptions =
fromFirst APOLocals configMonoid.applyProgOptions
allowNewer = configMonoid.allowNewer
allowNewerDeps = coerce configMonoid.allowNewerDeps
defaultInitSnapshot <- do
root <- getCurrentDir
let resolve = (First <$>) . traverse (resolvePaths (Just root)) . getFirst
resolve configMonoid.defaultInitSnapshot
let defaultTemplate = getFirst configMonoid.defaultTemplate
dumpLogs = fromFirst DumpWarningLogs configMonoid.dumpLogs
saveHackageCreds = configMonoid.saveHackageCreds
hackageBaseUrl =
fromFirst Constants.hackageBaseUrl configMonoid.hackageBaseUrl
hideSourcePaths = fromFirstTrue configMonoid.hideSourcePaths
recommendStackUpgrade = fromFirstTrue configMonoid.recommendStackUpgrade
notifyIfNixOnPath = fromFirstTrue configMonoid.notifyIfNixOnPath
notifyIfGhcUntested = fromFirstTrue configMonoid.notifyIfGhcUntested
notifyIfCabalUntested = fromFirstTrue configMonoid.notifyIfCabalUntested
notifyIfArchUnknown = fromFirstTrue configMonoid.notifyIfArchUnknown
notifyIfNoRunTests = fromFirstTrue configMonoid.notifyIfNoRunTests
notifyIfNoRunBenchmarks =
fromFirstTrue configMonoid.notifyIfNoRunBenchmarks
noRunCompile = fromFirstFalse configMonoid.noRunCompile
allowDifferentUser <-
case getFirst configMonoid.allowDifferentUser of
Just True -> pure True
_ -> getInContainer
configRunner' <- view runnerL
useAnsi <- liftIO $ hNowSupportsANSI stderr
let stylesUpdate' = (configRunner' ^. stylesUpdateL) <>
configMonoid.styles
useColor' = configRunner'.useColor
mUseColor = do
colorWhen <- getFirst configMonoid.colorWhen
pure $ case colorWhen of
ColorNever -> False
ColorAlways -> True
ColorAuto -> useAnsi
useColor'' = fromMaybe useColor' mUseColor
configRunner'' = configRunner'
& processContextL .~ origEnv
& stylesUpdateL .~ stylesUpdate'
& useColorL .~ useColor''
go = configRunner'.globalOpts
pic = fromFirst defaultPackageIndexConfig configMonoid.packageIndex
mpantryRoot <- liftIO $ lookupEnv pantryRootEnvVar
pantryRoot <-
case mpantryRoot of
Just dir ->
case parseAbsDir dir of
Nothing -> throwIO $ ParseAbsolutePathException pantryRootEnvVar dir
Just x -> pure x
Nothing -> pure $ stackRoot </> relDirPantry
let snapLoc =
case getFirst configMonoid.snapshotLocation of
Nothing -> defaultSnapshotLocation
Just addr ->
customSnapshotLocation
where
customSnapshotLocation (LTS x y) =
mkRSLUrl $ addr'
<> "/lts/" <> display x
<> "/" <> display y <> ".yaml"
customSnapshotLocation (Nightly date) =
let (year, month, day) = toGregorian date
in mkRSLUrl $ addr'
<> "/nightly/"
<> display year
<> "/" <> display month
<> "/" <> display day <> ".yaml"
mkRSLUrl builder = RSLUrl (utf8BuilderToText builder) Nothing
addr' = display $ T.dropWhileEnd (=='/') addr
globalHintsLoc <- case getFirst configMonoid.globalHintsLocation of
Nothing -> pure defaultGlobalHintsLocation
Just unresolverGlobalHintsLoc -> do
resolvedGlobalHintsLocation <-
resolvePaths (Just stackRoot) unresolverGlobalHintsLoc
pure $ const resolvedGlobalHintsLocation
let stackDeveloperMode = fromFirst
stackDeveloperModeDefault
configMonoid.stackDeveloperMode
hpackForce = if fromFirstFalse configMonoid.hpackForce
then Hpack.Force
else Hpack.NoForce
casa =
if fromFirstTrue configMonoid.casaOpts.enable
then
let casaRepoPrefix = fromFirst
(fromFirst defaultCasaRepoPrefix configMonoid.casaRepoPrefix)
configMonoid.casaOpts.repoPrefix
casaMaxKeysPerRequest = fromFirst
defaultCasaMaxPerRequest
configMonoid.casaOpts.maxKeysPerRequest
in Just (casaRepoPrefix, casaMaxKeysPerRequest)
else Nothing
withNewLogFunc go useColor'' stylesUpdate' $ \logFunc -> do
let runner = configRunner'' & logFuncL .~ logFunc
withLocalLogFunc logFunc $ handleMigrationException $ do
logDebug $ case casa of
Nothing -> "Use of Casa server disabled."
Just (repoPrefix, maxKeys) ->
"Use of Casa server enabled: ("
<> fromString (show repoPrefix)
<> ", "
<> fromString (show maxKeys)
<> ")."
withPantryConfig'
pantryRoot
pic
(maybe HpackBundled HpackCommand $ getFirst configMonoid.overrideHpack)
hpackForce
clConnectionCount
casa
snapLoc
globalHintsLoc
(\pantryConfig -> initUserStorage
(stackRoot </> relFileStorage)
( \userStorage -> inner Config
{ workDir
, userGlobalConfigFile
, build
, docker
, nix
, processContextSettings
, localProgramsBase
, localPrograms
, hideTHLoading
, prefixTimestamps
, platform
, platformVariant
, ghcVariant
, ghcBuild
, latestSnapshot
, systemGHC
, installGHC
, skipGHCCheck
, skipMsys
, msysEnvironment
, compilerCheck
, compilerRepository
, localBin
, fileWatchHook
, requireStackVersion
, jobs
, overrideGccPath
, extraIncludeDirs
, extraLibDirs
, customPreprocessorExts
, concurrentTests
, templateParams
, scmInit
, ghcOptionsByName
, ghcOptionsByCat
, cabalConfigOpts
, setupInfoLocations
, setupInfoInline
, pvpBounds
, modifyCodePage
, rebuildGhcOptions
, applyGhcOptions
, applyProgOptions
, allowNewer
, allowNewerDeps
, defaultInitSnapshot
, defaultTemplate
, allowDifferentUser
, dumpLogs
, project
, allowLocals
, saveHackageCreds
, hackageBaseUrl
, runner
, pantryConfig
, stackRoot
, snapshot
, userStorage
, hideSourcePaths
, recommendStackUpgrade
, notifyIfNixOnPath
, notifyIfGhcUntested
, notifyIfCabalUntested
, notifyIfArchUnknown
, notifyIfNoRunTests
, notifyIfNoRunBenchmarks
, noRunCompile
, stackDeveloperMode
, casa
}
)
)
-- | Runs the provided action with the given 'LogFunc' in the environment
withLocalLogFunc :: HasLogFunc env => LogFunc -> RIO env a -> RIO env a
withLocalLogFunc logFunc = local (set logFuncL logFunc)
-- | Runs the provided action with a new 'LogFunc', given a 'StylesUpdate'.
withNewLogFunc :: MonadUnliftIO m
=> GlobalOpts
-> Bool -- ^ Use color
-> StylesUpdate
-> (LogFunc -> m a)
-> m a
withNewLogFunc go useColor (StylesUpdate update) inner = do
logOptions0 <- logOptionsHandle stderr False
let logOptions
= setLogUseColor useColor
$ setLogLevelColors logLevelColors
$ setLogSecondaryColor secondaryColor
$ setLogAccentColors (const highlightColor)
$ setLogUseTime go.timeInLog
$ setLogMinLevel go.logLevel
$ setLogVerboseFormat (go.logLevel <= LevelDebug)
$ setLogTerminal go.terminal
logOptions0
withLogFunc logOptions inner
where
styles = defaultStyles // update
logLevelColors :: LogLevel -> Utf8Builder
logLevelColors level =
fromString $ setSGRCode $ snd $ styles ! logLevelToStyle level
secondaryColor = fromString $ setSGRCode $ snd $ styles ! Secondary
highlightColor = fromString $ setSGRCode $ snd $ styles ! Highlight
-- | Get the default location of the local programs directory.
getDefaultLocalProgramsBase :: MonadThrow m
=> Path Abs Dir
-> Platform
-> ProcessContext
-> m (Path Abs Dir)
getDefaultLocalProgramsBase configStackRoot configPlatform override =
case configPlatform of
-- For historical reasons, on Windows a subdirectory of LOCALAPPDATA is
-- used instead of a subdirectory of STACK_ROOT. Unifying the defaults would
-- mean that Windows users would manually have to move data from the old
-- location to the new one, which is undesirable.
Platform _ Windows -> do
let envVars = view envVarsL override
case T.unpack <$> Map.lookup "LOCALAPPDATA" envVars of
Just t -> case parseAbsDir t of
Nothing ->
throwM $ ParseAbsolutePathException "LOCALAPPDATA" t
Just lad ->
pure $ lad </> relDirUpperPrograms </> relDirStackProgName
Nothing -> pure defaultBase
_ -> pure defaultBase
where
defaultBase = configStackRoot </> relDirPrograms
-- | Load the configuration, using current directory, environment variables,
-- and defaults as necessary.
loadConfig ::
(HasRunner env, HasTerm env)
=> (Config -> RIO env a)
-> RIO env a
loadConfig inner = do
mstackYaml <- view $ globalOptsL . to (.stackYaml)
mproject <- loadProjectConfig mstackYaml
mASnapshot <- view $ globalOptsL . to (.snapshot)
configArgs <- view $ globalOptsL . to (.configMonoid)
(configRoot, stackRoot, userOwnsStackRoot) <-
determineStackRootAndOwnership configArgs
let (mproject', addConfigMonoid) =
case mproject of
PCProject (proj, fp, cm) -> (PCProject (proj, fp), (cm:))
PCGlobalProject -> (PCGlobalProject, id)
PCNoProject deps -> (PCNoProject deps, id)
userConfigPath <- getDefaultUserConfigPath configRoot
extraConfigs0 <- getExtraConfigs userConfigPath >>=
mapM (\file -> loadConfigYaml (parseConfigMonoid (parent file)) file)
let extraConfigs =
-- non-project config files' existence of a docker section should never
-- default docker to enabled, so make it look like they didn't exist
map
(\c -> c {dockerOpts = c.dockerOpts { defaultEnable = Any False }})
extraConfigs0
let withConfig =
configFromConfigMonoid
stackRoot
userConfigPath
mASnapshot
mproject'
(mconcat $ configArgs : addConfigMonoid extraConfigs)
withConfig $ \config -> do
let Platform arch _ = config.platform
case arch of
OtherArch unknownArch
| config.notifyIfArchUnknown ->
prettyWarnL
[ flow "Unknown value for architecture setting:"
, style Shell (fromString unknownArch) <> "."
, flow "To mute this message in future, set"
, style Shell (flow "notify-if-arch-unknown: false")
, flow "in Stack's configuration."
]
_ -> pure ()
unless (stackVersion `withinRange` config.requireStackVersion)
(throwM (BadStackVersionException config.requireStackVersion))
unless config.allowDifferentUser $ do
unless userOwnsStackRoot $
throwM (UserDoesn'tOwnDirectory stackRoot)
forM_ (configProjectRoot config) $ \dir ->
checkOwnership (dir </> config.workDir)
inner config
-- | Load the build configuration, adds build-specific values to config loaded
-- by @loadConfig@. values.
withBuildConfig :: RIO BuildConfig a -> RIO Config a
withBuildConfig inner = do
config <- ask
-- If provided, turn the AbstractSnapshot from the command line into a
-- snapshot that can be used below.
-- The snapshot and mcompiler are provided on the command line. In order
-- to properly deal with an AbstractSnapshot, we need a base directory (to
-- deal with custom snapshot relative paths). We consider the current working
-- directory to be the correct base. Let's calculate the mSnapshot first.
mSnapshot <- forM config.snapshot $ \aSnapshot -> do
logDebug $
"Using snapshot: "
<> display aSnapshot
<> " specified on command line"
makeConcreteSnapshot aSnapshot
(project', configFile) <- case config.project of
PCProject (project, fp) -> do
forM_ project.userMsg prettyUserMessage
pure (project, Right fp)
PCNoProject extraDeps -> do
p <-
case mSnapshot of
Nothing -> throwIO NoSnapshotWhenUsingNoProject
Just _ -> getEmptyProject mSnapshot extraDeps
pure (p, Left config.userGlobalConfigFile)
PCGlobalProject -> do
logDebug "Run from outside a project, using implicit global project config"
destDir <- getImplicitGlobalProjectDir
let dest :: Path Abs File
dest = destDir </> stackDotYaml
dest' :: FilePath
dest' = toFilePath dest
ensureDir destDir
exists <- doesFileExist dest
if exists
then do
iopc <- loadConfigYaml (parseProjectAndConfigMonoid destDir) dest
ProjectAndConfigMonoid project _ <- liftIO iopc
when (view terminalL config) $
case config.snapshot of
Nothing ->
logDebug $
"Using snapshot: "
<> display project.snapshot
<> " from implicit global project's config file: "
<> fromString dest'
Just _ -> pure ()
pure (project, Right dest)
else do
prettyInfoL
[ flow "Writing the configuration file for the implicit \
\global project to:"
, pretty dest <> "."
, flow "Note: You can change the snapshot via the"
, style Shell "snapshot"
, flow "field there."
]
p <- getEmptyProject mSnapshot []
liftIO $ do
writeBinaryFileAtomic dest $ byteString $ S.concat
[ "# This is the implicit global project's configuration file, which is only used\n"
, "# when 'stack' is run outside of a real project. Settings here do _not_ act as\n"
, "# defaults for all projects. To change Stack's default settings, edit\n"
, "# '", encodeUtf8 (T.pack $ toFilePath config.userGlobalConfigFile), "' instead.\n"
, "#\n"
, "# For more information about Stack's configuration, see\n"
, "# http://docs.haskellstack.org/en/stable/configure/yaml/\n"
, "#\n"
, Yaml.encode p]
writeBinaryFileAtomic (parent dest </> relFileReadmeTxt) $
"This is the implicit global project, which is " <>
"used only when 'stack' is run\noutside of a " <>
"real project.\n"
pure (p, Right dest)
mcompiler <- view $ globalOptsL . to (.compiler)
let project :: Project
project = project'
{ Project.compiler = mcompiler <|> project'.compiler
, Project.snapshot = fromMaybe project'.snapshot mSnapshot
}
-- We are indifferent as to whether the configuration file is a
-- user-specific global or a project-level one.
eitherConfigFile = EE.fromEither configFile
extraPackageDBs <- mapM resolveDir' project.extraPackageDBs
smWanted <- lockCachedWanted eitherConfigFile project.snapshot $
fillProjectWanted eitherConfigFile config project
-- Unfortunately redoes getWorkDir, since we don't have a BuildConfig yet
workDir <- view workDirL
let projectStorageFile = parent eitherConfigFile </> workDir </> relFileStorage
initProjectStorage projectStorageFile $ \projectStorage -> do
let bc = BuildConfig
{ config
, smWanted
, extraPackageDBs
, configFile
, curator = project.curator
, projectStorage
}
runRIO bc inner
where
getEmptyProject ::
Maybe RawSnapshotLocation
-> [PackageIdentifierRevision]
-> RIO Config Project
getEmptyProject mSnapshot extraDeps = do
snapshot <- case mSnapshot of
Just snapshot -> do
prettyInfoL
[ flow "Using the snapshot"
, style Current (fromString $ T.unpack $ textDisplay snapshot)
, flow "specified on the command line."
]
pure snapshot
Nothing -> do
r'' <- getLatestSnapshot
prettyInfoL
[ flow "Using the latest snapshot"
, style Current (fromString $ T.unpack $ textDisplay r'') <> "."
]
pure r''
pure Project
{ userMsg = Nothing
, packages = []
, extraDeps = map (RPLImmutable . flip RPLIHackage Nothing) extraDeps
, flagsByPkg = mempty
, snapshot
, compiler = Nothing
, extraPackageDBs = []
, curator = Nothing
, dropPackages = mempty
}
prettyUserMessage :: String -> RIO Config ()
prettyUserMessage userMsg = do
let userMsgs = map flow $ splitAtLineEnds userMsg
warningDoc = mconcat $ intersperse blankLine userMsgs
prettyWarn warningDoc
where
splitAtLineEnds = reverse . map reverse . go []
where
go :: [String] -> String -> [String]
go ss [] = ss
go ss s = case go' [] s of
([], rest) -> go ss rest
(s', rest) -> go (s' : ss) rest
go' :: String -> String -> (String, String)
go' s [] = (s, [])
go' s [c] = (c:s, [])
go' s "\n\n" = (s, [])
go' s [c1, c2] = (c2:c1:s, [])
go' s ('\n':'\n':rest) = (s, stripLineEnds rest)
go' s ('\n':'\r':'\n':rest) = (s, stripLineEnds rest)
go' s ('\r':'\n':'\n':rest) = (s, stripLineEnds rest)
go' s ('\r':'\n':'\r':'\n':rest) = (s, stripLineEnds rest)
go' s (c:rest) = go' (c:s) rest
stripLineEnds :: String -> String
stripLineEnds ('\n':rest) = stripLineEnds rest
stripLineEnds ('\r':'\n':rest) = stripLineEnds rest
stripLineEnds rest = rest
fillProjectWanted ::
(HasLogFunc env, HasPantryConfig env, HasProcessContext env)
=> Path Abs File
-- ^ Location of the configuration file, which may be either a
-- user-specific global or a project-level one.
-> Config
-> Project
-> Map RawPackageLocationImmutable PackageLocationImmutable
-> WantedCompiler
-> Map PackageName (Bool -> RIO env DepPackage)
-> RIO env (SMWanted, [CompletedPLI])
fillProjectWanted configFile config project locCache snapCompiler snapPackages = do
let bopts = config.build
packages0 <- for project.packages $ \fp@(RelFilePath t) -> do
abs' <- resolveDir (parent configFile) (T.unpack t)
let resolved = ResolvedPath fp abs'
pp <- mkProjectPackage YesPrintWarnings resolved bopts.buildHaddocks
pure (pp.projectCommon.name, pp)
-- prefetch git repos to avoid cloning per subdirectory
-- see https://github.com/commercialhaskell/stack/issues/5411
let gitRepos = mapMaybe
( \case
(RPLImmutable (RPLIRepo repo rpm)) -> Just (repo, rpm)
_ -> Nothing
)
project.extraDeps
logDebug ("Prefetching git repos: " <> display (T.pack (show gitRepos)))
fetchReposRaw gitRepos
(deps0, mcompleted) <- fmap unzip . forM project.extraDeps $ \rpl -> do
(pl, mCompleted) <- case rpl of
RPLImmutable rpli -> do
(compl, mcompl) <-
case Map.lookup rpli locCache of
Just compl -> pure (compl, Just compl)
Nothing -> do
cpl <- completePackageLocation rpli
if cplHasCabalFile cpl
then pure (cplComplete cpl, Just $ cplComplete cpl)
else do
warnMissingCabalFile rpli
pure (cplComplete cpl, Nothing)
pure (PLImmutable compl, CompletedPLI rpli <$> mcompl)
RPLMutable p ->
pure (PLMutable p, Nothing)
dp <- additionalDepPackage (shouldHaddockDeps bopts) pl
pure ((dp.depCommon.name, dp), mCompleted)
checkDuplicateNames $
map (second (PLMutable . (.resolvedDir))) packages0 ++
map (second (.location)) deps0
let packages1 = Map.fromList packages0
snPackages = snapPackages
`Map.difference` packages1
`Map.difference` Map.fromList deps0
`Map.withoutKeys` project.dropPackages
snDeps <- for snPackages $ \getDep -> getDep (shouldHaddockDeps bopts)
let deps1 = Map.fromList deps0 `Map.union` snDeps
let mergeApply m1 m2 f =
MS.merge MS.preserveMissing MS.dropMissing (MS.zipWithMatched f) m1 m2
pFlags = project.flagsByPkg
packages2 = mergeApply packages1 pFlags $ \_ p flags ->
p { projectCommon = p.projectCommon { flags = flags } }
deps2 = mergeApply deps1 pFlags $ \_ d flags ->
d { depCommon = d.depCommon { flags = flags } }
checkFlagsUsedThrowing pFlags packages1 deps1
let pkgGhcOptions = config.ghcOptionsByName
deps = mergeApply deps2 pkgGhcOptions $ \_ d options ->
d { depCommon = d.depCommon { ghcOptions = options } }
packages = mergeApply packages2 pkgGhcOptions $ \_ p options ->
p { projectCommon = p.projectCommon { ghcOptions = options } }
unusedPkgGhcOptions =
pkgGhcOptions `Map.restrictKeys` Map.keysSet packages2
`Map.restrictKeys` Map.keysSet deps2
unless (Map.null unusedPkgGhcOptions) $
throwM $ InvalidGhcOptionsSpecification (Map.keys unusedPkgGhcOptions)
let wanted = SMWanted
{ compiler = fromMaybe snapCompiler project.compiler
, project = packages
, deps = deps
, snapshotLocation = project.snapshot
}
pure (wanted, catMaybes mcompleted)
-- | Check if a package is a project package or a dependency and, if it is,