mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2024-12-14 10:13:05 +02:00
eaa981c5aa
Added an execution cache so that documentation can be generated without setting up the full container environment. This is useful for packaging, keeps the documentation consistent for a release, and speeds up generation when no changes are made in the execution list.
163 lines
5.2 KiB
Perl
163 lines
5.2 KiB
Perl
####################################################################################################################################
|
|
# DOC HTML SITE MODULE
|
|
####################################################################################################################################
|
|
package BackRestDoc::Html::DocHtmlSite;
|
|
|
|
use strict;
|
|
use warnings FATAL => qw(all);
|
|
use Carp qw(confess);
|
|
|
|
use Data::Dumper;
|
|
use Exporter qw(import);
|
|
our @EXPORT = qw();
|
|
use File::Basename qw(dirname);
|
|
use File::Copy;
|
|
use POSIX qw(strftime);
|
|
use Scalar::Util qw(blessed);
|
|
use Storable qw(dclone);
|
|
|
|
use lib dirname($0) . '/../lib';
|
|
use pgBackRest::Common::Log;
|
|
use pgBackRest::Common::String;
|
|
use pgBackRest::FileCommon;
|
|
use pgBackRest::Version;
|
|
|
|
use lib dirname($0) . '/../test/lib';
|
|
use pgBackRestTest::Common::ExecuteTest;
|
|
|
|
use BackRestDoc::Common::DocConfig;
|
|
use BackRestDoc::Common::DocManifest;
|
|
use BackRestDoc::Html::DocHtmlPage;
|
|
|
|
####################################################################################################################################
|
|
# CONSTRUCTOR
|
|
####################################################################################################################################
|
|
sub new
|
|
{
|
|
my $class = shift; # Class name
|
|
|
|
# Create the class hash
|
|
my $self = {};
|
|
bless $self, $class;
|
|
|
|
$self->{strClass} = $class;
|
|
|
|
# Assign function parameters, defaults, and log debug info
|
|
(
|
|
my $strOperation,
|
|
$self->{oManifest},
|
|
$self->{strXmlPath},
|
|
$self->{strHtmlPath},
|
|
$self->{strCssFile},
|
|
$self->{strFaviconFile},
|
|
$self->{strProjectLogoFile},
|
|
$self->{bExe}
|
|
) =
|
|
logDebugParam
|
|
(
|
|
__PACKAGE__ . '->new', \@_,
|
|
{name => 'oManifest'},
|
|
{name => 'strXmlPath'},
|
|
{name => 'strHtmlPath'},
|
|
{name => 'strCssFile'},
|
|
{name => 'strFaviconFile', required => false},
|
|
{name => 'strProjectLogoFile', required => false},
|
|
{name => 'bExe'}
|
|
);
|
|
|
|
# Remove the current html path if it exists
|
|
if (-e $self->{strHtmlPath})
|
|
{
|
|
executeTest("rm -rf $self->{strHtmlPath}/*");
|
|
}
|
|
# Else create the html path
|
|
else
|
|
{
|
|
mkdir($self->{strHtmlPath})
|
|
or confess &log(ERROR, "unable to create path $self->{strHtmlPath}");
|
|
}
|
|
|
|
# Return from function and log return values if any
|
|
return logDebugReturn
|
|
(
|
|
$strOperation,
|
|
{name => 'self', value => $self}
|
|
);
|
|
}
|
|
|
|
####################################################################################################################################
|
|
# process
|
|
#
|
|
# Generate the site html
|
|
####################################################################################################################################
|
|
sub process
|
|
{
|
|
my $self = shift;
|
|
|
|
# Assign function parameters, defaults, and log debug info
|
|
my $strOperation = logDebugParam(__PACKAGE__ . '->process');
|
|
|
|
# Copy the css file
|
|
my $strCssFileDestination = "$self->{strHtmlPath}/default.css";
|
|
copy($self->{strCssFile}, $strCssFileDestination)
|
|
or confess &log(ERROR, "unable to copy $self->{strCssFile} to ${strCssFileDestination}");
|
|
|
|
# Copy the favicon file
|
|
if (defined($self->{strFaviconFile}))
|
|
{
|
|
my $strFaviconFileDestination = "$self->{strHtmlPath}/" . $self->{oManifest}->variableGet('project-favicon');
|
|
copy($self->{strFaviconFile}, $strFaviconFileDestination)
|
|
or confess &log(ERROR, "unable to copy $self->{strFaviconFile} to ${strFaviconFileDestination}");
|
|
}
|
|
|
|
# Copy the project logo file
|
|
if (defined($self->{strProjectLogoFile}))
|
|
{
|
|
my $strProjectLogoFileDestination = "$self->{strHtmlPath}/" . $self->{oManifest}->variableGet('project-logo');
|
|
copy($self->{strProjectLogoFile}, $strProjectLogoFileDestination)
|
|
or confess &log(ERROR, "unable to copy $self->{strProjectLogoFile} to ${strProjectLogoFileDestination}");
|
|
}
|
|
|
|
foreach my $strPageId ($self->{oManifest}->renderOutList(RENDER_TYPE_HTML))
|
|
{
|
|
&log(INFO, " render out: ${strPageId}");
|
|
|
|
my $strHtml;
|
|
|
|
eval
|
|
{
|
|
$strHtml =
|
|
$self->{oManifest}->variableReplace(
|
|
(new BackRestDoc::Html::DocHtmlPage($self->{oManifest}, $strPageId, $self->{bExe}))->process());
|
|
};
|
|
|
|
if ($@)
|
|
{
|
|
my $oMessage = $@;
|
|
|
|
# If a backrest exception then return the code - don't confess
|
|
if (blessed($oMessage) && $oMessage->isa('pgBackRest::Common::Exception') && $oMessage->code() == -1)
|
|
{
|
|
my $oRenderOut = $self->{oManifest}->renderOutGet(RENDER_TYPE_HTML, $strPageId);
|
|
$self->{oManifest}->cacheReset($$oRenderOut{source});
|
|
|
|
$strHtml =
|
|
$self->{oManifest}->variableReplace(
|
|
(new BackRestDoc::Html::DocHtmlPage($self->{oManifest}, $strPageId, $self->{bExe}))->process());
|
|
}
|
|
else
|
|
{
|
|
confess $@;
|
|
}
|
|
}
|
|
|
|
# Save the html page
|
|
fileStringWrite("$self->{strHtmlPath}/${strPageId}.html", $strHtml, false);
|
|
}
|
|
|
|
# Return from function and log return values if any
|
|
logDebugReturn($strOperation);
|
|
}
|
|
|
|
1;
|