Fix more incorrect usages of 'is'
[bitbake.git] / lib / bb / fetch2 / svn.py
1 # ex:ts=4:sw=4:sts=4:et
2 # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
3 """
4 BitBake 'Fetch' implementation for svn.
5
6 """
7
8 # Copyright (C) 2003, 2004  Chris Larson
9 # Copyright (C) 2004        Marcin Juszkiewicz
10 #
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License version 2 as
13 # published by the Free Software Foundation.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License along
21 # with this program; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #
24 # Based on functions from the base bb module, Copyright 2003 Holger Schurig
25
26 import os
27 import sys
28 import logging
29 import bb
30 from   bb import data
31 from   bb.fetch2 import FetchMethod
32 from   bb.fetch2 import FetchError
33 from   bb.fetch2 import MissingParameterError
34 from   bb.fetch2 import runfetchcmd
35 from   bb.fetch2 import logger
36
37 class Svn(FetchMethod):
38     """Class to fetch a module or modules from svn repositories"""
39     def supports(self, url, ud, d):
40         """
41         Check to see if a given url can be fetched with svn.
42         """
43         return ud.type in ['svn']
44
45     def urldata_init(self, ud, d):
46         """
47         init svn specific variable within url data
48         """
49         if not "module" in ud.parm:
50             raise MissingParameterError('module', ud.url)
51
52         ud.module = ud.parm["module"]
53
54         # Create paths to svn checkouts
55         relpath = self._strip_leading_slashes(ud.path)
56         ud.pkgdir = os.path.join(data.expand('${SVNDIR}', d), ud.host, relpath)
57         ud.moddir = os.path.join(ud.pkgdir, ud.module)
58
59         if 'rev' in ud.parm:
60             ud.revision = ud.parm['rev']
61
62         ud.localfile = data.expand('%s_%s_%s_%s_.tar.gz' % (ud.module.replace('/', '.'), ud.host, ud.path.replace('/', '.'), ud.revision), d)
63
64     def _buildsvncommand(self, ud, d, command):
65         """
66         Build up an svn commandline based on ud
67         command is "fetch", "update", "info"
68         """
69
70         basecmd = data.expand('${FETCHCMD_svn}', d)
71
72         proto = ud.parm.get('proto', 'svn')
73
74         svn_rsh = None
75         if proto == "svn+ssh" and "rsh" in ud.parm:
76             svn_rsh = ud.parm["rsh"]
77
78         svnroot = ud.host + ud.path
79
80         options = []
81
82         if ud.user:
83             options.append("--username %s" % ud.user)
84
85         if ud.pswd:
86             options.append("--password %s" % ud.pswd)
87
88         if command == "info":
89             svncmd = "%s info %s %s://%s/%s/" % (basecmd, " ".join(options), proto, svnroot, ud.module)
90         else:
91             suffix = ""
92             if ud.revision:
93                 options.append("-r %s" % ud.revision)
94                 suffix = "@%s" % (ud.revision)
95
96             if command == "fetch":
97                 svncmd = "%s co %s %s://%s/%s%s %s" % (basecmd, " ".join(options), proto, svnroot, ud.module, suffix, ud.module)
98             elif command == "update":
99                 svncmd = "%s update %s" % (basecmd, " ".join(options))
100             else:
101                 raise FetchError("Invalid svn command %s" % command, ud.url)
102
103         if svn_rsh:
104             svncmd = "svn_RSH=\"%s\" %s" % (svn_rsh, svncmd)
105
106         return svncmd
107
108     def download(self, loc, ud, d):
109         """Fetch url"""
110
111         logger.debug(2, "Fetch: checking for module directory '" + ud.moddir + "'")
112
113         if os.access(os.path.join(ud.moddir, '.svn'), os.R_OK):
114             svnupdatecmd = self._buildsvncommand(ud, d, "update")
115             logger.info("Update " + loc)
116             # update sources there
117             os.chdir(ud.moddir)
118             logger.debug(1, "Running %s", svnupdatecmd)
119             bb.fetch2.check_network_access(d, svnupdatecmd, ud.url)
120             runfetchcmd(svnupdatecmd, d)
121         else:
122             svnfetchcmd = self._buildsvncommand(ud, d, "fetch")
123             logger.info("Fetch " + loc)
124             # check out sources there
125             bb.utils.mkdirhier(ud.pkgdir)
126             os.chdir(ud.pkgdir)
127             logger.debug(1, "Running %s", svnfetchcmd)
128             bb.fetch2.check_network_access(d, svnfetchcmd, ud.url)
129             runfetchcmd(svnfetchcmd, d)
130
131         scmdata = ud.parm.get("scmdata", "")
132         if scmdata == "keep":
133             tar_flags = ""
134         else:
135             tar_flags = "--exclude '.svn'"
136
137         os.chdir(ud.pkgdir)
138         # tar them up to a defined filename
139         runfetchcmd("tar %s -czf %s %s" % (tar_flags, ud.localpath, ud.module), d, cleanup = [ud.localpath])
140
141     def clean(self, ud, d):
142         """ Clean SVN specific files and dirs """
143
144         bb.utils.remove(ud.localpath)
145         bb.utils.remove(ud.moddir, True)
146         
147
148     def supports_srcrev(self):
149         return True
150
151     def _revision_key(self, url, ud, d, name):
152         """
153         Return a unique key for the url
154         """
155         return "svn:" + ud.moddir
156
157     def _latest_revision(self, url, ud, d, name):
158         """
159         Return the latest upstream revision number
160         """
161         bb.fetch2.check_network_access(d, self._buildsvncommand(ud, d, "info"))
162
163         output = runfetchcmd("LANG=C LC_ALL=C " + self._buildsvncommand(ud, d, "info"), d, True)
164
165         revision = None
166         for line in output.splitlines():
167             if "Last Changed Rev" in line:
168                 revision = line.split(":")[1].strip()
169
170         return revision
171
172     def _sortable_revision(self, url, ud, d):
173         """
174         Return a sortable revision number which in our case is the revision number
175         """
176
177         return self._build_revision(url, ud, d)
178
179     def _build_revision(self, url, ud, d):
180         return ud.revision