unify mirror support and make it independant of the fetcher
[bitbake.git] / lib / bb / fetch / 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 bb
30 from bb import data
31 from bb.fetch import Fetch
32 from bb.fetch import FetchError
33 from bb.fetch import MissingParameterError
34 from bb.fetch import runfetchcmd
35
36 class Hg(Fetch):
37     """Class to fetch a from mercurial repositories"""
38     def supports(self, url, ud, d):
39         """
40         Check to see if a given url can be fetched with mercurial.
41         """
42         return ud.type in ['hg']
43
44     def localpath(self, url, ud, d):
45         if not "module" in ud.parm:
46             raise MissingParameterError("hg method needs a 'module' parameter")
47
48         ud.module = ud.parm["module"]
49
50         # Create paths to mercurial checkouts
51         relpath = ud.path
52         if relpath.startswith('/'):
53             # Remove leading slash as os.path.join can't cope
54             relpath = relpath[1:]
55         ud.pkgdir = os.path.join(data.expand('${HGDIR}', d), ud.host, relpath)
56         ud.moddir = os.path.join(ud.pkgdir, ud.module)
57
58         if 'rev' in ud.parm:
59             ud.revision = ud.parm['rev']
60         else:
61             tag = Fetch.srcrev_internal_helper(ud, d)
62             if tag is True:
63                 ud.revision = self.latest_revision(url, ud, d)
64             elif tag:
65                 ud.revision = tag
66             else:
67                 ud.revision = self.latest_revision(url, ud, d)
68
69         ud.localfile = data.expand('%s_%s_%s_%s.tar.gz' % (ud.module.replace('/', '.'), ud.host, ud.path.replace('/', '.'), ud.revision), d)
70
71         return os.path.join(data.getVar("DL_DIR", d, True), ud.localfile)
72
73     def _buildhgcommand(self, ud, d, command):
74         """
75         Build up an hg commandline based on ud
76         command is "fetch", "update", "info"
77         """
78
79         basecmd = data.expand('${FETCHCMD_hg}', d)
80
81         proto = "http"
82         if "proto" in ud.parm:
83             proto = ud.parm["proto"]
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 is "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 is "fetch":
103             cmd = "%s clone %s %s://%s/%s %s" % (basecmd, " ".join(options), proto, hgroot, ud.module, ud.module)
104         elif command is "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 is "update":
110             cmd = "%s update -C %s" % (basecmd, " ".join(options))
111         else:
112             raise FetchError("Invalid hg command %s" % command)
113
114         return cmd
115
116     def go(self, loc, ud, d):
117         """Fetch url"""
118
119         bb.msg.debug(2, bb.msg.domain.Fetcher, "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             bb.msg.note(1, bb.msg.domain.Fetcher, "Update " + loc)
124             # update sources there
125             os.chdir(ud.moddir)
126             bb.msg.debug(1, bb.msg.domain.Fetcher, "Running %s" % updatecmd)
127             runfetchcmd(updatecmd, d)
128
129         else:
130             fetchcmd = self._buildhgcommand(ud, d, "fetch")
131             bb.msg.note(1, bb.msg.domain.Fetcher, "Fetch " + loc)
132             # check out sources there
133             bb.mkdirhier(ud.pkgdir)
134             os.chdir(ud.pkgdir)
135             bb.msg.debug(1, bb.msg.domain.Fetcher, "Running %s" % fetchcmd)
136             runfetchcmd(fetchcmd, d)
137         
138         # Even when we clone (fetch), we still need to update as hg's clone
139         # won't checkout the specified revision if its on a branch
140         updatecmd = self._buildhgcommand(ud, d, "update")
141         bb.msg.debug(1, bb.msg.domain.Fetcher, "Running %s" % updatecmd)
142         runfetchcmd(updatecmd, d)
143
144         os.chdir(ud.pkgdir)
145         try:
146             runfetchcmd("tar -czf %s %s" % (ud.localpath, ud.module), d)
147         except:
148             t, v, tb = sys.exc_info()
149             try:
150                 os.unlink(ud.localpath)
151             except OSError:
152                 pass
153             raise t, v, tb
154
155     def suppports_srcrev(self):
156         return True
157
158     def _latest_revision(self, url, ud, d):
159         """
160         Compute tip revision for the url
161         """
162         output = runfetchcmd(self._buildhgcommand(ud, d, "info"), d)
163         return output.strip()
164
165     def _build_revision(self, url, ud, d):
166         return ud.revision
167
168     def _revision_key(self, url, ud, d):
169         """
170         Return a unique key for the url
171         """
172         return "hg:" + ud.moddir
173