Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

feat: add location data to user agent

Marc Seitzd504278e4f30
diff --git a/components/visitors/visitor-useragent.tsx b/components/visitors/visitor-useragent.tsx
index a9d90adb..fb37e2ba 100644
--- a/components/visitors/visitor-useragent.tsx
+++ b/components/visitors/visitor-useragent.tsx
@@ -1,5 +1,6 @@
import ErrorPage from "next/error";
+import { COUNTRIES } from "@/lib/constants";
import { useVisitorUserAgent } from "@/lib/swr/use-stats";
import UAIcon from "../user-agent-icon";
@@ -15,21 +16,38 @@ export default function VisitorUserAgent({ viewId }: { viewId: string }) {
return <div>Loading...</div>;
}
- const { device, browser, os } = userAgent;
+ const { device, browser, os, country, city } = userAgent;
return (
- <div className="pb-0.5 pl-0.5 md:pb-1 md:pl-1">
- <div className="flex items-center">
- <div className="flex items-center gap-x-1 px-1">
- <UAIcon display={device} type="devices" className="size-4" /> {device}
- ,
- </div>
- <div className="flex items-center gap-x-1 px-1">
- <UAIcon display={browser} type="browsers" className="size-4" />{" "}
- {browser},
- </div>
- <div className="flex items-center gap-x-1 px-1">
- <UAIcon display={os} type="os" className="size-4" /> {os}
+ <div>
+ <div className="pb-0.5 pl-0.5 md:pb-1 md:pl-1">
+ {city && country ? (
+ <div className="flex items-center">
+ <div className="flex items-center gap-x-1 px-1">
+ <img
+ alt={country}
+ src={`https://flag.vercel.app/m/${country}.svg`}
+ className="h-3 w-4"
+ />
+ <span>{city},</span>
+ <span>{COUNTRIES[country]}</span>
+ </div>
+ </div>
+ ) : null}
+ </div>
+ <div className="pb-0.5 pl-0.5 md:pb-1 md:pl-1">
+ <div className="flex items-center">
+ <div className="flex items-center gap-x-1 px-1">
+ <UAIcon display={device} type="devices" className="size-4" />{" "}
+ {device},
+ </div>
+ <div className="flex items-center gap-x-1 px-1">
+ <UAIcon display={browser} type="browsers" className="size-4" />{" "}
+ {browser},
+ </div>
+ <div className="flex items-center gap-x-1 px-1">
+ <UAIcon display={os} type="os" className="size-4" /> {os}
+ </div>
</div>
</div>
</div>
diff --git a/lib/constants.ts b/lib/constants.ts
index 3397fa42..6ad9d887 100644
--- a/lib/constants.ts
+++ b/lib/constants.ts
@@ -104,3 +104,258 @@ export const SUPPORTED_DOCUMENT_SIMPLE_TYPES = [
"cad",
"image",
];
+
+export const COUNTRIES: { [key: string]: string } = {
+ AF: "Afghanistan",
+ AL: "Albania",
+ DZ: "Algeria",
+ AS: "American Samoa",
+ AD: "Andorra",
+ AO: "Angola",
+ AI: "Anguilla",
+ AQ: "Antarctica",
+ AG: "Antigua and Barbuda",
+ AR: "Argentina",
+ AM: "Armenia",
+ AW: "Aruba",
+ AU: "Australia",
+ AT: "Austria",
+ AZ: "Azerbaijan",
+ BS: "Bahamas",
+ BH: "Bahrain",
+ BD: "Bangladesh",
+ BB: "Barbados",
+ BY: "Belarus",
+ BE: "Belgium",
+ BZ: "Belize",
+ BJ: "Benin",
+ BM: "Bermuda",
+ BT: "Bhutan",
+ BO: "Bolivia",
+ BA: "Bosnia and Herzegovina",
+ BW: "Botswana",
+ BV: "Bouvet Island",
+ BR: "Brazil",
+ IO: "British Indian Ocean Territory",
+ BN: "Brunei Darussalam",
+ BG: "Bulgaria",
+ BF: "Burkina Faso",
+ BI: "Burundi",
+ KH: "Cambodia",
+ CM: "Cameroon",
+ CA: "Canada",
+ CV: "Cape Verde",
+ KY: "Cayman Islands",
+ CF: "Central African Republic",
+ TD: "Chad",
+ CL: "Chile",
+ CN: "China",
+ CX: "Christmas Island",
+ CC: "Cocos (Keeling) Islands",
+ CO: "Colombia",
+ KM: "Comoros",
+ CG: "Congo (Republic)",
+ CD: "Congo (Democratic Republic)",
+ CK: "Cook Islands",
+ CR: "Costa Rica",
+ CI: "Ivory Coast",
+ HR: "Croatia",
+ CU: "Cuba",
+ CY: "Cyprus",
+ CZ: "Czech Republic",
+ DK: "Denmark",
+ DJ: "Djibouti",
+ DM: "Dominica",
+ DO: "Dominican Republic",
+ EC: "Ecuador",
+ EG: "Egypt",
+ SV: "El Salvador",
+ GQ: "Equatorial Guinea",
+ ER: "Eritrea",
+ EE: "Estonia",
+ ET: "Ethiopia",
+ FK: "Falkland Islands",
+ FO: "Faroe Islands",
+ FJ: "Fiji",
+ FI: "Finland",
+ FR: "France",
+ GF: "French Guiana",
+ PF: "French Polynesia",
+ TF: "French Southern Territories",
+ GA: "Gabon",
+ GM: "Gambia",
+ GE: "Georgia",
+ DE: "Germany",
+ GH: "Ghana",
+ GI: "Gibraltar",
+ GR: "Greece",
+ GL: "Greenland",
+ GD: "Grenada",
+ GP: "Guadeloupe",
+ GU: "Guam",
+ GT: "Guatemala",
+ GN: "Guinea",
+ GW: "Guinea-Bissau",
+ GY: "Guyana",
+ HT: "Haiti",
+ HM: "Heard Island and McDonald Islands",
+ VA: "Vatican City",
+ HN: "Honduras",
+ HK: "Hong Kong",
+ HU: "Hungary",
+ IS: "Iceland",
+ IN: "India",
+ ID: "Indonesia",
+ IR: "Iran",
+ IQ: "Iraq",
+ IE: "Ireland",
+ IL: "Israel",
+ IT: "Italy",
+ JM: "Jamaica",
+ JP: "Japan",
+ JO: "Jordan",
+ KZ: "Kazakhstan",
+ KE: "Kenya",
+ KI: "Kiribati",
+ KP: "North Korea",
+ KR: "South Korea",
+ KW: "Kuwait",
+ KG: "Kyrgyzstan",
+ LA: "Laos",
+ LV: "Latvia",
+ LB: "Lebanon",
+ LS: "Lesotho",
+ LR: "Liberia",
+ LY: "Libya",
+ LI: "Liechtenstein",
+ LT: "Lithuania",
+ LU: "Luxembourg",
+ MO: "Macao",
+ MG: "Madagascar",
+ MW: "Malawi",
+ MY: "Malaysia",
+ MV: "Maldives",
+ ML: "Mali",
+ MT: "Malta",
+ MH: "Marshall Islands",
+ MQ: "Martinique",
+ MR: "Mauritania",
+ MU: "Mauritius",
+ YT: "Mayotte",
+ MX: "Mexico",
+ FM: "Micronesia",
+ MD: "Moldova",
+ MC: "Monaco",
+ MN: "Mongolia",
+ MS: "Montserrat",
+ MA: "Morocco",
+ MZ: "Mozambique",
+ MM: "Myanmar",
+ NA: "Namibia",
+ NR: "Nauru",
+ NP: "Nepal",
+ NL: "Netherlands",
+ NC: "New Caledonia",
+ NZ: "New Zealand",
+ NI: "Nicaragua",
+ NE: "Niger",
+ NG: "Nigeria",
+ NU: "Niue",
+ NF: "Norfolk Island",
+ MK: "Macedonia",
+ MP: "Northern Mariana Islands",
+ NO: "Norway",
+ OM: "Oman",
+ PK: "Pakistan",
+ PW: "Palau",
+ PS: "Palestine",
+ PA: "Panama",
+ PG: "Papua New Guinea",
+ PY: "Paraguay",
+ PE: "Peru",
+ PH: "Philippines",
+ PN: "Pitcairn",
+ PL: "Poland",
+ PT: "Portugal",
+ PR: "Puerto Rico",
+ QA: "Qatar",
+ RE: "Reunion",
+ RO: "Romania",
+ RU: "Russia",
+ RW: "Rwanda",
+ SH: "Saint Helena",
+ KN: "Saint Kitts and Nevis",
+ LC: "Saint Lucia",
+ PM: "Saint Pierre and Miquelon",
+ VC: "Saint Vincent and the Grenadines",
+ WS: "Samoa",
+ SM: "San Marino",
+ ST: "Sao Tome and Principe",
+ SA: "Saudi Arabia",
+ SN: "Senegal",
+ SC: "Seychelles",
+ SL: "Sierra Leone",
+ SG: "Singapore",
+ SK: "Slovakia",
+ SI: "Slovenia",
+ SB: "Solomon Islands",
+ SO: "Somalia",
+ ZA: "South Africa",
+ GS: "South Georgia and the South Sandwich Islands",
+ ES: "Spain",
+ LK: "Sri Lanka",
+ SD: "Sudan",
+ SR: "Suriname",
+ SJ: "Svalbard and Jan Mayen",
+ SZ: "Eswatini",
+ SE: "Sweden",
+ CH: "Switzerland",
+ SY: "Syrian Arab Republic",
+ TW: "Taiwan",
+ TJ: "Tajikistan",
+ TZ: "Tanzania",
+ TH: "Thailand",
+ TL: "Timor-Leste",
+ TG: "Togo",
+ TK: "Tokelau",
+ TO: "Tonga",
+ TT: "Trinidad and Tobago",
+ TN: "Tunisia",
+ TR: "Turkey",
+ TM: "Turkmenistan",
+ TC: "Turks and Caicos Islands",
+ TV: "Tuvalu",
+ UG: "Uganda",
+ UA: "Ukraine",
+ AE: "United Arab Emirates",
+ GB: "United Kingdom",
+ US: "United States",
+ UM: "United States Minor Outlying Islands",
+ UY: "Uruguay",
+ UZ: "Uzbekistan",
+ VU: "Vanuatu",
+ VE: "Venezuela",
+ VN: "Vietnam",
+ VG: "Virgin Islands, British",
+ VI: "Virgin Islands, U.S.",
+ WF: "Wallis and Futuna",
+ EH: "Western Sahara",
+ YE: "Yemen",
+ ZM: "Zambia",
+ ZW: "Zimbabwe",
+ AX: "Åland Islands",
+ BQ: "Bonaire, Sint Eustatius and Saba",
+ CW: "Curaçao",
+ GG: "Guernsey",
+ IM: "Isle of Man",
+ JE: "Jersey",
+ ME: "Montenegro",
+ BL: "Saint Barthélemy",
+ MF: "Saint Martin (French part)",
+ RS: "Serbia",
+ SX: "Sint Maarten (Dutch part)",
+ SS: "South Sudan",
+ XK: "Kosovo",
+};
+
+export const COUNTRY_CODES = Object.keys(COUNTRIES) as [string, ...string[]];
diff --git a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/user-agent.ts b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/user-agent.ts
index f61513af..87733eeb 100644
--- a/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/user-agent.ts
+++ b/pages/api/teams/[teamId]/documents/[id]/views/[viewId]/user-agent.ts
@@ -43,6 +43,7 @@ export default async function handle(
},
select: {
id: true,
+ plan: true,
},
});
@@ -50,6 +51,10 @@ export default async function handle(
return res.status(401).end("Unauthorized");
}
+ if (team.plan.includes("free")) {
+ return res.status(403).end("Forbidden");
+ }
+
const userAgent = await getViewUserAgent({
documentId: docId,
viewId: viewId,
@@ -57,10 +62,14 @@ export default async function handle(
});
const userAgentData = userAgent.data[0];
- // don't send location to the client
- const { country, city, ...remainingResponse } = userAgentData;
-
- return res.status(200).json(remainingResponse);
+ // Include country and city for business and datarooms plans
+ if (team.plan.includes("business") || team.plan.includes("datarooms")) {
+ return res.status(200).json(userAgentData);
+ } else {
+ // For other plans, exclude country and city
+ const { country, city, ...remainingResponse } = userAgentData;
+ return res.status(200).json(remainingResponse);
+ }
} catch (error) {
errorhandler(error, res);
}