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
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.extend.subversion</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.extend-module.html">Package extend</a> ::
Module subversion
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.extend.subversion-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module subversion</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html">source code</a></span></p>
<p>Provides an extension to back up Subversion repositories.</p>
<p>This is a Cedar Backup extension used to back up Subversion
repositories via the Cedar Backup command line. Each Subversion
repository can be backed using the same collect modes allowed for
filesystems in the standard Cedar Backup collect action: weekly, daily,
incremental.</p>
<p>This extension requires a new configuration section <subversion>
and is intended to be run either immediately before or immediately after
the standard collect action. Aside from its own configuration, it
requires the options and collect configuration sections in the standard
Cedar Backup configuration file.</p>
<p>There are two different kinds of Subversion repositories at this
writing: BDB (Berkeley Database) and FSFS (a "filesystem within a
filesystem"). Although the repository type can be specified in
configuration, that information is just kept around for reference. It
doesn't affect the backup. Both kinds of repositories are backed up in
the same way, using <code>svnadmin dump</code> in an incremental
mode.</p>
<p>It turns out that FSFS repositories can also be backed up just like
any other filesystem directory. If you would rather do that, then use
the normal collect action. This is probably simpler, although it carries
its own advantages and disadvantages (plus you will have to be careful to
exclude the working directories Subversion uses when building an update
to commit). Check the Subversion documentation for more information.</p>
<hr />
<div class="fields"> <p><strong>Author:</strong>
Kenneth J. Pronovici <pronovic@ieee.org>
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.RepositoryDir-class.html" class="summary-name">RepositoryDir</a><br />
Class representing Subversion repository directory.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.Repository-class.html" class="summary-name">Repository</a><br />
Class representing generic Subversion repository configuration..
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.SubversionConfig-class.html" class="summary-name">SubversionConfig</a><br />
Class representing Subversion configuration.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.LocalConfig-class.html" class="summary-name">LocalConfig</a><br />
Class representing this extension's configuration document.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.BDBRepository-class.html" class="summary-name">BDBRepository</a><br />
Class representing Subversion BDB (Berkeley Database) repository
configuration.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="CedarBackup2.extend.subversion.FSFSRepository-class.html" class="summary-name">FSFSRepository</a><br />
Class representing Subversion FSFS repository configuration.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#executeAction" class="summary-sig-name">executeAction</a>(<span class="summary-sig-arg">configPath</span>,
<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">config</span>)</span><br />
Executes the Subversion backup action.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#executeAction">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getCollectMode" class="summary-sig-name" onclick="show_private();">_getCollectMode</a>(<span class="summary-sig-arg">local</span>,
<span class="summary-sig-arg">repository</span>)</span><br />
Gets the collect mode that should be used for a repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getCollectMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getCompressMode" class="summary-sig-name" onclick="show_private();">_getCompressMode</a>(<span class="summary-sig-arg">local</span>,
<span class="summary-sig-arg">repository</span>)</span><br />
Gets the compress mode that should be used for a repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getCompressMode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getRevisionPath" class="summary-sig-name" onclick="show_private();">_getRevisionPath</a>(<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">repository</span>)</span><br />
Gets the path to the revision file associated with a repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getRevisionPath">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getBackupPath" class="summary-sig-name" onclick="show_private();">_getBackupPath</a>(<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">repositoryPath</span>,
<span class="summary-sig-arg">compressMode</span>,
<span class="summary-sig-arg">startRevision</span>,
<span class="summary-sig-arg">endRevision</span>)</span><br />
Gets the backup file path (including correct extension) associated
with a repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getBackupPath">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getRepositoryPaths" class="summary-sig-name" onclick="show_private();">_getRepositoryPaths</a>(<span class="summary-sig-arg">repositoryDir</span>)</span><br />
Gets a list of child repository paths within a repository directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getRepositoryPaths">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getExclusions" class="summary-sig-name" onclick="show_private();">_getExclusions</a>(<span class="summary-sig-arg">repositoryDir</span>)</span><br />
Gets exclusions (file and patterns) associated with an repository
directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getExclusions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_backupRepository" class="summary-sig-name" onclick="show_private();">_backupRepository</a>(<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">local</span>,
<span class="summary-sig-arg">todayIsStart</span>,
<span class="summary-sig-arg">fullBackup</span>,
<span class="summary-sig-arg">repository</span>)</span><br />
Backs up an individual Subversion repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_backupRepository">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_getOutputFile" class="summary-sig-name" onclick="show_private();">_getOutputFile</a>(<span class="summary-sig-arg">backupPath</span>,
<span class="summary-sig-arg">compressMode</span>)</span><br />
Opens the output file used for saving the Subversion dump.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getOutputFile">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_loadLastRevision" class="summary-sig-name" onclick="show_private();">_loadLastRevision</a>(<span class="summary-sig-arg">revisionPath</span>)</span><br />
Loads the indicated revision file from disk into an integer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_loadLastRevision">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#_writeLastRevision" class="summary-sig-name" onclick="show_private();">_writeLastRevision</a>(<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">revisionPath</span>,
<span class="summary-sig-arg">endRevision</span>)</span><br />
Writes the end revision to the indicated revision file on disk.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_writeLastRevision">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#backupRepository" class="summary-sig-name">backupRepository</a>(<span class="summary-sig-arg">repositoryPath</span>,
<span class="summary-sig-arg">backupFile</span>,
<span class="summary-sig-arg">startRevision</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">endRevision</span>=<span class="summary-sig-default">None</span>)</span><br />
Backs up an individual Subversion repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupRepository">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#getYoungestRevision" class="summary-sig-name">getYoungestRevision</a>(<span class="summary-sig-arg">repositoryPath</span>)</span><br />
Gets the youngest (newest) revision in a Subversion repository using
<code>svnlook</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#getYoungestRevision">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#backupBDBRepository" class="summary-sig-name">backupBDBRepository</a>(<span class="summary-sig-arg">repositoryPath</span>,
<span class="summary-sig-arg">backupFile</span>,
<span class="summary-sig-arg">startRevision</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">endRevision</span>=<span class="summary-sig-default">None</span>)</span><br />
Backs up an individual Subversion BDB repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupBDBRepository">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.extend.subversion-module.html#backupFSFSRepository" class="summary-sig-name">backupFSFSRepository</a>(<span class="summary-sig-arg">repositoryPath</span>,
<span class="summary-sig-arg">backupFile</span>,
<span class="summary-sig-arg">startRevision</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">endRevision</span>=<span class="summary-sig-default">None</span>)</span><br />
Backs up an individual Subversion FSFS repository.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupFSFSRepository">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger("CedarBackup2.log.extend.subversion")">logging.getLogger("CedarBackup2.log.extend.subversion")</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="SVNLOOK_COMMAND"></a><span class="summary-name">SVNLOOK_COMMAND</span> = <code title="['svnlook']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">svnlook</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="SVNADMIN_COMMAND"></a><span class="summary-name">SVNADMIN_COMMAND</span> = <code title="['svnadmin']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">svnadmin</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="REVISION_PATH_EXTENSION"></a><span class="summary-name">REVISION_PATH_EXTENSION</span> = <code title="'svnlast'"><code class="variable-quote">'</code><code class="variable-string">svnlast</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="executeAction"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">executeAction</span>(<span class="sig-arg">configPath</span>,
<span class="sig-arg">options</span>,
<span class="sig-arg">config</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#executeAction">source code</a></span>
</td>
</tr></table>
<p>Executes the Subversion backup action.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>configPath</code></strong> (String representing a path on disk.) - Path to configuration file on disk.</li>
<li><strong class="pname"><code>options</code></strong> (Options object.) - Program command-line options.</li>
<li><strong class="pname"><code>config</code></strong> (Config object.) - Program configuration.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - Under many generic error conditions</li>
<li><code><strong class='fraise'>IOError</strong></code> - If a backup could not be written for some reason.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getCollectMode"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getCollectMode</span>(<span class="sig-arg">local</span>,
<span class="sig-arg">repository</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getCollectMode">source code</a></span>
</td>
</tr></table>
<p>Gets the collect mode that should be used for a repository. Use
repository's if possible, otherwise take from subversion section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>repository</code></strong> - Repository object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Collect mode to use.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getCompressMode"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getCompressMode</span>(<span class="sig-arg">local</span>,
<span class="sig-arg">repository</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getCompressMode">source code</a></span>
</td>
</tr></table>
<p>Gets the compress mode that should be used for a repository. Use
repository's if possible, otherwise take from subversion section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>local</code></strong> - LocalConfig object.</li>
<li><strong class="pname"><code>repository</code></strong> - Repository object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Compress mode to use.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getRevisionPath"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getRevisionPath</span>(<span class="sig-arg">config</span>,
<span class="sig-arg">repository</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getRevisionPath">source code</a></span>
</td>
</tr></table>
<p>Gets the path to the revision file associated with a repository.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>config</code></strong> - Config object.</li>
<li><strong class="pname"><code>repository</code></strong> - Repository object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Absolute path to the revision file associated with the
repository.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getBackupPath"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getBackupPath</span>(<span class="sig-arg">config</span>,
<span class="sig-arg">repositoryPath</span>,
<span class="sig-arg">compressMode</span>,
<span class="sig-arg">startRevision</span>,
<span class="sig-arg">endRevision</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getBackupPath">source code</a></span>
</td>
</tr></table>
<p>Gets the backup file path (including correct extension) associated
with a repository.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>config</code></strong> - Config object.</li>
<li><strong class="pname"><code>repositoryPath</code></strong> - Path to the indicated repository</li>
<li><strong class="pname"><code>compressMode</code></strong> - Compress mode to use for this repository.</li>
<li><strong class="pname"><code>startRevision</code></strong> - Starting repository revision.</li>
<li><strong class="pname"><code>endRevision</code></strong> - Ending repository revision.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Absolute path to the backup file associated with the repository.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getRepositoryPaths"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getRepositoryPaths</span>(<span class="sig-arg">repositoryDir</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getRepositoryPaths">source code</a></span>
</td>
</tr></table>
<p>Gets a list of child repository paths within a repository
directory.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>repositoryDir</code></strong> - RepositoryDirectory</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getExclusions"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getExclusions</span>(<span class="sig-arg">repositoryDir</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getExclusions">source code</a></span>
</td>
</tr></table>
<p>Gets exclusions (file and patterns) associated with an repository
directory.</p>
<p>The returned files value is a list of absolute paths to be excluded
from the backup for a given directory. It is derived from the repository
directory's relative exclude paths.</p>
<p>The returned patterns value is a list of patterns to be excluded from
the backup for a given directory. It is derived from the repository
directory's list of patterns.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>repositoryDir</code></strong> - Repository directory object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple (files, patterns) indicating what to exclude.</dd>
</dl>
</td></tr></table>
</div>
<a name="_backupRepository"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_backupRepository</span>(<span class="sig-arg">config</span>,
<span class="sig-arg">local</span>,
<span class="sig-arg">todayIsStart</span>,
<span class="sig-arg">fullBackup</span>,
<span class="sig-arg">repository</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_backupRepository">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual Subversion repository.</p>
<p>This internal method wraps the public methods and adds some
functionality to work better with the extended action itself.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>config</code></strong> - Cedar Backup configuration.</li>
<li><strong class="pname"><code>local</code></strong> - Local configuration</li>
<li><strong class="pname"><code>todayIsStart</code></strong> - Indicates whether today is start of week</li>
<li><strong class="pname"><code>fullBackup</code></strong> - Full backup flag</li>
<li><strong class="pname"><code>repository</code></strong> - Repository to operate on</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some value is missing or invalid.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem executing the Subversion dump.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_getOutputFile"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getOutputFile</span>(<span class="sig-arg">backupPath</span>,
<span class="sig-arg">compressMode</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_getOutputFile">source code</a></span>
</td>
</tr></table>
<p>Opens the output file used for saving the Subversion dump.</p>
<p>If the compress mode is "gzip", we'll open a
<code>GzipFile</code>, and if the compress mode is "bzip2",
we'll open a <code>BZ2File</code>. Otherwise, we'll just return an
object from the normal <code>open()</code> method.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>backupPath</code></strong> - Path to file to open.</li>
<li><strong class="pname"><code>compressMode</code></strong> - Compress mode of file ("none", "gzip",
"bzip").</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Output file object.</dd>
</dl>
</td></tr></table>
</div>
<a name="_loadLastRevision"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_loadLastRevision</span>(<span class="sig-arg">revisionPath</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_loadLastRevision">source code</a></span>
</td>
</tr></table>
<p>Loads the indicated revision file from disk into an integer.</p>
<p>If we can't load the revision file successfully (either because it
doesn't exist or for some other reason), then a revision of -1 will be
returned - but the condition will be logged. This way, we err on the
side of backing up too much, because anyone using this will presumably be
adding 1 to the revision, so they don't duplicate any backups.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>revisionPath</code></strong> - Path to the revision file on disk.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Integer representing last backed-up revision, -1 on error or if
none can be read.</dd>
</dl>
</td></tr></table>
</div>
<a name="_writeLastRevision"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_writeLastRevision</span>(<span class="sig-arg">config</span>,
<span class="sig-arg">revisionPath</span>,
<span class="sig-arg">endRevision</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#_writeLastRevision">source code</a></span>
</td>
</tr></table>
<p>Writes the end revision to the indicated revision file on disk.</p>
<p>If we can't write the revision file successfully for any reason, we'll
log the condition but won't throw an exception.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>config</code></strong> - Config object.</li>
<li><strong class="pname"><code>revisionPath</code></strong> - Path to the revision file on disk.</li>
<li><strong class="pname"><code>endRevision</code></strong> - Last revision backed up on this run.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="backupRepository"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">backupRepository</span>(<span class="sig-arg">repositoryPath</span>,
<span class="sig-arg">backupFile</span>,
<span class="sig-arg">startRevision</span>=<span class="sig-default">None</span>,
<span class="sig-arg">endRevision</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupRepository">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual Subversion repository.</p>
<p>The starting and ending revision values control an incremental backup.
If the starting revision is not passed in, then revision zero (the start
of the repository) is assumed. If the ending revision is not passed in,
then the youngest revision in the database will be used as the
endpoint.</p>
<p>The backup data will be written into the passed-in back file.
Normally, this would be an object as returned from <code>open</code>, but
it is possible to use something like a <code>GzipFile</code> to write
compressed output. The caller is responsible for closing the passed-in
backup file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>repositoryPath</code></strong> (String path representing Subversion repository on disk.) - Path to Subversion repository to back up</li>
<li><strong class="pname"><code>backupFile</code></strong> (Python file object as from <code>open()</code> or
<code>file()</code>.) - Python file object to use for writing backup.</li>
<li><strong class="pname"><code>startRevision</code></strong> (Integer value >= 0.) - Starting repository revision to back up (for incremental backups)</li>
<li><strong class="pname"><code>endRevision</code></strong> (Integer value >= 0.) - Ending repository revision to back up (for incremental backups)</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If some value is missing or invalid.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem executing the Subversion dump.</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Notes:</strong>
<ul class="nomargin-top">
<li>
This function should either be run as root or as the owner of the
Subversion repository.
</li>
<li>
It is apparently <i>not</i> a good idea to interrupt this function.
Sometimes, this leaves the repository in a "wedged"
state, which requires recovery using <code>svnadmin recover</code>.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="getYoungestRevision"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getYoungestRevision</span>(<span class="sig-arg">repositoryPath</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#getYoungestRevision">source code</a></span>
</td>
</tr></table>
<p>Gets the youngest (newest) revision in a Subversion repository using
<code>svnlook</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>repositoryPath</code></strong> (String path representing Subversion repository on disk.) - Path to Subversion repository to look in.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Youngest revision as an integer.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If there is a problem parsing the <code>svnlook</code> output.</li>
<li><code><strong class='fraise'>IOError</strong></code> - If there is a problem executing the <code>svnlook</code> command.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
This function should either be run as root or as the owner of the
Subversion repository.
</p>
</div></td></tr></table>
</div>
<a name="backupBDBRepository"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">backupBDBRepository</span>(<span class="sig-arg">repositoryPath</span>,
<span class="sig-arg">backupFile</span>,
<span class="sig-arg">startRevision</span>=<span class="sig-default">None</span>,
<span class="sig-arg">endRevision</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupBDBRepository">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual Subversion BDB repository. This function is
deprecated. Use <a
href="CedarBackup2.extend.subversion-module.html#backupRepository"
class="link">backupRepository</a> instead.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="backupFSFSRepository"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">backupFSFSRepository</span>(<span class="sig-arg">repositoryPath</span>,
<span class="sig-arg">backupFile</span>,
<span class="sig-arg">startRevision</span>=<span class="sig-default">None</span>,
<span class="sig-arg">endRevision</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.extend.subversion-pysrc.html#backupFSFSRepository">source code</a></span>
</td>
</tr></table>
<p>Backs up an individual Subversion FSFS repository. This function is
deprecated. Use <a
href="CedarBackup2.extend.subversion-module.html#backupRepository"
class="link">backupRepository</a> instead.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Oct 19 20:56:41 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
