Deprecate gcl.GetSVNFileInfo() for gclient.CaptureSVNInfo().

gcl.py

 #!/usr/bin/python
 # Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 #
 # Wrapper script around Rietveld's upload.py that groups files into
 # changelists.
 
 import getpass
 import os
 import random
 import re
 import string
 import subprocess
 import sys
 import tempfile
 import upload
 import urllib2
 import xml.dom.minidom
 
+# gcl now depends on gclient.
+import gclient
 
 __version__ = '1.0'
 
 
 CODEREVIEW_SETTINGS = {
   # Default values.
   "CODE_REVIEW_SERVER": "codereview.chromium.org",
   "CC_LIST": "chromium-reviews@googlegroups.com",
   "VIEW_VC": "http://src.chromium.org/viewvc/chrome?view=rev&revision=",
 }
 
 # globals that store the root of the current repository and the directory where
 # we store information about changelists.
 repository_root = ""
 gcl_info_dir = ""
 
 # Filename where we store repository specific information for gcl.
 CODEREVIEW_SETTINGS_FILE = "codereview.settings"
 
 # Warning message when the change appears to be missing tests.
 MISSING_TEST_MSG = "Change contains new or modified methods, but no new tests!"
 
 # Caches whether we read the codereview.settings file yet or not.
 read_gcl_info = False
 
 
-### Simplified XML processing functions.
-
-def ParseXML(output):
-  try:
-    return xml.dom.minidom.parseString(output)
-  except xml.parsers.expat.ExpatError:
-    return None
-
-def GetNamedNodeText(node, node_name):
-  child_nodes = node.getElementsByTagName(node_name)
-  if not child_nodes:
-    return None
-  assert len(child_nodes) == 1 and child_nodes[0].childNodes.length == 1
-  return child_nodes[0].firstChild.nodeValue
-
-
-def GetNodeNamedAttributeText(node, node_name, attribute_name):
-  child_nodes = node.getElementsByTagName(node_name)
-  if not child_nodes:
-    return None
-  assert len(child_nodes) == 1
-  return child_nodes[0].getAttribute(attribute_name)
-
-
 ### SVN Functions
 
 def IsSVNMoved(filename):
   """Determine if a file has been added through svn mv"""
-  info = GetSVNFileInfo(filename)
+  info = gclient.CaptureSVNInfo(filename)
   return (info.get('Copied From URL') and
           info.get('Copied From Rev') and
           info.get('Schedule') == 'add')
 
 
-def GetSVNFileInfo(file):
-  """Returns a dictionary from the svn info output for the given file."""
-  output = RunShell(["svn", "info", "--xml", file])
-  dom = ParseXML(output)
-  result = {}
-  if dom:
-    # /info/entry/
-    #   url
-    #   reposityory/(root|uuid)
-    #   wc-info/(schedule|depth)
-    #   commit/(author|date)
-    result['Node Kind'] = GetNodeNamedAttributeText(dom, 'entry', 'kind')
-    result['Repository Root'] = GetNamedNodeText(dom, 'root')
-    result['Schedule'] = GetNamedNodeText(dom, 'schedule')
-    result['URL'] = GetNamedNodeText(dom, 'url')
-    result['Path'] = GetNodeNamedAttributeText(dom, 'entry', 'path')
-    result['Copied From URL'] = GetNamedNodeText(dom, 'copy-from-url')
-    result['Copied From Rev'] = GetNamedNodeText(dom, 'copy-from-rev')
-  return result
-
-
 def GetSVNFileProperty(file, property_name):
   """Returns the value of an SVN property for the given file.
 
   Args:
     file: The file to check
     property_name: The name of the SVN property, e.g. "svn:mime-type"
 
   Returns:
     The value of the property, which will be the empty string if the property
     is not set on the file.  If the file is not under version control, the
@@ skipping 26 matching lines @@
     'deleted': 'D',
     'ignored': 'I',
     'missing': '!',
     'modified': 'M',
     'normal': ' ',
     'replaced': 'R',
     'unversioned': '?',
     # TODO(maruel): Find the corresponding strings for X, ~
   }
   output = RunShell(command)
-  dom = ParseXML(output)
+  dom = gclient.ParseXML(output)
   results = []
   if dom:
     # /status/target/entry/(wc-status|commit|author|date)
     for target in dom.getElementsByTagName('target'):
       base_path = target.getAttribute('path')
       for entry in target.getElementsByTagName('entry'):
         file = entry.getAttribute('path')
         wc_status = entry.getElementsByTagName('wc-status')
         assert len(wc_status) == 1
         # Emulate svn 1.5 status ouput...
@@ skipping 34 matching lines @@
   return [item[1] for item in GetSVNStatus(extra_args) if item[0][0] == '?']
 
 
 def GetRepositoryRoot():
   """Returns the top level directory of the current repository.
 
   The directory is returned as an absolute path.
   """
   global repository_root
   if not repository_root:
-    cur_dir_repo_root = GetSVNFileInfo(os.getcwd()).get("Repository Root")
+    infos = gclient.CaptureSVNInfo(os.getcwd(), print_error=False)
+    cur_dir_repo_root = infos.get("Repository Root")
     if not cur_dir_repo_root:
       raise Exception("gcl run outside of repository")
 
     repository_root = os.getcwd()
     while True:
       parent = os.path.dirname(repository_root)
-      if GetSVNFileInfo(parent).get("Repository Root") != cur_dir_repo_root:
+      if (gclient.CaptureSVNInfo(parent).get("Repository Root") !=
+          cur_dir_repo_root):
         break
       repository_root = parent
   return repository_root
 
 
 def GetInfoDir():
   """Returns the directory where gcl info files are stored."""
   global gcl_info_dir
   if not gcl_info_dir:
     gcl_info_dir = os.path.join(GetRepositoryRoot(), '.svn', 'gcl_info')
   return gcl_info_dir
 
 
 def GetCodeReviewSetting(key):
   """Returns a value for the given key for this repository."""
   global read_gcl_info
   if not read_gcl_info:
     read_gcl_info = True
     # First we check if we have a cached version.
     cached_settings_file = os.path.join(GetInfoDir(), CODEREVIEW_SETTINGS_FILE)
     if (not os.path.exists(cached_settings_file) or
         os.stat(cached_settings_file).st_mtime > 60*60*24*3):
-      dir_info = GetSVNFileInfo(".")
+      dir_info = gclient.CaptureSVNInfo(".")
       repo_root = dir_info["Repository Root"]
       url_path = dir_info["URL"]
       settings = ""
       while True:
         # Look for the codereview.settings file at the current level.
         svn_path = url_path + "/" + CODEREVIEW_SETTINGS_FILE
         settings, rc = RunShellWithReturnCode(["svn", "cat", svn_path])
         if not rc:
           # Exit the loop if the file was found.
           break
@@ skipping 502 matching lines @@
   previous_cwd = os.getcwd()
   if root is None:
     os.chdir(GetRepositoryRoot())
   else:
     os.chdir(root)
 
   diff = []
   for file in files:
     # Use svn info output instead of os.path.isdir because the latter fails
     # when the file is deleted.
-    if GetSVNFileInfo(file).get("Node Kind") in ("dir", "directory"):
+    if gclient.CaptureSVNInfo(file).get("Node Kind") in ("dir", "directory"):
       continue
     # If the user specified a custom diff command in their svn config file,
     # then it'll be used when we do svn diff, which we don't want to happen
     # since we want the unified diff.  Using --diff-cmd=diff doesn't always
     # work, since they can have another diff executable in their path that
     # gives different line endings.  So we use a bogus temp directory as the
     # config directory, which gets around these problems.
     if sys.platform.startswith("win"):
       parent_dir = tempfile.gettempdir()
     else:
@@ skipping 420 matching lines @@
     # the files. This allows commands such as 'gcl diff xxx' to work.
     args =["svn", command]
     root = GetRepositoryRoot()
     args.extend([os.path.join(root, x) for x in change_info.FileList()])
     RunShell(args, True)
   return 0
 
 
 if __name__ == "__main__":
   sys.exit(main())