Files
KefinTweaks/utils.js
T

299 lines
11 KiB
JavaScript

// KefinTweaks Utilities
// Provides standardized functionality for hooking into Emby.Page.onViewShow
// while maintaining original Jellyfin functionality
(function() {
'use strict';
// Common logging function
const LOG = (...args) => console.log('[KefinTweaks Utils]', ...args);
const WARN = (...args) => console.warn('[KefinTweaks Utils]', ...args);
const ERR = (...args) => console.error('[KefinTweaks Utils]', ...args);
LOG('Utils script loaded');
// Store the original onViewShow function
let originalOnViewShow = null;
// Initialize the utils by hooking into Emby.Page.onViewShow
function initialize() {
// Store the original onViewShow if it exists
if (window.Emby && window.Emby.Page && window.Emby.Page.onViewShow) {
originalOnViewShow = window.Emby.Page.onViewShow;
LOG('Stored original Emby.Page.onViewShow');
}
// Override onViewShow to maintain original functionality
if (window.Emby && window.Emby.Page) {
window.Emby.Page.onViewShow = function (...args) {
// Call original handler if it exists
if (originalOnViewShow) {
try {
originalOnViewShow.apply(this, ...args);
} catch (err) {
ERR('Error in original onViewShow handler:', err);
}
}
// Call our registered handlers
notifyHandlers(args[0], args[1]);
};
LOG('Hooked into Emby.Page.onViewShow');
} else {
WARN('Emby.Page.onViewShow not found - utils may not work correctly');
}
}
// Array to store registered handlers
const handlers = [];
/**
* Register a callback to be called when page view changes
* @param {Function} callback - Function to call when page view changes
* @param {Object} options - Options for the handler
*/
function onViewPage(callback, options = {}) {
if (typeof callback !== 'function') {
ERR('Callback must be a function');
return;
}
const handlerConfig = {
callback,
options: {
immediate: false, // Call immediately if on matching page
pages: [], // Specific pages to watch (empty = all pages)
...options
}
};
handlers.push(handlerConfig);
LOG(`Registered onViewPage handler (total: ${handlers.length})`);
// Call immediately if requested and we're on a matching page
if (handlerConfig.options.immediate) {
const currentView = getCurrentView();
if (currentView && shouldCallHandler(handlerConfig, currentView)) {
try {
callback(currentView, document);
} catch (err) {
ERR('Error in immediate handler call:', err);
}
}
}
// Return a function to unregister this handler
return () => {
const index = handlers.indexOf(handlerConfig);
if (index !== -1) {
handlers.splice(index, 1);
LOG(`Unregistered onViewPage handler (remaining: ${handlers.length})`);
}
};
}
/**
* Notify all registered handlers of a view change
* @param {string} view - The view name
* @param {Element} element - The view element
*/
function notifyHandlers(view, element) {
handlers.forEach((config) => {
if (shouldCallHandler(config, view)) {
try {
config.callback(view, element);
} catch (err) {
ERR('Error in onViewPage handler:', err);
}
}
});
}
/**
* Check if a handler should be called for a given view
* @param {Object} config - Handler configuration
* @param {string} view - The view name
* @returns {boolean} Whether the handler should be called
*/
function shouldCallHandler(config, view) {
const { pages } = config.options;
// If no specific pages are specified, call for all pages
if (pages.length === 0) return true;
// Get current URL hash to determine actual page
const currentUrl = window.location.hash;
// Check if the current URL matches any of the specified pages
return pages.some(page => {
if (typeof page === 'string') {
// Check if URL hash contains the page pattern
return currentUrl.includes(`/${page}.html`) || currentUrl.includes(`/${page}`) || currentUrl.includes(page);
} else if (page instanceof RegExp) {
return page.test(currentUrl);
}
return false;
});
}
/**
* Get the current view name
* @returns {string|null} Current view name or null if not available
*/
function getCurrentView() {
// Try to get view from URL hash (primary method)
const hash = window.location.hash;
if (hash) {
// Extract page name from hash patterns like #/home.html, #/search.html, etc.
const pageMatch = hash.match(/#\/([^\/\?]+)\.html/);
if (pageMatch) {
return pageMatch[1];
}
// Fallback: look for /view/ pattern
const viewMatch = hash.match(/\/view\/([^\/\?]+)/);
if (viewMatch) {
return viewMatch[1];
}
}
// Try to get view from active page element (fallback)
const activePage = document.querySelector('.page:not(.hide)');
if (activePage) {
return activePage.getAttribute('data-page') || activePage.className.split(' ').find(cls => cls.includes('Page'));
}
return null;
}
/**
* Get the number of registered handlers
* @returns {number} Number of registered handlers
*/
function getHandlerCount() {
return handlers.length;
}
/**
* Clear all handlers
*/
function clearHandlers() {
handlers.length = 0;
LOG('Cleared all onViewPage handlers');
}
// Initialize when DOM is ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', initialize);
} else {
initialize();
}
/**
* Add a custom menu link to the custom menu options
* @param {string} name - Display name for the menu item
* @param {string} icon - Material icon name
* @param {string} url - URL to navigate to
* @param {boolean} openInNewTab - Whether to open in new tab (default: false)
* @returns {Promise<boolean>} - True if successfully added, false otherwise
*/
function addCustomMenuLink(name, icon, url, openInNewTab = false) {
return new Promise((resolve) => {
// Check if menu container already exists
const existingContainer = document.querySelector('.customMenuOptions');
if (existingContainer) {
const success = addLinkToContainer(existingContainer, name, icon, url, openInNewTab);
resolve(success);
return;
}
LOG(`Custom menu container not found, waiting for it to appear for link: ${name}`);
// Use MutationObserver to watch for the menu container
const observer = new MutationObserver((mutations) => {
for (const mutation of mutations) {
mutation.addedNodes.forEach(node => {
if (node.nodeType === Node.ELEMENT_NODE) {
// Check if the added node is the menu or contains it
if (node.matches?.('.customMenuOptions') || node.querySelector?.('.customMenuOptions')) {
const container = node.matches?.('.customMenuOptions') ? node : node.querySelector('.customMenuOptions');
LOG(`Custom menu container detected, adding link: ${name}`);
observer.disconnect();
const success = addLinkToContainer(container, name, icon, url, openInNewTab);
resolve(success);
return;
}
}
});
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
});
}
/**
* Add the link to the existing container
* @param {Element} container - The custom menu options container
* @param {string} name - Display name for the menu item
* @param {string} icon - Material icon name
* @param {string} url - URL to navigate to
* @param {boolean} openInNewTab - Whether to open in new tab
* @returns {boolean} - True if successfully added
*/
function addLinkToContainer(container, name, icon, url, openInNewTab) {
try {
// Create the menu link element
const link = document.createElement('a');
link.setAttribute('is', 'emby-linkbutton');
link.className = 'emby-button navMenuOption lnkMediaFolder';
link.href = url;
if (openInNewTab) {
link.setAttribute('rel', 'noopener noreferrer');
link.setAttribute('target', '_blank');
}
// Create the icon span
const iconSpan = document.createElement('span');
iconSpan.className = `material-icons navMenuOptionIcon ${icon}`;
iconSpan.setAttribute('aria-hidden', 'true');
// Create the text span
const textSpan = document.createElement('span');
textSpan.className = 'navMenuOptionText';
textSpan.textContent = name;
// Append icon and text to link
link.appendChild(iconSpan);
link.appendChild(textSpan);
// Append link to container
container.appendChild(link);
LOG(`Successfully added custom menu link: ${name}`);
return true;
} catch (err) {
ERR(`Error adding custom menu link ${name}:`, err);
return false;
}
}
// Expose utilities to global scope
window.KefinTweaksUtils = {
onViewPage,
getCurrentView,
getHandlerCount,
clearHandlers,
addCustomMenuLink
};
LOG('KefinTweaks Utils loaded and available at window.KefinTweaksUtils');
})();