Fix more incorrect usages of 'is'
[bitbake.git] / lib / bb / fetch2 / hg.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 mercurial DRCS (hg).
5
6 """
7
8 # Copyright (C) 2003, 2004  Chris Larson
9 # Copyright (C) 2004        Marcin Juszkiewicz
10 # Copyright (C) 2007        Robert Schuster
11 #
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License version 2 as
14 # published by the Free Software Foundation.
15 #
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20 #
21 # You should have received a copy of the GNU General Public License along
22 # with this program; if not, write to the Free Software Foundation, Inc.,
23 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #
25 # Based on functions from the base bb module, Copyright 2003 Holger Schurig
26
27 import os
28 import sys
29 import logging
30 import bb
31 from bb import data
32 from bb.fetch2 import FetchMethod
33 from bb.fetch2 import FetchError
34 from bb.fetch2 import MissingParameterError
35 from bb.fetch2 import runfetchcmd
36 from bb.fetch2 import logger
37
38 class Hg(FetchMethod):
39     """Class to fetch from mercurial repositories"""
40     def supports(self, url, ud, d):
41         """
42         Check to see if a given url can be fetched with mercurial.
43         """
44         return ud.type in ['hg']
45
46     def urldata_init(self, ud, d):
47         """
48         init hg specific variable within url data
49         """
50         if not "module" in ud.parm:
51             raise MissingParameterError('module', ud.url)
52
53         ud.module = ud.parm["module"]
54
55         # Create paths to mercurial checkouts
56         relpath = self._strip_leading_slashes(ud.path)
57         ud.pkgdir = os.path.join(data.expand('${HGDIR}', d), ud.host, relpath)
58         ud.moddir = os.path.join(ud.pkgdir, ud.module)
59
60         if 'rev' in ud.parm:
61             ud.revision = ud.parm['rev']
62         elif not ud.revision:
63             ud.revision = self.latest_revision(ud.url, ud, d)
64
65         ud.localfile = data.expand('%s_%s_%s_%s.tar.gz' % (ud.module.replace('/', '.'), ud.host, ud.path.replace('/', '.'), ud.revision), d)
66
67     def need_update(self, url, ud, d):
68         revTag = ud.parm.get('rev', 'tip')
69         if revTag == "tip":
70             return True
71         if not os.path.exists(ud.localpath):
72             return True
73         return False
74
75     def _buildhgcommand(self, ud, d, command):
76         """
77         Build up an hg commandline based on ud
78         command is "fetch", "update", "info"
79         """
80
81         basecmd = data.expand('${FETCHCMD_hg}', d)
82
83         proto = ud.parm.get('proto', 'http')
84
85         host = ud.host
86         if proto == "file":
87             host = "/"
88             ud.host = "localhost"
89
90         if not ud.user:
91             hgroot = host + ud.path
92         else:
93             hgroot = ud.user + "@" + host + ud.path
94
95         if command == "info":
96             return "%s identify -i %s://%s/%s" % (basecmd, proto, hgroot, ud.module)
97
98         options = [];
99         if ud.revision:
100             options.append("-r %s" % ud.revision)
101
102         if command == "fetch":
103             cmd = "%s clone %s %s://%s/%s %s" % (basecmd, " ".join(options), proto, hgroot, ud.module, ud.module)
104         elif command == "pull":
105             # do not pass options list; limiting pull to rev causes the local
106             # repo not to contain it and immediately following "update" command
107             # will crash
108             cmd = "%s pull" % (basecmd)
109         elif command == "update":
110             cmd = "%s update -C %s" % (basecmd, " ".join(options))
111         else:
112             raise FetchError("Invalid hg command %s" % command, ud.url)
113
114         return cmd
115
116     def download(self, loc, ud, d):
117         """Fetch url"""
118
119         logger.debug(2, "Fetch: checking for module directory '" + ud.moddir + "'")
120
121         if os.access(os.path.join(ud.moddir, '.hg'), os.R_OK):
122             updatecmd = self._buildhgcommand(ud, d, "pull")
123             logger.info("Update " + loc)
124             # update sources there
125             os.chdir(ud.moddir)
126             logger.debug(1, "Running %s", updatecmd)
127             bb.fetch2.check_network_access(d, updatecmd, ud.url)
128             runfetchcmd(updatecmd, d)
129
130         else:
131             fetchcmd = self._buildhgcommand(ud, d, "fetch")
132             logger.info("Fetch " + loc)
133             # check out sources there
134             bb.utils.mkdirhier(ud.pkgdir)
135             os.chdir(ud.pkgdir)
136             logger.debug(1, "Running %s", fetchcmd)
137             bb.fetch2.check_network_access(d, fetchcmd, ud.url)
138             runfetchcmd(fetchcmd, d)
139
140         # Even when we clone (fetch), we still need to update as hg's clone
141         # won't checkout the specified revision if its on a branch
142         updatecmd = self._buildhgcommand(ud, d, "update")
143         os.chdir(ud.moddir)
144         logger.debug(1, "Running %s", updatecmd)
145         runfetchcmd(updatecmd, d)
146
147         scmdata = ud.parm.get("scmdata", "")
148         if scmdata == "keep":
149             tar_flags = ""
150         else:
151             tar_flags = "--exclude '.hg' --exclude '.hgrags'"
152
153         os.chdir(ud.pkgdir)
154         runfetchcmd("tar %s -czf %s %s" % (tar_flags, ud.localpath, ud.module), d, cleanup = [ud.localpath])
155
156     def supports_srcrev(self):
157         return True
158
159     def _latest_revision(self, url, ud, d, name):
160         """
161         Compute tip revision for the url
162         """
163         bb.fetch2.check_network_access(d, self._buildhgcommand(ud, d, "info"))
164         output = runfetchcmd(self._buildhgcommand(ud, d, "info"), d)
165         return output.strip()
166
167     def _build_revision(self, url, ud, d):
168         return ud.revision
169
170     def _revision_key(self, url, ud, d, name):
171         """
172         Return a unique key for the url
173         """
174         return "hg:" + ud.moddir