Skip to content

Allow viewing of the changelog from the WebUI #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Martinski4GitHub merged 4 commits into from
Mar 9, 2025
Merged

Allow viewing of the changelog from the WebUI #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b619291
Allow viewing of the changelog from the WebUI
ExtremeFiretop Mar 9, 2025
16ae0c8
Update MerlinAU.sh
ExtremeFiretop Mar 9, 2025
1eca4e9
Update MerlinAU.sh
ExtremeFiretop Mar 9, 2025
5dfcdb6
Update MerlinAU.sh
ExtremeFiretop Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 100 additions & 55 deletions MerlinAU.asp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,82 @@ const fwUpdateDirPath =
}
};

function ShowLatestChangelog() {
document.form.action_script.value = 'start_MerlinAUdownloadchangelog';
document.form.action_wait.value = 10;

// Open popup **before** form submission to avoid browser popup blocking
var changelogWindow = window.open("", "ChangelogPopup", "width=800,height=600,scrollbars=1,resizable=1");

if (!changelogWindow) {
alert("Popup blocked! Please allow popups for this site to view the changelog.");
return;
}

changelogWindow.document.open();
changelogWindow.document.write("<html><head><title>Latest Changelog</title></head>");
changelogWindow.document.write("<body style='font-family:monospace; white-space:pre-wrap;'>");
changelogWindow.document.write("<p>Loading latest changelog...</p>");
changelogWindow.document.write("</body></html>");
changelogWindow.document.close();

// Now submit the form (which might trigger a page refresh)
showLoading();
document.form.submit();

// Delay the AJAX request slightly (but make sure it runs before page refresh)
setTimeout(function() {
$.ajax({
url: '/ext/MerlinAU/changelog.htm',
dataType: 'text',
timeout: 9000,
success: function(data) {
// Ensure the popup is still open before modifying it
if (changelogWindow && !changelogWindow.closed) {
changelogWindow.document.open();
changelogWindow.document.write("<html><head><title>Latest Changelog</title></head>");
changelogWindow.document.write("<body style='font-family:monospace; white-space:pre-wrap;'>");
changelogWindow.document.write("<pre>" + data + "</pre>");
changelogWindow.document.write("</body></html>");
changelogWindow.document.close();
}
},
error: function() {
if (changelogWindow && !changelogWindow.closed) {
changelogWindow.document.open();
changelogWindow.document.write("<html><head><title>Changelog Error</title></head>");
changelogWindow.document.write("<body style='font-family:monospace; white-space:pre-wrap;'>");
changelogWindow.document.write("<p>Failed to load the changelog.</p>");
changelogWindow.document.write("</body></html>");
changelogWindow.document.close();
}
}
});
}, 8000); // Delay slightly to allow form processing, but not too much
}

// **Control "Approve/Block Changelog" Checkbox State** //
function ToggleChangelogApproval(checkboxElem) {
if (checkboxElem.checked) {
// They are approving
if (!confirm(approveChangelogMsge)) {
// If user cancels at the confirm prompt, revert checkbox
checkboxElem.checked = false;
return;
}
ApproveChangelog();
}
else {
// They are blocking
if (!confirm(blockChangelogMsge)) {
// If user cancels at the confirm prompt, revert checkbox
checkboxElem.checked = true;
return;
}
BlockChangelog();
}
}

/**----------------------------------------**/
/** Modified by Martinski W. [2025-Feb-23] **/
/**----------------------------------------**/
Expand Down Expand Up @@ -1378,7 +1454,6 @@ function ApproveChangelog()
{
console.log("Approving Changelog...");

if (!confirm (approveChangelogMsge)) { return; }
document.form.action_script.value = 'start_MerlinAUapprovechangelog';
document.form.action_wait.value = 10;
showLoading();
Expand All @@ -1392,7 +1467,6 @@ function BlockChangelog()
{
console.log("Blocking Changelog...");

if (!confirm (blockChangelogMsge)) { return; }
document.form.action_script.value = 'start_MerlinAUblockchangelog';
document.form.action_wait.value = 10;
showLoading();
Expand Down Expand Up @@ -1577,66 +1651,34 @@ function InitializeFields()
}

// **Handle Changelog Approval Display** //
// Now we handle the new Approve Changelog checkbox
var changelogApprovalElement = document.getElementById('changelogApproval');
if (changelogApprovalElement)
{ // Default to "Disabled" if missing //
var approvalStatus = custom_settings.hasOwnProperty('FW_New_Update_Changelog_Approval') ? custom_settings.FW_New_Update_Changelog_Approval : "Disabled";
SetStatusForGUI('changelogApproval', approvalStatus);
}

// **Control "Approve/Block Changelog" Button State** //
var approveBlockChangelogBtn = document.getElementById('approveBlockChangeLogBtn');
if (approveBlockChangelogBtn)
{
var approveChangelogCheck = document.getElementById('approveChangelogCheck');
if (approveChangelogCheck) {
var isChangelogCheckEnabled = (custom_settings.CheckChangeLog === 'ENABLED');
var changelogApprovalValue = custom_settings.FW_New_Update_Changelog_Approval;

approveBlockChangelogBtn.style.display = 'inline-block';

// Decide whether we want "Approve" or "Block" //
if (changelogApprovalValue === 'APPROVED')
{ // Toggle functionality //
approveBlockChangelogBtn.value = "Block Changelog";
approveBlockChangelogBtn.title = blockChangelogHint;
approveBlockChangelogBtn.onclick = function() {
BlockChangelog();
return false; // Prevent default form submission
};

approveBlockChangelogBtn.disabled = false;
approveBlockChangelogBtn.style.opacity = '1';
approveBlockChangelogBtn.style.cursor = 'pointer';
}
else if (changelogApprovalValue === 'BLOCKED')
{ // Toggle functionality //
approveBlockChangelogBtn.value = "Approve Changelog";
approveBlockChangelogBtn.title = approveChangelogHint;
approveBlockChangelogBtn.onclick = function() {
ApproveChangelog();
return false;
};
approveBlockChangelogBtn.disabled = false;
var approvalValue = custom_settings.FW_New_Update_Changelog_Approval; // e.g. "APPROVED" or "BLOCKED"

// If Changelog Check is disabled, also disable our checkbox
if (!isChangelogCheckEnabled || !approvalValue || approvalValue === 'TBD') {
approveChangelogCheck.disabled = true;
approveChangelogCheck.checked = false;
}
else
{
approveBlockChangelogBtn.value = "Approve Changelog";
else {
approveChangelogCheck.disabled = false;

// Condition: Enable button only if
// 1. Changelog Check is enabled
// 2. Changelog Approval is neither empty nor "TBD"
if (isChangelogCheckEnabled && changelogApprovalValue && changelogApprovalValue !== 'TBD')
{
approveBlockChangelogBtn.title = approveChangelogHint;
approveBlockChangelogBtn.disabled = false;
approveBlockChangelogBtn.style.opacity = '1';
approveBlockChangelogBtn.style.cursor = 'pointer';
// If the stored approval is "APPROVED", default to checked
if (approvalValue === 'APPROVED') {
approveChangelogCheck.checked = true;
}
else
{
approveBlockChangelogBtn.title = '';
approveBlockChangelogBtn.disabled = true;
approveBlockChangelogBtn.style.opacity = '0.5';
approveBlockChangelogBtn.style.cursor = 'not-allowed';
// Otherwise, set as unchecked for "BLOCKED," "Disabled," etc.
else {
approveChangelogCheck.checked = false;
}
}
}
Expand Down Expand Up @@ -2566,10 +2608,13 @@ function initializeCollapsibleSections()
</br>
</td>
<td style="text-align: center; border: none;" id="approveChangelogCell">
<input type="submit" class="button_gen savebutton" id="approveBlockChangeLogBtn"
onclick="ApproveChangelog(); return false;"
value="Approve Changelog" title="" name="button">
<br><label style="margin-top: 5px; margin-bottom:8x"></br>
<input type="submit" id="LatestChangelogButton" onclick="ShowLatestChangelog();
return false;" value="Latest Changelog" class="button_gen savebutton" title="View the latest changelog" name="button">
<br>
<label style="color:#FFCC00; margin-top: 5px; margin-bottom:8x">
<input type="checkbox" id="approveChangelogCheck" name="approveChangelogCheck" onclick="ToggleChangelogApproval(this);"
style="padding:0; vertical-align:middle; position:relative; margin-left:-5px; margin-top:5px; margin-bottom:8px"/>Approve Changelog</label>
</br>
</td>
<td style="text-align: left; border: none;">
<input type="submit" id="UninstallButton" onclick="Uninstall(); return false;"
Expand Down
21 changes: 17 additions & 4 deletions MerlinAU.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ readonly CONFIG_FILE="${SETTINGS_DIR}/custom_settings.txt"
readonly SCRIPT_VERPATH="${SETTINGS_DIR}/version.txt"
readonly HELPER_JSFILE="${SETTINGS_DIR}/CheckHelper.js"
readonly PSWD_CHECK_JS="${SETTINGS_DIR}/PswdCheckStatus.js"
readonly CHANGELOG_PATH="${SETTINGS_DIR}/changelog.txt"
readonly SHARED_SETTINGS_FILE="${ADDONS_PATH}/custom_settings.txt"
readonly SHARED_WEB_DIR="$(readlink -f /www/user)"
readonly SCRIPT_WEB_DIR="${SHARED_WEB_DIR}/$SCRIPT_NAME"
Expand Down Expand Up @@ -2341,6 +2342,7 @@ _CreateSymLinks_()
ln -sf "$CONFIG_FILE" "${SCRIPT_WEB_DIR}/config.htm" 2>/dev/null
ln -sf "$HELPER_JSFILE" "${SCRIPT_WEB_DIR}/checkHelper.js" 2>/dev/null
ln -sf "$PSWD_CHECK_JS" "${SCRIPT_WEB_DIR}/pswdCheckStatus.js" 2>/dev/null
ln -sf "$CHANGELOG_PATH" "${SCRIPT_WEB_DIR}/changelog.htm" 2>/dev/null
}

##----------------------------------------##
Expand Down Expand Up @@ -7123,7 +7125,7 @@ _ManageChangelogMerlin_()
# Create directory to download changelog if missing #
if ! _CreateDirectory_ "$FW_BIN_DIR" ; then return 1 ; fi

if [ "$mode" = "view" ]
if [ "$mode" = "view" ] || [ "$mode" = "webuidownload" ]
then
if [ "$fwInstalledBaseVers" -eq 3006 ]
then
Expand Down Expand Up @@ -7183,7 +7185,9 @@ _ManageChangelogMerlin_()
"$inMenuMode" && _WaitForEnterKey_ "$logsMenuReturnPromptStr"
fi
fi
cp -fp "$changeLogFile" "${SETTINGS_DIR}/changelog.txt"
rm -f "$changeLogFile" "$wgetLogFile"
ln -sf "${SETTINGS_DIR}/changelog.txt" "${SCRIPT_WEB_DIR}/changelog.htm" 2>/dev/null
return 0
}

Expand All @@ -7196,7 +7200,6 @@ _ManageChangelogGnuton_()
then echo "**ERROR** **NO_PARAMS**" ; return 1 ; fi

local mode="$1" # Mode should be 'download' or 'view' #
local newUpdateVerStr=""
local wgetLogFile changeLogFile changeLogTag

# Create directory to download changelog if missing
Expand Down Expand Up @@ -7242,7 +7245,9 @@ _ManageChangelogGnuton_()
less "$FW_Changelog_GITHUB"
fi
fi
cp -fp "$changeLogFile" "${SETTINGS_DIR}/changelog.txt"
rm -f "$FW_Changelog_GITHUB" "$wgetLogFile"
ln -sf "${SETTINGS_DIR}/changelog.txt" "${SCRIPT_WEB_DIR}/changelog.htm" 2>/dev/null
return 1
}

Expand Down Expand Up @@ -7295,7 +7300,7 @@ _CheckNewUpdateFirmwareNotification_()
then
if "$isGNUtonFW"
then
_ManageChangelogGnuton_ "download" "$fwNewUpdateNotificationVers"
_ManageChangelogGnuton_ "download"
else
_ManageChangelogMerlin_ "download" "$fwNewUpdateNotificationVers"
fi
Expand All @@ -7313,7 +7318,7 @@ _CheckNewUpdateFirmwareNotification_()
then
if "$isGNUtonFW"
then
_ManageChangelogGnuton_ "download" "$fwNewUpdateNotificationVers"
_ManageChangelogGnuton_ "download"
else
_ManageChangelogMerlin_ "download" "$fwNewUpdateNotificationVers"
fi
Expand Down Expand Up @@ -10651,6 +10656,14 @@ then
_DoUnInstallation_
sleep 1
;;
"${SCRIPT_NAME}downloadchangelog")
if "$isGNUtonFW"
then
_ManageChangelogGnuton_ "webuidownload"
else
_ManageChangelogMerlin_ "webuidownload"
fi
;;
"${SCRIPT_NAME}approvechangelog")
currApprovalStatus="$(Get_Custom_Setting "FW_New_Update_Changelog_Approval")"
if [ "$currApprovalStatus" = "BLOCKED" ]
Expand Down