blob: b359024d4fee869a9dc9d159309cf4887821a51c [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',
84 help='mirror the forrest')
Shawn O. Pearce88443382010-10-08 10:02:09 +020085 g.add_option('--reference',
86 dest='reference',
87 help='location of mirror directory', metavar='DIR')
Doug Anderson30d45292011-05-04 15:01:04 -070088 g.add_option('--depth', type='int', default=None,
89 dest='depth',
90 help='create a shallow clone with given depth; see git clone')
Colin Cross5acde752012-03-28 20:15:45 -070091 g.add_option('-g', '--groups',
Conley Owens971de8e2012-04-16 10:36:08 -070092 dest='groups', default='default',
Colin Cross5acde752012-03-28 20:15:45 -070093 help='restrict manifest projects to ones with a specified group',
94 metavar='GROUP')
Conley Owensd21720d2012-04-16 11:02:21 -070095 g.add_option('-p', '--platform',
96 dest='platform', default='auto',
97 help='restrict manifest projects to ones with a specified'
98 'platform group [auto|all|none|linux|darwin|...]',
99 metavar='PLATFORM')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700100
101 # Tool
Shawn O. Pearcefd89b672009-04-18 11:28:57 -0700102 g = p.add_option_group('repo Version options')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700103 g.add_option('--repo-url',
104 dest='repo_url',
105 help='repo repository location', metavar='URL')
106 g.add_option('--repo-branch',
107 dest='repo_branch',
108 help='repo branch or revision', metavar='REVISION')
109 g.add_option('--no-repo-verify',
110 dest='no_repo_verify', action='store_true',
111 help='do not verify repo source code')
112
Victor Boivie841be342011-04-05 11:31:10 +0200113 # Other
114 g = p.add_option_group('Other options')
115 g.add_option('--config-name',
116 dest='config_name', action="store_true", default=False,
117 help='Always prompt for name/e-mail')
118
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700119 def _SyncManifest(self, opt):
120 m = self.manifest.manifestProject
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700121 is_new = not m.Exists
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700122
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700123 if is_new:
Shawn O. Pearce34fb20f2011-11-30 13:41:02 -0800124 if not opt.manifest_url:
125 print >>sys.stderr, 'fatal: manifest url (-u) is required.'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700126 sys.exit(1)
127
128 if not opt.quiet:
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700129 print >>sys.stderr, 'Get %s' \
130 % GitConfig.ForUser().UrlInsteadOf(opt.manifest_url)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700131 m._InitGitDir()
132
133 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700134 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700135 else:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700136 m.revisionExpr = 'refs/heads/master'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700137 else:
138 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700139 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700140 else:
141 m.PreSync()
142
143 if opt.manifest_url:
144 r = m.GetRemote(m.remote.name)
145 r.url = opt.manifest_url
146 r.ResetFetch()
147 r.Save()
148
Conley Owens971de8e2012-04-16 10:36:08 -0700149 groups = re.split('[,\s]+', opt.groups)
Conley Owensd21720d2012-04-16 11:02:21 -0700150 all_platforms = ['linux', 'darwin']
151 platformize = lambda x: 'platform-' + x
152 if opt.platform == 'auto':
153 if (not opt.mirror and
154 not m.config.GetString('repo.mirror') == 'true'):
155 groups.append(platformize(platform.system().lower()))
156 elif opt.platform == 'all':
Colin Cross54657272012-04-23 13:39:48 -0700157 groups.extend(map(platformize, all_platforms))
Conley Owensd21720d2012-04-16 11:02:21 -0700158 elif opt.platform in all_platforms:
159 groups.extend(platformize(opt.platform))
160 elif opt.platform != 'none':
161 print >>sys.stderr, 'fatal: invalid platform flag'
162 sys.exit(1)
163
Conley Owens971de8e2012-04-16 10:36:08 -0700164 groups = [x for x in groups if x]
165 groupstr = ','.join(groups)
Colin Cross54657272012-04-23 13:39:48 -0700166 if opt.platform == 'auto' and groupstr == 'default,platform-' + platform.system().lower():
Conley Owens971de8e2012-04-16 10:36:08 -0700167 groupstr = None
168 m.config.SetString('manifest.groups', groupstr)
Colin Cross5acde752012-03-28 20:15:45 -0700169
Shawn O. Pearce88443382010-10-08 10:02:09 +0200170 if opt.reference:
171 m.config.SetString('repo.reference', opt.reference)
172
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800173 if opt.mirror:
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700174 if is_new:
175 m.config.SetString('repo.mirror', 'true')
176 else:
177 print >>sys.stderr, 'fatal: --mirror not supported on existing client'
178 sys.exit(1)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800179
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700180 if not m.Sync_NetworkHalf(is_new=is_new):
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700181 r = m.GetRemote(m.remote.name)
182 print >>sys.stderr, 'fatal: cannot obtain manifest %s' % r.url
Doug Anderson2630dd92011-04-07 13:36:30 -0700183
184 # Better delete the manifest git dir if we created it; otherwise next
185 # time (when user fixes problems) we won't go through the "is_new" logic.
186 if is_new:
187 shutil.rmtree(m.gitdir)
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700188 sys.exit(1)
189
Shawn O. Pearce350cde42009-04-16 11:21:18 -0700190 syncbuf = SyncBuffer(m.config)
191 m.Sync_LocalHalf(syncbuf)
192 syncbuf.Finish()
193
Shawn O. Pearcedf018832009-03-17 08:15:27 -0700194 if is_new or m.CurrentBranch is None:
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700195 if not m.StartBranch('default'):
196 print >>sys.stderr, 'fatal: cannot create default in manifest'
197 sys.exit(1)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700198
199 def _LinkManifest(self, name):
200 if not name:
201 print >>sys.stderr, 'fatal: manifest name (-m) is required.'
202 sys.exit(1)
203
204 try:
205 self.manifest.Link(name)
206 except ManifestParseError, e:
207 print >>sys.stderr, "fatal: manifest '%s' not available" % name
208 print >>sys.stderr, 'fatal: %s' % str(e)
209 sys.exit(1)
210
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700211 def _Prompt(self, prompt, value):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700212 mp = self.manifest.manifestProject
213
214 sys.stdout.write('%-10s [%s]: ' % (prompt, value))
215 a = sys.stdin.readline().strip()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700216 if a == '':
217 return value
218 return a
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700219
Victor Boivie841be342011-04-05 11:31:10 +0200220 def _ShouldConfigureUser(self):
221 gc = self.manifest.globalConfig
222 mp = self.manifest.manifestProject
223
224 # If we don't have local settings, get from global.
225 if not mp.config.Has('user.name') or not mp.config.Has('user.email'):
226 if not gc.Has('user.name') or not gc.Has('user.email'):
227 return True
228
229 mp.config.SetString('user.name', gc.GetString('user.name'))
230 mp.config.SetString('user.email', gc.GetString('user.email'))
231
232 print ''
233 print 'Your identity is: %s <%s>' % (mp.config.GetString('user.name'),
234 mp.config.GetString('user.email'))
235 print 'If you want to change this, please re-run \'repo init\' with --config-name'
236 return False
237
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700238 def _ConfigureUser(self):
239 mp = self.manifest.manifestProject
240
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700241 while True:
242 print ''
243 name = self._Prompt('Your Name', mp.UserName)
244 email = self._Prompt('Your Email', mp.UserEmail)
245
246 print ''
247 print 'Your identity is: %s <%s>' % (name, email)
Mike Frysingere9311272011-08-11 15:46:43 -0400248 sys.stdout.write('is this correct [y/N]? ')
Nico Sallembien6d7508b2010-04-01 11:03:53 -0700249 a = sys.stdin.readline().strip()
250 if a in ('yes', 'y', 't', 'true'):
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700251 break
252
253 if name != mp.UserName:
254 mp.config.SetString('user.name', name)
255 if email != mp.UserEmail:
256 mp.config.SetString('user.email', email)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700257
258 def _HasColorSet(self, gc):
259 for n in ['ui', 'diff', 'status']:
260 if gc.Has('color.%s' % n):
261 return True
262 return False
263
264 def _ConfigureColor(self):
265 gc = self.manifest.globalConfig
266 if self._HasColorSet(gc):
267 return
268
269 class _Test(Coloring):
270 def __init__(self):
271 Coloring.__init__(self, gc, 'test color display')
272 self._on = True
273 out = _Test()
274
275 print ''
276 print "Testing colorized output (for 'repo diff', 'repo status'):"
277
278 for c in ['black','red','green','yellow','blue','magenta','cyan']:
279 out.write(' ')
280 out.printer(fg=c)(' %-6s ', c)
281 out.write(' ')
282 out.printer(fg='white', bg='black')(' %s ' % 'white')
283 out.nl()
284
285 for c in ['bold','dim','ul','reverse']:
286 out.write(' ')
287 out.printer(fg='black', attr=c)(' %-6s ', c)
288 out.nl()
289
Mike Frysingere9311272011-08-11 15:46:43 -0400290 sys.stdout.write('Enable color display in this user account (y/N)? ')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700291 a = sys.stdin.readline().strip().lower()
292 if a in ('y', 'yes', 't', 'true', 'on'):
293 gc.SetString('color.ui', 'auto')
294
Doug Anderson30d45292011-05-04 15:01:04 -0700295 def _ConfigureDepth(self, opt):
296 """Configure the depth we'll sync down.
297
298 Args:
299 opt: Options from optparse. We care about opt.depth.
300 """
301 # Opt.depth will be non-None if user actually passed --depth to repo init.
302 if opt.depth is not None:
303 if opt.depth > 0:
304 # Positive values will set the depth.
305 depth = str(opt.depth)
306 else:
307 # Negative numbers will clear the depth; passing None to SetString
308 # will do that.
309 depth = None
310
311 # We store the depth in the main manifest project.
312 self.manifest.manifestProject.config.SetString('repo.depth', depth)
313
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700314 def Execute(self, opt, args):
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700315 git_require(MIN_GIT_VERSION, fail=True)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700316 self._SyncManifest(opt)
317 self._LinkManifest(opt.manifest_name)
318
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700319 if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
Victor Boivie841be342011-04-05 11:31:10 +0200320 if opt.config_name or self._ShouldConfigureUser():
321 self._ConfigureUser()
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700322 self._ConfigureColor()
323
Doug Anderson30d45292011-05-04 15:01:04 -0700324 self._ConfigureDepth(opt)
325
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700326 if self.manifest.IsMirror:
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800327 type = 'mirror '
328 else:
329 type = ''
330
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700331 print ''
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800332 print 'repo %sinitialized in %s' % (type, self.manifest.topdir)