#################################################################################################################################### # DOC MARKDOWN MODULE #################################################################################################################################### package BackRestDoc::Markdown::DocMarkdown; 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 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::Markdown::DocMarkdownRender; #################################################################################################################################### # Operation constants #################################################################################################################################### use constant OP_DOC_MARKDOWN => 'DocMarkdown'; use constant OP_DOC_MARKDOWN_NEW => OP_DOC_MARKDOWN . '->new'; use constant OP_DOC_MARKDOWN_PROCESS => OP_DOC_MARKDOWN . '->process'; #################################################################################################################################### # 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->{strMarkdownPath}, $self->{bExe} ) = logDebugParam ( OP_DOC_MARKDOWN_NEW, \@_, {name => 'oManifest'}, {name => 'strXmlPath'}, {name => 'strMarkdownPath'}, {name => 'bExe'} ); # Remove the current html path if it exists if (-e $self->{strMarkdownPath}) { executeTest("rm -rf $self->{strMarkdownPath}/*"); } # Else create the html path else { mkdir($self->{strMarkdownPath}) or confess &log(ERROR, "unable to create path $self->{strMarkdownPath}"); } # 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(OP_DOC_MARKDOWN_PROCESS); foreach my $strRenderOutId ($self->{oManifest}->renderOutList(RENDER_TYPE_MARKDOWN)) { my $oRenderOut = $self->{oManifest}->renderOutGet(RENDER_TYPE_MARKDOWN, $strRenderOutId); my $strFile = "$self->{strMarkdownPath}/" . (defined($$oRenderOut{file}) ? $$oRenderOut{file} : "${strRenderOutId}.md"); &log(INFO, " render out: ${strRenderOutId}"); # Save the html page fileStringWrite($strFile, $self->{oManifest}->variableReplace((new BackRestDoc::Markdown::DocMarkdownRender($self->{oManifest}, $strRenderOutId, $self->{bExe}))->process()), false); } # Return from function and log return values if any logDebugReturn($strOperation); } 1;