-
Notifications
You must be signed in to change notification settings - Fork 703
/
Copy pathConfig.hs
1991 lines (1861 loc) · 69.8 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 DataKinds #-}
{-# LANGUAGE DeriveGeneric #-}
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
-- |
-- Module : Distribution.Client.Config
-- Copyright : (c) David Himmelstrup 2005
-- License : BSD-like
--
-- Maintainer : lemmih@gmail.com
-- Stability : provisional
-- Portability : portable
--
-- Utilities for handling saved state such as known packages, known servers and
-- downloaded packages.
module Distribution.Client.Config
( SavedConfig (..)
, loadConfig
, getConfigFilePath
, showConfig
, showConfigWithComments
, parseConfig
, defaultConfigFile
, defaultCacheDir
, defaultCacheHome
, defaultScriptBuildsDir
, defaultStoreDir
, defaultCompiler
, defaultInstallPath
, defaultLogsDir
, defaultReportsDir
, defaultUserInstall
, baseSavedConfig
, commentSavedConfig
, initialSavedConfig
, configFieldDescriptions
, haddockFlagsFields
, installDirsFields
, withProgramsFields
, withProgramOptionsFields
, userConfigDiff
, userConfigUpdate
, createDefaultConfigFile
, remoteRepoFields
, postProcessRepo
) where
import Distribution.Client.Compat.Prelude
import Distribution.Compat.Environment
( getEnvironment
, lookupEnv
)
import Prelude ()
import Language.Haskell.Extension (Language (Haskell2010))
import Distribution.Deprecated.ViewAsFieldDescr
( viewAsFieldDescr
)
import Distribution.Client.BuildReports.Types
( ReportLevel (..)
)
import Distribution.Client.CmdInstall.ClientInstallFlags
( ClientInstallFlags (..)
, clientInstallOptions
, defaultClientInstallFlags
)
import qualified Distribution.Client.Init.Defaults as IT
import qualified Distribution.Client.Init.Types as IT
( InitFlags (..)
)
import Distribution.Client.Setup
( ConfigExFlags (..)
, GlobalFlags (..)
, InstallFlags (..)
, ReportFlags (..)
, UploadFlags (..)
, configureExOptions
, defaultConfigExFlags
, defaultGlobalFlags
, defaultInstallFlags
, globalCommand
, initOptions
, installOptions
, reportCommand
, uploadCommand
)
import Distribution.Client.Types
( AllowNewer (..)
, AllowOlder (..)
, LocalRepo (..)
, RelaxDeps (..)
, RemoteRepo (..)
, RepoName (..)
, emptyRemoteRepo
, isRelaxDeps
, unRepoName
)
import Distribution.Client.Types.Credentials
( Password (..)
, Token (..)
, Username (..)
)
import Distribution.Utils.NubList
( NubList
, fromNubList
, overNubList
, toNubList
)
import qualified Data.ByteString as BS
import qualified Data.Map as M
import Distribution.Client.Errors
import Distribution.Client.HttpUtils
( isOldHackageURI
)
import Distribution.Client.ParseUtils
( parseFields
, ppFields
, ppSection
)
import Distribution.Client.ProjectFlags (ProjectFlags (..))
import Distribution.Client.ReplFlags
import Distribution.Client.Version
( cabalInstallVersion
)
import qualified Distribution.Compat.CharParsing as P
import Distribution.Compiler
( CompilerFlavor (..)
, defaultCompilerFlavor
)
import Distribution.Deprecated.ParseUtils
( FieldDescr (..)
, PError (..)
, PWarning (..)
, ParseResult (..)
, liftField
, lineNo
, listField
, listFieldParsec
, locatedErrorMsg
, parseOptCommaList
, parseTokenQ
, readFields
, runP
, showPWarning
, simpleField
, simpleFieldParsec
, spaceListField
, syntaxError
, warning
)
import qualified Distribution.Deprecated.ParseUtils as ParseUtils
( Field (..)
)
import Distribution.Parsec (ParsecParser, parsecFilePath, parsecOptCommaList, parsecToken)
import Distribution.Simple.Command
( CommandUI (commandOptions)
, OptionField
, ShowOrParseArgs (..)
, commandDefaultFlags
)
import Distribution.Simple.Compiler
( DebugInfoLevel (..)
, OptimisationLevel (..)
)
import Distribution.Simple.InstallDirs
( InstallDirs (..)
, PathTemplate
, defaultInstallDirs
, toPathTemplate
)
import Distribution.Simple.Program
( defaultProgramDb
)
import Distribution.Simple.Setup
( BenchmarkFlags (..)
, CommonSetupFlags (..)
, ConfigFlags (..)
, Flag (..)
, HaddockFlags (..)
, TestFlags (..)
, configureOptions
, defaultBenchmarkFlags
, defaultConfigFlags
, defaultHaddockFlags
, defaultTestFlags
, flagToMaybe
, fromFlagOrDefault
, haddockOptions
, installDirsOptions
, optionDistPref
, programDbOptions
, programDbPaths'
, toFlag
)
import Distribution.Simple.Utils
( cabalVersion
, dieWithException
, lowercase
, notice
, toUTF8BS
, warn
)
import Distribution.Solver.Types.ConstraintSource
import Distribution.Utils.Path (getSymbolicPath, unsafeMakeSymbolicPath)
import Distribution.Verbosity
( normal
)
import Network.URI
( URI (..)
, URIAuth (..)
, parseURI
)
import System.Directory
( XdgDirectory (XdgCache, XdgConfig, XdgState)
, createDirectoryIfMissing
, doesDirectoryExist
, doesFileExist
, getAppUserDataDirectory
, getHomeDirectory
, getXdgDirectory
, renameFile
)
import System.FilePath
( normalise
, takeDirectory
, (<.>)
, (</>)
)
import System.IO.Error
( isDoesNotExistError
)
import Text.PrettyPrint
( ($+$)
)
import qualified Text.PrettyPrint as Disp
( empty
, render
, text
)
import Text.PrettyPrint.HughesPJ
( Doc
, text
)
--
-- * Configuration saved in the config file
--
data SavedConfig = SavedConfig
{ savedGlobalFlags :: GlobalFlags
, savedInitFlags :: IT.InitFlags
, savedInstallFlags :: InstallFlags
, savedClientInstallFlags :: ClientInstallFlags
, savedConfigureFlags :: ConfigFlags
, savedConfigureExFlags :: ConfigExFlags
, savedUserInstallDirs :: InstallDirs (Flag PathTemplate)
, savedGlobalInstallDirs :: InstallDirs (Flag PathTemplate)
, savedUploadFlags :: UploadFlags
, savedReportFlags :: ReportFlags
, savedHaddockFlags :: HaddockFlags
, savedTestFlags :: TestFlags
, savedBenchmarkFlags :: BenchmarkFlags
, savedProjectFlags :: ProjectFlags
, savedReplMulti :: Flag Bool
}
deriving (Generic)
instance Monoid SavedConfig where
mempty = gmempty
mappend = (<>)
instance Semigroup SavedConfig where
a <> b =
SavedConfig
{ savedGlobalFlags = combinedSavedGlobalFlags
, savedInitFlags = combinedSavedInitFlags
, savedInstallFlags = combinedSavedInstallFlags
, savedClientInstallFlags = combinedSavedClientInstallFlags
, savedConfigureFlags = combinedSavedConfigureFlags
, savedConfigureExFlags = combinedSavedConfigureExFlags
, savedUserInstallDirs = combinedSavedUserInstallDirs
, savedGlobalInstallDirs = combinedSavedGlobalInstallDirs
, savedUploadFlags = combinedSavedUploadFlags
, savedReportFlags = combinedSavedReportFlags
, savedHaddockFlags = combinedSavedHaddockFlags
, savedTestFlags = combinedSavedTestFlags
, savedBenchmarkFlags = combinedSavedBenchmarkFlags
, savedProjectFlags = combinedSavedProjectFlags
, savedReplMulti = combinedSavedReplMulti
}
where
-- This is ugly, but necessary. If we're mappending two config files, we
-- want the values of the *non-empty* list fields from the second one to
-- \*override* the corresponding values from the first one. Default
-- behaviour (concatenation) is confusing and makes some use cases (see
-- #1884) impossible.
--
-- However, we also want to allow specifying multiple values for a list
-- field in a *single* config file. For example, we want the following to
-- continue to work:
--
-- remote-repo: hackage.haskell.org:http://hackage.haskell.org/
-- remote-repo: private-collection:http://hackage.local/
--
-- So we can't just wrap the list fields inside Flags; we have to do some
-- special-casing just for SavedConfig.
-- NB: the signature prevents us from using 'combine' on lists.
combine' :: (SavedConfig -> flags) -> (flags -> Flag a) -> Flag a
combine' field subfield =
(subfield . field $ a) `mappend` (subfield . field $ b)
combineMonoid
:: Monoid mon
=> (SavedConfig -> flags)
-> (flags -> mon)
-> mon
combineMonoid field subfield =
(subfield . field $ a) `mappend` (subfield . field $ b)
lastNonEmpty' :: (SavedConfig -> flags) -> (flags -> [a]) -> [a]
lastNonEmpty' field subfield =
let a' = subfield . field $ a
b' = subfield . field $ b
in case b' of
[] -> a'
_ -> b'
lastNonMempty'
:: (Eq a, Monoid a) => (SavedConfig -> flags) -> (flags -> a) -> a
lastNonMempty' field subfield =
let a' = subfield . field $ a
b' = subfield . field $ b
in if b' == mempty then a' else b'
lastNonEmptyNL'
:: (SavedConfig -> flags)
-> (flags -> NubList a)
-> NubList a
lastNonEmptyNL' field subfield =
let a' = subfield . field $ a
b' = subfield . field $ b
in case fromNubList b' of
[] -> a'
_ -> b'
combinedSavedGlobalFlags =
GlobalFlags
{ globalVersion = combine globalVersion
, globalNumericVersion = combine globalNumericVersion
, globalConfigFile = combine globalConfigFile
, globalConstraintsFile = combine globalConstraintsFile
, globalRemoteRepos = lastNonEmptyNL globalRemoteRepos
, globalCacheDir = combine globalCacheDir
, globalLocalNoIndexRepos = lastNonEmptyNL globalLocalNoIndexRepos
, globalActiveRepos = combine globalActiveRepos
, globalLogsDir = combine globalLogsDir
, globalIgnoreExpiry = combine globalIgnoreExpiry
, globalHttpTransport = combine globalHttpTransport
, globalNix = combine globalNix
, globalStoreDir = combine globalStoreDir
, globalProgPathExtra = lastNonEmptyNL globalProgPathExtra
}
where
combine = combine' savedGlobalFlags
lastNonEmptyNL = lastNonEmptyNL' savedGlobalFlags
combinedSavedInitFlags =
IT.InitFlags
{ IT.applicationDirs = combineMonoid savedInitFlags IT.applicationDirs
, IT.author = combine IT.author
, IT.buildTools = combineMonoid savedInitFlags IT.buildTools
, IT.cabalVersion = combine IT.cabalVersion
, IT.category = combine IT.category
, IT.dependencies = combineMonoid savedInitFlags IT.dependencies
, IT.email = combine IT.email
, IT.exposedModules = combineMonoid savedInitFlags IT.exposedModules
, IT.extraSrc = combineMonoid savedInitFlags IT.extraSrc
, IT.extraDoc = combineMonoid savedInitFlags IT.extraDoc
, IT.homepage = combine IT.homepage
, IT.initHcPath = combine IT.initHcPath
, IT.initVerbosity = combine IT.initVerbosity
, IT.initializeTestSuite = combine IT.initializeTestSuite
, IT.interactive = combine IT.interactive
, IT.language = combine IT.language
, IT.license = combine IT.license
, IT.mainIs = combine IT.mainIs
, IT.minimal = combine IT.minimal
, IT.noComments = combine IT.noComments
, IT.otherExts = combineMonoid savedInitFlags IT.otherExts
, IT.otherModules = combineMonoid savedInitFlags IT.otherModules
, IT.overwrite = combine IT.overwrite
, IT.packageDir = combine IT.packageDir
, IT.packageName = combine IT.packageName
, IT.packageType = combine IT.packageType
, IT.quiet = combine IT.quiet
, IT.simpleProject = combine IT.simpleProject
, IT.sourceDirs = combineMonoid savedInitFlags IT.sourceDirs
, IT.synopsis = combine IT.synopsis
, IT.testDirs = combineMonoid savedInitFlags IT.testDirs
, IT.version = combine IT.version
}
where
combine = combine' savedInitFlags
combinedSavedInstallFlags =
InstallFlags
{ installDocumentation = combine installDocumentation
, installHaddockIndex = combine installHaddockIndex
, installDryRun = combine installDryRun
, installOnlyDownload = combine installOnlyDownload
, installDest = combine installDest
, installMaxBackjumps = combine installMaxBackjumps
, installReorderGoals = combine installReorderGoals
, installCountConflicts = combine installCountConflicts
, installFineGrainedConflicts = combine installFineGrainedConflicts
, installMinimizeConflictSet = combine installMinimizeConflictSet
, installIndependentGoals = combine installIndependentGoals
, installPreferOldest = combine installPreferOldest
, installShadowPkgs = combine installShadowPkgs
, installStrongFlags = combine installStrongFlags
, installAllowBootLibInstalls = combine installAllowBootLibInstalls
, installOnlyConstrained = combine installOnlyConstrained
, installReinstall = combine installReinstall
, installAvoidReinstalls = combine installAvoidReinstalls
, installOverrideReinstall = combine installOverrideReinstall
, installUpgradeDeps = combine installUpgradeDeps
, installOnly = combine installOnly
, installOnlyDeps = combine installOnlyDeps
, installIndexState = combine installIndexState
, installRootCmd = combine installRootCmd
, installSummaryFile = lastNonEmptyNL installSummaryFile
, installLogFile = combine installLogFile
, installBuildReports = combine installBuildReports
, installReportPlanningFailure = combine installReportPlanningFailure
, installSymlinkBinDir = combine installSymlinkBinDir
, installPerComponent = combine installPerComponent
, installNumJobs = combine installNumJobs
, installUseSemaphore = combine installUseSemaphore
, installKeepGoing = combine installKeepGoing
, installRunTests = combine installRunTests
, installOfflineMode = combine installOfflineMode
}
where
combine = combine' savedInstallFlags
lastNonEmptyNL = lastNonEmptyNL' savedInstallFlags
combinedSavedClientInstallFlags =
ClientInstallFlags
{ cinstInstallLibs = combine cinstInstallLibs
, cinstEnvironmentPath = combine cinstEnvironmentPath
, cinstOverwritePolicy = combine cinstOverwritePolicy
, cinstInstallMethod = combine cinstInstallMethod
, cinstInstalldir = combine cinstInstalldir
}
where
combine = combine' savedClientInstallFlags
combinedSavedCommonFlags which =
CommonSetupFlags
{ setupDistPref = combine setupDistPref
, setupWorkingDir = combine setupWorkingDir
, setupCabalFilePath = combine setupCabalFilePath
, setupVerbosity = combine setupVerbosity
, setupTargets = lastNonEmpty setupTargets
, setupKeepTempFiles = combine setupKeepTempFiles
}
where
lastNonEmpty = lastNonEmpty' which
combine = combine' which
combinedSavedConfigureFlags =
ConfigFlags
{ configCommonFlags = combinedSavedCommonFlags (configCommonFlags . savedConfigureFlags)
, configPrograms_ = configPrograms_ . savedConfigureFlags $ b
, -- TODO: NubListify
configProgramPaths = lastNonEmpty configProgramPaths
, -- TODO: NubListify
configProgramArgs = lastNonEmpty configProgramArgs
, configProgramPathExtra = lastNonEmptyNL configProgramPathExtra
, configInstantiateWith = lastNonEmpty configInstantiateWith
, configHcFlavor = combine configHcFlavor
, configHcPath = combine configHcPath
, configHcPkg = combine configHcPkg
, configVanillaLib = combine configVanillaLib
, configProfLib = combine configProfLib
, configProf = combine configProf
, configProfShared = combine configProfShared
, configSharedLib = combine configSharedLib
, configStaticLib = combine configStaticLib
, configDynExe = combine configDynExe
, configFullyStaticExe = combine configFullyStaticExe
, configProfExe = combine configProfExe
, configProfDetail = combine configProfDetail
, configProfLibDetail = combine configProfLibDetail
, -- TODO: NubListify
configConfigureArgs = lastNonEmpty configConfigureArgs
, configOptimization = combine configOptimization
, configDebugInfo = combine configDebugInfo
, configProgPrefix = combine configProgPrefix
, configProgSuffix = combine configProgSuffix
, -- Parametrised by (Flag PathTemplate), so safe to use 'mappend'.
configInstallDirs =
(configInstallDirs . savedConfigureFlags $ a)
`mappend` (configInstallDirs . savedConfigureFlags $ b)
, configScratchDir = combine configScratchDir
, -- TODO: NubListify
configExtraLibDirs = lastNonEmpty configExtraLibDirs
, configExtraLibDirsStatic = lastNonEmpty configExtraLibDirsStatic
, -- TODO: NubListify
configExtraFrameworkDirs = lastNonEmpty configExtraFrameworkDirs
, -- TODO: NubListify
configExtraIncludeDirs = lastNonEmpty configExtraIncludeDirs
, configDeterministic = combine configDeterministic
, configIPID = combine configIPID
, configCID = combine configCID
, configUserInstall = combine configUserInstall
, -- TODO: NubListify
configPackageDBs = lastNonEmpty configPackageDBs
, configGHCiLib = combine configGHCiLib
, configSplitSections = combine configSplitSections
, configSplitObjs = combine configSplitObjs
, configStripExes = combine configStripExes
, configStripLibs = combine configStripLibs
, -- TODO: NubListify
configConstraints = lastNonEmpty configConstraints
, -- TODO: NubListify
configDependencies = lastNonEmpty configDependencies
, configPromisedDependencies = lastNonEmpty configPromisedDependencies
, -- TODO: NubListify
configConfigurationsFlags = lastNonMempty configConfigurationsFlags
, configTests = combine configTests
, configBenchmarks = combine configBenchmarks
, configCoverage = combine configCoverage
, configLibCoverage = combine configLibCoverage
, configExactConfiguration = combine configExactConfiguration
, configFlagError = combine configFlagError
, configRelocatable = combine configRelocatable
, configUseResponseFiles = combine configUseResponseFiles
, configDumpBuildInfo = combine configDumpBuildInfo
, configAllowDependingOnPrivateLibs =
combine configAllowDependingOnPrivateLibs
, configCoverageFor = combine configCoverageFor
, configIgnoreBuildTools = combine configIgnoreBuildTools
}
where
combine = combine' savedConfigureFlags
lastNonEmpty = lastNonEmpty' savedConfigureFlags
lastNonEmptyNL = lastNonEmptyNL' savedConfigureFlags
lastNonMempty = lastNonMempty' savedConfigureFlags
combinedSavedConfigureExFlags =
ConfigExFlags
{ configCabalVersion = combine configCabalVersion
, configAppend = combine configAppend
, configBackup = combine configBackup
, -- TODO: NubListify
configExConstraints = lastNonEmpty configExConstraints
, -- TODO: NubListify
configPreferences = lastNonEmpty configPreferences
, configSolver = combine configSolver
, configAllowNewer =
combineMonoid savedConfigureExFlags configAllowNewer
, configAllowOlder =
combineMonoid savedConfigureExFlags configAllowOlder
, configWriteGhcEnvironmentFilesPolicy =
combine configWriteGhcEnvironmentFilesPolicy
}
where
combine = combine' savedConfigureExFlags
lastNonEmpty = lastNonEmpty' savedConfigureExFlags
-- Parametrised by (Flag PathTemplate), so safe to use 'mappend'.
combinedSavedUserInstallDirs =
savedUserInstallDirs a
`mappend` savedUserInstallDirs b
-- Parametrised by (Flag PathTemplate), so safe to use 'mappend'.
combinedSavedGlobalInstallDirs =
savedGlobalInstallDirs a
`mappend` savedGlobalInstallDirs b
combinedSavedUploadFlags =
UploadFlags
{ uploadCandidate = combine uploadCandidate
, uploadDoc = combine uploadDoc
, uploadToken = combine uploadToken
, uploadUsername = combine uploadUsername
, uploadPassword = combine uploadPassword
, uploadPasswordCmd = combine uploadPasswordCmd
, uploadVerbosity = combine uploadVerbosity
}
where
combine = combine' savedUploadFlags
combinedSavedReportFlags =
ReportFlags
{ reportToken = combine reportToken
, reportUsername = combine reportUsername
, reportPassword = combine reportPassword
, reportVerbosity = combine reportVerbosity
}
where
combine = combine' savedReportFlags
combinedSavedHaddockFlags =
HaddockFlags
{ haddockCommonFlags = combinedSavedCommonFlags (haddockCommonFlags . savedHaddockFlags)
, -- TODO: NubListify
haddockProgramPaths = lastNonEmpty haddockProgramPaths
, -- TODO: NubListify
haddockProgramArgs = lastNonEmpty haddockProgramArgs
, haddockHoogle = combine haddockHoogle
, haddockHtml = combine haddockHtml
, haddockHtmlLocation = combine haddockHtmlLocation
, haddockForHackage = combine haddockForHackage
, haddockExecutables = combine haddockExecutables
, haddockTestSuites = combine haddockTestSuites
, haddockBenchmarks = combine haddockBenchmarks
, haddockForeignLibs = combine haddockForeignLibs
, haddockInternal = combine haddockInternal
, haddockCss = combine haddockCss
, haddockLinkedSource = combine haddockLinkedSource
, haddockQuickJump = combine haddockQuickJump
, haddockHscolourCss = combine haddockHscolourCss
, haddockContents = combine haddockContents
, haddockIndex = combine haddockIndex
, haddockBaseUrl = combine haddockBaseUrl
, haddockResourcesDir = combine haddockResourcesDir
, haddockOutputDir = combine haddockOutputDir
, haddockUseUnicode = combine haddockUseUnicode
}
where
combine = combine' savedHaddockFlags
lastNonEmpty = lastNonEmpty' savedHaddockFlags
combinedSavedTestFlags =
TestFlags
{ testCommonFlags = combinedSavedCommonFlags (testCommonFlags . savedTestFlags)
, testHumanLog = combine testHumanLog
, testMachineLog = combine testMachineLog
, testShowDetails = combine testShowDetails
, testKeepTix = combine testKeepTix
, testWrapper = combine testWrapper
, testFailWhenNoTestSuites = combine testFailWhenNoTestSuites
, testOptions = lastNonEmpty testOptions
}
where
combine = combine' savedTestFlags
lastNonEmpty = lastNonEmpty' savedTestFlags
combinedSavedBenchmarkFlags =
BenchmarkFlags
{ benchmarkCommonFlags = combinedSavedCommonFlags (benchmarkCommonFlags . savedBenchmarkFlags)
, benchmarkOptions = lastNonEmpty benchmarkOptions
}
where
lastNonEmpty = lastNonEmpty' savedBenchmarkFlags
combinedSavedReplMulti = combine' savedReplMulti id
combinedSavedProjectFlags =
ProjectFlags
{ flagProjectDir = combine flagProjectDir
, flagProjectFile = combine flagProjectFile
, flagIgnoreProject = combine flagIgnoreProject
}
where
combine = combine' savedProjectFlags
--
-- * Default config
--
-- | These are the absolute basic defaults. The fields that must be
-- initialised. When we load the config from the file we layer the loaded
-- values over these ones, so any missing fields in the file take their values
-- from here.
baseSavedConfig :: IO SavedConfig
baseSavedConfig = do
userPrefix <- defaultInstallPrefix
cacheDir <- defaultCacheDir
logsDir <- defaultLogsDir
return
mempty
{ savedConfigureFlags =
mempty
{ configHcFlavor = toFlag defaultCompiler
, configUserInstall = toFlag defaultUserInstall
, configCommonFlags =
mempty
{ setupVerbosity = toFlag normal
}
}
, savedUserInstallDirs =
mempty
{ prefix = toFlag (toPathTemplate userPrefix)
}
, savedGlobalFlags =
mempty
{ globalCacheDir = toFlag cacheDir
, globalLogsDir = toFlag logsDir
}
}
-- | This is the initial configuration that we write out to the config file
-- if the file does not exist (or the config we use if the file cannot be read
-- for some other reason). When the config gets loaded it gets layered on top
-- of 'baseSavedConfig' so we do not need to include it into the initial
-- values we save into the config file.
initialSavedConfig :: IO SavedConfig
initialSavedConfig = do
cacheDir <- defaultCacheDir
logsDir <- defaultLogsDir
installPath <- defaultInstallPath
return
mempty
{ savedGlobalFlags =
mempty
{ globalCacheDir = toFlag cacheDir
, globalRemoteRepos = toNubList [defaultRemoteRepo]
}
, savedInstallFlags =
mempty
{ installSummaryFile = toNubList [toPathTemplate (logsDir </> "build.log")]
, installBuildReports = toFlag NoReports
, installNumJobs = toFlag Nothing
}
, savedClientInstallFlags =
mempty
{ cinstInstalldir = toFlag installPath
}
}
-- | Issue a warning if both @$XDG_CONFIG_HOME/cabal/config@ and
-- @~/.cabal@ exists.
warnOnTwoConfigs :: Verbosity -> IO ()
warnOnTwoConfigs verbosity = do
defaultDir <- getAppUserDataDirectory "cabal"
xdgCfgDir <- getXdgDirectory XdgConfig "cabal"
when (defaultDir /= xdgCfgDir) $ do
dotCabalExists <- doesDirectoryExist defaultDir
let xdgCfg = xdgCfgDir </> "config"
xdgCfgExists <- doesFileExist xdgCfg
when (dotCabalExists && xdgCfgExists) $
warn verbosity $
"Both "
<> defaultDir
<> " and "
<> xdgCfg
<> " exist - ignoring the former.\n"
<> "It is advisable to remove one of them. In that case, we will use the remaining one by default (unless '$CABAL_DIR' is explicitly set)."
-- | If @CABAL\_DIR@ is set, return @Just@ its value. Otherwise, if
-- @~/.cabal@ exists and @$XDG_CONFIG_HOME/cabal/config@ does not
-- exist, return @Just "~/.cabal"@. Otherwise, return @Nothing@. If
-- this function returns Nothing, then it implies that we are not
-- using a single directory for everything, but instead use XDG paths.
-- Fundamentally, this function is used to implement transparent
-- backwards compatibility with pre-XDG versions of cabal-install.
maybeGetCabalDir :: IO (Maybe FilePath)
maybeGetCabalDir = do
mDir <- lookupEnv "CABAL_DIR"
case mDir of
Just dir -> return $ Just dir
Nothing -> do
defaultDir <- getAppUserDataDirectory "cabal"
dotCabalExists <- doesDirectoryExist defaultDir
xdgCfg <- getXdgDirectory XdgConfig ("cabal" </> "config")
xdgCfgExists <- doesFileExist xdgCfg
if dotCabalExists && not xdgCfgExists
then return $ Just defaultDir
else return Nothing
-- | The default behaviour of cabal-install is to use the XDG
-- directory standard. However, if @CABAL_DIR@ is set, we instead use
-- that directory as a single store for everything cabal-related, like
-- the old @~/.cabal@ behaviour. Also, for backwards compatibility,
-- if @~/.cabal@ exists we treat that as equivalent to @CABAL_DIR@
-- being set. This function abstracts that decision-making.
getDefaultDir :: XdgDirectory -> FilePath -> IO FilePath
getDefaultDir xdg subdir = do
mDir <- maybeGetCabalDir
case mDir of
Just dir -> return $ dir </> subdir
Nothing -> getXdgDirectory xdg $ "cabal" </> subdir
-- | The default prefix used for installation.
defaultInstallPrefix :: IO FilePath
defaultInstallPrefix = do
mDir <- maybeGetCabalDir
case mDir of
Just dir ->
return dir
Nothing -> do
dir <- getHomeDirectory
return $ dir </> ".local"
defaultConfigFile :: IO FilePath
defaultConfigFile =
getDefaultDir XdgConfig "config"
defaultCacheHome :: IO FilePath
defaultCacheHome =
getDefaultDir XdgCache ""
defaultCacheDir :: IO FilePath
defaultCacheDir =
getDefaultDir XdgCache "packages"
defaultScriptBuildsDir :: IO FilePath
defaultScriptBuildsDir =
getDefaultDir XdgCache "script-builds"
defaultStoreDir :: IO FilePath
defaultStoreDir =
getDefaultDir XdgState "store"
defaultLogsDir :: IO FilePath
defaultLogsDir =
getDefaultDir XdgCache "logs"
defaultReportsDir :: IO FilePath
defaultReportsDir =
getDefaultDir XdgCache "reports"
defaultInstallPath :: IO FilePath
defaultInstallPath = do
mDir <- maybeGetCabalDir
case mDir of
Just dir ->
return $ dir </> "bin"
Nothing -> do
dir <- getHomeDirectory
return $ dir </> ".local" </> "bin"
defaultCompiler :: CompilerFlavor
defaultCompiler = fromMaybe GHC defaultCompilerFlavor
defaultUserInstall :: Bool
defaultUserInstall = True
-- We do per-user installs by default on all platforms. We used to default to
-- global installs on Windows but that no longer works on Windows Vista or 7.
defaultRemoteRepo :: RemoteRepo
defaultRemoteRepo = RemoteRepo name uri Nothing [] 0 False
where
str = "hackage.haskell.org"
name = RepoName str
uri = URI "http:" (Just (URIAuth "" str "")) "/" "" ""
-- Note that lots of old config files will have the old url
-- http://hackage.haskell.org/packages/archive
-- but new config files can use the new url (without the /packages/archive)
-- and avoid having to do a http redirect
-- For the default repo we know extra information, fill this in.
--
-- We need this because the 'defaultRemoteRepo' above is only used for the
-- first time when a config file is made. So for users with older config files
-- we might have only have older info. This lets us fill that in even for old
-- config files.
--
addInfoForKnownRepos :: RemoteRepo -> RemoteRepo
addInfoForKnownRepos repo
| remoteRepoName repo == remoteRepoName defaultRemoteRepo =
useSecure . tryHttps . fixOldURI $ repo
where
fixOldURI r
| isOldHackageURI (remoteRepoURI r) =
r{remoteRepoURI = remoteRepoURI defaultRemoteRepo}
| otherwise = r
tryHttps r = r{remoteRepoShouldTryHttps = True}
useSecure
r@RemoteRepo
{ remoteRepoSecure = secure
, remoteRepoRootKeys = []
, remoteRepoKeyThreshold = 0
}
| secure /= Just False =
r
{ -- Use hackage-security by default unless you opt-out with
-- secure: False
remoteRepoSecure = Just True
, remoteRepoRootKeys = defaultHackageRemoteRepoKeys
, remoteRepoKeyThreshold = defaultHackageRemoteRepoKeyThreshold
}
useSecure r = r
addInfoForKnownRepos other = other
-- | The current hackage.haskell.org repo root keys that we ship with cabal.
---
-- This lets us bootstrap trust in this repo without user intervention.
-- These keys need to be periodically updated when new root keys are added.
-- See the root key procedures for details.
--
defaultHackageRemoteRepoKeys :: [String]
defaultHackageRemoteRepoKeys =
-- Key owners and public keys are provided as a convenience to readers.
-- The canonical source for this mapping data is the hackage-root-keys
-- repository and Hackage's root.json file.
--
-- Links:
-- * https://github.com/haskell-infra/hackage-root-keys
-- * https://hackage.haskell.org/root.json
-- Please consult root.json on Hackage to map key IDs to public keys,
-- and the hackage-root-keys repository to map public keys to their
-- owners.
[ -- Adam Gundry (uRPdSiL3/MNsk50z6NB55ABo0OrrNDXigtCul4vtzmw=)
"fe331502606802feac15e514d9b9ea83fee8b6ffef71335479a2e68d84adc6b0"
, -- Gershom Bazerman (bYoUXXQ9TtX10UriaMiQtTccuXPGnmldP68djzZ7cLo=)
"1ea9ba32c526d1cc91ab5e5bd364ec5e9e8cb67179a471872f6e26f0ae773d42"
, -- John Wiegley (zazm5w480r+zPO6Z0+8fjGuxZtb9pAuoVmQ+VkuCvgU=)
"0a5c7ea47cd1b15f01f5f51a33adda7e655bc0f0b0615baa8e271f4c3351e21d"
, -- Norman Ramsey (ZI8di3a9Un0s2RBrt5GwVRvfOXVuywADfXGPZfkiDb0=)
"51f0161b906011b52c6613376b1ae937670da69322113a246a09f807c62f6921"
, -- Mathieu Boespflug (ydN1nGGQ79K1Q0nN+ul+Ln8MxikTB95w0YdGd3v3kmg=)
"be75553f3c7ba1dbe298da81f1d1b05c9d39dd8ed2616c9bddf1525ca8c03e48"
, -- Joachim Breitner (5iUgwqZCWrCJktqMx0bBMIuoIyT4A1RYGozzchRN9rA=)
"d26e46f3b631aae1433b89379a6c68bd417eb5d1c408f0643dcc07757fece522"
]
-- | The required threshold of root key signatures for hackage.haskell.org
defaultHackageRemoteRepoKeyThreshold :: Int
defaultHackageRemoteRepoKeyThreshold = 3
--
-- * Config file reading
--
-- | Loads the main configuration, and applies additional defaults to give the
-- effective configuration. To loads just what is actually in the config file,
-- use 'loadRawConfig'.
loadConfig :: Verbosity -> Flag FilePath -> IO SavedConfig
loadConfig verbosity configFileFlag = do
warnOnTwoConfigs verbosity
config <- loadRawConfig verbosity configFileFlag
extendToEffectiveConfig config
extendToEffectiveConfig :: SavedConfig -> IO SavedConfig
extendToEffectiveConfig config = do
base <- baseSavedConfig
let effective0 = base `mappend` config
globalFlags0 = savedGlobalFlags effective0
effective =
effective0
{ savedGlobalFlags =
globalFlags0
{ globalRemoteRepos =
overNubList
(map addInfoForKnownRepos)
(globalRemoteRepos globalFlags0)
}
}
return effective
-- | Like 'loadConfig' but does not apply any additional defaults, it just
-- loads what is actually in the config file. This is thus suitable for
-- comparing or editing a config file, but not suitable for using as the
-- effective configuration.
loadRawConfig :: Verbosity -> Flag FilePath -> IO SavedConfig
loadRawConfig verbosity configFileFlag = do
(source, configFile) <- getConfigFilePathAndSource configFileFlag
minp <- readConfigFile mempty configFile
case minp of
Nothing -> do
notice verbosity $
"Config file path source is " ++ sourceMsg source ++ "."
-- 2021-10-07, issue #7705
-- Only create default config file if name was not given explicitly
-- via option --config-file or environment variable.
case source of
Default -> do
notice verbosity msgNotFound
createDefaultConfigFile verbosity [] configFile
CommandlineOption -> failNoConfigFile
EnvironmentVariable -> failNoConfigFile
where
msgNotFound
| null configFile = "Config file name is empty"
| otherwise = unwords ["Config file not found:", configFile]
failNoConfigFile =
dieWithException verbosity $ FailNoConfigFile msgNotFound
Just (ParseOk ws conf) -> do