blob: 63b7b6f2d51f453f89204ae349a7e22cce03be62 [file] [log] [blame]
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -07001#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
Sarah Owenscecd1d82012-11-01 22:59:27 -070016from __future__ import print_function
John L. Villalovos9c76f672015-03-16 20:49:10 -070017import fcntl
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070018import os
John L. Villalovos9c76f672015-03-16 20:49:10 -070019import select
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070020import sys
21import subprocess
Shawn O. Pearcefb231612009-04-10 18:53:46 -070022import tempfile
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070023from signal import SIGTERM
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070024from error import GitError
Shawn O. Pearcead3193a2009-04-18 09:54:51 -070025from trace import REPO_TRACE, IsTrace, Trace
Conley Owensff0a3c82014-01-30 14:46:03 -080026from wrapper import Wrapper
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070027
28GIT = 'git'
29MIN_GIT_VERSION = (1, 5, 4)
30GIT_DIR = 'GIT_DIR'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070031
32LAST_GITDIR = None
33LAST_CWD = None
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070034
Shawn O. Pearcefb231612009-04-10 18:53:46 -070035_ssh_proxy_path = None
36_ssh_sock_path = None
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070037_ssh_clients = []
Shawn O. Pearcefb231612009-04-10 18:53:46 -070038
Nico Sallembien1c85f4e2010-04-27 14:35:27 -070039def ssh_sock(create=True):
Shawn O. Pearcefb231612009-04-10 18:53:46 -070040 global _ssh_sock_path
41 if _ssh_sock_path is None:
42 if not create:
43 return None
Mickaël Salaün2f6ab7f2012-09-30 00:37:55 +020044 tmp_dir = '/tmp'
45 if not os.path.exists(tmp_dir):
46 tmp_dir = tempfile.gettempdir()
Shawn O. Pearcefb231612009-04-10 18:53:46 -070047 _ssh_sock_path = os.path.join(
Mickaël Salaün2f6ab7f2012-09-30 00:37:55 +020048 tempfile.mkdtemp('', 'ssh-', tmp_dir),
Shawn O. Pearcefb231612009-04-10 18:53:46 -070049 'master-%r@%h:%p')
50 return _ssh_sock_path
51
52def _ssh_proxy():
53 global _ssh_proxy_path
54 if _ssh_proxy_path is None:
55 _ssh_proxy_path = os.path.join(
56 os.path.dirname(__file__),
57 'git_ssh')
58 return _ssh_proxy_path
59
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -070060def _add_ssh_client(p):
61 _ssh_clients.append(p)
62
63def _remove_ssh_client(p):
64 try:
65 _ssh_clients.remove(p)
66 except ValueError:
67 pass
68
69def terminate_ssh_clients():
70 global _ssh_clients
71 for p in _ssh_clients:
72 try:
73 os.kill(p.pid, SIGTERM)
74 p.wait()
75 except OSError:
76 pass
77 _ssh_clients = []
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070078
Shawn O. Pearce334851e2011-09-19 08:05:31 -070079_git_version = None
80
John L. Villalovos9c76f672015-03-16 20:49:10 -070081class _sfd(object):
82 """select file descriptor class"""
83 def __init__(self, fd, dest, std_name):
84 assert std_name in ('stdout', 'stderr')
85 self.fd = fd
86 self.dest = dest
87 self.std_name = std_name
88 def fileno(self):
89 return self.fd.fileno()
90
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070091class _GitCall(object):
92 def version(self):
93 p = GitCommand(None, ['--version'], capture_stdout=True)
94 if p.Wait() == 0:
Anthony Kingcf738ed2015-06-03 16:50:39 +010095 if hasattr(p.stdout, 'decode'):
96 return p.stdout.decode('utf-8')
97 else:
98 return p.stdout
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070099 return None
100
Shawn O. Pearce334851e2011-09-19 08:05:31 -0700101 def version_tuple(self):
102 global _git_version
Shawn O. Pearce334851e2011-09-19 08:05:31 -0700103 if _git_version is None:
Chirayu Desaic46de692014-08-20 09:34:10 +0530104 ver_str = git.version()
Conley Owensff0a3c82014-01-30 14:46:03 -0800105 _git_version = Wrapper().ParseGitVersion(ver_str)
106 if _git_version is None:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700107 print('fatal: "%s" unsupported' % ver_str, file=sys.stderr)
Shawn O. Pearce334851e2011-09-19 08:05:31 -0700108 sys.exit(1)
109 return _git_version
110
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700111 def __getattr__(self, name):
112 name = name.replace('_','-')
113 def fun(*cmdv):
114 command = [name]
115 command.extend(cmdv)
116 return GitCommand(None, command).Wait() == 0
117 return fun
118git = _GitCall()
119
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700120def git_require(min_version, fail=False):
Shawn O. Pearce334851e2011-09-19 08:05:31 -0700121 git_version = git.version_tuple()
122 if min_version <= git_version:
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700123 return True
124 if fail:
David Pursehouse7e6dd2d2012-10-25 12:40:51 +0900125 need = '.'.join(map(str, min_version))
Sarah Owenscecd1d82012-11-01 22:59:27 -0700126 print('fatal: git %s or later required' % need, file=sys.stderr)
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700127 sys.exit(1)
128 return False
129
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800130def _setenv(env, name, value):
131 env[name] = value.encode()
132
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700133class GitCommand(object):
134 def __init__(self,
135 project,
136 cmdv,
137 bare = False,
138 provide_stdin = False,
139 capture_stdout = False,
140 capture_stderr = False,
141 disable_editor = False,
Shawn O. Pearcefb231612009-04-10 18:53:46 -0700142 ssh_proxy = False,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700143 cwd = None,
144 gitdir = None):
Shawn O. Pearce727ee982010-12-07 08:46:14 -0800145 env = os.environ.copy()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700146
David Pursehouse1d947b32012-10-25 12:23:11 +0900147 for key in [REPO_TRACE,
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700148 GIT_DIR,
149 'GIT_ALTERNATE_OBJECT_DIRECTORIES',
150 'GIT_OBJECT_DIRECTORY',
151 'GIT_WORK_TREE',
152 'GIT_GRAFT_FILE',
153 'GIT_INDEX_FILE']:
David Pursehouse1d947b32012-10-25 12:23:11 +0900154 if key in env:
155 del env[key]
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700156
John L. Villalovos9c76f672015-03-16 20:49:10 -0700157 # If we are not capturing std* then need to print it.
158 self.tee = {'stdout': not capture_stdout, 'stderr': not capture_stderr}
159
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700160 if disable_editor:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800161 _setenv(env, 'GIT_EDITOR', ':')
Shawn O. Pearcefb231612009-04-10 18:53:46 -0700162 if ssh_proxy:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800163 _setenv(env, 'REPO_SSH_SOCK', ssh_sock())
164 _setenv(env, 'GIT_SSH', _ssh_proxy())
Shawn O. Pearce62d0b102012-06-05 15:11:15 -0700165 if 'http_proxy' in env and 'darwin' == sys.platform:
Shawn O. Pearce337aee02012-06-13 10:40:46 -0700166 s = "'http.proxy=%s'" % (env['http_proxy'],)
Shawn O. Pearce62d0b102012-06-05 15:11:15 -0700167 p = env.get('GIT_CONFIG_PARAMETERS')
168 if p is not None:
169 s = p + ' ' + s
170 _setenv(env, 'GIT_CONFIG_PARAMETERS', s)
Dan Willemsen466b8c42015-11-25 13:26:39 -0800171 if 'GIT_ALLOW_PROTOCOL' not in env:
172 _setenv(env, 'GIT_ALLOW_PROTOCOL',
173 'file:git:http:https:ssh:persistent-http:persistent-https:sso')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700174
175 if project:
176 if not cwd:
177 cwd = project.worktree
178 if not gitdir:
179 gitdir = project.gitdir
180
181 command = [GIT]
182 if bare:
183 if gitdir:
Shawn O. Pearcef18cb762010-12-07 11:41:05 -0800184 _setenv(env, GIT_DIR, gitdir)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700185 cwd = None
John L. Villalovos9c76f672015-03-16 20:49:10 -0700186 command.append(cmdv[0])
187 # Need to use the --progress flag for fetch/clone so output will be
188 # displayed as by default git only does progress output if stderr is a TTY.
189 if sys.stderr.isatty() and cmdv[0] in ('fetch', 'clone'):
190 if '--progress' not in cmdv and '--quiet' not in cmdv:
191 command.append('--progress')
192 command.extend(cmdv[1:])
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700193
194 if provide_stdin:
195 stdin = subprocess.PIPE
196 else:
197 stdin = None
198
John L. Villalovos9c76f672015-03-16 20:49:10 -0700199 stdout = subprocess.PIPE
200 stderr = subprocess.PIPE
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700201
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700202 if IsTrace():
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700203 global LAST_CWD
204 global LAST_GITDIR
205
206 dbg = ''
207
208 if cwd and LAST_CWD != cwd:
209 if LAST_GITDIR or LAST_CWD:
210 dbg += '\n'
211 dbg += ': cd %s\n' % cwd
212 LAST_CWD = cwd
213
214 if GIT_DIR in env and LAST_GITDIR != env[GIT_DIR]:
215 if LAST_GITDIR or LAST_CWD:
216 dbg += '\n'
217 dbg += ': export GIT_DIR=%s\n' % env[GIT_DIR]
218 LAST_GITDIR = env[GIT_DIR]
219
220 dbg += ': '
221 dbg += ' '.join(command)
222 if stdin == subprocess.PIPE:
223 dbg += ' 0<|'
224 if stdout == subprocess.PIPE:
225 dbg += ' 1>|'
226 if stderr == subprocess.PIPE:
227 dbg += ' 2>|'
Shawn O. Pearcead3193a2009-04-18 09:54:51 -0700228 Trace('%s', dbg)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700229
230 try:
231 p = subprocess.Popen(command,
232 cwd = cwd,
233 env = env,
234 stdin = stdin,
235 stdout = stdout,
236 stderr = stderr)
Sarah Owensa5be53f2012-09-09 15:37:57 -0700237 except Exception as e:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700238 raise GitError('%s: %s' % (command[1], e))
239
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700240 if ssh_proxy:
241 _add_ssh_client(p)
242
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700243 self.process = p
244 self.stdin = p.stdin
245
246 def Wait(self):
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700247 try:
Ulrik Sjölin498fe902011-09-11 22:59:37 +0200248 p = self.process
John L. Villalovos9c76f672015-03-16 20:49:10 -0700249 rc = self._CaptureOutput()
Shawn O. Pearceca8c32c2010-05-11 18:21:33 -0700250 finally:
251 _remove_ssh_client(p)
252 return rc
John L. Villalovos9c76f672015-03-16 20:49:10 -0700253
254 def _CaptureOutput(self):
255 p = self.process
256 s_in = [_sfd(p.stdout, sys.stdout, 'stdout'),
257 _sfd(p.stderr, sys.stderr, 'stderr')]
258 self.stdout = ''
259 self.stderr = ''
260
261 for s in s_in:
262 flags = fcntl.fcntl(s.fd, fcntl.F_GETFL)
263 fcntl.fcntl(s.fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
264
265 while s_in:
266 in_ready, _, _ = select.select(s_in, [], [])
267 for s in in_ready:
268 buf = s.fd.read(4096)
269 if not buf:
270 s_in.remove(s)
271 continue
Anthony King6cfc68e2015-06-03 16:39:32 +0100272 if not hasattr(buf, 'encode'):
273 buf = buf.decode()
John L. Villalovos9c76f672015-03-16 20:49:10 -0700274 if s.std_name == 'stdout':
275 self.stdout += buf
276 else:
277 self.stderr += buf
278 if self.tee[s.std_name]:
279 s.dest.write(buf)
280 s.dest.flush()
281 return p.wait()