1*9780544fSAndrew Rist#************************************************************** 2*9780544fSAndrew Rist# 3*9780544fSAndrew Rist# Licensed to the Apache Software Foundation (ASF) under one 4*9780544fSAndrew Rist# or more contributor license agreements. See the NOTICE file 5*9780544fSAndrew Rist# distributed with this work for additional information 6*9780544fSAndrew Rist# regarding copyright ownership. The ASF licenses this file 7*9780544fSAndrew Rist# to you under the Apache License, Version 2.0 (the 8*9780544fSAndrew Rist# "License"); you may not use this file except in compliance 9*9780544fSAndrew Rist# with the License. You may obtain a copy of the License at 10*9780544fSAndrew Rist# 11*9780544fSAndrew Rist# http://www.apache.org/licenses/LICENSE-2.0 12*9780544fSAndrew Rist# 13*9780544fSAndrew Rist# Unless required by applicable law or agreed to in writing, 14*9780544fSAndrew Rist# software distributed under the License is distributed on an 15*9780544fSAndrew Rist# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*9780544fSAndrew Rist# KIND, either express or implied. See the License for the 17*9780544fSAndrew Rist# specific language governing permissions and limitations 18*9780544fSAndrew Rist# under the License. 19*9780544fSAndrew Rist# 20*9780544fSAndrew Rist#************************************************************** 21*9780544fSAndrew Rist 22*9780544fSAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweirpackage par2script::check; 25cdf0e10cSrcweir 26cdf0e10cSrcweiruse par2script::globals; 27cdf0e10cSrcweir 28cdf0e10cSrcweir################################ 29cdf0e10cSrcweir# Checks of the setup script 30cdf0e10cSrcweir################################ 31cdf0e10cSrcweir 32cdf0e10cSrcweir######################################################## 33cdf0e10cSrcweir# Checking if all defined directories are needed 34cdf0e10cSrcweir######################################################## 35cdf0e10cSrcweir 36cdf0e10cSrcweirsub check_needed_directories 37cdf0e10cSrcweir{ 38cdf0e10cSrcweir my $allfiles = $par2script::globals::definitions{'File'}; 39cdf0e10cSrcweir my $alldirs = $par2script::globals::definitions{'Directory'}; 40cdf0e10cSrcweir 41cdf0e10cSrcweir # checking if all defined directories are needed 42cdf0e10cSrcweir 43cdf0e10cSrcweir my $dir; 44cdf0e10cSrcweir foreach $dir ( keys %{$alldirs} ) 45cdf0e10cSrcweir { 46cdf0e10cSrcweir # I. directory has create flag 47cdf0e10cSrcweir if (( exists($alldirs->{$dir}->{'Styles'}) ) && ( $alldirs->{$dir}->{'Styles'} =~ /\bCREATE\b/ )) { next; } 48cdf0e10cSrcweir 49cdf0e10cSrcweir # II. there is at least one file in the directory 50cdf0e10cSrcweir my $fileinside = 0; 51cdf0e10cSrcweir my $file; 52cdf0e10cSrcweir foreach $file ( keys %{$allfiles} ) 53cdf0e10cSrcweir { 54cdf0e10cSrcweir if (( $allfiles->{$file}->{'Dir'} eq $dir ) || ( $allfiles->{$file}->{'NetDir'} eq $dir )) 55cdf0e10cSrcweir { 56cdf0e10cSrcweir $fileinside = 1; 57cdf0e10cSrcweir last; 58cdf0e10cSrcweir } 59cdf0e10cSrcweir } 60cdf0e10cSrcweir if ( $fileinside ) { next; } 61cdf0e10cSrcweir 62cdf0e10cSrcweir # III. the directory is parent for another directory 63cdf0e10cSrcweir my $isparent = 0; 64cdf0e10cSrcweir my $onedir; 65cdf0e10cSrcweir foreach $onedir ( keys %{$alldirs} ) 66cdf0e10cSrcweir { 67cdf0e10cSrcweir if ( $alldirs->{$onedir}->{'ParentID'} eq $dir ) 68cdf0e10cSrcweir { 69cdf0e10cSrcweir $isparent = 1; 70cdf0e10cSrcweir last; 71cdf0e10cSrcweir } 72cdf0e10cSrcweir } 73cdf0e10cSrcweir if ( $isparent ) { next; } 74cdf0e10cSrcweir 75cdf0e10cSrcweir # no condition is true -> directory definition is superfluous 76cdf0e10cSrcweir my $infoline = "\tINFO: Directory definition $dir is superfluous\n"; 77cdf0e10cSrcweir # print $infoline; 78cdf0e10cSrcweir push(@par2script::globals::logfileinfo, $infoline); 79cdf0e10cSrcweir } 80cdf0e10cSrcweir} 81cdf0e10cSrcweir 82cdf0e10cSrcweir################################################## 83cdf0e10cSrcweir# Checking if the directories in the item 84cdf0e10cSrcweir# definitions are defined. 85cdf0e10cSrcweir################################################## 86cdf0e10cSrcweir 87cdf0e10cSrcweirsub check_directories_in_item_definitions 88cdf0e10cSrcweir{ 89cdf0e10cSrcweir my $item; 90cdf0e10cSrcweir foreach $item ( @par2script::globals::items_with_directories ) 91cdf0e10cSrcweir { 92cdf0e10cSrcweir my $allitems = $par2script::globals::definitions{$item}; 93cdf0e10cSrcweir 94cdf0e10cSrcweir my $onegid; 95cdf0e10cSrcweir foreach $onegid ( keys %{$allitems} ) 96cdf0e10cSrcweir { 97cdf0e10cSrcweir if ( ! exists($allitems->{$onegid}->{'Dir'}) ) { die "\nERROR: No directory defined for item: $onegid!\n\n"; } 98cdf0e10cSrcweir my $dir = $allitems->{$onegid}->{'Dir'}; 99cdf0e10cSrcweir if (( $dir eq "PD_PROGDIR" ) || ( $dir =~ /PREDEFINED_/ )) { next; } 100cdf0e10cSrcweir 101cdf0e10cSrcweir # checking if this directoryid is defined 102cdf0e10cSrcweir if ( ! exists($par2script::globals::definitions{'Directory'}->{$dir}) ) 103cdf0e10cSrcweir { 104cdf0e10cSrcweir die "\nERROR: Directory $dir in item $onegid not defined!\n\n"; 105cdf0e10cSrcweir } 106cdf0e10cSrcweir } 107cdf0e10cSrcweir } 108cdf0e10cSrcweir} 109cdf0e10cSrcweir 110cdf0e10cSrcweir######################################################## 111cdf0e10cSrcweir# Checking for all Items, that know their modules, 112cdf0e10cSrcweir# whether these modules exist. 113cdf0e10cSrcweir######################################################## 114cdf0e10cSrcweir 115cdf0e10cSrcweirsub check_module_existence 116cdf0e10cSrcweir{ 117cdf0e10cSrcweir my $item; 118cdf0e10cSrcweir foreach $item ( @par2script::globals::items_with_moduleid ) 119cdf0e10cSrcweir { 120cdf0e10cSrcweir my $allitems = $par2script::globals::definitions{$item}; 121cdf0e10cSrcweir 122cdf0e10cSrcweir my $onegid; 123cdf0e10cSrcweir foreach $onegid ( keys %{$allitems} ) 124cdf0e10cSrcweir { 125cdf0e10cSrcweir if ( ! exists($allitems->{$onegid}->{'ModuleID'}) ) { die "\nERROR: No ModuleID defined for item: $onegid!\n\n"; } 126cdf0e10cSrcweir my $moduleid = $allitems->{$onegid}->{'ModuleID'}; 127cdf0e10cSrcweir 128cdf0e10cSrcweir # checking if this directoryid is defined 129cdf0e10cSrcweir if ( ! exists($par2script::globals::definitions{'Module'}->{$moduleid}) ) 130cdf0e10cSrcweir { 131cdf0e10cSrcweir die "\nERROR: ModuleID $moduleid in item $onegid not defined!\n\n"; 132cdf0e10cSrcweir } 133cdf0e10cSrcweir } 134cdf0e10cSrcweir } 135cdf0e10cSrcweir} 136cdf0e10cSrcweir 137cdf0e10cSrcweir######################################################## 138cdf0e10cSrcweir# Every script has to contain exactly one root module. 139cdf0e10cSrcweir# This module has no ParentID or an empty ParentID. 140cdf0e10cSrcweir######################################################## 141cdf0e10cSrcweir 142cdf0e10cSrcweirsub check_rootmodule 143cdf0e10cSrcweir{ 144cdf0e10cSrcweir my $rootgid = ""; 145cdf0e10cSrcweir my $foundroot = 0; 146cdf0e10cSrcweir 147cdf0e10cSrcweir my $allmodules = $par2script::globals::definitions{'Module'}; 148cdf0e10cSrcweir 149cdf0e10cSrcweir my $modulegid = ""; 150cdf0e10cSrcweir foreach $modulegid (keys %{$allmodules} ) 151cdf0e10cSrcweir { 152cdf0e10cSrcweir if (( ! exists($allmodules->{$modulegid}->{'ParentID'}) ) || ( $allmodules->{$modulegid}->{'ParentID'} eq "" )) 153cdf0e10cSrcweir { 154cdf0e10cSrcweir if ( $foundroot ) 155cdf0e10cSrcweir { 156cdf0e10cSrcweir die "\nERROR: More than one Root module. Only one module without ParentID or with empty ParentID allowed ($rootgid and $modulegid).\n"; 157cdf0e10cSrcweir } 158cdf0e10cSrcweir $rootgid = $modulegid; 159cdf0e10cSrcweir $foundroot = 1; 160cdf0e10cSrcweir } 161cdf0e10cSrcweir } 162cdf0e10cSrcweir 163cdf0e10cSrcweir if ( ! $foundroot ) 164cdf0e10cSrcweir { 165cdf0e10cSrcweir die "\nERROR: Could not find Root module. Did not find module without ParentID or with empty ParentID.\n"; 166cdf0e10cSrcweir } 167cdf0e10cSrcweir 168cdf0e10cSrcweir print " $rootgid\n"; 169cdf0e10cSrcweir 170cdf0e10cSrcweir} 171cdf0e10cSrcweir 172cdf0e10cSrcweir######################################################## 173cdf0e10cSrcweir# File, Shortcut, Directory, Unixlink must not 174cdf0e10cSrcweir# contain a ModuleID 175cdf0e10cSrcweir######################################################## 176cdf0e10cSrcweir 177cdf0e10cSrcweirsub check_moduleid_at_items 178cdf0e10cSrcweir{ 179cdf0e10cSrcweir my $item; 180cdf0e10cSrcweir foreach $item ( @par2script::globals::items_without_moduleid ) 181cdf0e10cSrcweir { 182cdf0e10cSrcweir my $allitems = $par2script::globals::definitions{$item}; 183cdf0e10cSrcweir 184cdf0e10cSrcweir my $onegid; 185cdf0e10cSrcweir foreach $onegid ( keys %{$allitems} ) 186cdf0e10cSrcweir { 187cdf0e10cSrcweir if ( exists($allitems->{$onegid}->{'ModuleID'}) ) 188cdf0e10cSrcweir { 189cdf0e10cSrcweir die "\nERROR: ModuleID assigned to $onegid! No module assignment to $item!\n\n"; 190cdf0e10cSrcweir } 191cdf0e10cSrcweir } 192cdf0e10cSrcweir } 193cdf0e10cSrcweir} 194cdf0e10cSrcweir 195cdf0e10cSrcweir######################################################## 196cdf0e10cSrcweir# Controlling existence of multi assignments 197cdf0e10cSrcweir######################################################## 198cdf0e10cSrcweir 199cdf0e10cSrcweirsub check_multiple_assignments 200cdf0e10cSrcweir{ 201cdf0e10cSrcweir my @multiassignments = (); 202cdf0e10cSrcweir my $error; 203cdf0e10cSrcweir 204cdf0e10cSrcweir my $topitem; 205cdf0e10cSrcweir foreach $topitem ( keys %par2script::globals::assignedgids ) 206cdf0e10cSrcweir { 207cdf0e10cSrcweir my $item; 208cdf0e10cSrcweir foreach $item ( keys %{$par2script::globals::assignedgids{$topitem}} ) 209cdf0e10cSrcweir { 210cdf0e10cSrcweir if ( $par2script::globals::assignedgids{$topitem}->{$item} > 1 ) 211cdf0e10cSrcweir { 212cdf0e10cSrcweir $error = 1; 213cdf0e10cSrcweir my $string = "\tGID: $item Assignments: $par2script::globals::assignedgids{$topitem}->{$item}"; 214cdf0e10cSrcweir push(@multiassignments, $string); 215cdf0e10cSrcweir } 216cdf0e10cSrcweir } 217cdf0e10cSrcweir } 218cdf0e10cSrcweir 219cdf0e10cSrcweir if ( $error ) { par2script::exiter::multiassignmenterror(\@multiassignments); } 220cdf0e10cSrcweir} 221cdf0e10cSrcweir 222cdf0e10cSrcweir######################################################## 223cdf0e10cSrcweir# Check, if a defined directory has a flag CREATE 224cdf0e10cSrcweir######################################################## 225cdf0e10cSrcweir 226cdf0e10cSrcweirsub contains_create_flag 227cdf0e10cSrcweir{ 228cdf0e10cSrcweir my ($gid) = @_; 229cdf0e10cSrcweir 230cdf0e10cSrcweir my $createflag = 0; 231cdf0e10cSrcweir 232cdf0e10cSrcweir if (( exists($par2script::globals::definitions{'Directory'}->{$gid}->{'Styles'}) ) && 233cdf0e10cSrcweir ( $par2script::globals::definitions{'Directory'}->{$gid}->{'Styles'} =~ /\bCREATE\b/ )) 234cdf0e10cSrcweir { 235cdf0e10cSrcweir $createflag = 1; 236cdf0e10cSrcweir } 237cdf0e10cSrcweir 238cdf0e10cSrcweir return $createflag; 239cdf0e10cSrcweir} 240cdf0e10cSrcweir 241cdf0e10cSrcweir######################################################## 242cdf0e10cSrcweir# Controlling existence of definitions without 243cdf0e10cSrcweir# any assignment 244cdf0e10cSrcweir######################################################## 245cdf0e10cSrcweir 246cdf0e10cSrcweirsub check_missing_assignments 247cdf0e10cSrcweir{ 248cdf0e10cSrcweir # If defined gids for "File", "Directory" or "Unixlink" are not assigned, 249cdf0e10cSrcweir # this causes an error. 250cdf0e10cSrcweir # Directories only have to be assigned, if they have the flag "CREATE". 251cdf0e10cSrcweir 252cdf0e10cSrcweir my @missingassignments = (); 253cdf0e10cSrcweir $error = 0; 254cdf0e10cSrcweir 255cdf0e10cSrcweir my $item; 256cdf0e10cSrcweir foreach $item ( @par2script::globals::items_assigned_at_modules ) 257cdf0e10cSrcweir { 258cdf0e10cSrcweir my $assignedgids = $par2script::globals::assignedgids{$item}; 259cdf0e10cSrcweir my $definedgids = $par2script::globals::definitions{$item}; 260cdf0e10cSrcweir 261cdf0e10cSrcweir my $gid; 262cdf0e10cSrcweir foreach $gid ( keys %{$definedgids} ) 263cdf0e10cSrcweir { 264cdf0e10cSrcweir if ( $item eq "Directory" ) { if ( ! contains_create_flag($gid) ) { next; } } 265cdf0e10cSrcweir 266cdf0e10cSrcweir if ( ! exists( $assignedgids->{$gid} )) 267cdf0e10cSrcweir { 268cdf0e10cSrcweir $error = 1; 269cdf0e10cSrcweir push(@missingassignments, $gid); 270cdf0e10cSrcweir } 271cdf0e10cSrcweir } 272cdf0e10cSrcweir } 273cdf0e10cSrcweir 274cdf0e10cSrcweir if ( $error ) { par2script::exiter::missingassignmenterror(\@missingassignments); } 275cdf0e10cSrcweir} 276cdf0e10cSrcweir 277cdf0e10cSrcweir############################################################# 278cdf0e10cSrcweir# Controlling if for all shortcuts with file assignment 279cdf0e10cSrcweir# the file is defined. And for all shortcuts with 280cdf0e10cSrcweir# shortcut assignment the shortcut has to be defined. 281cdf0e10cSrcweir############################################################# 282cdf0e10cSrcweir 283cdf0e10cSrcweirsub check_shortcut_assignments 284cdf0e10cSrcweir{ 285cdf0e10cSrcweir my $allshortcuts = $par2script::globals::definitions{'Shortcut'}; 286cdf0e10cSrcweir my $allfiles = $par2script::globals::definitions{'File'}; 287cdf0e10cSrcweir 288cdf0e10cSrcweir my $shortcut; 289cdf0e10cSrcweir foreach $shortcut ( keys %{$allshortcuts} ) 290cdf0e10cSrcweir { 291cdf0e10cSrcweir if (( exists($allshortcuts->{$shortcut}->{'FileID'}) ) && 292cdf0e10cSrcweir ( ! exists($allfiles->{$allshortcuts->{$shortcut}->{'FileID'}}) )) 293cdf0e10cSrcweir { 294cdf0e10cSrcweir # die "\nERROR: FileID $allshortcuts->{$shortcut}->{'FileID'} has no definition at shortcut $shortcut !\n"; 295cdf0e10cSrcweir print "\n\tWARNING: FileID $allshortcuts->{$shortcut}->{'FileID'} has no definition at shortcut $shortcut !\n"; 296cdf0e10cSrcweir } 297cdf0e10cSrcweir 298cdf0e10cSrcweir if (( exists($allshortcuts->{$shortcut}->{'ShortcutID'}) ) && 299cdf0e10cSrcweir ( ! exists($allshortcuts->{$allshortcuts->{$shortcut}->{'ShortcutID'}}) )) 300cdf0e10cSrcweir { 301cdf0e10cSrcweir die "\nERROR: ShortcutID $allshortcuts->{$shortcut}->{'ShortcutID'} has no definition at shortcut $shortcut !\n"; 302cdf0e10cSrcweir } 303cdf0e10cSrcweir 304cdf0e10cSrcweir if (( ! exists($allshortcuts->{$shortcut}->{'ShortcutID'}) ) && 305cdf0e10cSrcweir ( ! exists($allshortcuts->{$shortcut}->{'FileID'}) )) 306cdf0e10cSrcweir { 307cdf0e10cSrcweir die "\nERROR: Shortcut requires assignment to \"ShortcutID\" or \"FileID\". Missing at shortcut $shortcut !\n"; 308cdf0e10cSrcweir } 309cdf0e10cSrcweir } 310cdf0e10cSrcweir} 311cdf0e10cSrcweir 312cdf0e10cSrcweir############################################################# 313cdf0e10cSrcweir# Controlling if for Modules and Directories, the parents 314cdf0e10cSrcweir# are defined. If not, this can lead to a problem during 315cdf0e10cSrcweir# script creation, because only recursively added 316cdf0e10cSrcweir# Modules or Directories are added to the script. 317cdf0e10cSrcweir############################################################# 318cdf0e10cSrcweir 319cdf0e10cSrcweirsub check_missing_parents 320cdf0e10cSrcweir{ 321cdf0e10cSrcweir my @parentitems = ("Module", "Directory"); 322cdf0e10cSrcweir my %rootparents = ("PREDEFINED_PROGDIR" => "1"); 323cdf0e10cSrcweir 324cdf0e10cSrcweir my $oneitem; 325cdf0e10cSrcweir foreach $oneitem ( @parentitems ) 326cdf0e10cSrcweir { 327cdf0e10cSrcweir my $alldefinitions = $par2script::globals::definitions{$oneitem}; 328cdf0e10cSrcweir 329cdf0e10cSrcweir my $onegid; 330cdf0e10cSrcweir foreach $onegid ( keys %{$alldefinitions} ) 331cdf0e10cSrcweir { 332cdf0e10cSrcweir # If there is a ParentID used, it must be defined 333cdf0e10cSrcweir if (( exists($alldefinitions->{$onegid}->{'ParentID'}) ) && 334cdf0e10cSrcweir ( ! exists($alldefinitions->{$alldefinitions->{$onegid}->{'ParentID'}}) ) && 335cdf0e10cSrcweir ( ! exists($rootparents{$alldefinitions->{$onegid}->{'ParentID'}}) )) 336cdf0e10cSrcweir { 337cdf0e10cSrcweir die "\nERROR: Parent \"$alldefinitions->{$onegid}->{'ParentID'}\" at $oneitem \"$onegid\" is not defined!\n"; 338cdf0e10cSrcweir } 339cdf0e10cSrcweir } 340cdf0e10cSrcweir } 341cdf0e10cSrcweir} 342cdf0e10cSrcweir 343cdf0e10cSrcweir1; 344