From 940b45ee85b5a4badaca4ba06f64ada8fa9a1d5b Mon Sep 17 00:00:00 2001 From: Alezia Kurdis <60075796+AleziaKurdis@users.noreply.github.com> Date: Sat, 27 Feb 2021 13:13:37 -0500 Subject: [PATCH] Add Broken Url Report feature --- .../system/create/modules/brokenUrlReport.js | 369 ++++++++++++++++++ 1 file changed, 369 insertions(+) create mode 100644 scripts/system/create/modules/brokenUrlReport.js diff --git a/scripts/system/create/modules/brokenUrlReport.js b/scripts/system/create/modules/brokenUrlReport.js new file mode 100644 index 0000000000..34c36caf05 --- /dev/null +++ b/scripts/system/create/modules/brokenUrlReport.js @@ -0,0 +1,369 @@ +// +// brokenUrlReport.js +// +// Created by Alezia Kurdis on February 22, 2021. +// Copyright 2021 Vircadia contributors. +// +// This script add reports functionalities to the Create Application. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +var brokenUrlReportHttpRequest; +var brokenUrlReportUrlList = []; +var brokenUrlReportInvalideUrlList = []; +var brokenUrlReportProcessedUrlNo = 0; +var brokenUrlReportUrlEntry; +var brokenUrlReportMessageBox; +var brokenUrlReportOverlayWebWindow; +var BROKEN_URL_REPORT_YES_BUTTON = 0x4000; +var BROKEN_URL_REPORT_NO_BUTTON = 0x10000; +var MAX_URL_BEFORE_WARNING_FOR_LONG_PROCESS = 20; + +function brokenUrlReportRequestUrlValidityCheck(no) { + brokenUrlReportHttpRequest = new XMLHttpRequest(); + brokenUrlReportHttpRequest.requestComplete.connect(brokenUrlReportGetResponseStatus); + brokenUrlReportHttpRequest.open("GET", brokenUrlReportUrlList[no].url); + brokenUrlReportHttpRequest.send(); +} + +function brokenUrlReportGetResponseStatus() { + if (brokenUrlReportHttpRequest.status === 0 || brokenUrlReportHttpRequest.status > 299) { + brokenUrlReportUrlList[brokenUrlReportProcessedUrlNo].validity = brokenUrlReportHttpRequest.status; + brokenUrlReportInvalideUrlList.push(brokenUrlReportUrlList[brokenUrlReportProcessedUrlNo]); + } + brokenUrlReportHttpRequest.requestComplete.disconnect(brokenUrlReportGetResponseStatus); + brokenUrlReportHttpRequest = null; + brokenUrlReportProcessedUrlNo = brokenUrlReportProcessedUrlNo + 1; + if (brokenUrlReportProcessedUrlNo === brokenUrlReportUrlList.length) { + brokenUrlReportGenerateFormatedReport(brokenUrlReportInvalideUrlList); + brokenUrlReportUrlList = []; + brokenUrlReportInvalideUrlList = []; + brokenUrlReportProcessedUrlNo = 0; + } else { + brokenUrlReportRequestUrlValidityCheck(brokenUrlReportProcessedUrlNo); + } +} + +function brokenUrlReportGenerateFormatedReport(brokenUrlReportInvalideUrlList) { + var brokenUrlReportContent = ""; + if (brokenUrlReportInvalideUrlList.length === 0) { + brokenUrlReportContent = "

Broken Url Report

" + brokenUrlReportUrlList.length + " URL tested.
NO ISSUE HAS BEEN FOUND.




"; + brokenUrlReportContent = brokenUrlReportContent + "
This report ignores URL from the Asset Server (atp://), local drive paths or any string not starting by 'http'.
"; + Script.setTimeout(function () { + brokenUrlReportOverlayWebWindow.emitScriptEvent(brokenUrlReportContent); + }, 3000); + return; + } + brokenUrlReportContent = "

Broken Url Report

\n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + for (var i = 0; i < brokenUrlReportInvalideUrlList.length; i++ ){ + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + brokenUrlReportContent = brokenUrlReportContent + " \n"; + } + brokenUrlReportContent = brokenUrlReportContent + "
 EntityBroken Url
NoTypeName & IDPropertyStatusCurrent URL
" + (i + 1) + "" + brokenUrlReportInvalideUrlList[i].type + "" + brokenUrlReportInvalideUrlList[i].name + "
" + brokenUrlReportInvalideUrlList[i].id + "		" + brokenUrlReportInvalideUrlList[i].urlType + "" + brokenUrlReportInvalideUrlList[i].validity + "" + brokenUrlReportInvalideUrlList[i].url + "
\n"; + brokenUrlReportContent = brokenUrlReportContent + "

" + brokenUrlReportUrlList.length + " URL tested.

"; + brokenUrlReportContent = brokenUrlReportContent + "
This report ignores URL from the Asset Server (atp://), local drive paths or any string not starting by 'http'.
"; + + Script.setTimeout(function () { + brokenUrlReportOverlayWebWindow.emitScriptEvent(brokenUrlReportContent); + }, 3000); +} + +function brokenUrlReportGetUrlTypeColor(urlType) { + var hexaColor = "#FFFFFF"; + switch (urlType) { + case "script": + hexaColor = "#00FF00"; + break; + case "serverScripts": + hexaColor = "#FF00FF"; + break; + case "imageURL": + hexaColor = "#00FFFF"; + break; + case "materialURL": + hexaColor = "#FF6600"; + break; + case "modelURL": + hexaColor = "#FFFF00"; + break; + case "compoundShapeURL": + hexaColor = "#6666FF"; + break; + case "animation.url": + hexaColor = "#6699FF"; + break; + case "textures": + hexaColor = "#FF0066"; + break; + case "xTextureURL": + hexaColor = "#0000FF"; + break; + case "yTextureURL": + hexaColor = "#009966"; + break; + case "zTextureURL": + hexaColor = "#993366"; + break; + case "font": + hexaColor = "#FFFFFF"; + break; + case "sourceUrl": + hexaColor = "#BBFF00"; + break; + case "scriptURL": + hexaColor = "#FFBBBB"; + break; + case "filterURL": + hexaColor = "#BBBBFF"; + break; + case "skybox.url": + hexaColor = "#BBFFFF"; + break; + case "ambientLight.ambientURL": + hexaColor = "#FF3300"; + } + return hexaColor; +} + +function brokenUrlReport(entityIds) { + if (entityIds.length === 0) { + audioFeedback.rejection(); + Window.alert("You have nothing selected."); + return; + } else { + var properties; + for (var i = 0; i < entityIds.length; i++ ){ + properties = Entities.getEntityProperties(entityIds[i]); + if (properties.script.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "script", + url: properties.script, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.serverScripts.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "serverScripts", + url: properties.serverScripts, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Image" && properties.imageURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "imageURL", + url: properties.imageURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Material" && properties.materialURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "materialURL", + url: properties.materialURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Model" && properties.modelURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "modelURL", + url: properties.modelURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if ((properties.type === "Zone" || properties.type === "Model" || properties.type === "ParticleEffect") && properties.compoundShapeURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "compoundShapeURL", + url: properties.compoundShapeURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Model" && properties.animation.url.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "animation.url", + url: properties.animation.url, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "ParticleEffect" && properties.textures.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "textures", + url: properties.textures, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "PolyVox" && properties.xTextureURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "xTextureURL", + url: properties.xTextureURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "PolyVox" && properties.yTextureURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "yTextureURL", + url: properties.yTextureURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "PolyVox" && properties.zTextureURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "zTextureURL", + url: properties.zTextureURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Text" && properties.font.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "font", + url: properties.font, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Web" && properties.sourceUrl.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "sourceUrl", + url: properties.sourceUrl, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Web" && properties.scriptURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "scriptURL", + url: properties.scriptURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Zone" && properties.filterURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "filterURL", + url: properties.filterURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Zone" && properties.skybox.url.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "skybox.url", + url: properties.skybox.url, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + if (properties.type === "Zone" && properties.ambientLight.ambientURL.toLowerCase().startsWith("http")) { + brokenUrlReportUrlEntry = { + id: entityIds[i], + name: properties.name, + type: properties.type, + urlType: "ambientLight.ambientURL", + url: properties.ambientLight.ambientURL, + validity: "NOT_TESTED" + }; + brokenUrlReportUrlList.push(brokenUrlReportUrlEntry); + } + } + if (brokenUrlReportUrlList.length === 0) { + audioFeedback.confirmation(); + Window.alert("No 'http' url has been found within the current selection."); + return; + } else { + if (brokenUrlReportUrlList.length > MAX_URL_BEFORE_WARNING_FOR_LONG_PROCESS) { + var message = "Number of http URL found: " + brokenUrlReportUrlList.length + "\n The analysis may take time. Do you want to proceed?"; + var answer = Window.confirm(message); + if (!answer) { + return; + } + } + brokenUrlReportOverlayWebWindow = new OverlayWebWindow({ + title: "Broken Url Report", + source: Script.resolvePath("brokenUrlReport.html"), + width: 1000, + height: 600 + }); + brokenUrlReportContent = ""; + brokenUrlReportRequestUrlValidityCheck(brokenUrlReportProcessedUrlNo); + } + } +}