From 0ffdc5f6a5f74b11ee1d9fd2b65595bf5dea9e22 Mon Sep 17 00:00:00 2001
From: Martynas Bagdonas <git.martynas@gmail.com>
Date: Wed, 13 Sep 2023 13:47:25 +0200
Subject: [PATCH] Enable injecting custom content into various reader UI parts

---
 .../components/common/custom-sections.js      | 26 +++++++++++++++++
 src/common/components/common/preview.js       |  2 ++
 src/common/components/toolbar.js              |  2 ++
 src/common/components/view/selection-popup.js |  2 ++
 src/common/context-menu.js                    | 28 ++++++++++++++++---
 src/common/stylesheets/base/_base.scss        |  4 +++
 .../stylesheets/components/_page-popup.scss   | 11 ++++++++
 .../stylesheets/components/_preview.scss      |  6 ++++
 .../stylesheets/components/_toolbar.scss      |  6 ++++
 9 files changed, 83 insertions(+), 4 deletions(-)
 create mode 100644 src/common/components/common/custom-sections.js

diff --git a/src/common/components/common/custom-sections.js b/src/common/components/common/custom-sections.js
new file mode 100644
index 00000000..27e1f884
--- /dev/null
+++ b/src/common/components/common/custom-sections.js
@@ -0,0 +1,26 @@
+import React, { memo, useEffect, useRef } from 'react';
+
+let CustomSections = memo(({ type, ...props }) => {
+	let sectionRef = useRef();
+	useEffect(() => {
+		sectionRef.current.replaceChildren();
+		let finished = false;
+		let append = (...args) => {
+			if (finished) {
+				throw new Error('Append must be called directly and synchronously in the event');
+			}
+			let section = document.createElement('div');
+			section.className = 'section';
+			section.append(...args);
+			sectionRef.current.append(section);
+		};
+		let event = new CustomEvent(`customEvent`, { detail: { type: `render${type}`, doc: document, append, params: props } });
+		window.dispatchEvent(event);
+		finished = true;
+	});
+	return (
+		<div ref={sectionRef} className="custom-sections"/>
+	);
+});
+
+export default CustomSections;
diff --git a/src/common/components/common/preview.js b/src/common/components/common/preview.js
index e3d7e374..b23624dd 100644
--- a/src/common/components/common/preview.js
+++ b/src/common/components/common/preview.js
@@ -6,6 +6,7 @@ import ExpandableEditor from './expandable-editor';
 import { IconHighlight, IconUnderline, IconNote, IconArea, IconInk, IconText } from './icons';
 import { getPopupCoordinatesFromClickEvent } from '../../lib/utilities';
 import { ReaderContext } from '../../reader';
+import CustomSections from './custom-sections';
 
 // TODO: Don't allow to select UI text in popup header and footer
 
@@ -289,6 +290,7 @@ export function SidebarPreview(props) {
 							{annotation.authorName}
 						</div>
 					)}
+					<CustomSections type="SidebarAnnotationHeader" annotation={annotation}/>
 					<button
 						data-tabstop={props.selected && !props.readOnly ? 1 : undefined}
 						tabIndex={props.selected && !props.readOnly ? -1 : undefined}
diff --git a/src/common/components/toolbar.js b/src/common/components/toolbar.js
index 157abd87..3dbd2173 100644
--- a/src/common/components/toolbar.js
+++ b/src/common/components/toolbar.js
@@ -1,6 +1,7 @@
 import React, { Fragment, useState, useCallback, useEffect, useRef, useImperativeHandle, useLayoutEffect } from 'react';
 import { useIntl } from 'react-intl';
 import cx from 'classnames';
+import CustomSections from './common/custom-sections';
 
 function Toolbar(props) {
 	const intl = useIntl();
@@ -221,6 +222,7 @@ function Toolbar(props) {
 				</div>
 			</div>
 			<div className="end">
+				<CustomSections type="Toolbar"/>
 				<button
 					id="viewFind"
 					className={cx('toolbarButton', { active: props.findPopupOpen })}
diff --git a/src/common/components/view/selection-popup.js b/src/common/components/view/selection-popup.js
index 3880135b..b2c3d611 100644
--- a/src/common/components/view/selection-popup.js
+++ b/src/common/components/view/selection-popup.js
@@ -2,6 +2,7 @@ import React from 'react';
 import { FormattedMessage, useIntl } from 'react-intl';
 import { ANNOTATION_COLORS } from '../../defines';
 import ViewPopup from './view-popup';
+import CustomSections from '../common/custom-sections';
 
 function SelectionPopup(props) {
 	const intl = useIntl();
@@ -35,6 +36,7 @@ function SelectionPopup(props) {
 				<div className="wide-button" data-tabstop={true} onClick={handleAddToNote}>
 					<FormattedMessage id="pdfReader.addToNote"/>
 				</div>}
+			<CustomSections type="TextSelectionPopup" annotation={props.params.annotation}/>
 		</ViewPopup>
 	);
 }
diff --git a/src/common/context-menu.js b/src/common/context-menu.js
index e0be3853..6bc14d69 100644
--- a/src/common/context-menu.js
+++ b/src/common/context-menu.js
@@ -1,5 +1,20 @@
 import { ANNOTATION_COLORS } from './defines';
 
+function appendCustomItemGroups(name, reader, params) {
+	let itemGroups = [];
+	let finished = false;
+	let append = (...items) => {
+		if (finished) {
+			throw new Error('Append must be called directly and synchronously in the event');
+		}
+		itemGroups.push(items);
+	};
+	let event = new CustomEvent(`customEvent`, { detail: { type: name, reader, append, params } });
+	window.dispatchEvent(event);
+	finished = true;
+	return itemGroups;
+}
+
 function createItemGroup(itemGroups) {
 	return itemGroups.map(items => items.filter(x => x).filter(item => !item.disabled || item.persistent)).filter(items => items.length);
 }
@@ -34,7 +49,8 @@ export function createColorContextMenu(reader, params) {
 					label: reader._getString('general.copy'),
 					onCommand: (size) => reader.setTool({ size })
 				}
-			]
+			],
+			...appendCustomItemGroups('createColorContextMenu', reader, params)
 		])
 	};
 }
@@ -111,7 +127,8 @@ export function createViewContextMenu(reader, params) {
 					persistent: true,
 					onCommand: () => reader.navigateToPreviousPage()
 				}
-			]
+			],
+			...appendCustomItemGroups('createViewContextMenu', reader, params)
 		])
 	};
 }
@@ -204,7 +221,8 @@ export function createAnnotationContextMenu(reader, params) {
 					persistent: true,
 					onCommand: () => reader.deleteAnnotations(params.ids)
 				},
-			]
+			],
+			...appendCustomItemGroups('createAnnotationContextMenu', reader, params)
 		])
 	};
 }
@@ -235,7 +253,8 @@ export function createThumbnailContextMenu(reader, params) {
 					persistent: true,
 					onCommand: () => reader.deletePages(params.pageIndexes)
 				},
-			]
+			],
+			...appendCustomItemGroups('createThumbnailContextMenu', reader, params)
 		])
 	};
 }
@@ -253,6 +272,7 @@ export function createSelectorContextMenu(reader, params) {
 					onCommand: () => reader.setFilter({ colors: [], tags: [], authors: [] })
 				}
 			],
+			...appendCustomItemGroups('createSelectorContextMenu', reader, params)
 		])
 	};
 }
diff --git a/src/common/stylesheets/base/_base.scss b/src/common/stylesheets/base/_base.scss
index 3d5b860c..7703770a 100644
--- a/src/common/stylesheets/base/_base.scss
+++ b/src/common/stylesheets/base/_base.scss
@@ -246,3 +246,7 @@ body.freeze {
 		content: '⧉';
 	}
 }
+
+.custom-sections:empty {
+	display: none;
+}
diff --git a/src/common/stylesheets/components/_page-popup.scss b/src/common/stylesheets/components/_page-popup.scss
index 8629e38a..e2ada8f2 100644
--- a/src/common/stylesheets/components/_page-popup.scss
+++ b/src/common/stylesheets/components/_page-popup.scss
@@ -9,6 +9,7 @@
 	box-shadow: $page-popup-box-shadow;
 	@include popover-pointer($width: 16px, $height: 8px);
 	z-index: 1;
+	max-width: 175px;
 
 
 	padding: $selection-popup-padding;
@@ -16,6 +17,7 @@
 	.colors {
 		display: flex;
 		align-items: center;
+		justify-content: center;
 	}
 
 	.toolbarButton {
@@ -55,6 +57,15 @@
 			background: $selection-popup-btn-hover-bg;
 		}
 	}
+
+	.custom-sections {
+		padding-top: 5px;
+
+		.section {
+			padding: 5px 0;
+			border-top: 1px solid #d7dad7;
+		}
+	}
 }
 
 .view-popup {
diff --git a/src/common/stylesheets/components/_preview.scss b/src/common/stylesheets/components/_preview.scss
index a89261e7..66a4b48b 100644
--- a/src/common/stylesheets/components/_preview.scss
+++ b/src/common/stylesheets/components/_preview.scss
@@ -75,6 +75,12 @@
 				color: #c0c0c0;
 			}
 		}
+
+		.custom-sections {
+			display: flex;
+			padding: 0 3px;
+			gap: 3px;
+		}
 	}
 
 	.text {
diff --git a/src/common/stylesheets/components/_toolbar.scss b/src/common/stylesheets/components/_toolbar.scss
index afbe100d..89f54f88 100644
--- a/src/common/stylesheets/components/_toolbar.scss
+++ b/src/common/stylesheets/components/_toolbar.scss
@@ -41,6 +41,12 @@
 
 	}
 
+	.custom-sections {
+		display: flex;
+		padding: 0 3px;
+		gap: 3px;
+	}
+
 	.toolbarButton {
 		.is-blurred & {
 			background: $toolbar-btn-blurred-bg;