kiwix/kiwix-js-pwa
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-js-pwa.git synced 2025-09-09 20:32:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

ESLint cleanup of transformStyles.js

Browse Source
This commit is contained in:
Jaifroid 2023-10-10 15:00:20 +01:00
parent 957a70af8a
commit 5872f8037a
1 changed files with 95 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
www/js/lib/transformStyles.js
View File

@ -47,24 +47,26 @@
'use strict';
import util from './util.js';
import uiUtil from './uiUtil.js';
/* global params */
var prefix = (window.location.protocol + '//' + window.location.host + window.location.pathname).replace(/\/[^/]*$/, '/');
/* zl = zimLink; zim = zimType; cc = cssCache; cs = cssSource; i] */
function filterCSS (zl, zim, cc, cs, i) {
var rtnFunction = "injectCSS";
if ((zim != cs) && zl.match(/(-\/(?:s\/css_modules\/|mw\/)?style\.css)|minerva|mobile|parsoid/i)) { //If it's the wrong ZIM type and style matches main styles...
var rtnFunction = 'injectCSS';
if ((zim !== cs) && zl.match(/(-\/(?:s\/css_modules\/|mw\/)?style\.css)|minerva|mobile|parsoid/i)) { // If it's the wrong ZIM type and style matches main styles...
if (zl.match(/-\/(?:s\/|mw\/)?style\.css|minerva|style-mobile\.css/i)) { // If it matches one of the required styles...
zl = (cs == "mobile") ? prefix + "-/s/style-mobile.css" : prefix + "-/s/style.css"; //Take it from cache, because not in the ZIM
console.log("Matched #" + i + " [" + zl + "] from local filesystem because style is not in ZIM" +
"\nbut your display options require a " + cs + " style");
zl = (cs === 'mobile') ? prefix + '-/s/style-mobile.css' : prefix + '-/s/style.css'; // Take it from cache, because not in the ZIM
console.log('Matched #' + i + ' [' + zl + '] from local filesystem because style is not in ZIM' +
'\nbut your display options require a ' + cs + ' style');
}
if (cs == "desktop" && /minerva|mobile|parsoid|(css_modules|mw)\/style\.css/.test(zl) && !/(css_modules|mw)\/mobile_main_page\.css/.test(zl)) {
if (cs === 'desktop' && /minerva|mobile|parsoid|(css_modules|mw)\/style\.css/.test(zl) && !/(css_modules|mw)\/mobile_main_page\.css/.test(zl)) {
// If user selected desktop style and style is one of the mobile styles, but not mobile_main_page for newstyle all image homepages
console.log("Voiding #" + i + " [" + zl + "] from document header \nbecause your display options require a desktop style");
zl = "#"; //Void these mobile styles
console.log('Voiding #' + i + ' [' + zl + '] from document header \nbecause your display options require a desktop style');
zl = '#'; // Void these mobile styles
}
// Rename this required mobile style so that we don't trigger reading ZIM as mobile in print intercept
zl = /(css_modules|mw)\/mobile_main_page\.css/.test(zl) && cs == 'desktop' ? prefix + "-/s/css_modules/newstyle_main_page.css" : zl;
zl = /(css_modules|mw)\/mobile_main_page\.css/.test(zl) && cs === 'desktop' ? prefix + '-/s/css_modules/newstyle_main_page.css' : zl;
} else {
// If this is a standard Wikipedia css use stylesheet cached in the filesystem...
// DEV: Although "." matches any character in regex, there is enough specificity in the patterns below
@ -102,25 +104,25 @@ function filterCSS(zl, zim, cc, cs, i) {
/\/style-mobile.css/i.test(zl) ||
/\/skins.minerva.base.reset\|skins.minerva.content.styles\|ext.cite.style\|mediawiki.page.gallery.styles\|mobile.app.pagestyles.android\|mediawiki.skinning.content.parsoid.css/i.test(zl)
)) {
zl = zl.replace(/\|/ig, "_"); //Replace "|" with "_" (legacy for some stylesheets with pipes in filename - but next line renders this redundant in current implementation)
zl = zl.replace(/\|/ig, '_'); // Replace "|" with "_" (legacy for some stylesheets with pipes in filename - but next line renders this redundant in current implementation)
if (/(-\/(?:s\/css_modules\/|mw\/)?style\.css)|minerva|inserted_style_mobile/i.test(zl)) { // If it matches one of the required styles...
zl = cs == "mobile" ? "-/s/style-mobile.css" : "-/s/style.css";
zl = cs === 'mobile' ? '-/s/style-mobile.css' : '-/s/style.css';
}
// Rename this required mobile style so that we don't trigger reading ZIM as mobile in print intercept
zl = /\/mobile_main_page\.css/.test(zl) ? "-/mw/newstyle_main_page.css" : zl;
zl = /\/content\.parsoid\.css/.test(zl) ? "-/s/css_modules/content.parsoid.css" : zl;
zl = /\/sotoki\.css/.test(zl) ? "C/static/css/sotoki.css" : zl;
zl = /\/mobile_main_page\.css/.test(zl) ? '-/mw/newstyle_main_page.css' : zl;
zl = /\/content\.parsoid\.css/.test(zl) ? '-/s/css_modules/content.parsoid.css' : zl;
zl = /\/sotoki\.css/.test(zl) ? 'C/static/css/sotoki.css' : zl;
// Replace bootstrap with own: DEV: when upgrading to Bootstrap 4, stop doing this!
zl = zl.replace(/.+(bootstrap[^\/]*?\.css)/i, "css/$1");
console.debug("Matched #" + i + " [" + zl + "] from local filesystem");
zl = zl.replace(/.+(bootstrap[^/]*?\.css)/i, 'css/$1');
console.debug('Matched #' + i + ' [' + zl + '] from local filesystem');
// Make link absolute
zl = zl.replace(/^[/.]*/, prefix);
// injectCSS();
} else if (params.contentInjectionMode == 'jquery') { //Try to get the stylesheet from the ZIM file unless it's the wrong ZIM type
zl = zl.replace(/^[./]+/, ""); //Remove the directory path
console.debug("Attempting to resolve CSS link #" + i + " [" + zl + "] from ZIM file..." +
(cc ? "\n(Consider adding file #" + i + " to the local filesystem)" : ""));
rtnFunction = "resolveCSS";
} else if (params.contentInjectionMode === 'jquery') { // Try to get the stylesheet from the ZIM file unless it's the wrong ZIM type
zl = zl.replace(/^[./]+/, ''); // Remove the directory path
console.debug('Attempting to resolve CSS link #' + i + ' [' + zl + '] from ZIM file...' +
(cc ? '\n(Consider adding file #' + i + ' to the local filesystem)' : ''));
rtnFunction = 'resolveCSS';
}
}
return { zl: zl, rtnFunction: rtnFunction };
@ -129,20 +131,20 @@ function filterCSS(zl, zim, cc, cs, i) {
function toMobileCSS (html, zim, cc, cs, css) {
// DEV: Careful not to add styles twice...
// NB Can't relocate to filterCSS function above because it filters styles serially and code would be called for every style...
if (zim == "desktop" && zim != cs) { //If ZIM doesn't match user-requested style, add in stylesheets if they're missing
css += /\/content\.parsoid\.css/i.test(css) ? "" : '<link href="' + prefix + '-/s/css_modules/content.parsoid.css" rel="stylesheet" type="text/css">\r\n';
css += /\/inserted_style_mobile\.css/i.test(css) ? "" : '<link href="' + prefix + '-/s/style-mobile.css" rel="stylesheet" type="text/css">\r\n';
css += /\/mobile\.css/i.test(css) ? "" : '<link href="' + prefix + '-/s/css_modules/mobile.css" rel="stylesheet" type="text/css">\r\n';
if (zim === 'desktop' && zim !== cs) { // If ZIM doesn't match user-requested style, add in stylesheets if they're missing
css += /\/content\.parsoid\.css/i.test(css) ? '' : '<link href="' + prefix + '-/s/css_modules/content.parsoid.css" rel="stylesheet" type="text/css">\r\n';
css += /\/inserted_style_mobile\.css/i.test(css) ? '' : '<link href="' + prefix + '-/s/style-mobile.css" rel="stylesheet" type="text/css">\r\n';
css += /\/mobile\.css/i.test(css) ? '' : '<link href="' + prefix + '-/s/css_modules/mobile.css" rel="stylesheet" type="text/css">\r\n';
}
if (cc || (zim == "desktop")) { //If user requested cached styles OR the ZIM does not contain mobile styles
console.log(zim == "desktop" ? "Transforming display style to mobile..." : "Optimizing cached styles for mobile display...");
if (cc || (zim === 'desktop')) { // If user requested cached styles OR the ZIM does not contain mobile styles
console.log(zim === 'desktop' ? 'Transforming display style to mobile...' : 'Optimizing cached styles for mobile display...');
// Add styling to image captions that is hard-coded in Wikipedia mobile
html = html.replace(/class\s*=\s*["']\s*thumbcaption\s*["']\s*/ig, 'style="margin: 0.5em 0 0.5em; font-size: 0.8em; line-height: 1.5; padding: 0 !important; color: #54595d; width: auto !important;"');
// Wrap <h2> tags in <div> to control bottom border width if there's an infobox, but not if it's a new-style ZIM with collapsible details tags
if (!/<details[\s\S]+?<summary\b/i.test(html)) {
html = /<table\s+(?=[^>]*class\s*=\s*["'][^"']*(?:mw-stack|infobox|vertical-navbox|qbRight|wv-quickbar))/i.test(html) ? html.replace(/(<h2\s+[^<]*<\/h2>)/ig, '<div style="width: 60%;">$1</div>') : html;
}
if (zim == "desktop") {
if (zim === 'desktop') {
var infobox = [];
if (/<table\b[^>]+(?:mw-stack|infobox|vertical-navbox|qbRight|wv-quickbar)/i.test(html)) {
infobox = util.matchOuter(html, '<table\\b[^>]+(?:mw-stack|infobox|vertical-navbox|qbRight|wv-quickbar)[^>]+>', '</table>', 'i');
@ -152,13 +154,13 @@ function toMobileCSS(html, zim, cc, cs, css) {
}
}
if (infobox.length) {
var temphtml = html.replace(infobox[0], "<!-- @@@kiwixmarker@@@ -->");
var temphtml = html.replace(infobox[0], '<!-- @@@kiwixmarker@@@ -->');
var paras = util.matchInner(temphtml, '<p\\b[^>]*>', '</p>', 'gi');
var matched = false;
if (paras.length) {
for (var g = 0; g < 3; g++) {
// Check if the paragraph is a proper sentence, i.e. contains at least 50 non-HTML-delimetered non-full-stop characters, followed by a punctuation character
if (paras[g] && /[^.]{50,}[^.]*[.,;:?!-]/.test(paras[g].replace(/<[^>]*>/g, ""))) { matched = true; break; }
if (paras[g] && /[^.]{50,}[^.]*[.,;:?!-]/.test(paras[g].replace(/<[^>]*>/g, ''))) { matched = true; break; }
}
if (matched) {
// If there are navboxes below the infobox, hide them in mobile view
@ -170,16 +172,16 @@ function toMobileCSS(html, zim, cc, cs, css) {
// Hide any navboxes inside the infobox
infobox[0] = infobox[0].replace(/(<(?:table|div)\b(?=[^>]+?class\s*=\s*["'][^"']*navbox))(?:([^>]+?)style\s*=\s*["'])(?:([^"']*?)display\s*:[^;"']*[;"'])?/ig, '$1$2style="display:none;$3');
// We already deleted the table above
html = "";
html = '';
// First try to move the lead paragraph
html = temphtml.replace(/(<div\s+[^>]*?\bid\s*=\s*["']mw-content-text\s*[^>]*>\s*)/i, "$1\r\n" + paras[g].replace(/(<p\s+)/i, '$1data-kiwix-id="lead" ') + "\r\n");
html = temphtml.replace(/(<div\s+[^>]*?\bid\s*=\s*["']mw-content-text\s*[^>]*>\s*)/i, '$1\r\n' + paras[g].replace(/(<p\s+)/i, '$1data-kiwix-id="lead" ') + '\r\n');
if (html) { // Looks like we succeeded so clean up
html = html.replace(paras[g], "");
html = html.replace("<!-- @@@kiwixmarker@@@ -->", infobox[0]);
html = html.replace(paras[g], '');
html = html.replace('<!-- @@@kiwixmarker@@@ -->', infobox[0]);
} else {
// So there was no match, let's try just swapping para and infobox
html = temphtml.replace(paras[g], paras[g].replace(/(<p\s+)/i, '$1data-kiwix-id="lead" ') + "\r\n" + infobox[0]);
html = html.replace("<!-- @@@kiwixmarker@@@ -->", "");
html = temphtml.replace(paras[g], paras[g].replace(/(<p\s+)/i, '$1data-kiwix-id="lead" ') + '\r\n' + infobox[0]);
html = html.replace('<!-- @@@kiwixmarker@@@ -->', '');
}
}
}
@ -195,29 +197,29 @@ function toMobileCSS(html, zim, cc, cs, css) {
}
function toDesktopCSS (html, zim, cc, cs, css) {
if (cc || (zim != cs)) {
if (cc || (zim !== cs)) {
if (/class\s*=\s*["']gallery/i.test(html) && !/gallery/i.test(css)) {
console.log("Inserting missing css required for gallery display [mediawiki.page.gallery.styles.css]...");
css += /\/mediawiki\.page\.gallery\.styles\.css/i.test(css) ? "" : '<link href="' + prefix + '-/s/css_modules/mediawiki.page.gallery.styles.css" rel="stylesheet" type="text/css">\r\n';
console.log('Inserting missing css required for gallery display [mediawiki.page.gallery.styles.css]...');
css += /\/mediawiki\.page\.gallery\.styles\.css/i.test(css) ? '' : '<link href="' + prefix + '-/s/css_modules/mediawiki.page.gallery.styles.css" rel="stylesheet" type="text/css">\r\n';
}
}
if (cc || (zim == "mobile")) { //If user requested cached styles OR the ZIM does not contain desktop styles
console.log(zim == "mobile" ? "Transforming display style to desktop..." : "Optimizing cached styles for desktop display...");
if (cc || (zim === 'mobile')) { // If user requested cached styles OR the ZIM does not contain desktop styles
console.log(zim === 'mobile' ? 'Transforming display style to desktop...' : 'Optimizing cached styles for desktop display...');
// If it's in mobile position, move info-box above lead paragraph like on Wikipedia desktop
if (zim == "mobile") {
if (zim === 'mobile') {
// Attempt to match div-style infobox first
var tableBox = util.matchOuter(html, '<div\\b[^>]+?(?:infobox[^-]|vertical-navbox|qbRight|wv-quickbar)[^>]*>', '</div>', 'i');
// If above failed we may have traditional table-style infobox
tableBox = !(tableBox && tableBox.length) ? util.matchOuter(html, '<table\\b[^>]+?(?:mw-stack|infobox[^-]|vertical-navbox|qbRight|wv-quickbar)[^>]*>', '</table>', 'i') : tableBox;
if (tableBox && tableBox.length) {
html = html.replace(tableBox, "");
html = html.replace(/(<\/h1>\s*)/i, "$1" + tableBox);
html = html.replace(tableBox, '');
html = html.replace(/(<\/h1>\s*)/i, '$1' + tableBox);
}
}
// Ensure white background colour
html = html.replace(/(class\s*=\s*["']\s*mw-body\s*["'][^>]*?style\s*=\s*["'])/i, "$1background-color:white;");
html = html.replace(/(class\s*=\s*["']\s*mw-body\s*["'][^>]*?style\s*=\s*["'])/i, '$1background-color:white;');
// Void empty header title
html = html.replace(/<h1\s*[^>]+titleHeading[^>]+>\s*<\/h1>\s*/ig, "");
html = html.replace(/<h1\s*[^>]+titleHeading[^>]+>\s*<\/h1>\s*/ig, '');
}
// Remove hard-coded style on h1
html = html.replace(/(<h1\b[^>]+)background-color\s*:\s*white;\s*/i, '$1');