1 14c54eff 2009-07-16 rsc #!/usr/bin/env python
3 14c54eff 2009-07-16 rsc # Copyright 2007 Google Inc.
5 14c54eff 2009-07-16 rsc # Licensed under the Apache License, Version 2.0 (the "License");
6 14c54eff 2009-07-16 rsc # you may not use this file except in compliance with the License.
7 14c54eff 2009-07-16 rsc # You may obtain a copy of the License at
9 14c54eff 2009-07-16 rsc # http://www.apache.org/licenses/LICENSE-2.0
11 14c54eff 2009-07-16 rsc # Unless required by applicable law or agreed to in writing, software
12 14c54eff 2009-07-16 rsc # distributed under the License is distributed on an "AS IS" BASIS,
13 14c54eff 2009-07-16 rsc # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 14c54eff 2009-07-16 rsc # See the License for the specific language governing permissions and
15 14c54eff 2009-07-16 rsc # limitations under the License.
17 14c54eff 2009-07-16 rsc """Tool for uploading diffs from a version control system to the codereview app.
19 14c54eff 2009-07-16 rsc Usage summary: upload.py [options] [-- diff_options]
21 14c54eff 2009-07-16 rsc Diff options are passed to the diff command of the underlying system.
23 14c54eff 2009-07-16 rsc Supported version control systems:
28 14c54eff 2009-07-16 rsc It is important for Git/Mercurial users to specify a tree/node/branch to diff
29 14c54eff 2009-07-16 rsc against by using the '--rev' option.
31 14c54eff 2009-07-16 rsc # This code is derived from appcfg.py in the App Engine SDK (open source),
32 14c54eff 2009-07-16 rsc # and from ASPN recipe #146306.
34 14c54eff 2009-07-16 rsc import cookielib
35 14c54eff 2009-07-16 rsc import getpass
36 14c54eff 2009-07-16 rsc import logging
37 14c54eff 2009-07-16 rsc import mimetypes
38 14c54eff 2009-07-16 rsc import optparse
41 14c54eff 2009-07-16 rsc import socket
42 14c54eff 2009-07-16 rsc import subprocess
44 14c54eff 2009-07-16 rsc import urllib
45 14c54eff 2009-07-16 rsc import urllib2
46 14c54eff 2009-07-16 rsc import urlparse
48 14c54eff 2009-07-16 rsc # The md5 module was deprecated in Python 2.5.
50 14c54eff 2009-07-16 rsc from hashlib import md5
51 14c54eff 2009-07-16 rsc except ImportError:
52 14c54eff 2009-07-16 rsc from md5 import md5
55 14c54eff 2009-07-16 rsc import readline
56 14c54eff 2009-07-16 rsc except ImportError:
59 14c54eff 2009-07-16 rsc # The logging verbosity:
60 14c54eff 2009-07-16 rsc # 0: Errors only.
61 14c54eff 2009-07-16 rsc # 1: Status messages.
62 14c54eff 2009-07-16 rsc # 2: Info logs.
63 14c54eff 2009-07-16 rsc # 3: Debug logs.
64 14c54eff 2009-07-16 rsc verbosity = 1
66 14c54eff 2009-07-16 rsc # Max size of patch or base file.
67 14c54eff 2009-07-16 rsc MAX_UPLOAD_SIZE = 900 * 1024
69 14c54eff 2009-07-16 rsc # Constants for version control names. Used by GuessVCSName.
70 14c54eff 2009-07-16 rsc VCS_GIT = "Git"
71 14c54eff 2009-07-16 rsc VCS_MERCURIAL = "Mercurial"
72 14c54eff 2009-07-16 rsc VCS_SUBVERSION = "Subversion"
73 14c54eff 2009-07-16 rsc VCS_UNKNOWN = "Unknown"
76 14c54eff 2009-07-16 rsc def GetEmail(prompt):
77 14c54eff 2009-07-16 rsc """Prompts the user for their email address and returns it.
79 14c54eff 2009-07-16 rsc The last used email address is saved to a file and offered up as a suggestion
80 14c54eff 2009-07-16 rsc to the user. If the user presses enter without typing in anything the last
81 14c54eff 2009-07-16 rsc used email address is used. If the user enters a new address, it is saved
82 14c54eff 2009-07-16 rsc for next time we prompt.
85 14c54eff 2009-07-16 rsc last_email_file_name = os.path.expanduser("~/.last_codereview_email_address")
86 14c54eff 2009-07-16 rsc last_email = ""
87 14c54eff 2009-07-16 rsc if os.path.exists(last_email_file_name):
89 14c54eff 2009-07-16 rsc last_email_file = open(last_email_file_name, "r")
90 14c54eff 2009-07-16 rsc last_email = last_email_file.readline().strip("\n")
91 14c54eff 2009-07-16 rsc last_email_file.close()
92 14c54eff 2009-07-16 rsc prompt += " [%s]" % last_email
93 14c54eff 2009-07-16 rsc except IOError, e:
95 14c54eff 2009-07-16 rsc email = raw_input(prompt + ": ").strip()
98 14c54eff 2009-07-16 rsc last_email_file = open(last_email_file_name, "w")
99 14c54eff 2009-07-16 rsc last_email_file.write(email)
100 14c54eff 2009-07-16 rsc last_email_file.close()
101 14c54eff 2009-07-16 rsc except IOError, e:
104 14c54eff 2009-07-16 rsc email = last_email
105 14c54eff 2009-07-16 rsc return email
108 14c54eff 2009-07-16 rsc def StatusUpdate(msg):
109 14c54eff 2009-07-16 rsc """Print a status message to stdout.
111 14c54eff 2009-07-16 rsc If 'verbosity' is greater than 0, print the message.
114 14c54eff 2009-07-16 rsc msg: The string to print.
116 14c54eff 2009-07-16 rsc if verbosity > 0:
120 14c54eff 2009-07-16 rsc def ErrorExit(msg):
121 14c54eff 2009-07-16 rsc """Print an error message to stderr and exit."""
122 14c54eff 2009-07-16 rsc print >>sys.stderr, msg
126 14c54eff 2009-07-16 rsc class ClientLoginError(urllib2.HTTPError):
127 14c54eff 2009-07-16 rsc """Raised to indicate there was an error authenticating with ClientLogin."""
129 14c54eff 2009-07-16 rsc def __init__(self, url, code, msg, headers, args):
130 14c54eff 2009-07-16 rsc urllib2.HTTPError.__init__(self, url, code, msg, headers, None)
131 14c54eff 2009-07-16 rsc self.args = args
132 14c54eff 2009-07-16 rsc self.reason = args["Error"]
135 14c54eff 2009-07-16 rsc class AbstractRpcServer(object):
136 14c54eff 2009-07-16 rsc """Provides a common interface for a simple RPC server."""
138 14c54eff 2009-07-16 rsc def __init__(self, host, auth_function, host_override=None, extra_headers={},
139 14c54eff 2009-07-16 rsc save_cookies=False):
140 14c54eff 2009-07-16 rsc """Creates a new HttpRpcServer.
143 14c54eff 2009-07-16 rsc host: The host to send requests to.
144 14c54eff 2009-07-16 rsc auth_function: A function that takes no arguments and returns an
145 14c54eff 2009-07-16 rsc (email, password) tuple when called. Will be called if authentication
146 14c54eff 2009-07-16 rsc is required.
147 14c54eff 2009-07-16 rsc host_override: The host header to send to the server (defaults to host).
148 14c54eff 2009-07-16 rsc extra_headers: A dict of extra headers to append to every request.
149 14c54eff 2009-07-16 rsc save_cookies: If True, save the authentication cookies to local disk.
150 14c54eff 2009-07-16 rsc If False, use an in-memory cookiejar instead. Subclasses must
151 14c54eff 2009-07-16 rsc implement this functionality. Defaults to False.
153 14c54eff 2009-07-16 rsc self.host = host
154 14c54eff 2009-07-16 rsc self.host_override = host_override
155 14c54eff 2009-07-16 rsc self.auth_function = auth_function
156 14c54eff 2009-07-16 rsc self.authenticated = False
157 14c54eff 2009-07-16 rsc self.extra_headers = extra_headers
158 14c54eff 2009-07-16 rsc self.save_cookies = save_cookies
159 14c54eff 2009-07-16 rsc self.opener = self._GetOpener()
160 14c54eff 2009-07-16 rsc if self.host_override:
161 14c54eff 2009-07-16 rsc logging.info("Server: %s; Host: %s", self.host, self.host_override)
163 14c54eff 2009-07-16 rsc logging.info("Server: %s", self.host)
165 14c54eff 2009-07-16 rsc def _GetOpener(self):
166 14c54eff 2009-07-16 rsc """Returns an OpenerDirector for making HTTP requests.
169 14c54eff 2009-07-16 rsc A urllib2.OpenerDirector object.
171 14c54eff 2009-07-16 rsc raise NotImplementedError()
173 14c54eff 2009-07-16 rsc def _CreateRequest(self, url, data=None):
174 14c54eff 2009-07-16 rsc """Creates a new urllib request."""
175 14c54eff 2009-07-16 rsc logging.debug("Creating request for: '%s' with payload:\n%s", url, data)
176 14c54eff 2009-07-16 rsc req = urllib2.Request(url, data=data)
177 14c54eff 2009-07-16 rsc if self.host_override:
178 14c54eff 2009-07-16 rsc req.add_header("Host", self.host_override)
179 14c54eff 2009-07-16 rsc for key, value in self.extra_headers.iteritems():
180 14c54eff 2009-07-16 rsc req.add_header(key, value)
183 14c54eff 2009-07-16 rsc def _GetAuthToken(self, email, password):
184 14c54eff 2009-07-16 rsc """Uses ClientLogin to authenticate the user, returning an auth token.
187 14c54eff 2009-07-16 rsc email: The user's email address
188 14c54eff 2009-07-16 rsc password: The user's password
191 14c54eff 2009-07-16 rsc ClientLoginError: If there was an error authenticating with ClientLogin.
192 14c54eff 2009-07-16 rsc HTTPError: If there was some other form of HTTP error.
195 14c54eff 2009-07-16 rsc The authentication token returned by ClientLogin.
197 14c54eff 2009-07-16 rsc account_type = "GOOGLE"
198 14c54eff 2009-07-16 rsc if self.host.endswith(".google.com"):
199 14c54eff 2009-07-16 rsc # Needed for use inside Google.
200 14c54eff 2009-07-16 rsc account_type = "HOSTED"
201 14c54eff 2009-07-16 rsc req = self._CreateRequest(
202 14c54eff 2009-07-16 rsc url="https://www.google.com/accounts/ClientLogin",
203 14c54eff 2009-07-16 rsc data=urllib.urlencode({
204 14c54eff 2009-07-16 rsc "Email": email,
205 14c54eff 2009-07-16 rsc "Passwd": password,
206 14c54eff 2009-07-16 rsc "service": "ah",
207 14c54eff 2009-07-16 rsc "source": "rietveld-codereview-upload",
208 14c54eff 2009-07-16 rsc "accountType": account_type,
212 14c54eff 2009-07-16 rsc response = self.opener.open(req)
213 14c54eff 2009-07-16 rsc response_body = response.read()
214 14c54eff 2009-07-16 rsc response_dict = dict(x.split("=")
215 14c54eff 2009-07-16 rsc for x in response_body.split("\n") if x)
216 14c54eff 2009-07-16 rsc return response_dict["Auth"]
217 14c54eff 2009-07-16 rsc except urllib2.HTTPError, e:
218 14c54eff 2009-07-16 rsc if e.code == 403:
219 14c54eff 2009-07-16 rsc body = e.read()
220 14c54eff 2009-07-16 rsc response_dict = dict(x.split("=", 1) for x in body.split("\n") if x)
221 14c54eff 2009-07-16 rsc raise ClientLoginError(req.get_full_url(), e.code, e.msg,
222 14c54eff 2009-07-16 rsc e.headers, response_dict)
226 14c54eff 2009-07-16 rsc def _GetAuthCookie(self, auth_token):
227 14c54eff 2009-07-16 rsc """Fetches authentication cookies for an authentication token.
230 14c54eff 2009-07-16 rsc auth_token: The authentication token returned by ClientLogin.
233 14c54eff 2009-07-16 rsc HTTPError: If there was an error fetching the authentication cookies.
235 14c54eff 2009-07-16 rsc # This is a dummy value to allow us to identify when we're successful.
236 14c54eff 2009-07-16 rsc continue_location = "http://localhost/"
237 14c54eff 2009-07-16 rsc args = {"continue": continue_location, "auth": auth_token}
238 14c54eff 2009-07-16 rsc req = self._CreateRequest("http://%s/_ah/login?%s" %
239 14c54eff 2009-07-16 rsc (self.host, urllib.urlencode(args)))
241 14c54eff 2009-07-16 rsc response = self.opener.open(req)
242 14c54eff 2009-07-16 rsc except urllib2.HTTPError, e:
243 14c54eff 2009-07-16 rsc response = e
244 14c54eff 2009-07-16 rsc if (response.code != 302 or
245 14c54eff 2009-07-16 rsc response.info()["location"] != continue_location):
246 14c54eff 2009-07-16 rsc raise urllib2.HTTPError(req.get_full_url(), response.code, response.msg,
247 14c54eff 2009-07-16 rsc response.headers, response.fp)
248 14c54eff 2009-07-16 rsc self.authenticated = True
250 14c54eff 2009-07-16 rsc def _Authenticate(self):
251 14c54eff 2009-07-16 rsc """Authenticates the user.
253 14c54eff 2009-07-16 rsc The authentication process works as follows:
254 14c54eff 2009-07-16 rsc 1) We get a username and password from the user
255 14c54eff 2009-07-16 rsc 2) We use ClientLogin to obtain an AUTH token for the user
256 14c54eff 2009-07-16 rsc (see http://code.google.com/apis/accounts/AuthForInstalledApps.html).
257 14c54eff 2009-07-16 rsc 3) We pass the auth token to /_ah/login on the server to obtain an
258 14c54eff 2009-07-16 rsc authentication cookie. If login was successful, it tries to redirect
259 14c54eff 2009-07-16 rsc us to the URL we provided.
261 14c54eff 2009-07-16 rsc If we attempt to access the upload API without first obtaining an
262 14c54eff 2009-07-16 rsc authentication cookie, it returns a 401 response and directs us to
263 14c54eff 2009-07-16 rsc authenticate ourselves with ClientLogin.
265 14c54eff 2009-07-16 rsc for i in range(3):
266 14c54eff 2009-07-16 rsc credentials = self.auth_function()
268 14c54eff 2009-07-16 rsc auth_token = self._GetAuthToken(credentials[0], credentials[1])
269 14c54eff 2009-07-16 rsc except ClientLoginError, e:
270 14c54eff 2009-07-16 rsc if e.reason == "BadAuthentication":
271 14c54eff 2009-07-16 rsc print >>sys.stderr, "Invalid username or password."
273 14c54eff 2009-07-16 rsc if e.reason == "CaptchaRequired":
274 14c54eff 2009-07-16 rsc print >>sys.stderr, (
275 14c54eff 2009-07-16 rsc "Please go to\n"
276 14c54eff 2009-07-16 rsc "https://www.google.com/accounts/DisplayUnlockCaptcha\n"
277 14c54eff 2009-07-16 rsc "and verify you are a human. Then try again.")
279 14c54eff 2009-07-16 rsc if e.reason == "NotVerified":
280 14c54eff 2009-07-16 rsc print >>sys.stderr, "Account not verified."
282 14c54eff 2009-07-16 rsc if e.reason == "TermsNotAgreed":
283 14c54eff 2009-07-16 rsc print >>sys.stderr, "User has not agreed to TOS."
285 14c54eff 2009-07-16 rsc if e.reason == "AccountDeleted":
286 14c54eff 2009-07-16 rsc print >>sys.stderr, "The user account has been deleted."
288 14c54eff 2009-07-16 rsc if e.reason == "AccountDisabled":
289 14c54eff 2009-07-16 rsc print >>sys.stderr, "The user account has been disabled."
291 14c54eff 2009-07-16 rsc if e.reason == "ServiceDisabled":
292 14c54eff 2009-07-16 rsc print >>sys.stderr, ("The user's access to the service has been "
293 14c54eff 2009-07-16 rsc "disabled.")
295 14c54eff 2009-07-16 rsc if e.reason == "ServiceUnavailable":
296 14c54eff 2009-07-16 rsc print >>sys.stderr, "The service is not available; try again later."
299 14c54eff 2009-07-16 rsc self._GetAuthCookie(auth_token)
302 14c54eff 2009-07-16 rsc def Send(self, request_path, payload=None,
303 14c54eff 2009-07-16 rsc content_type="application/octet-stream",
304 14c54eff 2009-07-16 rsc timeout=None,
306 14c54eff 2009-07-16 rsc """Sends an RPC and returns the response.
309 14c54eff 2009-07-16 rsc request_path: The path to send the request to, eg /api/appversion/create.
310 14c54eff 2009-07-16 rsc payload: The body of the request, or None to send an empty request.
311 14c54eff 2009-07-16 rsc content_type: The Content-Type header to use.
312 14c54eff 2009-07-16 rsc timeout: timeout in seconds; default None i.e. no timeout.
313 14c54eff 2009-07-16 rsc (Note: for large requests on OS X, the timeout doesn't work right.)
314 14c54eff 2009-07-16 rsc kwargs: Any keyword arguments are converted into query string parameters.
317 14c54eff 2009-07-16 rsc The response body, as a string.
319 14c54eff 2009-07-16 rsc # TODO: Don't require authentication. Let the server say
320 14c54eff 2009-07-16 rsc # whether it is necessary.
321 14c54eff 2009-07-16 rsc if not self.authenticated:
322 14c54eff 2009-07-16 rsc self._Authenticate()
324 14c54eff 2009-07-16 rsc old_timeout = socket.getdefaulttimeout()
325 14c54eff 2009-07-16 rsc socket.setdefaulttimeout(timeout)
330 14c54eff 2009-07-16 rsc args = dict(kwargs)
331 14c54eff 2009-07-16 rsc url = "http://%s%s" % (self.host, request_path)
333 14c54eff 2009-07-16 rsc url += "?" + urllib.urlencode(args)
334 14c54eff 2009-07-16 rsc req = self._CreateRequest(url=url, data=payload)
335 14c54eff 2009-07-16 rsc req.add_header("Content-Type", content_type)
337 14c54eff 2009-07-16 rsc f = self.opener.open(req)
338 14c54eff 2009-07-16 rsc response = f.read()
340 14c54eff 2009-07-16 rsc return response
341 14c54eff 2009-07-16 rsc except urllib2.HTTPError, e:
342 14c54eff 2009-07-16 rsc if tries > 3:
344 14c54eff 2009-07-16 rsc elif e.code == 401:
345 14c54eff 2009-07-16 rsc self._Authenticate()
346 14c54eff 2009-07-16 rsc ## elif e.code >= 500 and e.code < 600:
347 14c54eff 2009-07-16 rsc ## # Server Error - try again.
352 14c54eff 2009-07-16 rsc socket.setdefaulttimeout(old_timeout)
355 14c54eff 2009-07-16 rsc class HttpRpcServer(AbstractRpcServer):
356 14c54eff 2009-07-16 rsc """Provides a simplified RPC-style interface for HTTP requests."""
358 14c54eff 2009-07-16 rsc def _Authenticate(self):
359 14c54eff 2009-07-16 rsc """Save the cookie jar after authentication."""
360 14c54eff 2009-07-16 rsc super(HttpRpcServer, self)._Authenticate()
361 14c54eff 2009-07-16 rsc if self.save_cookies:
362 14c54eff 2009-07-16 rsc StatusUpdate("Saving authentication cookies to %s" % self.cookie_file)
363 14c54eff 2009-07-16 rsc self.cookie_jar.save()
365 14c54eff 2009-07-16 rsc def _GetOpener(self):
366 14c54eff 2009-07-16 rsc """Returns an OpenerDirector that supports cookies and ignores redirects.
369 14c54eff 2009-07-16 rsc A urllib2.OpenerDirector object.
371 14c54eff 2009-07-16 rsc opener = urllib2.OpenerDirector()
372 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.ProxyHandler())
373 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.UnknownHandler())
374 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.HTTPHandler())
375 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.HTTPDefaultErrorHandler())
376 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.HTTPSHandler())
377 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.HTTPErrorProcessor())
378 14c54eff 2009-07-16 rsc if self.save_cookies:
379 14c54eff 2009-07-16 rsc self.cookie_file = os.path.expanduser("~/.codereview_upload_cookies")
380 14c54eff 2009-07-16 rsc self.cookie_jar = cookielib.MozillaCookieJar(self.cookie_file)
381 14c54eff 2009-07-16 rsc if os.path.exists(self.cookie_file):
383 14c54eff 2009-07-16 rsc self.cookie_jar.load()
384 14c54eff 2009-07-16 rsc self.authenticated = True
385 14c54eff 2009-07-16 rsc StatusUpdate("Loaded authentication cookies from %s" %
386 14c54eff 2009-07-16 rsc self.cookie_file)
387 14c54eff 2009-07-16 rsc except (cookielib.LoadError, IOError):
388 14c54eff 2009-07-16 rsc # Failed to load cookies - just ignore them.
391 14c54eff 2009-07-16 rsc # Create an empty cookie file with mode 600
392 14c54eff 2009-07-16 rsc fd = os.open(self.cookie_file, os.O_CREAT, 0600)
393 14c54eff 2009-07-16 rsc os.close(fd)
394 14c54eff 2009-07-16 rsc # Always chmod the cookie file
395 14c54eff 2009-07-16 rsc os.chmod(self.cookie_file, 0600)
397 14c54eff 2009-07-16 rsc # Don't save cookies across runs of update.py.
398 14c54eff 2009-07-16 rsc self.cookie_jar = cookielib.CookieJar()
399 14c54eff 2009-07-16 rsc opener.add_handler(urllib2.HTTPCookieProcessor(self.cookie_jar))
400 14c54eff 2009-07-16 rsc return opener
403 14c54eff 2009-07-16 rsc parser = optparse.OptionParser(usage="%prog [options] [-- diff_options]")
404 14c54eff 2009-07-16 rsc parser.add_option("-y", "--assume_yes", action="store_true",
405 14c54eff 2009-07-16 rsc dest="assume_yes", default=False,
406 14c54eff 2009-07-16 rsc help="Assume that the answer to yes/no questions is 'yes'.")
408 14c54eff 2009-07-16 rsc group = parser.add_option_group("Logging options")
409 14c54eff 2009-07-16 rsc group.add_option("-q", "--quiet", action="store_const", const=0,
410 14c54eff 2009-07-16 rsc dest="verbose", help="Print errors only.")
411 14c54eff 2009-07-16 rsc group.add_option("-v", "--verbose", action="store_const", const=2,
412 14c54eff 2009-07-16 rsc dest="verbose", default=1,
413 14c54eff 2009-07-16 rsc help="Print info level logs (default).")
414 14c54eff 2009-07-16 rsc group.add_option("--noisy", action="store_const", const=3,
415 14c54eff 2009-07-16 rsc dest="verbose", help="Print all logs.")
416 14c54eff 2009-07-16 rsc # Review server
417 14c54eff 2009-07-16 rsc group = parser.add_option_group("Review server options")
418 14c54eff 2009-07-16 rsc group.add_option("-s", "--server", action="store", dest="server",
419 14c54eff 2009-07-16 rsc default="codereview.appspot.com",
420 14c54eff 2009-07-16 rsc metavar="SERVER",
421 14c54eff 2009-07-16 rsc help=("The server to upload to. The format is host[:port]. "
422 14c54eff 2009-07-16 rsc "Defaults to '%default'."))
423 14c54eff 2009-07-16 rsc group.add_option("-e", "--email", action="store", dest="email",
424 14c54eff 2009-07-16 rsc metavar="EMAIL", default=None,
425 14c54eff 2009-07-16 rsc help="The username to use. Will prompt if omitted.")
426 14c54eff 2009-07-16 rsc group.add_option("-H", "--host", action="store", dest="host",
427 14c54eff 2009-07-16 rsc metavar="HOST", default=None,
428 14c54eff 2009-07-16 rsc help="Overrides the Host header sent with all RPCs.")
429 14c54eff 2009-07-16 rsc group.add_option("--no_cookies", action="store_false",
430 14c54eff 2009-07-16 rsc dest="save_cookies", default=True,
431 14c54eff 2009-07-16 rsc help="Do not save authentication cookies to local disk.")
433 14c54eff 2009-07-16 rsc group = parser.add_option_group("Issue options")
434 14c54eff 2009-07-16 rsc group.add_option("-d", "--description", action="store", dest="description",
435 14c54eff 2009-07-16 rsc metavar="DESCRIPTION", default=None,
436 14c54eff 2009-07-16 rsc help="Optional description when creating an issue.")
437 14c54eff 2009-07-16 rsc group.add_option("-f", "--description_file", action="store",
438 14c54eff 2009-07-16 rsc dest="description_file", metavar="DESCRIPTION_FILE",
439 14c54eff 2009-07-16 rsc default=None,
440 14c54eff 2009-07-16 rsc help="Optional path of a file that contains "
441 14c54eff 2009-07-16 rsc "the description when creating an issue.")
442 14c54eff 2009-07-16 rsc group.add_option("-r", "--reviewers", action="store", dest="reviewers",
443 14c54eff 2009-07-16 rsc metavar="REVIEWERS", default=None,
444 14c54eff 2009-07-16 rsc help="Add reviewers (comma separated email addresses).")
445 14c54eff 2009-07-16 rsc group.add_option("--cc", action="store", dest="cc",
446 14c54eff 2009-07-16 rsc metavar="CC", default=None,
447 14c54eff 2009-07-16 rsc help="Add CC (comma separated email addresses).")
448 14c54eff 2009-07-16 rsc # Upload options
449 14c54eff 2009-07-16 rsc group = parser.add_option_group("Patch options")
450 14c54eff 2009-07-16 rsc group.add_option("-m", "--message", action="store", dest="message",
451 14c54eff 2009-07-16 rsc metavar="MESSAGE", default=None,
452 14c54eff 2009-07-16 rsc help="A message to identify the patch. "
453 14c54eff 2009-07-16 rsc "Will prompt if omitted.")
454 14c54eff 2009-07-16 rsc group.add_option("-i", "--issue", type="int", action="store",
455 14c54eff 2009-07-16 rsc metavar="ISSUE", default=None,
456 14c54eff 2009-07-16 rsc help="Issue number to which to add. Defaults to new issue.")
457 14c54eff 2009-07-16 rsc group.add_option("--download_base", action="store_true",
458 14c54eff 2009-07-16 rsc dest="download_base", default=False,
459 14c54eff 2009-07-16 rsc help="Base files will be downloaded by the server "
460 14c54eff 2009-07-16 rsc "(side-by-side diffs may not work on files with CRs).")
461 14c54eff 2009-07-16 rsc group.add_option("--rev", action="store", dest="revision",
462 14c54eff 2009-07-16 rsc metavar="REV", default=None,
463 14c54eff 2009-07-16 rsc help="Branch/tree/revision to diff against (used by DVCS).")
464 14c54eff 2009-07-16 rsc group.add_option("--send_mail", action="store_true",
465 14c54eff 2009-07-16 rsc dest="send_mail", default=False,
466 14c54eff 2009-07-16 rsc help="Send notification email to reviewers.")
469 14c54eff 2009-07-16 rsc def GetRpcServer(options):
470 14c54eff 2009-07-16 rsc """Returns an instance of an AbstractRpcServer.
473 14c54eff 2009-07-16 rsc A new AbstractRpcServer, on which RPC calls can be made.
476 14c54eff 2009-07-16 rsc rpc_server_class = HttpRpcServer
478 14c54eff 2009-07-16 rsc def GetUserCredentials():
479 14c54eff 2009-07-16 rsc """Prompts the user for a username and password."""
480 14c54eff 2009-07-16 rsc email = options.email
481 14c54eff 2009-07-16 rsc if email is None:
482 14c54eff 2009-07-16 rsc email = GetEmail("Email (login for uploading to %s)" % options.server)
483 14c54eff 2009-07-16 rsc password = getpass.getpass("Password for %s: " % email)
484 14c54eff 2009-07-16 rsc return (email, password)
486 14c54eff 2009-07-16 rsc # If this is the dev_appserver, use fake authentication.
487 14c54eff 2009-07-16 rsc host = (options.host or options.server).lower()
488 14c54eff 2009-07-16 rsc if host == "localhost" or host.startswith("localhost:"):
489 14c54eff 2009-07-16 rsc email = options.email
490 14c54eff 2009-07-16 rsc if email is None:
491 14c54eff 2009-07-16 rsc email = "test@example.com"
492 14c54eff 2009-07-16 rsc logging.info("Using debug user %s. Override with --email" % email)
493 14c54eff 2009-07-16 rsc server = rpc_server_class(
494 14c54eff 2009-07-16 rsc options.server,
495 14c54eff 2009-07-16 rsc lambda: (email, "password"),
496 14c54eff 2009-07-16 rsc host_override=options.host,
497 14c54eff 2009-07-16 rsc extra_headers={"Cookie":
498 14c54eff 2009-07-16 rsc 'dev_appserver_login="%s:False"' % email},
499 14c54eff 2009-07-16 rsc save_cookies=options.save_cookies)
500 14c54eff 2009-07-16 rsc # Don't try to talk to ClientLogin.
501 14c54eff 2009-07-16 rsc server.authenticated = True
502 14c54eff 2009-07-16 rsc return server
504 14c54eff 2009-07-16 rsc return rpc_server_class(options.server, GetUserCredentials,
505 14c54eff 2009-07-16 rsc host_override=options.host,
506 14c54eff 2009-07-16 rsc save_cookies=options.save_cookies)
509 14c54eff 2009-07-16 rsc def EncodeMultipartFormData(fields, files):
510 14c54eff 2009-07-16 rsc """Encode form fields for multipart/form-data.
513 14c54eff 2009-07-16 rsc fields: A sequence of (name, value) elements for regular form fields.
514 14c54eff 2009-07-16 rsc files: A sequence of (name, filename, value) elements for data to be
515 14c54eff 2009-07-16 rsc uploaded as files.
517 14c54eff 2009-07-16 rsc (content_type, body) ready for httplib.HTTP instance.
520 14c54eff 2009-07-16 rsc http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/146306
522 14c54eff 2009-07-16 rsc BOUNDARY = '-M-A-G-I-C---B-O-U-N-D-A-R-Y-'
523 14c54eff 2009-07-16 rsc CRLF = '\r\n'
525 14c54eff 2009-07-16 rsc for (key, value) in fields:
526 14c54eff 2009-07-16 rsc lines.append('--' + BOUNDARY)
527 14c54eff 2009-07-16 rsc lines.append('Content-Disposition: form-data; name="%s"' % key)
528 14c54eff 2009-07-16 rsc lines.append('')
529 14c54eff 2009-07-16 rsc lines.append(value)
530 14c54eff 2009-07-16 rsc for (key, filename, value) in files:
531 14c54eff 2009-07-16 rsc lines.append('--' + BOUNDARY)
532 14c54eff 2009-07-16 rsc lines.append('Content-Disposition: form-data; name="%s"; filename="%s"' %
533 14c54eff 2009-07-16 rsc (key, filename))
534 14c54eff 2009-07-16 rsc lines.append('Content-Type: %s' % GetContentType(filename))
535 14c54eff 2009-07-16 rsc lines.append('')
536 14c54eff 2009-07-16 rsc lines.append(value)
537 14c54eff 2009-07-16 rsc lines.append('--' + BOUNDARY + '--')
538 14c54eff 2009-07-16 rsc lines.append('')
539 14c54eff 2009-07-16 rsc body = CRLF.join(lines)
540 14c54eff 2009-07-16 rsc content_type = 'multipart/form-data; boundary=%s' % BOUNDARY
541 14c54eff 2009-07-16 rsc return content_type, body
544 14c54eff 2009-07-16 rsc def GetContentType(filename):
545 14c54eff 2009-07-16 rsc """Helper to guess the content-type from the filename."""
546 14c54eff 2009-07-16 rsc return mimetypes.guess_type(filename)[0] or 'application/octet-stream'
549 14c54eff 2009-07-16 rsc # Use a shell for subcommands on Windows to get a PATH search.
550 14c54eff 2009-07-16 rsc use_shell = sys.platform.startswith("win")
552 14c54eff 2009-07-16 rsc def RunShellWithReturnCode(command, print_output=False,
553 14c54eff 2009-07-16 rsc universal_newlines=True):
554 14c54eff 2009-07-16 rsc """Executes a command and returns the output from stdout and the return code.
557 14c54eff 2009-07-16 rsc command: Command to execute.
558 14c54eff 2009-07-16 rsc print_output: If True, the output is printed to stdout.
559 14c54eff 2009-07-16 rsc If False, both stdout and stderr are ignored.
560 14c54eff 2009-07-16 rsc universal_newlines: Use universal_newlines flag (default: True).
563 14c54eff 2009-07-16 rsc Tuple (output, return code)
565 14c54eff 2009-07-16 rsc logging.info("Running %s", command)
566 14c54eff 2009-07-16 rsc p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
567 14c54eff 2009-07-16 rsc shell=use_shell, universal_newlines=universal_newlines)
568 14c54eff 2009-07-16 rsc if print_output:
569 14c54eff 2009-07-16 rsc output_array = []
571 14c54eff 2009-07-16 rsc line = p.stdout.readline()
572 14c54eff 2009-07-16 rsc if not line:
574 14c54eff 2009-07-16 rsc print line.strip("\n")
575 14c54eff 2009-07-16 rsc output_array.append(line)
576 14c54eff 2009-07-16 rsc output = "".join(output_array)
578 14c54eff 2009-07-16 rsc output = p.stdout.read()
580 14c54eff 2009-07-16 rsc errout = p.stderr.read()
581 14c54eff 2009-07-16 rsc if print_output and errout:
582 14c54eff 2009-07-16 rsc print >>sys.stderr, errout
583 14c54eff 2009-07-16 rsc p.stdout.close()
584 14c54eff 2009-07-16 rsc p.stderr.close()
585 14c54eff 2009-07-16 rsc return output, p.returncode
588 14c54eff 2009-07-16 rsc def RunShell(command, silent_ok=False, universal_newlines=True,
589 14c54eff 2009-07-16 rsc print_output=False):
590 14c54eff 2009-07-16 rsc data, retcode = RunShellWithReturnCode(command, print_output,
591 14c54eff 2009-07-16 rsc universal_newlines)
593 14c54eff 2009-07-16 rsc ErrorExit("Got error status from %s:\n%s" % (command, data))
594 14c54eff 2009-07-16 rsc if not silent_ok and not data:
595 14c54eff 2009-07-16 rsc ErrorExit("No output from %s" % command)
599 14c54eff 2009-07-16 rsc class VersionControlSystem(object):
600 14c54eff 2009-07-16 rsc """Abstract base class providing an interface to the VCS."""
602 14c54eff 2009-07-16 rsc def __init__(self, options):
603 14c54eff 2009-07-16 rsc """Constructor.
606 14c54eff 2009-07-16 rsc options: Command line options.
608 14c54eff 2009-07-16 rsc self.options = options
610 14c54eff 2009-07-16 rsc def GenerateDiff(self, args):
611 14c54eff 2009-07-16 rsc """Return the current diff as a string.
614 14c54eff 2009-07-16 rsc args: Extra arguments to pass to the diff command.
616 14c54eff 2009-07-16 rsc raise NotImplementedError(
617 14c54eff 2009-07-16 rsc "abstract method -- subclass %s must override" % self.__class__)
619 14c54eff 2009-07-16 rsc def GetUnknownFiles(self):
620 14c54eff 2009-07-16 rsc """Return a list of files unknown to the VCS."""
621 14c54eff 2009-07-16 rsc raise NotImplementedError(
622 14c54eff 2009-07-16 rsc "abstract method -- subclass %s must override" % self.__class__)
624 14c54eff 2009-07-16 rsc def CheckForUnknownFiles(self):
625 14c54eff 2009-07-16 rsc """Show an "are you sure?" prompt if there are unknown files."""
626 14c54eff 2009-07-16 rsc unknown_files = self.GetUnknownFiles()
627 14c54eff 2009-07-16 rsc if unknown_files:
628 14c54eff 2009-07-16 rsc print "The following files are not added to version control:"
629 14c54eff 2009-07-16 rsc for line in unknown_files:
631 14c54eff 2009-07-16 rsc prompt = "Are you sure to continue?(y/N) "
632 14c54eff 2009-07-16 rsc answer = raw_input(prompt).strip()
633 14c54eff 2009-07-16 rsc if answer != "y":
634 14c54eff 2009-07-16 rsc ErrorExit("User aborted")
636 14c54eff 2009-07-16 rsc def GetBaseFile(self, filename):
637 14c54eff 2009-07-16 rsc """Get the content of the upstream version of a file.
640 14c54eff 2009-07-16 rsc A tuple (base_content, new_content, is_binary, status)
641 14c54eff 2009-07-16 rsc base_content: The contents of the base file.
642 14c54eff 2009-07-16 rsc new_content: For text files, this is empty. For binary files, this is
643 14c54eff 2009-07-16 rsc the contents of the new file, since the diff output won't contain
644 14c54eff 2009-07-16 rsc information to reconstruct the current file.
645 14c54eff 2009-07-16 rsc is_binary: True iff the file is binary.
646 14c54eff 2009-07-16 rsc status: The status of the file.
649 14c54eff 2009-07-16 rsc raise NotImplementedError(
650 14c54eff 2009-07-16 rsc "abstract method -- subclass %s must override" % self.__class__)
653 14c54eff 2009-07-16 rsc def GetBaseFiles(self, diff):
654 14c54eff 2009-07-16 rsc """Helper that calls GetBase file for each file in the patch.
657 14c54eff 2009-07-16 rsc A dictionary that maps from filename to GetBaseFile's tuple. Filenames
658 14c54eff 2009-07-16 rsc are retrieved based on lines that start with "Index:" or
659 14c54eff 2009-07-16 rsc "Property changes on:".
662 14c54eff 2009-07-16 rsc for line in diff.splitlines(True):
663 14c54eff 2009-07-16 rsc if line.startswith('Index:') or line.startswith('Property changes on:'):
664 14c54eff 2009-07-16 rsc unused, filename = line.split(':', 1)
665 14c54eff 2009-07-16 rsc # On Windows if a file has property changes its filename uses '\'
666 14c54eff 2009-07-16 rsc # instead of '/'.
667 14c54eff 2009-07-16 rsc filename = filename.strip().replace('\\', '/')
668 14c54eff 2009-07-16 rsc files[filename] = self.GetBaseFile(filename)
669 14c54eff 2009-07-16 rsc return files
672 14c54eff 2009-07-16 rsc def UploadBaseFiles(self, issue, rpc_server, patch_list, patchset, options,
674 14c54eff 2009-07-16 rsc """Uploads the base files (and if necessary, the current ones as well)."""
676 14c54eff 2009-07-16 rsc def UploadFile(filename, file_id, content, is_binary, status, is_base):
677 14c54eff 2009-07-16 rsc """Uploads a file to the server."""
678 14c54eff 2009-07-16 rsc file_too_large = False
680 14c54eff 2009-07-16 rsc type = "base"
682 14c54eff 2009-07-16 rsc type = "current"
683 14c54eff 2009-07-16 rsc if len(content) > MAX_UPLOAD_SIZE:
684 14c54eff 2009-07-16 rsc print ("Not uploading the %s file for %s because it's too large." %
685 14c54eff 2009-07-16 rsc (type, filename))
686 14c54eff 2009-07-16 rsc file_too_large = True
687 14c54eff 2009-07-16 rsc content = ""
688 14c54eff 2009-07-16 rsc checksum = md5(content).hexdigest()
689 14c54eff 2009-07-16 rsc if options.verbose > 0 and not file_too_large:
690 14c54eff 2009-07-16 rsc print "Uploading %s file for %s" % (type, filename)
691 14c54eff 2009-07-16 rsc url = "/%d/upload_content/%d/%d" % (int(issue), int(patchset), file_id)
692 14c54eff 2009-07-16 rsc form_fields = [("filename", filename),
693 14c54eff 2009-07-16 rsc ("status", status),
694 14c54eff 2009-07-16 rsc ("checksum", checksum),
695 14c54eff 2009-07-16 rsc ("is_binary", str(is_binary)),
696 14c54eff 2009-07-16 rsc ("is_current", str(not is_base)),
698 14c54eff 2009-07-16 rsc if file_too_large:
699 14c54eff 2009-07-16 rsc form_fields.append(("file_too_large", "1"))
700 14c54eff 2009-07-16 rsc if options.email:
701 14c54eff 2009-07-16 rsc form_fields.append(("user", options.email))
702 14c54eff 2009-07-16 rsc ctype, body = EncodeMultipartFormData(form_fields,
703 14c54eff 2009-07-16 rsc [("data", filename, content)])
704 14c54eff 2009-07-16 rsc response_body = rpc_server.Send(url, body,
705 14c54eff 2009-07-16 rsc content_type=ctype)
706 14c54eff 2009-07-16 rsc if not response_body.startswith("OK"):
707 14c54eff 2009-07-16 rsc StatusUpdate(" --> %s" % response_body)
710 14c54eff 2009-07-16 rsc patches = dict()
711 14c54eff 2009-07-16 rsc [patches.setdefault(v, k) for k, v in patch_list]
712 14c54eff 2009-07-16 rsc for filename in patches.keys():
713 14c54eff 2009-07-16 rsc base_content, new_content, is_binary, status = files[filename]
714 14c54eff 2009-07-16 rsc file_id_str = patches.get(filename)
715 14c54eff 2009-07-16 rsc if file_id_str.find("nobase") != -1:
716 14c54eff 2009-07-16 rsc base_content = None
717 14c54eff 2009-07-16 rsc file_id_str = file_id_str[file_id_str.rfind("_") + 1:]
718 14c54eff 2009-07-16 rsc file_id = int(file_id_str)
719 14c54eff 2009-07-16 rsc if base_content != None:
720 14c54eff 2009-07-16 rsc UploadFile(filename, file_id, base_content, is_binary, status, True)
721 14c54eff 2009-07-16 rsc if new_content != None:
722 14c54eff 2009-07-16 rsc UploadFile(filename, file_id, new_content, is_binary, status, False)
724 14c54eff 2009-07-16 rsc def IsImage(self, filename):
725 14c54eff 2009-07-16 rsc """Returns true if the filename has an image extension."""
726 14c54eff 2009-07-16 rsc mimetype = mimetypes.guess_type(filename)[0]
727 14c54eff 2009-07-16 rsc if not mimetype:
728 14c54eff 2009-07-16 rsc return False
729 14c54eff 2009-07-16 rsc return mimetype.startswith("image/")
731 14c54eff 2009-07-16 rsc def IsBinary(self, filename):
732 14c54eff 2009-07-16 rsc """Returns true if the guessed mimetyped isnt't in text group."""
733 14c54eff 2009-07-16 rsc mimetype = mimetypes.guess_type(filename)[0]
734 14c54eff 2009-07-16 rsc if not mimetype:
735 14c54eff 2009-07-16 rsc return False # e.g. README, "real" binaries usually have an extension
736 14c54eff 2009-07-16 rsc return not mimetype.startswith("text/")
739 14c54eff 2009-07-16 rsc class SubversionVCS(VersionControlSystem):
740 14c54eff 2009-07-16 rsc """Implementation of the VersionControlSystem interface for Subversion."""
742 14c54eff 2009-07-16 rsc def __init__(self, options):
743 14c54eff 2009-07-16 rsc super(SubversionVCS, self).__init__(options)
744 14c54eff 2009-07-16 rsc if self.options.revision:
745 14c54eff 2009-07-16 rsc match = re.match(r"(\d+)(:(\d+))?", self.options.revision)
746 14c54eff 2009-07-16 rsc if not match:
747 14c54eff 2009-07-16 rsc ErrorExit("Invalid Subversion revision %s." % self.options.revision)
748 14c54eff 2009-07-16 rsc self.rev_start = match.group(1)
749 14c54eff 2009-07-16 rsc self.rev_end = match.group(3)
751 14c54eff 2009-07-16 rsc self.rev_start = self.rev_end = None
752 14c54eff 2009-07-16 rsc # Cache output from "svn list -r REVNO dirname".
753 14c54eff 2009-07-16 rsc # Keys: dirname, Values: 2-tuple (ouput for start rev and end rev).
754 14c54eff 2009-07-16 rsc self.svnls_cache = {}
755 14c54eff 2009-07-16 rsc # SVN base URL is required to fetch files deleted in an older revision.
756 14c54eff 2009-07-16 rsc # Result is cached to not guess it over and over again in GetBaseFile().
757 14c54eff 2009-07-16 rsc required = self.options.download_base or self.options.revision is not None
758 14c54eff 2009-07-16 rsc self.svn_base = self._GuessBase(required)
760 14c54eff 2009-07-16 rsc def GuessBase(self, required):
761 14c54eff 2009-07-16 rsc """Wrapper for _GuessBase."""
762 14c54eff 2009-07-16 rsc return self.svn_base
764 14c54eff 2009-07-16 rsc def _GuessBase(self, required):
765 14c54eff 2009-07-16 rsc """Returns the SVN base URL.
768 14c54eff 2009-07-16 rsc required: If true, exits if the url can't be guessed, otherwise None is
771 14c54eff 2009-07-16 rsc info = RunShell(["svn", "info"])
772 14c54eff 2009-07-16 rsc for line in info.splitlines():
773 14c54eff 2009-07-16 rsc words = line.split()
774 14c54eff 2009-07-16 rsc if len(words) == 2 and words[0] == "URL:":
775 14c54eff 2009-07-16 rsc url = words[1]
776 14c54eff 2009-07-16 rsc scheme, netloc, path, params, query, fragment = urlparse.urlparse(url)
777 14c54eff 2009-07-16 rsc username, netloc = urllib.splituser(netloc)
778 14c54eff 2009-07-16 rsc if username:
779 14c54eff 2009-07-16 rsc logging.info("Removed username from base URL")
780 14c54eff 2009-07-16 rsc if netloc.endswith("svn.python.org"):
781 14c54eff 2009-07-16 rsc if netloc == "svn.python.org":
782 14c54eff 2009-07-16 rsc if path.startswith("/projects/"):
783 14c54eff 2009-07-16 rsc path = path[9:]
784 14c54eff 2009-07-16 rsc elif netloc != "pythondev@svn.python.org":
785 14c54eff 2009-07-16 rsc ErrorExit("Unrecognized Python URL: %s" % url)
786 14c54eff 2009-07-16 rsc base = "http://svn.python.org/view/*checkout*%s/" % path
787 14c54eff 2009-07-16 rsc logging.info("Guessed Python base = %s", base)
788 14c54eff 2009-07-16 rsc elif netloc.endswith("svn.collab.net"):
789 14c54eff 2009-07-16 rsc if path.startswith("/repos/"):
790 14c54eff 2009-07-16 rsc path = path[6:]
791 14c54eff 2009-07-16 rsc base = "http://svn.collab.net/viewvc/*checkout*%s/" % path
792 14c54eff 2009-07-16 rsc logging.info("Guessed CollabNet base = %s", base)
793 14c54eff 2009-07-16 rsc elif netloc.endswith(".googlecode.com"):
794 14c54eff 2009-07-16 rsc path = path + "/"
795 14c54eff 2009-07-16 rsc base = urlparse.urlunparse(("http", netloc, path, params,
796 14c54eff 2009-07-16 rsc query, fragment))
797 14c54eff 2009-07-16 rsc logging.info("Guessed Google Code base = %s", base)
799 14c54eff 2009-07-16 rsc path = path + "/"
800 14c54eff 2009-07-16 rsc base = urlparse.urlunparse((scheme, netloc, path, params,
801 14c54eff 2009-07-16 rsc query, fragment))
802 14c54eff 2009-07-16 rsc logging.info("Guessed base = %s", base)
804 14c54eff 2009-07-16 rsc if required:
805 14c54eff 2009-07-16 rsc ErrorExit("Can't find URL in output from svn info")
808 14c54eff 2009-07-16 rsc def GenerateDiff(self, args):
809 14c54eff 2009-07-16 rsc cmd = ["svn", "diff"]
810 14c54eff 2009-07-16 rsc if self.options.revision:
811 14c54eff 2009-07-16 rsc cmd += ["-r", self.options.revision]
812 14c54eff 2009-07-16 rsc cmd.extend(args)
813 14c54eff 2009-07-16 rsc data = RunShell(cmd)
815 14c54eff 2009-07-16 rsc for line in data.splitlines():
816 14c54eff 2009-07-16 rsc if line.startswith("Index:") or line.startswith("Property changes on:"):
818 14c54eff 2009-07-16 rsc logging.info(line)
819 14c54eff 2009-07-16 rsc if not count:
820 14c54eff 2009-07-16 rsc ErrorExit("No valid patches found in output from svn diff")
823 14c54eff 2009-07-16 rsc def _CollapseKeywords(self, content, keyword_str):
824 14c54eff 2009-07-16 rsc """Collapses SVN keywords."""
825 14c54eff 2009-07-16 rsc # svn cat translates keywords but svn diff doesn't. As a result of this
826 14c54eff 2009-07-16 rsc # behavior patching.PatchChunks() fails with a chunk mismatch error.
827 14c54eff 2009-07-16 rsc # This part was originally written by the Review Board development team
828 14c54eff 2009-07-16 rsc # who had the same problem (http://reviews.review-board.org/r/276/).
829 14c54eff 2009-07-16 rsc # Mapping of keywords to known aliases
830 14c54eff 2009-07-16 rsc svn_keywords = {
831 14c54eff 2009-07-16 rsc # Standard keywords
832 14c54eff 2009-07-16 rsc 'Date': ['Date', 'LastChangedDate'],
833 14c54eff 2009-07-16 rsc 'Revision': ['Revision', 'LastChangedRevision', 'Rev'],
834 14c54eff 2009-07-16 rsc 'Author': ['Author', 'LastChangedBy'],
835 14c54eff 2009-07-16 rsc 'HeadURL': ['HeadURL', 'URL'],
836 14c54eff 2009-07-16 rsc 'Id': ['Id'],
839 14c54eff 2009-07-16 rsc 'LastChangedDate': ['LastChangedDate', 'Date'],
840 14c54eff 2009-07-16 rsc 'LastChangedRevision': ['LastChangedRevision', 'Rev', 'Revision'],
841 14c54eff 2009-07-16 rsc 'LastChangedBy': ['LastChangedBy', 'Author'],
842 14c54eff 2009-07-16 rsc 'URL': ['URL', 'HeadURL'],
845 14c54eff 2009-07-16 rsc def repl(m):
846 14c54eff 2009-07-16 rsc if m.group(2):
847 14c54eff 2009-07-16 rsc return "$%s::%s$" % (m.group(1), " " * len(m.group(3)))
848 14c54eff 2009-07-16 rsc return "$%s$" % m.group(1)
849 14c54eff 2009-07-16 rsc keywords = [keyword
850 14c54eff 2009-07-16 rsc for name in keyword_str.split(" ")
851 14c54eff 2009-07-16 rsc for keyword in svn_keywords.get(name, [])]
852 14c54eff 2009-07-16 rsc return re.sub(r"\$(%s):(:?)([^\$]+)\$" % '|'.join(keywords), repl, content)
854 14c54eff 2009-07-16 rsc def GetUnknownFiles(self):
855 14c54eff 2009-07-16 rsc status = RunShell(["svn", "status", "--ignore-externals"], silent_ok=True)
856 14c54eff 2009-07-16 rsc unknown_files = []
857 14c54eff 2009-07-16 rsc for line in status.split("\n"):
858 14c54eff 2009-07-16 rsc if line and line[0] == "?":
859 14c54eff 2009-07-16 rsc unknown_files.append(line)
860 14c54eff 2009-07-16 rsc return unknown_files
862 14c54eff 2009-07-16 rsc def ReadFile(self, filename):
863 14c54eff 2009-07-16 rsc """Returns the contents of a file."""
864 14c54eff 2009-07-16 rsc file = open(filename, 'rb')
867 14c54eff 2009-07-16 rsc result = file.read()
869 14c54eff 2009-07-16 rsc file.close()
870 14c54eff 2009-07-16 rsc return result
872 14c54eff 2009-07-16 rsc def GetStatus(self, filename):
873 14c54eff 2009-07-16 rsc """Returns the status of a file."""
874 14c54eff 2009-07-16 rsc if not self.options.revision:
875 14c54eff 2009-07-16 rsc status = RunShell(["svn", "status", "--ignore-externals", filename])
876 14c54eff 2009-07-16 rsc if not status:
877 14c54eff 2009-07-16 rsc ErrorExit("svn status returned no output for %s" % filename)
878 14c54eff 2009-07-16 rsc status_lines = status.splitlines()
879 14c54eff 2009-07-16 rsc # If file is in a cl, the output will begin with
880 14c54eff 2009-07-16 rsc # "\n--- Changelist 'cl_name':\n". See
881 14c54eff 2009-07-16 rsc # http://svn.collab.net/repos/svn/trunk/notes/changelist-design.txt
882 14c54eff 2009-07-16 rsc if (len(status_lines) == 3 and
883 14c54eff 2009-07-16 rsc not status_lines[0] and
884 14c54eff 2009-07-16 rsc status_lines[1].startswith("--- Changelist")):
885 14c54eff 2009-07-16 rsc status = status_lines[2]
887 14c54eff 2009-07-16 rsc status = status_lines[0]
888 14c54eff 2009-07-16 rsc # If we have a revision to diff against we need to run "svn list"
889 14c54eff 2009-07-16 rsc # for the old and the new revision and compare the results to get
890 14c54eff 2009-07-16 rsc # the correct status for a file.
892 14c54eff 2009-07-16 rsc dirname, relfilename = os.path.split(filename)
893 14c54eff 2009-07-16 rsc if dirname not in self.svnls_cache:
894 14c54eff 2009-07-16 rsc cmd = ["svn", "list", "-r", self.rev_start, dirname or "."]
895 14c54eff 2009-07-16 rsc out, returncode = RunShellWithReturnCode(cmd)
896 14c54eff 2009-07-16 rsc if returncode:
897 14c54eff 2009-07-16 rsc ErrorExit("Failed to get status for %s." % filename)
898 14c54eff 2009-07-16 rsc old_files = out.splitlines()
899 14c54eff 2009-07-16 rsc args = ["svn", "list"]
900 14c54eff 2009-07-16 rsc if self.rev_end:
901 14c54eff 2009-07-16 rsc args += ["-r", self.rev_end]
902 14c54eff 2009-07-16 rsc cmd = args + [dirname or "."]
903 14c54eff 2009-07-16 rsc out, returncode = RunShellWithReturnCode(cmd)
904 14c54eff 2009-07-16 rsc if returncode:
905 14c54eff 2009-07-16 rsc ErrorExit("Failed to run command %s" % cmd)
906 14c54eff 2009-07-16 rsc self.svnls_cache[dirname] = (old_files, out.splitlines())
907 14c54eff 2009-07-16 rsc old_files, new_files = self.svnls_cache[dirname]
908 14c54eff 2009-07-16 rsc if relfilename in old_files and relfilename not in new_files:
909 14c54eff 2009-07-16 rsc status = "D "
910 14c54eff 2009-07-16 rsc elif relfilename in old_files and relfilename in new_files:
911 14c54eff 2009-07-16 rsc status = "M "
913 14c54eff 2009-07-16 rsc status = "A "
914 14c54eff 2009-07-16 rsc return status
916 14c54eff 2009-07-16 rsc def GetBaseFile(self, filename):
917 14c54eff 2009-07-16 rsc status = self.GetStatus(filename)
918 14c54eff 2009-07-16 rsc base_content = None
919 14c54eff 2009-07-16 rsc new_content = None
921 14c54eff 2009-07-16 rsc # If a file is copied its status will be "A +", which signifies
922 14c54eff 2009-07-16 rsc # "addition-with-history". See "svn st" for more information. We need to
923 14c54eff 2009-07-16 rsc # upload the original file or else diff parsing will fail if the file was
925 14c54eff 2009-07-16 rsc if status[0] == "A" and status[3] != "+":
926 14c54eff 2009-07-16 rsc # We'll need to upload the new content if we're adding a binary file
927 14c54eff 2009-07-16 rsc # since diff's output won't contain it.
928 14c54eff 2009-07-16 rsc mimetype = RunShell(["svn", "propget", "svn:mime-type", filename],
929 14c54eff 2009-07-16 rsc silent_ok=True)
930 14c54eff 2009-07-16 rsc base_content = ""
931 14c54eff 2009-07-16 rsc is_binary = bool(mimetype) and not mimetype.startswith("text/")
932 14c54eff 2009-07-16 rsc if is_binary and self.IsImage(filename):
933 14c54eff 2009-07-16 rsc new_content = self.ReadFile(filename)
934 14c54eff 2009-07-16 rsc elif (status[0] in ("M", "D", "R") or
935 14c54eff 2009-07-16 rsc (status[0] == "A" and status[3] == "+") or # Copied file.
936 14c54eff 2009-07-16 rsc (status[0] == " " and status[1] == "M")): # Property change.
938 14c54eff 2009-07-16 rsc if self.options.revision:
939 14c54eff 2009-07-16 rsc url = "%s/%s@%s" % (self.svn_base, filename, self.rev_start)
941 14c54eff 2009-07-16 rsc # Don't change filename, it's needed later.
942 14c54eff 2009-07-16 rsc url = filename
943 14c54eff 2009-07-16 rsc args += ["-r", "BASE"]
944 14c54eff 2009-07-16 rsc cmd = ["svn"] + args + ["propget", "svn:mime-type", url]
945 14c54eff 2009-07-16 rsc mimetype, returncode = RunShellWithReturnCode(cmd)
946 14c54eff 2009-07-16 rsc if returncode:
947 14c54eff 2009-07-16 rsc # File does not exist in the requested revision.
948 14c54eff 2009-07-16 rsc # Reset mimetype, it contains an error message.
949 14c54eff 2009-07-16 rsc mimetype = ""
950 14c54eff 2009-07-16 rsc get_base = False
951 14c54eff 2009-07-16 rsc is_binary = bool(mimetype) and not mimetype.startswith("text/")
952 14c54eff 2009-07-16 rsc if status[0] == " ":
953 14c54eff 2009-07-16 rsc # Empty base content just to force an upload.
954 14c54eff 2009-07-16 rsc base_content = ""
955 14c54eff 2009-07-16 rsc elif is_binary:
956 14c54eff 2009-07-16 rsc if self.IsImage(filename):
957 14c54eff 2009-07-16 rsc get_base = True
958 14c54eff 2009-07-16 rsc if status[0] == "M":
959 14c54eff 2009-07-16 rsc if not self.rev_end:
960 14c54eff 2009-07-16 rsc new_content = self.ReadFile(filename)
962 14c54eff 2009-07-16 rsc url = "%s/%s@%s" % (self.svn_base, filename, self.rev_end)
963 14c54eff 2009-07-16 rsc new_content = RunShell(["svn", "cat", url],
964 14c54eff 2009-07-16 rsc universal_newlines=True, silent_ok=True)
966 14c54eff 2009-07-16 rsc base_content = ""
968 14c54eff 2009-07-16 rsc get_base = True
970 14c54eff 2009-07-16 rsc if get_base:
971 14c54eff 2009-07-16 rsc if is_binary:
972 14c54eff 2009-07-16 rsc universal_newlines = False
974 14c54eff 2009-07-16 rsc universal_newlines = True
975 14c54eff 2009-07-16 rsc if self.rev_start:
976 14c54eff 2009-07-16 rsc # "svn cat -r REV delete_file.txt" doesn't work. cat requires
977 14c54eff 2009-07-16 rsc # the full URL with "@REV" appended instead of using "-r" option.
978 14c54eff 2009-07-16 rsc url = "%s/%s@%s" % (self.svn_base, filename, self.rev_start)
979 14c54eff 2009-07-16 rsc base_content = RunShell(["svn", "cat", url],
980 14c54eff 2009-07-16 rsc universal_newlines=universal_newlines,
981 14c54eff 2009-07-16 rsc silent_ok=True)
983 14c54eff 2009-07-16 rsc base_content = RunShell(["svn", "cat", filename],
984 14c54eff 2009-07-16 rsc universal_newlines=universal_newlines,
985 14c54eff 2009-07-16 rsc silent_ok=True)
986 14c54eff 2009-07-16 rsc if not is_binary:
988 14c54eff 2009-07-16 rsc if self.rev_start:
989 14c54eff 2009-07-16 rsc url = "%s/%s@%s" % (self.svn_base, filename, self.rev_start)
991 14c54eff 2009-07-16 rsc url = filename
992 14c54eff 2009-07-16 rsc args += ["-r", "BASE"]
993 14c54eff 2009-07-16 rsc cmd = ["svn"] + args + ["propget", "svn:keywords", url]
994 14c54eff 2009-07-16 rsc keywords, returncode = RunShellWithReturnCode(cmd)
995 14c54eff 2009-07-16 rsc if keywords and not returncode:
996 14c54eff 2009-07-16 rsc base_content = self._CollapseKeywords(base_content, keywords)
998 14c54eff 2009-07-16 rsc StatusUpdate("svn status returned unexpected output: %s" % status)
1000 14c54eff 2009-07-16 rsc return base_content, new_content, is_binary, status[0:5]
1003 14c54eff 2009-07-16 rsc class GitVCS(VersionControlSystem):
1004 14c54eff 2009-07-16 rsc """Implementation of the VersionControlSystem interface for Git."""
1006 14c54eff 2009-07-16 rsc NULL_HASH = "0"*40
1008 14c54eff 2009-07-16 rsc def __init__(self, options):
1009 14c54eff 2009-07-16 rsc super(GitVCS, self).__init__(options)
1010 14c54eff 2009-07-16 rsc # Map of filename -> (hash before, hash after) of base file.
1011 14c54eff 2009-07-16 rsc self.base_hashes = {}
1013 14c54eff 2009-07-16 rsc def GenerateDiff(self, extra_args):
1014 14c54eff 2009-07-16 rsc # This is more complicated than svn's GenerateDiff because we must convert
1015 14c54eff 2009-07-16 rsc # the diff output to include an svn-style "Index:" line as well as record
1016 14c54eff 2009-07-16 rsc # the hashes of the base files, so we can upload them along with our diff.
1017 14c54eff 2009-07-16 rsc if self.options.revision:
1018 14c54eff 2009-07-16 rsc extra_args = [self.options.revision] + extra_args
1019 14c54eff 2009-07-16 rsc gitdiff = RunShell(["git", "diff", "--full-index"] + extra_args)
1020 14c54eff 2009-07-16 rsc svndiff = []
1021 14c54eff 2009-07-16 rsc filecount = 0
1022 14c54eff 2009-07-16 rsc filename = None
1023 14c54eff 2009-07-16 rsc for line in gitdiff.splitlines():
1024 14c54eff 2009-07-16 rsc match = re.match(r"diff --git a/(.*) b/.*$", line)
1026 14c54eff 2009-07-16 rsc filecount += 1
1027 14c54eff 2009-07-16 rsc filename = match.group(1)
1028 14c54eff 2009-07-16 rsc svndiff.append("Index: %s\n" % filename)
1030 14c54eff 2009-07-16 rsc # The "index" line in a git diff looks like this (long hashes elided):
1031 14c54eff 2009-07-16 rsc # index 82c0d44..b2cee3f 100755
1032 14c54eff 2009-07-16 rsc # We want to save the left hash, as that identifies the base file.
1033 14c54eff 2009-07-16 rsc match = re.match(r"index (\w+)\.\.(\w+)", line)
1035 14c54eff 2009-07-16 rsc self.base_hashes[filename] = (match.group(1), match.group(2))
1036 14c54eff 2009-07-16 rsc svndiff.append(line + "\n")
1037 14c54eff 2009-07-16 rsc if not filecount:
1038 14c54eff 2009-07-16 rsc ErrorExit("No valid patches found in output from git diff")
1039 14c54eff 2009-07-16 rsc return "".join(svndiff)
1041 14c54eff 2009-07-16 rsc def GetUnknownFiles(self):
1042 14c54eff 2009-07-16 rsc status = RunShell(["git", "ls-files", "--exclude-standard", "--others"],
1043 14c54eff 2009-07-16 rsc silent_ok=True)
1044 14c54eff 2009-07-16 rsc return status.splitlines()
1046 14c54eff 2009-07-16 rsc def GetFileContent(self, file_hash, is_binary):
1047 14c54eff 2009-07-16 rsc """Returns the content of a file identified by its git hash."""
1048 14c54eff 2009-07-16 rsc data, retcode = RunShellWithReturnCode(["git", "show", file_hash],
1049 14c54eff 2009-07-16 rsc universal_newlines=not is_binary)
1050 14c54eff 2009-07-16 rsc if retcode:
1051 14c54eff 2009-07-16 rsc ErrorExit("Got error status from 'git show %s'" % file_hash)
1052 14c54eff 2009-07-16 rsc return data
1054 14c54eff 2009-07-16 rsc def GetBaseFile(self, filename):
1055 14c54eff 2009-07-16 rsc hash_before, hash_after = self.base_hashes[filename]
1056 14c54eff 2009-07-16 rsc base_content = None
1057 14c54eff 2009-07-16 rsc new_content = None
1058 14c54eff 2009-07-16 rsc is_binary = self.IsBinary(filename)
1060 14c54eff 2009-07-16 rsc if hash_before == self.NULL_HASH: # All-zero hash indicates no base file.
1061 14c54eff 2009-07-16 rsc status = "A"
1062 14c54eff 2009-07-16 rsc base_content = ""
1064 14c54eff 2009-07-16 rsc status = "M"
1065 14c54eff 2009-07-16 rsc if not is_binary or self.IsImage(filename):
1066 14c54eff 2009-07-16 rsc base_content = self.GetFileContent(hash_before, is_binary)
1068 14c54eff 2009-07-16 rsc if is_binary and self.IsImage(filename) and not hash_after == "0" * 40:
1069 14c54eff 2009-07-16 rsc new_content = self.GetFileContent(hash_after, is_binary)
1071 14c54eff 2009-07-16 rsc if hash_after == self.NULL_HASH:
1072 14c54eff 2009-07-16 rsc status = "D"
1073 14c54eff 2009-07-16 rsc return (base_content, new_content, is_binary, status)
1076 14c54eff 2009-07-16 rsc class MercurialVCS(VersionControlSystem):
1077 14c54eff 2009-07-16 rsc """Implementation of the VersionControlSystem interface for Mercurial."""
1079 14c54eff 2009-07-16 rsc def __init__(self, options, repo_dir):
1080 14c54eff 2009-07-16 rsc super(MercurialVCS, self).__init__(options)
1081 14c54eff 2009-07-16 rsc # Absolute path to repository (we can be in a subdir)
1082 14c54eff 2009-07-16 rsc self.repo_dir = os.path.normpath(repo_dir)
1083 14c54eff 2009-07-16 rsc # Compute the subdir
1084 14c54eff 2009-07-16 rsc cwd = os.path.normpath(os.getcwd())
1085 14c54eff 2009-07-16 rsc assert cwd.startswith(self.repo_dir)
1086 14c54eff 2009-07-16 rsc self.subdir = cwd[len(self.repo_dir):].lstrip(r"\/")
1087 14c54eff 2009-07-16 rsc if self.options.revision:
1088 14c54eff 2009-07-16 rsc self.base_rev = self.options.revision
1090 14c54eff 2009-07-16 rsc self.base_rev = RunShell(["hg", "parent", "-q"]).split(':')[1].strip()
1092 14c54eff 2009-07-16 rsc def _GetRelPath(self, filename):
1093 14c54eff 2009-07-16 rsc """Get relative path of a file according to the current directory,
1094 14c54eff 2009-07-16 rsc given its logical path in the repo."""
1095 14c54eff 2009-07-16 rsc assert filename.startswith(self.subdir), filename
1096 14c54eff 2009-07-16 rsc return filename[len(self.subdir):].lstrip(r"\/")
1098 14c54eff 2009-07-16 rsc def GenerateDiff(self, extra_args):
1099 14c54eff 2009-07-16 rsc # If no file specified, restrict to the current subdir
1100 14c54eff 2009-07-16 rsc extra_args = extra_args or ["."]
1101 14c54eff 2009-07-16 rsc cmd = ["hg", "diff", "--git", "-r", self.base_rev] + extra_args
1102 14c54eff 2009-07-16 rsc data = RunShell(cmd, silent_ok=True)
1103 14c54eff 2009-07-16 rsc svndiff = []
1104 14c54eff 2009-07-16 rsc filecount = 0
1105 14c54eff 2009-07-16 rsc for line in data.splitlines():
1106 14c54eff 2009-07-16 rsc m = re.match("diff --git a/(\S+) b/(\S+)", line)
1108 14c54eff 2009-07-16 rsc # Modify line to make it look like as it comes from svn diff.
1109 14c54eff 2009-07-16 rsc # With this modification no changes on the server side are required
1110 14c54eff 2009-07-16 rsc # to make upload.py work with Mercurial repos.
1111 14c54eff 2009-07-16 rsc # NOTE: for proper handling of moved/copied files, we have to use
1112 14c54eff 2009-07-16 rsc # the second filename.
1113 14c54eff 2009-07-16 rsc filename = m.group(2)
1114 14c54eff 2009-07-16 rsc svndiff.append("Index: %s" % filename)
1115 14c54eff 2009-07-16 rsc svndiff.append("=" * 67)
1116 14c54eff 2009-07-16 rsc filecount += 1
1117 14c54eff 2009-07-16 rsc logging.info(line)
1119 14c54eff 2009-07-16 rsc svndiff.append(line)
1120 14c54eff 2009-07-16 rsc if not filecount:
1121 14c54eff 2009-07-16 rsc ErrorExit("No valid patches found in output from hg diff")
1122 14c54eff 2009-07-16 rsc return "\n".join(svndiff) + "\n"
1124 14c54eff 2009-07-16 rsc def GetUnknownFiles(self):
1125 14c54eff 2009-07-16 rsc """Return a list of files unknown to the VCS."""
1127 14c54eff 2009-07-16 rsc status = RunShell(["hg", "status", "--rev", self.base_rev, "-u", "."],
1128 14c54eff 2009-07-16 rsc silent_ok=True)
1129 14c54eff 2009-07-16 rsc unknown_files = []
1130 14c54eff 2009-07-16 rsc for line in status.splitlines():
1131 14c54eff 2009-07-16 rsc st, fn = line.split(" ", 1)
1132 14c54eff 2009-07-16 rsc if st == "?":
1133 14c54eff 2009-07-16 rsc unknown_files.append(fn)
1134 14c54eff 2009-07-16 rsc return unknown_files
1136 14c54eff 2009-07-16 rsc def GetBaseFile(self, filename):
1137 14c54eff 2009-07-16 rsc # "hg status" and "hg cat" both take a path relative to the current subdir
1138 14c54eff 2009-07-16 rsc # rather than to the repo root, but "hg diff" has given us the full path
1139 14c54eff 2009-07-16 rsc # to the repo root.
1140 14c54eff 2009-07-16 rsc base_content = ""
1141 14c54eff 2009-07-16 rsc new_content = None
1142 14c54eff 2009-07-16 rsc is_binary = False
1143 14c54eff 2009-07-16 rsc oldrelpath = relpath = self._GetRelPath(filename)
1144 14c54eff 2009-07-16 rsc # "hg status -C" returns two lines for moved/copied files, one otherwise
1145 14c54eff 2009-07-16 rsc out = RunShell(["hg", "status", "-C", "--rev", self.base_rev, relpath])
1146 14c54eff 2009-07-16 rsc out = out.splitlines()
1147 14c54eff 2009-07-16 rsc # HACK: strip error message about missing file/directory if it isn't in
1148 14c54eff 2009-07-16 rsc # the working copy
1149 14c54eff 2009-07-16 rsc if out[0].startswith('%s: ' % relpath):
1150 14c54eff 2009-07-16 rsc out = out[1:]
1151 14c54eff 2009-07-16 rsc if len(out) > 1:
1152 14c54eff 2009-07-16 rsc # Moved/copied => considered as modified, use old filename to
1153 14c54eff 2009-07-16 rsc # retrieve base contents
1154 14c54eff 2009-07-16 rsc oldrelpath = out[1].strip()
1155 14c54eff 2009-07-16 rsc status = "M"
1157 14c54eff 2009-07-16 rsc status, _ = out[0].split(' ', 1)
1158 14c54eff 2009-07-16 rsc if ":" in self.base_rev:
1159 14c54eff 2009-07-16 rsc base_rev = self.base_rev.split(":", 1)[0]
1161 14c54eff 2009-07-16 rsc base_rev = self.base_rev
1162 14c54eff 2009-07-16 rsc if status != "A":
1163 14c54eff 2009-07-16 rsc base_content = RunShell(["hg", "cat", "-r", base_rev, oldrelpath],
1164 14c54eff 2009-07-16 rsc silent_ok=True)
1165 14c54eff 2009-07-16 rsc is_binary = "\0" in base_content # Mercurial's heuristic
1166 14c54eff 2009-07-16 rsc if status != "R":
1167 14c54eff 2009-07-16 rsc new_content = open(relpath, "rb").read()
1168 14c54eff 2009-07-16 rsc is_binary = is_binary or "\0" in new_content
1169 14c54eff 2009-07-16 rsc if is_binary and base_content:
1170 14c54eff 2009-07-16 rsc # Fetch again without converting newlines
1171 14c54eff 2009-07-16 rsc base_content = RunShell(["hg", "cat", "-r", base_rev, oldrelpath],
1172 14c54eff 2009-07-16 rsc silent_ok=True, universal_newlines=False)
1173 14c54eff 2009-07-16 rsc if not is_binary or not self.IsImage(relpath):
1174 14c54eff 2009-07-16 rsc new_content = None
1175 14c54eff 2009-07-16 rsc return base_content, new_content, is_binary, status
1178 14c54eff 2009-07-16 rsc # NOTE: The SplitPatch function is duplicated in engine.py, keep them in sync.
1179 14c54eff 2009-07-16 rsc def SplitPatch(data):
1180 14c54eff 2009-07-16 rsc """Splits a patch into separate pieces for each file.
1183 14c54eff 2009-07-16 rsc data: A string containing the output of svn diff.
1186 14c54eff 2009-07-16 rsc A list of 2-tuple (filename, text) where text is the svn diff output
1187 14c54eff 2009-07-16 rsc pertaining to filename.
1189 14c54eff 2009-07-16 rsc patches = []
1190 14c54eff 2009-07-16 rsc filename = None
1192 14c54eff 2009-07-16 rsc for line in data.splitlines(True):
1193 14c54eff 2009-07-16 rsc new_filename = None
1194 14c54eff 2009-07-16 rsc if line.startswith('Index:'):
1195 14c54eff 2009-07-16 rsc unused, new_filename = line.split(':', 1)
1196 14c54eff 2009-07-16 rsc new_filename = new_filename.strip()
1197 14c54eff 2009-07-16 rsc elif line.startswith('Property changes on:'):
1198 14c54eff 2009-07-16 rsc unused, temp_filename = line.split(':', 1)
1199 14c54eff 2009-07-16 rsc # When a file is modified, paths use '/' between directories, however
1200 14c54eff 2009-07-16 rsc # when a property is modified '\' is used on Windows. Make them the same
1201 14c54eff 2009-07-16 rsc # otherwise the file shows up twice.
1202 14c54eff 2009-07-16 rsc temp_filename = temp_filename.strip().replace('\\', '/')
1203 14c54eff 2009-07-16 rsc if temp_filename != filename:
1204 14c54eff 2009-07-16 rsc # File has property changes but no modifications, create a new diff.
1205 14c54eff 2009-07-16 rsc new_filename = temp_filename
1206 14c54eff 2009-07-16 rsc if new_filename:
1207 14c54eff 2009-07-16 rsc if filename and diff:
1208 14c54eff 2009-07-16 rsc patches.append((filename, ''.join(diff)))
1209 14c54eff 2009-07-16 rsc filename = new_filename
1210 14c54eff 2009-07-16 rsc diff = [line]
1212 14c54eff 2009-07-16 rsc if diff is not None:
1213 14c54eff 2009-07-16 rsc diff.append(line)
1214 14c54eff 2009-07-16 rsc if filename and diff:
1215 14c54eff 2009-07-16 rsc patches.append((filename, ''.join(diff)))
1216 14c54eff 2009-07-16 rsc return patches
1219 14c54eff 2009-07-16 rsc def UploadSeparatePatches(issue, rpc_server, patchset, data, options):
1220 14c54eff 2009-07-16 rsc """Uploads a separate patch for each file in the diff output.
1222 14c54eff 2009-07-16 rsc Returns a list of [patch_key, filename] for each file.
1224 14c54eff 2009-07-16 rsc patches = SplitPatch(data)
1226 14c54eff 2009-07-16 rsc for patch in patches:
1227 14c54eff 2009-07-16 rsc if len(patch[1]) > MAX_UPLOAD_SIZE:
1228 14c54eff 2009-07-16 rsc print ("Not uploading the patch for " + patch[0] +
1229 14c54eff 2009-07-16 rsc " because the file is too large.")
1231 14c54eff 2009-07-16 rsc form_fields = [("filename", patch[0])]
1232 14c54eff 2009-07-16 rsc if not options.download_base:
1233 14c54eff 2009-07-16 rsc form_fields.append(("content_upload", "1"))
1234 14c54eff 2009-07-16 rsc files = [("data", "data.diff", patch[1])]
1235 14c54eff 2009-07-16 rsc ctype, body = EncodeMultipartFormData(form_fields, files)
1236 14c54eff 2009-07-16 rsc url = "/%d/upload_patch/%d" % (int(issue), int(patchset))
1237 14c54eff 2009-07-16 rsc print "Uploading patch for " + patch[0]
1238 14c54eff 2009-07-16 rsc response_body = rpc_server.Send(url, body, content_type=ctype)
1239 14c54eff 2009-07-16 rsc lines = response_body.splitlines()
1240 14c54eff 2009-07-16 rsc if not lines or lines[0] != "OK":
1241 14c54eff 2009-07-16 rsc StatusUpdate(" --> %s" % response_body)
1242 14c54eff 2009-07-16 rsc sys.exit(1)
1243 14c54eff 2009-07-16 rsc rv.append([lines[1], patch[0]])
1247 14c54eff 2009-07-16 rsc def GuessVCSName():
1248 14c54eff 2009-07-16 rsc """Helper to guess the version control system.
1250 14c54eff 2009-07-16 rsc This examines the current directory, guesses which VersionControlSystem
1251 14c54eff 2009-07-16 rsc we're using, and returns an string indicating which VCS is detected.
1254 14c54eff 2009-07-16 rsc A pair (vcs, output). vcs is a string indicating which VCS was detected
1255 14c54eff 2009-07-16 rsc and is one of VCS_GIT, VCS_MERCURIAL, VCS_SUBVERSION, or VCS_UNKNOWN.
1256 14c54eff 2009-07-16 rsc output is a string containing any interesting output from the vcs
1257 14c54eff 2009-07-16 rsc detection routine, or None if there is nothing interesting.
1259 14c54eff 2009-07-16 rsc # Mercurial has a command to get the base directory of a repository
1260 14c54eff 2009-07-16 rsc # Try running it, but don't die if we don't have hg installed.
1261 14c54eff 2009-07-16 rsc # NOTE: we try Mercurial first as it can sit on top of an SVN working copy.
1263 14c54eff 2009-07-16 rsc out, returncode = RunShellWithReturnCode(["hg", "root"])
1264 14c54eff 2009-07-16 rsc if returncode == 0:
1265 14c54eff 2009-07-16 rsc return (VCS_MERCURIAL, out.strip())
1266 14c54eff 2009-07-16 rsc except OSError, (errno, message):
1267 14c54eff 2009-07-16 rsc if errno != 2: # ENOENT -- they don't have hg installed.
1270 14c54eff 2009-07-16 rsc # Subversion has a .svn in all working directories.
1271 14c54eff 2009-07-16 rsc if os.path.isdir('.svn'):
1272 14c54eff 2009-07-16 rsc logging.info("Guessed VCS = Subversion")
1273 14c54eff 2009-07-16 rsc return (VCS_SUBVERSION, None)
1275 14c54eff 2009-07-16 rsc # Git has a command to test if you're in a git tree.
1276 14c54eff 2009-07-16 rsc # Try running it, but don't die if we don't have git installed.
1278 14c54eff 2009-07-16 rsc out, returncode = RunShellWithReturnCode(["git", "rev-parse",
1279 14c54eff 2009-07-16 rsc "--is-inside-work-tree"])
1280 14c54eff 2009-07-16 rsc if returncode == 0:
1281 14c54eff 2009-07-16 rsc return (VCS_GIT, None)
1282 14c54eff 2009-07-16 rsc except OSError, (errno, message):
1283 14c54eff 2009-07-16 rsc if errno != 2: # ENOENT -- they don't have git installed.
1286 14c54eff 2009-07-16 rsc return (VCS_UNKNOWN, None)
1289 14c54eff 2009-07-16 rsc def GuessVCS(options):
1290 14c54eff 2009-07-16 rsc """Helper to guess the version control system.
1292 14c54eff 2009-07-16 rsc This examines the current directory, guesses which VersionControlSystem
1293 14c54eff 2009-07-16 rsc we're using, and returns an instance of the appropriate class. Exit with an
1294 14c54eff 2009-07-16 rsc error if we can't figure it out.
1297 14c54eff 2009-07-16 rsc A VersionControlSystem instance. Exits if the VCS can't be guessed.
1299 14c54eff 2009-07-16 rsc (vcs, extra_output) = GuessVCSName()
1300 14c54eff 2009-07-16 rsc if vcs == VCS_MERCURIAL:
1301 14c54eff 2009-07-16 rsc return MercurialVCS(options, extra_output)
1302 14c54eff 2009-07-16 rsc elif vcs == VCS_SUBVERSION:
1303 14c54eff 2009-07-16 rsc return SubversionVCS(options)
1304 14c54eff 2009-07-16 rsc elif vcs == VCS_GIT:
1305 14c54eff 2009-07-16 rsc return GitVCS(options)
1307 14c54eff 2009-07-16 rsc ErrorExit(("Could not guess version control system. "
1308 14c54eff 2009-07-16 rsc "Are you in a working copy directory?"))
1311 14c54eff 2009-07-16 rsc def RealMain(argv, data=None):
1312 14c54eff 2009-07-16 rsc """The real main function.
1315 14c54eff 2009-07-16 rsc argv: Command line arguments.
1316 14c54eff 2009-07-16 rsc data: Diff contents. If None (default) the diff is generated by
1317 14c54eff 2009-07-16 rsc the VersionControlSystem implementation returned by GuessVCS().
1320 14c54eff 2009-07-16 rsc A 2-tuple (issue id, patchset id).
1321 14c54eff 2009-07-16 rsc The patchset id is None if the base files are not uploaded by this
1322 14c54eff 2009-07-16 rsc script (applies only to SVN checkouts).
1324 14c54eff 2009-07-16 rsc logging.basicConfig(format=("%(asctime).19s %(levelname)s %(filename)s:"
1325 14c54eff 2009-07-16 rsc "%(lineno)s %(message)s "))
1326 14c54eff 2009-07-16 rsc os.environ['LC_ALL'] = 'C'
1327 14c54eff 2009-07-16 rsc options, args = parser.parse_args(argv[1:])
1328 14c54eff 2009-07-16 rsc global verbosity
1329 14c54eff 2009-07-16 rsc verbosity = options.verbose
1330 14c54eff 2009-07-16 rsc if verbosity >= 3:
1331 14c54eff 2009-07-16 rsc logging.getLogger().setLevel(logging.DEBUG)
1332 14c54eff 2009-07-16 rsc elif verbosity >= 2:
1333 14c54eff 2009-07-16 rsc logging.getLogger().setLevel(logging.INFO)
1334 14c54eff 2009-07-16 rsc vcs = GuessVCS(options)
1335 14c54eff 2009-07-16 rsc if isinstance(vcs, SubversionVCS):
1336 14c54eff 2009-07-16 rsc # base field is only allowed for Subversion.
1337 14c54eff 2009-07-16 rsc # Note: Fetching base files may become deprecated in future releases.
1338 14c54eff 2009-07-16 rsc base = vcs.GuessBase(options.download_base)
1340 14c54eff 2009-07-16 rsc base = None
1341 14c54eff 2009-07-16 rsc if not base and options.download_base:
1342 14c54eff 2009-07-16 rsc options.download_base = True
1343 14c54eff 2009-07-16 rsc logging.info("Enabled upload of base file")
1344 14c54eff 2009-07-16 rsc if not options.assume_yes:
1345 14c54eff 2009-07-16 rsc vcs.CheckForUnknownFiles()
1346 14c54eff 2009-07-16 rsc if data is None:
1347 14c54eff 2009-07-16 rsc data = vcs.GenerateDiff(args)
1348 14c54eff 2009-07-16 rsc files = vcs.GetBaseFiles(data)
1349 14c54eff 2009-07-16 rsc if verbosity >= 1:
1350 14c54eff 2009-07-16 rsc print "Upload server:", options.server, "(change with -s/--server)"
1351 14c54eff 2009-07-16 rsc if options.issue:
1352 14c54eff 2009-07-16 rsc prompt = "Message describing this patch set: "
1354 14c54eff 2009-07-16 rsc prompt = "New issue subject: "
1355 14c54eff 2009-07-16 rsc message = options.message or raw_input(prompt).strip()
1356 14c54eff 2009-07-16 rsc if not message:
1357 14c54eff 2009-07-16 rsc ErrorExit("A non-empty message is required")
1358 14c54eff 2009-07-16 rsc rpc_server = GetRpcServer(options)
1359 14c54eff 2009-07-16 rsc form_fields = [("subject", message)]
1361 14c54eff 2009-07-16 rsc form_fields.append(("base", base))
1362 14c54eff 2009-07-16 rsc if options.issue:
1363 14c54eff 2009-07-16 rsc form_fields.append(("issue", str(options.issue)))
1364 14c54eff 2009-07-16 rsc if options.email:
1365 14c54eff 2009-07-16 rsc form_fields.append(("user", options.email))
1366 14c54eff 2009-07-16 rsc if options.reviewers:
1367 14c54eff 2009-07-16 rsc for reviewer in options.reviewers.split(','):
1368 14c54eff 2009-07-16 rsc if "@" in reviewer and not reviewer.split("@")[1].count(".") == 1:
1369 14c54eff 2009-07-16 rsc ErrorExit("Invalid email address: %s" % reviewer)
1370 14c54eff 2009-07-16 rsc form_fields.append(("reviewers", options.reviewers))
1371 14c54eff 2009-07-16 rsc if options.cc:
1372 14c54eff 2009-07-16 rsc for cc in options.cc.split(','):
1373 14c54eff 2009-07-16 rsc if "@" in cc and not cc.split("@")[1].count(".") == 1:
1374 14c54eff 2009-07-16 rsc ErrorExit("Invalid email address: %s" % cc)
1375 14c54eff 2009-07-16 rsc form_fields.append(("cc", options.cc))
1376 14c54eff 2009-07-16 rsc description = options.description
1377 14c54eff 2009-07-16 rsc if options.description_file:
1378 14c54eff 2009-07-16 rsc if options.description:
1379 14c54eff 2009-07-16 rsc ErrorExit("Can't specify description and description_file")
1380 14c54eff 2009-07-16 rsc file = open(options.description_file, 'r')
1381 14c54eff 2009-07-16 rsc description = file.read()
1382 14c54eff 2009-07-16 rsc file.close()
1383 14c54eff 2009-07-16 rsc if description:
1384 14c54eff 2009-07-16 rsc form_fields.append(("description", description))
1385 14c54eff 2009-07-16 rsc # Send a hash of all the base file so the server can determine if a copy
1386 14c54eff 2009-07-16 rsc # already exists in an earlier patchset.
1387 14c54eff 2009-07-16 rsc base_hashes = ""
1388 14c54eff 2009-07-16 rsc for file, info in files.iteritems():
1389 14c54eff 2009-07-16 rsc if not info[0] is None:
1390 14c54eff 2009-07-16 rsc checksum = md5(info[0]).hexdigest()
1391 14c54eff 2009-07-16 rsc if base_hashes:
1392 14c54eff 2009-07-16 rsc base_hashes += "|"
1393 14c54eff 2009-07-16 rsc base_hashes += checksum + ":" + file
1394 14c54eff 2009-07-16 rsc form_fields.append(("base_hashes", base_hashes))
1395 14c54eff 2009-07-16 rsc # If we're uploading base files, don't send the email before the uploads, so
1396 14c54eff 2009-07-16 rsc # that it contains the file status.
1397 14c54eff 2009-07-16 rsc if options.send_mail and options.download_base:
1398 14c54eff 2009-07-16 rsc form_fields.append(("send_mail", "1"))
1399 14c54eff 2009-07-16 rsc if not options.download_base:
1400 14c54eff 2009-07-16 rsc form_fields.append(("content_upload", "1"))
1401 14c54eff 2009-07-16 rsc if len(data) > MAX_UPLOAD_SIZE:
1402 14c54eff 2009-07-16 rsc print "Patch is large, so uploading file patches separately."
1403 14c54eff 2009-07-16 rsc uploaded_diff_file = []
1404 14c54eff 2009-07-16 rsc form_fields.append(("separate_patches", "1"))
1406 14c54eff 2009-07-16 rsc uploaded_diff_file = [("data", "data.diff", data)]
1407 14c54eff 2009-07-16 rsc ctype, body = EncodeMultipartFormData(form_fields, uploaded_diff_file)
1408 14c54eff 2009-07-16 rsc response_body = rpc_server.Send("/upload", body, content_type=ctype)
1409 14c54eff 2009-07-16 rsc patchset = None
1410 14c54eff 2009-07-16 rsc if not options.download_base or not uploaded_diff_file:
1411 14c54eff 2009-07-16 rsc lines = response_body.splitlines()
1412 14c54eff 2009-07-16 rsc if len(lines) >= 2:
1413 14c54eff 2009-07-16 rsc msg = lines[0]
1414 14c54eff 2009-07-16 rsc patchset = lines[1].strip()
1415 14c54eff 2009-07-16 rsc patches = [x.split(" ", 1) for x in lines[2:]]
1417 14c54eff 2009-07-16 rsc msg = response_body
1419 14c54eff 2009-07-16 rsc msg = response_body
1420 14c54eff 2009-07-16 rsc StatusUpdate(msg)
1421 14c54eff 2009-07-16 rsc if not response_body.startswith("Issue created.") and \
1422 14c54eff 2009-07-16 rsc not response_body.startswith("Issue updated."):
1423 14c54eff 2009-07-16 rsc sys.exit(0)
1424 14c54eff 2009-07-16 rsc issue = msg[msg.rfind("/")+1:]
1426 14c54eff 2009-07-16 rsc if not uploaded_diff_file:
1427 14c54eff 2009-07-16 rsc result = UploadSeparatePatches(issue, rpc_server, patchset, data, options)
1428 14c54eff 2009-07-16 rsc if not options.download_base:
1429 14c54eff 2009-07-16 rsc patches = result
1431 14c54eff 2009-07-16 rsc if not options.download_base:
1432 14c54eff 2009-07-16 rsc vcs.UploadBaseFiles(issue, rpc_server, patches, patchset, options, files)
1433 14c54eff 2009-07-16 rsc if options.send_mail:
1434 14c54eff 2009-07-16 rsc rpc_server.Send("/" + issue + "/mail", payload="")
1435 14c54eff 2009-07-16 rsc return issue, patchset
1438 14c54eff 2009-07-16 rsc def main():
1440 14c54eff 2009-07-16 rsc RealMain(sys.argv)
1441 14c54eff 2009-07-16 rsc except KeyboardInterrupt:
1443 14c54eff 2009-07-16 rsc StatusUpdate("Interrupted.")
1444 14c54eff 2009-07-16 rsc sys.exit(1)
1447 14c54eff 2009-07-16 rsc if __name__ == "__main__":
