ip_locator_cn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a6d59b99c393a70bc272fb7d6a9af22488f358aff70803fa8edc5ef6a2cd1bc
+  data.tar.gz: 3f35ee0f891112133baa58a3938e6d2a199296e40bf21c442b34204dd49ecdf2
+SHA512:
+  metadata.gz: 2bea475014d0f4ad880129b10a8c39dd6e1f930ea4ce92892713bef024160f0ef8ad7804011807bff06b403fbf1dcff27a27b74cd9f471377a0d206002f04fb9
+  data.tar.gz: d3847a4a344ae42069c5f4a981d21169fdeb231c4b332e606f864efe5b60779c5f76903e7380f1c1605e6524953fe8a346bfaca344f17a95da4ee850456e6a62

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ip_locator_cn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ip_locator_cn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ip_locator_cn!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 xiaohui
+
+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,39 @@
+# IpLocatorCn
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ip_locator_cn`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ip_locator_cn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ip_locator_cn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xiaohui-zhangxh/ip_locator_cn.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "ip_locator_cn"
+
+# 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(__FILE__)

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/ip_locator_cn.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ip_locator_cn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ip_locator_cn"
+  spec.version       = IpLocatorCn::VERSION
+  spec.authors       = ["xiaohui"]
+  spec.email         = ["xiaohui@tanmer.com"]
+
+  spec.summary       = %q{Resolve IP info in China}
+  spec.description   = %q{Resolve IP with qqwry.data, can download qqwry.data on the air.}
+  spec.homepage      = "https://github.com/xiaohui-zhangxh/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ip_locator_cn.rb

@@ -0,0 +1,21 @@
+require "ip_locator_cn/version"
+require 'ip_locator_cn/qqwry'
+module IpLocatorCn
+  # embeded qqwry.dat
+  def self.data_path
+    File.expand_path('../../data/qqwry.dat', __FILE__)
+  end
+
+  # download url for qqwry.rar (uncracked)
+  def self.live_data_url
+    'http://update.cz88.net/ip/qqwry.rar'
+  end
+
+  def self.copywrite_url
+    'http://update.cz88.net/ip/copywrite.rar'
+  end
+
+  def self.resolve(ip)
+    QQWry.new(dat_path: data_path).resolve(ip)
+  end
+end

data/lib/ip_locator_cn/qqwry.rb

@@ -0,0 +1,287 @@
+require 'ip_locator_cn/qqwry/provinces'
+require 'ip_locator_cn/qqwry/city_directly'
+require 'ip_locator_cn/qqwry/isp'
+
+module IpLocatorCn
+  class QQWry
+    IP_ENTRY_BYTES = 7.freeze
+
+    attr_reader :first_ip_pos, :last_ip_pos, :total_ips, :debug
+
+    def initialize(dat_path: nil, live_dat: false, debug: false)
+      @debug = debug
+      if live_dat
+        live_load_dat
+        parse_dat_info
+      elsif dat_path
+        @io = File.open(dat_path, 'rb')
+        parse_dat_info
+      end
+    end
+
+    # return: <Hash> result
+    # result['ip']        输入的ip
+    # result['country']   国家 如 中国
+    # result['province']  省份信息 如 河北省
+    # result['city']      市区 如 邢台市
+    # result['county']    郡县 如 威县
+    # result['isp']       运营商 如 联通
+    # result['area']      最完整的信息 如 中国河北省邢台市威县新科网吧(北外街)
+    def resolve(ip)
+      location = location_from_ip(ip)
+      extract_location(location[:country]).tap do |result|
+        result[:ip] = ip
+        result[:country] ||= ''
+        result[:province] ||= ''
+        result[:city] ||= ''
+        result[:county] ||= ''
+        result[:isp] = get_isp(location[:area]) || ''
+        result[:area] = [
+          result[:country],
+          result[:province],
+          result[:city],
+          result[:county],
+          location[:area]
+        ].join
+      end
+    end
+
+    def location_from_ip(ip)
+      info = {}
+      pos = locate_ip_pos(ip)
+      log "pos is #{pos}"
+      # 用户IP所在范围的开始地址
+      seek(pos)
+      begin_ip = long2ip(read_ip())
+      log "begin_ip is #{begin_ip}"
+      # 用户IP所在范围的结束地址
+      offset = getlong3()
+      seek(offset)
+      endip = long2ip(read_ip())
+      log "endip is #{endip}"
+      log "offset is #{offset}"
+      byte = read(1) # 标志字节
+      case byte.ord
+      when 1
+        # 标志字节为1，表示国家和区域信息都被同时重定向
+        country_offset = getlong3() # 重定向地址
+        seek(country_offset)
+        byte = read(1) # 标志字节
+        case byte.ord
+        when 2
+          seek(getlong3)
+          info[:country] = getstring()
+          seek(country_offset + 4)
+          info[:area] = getarea()
+        else
+          info[:country] = getstring(byte)
+          info[:area] = getarea()
+        end
+      when 2
+        # 标志字节为2，表示国家信息被重定向
+        seek(getlong3)
+        info[:country] = getstring()
+        seek(offset + 8)
+        info[:area] = getarea()
+      else
+        info[:country] = getstring(byte)
+        info[:area] = getarea()
+      end
+
+      info[:country] = encoding_convert(info[:country])
+      info[:area] = encoding_convert(info[:area])
+
+      log "country is #{info[:country]}"
+      log "area is #{info[:area]}"
+
+      if info[:country] == ' CZ88.NET' || info[:country] == '纯真网络'
+        info[:country] = 'Unknown'
+      end
+
+      info[:area] = '' if info[:area] == ' CZ88.NET'
+
+      info
+    end
+
+    # 提取 四川省成都市高新区 => 中国 四川 成都市 高新区
+    def extract_location(str)
+      collection = {}
+      seperator_sheng = '省'
+      seperator_shi = '市'
+      seperator_xian = '县'
+      seperator_qu = '区'
+      is_city_directly = false
+
+      # 省份
+      if str.include?(seperator_sheng)
+        collection[:province], str = str.split(seperator_sheng, 2)
+      else
+        province = (PROVINCES + CITY_DIRECTLY).find{ |x| str.start_with?(x) }
+        if x
+          collection[:province] = province
+          is_city_directly = CITY_DIRECTLY.include?(province)
+          str = str[province.length..-1]
+          str = str[1..-1] if str.start_with?(seperator_shi) # 上海市浦东区 => [上海, 市浦东区] => [上海, 浦东区]
+        end
+      end
+
+      return { country: str } unless collection.key?(:province)
+
+      # 市
+      if str.include?(seperator_shi)
+        collection[:city], str = str.split(seperator_shi, 2)
+        collection[:city] += seperator_shi
+      end
+
+      # 县
+      if str.include?(seperator_xian)
+        collection[:county], str = str.split(seperator_xian, 2)
+        collection[:county] += seperator_xian
+      end
+
+      # 区
+      if !collection.key?(:county) && str.include?(seperator_qu)
+        collection[:county], str = str.split(seperator_qu, 2)
+        collection[:county] += seperator_qu
+        if is_city_directly
+          collection[:city] = collection[:county]
+          collection.delete(:county)
+        end
+      end
+
+      collection[:country] = '中国'
+      collection
+    end
+
+    private
+
+    def download(url)
+      log "downloading #{url}"
+      open(url)
+    end
+
+    def live_load_dat
+      require 'open-uri'
+      copywrite = download(IpLocatorCn.copywrite_url).read and nil
+      qqwry = download(IpLocatorCn.live_data_url).read.bytes and nil
+      key = copywrite.unpack('V6')[5]
+      log "qqwry decoding key is #{key}"
+      (0...0x200).each do |i|
+        key *= 0x805
+        key += 1
+        key &= 0xFF
+        qqwry[i] ^= key
+      end
+      qqwry = Zlib::Inflate.inflate(qqwry.pack('C*')) and nil
+      @io = StringIO.new(qqwry)
+    end
+
+    def parse_dat_info
+      @first_ip_pos = getlong4()
+      @last_ip_pos = getlong4()
+      @total_ips = (last_ip_pos - first_ip_pos) / IP_ENTRY_BYTES
+      log "total ip ranges: #{total_ips}"
+    end
+
+    def get_isp(str)
+      ISP.find {|x| str.include?(x)}
+    end
+
+    # b-tree search ip from qqwry.dat
+    def locate_ip_pos(ip)
+      x = ip2long(ip)
+      min, max = 0, total_ips
+
+      while min <= max
+        # b-tree search
+        i = ((min + max) / 2).floor
+        pos = first_ip_pos + i * IP_ENTRY_BYTES
+        seek(pos)
+        # get middle ip
+        y = read_ip()
+        if x < y
+          # user ip < middle ip
+          max = i - 1
+        else
+          # user ip > middle ip, read next ip entry
+          read(3)
+          y = read_ip()
+          if x > y
+            # user ip > next ip
+            min = i + 1
+          else
+            return pos
+          end
+        end
+      end
+      -1
+    end
+
+    def seek(n)
+      @io.seek(n)
+    end
+
+    def read(n)
+      @io.read(n)
+    end
+
+    def read_ip
+      ipparts2long(read(4).reverse.bytes)
+    end
+
+    def getlong4
+      read(4).unpack('V')[0]
+    end
+
+    def getlong3
+      (read(3) + "\0").unpack('V')[0]
+    end
+
+    def ip2long(ip)
+      parts = ip.split('.').map(&:to_i)
+      ipparts2long(parts)
+    end
+
+    def ipparts2long(parts)
+      0.upto(3).map{|i| parts[i] << ((3 - i) * 8) }.sum
+    end
+
+    def long2ip(n)
+      0.upto(3).map{|i| (n >> ((3 - i) * 8)) & 0xFF }.join('.')
+    end
+
+    def getstring(data='')
+      char = read(1)
+      while char.ord > 0
+        data += char
+        char = read(1)
+      end
+
+      data
+    end
+
+    def getarea
+      char = read(1)
+      case char.ord
+      when 0
+        return ''
+      when 1, 2
+        seek(getlong3)
+        return getstring()
+      else
+        return getstring(char)
+      end
+    end
+
+    def encoding_convert(str)
+      ec = Encoding::Converter.new("GBK", "UTF-8")
+      result = ec.convert(str)
+      ec.finish
+      result
+    end
+
+    def log(msg)
+      puts "[#{Time.now}] => #{msg}" if debug
+    end
+  end
+end

data/lib/ip_locator_cn/qqwry/city_directly.rb

@@ -0,0 +1,10 @@
+module IpLocatorCn
+  class QQWry
+    CITY_DIRECTLY = [
+      '北京',
+      '天津',
+      '重庆',
+      '上海',
+    ].freeze
+  end
+end

data/lib/ip_locator_cn/qqwry/isp.rb

@@ -0,0 +1,12 @@
+module IpLocatorCn
+  class QQWry
+    ISP = [
+      '联通',
+      '移动',
+      '铁通',
+      '电信',
+      '长城',
+      '聚友',
+    ].freeze
+  end
+end

data/lib/ip_locator_cn/qqwry/provinces.rb

@@ -0,0 +1,40 @@
+module IpLocatorCn
+  class QQWry
+    PROVINCES = [
+      '北京',
+      '天津',
+      '重庆',
+      '上海',
+      '河北',
+      '山西',
+      '辽宁',
+      '吉林',
+      '黑龙江',
+      '江苏',
+      '浙江',
+      '安徽',
+      '福建',
+      '江西',
+      '山东',
+      '河南',
+      '湖北',
+      '湖南',
+      '广东',
+      '海南',
+      '四川',
+      '贵州',
+      '云南',
+      '陕西',
+      '甘肃',
+      '青海',
+      '台湾',
+      '内蒙古',
+      '广西',
+      '宁夏',
+      '新疆',
+      '西藏',
+      '香港',
+      '澳门',
+    ].freeze
+  end
+end

data/lib/ip_locator_cn/version.rb

@@ -0,0 +1,3 @@
+module IpLocatorCn
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ip_locator_cn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xiaohui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Resolve IP with qqwry.data, can download qqwry.data on the air.
+email:
+- xiaohui@tanmer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/qqwry.dat
+- ip_locator_cn.gemspec
+- lib/ip_locator_cn.rb
+- lib/ip_locator_cn/qqwry.rb
+- lib/ip_locator_cn/qqwry/city_directly.rb
+- lib/ip_locator_cn/qqwry/isp.rb
+- lib/ip_locator_cn/qqwry/provinces.rb
+- lib/ip_locator_cn/version.rb
+homepage: https://github.com/xiaohui-zhangxh/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/xiaohui-zhangxh/
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Resolve IP info in China
+test_files: []