// ==UserScript==
// @name JPDB Immersion Kit Examples
// @version 1.9
// @description Embeds anime images & audio examples into JPDB review and vocabulary pages using Immersion Kit's API. Compatible only with TamperMonkey.
// @author awoo
// @namespace jpdb-immersion-kit-examples
// @match https://jpdb.io/review*
// @match https://jpdb.io/vocabulary/*
// @match https://jpdb.io/kanji/*
// @grant GM_addElement
// @grant GM_xmlhttpRequest
// @license MIT
// ==/UserScript==
(function() {
'use strict';
const CONFIG = {
IMAGE_WIDTH: '400px',
WIDE_MODE: true,
PAGE_WIDTH: '75rem',
SOUND_VOLUME: 80,
ENABLE_EXAMPLE_TRANSLATION: true,
SENTENCE_FONT_SIZE: '120%',
TRANSLATION_FONT_SIZE: '85%',
COLORED_SENTENCE_TEXT: true,
AUTO_PLAY_SOUND: true,
NUMBER_OF_PRELOADS: 1,
MINIMUM_EXAMPLE_LENGTH: 0
};
const state = {
currentExampleIndex: 0,
examples: [],
apiDataFetched: false,
vocab: '',
embedAboveSubsectionMeanings: false,
preloadedIndices: new Set(),
currentAudio: null,
exactSearch: true
};
//API FUNCTIONS=====================================================================================================================
const MAX_ENTRIES = 1000;
const EXPIRATION_TIME = 30 * 24 * 60 * 60 * 1000; // 30 days in milliseconds
function openIndexedDB() {
return new Promise((resolve, reject) => {
// Open (or create) the IndexedDB with version 1
const request = indexedDB.open('ImmersionKitDB', 1);
// Event fired if the database needs to be upgraded (e.g., creation of object store)
request.onupgradeneeded = function(event) {
const db = event.target.result;
// Create 'dataStore' if it doesn't exist, using 'keyword' as the key path
if (!db.objectStoreNames.contains('dataStore')) {
db.createObjectStore('dataStore', { keyPath: 'keyword' });
}
};
// Successfully opened the database
request.onsuccess = function(event) {
resolve(event.target.result);
};
// Handle any errors during the opening of the database
request.onerror = function(event) {
reject('IndexedDB error: ' + event.target.errorCode);
};
});
}
function getFromIndexedDB(db, keyword) {
return new Promise((resolve, reject) => {
// Create a read-only transaction on 'dataStore'
const transaction = db.transaction(['dataStore'], 'readonly');
const store = transaction.objectStore('dataStore');
// Retrieve the entry with the specified keyword
const request = store.get(keyword);
// When the retrieval is successful
request.onsuccess = function(event) {
const result = event.target.result;
// Check if the result is valid and not expired
if (result && Date.now() - result.timestamp < EXPIRATION_TIME) {
resolve(result.data);
} else {
resolve(null);
}
};
// Handle errors during retrieval
request.onerror = function(event) {
reject('IndexedDB get error: ' + event.target.errorCode);
};
});
}
function saveToIndexedDB(db, keyword, data) {
return new Promise(async (resolve, reject) => {
// Create a read-write transaction on 'dataStore'
const transaction = db.transaction(['dataStore'], 'readwrite');
const store = transaction.objectStore('dataStore');
// Retrieve all entries from the store
const allEntries = store.getAll();
allEntries.onsuccess = function(event) {
const entries = event.target.result;
// If the store has reached the maximum number of entries, delete old ones
if (entries.length >= MAX_ENTRIES) {
// Sort entries by timestamp to find the oldest ones
entries.sort((a, b) => a.timestamp - b.timestamp);
const oldEntries = entries.slice(0, entries.length - MAX_ENTRIES + 1);
// Delete each old entry asynchronously
const deletePromises = oldEntries.map(entry => {
const deleteTransaction = db.transaction(['dataStore'], 'readwrite');
const deleteStore = deleteTransaction.objectStore('dataStore');
return new Promise((resolve, reject) => {
const request = deleteStore.delete(entry.keyword);
request.onsuccess = () => resolve();
request.onerror = () => reject('Failed to delete old entry');
});
});
// After deleting old entries, save the new entry
Promise.all(deletePromises).then(() => {
const request = store.put({ keyword: keyword, data: data, timestamp: Date.now() });
request.onsuccess = function() {
resolve();
};
request.onerror = function(event) {
reject('IndexedDB save error: ' + event.target.errorCode);
};
}).catch(reject);
} else {
// Save the new entry without deletion if max entries aren't reached
const request = store.put({ keyword: keyword, data: data, timestamp: Date.now() });
request.onsuccess = function() {
resolve();
};
request.onerror = function(event) {
reject('IndexedDB save error: ' + event.target.errorCode);
};
}
};
// Handle errors during retrieval of all entries
allEntries.onerror = function(event) {
reject('Failed to retrieve all entries');
};
});
}
function getImmersionKitData(vocab, exactSearch) {
return new Promise(async (resolve, reject) => {
// Modify vocab for exact search format if necessary
const searchVocab = exactSearch ? `「${vocab}」` : vocab;
const url = `https://api.immersionkit.com/look_up_dictionary?keyword=${encodeURIComponent(searchVocab)}&sort=shortness&min_length=${CONFIG.MINIMUM_EXAMPLE_LENGTH}`;
try {
// Open the IndexedDB and check for cached data
const db = await openIndexedDB();
const cachedData = await getFromIndexedDB(db, searchVocab);
// If valid cached data is found, use it
if (cachedData && cachedData.data && Array.isArray(cachedData.data) && cachedData.data.length > 0) {
console.log('Data retrieved from IndexedDB');
state.examples = cachedData.data[0].examples;
state.apiDataFetched = true;
resolve();
} else {
// Fetch data from the API if no valid cached data exists
console.log(`Calling API for: ${searchVocab}`);
GM_xmlhttpRequest({
method: "GET",
url: url,
onload: async function(response) {
if (response.status === 200) {
const jsonData = parseJSON(response.responseText);
console.log("API JSON Received");
console.log(url);
// Validate and store the response data
if (validateApiResponse(jsonData)) {
state.examples = jsonData.data[0].examples;
state.apiDataFetched = true;
await saveToIndexedDB(db, searchVocab, jsonData);
resolve();
} else {
reject('Invalid API response');
}
} else {
reject(`API call failed with status: ${response.status}`);
}
},
onerror: function(error) {
reject(`An error occurred: ${error}`);
}
});
}
} catch (error) {
reject(`Error: ${error}`);
}
});
}
function parseJSON(responseText) {
// Parse the response text into JSON format, with error handling
try {
return JSON.parse(responseText);
} catch (e) {
console.error('Error parsing JSON:', e);
return null;
}
}
function validateApiResponse(jsonData) {
// Validate that the API response contains the expected data structure
return jsonData && jsonData.data && jsonData.data[0] && jsonData.data[0].examples;
}
function deleteIndexedDB() {
return new Promise((resolve, reject) => {
// Delete the entire IndexedDB database
const request = indexedDB.deleteDatabase('ImmersionKitDB');
// Successfully deleted the database
request.onsuccess = function() {
console.log('IndexedDB deleted successfully');
resolve();
};
// Handle any errors during the deletion process
request.onerror = function(event) {
console.error('Error deleting IndexedDB:', event.target.errorCode);
reject('Error deleting IndexedDB: ' + event.target.errorCode);
};
// Warn if the delete operation is blocked (e.g., other tabs still open)
request.onblocked = function() {
console.warn('Delete operation blocked. Please close all other tabs with this site open and try again.');
reject('Delete operation blocked');
};
});
}
//FAVORITE DATA FUNCTIONS=====================================================================================================================
function getStoredData(key) {
// Retrieve the stored value from localStorage using the provided key
const storedValue = localStorage.getItem(key);
// If a stored value exists, split it into index and exactState
if (storedValue) {
const [index, exactState] = storedValue.split(',');
return {
index: parseInt(index, 10), // Convert index to an integer
exactState: exactState === '1' // Convert exactState to a boolean
};
}
// Return default values if no stored value exists
return { index: 0, exactState: state.exactSearch };
}
function storeData(key, index, exactState) {
// Create a string value from index and exactState to store in localStorage
const value = `${index},${exactState ? 1 : 0}`;
// Store the value in localStorage using the provided key
localStorage.setItem(key, value);
}
// PARSE VOCAB FUNCTIONS =====================================================================================================================
function parseVocabFromAnswer() {
// Select all links containing "/kanji/" or "/vocabulary/" in the href attribute
const elements = document.querySelectorAll('a[href*="/kanji/"], a[href*="/vocabulary/"]');
console.log("Parsing Answer Page");
// Iterate through the matched elements
for (const element of elements) {
const href = element.getAttribute('href');
const text = element.textContent.trim();
// Match the href to extract kanji or vocabulary (ignoring ID if present)
const match = href.match(/\/(kanji|vocabulary)\/(?:\d+\/)?([^\#]*)#/);
if (match) return match[2].trim();
if (text) return text.trim();
}
return '';
}
function parseVocabFromReview() {
// Select the element with class 'kind' to determine the type of content
const kindElement = document.querySelector('.kind');
console.log("Parsing Review Page");
if (!kindElement) return ''; // If the element doesn't exist, return an empty string
const kindText = kindElement.textContent.trim();
if (kindText !== 'Kanji' && kindText !== 'Vocabulary') return ''; // Return empty if it's neither kanji nor vocab
if (kindText === 'Vocabulary') {
// Select the element with class 'plain' to extract vocabulary
const plainElement = document.querySelector('.plain');
if (!plainElement) return '';
let vocabulary = plainElement.textContent.trim();
const nestedVocabularyElement = plainElement.querySelector('div:not([style])');
if (nestedVocabularyElement) {
vocabulary = nestedVocabularyElement.textContent.trim();
}
const specificVocabularyElement = plainElement.querySelector('div:nth-child(3)');
if (specificVocabularyElement) {
vocabulary = specificVocabularyElement.textContent.trim();
}
// Regular expression to check if the vocabulary contains kanji characters
const kanjiRegex = /[\u4e00-\u9faf\u3400-\u4dbf]/;
if (kanjiRegex.test(vocabulary) || vocabulary) {
console.log("Found Vocabulary:", vocabulary);
return vocabulary;
}
} else if (kindText === 'Kanji') {
// Select the hidden input element to extract kanji
const hiddenInput = document.querySelector('input[name="c"]');
if (!hiddenInput) return '';
const vocab = hiddenInput.value.split(',')[1];
const kanjiRegex = /[\u4e00-\u9faf\u3400-\u4dbf]/;
if (kanjiRegex.test(vocab)) {
console.log("Found Kanji:", vocab);
return vocab;
}
}
return '';
}
function parseVocabFromVocabulary() {
// Get the current URL
const url = window.location.href;
// Match the URL structure for a vocabulary page
const match = url.match(/https:\/\/jpdb\.io\/vocabulary\/(\d+)\/([^\#]*)#a/);
console.log("Parsing Vocabulary Page");
if (match) {
// Extract and decode the vocabulary part from the URL
let vocab = match[2];
state.embedAboveSubsectionMeanings = true; // Set state flag
vocab = vocab.split('/')[0];
return decodeURIComponent(vocab);
}
// Return empty string if no match
return '';
}
function parseVocabFromKanji() {
// Get the current URL
const url = window.location.href;
// Match the URL structure for a kanji page
const match = url.match(/https:\/\/jpdb\.io\/kanji\/(\d+)\/([^\#]*)#a/);
console.log("Parsing Kanji Page");
if (match) {
// Extract and decode the kanji part from the URL
let kanji = match[2];
state.embedAboveSubsectionMeanings = true; // Set state flag
kanji = kanji.split('/')[0];
return decodeURIComponent(kanji);
}
// Return empty string if no match
return '';
}
//EMBED FUNCTIONS=====================================================================================================================
function createAnchor(marginLeft) {
// Create and style an anchor element
const anchor = document.createElement('a');
anchor.href = '#';
anchor.style.border = '0';
anchor.style.display = 'inline-flex';
anchor.style.verticalAlign = 'middle';
anchor.style.marginLeft = marginLeft;
return anchor;
}
function createIcon(iconClass, fontSize = '1.4rem', color = '#3d81ff') {
// Create and style an icon element
const icon = document.createElement('i');
icon.className = iconClass;
icon.style.fontSize = fontSize;
icon.style.opacity = '1.0';
icon.style.verticalAlign = 'baseline';
icon.style.color = color;
return icon;
}
function createSpeakerButton(soundUrl) {
// Create a speaker button with an icon and click event for audio playback
const anchor = createAnchor('0.5rem');
const icon = createIcon('ti ti-volume');
anchor.appendChild(icon);
anchor.addEventListener('click', (event) => {
event.preventDefault();
playAudio(soundUrl);
});
return anchor;
}
function createStarButton() {
// Create a star button with an icon and click event for toggling favorite state
const anchor = createAnchor('0.5rem');
const starIcon = document.createElement('span');
const storedValue = localStorage.getItem(state.vocab);
// Determine the star icon (filled or empty) based on stored value
if (!storedValue) {
starIcon.textContent = '☆';
} else {
const [storedIndex, storedExactState] = storedValue.split(',');
const index = parseInt(storedIndex, 10);
const exactState = storedExactState === '1';
starIcon.textContent = (state.currentExampleIndex === index && state.exactSearch === exactState) ? '★' : '☆';
}
// Style the star icon
starIcon.style.fontSize = '1.4rem';
starIcon.style.color = '#3D8DFF';
starIcon.style.verticalAlign = 'middle';
starIcon.style.position = 'relative';
starIcon.style.top = '-2px';
// Append the star icon to the anchor and set up the click event to toggle star state
anchor.appendChild(starIcon);
anchor.addEventListener('click', (event) => {
event.preventDefault();
toggleStarState(starIcon);
});
return anchor;
}
function toggleStarState(starIcon) {
// Toggle the star state between filled and empty
const storedValue = localStorage.getItem(state.vocab);
if (storedValue) {
const [storedIndex, storedExactState] = storedValue.split(',');
const index = parseInt(storedIndex, 10);
const exactState = storedExactState === '1';
if (index === state.currentExampleIndex && exactState === state.exactSearch) {
localStorage.removeItem(state.vocab);
starIcon.textContent = '☆';
} else {
localStorage.setItem(state.vocab, `${state.currentExampleIndex},${state.exactSearch ? 1 : 0}`);
starIcon.textContent = '★';
}
} else {
localStorage.setItem(state.vocab, `${state.currentExampleIndex},${state.exactSearch ? 1 : 0}`);
starIcon.textContent = '★';
}
}
function createQuoteButton() {
// Create a quote button with an icon and click event for toggling quote style
const anchor = createAnchor('0rem');
const quoteIcon = document.createElement('span');
// Set the icon based on exact search state
quoteIcon.innerHTML = state.exactSearch ? '<b>「」</b>' : '『』';
// Style the quote icon
quoteIcon.style.fontSize = '1.1rem';
quoteIcon.style.color = '#3D8DFF';
quoteIcon.style.verticalAlign = 'middle';
quoteIcon.style.position = 'relative';
quoteIcon.style.top = '0px';
// Append the quote icon to the anchor and set up the click event to toggle quote state
anchor.appendChild(quoteIcon);
anchor.addEventListener('click', (event) => {
event.preventDefault();
toggleQuoteState(quoteIcon);
});
return anchor;
}
function toggleQuoteState(quoteIcon) {
// Toggle between single and double quote styles
state.exactSearch = !state.exactSearch;
quoteIcon.innerHTML = state.exactSearch ? '<b>「」</b>' : '『』';
// Update state based on stored data
const storedData = getStoredData(state.vocab);
if (storedData && storedData.exactState === state.exactSearch) {
state.currentExampleIndex = storedData.index;
} else {
state.currentExampleIndex = 0;
}
state.apiDataFetched = false;
getImmersionKitData(state.vocab, state.exactSearch)
.then(() => {
embedImageAndPlayAudio();
})
.catch(error => {
console.error(error);
});
}
function createMenuButton() {
// Create a menu button with a dropdown menu
const anchor = createAnchor('0.5rem');
const menuIcon = document.createElement('span');
menuIcon.innerHTML = '☰';
// Style the menu icon
menuIcon.style.fontSize = '1.4rem';
menuIcon.style.color = '#3D8DFF';
menuIcon.style.verticalAlign = 'middle';
menuIcon.style.position = 'relative';
menuIcon.style.top = '-2px';
// Append the menu icon to the anchor and set up the click event to show the overlay menu
anchor.appendChild(menuIcon);
anchor.addEventListener('click', (event) => {
event.preventDefault();
const overlay = createOverlayMenu();
document.body.appendChild(overlay);
});
return anchor;
}
function createTextButton(vocab, exact) {
// Create a text button for the Immersion Kit
const textButton = document.createElement('a');
textButton.textContent = 'Immersion Kit';
textButton.style.color = 'var(--subsection-label-color)';
textButton.style.fontSize = '85%';
textButton.style.marginRight = '0.5rem';
textButton.style.verticalAlign = 'middle';
textButton.href = `https://www.immersionkit.com/dictionary?keyword=${encodeURIComponent(vocab)}&sort=shortness${exact ? '&exact=true' : ''}`;
textButton.target = '_blank';
return textButton;
}
function createButtonContainer(soundUrl, vocab, exact) {
// Create a container for all buttons
const buttonContainer = document.createElement('div');
buttonContainer.className = 'button-container';
buttonContainer.style.display = 'flex';
buttonContainer.style.justifyContent = 'space-between';
buttonContainer.style.alignItems = 'center';
buttonContainer.style.marginBottom = '5px';
buttonContainer.style.lineHeight = '1.4rem';
// Create individual buttons
const menuButton = createMenuButton();
const textButton = createTextButton(vocab, exact);
const speakerButton = createSpeakerButton(soundUrl);
const starButton = createStarButton();
const quoteButton = createQuoteButton();
// Center the buttons within the container
const centeredButtonsWrapper = document.createElement('div');
centeredButtonsWrapper.style.display = 'flex';
centeredButtonsWrapper.style.justifyContent = 'center';
centeredButtonsWrapper.style.flex = '1';
centeredButtonsWrapper.append(textButton, speakerButton, starButton, quoteButton);
buttonContainer.append(centeredButtonsWrapper, menuButton);
return buttonContainer;
}
function stopCurrentAudio() {
// Stop any currently playing audio
if (state.currentAudio) {
state.currentAudio.source.stop();
state.currentAudio.context.close();
state.currentAudio = null;
}
}
function playAudio(soundUrl) {
if (soundUrl) {
stopCurrentAudio();
GM_xmlhttpRequest({
method: 'GET',
url: soundUrl,
responseType: 'arraybuffer',
onload: function(response) {
const audioContext = new (window.AudioContext || window.webkitAudioContext)();
audioContext.decodeAudioData(response.response, function(buffer) {
const source = audioContext.createBufferSource();
source.buffer = buffer;
const gainNode = audioContext.createGain();
// Connect the source to the gain node and the gain node to the destination
source.connect(gainNode);
gainNode.connect(audioContext.destination);
// Mute the first part and then ramp up the volume
gainNode.gain.setValueAtTime(0, audioContext.currentTime);
gainNode.gain.linearRampToValueAtTime(CONFIG.SOUND_VOLUME / 100, audioContext.currentTime + 0.1);
// Play the audio, skip the first part to avoid any "pop"
source.start(0, 0.05);
// Save the current audio context and source for stopping later
state.currentAudio = {
context: audioContext,
source: source
};
}, function(error) {
console.error('Error decoding audio:', error);
});
},
onerror: function(error) {
console.error('Error fetching audio:', error);
}
});
}
}
function renderImageAndPlayAudio(vocab, shouldAutoPlaySound) {
const example = state.examples[state.currentExampleIndex] || {};
const imageUrl = example.image_url || null;
const soundUrl = example.sound_url || null;
const sentence = example.sentence || null;
// Remove any existing container
removeExistingContainer();
if (!shouldRenderContainer()) return;
// Create and append the main wrapper and text button container
const wrapperDiv = createWrapperDiv();
const textDiv = createButtonContainer(soundUrl, vocab, state.exactSearch);
wrapperDiv.appendChild(textDiv);
// Handle image rendering and click event for playing audio
if (imageUrl) {
const imageElement = createImageElement(wrapperDiv, imageUrl, vocab, state.exactSearch);
if (imageElement) {
imageElement.addEventListener('click', () => playAudio(soundUrl));
}
} else {
const noImageText = document.createElement('div');
noImageText.textContent = 'NO IMAGE';
noImageText.style.padding = '100px 0';
wrapperDiv.appendChild(noImageText);
}
// Append sentence and translation or a placeholder text
sentence ? appendSentenceAndTranslation(wrapperDiv, sentence, example.translation) : appendNoneText(wrapperDiv);
// Create navigation elements
const navigationDiv = createNavigationDiv();
const leftArrow = createLeftArrow(vocab, shouldAutoPlaySound);
const rightArrow = createRightArrow(vocab, shouldAutoPlaySound);
// Create and append the main container
const containerDiv = createContainerDiv(leftArrow, wrapperDiv, rightArrow, navigationDiv);
appendContainer(containerDiv);
// Auto-play sound if configured
if (CONFIG.AUTO_PLAY_SOUND && shouldAutoPlaySound) {
playAudio(soundUrl);
}
}
function removeExistingContainer() {
// Remove the existing container if it exists
const existingContainer = document.getElementById('immersion-kit-container');
if (existingContainer) {
existingContainer.remove();
}
}
function shouldRenderContainer() {
// Determine if the container should be rendered based on the presence of certain elements
const resultVocabularySection = document.querySelector('.result.vocabulary');
const hboxWrapSection = document.querySelector('.hbox.wrap');
const subsectionMeanings = document.querySelector('.subsection-meanings');
const subsectionLabels = document.querySelectorAll('h6.subsection-label');
return resultVocabularySection || hboxWrapSection || subsectionMeanings || subsectionLabels.length >= 3;
}
function createWrapperDiv() {
// Create and style the wrapper div
const wrapperDiv = document.createElement('div');
wrapperDiv.id = 'image-wrapper';
wrapperDiv.style.textAlign = 'center';
wrapperDiv.style.padding = '5px 0';
return wrapperDiv;
}
function createImageElement(wrapperDiv, imageUrl, vocab, exactSearch) {
// Create and return an image element with specified attributes
const searchVocab = exactSearch ? `「${vocab}」` : vocab;
const titleText = `${searchVocab} #${state.currentExampleIndex + 1}`;
return GM_addElement(wrapperDiv, 'img', {
src: imageUrl,
alt: 'Embedded Image',
title: titleText,
style: `max-width: ${CONFIG.IMAGE_WIDTH}; margin-top: 10px; cursor: pointer;`
});
}
function highlightVocab(sentence, vocab) {
// Highlight vocabulary in the sentence based on configuration
if (!CONFIG.COLORED_SENTENCE_TEXT) return sentence;
if (state.exactSearch) {
const regex = new RegExp(`(${vocab})`, 'g');
return sentence.replace(regex, '<span style="color: var(--outline-input-color);">$1</span>');
} else {
return vocab.split('').reduce((acc, char) => {
const regex = new RegExp(char, 'g');
return acc.replace(regex, `<span style="color: var(--outline-input-color);">${char}</span>`);
}, sentence);
}
}
function appendSentenceAndTranslation(wrapperDiv, sentence, translation) {
// Append sentence and translation to the wrapper div
const sentenceText = document.createElement('div');
sentenceText.innerHTML = highlightVocab(sentence, state.vocab);
sentenceText.style.marginTop = '10px';
sentenceText.style.fontSize = CONFIG.SENTENCE_FONT_SIZE;
sentenceText.style.color = 'lightgray';
sentenceText.style.maxWidth = CONFIG.IMAGE_WIDTH;
sentenceText.style.whiteSpace = 'pre-wrap';
wrapperDiv.appendChild(sentenceText);
if (CONFIG.ENABLE_EXAMPLE_TRANSLATION && translation) {
const translationText = document.createElement('div');
translationText.innerHTML = replaceSpecialCharacters(translation);
translationText.style.marginTop = '5px';
translationText.style.fontSize = CONFIG.TRANSLATION_FONT_SIZE;
translationText.style.color = 'var(--subsection-label-color)';
translationText.style.maxWidth = CONFIG.IMAGE_WIDTH;
translationText.style.whiteSpace = 'pre-wrap';
wrapperDiv.appendChild(translationText);
}
}
function appendNoneText(wrapperDiv) {
// Append a "None" text to the wrapper div
const noneText = document.createElement('div');
noneText.textContent = 'None';
noneText.style.marginTop = '10px';
noneText.style.fontSize = '85%';
noneText.style.color = 'var(--subsection-label-color)';
wrapperDiv.appendChild(noneText);
}
function createNavigationDiv() {
// Create and style the navigation div
const navigationDiv = document.createElement('div');
navigationDiv.id = 'immersion-kit-embed';
navigationDiv.style.display = 'flex';
navigationDiv.style.justifyContent = 'center';
navigationDiv.style.alignItems = 'center';
navigationDiv.style.maxWidth = CONFIG.IMAGE_WIDTH;
navigationDiv.style.margin = '0 auto';
return navigationDiv;
}
function createLeftArrow(vocab, shouldAutoPlaySound) {
// Create and configure the left arrow button
const leftArrow = document.createElement('button');
leftArrow.textContent = '<';
leftArrow.style.marginRight = '10px';
leftArrow.disabled = state.currentExampleIndex === 0;
leftArrow.addEventListener('click', () => {
if (state.currentExampleIndex > 0) {
state.currentExampleIndex--;
renderImageAndPlayAudio(vocab, shouldAutoPlaySound);
preloadImages();
}
});
return leftArrow;
}
function createRightArrow(vocab, shouldAutoPlaySound) {
// Create and configure the right arrow button
const rightArrow = document.createElement('button');
rightArrow.textContent = '>';
rightArrow.style.marginLeft = '10px';
rightArrow.disabled = state.currentExampleIndex >= state.examples.length - 1;
rightArrow.addEventListener('click', () => {
if (state.currentExampleIndex < state.examples.length - 1) {
state.currentExampleIndex++;
renderImageAndPlayAudio(vocab, shouldAutoPlaySound);
preloadImages();
}
});
return rightArrow;
}
function createContainerDiv(leftArrow, wrapperDiv, rightArrow, navigationDiv) {
// Create and configure the main container div
const containerDiv = document.createElement('div');
containerDiv.id = 'immersion-kit-container';
containerDiv.style.display = 'flex';
containerDiv.style.alignItems = 'center';
containerDiv.style.justifyContent = 'center';
containerDiv.style.flexDirection = 'column';
const arrowWrapperDiv = document.createElement('div');
arrowWrapperDiv.style.display = 'flex';
arrowWrapperDiv.style.alignItems = 'center';
arrowWrapperDiv.style.justifyContent = 'center';
arrowWrapperDiv.append(leftArrow, wrapperDiv, rightArrow);
containerDiv.append(arrowWrapperDiv, navigationDiv);
return containerDiv;
}
function appendContainer(containerDiv) {
// Append the container div to the appropriate section based on configuration
const resultVocabularySection = document.querySelector('.result.vocabulary');
const hboxWrapSection = document.querySelector('.hbox.wrap');
const subsectionMeanings = document.querySelector('.subsection-meanings');
const subsectionComposedOfKanji = document.querySelector('.subsection-composed-of-kanji');
const subsectionPitchAccent = document.querySelector('.subsection-pitch-accent');
const subsectionLabels = document.querySelectorAll('h6.subsection-label');
const vboxGap = document.querySelector('.vbox.gap');
if (CONFIG.WIDE_MODE && subsectionMeanings) {
const wrapper = document.createElement('div');
wrapper.style.display = 'flex';
wrapper.style.alignItems = 'flex-start';
const originalContentWrapper = document.createElement('div');
originalContentWrapper.style.flex = '1';
originalContentWrapper.appendChild(subsectionMeanings);
if (subsectionComposedOfKanji) {
const newline1 = document.createElement('br');
originalContentWrapper.appendChild(newline1);
originalContentWrapper.appendChild(subsectionComposedOfKanji);
}
if (subsectionPitchAccent) {
const newline2 = document.createElement('br');
originalContentWrapper.appendChild(newline2);
originalContentWrapper.appendChild(subsectionPitchAccent);
}
wrapper.appendChild(originalContentWrapper);
wrapper.appendChild(containerDiv);
if (vboxGap) {
const existingDynamicDiv = vboxGap.querySelector('#dynamic-content');
if (existingDynamicDiv) {
existingDynamicDiv.remove();
}
const dynamicDiv = document.createElement('div');
dynamicDiv.id = 'dynamic-content';
dynamicDiv.appendChild(wrapper);
if (window.location.href.includes('vocabulary')) {
vboxGap.insertBefore(dynamicDiv, vboxGap.children[1]);
} else {
vboxGap.insertBefore(dynamicDiv, vboxGap.firstChild);
}
}
} else {
if (state.embedAboveSubsectionMeanings && subsectionMeanings) {
subsectionMeanings.parentNode.insertBefore(containerDiv, subsectionMeanings);
} else if (resultVocabularySection) {
resultVocabularySection.parentNode.insertBefore(containerDiv, resultVocabularySection);
} else if (hboxWrapSection) {
hboxWrapSection.parentNode.insertBefore(containerDiv, hboxWrapSection);
} else if (subsectionLabels.length >= 4) {
subsectionLabels[3].parentNode.insertBefore(containerDiv, subsectionLabels[3]);
}
}
}
function embedImageAndPlayAudio() {
// Embed the image and play audio, removing existing navigation div if present
const existingNavigationDiv = document.getElementById('immersion-kit-embed');
if (existingNavigationDiv) existingNavigationDiv.remove();
const reviewUrlPattern = /https:\/\/jpdb\.io\/review(#a)?$/;
renderImageAndPlayAudio(state.vocab, !reviewUrlPattern.test(window.location.href));
preloadImages();
}
function replaceSpecialCharacters(text) {
// Replace special characters in the text
return text.replace(/<br>/g, '\n').replace(/"/g, '"').replace(/\n/g, '<br>');
}
function preloadImages() {
// Preload images around the current example index
const preloadDiv = GM_addElement(document.body, 'div', { style: 'display: none;' });
const startIndex = Math.max(0, state.currentExampleIndex - CONFIG.NUMBER_OF_PRELOADS);
const endIndex = Math.min(state.examples.length - 1, state.currentExampleIndex + CONFIG.NUMBER_OF_PRELOADS);
for (let i = startIndex; i <= endIndex; i++) {
if (!state.preloadedIndices.has(i) && state.examples[i].image_url) {
GM_addElement(preloadDiv, 'img', { src: state.examples[i].image_url });
state.preloadedIndices.add(i);
}
}
}
//MENU FUNCTIONS=====================================================================================================================
function handleImportButtonClick() {
// Create a file input element and trigger the importFavorites function on file selection
const fileInput = document.createElement('input');
fileInput.type = 'file';
fileInput.accept = 'application/json';
fileInput.addEventListener('change', importFavorites);
fileInput.click();
}
function exportFavorites() {
// Export non-configuration items from localStorage to a JSON file
const favorites = {};
for (let i = 0; i < localStorage.length; i++) {
const key = localStorage.key(i);
if (!key.startsWith('CONFIG')) {
favorites[key] = localStorage.getItem(key);
}
}
const blob = new Blob([JSON.stringify(favorites, null, 2)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = 'favorites.json';
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
}
function importFavorites(event) {
// Import favorites from a selected JSON file and reload the page
const file = event.target.files[0];
if (!file) return;
const reader = new FileReader();
reader.onload = function(e) {
try {
const favorites = JSON.parse(e.target.result);
for (const key in favorites) {
localStorage.setItem(key, favorites[key]);
}
alert('Favorites imported successfully!');
location.reload();
} catch (error) {
alert('Error importing favorites:', error);
}
};
reader.readAsText(file);
}
function createConfirmationPopup(messageText, onYes, onNo) {
// Create a confirmation popup with Yes and No buttons
const popupOverlay = document.createElement('div');
popupOverlay.style.position = 'fixed';
popupOverlay.style.top = '0';
popupOverlay.style.left = '0';
popupOverlay.style.width = '100%';
popupOverlay.style.height = '100%';
popupOverlay.style.backgroundColor = 'rgba(0, 0, 0, 0.75)';
popupOverlay.style.zIndex = '1001';
popupOverlay.style.display = 'flex';
popupOverlay.style.justifyContent = 'center';
popupOverlay.style.alignItems = 'center';
const popupContent = document.createElement('div');
popupContent.style.backgroundColor = 'var(--background-color)';
popupContent.style.padding = '20px';
popupContent.style.borderRadius = '5px';
popupContent.style.boxShadow = '0 0 10px rgba(0, 0, 0, 0.5)';
popupContent.style.textAlign = 'center';
const message = document.createElement('p');
message.textContent = messageText;
const yesButton = document.createElement('button');
yesButton.textContent = 'Yes';
yesButton.style.backgroundColor = '#C82800';
yesButton.style.marginRight = '10px';
yesButton.addEventListener('click', () => {
onYes();
document.body.removeChild(popupOverlay);
});
const noButton = document.createElement('button');
noButton.textContent = 'No';
noButton.addEventListener('click', () => {
onNo();
document.body.removeChild(popupOverlay);
});
popupContent.appendChild(message);
popupContent.appendChild(yesButton);
popupContent.appendChild(noButton);
popupOverlay.appendChild(popupContent);
document.body.appendChild(popupOverlay);
}
function saveConfig() {
// Save configuration settings and handle changes to minimum example length
const overlay = document.getElementById('overlayMenu');
if (!overlay) return;
const inputs = overlay.querySelectorAll('input, span');
let minimumExampleLengthChanged = false;
let newMinimumExampleLength;
const changes = {};
inputs.forEach(input => {
const key = input.getAttribute('data-key');
const type = input.getAttribute('data-type');
let value;
if (type === 'boolean') {
value = input.checked;
} else if (type === 'number') {
value = parseFloat(input.textContent);
} else if (type === 'string') {
value = input.textContent;
}
if (key && type) {
const typePart = input.getAttribute('data-type-part');
const originalFormattedType = typePart.slice(1, -1);
if (key === 'MINIMUM_EXAMPLE_LENGTH' && CONFIG.MINIMUM_EXAMPLE_LENGTH !== value) {
minimumExampleLengthChanged = true;
newMinimumExampleLength = value;
}
changes[key] = value + originalFormattedType;
}
});
if (minimumExampleLengthChanged) {
createConfirmationPopup(
'Changing Minimum Example Length will break your current favorites. Are you sure? Deleting favorites is recommended.',
() => {
CONFIG.MINIMUM_EXAMPLE_LENGTH = newMinimumExampleLength;
localStorage.setItem('CONFIG.MINIMUM_EXAMPLE_LENGTH', newMinimumExampleLength);
applyChanges(changes);
finalizeSaveConfig();
location.reload();
},
() => {
document.body.removeChild(overlay);
document.body.appendChild(createOverlayMenu());
}
);
} else {
applyChanges(changes);
finalizeSaveConfig();
setPageWidth();
}
}
function applyChanges(changes) {
// Apply configuration changes to localStorage
for (const key in changes) {
localStorage.setItem(key, changes[key]);
}
}
function finalizeSaveConfig() {
// Finalize configuration save and reload necessary components
loadConfig();
renderImageAndPlayAudio(state.vocab, CONFIG.AUTO_PLAY_SOUND);
const overlay = document.getElementById('overlayMenu');
if (overlay) {
document.body.removeChild(overlay);
}
}
function loadConfig() {
// Load configuration settings from localStorage
for (const key in CONFIG) {
const valueType = typeof CONFIG[key];
const savedValue = localStorage.getItem(key);
if (savedValue !== null) {
if (valueType === 'boolean') {
CONFIG[key] = savedValue === 'true';
} else if (valueType === 'number') {
CONFIG[key] = parseFloat(savedValue);
} else if (valueType === 'string') {
CONFIG[key] = savedValue;
}
}
}
}
function createButton(text, margin, onClick, width) {
// Create a button element with specified properties
const button = document.createElement('button');
button.textContent = text;
button.style.margin = margin;
button.style.width = width;
button.style.textAlign = 'center';
button.style.display = 'inline-block';
button.style.lineHeight = '30px';
button.style.padding = '5px 0';
button.addEventListener('click', onClick);
return button;
}
function createMenuButtons() {
// Create and return the menu buttons for export, import, save, close, default, and delete actions
const exportImportButtonWidth = '200px';
const actionButtonWidth = '100px';
const exportButton = createButton('Export Favorites', '10px', exportFavorites, exportImportButtonWidth);
const importButton = createButton('Import Favorites', '10px', handleImportButtonClick, exportImportButtonWidth);
const exportImportContainer = document.createElement('div');
exportImportContainer.style.textAlign = 'center';
exportImportContainer.style.marginTop = '10px';
exportImportContainer.append(exportButton, importButton);
const closeButton = createButton('Close', '10px', () => {
loadConfig();
document.body.removeChild(document.getElementById('overlayMenu'));
}, actionButtonWidth);
const saveButton = createButton('Save', '10px', saveConfig, actionButtonWidth);
const defaultButton = createButton('Default', '10px', () => {
createConfirmationPopup(
'This will reset all your settings to default. Are you sure?',
() => {
Object.keys(localStorage).forEach(key => {
if (key.startsWith('CONFIG')) {
localStorage.removeItem(key);
}
});
location.reload();
},
() => {
const overlay = document.getElementById('overlayMenu');
if (overlay) {
document.body.removeChild(overlay);
}
loadConfig();
document.body.appendChild(createOverlayMenu());
}
);
}, actionButtonWidth);
defaultButton.style.backgroundColor = '#C82800';
defaultButton.style.color = 'white';
const deleteButton = createButton('DELETE', '10px', () => {
createConfirmationPopup(
'This will delete all your favorites and cached data. Are you sure?',
async () => {
Object.keys(localStorage).forEach(key => {
if (!key.startsWith('CONFIG')) {
localStorage.removeItem(key);
}
});
try {
await deleteIndexedDB();
location.reload();
} catch (error) {
console.error('Failed to delete IndexedDB:', error);
}
},
() => {
const overlay = document.getElementById('overlayMenu');
if (overlay) {
document.body.removeChild(overlay);
}
loadConfig();
document.body.appendChild(createOverlayMenu());
}
);
}, actionButtonWidth);
deleteButton.style.backgroundColor = '#C82800';
deleteButton.style.color = 'white';
const actionButtonsContainer = document.createElement('div');
actionButtonsContainer.style.textAlign = 'center';
actionButtonsContainer.style.marginTop = '10px';
actionButtonsContainer.append(closeButton, saveButton, defaultButton, deleteButton);
const buttonContainer = document.createElement('div');
buttonContainer.append(exportImportContainer, actionButtonsContainer);
return buttonContainer;
}
function createOverlayMenu() {
// Create and return the overlay menu for configuration settings
const overlay = document.createElement('div');
overlay.id = 'overlayMenu';
overlay.style.position = 'fixed';
overlay.style.top = '0';
overlay.style.left = '0';
overlay.style.width = '100%';
overlay.style.height = '100%';
overlay.style.backgroundColor = 'rgba(0, 0, 0, 0.75)';
overlay.style.zIndex = '1000';
overlay.style.display = 'flex';
overlay.style.justifyContent = 'center';
overlay.style.alignItems = 'center';
const menuContent = document.createElement('div');
menuContent.style.backgroundColor = 'var(--background-color)';
menuContent.style.color = 'var(--text-color)';
menuContent.style.padding = '20px';
menuContent.style.borderRadius = '5px';
menuContent.style.boxShadow = '0 0 10px rgba(0, 0, 0, 0.5)';
menuContent.style.width = '80%';
menuContent.style.maxWidth = '550px';
menuContent.style.maxHeight = '80%';
menuContent.style.overflowY = 'auto';
for (const [key, value] of Object.entries(CONFIG)) {
const optionContainer = document.createElement('div');
optionContainer.style.marginBottom = '10px';
optionContainer.style.display = 'flex';
optionContainer.style.alignItems = 'center';
const leftContainer = document.createElement('div');
leftContainer.style.flex = '1';
leftContainer.style.display = 'flex';
leftContainer.style.alignItems = 'center';
const rightContainer = document.createElement('div');
rightContainer.style.flex = '1';
rightContainer.style.display = 'flex';
rightContainer.style.alignItems = 'center';
rightContainer.style.justifyContent = 'center';
const label = document.createElement('label');
label.textContent = key.replace(/_/g, ' ').split(' ').map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()).join(' ');
label.style.marginRight = '10px';
leftContainer.appendChild(label);
if (typeof value === 'boolean') {
const checkboxContainer = document.createElement('div');
checkboxContainer.style.display = 'flex';
checkboxContainer.style.alignItems = 'center';
checkboxContainer.style.justifyContent = 'center';
const checkbox = document.createElement('input');
checkbox.type = 'checkbox';
checkbox.checked = value;
checkbox.setAttribute('data-key', key);
checkbox.setAttribute('data-type', 'boolean');
checkbox.setAttribute('data-type-part', '');
checkboxContainer.appendChild(checkbox);
rightContainer.appendChild(checkboxContainer);
} else if (typeof value === 'number') {
const numberContainer = document.createElement('div');
numberContainer.style.display = 'flex';
numberContainer.style.alignItems = 'center';
numberContainer.style.justifyContent = 'center';
const decrementButton = document.createElement('button');
decrementButton.textContent = '-';
decrementButton.style.marginRight = '5px';
const input = document.createElement('span');
input.textContent = value;
input.style.margin = '0 10px';
input.style.minWidth = '3ch';
input.style.textAlign = 'center';
input.setAttribute('data-key', key);
input.setAttribute('data-type', 'number');
input.setAttribute('data-type-part', '');
const incrementButton = document.createElement('button');
incrementButton.textContent = '+';
incrementButton.style.marginLeft = '5px';
const updateButtonStates = () => {
let currentValue = parseFloat(input.textContent);
if (currentValue <= 0) {
decrementButton.disabled = true;
decrementButton.style.color = 'grey';
} else {
decrementButton.disabled = false;
decrementButton.style.color = '';
}
if (key === 'SOUND_VOLUME' && currentValue >= 100) {
incrementButton.disabled = true;
incrementButton.style.color = 'grey';
} else {
incrementButton.disabled = false;
incrementButton.style.color = '';
}
};
decrementButton.addEventListener('click', () => {
let currentValue = parseFloat(input.textContent);
if (currentValue > 0) {
if (currentValue > 200) {
input.textContent = currentValue - 25;
} else if (currentValue > 20) {
input.textContent = currentValue - 5;
} else {
input.textContent = currentValue - 1;
}
updateButtonStates();
}
});
incrementButton.addEventListener('click', () => {
let currentValue = parseFloat(input.textContent);
if (key === 'SOUND_VOLUME' && currentValue >= 100) {
return;
}
if (currentValue >= 200) {
input.textContent = currentValue + 25;
} else if (currentValue >= 20) {
input.textContent = currentValue + 5;
} else {
input.textContent = currentValue + 1;
}
updateButtonStates();
});
numberContainer.appendChild(decrementButton);
numberContainer.appendChild(input);
numberContainer.appendChild(incrementButton);
rightContainer.appendChild(numberContainer);
// Initialize button states
updateButtonStates();
} else if (typeof value === 'string') {
const typeParts = value.split(/(\d+)/).filter(Boolean);
const numberParts = typeParts.filter(part => !isNaN(part)).map(Number);
const numberContainer = document.createElement('div');
numberContainer.style.display = 'flex';
numberContainer.style.alignItems = 'center';
numberContainer.style.justifyContent = 'center';
const typeSpan = document.createElement('span');
const formattedType = '(' + typeParts.filter(part => isNaN(part)).join('').replace(/_/g, ' ').toLowerCase() + ')';
typeSpan.textContent = formattedType;
typeSpan.style.marginRight = '10px';
leftContainer.appendChild(typeSpan);
typeParts.forEach(part => {
if (!isNaN(part)) {
const decrementButton = document.createElement('button');
decrementButton.textContent = '-';
decrementButton.style.marginRight = '5px';
const input = document.createElement('span');
input.textContent = part;
input.style.margin = '0 10px';
input.style.minWidth = '3ch';
input.style.textAlign = 'center';
input.setAttribute('data-key', key);
input.setAttribute('data-type', 'string');
input.setAttribute('data-type-part', formattedType);
const incrementButton = document.createElement('button');
incrementButton.textContent = '+';
incrementButton.style.marginLeft = '5px';
const updateButtonStates = () => {
let currentValue = parseFloat(input.textContent);
if (currentValue <= 0) {
decrementButton.disabled = true;
decrementButton.style.color = 'grey';
} else {
decrementButton.disabled = false;
decrementButton.style.color = '';
}
if (key === 'SOUND_VOLUME' && currentValue >= 100) {
incrementButton.disabled = true;
incrementButton.style.color = 'grey';
} else {
incrementButton.disabled = false;
incrementButton.style.color = '';
}
};
decrementButton.addEventListener('click', () => {
let currentValue = parseFloat(input.textContent);
if (currentValue > 0) {
if (currentValue > 200) {
input.textContent = currentValue - 25;
} else if (currentValue > 20) {
input.textContent = currentValue - 5;
} else {
input.textContent = currentValue - 1;
}
updateButtonStates();
}
});
incrementButton.addEventListener('click', () => {
let currentValue = parseFloat(input.textContent);
if (key === 'SOUND_VOLUME' && currentValue >= 100) {
return;
}
if (currentValue >= 200) {
input.textContent = currentValue + 25;
} else if (currentValue >= 20) {
input.textContent = currentValue + 5;
} else {
input.textContent = currentValue + 1;
}
updateButtonStates();
});
numberContainer.appendChild(decrementButton);
numberContainer.appendChild(input);
numberContainer.appendChild(incrementButton);
// Initialize button states
updateButtonStates();
}
});
rightContainer.appendChild(numberContainer);
}
optionContainer.appendChild(leftContainer);
optionContainer.appendChild(rightContainer);
menuContent.appendChild(optionContainer);
}
const menuButtons = createMenuButtons();
menuContent.appendChild(menuButtons);
overlay.appendChild(menuContent);
return overlay;
}
//MAIN FUNCTIONS=====================================================================================================================
function onPageLoad() {
// Initialize state and determine vocabulary based on URL
state.embedAboveSubsectionMeanings = false;
const url = window.location.href;
if (url.includes('/vocabulary/')) {
state.vocab = parseVocabFromVocabulary();
} else if (url.includes('c=')) {
state.vocab = parseVocabFromAnswer();
} else if (url.includes('/kanji/')) {
state.vocab = parseVocabFromKanji();
} else {
state.vocab = parseVocabFromReview();
}
// Retrieve stored data for the current vocabulary
const { index, exactState } = getStoredData(state.vocab);
state.currentExampleIndex = index;
state.exactSearch = exactState;
// Fetch data and embed image/audio if necessary
if (state.vocab && !state.apiDataFetched) {
getImmersionKitData(state.vocab, state.exactSearch)
.then(() => {
preloadImages();
if (!/https:\/\/jpdb\.io\/review(#a)?$/.test(url)) {
embedImageAndPlayAudio();
}
})
.catch(console.error);
} else if (state.apiDataFetched) {
embedImageAndPlayAudio();
preloadImages();
setPageWidth();
}
}
function setPageWidth() {
// Set the maximum width of the page
document.body.style.maxWidth = CONFIG.PAGE_WIDTH;
}
// Observe URL changes and reload the page content accordingly
const observer = new MutationObserver(() => {
if (window.location.href !== observer.lastUrl) {
observer.lastUrl = window.location.href;
onPageLoad();
}
});
observer.lastUrl = window.location.href;
observer.observe(document, { subtree: true, childList: true });
// Add event listeners for page load and URL changes
window.addEventListener('load', onPageLoad);
window.addEventListener('popstate', onPageLoad);
window.addEventListener('hashchange', onPageLoad);
// Initial configuration and preloading
loadConfig();
setPageWidth();
preloadImages();
})();