cli_ure/source/scripts/increment_version.pl

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 use warnings;
  20 use strict;
  21 use diagnostics;
  22
  23 sub trim;
  24 sub readIncVersions($);
  25 sub processLine($$);
  26 sub checkName($);
  27 sub incrementNewVersion($);
  28 sub incrementOldVersion($);
  29 sub incrementPolicyVersion($);
  30 my $usage =
  31 "The tool increments the minor version of assemblies and the major version of ".
  32 "the respective policy files. This is only done if new uno types have been added since".
  33 "the last product upate. This information is obtained from the file which is passed as ".
  34 "argument changedTypes. The names in the version file must have a particular form. ".
  35 "They must end on one of folling terms: NEW_VERSION, OLD_VERSION, POLICY_VERSION\n".
  36 "If no new published types habe been added then no output, argument  newVersions, is written".
  37 "Usage is: \n increment_version.pl oldVersions  incVersions newVersions changedTypes\n\n".
  38 "oldVersion: Contains name value pairs, which are used for forming the config files of ".
  39 "the policy assemblies, for building the assemblies. \n\n".
  40 "incVersions: File containing the names of which the versions are to be incremented. ".
  41 "Every line may only contain one name. The names must exactly match those from the ".
  42 "oldVersion file.\n\n".
  43 "newVersions: Contains all entries from oldVersions, but the values of the names,".
  44 "which occur in selection, have been incremented.\n\n".
  45 "changedTypes: File that contains the information if new published types have been added ".
  46 "since the last product update.\n\n" ;
  47
  48 my $sNameForm =
  49 "The names must end on one of these names: NEW_VERSION, OLD_VERSION, POLICY_VERSION\n".
  50 "For example, valid names are: \n".
  51 "CLI_URETYPES_NEW_VERSION\nCLI_URETYPES_OLD_VERSION\nCLI_URETYPES_POLICY_VERSION\n";
  52
  53 if (scalar @ARGV < 4) {
  54    print $usage;
  55    exit -1;
  56 }
  57
  58 -e "$ARGV[0]" or die "Error: wrong arguments. \n".$usage;
  59 -e "$ARGV[1]" or die "Error: wrong arguments. \n".$usage;
  60 -e "$ARGV[3]" or die "Error: wrong arguments. \n".$usage;
  61
  62 #check if new types have been added since last release.
  63 #If not, then there is nothing to be done.
  64 #read in oldVersions line by line and apply the increment operation
  65 open TYPES, "$ARGV[3]" or die "Cannot open to $ARGV[3] $!";
  66
  67 my $newTypes;
  68
  69 #We look for the line that contains the number of new types
  70 while(<TYPES>)
  71 {
  72     if (/New and published types/i)
  73     {
  74     $_ =~ /=\s*(\d+)/;
  75     if ( ! defined $1)
  76     {
  77         print "\n###$ARGV[3] contains an invalid entry for 'New and published types'.  \n\n";
  78         exit -1;
  79     }
  80     $newTypes = $1;
  81     }
  82 }
  83
  84 #Check if changeTypes contained the line we are looking for
  85 if (! defined $newTypes)
  86 {
  87     print "\n###$ARGV[3] does not contain entry about the new types ".
  88     "or we are looking for the wrong string! \n\n";
  89     exit -1;
  90 }
  91
  92 if ( $newTypes == 0)
  93 {
  94     print "\nNo new UNO types since las product update.\n";
  95     exit 0;
  96 }
  97 else
  98 {
  99     print "\nNew UNO types were addes since last release. The version will be increased.\n\n";
 100 }
 101
 102 #read in incVersions in a list
 103 my @incVersions = readIncVersions($ARGV[1]);
 104 #print "@incVersions";
 105
 106 #read in oldVersions line by line and apply the increment operation
 107 open OLDVERSION, "$ARGV[0]" or die "Cannot open to $ARGV[0] $!";
 108
 109 #open file we want to write to
 110 open NEWVERSION, "> $ARGV[2]" or die "Cannot write to $ARGV[2] $!";
 111
 112 print NEWVERSION processLine($_, @incVersions) while(<OLDVERSION>);
 113
 114 close NEWVERSION;
 115 close OLDVERSION;
 116
 117 exit 0;
 118
 119 sub processLine($$)
 120 {
 121     my $line = $_[0];
 122     #skip empty lines
 123     my $trimmed;
 124     return $line if (length($trimmed = trim($line)) == 0);
 125     #Skip comment symbol: #
 126     return $line if ($trimmed =~ /^#/);
 127
 128     #Get the left part of '='
 129     my $i = index($line, "=");
 130     if( $i == -1)
 131     {
 132     print "Error: No '=' found in line:,: \n $line \n";
 133     exit -1;
 134     }
 135     my $name = substr($line, 0, $i);
 136     $name = trim($name);
 137     #We do not check the names here because the file can contain
 138     #other names, e.g. CLI_URETYPES_POLICY_ASSEMBLY
 139     if (length($name) == 0) {
 140     print "Wrong line in $ARGV[0]\n", $sNameForm;
 141     exit -1;
 142     }
 143     my $value = substr($line, $i + 1);
 144     $value = trim($value);
 145
 146     #Check if the entry shall be incremented, this information is in the second
 147     #argument
 148     my $found;
 149     for(@incVersions) {
 150     if ($_ eq $name) {
 151         $found = 1;
 152         last;
 153     }
 154     }
 155     if ( ! defined($found)) {
 156      return $line;
 157     }
 158
 159     #Check if the name represents a version we need to change
 160     if ($name =~ /NEW_VERSION$/)
 161     {
 162     $value = incrementNewVersion($value);
 163     }
 164     elsif ($name =~ /OLD_VERSION$/)
 165     {
 166     $value = incrementOldVersion($value);
 167     }
 168     elsif ($name =~ /POLICY_VERSION$/)
 169     {
 170     $value = incrementPolicyVersion($value);
 171     }
 172     else
 173     {
 174     #other name which we ignore
 175     return $line;
 176     }
 177     return "${name}=${value}\n";
 178 }
 179
 180 #The value of a new version has the form x.x.x.x
 181 #We increment the third position from the left.
 182 #Te argument must already be trimmed.
 183 sub incrementNewVersion($)
 184 {
 185    my @parts = split /\./,$_[0];
 186    if (scalar @parts != 4)
 187    {
 188        print "Error, no valid version given in $ARGV[0]\n. A 'new version' has four parts.";
 189        exit -1;
 190    }
 191    $parts[2]++;
 192    #build the version string and return
 193    return "$parts[0].$parts[1].$parts[2].$parts[3]";
 194 }
 195
 196 #The value of a new version has the form x.x.x.x-x.x.x.x
 197 #We increment the third position of the second part.
 198 #Te argument must already be trimmed.
 199 sub incrementOldVersion($)
 200 {
 201     my @parts = split /[\.-]/,$_[0];
 202     if (scalar @parts != 8)
 203     {
 204     print "Error, no valid version given in $ARGV[0]\n. A 'old version' has the form
 205 x.x.x.x-x.x.x.x\n.";
 206     exit -1;
 207     }
 208     $parts[6]++;
 209     return "$parts[0].$parts[1].$parts[2].$parts[3]-$parts[4].$parts[5].$parts[6].$parts[7]";
 210     return $_[0];
 211 }
 212
 213 sub incrementPolicyVersion($)
 214 {
 215    my @parts = split /\./,$_[0];
 216    if (scalar @parts != 4)
 217    {
 218        print "Error, no valid version given in $ARGV[0]\n. A 'policy version' has four parts.";
 219        exit -1;
 220    }
 221    $parts[0]++;
 222    #build the version string and return
 223    return "$parts[0].$parts[1].$parts[2].$parts[3]";
 224 }
 225
 226
 227 sub readIncVersions($)
 228 {
 229     open INC, $_[0] or die "Could not open $_[0] $!";
 230     my $arg = $_[0];
 231     my @names;
 232
 233     while(<INC>)
 234     {
 235     chomp;
 236     #Skip empty lines
 237     my $line;
 238     if (length($line = trim($_)) == 0) {
 239         next;
 240     }
 241     #Skip comment symbol: #
 242     if ($line =~ /^#/) {
 243         next;
 244     }
 245     if (!checkName($line)) {
 246         print "Wrong entry in file $_[0]\n", $sNameForm;
 247         exit -1;
 248     }
 249     push @names, $line;
 250     }
 251     print "No entries found in $arg\n" if(scalar @names == 0);
 252     return @names;
 253 }
 254
 255 #The argument must already be trimmed
 256 #returns 1 if ok
 257 sub checkName($)
 258 {
 259     my $name = $_[0];
 260     if ( $name !~/NEW_VERSION$|OLD_VERSION$|POLICY_VERSION$/) {
 261     return 0;
 262     }
 263     return 1;
 264 }
 265
 266 sub trim($)
 267 {
 268     my $string = shift;
 269     $string =~ s/^\s+//;
 270     $string =~ s/\s+$//;
 271     return $string;
 272 }