Tools/Scripts/check-for-inappropriate-files-in-framework

   1 #!/usr/bin/env ruby
   2
   3 # Copyright (C) 2010 Apple Inc. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 # 1. Redistributions of source code must retain the above copyright
   9 #    notice, this list of conditions and the following disclaimer.
  10 # 2. Redistributions in binary form must reproduce the above copyright
  11 #    notice, this list of conditions and the following disclaimer in the
  12 #    documentation and/or other materials provided with the distribution.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  15 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  18 # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  24 # THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 base_directory = ENV['TARGET_BUILD_DIR'] or throw "Unable to find TARGET_BUILD_DIR in the environment!"
  27 project_name = ENV['PROJECT_NAME'] or throw "Unable to find PROJECT_NAME in the environment!"
  28 is_shallow_bundle = (ENV['SHALLOW_BUNDLE'] || "NO").upcase == "YES"
  29
  30 $INAPPROPRIATE_FILES = { "WebCore" => { "Resources" => ["*.css", "*.in", "*.idl", "*.h"] },
  31                          "WebKit2" => { "Resources" => ["*.in", "*.h"] },
  32                        }
  33
  34 Dir.chdir base_directory
  35
  36 $error_printed = false
  37
  38 def print_error msg
  39   $error_printed = true
  40   STDERR.puts "ERROR: #{msg}"
  41 end
  42
  43 def print_inappropriate_file_error framework, relative_path
  44   print_error "#{framework}.framework/#{relative_path} should not be present in the framework."
  45 end
  46
  47 def check_framework framework, is_shallow_bundle
  48   $INAPPROPRIATE_FILES[framework].each do |directory, patterns|
  49     framework_bundle_path = is_shallow_bundle ? "#{framework}.framework" : "#{framework}.framework/Versions/A/#{directory}"
  50     Dir.chdir framework_bundle_path do
  51       patterns.each do |pattern|
  52         Dir.glob(pattern).each do |inappropriate_file|
  53           print_inappropriate_file_error framework, is_shallow_bundle ? inappropriate_file : "#{directory}/#{inappropriate_file}"
  54           File.unlink inappropriate_file
  55         end
  56       end
  57     end
  58   end
  59 end
  60
  61 check_framework project_name, is_shallow_bundle
  62
  63 if $error_printed
  64   STDERR.puts
  65   STDERR.puts "    Inappropriate files were detected and have been removed from the framework."
  66   STDERR.puts "    If this error continues to appear after building again then the build system needs"
  67   STDERR.puts "    to be modified so that the inappropriate files are no longer copied in to the framework."
  68   STDERR.puts
  69   exit 1
  70 end