blob: 99007d60420ede388fcc7edb142548f3dc9a946b [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
16import os
Conley Owensd21720d2012-04-16 11:02:21 -070017import platform
Conley Owens971de8e2012-04-16 10:36:08 -070018import re
Doug Anderson2630dd92011-04-07 13:36:30 -070019import shutil
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070020import sys
21
22from color import Coloring
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080023from command import InteractiveCommand, MirrorSafeCommand
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070024from error import ManifestParseError
Shawn O. Pearce350cde42009-04-16 11:21:18 -070025from project import SyncBuffer
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -070026from git_config import GitConfig
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -070027from git_command import git_require, MIN_GIT_VERSION
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070028
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080029class Init(InteractiveCommand, MirrorSafeCommand):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070030 common = True
31 helpSummary = "Initialize repo in the current directory"
32 helpUsage = """
33%prog [options]
34"""
35 helpDescription = """
36The '%prog' command is run once to install and initialize repo.
37The latest repo source code and manifest collection is downloaded
38from the server and is installed in the .repo/ directory in the
39current working directory.
40
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070041The optional -b argument can be used to select the manifest branch
42to checkout and use. If no branch is specified, master is assumed.
43
44The optional -m argument can be used to specify an alternate manifest
45to be used. If no manifest is specified, the manifest default.xml
46will be used.
47
Shawn O. Pearce88443382010-10-08 10:02:09 +020048The --reference option can be used to point to a directory that
49has the content of a --mirror sync. This will make the working
50directory use as much data as possible from the local reference
51directory when fetching from the server. This will make the sync
52go a lot faster by reducing data traffic on the network.
53
54
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070055Switching Manifest Branches
56---------------------------
57
58To switch to another manifest branch, `repo init -b otherbranch`
59may be used in an existing client. However, as this only updates the
60manifest, a subsequent `repo sync` (or `repo sync -d`) is necessary
61to update the working directory files.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070062"""
63
64 def _Options(self, p):
65 # Logging
66 g = p.add_option_group('Logging options')
67 g.add_option('-q', '--quiet',
68 dest="quiet", action="store_true", default=False,
69 help="be quiet")
70
71 # Manifest
72 g = p.add_option_group('Manifest options')
73 g.add_option('-u', '--manifest-url',
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -080074 dest='manifest_url',
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070075 help='manifest repository location', metavar='URL')
76 g.add_option('-b', '--manifest-branch',
77 dest='manifest_branch',
78 help='manifest branch or revision', metavar='REVISION')
79 g.add_option('-m', '--manifest-name',
80 dest='manifest_name', default='default.xml',
81 help='initial manifest file', metavar='NAME.xml')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -080082 g.add_option('--mirror',
83 dest='mirror', action='store_true',
David Pursehouse3d07da82012-08-15 14:22:08 +090084 help='create a replica of the remote repositories '
85 'rather than a client working directory')
Shawn O. Pearce88443382010-10-08 10:02:09 +020086 g.add_option('--reference',
87 dest='reference',
88 help='location of mirror directory', metavar='DIR')
Doug Anderson30d45292011-05-04 15:01:04 -070089 g.add_option('--depth', type='int', default=None,
90 dest='depth',
91 help='create a shallow clone with given depth; see git clone')
Colin Cross5acde752012-03-28 20:15:45 -070092 g.add_option('-g', '--groups',
Conley Owensbb1b5f52012-08-13 13:11:18 -070093 dest='groups', default='all,-notdefault',
Colin Cross5acde752012-03-28 20:15:45 -070094 help='restrict manifest projects to ones with a specified group',
95 metavar='GROUP')
Conley Owensd21720d2012-04-16 11:02:21 -070096 g.add_option('-p', '--platform',
97 dest='platform', default='auto',
Conley Owensbb1b5f52012-08-13 13:11:18 -070098 help='restrict manifest projects to ones with a specified '
Conley Owensd21720d2012-04-16 11:02:21 -070099 'platform group [auto|all|none|linux|darwin|...]',
100 metavar='PLATFORM')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700101
102 # Tool
Shawn O. Pearcefd89b672009-04-18 11:28:57 -0700103 g = p.add_option_group('repo Version options')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700104 g.add_option('--repo-url',
105 dest='repo_url',
106 help='repo repository location', metavar='URL')
107 g.add_option('--repo-branch',
108 dest='repo_branch',
109 help='repo branch or revision', metavar='REVISION')
110 g.add_option('--no-repo-verify',
111 dest='no_repo_verify', action='store_true',
112 help='do not verify repo source code')
113
Victor Boivie841be342011-04-05 11:31:10 +0200114 # Other
115 g = p.add_option_group('Other options')
116 g.add_option('--config-name',
117 dest='config_name', action="store_true", default=False,
118 help='Always prompt for name/e-mail')
119
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700120 def _SyncManifest(self, opt):
121 m = self.manifest.manifestProject
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700122 is_new = not m.Exists
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700123
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700124 if is_new:
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800125 if not opt.manifest_url:
126 print >>sys.stderr, 'fatal: manifest url (-u) is required.'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700127 sys.exit(1)
128
129 if not opt.quiet:
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700130 print >>sys.stderr, 'Get %s' \
131 % GitConfig.ForUser().UrlInsteadOf(opt.manifest_url)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700132 m._InitGitDir()
133
134 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700135 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700136 else:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700137 m.revisionExpr = 'refs/heads/master'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700138 else:
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:
142 m.PreSync()
143
144 if opt.manifest_url:
145 r = m.GetRemote(m.remote.name)
146 r.url = opt.manifest_url
147 r.ResetFetch()
148 r.Save()
149
David Pursehouse1d947b32012-10-25 12:23:11 +0900150 groups = re.split(r'[,\s]+', opt.groups)
Conley Owensd21720d2012-04-16 11:02:21 -0700151 all_platforms = ['linux', 'darwin']
152 platformize = lambda x: 'platform-' + x
153 if opt.platform == 'auto':
154 if (not opt.mirror and
155 not m.config.GetString('repo.mirror') == 'true'):
156 groups.append(platformize(platform.system().lower()))
157 elif opt.platform == 'all':
Colin Cross54657272012-04-23 13:39:48 -0700158 groups.extend(map(platformize, all_platforms))
Conley Owensd21720d2012-04-16 11:02:21 -0700159 elif opt.platform in all_platforms:
160 groups.extend(platformize(opt.platform))
161 elif opt.platform != 'none':
162 print >>sys.stderr, 'fatal: invalid platform flag'
163 sys.exit(1)
164
Conley Owens971de8e2012-04-16 10:36:08 -0700165 groups = [x for x in groups if x]
166 groupstr = ','.join(groups)
Conley Owensbb1b5f52012-08-13 13:11:18 -0700167 if opt.platform == 'auto' and groupstr == 'all,-notdefault,platform-' + platform.system().lower():
Conley Owens971de8e2012-04-16 10:36:08 -0700168 groupstr = None
169 m.config.SetString('manifest.groups', groupstr)
Colin Cross5acde752012-03-28 20:15:45 -0700170
Shawn O. Pearce88443382010-10-08 10:02:09 +0200171 if opt.reference:
172 m.config.SetString('repo.reference', opt.reference)
173
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800174 if opt.mirror:
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700175 if is_new:
176 m.config.SetString('repo.mirror', 'true')
177 else:
178 print >>sys.stderr, 'fatal: --mirror not supported on existing client'
179 sys.exit(1)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800180
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700181 if not m.Sync_NetworkHalf(is_new=is_new):
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700182 r = m.GetRemote(m.remote.name)
183 print >>sys.stderr, 'fatal: cannot obtain manifest %s' % r.url
Doug Anderson2630dd92011-04-07 13:36:30 -0700184
185 # Better delete the manifest git dir if we created it; otherwise next
186 # time (when user fixes problems) we won't go through the "is_new" logic.
187 if is_new:
188 shutil.rmtree(m.gitdir)
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700189 sys.exit(1)
190
Florian Vallee5d016502012-06-07 17:19:26 +0200191 if opt.manifest_branch:
192 m.MetaBranchSwitch(opt.manifest_branch)
193
Shawn O. Pearce350cde42009-04-16 11:21:18 -0700194 syncbuf = SyncBuffer(m.config)
195 m.Sync_LocalHalf(syncbuf)
196 syncbuf.Finish()
197
Shawn O. Pearcedf018832009-03-17 08:15:27 -0700198 if is_new or m.CurrentBranch is None:
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700199 if not m.StartBranch('default'):
200 print >>sys.stderr, 'fatal: cannot create default in manifest'
201 sys.exit(1)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700202
203 def _LinkManifest(self, name):
204 if not name:
205 print >>sys.stderr, 'fatal: manifest name (-m) is required.'
206 sys.exit(1)
207
208 try:
209 self.manifest.Link(name)
Sarah Owensa5be53f2012-09-09 15:37:57 -0700210 except ManifestParseError as e:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700211 print >>sys.stderr, "fatal: manifest '%s' not available" % name
212 print >>sys.stderr, 'fatal: %s' % str(e)
213 sys.exit(1)
214
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700215 def _Prompt(self, prompt, value):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700216 sys.stdout.write('%-10s [%s]: ' % (prompt, value))
217 a = sys.stdin.readline().strip()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700218 if a == '':
219 return value
220 return a
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700221
Victor Boivie841be342011-04-05 11:31:10 +0200222 def _ShouldConfigureUser(self):
223 gc = self.manifest.globalConfig
224 mp = self.manifest.manifestProject
225
226 # If we don't have local settings, get from global.
227 if not mp.config.Has('user.name') or not mp.config.Has('user.email'):
228 if not gc.Has('user.name') or not gc.Has('user.email'):
229 return True
230
231 mp.config.SetString('user.name', gc.GetString('user.name'))
232 mp.config.SetString('user.email', gc.GetString('user.email'))
233
234 print ''
235 print 'Your identity is: %s <%s>' % (mp.config.GetString('user.name'),
236 mp.config.GetString('user.email'))
237 print 'If you want to change this, please re-run \'repo init\' with --config-name'
238 return False
239
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700240 def _ConfigureUser(self):
241 mp = self.manifest.manifestProject
242
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700243 while True:
244 print ''
245 name = self._Prompt('Your Name', mp.UserName)
246 email = self._Prompt('Your Email', mp.UserEmail)
247
248 print ''
249 print 'Your identity is: %s <%s>' % (name, email)
Mike Frysingere9311272011-08-11 15:46:43 -0400250 sys.stdout.write('is this correct [y/N]? ')
David Pursehousefc241242012-11-14 09:19:39 +0900251 a = sys.stdin.readline().strip().lower()
Nico Sallembien6d7508b2010-04-01 11:03:53 -0700252 if a in ('yes', 'y', 't', 'true'):
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700253 break
254
255 if name != mp.UserName:
256 mp.config.SetString('user.name', name)
257 if email != mp.UserEmail:
258 mp.config.SetString('user.email', email)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700259
260 def _HasColorSet(self, gc):
261 for n in ['ui', 'diff', 'status']:
262 if gc.Has('color.%s' % n):
263 return True
264 return False
265
266 def _ConfigureColor(self):
267 gc = self.manifest.globalConfig
268 if self._HasColorSet(gc):
269 return
270
271 class _Test(Coloring):
272 def __init__(self):
273 Coloring.__init__(self, gc, 'test color display')
274 self._on = True
275 out = _Test()
276
277 print ''
278 print "Testing colorized output (for 'repo diff', 'repo status'):"
279
280 for c in ['black','red','green','yellow','blue','magenta','cyan']:
281 out.write(' ')
282 out.printer(fg=c)(' %-6s ', c)
283 out.write(' ')
284 out.printer(fg='white', bg='black')(' %s ' % 'white')
285 out.nl()
286
287 for c in ['bold','dim','ul','reverse']:
288 out.write(' ')
289 out.printer(fg='black', attr=c)(' %-6s ', c)
290 out.nl()
291
Mike Frysingere9311272011-08-11 15:46:43 -0400292 sys.stdout.write('Enable color display in this user account (y/N)? ')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700293 a = sys.stdin.readline().strip().lower()
294 if a in ('y', 'yes', 't', 'true', 'on'):
295 gc.SetString('color.ui', 'auto')
296
Doug Anderson30d45292011-05-04 15:01:04 -0700297 def _ConfigureDepth(self, opt):
298 """Configure the depth we'll sync down.
299
300 Args:
301 opt: Options from optparse. We care about opt.depth.
302 """
303 # Opt.depth will be non-None if user actually passed --depth to repo init.
304 if opt.depth is not None:
305 if opt.depth > 0:
306 # Positive values will set the depth.
307 depth = str(opt.depth)
308 else:
309 # Negative numbers will clear the depth; passing None to SetString
310 # will do that.
311 depth = None
312
313 # We store the depth in the main manifest project.
314 self.manifest.manifestProject.config.SetString('repo.depth', depth)
315
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800316 def _DisplayResult(self):
317 if self.manifest.IsMirror:
318 init_type = 'mirror '
319 else:
320 init_type = ''
321
322 print ''
323 print 'repo %shas been initialized in %s' % (init_type, self.manifest.topdir)
324
325 current_dir = os.getcwd()
326 if current_dir != self.manifest.topdir:
327 print 'If this is not the directory in which you want to initialize repo, please run:'
328 print ' rm -r %s/.repo' % self.manifest.topdir
329 print 'and try again.'
330
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700331 def Execute(self, opt, args):
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700332 git_require(MIN_GIT_VERSION, fail=True)
Victor Boivie297e7c62012-10-05 14:50:05 +0200333
334 if opt.reference:
335 opt.reference = os.path.expanduser(opt.reference)
336
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700337 self._SyncManifest(opt)
338 self._LinkManifest(opt.manifest_name)
339
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700340 if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
Victor Boivie841be342011-04-05 11:31:10 +0200341 if opt.config_name or self._ShouldConfigureUser():
342 self._ConfigureUser()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700343 self._ConfigureColor()
344
Doug Anderson30d45292011-05-04 15:01:04 -0700345 self._ConfigureDepth(opt)
346
Yang Zhenhui75cc3532012-10-23 15:41:54 +0800347 self._DisplayResult()