solenv/bin/modules/par2script/check.pm

   1 #*************************************************************************
   2 #
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # Copyright 2008 by Sun Microsystems, Inc.
   6 #
   7 # OpenOffice.org - a multi-platform office productivity suite
   8 #
   9 # $RCSfile: check.pm,v $
  10 #
  11 # $Revision: 1.8 $
  12 #
  13 # This file is part of OpenOffice.org.
  14 #
  15 # OpenOffice.org is free software: you can redistribute it and/or modify
  16 # it under the terms of the GNU Lesser General Public License version 3
  17 # only, as published by the Free Software Foundation.
  18 #
  19 # OpenOffice.org is distributed in the hope that it will be useful,
  20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 # GNU Lesser General Public License version 3 for more details
  23 # (a copy is included in the LICENSE file that accompanied this code).
  24 #
  25 # You should have received a copy of the GNU Lesser General Public License
  26 # version 3 along with OpenOffice.org.  If not, see
  27 # <http://www.openoffice.org/license.html>
  28 # for a copy of the LGPLv3 License.
  29 #
  30 #*************************************************************************
  31
  32 package par2script::check;
  33
  34 use par2script::globals;
  35
  36 ################################
  37 # Checks of the setup script
  38 ################################
  39
  40 ########################################################
  41 # Checking if all defined directories are needed
  42 ########################################################
  43
  44 sub check_needed_directories
  45 {
  46     my $allfiles = $par2script::globals::definitions{'File'};
  47     my $alldirs = $par2script::globals::definitions{'Directory'};
  48
  49     # checking if all defined directories are needed
  50
  51     my $dir;
  52     foreach $dir ( keys %{$alldirs} )
  53     {
  54         # I. directory has create flag
  55         if (( exists($alldirs->{$dir}->{'Styles'}) ) && ( $alldirs->{$dir}->{'Styles'} =~ /\bCREATE\b/ )) { next; }
  56
  57         # II. there is at least one file in the directory
  58         my $fileinside = 0;
  59         my $file;
  60         foreach $file ( keys %{$allfiles} )
  61         {
  62             if (( $allfiles->{$file}->{'Dir'} eq $dir ) || ( $allfiles->{$file}->{'NetDir'} eq $dir ))
  63             {
  64                 $fileinside = 1;
  65                 last;
  66             }
  67         }
  68         if ( $fileinside ) { next; }
  69
  70         # III. the directory is parent for another directory
  71         my $isparent = 0;
  72         my $onedir;
  73         foreach $onedir ( keys %{$alldirs} )
  74         {
  75             if ( $alldirs->{$onedir}->{'ParentID'} eq $dir )
  76             {
  77                 $isparent = 1;
  78                 last;
  79             }
  80         }
  81         if ( $isparent ) { next; }
  82
  83         # no condition is true -> directory definition is superfluous
  84         my $infoline = "\tINFO: Directory definition $dir is superfluous\n";
  85         # print $infoline;
  86         push(@par2script::globals::logfileinfo, $infoline);
  87     }
  88 }
  89
  90 ##################################################
  91 # Checking if the directories in the item
  92 # definitions are defined.
  93 ##################################################
  94
  95 sub check_directories_in_item_definitions
  96 {
  97     my $item;
  98     foreach $item ( @par2script::globals::items_with_directories )
  99     {
 100         my $allitems = $par2script::globals::definitions{$item};
 101
 102         my $onegid;
 103         foreach $onegid ( keys %{$allitems} )
 104         {
 105             if ( ! exists($allitems->{$onegid}->{'Dir'}) ) { die "\nERROR: No directory defined for item: $onegid!\n\n"; }
 106             my $dir = $allitems->{$onegid}->{'Dir'};
 107             if (( $dir eq "PD_PROGDIR" ) || ( $dir =~ /PREDEFINED_/ )) { next; }
 108
 109             # checking if this directoryid is defined
 110             if ( ! exists($par2script::globals::definitions{'Directory'}->{$dir}) )
 111             {
 112                 die "\nERROR: Directory $dir in item $onegid not defined!\n\n";
 113             }
 114         }
 115     }
 116 }
 117
 118 ########################################################
 119 # Checking for all Items, that know their modules,
 120 # whether these modules exist.
 121 ########################################################
 122
 123 sub check_module_existence
 124 {
 125     my $item;
 126     foreach $item ( @par2script::globals::items_with_moduleid )
 127     {
 128         my $allitems = $par2script::globals::definitions{$item};
 129
 130         my $onegid;
 131         foreach $onegid ( keys %{$allitems} )
 132         {
 133             if ( ! exists($allitems->{$onegid}->{'ModuleID'}) ) { die "\nERROR: No ModuleID defined for item: $onegid!\n\n"; }
 134             my $moduleid = $allitems->{$onegid}->{'ModuleID'};
 135
 136             # checking if this directoryid is defined
 137             if ( ! exists($par2script::globals::definitions{'Module'}->{$moduleid}) )
 138             {
 139                 die "\nERROR: ModuleID $moduleid in item $onegid not defined!\n\n";
 140             }
 141         }
 142     }
 143 }
 144
 145 ########################################################
 146 # If the StarRegistry is not defined in the script,
 147 # it has to be removed from the file definition.
 148 ########################################################
 149
 150 sub check_registry_at_files
 151 {
 152     my %starregistrygid = ();
 153
 154     my $item;
 155     foreach $item ( keys %{$par2script::globals::definitions{'File'}} )
 156     {
 157         if (( exists($par2script::globals::definitions{'File'}->{$item}->{'Styles'}) ) &&
 158             ( $par2script::globals::definitions{'File'}->{$item}->{'Styles'} =~ /\bSTARREGISTRY\b/ ))
 159         {
 160             $starregistrygid{$item} = 1;
 161         }
 162     }
 163
 164     foreach $item ( keys %{$par2script::globals::definitions{'File'}} )
 165     {
 166         if ( exists($par2script::globals::definitions{'File'}->{$item}->{'RegistryID'}) )
 167         {
 168             my $registryid = $par2script::globals::definitions{'File'}->{$item}->{'RegistryID'};
 169             if ( ! exists($starregistrygid{$registryid}) )
 170             {
 171                 die "\nERROR: No definition found for $registryid at file $item\n\n";
 172             }
 173
 174             # if ( ! ( $par2script::globals::definitions{'File'}->{$item}->{'Styles'} =~ /\bUNO_COMPONENT\b/ ))
 175             # {
 176             #   die "\nERROR: Flag UNO_COMPONENT required for file $item\n\n";
 177             # }
 178             # -> also possible, that Regmergefile is defined (does not require flag UNO_COMPONENT)
 179         }
 180
 181         # and also vice versa
 182
 183         if (( exists($par2script::globals::definitions{'File'}->{$item}->{'Styles'}) ) &&
 184             ( $par2script::globals::definitions{'File'}->{$item}->{'Styles'} =~ /\bUNO_COMPONENT\b/ ))
 185         {
 186             if ( ! exists($par2script::globals::definitions{'File'}->{$item}->{'RegistryID'}) )
 187             {
 188                 die "\nERROR: Flag UNO_COMPONENT defined, but no file as \"RegistryID\" at file $item !\n\n";
 189             }
 190         }
 191     }
 192 }
 193
 194 ########################################################
 195 # Every script has to contain exactly one root module.
 196 # This module has no ParentID or an empty ParentID.
 197 ########################################################
 198
 199 sub check_rootmodule
 200 {
 201     my $rootgid = "";
 202     my $foundroot = 0;
 203
 204     my $allmodules = $par2script::globals::definitions{'Module'};
 205
 206     my $modulegid = "";
 207     foreach $modulegid (keys %{$allmodules} )
 208     {
 209         if (( ! exists($allmodules->{$modulegid}->{'ParentID'}) ) || ( $allmodules->{$modulegid}->{'ParentID'} eq "" ))
 210         {
 211             if ( $foundroot )
 212             {
 213                 die "\nERROR: More than one Root module. Only one module without ParentID or with empty ParentID allowed ($rootgid and $modulegid).\n";
 214             }
 215             $rootgid = $modulegid;
 216             $foundroot = 1;
 217         }
 218     }
 219
 220     if ( ! $foundroot )
 221     {
 222         die "\nERROR: Could not find Root module. Did not find module without ParentID or with empty ParentID.\n";
 223     }
 224
 225     print " $rootgid\n";
 226
 227 }
 228
 229 ########################################################
 230 # File, Shortcut, Directory, Unixlink must not
 231 # contain a ModuleID
 232 ########################################################
 233
 234 sub check_moduleid_at_items
 235 {
 236     my $item;
 237     foreach $item ( @par2script::globals::items_without_moduleid )
 238     {
 239         my $allitems = $par2script::globals::definitions{$item};
 240
 241         my $onegid;
 242         foreach $onegid ( keys %{$allitems} )
 243         {
 244             if ( exists($allitems->{$onegid}->{'ModuleID'}) )
 245             {
 246                 die "\nERROR: ModuleID assigned to $onegid! No module assignment to $item!\n\n";
 247             }
 248         }
 249     }
 250 }
 251
 252 ########################################################
 253 # Controlling existence of multi assignments
 254 ########################################################
 255
 256 sub check_multiple_assignments
 257 {
 258     my @multiassignments = ();
 259     my $error;
 260
 261     my $topitem;
 262     foreach $topitem ( keys %par2script::globals::assignedgids )
 263     {
 264         my $item;
 265         foreach $item ( keys %{$par2script::globals::assignedgids{$topitem}} )
 266         {
 267             if ( $par2script::globals::assignedgids{$topitem}->{$item} > 1 )
 268             {
 269                 $error = 1;
 270                 my $string = "\tGID: $item Assignments: $par2script::globals::assignedgids{$topitem}->{$item}";
 271                 push(@multiassignments, $string);
 272             }
 273         }
 274     }
 275
 276     if ( $error ) { par2script::exiter::multiassignmenterror(\@multiassignments); }
 277 }
 278
 279 ########################################################
 280 # Check, if a defined directory has a flag CREATE
 281 ########################################################
 282
 283 sub contains_create_flag
 284 {
 285     my ($gid) = @_;
 286
 287     my $createflag = 0;
 288
 289     if (( exists($par2script::globals::definitions{'Directory'}->{$gid}->{'Styles'}) ) &&
 290         ( $par2script::globals::definitions{'Directory'}->{$gid}->{'Styles'} =~ /\bCREATE\b/ ))
 291     {
 292         $createflag = 1;
 293     }
 294
 295     return $createflag;
 296 }
 297
 298 ########################################################
 299 # Controlling existence of definitions without
 300 # any assignment
 301 ########################################################
 302
 303 sub check_missing_assignments
 304 {
 305     # If defined gids for "File", "Directory" or "Unixlink" are not assigned,
 306     # this causes an error.
 307     # Directories only have to be assigned, if they have the flag "CREATE".
 308
 309     my @missingassignments = ();
 310     $error = 0;
 311
 312     my $item;
 313     foreach $item ( @par2script::globals::items_assigned_at_modules )
 314     {
 315         my $assignedgids = $par2script::globals::assignedgids{$item};
 316         my $definedgids = $par2script::globals::definitions{$item};
 317
 318         my $gid;
 319         foreach $gid ( keys %{$definedgids} )
 320         {
 321             if ( $item eq "Directory" ) { if ( ! contains_create_flag($gid) ) { next; } }
 322
 323             if ( ! exists( $assignedgids->{$gid} ))
 324             {
 325                 $error = 1;
 326                 push(@missingassignments, $gid);
 327             }
 328         }
 329     }
 330
 331     if ( $error ) { par2script::exiter::missingassignmenterror(\@missingassignments); }
 332 }
 333
 334 #############################################################
 335 # Controlling if for all shortcuts with file assignment
 336 # the file is defined. And for all shortcuts with
 337 # shortcut assignment the shortcut has to be defined.
 338 #############################################################
 339
 340 sub check_shortcut_assignments
 341 {
 342     my $allshortcuts = $par2script::globals::definitions{'Shortcut'};
 343     my $allfiles = $par2script::globals::definitions{'File'};
 344
 345     my $shortcut;
 346     foreach $shortcut ( keys %{$allshortcuts} )
 347     {
 348         if (( exists($allshortcuts->{$shortcut}->{'FileID'}) ) &&
 349             ( ! exists($allfiles->{$allshortcuts->{$shortcut}->{'FileID'}}) ))
 350         {
 351             # die "\nERROR: FileID $allshortcuts->{$shortcut}->{'FileID'} has no definition at shortcut $shortcut !\n";
 352             print "\n\tWARNING: FileID $allshortcuts->{$shortcut}->{'FileID'} has no definition at shortcut $shortcut !\n";
 353         }
 354
 355         if (( exists($allshortcuts->{$shortcut}->{'ShortcutID'}) ) &&
 356             ( ! exists($allshortcuts->{$allshortcuts->{$shortcut}->{'ShortcutID'}}) ))
 357         {
 358             die "\nERROR: ShortcutID $allshortcuts->{$shortcut}->{'ShortcutID'} has no definition at shortcut $shortcut !\n";
 359         }
 360
 361         if (( ! exists($allshortcuts->{$shortcut}->{'ShortcutID'}) ) &&
 362             ( ! exists($allshortcuts->{$shortcut}->{'FileID'}) ))
 363         {
 364             die "\nERROR: Shortcut requires assignment to \"ShortcutID\" or \"FileID\". Missing at shortcut $shortcut !\n";
 365         }
 366     }
 367 }
 368
 369 #############################################################
 370 # Controlling if for Modules and Directories, the parents
 371 # are defined. If not, this can lead to a problem during
 372 # script creation, because only recursively added
 373 # Modules or Directories are added to the script.
 374 #############################################################
 375
 376 sub check_missing_parents
 377 {
 378     my @parentitems = ("Module", "Directory");
 379     my %rootparents = ("PREDEFINED_PROGDIR" => "1");
 380
 381     my $oneitem;
 382     foreach $oneitem ( @parentitems )
 383     {
 384         my $alldefinitions = $par2script::globals::definitions{$oneitem};
 385
 386         my $onegid;
 387         foreach $onegid ( keys %{$alldefinitions} )
 388         {
 389             # If there is a ParentID used, it must be defined
 390             if (( exists($alldefinitions->{$onegid}->{'ParentID'}) ) &&
 391                 ( ! exists($alldefinitions->{$alldefinitions->{$onegid}->{'ParentID'}}) ) &&
 392                 ( ! exists($rootparents{$alldefinitions->{$onegid}->{'ParentID'}}) ))
 393             {
 394                 die "\nERROR: Parent \"$alldefinitions->{$onegid}->{'ParentID'}\" at $oneitem \"$onegid\" is not defined!\n";
 395             }
 396         }
 397     }
 398 }
 399
 400 1;