svn.py revision f5ad077741427df305fadba9e6380103902bc266 
1'''
2Copyright 2011 Google Inc.
3
4Use of this source code is governed by a BSD-style license that can be
5found in the LICENSE file.
6'''
7
8import fnmatch
9import os
10import re
11import subprocess
12
13PROPERTY_MIMETYPE = 'svn:mime-type'
14
15# Status types for GetFilesWithStatus()
16STATUS_ADDED                 = 0x01
17STATUS_DELETED               = 0x02
18STATUS_MODIFIED              = 0x04
19STATUS_NOT_UNDER_SVN_CONTROL = 0x08
20
21class Svn:
22
23    def __init__(self, directory):
24        """Set up to manipulate SVN control within the given directory.
25
26        @param directory
27        """
28        self._directory = directory
29
30    def _RunCommand(self, args):
31        """Run a command (from self._directory) and return stdout as a single
32        string.
33
34        @param args a list of arguments
35        """
36        print 'RunCommand: %s' % args
37        proc = subprocess.Popen(args, cwd=self._directory,
38                                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
39        (stdout, stderr) = proc.communicate()
40        if proc.returncode is not 0:
41            raise Exception('command "%s" failed in dir "%s": %s' %
42                            (args, self._directory, stderr))
43        return stdout
44
45    def Checkout(self, url, path):
46        """Check out a working copy from a repository.
47        Returns stdout as a single string.
48
49        @param url URL from which to check out the working copy
50        @param path path (within self._directory) where the local copy will be
51        written
52        """
53        return self._RunCommand(['svn', 'checkout', url, path])
54
55    def ListSubdirs(self, url):
56        """Returns a list of all subdirectories (not files) within a given SVN
57        url.
58
59        @param url remote directory to list subdirectories of
60        """
61        subdirs = []
62        filenames = self._RunCommand(['svn', 'ls', url]).split('\n')
63        for filename in filenames:
64            if filename.endswith('/'):
65                subdirs.append(filename.strip('/'))
66        return subdirs
67
68    def GetNewFiles(self):
69        """Return a list of files which are in this directory but NOT under
70        SVN control.
71        """
72        return self.GetFilesWithStatus(STATUS_NOT_UNDER_SVN_CONTROL)
73
74    def GetNewAndModifiedFiles(self):
75        """Return a list of files in this dir which are newly added or modified,
76        including those that are not (yet) under SVN control.
77        """
78        return self.GetFilesWithStatus(
79            STATUS_ADDED | STATUS_MODIFIED | STATUS_NOT_UNDER_SVN_CONTROL)
80
81    def GetFilesWithStatus(self, status):
82        """Return a list of files in this dir with the given SVN status.
83
84        @param status bitfield combining one or more STATUS_xxx values
85        """
86        status_types_string = ''
87        if status & STATUS_ADDED:
88            status_types_string += 'A'
89        if status & STATUS_DELETED:
90            status_types_string += 'D'
91        if status & STATUS_MODIFIED:
92            status_types_string += 'M'
93        if status & STATUS_NOT_UNDER_SVN_CONTROL:
94            status_types_string += '\?'
95        status_regex_string = '^[%s].....\s+(.+)$' % status_types_string
96        stdout = self._RunCommand(['svn', 'status'])
97        status_regex = re.compile(status_regex_string, re.MULTILINE)
98        files = status_regex.findall(stdout)
99        return files
100
101    def AddFiles(self, filenames):
102        """Adds these files to SVN control.
103
104        @param filenames files to add to SVN control
105        """
106        self._RunCommand(['svn', 'add'] + filenames)
107
108    def SetProperty(self, filenames, property_name, property_value):
109        """Sets a svn property for these files.
110
111        @param filenames files to set property on
112        @param property_name property_name to set for each file
113        @param property_value what to set the property_name to
114        """
115        if filenames:
116            self._RunCommand(
117                ['svn', 'propset', property_name, property_value] + filenames)
118
119    def SetPropertyByFilenamePattern(self, filename_pattern,
120                                     property_name, property_value):
121        """Sets a svn property for all files matching filename_pattern.
122
123        @param filename_pattern set the property for all files whose names match
124               this Unix-style filename pattern (e.g., '*.jpg')
125        @param property_name property_name to set for each file
126        @param property_value what to set the property_name to
127        """
128        all_files = os.listdir(self._directory)
129        matching_files = sorted(fnmatch.filter(all_files, filename_pattern))
130        self.SetProperty(matching_files, property_name, property_value)
131
132    def ExportBaseVersionOfFile(self, file_within_repo, dest_path):
133        """Retrieves a copy of the base version (what you would get if you ran
134        'svn revert') of a file within the repository.
135
136        @param file_within_repo path to the file within the repo whose base
137               version you wish to obtain
138        @param dest_path destination to which to write the base content
139        """
140        self._RunCommand(['svn', 'export', '--revision', 'BASE',
141                          file_within_repo, dest_path])
142