Skip to content

Add an AppOffline.htm when the local upgrade process is unpacking files #7328

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

Open
donker wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add an AppOffline.htm when the local upgrade process is unpacking files #7328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20ee667
Add ability to skip backing up files in the FileInstaller
donker Jun 17, 2026
d2c1930
Add AppOffline.htm to solution which is copied in during local instal…
donker Jun 17, 2026
1779561
Propegate the backup switch to the relevant installers
donker Jun 17, 2026
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
2 changes: 1 addition & 1 deletion DNN Platform/Library/Services/Installer/Installers/CleanupInstaller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ protected bool CleanupFile(InstallFile insFile)
try
{
// Backup File
if (File.Exists(this.PhysicalBasePath + insFile.FullName))
if (File.Exists(this.PhysicalBasePath + insFile.FullName) && this.BackupFiles)
{
Util.BackupFile(insFile, this.PhysicalBasePath, this.Log);
}
Expand Down
5 changes: 4 additions & 1 deletion DNN Platform/Library/Services/Installer/Installers/FileInstaller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ public class FileInstaller : ComponentInstallerBase
/// <summary>Gets the name of the Item Node (<c>file</c>).</summary>
protected virtual string ItemNodeName => "file";

/// <summary>Gets or sets a value indicating whether any existing files should be backed up during installation.</summary>
protected bool BackupFiles { get; set; } = true;

/// <summary>Gets the PhysicalBasePath for the files.</summary>
protected virtual string PhysicalBasePath
{
Expand Down Expand Up @@ -177,7 +180,7 @@ protected virtual bool InstallFile(InstallFile insFile)
if (this.Package.InstallerInfo.IgnoreWhiteList || Util.IsFileValid(insFile, this.Package.InstallerInfo.AllowableFiles))
{
// Install File
if (File.Exists(this.PhysicalBasePath + insFile.FullName))
if (File.Exists(this.PhysicalBasePath + insFile.FullName) && this.BackupFiles)
{
Util.BackupFile(insFile, this.PhysicalBasePath, this.Log);
}
Expand Down
2 changes: 1 addition & 1 deletion DNN Platform/Library/Services/Installer/Installers/ResourceFileInstaller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ protected override bool InstallFile(InstallFile insFile)
writer.WriteElementString("name", fileName);

var physicalPath = Path.Combine(this.PhysicalBasePath, entry.FullName);
if (File.Exists(physicalPath))
if (File.Exists(physicalPath) && this.BackupFiles)
{
Util.BackupFile(
new InstallFile(entry.FullName, this.Package.InstallerInfo),
Expand Down
27 changes: 27 additions & 0 deletions DNN Platform/Library/Services/Installer/LocalUpgradeService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ public async Task StartLocalUpgrade(IReadOnlyList<LocalUpgradeInfo> upgrades, Ca
/// <inheritdoc />
public async Task StartLocalUpgrade(LocalUpgradeInfo upgrade, CancellationToken cancellationToken)
{
this.SetAppOffline();
var upgradeZipPath = Path.Combine(this.UpgradeDirectoryPath, upgrade.PackageName + ".zip");
using var fileStream = File.OpenRead(upgradeZipPath);
using var archive = new ZipArchive(fileStream, ZipArchiveMode.Read);
Expand Down Expand Up @@ -218,6 +219,7 @@ await FileSystemUtils.UnzipResourcesAsync(
.Where(entry => !upgradeSettings.UpgradeExclude.Any(filter => entry.FullName.StartsWith(filter, StringComparison.OrdinalIgnoreCase))),
this.appStatus.ApplicationMapPath,
cancellationToken);
this.SetAppOnline();
}

private static async Task<Version> ReadZippedAssemblyVersion(ZipArchiveEntry assemblyEntry, CancellationToken cancellationToken)
Expand Down Expand Up @@ -246,12 +248,37 @@ await assemblyStream.CopyToAsync(
}
}

private void SetAppOffline()
{
var appOfflineFile = Path.Combine(Globals.HostMapPath, "AppOffline", "App_Offline.htm");
if (!File.Exists(appOfflineFile))
{
appOfflineFile = Path.Combine(this.appStatus.ApplicationMapPath, "Resources", "AppOffline", "App_Offline.htm");
}

var targetFile = Path.Combine(this.appStatus.ApplicationMapPath, "App_Offline.htm");
if (!File.Exists(targetFile))
{
File.Copy(appOfflineFile, targetFile);
}
}

private void SetAppOnline()
{
var appOfflineFile = Path.Combine(this.appStatus.ApplicationMapPath, "App_Offline.htm");
if (File.Exists(appOfflineFile))
{
File.Delete(appOfflineFile);
}
}

private class LocalUpgradeAssemblyInstaller : AssemblyInstaller
{
public LocalUpgradeAssemblyInstaller(InstallerInfo installerInfo)
{
this.Package = new PackageInfo();
this.Package.AttachInstallerInfo(installerInfo);
this.BackupFiles = false;
}

public async Task AddFiles(IEnumerable<ZipArchiveEntry> assemblyEntries, CancellationToken cancellationToken)
Expand Down
1 change: 1 addition & 0 deletions DNN Platform/Website/DotNetNuke.Website.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@
<Content Include="Providers\DataProviders\SqlDataProvider\10.02.01.SqlDataProvider" />
<Content Include="Providers\DataProviders\SqlDataProvider\10.02.02.SqlDataProvider" />
<Content Include="Providers\DataProviders\SqlDataProvider\10.02.04.SqlDataProvider" />
<Content Include="Resources\AppOffline\App_Offline.htm" />
<Content Include="Resources\Shared\components\SimpleMDE\codemirror.css" />
<Content Include="Resources\Shared\components\SimpleMDE\marked.js" />
<Content Include="Resources\Shared\components\SimpleMDE\simplemde.css" />
Expand Down
200 changes: 200 additions & 0 deletions DNN Platform/Website/Resources/AppOffline/App_Offline.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Site Offline - Upgrade in Progress</title>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link href="https://fonts.googleapis.com/css2?family=Ubuntu:wght@300;400;500;700&display=swap" rel="stylesheet" />
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}

html,
body {
height: 100%;
margin: 0;
}

body {
font-family: Ubuntu, Helvetica, sans-serif;
color: rgb(71, 42, 43);
background: rgb(240, 240, 240);
display: flex;
flex-direction: column;
min-height: 100vh;
}

.container {
width: 100%;
max-width: 1200px;
margin: 0 auto;
padding: 0 24px;
}

.eyebrow-bar {
background: rgb(14, 41, 54);
min-height: 40px;
}

.logo-menu-bar {
background: rgb(60, 122, 154);
min-height: 120px;
display: flex;
align-items: center;
}

.logo-menu-bar .container {
display: flex;
align-items: center;
}

.logo svg {
display: block;
width: 155px;
height: auto;
}

main {
flex: 1;
background: rgb(240, 240, 240);
padding: 64px 0 80px;
}

.hero {
max-width: 760px;
margin: 0 auto;
text-align: center;
padding: 0 24px;
}

h1 {
margin: 0 0 16px;
font-size: clamp(2rem, 4vw, 2.75rem);
font-weight: 700;
line-height: 1.2;
color: rgb(71, 42, 43);
}

.tagline {
margin: 0 0 24px;
font-size: clamp(1rem, 2vw, 1.25rem);
font-weight: 700;
letter-spacing: 0.04em;
text-transform: uppercase;
color: rgb(71, 42, 43);
}

.message {
margin: 0 auto;
max-width: 640px;
font-size: 1.125rem;
line-height: 1.7;
color: rgb(71, 42, 43);
}

.divider {
display: flex;
align-items: center;
justify-content: center;
margin: 48px auto 0;
max-width: 760px;
position: relative;
}

.divider::before {
content: "";
position: absolute;
left: 0;
right: 0;
top: 50%;
height: 4px;
transform: translateY(-50%);
background: linear-gradient(
to right,
rgb(237, 61, 70) 0%,
rgb(237, 61, 70) 50%,
rgb(0, 165, 224) 50%,
rgb(0, 165, 224) 100%
);
}

.divider-arrow {
position: relative;
width: 0;
height: 0;
border-left: 14px solid transparent;
border-right: 14px solid transparent;
border-top: 16px solid rgb(0, 165, 224);
}

footer {
background: rgb(14, 41, 54);
color: rgba(255, 255, 255, 0.85);
padding: 24px 0;
font-size: 0.95rem;
text-align: center;
}

footer p {
margin: 0;
line-height: 1.6;
}

@media (max-width: 600px) {
.logo-menu-bar {
min-height: 96px;
}

main {
padding: 48px 0 64px;
}

.message {
font-size: 1rem;
}
}
</style>
</head>
<body>
<header>
<div class="eyebrow-bar" aria-hidden="true"></div>
<div class="logo-menu-bar">
<div class="container">
<div class="logo">
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="155" height="62" viewBox="-42.52 77.519 155 62" role="img" aria-label="DNN">
<path fill="#FFFFFF" d="M43.598,115.273h-4.551v-9.107h4.551c2.516,0,4.559,2.04,4.559,4.553 C48.157,113.234,46.114,115.273,43.598,115.273 M43.598,98.332H30.994v24.777h12.604c6.848,0,12.393-5.547,12.393-12.393 C55.99,103.88,50.446,98.332,43.598,98.332"/>
<path fill="#FFFFFF" d="M83.959,110.603c-0.063-6.786-5.582-12.271-12.385-12.271H59.189v24.777h8.053v-16.725h4.332 c2.397,0,4.339,1.941,4.339,4.336v12.39h8.05v-12.507H83.959z"/>
<path fill="#FFFFFF" d="M112.473,110.603c-0.064-6.786-5.578-12.271-12.379-12.271H87.701v24.777h8.055v-16.725h4.338 c2.395,0,4.336,1.941,4.336,4.336v12.39h8.051v-12.507H112.473z"/>
<path fill="#FFFFFF" d="M-3.951,79.015c-2.551-0.689-5.236-1.061-8.004-1.061H-42.52v38.571h20.376V98.333h18.191L-3.951,79.015z M-1.766,79.697v18.635h18.637C13.798,89.651,6.916,82.763-1.766,79.697 M17.549,100.519H-1.766v8.013c-0.009,5.623-4.567,10.177-10.188,10.177h-8.004v20.375h8.004c16.88,0,30.562-13.683,30.562-30.564 C18.606,105.751,18.239,103.068,17.549,100.519 M-42.52,139.083h20.375v-20.377H-42.52V139.083z"/>
</svg>
</div>
</div>
</div>
</header>

<main>
<section class="hero">
<h1>We'll be right back</h1>
<p class="tagline">The site is currently being upgraded</p>
<p class="message">
Our application is temporarily offline while we perform an upgrade.
Thank you for your patience — the site will be back online again soon.
</p>
<div class="divider" aria-hidden="true">
<div class="divider-arrow"></div>
</div>
</section>
</main>

<footer>
<div class="container">
<p>This page is shown automatically while the site is offline for maintenance.</p>
</div>
</footer>
</body>
</html>
Loading