solenv/bin/modules/installer/converter.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: converter.pm,v $
  10 #
  11 # $Revision: 1.18 $
  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 installer::converter;
  33
  34 use installer::globals;
  35
  36 #############################
  37 # Converter
  38 #############################
  39
  40 sub convert_array_to_hash
  41 {
  42     my ($arrayref) = @_;
  43
  44     my %newhash = ();
  45
  46     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
  47     {
  48         my $line = ${$arrayref}[$i];
  49
  50         if ( $line =~ /^\s*([\w-]+?)\s+(.*?)\s*$/ )
  51         {
  52             my $key = $1;
  53             my $value = $2;
  54             $newhash{$key} = $value;
  55         }
  56     }
  57
  58     return \%newhash;
  59 }
  60
  61 sub convert_hash_into_array
  62 {
  63     my ($hashref) = @_;
  64
  65     my @array = ();
  66     my $key;
  67
  68     foreach $key (keys %{$hashref})
  69     {
  70         my $value = $hashref->{$key};
  71         my $input = "$key = $value\n";
  72         push(@array ,$input);
  73     }
  74
  75     return \@array
  76 }
  77
  78 #############################################################################
  79 # Converting a string list with separator $listseparator
  80 # into an array
  81 #############################################################################
  82
  83 sub convert_stringlist_into_array_without_linebreak_and_quotes
  84 {
  85     my ( $includestringref, $listseparator ) = @_;
  86
  87     my @newarray = ();
  88     my $first;
  89     my $last = ${$includestringref};
  90
  91     while ( $last =~ /^\s*(.+?)\Q$listseparator\E(.+)\s*$/)     # "$" for minimal matching
  92     {
  93         $first = $1;
  94         $last = $2;
  95         $first =~ s/\"//g;
  96         push(@newarray, $first);
  97     }
  98
  99     $last =~ s/\"//g;
 100     push(@newarray, $last);
 101
 102     return \@newarray;
 103 }
 104
 105 #############################################################################
 106 # Converting a string list with separator $listseparator
 107 # into an array
 108 #############################################################################
 109
 110 sub convert_stringlist_into_array
 111 {
 112     my ( $includestringref, $listseparator ) = @_;
 113
 114     my @newarray = ();
 115     my $first;
 116     my $last = ${$includestringref};
 117
 118     while ( $last =~ /^\s*(.+?)\Q$listseparator\E(.+)\s*$/)     # "$" for minimal matching
 119     {
 120         $first = $1;
 121         $last = $2;
 122         # Problem with two directly following listseparators. For example a path with two ";;" directly behind each other
 123         $first =~ s/^$listseparator//;
 124         push(@newarray, "$first\n");
 125     }
 126
 127     push(@newarray, "$last\n");
 128
 129     return \@newarray;
 130 }
 131
 132 #############################################################################
 133 # Converting a string list with separator $listseparator
 134 # into an array
 135 #############################################################################
 136
 137 sub convert_stringlist_into_array_without_newline
 138 {
 139     my ( $includestringref, $listseparator ) = @_;
 140
 141     my @newarray = ();
 142     my $first;
 143     my $last = ${$includestringref};
 144
 145     while ( $last =~ /^\s*(.+?)\Q$listseparator\E(.+)\s*$/)     # "$" for minimal matching
 146     {
 147         $first = $1;
 148         $last = $2;
 149         push(@newarray, "$first");
 150     }
 151
 152     push(@newarray, "$last");
 153
 154     return \@newarray;
 155 }
 156
 157 #############################################################################
 158 # Converting a string list with separator $listseparator
 159 # into a hash with values 1.
 160 #############################################################################
 161
 162 sub convert_stringlist_into_hash
 163 {
 164     my ( $includestringref, $listseparator ) = @_;
 165
 166     my %newhash = ();
 167     my $first;
 168     my $last = ${$includestringref};
 169
 170     while ( $last =~ /^\s*(.+?)\Q$listseparator\E(.+)\s*$/)     # "$" for minimal matching
 171     {
 172         $first = $1;
 173         $last = $2;
 174         $newhash{$first} = 1;
 175     }
 176
 177     $newhash{$last} = 1;
 178
 179     return \%newhash;
 180 }
 181
 182 #############################################################################
 183 # Converting a string list with separator $listseparator
 184 # into an array
 185 #############################################################################
 186
 187 sub convert_whitespace_stringlist_into_array
 188 {
 189     my ( $includestringref ) = @_;
 190
 191     my @newarray = ();
 192     my $first;
 193     my $last = ${$includestringref};
 194
 195     while ( $last =~ /^\s*(\S+?)\s+(\S+)\s*$/)  # "$" for minimal matching
 196     {
 197         $first = $1;
 198         $last = $2;
 199         push(@newarray, "$first\n");
 200     }
 201
 202     push(@newarray, "$last\n");
 203
 204     return \@newarray;
 205 }
 206
 207 #############################################################################
 208 # Converting an array into a comma separated string
 209 #############################################################################
 210
 211 sub convert_array_to_comma_separated_string
 212 {
 213     my ( $arrayref ) = @_;
 214
 215     my $newstring = "";
 216
 217     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 218     {
 219         my $arrayentry = ${$arrayref}[$i];
 220         $arrayentry =~ s/\s*$//;
 221         $newstring = $newstring . $arrayentry . ",";
 222     }
 223
 224     $newstring =~ s/\,\s*$//;
 225
 226     return $newstring;
 227 }
 228
 229 #############################################################################
 230 # Converting an array into a space separated string
 231 #############################################################################
 232
 233 sub convert_array_to_space_separated_string
 234 {
 235     my ( $arrayref ) = @_;
 236
 237     my $newstring = "";
 238
 239     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 240     {
 241         my $arrayentry = ${$arrayref}[$i];
 242         $arrayentry =~ s/\s*$//;
 243         $newstring = $newstring . $arrayentry . " ";
 244     }
 245
 246     $newstring =~ s/\s*$//;
 247
 248     return $newstring;
 249 }
 250
 251 #############################################################################
 252 # The file name contains for some files "/". If this programs runs on
 253 # a windows platform, this has to be converted to "\".
 254 #############################################################################
 255
 256 sub convert_slash_to_backslash
 257 {
 258     my ($filesarrayref) = @_;
 259
 260     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
 261     {
 262         my $onefile = ${$filesarrayref}[$i];
 263         if ( $onefile->{'Name'} ) { $onefile->{'Name'} =~ s/\//\\/g; }
 264     }
 265 }
 266
 267 ############################################################################
 268 # Creating a copy of an existing file object
 269 # No converter
 270 ############################################################################
 271
 272 sub copy_item_object
 273 {
 274     my ($olditemhashref, $newitemhashref) = @_;
 275
 276     foreach $key (keys %{$olditemhashref})
 277     {
 278         my $value = $olditemhashref->{$key};
 279         $newitemhashref->{$key} = $value;
 280     }
 281 }
 282
 283 #################################################################
 284 # Windows pathes must not contain the following structure:
 285 # c:\dirA\dirB\..\dirC
 286 # This has to be exchanged to
 287 # c:\dirA\dirC
 288 #################################################################
 289
 290 sub make_path_conform
 291 {
 292     my ( $path ) = @_;
 293
 294     my $oldpath = $path;
 295
 296     while ( $path =~ /(^.*)(\Q$installer::globals::separator\E.*?[^\.])(\Q$installer::globals::separator\E\.\.)(\Q$installer::globals::separator\E.*$)/ )
 297     {
 298         my $part1 = $1;
 299         my $part2 = $4;
 300
 301         # $2 must not end with a "." ! Problem with "..\.."
 302
 303         $path = $part1 . $part2;
 304     }
 305
 306     return $path;
 307 }
 308
 309 #################################################################
 310 # Copying an item collector
 311 # A reference to an array consisting of references to hashes.
 312 #################################################################
 313
 314 sub copy_collector
 315 {
 316     my ( $oldcollector ) = @_;
 317
 318     my @newcollector = ();
 319
 320     for ( my $i = 0; $i <= $#{$oldcollector}; $i++ )
 321     {
 322         my %newhash = ();
 323         my $key;
 324
 325         foreach $key (keys %{${$oldcollector}[$i]})
 326         {
 327             $newhash{$key} = ${$oldcollector}[$i]->{$key};
 328         }
 329
 330         push(@newcollector, \%newhash);
 331     }
 332
 333     return \@newcollector;
 334 }
 335
 336 #################################################################
 337 # Copying an array
 338 #################################################################
 339
 340 sub copy_array_from_references
 341 {
 342     my ( $arrayref ) = @_;
 343
 344     my @newarray = ();
 345
 346     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 347     {
 348         push(@newarray, ${$arrayref}[$i]);
 349     }
 350
 351     return \@newarray;
 352 }
 353
 354 ###########################################################
 355 # Copying a hash
 356 ###########################################################
 357
 358 sub copy_hash_from_references
 359 {
 360     my ($hashref) = @_;
 361
 362     my %newhash = ();
 363     my $key;
 364
 365     foreach $key (keys %{$hashref})
 366     {
 367         $newhash{$key} = $hashref->{$key};
 368     }
 369
 370     return \%newhash;
 371 }
 372
 373 #################################################################
 374 # Combining two arrays, first wins
 375 #################################################################
 376
 377 sub combine_arrays_from_references_first_win
 378 {
 379     my ( $arrayref1, $arrayref2 ) = @_;
 380
 381     my $hashref1 = convert_array_to_hash($arrayref1);
 382     my $hashref2 = convert_array_to_hash($arrayref2);
 383     my %commonhash = ();
 384     my @newarray = ();
 385
 386     # starting with second hash
 387     foreach my $key ( keys %{$hashref2} ) { $commonhash{$key} = $hashref2->{$key}; }
 388     # overwriting with first hash
 389     foreach my $key ( keys %{$hashref1} ) { $commonhash{$key} = $hashref1->{$key}; }
 390
 391     # Creating the new array
 392     foreach my $key ( keys %commonhash ) { push(@newarray, "$key $commonhash{$key}\n"); }
 393
 394     return \@newarray;
 395 }
 396
 397 #################################################################
 398 # Combining two arrays
 399 #################################################################
 400
 401 sub combine_arrays_from_references
 402 {
 403     my ( $arrayref1, $arrayref2 ) = @_;
 404
 405     my @newarray = ();
 406
 407     for ( my $i = 0; $i <= $#{$arrayref1}; $i++ )
 408     {
 409         push(@newarray, ${$arrayref1}[$i]);
 410     }
 411
 412     for ( my $i = 0; $i <= $#{$arrayref2}; $i++ )
 413     {
 414         push(@newarray, ${$arrayref2}[$i]);
 415     }
 416
 417     return \@newarray;
 418 }
 419
 420 #################################################################
 421 # Returning the current ending number of a directory
 422 #################################################################
 423
 424 sub get_number_from_directory
 425 {
 426     my ( $directory ) = @_;
 427
 428     my $number = 0;
 429
 430     if ( $directory =~ /\_(\d+)\s*$/ )
 431     {
 432         $number = $1;
 433     }
 434
 435     return $number;
 436 }
 437
 438 #################################################################
 439 # Replacing separators, that are included into quotes
 440 #################################################################
 441
 442 sub replace_masked_separator
 443 {
 444     my ($string, $separator, $replacementstring) = @_;
 445
 446     $string =~ s/\\\Q$separator\E/$replacementstring/g;
 447
 448     return $string;
 449 }
 450
 451 #################################################################
 452 # Resolving separators, that were replaced
 453 # in function mask_separator_in_quotes
 454 #################################################################
 455
 456 sub resolve_masked_separator
 457 {
 458     my ($arrayref, $separator, $replacementstring) = @_;
 459
 460     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 461     {
 462         ${$arrayref}[$i] =~ s/$replacementstring/$separator/g
 463     }
 464 }
 465
 466 1;