${message.metadata.time}`;
+ }
+ }
+
+ return metadata;
+}
+
+export function formatMessage(message) {
+ let metadata = formatMetadata(message);
+ let html = message.messageText;
+ let divClass = 'message';
+
+ if (message.type === 'audio') {
+ html = `
`;
+ } else if (message.type === 'image') {
+ html = `
`;
+ metadata = '';
+ } else if (message.type === 'vcard') {
+ html = `
Contact card `;
+ } else if (message.type === 'video') {
+ // All video is either already mp4 or has been converted to mp4.
+ const relativePath = message.messageText.relativePath.replace(path.extname(message.messageText.relativePath), '.mp4');
+
+ html = `
+
+
+ Sorry, your browser doesn't support embedded videos.
+
+
`;
+ } else if (message.type === 'separator') {
+ divClass = '';
+ }
+
+ return `\n
+ ${html}${metadata}
+
`;
+}
diff --git a/src/library/options.js b/src/library/options.js
new file mode 100644
index 0000000..e27f2c9
--- /dev/null
+++ b/src/library/options.js
@@ -0,0 +1,44 @@
+import fs from 'fs';
+import path from 'path';
+import { Command, Option } from 'commander';
+
+export const program = new Command();
+
+program
+ .name('google-voice-transformer')
+ .description('CLI to convert Google Takeout (Voice) to a more readable format')
+ .version('0.1.0');
+
+program
+ .description('Convert the Google Takeout format to a more readable format.')
+ .option('--path
', '(optional) The path to your Takeout folder. The program will look for this folder in the same directory')
+ .addOption(new Option('--template ', '(optional) The output file template').choices(['default', 'whatsapp']));
+
+export const options = {};
+
+program.parse();
+
+const userInput = program.opts();
+
+// Clean the template option.
+userInput.template = userInput.template ?? 'default';
+options.template = userInput.template.toLowerCase();
+
+// Verify that the path to the data directory exists.
+options.path = path.normalize(userInput.path ?? path.join(process.cwd(), 'Takeout')).replaceAll('\\', '/');
+
+if (fs.existsSync(options.path) === false) {
+ program.error('The path to the Takeout folder does not exist. Either run this program from the same place where you are storing your Takeout directory or use the --path option to point the program to the location of your Takeout directory.');
+}
+
+options.callsPath = path.join(options.path, 'Voice', 'Calls').replaceAll('\\', '/');
+
+// Verify that the Calls sub-directory exists in the Takeout folder.
+if (fs.existsSync(options.callsPath) === false) {
+ program.error('Your Takeout folder does not contain the ./Takeout/Voice/Calls subdirectory.');
+}
+
+export const globOptions = {
+ dot: false,
+ onlyFiles: true,
+};
diff --git a/src/library/output.js b/src/library/output.js
new file mode 100644
index 0000000..ce9c18b
--- /dev/null
+++ b/src/library/output.js
@@ -0,0 +1,95 @@
+import fs from 'fs';
+import path from 'path';
+import { writeFile } from 'fs/promises';
+import convert from './convert.js';
+import { formatMessage } from './format.js';
+import { options } from './options.js';
+
+import templateDefault from '../templates/default.html';
+import templateWhatsapp from '../templates/whatsapp.html';
+import stylesDefault from '../templates/default.css';
+import stylesWhatsapp from '../templates/whatsapp.css';
+
+const templates = {
+ default: templateDefault,
+ whatsapp: templateWhatsapp,
+};
+
+const styles = {
+ default: stylesDefault,
+ whatsapp: stylesWhatsapp,
+};
+
+export function createFolder(name) {
+ const outputPath = path.join(process.cwd(), name);
+
+ if (fs.existsSync(outputPath) === false) {
+ fs.mkdirSync(outputPath, { recursive: true });
+ }
+
+ return outputPath;
+}
+
+export function outputName(batch) {
+ let contact = 'Unknown';
+
+ if (batch.contact.name !== '' && batch.contact.tel !== '' && batch.contact.name !== batch.contact.tel) {
+ contact = `${batch.contact.name} (${batch.contact.tel})`;
+ } else if (batch.contact.name === '' && batch.contact.tel !== '') {
+ contact = batch.contact.tel;
+ } else if (batch.contact.name !== '' && batch.contact.tel === '') {
+ contact = batch.contact.name;
+ } else if (batch.contact.tel !== '') {
+ contact = batch.contact.tel;
+ }
+
+ return contact;
+}
+
+export async function compile(batch) {
+ const output = [];
+ const promises = [];
+ const mediaFolder = `output/media/${outputName(batch)}`;
+
+ createFolder(mediaFolder);
+
+ batch.messages.forEach((message) => {
+ if (['audio', 'image', 'vcard', 'video'].includes(message.type)) {
+ if (message.type === 'video' && path.extname(message.messageText.relativePath) !== '.mp4') {
+ promises.push(convert(message.messageText));
+ } else if (message.messageText.fullPath !== '') {
+ const sourceExists = fs.existsSync(message.messageText.fullPath);
+ const targetExists = fs.existsSync(mediaFolder);
+
+ // This is not a video media file.
+ if (!sourceExists) {
+ console.warn('[WARN] The source media file is not accessible.');
+ console.log(`\t${message.messageText.fullPath}`);
+ } else if (!targetExists) {
+ console.warn('[WARN] The target media folder is not accessible.');
+ console.log(`\t${mediaFolder}`);
+ } else {
+ fs.copyFileSync(message.messageText.fullPath, path.join(mediaFolder, message.messageText.filename));
+ }
+ }
+ }
+
+ output.push(formatMessage(message));
+ });
+
+ if (promises.length > 0) {
+ await Promise.all(promises);
+ }
+
+ const html = templates[options.template]
+ .replace('{{messages}}', output.join(''))
+ .replace('{{styles}}', styles[options.template])
+ .replace('{{contact.name}}', batch.contact.name)
+ .replace('{{contact.tel}}', batch.contact.tel);
+
+ const filename = `${outputName(batch)}.html`;
+
+ writeFile(`output/${filename}`, html).then(() => {
+ console.log(`Compiled ${filename}`);
+ });
+}
diff --git a/src/library/parse.js b/src/library/parse.js
new file mode 100644
index 0000000..7309025
--- /dev/null
+++ b/src/library/parse.js
@@ -0,0 +1,254 @@
+import fs, { existsSync } from 'fs';
+import path from 'path';
+import fg from 'fast-glob';
+import { parse } from 'node-html-parser';
+import { formatSeparator, formatTime } from './format.js';
+import { globOptions, options } from './options.js';
+import { compile, outputName } from './output.js';
+
+const audioExtensions = ['amr', 'mp3'];
+const imageExtensions = ['gif', 'jpg', 'jpeg', 'png', 'webp'];
+const videoExtensions = ['3gp', 'mp4', 'mpg'];
+const attachmentExtensions = [
+ ...audioExtensions,
+ ...imageExtensions,
+ ...videoExtensions,
+ // Virtual contact file
+ 'vcf',
+];
+
+// Get a list of all attachment files.
+const attachmentSources = [];
+
+fg.sync([`${options.callsPath}/* - Text - *.{${attachmentExtensions.join(',')}}`], { ...globOptions, objectMode: true }).forEach((attachment) => {
+ attachmentSources.push(attachment.name);
+});
+
+const batch = {
+ contact: {
+ name: '',
+ tel: '',
+ me: '',
+ },
+ messages: [],
+};
+
+function extractContact(telephoneLinks, filepath) {
+ const details = {
+ name: '',
+ tel: '',
+ };
+
+ telephoneLinks.forEach((link) => {
+ const child = link.querySelector('span.fn');
+
+ if (child !== null) {
+ // This is a message sent by the other person.
+ // Extract the telephone number.
+ details.tel = link.getAttribute('href').replace('tel:', '');
+ details.name = child.text;
+ }
+
+ if (batch.contact.me === '' || typeof batch.contact.me === 'undefined') {
+ const childMe = link.querySelector('abbr.fn');
+
+ if (childMe !== null) {
+ const telephone = link.getAttribute('href').trim();
+
+ if (telephone !== 'tel:') {
+ batch.contact.me = telephone;
+ }
+ }
+ }
+ });
+
+ // Fallback on extracting either the name or telephone number from the filename.
+ const basename = path.basename(filepath, path.extname(filepath));
+ const filenameContact = basename.split(' - ')[0].trim();
+
+ if (details.tel === '' && filenameContact.charAt(0) === '+') {
+ details.tel = filenameContact;
+ }
+
+ if (details.name === '') {
+ details.name = filenameContact;
+ }
+
+ return details;
+}
+
+function findMedia(type, basename) {
+ const details = {
+ filename: basename,
+ fullPath: '',
+ relativePath: '',
+ };
+ let extensions = attachmentExtensions;
+
+ if (type === 'audio') {
+ extensions = audioExtensions;
+ } else if (type === 'image') {
+ extensions = imageExtensions;
+ } else if (type === 'vcard') {
+ extensions = ['vcf'];
+ } else if (type === 'video') {
+ extensions = videoExtensions;
+ }
+
+ if (!existsSync(path.join('data', basename))) {
+ // This media basename does not exist as a complete filename. Try looking for it with some extensions.
+ extensions.some((extension) => {
+ const filename = `${basename}.${extension}`;
+ const fullPath = path.join(options.callsPath, filename);
+
+ if (attachmentSources.includes(filename)) {
+ details.filename = filename;
+ details.fullPath = fullPath;
+ details.relativePath = path.join('media', batch.contact.outputName, filename).replaceAll('\\', '/');
+
+ return true;
+ }
+
+ // The filename on disk may be truncated.
+ attachmentSources.some((attachment) => {
+ if (path.extname(attachment).toLowerCase() === `.${extension}`) {
+ const base = path.basename(attachment, path.extname(attachment));
+
+ if (basename.includes(base)) {
+ details.filename = `${base}.${extension}`;
+ details.fullPath = path.join(options.callsPath, details.filename);
+ details.relativePath = path.join('media', batch.contact.outputName, details.filename).replaceAll('\\', '/');
+
+ return true;
+ }
+ }
+
+ return false;
+ });
+
+ return false;
+ });
+ }
+
+ if (details.fullPath === '') {
+ console.warn('[WARN] A media file referenced in the text message is not present in your Takeout directory.');
+ console.log(`\tType: ${type} Basename: ${basename}`);
+ }
+
+ return details;
+}
+
+let previousTimestamp = '';
+
+function parseSourceFile(filepath) {
+ // Read the source file.
+ const data = fs.readFileSync(filepath, 'utf8');
+
+ // Parse the file contents into a DOM tree.
+ const root = parse(data);
+
+ // Extract the wrapper that holds all of the messages.
+ const hChatLog = root.querySelector('div.hChatLog');
+
+ // Find all of the message containers within the wrapper.
+ const messageContainers = hChatLog.querySelectorAll('div.message');
+
+ // Extract the contact's name and telephone number.
+ const { name, tel } = extractContact(hChatLog.querySelectorAll('a.tel'), filepath);
+
+ if (batch.messages.length > 0 && batch.contact.name !== name && batch.contact.tel !== tel) {
+ // This source file is from a different contact than the last contact we processed.
+ // Compile the previously saved contact's messages.
+ compile(batch);
+
+ // Clear the previous contact's messages.
+ batch.contact.name = '';
+ batch.contact.tel = '';
+ batch.messages = [];
+
+ // Clear the timestamp.
+ previousTimestamp = '';
+ }
+
+ if (batch.contact.name === '') {
+ batch.contact.name = name;
+ }
+
+ if (batch.contact.tel === '') {
+ batch.contact.tel = tel;
+ }
+
+ batch.contact.outputName = outputName(batch);
+
+ // Process each text message within this source file.
+ messageContainers.forEach((message) => {
+ const senderTelephone = message.querySelector('a.tel').getAttribute('href');
+ const audioElement = message.querySelector('a.audio');
+ const imageElement = message.querySelector('img');
+ const vcardElement = message.querySelector('a.vcard');
+ const videoElement = message.querySelector('a.video');
+ const messageElement = message.querySelector('q');
+ let messageText = messageElement.removeWhitespace().rawText.replace(/\s+/g, ' ');
+ let type = 'text';
+
+ if (audioElement !== null) {
+ type = 'audio';
+ messageText = audioElement.getAttribute('href');
+ }
+
+ if (imageElement !== null) {
+ type = 'image';
+ messageText = imageElement.getAttribute('src');
+ }
+
+ if (vcardElement !== null) {
+ type = 'vcard';
+ messageText = vcardElement.getAttribute('href');
+ }
+
+ if (videoElement !== null) {
+ type = 'video';
+ messageText = videoElement.getAttribute('href');
+ }
+
+ if (type !== 'text') {
+ // Verify that the media file exists and append its file extension.
+ messageText = findMedia(type, messageText);
+ }
+
+ const timestamp = message.querySelector('abbr').getAttribute('title');
+ const separator = formatSeparator(previousTimestamp, timestamp);
+
+ if (separator) {
+ batch.messages.push({
+ type: 'separator',
+ messageText: separator,
+ direction: 'center',
+ });
+ }
+
+ previousTimestamp = timestamp;
+
+ const details = {
+ type,
+ messageText,
+ metadata: {
+ time: formatTime(timestamp),
+ timestamp,
+ },
+ direction: senderTelephone === batch.contact.me ? 'sent' : 'received',
+ };
+
+ batch.messages.push(details);
+ });
+}
+
+export default function parseSourceFiles(textSources) {
+ textSources.forEach((filepath) => {
+ parseSourceFile(filepath);
+ });
+
+ if (batch.messages.length > 0) {
+ compile(batch);
+ }
+}
diff --git a/src/templates/default.css b/src/templates/default.css
new file mode 100644
index 0000000..9f7f558
--- /dev/null
+++ b/src/templates/default.css
@@ -0,0 +1,113 @@
+*,
+*::before,
+*::after {
+ box-sizing: inherit;
+}
+
+html {
+ box-sizing: border-box;
+ height: 100%;
+ margin: 0;
+ padding: 0;
+}
+
+body {
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+ font-family: Roboto, sans-serif;
+ margin: 0;
+ padding: 0;
+}
+
+img,
+video {
+ max-width: 330px;
+}
+
+div.wrapper {
+ display: flex;
+ flex-direction: column;
+}
+
+div.name {
+ vertical-align: middle;
+ font-size: large;
+ height: 40px;
+ display: flex;
+ align-items: center;
+ padding-left: 20px;
+ background-color: #000;
+ color: #fff;
+}
+
+div.conversation {
+ flex-grow: 1;
+ padding: 20px;
+}
+
+.message {
+ color: #000;
+ clear: both;
+ line-height: 18px;
+ font-size: 14px;
+ padding: 10px 16px;
+ position: relative;
+ margin: 8px 0;
+ max-width: 65%;
+ word-wrap: break-word;
+}
+
+.message:first-child {
+ margin: 16px 0 8px;
+}
+
+.message.received {
+ color: #202124;
+ background: #f1f3f4;
+ border-radius: 20px;
+ float: left;
+}
+
+.message.received .metadata {
+ padding: 0 0 0 16px;
+}
+
+.message.sent {
+ color: #004d40;
+ background: #e0f2f1;
+ border-radius: 20px;
+ float: right;
+}
+
+div.center {
+ background-color: #000;
+ margin: 0 auto;
+ width: 200px;
+ text-align: center;
+ border-radius: 20px;
+ font-size: 16px;
+ color: #fff;
+ padding: 10px 16px;
+ clear: both;
+}
+
+div.status {
+ color: #5f6368;
+ clear: both;
+ letter-spacing: 0.3px;
+ margin-bottom: 16px;
+ width: 100%;
+ font-size: 12px;
+}
+
+div.status.received {
+ padding: 0 20px;
+}
+
+div.status.sent {
+ text-align: end;
+}
+
+span.name {
+ margin-right: 30px;
+}
diff --git a/src/templates/default.html b/src/templates/default.html
new file mode 100644
index 0000000..b8e4ed2
--- /dev/null
+++ b/src/templates/default.html
@@ -0,0 +1,22 @@
+
+
+
+
+
+
+
+
+
+
+ {{contact.name}}
+ {{contact.tel}}
+
+
+ {{messages}}
+
+
+
+
+
+
+
+ {{contact.name}}
+ {{contact.tel}}
+
+
+
+
+
+
+
+
+
+
+## Requirements
+
+Your [Google Takeout][1] data. Make sure that it includes your Google Voice data. Extract the archive and save the `Takeout` directory to disk.
+
+
+
+## Usage
+
+```posh
+Usage: google-voice-transformer [options]
+
+Convert the Google Takeout format to a more readable format.
+
+Options:
+ -V, --version output the version number
+ --path