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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2013-2023 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org>
;;; Copyright © 2014, 2016 Alex Kost <alezost@gmail.com>
;;; Copyright © 2015 Mark H Weaver <mhw@netris.org>
;;; Copyright © 2015 Sou Bunnbu <iyzsong@gmail.com>
;;; Copyright © 2016, 2017, 2018, 2019, 2021, 2022 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2016 Chris Marusich <cmmarusich@gmail.com>
;;; Copyright © 2017 Huang Ying <huang.ying.caritas@gmail.com>
;;; Copyright © 2017, 2021 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2019 Kyle Meyer <kyle@kyleam.com>
;;; Copyright © 2019 Mathieu Othacehe <m.othacehe@gmail.com>
;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org>
;;; Copyright © 2014 David Thompson <davet@gnu.org>
;;; Copyright © 2022 Arun Isaac <arunisaac@systemreboot.net>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix 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 General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (guix profiles)
#:use-module ((guix config) #:select (%state-directory))
#:use-module ((guix utils) #:hide (package-name->name+version))
#:use-module ((guix build utils)
#:select (package-name->name+version mkdir-p switch-symlinks))
#:use-module ((guix diagnostics) #:select (&fix-hint formatted-message))
#:use-module (guix i18n)
#:use-module (guix records)
#:use-module (guix packages)
#:use-module (guix derivations)
#:use-module (guix search-paths)
#:use-module (guix gexp)
#:use-module (guix modules)
#:use-module (guix monads)
#:use-module (guix store)
#:use-module (ice-9 vlist)
#:use-module (ice-9 match)
#:use-module (ice-9 regex)
#:use-module (ice-9 ftw)
#:use-module (ice-9 format)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-9)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-19)
#:use-module (srfi srfi-26)
#:use-module (srfi srfi-34)
#:use-module (srfi srfi-35)
#:autoload (srfi srfi-98) (get-environment-variables)
#:export (&profile-error
profile-error?
profile-error-profile
&profile-not-found-error
profile-not-found-error?
&profile-collision-error
profile-collision-error?
profile-collision-error-entry
profile-collision-error-conflict
&missing-generation-error
missing-generation-error?
missing-generation-error-generation
&unmatched-pattern-error
unmatched-pattern-error?
unmatched-pattern-error-pattern
unmatched-pattern-error-manifest
manifest make-manifest
manifest?
manifest-entries
manifest-transitive-entries
<manifest-entry> ; FIXME: eventually make it internal
manifest-entry
manifest-entry?
manifest-entry-name
manifest-entry-version
manifest-entry-output
manifest-entry-item
manifest-entry-dependencies
manifest-entry-search-paths
manifest-entry-parent
manifest-entry-properties
lower-manifest-entry
manifest-entry=?
manifest-pattern
manifest-pattern?
manifest-pattern-name
manifest-pattern-version
manifest-pattern-output
concatenate-manifests
map-manifest-entries
manifest-remove
manifest-add
manifest-lookup
manifest-installed?
manifest-matching-entries
manifest-search-paths
check-for-collisions
manifest->code
manifest-transaction
manifest-transaction?
manifest-transaction-install
manifest-transaction-remove
manifest-transaction-install-entry
manifest-transaction-remove-pattern
manifest-transaction-null?
manifest-transaction-removal-candidate?
manifest-perform-transaction
manifest-transaction-effects
profile-manifest
package->manifest-entry
package->development-manifest
packages->manifest
ca-certificate-bundle
%default-profile-hooks
%manifest-format-version
profile-derivation
profile-search-paths
load-profile
profile
profile?
profile-name
profile-content
profile-hooks
profile-locales?
profile-allow-collisions?
profile-relative-symlinks?
generation-number
generation-profile
generation-numbers
profile-generations
relative-generation-spec->number
relative-generation
previous-generation-number
generation-time
generation-file-name
switch-to-generation
roll-back
delete-generation
%user-profile-directory
%profile-directory
%current-profile
ensure-profile-directory
canonicalize-profile
user-friendly-profile
linux-module-database))
;;; Commentary:
;;;
;;; Tools to create and manipulate profiles---i.e., the representation of a
;;; set of installed packages.
;;;
;;; Code:
;;;
;;; Condition types.
;;;
(define-condition-type &profile-error &error
profile-error?
(profile profile-error-profile))
(define-condition-type &profile-not-found-error &profile-error
profile-not-found-error?)
(define-condition-type &profile-collision-error &error
profile-collision-error?
(entry profile-collision-error-entry) ;<manifest-entry>
(conflict profile-collision-error-conflict)) ;<manifest-entry>
(define-condition-type &unmatched-pattern-error &error
unmatched-pattern-error?
(pattern unmatched-pattern-error-pattern) ;<manifest-pattern>
(manifest unmatched-pattern-error-manifest)) ;<manifest>
(define-condition-type &missing-generation-error &profile-error
missing-generation-error?
(generation missing-generation-error-generation))
;;;
;;; Manifests.
;;;
(define-record-type <manifest>
(manifest entries)
manifest?
(entries manifest-entries)) ; list of <manifest-entry>
;; Convenient alias, to avoid name clashes.
(define make-manifest manifest)
(define-record-type* <manifest-entry> manifest-entry
make-manifest-entry
manifest-entry?
(name manifest-entry-name) ; string
(version manifest-entry-version) ; string
(output manifest-entry-output ; string
(default "out"))
(item manifest-entry-item) ; package | file-like | store path
(dependencies manifest-entry-dependencies ; <manifest-entry>*
(default '()))
(search-paths manifest-entry-search-paths ; search-path-specification*
(default '()))
(parent manifest-entry-parent ; promise (#f | <manifest-entry>)
(default (delay #f)))
(properties manifest-entry-properties ; list of symbol/value pairs
(default '())))
(define-record-type* <manifest-pattern> manifest-pattern
make-manifest-pattern
manifest-pattern?
(name manifest-pattern-name) ; string
(version manifest-pattern-version ; string | #f
(default #f))
(output manifest-pattern-output ; string | #f
(default "out")))
(define (list=? = lst1 lst2)
"Return true if LST1 and LST2 have the same length and their elements are
pairwise equal per =."
(match lst1
(()
(null? lst2))
((head1 . tail1)
(match lst2
((head2 . tail2)
(and (= head1 head2) (list=? = tail1 tail2)))
(()
#f)))))
(define (manifest-entry=? entry1 entry2)
"Return true if ENTRY1 is equivalent to ENTRY2, ignoring their 'properties'
field."
(match entry1
(($ <manifest-entry> name1 version1 output1 item1 dependencies1 paths1)
(match entry2
(($ <manifest-entry> name2 version2 output2 item2 dependencies2 paths2)
(and (string=? name1 name2)
(string=? version1 version2)
(string=? output1 output2)
(equal? item1 item2) ;XXX: could be <package> vs. store item
(equal? paths1 paths2)
(list=? manifest-entry=? dependencies1 dependencies2)))))))
(define (manifest-transitive-entries manifest)
"Return the entries of MANIFEST along with their propagated inputs,
recursively."
(let loop ((entries (manifest-entries manifest))
(result '())
(visited vlist-null)) ;compare with 'manifest-entry=?'
(match entries
(()
(reverse result))
((head . tail)
(if (vhash-assoc head visited manifest-entry=?)
(loop tail result visited)
(loop (append (manifest-entry-dependencies head)
tail)
(cons head result)
(vhash-cons head #t visited)))))))
(define (profile-manifest profile)
"Return the PROFILE's manifest."
(let ((file (string-append profile "/manifest")))
(if (file-exists? file)
(call-with-input-file file read-manifest)
(manifest '()))))
(define (manifest-entry-lookup manifest)
"Return a lookup procedure for the entries of MANIFEST. The lookup
procedure takes two arguments: the entry name and output."
(define mapping
(let loop ((entries (manifest-entries manifest))
(mapping vlist-null))
(fold (lambda (entry result)
(vhash-cons (cons (manifest-entry-name entry)
(manifest-entry-output entry))
entry
(loop (manifest-entry-dependencies entry)
result)))
mapping
entries)))
(lambda (name output)
(match (vhash-assoc (cons name output) mapping)
((_ . entry) entry)
(#f #f))))
(define* (lower-manifest-entry entry system #:key target)
"Lower ENTRY for SYSTEM and TARGET such that its 'item' field is a store
file name."
(define (recurse entry)
(mapm/accumulate-builds (lambda (entry)
(lower-manifest-entry entry system
#:target target))
(manifest-entry-dependencies entry)))
(let ((item (manifest-entry-item entry)))
(if (string? item)
(with-monad %store-monad
(return entry))
(mlet %store-monad ((drv (lower-object item system
#:target target))
(dependencies (recurse entry))
(output -> (manifest-entry-output entry)))
(return (manifest-entry
(inherit entry)
(item (derivation->output-path drv output))
(dependencies dependencies)))))))
(define* (check-for-collisions manifest system #:key target)
"Check whether the entries of MANIFEST conflict with one another; raise a
'&profile-collision-error' when a conflict is encountered."
(define lookup
(manifest-entry-lookup manifest))
(define candidates
(filter-map (lambda (entry)
(let ((other (lookup (manifest-entry-name entry)
(manifest-entry-output entry))))
(and other
(not (eq? (manifest-entry-item entry)
(manifest-entry-item other)))
(list entry other))))
(manifest-transitive-entries manifest)))
(define lower-pair
(match-lambda
((first second)
(mlet %store-monad ((first (lower-manifest-entry first system
#:target target))
(second (lower-manifest-entry second system
#:target target)))
(return (list first second))))))
;; Start by lowering CANDIDATES "in parallel".
(mlet %store-monad ((lst (mapm/accumulate-builds lower-pair candidates)))
(foldm %store-monad
(lambda (entries result)
(match entries
((first second)
(if (string=? (manifest-entry-item first)
(manifest-entry-item second))
(return result)
(raise (condition
(&profile-collision-error
(entry first)
(conflict second))))))))
#t
lst)))
(define (default-properties package)
"Return the default properties of a manifest entry for PACKAGE."
;; Preserve transformation options by default.
(match (assq-ref (package-properties package) 'transformations)
(#f '())
(transformations `((transformations . ,transformations)))))
(define* (package->manifest-entry package #:optional (output "out")
#:key (parent (delay #f))
(properties (default-properties package)))
"Return a manifest entry for the OUTPUT of package PACKAGE."
;; For each dependency, keep a promise pointing to its "parent" entry.
(letrec* ((deps (map (match-lambda
((label package)
(package->manifest-entry package
#:parent (delay entry)))
((label package output)
(package->manifest-entry package output
#:parent (delay entry))))
(package-propagated-inputs package)))
(entry (manifest-entry
(name (package-name package))
(version (package-version package))
(output output)
(item package)
(dependencies (delete-duplicates deps))
(search-paths
(package-transitive-native-search-paths package))
(parent parent)
(properties properties))))
entry))
(define* (package->development-manifest package
#:optional
(system (%current-system))
#:key target)
"Return a manifest for the \"development inputs\" of PACKAGE for SYSTEM,
optionally when cross-compiling to TARGET. Development inputs include both
explicit and implicit inputs of PACKAGE."
(manifest
(filter-map (match-lambda
((label (? package? package))
(package->manifest-entry package))
((label (? package? package) output)
(package->manifest-entry package output))
;; TODO: Support <inferior-package>.
(_
#f))
(package-development-inputs package system #:target target))))
(define (packages->manifest packages)
"Return a list of manifest entries, one for each item listed in PACKAGES.
Elements of PACKAGES can be either package objects or package/string tuples
denoting a specific output of a package."
(define inferiors-loaded?
;; This hack allows us to provide seamless integration for inferior
;; packages while not having a hard dependency on (guix inferior).
(resolve-module '(guix inferior) #f #f #:ensure #f))
(define (inferior->entry)
(module-ref (resolve-interface '(guix inferior))
'inferior-package->manifest-entry))
(manifest
(delete-duplicates
(map (match-lambda
(((? package? package) output)
(package->manifest-entry package output))
((? package? package)
(package->manifest-entry package))
((thing output)
(if inferiors-loaded?
((inferior->entry) thing output)
(throw 'wrong-type-arg 'packages->manifest
"Wrong package object: ~S" (list thing) (list thing))))
(thing
(if inferiors-loaded?
((inferior->entry) thing)
(throw 'wrong-type-arg 'packages->manifest
"Wrong package object: ~S" (list thing) (list thing)))))
packages)
manifest-entry=?)))
(define %manifest-format-version
;; The current manifest format version.
4)
(define* (manifest->gexp manifest #:optional
(format-version %manifest-format-version))
"Return a representation in FORMAT-VERSION of MANIFEST as a gexp."
(define (optional name value)
(match format-version
(4
(if (null? value)
#~()
#~((#$name #$value))))
(3
(match name
('properties #~((#$name #$@value)))
(_ #~((#$name #$value)))))))
(define (entry->gexp entry)
;; Maintain in state monad a vhash of visited entries, indexed by their
;; item, usually package objects (we cannot use the entry itself as an
;; index since identical entries are usually not 'eq?'). Use that vhash
;; to avoid repeating duplicate entries. This is particularly useful in
;; the presence of propagated inputs, where we could otherwise end up
;; repeating large trees.
(mlet %state-monad ((visited (current-state)))
(if (and (= format-version 4)
(match (vhash-assq (manifest-entry-item entry) visited)
((_ . previous-entry)
(manifest-entry=? previous-entry entry))
(#f #f)))
(return #~(repeated #$(manifest-entry-name entry)
#$(manifest-entry-version entry)
(ungexp (manifest-entry-item entry)
(manifest-entry-output entry))))
(mbegin %state-monad
(set-current-state (vhash-consq (manifest-entry-item entry)
entry visited))
(mlet %state-monad ((deps (mapm %state-monad entry->gexp
(manifest-entry-dependencies entry))))
(return
(match entry
(($ <manifest-entry> name version output (? string? path)
(_ ...) (search-paths ...) _ (properties ...))
#~(#$name #$version #$output #$path
#$@(optional 'propagated-inputs deps)
#$@(optional 'search-paths
(map search-path-specification->sexp
search-paths))
#$@(optional 'properties properties)))
(($ <manifest-entry> name version output package
(_deps ...) (search-paths ...) _ (properties ...))
#~(#$name #$version #$output
(ungexp package (or output "out"))
#$@(optional 'propagated-inputs deps)
#$@(optional 'search-paths
(map search-path-specification->sexp
search-paths))
#$@(optional 'properties properties))))))))))
(unless (memq format-version '(3 4))
(raise (formatted-message
(G_ "cannot emit manifests formatted as version ~a")
format-version)))
(match manifest
(($ <manifest> (entries ...))
#~(manifest (version #$format-version)
(packages #$(run-with-state
(mapm %state-monad entry->gexp entries)
vlist-null))))))
(define (sexp->manifest sexp)
"Parse SEXP as a manifest."
(define (infer-dependency item parent)
;; Return a <manifest-entry> for ITEM.
(let-values (((name version)
(package-name->name+version
(store-path-package-name item))))
(manifest-entry
(name name)
(version version)
(item item)
(parent parent))))
(define* (sexp->manifest-entry/v3 sexp #:optional (parent (delay #f)))
;; Read SEXP as a version 3 manifest entry.
(match sexp
((name version output path
('propagated-inputs deps)
('search-paths search-paths)
extra-stuff ...)
;; For each of DEPS, keep a promise pointing to ENTRY.
(letrec* ((deps* (map (cut sexp->manifest-entry/v3 <> (delay entry))
deps))
(entry (manifest-entry
(name name)
(version version)
(output output)
(item path)
(dependencies deps*)
(search-paths (map sexp->search-path-specification
search-paths))
(parent parent)
(properties (or (assoc-ref extra-stuff 'properties)
'())))))
entry))))
(define-syntax let-fields
(syntax-rules ()
;; Bind the fields NAME of LST to same-named variables in the lexical
;; scope of BODY.
((_ lst (name rest ...) body ...)
(let ((name (match (assq 'name lst)
((_ value) value)
(#f '()))))
(let-fields lst (rest ...) body ...)))
((_ lst () body ...)
(begin body ...))))
(define* (sexp->manifest-entry sexp #:optional (parent (delay #f)))
(match sexp
(('repeated name version path)
;; This entry is the same as another one encountered earlier; look it
;; up and return it.
(mlet %state-monad ((visited (current-state))
(key -> (list name version path)))
(match (vhash-assoc key visited)
(#f
(raise (formatted-message
(G_ "invalid repeated entry in profile: ~s")
sexp)))
((_ . entry)
(return entry)))))
((name version output path fields ...)
(let-fields fields (propagated-inputs search-paths properties)
(mlet* %state-monad
((entry -> #f)
(deps (mapm %state-monad
(cut sexp->manifest-entry <> (delay entry))
propagated-inputs))
(visited (current-state))
(key -> (list name version path)))
(set! entry ;XXX: emulate 'letrec*'
(manifest-entry
(name name)
(version version)
(output output)
(item path)
(dependencies deps)
(search-paths (map sexp->search-path-specification
search-paths))
(parent parent)
(properties properties)))
(mbegin %state-monad
(set-current-state (vhash-cons key entry visited))
(return entry)))))))
(match sexp
;; Versions 0 and 1 are no longer produced since 2015.
;; Version 2 adds search paths and is slightly more verbose.
(('manifest ('version 2 minor-version ...)
('packages ((name version output path
('propagated-inputs deps)
('search-paths search-paths)
extra-stuff ...)
...)))
(manifest
(map (lambda (name version output path deps search-paths)
(letrec* ((deps* (map (cute infer-dependency <> (delay entry))
deps))
(entry (manifest-entry
(name name)
(version version)
(output output)
(item path)
(dependencies deps*)
(search-paths
(map sexp->search-path-specification
search-paths)))))
entry))
name version output path deps search-paths)))
;; Version 3 represents DEPS as full-blown manifest entries.
(('manifest ('version 3 minor-version ...)
('packages (entries ...)))
(manifest (map sexp->manifest-entry/v3 entries)))
;; Version 4 deduplicates repeated entries and makes manifest entry fields
;; such as 'propagated-inputs' and 'search-paths' optional.
(('manifest ('version 4 minor-version ...)
('packages (entries ...)))
(manifest (run-with-state
(mapm %state-monad sexp->manifest-entry entries)
vlist-null)))
(_
(raise (condition
(&message (message "unsupported manifest format")))))))
(define (read-manifest port)
"Return the packages listed in MANIFEST."
(sexp->manifest (read port)))
(define (concatenate-manifests lst)
"Concatenate the manifests listed in LST and return the resulting manifest."
(manifest (append-map manifest-entries lst)))
(define (map-manifest-entries proc manifest)
"Apply PROC to all the entries of MANIFEST and return a new manifest."
(make-manifest
(map proc (manifest-entries manifest))))
(define (entry-predicate pattern)
"Return a procedure that returns #t when passed a manifest entry that
matches NAME/OUTPUT/VERSION. OUTPUT and VERSION may be #f, in which case they
are ignored."
(match pattern
(($ <manifest-pattern> name version output)
(match-lambda
(($ <manifest-entry> entry-name entry-version entry-output)
(and (string=? entry-name name)
(or (not entry-output) (not output)
(string=? entry-output output))
(or (not version)
(string=? entry-version version))))))))
(define (manifest-remove manifest patterns)
"Remove entries for each of PATTERNS from MANIFEST. Each item in PATTERNS
must be a manifest-pattern."
(define (remove-entry pattern lst)
(remove (entry-predicate pattern) lst))
(make-manifest (fold remove-entry
(manifest-entries manifest)
patterns)))
(define (manifest-add manifest entries)
"Add a list of manifest ENTRIES to MANIFEST and return new manifest.
Remove MANIFEST entries that have the same name and output as ENTRIES."
(define (same-entry? entry name output)
(match entry
(($ <manifest-entry> entry-name _ entry-output _)
(and (equal? name entry-name)
(equal? output entry-output)))))
(make-manifest
(fold (lambda (entry result) ;XXX: quadratic
(match entry
(($ <manifest-entry> name _ out _)
(cons entry
(remove (cut same-entry? <> name out)
result)))))
(manifest-entries manifest)
entries)))
(define (manifest-lookup manifest pattern)
"Return the first item of MANIFEST that matches PATTERN, or #f if there is
no match.."
(find (entry-predicate pattern)
(manifest-entries manifest)))
(define (manifest-installed? manifest pattern)
"Return #t if MANIFEST has an entry matching PATTERN (a manifest-pattern),
#f otherwise."
(->bool (manifest-lookup manifest pattern)))
(define (manifest-matching-entries manifest patterns)
"Return all the entries of MANIFEST that match one of the PATTERNS. Raise
an '&unmatched-pattern-error' if none of the entries of MANIFEST matches one
of PATTERNS."
(fold-right (lambda (pattern matches)
(match (filter (entry-predicate pattern)
(manifest-entries manifest))
(()
(raise (condition
(&unmatched-pattern-error
(pattern pattern)
(manifest manifest)))))
(lst
(append lst matches))))
'()
patterns))
(define (manifest-search-paths manifest)
"Return the list of search path specifications that apply to MANIFEST,
including the search path specification for $PATH."
(delete-duplicates
(cons $PATH
(append-map manifest-entry-search-paths
(manifest-entries manifest)))))
(define* (manifest->code manifest
#:key (entry-package-version (const "")))
"Return an sexp representing code to build an approximate version of
MANIFEST; the code is wrapped in a top-level 'begin' form. Call
ENTRY-PACKAGE-VERSION to determine the version number to use in the spec for a
given entry; it can be set to 'manifest-entry-version' for fully-specified
version numbers, or to some other procedure to disambiguate versions for
packages for which several versions are available."
(define (entry-transformations entry)
;; Return the transformations that apply to ENTRY.
(assoc-ref (manifest-entry-properties entry) 'transformations))
(define transformation-procedures
;; List of transformation options/procedure name pairs.
(let loop ((entries (manifest-entries manifest))
(counter 1)
(result '()))
(match entries
(() result)
((entry . tail)
(match (entry-transformations entry)
(#f
(loop tail counter result))
(options
(if (assoc-ref result options)
(loop tail counter result)
(loop tail (+ 1 counter)
(alist-cons options
(string->symbol
(format #f "transform~a" counter))
result)))))))))
(define (qualified-name entry)
;; Return the name of ENTRY possibly with "@" followed by a version.
(match (entry-package-version entry)
("" (manifest-entry-name entry))
(version (string-append (manifest-entry-name entry)
"@" version))))
(if (null? transformation-procedures)
`(begin ;simplest case
(specifications->manifest
(list ,@(map (lambda (entry)
(match (manifest-entry-output entry)
("out" (qualified-name entry))
(output (string-append (qualified-name entry)
":" output))))
(manifest-entries manifest)))))
(let* ((transform (lambda (options exp)
(if (not options)
exp
(let ((proc (assoc-ref transformation-procedures
options)))
`(,proc ,exp))))))
`(begin ;transformations apply
(use-modules (guix transformations))
,@(map (match-lambda
((options . name)
`(define ,name
(options->transformation ',options))))
transformation-procedures)
(packages->manifest
(list ,@(map (lambda (entry)
(define options
(entry-transformations entry))
(define name
(qualified-name entry))
(match (manifest-entry-output entry)
("out"
(transform options
`(specification->package ,name)))
(output
`(list ,(transform
options
`(specification->package ,name))
,output))))
(manifest-entries manifest))))))))
;;;
;;; Manifest transactions.
;;;
(define-record-type* <manifest-transaction> manifest-transaction
make-manifest-transaction
manifest-transaction?
(install manifest-transaction-install ; list of <manifest-entry>
(default '()))
(remove manifest-transaction-remove ; list of <manifest-pattern>
(default '())))
(define (manifest-transaction-install-entry entry transaction)
"Augment TRANSACTION's set of installed packages with ENTRY, a
<manifest-entry>."
(manifest-transaction
(inherit transaction)
(install
(cons entry (manifest-transaction-install transaction)))))
(define (manifest-transaction-remove-pattern pattern transaction)
"Add PATTERN to TRANSACTION's list of packages to remove."
(manifest-transaction
(inherit transaction)
(remove
(cons pattern (manifest-transaction-remove transaction)))))
(define (manifest-transaction-null? transaction)
"Return true if TRANSACTION has no effect---i.e., it neither installs nor
remove software."
(match transaction
(($ <manifest-transaction> () ()) #t)
(($ <manifest-transaction> _ _) #f)))
(define (manifest-transaction-removal-candidate? entry transaction)
"Return true if ENTRY is a candidate for removal in TRANSACTION."
(any (lambda (pattern)
((entry-predicate pattern) entry))
(manifest-transaction-remove transaction)))
(define (manifest-transaction-effects manifest transaction)
"Compute the effect of applying TRANSACTION to MANIFEST. Return 4 values:
the list of packages that would be removed, installed, upgraded, or downgraded
when applying TRANSACTION to MANIFEST. Upgrades are represented as pairs
where the head is the entry being upgraded and the tail is the entry that will
replace it."
(define (manifest-entry->pattern entry)
(manifest-pattern
(name (manifest-entry-name entry))
(output (manifest-entry-output entry))))
(define manifest-entry-pair=?
(match-lambda*
(((m1a . m2a) (m1b . m2b))
(and (manifest-entry=? m1a m1b)
(manifest-entry=? m2a m2b)))
(_ #f)))
(let loop ((input (manifest-transaction-install transaction))
(install '())
(upgrade '())
(downgrade '()))
(match input
(()
(let ((remove (manifest-transaction-remove transaction)))
(values (delete-duplicates
(manifest-matching-entries manifest remove)
manifest-entry=?)
(delete-duplicates (reverse install) manifest-entry=?)
(delete-duplicates
(reverse upgrade)
manifest-entry-pair=?)
(delete-duplicates
(reverse downgrade)
manifest-entry-pair=?))))
((entry rest ...)
;; Check whether installing ENTRY corresponds to the installation of a
;; new package or to an upgrade.
;; XXX: When the exact same output directory is installed, we're not
;; really upgrading anything. Add a check for that case.
(let* ((pattern (manifest-entry->pattern entry))
(previous (manifest-lookup manifest pattern))
(newer? (and previous
(version>=? (manifest-entry-version entry)
(manifest-entry-version previous)))))
(loop rest
(if previous install (cons entry install))
(if (and previous newer?)
(alist-cons previous entry upgrade)
upgrade)
(if (and previous (not newer?))
(alist-cons previous entry downgrade)
downgrade)))))))
(define (manifest-perform-transaction manifest transaction)
"Perform TRANSACTION on MANIFEST and return the new manifest."
(let ((install (manifest-transaction-install transaction))
(remove (manifest-transaction-remove transaction)))
(manifest-add (manifest-remove manifest remove)
install)))
;;;
;;; Profiles.
;;;
(define (manifest-inputs manifest)
"Return a list of <gexp-input> objects for MANIFEST."
(define entry->input
(match-lambda
(($ <manifest-entry> name version output thing deps)
;; THING may be a package or a file name. In the latter case, assume
;; it's already valid.
(cons (gexp-input thing output)
(append-map entry->input deps)))))
(append-map entry->input (manifest-entries manifest)))
(define* (manifest-lookup-package manifest name #:optional version)
"Return as a monadic value the first package or store path referenced by
MANIFEST that is named NAME and optionally has the given VERSION prefix, or #f
if not found."
;; Return as a monadic value the package or store path referenced by the
;; manifest ENTRY, or #f if not referenced.
(define (entry-lookup-package entry)
(define (find-among-inputs inputs)
(find (lambda (input)
(and (package? input)
(equal? name (package-name input))
(if version
(string-prefix? version (package-version input))
#t)))
inputs))
(define (find-among-store-items items)
(find (lambda (item)
(let-values (((name* version*)
(package-name->name+version
(store-path-package-name item))))
(and (string=? name name*)
(if version
(string-prefix? version version*)
#t))))
items))
(with-monad %store-monad
(match (manifest-entry-item entry)
((? package? package)
(match (cons (list (package-name package) package)
(package-transitive-inputs package))
(((labels inputs . _) ...)
(return (find-among-inputs inputs)))))
((? string? item)
(mlet %store-monad ((refs (references* item)))
(return (find-among-store-items refs))))
(item
;; XXX: ITEM might be a 'computed-file' or anything like that, in
;; which case we don't know what to do. The fix may be to check
;; references once ITEM is compiled, as proposed at
;; <https://bugs.gnu.org/29927>.
(return #f)))))
(anym %store-monad
entry-lookup-package (manifest-entries manifest)))
(define (info-dir-file manifest)
"Return a derivation that builds the 'dir' file for all the entries of
MANIFEST."
(define texinfo ;lazy reference
(module-ref (resolve-interface '(gnu packages texinfo)) 'texinfo))
(define gzip ;lazy reference
(module-ref (resolve-interface '(gnu packages compression)) 'gzip))
(define glibc-utf8-locales ;lazy reference
(module-ref (resolve-interface '(gnu packages base)) 'glibc-utf8-locales))
(define build
(with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils)
(srfi srfi-1) (srfi srfi-26)
(ice-9 ftw))
(define (info-file? file)
(or (string-suffix? ".info" file)
(string-suffix? ".info.gz" file)))
(define (info-files top)
(let ((infodir (string-append top "/share/info")))
(map (cut string-append infodir "/" <>)
(or (scandir infodir info-file?) '()))))
(define (info-file-language file)
(let* ((base (if (string-suffix? ".gz" file)
(basename file ".info.gz")
(basename file ".info")))
(dot (string-rindex base #\.)))
(if dot
(string-drop base (+ 1 dot))
"en")))
(define (install-info info)
(let ((language (info-file-language info)))
;; We need to choose a valid locale for $LANGUAGE to be honored.
(setenv "LC_ALL" "en_US.utf8")
(setenv "LANGUAGE" language)
(zero?
(system* #+(file-append texinfo "/bin/install-info")
info
(apply string-append #$output "/share/info/dir"
(if (string=? "en" language)
'("")
`("." ,language)))))))
(setenv "PATH" (string-append #+gzip "/bin")) ;for info.gz files
(setenv "GUIX_LOCPATH"
#+(file-append glibc-utf8-locales "/lib/locale"))
(mkdir-p (string-append #$output "/share/info"))
(exit (every install-info
(append-map info-files
'#$(manifest-inputs manifest)))))))
(gexp->derivation "info-dir" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . info-dir))))
(define (ghc-package-cache-file manifest)
"Return a derivation that builds the GHC 'package.cache' file for all the
entries of MANIFEST, or #f if MANIFEST does not have any GHC packages."
(define ghc ;lazy reference
(module-ref (resolve-interface '(gnu packages haskell)) 'ghc))
(define build
(with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils)
(srfi srfi-1) (srfi srfi-26)
(ice-9 ftw))
(define ghc-name-version
(let* ((base (basename #+ghc)))
(string-drop base
(+ 1 (string-index base #\-)))))
(define db-subdir
(string-append "lib/" ghc-name-version "/package.conf.d"))
(define db-dir
(string-append #$output "/" db-subdir))
(define (conf-files top)
(let ((db (string-append top "/" db-subdir)))
(if (file-exists? db)
(find-files db "\\.conf$")
'())))
(define (copy-conf-file conf)
(let ((base (basename conf)))
(copy-file conf (string-append db-dir "/" base))))
(system* (string-append #+ghc "/bin/ghc-pkg") "init" db-dir)
(for-each copy-conf-file
(append-map conf-files
(delete-duplicates
'#$(manifest-inputs manifest))))
(let ((success
(zero?
(system* (string-append #+ghc "/bin/ghc-pkg") "recache"
(string-append "--package-db=" db-dir)))))
(for-each delete-file (find-files db-dir "\\.conf$"))
(exit success)))))
(with-monad %store-monad
;; Don't depend on GHC when there's nothing to do.
(if (any (cut string-prefix? "ghc" <>)
(map manifest-entry-name (manifest-entries manifest)))
(gexp->derivation "ghc-package-cache" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . ghc-package-cache)))
(return #f))))
(define (ca-certificate-bundle manifest)
"Return a derivation that builds a single-file bundle containing the CA
certificates in the /etc/ssl/certs sub-directories of the packages in
MANIFEST. Single-file bundles are required by programs such as Git and Lynx."
;; See <http://lists.gnu.org/archive/html/guix-devel/2015-02/msg00429.html>
;; for a discussion.
(define glibc-utf8-locales ;lazy reference
(module-ref (resolve-interface '(gnu packages base)) 'glibc-utf8-locales))
(define build
(with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils)
(rnrs io ports)
(srfi srfi-1)
(srfi srfi-26)
(ice-9 ftw)
(ice-9 match))
(define (pem-file? file)
(string-suffix? ".pem" file))
(define (ca-files top)
(let ((cert-dir (string-append top "/etc/ssl/certs")))
(map (cut string-append cert-dir "/" <>)
(or (scandir cert-dir pem-file?) '()))))
(define (concatenate-files files result)
"Make RESULT the concatenation of all of FILES."
(define (dump file port)
(display (call-with-input-file file get-string-all)
port)
(newline port)) ;required, see <https://bugs.debian.org/635570>
(call-with-output-file result
(lambda (port)
(for-each (cut dump <> port) files))))
;; Some file names in the NSS certificates are UTF-8 encoded so
;; install a UTF-8 locale.
(setenv "LOCPATH"
(string-append #+glibc-utf8-locales "/lib/locale/"
#+(version-major+minor
(package-version glibc-utf8-locales))))
(setlocale LC_ALL "en_US.utf8")
(match (append-map ca-files '#$(manifest-inputs manifest))
(()
;; Since there are no CA files, just create an empty directory. Do
;; not create the etc/ssl/certs sub-directory, since that would
;; wrongfully lead to a message about 'SSL_CERT_DIR' needing to be
;; defined.
(mkdir #$output)
#t)
((ca-files ...)
(let ((result (string-append #$output "/etc/ssl/certs")))
(mkdir-p result)
(concatenate-files ca-files
(string-append result
"/ca-certificates.crt"))
#t))))))
(gexp->derivation "ca-certificate-bundle" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . ca-certificate-bundle))))
(define (emacs-subdirs manifest)
(define build
(with-imported-modules (source-module-closure
'((guix build profiles)
(guix build utils)))
#~(begin
(use-modules (guix build utils)
(guix build profiles)
(ice-9 ftw) ; scandir
(srfi srfi-1) ; append-map
(srfi srfi-26))
(let ((destdir (string-append #$output "/share/emacs/site-lisp"))
(subdirs
(append-map
(lambda (dir)
(filter
file-is-directory?
(map (cute string-append dir "/" <>)
(scandir dir (negate (cute member <> '("." "..")))))))
(filter file-exists?
(map (cute string-append <> "/share/emacs/site-lisp")
'#$(manifest-inputs manifest))))))
(mkdir-p destdir)
(with-directory-excursion destdir
(call-with-output-file "subdirs.el"
(lambda (port)
(write
`(normal-top-level-add-to-load-path
(list ,@(delete-duplicates subdirs)))
port)
(newline port)
#t)))))))
(gexp->derivation "emacs-subdirs" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . emacs-subdirs))))
(define (gdk-pixbuf-loaders-cache-file manifest)
"Return a derivation that produces a loaders cache file for every gdk-pixbuf
loaders discovered in MANIFEST."
(define gdk-pixbuf ;lazy reference
(module-ref (resolve-interface '(gnu packages gtk)) 'gdk-pixbuf))
(mlet* %store-monad
((gdk-pixbuf (manifest-lookup-package manifest "gdk-pixbuf"))
(librsvg (manifest-lookup-package manifest "librsvg"))
(gdk-pixbuf-bin -> (if (string? gdk-pixbuf)
(string-append gdk-pixbuf "/bin")
(file-append gdk-pixbuf "/bin"))))
(define build
(with-imported-modules (source-module-closure
'((guix build glib-or-gtk-build-system)))
#~(begin
(use-modules (guix build glib-or-gtk-build-system))
(setenv "PATH" (string-append #$gdk-pixbuf-bin ":" (getenv "PATH")))
(generate-gdk-pixbuf-loaders-cache
;; XXX: MANIFEST-LOOKUP-PACKAGE transitively searches through
;; every input referenced by the manifest, while MANIFEST-INPUTS
;; only retrieves the immediate inputs as well as their
;; propagated inputs; to avoid causing an empty output derivation
;; we must ensure that the inputs contain at least one
;; loaders.cache file. This is why we include gdk-pixbuf or
;; librsvg when they are transitively found.
(list #$@(if gdk-pixbuf
(list gdk-pixbuf)
'())
#$@(if librsvg
(list librsvg)
'())
#$@(manifest-inputs manifest))
(list #$output)))))
(if gdk-pixbuf
(gexp->derivation "gdk-pixbuf-loaders-cache-file" build
#:local-build? #t
#:substitutable? #f
#:properties
'((type . profile-hook)
(hook . gdk-pixbuf-loaders-cache-file)))
(return #f))))
(define (glib-schemas manifest)
"Return a derivation that unions all schemas from manifest entries and
creates the Glib 'gschemas.compiled' file."
(define glib ; lazy reference
(module-ref (resolve-interface '(gnu packages glib)) 'glib))
(mlet %store-monad ((%glib (manifest-lookup-package manifest "glib"))
;; XXX: Can't use glib-compile-schemas corresponding
;; to the glib referenced by 'manifest'. Because
;; '%glib' can be either a package or store path, and
;; there's no way to get the "bin" output for the later.
(glib-compile-schemas
-> #~(string-append #+glib:bin
"/bin/glib-compile-schemas")))
(define build
(with-imported-modules '((guix build utils)
(guix build union)
(guix build profiles)
(guix search-paths)
(guix records))
#~(begin
(use-modules (guix build utils)
(guix build union)
(guix build profiles)
(srfi srfi-26))
(let* ((destdir (string-append #$output "/share/glib-2.0/schemas"))
(schemadirs (filter file-exists?
(map (cut string-append <> "/share/glib-2.0/schemas")
'#$(manifest-inputs manifest)))))
;; Union all the schemas.
(mkdir-p (string-append #$output "/share/glib-2.0"))
(union-build destdir schemadirs
#:log-port (%make-void-port "w"))
(let ((dir destdir))
(when (file-is-directory? dir)
(ensure-writable-directory dir)
(invoke #+glib-compile-schemas
(string-append "--targetdir=" dir)
dir)))))))
;; Don't run the hook when there's nothing to do.
(if %glib
(gexp->derivation "glib-schemas" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . glib-schemas)))
(return #f))))
(define (gtk-icon-themes manifest)
"Return a derivation that unions all icon themes from manifest entries and
creates the GTK+ 'icon-theme.cache' file for each theme."
(define gtk+ ; lazy reference
(module-ref (resolve-interface '(gnu packages gtk)) 'gtk+))
(mlet %store-monad ((%gtk+ (manifest-lookup-package manifest "gtk+"))
;; XXX: Can't use gtk-update-icon-cache corresponding
;; to the gtk+ referenced by 'manifest'. Because
;; '%gtk+' can be either a package or store path, and
;; there's no way to get the "bin" output for the later.
(gtk-update-icon-cache
-> #~(string-append #+gtk+:bin
"/bin/gtk-update-icon-cache")))
(define build
(with-imported-modules '((guix build utils)
(guix build union)
(guix build profiles)
(guix search-paths)
(guix records))
#~(begin
(use-modules (guix build utils)
(guix build union)
(guix build profiles)
(srfi srfi-26)
(ice-9 ftw))
(let* ((destdir (string-append #$output "/share/icons"))
(icondirs (filter file-exists?
(map (cut string-append <> "/share/icons")
'#$(manifest-inputs manifest)))))
;; Union all the icons.
(mkdir-p (string-append #$output "/share"))
(union-build destdir icondirs
#:log-port (%make-void-port "w"))
;; Update the 'icon-theme.cache' file for each icon theme.
(for-each
(lambda (theme)
(let ((dir (string-append destdir "/" theme)))
;; Occasionally DESTDIR contains plain files, such as
;; "abiword_48.png". Ignore these.
(when (file-is-directory? dir)
(ensure-writable-directory dir)
(system* #+gtk-update-icon-cache "-t" dir "--quiet"))))
(scandir destdir (negate (cut member <> '("." "..")))))))))
;; Don't run the hook when there's nothing to do.
(if %gtk+
(gexp->derivation "gtk-icon-themes" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . gtk-icon-themes)))
(return #f))))
(define (gtk-im-modules manifest)
"Return a derivation that builds the cache files for input method modules
for both major versions of GTK+."
(mlet %store-monad ((gtk+ (manifest-lookup-package manifest "gtk+" "3"))
(gtk+-2 (manifest-lookup-package manifest "gtk+" "2")))
(define (build gtk gtk-version query)
(let ((major (string-take gtk-version 1)))
(with-imported-modules '((guix build utils)
(guix build union)
(guix build profiles)
(guix search-paths)
(guix records))
#~(begin
(use-modules (guix build utils)
(guix build union)
(guix build profiles)
(ice-9 popen)
(srfi srfi-1)
(srfi srfi-26))
(let* ((prefix (string-append "/lib/gtk-" #$major ".0/"
#$gtk-version))
(destdir (string-append #$output prefix))
(moddirs (cons (string-append #$gtk prefix "/immodules")
(filter file-exists?
(map (cut string-append <> prefix "/immodules")
'#$(manifest-inputs manifest)))))
(modules (append-map (cut find-files <> "\\.so$")
moddirs)))
;; Generate a new immodules cache file.
(mkdir-p (string-append #$output prefix))
(let ((pipe (apply open-pipe* OPEN_READ #$query modules))
(outfile (string-append #$output prefix
"/immodules-gtk" #$major ".cache")))
(dynamic-wind
(const #t)
(lambda ()
(call-with-output-file outfile
(lambda (out)
(while (not (eof-object? (peek-char pipe)))
(write-char (read-char pipe) out))))
#t)
(lambda ()
(close-pipe pipe)))))))))
;; Don't run the hook when there's nothing to do.
(let* ((pkg-gtk+ (module-ref ; lazy reference
(resolve-interface '(gnu packages gtk)) 'gtk+))
(pkg-gtk+2 (module-ref ; lazy reference
(resolve-interface '(gnu packages gtk)) 'gtk+-2))
(gexp #~(begin
#$(if gtk+
(build
gtk+ "3.0.0"
;; Use 'gtk-query-immodules-3.0' from the 'bin'
;; output of latest gtk+ package.
#~(string-append
#$pkg-gtk+:bin "/bin/gtk-query-immodules-3.0"))
#t)
#$(if gtk+-2
(build
gtk+-2 "2.10.0"
#~(string-append
#$pkg-gtk+2:bin "/bin/gtk-query-immodules-2.0"))
#t))))
(if (or gtk+ gtk+-2)
(gexp->derivation "gtk-im-modules" gexp
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . gtk-im-modules)))
(return #f)))))
(define (linux-module-database manifest)
"Return a derivation that unites all the kernel modules of the manifest
and creates the dependency graph of all these kernel modules.
This is meant to be used as a profile hook."
(define kmod ; lazy reference
(module-ref (resolve-interface '(gnu packages linux)) 'kmod))
(define guile-zlib
(module-ref (resolve-interface '(gnu packages guile)) 'guile-zlib))
(define build
(with-imported-modules (source-module-closure
'((guix build utils)
(gnu build linux-modules)))
(with-extensions (list guile-zlib)
#~(begin
(use-modules (ice-9 ftw)
(ice-9 match)
(srfi srfi-1) ; append-map
(gnu build linux-modules))
(let* ((inputs '#$(manifest-inputs manifest))
(module-directories
(map (lambda (directory)
(string-append directory "/lib/modules"))
inputs))
(directory-entries
(lambda (directory)
(or (scandir directory
(lambda (basename)
(not (string-prefix? "." basename))))
'())))
;; Note: Should usually result in one entry.
(versions (delete-duplicates
(append-map directory-entries
module-directories))))
(match versions
((version)
(let ((old-path (getenv "PATH")))
(setenv "PATH" #+(file-append kmod "/bin"))
(make-linux-module-directory inputs version #$output)
(setenv "PATH" old-path)))
(()
;; Nothing here, maybe because this is a kernel with
;; CONFIG_MODULES=n.
(mkdir #$output))
(_ (error "Specified Linux kernel and Linux kernel modules
are not all of the same version"))))))))
(gexp->derivation "linux-module-database" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . linux-module-database))))
(define (xdg-desktop-database manifest)
"Return a derivation that builds the @file{mimeinfo.cache} database from
desktop files. It's used to query what applications can handle a given
MIME type."
(define desktop-file-utils ; lazy reference
(module-ref (resolve-interface '(gnu packages freedesktop))
'desktop-file-utils))
(mlet %store-monad ((glib
(manifest-lookup-package
manifest "glib")))
(define build
(with-imported-modules '((guix build utils)
(guix build union))
#~(begin
(use-modules (srfi srfi-26)
(guix build utils)
(guix build union))
(let* ((destdir (string-append #$output "/share/applications"))
(appdirs (filter file-exists?
(map (cut string-append <>
"/share/applications")
'#$(manifest-inputs manifest))))
(update-desktop-database (string-append
#+desktop-file-utils
"/bin/update-desktop-database")))
(mkdir-p (string-append #$output "/share"))
(union-build destdir appdirs
#:log-port (%make-void-port "w"))
(exit (zero? (system* update-desktop-database destdir)))))))
;; Don't run the hook when 'glib' is not referenced.
(if glib
(gexp->derivation "xdg-desktop-database" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . xdg-desktop-database)))
(return #f))))
(define (xdg-mime-database manifest)
"Return a derivation that builds the @file{mime.cache} database from manifest
entries. It's used to query the MIME type of a given file."
(define shared-mime-info ; lazy reference
(module-ref (resolve-interface '(gnu packages gnome)) 'shared-mime-info))
(mlet %store-monad ((glib (manifest-lookup-package manifest "glib")))
(define build
(with-imported-modules '((guix build utils)
(guix build union))
#~(begin
(use-modules (guix build utils)
(guix build union)
(srfi srfi-26)
(ice-9 match))
(let* ((datadir (string-append #$output "/share"))
(destdir (string-append datadir "/mime"))
(pkgdirs (filter file-exists?
(map (cut string-append <>
"/share/mime/packages")
(cons #+shared-mime-info
'#$(manifest-inputs manifest))))))
(match pkgdirs
((shared-mime-info)
;; PKGDIRS contains nothing but 'shared-mime-info', which
;; already contains its database, so nothing to do.
(mkdir-p datadir)
(symlink #$(file-append shared-mime-info "/share/mime")
destdir))
(_
;; PKGDIRS contains additional packages providing
;; 'share/mime/packages' (very few packages do so) so rebuild
;; the database. TODO: Find a way to avoid reprocessing
;; 'shared-mime-info', which is the most expensive one.
(mkdir-p destdir)
(union-build (string-append destdir "/packages") pkgdirs
#:log-port (%make-void-port "w"))
(setenv "XDG_DATA_HOME" datadir)
(invoke #+(file-append shared-mime-info
"/bin/update-mime-database")
destdir)))))))
;; Don't run the hook when there are no GLib based applications.
(if glib
(gexp->derivation "xdg-mime-database" build
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . xdg-mime-database)))
(return #f))))
;; Several font packages may install font files into same directory, so
;; fonts.dir and fonts.scale file should be generated here, instead of in
;; packages.
(define (fonts-dir-file manifest)
"Return a derivation that builds the @file{fonts.dir} and @file{fonts.scale}
files for the fonts of the @var{manifest} entries."
(define mkfontscale
(module-ref (resolve-interface '(gnu packages xorg)) 'mkfontscale))
(define mkfontdir
(module-ref (resolve-interface '(gnu packages xorg)) 'mkfontdir))
(define build
#~(begin
(use-modules (srfi srfi-26)
(guix build utils)
(guix build union))
(let ((fonts-dirs (filter file-exists?
(map (cut string-append <>
"/share/fonts")
'#$(manifest-inputs manifest)))))
(mkdir #$output)
(if (null? fonts-dirs)
(exit #t)
(let* ((share-dir (string-append #$output "/share"))
(fonts-dir (string-append share-dir "/fonts"))
(mkfontscale (string-append #+mkfontscale
"/bin/mkfontscale"))
(mkfontdir (string-append #+mkfontdir
"/bin/mkfontdir"))
(empty-file? (lambda (filename)
(call-with-ascii-input-file filename
(lambda (p)
(eqv? #\0 (read-char p))))))
(fonts-dir-file "fonts.dir")
(fonts-scale-file "fonts.scale"))
(mkdir-p share-dir)
;; Create all sub-directories, because we may create fonts.dir
;; and fonts.scale files in the sub-directories.
(union-build fonts-dir fonts-dirs
#:log-port (%make-void-port "w")
#:create-all-directories? #t)
(let ((directories (find-files fonts-dir
(lambda (file stat)
(eq? 'directory (stat:type stat)))
#:directories? #t)))
(for-each (lambda (dir)
(with-directory-excursion dir
(when (file-exists? fonts-scale-file)
(delete-file fonts-scale-file))
(when (file-exists? fonts-dir-file)
(delete-file fonts-dir-file))
(unless (and (zero? (system* mkfontscale))
(zero? (system* mkfontdir)))
(exit #f))
(when (and (file-exists? fonts-scale-file)
(empty-file? fonts-scale-file))
(delete-file fonts-scale-file))
(when (and (file-exists? fonts-dir-file)
(empty-file? fonts-dir-file))
(delete-file fonts-dir-file))))
directories)))))))
(gexp->derivation "fonts-dir" build
#:modules '((guix build utils)
(guix build union)
(srfi srfi-26))
#:local-build? #t
#:substitutable? #f
#:properties
`((type . profile-hook)
(hook . fonts-dir))))
(define (manual-database manifest)
"Return a derivation that builds the manual page database (\"mandb\") for
the entries in MANIFEST."
(define gdbm-ffi
(module-ref (resolve-interface '(gnu packages guile))
'guile-gdbm-ffi))
(define guile-zlib
(module-ref (resolve-interface '(gnu packages guile)) 'guile-zlib))
(define modules
(delete '(guix config)
(source-module-closure `((guix build utils)
(guix man-db)))))
(define build
(with-imported-modules modules
(with-extensions (list gdbm-ffi ;for (guix man-db)
guile-zlib)
#~(begin
(use-modules (guix man-db)
(guix build utils)
(ice-9 threads)
(srfi srfi-1)
(srfi srfi-19))
(define (print-string msg)
(display msg)
(force-output))
(define-syntax-rule (print fmt args ...)
;; Build up the string and display it at once.
(print-string (format #f fmt args ...)))
(define (compute-entry directory count total)
(print "\r[~3d/~3d] building list of man-db entries..."
count total)
(let ((man (string-append directory "/share/man")))
(if (directory-exists? man)
(mandb-entries man)
'())))
(define (compute-entries)
;; This is the most expensive part (I/O and CPU, due to
;; decompression), so report progress as we traverse INPUTS.
;; Cap at 4 threads because we don't see any speedup beyond that
;; on an SSD laptop.
(let* ((inputs '#$(manifest-inputs manifest))
(total (length inputs))
(threads (min (parallel-job-count) 4)))
(concatenate
(n-par-map threads compute-entry inputs
(iota total 1)
(make-list total total)))))
(define man-directory
(string-append #$output "/share/man"))
(mkdir-p man-directory)
(format #t "Creating manual page database...~%")
(force-output)
(let* ((start (current-time))
(entries (compute-entries))
(_ (write-mandb-database (string-append man-directory
"/index.db")
entries))
(duration (time-difference (current-time) start)))
(newline)
(format #t "~a entries processed in ~,1f s~%"
(length entries)
(+ (time-second duration)
(* (time-nanosecond duration) (expt 10 -9))))
(force-output))))))
(gexp->derivation "manual-database" build
#:substitutable? #f
#:local-build? #t
#:properties
`((type . profile-hook)
(hook . manual-database))))
(define (manual-database/optional manifest)
"Return a derivation to build the manual database of MANIFEST, but only if
MANIFEST contains the \"man-db\" package. Otherwise, return #f."
;; Building the man database (for "man -k") is expensive and rarely used.
;; Build it only if the profile also contains "man-db".
(mlet %store-monad ((man-db (manifest-lookup-package manifest "man-db")))
(if man-db
(manual-database manifest)
(return #f))))
(define (texlive-font-maps manifest)
"Return a derivation that builds the TeX Live font maps for the entries in
MANIFEST."
(define entry->texlive-input
(match-lambda
(($ <manifest-entry> name version output thing deps)
(if (string-prefix? "texlive-" name)
(cons (gexp-input thing output)
(append-map entry->texlive-input deps))
'()))))
(define texlive-inputs
(append-map entry->texlive-input (manifest-entries manifest)))
(define texlive-scripts
(module-ref (resolve-interface '(gnu packages tex)) 'texlive-scripts))
(define texlive-libkpathsea
(module-ref (resolve-interface '(gnu packages tex)) 'texlive-libkpathsea))
(define coreutils
(module-ref (resolve-interface '(gnu packages base)) 'coreutils))
(define grep
(module-ref (resolve-interface '(gnu packages base)) 'grep))
(define sed
(module-ref (resolve-interface '(gnu packages base)) 'sed))
(define updmap.cfg
(module-ref (resolve-interface '(gnu packages tex))
'texlive-default-updmap.cfg))
(define build
(with-imported-modules '((guix build utils)
(guix build union))
#~(begin
(use-modules (guix build utils)
(guix build union)
(ice-9 popen))
;; Build a modifiable union of all texlive inputs. We do this so
;; that TeX live can resolve the parent and grandparent directories
;; correctly. There might be a more elegant way to accomplish this.
(union-build "/tmp/texlive"
'#$texlive-inputs
#:create-all-directories? #t
#:log-port (%make-void-port "w"))
;; XXX: This is annoying, but it's necessary because
;; texlive-libkpathsea does not provide wrapped executables.
(setenv "PATH"
(string-append #$(file-append coreutils "/bin")
":"
#$(file-append grep "/bin")
":"
#$(file-append sed "/bin")
":"
#$(file-append texlive-libkpathsea "/bin")))
(setenv "PERL5LIB" #$(file-append texlive-scripts "/share/tlpkg"))
(setenv "GUIX_TEXMF" "/tmp/texlive/share/texmf-dist")
;; Remove invalid maps from config file.
(let* ((web2c (string-append #$output "/share/texmf-dist/web2c/"))
(maproot (string-append #$output "/share/texmf-dist/fonts/map/"))
(updmap.cfg (string-append web2c "updmap.cfg")))
(install-file #$(file-append updmap.cfg "/web2c/updmap.cfg") web2c)
(make-file-writable updmap.cfg)
(let* ((port (open-pipe* OPEN_WRITE
#$(file-append texlive-scripts "/bin/updmap-sys")
"--syncwithtrees"
"--nohash"
"--force"
(string-append "--cnffile=" updmap.cfg))))
(display "Y\n" port)
(when (not (zero? (status:exit-val (close-pipe port))))
(error "failed to filter updmap.cfg")))
;; Generate font maps.
(invoke #$(file-append texlive-scripts "/bin/updmap-sys")
(string-append "--cnffile=" updmap.cfg)
(string-append "--dvipdfmxoutputdir="
maproot "dvipdfmx/updmap")
(string-append "--dvipsoutputdir="
maproot "dvips/updmap")
(string-append "--pdftexoutputdir="
maproot "pdftex/updmap"))
;; Create ls-R file. I know, that's not *just* for font maps, but
;; we've generated new files, so there's no point in running it
;; any earlier. The ls-R file must act on a full TeX Live tree,
;; but we have two: the one in /tmp containing all packages and
;; the one in #$output containing the generated font maps. To
;; avoid having to merge ls-R files, we copy the generated stuff
;; to /tmp and run mktexlsr only once.
(let ((a (string-append #$output "/share/texmf-dist"))
(b "/tmp/texlive/share/texmf-dist")
(mktexlsr #$(file-append texlive-scripts "/bin/mktexlsr")))
(copy-recursively a b)
(invoke mktexlsr b)
(install-file (string-append b "/ls-R") a))))))
(with-monad %store-monad
(if (pair? texlive-inputs)
(gexp->derivation "texlive-font-maps" build
#:substitutable? #f
#:local-build? #t
#:properties
`((type . profile-hook)
(hook . texlive-font-maps)))
(return #f))))
(define %default-profile-hooks
;; This is the list of derivation-returning procedures that are called by
;; default when making a non-empty profile.
(list info-dir-file
manual-database/optional
fonts-dir-file
ghc-package-cache-file
ca-certificate-bundle
emacs-subdirs
gdk-pixbuf-loaders-cache-file
glib-schemas
gtk-icon-themes
gtk-im-modules
texlive-font-maps
xdg-desktop-database
xdg-mime-database))
(define* (profile-derivation manifest
#:key
(name "profile")
(hooks %default-profile-hooks)
(locales? #t)
(allow-unsupported-packages? #f)
(allow-collisions? #f)
(relative-symlinks? #f)
(format-version %manifest-format-version)
system target)
"Return a derivation that builds a profile (aka. 'user environment') with
the given MANIFEST. The profile includes additional derivations returned by
the monadic procedures listed in HOOKS--such as an Info 'dir' file, etc.
Unless ALLOW-COLLISIONS? is true, a '&profile-collision-error' is raised if
entries in MANIFEST collide (for instance if there are two same-name packages
with a different version number.) Unless ALLOW-UNSUPPORTED-PACKAGES? is true
or TARGET is set, raise an error if MANIFEST contains a package that does not
support SYSTEM.
When LOCALES? is true, the build is performed under a UTF-8 locale; this adds
a dependency on the 'glibc-utf8-locales' package.
When RELATIVE-SYMLINKS? is true, use relative file names for symlink targets.
This is one of the things to do for the result to be relocatable.
When TARGET is true, it must be a GNU triplet, and the packages in MANIFEST
are cross-built for TARGET."
(define (check-supported-packages system)
;; Raise an error if a package in MANIFEST does not support SYSTEM.
(map-manifest-entries
(lambda (entry)
(match (manifest-entry-item entry)
((? package? package)
(unless (supported-package? package system)
(raise (formatted-message (G_ "package ~a does not support ~a")
(package-full-name package) system))))
(_ #t)))
manifest))
(mlet* %store-monad ((system (if system
(return system)
(current-system)))
(target (if target
(return target)
(current-target-system)))
(ok? -> (or allow-unsupported-packages? target
(check-supported-packages system)))
(ok? (if allow-collisions?
(return #t)
(check-for-collisions manifest system
#:target target)))
(extras (if (null? (manifest-entries manifest))
(return '())
(mapm/accumulate-builds (lambda (hook)
(hook manifest))
hooks))))
(define extra-inputs
(filter-map (lambda (drv)
(and (derivation? drv) (gexp-input drv)))
extras))
(define glibc-utf8-locales ;lazy reference
(module-ref (resolve-interface '(gnu packages base))
'glibc-utf8-locales))
(define set-utf8-locale
;; Some file names (e.g., in 'nss-certs') are UTF-8 encoded so
;; install a UTF-8 locale.
#~(begin
(setenv "LOCPATH"
#$(file-append glibc-utf8-locales "/lib/locale/"
(version-major+minor
(package-version glibc-utf8-locales))))
(setlocale LC_ALL "en_US.utf8")))
(define builder
(with-imported-modules '((guix build profiles)
(guix build union)
(guix build utils)
(guix search-paths)
(guix records))
#~(begin
(use-modules (guix build profiles)
(guix search-paths)
(srfi srfi-1))
(let ((line (cond-expand (guile-2.2 'line)
(else _IOLBF)))) ;Guile 2.0
(setvbuf (current-output-port) line)
(setvbuf (current-error-port) line))
#+(if locales? set-utf8-locale #t)
(build-profile #$output '#$(manifest->gexp manifest format-version)
#:extra-inputs '#$extra-inputs
#:symlink #$(if relative-symlinks?
#~symlink-relative
#~symlink)))))
(gexp->derivation name builder
#:system system
#:target target
;; Don't complain about _IO* on Guile 2.2.
#:env-vars '(("GUILE_WARN_DEPRECATED" . "no"))
;; Not worth offloading.
#:local-build? #t
;; Disable substitution because it would trigger a
;; connection to the substitute server, which is likely
;; to have no substitute to offer.
#:substitutable? #f
#:properties `((type . profile)
(profile
(count
. ,(length
(manifest-entries manifest))))))))
;; Declarative profile.
(define-record-type* <profile> profile make-profile
profile?
(name profile-name (default "profile")) ;string
(content profile-content) ;<manifest>
(hooks profile-hooks ;list of procedures
(default %default-profile-hooks))
(locales? profile-locales? ;Boolean
(default #t))
(allow-collisions? profile-allow-collisions? ;Boolean
(default #f))
(relative-symlinks? profile-relative-symlinks? ;Boolean
(default #f))
(format-version profile-format-version ;integer
(default %manifest-format-version)))
(define-gexp-compiler (profile-compiler (profile <profile>) system target)
"Compile PROFILE to a derivation."
(match profile
(($ <profile> name manifest hooks
locales? allow-collisions? relative-symlinks?
format-version)
(profile-derivation manifest
#:name name
#:hooks hooks
#:locales? locales?
#:allow-collisions? allow-collisions?
#:relative-symlinks? relative-symlinks?
#:format-version format-version
#:system system #:target target))))
(define* (profile-search-paths profile
#:optional (manifest (profile-manifest profile))
#:key (getenv (const #f)))
"Read the manifest of PROFILE and evaluate the values of search path
environment variables required by PROFILE; return a list of
specification/value pairs. If MANIFEST is not #f, it is assumed to be the
manifest of PROFILE, which avoids rereading it.
Use GETENV to determine the current settings and report only settings not
already effective."
(evaluate-search-paths (manifest-search-paths manifest)
(list profile) getenv))
(define %precious-variables
;; Environment variables in the default 'load-profile' white list.
'("HOME" "USER" "LOGNAME" "DISPLAY" "XAUTHORITY" "TERM" "TZ" "PAGER"))
(define (purify-environment white-list white-list-regexps)
"Unset all environment variables except those that match the regexps in
WHITE-LIST-REGEXPS and those listed in WHITE-LIST."
(for-each unsetenv
(remove (lambda (variable)
(or (member variable white-list)
(find (cut regexp-exec <> variable)
white-list-regexps)))
(match (get-environment-variables)
(((names . _) ...)
names)))))
(define* (load-profile profile
#:optional (manifest (profile-manifest profile))
#:key pure? (white-list-regexps '())
(white-list %precious-variables))
"Set the environment variables specified by MANIFEST for PROFILE. When
PURE? is #t, unset the variables in the current environment except those that
match the regexps in WHITE-LIST-REGEXPS and those listed in WHITE-LIST.
Otherwise, augment existing environment variables with additional search
paths."
(when pure?
(purify-environment white-list white-list-regexps))
(for-each (match-lambda
((($ <search-path-specification> variable _ separator) . value)
(let ((current (getenv variable)))
(setenv variable
(if (and current (not pure?))
(if separator
(string-append value separator current)
value)
value)))))
(profile-search-paths profile manifest)))
(define (profile-regexp profile)
"Return a regular expression that matches PROFILE's name and number."
(make-regexp (string-append "^" (regexp-quote (basename profile))
"-([0-9]+)")))
(define* (generation-number profile
#:optional (base-profile profile))
"Return PROFILE's number or 0. An absolute file name must be used.
Optionally, if BASE-PROFILE is provided, use it instead of PROFILE to
construct the regexp matching generations. This is useful in special cases
like: (generation-number \"/run/current-system\" %system-profile)."
(or (and=> (false-if-exception (regexp-exec (profile-regexp base-profile)
(basename (readlink profile))))
(compose string->number (cut match:substring <> 1)))
0))
(define %profile-generation-rx
;; Regexp that matches profile generation.
(make-regexp "(.*)-([0-9]+)-link$"))
(define (generation-profile file)
"If FILE is a profile generation GC root such as \"guix-profile-42-link\",
return its corresponding profile---e.g., \"guix-profile\". Otherwise return
#f."
(match (regexp-exec %profile-generation-rx file)
(#f #f)
(m (let ((profile (match:substring m 1)))
(and (file-exists? (string-append profile "/manifest"))
profile)))))
(define (generation-numbers profile)
"Return the sorted list of generation numbers of PROFILE, or '(0) if no
former profiles were found."
(match (scandir (dirname profile)
(cute regexp-exec (profile-regexp profile) <>))
(#f ; no profile directory
'(0))
(() ; no profiles
'(0))
((profiles ...) ; former profiles around
(sort (map (compose string->number
(cut match:substring <> 1)
(cute regexp-exec (profile-regexp profile) <>))
profiles)
<))))
(define (profile-generations profile)
"Return a list of PROFILE's generations."
(let ((generations (generation-numbers profile)))
(if (equal? generations '(0))
'()
generations)))
(define (relative-generation-spec->number profile spec)
"Return PROFILE's generation specified by SPEC, which is a string. The SPEC
may be a N, -N, or +N, where N is a number. If the spec is N, then the number
returned is N. If it is -N, then the number returned is the profile's current
generation number minus N. If it is +N, then the number returned is the
profile's current generation number plus N. Return #f if there is no such
generation."
(let ((number (string->number spec)))
(and number
(case (string-ref spec 0)
((#\+ #\-)
(relative-generation profile number))
(else (if (memv number (profile-generations profile))
number
#f))))))
(define* (relative-generation profile shift #:optional
(current (generation-number profile)))
"Return PROFILE's generation shifted from the CURRENT generation by SHIFT.
SHIFT is a positive or negative number.
Return #f if there is no such generation."
(let* ((abs-shift (abs shift))
(numbers (profile-generations profile))
(from-current (memq current
(if (negative? shift)
(reverse numbers)
numbers))))
(and from-current
(< abs-shift (length from-current))
(list-ref from-current abs-shift))))
(define* (previous-generation-number profile #:optional
(number (generation-number profile)))
"Return the number of the generation before generation NUMBER of
PROFILE, or 0 if none exists. It could be NUMBER - 1, but it's not the
case when generations have been deleted (there are \"holes\")."
(or (relative-generation profile -1 number)
0))
(define (generation-file-name profile generation)
"Return the file name for PROFILE's GENERATION."
(format #f "~a-~a-link" profile generation))
(define (generation-time profile number)
"Return the creation time of a generation in the UTC format."
(make-time time-utc 0
(stat:ctime (stat (generation-file-name profile number)))))
(define (link-to-empty-profile store generation)
"Link GENERATION, a string, to the empty profile. An error is raised if
that fails."
(let* ((drv (run-with-store store
(profile-derivation (manifest '())
#:locales? #f)))
(prof (derivation->output-path drv "out")))
(build-derivations store (list drv))
(switch-symlinks generation prof)))
(define (switch-to-generation profile number)
"Atomically switch PROFILE to the generation NUMBER. Return the number of
the generation that was current before switching."
(let ((current (generation-number profile))
(generation (generation-file-name profile number)))
(cond ((not (file-exists? profile))
(raise (condition (&profile-not-found-error
(profile profile)))))
((not (file-exists? generation))
(raise (condition (&missing-generation-error
(profile profile)
(generation number)))))
(else
(switch-symlinks profile (basename generation))
current))))
(define (switch-to-previous-generation profile)
"Atomically switch PROFILE to the previous generation. Return the former
generation number and the current one."
(let ((previous (previous-generation-number profile)))
(values (switch-to-generation profile previous)
previous)))
(define (roll-back store profile)
"Roll back to the previous generation of PROFILE. Return the number of the
generation that was current before switching and the new generation number."
(let* ((number (generation-number profile))
(previous-number (previous-generation-number profile number))
(previous-generation (generation-file-name profile previous-number)))
(cond ((not (file-exists? profile)) ;invalid profile
(raise (condition (&profile-not-found-error
(profile profile)))))
((zero? number) ;empty profile
(values number number))
((or (zero? previous-number) ;going to emptiness
(not (file-exists? previous-generation)))
(link-to-empty-profile store previous-generation)
(switch-to-previous-generation profile))
(else ;anything else
(switch-to-previous-generation profile)))))
(define (delete-generation store profile number)
"Delete generation with NUMBER from PROFILE. Return the file name of the
generation that has been deleted, or #f if nothing was done (for instance
because the NUMBER is zero.)"
(define (delete-and-return)
(let ((generation (generation-file-name profile number)))
(delete-file generation)
generation))
(let* ((current-number (generation-number profile))
(previous-number (previous-generation-number profile number))
(previous-generation (generation-file-name profile previous-number)))
(cond ((zero? number) #f) ;do not delete generation 0
((and (= number current-number)
(not (file-exists? previous-generation)))
(link-to-empty-profile store previous-generation)
(switch-to-previous-generation profile)
(delete-and-return))
((= number current-number)
(roll-back store profile)
(delete-and-return))
(else
(delete-and-return)))))
(define %user-profile-directory
(and=> (getenv "HOME")
(cut string-append <> "/.guix-profile")))
(define %profile-directory
(string-append %state-directory "/profiles/"
(or (and=> (or (getenv "USER")
(getenv "LOGNAME")
(false-if-exception
(passwd:name (getpwuid (getuid)))))
(cut string-append "per-user/" <>))
"default")))
(define %current-profile
;; Call it `guix-profile', not `profile', to allow Guix profiles to
;; coexist with Nix profiles.
(string-append %profile-directory "/guix-profile"))
(define (ensure-profile-directory)
"Attempt to create /…/profiles/per-user/$USER if needed. Nowadays this is
taken care of by the daemon."
(let ((s (stat %profile-directory #f)))
(unless (and s (eq? 'directory (stat:type s)))
(catch 'system-error
(lambda ()
(mkdir-p %profile-directory))
(lambda args
;; Often, we cannot create %PROFILE-DIRECTORY because its
;; parent directory is root-owned and we're running
;; unprivileged.
(raise (condition
(&message
(message
(format #f
(G_ "while creating directory `~a': ~a")
%profile-directory
(strerror (system-error-errno args)))))
(&fix-hint
(hint
(format #f (G_ "Please create the @file{~a} directory, \
with you as the owner.")
%profile-directory))))))))
;; Bail out if it's not owned by the user.
(unless (or (not s) (= (stat:uid s) (getuid)))
(raise (condition
(&message
(message
(format #f (G_ "directory `~a' is not owned by you")
%profile-directory)))
(&fix-hint
(hint
(format #f (G_ "Please change the owner of @file{~a} \
to user ~s.")
%profile-directory (or (getenv "USER")
(getenv "LOGNAME")
(getuid))))))))))
(define (canonicalize-profile profile)
"If PROFILE points to a profile in %PROFILE-DIRECTORY, return that.
Otherwise return PROFILE unchanged. The goal is to treat '-p ~/.guix-profile'
as if '-p' was omitted." ; see <http://bugs.gnu.org/17939>
;; Trim trailing slashes so 'readlink' can do its job.
(let ((profile (string-trim-right profile #\/)))
(catch 'system-error
(lambda ()
(let ((target (readlink profile)))
(if (string=? (dirname target) %profile-directory)
target
profile)))
(const profile))))
(define %known-shorthand-profiles
;; Known shorthand forms for profiles that the user manipulates.
(list (string-append (config-directory #:ensure? #f) "/current")
%user-profile-directory))
(define (user-friendly-profile profile)
"Return either ~/.guix-profile or ~/.config/guix/current if that's what
PROFILE refers to, directly or indirectly, or PROFILE."
(or (find (lambda (shorthand)
(and shorthand
(let ((target (false-if-exception
(readlink shorthand))))
(and target (string=? target profile)))))
%known-shorthand-profiles)
profile))
;;; Local Variables:
;;; eval: (put 'let-fields 'scheme-indent-function 2)
;;; End:
;;; profiles.scm ends here
|