blob: 1f915268482425007044fa11fac2d9ffa136b702 [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
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070017import os
Conley Owensd21720d2012-04-16 11:02:21 -070018import platform
Conley Owens971de8e2012-04-16 10:36:08 -070019import re
Doug Anderson2630dd92011-04-07 13:36:30 -070020import shutil
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070021import sys
Victor Boivie2b30e3a2012-10-05 12:37:58 +020022try:
23 # For python3
24 import urllib.parse
25except ImportError:
26 # For python2
27 import imp
28 import urlparse
29 urllib = imp.new_module('urllib')
30 urllib.parse = urlparse.urlparse
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070031
32from color import Coloring
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080033from command import InteractiveCommand, MirrorSafeCommand
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070034from error import ManifestParseError
Shawn O. Pearce350cde42009-04-16 11:21:18 -070035from project import SyncBuffer
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -070036from git_config import GitConfig
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -070037from git_command import git_require, MIN_GIT_VERSION
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070038
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080039class Init(InteractiveCommand, MirrorSafeCommand):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070040 common = True
41 helpSummary = "Initialize repo in the current directory"
42 helpUsage = """
43%prog [options]
44"""
45 helpDescription = """
46The '%prog' command is run once to install and initialize repo.
47The latest repo source code and manifest collection is downloaded
48from the server and is installed in the .repo/ directory in the
49current working directory.
50
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070051The optional -b argument can be used to select the manifest branch
52to checkout and use. If no branch is specified, master is assumed.
53
54The optional -m argument can be used to specify an alternate manifest
55to be used. If no manifest is specified, the manifest default.xml
56will be used.
57
Shawn O. Pearce88443382010-10-08 10:02:09 +020058The --reference option can be used to point to a directory that
59has the content of a --mirror sync. This will make the working
60directory use as much data as possible from the local reference
61directory when fetching from the server. This will make the sync
62go a lot faster by reducing data traffic on the network.
63
64
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070065Switching Manifest Branches
66---------------------------
67
68To switch to another manifest branch, `repo init -b otherbranch`
69may be used in an existing client. However, as this only updates the
70manifest, a subsequent `repo sync` (or `repo sync -d`) is necessary
71to update the working directory files.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070072"""
73
74 def _Options(self, p):
75 # Logging
76 g = p.add_option_group('Logging options')
77 g.add_option('-q', '--quiet',
78 dest="quiet", action="store_true", default=False,
79 help="be quiet")
80
81 # Manifest
82 g = p.add_option_group('Manifest options')
83 g.add_option('-u', '--manifest-url',
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -080084 dest='manifest_url',
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070085 help='manifest repository location', metavar='URL')
86 g.add_option('-b', '--manifest-branch',
87 dest='manifest_branch',
88 help='manifest branch or revision', metavar='REVISION')
89 g.add_option('-m', '--manifest-name',
90 dest='manifest_name', default='default.xml',
91 help='initial manifest file', metavar='NAME.xml')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -080092 g.add_option('--mirror',
93 dest='mirror', action='store_true',
David Pursehouse3d07da82012-08-15 14:22:08 +090094 help='create a replica of the remote repositories '
95 'rather than a client working directory')
Shawn O. Pearce88443382010-10-08 10:02:09 +020096 g.add_option('--reference',
97 dest='reference',
98 help='location of mirror directory', metavar='DIR')
Doug Anderson30d45292011-05-04 15:01:04 -070099 g.add_option('--depth', type='int', default=None,
100 dest='depth',
101 help='create a shallow clone with given depth; see git clone')
Colin Cross5acde752012-03-28 20:15:45 -0700102 g.add_option('-g', '--groups',
David Holmer0a1c6a12012-11-14 19:19:00 -0500103 dest='groups', default='default',
104 help='restrict manifest projects to ones with specified '
105 'group(s) [default|all|G1,G2,G3|G4,-G5,-G6]',
Colin Cross5acde752012-03-28 20:15:45 -0700106 metavar='GROUP')
Conley Owensd21720d2012-04-16 11:02:21 -0700107 g.add_option('-p', '--platform',
108 dest='platform', default='auto',
Conley Owensbb1b5f52012-08-13 13:11:18 -0700109 help='restrict manifest projects to ones with a specified '
Conley Owensd21720d2012-04-16 11:02:21 -0700110 'platform group [auto|all|none|linux|darwin|...]',
111 metavar='PLATFORM')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700112
113 # Tool
Shawn O. Pearcefd89b672009-04-18 11:28:57 -0700114 g = p.add_option_group('repo Version options')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700115 g.add_option('--repo-url',
116 dest='repo_url',
117 help='repo repository location', metavar='URL')
118 g.add_option('--repo-branch',
119 dest='repo_branch',
120 help='repo branch or revision', metavar='REVISION')
121 g.add_option('--no-repo-verify',
122 dest='no_repo_verify', action='store_true',
123 help='do not verify repo source code')
124
Victor Boivie841be342011-04-05 11:31:10 +0200125 # Other
126 g = p.add_option_group('Other options')
127 g.add_option('--config-name',
128 dest='config_name', action="store_true", default=False,
129 help='Always prompt for name/e-mail')
130
David Pursehouse3f5ea0b2012-11-17 03:13:09 +0900131 def _RegisteredEnvironmentOptions(self):
132 return {'REPO_MANIFEST_URL': 'manifest_url',
133 'REPO_MIRROR_LOCATION': 'reference'}
134
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700135 def _SyncManifest(self, opt):
136 m = self.manifest.manifestProject
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700137 is_new = not m.Exists
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700138
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700139 if is_new:
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800140 if not opt.manifest_url:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700141 print('fatal: manifest url (-u) is required.', file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700142 sys.exit(1)
143
144 if not opt.quiet:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700145 print('Get %s' % GitConfig.ForUser().UrlInsteadOf(opt.manifest_url),
146 file=sys.stderr)
Victor Boivie2b30e3a2012-10-05 12:37:58 +0200147
148 # The manifest project object doesn't keep track of the path on the
149 # server where this git is located, so let's save that here.
150 mirrored_manifest_git = None
151 if opt.reference:
152 manifest_git_path = urllib.parse(opt.manifest_url).path[1:]
153 mirrored_manifest_git = os.path.join(opt.reference, manifest_git_path)
154 if not mirrored_manifest_git.endswith(".git"):
155 mirrored_manifest_git += ".git"
156 if not os.path.exists(mirrored_manifest_git):
157 mirrored_manifest_git = os.path.join(opt.reference + '/.repo/manifests.git')
158
159 m._InitGitDir(mirror_git=mirrored_manifest_git)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700160
161 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700162 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700163 else:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700164 m.revisionExpr = 'refs/heads/master'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700165 else:
166 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700167 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700168 else:
169 m.PreSync()
170
171 if opt.manifest_url:
172 r = m.GetRemote(m.remote.name)
173 r.url = opt.manifest_url
174 r.ResetFetch()
175 r.Save()
176
David Pursehouse1d947b32012-10-25 12:23:11 +0900177 groups = re.split(r'[,\s]+', opt.groups)
Conley Owensd21720d2012-04-16 11:02:21 -0700178 all_platforms = ['linux', 'darwin']
179 platformize = lambda x: 'platform-' + x
180 if opt.platform == 'auto':
181 if (not opt.mirror and
182 not m.config.GetString('repo.mirror') == 'true'):
183 groups.append(platformize(platform.system().lower()))
184 elif opt.platform == 'all':
Colin Cross54657272012-04-23 13:39:48 -0700185 groups.extend(map(platformize, all_platforms))
Conley Owensd21720d2012-04-16 11:02:21 -0700186 elif opt.platform in all_platforms:
187 groups.extend(platformize(opt.platform))
188 elif opt.platform != 'none':
Sarah Owenscecd1d82012-11-01 22:59:27 -0700189 print('fatal: invalid platform flag', file=sys.stderr)
Conley Owensd21720d2012-04-16 11:02:21 -0700190 sys.exit(1)
191
Conley Owens971de8e2012-04-16 10:36:08 -0700192 groups = [x for x in groups if x]
193 groupstr = ','.join(groups)
David Holmer0a1c6a12012-11-14 19:19:00 -0500194 if opt.platform == 'auto' and groupstr == 'default,platform-' + platform.system().lower():
Conley Owens971de8e2012-04-16 10:36:08 -0700195 groupstr = None
196 m.config.SetString('manifest.groups', groupstr)
Colin Cross5acde752012-03-28 20:15:45 -0700197
Shawn O. Pearce88443382010-10-08 10:02:09 +0200198 if opt.reference:
199 m.config.SetString('repo.reference', opt.reference)
200
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800201 if opt.mirror:
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700202 if is_new:
203 m.config.SetString('repo.mirror', 'true')
204 else:
David Pursehouse25470982012-11-21 14:41:58 +0900205 print('fatal: --mirror is only supported when initializing a new '
206 'workspace.', file=sys.stderr)
207 print('Either delete the .repo folder in this workspace, or initialize '
208 'in another location.', file=sys.stderr)
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700209 sys.exit(1)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800210
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700211 if not m.Sync_NetworkHalf(is_new=is_new):
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700212 r = m.GetRemote(m.remote.name)
Sarah Owenscecd1d82012-11-01 22:59:27 -0700213 print('fatal: cannot obtain manifest %s' % r.url, file=sys.stderr)
Doug Anderson2630dd92011-04-07 13:36:30 -0700214
215 # Better delete the manifest git dir if we created it; otherwise next
216 # time (when user fixes problems) we won't go through the "is_new" logic.
217 if is_new:
218 shutil.rmtree(m.gitdir)
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700219 sys.exit(1)
220
Florian Vallee5d016502012-06-07 17:19:26 +0200221 if opt.manifest_branch:
222 m.MetaBranchSwitch(opt.manifest_branch)
223
Shawn O. Pearce350cde42009-04-16 11:21:18 -0700224 syncbuf = SyncBuffer(m.config)
225 m.Sync_LocalHalf(syncbuf)
226 syncbuf.Finish()
227
Shawn O. Pearcedf018832009-03-17 08:15:27 -0700228 if is_new or m.CurrentBranch is None:
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700229 if not m.StartBranch('default'):
Sarah Owenscecd1d82012-11-01 22:59:27 -0700230 print('fatal: cannot create default in manifest', file=sys.stderr)
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700231 sys.exit(1)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700232
233 def _LinkManifest(self, name):
234 if not name:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700235 print('fatal: manifest name (-m) is required.', file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700236 sys.exit(1)
237
238 try:
239 self.manifest.Link(name)
Sarah Owensa5be53f2012-09-09 15:37:57 -0700240 except ManifestParseError as e:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700241 print("fatal: manifest '%s' not available" % name, file=sys.stderr)
242 print('fatal: %s' % str(e), file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700243 sys.exit(1)
244
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700245 def _Prompt(self, prompt, value):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700246 sys.stdout.write('%-10s [%s]: ' % (prompt, value))
247 a = sys.stdin.readline().strip()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700248 if a == '':
249 return value
250 return a
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700251
Victor Boivie841be342011-04-05 11:31:10 +0200252 def _ShouldConfigureUser(self):
253 gc = self.manifest.globalConfig
254 mp = self.manifest.manifestProject
255
256 # If we don't have local settings, get from global.
257 if not mp.config.Has('user.name') or not mp.config.Has('user.email'):
258 if not gc.Has('user.name') or not gc.Has('user.email'):
259 return True
260
261 mp.config.SetString('user.name', gc.GetString('user.name'))
262 mp.config.SetString('user.email', gc.GetString('user.email'))
263
Sarah Owenscecd1d82012-11-01 22:59:27 -0700264 print()
265 print('Your identity is: %s <%s>' % (mp.config.GetString('user.name'),
266 mp.config.GetString('user.email')))
267 print('If you want to change this, please re-run \'repo init\' with --config-name')
Victor Boivie841be342011-04-05 11:31:10 +0200268 return False
269
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700270 def _ConfigureUser(self):
271 mp = self.manifest.manifestProject
272
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700273 while True:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700274 print()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700275 name = self._Prompt('Your Name', mp.UserName)
276 email = self._Prompt('Your Email', mp.UserEmail)
277
Sarah Owenscecd1d82012-11-01 22:59:27 -0700278 print()
279 print('Your identity is: %s <%s>' % (name, email))
Mike Frysingere9311272011-08-11 15:46:43 -0400280 sys.stdout.write('is this correct [y/N]? ')
David Pursehousefc241242012-11-14 09:19:39 +0900281 a = sys.stdin.readline().strip().lower()
Nico Sallembien6d7508b2010-04-01 11:03:53 -0700282 if a in ('yes', 'y', 't', 'true'):
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700283 break
284
285 if name != mp.UserName:
286 mp.config.SetString('user.name', name)
287 if email != mp.UserEmail:
288 mp.config.SetString('user.email', email)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700289
290 def _HasColorSet(self, gc):
291 for n in ['ui', 'diff', 'status']:
292 if gc.Has('color.%s' % n):
293 return True
294 return False
295
296 def _ConfigureColor(self):
297 gc = self.manifest.globalConfig
298 if self._HasColorSet(gc):
299 return
300
301 class _Test(Coloring):
302 def __init__(self):
303 Coloring.__init__(self, gc, 'test color display')
304 self._on = True
305 out = _Test()
306
Sarah Owenscecd1d82012-11-01 22:59:27 -0700307 print()
308 print("Testing colorized output (for 'repo diff', 'repo status'):")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700309
David Pursehouse8f62fb72012-11-14 12:09:38 +0900310 for c in ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan']:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700311 out.write(' ')
312 out.printer(fg=c)(' %-6s ', c)
313 out.write(' ')
314 out.printer(fg='white', bg='black')(' %s ' % 'white')
315 out.nl()
316
David Pursehouse8f62fb72012-11-14 12:09:38 +0900317 for c in ['bold', 'dim', 'ul', 'reverse']:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700318 out.write(' ')
319 out.printer(fg='black', attr=c)(' %-6s ', c)
320 out.nl()
321
Mike Frysingere9311272011-08-11 15:46:43 -0400322 sys.stdout.write('Enable color display in this user account (y/N)? ')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700323 a = sys.stdin.readline().strip().lower()
324 if a in ('y', 'yes', 't', 'true', 'on'):
325 gc.SetString('color.ui', 'auto')
326
Doug Anderson30d45292011-05-04 15:01:04 -0700327 def _ConfigureDepth(self, opt):
328 """Configure the depth we'll sync down.
329
330 Args:
331 opt: Options from optparse. We care about opt.depth.
332 """
333 # Opt.depth will be non-None if user actually passed --depth to repo init.
334 if opt.depth is not None:
335 if opt.depth > 0:
336 # Positive values will set the depth.
337 depth = str(opt.depth)
338 else:
339 # Negative numbers will clear the depth; passing None to SetString
340 # will do that.
341 depth = None
342
343 # We store the depth in the main manifest project.
344 self.manifest.manifestProject.config.SetString('repo.depth', depth)
345
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800346 def _DisplayResult(self):
347 if self.manifest.IsMirror:
348 init_type = 'mirror '
349 else:
350 init_type = ''
351
Sarah Owenscecd1d82012-11-01 22:59:27 -0700352 print()
353 print('repo %shas been initialized in %s'
354 % (init_type, self.manifest.topdir))
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800355
356 current_dir = os.getcwd()
357 if current_dir != self.manifest.topdir:
David Pursehouse35765962013-01-29 09:49:48 +0900358 print('If this is not the directory in which you want to initialize '
Sarah Owenscecd1d82012-11-01 22:59:27 -0700359 'repo, please run:')
360 print(' rm -r %s/.repo' % self.manifest.topdir)
361 print('and try again.')
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800362
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700363 def Execute(self, opt, args):
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700364 git_require(MIN_GIT_VERSION, fail=True)
Victor Boivie297e7c62012-10-05 14:50:05 +0200365
366 if opt.reference:
367 opt.reference = os.path.expanduser(opt.reference)
368
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700369 self._SyncManifest(opt)
370 self._LinkManifest(opt.manifest_name)
371
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700372 if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
Victor Boivie841be342011-04-05 11:31:10 +0200373 if opt.config_name or self._ShouldConfigureUser():
374 self._ConfigureUser()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700375 self._ConfigureColor()
376
Doug Anderson30d45292011-05-04 15:01:04 -0700377 self._ConfigureDepth(opt)
378
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800379 self._DisplayResult()