Subversion Repositories DevTools

Rev

Rev 7009 | Rev 7447 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
227 dpurdie 1
#! perl
2
########################################################################
6177 dpurdie 3
# COPYRIGHT - VIX IP PTY LTD ("VIX"). ALL RIGHTS RESERVED.
227 dpurdie 4
#
5
# Module name   : jats.sh
6
# Module type   : Makefile system
7
# Compiler(s)   : n/a
8
# Environment(s): jats
9
#
10
# Description:
11
#       This is a wrapper script to simplify access to the jats
12
#       build system
13
#
14
# Usage:        jats build | make | install | help | ...
15
#
229 dpurdie 16
# Package: PACKAGE_TAG
17
# Version: VERSION_TAG
227 dpurdie 18
#......................................................................#
19
 
261 dpurdie 20
require 5.008_002;
227 dpurdie 21
use strict;
22
use warnings;
23
 
24
use Cwd;
25
use File::Copy;
26
use Getopt::Long qw(:config require_order);     # Stop on non-option
27
use FindBin;                                    # Determine the current directory
28
use lib "$FindBin::Bin/LIB";                    # Allow JATS libraries
29
use Config;
30
use Sys::Hostname;                              # For hostname
31
 
315 dpurdie 32
use Pod::Usage;                                 # For help support
227 dpurdie 33
use JatsError;                                  # Common error reporting
34
use DescPkg;                                    # Package Descriptor processing
35
use JatsSystem;                                 # System call interface
245 dpurdie 36
use JatsBuildFiles;                             # Parse Build Files
227 dpurdie 37
 
229 dpurdie 38
my $GBE_VERSION = "VERSION_TAG";                # Will be re-written when released
399 dpurdie 39
my $GBE_NOT_RELEASED = "RELEASE_TAG";           # Will be re-written (to empty) when released
227 dpurdie 40
my $opr_done;
41
my $opt_here = 0;
42
my $BUILD_FILE      = "build.pl";
43
my @BUILD_FILE_ALT  = qw(auto.pl build_test.pl);
44
my $BUILD_FILE_SET;
45
my $RESULT = 0;
46
my $PSPLIT = ':';                               # Win/Unix path splitter
47
my $opt_time = 0;
48
my $opt_help = 0;
49
my $opt_locate = 0;
50
my $opt_locate_file;
245 dpurdie 51
my $opt_locate_package;
319 dpurdie 52
my $opt_locate_dir;
227 dpurdie 53
my $opt_dir;
54
my $opt_java;
277 dpurdie 55
my $opt_export_vars = 1;
227 dpurdie 56
my $result;
379 dpurdie 57
my $opt_logfile;
6177 dpurdie 58
my $opt_script;
4902 dpurdie 59
my $notaBuildMachine = 0;
5848 dpurdie 60
my @opt_buildfilter;
227 dpurdie 61
 
62
#
63
#   Grab a copy of ALL the environment variable that will be used
64
#   This will simplify the script a great deal
65
#
66
 
279 dpurdie 67
our $GBE_JATS_VERSION   = $ENV{'GBE_JATS_VERSION'}   || '';
227 dpurdie 68
our $GBE_JATS_SANE      = $ENV{'GBE_JATS_SANE'}      || 0;
279 dpurdie 69
our $GBE_CORE           = $ENV{'GBE_CORE'}           || '';
70
our $GBE_BIN            = $ENV{'GBE_BIN'}            || '';
71
our $GBE_CONFIG         = $ENV{'GBE_CONFIG'}         || '';
72
our $GBE_DPLY           = $ENV{'GBE_DPLY'}           || '';
73
our $GBE_DPKG           = $ENV{'GBE_DPKG'}           || '';
4688 dpurdie 74
our $GBE_DPKG_REPLICA   = $ENV{'GBE_DPKG_REPLICA'}   || '';
279 dpurdie 75
our $GBE_DPKG_STORE     = $ENV{'GBE_DPKG_STORE'}     || '';
76
our $GBE_DPKG_LOCAL     = $ENV{'GBE_DPKG_LOCAL'}     || '';
6276 dpurdie 77
our $GBE_DPKG_ESCROW    = $ENV{'GBE_DPKG_ESCROW'}    || '';
279 dpurdie 78
our $GBE_DPKG_CACHE     = $ENV{'GBE_DPKG_CACHE'}     || '';
79
our $GBE_DPKG_SBOX      = $ENV{'GBE_DPKG_SBOX'}      || '';
80
our $GBE_SANDBOX        = $ENV{'GBE_SANDBOX'}        || '';
81
our $GBE_PERL           = $ENV{'GBE_PERL'}           || '';
82
our $GBE_TOOLS          = $ENV{'GBE_TOOLS'}          || '';
83
our $GBE_MACHTYPE       = $ENV{'GBE_MACHTYPE'}       || '';
273 dpurdie 84
our $GBE_HOSTMACH       = $ENV{'GBE_HOSTMACH'}       || $GBE_MACHTYPE;
279 dpurdie 85
our $GBE_PLATFORM       = $ENV{'GBE_PLATFORM'}       || '';
86
our $GBE_BUILDFILTER    = $ENV{'GBE_BUILDFILTER'}    || '';
227 dpurdie 87
our $GBE_DEBUG          = $ENV{'GBE_DEBUG'}          || 0;
88
our $GBE_VERBOSE        = $ENV{'GBE_VERBOSE'}        || 0;
279 dpurdie 89
our $GBE_DRV            = $ENV{'GBE_DRV'}            || '';
90
our $GBE_HOSTNAME       = $ENV{'GBE_HOSTNAME'}       || hostname || '';
91
our $USER               = $ENV{'USER'}               || '';
92
our $PERL5LIB           = $ENV{'PERL5LIB'}           || '';
93
our $JAVA_HOME          = $ENV{'JAVA_HOME'}          || '';
94
our $GBE_ABT            = $ENV{'GBE_ABT'}            || '';
343 dpurdie 95
our $GBE_VIEWBASE       = $ENV{'GBE_VIEWBASE'}       || '';
3967 dpurdie 96
our $GBE_VCS            = $ENV{'GBE_VCS'}            || 'SVN';
399 dpurdie 97
our $GBE_UNIX           = $^O ne "MSWin32" ;
227 dpurdie 98
our $CWD;
99
 
100
#-------------------------------------------------------------------------------
101
#   Clean up some environment variables
245 dpurdie 102
#       GBE_BUILDFILTER - may be space or comma separated list
103
#       GBE_PLATFORM - may be space or comma separated list
104
#       GBE_ABT - may be space or comma separated list
279 dpurdie 105
#       GBE_HOSTNAME - No whitespace
361 dpurdie 106
#       GBE_VCS - lowercase to match command ccrelease and others
227 dpurdie 107
#
108
$GBE_BUILDFILTER = join (' ', split( /[,\s]+/, $GBE_BUILDFILTER));
109
$GBE_PLATFORM    = join (' ', split( /[,\s]+/, $GBE_PLATFORM));
110
$GBE_ABT         = join (' ', split( /[,\s]+/, $GBE_ABT));
279 dpurdie 111
$GBE_HOSTNAME    =~ s~\s+~~g;
361 dpurdie 112
$GBE_VCS         = lc( $GBE_VCS );
227 dpurdie 113
 
4902 dpurdie 114
# Capture NON Build Machine config before parsing the command line
4928 dpurdie 115
#   Yes the user can still fudge the environment
116
if (exists $ENV{GBE_ABT} && $ENV{GBE_ABT} eq 'NONE' )
117
{
118
    $GBE_ABT = '';
119
    $notaBuildMachine = 1;
120
}
4902 dpurdie 121
 
227 dpurdie 122
#-------------------------------------------------------------------------------
123
#   Parse the user options
124
#   GetOptions has been configured so that it will stop parsing on the first
125
#   non-options. This allows the command syntax to the script to have options
126
#   that are directed to this script before the command keyword, and command
127
#   options to the subcommand to be after the keyword.
128
#
129
$result = GetOptions (
261 dpurdie 130
            "help|h:+"          => \$opt_help,
131
            "manual:3"          => \$opt_help,
132
            "verbose|v:+"       => \$GBE_VERBOSE,
133
            "debug:+"           => \$GBE_DEBUG,
227 dpurdie 134
            "cd|changedir=s"    => \$opt_dir,
135
            "locate"            => \$opt_locate,
136
            "locatefile=s"      => \$opt_locate_file,
245 dpurdie 137
            "locatepkg=s"       => \$opt_locate_package,
319 dpurdie 138
            "locatedir=s"       => \$opt_locate_dir,
227 dpurdie 139
            "here"              => \$opt_here,
140
            "time"              => \$opt_time,
141
            "b|buildfile=s"     => \&opts_buildfile,
245 dpurdie 142
            "java=s"            => \$opt_java,
227 dpurdie 143
            "version=s",        => \&opts_version,
144
            "platform:s",       => sub{ opts_extend( \$GBE_PLATFORM, @_ )},
5848 dpurdie 145
            "buildfilter:s"     => \@opt_buildfilter,
227 dpurdie 146
            "abt:s"             => sub{ opts_extend( \$GBE_ABT, @_ )},
277 dpurdie 147
            "exportvars!"       => \$opt_export_vars,
379 dpurdie 148
            "logfile=s",        => \$opt_logfile,
6177 dpurdie 149
            "script!",          => \$opt_script,
227 dpurdie 150
            );
151
 
152
#
153
#   Configure the error reporting process now that we have the user options
154
#
155
ErrorConfig( 'name'    => 'JATS',
156
             'debug'   => $GBE_DEBUG,
157
             'verbose' => $GBE_VERBOSE );
158
#
159
#   Post process some of the options
160
#
161
Error ("Options not parsed. Use -help for help") unless $result;
263 dpurdie 162
Verbose3 ('ARGS', @ARGV);
227 dpurdie 163
 
164
#
165
#   Option Helper Routine
166
#   Save alternate buildfile. Flag that it has been set
167
#
168
sub opts_buildfile
169
{
283 dpurdie 170
    my ($junk, $bf) = @_;
171
    $BUILD_FILE = $bf;
227 dpurdie 172
    $BUILD_FILE_SET = 1;
173
    Verbose ("Use alternate buildfile: $BUILD_FILE");
283 dpurdie 174
    return;
227 dpurdie 175
}
176
 
177
#
178
#   Options Helper Routine
179
#   Collect a space/comma delimited list and replace/append to string
180
#   Allows the string to be reset
181
#   Use of a +" will append to existing value
182
#
183
#       arg1 - Ref to string to store data
184
#       arg2 - Option name
185
#       arg3 - Option value
186
#
187
sub opts_extend
188
{
189
    my( $ref, $name, $value) = @_;
190
    if ( $value )
191
    {
192
        $value =~ s/,/ /g;
193
        $value = ${$ref} . ' ' . $value
194
            if ( $value =~ s/\+/ /g );
195
        $value =~ s/^\s+//;
196
        $value =~ s/\s+/ /;
197
    }
198
    ${$ref} = $value;
283 dpurdie 199
    return;
227 dpurdie 200
}
201
 
202
#
203
#   Options Helper routine
204
#   Collect --version=version, then stop processing of the command line
205
#   This will simulate a '--'
206
#
207
sub opts_version
208
{
283 dpurdie 209
    my ($junk, $vn) = @_;
210
    $GBE_JATS_VERSION = $vn;
211
    die("!FINISH\n");
227 dpurdie 212
}
213
 
214
################################################################################
215
#
216
#   Ensure that essential environment variables are present and that they
217
#   do not contain spaces.
218
#
219
ReportError('Set env-var GBE_PERL (typically "/usr/bin/perl")')   unless ( $GBE_PERL );
229 dpurdie 220
ReportError('Set env-var GBE_DPKG (typically "/devl/dpkg_archive")') unless ( $GBE_DPKG );
221
ReportError('Set env-var GBE_CORE (typically "/devl/dpkg_archive/PACKAGE_TAG/VERSION_TAG")')  unless ( $GBE_CORE );
279 dpurdie 222
ReportError('Hostname cannot be determined') unless ( $GBE_HOSTNAME );
227 dpurdie 223
 
229 dpurdie 224
################################################################################
225
#
226
#   Warn if using a version of perl that is newer than expected
227
#   The 'require' does a lower limit test
228
#
341 dpurdie 229
#   Notes:
230
#       Ubuntu 9.04 provides Perl 10 - don't complain
231
#       PDK is only available on Windows
232
#
233
if ( ! $GBE_JATS_SANE && ! $GBE_UNIX)
283 dpurdie 234
{
235
    Warning ("Perl Version may not be compatible",
236
             "Jats has been tested with: 5.8.8",
237
             "This version is: $]",
238
            ) if ( $] > 5.010000 );
227 dpurdie 239
 
399 dpurdie 240
    Warning ("The PDK, as used by some deployed packages does not work with",
241
             "this version of perl. VIX only has a licence for PDK V5 and",
242
             "this only works with Perl 5.6 and 5.8.",
283 dpurdie 243
             "This version is: $]",
244
            ) if ( $] > 5.009000 );
245
}
229 dpurdie 246
 
247
#
248
#   Warn if this is not an active state release
249
#
250
#   Would be nice, but I can't figure out how to do it - yet
251
#   The following does not work on all platforms
252
#
253
#unless ( $ActivePerl::VERSION )
254
#{
255
#    Warning ("Perl does not appear to be an ActiveState Release", "Jats may not function as expected");
256
#}
257
#else
258
#{
259
#    Verbose ("ActiveState Version: $ActivePerl::VERSION");
260
#}
261
 
227 dpurdie 262
################################################################################
229 dpurdie 263
#
245 dpurdie 264
#   Warn if this version of JATS is not correctly versioned
229 dpurdie 265
#   Users should be using correctly versioned copies of JATS. These come
266
#   from dpkg_archive.
267
#
399 dpurdie 268
#   Display warnings at the end of the run
269
#   This is an attempt to make them visible to the user
270
#
271
my @endWarnings;
272
if ( ! $GBE_JATS_SANE && $GBE_NOT_RELEASED ) {
273
    @endWarnings = ( "*** Unofficial version of JATS ***");
274
} else {
229 dpurdie 275
 
399 dpurdie 276
    #
277
    #   Windows only
278
    #   Attempt to detect JATS no being run via the jats2_current link
279
    #
1329 dpurdie 280
    unless  ( $GBE_UNIX || $GBE_JATS_SANE || $GBE_ABT || $GBE_CORE =~ m~core_devl[/\\]jats2_current~ ) {
399 dpurdie 281
        @endWarnings =
282
            ("***",
283
             "*** Jats is being invoked from a batch file that does not ",
284
             "*** automatically track the latest version. Update jats.bat",
285
             "*** so that GBE_CORE references core_devl/jats2_current",
286
             "***"
287
             );
288
    }
289
}
290
 
291
#-------------------------------------------------------------------------------
292
# Function        : END
293
#
294
# Description     : Display user warnings at the end of the processing
6177 dpurdie 295
#                   unless we are processing with a script
399 dpurdie 296
#
297
# Inputs          : global: @endWarnings
298
#
299
END
300
{
301
    Message (@endWarnings)
6177 dpurdie 302
        if ( @endWarnings && !$opt_script );
399 dpurdie 303
}
304
 
229 dpurdie 305
################################################################################
227 dpurdie 306
#   If running with cygwin then warn if the CYGWIN environment variable
307
#   contains "tty". tty mode causes some strange behaviour such as:
308
#       1) Non flushing of perl scripts under some conditions (eg:create_dpkg)
309
#
310
if ( $ENV{'CYGWIN'} && $ENV{'CYGWIN'} =~ m/tty/ )
311
{
312
    Warning ("The CYGWIN variable contains \"tty\".",
313
             "This can cause strange behaviour with interactive scripts");
314
}
315
 
316
#
317
#   Remove CDPATH - this breaks things when cygwin is running
318
#   even if we are not running under cygwin perl
319
#
320
delete $ENV{'CDPATH'};
321
 
322
 
323
################################################################################
324
#   Sanitize GBE_CORE and others for internal Perl use
325
#   It may contain \ to be added to PATH but within perl is needs /
326
#
327
$PERL5LIB =~ tr~\\/~/~s;
328
 
329
TestDirectoryConfig( 'GBE_CORE' );
330
TestDirectoryConfig( 'GBE_BIN' );
331
TestDirectoryConfig( 'GBE_PERL' );
332
TestDirectoryConfig( 'GBE_DPLY' );
333
TestDirectoryConfig( 'GBE_DPKG' );
334
TestDirectoryConfig( 'GBE_DPKG_CACHE' );
335
TestDirectoryConfig( 'GBE_DPKG_LOCAL' );
336
TestDirectoryConfig( 'GBE_DPKG_STORE' );
4688 dpurdie 337
TestDirectoryConfig( 'GBE_DPKG_REPLICA' );
6276 dpurdie 338
TestDirectoryConfig( 'GBE_DPKG_ESCROW' );
227 dpurdie 339
TestDirectoryConfig( 'GBE_DPKG_SBOX' );
340
TestDirectoryConfig( 'GBE_SANDBOX' );
341
 
342
################################################################################
343
#   Setup the Machine Type
344
#
345
#   GBE_MACHTYPE is used to determine the BIN directory from which JATS will
346
#   pull local binary executables from. The directory must exist.
347
#
348
#   We need GBE_MACHTYPE to be correctly defined by the user
349
#   This is machine specific and should be done in jats.sh/jats.bat
350
#
351
unless ( $GBE_MACHTYPE )
352
{
353
    $GBE_MACHTYPE = 'win32' if ( $^O eq "cygwin" );
354
    $GBE_MACHTYPE = 'win32' if ( $^O eq "MSWin32" );
355
    $GBE_MACHTYPE = 'win32' if ( $^O eq "win95" );
7009 dpurdie 356
    $GBE_HOSTMACH = $GBE_MACHTYPE;
227 dpurdie 357
    Verbose ("Setting GBE_MACHTYPE: $GBE_MACHTYPE") ;
358
}
359
 
360
ReportError ('Set env-var GBE_MACHTYPE (typically "win32")') unless ( $GBE_MACHTYPE );
361
ErrorDoExit();
362
 
7009 dpurdie 363
if ( $GBE_HOSTMACH eq 'win32' )
227 dpurdie 364
{
365
    $PSPLIT = ';';
366
    $GBE_UNIX = 0;
367
}
368
 
369
################################################################################
370
#   Windows: If the user is running JATS from within the development view
371
#   then they may not provide a drive letter in the full name of GBE_CORE
372
#   For correct operation GBE_CORE needs to be able to run programs and
373
#   scripts from any other drive
374
#
375
#   If GBE_CORE does not have a driver letter - then add one
376
#   Note: Use the CWD before any CD operations
377
#
7009 dpurdie 378
if ( $GBE_HOSTMACH eq 'win32'  && $GBE_CORE !~ m/^\w\:/ )
227 dpurdie 379
{
380
        my $cwd = getcwd();
381
        $GBE_CORE = substr( $cwd, 0, 2 ) . '/' . $GBE_CORE;
382
        $GBE_CORE =~ s~//~/~g;
383
        Verbose2 ("Setting GBE_CORE drive: $GBE_CORE");
384
}
385
 
386
################################################################################
387
#   Attempt to run JATS from a local cache
388
#   This mechanism allows JATS to be a link to a desired version on a network
389
#   drive, but to have the version transferred locally if required
390
#
229 dpurdie 391
#   The transfer/check is only done on the first invocation of jats. If jats uses
245 dpurdie 392
#   jats to perform functions, then it will not be performed.
229 dpurdie 393
#
245 dpurdie 394
#   If we want to run an alternate version of JATS, then don't attempt to
229 dpurdie 395
#   cache the initial version of JATS.
396
#
227 dpurdie 397
if ( $ENV{GBE_CACHE_JATS} && ! $GBE_JATS_SANE && ! $GBE_JATS_VERSION)
398
{
399
    my $state = "Not Cached: Not running from dpkg_archive";
400
    #
401
    #   Must have the DPKG_ARCHIVE cache
229 dpurdie 402
    #   Must be running from DPKG_ARCHIVE - prevent messing with local copies
227 dpurdie 403
    #
404
    if ( $GBE_DPKG_CACHE )
405
    {
229 dpurdie 406
        #
407
        #   JATS must be running from an archive, otherwise we assume that its
408
        #   a local copy. Detected by:
409
        #       GBE_NOT_RELEASED being set
410
        #       Lack of descpkg file
411
        #
412
        if ( ! $GBE_NOT_RELEASED  && -f "$GBE_CORE/descpkg" )
227 dpurdie 413
        {
4688 dpurdie 414
            my ($archive, $package, $aName) = LocateJatsVersion( $GBE_VERSION );
229 dpurdie 415
            if ( $archive )
416
            {
417
                #
4688 dpurdie 418
                #   If the required version is found in the cache, then use it
419
                #   This will bypass the slowish process of invoking cache_dpkg
420
                #   at the expense of not being able to handle situations where
421
                #   version is updated on the fly
229 dpurdie 422
                #
4688 dpurdie 423
                if (($aName ne 'GBE_DPKG_CACHE') && ( $ENV{GBE_CACHE_JATS} < 2))
283 dpurdie 424
                {
4688 dpurdie 425
                    Verbose ("Update cached version of JATS: $GBE_VERSION");
426
                    #
427
                    #   Attempt to cache the package
428
                    #   Need enough JATS environment to run the cache_dpkg utility
429
                    #
430
                    {
431
                        local %ENV = %ENV;
227 dpurdie 432
 
4688 dpurdie 433
                        $ENV{GBE_TOOLS} = "$GBE_CORE/TOOLS";
434
                        $ENV{PERL5LIB} = "$GBE_CORE/TOOLS/LIB" ;
7009 dpurdie 435
                        $ENV{GBE_BIN}  = "$GBE_CORE/BIN.$GBE_HOSTMACH";
4688 dpurdie 436
                        $ENV{GBE_VERBOSE}  = $GBE_VERBOSE;
227 dpurdie 437
 
4688 dpurdie 438
                        etool ( 'cache_dpkg.pl', $package );
439
                    }
283 dpurdie 440
                }
4688 dpurdie 441
                else
442
                {
443
                    Verbose("Required version found in cache");
444
                }
227 dpurdie 445
 
229 dpurdie 446
                my $tgt = "$GBE_DPKG_CACHE/$package";
447
                if ( -d $tgt )
448
                {
449
                    Verbose ("Using cached version of JATS: $GBE_VERSION");
450
                    $GBE_CORE = $tgt;
451
                    $state = "Cached";
452
                }
453
                else
454
                {
455
                    $state = "Not Cached: Copy Failure";
456
                }
227 dpurdie 457
            }
458
            else
459
            {
229 dpurdie 460
                $state = "Not Cached: Not found in archives";
227 dpurdie 461
            }
462
        }
463
    }
464
    else
465
    {
466
        $state = "Not Cached: No GBE_DPKG_CACHE";
467
    }
468
 
469
    #
470
    #   Flag JATS having been cached on the machine
471
    #
472
    $ENV{GBE_CACHE_JATS} = $state;
473
}
474
 
475
 
476
################################################################################
477
#   Establish a relationship between GBE_BIN, GBE_TOOLS and GBE_CONFIG
478
#   unless the user has already provided one.
479
#
480
#   Only NEED GBE_CORE - the others will be derived
481
#
482
unless ( $GBE_BIN )
483
{
484
    $GBE_BIN = "$GBE_CORE/BIN.$GBE_MACHTYPE";
485
    Verbose2 ("Setting GBE_BIN: $GBE_BIN");
486
}
487
ReportError ('GBE_MACHTYPE is not valid.',
488
             'There must be a corresponding BIN directory in GBE_CORE',
489
             "GBE_BIN     : $GBE_BIN",
490
             "GBE_MACHTYPE: $GBE_MACHTYPE"
491
             ) unless ( -d $GBE_BIN );
492
 
493
ReportError ('Machine specific binary directory does not appear to setup',
494
             'After JATS is installed the PostInstall script must be run',
495
             "GBE_BIN     : $GBE_BIN"
496
             ) unless ( -x $GBE_BIN . '/sh' || -x $GBE_BIN . '/sh.exe'  );
497
 
498
unless ( $GBE_TOOLS )
499
{
500
    $GBE_TOOLS = "$GBE_CORE/TOOLS";
501
    Verbose2 ("Setting GBE_TOOLS: $GBE_TOOLS");
502
}
503
 
504
unless ( $GBE_CONFIG )
505
{
506
    $GBE_CONFIG = "$GBE_CORE/CFG";
507
    Verbose2 ("Setting GBE_CONFIG: $GBE_CONFIG");
508
}
509
 
510
#
511
#   Extend the PERL5 with our own Module Repository
512
#
513
$PERL5LIB = join( $PSPLIT, split( $PSPLIT, $PERL5LIB), "$GBE_CORE/TOOLS/LIB" );
514
 
515
 
516
################################################################################
517
#   Sanity Test
518
#   The ABT environment requires several parameters to specify the location
519
#   of the Release/Deployment Managers
520
#
521
#   GBE_DM_LOCATION will be set GBE_RM_LOCATION, if not set
522
#
523
#   Only perform the test:
524
#       - On the first invocation of JATS, not nested invocations
525
#       - Based on the EnvVar, not the user option. This will allow a user
526
#         to invoke ABT without the need for these values to be present
527
#
528
if ( ! $GBE_JATS_SANE && $ENV{GBE_RM_LOCATION} && ! $ENV{GBE_DM_LOCATION} )
529
{
530
    $ENV{GBE_DM_LOCATION} = $ENV{GBE_RM_LOCATION};
531
}
532
 
533
if ( ! $GBE_JATS_SANE && $ENV{GBE_ABT} )
534
{
535
    foreach my $var ( qw(GBE_DM_LOCATION GBE_DM_USERNAME GBE_DM_PASSWORD GBE_RM_URL))
536
    {
537
        Warning("Deployment Manager EnvVar may need to be defined: $var") unless ( $ENV{$var} );
538
    }
539
 
540
    foreach my $var ( qw(GBE_RM_LOCATION GBE_RM_USERNAME GBE_RM_PASSWORD GBE_DM_URL))
541
    {
542
        ReportError("Release Manager EnvVar needs to be defined: $var") unless ( $ENV{$var} );
543
    }
544
}
545
 
546
################################################################################
319 dpurdie 547
#   Locate a specified directory - normally a view root
548
#   Scan upwards from the current directory loccing for the specified path
227 dpurdie 549
#
319 dpurdie 550
if ( $opt_locate_dir )
551
{
552
    my ($path) = scan_for_dir ($opt_locate_dir);
553
    Error ("Cannot locate directory: $opt_locate_dir") unless ( $path );
554
    change_dir ( $path );
555
}
556
 
557
################################################################################
558
#
227 dpurdie 559
#   Change to the required root directory
560
#       The user may specify a start directory( -c )
561
#
562
change_dir ( $opt_dir );
245 dpurdie 563
 
564
################################################################################
565
#   Locate the root of the build - if required
566
#   This is used by the autobuild tools to:
567
#       1) Locate the build.pl file for JATS based builds
568
#          The name of the target package can be provided to resolve
569
#          cases of multiple build files.
570
#
571
#       2) Locate the <ProjectName>depends.xml file for ANT based builds
572
#          The name of the buildfile will be specified
573
#          There must be only one file of this name in the tree
574
#
575
#   Note: If only one build file is found, then it will be used
576
#         It will not be sanity tested. This is intentional
577
#         for backward compatability.
578
#
579
if ( $opt_locate || $opt_locate_file || $opt_locate_package )
227 dpurdie 580
{
245 dpurdie 581
    #
582
    #   Allow the user to specify the name of the build file
583
    #   This will be used in ANT builds as the name changes
584
    #   but it can be predetermined
585
    #
227 dpurdie 586
    $opt_locate_file = $BUILD_FILE unless ( $opt_locate_file );
587
 
245 dpurdie 588
    #
589
    #   Create a Build File Scanner object
590
    #   This will be used to locate a suitable build file
591
    #
227 dpurdie 592
    Verbose ("Autolocate the build file: $opt_locate_file");
593
 
245 dpurdie 594
    my $bscanner = BuildFileScanner ( '.', $opt_locate_file );
595
    my $count = $bscanner->locate();
596
 
597
    Error ("Autolocate. Build file not found: $opt_locate_file" )
598
        if ( $count <= 0 );
599
 
227 dpurdie 600
    #
245 dpurdie 601
    #   If multiple build files have been found
602
    #   If $opt_locate_package is set then we can attempt to resolve the package
227 dpurdie 603
    #
245 dpurdie 604
    #   Scan the buildfiles and determine the names of the packages that will
605
    #   be built. This can be used to generate nice error messages
606
    if ( $count > 1 )
607
    {
608
        $bscanner->scan();
609
        $count = $bscanner->match( $opt_locate_package );
610
#DebugDumpData ("Bscan", \$bscanner );
227 dpurdie 611
 
245 dpurdie 612
        my $errmess;
613
        unless ( $opt_locate_package ) {
614
            $errmess = "Use -locatepkg=pkg to resolve required package";
615
 
616
        } elsif ( $count <= 0 ) {
617
            $errmess = "None found that build package: $opt_locate_package";
618
 
619
        } elsif ( $count > 1 ) {
620
            $errmess = "Multiple build files build the required package: $opt_locate_package";
621
        }
622
 
623
        #
624
        #   Pretty error display
625
        #   Display build directory and the package name (mangled)
626
        #
627
        if ( $errmess )
628
        {
629
            Error ("Autolocate. Multiple build files found.",
630
                   $errmess,
631
                   "Build files found in:", $bscanner->formatData() );
632
        }
633
    }
634
 
227 dpurdie 635
    #
245 dpurdie 636
    #   Extract the required build file directory
227 dpurdie 637
    #
245 dpurdie 638
    my $dir = $bscanner->getMatchDir() || '';
639
    Verbose ("Autolocate. Found $count build files: $dir");
227 dpurdie 640
 
641
    #
642
    #   Select the one true build directory
643
    #
245 dpurdie 644
    change_dir ( $dir );
227 dpurdie 645
 
646
    #
647
    #   Kill location scan as we have already located the build file
648
    #
649
    $opt_here = 1;
650
}
651
 
652
################################################################################
653
#   Version redirection
654
#   JATS allows the version of JATS to be used to be specified
655
#   This mechanism operates on the assumption that the required version is
656
#   present in dpkg_archive. If a specific version is required then the bulk
657
#   of this script is bypassed and the arguments passed directly to the required
658
#   target
659
#
660
if ( $GBE_JATS_VERSION && $GBE_JATS_VERSION eq $GBE_VERSION )
661
{
662
    Message("Using current JATS version: $GBE_JATS_VERSION" );
663
    $GBE_JATS_VERSION = undef;
664
}
665
 
666
if ( $GBE_JATS_VERSION )
667
{
668
    #
669
    #   Report any errors detected
670
    #
671
    ErrorDoExit();
672
    Message("Using JATS version: $GBE_JATS_VERSION");
673
 
674
    #
245 dpurdie 675
    #   If we have a cache available, then attempt to transfer the required
676
    #   version into the cache. If we don't have a cache, then don't even try.
229 dpurdie 677
    #
245 dpurdie 678
    if ( $GBE_DPKG_CACHE )
679
    {
680
        #
681
        #   Attempt to locate the desired version in one of the well known
682
        #   package archives. This will give us its package name.
683
        #
684
        my ($archive, $package) = LocateJatsVersion ($GBE_JATS_VERSION);
685
        Error("Cannot find JATS version: $GBE_JATS_VERSION") unless $archive;
229 dpurdie 686
 
245 dpurdie 687
        #
688
        #   Do NOT propagate GBE_JATS_VERSION in the environment
689
        #   This will only cause problem in recursion
690
        #
691
        delete $ENV{GBE_JATS_VERSION};
227 dpurdie 692
 
245 dpurdie 693
        #
694
        #   Attempt to cache the package
695
        #   Need enough JATS environment to run the utility
696
        #
283 dpurdie 697
        {
698
            local %ENV = %ENV;
227 dpurdie 699
 
283 dpurdie 700
            $ENV{PERL5LIB} = $PERL5LIB;
701
            $ENV{GBE_BIN}  = $GBE_BIN;
702
            $ENV{GBE_VERBOSE}  = $GBE_VERBOSE;
703
            $ENV{GBE_TOOLS}  = $GBE_TOOLS;
227 dpurdie 704
 
283 dpurdie 705
            etool ( 'cache_dpkg.pl', $package );
706
        }
245 dpurdie 707
    }
227 dpurdie 708
 
709
    #
229 dpurdie 710
    #   Locate the version of JATS to be run (again)
227 dpurdie 711
    #   It should be in the cache, but it may not be
712
    #
245 dpurdie 713
    my ($archive, $package) = LocateJatsVersion ($GBE_JATS_VERSION);
229 dpurdie 714
    Error("Cannot find JATS version: $GBE_JATS_VERSION") unless $archive;
715
 
716
    $GBE_CORE = "$archive/$package";
227 dpurdie 717
    Verbose2 ("Using alternate version: $GBE_CORE");
718
 
719
    #
720
    #   Run the specified version of JATS
721
    #   Force the required version of GBE_CORE and invoke the wrapper script
722
    #
723
    $ENV{GBE_CORE} = $GBE_CORE;
724
 
725
    Verbose("Use ARGV: @ARGV");
726
    $RESULT = System ($GBE_PERL, "$GBE_CORE/TOOLS/jats.pl", @ARGV );
727
    do_exit();
728
}
729
 
730
################################################################################
731
#   Determine the current directory
732
#   Note: Don't use `pwd`. This sucks for so many reasons including
733
#         the fact that it may not be available until this wrapper
734
#         script has done it job.
735
#
736
$CWD = getcwd();
367 dpurdie 737
Error ("Cannot determine current directory - may be protected" )unless ( defined $CWD );
363 dpurdie 738
$CWD =~tr~\\/~/~s;
227 dpurdie 739
Verbose ("Current Working Directory: $CWD");
740
 
741
################################################################################
742
#   Setup drive
743
#   This is only required under windows
744
#   Purpose is unclear, but under windows it is required, so lets create one
745
#   if its not present
746
#
747
unless ( $GBE_UNIX )
748
{
749
    unless ( $GBE_DRV )
750
    {
751
        ($GBE_DRV = $CWD ) =~ s~[^:]*$~~;
752
        $GBE_DRV = "c:" if ( $GBE_DRV !~ m/:/ );
753
        Verbose2( "Setting GBE_DRV: $GBE_DRV" );
754
    }
755
}
756
 
757
################################################################################
758
#   Sanity test the main archive variable
759
#   This MUST address one archive
760
#
761
 
762
Error ("GBE_DPKG must not be a path list: $GBE_DPKG")
763
    if ( $GBE_DPKG =~ /$PSPLIT/ );
764
Error ("GBE_DPKG is not a directory : $GBE_DPKG")
765
    unless( -d $GBE_DPKG );
766
 
767
################################################################################
768
#   Sanity test the cache
769
#
770
Error ("GBE_DPKG_CACHE is not a directory : $GBE_DPKG_CACHE")
771
    if ( $GBE_DPKG_CACHE && ! -d $GBE_DPKG_CACHE );
772
 
773
################################################################################
774
#   Sanity test the global store
775
#
776
Error ("GBE_DPKG_STORE is not a directory : $GBE_DPKG_STORE")
777
    if ( $GBE_DPKG_STORE && ! -d $GBE_DPKG_STORE );
778
 
779
Error ("GBE_DPLY is not a directory : $GBE_DPLY")
780
    if ( $GBE_DPLY && ! -d $GBE_DPLY );
4688 dpurdie 781
 
782
Error ("GBE_DPKG_REPLICA is not a directory : $GBE_DPKG_REPLICA")
783
    if ( $GBE_DPKG_REPLICA && ! -d $GBE_DPKG_REPLICA );
6276 dpurdie 784
 
785
Error ("GBE_DPKG_ESCROW is not a directory : $GBE_DPKG_ESCROW")
786
    if ( $GBE_DPKG_ESCROW && ! -d $GBE_DPKG_ESCROW );
227 dpurdie 787
 
788
########################################################################
789
#
790
#       Locate a local_dpkg_archive directory, by searching from the CWD
791
#       to the root of the file system
792
#
793
unless ( $GBE_DPKG_LOCAL )
794
{
283 dpurdie 795
    ($GBE_DPKG_LOCAL) = scan_for_dir ('local_dpkg_archive');
227 dpurdie 796
}
797
else
798
{
799
    Error ("GBE_DPKG_LOCAL is not a directory : $GBE_DPKG_LOCAL")
800
        unless( -d $GBE_DPKG_LOCAL );
801
}
802
 
803
########################################################################
804
#
805
#       Locate a sandbox_dpkg_archive directory by searching from the CWD
806
#       to the root of the file system
807
#
241 dpurdie 808
#       sandbox_dpkg_archive is a dpkg_archive for packages that are being
809
#       co-developed. Package Versions within the sandbox are ignored
227 dpurdie 810
#
241 dpurdie 811
 
812
#
813
#   Ensure that the user does not set $GBE_SANDBOX or $GBE_DPKG_SBOX
814
#   $GBE_JATS_SANE will be set for multiple invocations, thus it is cleared
815
#   for the first one (unless the user messes with it).
816
#
817
unless ( $GBE_JATS_SANE )
227 dpurdie 818
{
241 dpurdie 819
    Error ("GBE_SANDBOX must not be set by the user") if ( $GBE_SANDBOX );
820
    Error ("GBE_DPKG_SBOX must not be set by the user") if ( $GBE_DPKG_SBOX );
821
 
822
    #
823
    #   The ABT does not use the sandbox
824
    #   It will never be found and will be ignored
825
    #
826
    unless ( $GBE_ABT )
827
    {
277 dpurdie 828
        ($GBE_DPKG_SBOX,$GBE_SANDBOX)  = scan_for_dir ('sandbox_dpkg_archive');
227 dpurdie 829
    }
3559 dpurdie 830
 
831
    #
832
    #   Support sandbox specific buildfilter
833
    #   Remove comments(#) and empty lines
834
    #
6198 dpurdie 835
    my $sbBuildFilter = $GBE_DPKG_SBOX . '/buildfilter';
836
    if ( $GBE_SANDBOX && -f $sbBuildFilter )
3559 dpurdie 837
    {
6198 dpurdie 838
        Verbose("sbBuildFilter:$sbBuildFilter");
839
        if ( open (my $BF, $sbBuildFilter ))
3559 dpurdie 840
        {
841
            my @bf;
842
            while ( <$BF> )
843
            {
844
                s~\s$~~;
845
                s~^\s~~;
846
                next unless ( $_ );
847
                next if ( m~^#~ );
848
                push @bf,$_;
849
            }
850
            close $BF;
851
            if ( @bf )
852
            {
853
                $GBE_BUILDFILTER = join (' ', split( /[,\s]+/, join(',', @bf)));
854
                Verbose ("Local BuildFilter: $GBE_BUILDFILTER");
855
            }
856
        }
857
    }
227 dpurdie 858
}
859
 
6403 dpurdie 860
#
861
#   Base buildfilter will be Machine or Sandbox
862
#   Now merge in user specified build filters
863
#
864
map opts_extend( \$GBE_BUILDFILTER, '', $_ ) , @opt_buildfilter;
865
 
227 dpurdie 866
########################################################################
867
#
868
#   Ensure that the user has been set
869
#   Under windows USER may not be set, but USERNAME may be
299 dpurdie 870
#   As a last resort, use getlogin data
227 dpurdie 871
#
872
$USER = $ENV{ 'USERNAME' } || '' unless ( $USER );
873
$USER = $ENV{ 'LOGNAME' }  || '' unless ( $USER );
299 dpurdie 874
$USER = getlogin()         || '' unless ( $USER );
301 dpurdie 875
ReportError ('Cannot determine USER name, via USER, USERNAME, LOGNAME or getlogin')
876
    unless ( $USER );
299 dpurdie 877
#Debug ("User: ", $USER, $ENV{ 'USERNAME'}, $ENV{ 'LOGNAME' }, getlogin() );
878
 
227 dpurdie 879
################################################################################
375 dpurdie 880
#   Sanitize the EnvVars for Windows
227 dpurdie 881
#
375 dpurdie 882
#   It appears the %ENV is magical (in Win32)
883
#   The keys are case insensitive, even though the underlying env is not
884
#       Some of the Win32 binary tools used by JATS cannot handle lower
1329 dpurdie 885
#       case envVars. In particular Path/PATH.
375 dpurdie 886
#       This will also fix some issues within MAKE
227 dpurdie 887
#
375 dpurdie 888
#   Force all EnvVars to be uppercase
889
#       Need to delete the entry then reset it
227 dpurdie 890
#
4192 dpurdie 891
#   Note: Under windows the %ENV hash is special. Inserts are forced to uppercase
892
#   Note: Have issues with VS2012 and Cygwin. We end up with EnvVar tmp and TMP
893
#         This causes VS2012 to fail.
894
#
375 dpurdie 895
unless ( $GBE_JATS_SANE || $GBE_UNIX )
896
{
4969 dpurdie 897
    foreach my $var (keys %ENV)
375 dpurdie 898
    {
4969 dpurdie 899
        my $val = $ENV{$var};
375 dpurdie 900
        delete $ENV{$var};
4192 dpurdie 901
        delete $ENV{lc($var)};
375 dpurdie 902
        $ENV{$var} = $val;
903
    }
904
}
1329 dpurdie 905
 
906
#
907
#   Have a very strange issue with Solaris X86 and the buildtool
908
#   The GBE_MACHTYPE disappears from the environment
909
#   For some reason, deleting the PATH EnvVar and recreating it will fix it.
910
#
375 dpurdie 911
my $PATH = $ENV{'PATH'};
1329 dpurdie 912
delete $ENV{'PATH'};
913
$ENV{'PATH'} = $PATH;
227 dpurdie 914
 
1329 dpurdie 915
 
227 dpurdie 916
################################################################################
917
#   There is some really ugly interaction between Cygwin, ActiveState Perl 5.8.2
918
#   and xmake. Even if none of the cygwin bits are used within JATS the fact that
919
#   Cygwin is in the path causes problems.
920
#
921
#   Problems seen:
922
#       1) "jats build"     xmake fails with a segment fault. Possibly when
923
#                           displaying an error message
924
#       2) Warnings and messages generated from within Perl don't always appear
925
#          In particular. The output from a Message() within a PLATFORM/xxx file
926
#          does not get displayed.
927
#
928
#   Solution:
929
#       Remove cygwin from the PATH
930
#
931
$PATH =~ s~c:\\cygwin[^;]*;~~ig;
932
 
933
################################################################################
297 dpurdie 934
#   Setup the default JAVA_HOME
935
#   User should specify 1.4, 1.5,1.6 ....
936
#
6898 dpurdie 937
$JAVA_HOME = get_java_home ($opt_java) if ( $opt_java );
938
PathPrepend ("$JAVA_HOME/bin") if ( -d $JAVA_HOME );
297 dpurdie 939
 
343 dpurdie 940
################################################################################
941
#   Setup GBE_VIEWBASE
942
#   Ideally this should be configured externally
943
#
944
unless ( $GBE_VIEWBASE )
945
{
946
    if ( $GBE_UNIX ){
947
        my $HOME = $ENV{'HOME'};
948
        Error ("Unix HOME EnvVar not defined" ) unless ( $HOME );
949
        Error ("Unix HOME directory not found: $HOME" ) unless (-d $HOME );
950
        $GBE_VIEWBASE= "$HOME/jats_cbuilder";
951
    } else {
952
        $GBE_VIEWBASE= 'c:/clearcase';
953
    }
954
}
297 dpurdie 955
 
956
################################################################################
227 dpurdie 957
#   Ensure that the PATH contains the PERL executable
958
#   Need to true path to the PERL executable so that the user has access to some
959
#   of the perl utility programs such as pod2html
960
#
299 dpurdie 961
PathPrepend ($Config{'binexp'});
227 dpurdie 962
 
963
################################################################################
964
#   There is more ugliness if GBE_BIN is not in the users path
965
#   I suspect that it something within xmake (under win32) and that it needs
966
#   to be able to find sh within the path - even though its fully pathed
967
#
968
#   Add GBE_BIN to the start of the path to assist in searching
969
#   Also ensure that we pickup our version of utilities instead of random
970
#   versions.
971
#
297 dpurdie 972
PathPrepend ($GBE_BIN);
227 dpurdie 973
 
974
################################################################################
6898 dpurdie 975
# Under Windows - ensure that cmd.exe (or equivelent) is in the PATH
976
# Cygwin may remove it
977
# 
978
unless ( $GBE_JATS_SANE || $GBE_UNIX ) {
979
    if (exists $ENV{COMSPEC}) {
980
        $ENV{COMSPEC} =~ m~(.*)[\\/][^\\/]+~;
981
        $PATH = $PATH . $PSPLIT . $1;
982
    }
983
}
984
 
985
################################################################################
227 dpurdie 986
#   Clean PATH
987
#       Remove duplicates
988
#       Remove empty elements
989
#       Clean path endings
245 dpurdie 990
#       Place non-existent paths at the end. They will be seen, but not scanned
227 dpurdie 991
#
992
{
993
    my @new_path;
994
    my @non_exist;
995
    my %seen;
6898 dpurdie 996
    foreach ( split($PSPLIT, $PATH) )
227 dpurdie 997
    {
998
        s~[/\\]+$~~;                                # Remove trailing / or \
999
        my $name = ( $GBE_UNIX ) ? $_ : lc ($_);    # Windows is case insensitive
1000
        next unless ( $_ );                         # Remove empty elements
1001
        next if ( /^\.+$/ );                        # Remove . and ..
1002
        next if ( exists $seen{$name} );            # Remove duplicates
1003
        if ( -d $_ ) {
1004
            push @new_path, $_;                     # Exists
1005
        } else {
245 dpurdie 1006
            push @non_exist, $_;                    # Place non existent paths at the end
227 dpurdie 1007
        }
1008
        $seen{$name} = 1;
1009
    }
1010
    $PATH = join( $PSPLIT, @new_path, @non_exist );
1011
}
1012
 
1013
################################################################################
1014
#   Windows: Ensure that cmd.exe is in the users PATH
1015
#            If cmd.exe cannot be found then the 'system' command will not work
1016
#
317 dpurdie 1017
unless ( $GBE_JATS_SANE || $GBE_UNIX )
227 dpurdie 1018
{
1019
    my $cmd_found;
1020
    foreach ( split $PSPLIT, $PATH )
1021
    {
1022
        my $file = $_ . "/cmd.exe";
1023
        Verbose2 ("Look for: $file");
1024
        if ( -x $file  )
1025
        {
1026
            $cmd_found = 1;
1027
            Verbose ("Found: $file");
1028
            last;
1029
        }
1030
    }
1031
 
1032
    Warning( "Users PATH does not contain \"cmd.exe\"",
1033
             "System commands may not work" ) unless $cmd_found;
1034
}
1035
 
1036
################################################################################
1037
#   Sanitize the Microsoft Visual Studio environment variables LIB and INCLUDE.
1038
#   If these have a trailing \ then the generated makefiles
1039
#   will fail. This is impossible to detect and fix within make so do it here
1040
#
1041
#   Note: JATS no longer allows these environment variables through to the
1042
#         makefiles.
1043
#
317 dpurdie 1044
unless ( $GBE_JATS_SANE || $GBE_UNIX )
227 dpurdie 1045
{
369 dpurdie 1046
    for my $var (qw ( LIB INCLUDE ))
227 dpurdie 1047
    {
1048
        my $evar = $ENV{$var};
1049
        if ( $evar )
1050
        {
1051
            $evar =~ s~\\;~;~g;         # Remove trailing \ from components \; -> ;
1052
            $evar =~ s~\\$~~;           # Remove trailing \
1053
            $evar =~ s~;$~~;            # Remove trailing ;
1054
            $evar =~ s~;;~;~g;          # Remove empty items ;;
1055
            $ENV{$var} = $evar;
1056
        }
1057
    }
1058
}
1059
 
1060
################################################################################
297 dpurdie 1061
#   Update the environment variables used by JATS, unless requested otherwise.
227 dpurdie 1062
#
277 dpurdie 1063
#   If JATS is being used to startup build daemons, then we don't want to
1064
#   export many of the calculated values into the environment. In particular
1065
#   GBE_CORE, GBE_BIN, GBE_CONFIG and GBE_TOOLS must not be exported as it will
1066
#   prevent the daemon from picking up the 'current' version of JATS
1067
#
1068
#
287 dpurdie 1069
 
277 dpurdie 1070
if ( $opt_export_vars )
1071
{
1072
    $ENV{'PATH'}              = $PATH;
1073
    $ENV{'GBE_VERSION'}       = $GBE_VERSION;
1074
    $ENV{'GBE_CORE'}          = $GBE_CORE;
1075
    $ENV{'GBE_BIN'}           = $GBE_BIN;
1076
    $ENV{'GBE_CONFIG'}        = $GBE_CONFIG;
1077
    $ENV{'GBE_DPLY'}          = $GBE_DPLY;
1078
    $ENV{'GBE_DPKG'}          = $GBE_DPKG;
1079
    $ENV{'JATS_HOME'}         = $GBE_DPKG;
6276 dpurdie 1080
    $ENV{'GBE_DPKG_ESCROW'}   = $GBE_DPKG_ESCROW;
277 dpurdie 1081
    $ENV{'GBE_DPKG_CACHE'}    = $GBE_DPKG_CACHE;
4688 dpurdie 1082
    $ENV{'GBE_DPKG_REPLICA'}  = $GBE_DPKG_REPLICA;
277 dpurdie 1083
    $ENV{'GBE_DPKG_STORE'}    = $GBE_DPKG_STORE;
1084
    $ENV{'GBE_DPKG_LOCAL'}    = $GBE_DPKG_LOCAL;
1085
    $ENV{'GBE_SANDBOX'}       = $GBE_SANDBOX;
1086
    $ENV{'GBE_DPKG_SBOX'}     = $GBE_DPKG_SBOX;
1087
    $ENV{'GBE_PERL'}          = $GBE_PERL;
1088
    $ENV{'GBE_TOOLS'}         = $GBE_TOOLS;
1089
    $ENV{'GBE_MACHTYPE'}      = $GBE_MACHTYPE;
1090
    $ENV{'GBE_HOSTMACH'}      = $GBE_HOSTMACH;
1091
    $ENV{'GBE_PLATFORM'}      = $GBE_PLATFORM;
1092
    $ENV{'GBE_DRV'}           = $GBE_DRV;
1093
    $ENV{'PERL5LIB'}          = $PERL5LIB;
1094
    $ENV{'JAVA_HOME'}         = $JAVA_HOME if ($JAVA_HOME);
1095
    $ENV{'GBE_JATS_SANE'}     = 1;
1096
}
287 dpurdie 1097
else
1098
{
1099
    #
1100
    #   Delete, from the environment, values that are related to selecting
1101
    #   the version of JATS being used
1102
    #
5891 dpurdie 1103
    foreach ( qw( GBE_VERSION GBE_CORE GBE_BIN GBE_CONFIG GBE_TOOLS GBE_DRV PERL5LIB GBE_DPKG_SBOX GBE_SANDBOX GBE_PLATFORM GBE_JATS_SANE GBE_MAXMAKE ) )
287 dpurdie 1104
    {
1105
        delete $ENV{$_};
1106
    }
1107
}
277 dpurdie 1108
 
1109
#
1110
#   The following don't affect the operation of the build daemons selecting
1111
#   the current version of JATS. Some need to be passed through anyway
1112
#
227 dpurdie 1113
$ENV{'GBE_BUILDFILTER'}   = $GBE_BUILDFILTER;
277 dpurdie 1114
$ENV{'GBE_ABT'}           = $GBE_ABT if ($GBE_ABT);
227 dpurdie 1115
$ENV{'GBE_DEBUG'}         = $GBE_DEBUG;
1116
$ENV{'GBE_VERBOSE'}       = $GBE_VERBOSE;
1117
$ENV{'GBE_UNIX'}          = $GBE_UNIX;
1118
$ENV{'USER'}              = $USER;
279 dpurdie 1119
$ENV{'GBE_HOSTNAME'}      = $GBE_HOSTNAME;
343 dpurdie 1120
$ENV{'GBE_VIEWBASE'}      = $GBE_VIEWBASE;
361 dpurdie 1121
$ENV{'GBE_VCS'}           = $GBE_VCS;
227 dpurdie 1122
 
363 dpurdie 1123
#
1124
#   Warn users of potential problem
375 dpurdie 1125
#   Only do once. May change directory while getting here
1126
unless ( $GBE_JATS_SANE )
363 dpurdie 1127
{
1128
    Warning ("Current working directory contains spaces")
1129
        if ( $CWD =~ m/\s/ );
1130
}
1131
 
1132
 
227 dpurdie 1133
#-------------------------------------------------------------------------------
297 dpurdie 1134
# Function        : PathPrepend
1135
#
1136
# Description     : Prepend stuff to the PATH
1137
#
1138
# Inputs          : Items to prepend
1139
#
1140
# Returns         : Nothing
1141
#                   Modifies $PATH
1142
#
1143
sub PathPrepend
1144
{
299 dpurdie 1145
    foreach my $el ( @_ )
297 dpurdie 1146
    {
299 dpurdie 1147
        # Must NOT change the original argument, just a copy of it.
1148
        # Don't use $_ as this messes up too
1149
        my $item = $el;
297 dpurdie 1150
        $item =~ s~/~\\~g unless ( $GBE_UNIX );
1151
        $PATH = $item . $PSPLIT . $PATH;
1152
    }
1153
}
1154
 
1155
#-------------------------------------------------------------------------------
229 dpurdie 1156
# Function        : LocateJatsVersion
1157
#
245 dpurdie 1158
# Description     : Scan archives looking for a specified version of JATS
229 dpurdie 1159
#                   Complicated by the name change from core_devl to jats
245 dpurdie 1160
#                   that occurred circa version 2.71.7.
229 dpurdie 1161
#                   The required version may be in either of the packages
1162
#
4688 dpurdie 1163
#                   Ensure that package is complete
1164
#                   The caching process will write built.cache during the creation process
1165
#
229 dpurdie 1166
# Inputs          : $version            - Version to locate
1167
#
1168
# Returns         : undef               - if not found
1169
#                   Array of:
1170
#                       Repository
1171
#                       package/version
1172
#
1173
sub LocateJatsVersion
1174
{
1175
    my ($version) = @_;
1176
    my $package;
1177
    my $path;
1178
 
6276 dpurdie 1179
    foreach my $archive (qw ( GBE_DPKG_LOCAL GBE_DPKG_CACHE GBE_DPKG_ESCROW GBE_DPKG_REPLICA GBE_DPKG GBE_DPKG_STORE ))
229 dpurdie 1180
    {
1181
        no strict 'refs';
1182
        $path = ${$archive};
1183
        use strict 'refs';
1184
        next unless ( $path );
1185
 
369 dpurdie 1186
        foreach my $package (qw( jats core_devl ))
229 dpurdie 1187
        {
1188
            Verbose2( "ExamineDir: $path/$package/$version" );
1189
            if ( -d "$path/$package/$version" )
1190
            {
4688 dpurdie 1191
                unless (-f "$path/$package/$version/built.cache")
1192
                {
1193
                    return $path, "$package/$version", $archive;
1194
                }
229 dpurdie 1195
            }
1196
        }
1197
    }
283 dpurdie 1198
    return;
229 dpurdie 1199
}
1200
 
1201
 
1202
#-------------------------------------------------------------------------------
227 dpurdie 1203
# Function        : TestDirectoryConfig
1204
#
1205
# Description     : Sanity test a user configurable directory or file
1206
#                   Must not contain spaces
1207
#                   Must not be a network drive ie: //computer
1208
#
1209
# Inputs          :
1210
#
1211
# Returns         :
1212
#
1213
sub TestDirectoryConfig
1214
{
1215
    my ($dir) = @_;
1216
 
1217
    no strict 'refs';
1218
    my $val = ${$dir};
1219
 
1220
    if ( $val )
1221
    {
1222
        #
1223
        #   Cleanup the path
1224
        #
1225
        $val =~ tr~\\/~/~s;
1226
        $val =~ s~/+$~~;
255 dpurdie 1227
        $val = '' if ( $val eq '-' || $val eq 'none' );
227 dpurdie 1228
        ${$dir} = $val;
1229
 
1230
        ReportError("$dir path cannot contain spaces: $val") if ( $val =~ m/\s/ );
1231
        ReportError("$dir path cannot be a computer name: $val") if ( $val =~ m~^//~  );
1232
    }
1233
    use strict 'refs';
283 dpurdie 1234
    return;
227 dpurdie 1235
}
1236
 
1237
#-------------------------------------------------------------------------------
1238
# Function        : change_dir
1239
#
1240
# Description     : change directory to the specified directory
1241
#
1242
# Inputs          : $1      - Target directory
1243
#
1244
# Returns         :
1245
#
1246
sub change_dir
1247
{
1248
    my ($dir) = @_;
1249
 
363 dpurdie 1250
    if ( $dir && $dir ne '.' )
227 dpurdie 1251
    {
1252
        Verbose ("Changing to JATS build directory: $dir");
1253
        chdir $dir || Error ("Bad change directory: $dir");
363 dpurdie 1254
 
1255
        #
1256
        #   Reset the CWD
1257
        #   Note: Don't use `pwd`. This sucks for so many reasons including
1258
        #         the fact that it may not be available until this wrapper
1259
        #         script has done it job.
1260
        #
1261
        $CWD = getcwd();
367 dpurdie 1262
        Error ("Bad change directory: $dir","Cannot determine current directory - may be protected" )unless ( defined $CWD );
363 dpurdie 1263
        $CWD =~tr~\\/~/~s;
227 dpurdie 1264
    }
1265
}
1266
 
1267
#-------------------------------------------------------------------------------
277 dpurdie 1268
# Function        : scan_for_dir
1269
#
1270
# Description     : Scan from the current directory up to the root
1271
#                   of the current file system looking for a named
1272
#                   directory
1273
#
1274
# Inputs          : $target                 - Directory to locate
1275
#
1276
# Returns         : full_path               - Path of dir
1277
#                   full_dir                - Containng dir
1278
#
1279
 
1280
sub scan_for_dir
1281
{
1282
    my ($target) = @_;
1283
    Verbose2 ("Scan for $target");
1284
 
319 dpurdie 1285
    my $test_dir = $CWD || getcwd();
277 dpurdie 1286
    {
1287
        do
1288
        {
1289
            #
1290
            #   Stop at /home to prevent unix automounter spitting
1291
            #   lots of error messages
1292
            #
1293
            last if ( $test_dir =~ m~/home$~ );
1294
            Verbose2 ("Testing: $test_dir");
1295
 
1296
            my $test_path = $test_dir . '/' . $target;
1297
            if ( -d $test_path )
1298
            {
1299
                Verbose ("Found $target: $test_path");
1300
                return $test_path, $test_dir;
1301
            }
1302
            #
1303
            #   Remove one directory
1304
            #   Terminate the loop when no more can be removed
1305
            #
1306
        } while ( $test_dir =~ s~[/][^/]*$~~ );
1307
    }
1308
    return '','';
1309
}
1310
 
1311
#-------------------------------------------------------------------------------
227 dpurdie 1312
# Function        : get_java_home
1313
#
1314
# Description     : Convert user java option into a full path,or die
1315
#
1316
# Inputs          : User option
1317
#
1318
# Returns         : Full path
1319
#
1320
sub get_java_home
1321
{
1322
    my ($java) = @_;
1323
    my $jv = "JAVA_HOME_$java";
1324
    $jv =~ s~\.~_~g;
1325
 
1326
    unless ( exists($ENV{$jv}) )
1327
    {
1328
        Error ("Unknown JAVA version: $java",
1329
               "Looking for EnvVar: $jv",
1330
               "Example Usage: -java=1.5");
1331
    }
1332
    my $rv = $ENV{$jv};
1333
    unless ( -d $rv )
1334
    {
1335
        Error ("Java home path not found: $jv",
1336
               "Looking for: $rv" );
1337
    }
1338
    return $rv;
1339
}
1340
 
1341
#-------------------------------------------------------------------------------
1342
# Function        : get_version
1343
#
1344
# Description     : Return the version of JATS being run
1345
#                   JATS should be run from a "package"
1346
#                   The package should have a descpkg file
1347
#                   Use this file
1348
#
1349
# Inputs          :
1350
#
1351
# Returns         : A string
1352
#
1353
sub get_version
1354
{
229 dpurdie 1355
    #
1356
    #   The version number is embedded into this script by the release process
1357
    #   The text [V]ERSION_TAG will be replaced by the real version number
245 dpurdie 1358
    #   If this has not occurred then we know that the release is not official
229 dpurdie 1359
    #   Need to be a little bit careful about the tag name
1360
    #
1361
    return ("Unreleased Version. Version tag has not been set")
1362
        if ( $GBE_NOT_RELEASED );
1363
 
227 dpurdie 1364
    return "$GBE_VERSION [ Internal. Not an installed package ]"
1365
        if ( ! -f "$GBE_CORE/descpkg" );
1366
 
1367
    my $rec;
1368
    return $rec->{'VERSION_FULL'}
1369
        if ($rec = ReadDescpkg ( "$GBE_CORE/descpkg" ) );
1370
 
1371
    return "ERROR";
1372
}
1373
 
1374
#-------------------------------------------------------------------------------
1375
# Function        : print_version
1376
#
1377
# Description     :
1378
#
1379
# Inputs          :
1380
#
1381
# Returns         :
1382
#
1383
sub print_version
1384
{
1385
    #
1386
    #   Allow user to specify verboseness as an argument
1387
    #
1388
    foreach  ( @_ )
1389
    {
1390
        $GBE_VERBOSE++ if ( m/^-v/ );
1391
    }
1392
 
1393
    Message get_version();
1394
    Message "Internal: $GBE_VERSION" if ($GBE_VERBOSE);
1395
    $opr_done = 1;
283 dpurdie 1396
    return;
227 dpurdie 1397
}
1398
 
1399
 
1400
#-------------------------------------------------------------------------------
1401
#
1402
#   Give the user a clue
1403
#
1404
sub help
1405
{
1406
    my ($level) = @_;
1407
    $level = $opt_help unless ( $level );
1408
 
1409
    pod2usage(-verbose => 0, -message => "Version: ". get_version())  if ($level == 1 );
261 dpurdie 1410
    pod2usage(-verbose => $level - 1 );
227 dpurdie 1411
}
1412
 
1413
#-------------------------------------------------------------------------------
309 dpurdie 1414
# Function        : find_jats_dir
227 dpurdie 1415
#
309 dpurdie 1416
# Description     : Find a JATS build directory
1417
#                   Can be supressed with JATS '-here' command line option
227 dpurdie 1418
#
309 dpurdie 1419
# Inputs          : files               - Files to look for
1420
#                   options
1421
#                       --Ant           - Allow Ant files too
295 dpurdie 1422
#
309 dpurdie 1423
# Returns         : Will not return if not found
1424
#                   Will 'cd' to the build directory
1425
#
227 dpurdie 1426
sub find_jats_dir
1427
{
309 dpurdie 1428
    my $allow_ant;
1429
    my @FILES;
1430
    my $DIR;
1431
    my $check_file;
1432
 
227 dpurdie 1433
    #
1434
    #   Autodetect suppressed ?
1435
    #
1436
    return if ( $opt_here );
1437
 
309 dpurdie 1438
    #
1439
    #   Collect options
1440
    #   Collect the rest of the arguments
1441
    #
1442
    foreach ( @_ )
1443
    {
1444
        if ( m/^--Ant/ ) {
1445
            $allow_ant = 1;
1446
        }
1447
        else {
1448
            push @FILES, $_;
1449
        }
1450
    }
1451
 
227 dpurdie 1452
    push @FILES, @BUILD_FILE_ALT;
309 dpurdie 1453
    push @FILES, 'build.xml' if ( $allow_ant );
1454
 
1455
    #
1456
    #   Parent directories to search
1457
    #   Child dirs to search
1458
    #
227 dpurdie 1459
    my @SEARCH = qw( . .. ../.. ../../.. );
309 dpurdie 1460
    my @CHILD  = ('', '/jats', '/build', '/build/jats' );
227 dpurdie 1461
 
1462
    #
1463
    #   Locate the JATS build files
1464
    #   Allow the user to be in a number of parent directories
1465
    #
309 dpurdie 1466
    scan:
227 dpurdie 1467
    for my $ROOTDIR (@SEARCH)
1468
    {
309 dpurdie 1469
        for my $SUBDIR (@CHILD)
227 dpurdie 1470
        {
309 dpurdie 1471
            $DIR = $ROOTDIR . $SUBDIR;
227 dpurdie 1472
            next unless -d $DIR;
1473
 
283 dpurdie 1474
            for my $FILE ( @FILES)
227 dpurdie 1475
            {
309 dpurdie 1476
                $check_file = $DIR . '/' . $FILE;
227 dpurdie 1477
                Verbose2 ("Check for: $check_file");
309 dpurdie 1478
                last scan if ( -f $check_file );
1479
            }
1480
 
1481
            next unless ( $allow_ant );
1482
            foreach ( glob($DIR . '/*depends.xml' ) )
1483
            {
1484
                Verbose2 ("Check for: $_");
1485
                if ( m/(.+)depends.xml/ )
227 dpurdie 1486
                {
309 dpurdie 1487
                    $check_file = "$1.xml";
1488
                    last scan if ( -f $check_file );
227 dpurdie 1489
                }
1490
            }
1491
        }
309 dpurdie 1492
        $DIR = '';
227 dpurdie 1493
    }
309 dpurdie 1494
 
1495
    #
1496
    #   Change to the build directory if one has been found
1497
    #
1498
    if ( $DIR )
1499
    {
1500
        Verbose2 ("Found check file: $check_file");
1501
        change_dir ( $DIR );
1502
    }
1503
    else
1504
    {
1505
        Error ( 'JATS build directory not found.',
1506
                "Cannot locate: @FILES",
1507
                $allow_ant ? 'or Ant <Package>.xml <Package>depends.xml pair' : undef,
1508
                'Use -here option to supress this test'
1509
                );
1510
    }
227 dpurdie 1511
}
1512
 
1513
#-------------------------------------------------------------------------------
1514
#
295 dpurdie 1515
#   Determine the real build file to use
1516
#   Will select from a list of known build files.
227 dpurdie 1517
#
295 dpurdie 1518
sub getBuildFile
227 dpurdie 1519
{
1520
    my $build_file = $BUILD_FILE;
1521
    #
1522
    #   Use an alternative buildfile - if it exists
1523
    #   Do not use this file if the user has specified a buildfile
1524
    #
1525
    unless ( $BUILD_FILE_SET )
1526
    {
1527
        Verbose ("Search for alternate build file");
1528
        foreach my $test_file ( @BUILD_FILE_ALT )
1529
        {
1530
            Verbose2 ("Search for alternate build file: $test_file");
1531
            if ( -f $test_file )
1532
            {
1533
                $build_file = $test_file;
1534
                Message ("=== USING ALTERNATE BUILDFILE: $build_file ===");
1535
                last;
1536
            }
1537
        }
1538
    }
295 dpurdie 1539
   return $build_file;
1540
}
227 dpurdie 1541
 
295 dpurdie 1542
#-------------------------------------------------------------------------------
1543
#
1544
#   Kick off the build process
1545
#
1546
sub build
1547
{
4902 dpurdie 1548
    isaBuildMachine();
295 dpurdie 1549
    my $build_file = $BUILD_FILE;
1550
    (my $name = $CWD) =~ s~^.*/~~ ;
1551
    $opr_done = 1;
1552
 
1553
    find_jats_dir($build_file);
1554
    Message ("=== Building $name ===");
1555
    $build_file = getBuildFile();
1556
 
227 dpurdie 1557
    #
1558
    #   Jats/make does not handle file systems with spaces in the path names
1559
    #
1560
    Error('$CWD path cannot contain spaces') if ( $CWD =~ m/\s/ );
1561
 
333 dpurdie 1562
    $RESULT = System ($GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", @_ );
227 dpurdie 1563
 
283 dpurdie 1564
    Message ("=== Build $name NOT complete ===") if     ( $RESULT  );
1565
    Message ("=== Build $name complete ===")     unless ( $RESULT );
227 dpurdie 1566
    return $RESULT
1567
}
1568
 
1569
#-------------------------------------------------------------------------------
1570
# Function        : bmake_it
1571
#
1572
# Description     : Combo build and make operations
1573
#
1574
# Inputs          : ...     - COMMANDS or Make arguments.
1575
#                             Key commands are BUILD and INSTALL
1576
#
1577
# Returns         : RESULT code
1578
#
1579
sub bmake_it
1580
{
1581
    my @make_args = @_;
1582
    my $all = 1;
1583
    my $msg;
1584
    $opr_done = 1;
4902 dpurdie 1585
    isaBuildMachine();
227 dpurdie 1586
 
1587
    if ( $make_args[0] && $make_args[0] eq 'NOTALL' )
1588
    {
1589
        $all = 0;
1590
        shift @make_args;
1591
    }
1592
    elsif ( $make_args[0] && $make_args[0] eq 'BUILD' )
1593
    {
1594
        Verbose ("Makeit build") ;
1595
        $msg = "Component not built";
331 dpurdie 1596
        build('-noforce');
227 dpurdie 1597
        shift @make_args;
1598
    }
1599
 
1600
    unless ( $RESULT )
1601
    {
1602
        push @make_args, '-default=all' if ( $all );
1603
        Verbose ("Makeit make @make_args") ;
1604
 
309 dpurdie 1605
        find_jats_dir( 'makefile.pl', 'Makefile.gbe', $BUILD_FILE );
227 dpurdie 1606
        Error ("No Makefile.gbe file found") unless ( -f 'Makefile.gbe' );
1607
 
1608
        etool ( 'jmake.pl', @make_args );
1609
        $msg = "Component not made";
1610
        @make_args = ();
1611
    }
1612
 
1613
 
1614
    Verbose ("Makeit Result: $RESULT") ;
1615
    Error ( $msg ) if ( $RESULT );
1616
    return  if ( $RESULT );
1617
}
1618
 
1619
#-------------------------------------------------------------------------------
1620
# Function        : dev_expand
1621
#
1622
# Description     : Expand the users arguments to the "debug/prod" command
1623
#                   "debug/prod" builds and packages debug stuff
1624
#
1625
#                   Ignore make options.
1626
#
1627
# Inputs          : target
1628
#                   Argument list
1629
#
1630
# Returns         : expanded argument list
1631
#
1632
sub dev_expand
1633
{
1634
    my @resultd;
1635
    my @resultp;
1636
    my @args;
1637
    my @opts;
1638
 
1639
    #
1640
    #   Remove options from the argument list
1641
    #
1642
    foreach ( @_ )
1643
    {
1644
        if ( m~=~ || m~^-~ ) {
1645
            push @opts, $_;
1646
        } else {
1647
            push @args, $_;
1648
        }
1649
    }
1650
 
1651
    my $target = shift @args;
1652
    my @cmd = $target;
1653
    if ( $#args < 0 )
1654
    {
1655
        push @cmd, "package_$target";
1656
    }
1657
    else
1658
    {
1659
        foreach ( @args )
1660
        {
1661
            push @resultd, $_ . "_$target";
1662
            push @resultp, $_ . "_package_$target";
1663
            @cmd = ();
1664
        }
1665
    }
1666
 
1667
    return (@cmd, @resultd, @resultp, @opts);
1668
}
1669
 
1670
#-------------------------------------------------------------------------------
1671
# Function        : install_pkg
1672
#
1673
# Description     : Install the built package into local_dpkg_archive
1674
#                   This will make it available for use, without populating the
1675
#                   global archive
1676
#
1677
#                   This is done through an external utility to maintain
1678
#                   consistent interface
1679
#
1680
sub install_pkg
1681
{
1682
 
309 dpurdie 1683
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1684
    etool ( 'create_dpkg.pl', '-archive=local', '-quiet', '-override',  @_ );
1685
}
1686
 
1687
#-------------------------------------------------------------------------------
1688
# Function        : create_dpkg
1689
#
1690
# Description     : Install a package into the main dpkg_archive
1691
#                   This is done through an external utility to maintain
1692
#                   consistent interface
1693
#
1694
#                   This function is simply an easy way to access the utility
1695
 
1696
sub create_dpkg
1697
{
309 dpurdie 1698
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1699
    etool ( 'create_dpkg.pl',  @_ );
1700
}
1701
 
1702
#-------------------------------------------------------------------------------
1703
# Function        : etool
1704
#
1705
# Description     : Invoke an external tool program written in PERL
1706
#
1707
# Arguments       : $1  Name of the program to run
1708
#                       With optional .pl suffix
1709
#                   $2+ Program arguments
1710
#
1711
sub etool
1712
{
1713
    my $command = shift;
1714
    my $cmd;
1715
    my @etool_path = ( "$ENV{'GBE_TOOLS'}",
1716
                       "$ENV{'GBE_TOOLS'}/DEPLOY",
379 dpurdie 1717
                       "$ENV{'GBE_TOOLS'}/LOCAL",
1718
                        );
227 dpurdie 1719
    if ( $command )
1720
    {
1721
        #
1722
        #   Locate a potential tool
1723
        #   These will have the user name or a .pl extension
1724
        #
1725
        ETOOL_SEARCH:
1726
        foreach my $ext ( '', '.pl' )
1727
        {
1728
            foreach my $dir ( @etool_path )
1729
            {
297 dpurdie 1730
                $cmd = "$dir/jats_$command$ext";
1731
                last ETOOL_SEARCH if ( -f $cmd );
1732
 
227 dpurdie 1733
                $cmd = "$dir/$command$ext";
1734
                last ETOOL_SEARCH if ( -f $cmd );
1735
            }
1736
            $cmd='';
1737
        }
1738
 
1739
        Error ("Tool not found: $command", "Search path:", @etool_path) unless $cmd;
1740
        $RESULT = System ( $GBE_PERL, $cmd, @_ );
1741
    }
1742
    else
1743
    {
1744
        #
1745
        #   Display on the .pl commands
1746
        #
1747
        display_commands("Available Tools", \@etool_path, ['*.pl'] );
1748
    }
1749
 
1750
    $opr_done = 1;
1751
}
1752
 
1753
#-------------------------------------------------------------------------------
1754
# Function        : ebin
1755
#
1756
# Description     : Invoke an external JATS provided binary
1757
#                   within the JATS toolset
1758
#
1759
# Arguments       : $1  Name of the program to run
1760
#                   $2+ Program arguments
1761
#
1762
sub ebin
1763
{
1764
    my $command = shift;
1765
    my $cmd;
1766
    my @ebin_path = ( "$GBE_BIN" );
1767
 
1768
    if ( $command )
1769
    {
1770
        #
1771
        #   Locate a potential executable
1772
        #   This
1773
        #
1774
        ETOOL_SEARCH:
1775
        foreach my $ext ( '', '.exe', '.sh' )
1776
        {
1777
            foreach my $dir ( @ebin_path )
1778
            {
1779
                $cmd = "$dir/$command$ext";
1780
                last ETOOL_SEARCH if ( -f $cmd );
1781
            }
1782
            $cmd='';
1783
        }
1784
 
1785
        Error ("Program not found: $command", "Search path:", @ebin_path) unless $cmd;
1786
        $RESULT = System ( $cmd, @_ );
1787
    }
1788
    else
1789
    {
1790
        #
1791
        #   Display a list of programs
1792
        #
1793
        display_commands("Available Programs", \@ebin_path, ['*'] );
1794
    }
1795
 
1796
    $opr_done = 1;
1797
}
1798
 
1799
#-------------------------------------------------------------------------------
1800
# Function        : eprog
1801
#
1802
# Description     : Invoke an external program
1803
#                   Will detect local .pl files and execute them
1804
#                   Will detect local .jar files and execute them
229 dpurdie 1805
#                   Will detect local .bat files and execute them
227 dpurdie 1806
#
1807
# Arguments       : $1  Name of the program to run
1808
#                   $2+ Program arguments
1809
#
1810
sub eprog
1811
{
229 dpurdie 1812
    Verbose ("eprog: @_");
315 dpurdie 1813
    my $name = fix_command_name (shift @_);
227 dpurdie 1814
    Error ("eprog. No program specified") unless ( $name );
1815
 
229 dpurdie 1816
    $name .= ".pl"     if ( -f "${name}.pl" );
1817
    $name .= ".jar"    if ( -f "${name}.jar" );
1818
    $name .= ".bat"    if ( -f "${name}.bat" );
227 dpurdie 1819
 
229 dpurdie 1820
    #
245 dpurdie 1821
    #   On Windows programs in the CWD will be found
1822
    #   Mimic this behaviour on Unix
229 dpurdie 1823
    #
1824
    $name = "./$name" if ( $name !~ m~/~ && -f "./$name");
1825
 
227 dpurdie 1826
    if ( $name =~ m~\.pl$~ ) {
1827
        $RESULT = System ( $GBE_PERL, $name, @_ );
1828
 
1829
    } elsif ( $name =~  m~\.jar$~ ) {
1830
        $RESULT = System ( "$JAVA_HOME/bin/java", '-jar', $name, @_);
1831
 
1832
    } else {
229 dpurdie 1833
        #
1834
        #   Ensure .bat files are pathed with \, and not / characters
1835
        #   The windows command interpreter does not like /
1836
        #
1837
        $name =~ s~/~\\~g if ( $name =~ m~\.bat$~ );
1838
 
227 dpurdie 1839
        $RESULT = System ( $name, @_ );
1840
    }
1841
 
1842
    $opr_done = 1;
1843
}
1844
 
1845
#-------------------------------------------------------------------------------
1846
# Function        : display_commands
1847
#
1848
# Description     : Display a list of commands from a specified list of dirs
1849
#                   Internal helper function
1850
#
1851
# Inputs          : $title      - Display header
1852
#                   $ref_path   - Ref to an array that contains the search path
1853
#                   $ref_ext    - Ref to an array of valid patterns
1854
#
1855
# Returns         : Nothing
1856
#
1857
sub display_commands
1858
{
1859
    my ( $title, $ref_path, $ref_ext ) = @_;
1860
 
1861
    #
1862
    #   Display a list of commands
1863
    #
1864
    my %list;
1865
    foreach ( @$ref_path )
1866
    {
1867
        foreach my $ext ( @$ref_ext )
1868
        {
1869
            foreach my $file (  glob( "$_/$ext") )
1870
            {
1871
                $file =~ s~.*/~~ unless $GBE_VERBOSE;
1872
                $list{$file} = 1;
1873
            }
1874
        }
1875
    }
1876
 
1877
    my $count = 0;
1878
    my $limit = $GBE_VERBOSE ? 1 : 3;
1879
    print "$title:\n";
1880
    foreach ( sort keys %list )
1881
    {
1882
        printf "%-26s", $_;
1883
        print "\n" if ( !( ++$count % $limit) );
1884
    }
1885
}
1886
 
1887
#-------------------------------------------------------------------------------
315 dpurdie 1888
# Function        : fix_command_name
1889
#
1890
# Description     : Fix a command name parameter
1891
#                   Simplify use of cygwin for some users by allowing
1892
#                   that path of external tools to be a cygwin path
1893
#
1894
# Inputs          : cmd             - command
1895
#
1896
# Returns         : cleaned up version of cmd
1897
#
1898
sub fix_command_name
1899
{
1900
    my ($cmd) = @_;
1901
 
1902
    unless ( $GBE_UNIX )
1903
    {
1904
        #
1905
        #   Cygwin kludge
1906
        #       Replace /cygdrive/DriveLetter/ - with DriveLetter:/
1907
        #       Replace /DriveLetter/          - With DriveLetter:/
1908
        #
1909
        $cmd =~ s~^/cygdrive/([A-Z])/(.*)~$1:/$2~i;
1910
        $cmd =~ s~^/([A-Z])/(.*)~$1:/$2~i;
1911
    }
1912
    return $cmd;
1913
}
1914
 
1915
 
1916
#-------------------------------------------------------------------------------
227 dpurdie 1917
# Function        : run_ant
1918
#
1919
# Description     : Invoke ant
399 dpurdie 1920
#                   If the current directory looks like an VIX build system, then
227 dpurdie 1921
#                   create and maintain an auto.xml file. Otherwise simply invoke ant
1922
#
1923
# Inputs          : $1+ program arguments
1924
#
1925
sub run_ant
1926
{
4902 dpurdie 1927
    isaBuildMachine();
227 dpurdie 1928
    my $JAVA_HOME = $ENV{JAVA_HOME} || Error ("JAVA_HOME is not defined in the environment");
1929
    my $ANT_HOME  = $ENV{ANT_HOME}  || Error ("ANT_HOME is not defined in the environment" );
1930
 
1931
    #
399 dpurdie 1932
    #   Detect an VIX formatted build
227 dpurdie 1933
    #   This will have two files <projectname>.xml and <projectname>depends.xml
1934
    #   Create the 'auto.xml' file only if its not present
1935
    #
1936
    my @ant_arg;
1937
    my @flist;
1938
    my $basename = '';
235 dpurdie 1939
    my $scanner = '*depends.xml';
227 dpurdie 1940
 
1941
    #
1942
    #   Use specified build file to resolve multiple names
1943
    #   Strip any trailing depends.xml to make it user friendly
1944
    #
1945
    if ( $BUILD_FILE_SET )
1946
    {
1947
        $basename = $BUILD_FILE;
1948
        $basename =~ s~\.xml$~~;
1949
        $basename =~ s~depends$~~;
235 dpurdie 1950
        $scanner = "${basename}depends.xml";
227 dpurdie 1951
        Verbose ("Using buildfile: $basename");
1952
    }
1953
 
235 dpurdie 1954
    my @buildlist = glob($scanner);
227 dpurdie 1955
    foreach ( @buildlist )
1956
    {
1957
        if ( m/(.+)depends.xml/ )
1958
        {
1959
            my $pname = $1;
1960
            push @flist, $pname if ( -f "$pname.xml" );
1961
        }
1962
    }
1963
 
1964
    if ( $#flist >= 0 )
1965
    {
1966
        Error ("Multiple depends.xml files found:", @flist,
297 dpurdie 1967
               "Use 'jats -buildfile=name ant ...' to resolve") if ( $#flist > 0 );
227 dpurdie 1968
 
1969
        my $depend = "$flist[0]depends.xml";
1970
        @ant_arg = ('-f', "$flist[0].xml");
1971
 
1972
        Message ("Ant using projectfiles: $flist[0].xml");
1973
 
1974
        #
367 dpurdie 1975
        #   Create auto.xml if we have a depends.xml
227 dpurdie 1976
        #
367 dpurdie 1977
        if ( -f $depend )
227 dpurdie 1978
        {
367 dpurdie 1979
            #
1980
            #   Check for depends.xml newer than auto.xml.
1981
            #
1982
            my $auto_timestamp   = (stat('auto.xml'))[9] || 0;
1983
            my $depend_timestamp = (stat($depend))[9];
1984
            if ( $depend_timestamp > $auto_timestamp )
1985
            {
1986
                Message ("Creating: auto.xml");
1987
                copy( $depend, 'auto.xml' );
1988
                chmod 0777, 'auto.xml';
1989
            }
227 dpurdie 1990
        }
367 dpurdie 1991
        else
1992
        {
1993
            Warning ("Project file does not have a depends.xml file");
1994
        }
227 dpurdie 1995
    }
1996
    elsif ( $BUILD_FILE_SET  )
1997
    {
1998
        Error ("Specified build file pair not found:", $basename, $basename . "depends.xml");
1999
    }
2000
    #
2001
    #   The ant provided startup scripts don't return an exit code under
2002
    #   windows. Invoke ant directly
2003
    #
2004
    launch_ant ( $JAVA_HOME, $ANT_HOME, @ant_arg, @_ );
2005
    $opr_done = 1;
2006
}
2007
 
2008
#-------------------------------------------------------------------------------
2009
# Function        : run_abt
2010
#
2011
# Description     : Invoke auto build tool (older form)
2012
#                   Options for the ABT
2013
#                       --Java=x.x
2014
#                   Invoke ANT for the ABT using a specified version of Java
2015
#                   Do not play with the user environment.
297 dpurdie 2016
#                   Don't stick java path into environment
227 dpurdie 2017
#
2018
# Inputs          : $1+ program arguments
2019
#
2020
sub run_abt
2021
{
279 dpurdie 2022
    my $ABT_JAVA = 'JAVA_HOME_1_6';         # Default version for the ABT
227 dpurdie 2023
    my $JAVA_HOME = $ENV{$ABT_JAVA};
2024
    my $ANT_HOME  = $ENV{ANT_HOME};
2025
    my @abt_arg;
239 dpurdie 2026
    my $buildfile = 'build.xml';
227 dpurdie 2027
 
2028
    ErrorConfig( 'name'    => 'JATS ABT' );
4902 dpurdie 2029
    isaBuildMachine();
227 dpurdie 2030
 
2031
    #
239 dpurdie 2032
    #   Use the user specified buildfile
2033
    #
2034
    $buildfile = $BUILD_FILE
2035
        if ( $BUILD_FILE_SET );
2036
 
2037
    #
227 dpurdie 2038
    #   Extract known options
2039
    #
2040
    foreach  ( @_ )
2041
    {
2042
        if ( m/-java=(.*)/ ) {
2043
            $JAVA_HOME = get_java_home($1);
239 dpurdie 2044
 
2045
        } elsif ( m/^-buildfile=(.+)/ ) {
2046
            $buildfile = $1;
2047
 
227 dpurdie 2048
        } else {
2049
            push @abt_arg, $_;
2050
        }
2051
    }
2052
 
2053
    Error ("$ABT_JAVA is not defined in the environment") unless $JAVA_HOME;
2054
    Error ("ANT_HOME is not defined in the environment" ) unless $ANT_HOME;
239 dpurdie 2055
    Error ("Ant buildfile not found: $buildfile" ) unless (-f $buildfile);
227 dpurdie 2056
 
2057
    #
239 dpurdie 2058
    #   Insert correct build file arguments
2059
    #
279 dpurdie 2060
    push @abt_arg, '-buildfile', $buildfile;
2061
 
2062
    #
2063
    #   Add current directory as java library directory, but only if
2064
    #   it contains JAR files.
2065
    #
2066
    push @abt_arg, '-lib', $CWD
2067
        if ( glob ('*.jar') );
239 dpurdie 2068
 
2069
    #
227 dpurdie 2070
    #   Use the ant-launcher to invoke ant directly
2071
    #
2072
    launch_ant ( $JAVA_HOME, $ANT_HOME, @abt_arg );
2073
    $opr_done = 1;
2074
}
2075
 
2076
#-------------------------------------------------------------------------------
2077
# Function        : launch_ant
2078
#
2079
# Description     : Start ANT - with sanity checking
2080
#
2081
# Inputs          : JAVA_HOME
2082
#                   ANT_HOME
2083
#                   @user_args
2084
#
2085
# Returns         : Result Code
2086
#
2087
sub launch_ant
2088
{
2089
    my ($JAVA_HOME, $ANT_HOME, @user_args ) = @_;
2090
 
2091
    Error ("Directory not found: $JAVA_HOME") unless ( -d "$JAVA_HOME" );
2092
    Error ("Program not found: $JAVA_HOME/bin/java") unless ( -e "$JAVA_HOME/bin/java" || -e "$JAVA_HOME/bin/java.exe" );
2093
    Error ("Jar not found: $ANT_HOME/lib/ant-launcher.jar") unless ( -e "$ANT_HOME/lib/ant-launcher.jar" );
2094
    Error ("Directory not found: $ANT_HOME") unless ( -d "$ANT_HOME" );
2095
    Error ("Directory not found: $ANT_HOME/lib") unless ( -d "$ANT_HOME/lib" );
2096
 
2097
    #
4688 dpurdie 2098
    #   Documented KLUDGE
2099
    #   The 'ant-using' mechanism only understands GBE_DPKG
2100
    #   This is not good in a cloud build configuration where GBE_DPKG_REPLICA is the fastest repository
5568 dpurdie 2101
    #   Solution: In an GBE_ABT environment IFF GBE_DPKG_REPLIA exists then set GBE_DPKG and JATS_HOME
4688 dpurdie 2102
    #
2103
    if ($GBE_ABT && $GBE_DPKG_REPLICA)
2104
    {
2105
        $ENV{GBE_DPKG_ORIGINAL} = $ENV{GBE_DPKG};
2106
        $ENV{GBE_DPKG} = $ENV{GBE_DPKG_REPLICA};
5568 dpurdie 2107
        $ENV{JATS_HOME} = $ENV{GBE_DPKG_REPLICA};
4688 dpurdie 2108
        Message("Setting GBE_DPKG to GBE_DPKG_REPLICA");
2109
    }
2110
 
2111
    #
227 dpurdie 2112
    #   Use the ant-launcher to invoke ant directly
2113
    #
2114
    $RESULT = System ( "$JAVA_HOME/bin/java",
4688 dpurdie 2115
                       #"-agentlib:jdwp=transport=dt_socket,server=y,address=8000,suspend=y",      # Enable Remote Debug
227 dpurdie 2116
                       "-classpath","$ANT_HOME/lib/ant-launcher.jar",
2117
                       "-Dant.home=$ANT_HOME",
2118
                       "org.apache.tools.ant.launch.Launcher",
2119
                       "-lib","$ANT_HOME/lib",
2120
                       @user_args
2121
                       );
2122
 
2123
   return $RESULT;
2124
}
2125
 
2126
 
2127
#-------------------------------------------------------------------------------
2128
#
2129
#   Cleanup the sandbox
2429 dpurdie 2130
#   Perform a "make clean" then a "build clobber"
227 dpurdie 2131
#
2132
sub clobber
2133
{
4902 dpurdie 2134
    isaBuildMachine();
227 dpurdie 2135
    Message ("=== Removing ======");
2136
    find_jats_dir( $BUILD_FILE );
295 dpurdie 2137
    my $build_file = getBuildFile();
2138
 
227 dpurdie 2139
 
2140
    #
2429 dpurdie 2141
    #   Run a "make clean" to clean out a lot of stuff
2142
    #   Run a "build clobber" to get rid of interface and local directories
227 dpurdie 2143
    #
2429 dpurdie 2144
    etool ( 'jmake.pl', 'clean' )
227 dpurdie 2145
        if ( -f "Makefile.gbe" );
2146
 
295 dpurdie 2147
    if ( -f $build_file )
227 dpurdie 2148
    {
333 dpurdie 2149
        System ( $GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", 'clobber' );
227 dpurdie 2150
    }
2151
    else
2152
    {
2153
        Error ("Cannot clobber. No buildfile found");
2154
    }
2155
 
2156
    Message ("=== Remove complete ===");
2157
    $opr_done = 1;
2158
}
2159
 
2160
#-------------------------------------------------------------------------------
2161
# Function        : do_exit
2162
#
2163
# Description     : Common exit point so that time information can be displayed
2164
#
2165
# Inputs          : Optional exit code
2166
#
2167
# Returns         :
2168
#
2169
sub do_exit
2170
{
2171
    my ($ecode) = @_;
2172
 
2173
    $RESULT = $ecode if ( $ecode );
2174
 
2175
    #..
2176
    #   Determine the runtime
363 dpurdie 2177
    #       $^T is the time that the program started
227 dpurdie 2178
    #
2179
    if ( $opt_time )
2180
    {
2181
        my ($TIMEU, $TIMES) = times;
363 dpurdie 2182
        my $TIMER = time - $^T;
2183
        my $m = int($TIMER / 60);
2184
        my $s = $TIMER - ($m * 60);
227 dpurdie 2185
 
2186
        Message ( "Times: Real: $m:$s, User: $TIMEU, System: $TIMES");
2187
    }
2188
    #.
2189
    #   Make sure that any important exit code is passed to the user
2190
    #
2191
    Verbose ("ExitCode: $RESULT");
2192
    exit $RESULT;
2193
}
2194
 
4902 dpurdie 2195
#-------------------------------------------------------------------------------
2196
# Function        : isaBuildMachine 
2197
#
2198
# Description     : Test that this machine is a build machine
2199
#                   One that supports compilation
2200
#                   Jats may be installed on machines where it may be used in 
2201
#                   a support mode but not to build software. ie: auperaunx01
2202
#
2203
# Inputs          : None
2204
#
2205
# Returns         : May not return 
2206
#
2207
sub isaBuildMachine
2208
{
2209
    if ($notaBuildMachine)
2210
    {
2211
        Error("This machine does not support JATS for building software.",
2212
              "This machine does support JATS for the purpose of running support utilities.");
2213
    }
2214
 
2215
 
2216
}
2217
 
2218
 
227 dpurdie 2219
########################################################################
2220
#
2221
#   Main body of the script
2222
#
2223
#   Process help and manual options
2224
#       Done after all the setup to ensure that the PATH is correct
2225
#       Done before bombout to give user a chance
2226
#
379 dpurdie 2227
 
2228
#
2229
#   Redirect all output to a log file
2230
#   Only perform redirection AFTER we have setup the users environment
2231
#       May change this.
2232
#
2233
if ( $opt_logfile )
2234
{
2235
    open STDOUT, '>', $opt_logfile  or die "Can't redirect STDOUT: $!";
2236
    open STDERR, ">&STDOUT"         or die "Can't dup STDOUT: $!";
2237
}
2238
 
227 dpurdie 2239
help() if $opt_help;
2240
ErrorDoExit();  # Exit if any error in setup
2241
ErrorConfig( 'on_exit'    => \&do_exit );
2242
 
2243
#
231 dpurdie 2244
#   Reset operational flags.
2245
#   May have been used by setup
2246
#
2247
$opr_done = 0;
2248
$RESULT = 0;
2249
 
2250
#
227 dpurdie 2251
#   Process user commands
2252
#
263 dpurdie 2253
my $cmd = shift @ARGV || help(1);
227 dpurdie 2254
 
2255
print_version(@ARGV)                    if ( $cmd =~ m/^ver/ );
2256
 
2257
clobber                                 if ( $cmd =~ m/^clobber$/ );
2258
build    (@ARGV)                        if ( $cmd =~ m/^build$/ );
2259
 
2260
bmake_it ('NOTALL', @ARGV)              if ( $cmd =~ m/^[x]*make$/ );
2261
bmake_it (@ARGV)                        if ( $cmd =~ m/^go$/ );
2262
bmake_it (dev_expand('debug', @ARGV) )  if ( $cmd =~ m/^debug$/ );
2263
bmake_it (dev_expand('prod', @ARGV) )   if ( $cmd =~ m/^prod$/ );
2264
bmake_it ("clean", @ARGV)               if ( $cmd =~ m/^clean$/ );
2265
bmake_it ("rebuild", @ARGV)             if ( $cmd =~ m/^rebuild$/ );
2266
bmake_it ('BUILD', @ARGV)               if ( $cmd =~ m/^all$/ );
2267
bmake_it ($cmd, @ARGV )                 if ( $cmd =~ m/^run_unit_tests/ );
2268
 
2269
install_pkg(@ARGV)                      if ( $cmd =~ m/^install$/ );
2270
create_dpkg(@ARGV)                      if ( $cmd =~ m/^create_dpkg$/ );
2271
 
2272
ebin  (@ARGV)                           if ( $cmd =~ m/^ebin/ );
2273
etool (@ARGV)                           if ( $cmd =~ m/^etool/ );
2274
eprog (@ARGV)                           if ( $cmd =~ m/^eprog$/ );
2275
run_ant (@ARGV)                         if ( $cmd =~ m/^ant$/ );
2276
run_abt (@ARGV)                         if ( $cmd =~ m/^abt$/ );
2277
 
299 dpurdie 2278
etool ('cache_dpkg', @ARGV)                         if ( $cmd =~ m/^dpkg/ );
2279
etool ('gen_msprojects', @ARGV)                     if ( $cmd =~ m/^gen_msproject/ );
361 dpurdie 2280
etool ("jats_${GBE_VCS}release.pl", @ARGV)                  if ( $cmd =~ m/^release/ );
2281
etool ("jats_${GBE_VCS}release.pl", '-extractfiles' ,@ARGV) if ( $cmd =~ m/^extractf/ );
2282
etool ("jats_${GBE_VCS}release.pl", '-extract' ,@ARGV)      if (!$opr_done && $cmd =~ m/^extract/ );
383 dpurdie 2283
 
2284
etool ("jats_svnrelease.pl", '-extractfiles' ,@ARGV) if ( $cmd =~ m/^svnextractf/ );
2285
etool ("jats_svnrelease.pl", '-extract' ,@ARGV)      if (!$opr_done && $cmd =~ m/^svnextract/ );
2286
 
361 dpurdie 2287
etool ("jats_${GBE_VCS}label", @ARGV)                       if ( $cmd =~ m/^label$/ );
299 dpurdie 2288
etool ('jats_sandbox', @ARGV)                       if ( $cmd =~ m/^sandbox$/ );
313 dpurdie 2289
etool ('jats_help', @ARGV)                          if ( $cmd =~ m/^help$/ );
325 dpurdie 2290
etool ('jats_help', '-man', @ARGV)                  if ( $cmd =~ m/^man$/ );
315 dpurdie 2291
etool ('jats_vars.pl', @ARGV)                       if ( $cmd =~ m/^var/ );
227 dpurdie 2292
 
2293
etool ($cmd, @ARGV)                     unless ($opr_done); # Pass to etool if not known
2294
 
2295
do_exit();
2296
#.
2297
 
2298
#-------------------------------------------------------------------------------
2299
#   Documentation
2300
#
2301
 
2302
=pod
2303
 
361 dpurdie 2304
=for htmltoc    CORE::AA::Jats
2305
 
227 dpurdie 2306
=head1 NAME
2307
 
2308
jats - JATS utility interface tool
2309
 
2310
=head1 SYNOPSIS
2311
 
277 dpurdie 2312
 Usage: jats [opts] command [cmd-options]
227 dpurdie 2313
 
2314
 Where opts:
261 dpurdie 2315
    -h, -h -h, -man=[n] - Help messages with increasing verbosity
227 dpurdie 2316
    -cd dir             - Change to specified directory
2317
    -b file             - Use alternate build file
261 dpurdie 2318
    -verbose[=n]        - Verbose operation
2319
    -debug[=n]          - Enable debug mode of JATS scripts
227 dpurdie 2320
    -here               - Disable JATS auto locate of build.pl
2321
    -locate             - Locate build.pl file and change to directory
245 dpurdie 2322
    -locatepkg=pkg      - Locate build.pl. Resolve multiple files via pkg
2764 dpurdie 2323
    -locatefile=file    - Locate specified build file and change to directory
321 dpurdie 2324
    -locatedir=name     - Locate specified directory by scanning to the root
227 dpurdie 2325
    -platform=[name]    - Set GBE_PLATFORM to name   (=+ to append)
2326
    -buildfilter=[xxx]  - Set GBE_BUILDFILTER to xxx (=+ to append)
2327
    -abt=[xxx]          - Set GBE_ABT to xxx (=+ to append)
349 dpurdie 2328
    -java=version       - Alters java version used (1.4, 1.5, 1.6)
227 dpurdie 2329
    -time               - Time build and compile times
2330
    -version=xxx        - Use specified version of JATS
277 dpurdie 2331
    -[no]exportvars     - Export sanitised JATS EnvVars (default)
379 dpurdie 2332
    -logfile=xxxx       - All output is redirected to the specified file
6177 dpurdie 2333
    -[no]script         - Suppress JATS messages.
227 dpurdie 2334
 
331 dpurdie 2335
 Common commands include:
227 dpurdie 2336
    build               - Rebuild the sandbox and makefiles
2337
    make                - Make one or more components
2338
    ant                 - Invoke an ant build
2339
    abt [-java=xxx]     - Invoke the auto build tool
2340
    install             - Install package into local_dpkg_archive
2341
    help                - Display help message
325 dpurdie 2342
    man                 - Display extended help message
227 dpurdie 2343
    vars                - Display JATS related environment variables
2344
 
2345
    create_dpkg         - Install a package into main dpkg_archive
2346
    label               - Labelling functions
6353 dpurdie 2347
    release             - Build a release from a VCS label/tag
2348
    extract             - Extract a release from a VCS label/tag
227 dpurdie 2349
    dpkg_cache          - Maintain a dpkg cache
2350
    gen_msproject       - Generate MSVC project files
361 dpurdie 2351
    sandbox             - Run Sandbox utility
299 dpurdie 2352
 
227 dpurdie 2353
    etool name          - Run internal tool
2354
    eprog name          - Run external tool
2355
    ebin name           - Run JATS binary tool
2356
 
2357
 Shortcut commands. Composites of basic commands
331 dpurdie 2358
    all [opt]           - Same as a "build -noforce" and "make all"
227 dpurdie 2359
    go  [opt]           - Same as a "make all"
2360
    debug [tgt]         - Same as "make debug package_debug"
2361
    prod  [tgt]         - Same as "make prod package_prod"
2362
    clean               - Same as "make clean"
2363
    clobber             - Same as "build clobber"
2364
    *                   - Unknown commands are treated as arguments to etool
2365
 
2366
 Where [cmd-options] are command specific.
325 dpurdie 2367
    Try "jats help command" for details
227 dpurdie 2368
 
2369
=head1 OPTIONS
2370
 
2371
=over 8
2372
 
2373
=item B<-help>
2374
 
2375
Print a brief help message and exits.
2376
 
2377
=item B<-help -help>
2378
 
2379
Print a detailed help message with an explanation for each option.
2380
 
261 dpurdie 2381
=item B<-man[=n]>
227 dpurdie 2382
 
2383
Prints the manual page and exits.
2384
 
261 dpurdie 2385
If a numeric manual level is provide then it will be used to control the
361 dpurdie 2386
verbosity of help provided. This should be in the range of 1 to 3.
261 dpurdie 2387
 
227 dpurdie 2388
=item B<-b file> B<-buildfile file>
2389
 
2390
This option modifies the operation of the "build" command. The command will
2391
use the specified file instead of the normal build.pl file.
2392
 
2393
=item B<-cd dir> B<-changedir dir>
2394
 
2395
This option will change to specified directory before the command is invoked.
2396
 
261 dpurdie 2397
=item B<--verbose[=n]>
227 dpurdie 2398
 
2399
This option will increase the level of verbosity of the JATS command and command
261 dpurdie 2400
invoked by the JATS shell.
227 dpurdie 2401
 
261 dpurdie 2402
If an argument is provided, then it will be used to set the level, otherwise the
2403
existing level will be incremented. This option may be specified multiple times.
227 dpurdie 2404
 
261 dpurdie 2405
=item B<-debug[=n]>
2406
 
227 dpurdie 2407
This option will increase the level of debug output of the JATS command and command
261 dpurdie 2408
invoked by the JATS shell.
227 dpurdie 2409
 
261 dpurdie 2410
If an argument is provided, then it will be used to set the level, otherwise the
2411
existing level will be incremented. This option may be specified multiple times.
2412
 
227 dpurdie 2413
=item B<-here>
2414
 
2415
This option will disable the "autolocate" mechanism of the JATS shell script.
2416
 
2417
By default JATS will "hunt" for a suitable "build.pl" or "makefile.pl" before
2418
executing a build or a make command. JATS will look in the following directories
2419
for a  suitable file. Under some conditions this mechanism is not useful.
2420
 
2421
By default JATS will hunt in the following directories: "." "jats" "build/
2422
jats" ".." "../.." and "../../..".
2423
 
2424
=item B<-locate>
2425
 
2426
This option will cause the JATS wrapper script to locate the build.pl file and
2427
then change to that directory. This allows users to locate the build root of
2428
a project and then issue other JATS commands.
2429
 
2430
If the B<-c> option is also specified then searching will start in the specified
2431
directory.
2432
 
2433
If an alternate build file is specified with the B<-b> option then that filename
2434
will be used in the location process.
2435
 
2436
This option implies a B<-here>. No further scanning will be done.
2437
 
2438
Exactly one build file must be located. If more than buildfile is located then
2439
the locations of the build files is displayed and JATS will terminate.
2440
 
245 dpurdie 2441
 
2442
=item B<-locatepkg=packagename>
2443
 
2444
This option is similar to the B<-locate> option, but it allows the required
2445
build files to be located by ensuring that the required buildfile builds the
2446
specified package.
2447
 
2448
There are two forms in which the B<packagename> can be specified. It can be
361 dpurdie 2449
specified as a full package name and version, or as a package name and the
245 dpurdie 2450
project suffix. ie: jats-api.1.0.0000.cr or jats-api.cr
2451
 
227 dpurdie 2452
=item B<-locatefile=file>
2453
 
2454
This option is similar to the B<-locate> option, but it allows the name of the
2764 dpurdie 2455
build file to be located to be specified.
227 dpurdie 2456
 
2764 dpurdie 2457
If the named file has an '.xml' suffix then the process will look for a pair of
2458
ANT build files of the form xxx.xml and xxxdepends.xml.
2459
 
319 dpurdie 2460
=item B<-locatedir=name>
2461
 
2462
Locate the named directory by scanning from the current directory to the root
321 dpurdie 2463
of the filesystem. This operation is performed before any other location
319 dpurdie 2464
operations and before the B<-cd=path> operation.
2465
 
2466
It may be used to position the jats operation at the root of a view - provided
2467
the view root is known.
2468
 
227 dpurdie 2469
=item B<-platform=[name]>
2470
 
2471
This option will set the JATS specific environment variable GBE_PLATFORM to
2472
the specified name. The existing value of GBE_PLATFORM may be extended by
2473
using "=+".
2474
 
2475
In practice the GBE_PLATFORM variable is of little use. The same effect can be
2476
achieved directly with make targets or with GBE_BUILDFILTER.
2477
 
2478
=item B<-buildfilter=[xxx]>
2479
 
2480
This option will set the JATS specific environment variable GBE_BUILDFILTER to
2481
the specified name. The existing value of GBE_BUILDFILTER may be extended by
2482
using "=+".
2483
 
2484
This option may be used to limit the initial build, and subsequent "make" to a
2485
limited set of platforms.
2486
 
2487
=item B<-abt=[xxx]>
2488
 
2489
This option will set the JATS specific environment variable GBE_ABT to
2490
the specified name The existing value of GBE_ABT may be extended by
2491
using "=+"..
2492
 
2493
This option is used to pass arguments directly to some tools within the
2494
(ABT) Auto Build Tool framework, or to indicate that the build is being
2495
performed within the ABT framework.
2496
 
2497
=item B<-java=version>
2498
 
2499
This option will override the default java version used by the ant builds and
2500
passed to the underlying programs. The path to the Java SDK is determined from
2501
the environment using the version string replacing the '.' with '_'
2502
 
2503
eg: -java=1.5, will examine the environment for JAVA_HOME_1_5 and will set
2504
JAVA_HOME to that value. It will not setup the users PATH or classpath.
2505
 
2506
=item B<-time>
2507
 
2508
When this option is enabled the JATS script will report the runtime of the
2509
underlying, invoked, command.
2510
 
2511
=item B<-version=xxx>
2512
 
2513
When this option is invoked JATS will attempt to use the specified version to
2514
perform all processing. JATS will search the GBE_DPKG_LOCAL, GBE_DPKG_CACHE,
4688 dpurdie 2515
GBE_DPKG_REPLICA, GBE_DPKG, GBE_DPKG_STORE in order to locate the specified 
2516
version of the package.
227 dpurdie 2517
 
2518
The entire command line will be passed to the JATS wrapper script within that
2519
version. This bypasses the jats.bat or jats.sh startup scripts.
2520
 
277 dpurdie 2521
JATS will attempt to transfer the target version to the local cache in an
2522
attempt to improve performance.
227 dpurdie 2523
 
277 dpurdie 2524
=item B<-[no]exportvars>
227 dpurdie 2525
 
361 dpurdie 2526
The default operation is to export sanitized and calculated values to the
277 dpurdie 2527
programs running under JATS. The use of NoExportVars will prevent JATS from
2528
exporting modified EnvVars into the environment. This may be required by
2529
processes, such as the build daemons that need to pick up the current version of
2530
JATS on the fly and not have it fixed when the daemon is started.
227 dpurdie 2531
 
379 dpurdie 2532
=item B<-logfile=xxxx>
2533
 
2534
This option will cause all output to be redirected to the named logroll. Both
2535
STDOUT and STDERR will be redirected.
2536
 
2537
The redirection occurs after the sanity testing that JATS performs and before the
2538
user command is invoked. The redirection occurs after any directory change option
2539
is executed.
2540
 
2541
Output redirection continues until the program terminates. If JATS invokes other
2542
programs or scripts, there default output will also be redirected.
2543
 
6177 dpurdie 2544
=item B<-[no]script>
2545
 
2546
This option will suppress some internal warning messages, generated by the JATS wrapper
2547
script. It is intended to allow JATS to be used with a shell script without the output 
2548
being polluted with internal warnings.
2549
 
2550
The default operation is to show internal warnings. 
2551
 
227 dpurdie 2552
=back
2553
 
2554
=head1 ARGUMENTS
2555
 
2556
=head2 Basic Commands
2557
 
2558
The following commands are invoked directly by the JATS script to wrap the build
2559
tools in a controlled manner.
2560
 
2561
=over 8
2562
 
361 dpurdie 2563
=item L<build|TOOLS::buildlib>
227 dpurdie 2564
 
2565
Build or rebuild the sandbox and makefiles.
2566
 
2567
This command must be used before the component can be "made" and when the
2568
contents of the "buildpl" file change. It is a common mistake to use the "build"
2569
command to much.
2570
 
2571
The script will hunt for a suitable build.pl file before running the build and
2572
make subcommands.
2573
 
361 dpurdie 2574
The build process has a large number of options.
2575
Use L<"JATS build help"|TOOLS::buildlib/"item_help"> to display the complete list.
227 dpurdie 2576
 
361 dpurdie 2577
=item L<make|TOOLS::jmake>
227 dpurdie 2578
 
2579
Make one or more components
2580
 
2581
This command will invoke a suitable "make" program on the makefile found in
2582
the current directory. This makefile should have been generated by JATS.
2583
 
361 dpurdie 2584
The make process has a large number of options. Use
2585
L<"JATS make help"|TOOLS::jmake/"item_help">" to display the complete list.
227 dpurdie 2586
 
2587
=item B<ant>
2588
 
2589
This command will use ANT to build a component. JATS will determine the
2590
build.xml file to use with the following algorithm.
2591
 
2592
    If the files called <Project>depends.xml and <Project>.xml exist then JATS
2593
    will create an 'auto.xml' from the depends file, if one does not already
2594
    exist or is older than the depends.xml file and then use the <Project>.xml
2595
    file as the ant build file.
2596
 
2597
    Otherwise ant is invoked and it will expect a build.xml file.
2598
 
2599
If multiple <Project>depends.xml and <Project>.xml file pairs are found the
2600
command will fail. This can be resolved through the use of the -buildfile=name
2601
option.
2602
 
2603
Ant is invoked with the version of Java specified with the -Java=x.x option.
2604
 
2605
=item B<abt>
2606
 
2607
This command is used to invoke the Auto Build Tool. It will invoke ANT on the
2608
build.xml file in the current directory in such  manner as to not affect the
239 dpurdie 2609
environment of the programs running under ANT.
227 dpurdie 2610
 
361 dpurdie 2611
The remainder of the command line is passed to the ABT, with the exception of
239 dpurdie 2612
the options:
2613
 
2614
=over 8
2615
 
361 dpurdie 2616
=item *
2617
 
2618
-java=x.x. This is used to control the version of Java used by the
349 dpurdie 2619
ABT. The default is 1.6.
227 dpurdie 2620
 
361 dpurdie 2621
=item *
2622
 
2623
-buildfile=name. This is used to provide a different build file to ant.
239 dpurdie 2624
The default build file is 'build.xml'.
2625
 
2626
=back
2627
 
361 dpurdie 2628
=item L<help|TOOLS::jats_help>
227 dpurdie 2629
 
2630
Display the basic help message.
2631
 
361 dpurdie 2632
=item L<vars [-v]|TOOLS::jats_vars>
227 dpurdie 2633
 
2634
This command will display all the JATS related environment variables in a
2635
readable form.
2636
 
2637
Additional information will be displayed if an argument of "-v" is provided.
2638
 
2639
=back
2640
 
2641
=head2 Extended Commands
2642
 
2643
The following commands support the build environment. They are supplemental to
2644
the build environment. They are implemented as extensions to the basic JATS
2645
command scripts.
2646
 
2647
=over 8
2648
 
361 dpurdie 2649
=item L<create_dpkg|TOOLS::create_dpkg>
227 dpurdie 2650
 
2651
This command will install a generated package into main dpkg_archive. This
2652
command should not be used directly by a user as it does not ensure that package
2653
has been created in a repeatable manner - use "jats release".
2654
 
361 dpurdie 2655
=item label
227 dpurdie 2656
 
2657
This command provides a number of useful labelling mechanisms to assist in the
2658
labeling of source code.
2659
 
361 dpurdie 2660
The command will determine the default Version Control System and invoke the VCS
2661
specific utility. This will be one of:
227 dpurdie 2662
 
361 dpurdie 2663
=over 4
227 dpurdie 2664
 
361 dpurdie 2665
=item   *
2666
 
2667
ClearCase: L<cclabel|TOOLS::jats_cclabel>
2668
 
2669
=item   *
2670
 
2671
Subversion: L<svnlabel|TOOLS::jats_svnlabel>
2672
 
2673
=back
2674
 
2675
=item release
2676
 
2677
This command allows a package to be built and released, given a label.
2678
This is the desired release mechanism for manually releasing a package.
2679
 
227 dpurdie 2680
The command has two main uses:
2681
 
361 dpurdie 2682
=over 4
227 dpurdie 2683
 
2684
=item 1
2685
 
2686
Build a package for release. The process will ensure that the build is
2687
controlled and repeatable.
2688
 
2689
=item 2
2690
 
2691
Rebuild a package for test or debugging purposes.
2692
 
2693
=back
2694
 
361 dpurdie 2695
The command will determine the default Version Control System and invoke the VCS
2696
specific utility. This will be one of:
227 dpurdie 2697
 
361 dpurdie 2698
=over 4
2699
 
2700
=item   *
2701
 
2702
ClearCase: L<ccrelease|TOOLS::jats_ccrelease>
2703
 
2704
=item   *
2705
 
2706
Subversion: L<svnrelease|TOOLS::jats_svnrelease>
2707
 
2708
=back
2709
 
2710
=item L<extract|/"release">
2711
 
227 dpurdie 2712
This is the same as "release -extract"
2713
 
2714
 
361 dpurdie 2715
=item L<dpkg_cache|TOOLS::cache_dpkg>
227 dpurdie 2716
 
2717
This utility provides a number of commands to maintain the local cache of
245 dpurdie 2718
dpkg_archive.
227 dpurdie 2719
 
361 dpurdie 2720
=item L<gen_msproject|TOOLS::gen_msprojects>
227 dpurdie 2721
 
2722
This utility will generate a set of Microsoft Studio (Version 6) project and
361 dpurdie 2723
workspace files to encapsulate the JATS build. The resultant project allows
2724
Visual Studio to be used as an editor, source browser, debugger and build tool.
2725
JATS is still used to perform the build.
227 dpurdie 2726
 
361 dpurdie 2727
=item B<install>
2728
 
2729
This command will install a generated "package" into the local_dpkg_archive
2730
directory. This allows a group of packages to be tested before being published
2731
into the global dpkg_archive.
2732
 
2733
=for htmlclass Note
2734
 
2735
Note. This command is no longer needed. The "build" process will place a
2736
shortcut in the local_dpkg_archive to a components "pkg" directory. Other
2737
components will utilize this shortcut directly and pickup the package without
2738
the user needing to "install" the package - a step that can be forgotten.
2739
 
227 dpurdie 2740
=item B<etool name>
2741
 
2742
This command allows any JATS extension program to be run. The programs will by
2743
found in the JATS TOOLS directory.
2744
 
2745
=item B<eprog name>
2746
 
2747
This command allows any JATS extension program to be run.
2748
If the program end in .pl, then it will be run within a perl interpreter.
2749
If the program end in .jar, then it will be run under a java interpreter.
2750
 
2751
=item B<ebin name>
2752
 
2753
This command allows any JATS support program to be run. The programs will by
2754
found in the JATS BIN directory for the current platform. This command allows
2755
a user script to access many of the machine independent utilities in a simple
2756
manner.
2757
 
2758
Example: "JATS ebin ls" - will provide a "real" ls on all platforms.
2759
 
2760
Example: "JATS ebin sh" - will start up the shell used by make.
2761
 
2762
=back
2763
 
2764
=head2 Command Shortcuts
2765
 
2766
The following commands are user shortcuts to the basic commands. The are basic
2767
commands run in sequence.
2768
 
2769
=over 8
2770
 
2771
=item B<all [make_opts]>
2772
 
2773
This command is the same as running the command "build" and "make all".
2774
It will build a component with a single command.
2775
 
2776
If "make_opts" is not present then "make all" is used.
2777
 
2778
If "make_opts" is present then they are passed to the "make" command. In this
2779
manner is it possible to build a WIN32 component of package with a single
2780
command.
2781
 
2782
=item B<go [make_opts]>
2783
 
2784
This command is similar to the "all" shortcut, but it does not "build" the
2785
sandbox. It may be used where the sandbox has already been prepared.
2786
 
2787
=item B<debug [target]>
2788
 
2789
This command is the same as running "make debug package_debug". It will make and
2790
package all the debug components of a sandbox.
2791
 
2792
If any additional arguments are provided to the B<dev> command then they will be
2793
treated as make targets and the commands will be expanded to make and package
2794
the specified debug versions of the names platforms. Make options cannot be
2795
passed in this manner.
2796
 
2797
Example: "JATS dev GAK" will create and package the debug parts for the
2798
GAK_MOS68K and GAK_MOSCF.
2799
 
2800
=item B<prod [target]>
2801
 
2802
This command is the same as running "make prod package_prod". It will make and
2803
package all the debug components of a sandbox.
2804
 
2805
If any additional arguments are provided to the B<prod> command then they will be
2806
treated as make targets and the commands will be expanded to make and package
2807
the specified debug versions of the names platforms. Make options cannot be
2808
passed in this manner.
2809
 
2810
Example: "JATS prod GAK" will create and package the production parts for the
2811
GAK_MOS68K and GAK_MOSCF.
2812
 
2813
=item B<clean>
2814
 
2815
This is the same as "make clean".
2816
 
2817
=item B<clobber>
2818
 
2819
This is the same as "build clobber"
2820
 
2821
=item B<else>
2822
 
2823
Commands that are not known to the JATS wrapper script are passed to etool.
2824
 
2825
ie: "JATS xxxx" is is the same as "JATS etool xxxx".
2826
 
2827
=back
2828
 
2829
=head1 DESCRIPTION
2830
 
2831
JATS is a wrapper script. It provides:
2832
 
361 dpurdie 2833
=over 4
227 dpurdie 2834
 
2835
=item *
2836
 
361 dpurdie 2837
A controlled and sanitized environment to all the build tools.
227 dpurdie 2838
 
2839
=item *
2840
 
2841
The same command interface on all supported machines: Windows, Solaris and
2842
Linux.
2843
 
2844
=item *
2845
 
2846
Provides a framework for extending the build environment toolset.
2847
 
2848
=back
2849
 
315 dpurdie 2850
=head1 RELATED DOCUMENTATION
227 dpurdie 2851
 
361 dpurdie 2852
=over 4
227 dpurdie 2853
 
361 dpurdie 2854
=item   * L<Installation Notes|POD::InstallationNotes>
227 dpurdie 2855
 
361 dpurdie 2856
=item   * L<OverView|POD::OverView>
227 dpurdie 2857
 
361 dpurdie 2858
=item   * L<EnvVars|POD::EnvVars>
255 dpurdie 2859
 
361 dpurdie 2860
=item   * L<PkgArchives|POD::PkgArchives>
227 dpurdie 2861
 
2862
=back
2863
 
361 dpurdie 2864
Use L<jats help|TOOLS::jats_help> to see the available internal documentation.
227 dpurdie 2865
 
315 dpurdie 2866
=head1 EXAMPLES
227 dpurdie 2867
 
315 dpurdie 2868
=over 8
227 dpurdie 2869
 
361 dpurdie 2870
=item   L<JATS help|TOOLS::jats_help>
227 dpurdie 2871
 
315 dpurdie 2872
This will display the available internal documentation.
227 dpurdie 2873
 
361 dpurdie 2874
=item   L<JATS build|TOOLS::buildlib>
227 dpurdie 2875
 
315 dpurdie 2876
This will prime the current package being built ready for "make". The command
2877
will locate the build.pl file and process it. This will locate all the external
2878
packages and generate the required makefiles.
227 dpurdie 2879
 
361 dpurdie 2880
=item   L<JATS make|TOOLS::jmake>
227 dpurdie 2881
 
2882
This will run the GNU make program over the makefiles generated by the "build"
2883
command. This may be executed in a subdirectory in order to limit the targets
2884
that are "made".
2885
 
361 dpurdie 2886
=for htmlclass Note
2887
 
227 dpurdie 2888
B<NOTE:> Do not run "make" without using the JATS wrapper. It will not perform
2889
as expected as the environment will not have been set up correctly.
2890
 
2891
=back
2892
 
2893
=cut
2894