single-file-core.js 73 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757
  1. /*
  2. * Copyright 2010-2019 Gildas Lormeau
  3. * contact : gildas.lormeau <at> gmail.com
  4. *
  5. * This file is part of SingleFile.
  6. *
  7. * The code in this file is free software: you can redistribute it and/or
  8. * modify it under the terms of the GNU Affero General Public License
  9. * (GNU AGPL) as published by the Free Software Foundation, either version 3
  10. * of the License, or (at your option) any later version.
  11. *
  12. * The code in this file is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
  15. * General Public License for more details.
  16. *
  17. * As additional permission under GNU AGPL version 3 section 7, you may
  18. * distribute UNMODIFIED VERSIONS OF THIS file without the copy of the GNU
  19. * AGPL normally required by section 4, provided you include this license
  20. * notice and a URL through which recipients can access the Corresponding
  21. * Source.
  22. */
  23. this.SingleFileCore = this.SingleFileCore || (() => {
  24. const SELECTED_CONTENT_ATTRIBUTE_NAME = "data-single-file-selected-content";
  25. const DEBUG = false;
  26. let docUtil, cssTree, sessionId = 0;
  27. function getClass(...args) {
  28. [docUtil, cssTree] = args;
  29. return SingleFileClass;
  30. }
  31. class SingleFileClass {
  32. constructor(options) {
  33. this.options = options;
  34. options.insertFaviconLink = true;
  35. if (options.sessionId === undefined) {
  36. options.sessionId = sessionId;
  37. sessionId++;
  38. }
  39. }
  40. async run() {
  41. this.runner = new Runner(this.options, true);
  42. await this.runner.loadPage();
  43. await this.runner.initialize();
  44. await this.runner.run();
  45. }
  46. async getPageData() {
  47. return this.runner.getPageData();
  48. }
  49. }
  50. SingleFileClass.SELECTED_CONTENT_ATTRIBUTE_NAME = SELECTED_CONTENT_ATTRIBUTE_NAME;
  51. // -------------
  52. // ProgressEvent
  53. // -------------
  54. const PAGE_LOADING = "page-loading";
  55. const PAGE_LOADED = "page-loaded";
  56. const RESOURCES_INITIALIZING = "resource-initializing";
  57. const RESOURCES_INITIALIZED = "resources-initialized";
  58. const RESOURCE_LOADED = "resource-loaded";
  59. const PAGE_ENDED = "page-ended";
  60. const STAGE_STARTED = "stage-started";
  61. const STAGE_ENDED = "stage-ended";
  62. const STAGE_TASK_STARTED = "stage-task-started";
  63. const STAGE_TASK_ENDED = "stage-task-ended";
  64. class ProgressEvent {
  65. constructor(type, detail) {
  66. return { type, detail, PAGE_LOADING, PAGE_LOADED, RESOURCES_INITIALIZING, RESOURCES_INITIALIZED, RESOURCE_LOADED, PAGE_ENDED, STAGE_STARTED, STAGE_ENDED, STAGE_TASK_STARTED, STAGE_TASK_ENDED };
  67. }
  68. }
  69. // ------
  70. // Runner
  71. // ------
  72. const RESOLVE_URLS_STAGE = 0;
  73. const REPLACE_DATA_STAGE = 1;
  74. const REPLACE_DOCS_STAGE = 2;
  75. const POST_PROCESS_STAGE = 3;
  76. const STAGES = [{
  77. sequential: [
  78. { action: "preProcessPage" },
  79. { action: "insertShadowRootContents" },
  80. { action: "replaceStyleContents" },
  81. { option: "selected", action: "removeUnselectedElements" },
  82. { option: "removeVideoSrc", action: "insertVideoPosters" },
  83. { option: "removeFrames", action: "removeFrames" },
  84. { option: "removeImports", action: "removeImports" },
  85. { option: "removeScripts", action: "removeScripts" },
  86. { option: "removeVideoSrc", action: "removeVideoSources" },
  87. { option: "removeAudioSrc", action: "removeAudioSources" },
  88. { action: "removeDiscardedResources" },
  89. { action: "resetCharsetMeta" },
  90. { action: "setInputValues" },
  91. { option: "insertFaviconLink", action: "insertFaviconLink" },
  92. { action: "replaceCanvasElements" },
  93. { action: "insertFonts" },
  94. { option: "removeHiddenElements", action: "removeHiddenElements" },
  95. { action: "resolveHrefs" },
  96. { action: "resolveStyleAttributeURLs" }
  97. ],
  98. parallel: [
  99. { action: "resolveStylesheetURLs" },
  100. { option: "!removeFrames", action: "resolveFrameURLs" },
  101. { option: "!removeImports", action: "resolveHtmlImportURLs" }
  102. ]
  103. }, {
  104. sequential: [
  105. { option: "removeUnusedStyles", action: "removeUnusedStyles" },
  106. { option: "removeAlternativeMedias", action: "removeAlternativeMedias" },
  107. { option: "removeUnusedFonts", action: "removeUnusedFonts" }
  108. ],
  109. parallel: [
  110. { action: "processStylesheets" },
  111. { action: "processStyleAttributes" },
  112. { action: "processPageResources" },
  113. { option: "!removeScripts", action: "processScripts" }
  114. ]
  115. }, {
  116. sequential: [
  117. { option: "removeAlternativeImages", action: "removeAlternativeImages" },
  118. { option: "removeAlternativeFonts", action: "removeAlternativeFonts" }
  119. ],
  120. parallel: [
  121. { option: "!removeFrames", action: "processFrames" },
  122. { option: "!removeImports", action: "processHtmlImports" },
  123. ]
  124. }, {
  125. sequential: [
  126. { action: "replaceStylesheets" },
  127. { action: "replaceStyleAttributes" },
  128. { action: "insertVariables" },
  129. { option: "compressHTML", action: "compressHTML" }
  130. ]
  131. }];
  132. class Runner {
  133. constructor(options, root) {
  134. this.root = root;
  135. this.options = options;
  136. this.options.url = this.options.url || this.options.doc.location.href;
  137. this.options.baseURI = this.options.doc && this.options.doc.baseURI;
  138. this.batchRequest = new BatchRequest();
  139. this.processor = new Processor(options, this.batchRequest);
  140. if (this.options.doc) {
  141. const docData = docUtil.preProcessDoc(this.options.doc, this.options.win, this.options);
  142. this.options.canvasData = docData.canvasData;
  143. this.options.fontsData = docData.fontsData;
  144. this.options.stylesheetContents = docData.stylesheetContents;
  145. this.options.imageData = docData.imageData;
  146. this.options.postersData = docData.postersData;
  147. this.options.usedFonts = docData.usedFonts;
  148. this.options.shadowRootContents = docData.shadowRootContents;
  149. this.options.referrer = docData.referrer;
  150. }
  151. if (this.options.saveRawPage) {
  152. this.options.removeFrames = true;
  153. }
  154. this.options.content = this.options.content || (this.options.doc ? docUtil.serialize(this.options.doc, false) : null);
  155. this.onprogress = options.onprogress || (() => { });
  156. }
  157. async loadPage() {
  158. this.onprogress(new ProgressEvent(PAGE_LOADING, { pageURL: this.options.url, frame: !this.root }));
  159. await this.processor.loadPage(this.options.content);
  160. this.onprogress(new ProgressEvent(PAGE_LOADED, { pageURL: this.options.url, frame: !this.root }));
  161. }
  162. async initialize() {
  163. this.onprogress(new ProgressEvent(RESOURCES_INITIALIZING, { pageURL: this.options.url }));
  164. await this.executeStage(RESOLVE_URLS_STAGE);
  165. this.pendingPromises = this.executeStage(REPLACE_DATA_STAGE);
  166. if (this.options.doc) {
  167. docUtil.postProcessDoc(this.options.doc, this.options);
  168. }
  169. this.options.doc = null;
  170. this.options.win = null;
  171. }
  172. async run() {
  173. if (this.root) {
  174. this.processor.initialize(this.batchRequest);
  175. this.onprogress(new ProgressEvent(RESOURCES_INITIALIZED, { pageURL: this.options.url, index: 0, max: this.processor.maxResources }));
  176. }
  177. await this.batchRequest.run(detail => {
  178. detail.pageURL = this.options.url;
  179. this.onprogress(new ProgressEvent(RESOURCE_LOADED, detail));
  180. }, this.options);
  181. await this.pendingPromises;
  182. await this.executeStage(REPLACE_DOCS_STAGE);
  183. await this.executeStage(POST_PROCESS_STAGE);
  184. await this.processor.finalize();
  185. }
  186. async getPageData() {
  187. if (this.root) {
  188. this.onprogress(new ProgressEvent(PAGE_ENDED, { pageURL: this.options.url }));
  189. }
  190. return this.processor.getPageData();
  191. }
  192. async executeStage(step) {
  193. if (DEBUG) {
  194. log("**** STARTED STAGE", step, "****");
  195. }
  196. const frame = !this.root;
  197. this.onprogress(new ProgressEvent(STAGE_STARTED, { pageURL: this.options.url, step, frame }));
  198. STAGES[step].sequential.forEach(task => {
  199. let startTime;
  200. if (DEBUG) {
  201. startTime = Date.now();
  202. log(" -- STARTED task =", task.action);
  203. }
  204. this.onprogress(new ProgressEvent(STAGE_TASK_STARTED, { pageURL: this.options.url, step, task: task.action, frame }));
  205. this.executeTask(task);
  206. this.onprogress(new ProgressEvent(STAGE_TASK_ENDED, { pageURL: this.options.url, step, task: task.action, frame }));
  207. if (DEBUG) {
  208. log(" -- ENDED task =", task.action, "delay =", Date.now() - startTime);
  209. }
  210. });
  211. let parallelTasksPromise;
  212. if (STAGES[step].parallel) {
  213. parallelTasksPromise = await Promise.all(STAGES[step].parallel.map(async task => {
  214. let startTime;
  215. if (DEBUG) {
  216. startTime = Date.now();
  217. log(" // STARTED task =", task.action);
  218. }
  219. this.onprogress(new ProgressEvent(STAGE_TASK_STARTED, { pageURL: this.options.url, step, task: task.action, frame }));
  220. await this.executeTask(task);
  221. this.onprogress(new ProgressEvent(STAGE_TASK_ENDED, { pageURL: this.options.url, step, task: task.action, frame }));
  222. if (DEBUG) {
  223. log(" // ENDED task =", task.action, "delay =", Date.now() - startTime);
  224. }
  225. }));
  226. } else {
  227. parallelTasksPromise = Promise.resolve();
  228. }
  229. this.onprogress(new ProgressEvent(STAGE_ENDED, { pageURL: this.options.url, step, frame }));
  230. if (DEBUG) {
  231. log("**** ENDED STAGE", step, "****");
  232. }
  233. return parallelTasksPromise;
  234. }
  235. executeTask(task) {
  236. if (!task.option || ((task.option.startsWith("!") && !this.options[task.option]) || this.options[task.option])) {
  237. return this.processor[task.action]();
  238. }
  239. }
  240. }
  241. // ------------
  242. // BatchRequest
  243. // ------------
  244. class BatchRequest {
  245. constructor() {
  246. this.requests = new Map();
  247. this.duplicates = new Map();
  248. }
  249. async addURL(resourceURL, asDataURI, groupDuplicates) {
  250. return new Promise((resolve, reject) => {
  251. const requestKey = JSON.stringify([resourceURL, asDataURI]);
  252. let resourceRequests = this.requests.get(requestKey);
  253. if (!resourceRequests) {
  254. resourceRequests = [];
  255. this.requests.set(requestKey, resourceRequests);
  256. }
  257. const callbacks = { resolve, reject };
  258. resourceRequests.push(callbacks);
  259. if (groupDuplicates) {
  260. let duplicateRequests = this.duplicates.get(requestKey);
  261. if (!duplicateRequests) {
  262. duplicateRequests = [];
  263. this.duplicates.set(requestKey, duplicateRequests);
  264. }
  265. duplicateRequests.push(callbacks);
  266. }
  267. });
  268. }
  269. getMaxResources() {
  270. return this.requests.size;
  271. }
  272. async run(onloadListener, options) {
  273. const resourceURLs = Array.from(this.requests.keys());
  274. let indexResource = 0;
  275. return Promise.all(resourceURLs.map(async requestKey => {
  276. const [resourceURL, asDataURI] = JSON.parse(requestKey);
  277. const resourceRequests = this.requests.get(requestKey);
  278. try {
  279. const content = await docUtil.getContent(resourceURL, { asDataURI, maxResourceSize: options.maxResourceSize, maxResourceSizeEnabled: options.maxResourceSizeEnabled });
  280. indexResource = indexResource + 1;
  281. onloadListener({ index: indexResource, url: resourceURL });
  282. resourceRequests.forEach(callbacks => {
  283. const duplicateCallbacks = this.duplicates.get(requestKey);
  284. const duplicate = duplicateCallbacks && duplicateCallbacks.length > 1 && duplicateCallbacks.includes(callbacks);
  285. callbacks.resolve({ content: content.data, indexResource, duplicate });
  286. });
  287. } catch (error) {
  288. indexResource = indexResource + 1;
  289. onloadListener({ index: indexResource, url: resourceURL });
  290. resourceRequests.forEach(resourceRequest => resourceRequest.reject(error));
  291. }
  292. this.requests.delete(requestKey);
  293. }));
  294. }
  295. }
  296. // ---------
  297. // Processor
  298. // ---------
  299. const PREFIXES_FORBIDDEN_DATA_URI = ["data:text/"];
  300. const PREFIX_DATA_URI_IMAGE_SVG = "data:image/svg+xml";
  301. const EMPTY_IMAGE = "data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==";
  302. const SCRIPT_TAG_FOUND = /<script/gi;
  303. const NOSCRIPT_TAG_FOUND = /<noscript/gi;
  304. class Processor {
  305. constructor(options, batchRequest) {
  306. this.options = options;
  307. this.stats = new Stats(options);
  308. this.baseURI = Util.normalizeURL(options.baseURI || options.url);
  309. this.batchRequest = batchRequest;
  310. this.stylesheets = new Map();
  311. this.styles = new Map();
  312. this.cssVariables = new Map();
  313. }
  314. initialize() {
  315. this.options.saveDate = new Date();
  316. this.options.saveUrl = this.options.url;
  317. if (this.options.enableMaff) {
  318. this.maffMetaDataPromise = this.batchRequest.addURL(docUtil.resolveURL("index.rdf", this.options.baseURI || this.options.url), false);
  319. }
  320. this.maxResources = this.batchRequest.getMaxResources();
  321. if (!this.options.saveRawPage && !this.options.removeFrames && this.options.framesData) {
  322. this.options.framesData.forEach(frameData => this.maxResources += frameData.maxResources || 0);
  323. }
  324. this.stats.set("processed", "resources", this.maxResources);
  325. }
  326. async loadPage(pageContent, charset) {
  327. let content;
  328. if (!pageContent || this.options.saveRawPage) {
  329. content = await docUtil.getContent(this.baseURI, { asDataURI: false, maxResourceSize: this.options.maxResourceSize, maxResourceSizeEnabled: this.options.maxResourceSizeEnabled, charset });
  330. pageContent = content.data;
  331. }
  332. this.doc = docUtil.parseDocContent(pageContent, this.baseURI);
  333. if (this.options.saveRawPage) {
  334. let charset;
  335. this.doc.querySelectorAll("meta[charset], meta[http-equiv=\"content-type\"]").forEach(element => {
  336. const charsetDeclaration = element.content.split(";")[1];
  337. if (charsetDeclaration && !charset) {
  338. charset = charsetDeclaration.split("=")[1].trim().toLowerCase();
  339. }
  340. });
  341. if (charset && charset != content.charset) {
  342. return this.loadPage(pageContent, charset);
  343. }
  344. }
  345. this.workStyleElement = this.doc.createElement("style");
  346. this.doc.body.appendChild(this.workStyleElement);
  347. this.onEventAttributeNames = Util.getOnEventAttributeNames(this.doc);
  348. }
  349. async finalize() {
  350. if (this.workStyleElement.parentNode) {
  351. this.workStyleElement.remove();
  352. }
  353. const metaCharset = this.doc.head.querySelector("meta[charset]");
  354. if (metaCharset) {
  355. this.doc.head.insertBefore(metaCharset, this.doc.head.firstChild);
  356. }
  357. this.doc.querySelectorAll("base").forEach(element => element.remove());
  358. if (this.doc.head.querySelectorAll("*").length == 1 && metaCharset && this.doc.body.childNodes.length == 0) {
  359. this.doc.head.querySelector("meta[charset]").remove();
  360. }
  361. if (this.maffMetaDataPromise) {
  362. const maffMetaData = await this.maffMetaDataPromise;
  363. if (maffMetaData && maffMetaData.content) {
  364. const NAMESPACE_RDF = "http://www.w3.org/1999/02/22-rdf-syntax-ns#";
  365. const maffDoc = docUtil.parseXMLContent(maffMetaData.content);
  366. const originalURLElement = maffDoc.querySelector("RDF > Description > originalurl");
  367. const archiveTimeElement = maffDoc.querySelector("RDF > Description > archivetime");
  368. if (originalURLElement) {
  369. this.options.saveUrl = originalURLElement.getAttributeNS(NAMESPACE_RDF, "resource");
  370. }
  371. if (archiveTimeElement) {
  372. const value = archiveTimeElement.getAttributeNS(NAMESPACE_RDF, "resource");
  373. if (value) {
  374. const date = new Date(value);
  375. if (!isNaN(date.getTime())) {
  376. this.options.saveDate = new Date(value);
  377. }
  378. }
  379. }
  380. }
  381. }
  382. const titleElement = this.doc.querySelector("title");
  383. const descriptionElement = this.doc.querySelector("meta[name=description]");
  384. const authorElement = this.doc.querySelector("meta[name=author]");
  385. const creatorElement = this.doc.querySelector("meta[name=creator]");
  386. const publisherElement = this.doc.querySelector("meta[name=publisher]");
  387. this.options.title = titleElement ? titleElement.textContent.trim() : "";
  388. this.options.infobarContent = await ProcessorHelper.evalTemplate(this.options.infobarTemplate, this.options, null, true);
  389. this.options.info = {
  390. description: descriptionElement && descriptionElement.content ? descriptionElement.content.trim() : "",
  391. lang: this.doc.documentElement.lang,
  392. author: authorElement && authorElement.content ? authorElement.content.trim() : "",
  393. creator: creatorElement && creatorElement.content ? creatorElement.content.trim() : "",
  394. publisher: publisherElement && publisherElement.content ? publisherElement.content.trim() : ""
  395. };
  396. }
  397. async getPageData() {
  398. docUtil.postProcessDoc(this.doc, this.options);
  399. const url = docUtil.parseURL(this.baseURI);
  400. if (this.options.insertSingleFileComment) {
  401. const infobarContent = (this.options.infobarContent || "").replace(/\\n/g, "\n").replace(/\\t/g, "\t");
  402. const commentNode = this.doc.createComment("\n Page saved with SingleFile" +
  403. " \n url: " + this.options.saveUrl +
  404. " \n saved date: " + this.options.saveDate +
  405. (infobarContent ? " \n info: " + infobarContent : "") + "\n");
  406. this.doc.documentElement.insertBefore(commentNode, this.doc.documentElement.firstChild);
  407. }
  408. let size;
  409. if (this.options.displayStats) {
  410. size = docUtil.getContentSize(this.doc.documentElement.outerHTML);
  411. }
  412. const content = docUtil.serialize(this.doc, this.options.compressHTML);
  413. if (this.options.displayStats) {
  414. const contentSize = docUtil.getContentSize(content);
  415. this.stats.set("processed", "HTML bytes", contentSize);
  416. this.stats.add("discarded", "HTML bytes", size - contentSize);
  417. }
  418. let filename = await ProcessorHelper.evalTemplate(this.options.filenameTemplate, this.options, content) || "";
  419. filename = filename.replace(/[~\\?%*:|"<>\x00-\x1f\x7F]+/g, "_"); // eslint-disable-line no-control-regex
  420. filename = filename.replace(/\.\.\//g, "").replace(/^\/+/, "").replace(/\/+/g, "/").replace(/\/$/, "");
  421. if (!this.options.backgroundSave) {
  422. filename = filename.replace(/\//g, "_");
  423. }
  424. if (docUtil.getContentSize(filename) > 192) {
  425. const extensionMatch = filename.match(/(\.[^.]{3,4})$/);
  426. const extension = extensionMatch && extensionMatch[0] && extensionMatch[0].length > 1 ? extensionMatch[0] : "";
  427. filename = await docUtil.truncateContent(filename, 192 - extension.length);
  428. filename = filename + "…" + extension;
  429. }
  430. if (!filename) {
  431. filename = "Unnamed page";
  432. }
  433. const matchTitle = this.baseURI.match(/([^/]*)\/?(\.html?.*)$/) || this.baseURI.match(/\/\/([^/]*)\/?$/);
  434. return {
  435. stats: this.stats.data,
  436. title: this.options.title || (this.baseURI && matchTitle ? matchTitle[1] : (url.hostname ? url.hostname : "")),
  437. filename,
  438. content
  439. };
  440. }
  441. preProcessPage() {
  442. if (this.options.win) {
  443. this.doc.body.querySelectorAll(":not(svg) title, meta, link[href][rel*=\"icon\"]").forEach(element => element instanceof this.options.win.HTMLElement && this.doc.head.appendChild(element));
  444. }
  445. if (this.options.imageData && !this.options.saveRawPage) {
  446. const dataAttributeName = docUtil.IMAGE_ATTRIBUTE_NAME;
  447. this.doc.querySelectorAll("img").forEach(imgElement => {
  448. const imgData = this.options.imageData[Number(imgElement.getAttribute(dataAttributeName))];
  449. if (this.options.removeHiddenElements && imgData.size && !imgData.size.pxWidth && !imgData.size.pxHeight) {
  450. imgElement.setAttribute("src", EMPTY_IMAGE);
  451. } else if (imgData.currentSrc) {
  452. imgElement.setAttribute("src", imgData.currentSrc);
  453. }
  454. });
  455. if (this.options.loadDeferredImages) {
  456. this.doc.querySelectorAll("img[data-src]").forEach(imgElement => {
  457. const imgData = this.options.imageData[Number(imgElement.getAttribute(dataAttributeName))];
  458. if ((!imgElement.getAttribute("src") || imgElement.getAttribute("src") == EMPTY_IMAGE) && imgElement.getAttribute("data-src")) {
  459. imgData.src = imgElement.dataset.src;
  460. imgElement.setAttribute("src", imgElement.dataset.src);
  461. imgElement.removeAttribute("data-src");
  462. }
  463. });
  464. this.doc.querySelectorAll("img[data-srcset]").forEach(imgElement => {
  465. if (!imgElement.getAttribute("srcset") && imgElement.getAttribute("data-srcset")) {
  466. imgElement.setAttribute("srcset", imgElement.dataset.srcset);
  467. imgElement.removeAttribute("data-srcset");
  468. }
  469. });
  470. }
  471. }
  472. }
  473. insertShadowRootContents() {
  474. if (this.options.shadowRootContents) {
  475. this.doc.querySelectorAll("[" + docUtil.SHADOW_ROOT_ATTRIBUTE_NAME + "]").forEach((element, elementIndex) => {
  476. const elementInfo = this.options.shadowRootContents[elementIndex];
  477. if (elementInfo) {
  478. const frameElement = this.doc.createElement("iframe");
  479. frameElement.setAttribute("style", "all:initial!important;border:0!important;width:100%!important;height:" + elementInfo.height + "px!important");
  480. const windowId = "shadow-" + this.options.framesData.length;
  481. frameElement.setAttribute(docUtil.WIN_ID_ATTRIBUTE_NAME, windowId);
  482. this.options.framesData.push({ windowId, content: elementInfo.content, baseURI: this.baseURI });
  483. element.appendChild(frameElement);
  484. }
  485. });
  486. }
  487. }
  488. replaceStyleContents() {
  489. if (this.options.stylesheetContents) {
  490. this.doc.querySelectorAll("style").forEach((styleElement, styleIndex) => {
  491. if (this.options.stylesheetContents[styleIndex]) {
  492. styleElement.textContent = this.options.stylesheetContents[styleIndex];
  493. }
  494. });
  495. }
  496. }
  497. removeUnselectedElements() {
  498. removeUnmarkedElements(this.doc.body);
  499. this.doc.body.removeAttribute(SELECTED_CONTENT_ATTRIBUTE_NAME);
  500. function removeUnmarkedElements(element) {
  501. let selectedElementFound = false;
  502. Array.from(element.childNodes).forEach(node => {
  503. if (node.nodeType == 1) {
  504. const isSelectedElement = node.getAttribute(SELECTED_CONTENT_ATTRIBUTE_NAME) == "";
  505. selectedElementFound = selectedElementFound || isSelectedElement;
  506. if (isSelectedElement) {
  507. node.removeAttribute(SELECTED_CONTENT_ATTRIBUTE_NAME);
  508. removeUnmarkedElements(node);
  509. } else if (selectedElementFound) {
  510. removeNode(node);
  511. } else {
  512. node.style.setProperty("display", "none", "important");
  513. Array.from(node.childNodes).forEach(removeNode);
  514. }
  515. }
  516. });
  517. }
  518. function removeNode(node) {
  519. const tagName = node.tagName && node.tagName.toLowerCase();
  520. if (tagName != "svg" && tagName != "style" && tagName != "link") {
  521. node.remove();
  522. }
  523. }
  524. }
  525. insertVideoPosters() {
  526. if (this.options.postersData) {
  527. this.doc.querySelectorAll("video[src], video > source[src]").forEach((element, videoIndex) => {
  528. let videoElement;
  529. if (element.tagName == "VIDEO") {
  530. videoElement = element;
  531. } else {
  532. videoElement = element.parentElement;
  533. }
  534. if (!videoElement.poster && this.options.postersData[videoIndex]) {
  535. videoElement.setAttribute("poster", this.options.postersData[videoIndex]);
  536. }
  537. });
  538. }
  539. }
  540. removeFrames() {
  541. const frameElements = this.doc.querySelectorAll("iframe, frame, object[type=\"text/html\"][data]");
  542. this.stats.set("discarded", "frames", frameElements.length);
  543. this.stats.set("processed", "frames", frameElements.length);
  544. this.doc.querySelectorAll("iframe, frame, object[type=\"text/html\"][data]").forEach(element => element.remove());
  545. }
  546. removeImports() {
  547. const importElements = this.doc.querySelectorAll("link[rel=import]");
  548. this.stats.set("discarded", "HTML imports", importElements.length);
  549. this.stats.set("processed", "HTML imports", importElements.length);
  550. importElements.forEach(element => element.remove());
  551. }
  552. removeScripts() {
  553. this.onEventAttributeNames.forEach(attributeName => this.doc.querySelectorAll("[" + attributeName + "]").forEach(element => element.removeAttribute(attributeName)));
  554. this.doc.querySelectorAll("[href]").forEach(element => {
  555. if (element.href && element.href.match && element.href.match(/^\s*javascript:/)) {
  556. element.setAttribute("href", "");
  557. }
  558. });
  559. this.doc.querySelectorAll("[src]").forEach(element => {
  560. if (element.src && element.src.match(/^\s*javascript:/)) {
  561. element.removeAttribute("src");
  562. }
  563. });
  564. const scriptElements = this.doc.querySelectorAll("script:not([type=\"application/ld+json\"])");
  565. this.stats.set("discarded", "scripts", scriptElements.length);
  566. this.stats.set("processed", "scripts", scriptElements.length);
  567. scriptElements.forEach(element => element.remove());
  568. }
  569. removeVideoSources() {
  570. const videoSourceElements = this.doc.querySelectorAll("video[src], video > source");
  571. this.stats.set("discarded", "video sources", videoSourceElements.length);
  572. this.stats.set("processed", "video sources", videoSourceElements.length);
  573. videoSourceElements.forEach(element => {
  574. if (element.tagName == "SOURCE") {
  575. element.remove();
  576. } else {
  577. videoSourceElements.forEach(element => element.removeAttribute("src"));
  578. }
  579. });
  580. }
  581. removeAudioSources() {
  582. const audioSourceElements = this.doc.querySelectorAll("audio[src], audio > source[src]");
  583. this.stats.set("discarded", "audio sources", audioSourceElements.length);
  584. this.stats.set("processed", "audio sources", audioSourceElements.length);
  585. audioSourceElements.forEach(element => {
  586. if (element.tagName == "SOURCE") {
  587. element.remove();
  588. } else {
  589. audioSourceElements.forEach(element => element.removeAttribute("src"));
  590. }
  591. });
  592. }
  593. removeDiscardedResources() {
  594. this.doc.querySelectorAll("singlefile-infobar, singlefile-mask, singlefile-logs-window").forEach(element => element.remove());
  595. const objectElements = this.doc.querySelectorAll("applet, meta[http-equiv=refresh], meta[disabled-http-equiv], object[data]:not([type=\"image/svg+xml\"]):not([type=\"image/svg-xml\"]):not([type=\"text/html\"]), embed[src]:not([src*=\".svg\"]):not([src*=\".pdf\"])");
  596. this.stats.set("discarded", "objects", objectElements.length);
  597. this.stats.set("processed", "objects", objectElements.length);
  598. objectElements.forEach(element => element.remove());
  599. const replacedAttributeValue = this.doc.querySelectorAll("link[rel~=preconnect], link[rel~=prerender], link[rel~=dns-prefetch], link[rel~=preload], link[rel~=prefetch]");
  600. replacedAttributeValue.forEach(element => {
  601. const relValue = element.getAttribute("rel").replace(/(preconnect|prerender|dns-prefetch|preload|prefetch)/g, "").trim();
  602. if (relValue.length) {
  603. element.setAttribute("rel", relValue);
  604. } else {
  605. element.remove();
  606. }
  607. });
  608. this.doc.querySelectorAll("link[rel*=stylesheet][rel*=alternate][title]").forEach(element => element.remove());
  609. this.doc.querySelectorAll("meta[http-equiv=\"content-security-policy\"]").forEach(element => element.remove());
  610. if (this.options.compressHTML) {
  611. this.doc.querySelectorAll("input[type=hidden]").forEach(element => element.remove());
  612. }
  613. this.doc.querySelectorAll("a[ping]").forEach(element => element.removeAttribute("ping"));
  614. }
  615. resetCharsetMeta() {
  616. let charset;
  617. this.doc.querySelectorAll("meta[charset], meta[http-equiv=\"content-type\"]").forEach(element => {
  618. const charsetDeclaration = element.content.split(";")[1];
  619. if (charsetDeclaration && !charset) {
  620. charset = charsetDeclaration.split("=")[1];
  621. if (charset) {
  622. this.charset = charset.trim().toLowerCase();
  623. }
  624. }
  625. element.remove();
  626. });
  627. const metaElement = this.doc.createElement("meta");
  628. metaElement.setAttribute("charset", "utf-8");
  629. if (this.doc.head.firstChild) {
  630. this.doc.head.insertBefore(metaElement, this.doc.head.firstChild);
  631. } else {
  632. this.doc.head.appendChild(metaElement);
  633. }
  634. }
  635. setInputValues() {
  636. this.doc.querySelectorAll("input").forEach(input => {
  637. const value = input.getAttribute(docUtil.INPUT_VALUE_ATTRIBUTE_NAME);
  638. input.setAttribute("value", value || "");
  639. });
  640. this.doc.querySelectorAll("input[type=radio], input[type=checkbox]").forEach(input => {
  641. const value = input.getAttribute(docUtil.INPUT_VALUE_ATTRIBUTE_NAME);
  642. if (value == "true") {
  643. input.setAttribute("checked", "");
  644. }
  645. });
  646. this.doc.querySelectorAll("textarea").forEach(textarea => {
  647. const value = textarea.getAttribute(docUtil.INPUT_VALUE_ATTRIBUTE_NAME);
  648. textarea.textContent = value || "";
  649. });
  650. this.doc.querySelectorAll("select").forEach(select => {
  651. select.querySelectorAll("option").forEach(option => {
  652. const selected = option.getAttribute(docUtil.INPUT_VALUE_ATTRIBUTE_NAME) != null;
  653. if (selected) {
  654. option.setAttribute("selected", "");
  655. }
  656. });
  657. });
  658. }
  659. insertFaviconLink() {
  660. let faviconElement = this.doc.querySelector("link[href][rel=\"icon\"]");
  661. if (!faviconElement) {
  662. faviconElement = this.doc.querySelector("link[href][rel=\"shortcut icon\"]");
  663. }
  664. if (!faviconElement) {
  665. faviconElement = this.doc.createElement("link");
  666. faviconElement.setAttribute("type", "image/x-icon");
  667. faviconElement.setAttribute("rel", "shortcut icon");
  668. faviconElement.setAttribute("href", "/favicon.ico");
  669. }
  670. this.doc.head.appendChild(faviconElement);
  671. }
  672. replaceCanvasElements() {
  673. if (this.options.canvasData) {
  674. this.doc.querySelectorAll("canvas").forEach((canvasElement, indexCanvasElement) => {
  675. const canvasData = this.options.canvasData[indexCanvasElement];
  676. if (canvasData) {
  677. ProcessorHelper.setBackgroundImage(canvasElement, "url(" + canvasData.dataURI + ")");
  678. this.stats.add("processed", "canvas", 1);
  679. }
  680. });
  681. }
  682. }
  683. insertFonts() {
  684. if (this.options.fontsData && this.options.fontsData.length) {
  685. let stylesheetContent = "";
  686. this.options.fontsData.forEach(fontStyles => {
  687. if (fontStyles["font-family"] && fontStyles.src) {
  688. stylesheetContent += "@font-face{";
  689. let stylesContent = "";
  690. Object.keys(fontStyles).forEach(fontStyle => {
  691. if (stylesContent) {
  692. stylesContent += ";";
  693. }
  694. stylesContent += fontStyle + ":" + fontStyles[fontStyle];
  695. });
  696. stylesheetContent += stylesContent + "}";
  697. }
  698. });
  699. if (stylesheetContent) {
  700. const styleElement = this.doc.createElement("style");
  701. styleElement.textContent = stylesheetContent;
  702. const existingStyleElement = this.doc.querySelector("style");
  703. if (existingStyleElement) {
  704. existingStyleElement.parentElement.insertBefore(styleElement, existingStyleElement);
  705. } else {
  706. this.doc.head.insertBefore(styleElement, this.doc.head.firstChild);
  707. }
  708. }
  709. }
  710. }
  711. removeHiddenElements() {
  712. const hiddenElements = this.doc.querySelectorAll("[" + docUtil.REMOVED_CONTENT_ATTRIBUTE_NAME + "]");
  713. this.stats.set("discarded", "hidden elements", hiddenElements.length);
  714. this.stats.set("processed", "hidden elements", hiddenElements.length);
  715. hiddenElements.forEach(element => element.remove());
  716. }
  717. resolveHrefs() {
  718. this.doc.querySelectorAll("a[href], area[href], link[href]").forEach(element => {
  719. const href = element.getAttribute("href").trim();
  720. if (!Util.testIgnoredPath(href) && !href.startsWith("#")) {
  721. try {
  722. element.setAttribute("href", docUtil.resolveURL(href, this.options.baseURI || this.options.url));
  723. } catch (error) {
  724. // ignored
  725. }
  726. }
  727. });
  728. }
  729. resolveStyleAttributeURLs() {
  730. this.doc.querySelectorAll("[style]").forEach(element => {
  731. let styleContent = element.getAttribute("style");
  732. if (this.options.compressCSS) {
  733. styleContent = docUtil.compressCSS(styleContent);
  734. }
  735. styleContent = ProcessorHelper.resolveStylesheetURLs(styleContent, this.baseURI);
  736. const declarationList = cssTree.parse(styleContent, { context: "declarationList" });
  737. this.styles.set(element, declarationList);
  738. });
  739. }
  740. async resolveStylesheetURLs() {
  741. await Promise.all(Array.from(this.doc.querySelectorAll("style, link[rel*=stylesheet]"))
  742. .map(async element => {
  743. let mediaText;
  744. if (element.media) {
  745. mediaText = element.media.toLowerCase();
  746. }
  747. this.stylesheets.set(element, { mediaText });
  748. const options = { maxResourceSize: this.options.maxResourceSize, maxResourceSizeEnabled: this.options.maxResourceSizeEnabled, url: this.options.url, charset: this.charset, compressCSS: this.options.compressCSS };
  749. let stylesheetContent;
  750. if (element.tagName.toLowerCase() == "link") {
  751. if (element.charset) {
  752. options.charset = element.charset;
  753. }
  754. stylesheetContent = await ProcessorHelper.resolveLinkStylesheetURLs(element.href, this.baseURI, options, this.workStyleElement);
  755. } else {
  756. stylesheetContent = await ProcessorHelper.resolveImportURLs(element.textContent, this.baseURI, options, this.workStyleElement);
  757. }
  758. let stylesheet;
  759. try {
  760. stylesheet = cssTree.parse(stylesheetContent);
  761. } catch (error) {
  762. // ignored
  763. }
  764. if (stylesheet && stylesheet.children) {
  765. if (this.options.compressCSS) {
  766. ProcessorHelper.removeSingleLineCssComments(stylesheet);
  767. }
  768. this.stylesheets.get(element).stylesheet = stylesheet;
  769. } else {
  770. this.stylesheets.delete(element);
  771. }
  772. }));
  773. }
  774. async resolveFrameURLs() {
  775. if (!this.options.saveRawPage && this.options.framesData) {
  776. const frameElements = Array.from(this.doc.querySelectorAll("iframe, frame, object[type=\"text/html\"][data]"));
  777. await Promise.all(frameElements.map(async frameElement => {
  778. if (frameElement.tagName == "OBJECT") {
  779. frameElement.setAttribute("data", "data:text/html,");
  780. } else {
  781. frameElement.removeAttribute("src");
  782. frameElement.removeAttribute("srcdoc");
  783. }
  784. const frameWindowId = frameElement.getAttribute(docUtil.WIN_ID_ATTRIBUTE_NAME);
  785. if (frameWindowId) {
  786. const frameData = this.options.framesData.find(frame => frame.windowId == frameWindowId);
  787. if (frameData) {
  788. await initializeProcessor(frameData, frameElement, frameWindowId, this.batchRequest, Object.create(this.options));
  789. }
  790. }
  791. }));
  792. }
  793. async function initializeProcessor(frameData, frameElement, frameWindowId, batchRequest, options) {
  794. options.insertSingleFileComment = false;
  795. options.insertFaviconLink = false;
  796. options.doc = null;
  797. options.win = null;
  798. options.url = frameData.baseURI;
  799. options.windowId = frameWindowId;
  800. if (frameData.content) {
  801. options.content = frameData.content;
  802. options.postersData = frameData.postersData;
  803. options.canvasData = frameData.canvasData;
  804. options.stylesheetContents = frameData.stylesheetContents;
  805. options.fontsData = frameData.fontsData;
  806. options.imageData = frameData.imageData;
  807. options.usedFonts = frameData.usedFonts;
  808. options.shadowRootContents = frameData.shadowRootContents;
  809. frameData.processor = new Runner(options);
  810. frameData.frameElement = frameElement;
  811. await frameData.processor.loadPage();
  812. await frameData.processor.initialize();
  813. frameData.maxResources = batchRequest.getMaxResources();
  814. }
  815. }
  816. }
  817. async resolveHtmlImportURLs() {
  818. const linkElements = Array.from(this.doc.querySelectorAll("link[rel=import][href]"));
  819. if (!this.relImportProcessors) {
  820. this.relImportProcessors = new Map();
  821. }
  822. await Promise.all(linkElements.map(async linkElement => {
  823. const resourceURL = linkElement.href;
  824. linkElement.removeAttribute("href");
  825. const options = Object.create(this.options);
  826. options.insertSingleFileComment = false;
  827. options.insertFaviconLink = false;
  828. options.doc = null;
  829. options.win = null;
  830. options.url = resourceURL;
  831. if (!Util.testIgnoredPath(resourceURL) && Util.testValidPath(resourceURL)) {
  832. const processor = new Runner(options);
  833. this.relImportProcessors.set(linkElement, processor);
  834. await processor.loadPage();
  835. return processor.initialize();
  836. }
  837. }));
  838. }
  839. removeUnusedStyles() {
  840. if (!this.mediaAllInfo) {
  841. this.mediaAllInfo = docUtil.getMediaAllInfo(this.doc, this.stylesheets, this.styles);
  842. }
  843. const stats = docUtil.minifyCSSRules(this.stylesheets, this.styles, this.mediaAllInfo);
  844. this.stats.set("processed", "CSS rules", stats.processed);
  845. this.stats.set("discarded", "CSS rules", stats.discarded);
  846. }
  847. removeUnusedFonts() {
  848. docUtil.removeUnusedFonts(this.doc, this.stylesheets, this.styles, this.options);
  849. }
  850. removeAlternativeMedias() {
  851. const stats = docUtil.minifyMedias(this.stylesheets);
  852. this.stats.set("processed", "medias", stats.processed);
  853. this.stats.set("discarded", "medias", stats.discarded);
  854. }
  855. async processStylesheets() {
  856. await Promise.all(Array.from(this.stylesheets).map(([, stylesheetInfo]) =>
  857. ProcessorHelper.processStylesheet(stylesheetInfo.stylesheet.children, this.baseURI, this.options, this.cssVariables, this.batchRequest)
  858. ));
  859. }
  860. async processStyleAttributes() {
  861. return Promise.all(Array.from(this.styles).map(([, declarationList]) =>
  862. ProcessorHelper.processStyle(declarationList.children.toArray(), this.baseURI, this.options, this.cssVariables, this.batchRequest)
  863. ));
  864. }
  865. async processPageResources() {
  866. const processAttributeArgs = [
  867. ["link[href][rel*=\"icon\"]", "href", false, true],
  868. ["object[type=\"image/svg+xml\"], object[type=\"image/svg-xml\"]", "data"],
  869. ["img[src], input[src][type=image]", "src", true],
  870. ["embed[src*=\".svg\"], embed[src*=\".pdf\"]", "src"],
  871. ["video[poster]", "poster"],
  872. ["*[background]", "background"],
  873. ["image", "xlink:href"]
  874. ];
  875. let resourcePromises = processAttributeArgs.map(([selector, attributeName, processDuplicates, removeElementIfMissing]) =>
  876. ProcessorHelper.processAttribute(this.doc.querySelectorAll(selector), attributeName, this.baseURI, this.options, this.cssVariables, this.styles, this.batchRequest, processDuplicates, removeElementIfMissing)
  877. );
  878. resourcePromises = resourcePromises.concat([
  879. ProcessorHelper.processXLinks(this.doc.querySelectorAll("use"), this.baseURI, this.options, this.batchRequest),
  880. ProcessorHelper.processSrcset(this.doc.querySelectorAll("img[srcset], source[srcset]"), "srcset", this.baseURI, this.batchRequest)
  881. ]);
  882. if (!this.options.removeAudioSrc) {
  883. resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("audio[src], audio > source[src]"), "src", this.baseURI, this.options, this.cssVariables, this.styles, this.batchRequest));
  884. }
  885. if (!this.options.removeVideoSrc) {
  886. resourcePromises.push(ProcessorHelper.processAttribute(this.doc.querySelectorAll("video[src], video > source[src]"), "src", this.baseURI, this.options, this.cssVariables, this.styles, this.batchRequest));
  887. }
  888. await Promise.all(resourcePromises);
  889. ProcessorHelper.processShortcutIcons(this.doc);
  890. }
  891. async processScripts() {
  892. await Promise.all(Array.from(this.doc.querySelectorAll("script[src]")).map(async scriptElement => {
  893. let resourceURL;
  894. const scriptSrc = scriptElement.getAttribute("src");
  895. scriptElement.removeAttribute("src");
  896. scriptElement.textContent = "";
  897. try {
  898. resourceURL = docUtil.resolveURL(scriptSrc, this.baseURI);
  899. } catch (error) {
  900. // ignored
  901. }
  902. if (Util.testValidURL(resourceURL)) {
  903. this.stats.add("processed", "scripts", 1);
  904. const content = await docUtil.getContent(resourceURL, { asDataURI: true, maxResourceSize: this.options.maxResourceSize, maxResourceSizeEnabled: this.options.maxResourceSizeEnabled });
  905. scriptElement.setAttribute("src", content.data);
  906. }
  907. }));
  908. }
  909. removeAlternativeImages() {
  910. docUtil.removeAlternativeImages(this.doc);
  911. }
  912. removeAlternativeFonts() {
  913. docUtil.removeAlternativeFonts(this.doc, this.stylesheets);
  914. }
  915. async processFrames() {
  916. if (this.options.framesData) {
  917. const frameElements = Array.from(this.doc.querySelectorAll("iframe, frame, object[type=\"text/html\"][data]"));
  918. await Promise.all(frameElements.map(async frameElement => {
  919. const frameWindowId = frameElement.getAttribute(docUtil.WIN_ID_ATTRIBUTE_NAME);
  920. if (frameWindowId) {
  921. const frameData = this.options.framesData.find(frame => frame.windowId == frameWindowId);
  922. if (frameData) {
  923. if (frameData.processor) {
  924. this.stats.add("processed", "frames", 1);
  925. await frameData.processor.run();
  926. const pageData = await frameData.processor.getPageData();
  927. frameElement.removeAttribute(docUtil.WIN_ID_ATTRIBUTE_NAME);
  928. if (pageData.content.match(NOSCRIPT_TAG_FOUND) || pageData.content.match(SCRIPT_TAG_FOUND)) {
  929. frameElement.setAttribute("sandbox", "allow-popups allow-scripts allow-same-origin");
  930. } else {
  931. frameElement.setAttribute("sandbox", "allow-popups");
  932. }
  933. if (frameElement.tagName == "OBJECT") {
  934. frameElement.setAttribute("data", "data:text/html," + pageData.content);
  935. } else {
  936. if (frameElement.tagName == "FRAME") {
  937. frameElement.setAttribute("src", "data:text/html," + pageData.content.replace(/#/g, "%23"));
  938. } else {
  939. frameElement.setAttribute("srcdoc", pageData.content);
  940. frameElement.removeAttribute("src");
  941. }
  942. }
  943. this.stats.addAll(pageData);
  944. } else {
  945. this.stats.add("discarded", "frames", 1);
  946. }
  947. }
  948. }
  949. }));
  950. }
  951. }
  952. async processHtmlImports() {
  953. const linkElements = Array.from(this.doc.querySelectorAll("link[rel=import][href]"));
  954. await Promise.all(linkElements.map(async linkElement => {
  955. const processor = this.relImportProcessors.get(linkElement);
  956. if (processor) {
  957. this.stats.add("processed", "HTML imports", 1);
  958. this.relImportProcessors.delete(linkElement);
  959. const pageData = await processor.getPageData();
  960. linkElement.setAttribute("href", "data:text/html," + pageData.content);
  961. this.stats.addAll(pageData);
  962. } else {
  963. this.stats.add("discarded", "HTML imports", 1);
  964. }
  965. }));
  966. }
  967. replaceStylesheets() {
  968. this.doc.querySelectorAll("style").forEach(styleElement => {
  969. const stylesheetInfo = this.stylesheets.get(styleElement);
  970. if (stylesheetInfo) {
  971. let stylesheetContent = cssTree.generate(stylesheetInfo.stylesheet);
  972. styleElement.textContent = stylesheetContent;
  973. if (stylesheetInfo.mediaText) {
  974. styleElement.media = stylesheetInfo.mediaText;
  975. }
  976. } else {
  977. styleElement.remove();
  978. }
  979. });
  980. this.doc.querySelectorAll("link[rel*=stylesheet]").forEach(linkElement => {
  981. const stylesheetInfo = this.stylesheets.get(linkElement);
  982. if (stylesheetInfo) {
  983. const styleElement = this.doc.createElement("style");
  984. if (stylesheetInfo.mediaText) {
  985. styleElement.media = stylesheetInfo.mediaText;
  986. }
  987. let stylesheetContent = cssTree.generate(stylesheetInfo.stylesheet);
  988. styleElement.textContent = stylesheetContent;
  989. linkElement.parentElement.replaceChild(styleElement, linkElement);
  990. } else {
  991. linkElement.remove();
  992. }
  993. });
  994. }
  995. replaceStyleAttributes() {
  996. this.doc.querySelectorAll("[style]").forEach(async element => {
  997. const declarations = this.styles.get(element);
  998. if (declarations) {
  999. let styleContent = cssTree.generate(declarations);
  1000. element.setAttribute("style", styleContent);
  1001. } else {
  1002. element.setAttribute("style", "");
  1003. }
  1004. });
  1005. }
  1006. insertVariables() {
  1007. if (this.cssVariables.size) {
  1008. const styleElement = this.doc.createElement("style");
  1009. const firstStyleElement = this.doc.head.querySelector("style");
  1010. if (firstStyleElement) {
  1011. this.doc.head.insertBefore(styleElement, firstStyleElement);
  1012. } else {
  1013. this.doc.head.appendChild(styleElement);
  1014. }
  1015. let stylesheetContent = "";
  1016. this.cssVariables.forEach((content, indexResource) => {
  1017. if (stylesheetContent) {
  1018. stylesheetContent += ";";
  1019. }
  1020. stylesheetContent += `${SINGLE_FILE_VARIABLE_NAME_PREFIX + indexResource}:url("${content}")`;
  1021. });
  1022. styleElement.textContent = ":root{" + stylesheetContent + "}";
  1023. }
  1024. }
  1025. compressHTML() {
  1026. let size;
  1027. if (this.options.displayStats) {
  1028. size = docUtil.getContentSize(this.doc.documentElement.outerHTML);
  1029. }
  1030. docUtil.minifyHTML(this.doc, { PRESERVED_SPACE_ELEMENT_ATTRIBUTE_NAME: docUtil.PRESERVED_SPACE_ELEMENT_ATTRIBUTE_NAME });
  1031. if (this.options.displayStats) {
  1032. this.stats.add("discarded", "HTML bytes", size - docUtil.getContentSize(this.doc.documentElement.outerHTML));
  1033. }
  1034. }
  1035. }
  1036. // ---------------
  1037. // ProcessorHelper
  1038. // ---------------
  1039. const DATA_URI_PREFIX = "data:";
  1040. const ABOUT_BLANK_URI = "about:blank";
  1041. const EMPTY_DATA_URI = "data:base64,";
  1042. const REGEXP_AMP = /&/g;
  1043. const REGEXP_NBSP = /\u00a0/g;
  1044. const REGEXP_START_TAG = /</g;
  1045. const REGEXP_END_TAG = />/g;
  1046. const REGEXP_URL_HASH = /(#.+?)$/;
  1047. const PREFIX_DATA_URI_VND = "data:application/vnd.";
  1048. const SINGLE_FILE_VARIABLE_NAME_PREFIX = "--sf-img-";
  1049. class ProcessorHelper {
  1050. static async evalTemplate(template = "", options, content, dontReplaceSlash) {
  1051. const date = options.saveDate;
  1052. const url = docUtil.parseURL(options.saveUrl);
  1053. template = await Util.evalTemplateVariable(template, "page-title", () => options.title || "No title", dontReplaceSlash);
  1054. template = await Util.evalTemplateVariable(template, "page-language", () => options.info.lang || "No language", dontReplaceSlash);
  1055. template = await Util.evalTemplateVariable(template, "page-description", () => options.info.description || "No description", dontReplaceSlash);
  1056. template = await Util.evalTemplateVariable(template, "page-author", () => options.info.author || "No author", dontReplaceSlash);
  1057. template = await Util.evalTemplateVariable(template, "page-creator", () => options.info.creator || "No creator", dontReplaceSlash);
  1058. template = await Util.evalTemplateVariable(template, "page-publisher", () => options.info.publisher || "No publisher", dontReplaceSlash);
  1059. template = await Util.evalTemplateVariable(template, "datetime-iso", () => date.toISOString(), dontReplaceSlash);
  1060. template = await Util.evalTemplateVariable(template, "date-iso", () => date.toISOString().split("T")[0], dontReplaceSlash);
  1061. template = await Util.evalTemplateVariable(template, "time-iso", () => date.toISOString().split("T")[1].split("Z")[0], dontReplaceSlash);
  1062. template = await Util.evalTemplateVariable(template, "date-locale", () => date.toLocaleDateString(), dontReplaceSlash);
  1063. template = await Util.evalTemplateVariable(template, "time-locale", () => date.toLocaleTimeString(), dontReplaceSlash);
  1064. template = await Util.evalTemplateVariable(template, "day-locale", () => String(date.getDate()).padStart(2, "0"), dontReplaceSlash);
  1065. template = await Util.evalTemplateVariable(template, "month-locale", () => String(date.getMonth() + 1).padStart(2, "0"), dontReplaceSlash);
  1066. template = await Util.evalTemplateVariable(template, "year-locale", () => String(date.getFullYear()), dontReplaceSlash);
  1067. template = await Util.evalTemplateVariable(template, "datetime-locale", () => date.toLocaleString(), dontReplaceSlash);
  1068. template = await Util.evalTemplateVariable(template, "datetime-utc", () => date.toUTCString(), dontReplaceSlash);
  1069. template = await Util.evalTemplateVariable(template, "day-utc", () => String(date.getUTCDate()).padStart(2, "0"), dontReplaceSlash);
  1070. template = await Util.evalTemplateVariable(template, "month-utc", () => String(date.getUTCMonth() + 1).padStart(2, "0"), dontReplaceSlash);
  1071. template = await Util.evalTemplateVariable(template, "year-utc", () => String(date.getUTCFullYear()), dontReplaceSlash);
  1072. template = await Util.evalTemplateVariable(template, "hours-locale", () => String(date.getHours()).padStart(2, "0"), dontReplaceSlash);
  1073. template = await Util.evalTemplateVariable(template, "minutes-locale", () => String(date.getMinutes()).padStart(2, "0"), dontReplaceSlash);
  1074. template = await Util.evalTemplateVariable(template, "seconds-locale", () => String(date.getSeconds()).padStart(2, "0"), dontReplaceSlash);
  1075. template = await Util.evalTemplateVariable(template, "hours-utc", () => String(date.getUTCHours()).padStart(2, "0"), dontReplaceSlash);
  1076. template = await Util.evalTemplateVariable(template, "minutes-utc", () => String(date.getUTCMinutes()).padStart(2, "0"), dontReplaceSlash);
  1077. template = await Util.evalTemplateVariable(template, "seconds-utc", () => String(date.getUTCSeconds()).padStart(2, "0"), dontReplaceSlash);
  1078. template = await Util.evalTemplateVariable(template, "url-hash", () => url.hash.substring(1) || "No hash", dontReplaceSlash);
  1079. template = await Util.evalTemplateVariable(template, "url-host", () => url.host.replace(/\/$/, "") || "No host", dontReplaceSlash);
  1080. template = await Util.evalTemplateVariable(template, "url-hostname", () => url.hostname.replace(/\/$/, "") || "No hostname", dontReplaceSlash);
  1081. template = await Util.evalTemplateVariable(template, "url-href", () => decodeURI(url.href) || "No href", dontReplaceSlash);
  1082. template = await Util.evalTemplateVariable(template, "url-referrer", () => decodeURI(options.referrer) || "No referrer", dontReplaceSlash);
  1083. template = await Util.evalTemplateVariable(template, "url-password", () => url.password || "No password", dontReplaceSlash);
  1084. template = await Util.evalTemplateVariable(template, "url-pathname", () => decodeURI(url.pathname).replace(/^\//, "").replace(/\/$/, "") || "No pathname", dontReplaceSlash === undefined ? true : dontReplaceSlash);
  1085. template = await Util.evalTemplateVariable(template, "url-port", () => url.port || "No port", dontReplaceSlash);
  1086. template = await Util.evalTemplateVariable(template, "url-protocol", () => url.protocol || "No protocol", dontReplaceSlash);
  1087. template = await Util.evalTemplateVariable(template, "url-search", () => url.search.substring(1) || "No search", dontReplaceSlash);
  1088. const params = url.search.substring(1).split("&").map(parameter => parameter.split("="));
  1089. for (const [name, value] of params) {
  1090. template = await Util.evalTemplateVariable(template, "url-search-" + name, () => value || "", dontReplaceSlash);
  1091. }
  1092. template = template.replace(/{\s*url-search-[^}\s]*\s*}/gi, "");
  1093. template = await Util.evalTemplateVariable(template, "url-username", () => url.username || "No username", dontReplaceSlash);
  1094. template = await Util.evalTemplateVariable(template, "tab-id", () => String(options.tabId || "No tab id"), dontReplaceSlash);
  1095. template = await Util.evalTemplateVariable(template, "url-last-segment", () => decodeURI(Util.getLastSegment(url)) || "No last segment", dontReplaceSlash);
  1096. if (content) {
  1097. template = await Util.evalTemplateVariable(template, "digest-sha-256", async () => docUtil.digest("SHA-256", content), dontReplaceSlash);
  1098. template = await Util.evalTemplateVariable(template, "digest-sha-384", async () => docUtil.digest("SHA-384", content), dontReplaceSlash);
  1099. template = await Util.evalTemplateVariable(template, "digest-sha-512", async () => docUtil.digest("SHA-512", content), dontReplaceSlash);
  1100. }
  1101. return template.trim();
  1102. }
  1103. static setBackgroundImage(element, url, style) {
  1104. element.style.setProperty("background-blend-mode", "normal", "important");
  1105. element.style.setProperty("background-clip", "border-box", "important");
  1106. element.style.setProperty("background-position", style && style["background-position"] ? style["background-position"] : "center", "important");
  1107. element.style.setProperty("background-color", style && style["background-color"] ? style["background-color"] : "transparent", "important");
  1108. element.style.setProperty("background-image", url, "important");
  1109. element.style.setProperty("background-size", style && style["background-size"] ? style["background-size"] : "100% 100%", "important");
  1110. element.style.setProperty("background-origin", "content-box", "important");
  1111. element.style.setProperty("background-repeat", "no-repeat", "important");
  1112. }
  1113. static processShortcutIcons(doc) {
  1114. let shortcutIcon = Util.findShortcutIcon(Array.from(doc.querySelectorAll("link[href][rel=\"icon\"], link[href][rel=\"shortcut icon\"]")));
  1115. if (!shortcutIcon) {
  1116. shortcutIcon = Util.findShortcutIcon(Array.from(doc.querySelectorAll("link[href][rel*=\"icon\"]")));
  1117. if (shortcutIcon) {
  1118. shortcutIcon.rel = "icon";
  1119. }
  1120. }
  1121. if (shortcutIcon) {
  1122. doc.querySelectorAll("link[href][rel*=\"icon\"]").forEach(linkElement => {
  1123. if (linkElement != shortcutIcon) {
  1124. linkElement.remove();
  1125. }
  1126. });
  1127. }
  1128. }
  1129. static removeSingleLineCssComments(stylesheet) {
  1130. const removedRules = [];
  1131. for (let cssRule = stylesheet.children.head; cssRule; cssRule = cssRule.next) {
  1132. const ruleData = cssRule.data;
  1133. if (ruleData.type == "Raw" && ruleData.value && ruleData.value.trim().startsWith("//")) {
  1134. removedRules.push(cssRule);
  1135. }
  1136. }
  1137. removedRules.forEach(cssRule => stylesheet.children.remove(cssRule));
  1138. }
  1139. static async resolveImportURLs(stylesheetContent, baseURI, options, workStylesheet) {
  1140. stylesheetContent = ProcessorHelper.resolveStylesheetURLs(stylesheetContent, baseURI);
  1141. const imports = Util.getImportFunctions(stylesheetContent);
  1142. await Promise.all(imports.map(async cssImport => {
  1143. const match = Util.matchImport(cssImport);
  1144. if (match) {
  1145. let resourceURL = Util.normalizeURL(match.resourceURL);
  1146. if (!Util.testIgnoredPath(resourceURL) && Util.testValidPath(resourceURL)) {
  1147. try {
  1148. resourceURL = docUtil.resolveURL(match.resourceURL, baseURI);
  1149. } catch (error) {
  1150. // ignored
  1151. }
  1152. if (Util.testValidURL(resourceURL)) {
  1153. const downloadOptions = { asDataURI: false, maxResourceSize: options.maxResourceSize, maxResourceSizeEnabled: options.maxResourceSizeEnabled, validateTextContentType: true };
  1154. const content = await docUtil.getContent(resourceURL, downloadOptions);
  1155. resourceURL = content.resourceURL;
  1156. let importedStylesheetContent = Util.removeCssComments(content.data);
  1157. if (options.compressCSS) {
  1158. importedStylesheetContent = docUtil.compressCSS(importedStylesheetContent);
  1159. }
  1160. importedStylesheetContent = Util.wrapMediaQuery(importedStylesheetContent, match.media);
  1161. if (stylesheetContent.includes(cssImport)) {
  1162. importedStylesheetContent = await ProcessorHelper.resolveImportURLs(importedStylesheetContent, resourceURL, options, workStylesheet);
  1163. workStylesheet.textContent = importedStylesheetContent;
  1164. if (workStylesheet.sheet.cssRules.length) {
  1165. stylesheetContent = stylesheetContent.replace(Util.getRegExp(cssImport), importedStylesheetContent);
  1166. } else {
  1167. stylesheetContent = stylesheetContent.replace(Util.getRegExp(cssImport), "");
  1168. }
  1169. }
  1170. }
  1171. }
  1172. }
  1173. }));
  1174. return stylesheetContent;
  1175. }
  1176. static resolveStylesheetURLs(stylesheetContent, baseURI) {
  1177. const urlFunctions = Util.getUrlFunctions(stylesheetContent);
  1178. urlFunctions.map(urlFunction => {
  1179. const originalResourceURL = Util.matchURL(urlFunction);
  1180. const resourceURL = Util.normalizeURL(originalResourceURL);
  1181. if (!Util.testIgnoredPath(resourceURL)) {
  1182. if (!resourceURL || Util.testValidPath(resourceURL)) {
  1183. let resolvedURL;
  1184. try {
  1185. resolvedURL = docUtil.resolveURL(resourceURL, baseURI);
  1186. } catch (error) {
  1187. // ignored
  1188. }
  1189. if (Util.testValidURL(resolvedURL) && resourceURL != resolvedURL && stylesheetContent.includes(urlFunction)) {
  1190. stylesheetContent = stylesheetContent.replace(Util.getRegExp(urlFunction), urlFunction.replace(originalResourceURL, resolvedURL));
  1191. }
  1192. } else {
  1193. let newUrlFunction;
  1194. if (originalResourceURL) {
  1195. newUrlFunction = urlFunction.replace(originalResourceURL, EMPTY_DATA_URI);
  1196. } else {
  1197. newUrlFunction = "url(" + EMPTY_DATA_URI + ")";
  1198. }
  1199. stylesheetContent = stylesheetContent.replace(Util.getRegExp(urlFunction), newUrlFunction);
  1200. }
  1201. } else {
  1202. if (resourceURL.startsWith(DATA_URI_PREFIX)) {
  1203. const escapedResourceURL = resourceURL.replace(REGEXP_AMP, "&amp;").replace(REGEXP_NBSP, "&nbsp;").replace(REGEXP_START_TAG, "&lt;").replace(REGEXP_END_TAG, "&gt;");
  1204. if (escapedResourceURL != resourceURL && stylesheetContent.includes(urlFunction)) {
  1205. stylesheetContent = stylesheetContent.replace(Util.getRegExp(urlFunction), urlFunction.replace(originalResourceURL, escapedResourceURL));
  1206. }
  1207. }
  1208. }
  1209. });
  1210. return stylesheetContent;
  1211. }
  1212. static async resolveLinkStylesheetURLs(resourceURL, baseURI, options, workStylesheet) {
  1213. resourceURL = Util.normalizeURL(resourceURL);
  1214. if (resourceURL && resourceURL != baseURI && resourceURL != ABOUT_BLANK_URI) {
  1215. const downloadOptions = { asDataURI: false, maxResourceSize: options.maxResourceSize, maxResourceSizeEnabled: options.maxResourceSizeEnabled, charset: options.charset };
  1216. const content = await docUtil.getContent(resourceURL, downloadOptions);
  1217. resourceURL = content.resourceURL;
  1218. let stylesheetContent = Util.removeCssComments(content.data);
  1219. if (options.compressCSS) {
  1220. stylesheetContent = docUtil.compressCSS(stylesheetContent);
  1221. }
  1222. stylesheetContent = await ProcessorHelper.resolveImportURLs(stylesheetContent, resourceURL, options, workStylesheet);
  1223. return stylesheetContent;
  1224. }
  1225. }
  1226. static async processStylesheet(cssRules, baseURI, options, cssVariables, batchRequest) {
  1227. const promises = [];
  1228. const removedRules = [];
  1229. for (let cssRule = cssRules.head; cssRule; cssRule = cssRule.next) {
  1230. const ruleData = cssRule.data;
  1231. if (ruleData.type == "Atrule" && ruleData.name == "charset") {
  1232. removedRules.push(cssRule);
  1233. } else if (ruleData.block && ruleData.block.children) {
  1234. if (ruleData.type == "Rule") {
  1235. promises.push(this.processStyle(ruleData.block.children.toArray(), baseURI, options, cssVariables, batchRequest));
  1236. } else if (ruleData.type == "Atrule" && (ruleData.name == "media" || ruleData.name == "supports")) {
  1237. promises.push(this.processStylesheet(ruleData.block.children, baseURI, options, cssVariables, batchRequest));
  1238. } else if (ruleData.type == "Atrule" && ruleData.name == "font-face") {
  1239. promises.push(processFontFaceRule(ruleData));
  1240. }
  1241. }
  1242. }
  1243. removedRules.forEach(cssRule => cssRules.remove(cssRule));
  1244. await Promise.all(promises);
  1245. async function processFontFaceRule(ruleData) {
  1246. await Promise.all(ruleData.block.children.toArray().map(async declaration => {
  1247. if (declaration.type == "Declaration" && declaration.value.children) {
  1248. const urlFunctions = Util.getUrlFunctions(Util.getCSSValue(declaration.value));
  1249. await Promise.all(urlFunctions.map(async urlFunction => {
  1250. const originalResourceURL = Util.matchURL(urlFunction);
  1251. const resourceURL = Util.normalizeURL(originalResourceURL);
  1252. if (!Util.testIgnoredPath(resourceURL)) {
  1253. if (Util.testValidURL(resourceURL)) {
  1254. let { content } = await batchRequest.addURL(resourceURL, true);
  1255. if (content != EMPTY_DATA_URI && !content.startsWith(PREFIX_DATA_URI_VND) && !content.startsWith(PREFIX_DATA_URI_IMAGE_SVG)) {
  1256. const validResource = await docUtil.validFont(urlFunction);
  1257. if (!validResource) {
  1258. content = EMPTY_DATA_URI;
  1259. }
  1260. }
  1261. replaceURLs(declaration, originalResourceURL, content);
  1262. }
  1263. } else if (resourceURL.startsWith(DATA_URI_PREFIX) && !resourceURL.startsWith(PREFIX_DATA_URI_VND) && !resourceURL.startsWith(PREFIX_DATA_URI_IMAGE_SVG)) {
  1264. const validResource = await docUtil.validFont(urlFunction);
  1265. if (!validResource) {
  1266. replaceURLs(declaration, originalResourceURL, EMPTY_DATA_URI);
  1267. }
  1268. }
  1269. }));
  1270. }
  1271. }));
  1272. function replaceURLs(declaration, oldURL, newURL) {
  1273. declaration.value.children.forEach(token => {
  1274. if (token.type == "Url" && docUtil.removeQuotes(Util.getCSSValue(token.value)) == oldURL) {
  1275. token.value.value = newURL;
  1276. }
  1277. });
  1278. }
  1279. }
  1280. }
  1281. static async processStyle(declarations, baseURI, options, cssVariables, batchRequest) {
  1282. await Promise.all(declarations.map(async declaration => {
  1283. if (declaration.type == "Declaration" && declaration.value.children) {
  1284. const urlFunctions = Util.getUrlFunctions(Util.getCSSValue(declaration.value));
  1285. await Promise.all(urlFunctions.map(async urlFunction => {
  1286. const originalResourceURL = Util.matchURL(urlFunction);
  1287. const resourceURL = Util.normalizeURL(originalResourceURL);
  1288. if (!Util.testIgnoredPath(resourceURL)) {
  1289. if (Util.testValidURL(resourceURL)) {
  1290. let { content, indexResource, duplicate } = await batchRequest.addURL(resourceURL, true, true);
  1291. let variableDefined;
  1292. const tokens = [];
  1293. findURLToken(originalResourceURL, declaration.value.children, (token, parent, rootFunction) => {
  1294. if (duplicate && options.groupDuplicateImages && rootFunction) {
  1295. const value = cssTree.parse("var(" + SINGLE_FILE_VARIABLE_NAME_PREFIX + indexResource + ")", { context: "value" }).children.head;
  1296. tokens.push({ parent, token, value });
  1297. variableDefined = true;
  1298. } else {
  1299. token.data.value.value = content;
  1300. }
  1301. });
  1302. if (variableDefined) {
  1303. cssVariables.set(indexResource, content);
  1304. tokens.forEach(({ parent, token, value }) => parent.replace(token, value));
  1305. }
  1306. }
  1307. }
  1308. }));
  1309. }
  1310. }));
  1311. function findURLToken(url, children, callback, depth = 0) {
  1312. for (let token = children.head; token; token = token.next) {
  1313. if (token.data.children) {
  1314. findURLToken(url, token.data.children, callback, depth + 1);
  1315. }
  1316. if (token.data.type == "Url" && docUtil.removeQuotes(Util.getCSSValue(token.data.value)) == url) {
  1317. callback(token, children, depth == 0);
  1318. }
  1319. }
  1320. }
  1321. }
  1322. static async processAttribute(resourceElements, attributeName, baseURI, options, cssVariables, styles, batchRequest, processDuplicates, removeElementIfMissing) {
  1323. await Promise.all(Array.from(resourceElements).map(async resourceElement => {
  1324. let resourceURL = resourceElement.getAttribute(attributeName);
  1325. resourceURL = Util.normalizeURL(resourceURL);
  1326. if (!Util.testIgnoredPath(resourceURL)) {
  1327. resourceElement.setAttribute(attributeName, EMPTY_IMAGE);
  1328. if (Util.testValidPath(resourceURL)) {
  1329. try {
  1330. resourceURL = docUtil.resolveURL(resourceURL, baseURI);
  1331. } catch (error) {
  1332. // ignored
  1333. }
  1334. if (Util.testValidURL(resourceURL)) {
  1335. const { content, indexResource, duplicate } = await batchRequest.addURL(resourceURL, true, resourceElement.tagName == "IMG" && attributeName == "src");
  1336. if (removeElementIfMissing && content == EMPTY_DATA_URI) {
  1337. resourceElement.remove();
  1338. } else {
  1339. const forbiddenPrefixFound = PREFIXES_FORBIDDEN_DATA_URI.filter(prefixDataURI => content.startsWith(prefixDataURI)).length;
  1340. if (!forbiddenPrefixFound) {
  1341. const isSVG = content.startsWith(PREFIX_DATA_URI_IMAGE_SVG);
  1342. if (processDuplicates && duplicate && options.groupDuplicateImages && !isSVG) {
  1343. if (ProcessorHelper.replaceImageSource(resourceElement, SINGLE_FILE_VARIABLE_NAME_PREFIX + indexResource, options)) {
  1344. cssVariables.set(indexResource, content);
  1345. const declarationList = cssTree.parse(resourceElement.getAttribute("style"), { context: "declarationList" });
  1346. styles.set(resourceElement, declarationList);
  1347. } else {
  1348. resourceElement.setAttribute(attributeName, content);
  1349. }
  1350. } else {
  1351. resourceElement.setAttribute(attributeName, content);
  1352. }
  1353. }
  1354. }
  1355. }
  1356. }
  1357. }
  1358. }));
  1359. }
  1360. static async processXLinks(resourceElements, baseURI, options, batchRequest) {
  1361. const attributeName = "xlink:href";
  1362. await Promise.all(Array.from(resourceElements).map(async resourceElement => {
  1363. const originalResourceURL = resourceElement.getAttribute(attributeName);
  1364. let resourceURL = Util.normalizeURL(originalResourceURL);
  1365. if (Util.testValidPath(resourceURL) && !Util.testIgnoredPath(resourceURL)) {
  1366. resourceElement.setAttribute(attributeName, EMPTY_IMAGE);
  1367. try {
  1368. resourceURL = docUtil.resolveURL(resourceURL, baseURI);
  1369. } catch (error) {
  1370. // ignored
  1371. }
  1372. if (Util.testValidURL(resourceURL)) {
  1373. try {
  1374. const { content } = await batchRequest.addURL(resourceURL);
  1375. const hashMatch = originalResourceURL.match(REGEXP_URL_HASH);
  1376. if (hashMatch && hashMatch[0]) {
  1377. const svgDoc = docUtil.parseSVGContent(content);
  1378. const symbolElement = svgDoc.querySelector(hashMatch[0]);
  1379. if (symbolElement) {
  1380. resourceElement.setAttribute(attributeName, hashMatch[0]);
  1381. resourceElement.parentElement.insertBefore(symbolElement, resourceElement.parentElement.firstChild);
  1382. }
  1383. } else {
  1384. resourceElement.setAttribute(attributeName, PREFIX_DATA_URI_IMAGE_SVG + "," + content);
  1385. }
  1386. } catch (error) {
  1387. /* ignored */
  1388. }
  1389. }
  1390. } else if (resourceURL == options.url) {
  1391. resourceElement.setAttribute(attributeName, originalResourceURL.substring(resourceURL.length));
  1392. }
  1393. }));
  1394. }
  1395. static async processSrcset(resourceElements, attributeName, baseURI, batchRequest) {
  1396. await Promise.all(Array.from(resourceElements).map(async resourceElement => {
  1397. const srcset = docUtil.parseSrcset(resourceElement.getAttribute(attributeName));
  1398. const srcsetValues = await Promise.all(srcset.map(async srcsetValue => {
  1399. let resourceURL = Util.normalizeURL(srcsetValue.url);
  1400. if (!Util.testIgnoredPath(resourceURL)) {
  1401. if (Util.testValidPath(resourceURL)) {
  1402. try {
  1403. resourceURL = docUtil.resolveURL(resourceURL, baseURI);
  1404. } catch (error) {
  1405. // ignored
  1406. }
  1407. if (Util.testValidURL(resourceURL)) {
  1408. const { content } = await batchRequest.addURL(resourceURL, true);
  1409. const forbiddenPrefixFound = PREFIXES_FORBIDDEN_DATA_URI.filter(prefixDataURI => content.startsWith(prefixDataURI)).length;
  1410. if (forbiddenPrefixFound) {
  1411. return "";
  1412. }
  1413. return content + (srcsetValue.w ? " " + srcsetValue.w + "w" : srcsetValue.d ? " " + srcsetValue.d + "x" : "");
  1414. } else {
  1415. return "";
  1416. }
  1417. } else {
  1418. return "";
  1419. }
  1420. } else {
  1421. return resourceURL + (srcsetValue.w ? " " + srcsetValue.w + "w" : srcsetValue.d ? " " + srcsetValue.d + "x" : "");
  1422. }
  1423. }));
  1424. resourceElement.setAttribute(attributeName, srcsetValues.join(", "));
  1425. }));
  1426. }
  1427. static replaceImageSource(imgElement, variableName, options) {
  1428. const dataAttributeName = docUtil.IMAGE_ATTRIBUTE_NAME;
  1429. if (imgElement.getAttribute(dataAttributeName) != null) {
  1430. const imgData = options.imageData[Number(imgElement.getAttribute(dataAttributeName))];
  1431. if (imgData.replaceable) {
  1432. imgElement.setAttribute("src", `${PREFIX_DATA_URI_IMAGE_SVG},<svg xmlns="http://www.w3.org/2000/svg" width="${imgData.size.pxWidth}" height="${imgData.size.pxHeight}"><rect fill-opacity="0"/></svg>`);
  1433. const backgroundStyle = {};
  1434. const backgroundSize = (imgData.objectFit == "content" || imgData.objectFit == "cover") && imgData.objectFit;
  1435. if (backgroundSize) {
  1436. backgroundStyle["background-size"] = imgData.objectFit;
  1437. }
  1438. if (imgData.objectPosition) {
  1439. backgroundStyle["background-position"] = imgData.objectPosition;
  1440. }
  1441. if (imgData.backgroundColor) {
  1442. backgroundStyle["background-color"] = imgData.backgroundColor;
  1443. }
  1444. ProcessorHelper.setBackgroundImage(imgElement, "var(" + variableName + ")", backgroundStyle);
  1445. imgElement.removeAttribute(dataAttributeName);
  1446. return true;
  1447. }
  1448. }
  1449. }
  1450. }
  1451. // ----
  1452. // Util
  1453. // ----
  1454. const BLOB_URI_PREFIX = "blob:";
  1455. const HTTP_URI_PREFIX = /^https?:\/\//;
  1456. const FILE_URI_PREFIX = /^file:\/\//;
  1457. const EMPTY_URL = /^https?:\/\/+\s*$/;
  1458. const NOT_EMPTY_URL = /^(https?:\/\/|file:\/\/|blob:).+/;
  1459. const REGEXP_URL_FN = /(url\s*\(\s*'(.*?)'\s*\))|(url\s*\(\s*"(.*?)"\s*\))|(url\s*\(\s*(.*?)\s*\))/gi;
  1460. const REGEXP_URL_SIMPLE_QUOTES_FN = /^url\s*\(\s*'(.*?)'\s*\)$/i;
  1461. const REGEXP_URL_DOUBLE_QUOTES_FN = /^url\s*\(\s*"(.*?)"\s*\)$/i;
  1462. const REGEXP_URL_NO_QUOTES_FN = /^url\s*\(\s*(.*?)\s*\)$/i;
  1463. const REGEXP_IMPORT_FN = /(@import\s*url\s*\(\s*'(.*?)'\s*\)\s*(.*?)(;|$|}))|(@import\s*url\s*\(\s*"(.*?)"\s*\)\s*(.*?)(;|$|}))|(@import\s*url\s*\(\s*(.*?)\s*\)\s*(.*?)(;|$|}))|(@import\s*'(.*?)'\s*(.*?)(;|$|}))|(@import\s*"(.*?)"\s*(.*?)(;|$|}))|(@import\s*(.*?)\s*(.*?)(;|$|}))/gi;
  1464. const REGEXP_IMPORT_URL_SIMPLE_QUOTES_FN = /@import\s*url\s*\(\s*'(.*?)'\s*\)\s*(.*?)(;|$|})/i;
  1465. const REGEXP_IMPORT_URL_DOUBLE_QUOTES_FN = /@import\s*url\s*\(\s*"(.*?)"\s*\)\s*(.*?)(;|$|})/i;
  1466. const REGEXP_IMPORT_URL_NO_QUOTES_FN = /@import\s*url\s*\(\s*(.*?)\s*\)\s*(.*?)(;|$|})/i;
  1467. const REGEXP_IMPORT_SIMPLE_QUOTES_FN = /@import\s*'(.*?)'\s*(.*?)(;|$|})/i;
  1468. const REGEXP_IMPORT_DOUBLE_QUOTES_FN = /@import\s*"(.*?)"\s*(.*?)(;|$|})/i;
  1469. const REGEXP_IMPORT_NO_QUOTES_FN = /@import\s*(.*?)\s*(.*?)(;|$|})/i;
  1470. const REGEXP_ESCAPE = /([{}()^$&.*?/+|[\\\\]|\]|-)/g;
  1471. class Util {
  1472. static normalizeURL(url) {
  1473. if (!url || url.startsWith(DATA_URI_PREFIX)) {
  1474. return url;
  1475. } else {
  1476. return url.split("#")[0];
  1477. }
  1478. }
  1479. static getCSSValue(value) {
  1480. let result = "";
  1481. try {
  1482. result = cssTree.generate(value);
  1483. } catch (error) {
  1484. // ignored
  1485. }
  1486. return result;
  1487. }
  1488. static getOnEventAttributeNames(doc) {
  1489. const element = doc.createElement("div");
  1490. const attributeNames = [];
  1491. for (const propertyName in element) {
  1492. if (propertyName.startsWith("on")) {
  1493. attributeNames.push(propertyName);
  1494. }
  1495. }
  1496. return attributeNames;
  1497. }
  1498. static async evalTemplateVariable(template, variableName, valueGetter, dontReplaceSlash) {
  1499. const replaceRegExp = new RegExp("{\\s*" + variableName + "\\s*}", "g");
  1500. if (template && template.match(replaceRegExp)) {
  1501. let value = await valueGetter();
  1502. if (!dontReplaceSlash) {
  1503. value = value.replace(/\/+/g, "_");
  1504. }
  1505. return template.replace(replaceRegExp, value);
  1506. }
  1507. return template;
  1508. }
  1509. static getLastSegment(url) {
  1510. let lastSegmentMatch = url.pathname.match(/\/([^/]+)$/), lastSegment = lastSegmentMatch && lastSegmentMatch[0];
  1511. if (!lastSegment) {
  1512. lastSegmentMatch = url.href.match(/([^/]+)\/?$/);
  1513. lastSegment = lastSegmentMatch && lastSegmentMatch[0];
  1514. }
  1515. if (!lastSegment) {
  1516. lastSegmentMatch = lastSegment.match(/(.*)\.[^.]+$/);
  1517. lastSegment = lastSegmentMatch && lastSegmentMatch[0];
  1518. }
  1519. if (!lastSegment) {
  1520. lastSegment = url.hostname.replace(/\/+/g, "_").replace(/\/$/, "");
  1521. }
  1522. lastSegmentMatch = lastSegment.match(/(.*)\.[^.]+$/);
  1523. if (lastSegmentMatch && lastSegmentMatch[1]) {
  1524. lastSegment = lastSegmentMatch[1];
  1525. }
  1526. lastSegment = lastSegment.replace(/\/$/, "").replace(/^\//, "");
  1527. return lastSegment;
  1528. }
  1529. static getRegExp(string) {
  1530. return new RegExp(string.replace(REGEXP_ESCAPE, "\\$1"), "gi");
  1531. }
  1532. static getUrlFunctions(stylesheetContent) {
  1533. return Array.from(new Set(stylesheetContent.match(REGEXP_URL_FN) || []));
  1534. }
  1535. static getImportFunctions(stylesheetContent) {
  1536. return stylesheetContent.match(REGEXP_IMPORT_FN) || [];
  1537. }
  1538. static findShortcutIcon(shortcutIcons) {
  1539. shortcutIcons = shortcutIcons.filter(linkElement => linkElement.href != EMPTY_IMAGE);
  1540. shortcutIcons.sort((linkElement1, linkElement2) => (parseInt(linkElement2.sizes, 10) || 16) - (parseInt(linkElement1.sizes, 10) || 16));
  1541. return shortcutIcons[0];
  1542. }
  1543. static matchURL(stylesheetContent) {
  1544. const match = stylesheetContent.match(REGEXP_URL_SIMPLE_QUOTES_FN) ||
  1545. stylesheetContent.match(REGEXP_URL_DOUBLE_QUOTES_FN) ||
  1546. stylesheetContent.match(REGEXP_URL_NO_QUOTES_FN);
  1547. return match && match[1];
  1548. }
  1549. static testIgnoredPath(resourceURL) {
  1550. return resourceURL && (resourceURL.startsWith(DATA_URI_PREFIX) || resourceURL == ABOUT_BLANK_URI);
  1551. }
  1552. static testValidPath(resourceURL) {
  1553. return resourceURL && !resourceURL.match(EMPTY_URL);
  1554. }
  1555. static testValidURL(resourceURL) {
  1556. return Util.testValidPath(resourceURL) && (resourceURL.match(HTTP_URI_PREFIX) || resourceURL.match(FILE_URI_PREFIX) || resourceURL.startsWith(BLOB_URI_PREFIX)) && resourceURL.match(NOT_EMPTY_URL);
  1557. }
  1558. static matchImport(stylesheetContent) {
  1559. const match = stylesheetContent.match(REGEXP_IMPORT_URL_SIMPLE_QUOTES_FN) ||
  1560. stylesheetContent.match(REGEXP_IMPORT_URL_DOUBLE_QUOTES_FN) ||
  1561. stylesheetContent.match(REGEXP_IMPORT_URL_NO_QUOTES_FN) ||
  1562. stylesheetContent.match(REGEXP_IMPORT_SIMPLE_QUOTES_FN) ||
  1563. stylesheetContent.match(REGEXP_IMPORT_DOUBLE_QUOTES_FN) ||
  1564. stylesheetContent.match(REGEXP_IMPORT_NO_QUOTES_FN);
  1565. if (match) {
  1566. const [, resourceURL, media] = match;
  1567. return { resourceURL, media };
  1568. }
  1569. }
  1570. static removeCssComments(stylesheetContent) {
  1571. let start, end;
  1572. do {
  1573. start = stylesheetContent.indexOf("/*");
  1574. end = stylesheetContent.indexOf("*/", start + 2);
  1575. if (start != -1 && end != -1) {
  1576. stylesheetContent = stylesheetContent.substring(0, start) + stylesheetContent.substr(end + 2);
  1577. }
  1578. } while (start != -1 && end != -1);
  1579. return stylesheetContent;
  1580. }
  1581. static wrapMediaQuery(stylesheetContent, mediaQuery) {
  1582. if (mediaQuery) {
  1583. return "@media " + mediaQuery + "{ " + stylesheetContent + " }";
  1584. } else {
  1585. return stylesheetContent;
  1586. }
  1587. }
  1588. }
  1589. function log(...args) {
  1590. console.log("S-File <core> ", ...args); // eslint-disable-line no-console
  1591. }
  1592. // -----
  1593. // Stats
  1594. // -----
  1595. const STATS_DEFAULT_VALUES = {
  1596. discarded: {
  1597. "HTML bytes": 0,
  1598. "hidden elements": 0,
  1599. "HTML imports": 0,
  1600. scripts: 0,
  1601. objects: 0,
  1602. "audio sources": 0,
  1603. "video sources": 0,
  1604. frames: 0,
  1605. "CSS rules": 0,
  1606. canvas: 0,
  1607. stylesheets: 0,
  1608. resources: 0,
  1609. medias: 0
  1610. },
  1611. processed: {
  1612. "HTML bytes": 0,
  1613. "hidden elements": 0,
  1614. "HTML imports": 0,
  1615. scripts: 0,
  1616. objects: 0,
  1617. "audio sources": 0,
  1618. "video sources": 0,
  1619. frames: 0,
  1620. "CSS rules": 0,
  1621. canvas: 0,
  1622. stylesheets: 0,
  1623. resources: 0,
  1624. medias: 0
  1625. }
  1626. };
  1627. class Stats {
  1628. constructor(options) {
  1629. this.options = options;
  1630. if (options.displayStats) {
  1631. this.data = JSON.parse(JSON.stringify(STATS_DEFAULT_VALUES));
  1632. }
  1633. }
  1634. set(type, subType, value) {
  1635. if (this.options.displayStats) {
  1636. this.data[type][subType] = value;
  1637. }
  1638. }
  1639. add(type, subType, value) {
  1640. if (this.options.displayStats) {
  1641. this.data[type][subType] += value;
  1642. }
  1643. }
  1644. addAll(pageData) {
  1645. if (this.options.displayStats) {
  1646. Object.keys(this.data.discarded).forEach(key => this.add("discarded", key, pageData.stats.discarded[key] || 0));
  1647. Object.keys(this.data.processed).forEach(key => this.add("processed", key, pageData.stats.processed[key] || 0));
  1648. }
  1649. }
  1650. }
  1651. return { getClass };
  1652. })();