Merge pull request #66 from kairi003/develop

release v0.6.0

.gitignore

@@ -103,4 +103,5 @@ dist
 # TernJS port file
 .tern-port
 
+dst/
 *.zip

README.md

@@ -43,6 +43,13 @@ Specifically, it now needs "Download management" to execute a more appropriate f
 3. Enable "Developer mode".
 4. Click on "Load Unpacked" and open the directory `Get-cookies.txt-LOCALLY/src`.
 
+## Build for Firefox
+1. Download and unzip this repository.
+2. Merge `src/manifest.json` and `src/manifest-firefox.json` using one of the following methods:
+   - `npm install && npm run build:firfox` and install generated `.zip` file from the `dist` directory.
+   - `jq -s '.[0] + .[1]' src/manifest.json src/manifest-firefox.json > src/manifest.json` and install the extension from the `src` rectory.
+   - Merge manually.
+
 
 
 ## Example of extension installation directory (Google Chrome)

build.js

@@ -1,25 +1,25 @@
+#!/usr/bin/env node
+
 const fs = require('fs');
 const process = require('process');
 const path = require('path');
 const archiver = require('archiver');
-const { exec } = require('child_process');
-
+const { execSync } = require('child_process');
+const { program } = require('commander');
 
-const getBranch = () => new Promise((resolve, reject) => {
-  exec('git rev-parse --abbrev-ref HEAD', (err, stdout, stderr) => {
-    if (typeof stdout === 'string') {
-      resolve(stdout.trim());
-    } else {
-      reject(TypeError);
-    }
-  });
-});
+const options = program.option('-f --firefox', 'Build for Firefox').parse(process.argv).opts();
 
+const getGitInfo = () => {
+  const branch = execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
+  const commitHash = execSync('git rev-parse HEAD').toString().trim();
+  return { branch, commitHash };
+};
 
-const build = async (name) => {
-  const dt = new Date().toLocaleString('sv').replace(/\D/g, '');
-  const zipPath = `${name.replace('/', '_')}_${dt}.zip`;
-  const output = fs.createWriteStream(path.join(__dirname, zipPath));
+const build = async ({ branch, commitHash }) => {
+  const mode = options.firefox ? 'firefox' : 'chrome';
+  const zipName = `${branch.replace('/', '_')}_${commitHash.slice(0,5)}_${mode}.zip`;
+  fs.mkdirSync(path.join(__dirname, 'dst'), { recursive: true });
+  const output = fs.createWriteStream(path.join(__dirname, 'dst', zipName));
 
   process.chdir(path.join(__dirname, 'src'));
 
@@ -28,11 +28,17 @@ const build = async (name) => {
   });
 
   archive.pipe(output);
-  archive.glob('**/*');
+  archive.glob('**/*', { ignore: ['**/*.json'] });
 
-  await archive.finalize();
-  console.log('BUILD', zipPath);
-}
+  const manifest = JSON.parse(fs.readFileSync('manifest.json'));
+  if (options.firefox) {
+    const manifestFirefox = JSON.parse(fs.readFileSync('manifest-firefox.json'));
+    Object.assign(manifest, manifestFirefox);
+  }
+  archive.append(JSON.stringify(manifest, null, 2), { name: 'manifest.json' });
 
+  archive.finalize();
+  console.log('BUILD', zipName);
+};
 
-getBranch().then(build);
+build(getGitInfo());

package.json

@@ -3,11 +3,14 @@
     "@types/chrome": "^0.0.218",
     "@types/wicg-file-system-access": "^2020.9.5",
     "archiver": "^5.3.1",
+    "commander": "^12.1.0",
     "icon-gen": "^3.0.1",
     "prettier": "^3.2.5"
   },
   "scripts": {
     "format": "npx prettier --write src",
-    "build": "npm run format && node build.js"
+    "build": "npm run build:chrome && npm run build:firefox",
+    "build:chrome": "node build.js",
+    "build:firefox": "node build.js --firefox"
   }
 }

src/@types/index.d.ts

@@ -0,0 +1,5 @@
+type Format = {
+  ext: string;
+  mimeType: string;
+  serializer: (cookies: chrome.cookies.Cookie[]) => string;
+};

src/background.html

@@ -0,0 +1,2 @@
+<!-- This file is used to load the background script on Firefox. -->
+<script type="module" src="background.mjs"></script>

src/background.js → src/background.mjs

@@ -1,24 +1,4 @@
-/**
- * Retrieves both cookies with and without a partition key and returns the merged list
- * @param {chrome.cookies.GetAllDetails} details
- * @returns {chrome.cookies.Cookie[]}
- */
-const getAllCookies = async (details) => {
-  const { partitionKey, ...detailsWithoutPartitionKey } = details;
-  const cookiesWithPartitionKey = partitionKey ? await chrome.cookies.getAll(details) : [];
-  const cookies = await chrome.cookies.getAll(detailsWithoutPartitionKey);
-  return [...cookies, ...cookiesWithPartitionKey];
-};
-
-// Listen for messages from popup.js
-chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
-  if (message.action === 'requestAllCookies') {
-    const { details } = message;
-    getAllCookies(details).then(sendResponse);
-    return true;
-  }
-  return false;
-});
+import getAllCookies from './modules/get_all_cookies.mjs';
 
 /**
  * Update icon badge counter on active page

src/manifest-firefox.json

@@ -0,0 +1,11 @@
+{
+  "incognito": "spanning",
+  "background": {
+    "page": "background.html"
+  },
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "{ac87cfd8-47b1-4401-b32e-f033af5ed96b}"
+    }
+  }
+}

src/manifest.json

@@ -1,7 +1,7 @@
 {
   "name": "Get cookies.txt LOCALLY",
   "description": "Get cookies.txt, NEVER send information outside with open-source",
-  "version": "0.5.7",
+  "version": "0.6.2",
   "manifest_version": 3,
   "permissions": ["activeTab", "cookies", "downloads", "notifications"],
   "host_permissions": ["<all_urls>"],
@@ -22,6 +22,7 @@
   },
   "incognito": "split",
   "background": {
-    "service_worker": "background.js"
+    "service_worker": "background.mjs",
+    "type": "module"
   }
 }

src/modules/cookie_format.mjs

@@ -0,0 +1,38 @@
+/**
+ * Convert Chrome's JSON format cookies data to a string array for Netscape format
+ * @param {chrome.cookies.Cookie[]} cookies
+ * @returns {string[][]}
+ */
+export const jsonToNetscapeMapper = (cookies) => {
+  return cookies.map(({ domain, expirationDate, path, secure, name, value }) => {
+    const includeSubDomain = !!domain?.startsWith('.');
+    const expiry = expirationDate?.toFixed() ?? '0';
+    const arr = [domain, includeSubDomain, path, secure, expiry, name, value];
+    return arr.map((v) => (typeof v === 'boolean' ? v.toString().toUpperCase() : v));
+  });
+};
+
+/** @type {Record<string, Format>} */
+export const formatMap = {
+  netscape: {
+    ext: '.txt',
+    mimeType: 'text/plain',
+    serializer: (cookies) => {
+      const netscapeTable = jsonToNetscapeMapper(cookies);
+      const text = [
+        '# Netscape HTTP Cookie File',
+        '# http://curl.haxx.se/rfc/cookie_spec.html',
+        '# This is a generated file!  Do not edit.',
+        '',
+        ...netscapeTable.map((row) => row.join('\t')),
+        '' // Add a new line at the end
+      ].join('\n');
+      return text;
+    }
+  },
+  json: {
+    ext: '.json',
+    mimeType: 'application/json',
+    serializer: JSON.stringify
+  }
+};

src/modules/get_all_cookies.mjs

@@ -0,0 +1,29 @@
+/**
+ * Get all cookies that match the given criteria.
+ * @param {chrome.cookies.GetAllDetails} details
+ * @returns {Promise<chrome.cookies.Cookie[]>}
+ */
+export default async function getAllCookies(details) {
+  details.storeId ??= await getCurrentCookieStoreId();
+  const { partitionKey, ...detailsWithoutPartitionKey } = details;
+  const cookiesWithPartitionKey = partitionKey ? await chrome.cookies.getAll(details) : [];
+  const cookies = await chrome.cookies.getAll(detailsWithoutPartitionKey);
+  return [...cookies, ...cookiesWithPartitionKey];
+}
+
+/**
+ * Get the current cookie store ID.
+ * @returns {Promise<string | undefined>}
+ */
+const getCurrentCookieStoreId = async () => {
+  // If the extension is in split incognito mode, return undefined to choose the default store.
+  if (chrome.runtime.getManifest().incognito === 'split') return undefined;
+
+  // Firefox supports the `tab.cookieStoreId` property.
+  const [tab] = await chrome.tabs.query({ active: true, currentWindow: true });
+  if (tab.cookieStoreId) return tab.cookieStoreId;
+
+  // Chrome does not support the `tab.cookieStoreId` property.
+  const stores = await chrome.cookies.getAllCookieStores();
+  return stores.find((store) => store.tabIds.includes(tab.id))?.id;
+};

src/popup-options.css

@@ -12,6 +12,6 @@
   gap: 0.5em;
 }
 
-.netscape-table.nowrap {
+.netscape-table.nowrap tbody {
   white-space: nowrap;
 }

src/popup.html

@@ -7,7 +7,7 @@
     <link rel="stylesheet" href="popup-options.css" />
     <link rel="stylesheet" href="iconfont/material-icons.css" />
     <link rel="stylesheet" href="donation.css" />
-    <script src="popup.js" defer></script>
+    <script src="popup.mjs" type="module" defer></script>
     <script src="table-nowrap.js" defer></script>
   </head>