1.2.0, support client ip info

Author: metowolf

README.md

@@ -9,7 +9,7 @@ Open Source REST API for IP database, includes qqwry, ipipdotnet.
 ## Usage
 
 ```http
-GET https://api.i-meto.com/ip/v1/qqwry/119.29.29.29
+GET http://localhost:3000/v1/qqwry/119.29.29.29
 ```
 
 ```json
@@ -19,29 +19,21 @@ GET https://api.i-meto.com/ip/v1/qqwry/119.29.29.29
   "region_name": "广东",
   "city_name": "广州",
   "owner_domain": "cloud.tencent.com",
-  "isp_domain": "",
-  "range": {
-    "from": "119.29.0.0",
-    "to": "119.29.127.255"
-  }
+  "isp_domain": ""
 }
 ```
 
 ```http
-GET https://api.i-meto.com/ip/v1/ipip/119.29.29.29
+GET http://localhost:3000/v1/qqwry/me
 ```
 
 ```json
 {
-  "ip": "119.29.29.29",
-  "country_name": "DNSPOD.COM",
-  "region_name": "DNSPOD.COM",
+  "ip": "127.0.0.1",
+  "country_name": "本机地址",
+  "region_name": "本机地址",
   "city_name": "",
   "owner_domain": "",
-  "isp_domain": "",
-  "range": {
-    "from": "119.29.29.0",
-    "to": "119.29.29.255"
-  }
+  "isp_domain": ""
 }
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docker-ipdb",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "server.js",
   "repository": "[email protected]:metowolf/docker-ipdb.git",
   "author": "metowolf <[email protected]>",
@@ -18,11 +18,11 @@
     "koa-pino-logger": "^3.0.0",
     "koa-router": "^10.0.0",
     "koa2-cors": "^2.0.6",
-    "pino": "^6.11.3",
-    "pino-pretty": "^5.1.0",
-    "qqwry.ipdb": "^2021.6.30"
+    "pino": "^6.12.0",
+    "pino-pretty": "^5.1.1",
+    "qqwry.ipdb": "^2021.7.7"
   },
   "devDependencies": {
-    "nodemon": "^2.0.9"
+    "nodemon": "^2.0.12"
   }
 }

src/config.js

@@ -5,5 +5,7 @@ module.exports = {
     port: parseInt(process.env.HTTP_PORT || 3000, 10),
     host: process.env.HTTP_HOST || 'localhost',
     prefix: process.env.HTTP_PREFIX || ''
-  }
+  },
+  client_header: process.env.CLIENT_HEADER || 'x-real-ip',
+  disable_range: (process.env.DISABLE_RANGE || 'true') === 'true'
 }

src/services/v1/ipip/routes.js

@@ -2,6 +2,7 @@ const Router = require('koa-router')
 const IPDB = require('ipdb')
 const ipdb_range = require('@ipdb/range')
 const ipdb_database = require('@ipdb/database')
+const config = require('../../../config')
 const ipdb = new IPDB(ipdb_database, {
   patches: [ipdb_range]
 })
@@ -26,7 +27,10 @@ router.get('/version', async (ctx) => {
 // find ip
 router.get('/:ip', async (ctx) => {
   try {
-    const ip = ctx.params.ip
+    let ip = ctx.params.ip
+    if (ip === 'me') {
+      ip = ctx.headers[config.client_header] || ctx.ip
+    }
     const { code, data, message } = ipdb.find(ip)
     if (code) {
       throw new Error(message)
@@ -37,8 +41,10 @@ router.get('/:ip', async (ctx) => {
       region_name: data.region_name,
       city_name: data.city_name,
       owner_domain: data.owner_domain || '',
-      isp_domain: data.isp_domain || '',
-      range: {
+      isp_domain: data.isp_domain || ''
+    }
+    if (!config.disable_range) {
+      result.range = {
         from: data.range.from,
         to: data.range.to
       }

src/services/v1/qqwry/routes.js

@@ -2,6 +2,7 @@ const Router = require('koa-router')
 const IPDB = require('ipdb')
 const ipdb_range = require('@ipdb/range')
 const qqwry_ipdb = require('qqwry.ipdb')
+const config = require('../../../config')
 const ipdb = new IPDB(qqwry_ipdb, {
   patches: [ipdb_range]
 })
@@ -26,7 +27,10 @@ router.get('/version', async (ctx) => {
 // find ip
 router.get('/:ip', async (ctx) => {
   try {
-    const ip = ctx.params.ip
+    let ip = ctx.params.ip
+    if (ip === 'me') {
+      ip = ctx.headers[config.client_header] || ctx.ip
+    }
     const { code, data, message } = ipdb.find(ip)
     if (code) {
       throw new Error(message)
@@ -37,8 +41,10 @@ router.get('/:ip', async (ctx) => {
       region_name: data.region_name,
       city_name: data.city_name,
       owner_domain: data.owner_domain || '',
-      isp_domain: data.isp_domain || '',
-      range: {
+      isp_domain: data.isp_domain || ''
+    }
+    if (!config.disable_range) {
+      result.range = {
         from: data.range.from,
         to: data.range.to
       }