1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
####################################################################################################################################
# DOC HTML SITE MODULE
####################################################################################################################################
package pgBackRestDoc::Html::DocHtmlSite;
use strict;
use warnings FATAL => qw(all);
use Carp qw(confess);
use English '-no_match_vars';
use Data::Dumper;
use Exporter qw(import);
our @EXPORT = qw();
use File::Basename qw(dirname);
use File::Copy;
use POSIX qw(strftime);
use Storable qw(dclone);
use pgBackRestTest::Common::ExecuteTest;
use pgBackRestDoc::Common::DocManifest;
use pgBackRestDoc::Common::Exception;
use pgBackRestDoc::Common::Log;
use pgBackRestDoc::Common::String;
use pgBackRestDoc::Html::DocHtmlPage;
use pgBackRestDoc::ProjectInfo;
####################################################################################################################################
# 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'}
);
# 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');
# Get render options
my $oRender = $self->{oManifest}->renderGet(RENDER_TYPE_HTML);
my $bMenu = $$oRender{&RENDER_MENU};
my $bPretty = $$oRender{&RENDER_PRETTY};
my $bCompact = $$oRender{&RENDER_COMPACT};
if (!$bCompact)
{
# 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;
my $oRenderOut = $self->{oManifest}->renderOutGet(RENDER_TYPE_HTML, $strPageId);
eval
{
$strHtml = $self->{oManifest}->variableReplace(
new pgBackRestDoc::Html::DocHtmlPage(
$self->{oManifest}, $strPageId, $bMenu, $self->{bExe}, $bCompact,
${$self->{oManifest}->storage()->get($self->{strCssFile})}, $bPretty)->process());
return true;
}
or do
{
my $oException = $@;
if (exceptionCode($oException) == ERROR_FILE_INVALID)
{
my $oRenderOut = $self->{oManifest}->renderOutGet(RENDER_TYPE_HTML, $strPageId);
$self->{oManifest}->cacheReset($$oRenderOut{source});
$strHtml = $self->{oManifest}->variableReplace(
new pgBackRestDoc::Html::DocHtmlPage(
$self->{oManifest}, $strPageId, $bMenu, $self->{bExe}, $bCompact,
${$self->{oManifest}->storage()->get($self->{strCssFile})}, $bPretty)->process());
}
else
{
confess $oException;
}
};
# Save the html page
my $strFile = "$self->{strHtmlPath}/" . (defined($$oRenderOut{file}) ? $$oRenderOut{file} : "${strPageId}.html");
$self->{oManifest}->storage()->put($strFile, $strHtml);
}
# Return from function and log return values if any
logDebugReturn($strOperation);
}
1;
|
