1185.31.12
by John Arbash Meinel
Refactored the export code to make it easier to add new export formats. |
1 |
# Copyright (C) 2005 Canonical Ltd
|
2 |
||
3 |
# This program is free software; you can redistribute it and/or modify
|
|
4 |
# it under the terms of the GNU General Public License as published by
|
|
5 |
# the Free Software Foundation; either version 2 of the License, or
|
|
6 |
# (at your option) any later version.
|
|
7 |
||
8 |
# This program is distributed in the hope that it will be useful,
|
|
9 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
10 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
11 |
# GNU General Public License for more details.
|
|
12 |
||
13 |
# You should have received a copy of the GNU General Public License
|
|
14 |
# along with this program; if not, write to the Free Software
|
|
15 |
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
16 |
||
17 |
"""Export functionality, which can take a Tree and create a different representation.
|
|
18 |
||
19 |
Such as non-controlled directories, tarfiles, zipfiles, etc.
|
|
20 |
"""
|
|
21 |
||
22 |
from bzrlib.trace import mutter |
|
23 |
import os |
|
24 |
import bzrlib.errors as errors |
|
25 |
||
26 |
# Maps format name => export function
|
|
27 |
_exporters = {} |
|
28 |
# Maps filename extensions => export format name
|
|
29 |
_exporter_extensions = {} |
|
30 |
||
31 |
def register_exporter(format, extensions, func, override=False): |
|
32 |
"""Register an exporter.
|
|
33 |
||
34 |
:param format: This is the name of the format, such as 'tgz' or 'zip'
|
|
35 |
:param extensions: Extensions which should be used in the case that a
|
|
36 |
format was not explicitly specified.
|
|
37 |
:type extensions: List
|
|
38 |
:param func: The function. It will be called with (tree, dest, root)
|
|
39 |
:param override: Whether to override an object which already exists.
|
|
40 |
Frequently plugins will want to provide functionality
|
|
41 |
until it shows up in mainline, so the default is False.
|
|
42 |
"""
|
|
43 |
global _exporters, _exporter_extensions |
|
44 |
||
45 |
if not _exporters.has_key(format) or override: |
|
46 |
_exporters[format] = func |
|
47 |
||
48 |
for ext in extensions: |
|
49 |
if not _exporter_extensions.has_key(ext) or override: |
|
50 |
_exporter_extensions[ext] = format |
|
51 |
||
52 |
||
53 |
def register_lazy_exporter(scheme, extensions, module, funcname): |
|
54 |
"""Register lazy-loaded exporter function.
|
|
55 |
||
56 |
When requesting a specific type of export, load the respective path.
|
|
57 |
"""
|
|
58 |
def _loader(tree, dest, root): |
|
59 |
mod = __import__(module, globals(), locals(), [funcname]) |
|
60 |
func = getattr(mod, funcname) |
|
61 |
return func(tree, dest, root) |
|
62 |
register_exporter(scheme, extensions, _loader) |
|
63 |
||
64 |
||
65 |
def export(tree, dest, format=None, root=None): |
|
66 |
"""Export the given Tree to the specific destination.
|
|
67 |
||
68 |
:param tree: A Tree (such as RevisionTree) to export
|
|
69 |
:param dest: The destination where the files,etc should be put
|
|
70 |
:param format: The format (dir, zip, etc), if None, it will check the
|
|
71 |
extension on dest, looking for a match
|
|
72 |
:param root: The root location inside the format.
|
|
73 |
It is common practise to have zipfiles and tarballs
|
|
74 |
extract into a subdirectory, rather than into the
|
|
75 |
current working directory.
|
|
76 |
If root is None, the default root will be
|
|
77 |
selected as the destination without its
|
|
78 |
extension.
|
|
79 |
"""
|
|
80 |
global _exporters, _exporter_extensions |
|
81 |
||
82 |
if format is None: |
|
83 |
for ext in _exporter_extensions: |
|
84 |
if dest.endswith(ext): |
|
85 |
format = _exporter_extensions[ext] |
|
86 |
break
|
|
87 |
||
88 |
# Most of the exporters will just have to call
|
|
89 |
# this function anyway, so why not do it for them
|
|
90 |
if root is None: |
|
91 |
root = get_root_name(dest) |
|
92 |
||
93 |
if not _exporters.has_key(format): |
|
94 |
raise errors.NoSuchExportFormat(format) |
|
95 |
return _exporters[format](tree, dest, root) |
|
96 |
||
97 |
||
98 |
def get_root_name(dest): |
|
99 |
"""Get just the root name for an export.
|
|
100 |
||
101 |
>>> get_root_name('mytar.tar')
|
|
102 |
'mytar'
|
|
103 |
>>> get_root_name('mytar.tar.bz2')
|
|
104 |
'mytar'
|
|
105 |
>>> get_root_name('tar.tar.tar.tgz')
|
|
106 |
'tar.tar.tar'
|
|
107 |
>>> get_root_name('bzr-0.0.5.tar.gz')
|
|
108 |
'bzr-0.0.5'
|
|
109 |
>>> get_root_name('bzr-0.0.5.zip')
|
|
110 |
'bzr-0.0.5'
|
|
111 |
>>> get_root_name('bzr-0.0.5')
|
|
112 |
'bzr-0.0.5'
|
|
113 |
>>> get_root_name('a/long/path/mytar.tgz')
|
|
114 |
'mytar'
|
|
115 |
>>> get_root_name('../parent/../dir/other.tbz2')
|
|
116 |
'other'
|
|
117 |
"""
|
|
118 |
global _exporter_extensions |
|
119 |
dest = os.path.basename(dest) |
|
120 |
for ext in _exporter_extensions: |
|
121 |
if dest.endswith(ext): |
|
122 |
return dest[:-len(ext)] |
|
1185.31.13
by John Arbash Meinel
Updated the test to also test zip exports. Fixed some small bugs exposed by test suite. |
123 |
return dest |
1185.31.12
by John Arbash Meinel
Refactored the export code to make it easier to add new export formats. |
124 |
|
125 |
||
126 |
register_lazy_exporter(None, [], 'bzrlib.export.dir_exporter', 'dir_exporter') |
|
127 |
register_lazy_exporter('dir', [], 'bzrlib.export.dir_exporter', 'dir_exporter') |
|
128 |
register_lazy_exporter('tar', ['.tar'], 'bzrlib.export.tar_exporter', 'tar_exporter') |
|
129 |
register_lazy_exporter('tgz', ['.tar.gz', '.tgz'], 'bzrlib.export.tar_exporter', 'tgz_exporter') |
|
1185.31.13
by John Arbash Meinel
Updated the test to also test zip exports. Fixed some small bugs exposed by test suite. |
130 |
register_lazy_exporter('tbz2', ['.tar.bz2', '.tbz2'], 'bzrlib.export.tar_exporter', 'tbz_exporter') |
1185.31.12
by John Arbash Meinel
Refactored the export code to make it easier to add new export formats. |
131 |
register_lazy_exporter('zip', ['.zip'], 'bzrlib.export.zip_exporter', 'zip_exporter') |
132 |