import path from 'path'; import { getClientIp } from 'request-ip'; import { browserName, detectOS } from 'detect-browser'; import isLocalhost from 'is-localhost-ip'; import maxmind from 'maxmind'; import { safeDecodeURIComponent } from 'next-basics'; import { DESKTOP_OS, MOBILE_OS, DESKTOP_SCREEN_WIDTH, LAPTOP_SCREEN_WIDTH, MOBILE_SCREEN_WIDTH, } from './constants'; import { NextApiRequestCollect } from 'pages/api/send'; let lookup; export function getIpAddress(req) { // Custom header if (req.headers[process.env.CLIENT_IP_HEADER]) { return req.headers[process.env.CLIENT_IP_HEADER]; } // Cloudflare else if (req.headers['cf-connecting-ip']) { return req.headers['cf-connecting-ip']; } return getClientIp(req); } export function getDevice(screen, os) { if (!screen) return; const [width] = screen.split('x'); if (DESKTOP_OS.includes(os)) { if (os === 'Chrome OS' || width < DESKTOP_SCREEN_WIDTH) { return 'laptop'; } return 'desktop'; } else if (MOBILE_OS.includes(os)) { if (os === 'Amazon OS' || width > MOBILE_SCREEN_WIDTH) { return 'tablet'; } return 'mobile'; } if (width >= DESKTOP_SCREEN_WIDTH) { return 'desktop'; } else if (width >= LAPTOP_SCREEN_WIDTH) { return 'laptop'; } else if (width >= MOBILE_SCREEN_WIDTH) { return 'tablet'; } else { return 'mobile'; } } function getRegionCode(country, region) { if (!country || !region) { return undefined; } return region.includes('-') ? region : `${country}-${region}`; } export async function getLocation(ip, req) { // Ignore local ips if (await isLocalhost(ip)) { return; } // Cloudflare headers if (req.headers['cf-ipcountry']) { const country = safeDecodeURIComponent(req.headers['cf-ipcountry']); const subdivision1 = safeDecodeURIComponent(req.headers['cf-region-code']); const city = safeDecodeURIComponent(req.headers['cf-ipcity']); return { country, subdivision1: getRegionCode(country, subdivision1), city, }; } // Vercel headers if (req.headers['x-vercel-ip-country']) { const country = safeDecodeURIComponent(req.headers['x-vercel-ip-country']); const subdivision1 = safeDecodeURIComponent(req.headers['x-vercel-ip-country-region']); const city = safeDecodeURIComponent(req.headers['x-vercel-ip-city']); return { country, subdivision1: getRegionCode(country, subdivision1), city, }; } // Database lookup if (!lookup) { const dir = path.join(process.cwd(), 'geo'); lookup = await maxmind.open(path.resolve(dir, 'GeoLite2-City.mmdb')); } const result = lookup.get(ip); if (result) { const country = result.country?.iso_code ?? result?.registered_country?.iso_code; const subdivision1 = result.subdivisions?.[0]?.iso_code; const subdivision2 = result.subdivisions?.[1]?.names?.en; const city = result.city?.names?.en; return { country, subdivision1: getRegionCode(country, subdivision1), subdivision2, city, }; } } export async function getClientInfo(req: NextApiRequestCollect, { screen }) { const userAgent = req.headers['user-agent']; const ip = req.body.payload.ip || getIpAddress(req); const location = await getLocation(ip, req); const country = location?.country; const subdivision1 = location?.subdivision1; const subdivision2 = location?.subdivision2; const city = location?.city; const browser = browserName(userAgent); const os = detectOS(userAgent); const device = getDevice(screen, os); return { userAgent, browser, os, ip, country, subdivision1, subdivision2, city, device }; }