mail-jdec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 925ecb5ca03bce312fbffc21b30f4385cca1efd55461afcce02a7a8ccd46bdd2
+  data.tar.gz: 9a8fa9a47b6370d6e289fe53dbb14a053791d14d4fa5ea68160e7448678ed545
+SHA512:
+  metadata.gz: 2458f803b38b3ae52ab5b82032c38e2d9c15cfba810eb44df9a320b3ae782463afabba5e2f5029543c2d3cd9c4fc90522db664804de945f96d4edbf1bfdde49e
+  data.tar.gz: 8c6e60a7e79a00bbb90c602c44224cff6595afa1b5f13c5df79f93489ae4639b8df9ff2635fc9fec00b8fb2e9764070865d8bcf6059df5cd41009a9cedca8efe

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+.project
+Gemfile.lock
+coverage/
+pkg/
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+gemfile:
+  - gemfiles/mail27.gemfile
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshikazu Kaneta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Mail::Jdec
+
+A mail patch for decoding some inproper mails.
+
+## Dependencies
+
+* ruby 2.3+
+* mail 2.7
+* charlock_holmes (using libicu)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail-jdec'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Use mail as usual. You can enable/disable patched features as follows:
+
+```ruby
+# disable patch
+Mail::Jdec.disable
+
+# enable patch
+Mail::Jdec.enable
+```
+
+## Contributing
+
+Pull requests are welcome at https://github.com/kanety/mail-jdec.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mail/jdec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/mail27.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "mail", "~> 2.7.1"
+
+gemspec path: "../"

data/lib/mail/jdec/decoder.rb

@@ -0,0 +1,60 @@
+module Mail
+  module Jdec
+    class Decoder
+      class << self
+        def decode_if_needed(text)
+          return text if text.nil? || !text.ascii_only?
+
+          detected = Detector.detect(text)
+          if detected
+            charset = detected[:encoding].to_s
+            text = Mail::Encodings.transcode_charset(text.dup.force_encoding(charset), charset)
+          end
+
+          text
+        end
+
+        def force_utf8(str)
+          str.dup.force_encoding('utf-8').encode('utf-8', invalid: :replace, undef: :replace)
+        end
+      end
+    end
+
+    class ValueDecoder
+      class << self
+        include Mail::Constants
+
+        def value_decode(str)
+          # Optimization: If there's no encoded-words in the string, just return it
+          return str unless str =~ ENCODED_VALUE
+
+          lines = Mail::Encodings.send(:collapse_adjacent_encodings, str)
+
+          lines = lines.chunk do |value|
+            if value =~ ENCODED_VALUE
+              $1
+            else
+              ''
+            end
+          end
+
+          # Split on white-space boundaries with capture, so we capture the white-space as well
+          lines.map do |charset, values|
+            content = values.join
+            if content =~ ENCODED_VALUE
+              bytes = content.scan(/\=\?([^?]+)\?([QB])\?([^?]*?)\?\=/mi).map do |_, encoding, encoded|
+                case encoding
+                when *B_VALUES then Mail::RubyVer.decode_base64(encoded)
+                when *Q_VALUES then Mail::Encodings::QuotedPrintable.decode(encoded)
+                end
+              end.join('')
+              Mail::Encodings.transcode_charset(bytes, charset)
+            else
+              content
+            end
+          end.join('')
+        end
+      end
+    end
+  end
+end

data/lib/mail/jdec/detector.rb

@@ -0,0 +1,29 @@
+module Mail
+  module Jdec
+    class Detector
+      class << self
+        def detect(text)
+          return if text.nil?
+
+          detected = CharlockHolmes::EncodingDetector.detect(text)
+          detected if trusty?(detected) && find_encoding(detected)
+        end
+
+        private
+    
+        def find_encoding(detected)
+          Encoding.find(detected[:encoding])
+        rescue
+          nil
+        end
+
+        def trusty?(detected)
+          detected.key?(:type) &&
+            detected.key?(:encoding) &&
+            detected[:confidence].to_i > Jdec.autodetect_confidence &&
+            !Jdec.autodetect_skip_charsets.include?(detected[:encoding].downcase)
+        end
+      end
+    end
+  end
+end

data/lib/mail/jdec/elements/content_disposition_element_patch.rb

@@ -0,0 +1,25 @@
+module Mail
+  module Jdec
+    module ContentDispositionElementPatch
+      def initialize(string)
+        super
+      rescue Mail::Field::ParseError => e
+        if Jdec.enabled?
+          value = Jdec::Decoder.force_utf8(string)
+          if (matched = value.match(/^\s*attachment\s*;\s*(.+)/im))
+            @disposition_type = 'attachment'
+            @parameters = [{ filename: matched[1].gsub(/(\r\n|\r|\n)\s/, '') }]
+          else
+            raise e
+          end
+        else
+          raise e
+        end
+      end
+    end
+  end
+end
+
+unless Mail::ContentDispositionElement.included_modules.include?(Mail::Jdec::ContentDispositionElementPatch)
+  Mail::ContentDispositionElement.prepend Mail::Jdec::ContentDispositionElementPatch
+end

data/lib/mail/jdec/elements/content_type_element_patch.rb

@@ -0,0 +1,18 @@
+module Mail
+  module Jdec
+    module ContentTypeElementPatch
+      def initialize(string)
+        if Jdec.enabled?
+          # Handles ; name=
+          string = string.gsub(/^\s*;?\s*name=(.+)$/im) { "application/octet-stream; name=#{$1}" }
+        end
+
+        super
+      end
+    end
+  end
+end
+
+unless Mail::ContentTypeElement.included_modules.include?(Mail::Jdec::ContentTypeElementPatch)
+  Mail::ContentTypeElement.prepend Mail::Jdec::ContentTypeElementPatch
+end

data/lib/mail/jdec/encodings_patch.rb

@@ -0,0 +1,17 @@
+module Mail
+  module Jdec
+    module EncodingsPatch
+      def value_decode(str)
+        if Jdec.enabled?
+          Jdec::ValueDecoder.value_decode(str)
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+unless Mail::Encodings.singleton_class.included_modules.include?(Mail::Jdec::EncodingsPatch)
+  Mail::Encodings.singleton_class.prepend Mail::Jdec::EncodingsPatch
+end

data/lib/mail/jdec/fields/structured_field_patch.rb

@@ -0,0 +1,14 @@
+module Mail
+  module Jdec
+    module StructuredFieldPatch
+      def initialize(name = nil, value = nil, charset = nil)
+        value = Decoder.decode_if_needed(value) if Jdec.enabled?
+        super
+      end
+    end
+  end
+end
+
+unless Mail::StructuredField.included_modules.include?(Mail::Jdec::StructuredFieldPatch)
+  Mail::StructuredField.prepend Mail::Jdec::StructuredFieldPatch
+end

data/lib/mail/jdec/fields/unstructured_field_patch.rb

@@ -0,0 +1,14 @@
+module Mail
+  module Jdec
+    module UnstructuredFieldPatch
+      def initialize(name = nil, value = nil, charset = nil)
+        value = Decoder.decode_if_needed(value) if Jdec.enabled?
+        super
+      end
+    end
+  end
+end
+
+unless Mail::UnstructuredField.included_modules.include?(Mail::Jdec::UnstructuredFieldPatch)
+  Mail::UnstructuredField.prepend Mail::Jdec::UnstructuredFieldPatch
+end

data/lib/mail/jdec/message_patch.rb

@@ -0,0 +1,25 @@
+module Mail
+  module Jdec
+    module MessagePatch
+      def decoded
+        decoded = super
+
+        if Jdec.enabled? && (!has_content_type? || (!has_charset? && !attachment? && !multipart?))
+          detected = Detector.detect(decoded)
+          if detected && detected[:type] == :text
+            charset = detected[:encoding].downcase
+            decoded = Mail::Encodings.transcode_charset(decoded.dup.force_encoding(charset), charset)
+            header[:content_type] = 'text/plain'
+            header[:content_type].parameters[:charset] = charset
+          end
+        end
+
+        decoded
+      end
+    end
+  end
+end
+
+unless Mail::Message.included_modules.include?(Mail::Jdec::MessagePatch)
+  Mail::Message.prepend Mail::Jdec::MessagePatch
+end

data/lib/mail/jdec/ruby_1_9_patch.rb

@@ -0,0 +1,20 @@
+module Mail
+  module Jdec
+    module Ruby19Patch
+      def pick_encoding(charset)
+        if Jdec.enabled?
+          Jdec.preferred_charsets.each do |from, to|
+            if charset.to_s.downcase == from
+              return Encoding.find(to)
+            end
+          end
+        end
+        super
+      end
+    end
+  end
+end
+
+unless Mail::Ruby19.singleton_class.included_modules.include?(Mail::Jdec::Ruby19Patch)
+  Mail::Ruby19.singleton_class.prepend Mail::Jdec::Ruby19Patch
+end

data/lib/mail/jdec/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Jdec
+    VERSION = '1.0.0'
+  end
+end

data/lib/mail/jdec.rb

@@ -0,0 +1,44 @@
+require 'mail'
+require 'charlock_holmes'
+
+Dir["#{__dir__}/jdec/**/*.rb"].each do |file|
+  require file
+end
+
+module Mail
+  module Jdec
+    class << self
+      attr_reader :enabled
+      attr_accessor :autodetect_confidence
+      attr_accessor :autodetect_skip_charsets
+      attr_accessor :preferred_charsets
+
+      def enabled?
+        @@enabled
+      end
+
+      def enable
+        @@enabled = true
+      end
+
+      def disable
+        @@enabled = false
+      end
+    end
+
+    self.enable
+    self.autodetect_confidence = 50
+    self.autodetect_skip_charsets = %w(utf-8 iso-8859-1)
+    self.preferred_charsets = {
+      'iso-2022-jp' => 'cp50221',
+      'iso-2022-jp-1' => 'cp50221',
+      'iso-2022-jp-2' => 'cp50221',
+      'iso-2022-jp-3' => 'cp50221',
+      'iso-2022-jp-2004' => 'cp50221',
+      'shift_jis' => 'cp932',
+      'shift-jis' => 'cp932',
+      'x_sjis' => 'cp932',
+      'x-sjis' => 'cp932'
+    }
+  end
+end

data/mail-jdec.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail/jdec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail-jdec"
+  spec.version       = Mail::Jdec::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{A mail patch for decoding some inproper mails}
+  spec.description   = %q{A mail patch for decoding some inproper mails}
+  spec.homepage      = "https://github.com/kanety/mail-jdec"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mail", ">= 2.7.1"
+  spec.add_dependency "charlock_holmes", ">= 0.7.0"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mail-jdec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: charlock_holmes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A mail patch for decoding some inproper mails
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/mail27.gemfile
+- lib/mail/jdec.rb
+- lib/mail/jdec/decoder.rb
+- lib/mail/jdec/detector.rb
+- lib/mail/jdec/elements/content_disposition_element_patch.rb
+- lib/mail/jdec/elements/content_type_element_patch.rb
+- lib/mail/jdec/encodings_patch.rb
+- lib/mail/jdec/fields/structured_field_patch.rb
+- lib/mail/jdec/fields/unstructured_field_patch.rb
+- lib/mail/jdec/message_patch.rb
+- lib/mail/jdec/ruby_1_9_patch.rb
+- lib/mail/jdec/version.rb
+- mail-jdec.gemspec
+homepage: https://github.com/kanety/mail-jdec
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A mail patch for decoding some inproper mails
+test_files: []