blob: 1c23d62063dfd1c0326faad03c451bba38024c83 [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
Doug Anderson2630dd92011-04-07 13:36:30 -070017import shutil
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070018import sys
19
20from color import Coloring
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080021from command import InteractiveCommand, MirrorSafeCommand
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070022from error import ManifestParseError
Shawn O. Pearce350cde42009-04-16 11:21:18 -070023from project import SyncBuffer
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -070024from git_config import GitConfig
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -070025from git_command import git_require, MIN_GIT_VERSION
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070026
Shawn O. Pearcec95583b2009-03-03 17:47:06 -080027class Init(InteractiveCommand, MirrorSafeCommand):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070028 common = True
29 helpSummary = "Initialize repo in the current directory"
30 helpUsage = """
31%prog [options]
32"""
33 helpDescription = """
34The '%prog' command is run once to install and initialize repo.
35The latest repo source code and manifest collection is downloaded
36from the server and is installed in the .repo/ directory in the
37current working directory.
38
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070039The optional -b argument can be used to select the manifest branch
40to checkout and use. If no branch is specified, master is assumed.
41
42The optional -m argument can be used to specify an alternate manifest
43to be used. If no manifest is specified, the manifest default.xml
44will be used.
45
Shawn O. Pearce88443382010-10-08 10:02:09 +020046The --reference option can be used to point to a directory that
47has the content of a --mirror sync. This will make the working
48directory use as much data as possible from the local reference
49directory when fetching from the server. This will make the sync
50go a lot faster by reducing data traffic on the network.
51
52
Shawn O. Pearce77bb4af2009-04-18 11:33:32 -070053Switching Manifest Branches
54---------------------------
55
56To switch to another manifest branch, `repo init -b otherbranch`
57may be used in an existing client. However, as this only updates the
58manifest, a subsequent `repo sync` (or `repo sync -d`) is necessary
59to update the working directory files.
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070060"""
61
62 def _Options(self, p):
63 # Logging
64 g = p.add_option_group('Logging options')
65 g.add_option('-q', '--quiet',
66 dest="quiet", action="store_true", default=False,
67 help="be quiet")
68
69 # Manifest
70 g = p.add_option_group('Manifest options')
71 g.add_option('-u', '--manifest-url',
72 dest='manifest_url',
73 help='manifest repository location', metavar='URL')
74 g.add_option('-b', '--manifest-branch',
75 dest='manifest_branch',
76 help='manifest branch or revision', metavar='REVISION')
77 g.add_option('-m', '--manifest-name',
78 dest='manifest_name', default='default.xml',
79 help='initial manifest file', metavar='NAME.xml')
Shawn O. Pearcee284ad12008-11-04 07:37:10 -080080 g.add_option('--mirror',
81 dest='mirror', action='store_true',
82 help='mirror the forrest')
Shawn O. Pearce88443382010-10-08 10:02:09 +020083 g.add_option('--reference',
84 dest='reference',
85 help='location of mirror directory', metavar='DIR')
Doug Anderson30d45292011-05-04 15:01:04 -070086 g.add_option('--depth', type='int', default=None,
87 dest='depth',
88 help='create a shallow clone with given depth; see git clone')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070089
90 # Tool
Shawn O. Pearcefd89b672009-04-18 11:28:57 -070091 g = p.add_option_group('repo Version options')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -070092 g.add_option('--repo-url',
93 dest='repo_url',
94 help='repo repository location', metavar='URL')
95 g.add_option('--repo-branch',
96 dest='repo_branch',
97 help='repo branch or revision', metavar='REVISION')
98 g.add_option('--no-repo-verify',
99 dest='no_repo_verify', action='store_true',
100 help='do not verify repo source code')
101
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700102 def _SyncManifest(self, opt):
103 m = self.manifest.manifestProject
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700104 is_new = not m.Exists
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700105
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700106 if is_new:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700107 if not opt.manifest_url:
108 print >>sys.stderr, 'fatal: manifest url (-u) is required.'
109 sys.exit(1)
110
111 if not opt.quiet:
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700112 print >>sys.stderr, 'Get %s' \
113 % GitConfig.ForUser().UrlInsteadOf(opt.manifest_url)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700114 m._InitGitDir()
115
116 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700117 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700118 else:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700119 m.revisionExpr = 'refs/heads/master'
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700120 else:
121 if opt.manifest_branch:
Shawn O. Pearce3c8dea12009-05-29 18:38:17 -0700122 m.revisionExpr = opt.manifest_branch
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700123 else:
124 m.PreSync()
125
126 if opt.manifest_url:
127 r = m.GetRemote(m.remote.name)
128 r.url = opt.manifest_url
129 r.ResetFetch()
130 r.Save()
131
Shawn O. Pearce88443382010-10-08 10:02:09 +0200132 if opt.reference:
133 m.config.SetString('repo.reference', opt.reference)
134
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800135 if opt.mirror:
Shawn O. Pearce5470df62009-03-09 18:51:58 -0700136 if is_new:
137 m.config.SetString('repo.mirror', 'true')
138 else:
139 print >>sys.stderr, 'fatal: --mirror not supported on existing client'
140 sys.exit(1)
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800141
Shawn O. Pearcef322b9a2011-09-19 14:50:58 -0700142 if not m.Sync_NetworkHalf(is_new=is_new):
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700143 r = m.GetRemote(m.remote.name)
144 print >>sys.stderr, 'fatal: cannot obtain manifest %s' % r.url
Doug Anderson2630dd92011-04-07 13:36:30 -0700145
146 # Better delete the manifest git dir if we created it; otherwise next
147 # time (when user fixes problems) we won't go through the "is_new" logic.
148 if is_new:
149 shutil.rmtree(m.gitdir)
Shawn O. Pearce1fc99f42009-03-17 08:06:18 -0700150 sys.exit(1)
151
Shawn O. Pearce350cde42009-04-16 11:21:18 -0700152 syncbuf = SyncBuffer(m.config)
153 m.Sync_LocalHalf(syncbuf)
154 syncbuf.Finish()
155
Shawn O. Pearcedf018832009-03-17 08:15:27 -0700156 if is_new or m.CurrentBranch is None:
Shawn O. Pearce0a389e92009-04-10 16:21:18 -0700157 if not m.StartBranch('default'):
158 print >>sys.stderr, 'fatal: cannot create default in manifest'
159 sys.exit(1)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700160
161 def _LinkManifest(self, name):
162 if not name:
163 print >>sys.stderr, 'fatal: manifest name (-m) is required.'
164 sys.exit(1)
165
166 try:
167 self.manifest.Link(name)
168 except ManifestParseError, e:
169 print >>sys.stderr, "fatal: manifest '%s' not available" % name
170 print >>sys.stderr, 'fatal: %s' % str(e)
171 sys.exit(1)
172
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700173 def _Prompt(self, prompt, value):
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700174 mp = self.manifest.manifestProject
175
176 sys.stdout.write('%-10s [%s]: ' % (prompt, value))
177 a = sys.stdin.readline().strip()
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700178 if a == '':
179 return value
180 return a
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700181
182 def _ConfigureUser(self):
183 mp = self.manifest.manifestProject
184
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700185 while True:
186 print ''
187 name = self._Prompt('Your Name', mp.UserName)
188 email = self._Prompt('Your Email', mp.UserEmail)
189
190 print ''
191 print 'Your identity is: %s <%s>' % (name, email)
Mike Frysingere9311272011-08-11 15:46:43 -0400192 sys.stdout.write('is this correct [y/N]? ')
Nico Sallembien6d7508b2010-04-01 11:03:53 -0700193 a = sys.stdin.readline().strip()
194 if a in ('yes', 'y', 't', 'true'):
Shawn O. Pearce37dbf2b2009-07-02 10:53:04 -0700195 break
196
197 if name != mp.UserName:
198 mp.config.SetString('user.name', name)
199 if email != mp.UserEmail:
200 mp.config.SetString('user.email', email)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700201
202 def _HasColorSet(self, gc):
203 for n in ['ui', 'diff', 'status']:
204 if gc.Has('color.%s' % n):
205 return True
206 return False
207
208 def _ConfigureColor(self):
209 gc = self.manifest.globalConfig
210 if self._HasColorSet(gc):
211 return
212
213 class _Test(Coloring):
214 def __init__(self):
215 Coloring.__init__(self, gc, 'test color display')
216 self._on = True
217 out = _Test()
218
219 print ''
220 print "Testing colorized output (for 'repo diff', 'repo status'):"
221
222 for c in ['black','red','green','yellow','blue','magenta','cyan']:
223 out.write(' ')
224 out.printer(fg=c)(' %-6s ', c)
225 out.write(' ')
226 out.printer(fg='white', bg='black')(' %s ' % 'white')
227 out.nl()
228
229 for c in ['bold','dim','ul','reverse']:
230 out.write(' ')
231 out.printer(fg='black', attr=c)(' %-6s ', c)
232 out.nl()
233
Mike Frysingere9311272011-08-11 15:46:43 -0400234 sys.stdout.write('Enable color display in this user account (y/N)? ')
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700235 a = sys.stdin.readline().strip().lower()
236 if a in ('y', 'yes', 't', 'true', 'on'):
237 gc.SetString('color.ui', 'auto')
238
Doug Anderson30d45292011-05-04 15:01:04 -0700239 def _ConfigureDepth(self, opt):
240 """Configure the depth we'll sync down.
241
242 Args:
243 opt: Options from optparse. We care about opt.depth.
244 """
245 # Opt.depth will be non-None if user actually passed --depth to repo init.
246 if opt.depth is not None:
247 if opt.depth > 0:
248 # Positive values will set the depth.
249 depth = str(opt.depth)
250 else:
251 # Negative numbers will clear the depth; passing None to SetString
252 # will do that.
253 depth = None
254
255 # We store the depth in the main manifest project.
256 self.manifest.manifestProject.config.SetString('repo.depth', depth)
257
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700258 def Execute(self, opt, args):
Shawn O. Pearce2ec00b92009-06-12 09:32:50 -0700259 git_require(MIN_GIT_VERSION, fail=True)
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700260 self._SyncManifest(opt)
261 self._LinkManifest(opt.manifest_name)
262
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700263 if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700264 self._ConfigureUser()
265 self._ConfigureColor()
266
Doug Anderson30d45292011-05-04 15:01:04 -0700267 self._ConfigureDepth(opt)
268
Shawn O. Pearce8630f392009-03-19 10:17:12 -0700269 if self.manifest.IsMirror:
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800270 type = 'mirror '
271 else:
272 type = ''
273
The Android Open Source Projectcf31fe92008-10-21 07:00:00 -0700274 print ''
Shawn O. Pearcee284ad12008-11-04 07:37:10 -0800275 print 'repo %sinitialized in %s' % (type, self.manifest.topdir)