|
Packit |
c4476c |
#! /usr/bin/env perl
|
|
Packit |
c4476c |
# Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
Packit |
c4476c |
#
|
|
Packit |
c4476c |
# Licensed under the OpenSSL license (the "License"). You may not use
|
|
Packit |
c4476c |
# this file except in compliance with the License. You can obtain a copy
|
|
Packit |
c4476c |
# in the file LICENSE in the source distribution or at
|
|
Packit |
c4476c |
# https://www.openssl.org/source/license.html
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Reads one or more template files and runs it through Text::Template
|
|
Packit |
c4476c |
#
|
|
Packit |
c4476c |
# It is assumed that this scripts is called with -Mconfigdata, a module
|
|
Packit |
c4476c |
# that holds configuration data in %config
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
use strict;
|
|
Packit |
c4476c |
use warnings;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
use FindBin;
|
|
Packit |
c4476c |
use Getopt::Std;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# We actually expect to get the following hash tables from configdata:
|
|
Packit |
c4476c |
#
|
|
Packit |
c4476c |
# %config
|
|
Packit |
c4476c |
# %target
|
|
Packit |
c4476c |
# %withargs
|
|
Packit |
c4476c |
# %unified_info
|
|
Packit |
c4476c |
#
|
|
Packit |
c4476c |
# We just do a minimal test to see that we got what we expected.
|
|
Packit |
c4476c |
# $config{target} must exist as an absolute minimum.
|
|
Packit |
c4476c |
die "You must run this script with -Mconfigdata\n" if !exists($config{target});
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Make a subclass of Text::Template to override append_text_to_result,
|
|
Packit |
c4476c |
# as recommended here:
|
|
Packit |
c4476c |
#
|
|
Packit |
c4476c |
# http://search.cpan.org/~mjd/Text-Template-1.46/lib/Text/Template.pm#Automatic_postprocessing_of_template_hunks
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
package OpenSSL::Template;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Because we know that Text::Template isn't a core Perl module, we use
|
|
Packit |
c4476c |
# a fallback in case it's not installed on the system
|
|
Packit |
c4476c |
use File::Basename;
|
|
Packit |
c4476c |
use File::Spec::Functions;
|
|
Packit |
c4476c |
use lib "$FindBin::Bin/perl";
|
|
Packit |
c4476c |
use with_fallback "Text::Template 1.46";
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
#use parent qw/Text::Template/;
|
|
Packit |
c4476c |
use vars qw/@ISA/;
|
|
Packit |
c4476c |
push @ISA, qw/Text::Template/;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Override constructor
|
|
Packit |
c4476c |
sub new {
|
|
Packit |
c4476c |
my ($class) = shift;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Call the constructor of the parent class, Person.
|
|
Packit |
c4476c |
my $self = $class->SUPER::new( @_ );
|
|
Packit |
c4476c |
# Add few more attributes
|
|
Packit |
c4476c |
$self->{_output_off} = 0; # Default to output hunks
|
|
Packit |
c4476c |
bless $self, $class;
|
|
Packit |
c4476c |
return $self;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
sub append_text_to_output {
|
|
Packit |
c4476c |
my $self = shift;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
if ($self->{_output_off} == 0) {
|
|
Packit |
c4476c |
$self->SUPER::append_text_to_output(@_);
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
return;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
sub output_reset_on {
|
|
Packit |
c4476c |
my $self = shift;
|
|
Packit |
c4476c |
$self->{_output_off} = 0;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
sub output_on {
|
|
Packit |
c4476c |
my $self = shift;
|
|
Packit |
c4476c |
if (--$self->{_output_off} < 0) {
|
|
Packit |
c4476c |
$self->{_output_off} = 0;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
sub output_off {
|
|
Packit |
c4476c |
my $self = shift;
|
|
Packit |
c4476c |
$self->{_output_off}++;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Come back to main
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
package main;
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Helper functions for the templates #################################
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# It might be practical to quotify some strings and have them protected
|
|
Packit |
c4476c |
# from possible harm. These functions primarily quote things that might
|
|
Packit |
c4476c |
# be interpreted wrongly by a perl eval.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# quotify1 STRING
|
|
Packit |
c4476c |
# This adds quotes (") around the given string, and escapes any $, @, \,
|
|
Packit |
c4476c |
# " and ' by prepending a \ to them.
|
|
Packit |
c4476c |
sub quotify1 {
|
|
Packit |
c4476c |
my $s = shift @_;
|
|
Packit |
c4476c |
$s =~ s/([\$\@\\"'])/\\$1/g;
|
|
Packit |
c4476c |
'"'.$s.'"';
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# quotify_l LIST
|
|
Packit |
c4476c |
# For each defined element in LIST (i.e. elements that aren't undef), have
|
|
Packit |
c4476c |
# it quotified with 'quotify1'
|
|
Packit |
c4476c |
sub quotify_l {
|
|
Packit |
c4476c |
map {
|
|
Packit |
c4476c |
if (!defined($_)) {
|
|
Packit |
c4476c |
();
|
|
Packit |
c4476c |
} else {
|
|
Packit |
c4476c |
quotify1($_);
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
} @_;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Error reporter #####################################################
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# The error reporter uses %lines to figure out exactly which file the
|
|
Packit |
c4476c |
# error happened and at what line. Not that the line number may be
|
|
Packit |
c4476c |
# the start of a perl snippet rather than the exact line where it
|
|
Packit |
c4476c |
# happened. Nothing we can do about that here.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
my %lines = ();
|
|
Packit |
c4476c |
sub broken {
|
|
Packit |
c4476c |
my %args = @_;
|
|
Packit |
c4476c |
my $filename = "<STDIN>";
|
|
Packit |
c4476c |
my $deducelines = 0;
|
|
Packit |
c4476c |
foreach (sort keys %lines) {
|
|
Packit |
c4476c |
$filename = $lines{$_};
|
|
Packit |
c4476c |
last if ($_ > $args{lineno});
|
|
Packit |
c4476c |
$deducelines += $_;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
print STDERR $args{error}," in $filename, fragment starting at line ",$args{lineno}-$deducelines;
|
|
Packit |
c4476c |
undef;
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Check options ######################################################
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
my %opts = ();
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# -o ORIGINATOR
|
|
Packit |
c4476c |
# declares ORIGINATOR as the originating script.
|
|
Packit |
c4476c |
getopt('o', \%opts);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
my @autowarntext = ("WARNING: do not edit!",
|
|
Packit |
c4476c |
"Generated"
|
|
Packit |
c4476c |
. (defined($opts{o}) ? " by ".$opts{o} : "")
|
|
Packit |
c4476c |
. (scalar(@ARGV) > 0 ? " from ".join(", ",@ARGV) : ""));
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Template reading ###################################################
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Read in all the templates into $text, while keeping track of each
|
|
Packit |
c4476c |
# file and its size in lines, to try to help report errors with the
|
|
Packit |
c4476c |
# correct file name and line number.
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
my $prev_linecount = 0;
|
|
Packit |
c4476c |
my $text =
|
|
Packit |
c4476c |
@ARGV
|
|
Packit |
c4476c |
? join("", map { my $x = Text::Template::_load_text($_);
|
|
Packit |
c4476c |
if (!defined($x)) {
|
|
Packit |
c4476c |
die $Text::Template::ERROR, "\n";
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
$x = "{- output_reset_on() -}" . $x;
|
|
Packit |
c4476c |
my $linecount = $x =~ tr/\n//;
|
|
Packit |
c4476c |
$prev_linecount = ($linecount += $prev_linecount);
|
|
Packit |
c4476c |
$lines{$linecount} = $_;
|
|
Packit |
c4476c |
$x } @ARGV)
|
|
Packit |
c4476c |
: join("", <STDIN>);
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Engage! ############################################################
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
# Load the full template (combination of files) into Text::Template
|
|
Packit |
c4476c |
# and fill it up with our data. Output goes directly to STDOUT
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
my $template =
|
|
Packit |
c4476c |
OpenSSL::Template->new(TYPE => 'STRING',
|
|
Packit |
c4476c |
SOURCE => $text,
|
|
Packit |
c4476c |
PREPEND => qq{use lib "$FindBin::Bin/perl";});
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
sub output_reset_on {
|
|
Packit |
c4476c |
$template->output_reset_on();
|
|
Packit |
c4476c |
"";
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
sub output_on {
|
|
Packit |
c4476c |
$template->output_on();
|
|
Packit |
c4476c |
"";
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
sub output_off {
|
|
Packit |
c4476c |
$template->output_off();
|
|
Packit |
c4476c |
"";
|
|
Packit |
c4476c |
}
|
|
Packit |
c4476c |
|
|
Packit |
c4476c |
$template->fill_in(OUTPUT => \*STDOUT,
|
|
Packit |
c4476c |
HASH => { config => \%config,
|
|
Packit |
c4476c |
target => \%target,
|
|
Packit |
c4476c |
disabled => \%disabled,
|
|
Packit |
c4476c |
withargs => \%withargs,
|
|
Packit |
c4476c |
unified_info => \%unified_info,
|
|
Packit |
c4476c |
autowarntext => \@autowarntext,
|
|
Packit |
c4476c |
quotify1 => \"ify1,
|
|
Packit |
c4476c |
quotify_l => \"ify_l,
|
|
Packit |
c4476c |
output_reset_on => \&output_reset_on,
|
|
Packit |
c4476c |
output_on => \&output_on,
|
|
Packit |
c4476c |
output_off => \&output_off },
|
|
Packit |
c4476c |
DELIMITERS => [ "{-", "-}" ],
|
|
Packit |
c4476c |
BROKEN => \&broken);
|