blob: 9396f3c07b707c039f9e797caa126a0fdbab2c1e [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
22
23from color import Coloring
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080024from command import InteractiveCommand, MirrorSafeCommand
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070025from error import ManifestParseError
Shawn O. Pearce350cde42009-04-16 11:21:18 -070026from project import SyncBuffer
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -070027from git_config import GitConfig
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -070028from git_command import git_require, MIN_GIT_VERSION
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070029
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080030class Init(InteractiveCommand, MirrorSafeCommand):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070031 common = True
32 helpSummary = "Initialize repo in the current directory"
33 helpUsage = """
34%prog [options]
35"""
36 helpDescription = """
37The '%prog' command is run once to install and initialize repo.
38The latest repo source code and manifest collection is downloaded
39from the server and is installed in the .repo/ directory in the
40current working directory.
41
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070042The optional -b argument can be used to select the manifest branch
43to checkout and use. If no branch is specified, master is assumed.
44
45The optional -m argument can be used to specify an alternate manifest
46to be used. If no manifest is specified, the manifest default.xml
47will be used.
48
Shawn O. Pearce88443382010-10-08 10:02:09 +020049The --reference option can be used to point to a directory that
50has the content of a --mirror sync. This will make the working
51directory use as much data as possible from the local reference
52directory when fetching from the server. This will make the sync
53go a lot faster by reducing data traffic on the network.
54
55
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070056Switching Manifest Branches
57---------------------------
58
59To switch to another manifest branch, `repo init -b otherbranch`
60may be used in an existing client. However, as this only updates the
61manifest, a subsequent `repo sync` (or `repo sync -d`) is necessary
62to update the working directory files.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070063"""
64
65 def _Options(self, p):
66 # Logging
67 g = p.add_option_group('Logging options')
68 g.add_option('-q', '--quiet',
69 dest="quiet", action="store_true", default=False,
70 help="be quiet")
71
72 # Manifest
73 g = p.add_option_group('Manifest options')
74 g.add_option('-u', '--manifest-url',
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -080075 dest='manifest_url',
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070076 help='manifest repository location', metavar='URL')
77 g.add_option('-b', '--manifest-branch',
78 dest='manifest_branch',
79 help='manifest branch or revision', metavar='REVISION')
80 g.add_option('-m', '--manifest-name',
81 dest='manifest_name', default='default.xml',
82 help='initial manifest file', metavar='NAME.xml')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -080083 g.add_option('--mirror',
84 dest='mirror', action='store_true',
David Pursehouse3d07da82012-08-15 14:22:08 +090085 help='create a replica of the remote repositories '
86 'rather than a client working directory')
Shawn O. Pearce88443382010-10-08 10:02:09 +020087 g.add_option('--reference',
88 dest='reference',
89 help='location of mirror directory', metavar='DIR')
Doug Anderson30d45292011-05-04 15:01:04 -070090 g.add_option('--depth', type='int', default=None,
91 dest='depth',
92 help='create a shallow clone with given depth; see git clone')
Colin Cross5acde752012-03-28 20:15:45 -070093 g.add_option('-g', '--groups',
Conley Owensbb1b5f52012-08-13 13:11:18 -070094 dest='groups', default='all,-notdefault',
Colin Cross5acde752012-03-28 20:15:45 -070095 help='restrict manifest projects to ones with a specified group',
96 metavar='GROUP')
Conley Owensd21720d2012-04-16 11:02:21 -070097 g.add_option('-p', '--platform',
98 dest='platform', default='auto',
Conley Owensbb1b5f52012-08-13 13:11:18 -070099 help='restrict manifest projects to ones with a specified '
Conley Owensd21720d2012-04-16 11:02:21 -0700100 'platform group [auto|all|none|linux|darwin|...]',
101 metavar='PLATFORM')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700102
103 # Tool
Shawn O. Pearcefd89b672009-04-18 11:28:57 -0700104 g = p.add_option_group('repo Version options')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700105 g.add_option('--repo-url',
106 dest='repo_url',
107 help='repo repository location', metavar='URL')
108 g.add_option('--repo-branch',
109 dest='repo_branch',
110 help='repo branch or revision', metavar='REVISION')
111 g.add_option('--no-repo-verify',
112 dest='no_repo_verify', action='store_true',
113 help='do not verify repo source code')
114
Victor Boivie841be342011-04-05 11:31:10 +0200115 # Other
116 g = p.add_option_group('Other options')
117 g.add_option('--config-name',
118 dest='config_name', action="store_true", default=False,
119 help='Always prompt for name/e-mail')
120
David Pursehouse3f5ea0b2012-11-17 03:13:09 +0900121 def _RegisteredEnvironmentOptions(self):
122 return {'REPO_MANIFEST_URL': 'manifest_url',
123 'REPO_MIRROR_LOCATION': 'reference'}
124
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700125 def _SyncManifest(self, opt):
126 m = self.manifest.manifestProject
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700127 is_new = not m.Exists
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700128
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700129 if is_new:
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800130 if not opt.manifest_url:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700131 print('fatal: manifest url (-u) is required.', file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700132 sys.exit(1)
133
134 if not opt.quiet:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700135 print('Get %s' % GitConfig.ForUser().UrlInsteadOf(opt.manifest_url),
136 file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700137 m._InitGitDir()
138
139 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700140 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700141 else:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700142 m.revisionExpr = 'refs/heads/master'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700143 else:
144 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700145 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700146 else:
147 m.PreSync()
148
149 if opt.manifest_url:
150 r = m.GetRemote(m.remote.name)
151 r.url = opt.manifest_url
152 r.ResetFetch()
153 r.Save()
154
David Pursehouse1d947b32012-10-25 12:23:11 +0900155 groups = re.split(r'[,\s]+', opt.groups)
Conley Owensd21720d2012-04-16 11:02:21 -0700156 all_platforms = ['linux', 'darwin']
157 platformize = lambda x: 'platform-' + x
158 if opt.platform == 'auto':
159 if (not opt.mirror and
160 not m.config.GetString('repo.mirror') == 'true'):
161 groups.append(platformize(platform.system().lower()))
162 elif opt.platform == 'all':
Colin Cross54657272012-04-23 13:39:48 -0700163 groups.extend(map(platformize, all_platforms))
Conley Owensd21720d2012-04-16 11:02:21 -0700164 elif opt.platform in all_platforms:
165 groups.extend(platformize(opt.platform))
166 elif opt.platform != 'none':
Sarah Owenscecd1d82012-11-01 22:59:27 -0700167 print('fatal: invalid platform flag', file=sys.stderr)
Conley Owensd21720d2012-04-16 11:02:21 -0700168 sys.exit(1)
169
Conley Owens971de8e2012-04-16 10:36:08 -0700170 groups = [x for x in groups if x]
171 groupstr = ','.join(groups)
Conley Owensbb1b5f52012-08-13 13:11:18 -0700172 if opt.platform == 'auto' and groupstr == 'all,-notdefault,platform-' + platform.system().lower():
Conley Owens971de8e2012-04-16 10:36:08 -0700173 groupstr = None
174 m.config.SetString('manifest.groups', groupstr)
Colin Cross5acde752012-03-28 20:15:45 -0700175
Shawn O. Pearce88443382010-10-08 10:02:09 +0200176 if opt.reference:
177 m.config.SetString('repo.reference', opt.reference)
178
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800179 if opt.mirror:
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700180 if is_new:
181 m.config.SetString('repo.mirror', 'true')
182 else:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700183 print('fatal: --mirror not supported on existing client',
184 file=sys.stderr)
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700185 sys.exit(1)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800186
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700187 if not m.Sync_NetworkHalf(is_new=is_new):
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700188 r = m.GetRemote(m.remote.name)
Sarah Owenscecd1d82012-11-01 22:59:27 -0700189 print('fatal: cannot obtain manifest %s' % r.url, file=sys.stderr)
Doug Anderson2630dd92011-04-07 13:36:30 -0700190
191 # Better delete the manifest git dir if we created it; otherwise next
192 # time (when user fixes problems) we won't go through the "is_new" logic.
193 if is_new:
194 shutil.rmtree(m.gitdir)
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700195 sys.exit(1)
196
Florian Vallee5d016502012-06-07 17:19:26 +0200197 if opt.manifest_branch:
198 m.MetaBranchSwitch(opt.manifest_branch)
199
Shawn O. Pearce350cde42009-04-16 11:21:18 -0700200 syncbuf = SyncBuffer(m.config)
201 m.Sync_LocalHalf(syncbuf)
202 syncbuf.Finish()
203
Shawn O. Pearcedf018832009-03-17 08:15:27 -0700204 if is_new or m.CurrentBranch is None:
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700205 if not m.StartBranch('default'):
Sarah Owenscecd1d82012-11-01 22:59:27 -0700206 print('fatal: cannot create default in manifest', file=sys.stderr)
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700207 sys.exit(1)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700208
209 def _LinkManifest(self, name):
210 if not name:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700211 print('fatal: manifest name (-m) is required.', file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700212 sys.exit(1)
213
214 try:
215 self.manifest.Link(name)
Sarah Owensa5be53f2012-09-09 15:37:57 -0700216 except ManifestParseError as e:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700217 print("fatal: manifest '%s' not available" % name, file=sys.stderr)
218 print('fatal: %s' % str(e), file=sys.stderr)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700219 sys.exit(1)
220
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700221 def _Prompt(self, prompt, value):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700222 sys.stdout.write('%-10s [%s]: ' % (prompt, value))
223 a = sys.stdin.readline().strip()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700224 if a == '':
225 return value
226 return a
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700227
Victor Boivie841be342011-04-05 11:31:10 +0200228 def _ShouldConfigureUser(self):
229 gc = self.manifest.globalConfig
230 mp = self.manifest.manifestProject
231
232 # If we don't have local settings, get from global.
233 if not mp.config.Has('user.name') or not mp.config.Has('user.email'):
234 if not gc.Has('user.name') or not gc.Has('user.email'):
235 return True
236
237 mp.config.SetString('user.name', gc.GetString('user.name'))
238 mp.config.SetString('user.email', gc.GetString('user.email'))
239
Sarah Owenscecd1d82012-11-01 22:59:27 -0700240 print()
241 print('Your identity is: %s <%s>' % (mp.config.GetString('user.name'),
242 mp.config.GetString('user.email')))
243 print('If you want to change this, please re-run \'repo init\' with --config-name')
Victor Boivie841be342011-04-05 11:31:10 +0200244 return False
245
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700246 def _ConfigureUser(self):
247 mp = self.manifest.manifestProject
248
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700249 while True:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700250 print()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700251 name = self._Prompt('Your Name', mp.UserName)
252 email = self._Prompt('Your Email', mp.UserEmail)
253
Sarah Owenscecd1d82012-11-01 22:59:27 -0700254 print()
255 print('Your identity is: %s <%s>' % (name, email))
Mike Frysingere9311272011-08-11 15:46:43 -0400256 sys.stdout.write('is this correct [y/N]? ')
David Pursehousefc241242012-11-14 09:19:39 +0900257 a = sys.stdin.readline().strip().lower()
Nico Sallembien6d7508b2010-04-01 11:03:53 -0700258 if a in ('yes', 'y', 't', 'true'):
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700259 break
260
261 if name != mp.UserName:
262 mp.config.SetString('user.name', name)
263 if email != mp.UserEmail:
264 mp.config.SetString('user.email', email)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700265
266 def _HasColorSet(self, gc):
267 for n in ['ui', 'diff', 'status']:
268 if gc.Has('color.%s' % n):
269 return True
270 return False
271
272 def _ConfigureColor(self):
273 gc = self.manifest.globalConfig
274 if self._HasColorSet(gc):
275 return
276
277 class _Test(Coloring):
278 def __init__(self):
279 Coloring.__init__(self, gc, 'test color display')
280 self._on = True
281 out = _Test()
282
Sarah Owenscecd1d82012-11-01 22:59:27 -0700283 print()
284 print("Testing colorized output (for 'repo diff', 'repo status'):")
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700285
David Pursehouse8f62fb72012-11-14 12:09:38 +0900286 for c in ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan']:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700287 out.write(' ')
288 out.printer(fg=c)(' %-6s ', c)
289 out.write(' ')
290 out.printer(fg='white', bg='black')(' %s ' % 'white')
291 out.nl()
292
David Pursehouse8f62fb72012-11-14 12:09:38 +0900293 for c in ['bold', 'dim', 'ul', 'reverse']:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700294 out.write(' ')
295 out.printer(fg='black', attr=c)(' %-6s ', c)
296 out.nl()
297
Mike Frysingere9311272011-08-11 15:46:43 -0400298 sys.stdout.write('Enable color display in this user account (y/N)? ')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700299 a = sys.stdin.readline().strip().lower()
300 if a in ('y', 'yes', 't', 'true', 'on'):
301 gc.SetString('color.ui', 'auto')
302
Doug Anderson30d45292011-05-04 15:01:04 -0700303 def _ConfigureDepth(self, opt):
304 """Configure the depth we'll sync down.
305
306 Args:
307 opt: Options from optparse. We care about opt.depth.
308 """
309 # Opt.depth will be non-None if user actually passed --depth to repo init.
310 if opt.depth is not None:
311 if opt.depth > 0:
312 # Positive values will set the depth.
313 depth = str(opt.depth)
314 else:
315 # Negative numbers will clear the depth; passing None to SetString
316 # will do that.
317 depth = None
318
319 # We store the depth in the main manifest project.
320 self.manifest.manifestProject.config.SetString('repo.depth', depth)
321
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800322 def _DisplayResult(self):
323 if self.manifest.IsMirror:
324 init_type = 'mirror '
325 else:
326 init_type = ''
327
Sarah Owenscecd1d82012-11-01 22:59:27 -0700328 print()
329 print('repo %shas been initialized in %s'
330 % (init_type, self.manifest.topdir))
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800331
332 current_dir = os.getcwd()
333 if current_dir != self.manifest.topdir:
Sarah Owenscecd1d82012-11-01 22:59:27 -0700334 print('If this is not the directory in which you want to initialize'
335 'repo, please run:')
336 print(' rm -r %s/.repo' % self.manifest.topdir)
337 print('and try again.')
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800338
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700339 def Execute(self, opt, args):
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700340 git_require(MIN_GIT_VERSION, fail=True)
Victor Boivie297e7c62012-10-05 14:50:05 +0200341
342 if opt.reference:
343 opt.reference = os.path.expanduser(opt.reference)
344
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700345 self._SyncManifest(opt)
346 self._LinkManifest(opt.manifest_name)
347
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700348 if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
Victor Boivie841be342011-04-05 11:31:10 +0200349 if opt.config_name or self._ShouldConfigureUser():
350 self._ConfigureUser()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700351 self._ConfigureColor()
352
Doug Anderson30d45292011-05-04 15:01:04 -0700353 self._ConfigureDepth(opt)
354
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800355 self._DisplayResult()