/usr/share/perl5/FCM/System/Make/Share/Config.pm is in fcm 2016.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | #-------------------------------------------------------------------------------
# (C) British Crown Copyright 2006-16 Met Office.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
#-------------------------------------------------------------------------------
use strict;
use warnings;
#-------------------------------------------------------------------------------
package FCM::System::Make::Share::Config;
use base qw{FCM::Class::CODE};
use Cwd qw{cwd};
use FCM::Context::ConfigEntry;
use FCM::Context::Locator;
use FCM::System::Exception;
use File::Spec::Functions qw{file_name_is_absolute};
use File::Temp;
use Text::ParseWords qw{shellwords};
use Scalar::Util qw{blessed};
# Alias to class name
my $E = 'FCM::System::Exception';
# Configuration parser label to action map
my %CONFIG_PARSER_OF = (
'dest' => \&_parse_dest,
'name' => \&_parse_name,
'require-version' => \&_parse_require_version,
'step.class' => \&_parse_step_class,
'steps' => \&_parse_steps,
'use' => \&_parse_use,
);
__PACKAGE__->class(
{shared_util_of => '%', subsystem_of => '%', util => '&'},
{action_of => {parse => \&_parse, unparse => \&_unparse}},
);
# Get configuration file entries from an iterator, and use the entries to
# populate the context of the current make.
sub _parse {
my ($attrib_ref, $entry_callback_ref, $m_ctx, @args) = @_;
my $DEST_UTIL = $attrib_ref->{shared_util_of}{dest};
my $dir = $m_ctx->get_option_of('directory')
? $m_ctx->get_option_of('directory') : cwd();
my $dir_locator = FCM::Context::Locator->new($dir);
my @config_file_paths = $m_ctx->get_option_of('config-file-path')
? @{$m_ctx->get_option_of('config-file-path')} : ();
my @config_file_path_locators
= map {FCM::Context::Locator->new($_)} @config_file_paths;
my @config_file_names = $m_ctx->get_option_of('config-file')
? @{$m_ctx->get_option_of('config-file')} : (undef);
my @config_reader_refs;
for my $config_file_name (@config_file_names) {
my $is_specified_name = 1;
if (!defined($config_file_name)) {
$config_file_name = $DEST_UTIL->path(
{'name' => $m_ctx->get_name()}, 'config');
$is_specified_name = 0;
}
if ( $attrib_ref->{util}->uri_match($config_file_name)
|| file_name_is_absolute($config_file_name)
) {
push(@config_reader_refs, _get_config_reader(
$attrib_ref, $config_file_name, [@config_file_path_locators],
));
}
else { # $config_file_name is relative
my $config_reader_ref;
HEAD:
for my $head_locator ($dir_locator, @config_file_path_locators) {
my $locator = $attrib_ref->{util}->loc_cat(
$head_locator, $config_file_name,
);
if ($attrib_ref->{util}->loc_exists($locator)) {
$config_reader_ref = _get_config_reader(
$attrib_ref, $locator, [@config_file_path_locators],
);
last HEAD;
}
}
if (defined($config_reader_ref)) {
push(@config_reader_refs, $config_reader_ref);
}
elsif ($is_specified_name) {
return $E->throw($E->MAKE_CFG_FILE, $config_file_name);
}
}
}
if (!@config_reader_refs) {
my $config_file_name = $DEST_UTIL->path(
{'dest' => $dir_locator->get_value(), 'name' => $m_ctx->get_name()},
'config',
);
if (-f $config_file_name) {
push(@config_reader_refs, _get_config_reader(
$attrib_ref, $config_file_name, [@config_file_path_locators],
));
}
}
my $args_config_handle;
if (@args) {
$args_config_handle = File::Temp->new(
SUFFIX => '-fcm-make-args.cfg',
TEMPLATE => 'XXXXXX',
TMPDIR => 1,
);
for my $arg (@args) {
print($args_config_handle "$arg\n");
}
$args_config_handle->seek(0, 0);
push(@config_reader_refs, _get_config_reader(
$attrib_ref,
$args_config_handle->filename(),
[@config_file_path_locators],
));
}
if (!@config_reader_refs) {
return $E->throw($E->MAKE_CFG);
}
my $entry_iter_ref = sub {
while (@config_reader_refs) {
my $entry = $config_reader_refs[0]->();
if (defined($entry)) {
return $entry;
}
shift(@config_reader_refs);
}
return undef;
};
my @unknown_entries;
while (defined(my $entry = $entry_iter_ref->())) {
if (defined($entry_callback_ref)) {
$entry_callback_ref->($entry);
}
if (exists($CONFIG_PARSER_OF{$entry->get_label()})) {
$CONFIG_PARSER_OF{$entry->get_label()}->(
$attrib_ref, $m_ctx, $entry,
);
}
else {
my ($id, $label) = split(qr{\.}msx, $entry->get_label(), 2);
if ( $label
&& $label eq 'prop'
&& exists($entry->get_modifier_of()->{'class'})
&& exists($attrib_ref->{subsystem_of}{$id})
) {
my $subsystem = $attrib_ref->{subsystem_of}{$id};
if (!$subsystem->config_parse_class_prop($entry, $label)) {
push(@unknown_entries, $entry);
}
}
else {
my $ctx = $m_ctx->get_ctx_of($id);
if ( !defined($ctx)
&& exists($attrib_ref->{subsystem_of}{$id})
) {
$ctx = $attrib_ref->{subsystem_of}{$id}->ctx($id, $id);
$m_ctx->get_ctx_of()->{$id} = $ctx;
}
my $rc;
if (defined($ctx)) {
my $id_of_class = $ctx->get_id_of_class();
my $subsystem = $attrib_ref->{subsystem_of}{$id_of_class};
$rc = $subsystem->config_parse($ctx, $entry, $label);
}
if (!$rc) {
push(@unknown_entries, $entry);
}
}
}
}
if (defined($args_config_handle)) {
$args_config_handle->close();
}
if (@unknown_entries) {
return $E->throw($E->CONFIG_UNKNOWN, \@unknown_entries);
}
$m_ctx;
}
# Returns a config reader.
sub _get_config_reader {
my ($attrib_ref, $locator, $config_file_path_locators_ref) = @_;
if (!blessed($locator)) {
$locator = FCM::Context::Locator->new($locator);
}
$attrib_ref->{util}->config_reader(
$locator,
{ event_level => $attrib_ref->{util}->util_of_report()->LOW,
include_paths => $config_file_path_locators_ref,
},
);
}
# Reads the "dest" declaration from a config entry.
sub _parse_dest {
my ($attrib_ref, $m_ctx, $entry) = @_;
$m_ctx->set_dest($entry->get_value());
}
# Reads the "name" declaration from a config entry.
sub _parse_name {
my ($attrib_ref, $m_ctx, $entry) = @_;
$m_ctx->set_name($entry->get_value());
}
# Parse "require-version" declaration from a config entry.
sub _parse_require_version {
my ($attrib_ref, $m_ctx, $entry) = @_;
my ($version) = shellwords($attrib_ref->{util}->version());
my ($min_version, $max_version) = shellwords($entry->get_value());
if ( $min_version gt $version
|| defined($max_version) && $version gt $max_version
) {
return $E->throw($E->CONFIG_VERSION, $entry, $version);
}
}
# Reads the step.class declaration from a config entry.
sub _parse_step_class {
my ($attrib_ref, $m_ctx, $entry) = @_;
my $id_of_class = $entry->get_value();
if (!exists($attrib_ref->{subsystem_of}{$id_of_class})) {
return $E->throw($E->CONFIG_VALUE, $entry);
}
my $subsystem = $attrib_ref->{subsystem_of}{$id_of_class};
for my $id (@{$entry->get_ns_list()}) {
if (!defined($m_ctx->get_ctx_of($id))) {
$m_ctx->get_ctx_of()->{$id} = $subsystem->ctx($id_of_class, $id);
}
}
}
# Reads the steps declaration from a config entry.
sub _parse_steps {
my ($attrib_ref, $m_ctx, $entry) = @_;
my @steps = $entry->get_values();
$m_ctx->set_steps(\@steps);
for my $id (@steps) {
if (!defined($m_ctx->get_ctx_of($id))) {
if (!exists($attrib_ref->{subsystem_of}{$id})) {
return $E->throw($E->CONFIG_VALUE, $entry);
}
my $subsystem = $attrib_ref->{subsystem_of}{$id};
$m_ctx->get_ctx_of()->{$id} = $subsystem->ctx($id, $id);
}
}
}
# Reads the use declaration.
sub _parse_use {
my ($attrib_ref, $m_ctx, $entry) = @_;
my $DEST = $attrib_ref->{shared_util_of}{dest};
my $inherit_ctx_list_ref = $m_ctx->get_inherit_ctx_list();
for my $value ($entry->get_values()) {
$value = $attrib_ref->{util}->file_tilde_expand($value);
my $i_m_ctx = eval {$DEST->ctx_load($m_ctx, $value)};
if (my $e = $@) {
return $E->throw($E->CONFIG_VALUE, $entry, $e);
}
if (!defined($i_m_ctx) || $i_m_ctx->get_status() != $i_m_ctx->ST_OK) {
return $E->throw($E->CONFIG_INHERIT, $entry);
}
push(@{$m_ctx->get_inherit_ctx_list()}, $i_m_ctx);
while (my ($id, $i_ctx) = each(%{$i_m_ctx->get_ctx_of()})) {
my $id_of_class = $i_ctx->get_id_of_class();
if (exists($attrib_ref->{subsystem_of}{$id_of_class})) {
my $subsystem = $attrib_ref->{subsystem_of}{$id_of_class};
if (!defined($m_ctx->get_ctx_of($id))) {
$m_ctx->get_ctx_of()->{$id}
= $subsystem->ctx($id_of_class, $id);
}
if ($subsystem->can('config_parse_inherit_hook')) {
$subsystem->config_parse_inherit_hook(
$m_ctx->get_ctx_of($id), $i_ctx,
);
}
}
}
if (!@{$m_ctx->get_steps()}) {
$m_ctx->set_steps([@{$i_m_ctx->get_steps()}]);
}
}
}
# Turns the context back into a config.
sub _unparse {
my ($attrib_ref, $m_ctx) = @_;
my %subsystem_of = map {
my $id = $m_ctx->get_ctx_of()->{$_}->get_id_of_class();
($id, $attrib_ref->{subsystem_of}->{$id});
} @{$m_ctx->get_steps()};
map {$_->as_string()} (
( map { FCM::Context::ConfigEntry->new({
label => 'step.class',
ns_list => [$_->get_id()],
value => $_->get_id_of_class(),
});
}
grep {$_->get_id() ne $_->get_id_of_class()}
values(%{$m_ctx->get_ctx_of()})
),
( map { my ($action_ref, $label) = @{$_};
my $value = $action_ref->($attrib_ref, $m_ctx);
defined($value)
? FCM::Context::ConfigEntry->new(
{label => $label, value => $value},
)
: ()
;
}
( [sub {$m_ctx->get_name()}, 'name' ],
[\&_unparse_use , 'use' ],
[\&_unparse_steps , 'steps'],
[sub {$m_ctx->get_dest()}, 'dest' ],
),
),
( map { my $id = $_;
$subsystem_of{$id}->config_unparse_class_prop($id);
}
sort keys(%subsystem_of)
),
( map { my $ctx = $m_ctx->get_ctx_of()->{$_};
my $id_of_class = $ctx->get_id_of_class();
$subsystem_of{$id_of_class}->config_unparse($ctx);
}
@{$m_ctx->get_steps()}
),
);
}
# Serializes a list of words.
sub _unparse_join {
join(q{ }, map {s{(["'\s])}{\\$1}xms; $_} grep {defined()} @_);
}
# The value of "steps" declaration from the context.
sub _unparse_steps {
my ($attrib_ref, $m_ctx) = @_;
if (!@{$m_ctx->get_steps()}) {
return;
}
_unparse_join(@{$m_ctx->get_steps()});
}
# The value of "use" declaration from the context.
sub _unparse_use {
my ($attrib_ref, $m_ctx) = @_;
if (!@{$m_ctx->get_inherit_ctx_list()}) {
return;
}
my @i_ctx_list = @{$m_ctx->get_inherit_ctx_list()};
_unparse_join(map {$_->get_dest()} @i_ctx_list);
}
#-------------------------------------------------------------------------------
1;
__END__
=head1 NAME
FCM::System::Make::Share::Config
=head1 SYNOPSIS
use FCM::System::Make::Share::Config;
my $instance = FCM::System::Make::Share::Config->new(\%attrib);
my $ok = $instance->parse($m_ctx, $entry_iter_ref);
my @entries = $instance->unparse($m_ctx);
=head1 DESCRIPTION
A helper class for (un)parsing make config entries into the make context.
=head1 METHODS
=over 4
=item $class->new(\%attrib)
Returns a new instance. The allowed elements for %attrib are:
=over 4
=item {shared_util_of}{dest}
A helper object for manipulating the destination in a make context. Expects an
instance of L<FCM::System::Make::Share::Dest|FCM::System::Make::Share::Dest>.
=back
=item $instance->parse($m_ctx, $entry_iter_ref)
Parses entries returned by the $entry_iter_ref iterator into the $m_ctx.
Throws a variety of L<FCM::System::Exception|FCM::System::Exception> if some
data in the configuration file is incorrectly set.
=item $instance->unparse($m_ctx)
Turns $m_ctx back into a list of configuration entries.
=back
=head1 COPYRIGHT
(C) Crown copyright Met Office. All rights reserved.
=cut
|