src/third_party/WebKit/Source/devtools/scripts/optimize_png_images.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2014 Google Inc. All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7 #
   8 #     * Redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer.
  10 #     * Redistributions in binary form must reproduce the above
  11 # copyright notice, this list of conditions and the following disclaimer
  12 # in the documentation and/or other materials provided with the
  13 # distribution.
  14 #     * Neither the name of Google Inc. nor the names of its
  15 # contributors may be used to endorse or promote products derived from
  16 # this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 import devtools_file_hashes
  31 import os
  32 import os.path
  33 import subprocess
  34 import sys
  35
  36 try:
  37     import json
  38 except ImportError:
  39     import simplejson as json
  40
  41 scripts_path = os.path.dirname(os.path.abspath(__file__))
  42 devtools_path = os.path.dirname(scripts_path)
  43 blink_source_path = os.path.dirname(devtools_path)
  44 blink_path = os.path.dirname(blink_source_path)
  45 chromium_src_path = os.path.dirname(os.path.dirname(blink_path))
  46 devtools_frontend_path = os.path.join(devtools_path, "front_end")
  47 images_path = os.path.join(devtools_frontend_path, "Images")
  48 image_sources_path = os.path.join(images_path, "src")
  49 hashes_file_name = "optimize_png.hashes"
  50 hashes_file_path = os.path.join(image_sources_path, hashes_file_name)
  51
  52 file_names = os.listdir(image_sources_path)
  53 svg_file_paths = [os.path.join(image_sources_path, file_name) for file_name in file_names if file_name.endswith(".svg")]
  54 svg_file_paths_to_optimize = devtools_file_hashes.files_with_invalid_hashes(hashes_file_path, svg_file_paths)
  55 svg_file_names = [os.path.basename(file_path) for file_path in svg_file_paths_to_optimize]
  56
  57 optimize_script_path = os.path.join("tools", "resources", "optimize-png-files.sh")
  58
  59
  60 def check_installed(app_name, package, how_to):
  61     proc = subprocess.Popen("which %s" % app_name, stdout=subprocess.PIPE, shell=True)
  62     proc.communicate()
  63     if proc.returncode != 0:
  64         print "This script needs \"%s\" to be installed." % app_name
  65         if how_to:
  66             print how_to
  67         else:
  68             print "To install execute the following command: sudo apt-get install %s" % package
  69         sys.exit(1)
  70
  71 check_installed("pngcrush", "pngcrush", None)
  72 check_installed("optipng", "optipng", None)
  73 check_installed("advdef", "advancecomp", None)
  74 check_installed("pngout", None, "Utility can be downloaded here: http://www.jonof.id.au/kenutils")
  75
  76
  77 def optimize_png(file_name):
  78     png_full_path = os.path.join(images_path, file_name + ".png")
  79     optimize_command = "bash %s -o2 %s" % (optimize_script_path, png_full_path)
  80     proc = subprocess.Popen(optimize_command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, shell=True, cwd=chromium_src_path)
  81     return proc
  82
  83 if len(svg_file_names):
  84     print "%d unoptimized png files found." % len(svg_file_names)
  85 else:
  86     print "All png files are already optimized."
  87     sys.exit()
  88
  89 processes = {}
  90 for file_name in svg_file_names:
  91     name = os.path.splitext(file_name)[0]
  92     name2x = name + "_2x"
  93     processes[name] = optimize_png(name)
  94     processes[name2x] = optimize_png(name2x)
  95
  96 for file_name, proc in processes.items():
  97     (optimize_out, _) = proc.communicate()
  98     print("Optimization of %s finished: %s" % (file_name, optimize_out))
  99
 100 devtools_file_hashes.update_file_hashes(hashes_file_path, svg_file_paths)