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
|
# Copyright 1998-2024 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
__all__ = ["close_portdbapi_caches", "FetchlistDict", "portagetree", "portdbapi"]
import portage
portage.proxy.lazyimport.lazyimport(
globals(),
"portage.checksum",
"portage.data:portage_gid,secpass",
"portage.dbapi.dep_expand:dep_expand",
"portage.dep:Atom,dep_getkey,match_from_list,use_reduce,_match_slot",
"portage.package.ebuild.doebuild:doebuild",
"portage.package.ebuild.fetch:get_mirror_url,_download_suffix",
"portage.util:ensure_dirs,shlex_split,writemsg,writemsg_level",
"portage.util.listdir:listdir",
"portage.versions:best,catsplit,catpkgsplit,_pkgsplit@pkgsplit,ver_regexp,_pkg_str",
)
from portage.cache import volatile
from portage.cache.cache_errors import CacheError
from portage.cache.mappings import Mapping
from portage.dbapi import dbapi
from portage.exception import (
PortageException,
PortageKeyError,
FileNotFound,
InvalidAtom,
InvalidData,
InvalidDependString,
InvalidPackageName,
)
from portage.localization import _
from portage import eclass_cache, eapi_is_supported, _eapi_is_deprecated
from portage import os
from portage import _encodings
from portage import _unicode_encode
from portage.util.futures import asyncio
from portage.util.futures.iter_completed import iter_gather
from _emerge.EbuildMetadataPhase import EbuildMetadataPhase
import contextlib
import os as _os
import threading
import traceback
import warnings
import errno
import functools
import collections
from collections import OrderedDict
from collections.abc import Sequence
from typing import Optional, Union
from urllib.parse import urlparse
def close_portdbapi_caches():
# The python interpreter does _not_ guarantee that destructors are
# called for objects that remain when the interpreter exits, so we
# use an atexit hook to call destructors for any global portdbapi
# instances that may have been constructed.
try:
portage._legacy_globals_constructed
except AttributeError:
pass
else:
if "db" in portage._legacy_globals_constructed:
try:
db = portage.db
except AttributeError:
pass
else:
if isinstance(db, dict):
for x in db.values():
try:
if "porttree" in x.lazy_items:
continue
except (AttributeError, TypeError):
continue
try:
x = x.pop("porttree").dbapi
except (AttributeError, KeyError):
continue
if not isinstance(x, portdbapi):
continue
x.close_caches()
portage.process.atexit_register(close_portdbapi_caches)
# It used to be necessary for API consumers to remove portdbapi instances
# from portdbapi_instances, in order to avoid having accumulated instances
# consume memory. Now, portdbapi_instances is just an empty dummy list, so
# for backward compatibility, ignore ValueError for removal on non-existent
# items.
class _dummy_list(list):
def remove(self, item):
# TODO: Trigger a DeprecationWarning here, after stable portage
# has dummy portdbapi_instances.
try:
list.remove(self, item)
except ValueError:
pass
class _better_cache:
"""
The purpose of better_cache is to locate catpkgs in repositories using ``os.listdir()`` as much as possible, which
is less expensive IO-wise than exhaustively doing a stat on each repo for a particular catpkg. better_cache stores a
list of repos in which particular catpkgs appear. Various dbapi methods use better_cache to locate repositories of
interest related to particular catpkg rather than performing an exhaustive scan of all repos/overlays.
Better_cache.items data may look like this::
{ "sys-apps/portage" : [ repo1, repo2 ] }
Without better_cache, Portage will get slower and slower (due to excessive IO) as more overlays are added.
Also note that it is OK if this cache has some 'false positive' catpkgs in it. We use it to search for specific
catpkgs listed in ebuilds. The likelihood of a false positive catpkg in our cache causing a problem is extremely
low, because the user of our cache is passing us a catpkg that came from somewhere and has already undergone some
validation, and even then will further interrogate the short-list of repos we return to gather more information
on the catpkg.
Thus, the code below is optimized for speed rather than painstaking correctness. I have added a note to
``dbapi.getRepositories()`` to ensure that developers are aware of this just in case.
The better_cache has been redesigned to perform on-demand scans -- it will only scan a category at a time, as
needed. This should further optimize IO performance by not scanning category directories that are not needed by
Portage.
"""
def __init__(self, repositories):
self._items = collections.defaultdict(list)
self._scanned_cats = set()
# ordered list of all portree locations we'll scan:
self._repo_list = [
repo for repo in reversed(list(repositories)) if repo.location is not None
]
def __getitem__(self, catpkg):
result = self._items.get(catpkg)
if result is not None:
return result
cat, pkg = catsplit(catpkg)
if cat not in self._scanned_cats:
self._scan_cat(cat)
return self._items[catpkg]
def _scan_cat(self, cat):
for repo in self._repo_list:
cat_dir = repo.location + "/" + cat
try:
pkg_list = os.listdir(cat_dir)
except OSError as e:
if e.errno not in (errno.ENOTDIR, errno.ENOENT, errno.ESTALE):
raise
continue
for p in pkg_list:
try:
atom = Atom(f"{cat}/{p}")
except InvalidAtom:
continue
if atom != atom.cp:
continue
self._items[atom.cp].append(repo)
self._scanned_cats.add(cat)
class portdbapi(dbapi):
"""this tree will scan a portage directory located at root (passed to init)"""
portdbapi_instances = _dummy_list()
_use_mutable = True
@property
def _categories(self):
return self.settings.categories
@property
def porttree_root(self):
warnings.warn(
"portage.dbapi.porttree.portdbapi.porttree_root is deprecated in favor of portage.repository.config.RepoConfig.location "
"(available as repositories[repo_name].location attribute of instances of portage.dbapi.porttree.portdbapi class)",
DeprecationWarning,
stacklevel=2,
)
return self.settings.repositories.mainRepoLocation()
@property
def eclassdb(self):
warnings.warn(
"portage.dbapi.porttree.portdbapi.eclassdb is deprecated in favor of portage.repository.config.RepoConfig.eclass_db "
"(available as repositories[repo_name].eclass_db attribute of instances of portage.dbapi.porttree.portdbapi class)",
DeprecationWarning,
stacklevel=2,
)
main_repo = self.repositories.mainRepo()
if main_repo is None:
return None
return main_repo.eclass_db
def __init__(self, _unused_param=DeprecationWarning, mysettings=None):
"""
@param _unused_param: deprecated, use mysettings['PORTDIR'] instead
@type _unused_param: None
@param mysettings: an immutable config instance
@type mysettings: portage.config
"""
from portage import config
if mysettings:
self.settings = mysettings
else:
from portage import settings
self.settings = config(clone=settings)
if _unused_param is not DeprecationWarning:
warnings.warn(
"The first parameter of the "
+ "portage.dbapi.porttree.portdbapi"
+ " constructor is unused since portage-2.1.8. "
+ "mysettings['PORTDIR'] is used instead.",
DeprecationWarning,
stacklevel=2,
)
self.repositories = self.settings.repositories
self.treemap = self.repositories.treemap
# This is strictly for use in aux_get() doebuild calls when metadata
# is generated by the depend phase. It's safest to use a clone for
# this purpose because doebuild makes many changes to the config
# instance that is passed in.
self.doebuild_settings = config(clone=self.settings)
self._doebuild_settings_lock = asyncio.Lock()
self.depcachedir = os.path.realpath(self.settings.depcachedir)
if os.environ.get("SANDBOX_ON") == "1":
# Make api consumers exempt from sandbox violations
# when doing metadata cache updates.
sandbox_write = os.environ.get("SANDBOX_WRITE", "").split(":")
if self.depcachedir not in sandbox_write:
sandbox_write.append(self.depcachedir)
os.environ["SANDBOX_WRITE"] = ":".join(filter(None, sandbox_write))
self.porttrees = list(self.settings.repositories.repoLocationList())
# This is used as sanity check for aux_get(). If there is no
# root eclass dir, we assume that PORTDIR is invalid or
# missing. This check allows aux_get() to detect a missing
# repository and return early by raising a KeyError.
self._have_root_eclass_dir = os.path.isdir(
os.path.join(self.settings.repositories.mainRepoLocation(), "eclass")
)
# if the portdbapi is "frozen", then we assume that we can cache everything (that no updates to it are happening)
self.xcache = {}
self.frozen = 0
# Keep a list of repo names, sorted by priority (highest priority first).
self._ordered_repo_name_list = tuple(reversed(self.repositories.prepos_order))
self.auxdbmodule = self.settings.load_best_module("portdbapi.auxdbmodule")
self.auxdb = {}
self._pregen_auxdb = {}
# If the current user doesn't have depcachedir write permission,
# then the depcachedir cache is kept here read-only access.
self._ro_auxdb = {}
self._init_cache_dirs()
try:
depcachedir_st = os.stat(self.depcachedir)
depcachedir_w_ok = os.access(self.depcachedir, os.W_OK)
except OSError:
depcachedir_st = None
depcachedir_w_ok = False
cache_kwargs = {}
depcachedir_unshared = False
if (
portage.data.secpass < 1
and depcachedir_w_ok
and depcachedir_st is not None
and os.getuid() == depcachedir_st.st_uid
and os.getgid() == depcachedir_st.st_gid
):
# If this user owns depcachedir and is not in the
# portage group, then don't bother to set permissions
# on cache entries. This makes it possible to run
# egencache without any need to be a member of the
# portage group.
depcachedir_unshared = True
else:
cache_kwargs.update({"gid": portage_gid, "perms": 0o664})
# If secpass < 1, we don't want to write to the cache
# since then we won't be able to apply group permissions
# to the cache entries/directories.
if (secpass < 1 and not depcachedir_unshared) or not depcachedir_w_ok:
for x in self.porttrees:
self.auxdb[x] = volatile.database(
self.depcachedir, x, self._known_keys, **cache_kwargs
)
try:
self._ro_auxdb[x] = self.auxdbmodule(
self.depcachedir,
x,
self._known_keys,
readonly=True,
**cache_kwargs,
)
except CacheError:
pass
else:
for x in self.porttrees:
if x in self.auxdb:
continue
# location, label, auxdbkeys
self.auxdb[x] = self.auxdbmodule(
self.depcachedir, x, self._known_keys, **cache_kwargs
)
if "metadata-transfer" not in self.settings.features:
for x in self.porttrees:
if x in self._pregen_auxdb:
continue
cache = self._create_pregen_cache(x)
if cache is not None:
self._pregen_auxdb[x] = cache
# Selectively cache metadata in order to optimize dep matching.
self._aux_cache_keys = {
"BDEPEND",
"DEPEND",
"EAPI",
"IDEPEND",
"INHERITED",
"IUSE",
"KEYWORDS",
"LICENSE",
"PDEPEND",
"PROPERTIES",
"RDEPEND",
"repository",
"RESTRICT",
"SLOT",
"DEFINED_PHASES",
"REQUIRED_USE",
}
self._aux_cache = {}
self._better_cache = None
self._broken_ebuilds = set()
def __getstate__(self):
state = self.__dict__.copy()
# These attributes are not picklable, so they are automatically
# regenerated after unpickling.
state["_doebuild_settings_lock"] = None
return state
def __setstate__(self, state):
self.__dict__.update(state)
self._doebuild_settings_lock = asyncio.Lock()
def _set_porttrees(self, porttrees):
"""
Consumers, such as emirrordist, may modify the porttrees attribute in
order to modify the effective set of repositories for all portdbapi
operations.
@param porttrees: list of repo locations, in ascending order by
repo priority
@type porttrees: list
"""
self._porttrees = tuple(porttrees)
self._porttrees_repos = portage.OrderedDict(
(repo.name, repo)
for repo in (
self.repositories.get_repo_for_location(location)
for location in self._porttrees
)
)
def _get_porttrees(self):
return self._porttrees
porttrees = property(_get_porttrees, _set_porttrees)
@property
def _event_loop(self):
return asyncio._safe_loop()
def _create_pregen_cache(self, tree):
conf = self.repositories.get_repo_for_location(tree)
cache = conf.get_pregenerated_cache(self._known_keys, readonly=True)
if cache is not None:
try:
cache.ec = self.repositories.get_repo_for_location(tree).eclass_db
except AttributeError:
pass
if not cache.complete_eclass_entries:
warnings.warn(
(
"Repository '%s' used deprecated 'pms' cache format. "
"Please migrate to 'md5-dict' format."
)
% (conf.name,),
DeprecationWarning,
)
return cache
def _init_cache_dirs(self):
"""Create /var/cache/edb/dep and adjust permissions for the portage
group."""
dirmode = 0o2070
modemask = 0o2
try:
ensure_dirs(self.depcachedir, gid=portage_gid, mode=dirmode, mask=modemask)
except PortageException:
pass
def close_caches(self):
if not hasattr(self, "auxdb"):
# unhandled exception thrown from constructor
return
for x in self.auxdb:
self.auxdb[x].sync()
self.auxdb.clear()
def flush_cache(self):
for x in self.auxdb.values():
x.sync()
def findLicensePath(self, license_name):
for x in reversed(self.porttrees):
license_path = os.path.join(x, "licenses", license_name)
if os.access(license_path, os.R_OK):
return license_path
return None
def findname(
self, mycpv: str, mytree: Optional[str] = None, myrepo: Optional[str] = None
) -> str:
return self.findname2(mycpv, mytree, myrepo)[0]
def getRepositoryPath(self, repository_id):
"""
This function is required for GLEP 42 compliance; given a valid repository ID
it must return a path to the repository
TreeMap = { id:path }
"""
return self.treemap.get(repository_id)
def getRepositoryName(self, canonical_repo_path):
"""
This is the inverse of getRepositoryPath().
@param canonical_repo_path: the canonical path of a repository, as
resolved by os.path.realpath()
@type canonical_repo_path: String
@return: The repo_name for the corresponding repository, or None
if the path does not correspond a known repository
@rtype: String or None
"""
try:
return self.repositories.get_name_for_location(canonical_repo_path)
except KeyError:
return None
def getRepositories(self, catpkg=None):
"""
With catpkg=None, this will return a complete list of repositories in this dbapi. With catpkg set to a value,
this method will return a short-list of repositories that contain this catpkg. Use this second approach if
possible, to avoid exhaustively searching all repos for a particular catpkg. It's faster for this method to
find the catpkg than for you do it yourself. When specifying catpkg, you should have reasonable assurance that
the category is valid and PMS-compliant as the caching mechanism we use does not perform validation checks for
categories.
This function is required for GLEP 42 compliance.
@param catpkg: catpkg for which we want a list of repositories; we'll get a list of all repos containing this
catpkg; if None, return a list of all Repositories that contain a particular catpkg.
@return: a list of repositories.
"""
if catpkg is not None and self._better_cache is not None:
return [repo.name for repo in self._better_cache[catpkg]]
return self._ordered_repo_name_list
def getMissingRepoNames(self):
"""
Returns a list of repository paths that lack profiles/repo_name.
"""
return self.settings.repositories.missing_repo_names
def getIgnoredRepos(self):
"""
Returns a list of repository paths that have been ignored, because
another repo with the same name exists.
"""
return self.settings.repositories.ignored_repos
def findname2(
self,
mycpv: str,
mytree: Optional[str] = None,
myrepo: Optional[str] = None,
) -> Union[tuple[None, int], tuple[str, str], tuple[str, None]]:
"""
Returns the location of the CPV, and what overlay it was in.
Searches overlays first, then PORTDIR; this allows us to return the first
matching file. As opposed to starting in portdir and then doing overlays
second, we would have to exhaustively search the overlays until we found
the file we wanted.
If myrepo is not None it will find packages from this repository(overlay)
"""
if not mycpv:
return (None, 0)
if myrepo is not None:
mytree = self.treemap.get(myrepo)
if mytree is None:
return (None, 0)
elif mytree is not None:
# myrepo enables cached results when available
myrepo = self.repositories.location_map.get(mytree)
mysplit = mycpv.split("/")
psplit = pkgsplit(mysplit[1])
if psplit is None or len(mysplit) != 2:
raise InvalidPackageName(mycpv)
try:
cp = mycpv.cp
except AttributeError:
cp = mysplit[0] + "/" + psplit[0]
if self._better_cache is None:
if mytree:
mytrees = [mytree]
else:
mytrees = reversed(self.porttrees)
else:
try:
repos = self._better_cache[cp]
except KeyError:
return (None, 0)
mytrees = []
for repo in repos:
if mytree is not None and mytree != repo.location:
continue
mytrees.append(repo.location)
# For optimal performance in this hot spot, we do manual unicode
# handling here instead of using the wrapped os module.
encoding = _encodings["fs"]
errors = "strict"
relative_path = (
mysplit[0] + _os.sep + psplit[0] + _os.sep + mysplit[1] + ".ebuild"
)
# There is no need to access the filesystem when the package
# comes from this db and the package repo attribute corresponds
# to the desired repo, since the file was previously found by
# the cp_list method.
if (
myrepo is not None
and myrepo == getattr(mycpv, "repo", None)
and self is getattr(mycpv, "_db", None)
):
return (mytree + _os.sep + relative_path, mytree)
for x in mytrees:
filename = x + _os.sep + relative_path
if _os.access(
_unicode_encode(filename, encoding=encoding, errors=errors), _os.R_OK
):
return (filename, x)
return (None, 0)
def _write_cache(self, cpv, repo_path, metadata, ebuild_hash):
try:
cache = self.auxdb[repo_path]
chf = cache.validation_chf
metadata[f"_{chf}_"] = getattr(ebuild_hash, chf)
except CacheError:
# Normally this shouldn't happen, so we'll show
# a traceback for debugging purposes.
traceback.print_exc()
cache = None
if cache is not None:
try:
cache[cpv] = metadata
except CacheError:
# Normally this shouldn't happen, so we'll show
# a traceback for debugging purposes.
traceback.print_exc()
def _pull_valid_cache(self, cpv, ebuild_path, repo_path):
try:
ebuild_hash = eclass_cache.hashed_path(ebuild_path)
# snag mtime since we use it later, and to trigger stat failure
# if it doesn't exist
ebuild_hash.mtime
except FileNotFound:
writemsg(
_("!!! aux_get(): ebuild for " "'%s' does not exist at:\n") % (cpv,),
noiselevel=-1,
)
writemsg(f"!!! {ebuild_path}\n", noiselevel=-1)
raise PortageKeyError(cpv)
# Pull pre-generated metadata from the metadata/cache/
# directory if it exists and is valid, otherwise fall
# back to the normal writable cache.
auxdbs = []
pregen_auxdb = self._pregen_auxdb.get(repo_path)
if pregen_auxdb is not None:
auxdbs.append(pregen_auxdb)
ro_auxdb = self._ro_auxdb.get(repo_path)
if ro_auxdb is not None:
auxdbs.append(ro_auxdb)
auxdbs.append(self.auxdb[repo_path])
eclass_db = self.repositories.get_repo_for_location(repo_path).eclass_db
for auxdb in auxdbs:
try:
metadata = auxdb[cpv]
except KeyError:
continue
except CacheError:
if not auxdb.readonly:
try:
del auxdb[cpv]
except (KeyError, CacheError):
pass
continue
eapi = metadata.get("EAPI", "").strip()
if not eapi:
eapi = "0"
metadata["EAPI"] = eapi
if not eapi_is_supported(eapi):
# Since we're supposed to be able to efficiently obtain the
# EAPI from _parse_eapi_ebuild_head, we disregard cache entries
# for unsupported EAPIs.
continue
if auxdb.validate_entry(metadata, ebuild_hash, eclass_db):
break
else:
metadata = None
return (metadata, ebuild_hash)
def aux_get(
self,
mycpv: str,
mylist: Sequence[str],
mytree: Optional[str] = None,
myrepo: Optional[str] = None,
) -> list[str]:
"stub code for returning auxiliary db information, such as SLOT, DEPEND, etc."
'input: "sys-apps/foo-1.0",["SLOT","DEPEND","HOMEPAGE"]'
'return: ["0",">=sys-libs/bar-1.0","http://www.foo.com"] or raise PortageKeyError if error'
# For external API consumers, self._event_loop returns a new event
# loop on each access, so a local reference is needed in order
# to avoid instantiating more than one.
loop = self._event_loop
return loop.run_until_complete(
self.async_aux_get(mycpv, mylist, mytree=mytree, myrepo=myrepo, loop=loop)
)
async def async_aux_get(self, mycpv, mylist, mytree=None, myrepo=None, loop=None):
"""
Asynchronous form form of aux_get.
@param mycpv: cpv for an ebuild
@type mycpv: str
@param mylist: list of metadata keys
@type mylist: list
@param mytree: The canonical path of the tree in which the ebuild
is located, or None for automatic lookup
@type mytree: str
@param myrepo: name of the repo in which the ebuild is located,
or None for automatic lookup
@type myrepo: str
@param loop: event loop (defaults to global event loop)
@type loop: EventLoop
@return: list of metadata values
@rtype: asyncio.Future (or compatible)
"""
# Don't default to self._event_loop here, since that creates a
# local event loop for thread safety, and that could easily lead
# to simultaneous instantiation of multiple event loops here.
# Callers of this method certainly want the same event loop to
# be used for all calls.
loop = asyncio._wrap_loop(loop)
cache_me = False
if myrepo is not None:
mytree = self.treemap.get(myrepo)
if mytree is None:
raise PortageKeyError(myrepo)
if (
mytree is not None
and len(self.porttrees) == 1
and mytree == self.porttrees[0]
):
# mytree matches our only tree, so it's safe to
# ignore mytree and cache the result
mytree = None
myrepo = None
if mytree is None:
cache_me = True
if mytree is None and not self._known_keys.intersection(mylist).difference(
self._aux_cache_keys
):
aux_cache = self._aux_cache.get(mycpv)
if aux_cache is not None:
return [aux_cache.get(x, "") for x in mylist]
cache_me = True
try:
cat, pkg = mycpv.split("/", 1)
except ValueError:
# Missing slash. Can't find ebuild so raise PortageKeyError.
raise PortageKeyError(mycpv)
myebuild, mylocation = self.findname2(mycpv, mytree)
if not myebuild:
writemsg(
"!!! aux_get(): %s\n" % _("ebuild not found for '%s'") % mycpv,
noiselevel=1,
)
raise PortageKeyError(mycpv)
mydata, ebuild_hash = self._pull_valid_cache(mycpv, myebuild, mylocation)
if mydata is not None:
future = loop.create_future()
self._aux_get_return(
future,
mycpv,
mylist,
myebuild,
ebuild_hash,
mydata,
mylocation,
cache_me,
None,
)
return future.result()
if myebuild in self._broken_ebuilds:
raise PortageKeyError(mycpv)
proc = None
deallocate_config = None
async with contextlib.AsyncExitStack() as stack:
try:
if (
threading.current_thread() is threading.main_thread()
and loop._loop is asyncio._safe_loop()._loop
):
# In this case use self._doebuild_settings_lock to manage concurrency.
deallocate_config = loop.create_future()
await stack.enter_async_context(self._doebuild_settings_lock)
settings = self.doebuild_settings
else:
if portage._internal_caller:
raise AssertionError(
f"async_aux_get called from thread {threading.current_thread()} with loop {loop}"
)
# Clone a config instance since we do not have a thread-safe config pool.
settings = portage.config(clone=self.settings)
proc = EbuildMetadataPhase(
cpv=mycpv,
ebuild_hash=ebuild_hash,
portdb=self,
repo_path=mylocation,
scheduler=loop,
settings=settings,
deallocate_config=deallocate_config,
)
future = loop.create_future()
proc.addExitListener(
functools.partial(
self._aux_get_return,
future,
mycpv,
mylist,
myebuild,
ebuild_hash,
mydata,
mylocation,
cache_me,
)
)
future.add_done_callback(functools.partial(self._aux_get_cancel, proc))
proc.start()
finally:
# Wait for deallocate_config before releasing
# self._doebuild_settings_lock if needed.
if deallocate_config is not None:
if proc is None or not proc.isAlive():
deallocate_config.done() or deallocate_config.cancel()
else:
await deallocate_config
# After deallocate_config is done, release self._doebuild_settings_lock
# by leaving the stack context, and wait for proc to finish and
# trigger a call to self._aux_get_return.
return await future
@staticmethod
def _aux_get_cancel(proc, future):
if future.cancelled() and proc.returncode is None:
proc.cancel()
def _aux_get_return(
self,
future,
mycpv,
mylist,
myebuild,
ebuild_hash,
mydata,
mylocation,
cache_me,
proc,
):
if future.cancelled():
return
if proc is not None:
if proc.returncode != os.EX_OK:
self._broken_ebuilds.add(myebuild)
future.set_exception(PortageKeyError(mycpv))
return
mydata = proc.metadata
mydata["repository"] = self.repositories.get_name_for_location(mylocation)
mydata["_mtime_"] = ebuild_hash.mtime
eapi = mydata.get("EAPI")
if not eapi:
eapi = "0"
mydata["EAPI"] = eapi
if eapi_is_supported(eapi):
mydata["INHERITED"] = " ".join(mydata.get("_eclasses_", []))
# finally, we look at our internal cache entry and return the requested data.
returnme = [mydata.get(x, "") for x in mylist]
if cache_me and self.frozen:
aux_cache = {}
for x in self._aux_cache_keys:
aux_cache[x] = mydata.get(x, "")
self._aux_cache[mycpv] = aux_cache
future.set_result(returnme)
def getFetchMap(self, mypkg, useflags=None, mytree=None):
"""
Get the SRC_URI metadata as a dict which maps each file name to a
set of alternative URIs.
@param mypkg: cpv for an ebuild
@type mypkg: String
@param useflags: a collection of enabled USE flags, for evaluation of
conditionals
@type useflags: set, or None to enable all conditionals
@param mytree: The canonical path of the tree in which the ebuild
is located, or None for automatic lookup
@type mypkg: String
@return: A dict which maps each file name to a set of alternative
URIs.
@rtype: dict
"""
loop = self._event_loop
return loop.run_until_complete(
self.async_fetch_map(mypkg, useflags=useflags, mytree=mytree, loop=loop)
)
def async_fetch_map(self, mypkg, useflags=None, mytree=None, loop=None):
"""
Asynchronous form of getFetchMap.
@param mypkg: cpv for an ebuild
@type mypkg: String
@param useflags: a collection of enabled USE flags, for evaluation of
conditionals
@type useflags: set, or None to enable all conditionals
@param mytree: The canonical path of the tree in which the ebuild
is located, or None for automatic lookup
@type mypkg: String
@param loop: event loop (defaults to global event loop)
@type loop: EventLoop
@return: A future that results in a dict which maps each file name to
a set of alternative URIs.
@rtype: asyncio.Future (or compatible)
"""
loop = asyncio._wrap_loop(loop)
result = loop.create_future()
def aux_get_done(aux_get_future):
if result.cancelled():
return
if aux_get_future.exception() is not None:
if isinstance(aux_get_future.exception(), PortageKeyError):
# Convert this to an InvalidDependString exception since
# callers already handle it.
result.set_exception(
portage.exception.InvalidDependString(
"getFetchMap(): aux_get() error reading "
+ mypkg
+ "; aborting."
)
)
else:
result.set_exception(aux_get_future.exception())
return
eapi, myuris = aux_get_future.result()
if not eapi_is_supported(eapi):
# Convert this to an InvalidDependString exception
# since callers already handle it.
result.set_exception(
portage.exception.InvalidDependString(
f"getFetchMap(): '{mypkg}' has unsupported EAPI: '{eapi}'"
)
)
return
try:
result.set_result(
_parse_uri_map(
mypkg, {"EAPI": eapi, "SRC_URI": myuris}, use=useflags
)
)
except Exception as e:
result.set_exception(e)
aux_get_future = asyncio.ensure_future(
self.async_aux_get(mypkg, ["EAPI", "SRC_URI"], mytree=mytree, loop=loop),
loop,
)
result.add_done_callback(
lambda result: aux_get_future.cancel() if result.cancelled() else None
)
aux_get_future.add_done_callback(aux_get_done)
return result
def getfetchsizes(self, mypkg, useflags=None, debug=0, myrepo=None):
# returns a filename:size dictionary of remaining downloads
myebuild, mytree = self.findname2(mypkg, myrepo=myrepo)
if myebuild is None:
raise AssertionError(_("ebuild not found for '%s'") % mypkg)
pkgdir = os.path.dirname(myebuild)
mf = self.repositories.get_repo_for_location(
os.path.dirname(os.path.dirname(pkgdir))
).load_manifest(pkgdir, self.settings["DISTDIR"])
checksums = mf.getDigests()
if not checksums:
if debug:
writemsg(_("[empty/missing/bad digest]: %s\n") % (mypkg,))
return {}
filesdict = {}
myfiles = self.getFetchMap(mypkg, useflags=useflags, mytree=mytree)
# XXX: maybe this should be improved: take partial downloads
# into account? check checksums?
for myfile in myfiles:
try:
fetch_size = int(checksums[myfile]["size"])
except (KeyError, ValueError):
if debug:
writemsg(
_("[bad digest]: missing %(file)s for %(pkg)s\n")
% {"file": myfile, "pkg": mypkg}
)
continue
file_path = os.path.join(self.settings["DISTDIR"], myfile)
mystat = None
try:
mystat = os.stat(file_path)
except OSError:
pass
else:
if mystat.st_size != fetch_size:
# Use file with _download_suffix instead.
mystat = None
if mystat is None:
try:
mystat = os.stat(file_path + _download_suffix)
except OSError:
pass
if mystat is None:
existing_size = 0
ro_distdirs = self.settings.get("PORTAGE_RO_DISTDIRS")
if ro_distdirs is not None:
for x in shlex_split(ro_distdirs):
try:
mystat = os.stat(
portage.package.ebuild.fetch.get_mirror_url(
x, myfile, self.settings
)
)
except OSError:
pass
else:
if mystat.st_size == fetch_size:
existing_size = fetch_size
break
else:
existing_size = mystat.st_size
remaining_size = fetch_size - existing_size
if remaining_size > 0:
# Assume the download is resumable.
filesdict[myfile] = remaining_size
elif remaining_size < 0:
# The existing file is too large and therefore corrupt.
filesdict[myfile] = int(checksums[myfile]["size"])
return filesdict
def fetch_check(
self, mypkg, useflags=None, mysettings=None, all=False, myrepo=None
): # pylint: disable=redefined-builtin
"""
TODO: account for PORTAGE_RO_DISTDIRS
"""
if all:
useflags = None
elif useflags is None:
if mysettings:
useflags = mysettings["USE"].split()
if myrepo is not None:
mytree = self.treemap.get(myrepo)
if mytree is None:
return False
else:
mytree = None
myfiles = self.getFetchMap(mypkg, useflags=useflags, mytree=mytree)
myebuild = self.findname(mypkg, myrepo=myrepo)
if myebuild is None:
raise AssertionError(_("ebuild not found for '%s'") % mypkg)
pkgdir = os.path.dirname(myebuild)
mf = self.repositories.get_repo_for_location(
os.path.dirname(os.path.dirname(pkgdir))
)
mf = mf.load_manifest(pkgdir, self.settings["DISTDIR"])
mysums = mf.getDigests()
failures = {}
for x in myfiles:
if not mysums or x not in mysums:
ok = False
reason = _("digest missing")
else:
try:
ok, reason = portage.checksum.verify_all(
os.path.join(self.settings["DISTDIR"], x), mysums[x]
)
except FileNotFound as e:
ok = False
reason = _("File Not Found: '%s'") % (e,)
if not ok:
failures[x] = reason
if failures:
return False
return True
def cpv_exists(self, mykey, myrepo=None):
"Tells us whether an actual ebuild exists on disk (no masking)"
cps2 = mykey.split("/")
cps = catpkgsplit(mykey, silent=0)
if not cps:
# invalid cat/pkg-v
return 0
if self.findname(cps[0] + "/" + cps2[1], myrepo=myrepo):
return 1
return 0
def cp_all(self, categories=None, trees=None, reverse=False, sort=True):
"""
This returns a list of all keys in our tree or trees
@param categories: optional list of categories to search or
defaults to self.settings.categories
@param trees: optional list of trees to search the categories in or
defaults to self.porttrees
@param reverse: reverse sort order (default is False)
@param sort: return sorted results (default is True)
@rtype list of [cat/pkg,...]
"""
d = {}
if categories is None:
categories = self.settings.categories
if trees is None:
trees = self.porttrees
for x in categories:
for oroot in trees:
for y in listdir(
oroot + "/" + x, EmptyOnError=1, ignorecvs=1, dirsonly=1
):
try:
atom = Atom(f"{x}/{y}")
except InvalidAtom:
continue
if atom != atom.cp:
continue
d[atom.cp] = None
l = list(d)
if sort:
l.sort(reverse=reverse)
return l
def cp_list(self, mycp, use_cache=1, mytree=None):
# NOTE: Cache can be safely shared with the match cache, since the
# match cache uses the result from dep_expand for the cache_key.
if (
self.frozen
and mytree is not None
and len(self.porttrees) == 1
and mytree == self.porttrees[0]
):
# mytree matches our only tree, so it's safe to
# ignore mytree and cache the result
mytree = None
if self.frozen and mytree is None:
cachelist = self.xcache["cp-list"].get(mycp)
if cachelist is not None:
# Try to propagate this to the match-all cache here for
# repoman since he uses separate match-all caches for each
# profile (due to differences in _get_implicit_iuse).
self.xcache["match-all"][(mycp, mycp)] = cachelist
return cachelist[:]
mysplit = mycp.split("/")
invalid_category = mysplit[0] not in self._categories
# Process repos in ascending order by repo.priority, so that
# stable sort by version produces results ordered by
# (pkg.version, repo.priority).
if mytree is not None:
if isinstance(mytree, str):
repos = [self.repositories.get_repo_for_location(mytree)]
else:
# assume it's iterable
repos = [
self.repositories.get_repo_for_location(location)
for location in mytree
]
elif self._better_cache is None:
repos = self._porttrees_repos.values()
else:
repos = [
repo
for repo in reversed(self._better_cache[mycp])
if repo.name in self._porttrees_repos
]
mylist = []
for repo in repos:
oroot = repo.location
try:
file_list = os.listdir(os.path.join(oroot, mycp))
except OSError:
continue
for x in file_list:
pf = None
if x[-7:] == ".ebuild":
pf = x[:-7]
if pf is not None:
ps = pkgsplit(pf)
if not ps:
writemsg(
_("\nInvalid ebuild name: %s\n")
% os.path.join(oroot, mycp, x),
noiselevel=-1,
)
continue
if ps[0] != mysplit[1]:
writemsg(
_("\nInvalid ebuild name: %s\n")
% os.path.join(oroot, mycp, x),
noiselevel=-1,
)
continue
ver_match = ver_regexp.match("-".join(ps[1:]))
if ver_match is None or not ver_match.groups():
writemsg(
_("\nInvalid ebuild version: %s\n")
% os.path.join(oroot, mycp, x),
noiselevel=-1,
)
continue
mylist.append(
_pkg_str(mysplit[0] + "/" + pf, db=self, repo=repo.name)
)
if invalid_category and mylist:
writemsg(
_(
"\n!!! '%s' has a category that is not listed in "
"%setc/portage/categories\n"
)
% (mycp, self.settings["PORTAGE_CONFIGROOT"]),
noiselevel=-1,
)
mylist = []
# Always sort in ascending order here since it's handy and
# the result can be easily cached and reused. Since mylist
# is initially in ascending order by repo.priority, stable
# sort by version produces results in ascending order by
# (pkg.version, repo.priority).
self._cpv_sort_ascending(mylist)
if self.frozen and mytree is None:
cachelist = mylist[:]
self.xcache["cp-list"][mycp] = cachelist
self.xcache["match-all"][(mycp, mycp)] = cachelist
return mylist
def freeze(self):
for x in (
"bestmatch-visible",
"cp-list",
"match-all",
"match-all-cpv-only",
"match-visible",
"minimum-all",
"minimum-all-ignore-profile",
"minimum-visible",
):
self.xcache[x] = {}
self.frozen = 1
self._better_cache = _better_cache(self.repositories)
def melt(self):
self.xcache = {}
self._aux_cache = {}
self._better_cache = None
self.frozen = 0
def xmatch(
self,
level: str,
origdep: str,
mydep: type[DeprecationWarning] = DeprecationWarning,
mykey: type[DeprecationWarning] = DeprecationWarning,
mylist: type[DeprecationWarning] = DeprecationWarning,
) -> Union[Sequence[str], str]:
"""
Caching match function.
@param level: xmatch level (bestmatch-visible, match-all-cpv-only
match-allmatch-visible, minimum-all, minimum-all-ignore-profile,
or minimum-visible)
@type level: str
@param origdep: dependency to match (may omit category)
@type origdep: portage.dep.Atom or str
@return: match result(s)
@rtype: _pkg_str or list of _pkg_str (depends on level)
"""
if level == "list-visible":
level = "match-visible"
warnings.warn(
"The 'list-visible' mode of "
"portage.dbapi.porttree.portdbapi.xmatch "
"has been renamed to match-visible",
DeprecationWarning,
stacklevel=2,
)
if mydep is not DeprecationWarning:
warnings.warn(
"The 'mydep' parameter of "
"portage.dbapi.porttree.portdbapi.xmatch"
" is deprecated and ignored",
DeprecationWarning,
stacklevel=2,
)
loop = self._event_loop
return loop.run_until_complete(self.async_xmatch(level, origdep, loop=loop))
async def async_xmatch(self, level, origdep, loop=None):
"""
Asynchronous form of xmatch.
@param level: xmatch level (bestmatch-visible, match-all-cpv-only
match-allmatch-visible, minimum-all, minimum-all-ignore-profile,
or minimum-visible)
@type level: str
@param origdep: dependency to match (may omit category)
@type origdep: portage.dep.Atom or str
@param loop: event loop (defaults to global event loop)
@type loop: EventLoop
@return: match result(s)
@rtype: asyncio.Future (or compatible), which results in a _pkg_str
or list of _pkg_str (depends on level)
"""
mydep = dep_expand(origdep, mydb=self, settings=self.settings)
mykey = mydep.cp
# if no updates are being made to the tree, we can consult our xcache...
cache_key = None
if self.frozen:
cache_key = (mydep, mydep.unevaluated_atom)
try:
return self.xcache[level][cache_key][:]
except KeyError:
pass
loop = asyncio._wrap_loop(loop)
myval = None
mytree = None
if mydep.repo is not None:
mytree = self.treemap.get(mydep.repo)
if mytree is None:
if level.startswith("match-"):
myval = []
else:
myval = ""
if myval is not None:
# Unknown repo, empty result.
pass
elif level == "match-all-cpv-only":
# match *all* packages, only against the cpv, in order
# to bypass unnecessary cache access for things like IUSE
# and SLOT.
if mydep == mykey:
# Share cache with match-all/cp_list when the result is the
# same. Note that this requires that mydep.repo is None and
# thus mytree is also None.
level = "match-all"
myval = self.cp_list(mykey, mytree=mytree)
else:
myval = match_from_list(mydep, self.cp_list(mykey, mytree=mytree))
elif level in (
"bestmatch-visible",
"match-all",
"match-visible",
"minimum-all",
"minimum-all-ignore-profile",
"minimum-visible",
):
# Find the minimum matching visible version. This is optimized to
# minimize the number of metadata accesses (improves performance
# especially in cases where metadata needs to be generated).
if mydep == mykey:
mylist = self.cp_list(mykey, mytree=mytree)
else:
mylist = match_from_list(mydep, self.cp_list(mykey, mytree=mytree))
ignore_profile = level in ("minimum-all-ignore-profile",)
visibility_filter = level not in (
"match-all",
"minimum-all",
"minimum-all-ignore-profile",
)
single_match = level not in ("match-all", "match-visible")
myval = []
aux_keys = list(self._aux_cache_keys)
if level == "bestmatch-visible":
iterfunc = reversed
else:
iterfunc = iter
for cpv in iterfunc(mylist):
try:
metadata = dict(
zip(
aux_keys,
(
await self.async_aux_get(
cpv, aux_keys, myrepo=cpv.repo, loop=loop
)
),
)
)
except KeyError:
# ebuild not in this repo, or masked by corruption
continue
try:
pkg_str = _pkg_str(
cpv, metadata=metadata, settings=self.settings, db=self
)
except InvalidData:
continue
if visibility_filter and not self._visible(pkg_str, metadata):
continue
if mydep.slot is not None and not _match_slot(mydep, pkg_str):
continue
if mydep.unevaluated_atom.use is not None and not self._match_use(
mydep, pkg_str, metadata, ignore_profile=ignore_profile
):
continue
myval.append(pkg_str)
if single_match:
break
if single_match:
if myval:
myval = myval[0]
else:
myval = ""
else:
raise AssertionError(f"Invalid level argument: '{level}'")
if self.frozen:
xcache_this_level = self.xcache.get(level)
if xcache_this_level is not None:
xcache_this_level[cache_key] = myval
if not isinstance(myval, _pkg_str):
myval = myval[:]
return myval
def match(self, mydep: str, use_cache: int = 1) -> Union[Sequence[str], str]:
return self.xmatch("match-visible", mydep)
def gvisible(self, mylist):
warnings.warn(
"The 'gvisible' method of "
"portage.dbapi.porttree.portdbapi "
"is deprecated",
DeprecationWarning,
stacklevel=2,
)
return list(self._iter_visible(iter(mylist)))
def visible(self, cpv_iter):
warnings.warn(
"The 'visible' method of "
"portage.dbapi.porttree.portdbapi "
"is deprecated",
DeprecationWarning,
stacklevel=2,
)
if cpv_iter is None:
return []
return list(self._iter_visible(iter(cpv_iter)))
def _iter_visible(self, cpv_iter, myrepo=None):
"""
Return a new list containing only visible packages.
"""
aux_keys = list(self._aux_cache_keys)
metadata = {}
if myrepo is not None:
repos = [myrepo]
else:
# We iterate over self.porttrees, since it's common to
# tweak this attribute in order to adjust match behavior.
repos = []
for tree in reversed(self.porttrees):
repos.append(self.repositories.get_name_for_location(tree))
for mycpv in cpv_iter:
for repo in repos:
metadata.clear()
try:
metadata.update(
zip(aux_keys, self.aux_get(mycpv, aux_keys, myrepo=repo))
)
except KeyError:
continue
except PortageException as e:
writemsg(
f"!!! Error: aux_get('{mycpv}', {aux_keys})\n",
noiselevel=-1,
)
writemsg(f"!!! {e}\n", noiselevel=-1)
del e
continue
if not self._visible(mycpv, metadata):
continue
yield mycpv
# only yield a given cpv once
break
def _visible(self, cpv, metadata):
eapi = metadata["EAPI"]
if not eapi_is_supported(eapi):
return False
if _eapi_is_deprecated(eapi):
return False
if not metadata["SLOT"]:
return False
settings = self.settings
if settings._getMaskAtom(cpv, metadata):
return False
if settings._getMissingKeywords(cpv, metadata):
return False
if settings.local_config:
metadata["CHOST"] = settings.get("CHOST", "")
if not settings._accept_chost(cpv, metadata):
return False
metadata["USE"] = ""
if "?" in metadata["LICENSE"] or "?" in metadata["PROPERTIES"]:
self.doebuild_settings.setcpv(cpv, mydb=metadata)
metadata["USE"] = self.doebuild_settings["PORTAGE_USE"]
try:
if settings._getMissingLicenses(cpv, metadata):
return False
if settings._getMissingProperties(cpv, metadata):
return False
if settings._getMissingRestrict(cpv, metadata):
return False
except InvalidDependString:
return False
return True
class portagetree:
def __init__(
self, root=DeprecationWarning, virtual=DeprecationWarning, settings=None
):
"""
Constructor for a PortageTree
@param root: deprecated, defaults to settings['ROOT']
@type root: String/Path
@param virtual: UNUSED
@type virtual: No Idea
@param settings: Portage Configuration object (portage.settings)
@type settings: Instance of portage.config
"""
if settings is None:
settings = portage.settings
self.settings = settings
if root is not DeprecationWarning:
warnings.warn(
"The root parameter of the "
+ "portage.dbapi.porttree.portagetree"
+ " constructor is now unused. Use "
+ "settings['ROOT'] instead.",
DeprecationWarning,
stacklevel=2,
)
if virtual is not DeprecationWarning:
warnings.warn(
"The 'virtual' parameter of the "
"portage.dbapi.porttree.portagetree"
" constructor is unused",
DeprecationWarning,
stacklevel=2,
)
self.__virtual = virtual
self.dbapi = portdbapi(mysettings=settings)
@property
def portroot(self):
"""Deprecated. Use the portdbapi getRepositoryPath method instead."""
warnings.warn(
"The portroot attribute of "
"portage.dbapi.porttree.portagetree is deprecated. Use the "
"portdbapi getRepositoryPath method instead.",
DeprecationWarning,
stacklevel=3,
)
return self.settings["PORTDIR"]
@property
def root(self):
warnings.warn(
"The root attribute of "
+ "portage.dbapi.porttree.portagetree"
+ " is deprecated. Use "
+ "settings['ROOT'] instead.",
DeprecationWarning,
stacklevel=3,
)
return self.settings["ROOT"]
@property
def virtual(self):
warnings.warn(
"The 'virtual' attribute of "
+ "portage.dbapi.porttree.portagetree"
+ " is deprecated.",
DeprecationWarning,
stacklevel=3,
)
return self.__virtual
def dep_bestmatch(self, mydep):
"compatibility method"
mymatch = self.dbapi.xmatch("bestmatch-visible", mydep)
if mymatch is None:
return ""
return mymatch
def dep_match(self, mydep):
"compatibility method"
mymatch = self.dbapi.xmatch("match-visible", mydep)
if mymatch is None:
return []
return mymatch
def exists_specific(self, cpv):
return self.dbapi.cpv_exists(cpv)
def getallnodes(self):
"""new behavior: these are all *unmasked* nodes. There may or may not be available
masked package for nodes in this nodes list."""
return self.dbapi.cp_all()
def getname(self, pkgname):
"""Deprecated. Use the portdbapi findname method instead."""
warnings.warn(
"The getname method of "
"portage.dbapi.porttree.portagetree is deprecated. "
"Use the portdbapi findname method instead.",
DeprecationWarning,
stacklevel=2,
)
if not pkgname:
return ""
mysplit = pkgname.split("/")
psplit = pkgsplit(mysplit[1])
return "/".join([self.portroot, mysplit[0], psplit[0], mysplit[1]]) + ".ebuild"
def getslot(self, mycatpkg):
"Get a slot for a catpkg; assume it exists."
myslot = ""
try:
myslot = self.dbapi._pkg_str(mycatpkg, None).slot
except KeyError:
pass
return myslot
class FetchlistDict(Mapping):
"""
This provide a mapping interface to retrieve fetch lists. It's used
to allow portage.manifest.Manifest to access fetch lists via a standard
mapping interface rather than use the dbapi directly.
"""
def __init__(self, pkgdir, settings, mydbapi):
"""pkgdir is a directory containing ebuilds and settings is passed into
portdbapi.getfetchlist for __getitem__ calls."""
self.pkgdir = pkgdir
self.cp = os.sep.join(pkgdir.split(os.sep)[-2:])
self.settings = settings
self.mytree = os.path.realpath(os.path.dirname(os.path.dirname(pkgdir)))
self.portdb = mydbapi
def __getitem__(self, pkg_key):
"""Returns the complete fetch list for a given package."""
return list(self.portdb.getFetchMap(pkg_key, mytree=self.mytree))
def __contains__(self, cpv):
return cpv in self.__iter__()
def has_key(self, pkg_key):
"""Returns true if the given package exists within pkgdir."""
warnings.warn(
"portage.dbapi.porttree.FetchlistDict.has_key() is "
"deprecated, use the 'in' operator instead",
DeprecationWarning,
stacklevel=2,
)
return pkg_key in self
def __iter__(self):
return iter(self.portdb.cp_list(self.cp, mytree=self.mytree))
def __len__(self):
"""This needs to be implemented in order to avoid
infinite recursion in some cases."""
return len(self.portdb.cp_list(self.cp, mytree=self.mytree))
keys = __iter__
def _async_manifest_fetchlist(
portdb, repo_config, cp, cpv_list=None, max_jobs=None, max_load=None, loop=None
):
"""
Asynchronous form of FetchlistDict, with max_jobs and max_load
parameters in order to control async_aux_get concurrency.
@param portdb: portdbapi instance
@type portdb: portdbapi
@param repo_config: repository configuration for a Manifest
@type repo_config: RepoConfig
@param cp: cp for a Manifest
@type cp: str
@param cpv_list: list of ebuild cpv values for a Manifest
@type cpv_list: list
@param max_jobs: max number of futures to process concurrently (default
is portage.util.cpuinfo.get_cpu_count())
@type max_jobs: int
@param max_load: max load allowed when scheduling a new future,
otherwise schedule no more than 1 future at a time (default
is portage.util.cpuinfo.get_cpu_count())
@type max_load: int or float
@param loop: event loop
@type loop: EventLoop
@return: a Future resulting in a Mapping compatible with FetchlistDict
@rtype: asyncio.Future (or compatible)
"""
loop = asyncio._wrap_loop(loop)
result = loop.create_future()
cpv_list = (
portdb.cp_list(cp, mytree=repo_config.location)
if cpv_list is None
else cpv_list
)
def gather_done(gather_result):
# All exceptions must be consumed from gather_result before this
# function returns, in order to avoid triggering the event loop's
# exception handler.
e = None
if not gather_result.cancelled():
for future in gather_result.result():
if (
future.done()
and not future.cancelled()
and future.exception() is not None
):
e = future.exception()
if result.cancelled():
return
if e is None:
result.set_result(
{k: list(v.result()) for k, v in zip(cpv_list, gather_result.result())}
)
else:
result.set_exception(e)
gather_result = iter_gather(
# Use a generator expression for lazy evaluation, so that iter_gather
# controls the number of concurrent async_fetch_map calls.
(
portdb.async_fetch_map(cpv, mytree=repo_config.location, loop=loop)
for cpv in cpv_list
),
max_jobs=max_jobs,
max_load=max_load,
loop=loop,
)
gather_result.add_done_callback(gather_done)
result.add_done_callback(
lambda result: gather_result.cancel() if result.cancelled() else None
)
return result
def _parse_uri_map(cpv, metadata, use=None):
myuris = use_reduce(
metadata.get("SRC_URI", ""),
uselist=use,
matchall=(use is None),
is_src_uri=True,
eapi=metadata["EAPI"],
)
uri_map = OrderedDict()
myuris.reverse()
while myuris:
uri = myuris.pop()
if myuris and myuris[-1] == "->":
myuris.pop()
distfile = myuris.pop()
else:
distfile = os.path.basename(uri)
if not distfile:
raise portage.exception.InvalidDependString(
("getFetchMap(): '%s' SRC_URI has no file " + "name: '%s'")
% (cpv, uri)
)
uri_set = uri_map.get(distfile)
if uri_set is None:
# Use OrderedDict to preserve order from SRC_URI
# while ensuring uniqueness.
uri_set = OrderedDict()
uri_map[distfile] = uri_set
# SRC_URI may contain a file name with no scheme, and in
# this case it does not belong in uri_set.
if urlparse(uri).scheme:
uri_set[uri] = True
# Convert OrderedDicts to tuples.
for k, v in uri_map.items():
uri_map[k] = tuple(v)
return uri_map
|