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
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
|
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
At format 7 this was split out into Branch, Repository and Checkout control
directories.
"""
# TODO: Can we move specific formats into separate modules to make this file
# smaller?
from cStringIO import StringIO
import os
from bzrlib.lazy_import import lazy_import
lazy_import(globals(), """
from stat import S_ISDIR
import textwrap
from warnings import warn
import bzrlib
from bzrlib import (
errors,
lockable_files,
lockdir,
registry,
remote,
revision as _mod_revision,
symbol_versioning,
ui,
urlutils,
xml4,
xml5,
workingtree,
workingtree_4,
)
from bzrlib.osutils import (
sha_strings,
sha_string,
)
from bzrlib.smart.client import _SmartClient
from bzrlib.smart import protocol
from bzrlib.store.revision.text import TextRevisionStore
from bzrlib.store.text import TextStore
from bzrlib.store.versioned import WeaveStore
from bzrlib.transactions import WriteTransaction
from bzrlib.transport import (
do_catching_redirections,
get_transport,
)
from bzrlib.weave import Weave
""")
from bzrlib.trace import (
mutter,
note,
)
from bzrlib.transport.local import LocalTransport
from bzrlib.symbol_versioning import (
deprecated_function,
deprecated_method,
zero_ninetyone,
)
class BzrDir(object):
"""A .bzr control diretory.
BzrDir instances let you create or open any of the things that can be
found within .bzr - checkouts, branches and repositories.
transport
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
root_transport
a transport connected to the directory this bzr was opened from.
"""
def break_lock(self):
"""Invoke break_lock on the first object in the bzrdir.
If there is a tree, the tree is opened and break_lock() called.
Otherwise, branch is tried, and finally repository.
"""
# XXX: This seems more like a UI function than something that really
# belongs in this class.
try:
thing_to_unlock = self.open_workingtree()
except (errors.NotLocalUrl, errors.NoWorkingTree):
try:
thing_to_unlock = self.open_branch()
except errors.NotBranchError:
try:
thing_to_unlock = self.open_repository()
except errors.NoRepositoryPresent:
return
thing_to_unlock.break_lock()
def can_convert_format(self):
"""Return true if this bzrdir is one whose format we can convert from."""
return True
def check_conversion_target(self, target_format):
target_repo_format = target_format.repository_format
source_repo_format = self._format.repository_format
source_repo_format.check_conversion_target(target_repo_format)
@staticmethod
def _check_supported(format, allow_unsupported,
recommend_upgrade=True,
basedir=None):
"""Give an error or warning on old formats.
:param format: may be any kind of format - workingtree, branch,
or repository.
:param allow_unsupported: If true, allow opening
formats that are strongly deprecated, and which may
have limited functionality.
:param recommend_upgrade: If true (default), warn
the user through the ui object that they may wish
to upgrade the object.
"""
# TODO: perhaps move this into a base Format class; it's not BzrDir
# specific. mbp 20070323
if not allow_unsupported and not format.is_supported():
# see open_downlevel to open legacy branches.
raise errors.UnsupportedFormatError(format=format)
if recommend_upgrade \
and getattr(format, 'upgrade_recommended', False):
ui.ui_factory.recommend_upgrade(
format.get_format_description(),
basedir)
def clone(self, url, revision_id=None, force_new_repo=False):
"""Clone this bzrdir and its contents to url verbatim.
If urls last component does not exist, it will be created.
if revision_id is not None, then the clone operation may tune
itself to download less data.
:param force_new_repo: Do not use a shared repository for the target
even if one is available.
"""
return self.clone_on_transport(get_transport(url),
revision_id=revision_id,
force_new_repo=force_new_repo)
def clone_on_transport(self, transport, revision_id=None,
force_new_repo=False):
"""Clone this bzrdir and its contents to transport verbatim.
If the target directory does not exist, it will be created.
if revision_id is not None, then the clone operation may tune
itself to download less data.
:param force_new_repo: Do not use a shared repository for the target
even if one is available.
"""
transport.ensure_base()
result = self._format.initialize_on_transport(transport)
try:
local_repo = self.find_repository()
except errors.NoRepositoryPresent:
local_repo = None
if local_repo:
# may need to copy content in
if force_new_repo:
result_repo = local_repo.clone(
result,
revision_id=revision_id)
result_repo.set_make_working_trees(local_repo.make_working_trees())
else:
try:
result_repo = result.find_repository()
# fetch content this dir needs.
result_repo.fetch(local_repo, revision_id=revision_id)
except errors.NoRepositoryPresent:
# needed to make one anyway.
result_repo = local_repo.clone(
result,
revision_id=revision_id)
result_repo.set_make_working_trees(local_repo.make_working_trees())
# 1 if there is a branch present
# make sure its content is available in the target repository
# clone it.
try:
self.open_branch().clone(result, revision_id=revision_id)
except errors.NotBranchError:
pass
try:
self.open_workingtree().clone(result)
except (errors.NoWorkingTree, errors.NotLocalUrl):
pass
return result
# TODO: This should be given a Transport, and should chdir up; otherwise
# this will open a new connection.
def _make_tail(self, url):
t = get_transport(url)
t.ensure_base()
@classmethod
def create(cls, base, format=None, possible_transports=None):
"""Create a new BzrDir at the url 'base'.
This will call the current default formats initialize with base
as the only parameter.
:param format: If supplied, the format of branch to create. If not
supplied, the default is used.
:param possible_transports: If supplied, a list of transports that
can be reused to share a remote connection.
"""
if cls is not BzrDir:
raise AssertionError("BzrDir.create always creates the default"
" format, not one of %r" % cls)
t = get_transport(base, possible_transports)
t.ensure_base()
if format is None:
format = BzrDirFormat.get_default_format()
return format.initialize(base, possible_transports)
def create_branch(self):
"""Create a branch in this BzrDir.
The bzrdirs format will control what branch format is created.
For more control see BranchFormatXX.create(a_bzrdir).
"""
raise NotImplementedError(self.create_branch)
@staticmethod
def create_branch_and_repo(base, force_new_repo=False, format=None):
"""Create a new BzrDir, Branch and Repository at the url 'base'.
This will use the current default BzrDirFormat, and use whatever
repository format that that uses via bzrdir.create_branch and
create_repository. If a shared repository is available that is used
preferentially.
The created Branch object is returned.
:param base: The URL to create the branch at.
:param force_new_repo: If True a new repository is always created.
"""
bzrdir = BzrDir.create(base, format)
bzrdir._find_or_create_repository(force_new_repo)
return bzrdir.create_branch()
def _find_or_create_repository(self, force_new_repo):
"""Create a new repository if needed, returning the repository."""
if force_new_repo:
return self.create_repository()
try:
return self.find_repository()
except errors.NoRepositoryPresent:
return self.create_repository()
@staticmethod
def create_branch_convenience(base, force_new_repo=False,
force_new_tree=None, format=None,
possible_transports=None):
"""Create a new BzrDir, Branch and Repository at the url 'base'.
This is a convenience function - it will use an existing repository
if possible, can be told explicitly whether to create a working tree or
not.
This will use the current default BzrDirFormat, and use whatever
repository format that that uses via bzrdir.create_branch and
create_repository. If a shared repository is available that is used
preferentially. Whatever repository is used, its tree creation policy
is followed.
The created Branch object is returned.
If a working tree cannot be made due to base not being a file:// url,
no error is raised unless force_new_tree is True, in which case no
data is created on disk and NotLocalUrl is raised.
:param base: The URL to create the branch at.
:param force_new_repo: If True a new repository is always created.
:param force_new_tree: If True or False force creation of a tree or
prevent such creation respectively.
:param format: Override for the for the bzrdir format to create.
:param possible_transports: An optional reusable transports list.
"""
if force_new_tree:
# check for non local urls
t = get_transport(base, possible_transports)
if not isinstance(t, LocalTransport):
raise errors.NotLocalUrl(base)
bzrdir = BzrDir.create(base, format, possible_transports)
repo = bzrdir._find_or_create_repository(force_new_repo)
result = bzrdir.create_branch()
if force_new_tree or (repo.make_working_trees() and
force_new_tree is None):
try:
bzrdir.create_workingtree()
except errors.NotLocalUrl:
pass
return result
@staticmethod
@deprecated_function(zero_ninetyone)
def create_repository(base, shared=False, format=None):
"""Create a new BzrDir and Repository at the url 'base'.
If no format is supplied, this will default to the current default
BzrDirFormat by default, and use whatever repository format that that
uses for bzrdirformat.create_repository.
:param shared: Create a shared repository rather than a standalone
repository.
The Repository object is returned.
This must be overridden as an instance method in child classes, where
it should take no parameters and construct whatever repository format
that child class desires.
This method is deprecated, please call create_repository on a bzrdir
instance instead.
"""
bzrdir = BzrDir.create(base, format)
return bzrdir.create_repository(shared)
@staticmethod
def create_standalone_workingtree(base, format=None):
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
'base' must be a local path or a file:// url.
This will use the current default BzrDirFormat, and use whatever
repository format that that uses for bzrdirformat.create_workingtree,
create_branch and create_repository.
:return: The WorkingTree object.
"""
t = get_transport(base)
if not isinstance(t, LocalTransport):
raise errors.NotLocalUrl(base)
bzrdir = BzrDir.create_branch_and_repo(base,
force_new_repo=True,
format=format).bzrdir
return bzrdir.create_workingtree()
def create_workingtree(self, revision_id=None):
"""Create a working tree at this BzrDir.
revision_id: create it as of this revision id.
"""
raise NotImplementedError(self.create_workingtree)
def retire_bzrdir(self):
"""Permanently disable the bzrdir.
This is done by renaming it to give the user some ability to recover
if there was a problem.
This will have horrible consequences if anyone has anything locked or
in use.
"""
for i in xrange(10000):
try:
to_path = '.bzr.retired.%d' % i
self.root_transport.rename('.bzr', to_path)
note("renamed %s to %s"
% (self.root_transport.abspath('.bzr'), to_path))
break
except (errors.TransportError, IOError, errors.PathError):
pass
def destroy_workingtree(self):
"""Destroy the working tree at this BzrDir.
Formats that do not support this may raise UnsupportedOperation.
"""
raise NotImplementedError(self.destroy_workingtree)
def destroy_workingtree_metadata(self):
"""Destroy the control files for the working tree at this BzrDir.
The contents of working tree files are not affected.
Formats that do not support this may raise UnsupportedOperation.
"""
raise NotImplementedError(self.destroy_workingtree_metadata)
def find_repository(self):
"""Find the repository that should be used for a_bzrdir.
This does not require a branch as we use it to find the repo for
new branches as well as to hook existing branches up to their
repository.
"""
try:
return self.open_repository()
except errors.NoRepositoryPresent:
pass
next_transport = self.root_transport.clone('..')
while True:
# find the next containing bzrdir
try:
found_bzrdir = BzrDir.open_containing_from_transport(
next_transport)[0]
except errors.NotBranchError:
# none found
raise errors.NoRepositoryPresent(self)
# does it have a repository ?
try:
repository = found_bzrdir.open_repository()
except errors.NoRepositoryPresent:
next_transport = found_bzrdir.root_transport.clone('..')
if (found_bzrdir.root_transport.base == next_transport.base):
# top of the file system
break
else:
continue
if ((found_bzrdir.root_transport.base ==
self.root_transport.base) or repository.is_shared()):
return repository
else:
raise errors.NoRepositoryPresent(self)
raise errors.NoRepositoryPresent(self)
def get_branch_reference(self):
"""Return the referenced URL for the branch in this bzrdir.
:raises NotBranchError: If there is no Branch.
:return: The URL the branch in this bzrdir references if it is a
reference branch, or None for regular branches.
"""
return None
def get_branch_transport(self, branch_format):
"""Get the transport for use by branch format in this BzrDir.
Note that bzr dirs that do not support format strings will raise
IncompatibleFormat if the branch format they are given has
a format string, and vice versa.
If branch_format is None, the transport is returned with no
checking. if it is not None, then the returned transport is
guaranteed to point to an existing directory ready for use.
"""
raise NotImplementedError(self.get_branch_transport)
def get_repository_transport(self, repository_format):
"""Get the transport for use by repository format in this BzrDir.
Note that bzr dirs that do not support format strings will raise
IncompatibleFormat if the repository format they are given has
a format string, and vice versa.
If repository_format is None, the transport is returned with no
checking. if it is not None, then the returned transport is
guaranteed to point to an existing directory ready for use.
"""
raise NotImplementedError(self.get_repository_transport)
def get_workingtree_transport(self, tree_format):
"""Get the transport for use by workingtree format in this BzrDir.
Note that bzr dirs that do not support format strings will raise
IncompatibleFormat if the workingtree format they are given has a
format string, and vice versa.
If workingtree_format is None, the transport is returned with no
checking. if it is not None, then the returned transport is
guaranteed to point to an existing directory ready for use.
"""
raise NotImplementedError(self.get_workingtree_transport)
def __init__(self, _transport, _format):
"""Initialize a Bzr control dir object.
Only really common logic should reside here, concrete classes should be
made with varying behaviours.
:param _format: the format that is creating this BzrDir instance.
:param _transport: the transport this dir is based at.
"""
self._format = _format
self.transport = _transport.clone('.bzr')
self.root_transport = _transport
def is_control_filename(self, filename):
"""True if filename is the name of a path which is reserved for bzrdir's.
:param filename: A filename within the root transport of this bzrdir.
This is true IF and ONLY IF the filename is part of the namespace reserved
for bzr control dirs. Currently this is the '.bzr' directory in the root
of the root_transport. it is expected that plugins will need to extend
this in the future - for instance to make bzr talk with svn working
trees.
"""
# this might be better on the BzrDirFormat class because it refers to
# all the possible bzrdir disk formats.
# This method is tested via the workingtree is_control_filename tests-
# it was extracted from WorkingTree.is_control_filename. If the methods
# contract is extended beyond the current trivial implementation please
# add new tests for it to the appropriate place.
return filename == '.bzr' or filename.startswith('.bzr/')
def needs_format_conversion(self, format=None):
"""Return true if this bzrdir needs convert_format run on it.
For instance, if the repository format is out of date but the
branch and working tree are not, this should return True.
:param format: Optional parameter indicating a specific desired
format we plan to arrive at.
"""
raise NotImplementedError(self.needs_format_conversion)
@staticmethod
def open_unsupported(base):
"""Open a branch which is not supported."""
return BzrDir.open(base, _unsupported=True)
@staticmethod
def open(base, _unsupported=False):
"""Open an existing bzrdir, rooted at 'base' (url)
_unsupported is a private parameter to the BzrDir class.
"""
t = get_transport(base)
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
@staticmethod
def open_from_transport(transport, _unsupported=False,
_server_formats=True):
"""Open a bzrdir within a particular directory.
:param transport: Transport containing the bzrdir.
:param _unsupported: private.
"""
base = transport.base
def find_format(transport):
return transport, BzrDirFormat.find_format(
transport, _server_formats=_server_formats)
def redirected(transport, e, redirection_notice):
qualified_source = e.get_source_url()
relpath = transport.relpath(qualified_source)
if not e.target.endswith(relpath):
# Not redirected to a branch-format, not a branch
raise errors.NotBranchError(path=e.target)
target = e.target[:-len(relpath)]
note('%s is%s redirected to %s',
transport.base, e.permanently, target)
# Let's try with a new transport
qualified_target = e.get_target_url()[:-len(relpath)]
# FIXME: If 'transport' has a qualifier, this should
# be applied again to the new transport *iff* the
# schemes used are the same. It's a bit tricky to
# verify, so I'll punt for now
# -- vila20070212
return get_transport(target)
try:
transport, format = do_catching_redirections(find_format,
transport,
redirected)
except errors.TooManyRedirections:
raise errors.NotBranchError(base)
BzrDir._check_supported(format, _unsupported)
return format.open(transport, _found=True)
def open_branch(self, unsupported=False):
"""Open the branch object at this BzrDir if one is present.
If unsupported is True, then no longer supported branch formats can
still be opened.
TODO: static convenience version of this?
"""
raise NotImplementedError(self.open_branch)
@staticmethod
def open_containing(url, possible_transports=None):
"""Open an existing branch which contains url.
:param url: url to search from.
See open_containing_from_transport for more detail.
"""
transport = get_transport(url, possible_transports)
return BzrDir.open_containing_from_transport(transport)
@staticmethod
def open_containing_from_transport(a_transport):
"""Open an existing branch which contains a_transport.base
This probes for a branch at a_transport, and searches upwards from there.
Basically we keep looking up until we find the control directory or
run into the root. If there isn't one, raises NotBranchError.
If there is one and it is either an unrecognised format or an unsupported
format, UnknownFormatError or UnsupportedFormatError are raised.
If there is one, it is returned, along with the unused portion of url.
:return: The BzrDir that contains the path, and a Unicode path
for the rest of the URL.
"""
# this gets the normalised url back. I.e. '.' -> the full path.
url = a_transport.base
while True:
try:
result = BzrDir.open_from_transport(a_transport)
return result, urlutils.unescape(a_transport.relpath(url))
except errors.NotBranchError, e:
pass
try:
new_t = a_transport.clone('..')
except errors.InvalidURLJoin:
# reached the root, whatever that may be
raise errors.NotBranchError(path=url)
if new_t.base == a_transport.base:
# reached the root, whatever that may be
raise errors.NotBranchError(path=url)
a_transport = new_t
@classmethod
def open_containing_tree_or_branch(klass, location):
"""Return the branch and working tree contained by a location.
Returns (tree, branch, relpath).
If there is no tree at containing the location, tree will be None.
If there is no branch containing the location, an exception will be
raised
relpath is the portion of the path that is contained by the branch.
"""
bzrdir, relpath = klass.open_containing(location)
try:
tree = bzrdir.open_workingtree()
except (errors.NoWorkingTree, errors.NotLocalUrl):
tree = None
branch = bzrdir.open_branch()
else:
branch = tree.branch
return tree, branch, relpath
def open_repository(self, _unsupported=False):
"""Open the repository object at this BzrDir if one is present.
This will not follow the Branch object pointer - its strictly a direct
open facility. Most client code should use open_branch().repository to
get at a repository.
_unsupported is a private parameter, not part of the api.
TODO: static convenience version of this?
"""
raise NotImplementedError(self.open_repository)
def open_workingtree(self, _unsupported=False,
recommend_upgrade=True):
"""Open the workingtree object at this BzrDir if one is present.
:param recommend_upgrade: Optional keyword parameter, when True (the
default), emit through the ui module a recommendation that the user
upgrade the working tree when the workingtree being opened is old
(but still fully supported).
"""
raise NotImplementedError(self.open_workingtree)
def has_branch(self):
"""Tell if this bzrdir contains a branch.
Note: if you're going to open the branch, you should just go ahead
and try, and not ask permission first. (This method just opens the
branch and discards it, and that's somewhat expensive.)
"""
try:
self.open_branch()
return True
except errors.NotBranchError:
return False
def has_workingtree(self):
"""Tell if this bzrdir contains a working tree.
This will still raise an exception if the bzrdir has a workingtree that
is remote & inaccessible.
Note: if you're going to open the working tree, you should just go ahead
and try, and not ask permission first. (This method just opens the
workingtree and discards it, and that's somewhat expensive.)
"""
try:
self.open_workingtree(recommend_upgrade=False)
return True
except errors.NoWorkingTree:
return False
def _cloning_metadir(self):
"""Produce a metadir suitable for cloning with"""
result_format = self._format.__class__()
try:
try:
branch = self.open_branch()
source_repository = branch.repository
except errors.NotBranchError:
source_branch = None
source_repository = self.open_repository()
except errors.NoRepositoryPresent:
source_repository = None
else:
# XXX TODO: This isinstance is here because we have not implemented
# the fix recommended in bug # 103195 - to delegate this choice the
# repository itself.
repo_format = source_repository._format
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
result_format.repository_format = repo_format
try:
# TODO: Couldn't we just probe for the format in these cases,
# rather than opening the whole tree? It would be a little
# faster. mbp 20070401
tree = self.open_workingtree(recommend_upgrade=False)
except (errors.NoWorkingTree, errors.NotLocalUrl):
result_format.workingtree_format = None
else:
result_format.workingtree_format = tree._format.__class__()
return result_format, source_repository
def cloning_metadir(self):
"""Produce a metadir suitable for cloning or sprouting with.
These operations may produce workingtrees (yes, even though they're
"cloning" something that doesn't have a tree, so a viable workingtree
format must be selected.
"""
format, repository = self._cloning_metadir()
if format._workingtree_format is None:
if repository is None:
return format
tree_format = repository._format._matchingbzrdir.workingtree_format
format.workingtree_format = tree_format.__class__()
return format
def checkout_metadir(self):
return self.cloning_metadir()
def sprout(self, url, revision_id=None, force_new_repo=False,
recurse='down', possible_transports=None):
"""Create a copy of this bzrdir prepared for use as a new line of
development.
If urls last component does not exist, it will be created.
Attributes related to the identity of the source branch like
branch nickname will be cleaned, a working tree is created
whether one existed before or not; and a local branch is always
created.
if revision_id is not None, then the clone operation may tune
itself to download less data.
"""
target_transport = get_transport(url, possible_transports)
target_transport.ensure_base()
cloning_format = self.cloning_metadir()
result = cloning_format.initialize_on_transport(target_transport)
try:
source_branch = self.open_branch()
source_repository = source_branch.repository
except errors.NotBranchError:
source_branch = None
try:
source_repository = self.open_repository()
except errors.NoRepositoryPresent:
source_repository = None
if force_new_repo:
result_repo = None
else:
try:
result_repo = result.find_repository()
except errors.NoRepositoryPresent:
result_repo = None
if source_repository is None and result_repo is not None:
pass
elif source_repository is None and result_repo is None:
# no repo available, make a new one
result.create_repository()
elif source_repository is not None and result_repo is None:
# have source, and want to make a new target repo
result_repo = source_repository.sprout(result,
revision_id=revision_id)
else:
# fetch needed content into target.
if source_repository is not None:
# would rather do
# source_repository.copy_content_into(result_repo,
# revision_id=revision_id)
# so we can override the copy method
result_repo.fetch(source_repository, revision_id=revision_id)
if source_branch is not None:
source_branch.sprout(result, revision_id=revision_id)
else:
result.create_branch()
if isinstance(target_transport, LocalTransport) and (
result_repo is None or result_repo.make_working_trees()):
wt = result.create_workingtree()
wt.lock_write()
try:
if wt.path2id('') is None:
try:
wt.set_root_id(self.open_workingtree.get_root_id())
except errors.NoWorkingTree:
pass
finally:
wt.unlock()
else:
wt = None
if recurse == 'down':
if wt is not None:
basis = wt.basis_tree()
basis.lock_read()
subtrees = basis.iter_references()
recurse_branch = wt.branch
elif source_branch is not None:
basis = source_branch.basis_tree()
basis.lock_read()
subtrees = basis.iter_references()
recurse_branch = source_branch
else:
subtrees = []
basis = None
try:
for path, file_id in subtrees:
target = urlutils.join(url, urlutils.escape(path))
sublocation = source_branch.reference_parent(file_id, path)
sublocation.bzrdir.sprout(target,
basis.get_reference_revision(file_id, path),
force_new_repo=force_new_repo, recurse=recurse)
finally:
if basis is not None:
basis.unlock()
return result
class BzrDirPreSplitOut(BzrDir):
"""A common class for the all-in-one formats."""
def __init__(self, _transport, _format):
"""See BzrDir.__init__."""
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
assert self._format._lock_class == lockable_files.TransportLock
assert self._format._lock_file_name == 'branch-lock'
self._control_files = lockable_files.LockableFiles(
self.get_branch_transport(None),
self._format._lock_file_name,
self._format._lock_class)
def break_lock(self):
"""Pre-splitout bzrdirs do not suffer from stale locks."""
raise NotImplementedError(self.break_lock)
def clone(self, url, revision_id=None, force_new_repo=False):
"""See BzrDir.clone()."""
from bzrlib.workingtree import WorkingTreeFormat2
self._make_tail(url)
result = self._format._initialize_for_clone(url)
self.open_repository().clone(result, revision_id=revision_id)
from_branch = self.open_branch()
from_branch.clone(result, revision_id=revision_id)
try:
self.open_workingtree().clone(result)
except errors.NotLocalUrl:
# make a new one, this format always has to have one.
try:
WorkingTreeFormat2().initialize(result)
except errors.NotLocalUrl:
# but we cannot do it for remote trees.
to_branch = result.open_branch()
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
return result
def create_branch(self):
"""See BzrDir.create_branch."""
return self.open_branch()
def create_repository(self, shared=False):
"""See BzrDir.create_repository."""
if shared:
raise errors.IncompatibleFormat('shared repository', self._format)
return self.open_repository()
def create_workingtree(self, revision_id=None):
"""See BzrDir.create_workingtree."""
# this looks buggy but is not -really-
# because this format creates the workingtree when the bzrdir is
# created
# clone and sprout will have set the revision_id
# and that will have set it for us, its only
# specific uses of create_workingtree in isolation
# that can do wonky stuff here, and that only
# happens for creating checkouts, which cannot be
# done on this format anyway. So - acceptable wart.
result = self.open_workingtree(recommend_upgrade=False)
if revision_id is not None:
if revision_id == _mod_revision.NULL_REVISION:
result.set_parent_ids([])
else:
result.set_parent_ids([revision_id])
return result
def destroy_workingtree(self):
"""See BzrDir.destroy_workingtree."""
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
def destroy_workingtree_metadata(self):
"""See BzrDir.destroy_workingtree_metadata."""
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
self)
def get_branch_transport(self, branch_format):
"""See BzrDir.get_branch_transport()."""
if branch_format is None:
return self.transport
try:
branch_format.get_format_string()
except NotImplementedError:
return self.transport
raise errors.IncompatibleFormat(branch_format, self._format)
def get_repository_transport(self, repository_format):
"""See BzrDir.get_repository_transport()."""
if repository_format is None:
return self.transport
try:
repository_format.get_format_string()
except NotImplementedError:
return self.transport
raise errors.IncompatibleFormat(repository_format, self._format)
def get_workingtree_transport(self, workingtree_format):
"""See BzrDir.get_workingtree_transport()."""
if workingtree_format is None:
return self.transport
try:
workingtree_format.get_format_string()
except NotImplementedError:
return self.transport
raise errors.IncompatibleFormat(workingtree_format, self._format)
def needs_format_conversion(self, format=None):
"""See BzrDir.needs_format_conversion()."""
# if the format is not the same as the system default,
# an upgrade is needed.
if format is None:
format = BzrDirFormat.get_default_format()
return not isinstance(self._format, format.__class__)
def open_branch(self, unsupported=False):
"""See BzrDir.open_branch."""
from bzrlib.branch import BzrBranchFormat4
format = BzrBranchFormat4()
self._check_supported(format, unsupported)
return format.open(self, _found=True)
def sprout(self, url, revision_id=None, force_new_repo=False,
possible_transports=None):
"""See BzrDir.sprout()."""
from bzrlib.workingtree import WorkingTreeFormat2
self._make_tail(url)
result = self._format._initialize_for_clone(url)
try:
self.open_repository().clone(result, revision_id=revision_id)
except errors.NoRepositoryPresent:
pass
try:
self.open_branch().sprout(result, revision_id=revision_id)
except errors.NotBranchError:
pass
# we always want a working tree
WorkingTreeFormat2().initialize(result)
return result
class BzrDir4(BzrDirPreSplitOut):
"""A .bzr version 4 control object.
This is a deprecated format and may be removed after sept 2006.
"""
def create_repository(self, shared=False):
"""See BzrDir.create_repository."""
return self._format.repository_format.initialize(self, shared)
def needs_format_conversion(self, format=None):
"""Format 4 dirs are always in need of conversion."""
return True
def open_repository(self):
"""See BzrDir.open_repository."""
from bzrlib.repofmt.weaverepo import RepositoryFormat4
return RepositoryFormat4().open(self, _found=True)
class BzrDir5(BzrDirPreSplitOut):
"""A .bzr version 5 control object.
This is a deprecated format and may be removed after sept 2006.
"""
def open_repository(self):
"""See BzrDir.open_repository."""
from bzrlib.repofmt.weaverepo import RepositoryFormat5
return RepositoryFormat5().open(self, _found=True)
def open_workingtree(self, _unsupported=False,
recommend_upgrade=True):
"""See BzrDir.create_workingtree."""
from bzrlib.workingtree import WorkingTreeFormat2
wt_format = WorkingTreeFormat2()
# we don't warn here about upgrades; that ought to be handled for the
# bzrdir as a whole
return wt_format.open(self, _found=True)
class BzrDir6(BzrDirPreSplitOut):
"""A .bzr version 6 control object.
This is a deprecated format and may be removed after sept 2006.
"""
def open_repository(self):
"""See BzrDir.open_repository."""
from bzrlib.repofmt.weaverepo import RepositoryFormat6
return RepositoryFormat6().open(self, _found=True)
def open_workingtree(self, _unsupported=False,
recommend_upgrade=True):
"""See BzrDir.create_workingtree."""
# we don't warn here about upgrades; that ought to be handled for the
# bzrdir as a whole
from bzrlib.workingtree import WorkingTreeFormat2
return WorkingTreeFormat2().open(self, _found=True)
class BzrDirMeta1(BzrDir):
"""A .bzr meta version 1 control object.
This is the first control object where the
individual aspects are really split out: there are separate repository,
workingtree and branch subdirectories and any subset of the three can be
present within a BzrDir.
"""
def can_convert_format(self):
"""See BzrDir.can_convert_format()."""
return True
def create_branch(self):
"""See BzrDir.create_branch."""
return self._format.get_branch_format().initialize(self)
def create_repository(self, shared=False):
"""See BzrDir.create_repository."""
return self._format.repository_format.initialize(self, shared)
def create_workingtree(self, revision_id=None):
"""See BzrDir.create_workingtree."""
from bzrlib.workingtree import WorkingTreeFormat
return self._format.workingtree_format.initialize(self, revision_id)
def destroy_workingtree(self):
"""See BzrDir.destroy_workingtree."""
wt = self.open_workingtree(recommend_upgrade=False)
repository = wt.branch.repository
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
wt.revert([], old_tree=empty)
self.destroy_workingtree_metadata()
def destroy_workingtree_metadata(self):
self.transport.delete_tree('checkout')
def find_branch_format(self):
"""Find the branch 'format' for this bzrdir.
This might be a synthetic object for e.g. RemoteBranch and SVN.
"""
from bzrlib.branch import BranchFormat
return BranchFormat.find_format(self)
def _get_mkdir_mode(self):
"""Figure out the mode to use when creating a bzrdir subdir."""
temp_control = lockable_files.LockableFiles(self.transport, '',
lockable_files.TransportLock)
return temp_control._dir_mode
def get_branch_reference(self):
"""See BzrDir.get_branch_reference()."""
from bzrlib.branch import BranchFormat
format = BranchFormat.find_format(self)
return format.get_reference(self)
def get_branch_transport(self, branch_format):
"""See BzrDir.get_branch_transport()."""
if branch_format is None:
return self.transport.clone('branch')
try:
branch_format.get_format_string()
except NotImplementedError:
raise errors.IncompatibleFormat(branch_format, self._format)
try:
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
except errors.FileExists:
pass
return self.transport.clone('branch')
def get_repository_transport(self, repository_format):
"""See BzrDir.get_repository_transport()."""
if repository_format is None:
return self.transport.clone('repository')
try:
repository_format.get_format_string()
except NotImplementedError:
raise errors.IncompatibleFormat(repository_format, self._format)
try:
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
except errors.FileExists:
pass
return self.transport.clone('repository')
def get_workingtree_transport(self, workingtree_format):
"""See BzrDir.get_workingtree_transport()."""
if workingtree_format is None:
return self.transport.clone('checkout')
try:
workingtree_format.get_format_string()
except NotImplementedError:
raise errors.IncompatibleFormat(workingtree_format, self._format)
try:
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
except errors.FileExists:
pass
return self.transport.clone('checkout')
def needs_format_conversion(self, format=None):
"""See BzrDir.needs_format_conversion()."""
if format is None:
format = BzrDirFormat.get_default_format()
if not isinstance(self._format, format.__class__):
# it is not a meta dir format, conversion is needed.
return True
# we might want to push this down to the repository?
try:
if not isinstance(self.open_repository()._format,
format.repository_format.__class__):
# the repository needs an upgrade.
return True
except errors.NoRepositoryPresent:
pass
try:
if not isinstance(self.open_branch()._format,
format.get_branch_format().__class__):
# the branch needs an upgrade.
return True
except errors.NotBranchError:
pass
try:
my_wt = self.open_workingtree(recommend_upgrade=False)
if not isinstance(my_wt._format,
format.workingtree_format.__class__):
# the workingtree needs an upgrade.
return True
except (errors.NoWorkingTree, errors.NotLocalUrl):
pass
return False
def open_branch(self, unsupported=False):
"""See BzrDir.open_branch."""
format = self.find_branch_format()
self._check_supported(format, unsupported)
return format.open(self, _found=True)
def open_repository(self, unsupported=False):
"""See BzrDir.open_repository."""
from bzrlib.repository import RepositoryFormat
format = RepositoryFormat.find_format(self)
self._check_supported(format, unsupported)
return format.open(self, _found=True)
def open_workingtree(self, unsupported=False,
recommend_upgrade=True):
"""See BzrDir.open_workingtree."""
from bzrlib.workingtree import WorkingTreeFormat
format = WorkingTreeFormat.find_format(self)
self._check_supported(format, unsupported,
recommend_upgrade,
basedir=self.root_transport.base)
return format.open(self, _found=True)
class BzrDirFormat(object):
"""An encapsulation of the initialization and open routines for a format.
Formats provide three things:
* An initialization routine,
* a format string,
* an open routine.
Formats are placed in an dict by their format string for reference
during bzrdir opening. These should be subclasses of BzrDirFormat
for consistency.
Once a format is deprecated, just deprecate the initialize and open
methods on the format class. Do not deprecate the object, as the
object will be created every system load.
"""
_default_format = None
"""The default format used for new .bzr dirs."""
_formats = {}
"""The known formats."""
_control_formats = []
"""The registered control formats - .bzr, ....
This is a list of BzrDirFormat objects.
"""
_control_server_formats = []
"""The registered control server formats, e.g. RemoteBzrDirs.
This is a list of BzrDirFormat objects.
"""
_lock_file_name = 'branch-lock'
# _lock_class must be set in subclasses to the lock type, typ.
# TransportLock or LockDir
@classmethod
def find_format(klass, transport, _server_formats=True):
"""Return the format present at transport."""
if _server_formats:
formats = klass._control_server_formats + klass._control_formats
else:
formats = klass._control_formats
for format in formats:
try:
return format.probe_transport(transport)
except errors.NotBranchError:
# this format does not find a control dir here.
pass
raise errors.NotBranchError(path=transport.base)
@classmethod
def probe_transport(klass, transport):
"""Return the .bzrdir style format present in a directory."""
try:
format_string = transport.get(".bzr/branch-format").read()
except errors.NoSuchFile:
raise errors.NotBranchError(path=transport.base)
try:
return klass._formats[format_string]
except KeyError:
raise errors.UnknownFormatError(format=format_string)
@classmethod
def get_default_format(klass):
"""Return the current default format."""
return klass._default_format
def get_format_string(self):
"""Return the ASCII format string that identifies this format."""
raise NotImplementedError(self.get_format_string)
def get_format_description(self):
"""Return the short description for this format."""
raise NotImplementedError(self.get_format_description)
def get_converter(self, format=None):
"""Return the converter to use to convert bzrdirs needing converts.
This returns a bzrlib.bzrdir.Converter object.
This should return the best upgrader to step this format towards the
current default format. In the case of plugins we can/should provide
some means for them to extend the range of returnable converters.
:param format: Optional format to override the default format of the
library.
"""
raise NotImplementedError(self.get_converter)
def initialize(self, url, possible_transports=None):
"""Create a bzr control dir at this url and return an opened copy.
Subclasses should typically override initialize_on_transport
instead of this method.
"""
return self.initialize_on_transport(get_transport(url,
possible_transports))
def initialize_on_transport(self, transport):
"""Initialize a new bzrdir in the base directory of a Transport."""
# Since we don't have a .bzr directory, inherit the
# mode from the root directory
temp_control = lockable_files.LockableFiles(transport,
'', lockable_files.TransportLock)
temp_control._transport.mkdir('.bzr',
# FIXME: RBC 20060121 don't peek under
# the covers
mode=temp_control._dir_mode)
file_mode = temp_control._file_mode
del temp_control
mutter('created control directory in ' + transport.base)
control = transport.clone('.bzr')
utf8_files = [('README',
"This is a Bazaar-NG control directory.\n"
"Do not change any files in this directory.\n"),
('branch-format', self.get_format_string()),
]
# NB: no need to escape relative paths that are url safe.
control_files = lockable_files.LockableFiles(control,
self._lock_file_name, self._lock_class)
control_files.create_lock()
control_files.lock_write()
try:
for file, content in utf8_files:
control_files.put_utf8(file, content)
finally:
control_files.unlock()
return self.open(transport, _found=True)
def is_supported(self):
"""Is this format supported?
Supported formats must be initializable and openable.
Unsupported formats may not support initialization or committing or
some other features depending on the reason for not being supported.
"""
return True
def same_model(self, target_format):
return (self.repository_format.rich_root_data ==
target_format.rich_root_data)
@classmethod
def known_formats(klass):
"""Return all the known formats.
Concrete formats should override _known_formats.
"""
# There is double indirection here to make sure that control
# formats used by more than one dir format will only be probed
# once. This can otherwise be quite expensive for remote connections.
result = set()
for format in klass._control_formats:
result.update(format._known_formats())
return result
@classmethod
def _known_formats(klass):
"""Return the known format instances for this control format."""
return set(klass._formats.values())
def open(self, transport, _found=False):
"""Return an instance of this format for the dir transport points at.
_found is a private parameter, do not use it.
"""
if not _found:
found_format = BzrDirFormat.find_format(transport)
if not isinstance(found_format, self.__class__):
raise AssertionError("%s was asked to open %s, but it seems to need "
"format %s"
% (self, transport, found_format))
return self._open(transport)
def _open(self, transport):
"""Template method helper for opening BzrDirectories.
This performs the actual open and any additional logic or parameter
passing.
"""
raise NotImplementedError(self._open)
@classmethod
def register_format(klass, format):
klass._formats[format.get_format_string()] = format
@classmethod
def register_control_format(klass, format):
"""Register a format that does not use '.bzr' for its control dir.
TODO: This should be pulled up into a 'ControlDirFormat' base class
which BzrDirFormat can inherit from, and renamed to register_format
there. It has been done without that for now for simplicity of
implementation.
"""
klass._control_formats.append(format)
@classmethod
def register_control_server_format(klass, format):
"""Register a control format for client-server environments.
These formats will be tried before ones registered with
register_control_format. This gives implementations that decide to the
chance to grab it before anything looks at the contents of the format
file.
"""
klass._control_server_formats.append(format)
@classmethod
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
def set_default_format(klass, format):
klass._set_default_format(format)
@classmethod
def _set_default_format(klass, format):
"""Set default format (for testing behavior of defaults only)"""
klass._default_format = format
def __str__(self):
return self.get_format_string()[:-1]
@classmethod
def unregister_format(klass, format):
assert klass._formats[format.get_format_string()] is format
del klass._formats[format.get_format_string()]
@classmethod
def unregister_control_format(klass, format):
klass._control_formats.remove(format)
class BzrDirFormat4(BzrDirFormat):
"""Bzr dir format 4.
This format is a combined format for working tree, branch and repository.
It has:
- Format 1 working trees [always]
- Format 4 branches [always]
- Format 4 repositories [always]
This format is deprecated: it indexes texts using a text it which is
removed in format 5; write support for this format has been removed.
"""
_lock_class = lockable_files.TransportLock
def get_format_string(self):
"""See BzrDirFormat.get_format_string()."""
return "Bazaar-NG branch, format 0.0.4\n"
def get_format_description(self):
"""See BzrDirFormat.get_format_description()."""
return "All-in-one format 4"
def get_converter(self, format=None):
"""See BzrDirFormat.get_converter()."""
# there is one and only one upgrade path here.
return ConvertBzrDir4To5()
def initialize_on_transport(self, transport):
"""Format 4 branches cannot be created."""
raise errors.UninitializableFormat(self)
def is_supported(self):
"""Format 4 is not supported.
It is not supported because the model changed from 4 to 5 and the
conversion logic is expensive - so doing it on the fly was not
feasible.
"""
return False
def _open(self, transport):
"""See BzrDirFormat._open."""
return BzrDir4(transport, self)
def __return_repository_format(self):
"""Circular import protection."""
from bzrlib.repofmt.weaverepo import RepositoryFormat4
return RepositoryFormat4()
repository_format = property(__return_repository_format)
class BzrDirFormat5(BzrDirFormat):
"""Bzr control format 5.
This format is a combined format for working tree, branch and repository.
It has:
- Format 2 working trees [always]
- Format 4 branches [always]
- Format 5 repositories [always]
Unhashed stores in the repository.
"""
_lock_class = lockable_files.TransportLock
def get_format_string(self):
"""See BzrDirFormat.get_format_string()."""
return "Bazaar-NG branch, format 5\n"
def get_format_description(self):
"""See BzrDirFormat.get_format_description()."""
return "All-in-one format 5"
def get_converter(self, format=None):
"""See BzrDirFormat.get_converter()."""
# there is one and only one upgrade path here.
return ConvertBzrDir5To6()
def _initialize_for_clone(self, url):
return self.initialize_on_transport(get_transport(url), _cloning=True)
def initialize_on_transport(self, transport, _cloning=False):
"""Format 5 dirs always have working tree, branch and repository.
Except when they are being cloned.
"""
from bzrlib.branch import BzrBranchFormat4
from bzrlib.repofmt.weaverepo import RepositoryFormat5
from bzrlib.workingtree import WorkingTreeFormat2
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
RepositoryFormat5().initialize(result, _internal=True)
if not _cloning:
branch = BzrBranchFormat4().initialize(result)
try:
WorkingTreeFormat2().initialize(result)
except errors.NotLocalUrl:
# Even though we can't access the working tree, we need to
# create its control files.
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
return result
def _open(self, transport):
"""See BzrDirFormat._open."""
return BzrDir5(transport, self)
def __return_repository_format(self):
"""Circular import protection."""
from bzrlib.repofmt.weaverepo import RepositoryFormat5
return RepositoryFormat5()
repository_format = property(__return_repository_format)
class BzrDirFormat6(BzrDirFormat):
"""Bzr control format 6.
This format is a combined format for working tree, branch and repository.
It has:
- Format 2 working trees [always]
- Format 4 branches [always]
- Format 6 repositories [always]
"""
_lock_class = lockable_files.TransportLock
def get_format_string(self):
"""See BzrDirFormat.get_format_string()."""
return "Bazaar-NG branch, format 6\n"
def get_format_description(self):
"""See BzrDirFormat.get_format_description()."""
return "All-in-one format 6"
def get_converter(self, format=None):
"""See BzrDirFormat.get_converter()."""
# there is one and only one upgrade path here.
return ConvertBzrDir6ToMeta()
def _initialize_for_clone(self, url):
return self.initialize_on_transport(get_transport(url), _cloning=True)
def initialize_on_transport(self, transport, _cloning=False):
"""Format 6 dirs always have working tree, branch and repository.
Except when they are being cloned.
"""
from bzrlib.branch import BzrBranchFormat4
from bzrlib.repofmt.weaverepo import RepositoryFormat6
from bzrlib.workingtree import WorkingTreeFormat2
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
RepositoryFormat6().initialize(result, _internal=True)
if not _cloning:
branch = BzrBranchFormat4().initialize(result)
try:
WorkingTreeFormat2().initialize(result)
except errors.NotLocalUrl:
# Even though we can't access the working tree, we need to
# create its control files.
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
return result
def _open(self, transport):
"""See BzrDirFormat._open."""
return BzrDir6(transport, self)
def __return_repository_format(self):
"""Circular import protection."""
from bzrlib.repofmt.weaverepo import RepositoryFormat6
return RepositoryFormat6()
repository_format = property(__return_repository_format)
class BzrDirMetaFormat1(BzrDirFormat):
"""Bzr meta control format 1
This is the first format with split out working tree, branch and repository
disk storage.
It has:
- Format 3 working trees [optional]
- Format 5 branches [optional]
- Format 7 repositories [optional]
"""
_lock_class = lockdir.LockDir
def __init__(self):
self._workingtree_format = None
self._branch_format = None
def __eq__(self, other):
if other.__class__ is not self.__class__:
return False
if other.repository_format != self.repository_format:
return False
if other.workingtree_format != self.workingtree_format:
return False
return True
def __ne__(self, other):
return not self == other
def get_branch_format(self):
if self._branch_format is None:
from bzrlib.branch import BranchFormat
self._branch_format = BranchFormat.get_default_format()
return self._branch_format
def set_branch_format(self, format):
self._branch_format = format
def get_converter(self, format=None):
"""See BzrDirFormat.get_converter()."""
if format is None:
format = BzrDirFormat.get_default_format()
if not isinstance(self, format.__class__):
# converting away from metadir is not implemented
raise NotImplementedError(self.get_converter)
return ConvertMetaToMeta(format)
def get_format_string(self):
"""See BzrDirFormat.get_format_string()."""
return "Bazaar-NG meta directory, format 1\n"
def get_format_description(self):
"""See BzrDirFormat.get_format_description()."""
return "Meta directory format 1"
def _open(self, transport):
"""See BzrDirFormat._open."""
return BzrDirMeta1(transport, self)
def __return_repository_format(self):
"""Circular import protection."""
if getattr(self, '_repository_format', None):
return self._repository_format
from bzrlib.repository import RepositoryFormat
return RepositoryFormat.get_default_format()
def __set_repository_format(self, value):
"""Allow changint the repository format for metadir formats."""
self._repository_format = value
repository_format = property(__return_repository_format, __set_repository_format)
def __get_workingtree_format(self):
if self._workingtree_format is None:
from bzrlib.workingtree import WorkingTreeFormat
self._workingtree_format = WorkingTreeFormat.get_default_format()
return self._workingtree_format
def __set_workingtree_format(self, wt_format):
self._workingtree_format = wt_format
workingtree_format = property(__get_workingtree_format,
__set_workingtree_format)
# Register bzr control format
BzrDirFormat.register_control_format(BzrDirFormat)
# Register bzr formats
BzrDirFormat.register_format(BzrDirFormat4())
BzrDirFormat.register_format(BzrDirFormat5())
BzrDirFormat.register_format(BzrDirFormat6())
__default_format = BzrDirMetaFormat1()
BzrDirFormat.register_format(__default_format)
BzrDirFormat._default_format = __default_format
class Converter(object):
"""Converts a disk format object from one format to another."""
def convert(self, to_convert, pb):
"""Perform the conversion of to_convert, giving feedback via pb.
:param to_convert: The disk object to convert.
:param pb: a progress bar to use for progress information.
"""
def step(self, message):
"""Update the pb by a step."""
self.count +=1
self.pb.update(message, self.count, self.total)
class ConvertBzrDir4To5(Converter):
"""Converts format 4 bzr dirs to format 5."""
def __init__(self):
super(ConvertBzrDir4To5, self).__init__()
self.converted_revs = set()
self.absent_revisions = set()
self.text_count = 0
self.revisions = {}
def convert(self, to_convert, pb):
"""See Converter.convert()."""
self.bzrdir = to_convert
self.pb = pb
self.pb.note('starting upgrade from format 4 to 5')
if isinstance(self.bzrdir.transport, LocalTransport):
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
self._convert_to_weaves()
return BzrDir.open(self.bzrdir.root_transport.base)
def _convert_to_weaves(self):
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
try:
# TODO permissions
stat = self.bzrdir.transport.stat('weaves')
if not S_ISDIR(stat.st_mode):
self.bzrdir.transport.delete('weaves')
self.bzrdir.transport.mkdir('weaves')
except errors.NoSuchFile:
self.bzrdir.transport.mkdir('weaves')
# deliberately not a WeaveFile as we want to build it up slowly.
self.inv_weave = Weave('inventory')
# holds in-memory weaves for all files
self.text_weaves = {}
self.bzrdir.transport.delete('branch-format')
self.branch = self.bzrdir.open_branch()
self._convert_working_inv()
rev_history = self.branch.revision_history()
# to_read is a stack holding the revisions we still need to process;
# appending to it adds new highest-priority revisions
self.known_revisions = set(rev_history)
self.to_read = rev_history[-1:]
while self.to_read:
rev_id = self.to_read.pop()
if (rev_id not in self.revisions
and rev_id not in self.absent_revisions):
self._load_one_rev(rev_id)
self.pb.clear()
to_import = self._make_order()
for i, rev_id in enumerate(to_import):
self.pb.update('converting revision', i, len(to_import))
self._convert_one_rev(rev_id)
self.pb.clear()
self._write_all_weaves()
self._write_all_revs()
self.pb.note('upgraded to weaves:')
self.pb.note(' %6d revisions and inventories', len(self.revisions))
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
self.pb.note(' %6d texts', self.text_count)
self._cleanup_spare_files_after_format4()
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
def _cleanup_spare_files_after_format4(self):
# FIXME working tree upgrade foo.
for n in 'merged-patches', 'pending-merged-patches':
try:
## assert os.path.getsize(p) == 0
self.bzrdir.transport.delete(n)
except errors.NoSuchFile:
pass
self.bzrdir.transport.delete_tree('inventory-store')
self.bzrdir.transport.delete_tree('text-store')
def _convert_working_inv(self):
inv = xml4.serializer_v4.read_inventory(
self.branch.control_files.get('inventory'))
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
# FIXME inventory is a working tree change.
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
def _write_all_weaves(self):
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
weave_transport = self.bzrdir.transport.clone('weaves')
weaves = WeaveStore(weave_transport, prefixed=False)
transaction = WriteTransaction()
try:
i = 0
for file_id, file_weave in self.text_weaves.items():
self.pb.update('writing weave', i, len(self.text_weaves))
weaves._put_weave(file_id, file_weave, transaction)
i += 1
self.pb.update('inventory', 0, 1)
controlweaves._put_weave('inventory', self.inv_weave, transaction)
self.pb.update('inventory', 1, 1)
finally:
self.pb.clear()
def _write_all_revs(self):
"""Write all revisions out in new form."""
self.bzrdir.transport.delete_tree('revision-store')
self.bzrdir.transport.mkdir('revision-store')
revision_transport = self.bzrdir.transport.clone('revision-store')
# TODO permissions
_revision_store = TextRevisionStore(TextStore(revision_transport,
prefixed=False,
compressed=True))
try:
transaction = WriteTransaction()
for i, rev_id in enumerate(self.converted_revs):
self.pb.update('write revision', i, len(self.converted_revs))
_revision_store.add_revision(self.revisions[rev_id], transaction)
finally:
self.pb.clear()
def _load_one_rev(self, rev_id):
"""Load a revision object into memory.
Any parents not either loaded or abandoned get queued to be
loaded."""
self.pb.update('loading revision',
len(self.revisions),
len(self.known_revisions))
if not self.branch.repository.has_revision(rev_id):
self.pb.clear()
self.pb.note('revision {%s} not present in branch; '
'will be converted as a ghost',
rev_id)
self.absent_revisions.add(rev_id)
else:
rev = self.branch.repository._revision_store.get_revision(rev_id,
self.branch.repository.get_transaction())
for parent_id in rev.parent_ids:
self.known_revisions.add(parent_id)
self.to_read.append(parent_id)
self.revisions[rev_id] = rev
def _load_old_inventory(self, rev_id):
assert rev_id not in self.converted_revs
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
inv.revision_id = rev_id
rev = self.revisions[rev_id]
if rev.inventory_sha1:
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
'inventory sha mismatch for {%s}' % rev_id
return inv
def _load_updated_inventory(self, rev_id):
assert rev_id in self.converted_revs
inv_xml = self.inv_weave.get_text(rev_id)
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
return inv
def _convert_one_rev(self, rev_id):
"""Convert revision and all referenced objects to new format."""
rev = self.revisions[rev_id]
inv = self._load_old_inventory(rev_id)
present_parents = [p for p in rev.parent_ids
if p not in self.absent_revisions]
self._convert_revision_contents(rev, inv, present_parents)
self._store_new_weave(rev, inv, present_parents)
self.converted_revs.add(rev_id)
def _store_new_weave(self, rev, inv, present_parents):
# the XML is now updated with text versions
if __debug__:
entries = inv.iter_entries()
entries.next()
for path, ie in entries:
assert getattr(ie, 'revision', None) is not None, \
'no revision on {%s} in {%s}' % \
(file_id, rev.revision_id)
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
new_inv_sha1 = sha_string(new_inv_xml)
self.inv_weave.add_lines(rev.revision_id,
present_parents,
new_inv_xml.splitlines(True))
rev.inventory_sha1 = new_inv_sha1
def _convert_revision_contents(self, rev, inv, present_parents):
"""Convert all the files within a revision.
Also upgrade the inventory to refer to the text revision ids."""
rev_id = rev.revision_id
mutter('converting texts of revision {%s}',
rev_id)
parent_invs = map(self._load_updated_inventory, present_parents)
entries = inv.iter_entries()
entries.next()
for path, ie in entries:
self._convert_file_version(rev, ie, parent_invs)
def _convert_file_version(self, rev, ie, parent_invs):
"""Convert one version of one file.
The file needs to be added into the weave if it is a merge
of >=2 parents or if it's changed from its parent.
"""
file_id = ie.file_id
rev_id = rev.revision_id
w = self.text_weaves.get(file_id)
if w is None:
w = Weave(file_id)
self.text_weaves[file_id] = w
text_changed = False
previous_entries = ie.find_previous_heads(parent_invs,
None,
None,
entry_vf=w)
for old_revision in previous_entries:
# if this fails, its a ghost ?
assert old_revision in self.converted_revs, \
"Revision {%s} not in converted_revs" % old_revision
self.snapshot_ie(previous_entries, ie, w, rev_id)
del ie.text_id
assert getattr(ie, 'revision', None) is not None
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
# TODO: convert this logic, which is ~= snapshot to
# a call to:. This needs the path figured out. rather than a work_tree
# a v4 revision_tree can be given, or something that looks enough like
# one to give the file content to the entry if it needs it.
# and we need something that looks like a weave store for snapshot to
# save against.
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
if len(previous_revisions) == 1:
previous_ie = previous_revisions.values()[0]
if ie._unchanged(previous_ie):
ie.revision = previous_ie.revision
return
if ie.has_text():
text = self.branch.repository.weave_store.get(ie.text_id)
file_lines = text.readlines()
assert sha_strings(file_lines) == ie.text_sha1
assert sum(map(len, file_lines)) == ie.text_size
w.add_lines(rev_id, previous_revisions, file_lines)
self.text_count += 1
else:
w.add_lines(rev_id, previous_revisions, [])
ie.revision = rev_id
def _make_order(self):
"""Return a suitable order for importing revisions.
The order must be such that an revision is imported after all
its (present) parents.
"""
todo = set(self.revisions.keys())
done = self.absent_revisions.copy()
order = []
while todo:
# scan through looking for a revision whose parents
# are all done
for rev_id in sorted(list(todo)):
rev = self.revisions[rev_id]
parent_ids = set(rev.parent_ids)
if parent_ids.issubset(done):
# can take this one now
order.append(rev_id)
todo.remove(rev_id)
done.add(rev_id)
return order
class ConvertBzrDir5To6(Converter):
"""Converts format 5 bzr dirs to format 6."""
def convert(self, to_convert, pb):
"""See Converter.convert()."""
self.bzrdir = to_convert
self.pb = pb
self.pb.note('starting upgrade from format 5 to 6')
self._convert_to_prefixed()
return BzrDir.open(self.bzrdir.root_transport.base)
def _convert_to_prefixed(self):
from bzrlib.store import TransportStore
self.bzrdir.transport.delete('branch-format')
for store_name in ["weaves", "revision-store"]:
self.pb.note("adding prefixes to %s" % store_name)
store_transport = self.bzrdir.transport.clone(store_name)
store = TransportStore(store_transport, prefixed=True)
for urlfilename in store_transport.list_dir('.'):
filename = urlutils.unescape(urlfilename)
if (filename.endswith(".weave") or
filename.endswith(".gz") or
filename.endswith(".sig")):
file_id = os.path.splitext(filename)[0]
else:
file_id = filename
prefix_dir = store.hash_prefix(file_id)
# FIXME keep track of the dirs made RBC 20060121
try:
store_transport.move(filename, prefix_dir + '/' + filename)
except errors.NoSuchFile: # catches missing dirs strangely enough
store_transport.mkdir(prefix_dir)
store_transport.move(filename, prefix_dir + '/' + filename)
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
class ConvertBzrDir6ToMeta(Converter):
"""Converts format 6 bzr dirs to metadirs."""
def convert(self, to_convert, pb):
"""See Converter.convert()."""
from bzrlib.repofmt.weaverepo import RepositoryFormat7
from bzrlib.branch import BzrBranchFormat5
self.bzrdir = to_convert
self.pb = pb
self.count = 0
self.total = 20 # the steps we know about
self.garbage_inventories = []
self.pb.note('starting upgrade from format 6 to metadir')
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
# its faster to move specific files around than to open and use the apis...
# first off, nuke ancestry.weave, it was never used.
try:
self.step('Removing ancestry.weave')
self.bzrdir.transport.delete('ancestry.weave')
except errors.NoSuchFile:
pass
# find out whats there
self.step('Finding branch files')
last_revision = self.bzrdir.open_branch().last_revision()
bzrcontents = self.bzrdir.transport.list_dir('.')
for name in bzrcontents:
if name.startswith('basis-inventory.'):
self.garbage_inventories.append(name)
# create new directories for repository, working tree and branch
self.dir_mode = self.bzrdir._control_files._dir_mode
self.file_mode = self.bzrdir._control_files._file_mode
repository_names = [('inventory.weave', True),
('revision-store', True),
('weaves', True)]
self.step('Upgrading repository ')
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
self.make_lock('repository')
# we hard code the formats here because we are converting into
# the meta format. The meta format upgrader can take this to a
# future format within each component.
self.put_format('repository', RepositoryFormat7())
for entry in repository_names:
self.move_entry('repository', entry)
self.step('Upgrading branch ')
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
self.make_lock('branch')
self.put_format('branch', BzrBranchFormat5())
branch_files = [('revision-history', True),
('branch-name', True),
('parent', False)]
for entry in branch_files:
self.move_entry('branch', entry)
checkout_files = [('pending-merges', True),
('inventory', True),
('stat-cache', False)]
# If a mandatory checkout file is not present, the branch does not have
# a functional checkout. Do not create a checkout in the converted
# branch.
for name, mandatory in checkout_files:
if mandatory and name not in bzrcontents:
has_checkout = False
break
else:
has_checkout = True
if not has_checkout:
self.pb.note('No working tree.')
# If some checkout files are there, we may as well get rid of them.
for name, mandatory in checkout_files:
if name in bzrcontents:
self.bzrdir.transport.delete(name)
else:
from bzrlib.workingtree import WorkingTreeFormat3
self.step('Upgrading working tree')
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
self.make_lock('checkout')
self.put_format(
'checkout', WorkingTreeFormat3())
self.bzrdir.transport.delete_multi(
self.garbage_inventories, self.pb)
for entry in checkout_files:
self.move_entry('checkout', entry)
if last_revision is not None:
self.bzrdir._control_files.put_utf8(
'checkout/last-revision', last_revision)
self.bzrdir._control_files.put_utf8(
'branch-format', BzrDirMetaFormat1().get_format_string())
return BzrDir.open(self.bzrdir.root_transport.base)
def make_lock(self, name):
"""Make a lock for the new control dir name."""
self.step('Make %s lock' % name)
ld = lockdir.LockDir(self.bzrdir.transport,
'%s/lock' % name,
file_modebits=self.file_mode,
dir_modebits=self.dir_mode)
ld.create()
def move_entry(self, new_dir, entry):
"""Move then entry name into new_dir."""
name = entry[0]
mandatory = entry[1]
self.step('Moving %s' % name)
try:
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
except errors.NoSuchFile:
if mandatory:
raise
def put_format(self, dirname, format):
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
class ConvertMetaToMeta(Converter):
"""Converts the components of metadirs."""
def __init__(self, target_format):
"""Create a metadir to metadir converter.
:param target_format: The final metadir format that is desired.
"""
self.target_format = target_format
def convert(self, to_convert, pb):
"""See Converter.convert()."""
self.bzrdir = to_convert
self.pb = pb
self.count = 0
self.total = 1
self.step('checking repository format')
try:
repo = self.bzrdir.open_repository()
except errors.NoRepositoryPresent:
pass
else:
if not isinstance(repo._format, self.target_format.repository_format.__class__):
from bzrlib.repository import CopyConverter
self.pb.note('starting repository conversion')
converter = CopyConverter(self.target_format.repository_format)
converter.convert(repo, pb)
try:
branch = self.bzrdir.open_branch()
except errors.NotBranchError:
pass
else:
# TODO: conversions of Branch and Tree should be done by
# InterXFormat lookups
# Avoid circular imports
from bzrlib import branch as _mod_branch
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
self.target_format.get_branch_format().__class__ is
_mod_branch.BzrBranchFormat6):
branch_converter = _mod_branch.Converter5to6()
branch_converter.convert(branch)
try:
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
except (errors.NoWorkingTree, errors.NotLocalUrl):
pass
else:
# TODO: conversions of Branch and Tree should be done by
# InterXFormat lookups
if (isinstance(tree, workingtree.WorkingTree3) and
not isinstance(tree, workingtree_4.WorkingTree4) and
isinstance(self.target_format.workingtree_format,
workingtree_4.WorkingTreeFormat4)):
workingtree_4.Converter3to4().convert(tree)
return to_convert
# This is not in remote.py because it's small, and needs to be registered.
# Putting it in remote.py creates a circular import problem.
# we can make it a lazy object if the control formats is turned into something
# like a registry.
class RemoteBzrDirFormat(BzrDirMetaFormat1):
"""Format representing bzrdirs accessed via a smart server"""
def get_format_description(self):
return 'bzr remote bzrdir'
@classmethod
def probe_transport(klass, transport):
"""Return a RemoteBzrDirFormat object if it looks possible."""
try:
client = transport.get_smart_client()
except (NotImplementedError, AttributeError,
errors.TransportNotPossible):
# no smart server, so not a branch for this format type.
raise errors.NotBranchError(path=transport.base)
else:
# Send a 'hello' request in protocol version one, and decline to
# open it if the server doesn't support our required version (2) so
# that the VFS-based transport will do it.
request = client.get_request()
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
server_version = smart_protocol.query_version()
if server_version != 2:
raise errors.NotBranchError(path=transport.base)
return klass()
def initialize_on_transport(self, transport):
try:
# hand off the request to the smart server
shared_medium = transport.get_shared_medium()
except errors.NoSmartMedium:
# TODO: lookup the local format from a server hint.
local_dir_format = BzrDirMetaFormat1()
return local_dir_format.initialize_on_transport(transport)
client = _SmartClient(shared_medium)
path = client.remote_path_from_transport(transport)
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
path)
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
return remote.RemoteBzrDir(transport)
def _open(self, transport):
return remote.RemoteBzrDir(transport)
def __eq__(self, other):
if not isinstance(other, RemoteBzrDirFormat):
return False
return self.get_format_description() == other.get_format_description()
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
class BzrDirFormatInfo(object):
def __init__(self, native, deprecated, hidden):
self.deprecated = deprecated
self.native = native
self.hidden = hidden
class BzrDirFormatRegistry(registry.Registry):
"""Registry of user-selectable BzrDir subformats.
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
"""
def register_metadir(self, key,
repository_format, help, native=True, deprecated=False,
branch_format=None,
tree_format=None,
hidden=False):
"""Register a metadir subformat.
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
by the Repository format.
:param repository_format: The fully-qualified repository format class
name as a string.
:param branch_format: Fully-qualified branch format class name as
a string.
:param tree_format: Fully-qualified tree format class name as
a string.
"""
# This should be expanded to support setting WorkingTree and Branch
# formats, once BzrDirMetaFormat1 supports that.
def _load(full_name):
mod_name, factory_name = full_name.rsplit('.', 1)
try:
mod = __import__(mod_name, globals(), locals(),
[factory_name])
except ImportError, e:
raise ImportError('failed to load %s: %s' % (full_name, e))
try:
factory = getattr(mod, factory_name)
except AttributeError:
raise AttributeError('no factory %s in module %r'
% (full_name, mod))
return factory()
def helper():
bd = BzrDirMetaFormat1()
if branch_format is not None:
bd.set_branch_format(_load(branch_format))
if tree_format is not None:
bd.workingtree_format = _load(tree_format)
if repository_format is not None:
bd.repository_format = _load(repository_format)
return bd
self.register(key, helper, help, native, deprecated, hidden)
def register(self, key, factory, help, native=True, deprecated=False,
hidden=False):
"""Register a BzrDirFormat factory.
The factory must be a callable that takes one parameter: the key.
It must produce an instance of the BzrDirFormat when called.
This function mainly exists to prevent the info object from being
supplied directly.
"""
registry.Registry.register(self, key, factory, help,
BzrDirFormatInfo(native, deprecated, hidden))
def register_lazy(self, key, module_name, member_name, help, native=True,
deprecated=False, hidden=False):
registry.Registry.register_lazy(self, key, module_name, member_name,
help, BzrDirFormatInfo(native, deprecated, hidden))
def set_default(self, key):
"""Set the 'default' key to be a clone of the supplied key.
This method must be called once and only once.
"""
registry.Registry.register(self, 'default', self.get(key),
self.get_help(key), info=self.get_info(key))
def set_default_repository(self, key):
"""Set the FormatRegistry default and Repository default.
This is a transitional method while Repository.set_default_format
is deprecated.
"""
if 'default' in self:
self.remove('default')
self.set_default(key)
format = self.get('default')()
assert isinstance(format, BzrDirMetaFormat1)
def make_bzrdir(self, key):
return self.get(key)()
def help_topic(self, topic):
output = textwrap.dedent("""\
These formats can be used for creating branches, working trees, and
repositories.
""")
default_realkey = None
default_help = self.get_help('default')
help_pairs = []
for key in self.keys():
if key == 'default':
continue
help = self.get_help(key)
if help == default_help:
default_realkey = key
else:
help_pairs.append((key, help))
def wrapped(key, help, info):
if info.native:
help = '(native) ' + help
return ':%s:\n%s\n\n' % (key,
textwrap.fill(help, initial_indent=' ',
subsequent_indent=' '))
if default_realkey is not None:
output += wrapped(default_realkey, '(default) %s' % default_help,
self.get_info('default'))
deprecated_pairs = []
for key, help in help_pairs:
info = self.get_info(key)
if info.hidden:
continue
elif info.deprecated:
deprecated_pairs.append((key, help))
else:
output += wrapped(key, help, info)
if len(deprecated_pairs) > 0:
output += "Deprecated formats are shown below.\n\n"
for key, help in deprecated_pairs:
info = self.get_info(key)
output += wrapped(key, help, info)
return output
format_registry = BzrDirFormatRegistry()
format_registry.register('weave', BzrDirFormat6,
'Pre-0.8 format. Slower than knit and does not'
' support checkouts or shared repositories.',
deprecated=True)
format_registry.register_metadir('knit',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
branch_format='bzrlib.branch.BzrBranchFormat5',
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
format_registry.register_metadir('metaweave',
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
'Transitional format in 0.8. Slower than knit.',
branch_format='bzrlib.branch.BzrBranchFormat5',
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
deprecated=True)
format_registry.register_metadir('dirstate',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
'above when accessed over the network.',
branch_format='bzrlib.branch.BzrBranchFormat5',
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
# directly from workingtree_4 triggers a circular import.
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
)
format_registry.register_metadir('dirstate-tags',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
help='New in 0.15: Fast local operations and improved scaling for '
'network operations. Additionally adds support for tags.'
' Incompatible with bzr < 0.15.',
branch_format='bzrlib.branch.BzrBranchFormat6',
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
)
format_registry.register_metadir('dirstate-with-subtree',
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
help='New in 0.15: Fast local operations and improved scaling for '
'network operations. Additionally adds support for versioning nested '
'bzr branches. Incompatible with bzr < 0.15.',
branch_format='bzrlib.branch.BzrBranchFormat6',
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
hidden=True,
)
format_registry.set_default('dirstate-tags')
|