Home | History | Annotate | Download | only in steps 
      1 # Copyright (C) 2010 Google Inc. All rights reserved.
      2 #
      3 # Redistribution and use in source and binary forms, with or without
      4 # modification, are permitted provided that the following conditions are
      5 # met:
      6 #
      7 #     * Redistributions of source code must retain the above copyright
      8 # notice, this list of conditions and the following disclaimer.
      9 #     * Redistributions in binary form must reproduce the above
     10 # copyright notice, this list of conditions and the following disclaimer
     11 # in the documentation and/or other materials provided with the
     12 # distribution.
     13 #     * Neither the name of Google Inc. nor the names of its
     14 # contributors may be used to endorse or promote products derived from
     15 # this software without specific prior written permission.
     16 #
     17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28 
     29 import urllib
     30 
     31 from webkitpy.tool.steps.abstractstep import AbstractStep
     32 from webkitpy.tool.steps.options import Options
     33 from webkitpy.common.prettypatch import PrettyPatch
     34 from webkitpy.common.system import logutils
     35 from webkitpy.common.system.executive import ScriptError
     36 
     37 
     38 _log = logutils.get_logger(__file__)
     39 
     40 
     41 class ConfirmDiff(AbstractStep):
     42     @classmethod
     43     def options(cls):
     44         return AbstractStep.options() + [
     45             Options.confirm,
     46         ]
     47 
     48     def _show_pretty_diff(self, diff):
     49         if not self._tool.user.can_open_url():
     50             return None
     51 
     52         try:
     53             pretty_patch = PrettyPatch(self._tool.executive)
     54             pretty_diff_file = pretty_patch.pretty_diff_file(diff)
     55             url = "file://%s" % urllib.quote(pretty_diff_file.name)
     56             self._tool.user.open_url(url)
     57             # We return the pretty_diff_file here because we need to keep the
     58             # file alive until the user has had a chance to confirm the diff.
     59             return pretty_diff_file
     60         except ScriptError, e:
     61             _log.warning("PrettyPatch failed.  :(")
     62         except OSError, e:
     63             _log.warning("PrettyPatch unavailable.")
     64 
     65     def run(self, state):
     66         if not self._options.confirm:
     67             return
     68         diff = self.cached_lookup(state, "diff")
     69         pretty_diff_file = self._show_pretty_diff(diff)
     70         if not pretty_diff_file:
     71             self._tool.user.page(diff)
     72         diff_correct = self._tool.user.confirm("Was that diff correct?")
     73         if pretty_diff_file:
     74             pretty_diff_file.close()
     75         if not diff_correct:
     76             self._exit(1)
     77