app-info 2.8.2 → 3.0.0

data/lib/app_info/pe.rb

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+require 'pedump'
+require 'fileutils'
+require 'forwardable'
+
+module AppInfo
+  # Windows PE parser
+  #
+  # @see https://learn.microsoft.com/zh-cn/windows/win32/debug/pe-format Microsoft PE Format
+  class PE < File
+    include Helper::HumanFileSize
+    include Helper::Archive
+    extend Forwardable
+
+    ARCH = {
+      0x014c => 'x86',
+      0x0200 => 'Intel Itanium',
+      0x8664 => 'x64',
+      0x1c0 => 'arm',
+      0xaa64 => 'arm64',
+      0x5032 => 'RISC-v 32',
+      0x5064 => 'RISC-v 64',
+      0x5128 => 'RISC-v 128'
+    }.freeze
+
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::MICROSOFT
+    end
+
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::WINDOWS
+    end
+
+    # @return [Symbol] {Device}
+    def device
+      Device::WINDOWS
+    end
+
+    # return file size
+    # @example Read file size in integer
+    #   aab.size                    # => 3618865
+    #
+    # @example Read file size in human readabale
+    #   aab.size(human_size: true)  # => '3.45 MB'
+    #
+    # @param [Boolean] human_size Convert integer value to human readable.
+    # @return [Integer, String]
+    def size(human_size: false)
+      file_to_human_size(@file, human_size: human_size)
+    end
+
+    def binary_size(human_size: false)
+      file_to_human_size(binary_file, human_size: human_size)
+    end
+
+    # @!method product_name
+    #   @see VersionInfo#product_name
+    #   @return [String]
+    # @!method product_version
+    #   @see VersionInfo#product_version
+    #   @return [String]
+    # @!method company_name
+    #   @see VersionInfo#company_name
+    #   @return [String]
+    # @!method assembly_version
+    #   @see VersionInfo#assembly_version
+    #   @return [String]
+    # @!method file_version
+    #   @see VersionInfo#file_version
+    #   @return [String]
+    # @!method file_description
+    #   @see VersionInfo#file_description
+    #   @return [String]
+    # @!method copyright
+    #   @see VersionInfo#copyright
+    #   @return [String]
+    #   @return [String]
+    # @!method special_build
+    #   @see VersionInfo#special_build
+    #   @return [String]
+    # @!method private_build
+    #   @see VersionInfo#private_build
+    #   @return [String]
+    # @!method original_filename
+    #   @see VersionInfo#original_filename
+    #   @return [String]
+    # @!method internal_name
+    #   @see VersionInfo#internal_name
+    #   @return [String]
+    # @!method legal_trademarks
+    #   @see VersionInfo#legal_trademarks
+    #   @return [String]
+    def_delegators :version_info, :product_name, :product_version, :company_name, :assembly_version,
+                   :file_version, :file_description, :copyright, :special_build, :private_build,
+                   :original_filename, :internal_name, :legal_trademarks
+
+    alias name product_name
+
+    # Find {#product_version} then fallback to {#file_version}
+    # @return [String, nil]
+    def release_version
+      product_version || file_version
+    end
+
+    # Find {#special_build}, {#private_build} then fallback to {#assembly_version}
+    # @return [String, nil]
+    def build_version
+      special_build || private_build || assembly_version
+    end
+
+    # @return [String]
+    def archs
+      ARCH[image_file_header.Machine] || 'unknown'
+    end
+    alias architectures archs
+
+    # @return [Hash{String => String}] imports imports of libraries
+    def imports
+      @imports ||= pe.imports.each_with_object({}) do |import, obj|
+        obj[import.module_name] = import.first_thunk.map(&:name).compact
+      end
+    end
+
+    # @return [Array{String}] icons paths of bmp image icons
+    def icons
+      @icons ||= lambda {
+        # Fetch the largest size icon
+        files = []
+        pe.resources&.find_all do |res|
+          next unless res.type == 'ICON'
+
+          filename = "#{::File.basename(file, '.*')}-#{res.type}-#{res.id}.bmp"
+          icon_file = tempdir(filename, prefix: 'pe', system: true)
+          mask_icon_file = icon_file.sub('.bmp', '.mask.bmp')
+
+          begin
+            ::File.open(icon_file, 'wb') do |f|
+              f << res.restore_bitmap(io)
+            end
+
+            if res.bitmap_mask(io)
+              mask_icon_file = icon_file.sub('.bmp', '.mask.bmp')
+              ::File.open(mask_icon_file, 'wb') do |f|
+                f << res.bitmap_mask(io)
+              end
+            end
+          rescue StandardError => e
+            # ignore pedump throws any exception.
+            raise e unless e.backtrace.first.include?('pedump')
+
+            FileUtils.rm_f(icon_file)
+          ensure
+            next unless ::File.exist?(icon_file)
+
+            mask_file = ::File.exist?(mask_icon_file) ? mask_icon_file : nil
+            files << icon_metadata(icon_file, mask_file: mask_file)
+          end
+        end
+
+        files
+      }.call
+    end
+
+    # @return [PEdump]
+    def pe
+      @pe ||= lambda {
+        pe = PEdump.new(io)
+        pe.logger.level = Logger::FATAL # ignore :warn logger output
+        pe
+      }.call
+    end
+
+    # @return [VersionInfo]
+    def version_info
+      @version_info ||= VersionInfo.new(pe.version_info)
+    end
+
+    def clear!
+      @io = nil
+      @pe = nil
+      @icons = nil
+      @imports = nil
+    end
+
+    # @return [String] binary_file path
+    def binary_file
+      @binary_file ||= lambda {
+        file_io = ::File.open(@file, 'rb')
+        return @file unless file_io.read(100) =~ AppInfo::ZIP_RETGEX
+
+        zip_file = Zip::File.open(@file)
+        zip_entry = zip_file.glob('*.exe').first
+        raise NotFoundError, 'Not found .exe file in archive file' if zip_entry.nil?
+
+        exe_file = tempdir(zip_entry.name, prefix: 'pe-exe', system: true)
+        zip_entry.extract(exe_file)
+        zip_file.close
+
+        return exe_file
+      }.call
+    end
+
+    private
+
+    def image_file_header
+      @image_file_header ||= pe.pe.image_file_header
+    end
+
+    # @return [Hash{Symbol => String}]
+    def icon_metadata(file, mask_file: nil)
+      {
+        name: ::File.basename(file),
+        file: file,
+        mask: mask_file,
+        dimensions: ImageSize.path(file).size
+      }
+    end
+
+    # @return [File]
+    def io
+      @io ||= ::File.open(binary_file, 'rb')
+    end
+
+    # VersionInfo class
+    #
+    # @see https://learn.microsoft.com/zh-cn/windows/win32/menurc/versioninfo-resource
+    class VersionInfo
+      def initialize(raw)
+        @raw = raw
+      end
+
+      # @return [String]
+      def company_name
+        @company_name ||= value_of('CompanyName')
+      end
+
+      # @return [String]
+      def product_name
+        @product_name ||= value_of('ProductName')
+      end
+
+      # @return [String]
+      def product_version
+        @product_version ||= value_of('ProductVersion')
+      end
+
+      # @return [String]
+      def assembly_version
+        @assembly_version ||= value_of('Assembly Version')
+      end
+
+      # @return [String]
+      def file_version
+        @file_version ||= value_of('FileVersion')
+      end
+
+      # @return [String, nil]
+      def file_description
+        @file_description ||= value_of('FileDescription')
+      end
+
+      # @return [String, nil]
+      def special_build
+        @special_build ||= value_of('SpecialBuild')
+      end
+
+      # @return [String, nil]
+      def private_build
+        @private_build ||= value_of('PrivateBuild')
+      end
+
+      # @return [String]
+      def original_filename
+        @original_filename ||= value_of('OriginalFilename')
+      end
+
+      # @return [String]
+      def internal_name
+        @internal_name ||= value_of('InternalName')
+      end
+
+      # @return [String]
+      def legal_trademarks
+        @legal_trademarks ||= value_of('LegalTrademarks')
+      end
+
+      # @return [String]
+      def copyright
+        @copyright ||= value_of('LegalCopyright')
+      end
+
+      private
+
+      def value_of(key)
+        info.each do |v|
+          return v[:Value] if v[:szKey] == key.to_s
+        end
+
+        nil
+      end
+
+      def info
+        return @info if @info
+
+        @raw.each do |item|
+          next unless item.is_a?(PEdump::VS_VERSIONINFO)
+
+          versions = item[:Children].select { |v| v.is_a?(PEdump::StringFileInfo) }
+          next if versions.empty?
+
+          @info = versions[0][:Children][0][:Children]
+          return @info
+        end
+
+        @info = []
+      end
+    end
+  end
+end

data/lib/app_info/png_uncrush.rb

@@ -7,9 +7,10 @@ require 'zlib'
 require 'stringio'
 
 module AppInfo
+  # Decompress iOS Png image file.
+  # @see https://github.com/swcai/iphone-png-normalizer swcai/iphone-png-normalizer
+  # @author Wenwei Cai
   class PngUncrush
-    class Error < StandardError; end
-
     class FormatError < Error; end
 
     class PngReader # :nodoc:
@@ -31,20 +32,26 @@ module AppInfo
         @data = String.new
       end
 
+      # @return [Integer]
       def size
         @io.size
       end
 
+      # @param [String] format
+      # @return [String]
+      # @see IO package data
       def unpack(format)
         @io.unpack(format)
       end
 
+      # @return [String]
       def header
         @header ||= self[0, 8]
       end
 
+      # @return [Boolean]
       def png?
-        PNG_HEADER == header.bytes
+        header.bytes == PNG_HEADER
       end
 
       def [](offset, length)
@@ -60,23 +67,36 @@ module AppInfo
       end
     end
 
+    # Decompress crushed png file.
+    # @param [String] input path of png file
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def self.decompress(input, output)
       new(input).decompress(output)
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def self.dimensions(input)
       new(input).dimensions
     end
 
     def initialize(filename)
-      @io = PngReader.new(File.open(filename))
+      @io = PngReader.new(::File.open(filename))
       raise FormatError, 'not a png file' unless @io.png?
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def dimensions
       _dump_sections(dimensions: true)
     end
 
+    # Decompress crushed png file.
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def decompress(output)
       content = _remap(_dump_sections)
       return false unless content
@@ -125,7 +145,7 @@ module AppInfo
     end
 
     def write_file(path, content)
-      File.write(path, content, encoding: Encoding::BINARY)
+      ::File.write(path, content, encoding: Encoding::BINARY)
       true
     end
 

data/lib/app_info/proguard.rb

@@ -5,52 +5,52 @@ require 'rexml/document'
 
 module AppInfo
   # Proguard parser
-  class Proguard
+  class Proguard < File
     include Helper::Archive
 
     NAMESPACE = UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, 'icyleaf.com')
 
-    attr_reader :file
-
-    def initialize(file)
-      @file = file
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::GOOGLE
     end
 
-    def file_type
-      Platform::PROGUARD
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::ANDROID
     end
 
+    # @return [String]
     def uuid
       # Similar to https://docs.sentry.io/workflow/debug-files/#proguard-uuids
-      UUIDTools::UUID.sha1_create(NAMESPACE, File.read(mapping_path)).to_s
+      UUIDTools::UUID.sha1_create(NAMESPACE, ::File.read(mapping_path)).to_s
     end
     alias debug_id uuid
 
+    # @return [Boolean]
     def mapping?
-      File.exist?(mapping_path)
+      ::File.exist?(mapping_path)
     end
 
+    # @return [Boolean]
     def manifest?
-      File.exist?(manifest_path)
+      ::File.exist?(manifest_path)
     end
 
+    # @return [Boolean]
     def symbol?
-      File.exist?(symbol_path)
+      ::File.exist?(symbol_path)
     end
     alias resource? symbol?
 
+    # @return [String, nil]
     def package_name
       return unless manifest?
 
       manifest.root.attributes['package']
     end
 
-    def releasd_version
-      return unless manifest?
-
-      manifest.root.attributes['package']
-    end
-
+    # @return [String, nil]
     def version_name
       return unless manifest?
 
@@ -58,6 +58,7 @@ module AppInfo
     end
     alias release_version version_name
 
+    # @return [String, nil]
     def version_code
       return unless manifest?
 
@@ -65,27 +66,43 @@ module AppInfo
     end
     alias build_version version_code
 
+    def files
+      Dir.children(contents).each_with_object([]) do |filename, obj|
+        path = ::File.join(contents, filename)
+        obj << {
+          name: filename,
+          path: path,
+          size: ::File.size(path)
+        }
+      end
+    end
+
+    # @return [REXML::Document]
     def manifest
       return unless manifest?
 
-      @manifest ||= REXML::Document.new(File.new(manifest_path))
+      @manifest ||= REXML::Document.new(::File.new(manifest_path))
     end
 
+    # @return [String]
     def mapping_path
-      @mapping_path ||= Dir.glob(File.join(contents, '*mapping*.txt')).first
+      @mapping_path ||= Dir.glob(::File.join(contents, '*mapping*.txt')).first
     end
 
+    # @return [String]
     def manifest_path
-      @manifest_path ||= File.join(contents, 'AndroidManifest.xml')
+      @manifest_path ||= ::File.join(contents, 'AndroidManifest.xml')
     end
 
+    # @return [String]
     def symbol_path
-      @symbol_path ||= File.join(contents, 'R.txt')
+      @symbol_path ||= ::File.join(contents, 'R.txt')
     end
     alias resource_path symbol_path
 
+    # @return [String] contents path of contents
     def contents
-      @contents ||= unarchive(@file, path: 'proguard')
+      @contents ||= unarchive(@file, prefix: 'proguard')
     end
 
     def clear!

data/lib/app_info/protobuf/manifest.rb

@@ -6,8 +6,9 @@ require 'app_info/core_ext'
 
 module AppInfo
   module Protobuf
+    # AAB Protobuf Base class
     class Base
-      include Helper::Defines
+      include Helper::GenerateClass
 
       def initialize(doc, resources = nil)
         @resources = resources
@@ -17,10 +18,11 @@ module AppInfo
       private
 
       def parse(_)
-        raise 'not implemented'
+        raise ProtobufParseError, 'not implemented'
       end
     end
 
+    # AAB Protobuf Attribute
     class Attribute < Base
       attr_reader :namespace, :name, :value, :resource_id
 
@@ -47,6 +49,8 @@ module AppInfo
       end
     end
 
+    # AAB Protobuf Node class.
+    #   example: manifest,activity, activity-alias, service, receiver, provider, application
     class Node < Base
       attr_reader :name, :attributes, :children
 
@@ -106,6 +110,7 @@ module AppInfo
       end
     end
 
+    # AAB Protobuf Manifest
     class Manifest < Node
       def self.parse(io, resources = nil)
         doc = Aapt::Pb::XmlNode.decode(io)
@@ -152,8 +157,10 @@ module AppInfo
 
       def intent_filters(search: nil)
         activities.each_with_object([]) do |activity, obj|
+          next unless activity.respond_to?(:intent_filter)
+
           intent_filters = activity.intent_filter
-          next if intent_filters&.empty?
+          next if intent_filters.nil? || intent_filters&.empty?
 
           if search.nil? || search.empty?
             obj << intent_filters
@@ -168,7 +175,6 @@ module AppInfo
         end.flatten.uniq
       end
 
-      # :nodoc:
       # Workaround ruby always return true by called `Object.const_defined?(Data)`
       class Data < Node; end
 
@@ -182,6 +188,8 @@ module AppInfo
         CATEGORY_BROWSABLE = 'android.intent.category.BROWSABLE'
 
         def deep_links?
+          return unless respond_to?(:data)
+
           browsable? && data.any? { |d| DEEP_LINK_SCHEMES.include?(d.scheme) }
         end
 
@@ -193,6 +201,12 @@ module AppInfo
               .uniq
         end
 
+        def schemes?
+          return unless respond_to?(:data)
+
+          browsable? && data.any? { |d| !DEEP_LINK_SCHEMES.include?(d.scheme) }
+        end
+
         def schemes
           return unless schemes?
 
@@ -201,23 +215,20 @@ module AppInfo
               .uniq
         end
 
-        def schemes?
-          browsable? && data.any? { |d| !DEEP_LINK_SCHEMES.include?(d.scheme) }
-        end
-
         def browsable?
           exist?(CATEGORY_BROWSABLE)
         end
 
         def exist?(name, type: nil)
           if type.to_s.empty? && !name.start_with?('android.intent.')
-            raise 'Fill type or use correct name'
+            raise ProtobufParseError, 'Not found intent type'
           end
 
           type ||= name.split('.')[2]
-          raise 'Not found type' unless TYPES.include?(type)
+          raise ProtobufParseError, 'Not found intent type' unless TYPES.include?(type)
+          return false unless intent = send(type.to_sym)
 
-          values = send(type.to_sym).select { |e| e.name == name }
+          values = intent.select { |e| e.name == name }
           values.empty? ? false : values
         end
       end

data/lib/app_info/protobuf/models/Configuration_pb.rb

@@ -118,6 +118,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
 end
 
+# @!visibility private
 module Aapt
   module Pb
     Configuration = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("aapt.pb.Configuration").msgclass

data/lib/app_info/protobuf/models/README.md

@@ -3,12 +3,19 @@
 ## Convert to ruby model
 
 ```bash
-cd app_info/lib/app_info/abb/proto
+cd lib/app_info/protobuf/models
 
 protoc --ruby_out=. Resources.proto
 protoc --ruby_out=. Configuration.proto
 ```
 
+## Decode
+
+```bash
+protoc --decode=aapt.pb.ResourceTable Resources.proto < aab/base/BundleConfig.pb > BundleConfig.txt
+protoc --decode=aapt.pb.ResourceTable Resources.proto < aab/base/native.pb > native.txt
+```
+
 ## Resouces
 
 `Configuration.proto` and `Resources.proto` can be found in aapt2's github: