Subversion Repositories DevTools

Rev

Rev 7324 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
227 dpurdie 1
#! perl
2
########################################################################
7300 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;
7300 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'}     || '';
7319 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,
7300 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
7300 dpurdie 295
#                   unless we are processing with a script
399 dpurdie 296
#
297
# Inputs          : global: @endWarnings
298
#
299
END
300
{
301
    Message (@endWarnings)
7300 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' );
7319 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" );
7323 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
 
7323 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
#
7323 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" ;
7323 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 );
7319 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
 
7320 dpurdie 822
    ($GBE_DPKG_SBOX,$GBE_SANDBOX)  = scan_for_dir ('sandbox_dpkg_archive');
823
    if ($GBE_SANDBOX)
241 dpurdie 824
    {
7320 dpurdie 825
        #
826
        #   Support for auto detection of Build System Sandboxes
827
        #   
828
        my $sbAbtMarker = $GBE_DPKG_SBOX . '/abtMarker';
829
        if ( -f $sbAbtMarker ) {
830
            $GBE_ABT=1;
831
        }
3559 dpurdie 832
 
7320 dpurdie 833
        #
834
        #   Support sandbox specific buildfilter
835
        #   Remove comments(#) and empty lines
836
        #
837
        my $sbBuildFilter = $GBE_DPKG_SBOX . '/buildfilter';
838
        if ( -f $sbBuildFilter )
3559 dpurdie 839
        {
7320 dpurdie 840
            Verbose("sbBuildFilter:$sbBuildFilter");
841
            if ( open (my $BF, $sbBuildFilter ))
3559 dpurdie 842
            {
7320 dpurdie 843
                my @bf;
844
                while ( <$BF> )
845
                {
846
                    s~\s$~~;
847
                    s~^\s~~;
848
                    next unless ( $_ );
849
                    next if ( m~^#~ );
850
                    push @bf,$_;
851
                }
852
                close $BF;
853
                if ( @bf )
854
                {
855
                    $GBE_BUILDFILTER = join (' ', split( /[,\s]+/, join(',', @bf)));
856
                    Verbose ("Local BuildFilter: $GBE_BUILDFILTER");
857
                }
3559 dpurdie 858
            }
859
        }
860
    }
227 dpurdie 861
}
862
 
7322 dpurdie 863
#
864
#   Base buildfilter will be Machine or Sandbox
865
#   Now merge in user specified build filters
866
#
867
map opts_extend( \$GBE_BUILDFILTER, '', $_ ) , @opt_buildfilter;
868
 
227 dpurdie 869
########################################################################
870
#
871
#   Ensure that the user has been set
872
#   Under windows USER may not be set, but USERNAME may be
299 dpurdie 873
#   As a last resort, use getlogin data
227 dpurdie 874
#
875
$USER = $ENV{ 'USERNAME' } || '' unless ( $USER );
876
$USER = $ENV{ 'LOGNAME' }  || '' unless ( $USER );
299 dpurdie 877
$USER = getlogin()         || '' unless ( $USER );
301 dpurdie 878
ReportError ('Cannot determine USER name, via USER, USERNAME, LOGNAME or getlogin')
879
    unless ( $USER );
299 dpurdie 880
#Debug ("User: ", $USER, $ENV{ 'USERNAME'}, $ENV{ 'LOGNAME' }, getlogin() );
881
 
227 dpurdie 882
################################################################################
375 dpurdie 883
#   Sanitize the EnvVars for Windows
227 dpurdie 884
#
375 dpurdie 885
#   It appears the %ENV is magical (in Win32)
886
#   The keys are case insensitive, even though the underlying env is not
887
#       Some of the Win32 binary tools used by JATS cannot handle lower
1329 dpurdie 888
#       case envVars. In particular Path/PATH.
375 dpurdie 889
#       This will also fix some issues within MAKE
227 dpurdie 890
#
375 dpurdie 891
#   Force all EnvVars to be uppercase
892
#       Need to delete the entry then reset it
227 dpurdie 893
#
4192 dpurdie 894
#   Note: Under windows the %ENV hash is special. Inserts are forced to uppercase
895
#   Note: Have issues with VS2012 and Cygwin. We end up with EnvVar tmp and TMP
896
#         This causes VS2012 to fail.
897
#
375 dpurdie 898
unless ( $GBE_JATS_SANE || $GBE_UNIX )
899
{
4969 dpurdie 900
    foreach my $var (keys %ENV)
375 dpurdie 901
    {
4969 dpurdie 902
        my $val = $ENV{$var};
375 dpurdie 903
        delete $ENV{$var};
4192 dpurdie 904
        delete $ENV{lc($var)};
375 dpurdie 905
        $ENV{$var} = $val;
906
    }
907
}
1329 dpurdie 908
 
909
#
910
#   Have a very strange issue with Solaris X86 and the buildtool
911
#   The GBE_MACHTYPE disappears from the environment
912
#   For some reason, deleting the PATH EnvVar and recreating it will fix it.
913
#
375 dpurdie 914
my $PATH = $ENV{'PATH'};
1329 dpurdie 915
delete $ENV{'PATH'};
916
$ENV{'PATH'} = $PATH;
227 dpurdie 917
 
1329 dpurdie 918
 
227 dpurdie 919
################################################################################
920
#   There is some really ugly interaction between Cygwin, ActiveState Perl 5.8.2
921
#   and xmake. Even if none of the cygwin bits are used within JATS the fact that
922
#   Cygwin is in the path causes problems.
923
#
924
#   Problems seen:
925
#       1) "jats build"     xmake fails with a segment fault. Possibly when
926
#                           displaying an error message
927
#       2) Warnings and messages generated from within Perl don't always appear
928
#          In particular. The output from a Message() within a PLATFORM/xxx file
929
#          does not get displayed.
930
#
931
#   Solution:
932
#       Remove cygwin from the PATH
933
#
934
$PATH =~ s~c:\\cygwin[^;]*;~~ig;
935
 
936
################################################################################
297 dpurdie 937
#   Setup the default JAVA_HOME
938
#   User should specify 1.4, 1.5,1.6 ....
939
#
7323 dpurdie 940
$JAVA_HOME = get_java_home ($opt_java) if ( $opt_java );
941
PathPrepend ("$JAVA_HOME/bin") if ( -d $JAVA_HOME );
297 dpurdie 942
 
343 dpurdie 943
################################################################################
944
#   Setup GBE_VIEWBASE
945
#   Ideally this should be configured externally
946
#
947
unless ( $GBE_VIEWBASE )
948
{
949
    if ( $GBE_UNIX ){
950
        my $HOME = $ENV{'HOME'};
951
        Error ("Unix HOME EnvVar not defined" ) unless ( $HOME );
952
        Error ("Unix HOME directory not found: $HOME" ) unless (-d $HOME );
953
        $GBE_VIEWBASE= "$HOME/jats_cbuilder";
954
    } else {
955
        $GBE_VIEWBASE= 'c:/clearcase';
956
    }
957
}
297 dpurdie 958
 
959
################################################################################
227 dpurdie 960
#   Ensure that the PATH contains the PERL executable
961
#   Need to true path to the PERL executable so that the user has access to some
962
#   of the perl utility programs such as pod2html
963
#
299 dpurdie 964
PathPrepend ($Config{'binexp'});
227 dpurdie 965
 
966
################################################################################
967
#   There is more ugliness if GBE_BIN is not in the users path
968
#   I suspect that it something within xmake (under win32) and that it needs
969
#   to be able to find sh within the path - even though its fully pathed
970
#
971
#   Add GBE_BIN to the start of the path to assist in searching
972
#   Also ensure that we pickup our version of utilities instead of random
973
#   versions.
974
#
297 dpurdie 975
PathPrepend ($GBE_BIN);
227 dpurdie 976
 
977
################################################################################
7323 dpurdie 978
# Under Windows - ensure that cmd.exe (or equivelent) is in the PATH
979
# Cygwin may remove it
980
# 
981
unless ( $GBE_JATS_SANE || $GBE_UNIX ) {
982
    if (exists $ENV{COMSPEC}) {
983
        $ENV{COMSPEC} =~ m~(.*)[\\/][^\\/]+~;
984
        $PATH = $PATH . $PSPLIT . $1;
985
    }
986
}
987
 
988
################################################################################
227 dpurdie 989
#   Clean PATH
990
#       Remove duplicates
991
#       Remove empty elements
992
#       Clean path endings
245 dpurdie 993
#       Place non-existent paths at the end. They will be seen, but not scanned
227 dpurdie 994
#
995
{
996
    my @new_path;
997
    my @non_exist;
998
    my %seen;
7323 dpurdie 999
    foreach ( split($PSPLIT, $PATH) )
227 dpurdie 1000
    {
1001
        s~[/\\]+$~~;                                # Remove trailing / or \
1002
        my $name = ( $GBE_UNIX ) ? $_ : lc ($_);    # Windows is case insensitive
1003
        next unless ( $_ );                         # Remove empty elements
1004
        next if ( /^\.+$/ );                        # Remove . and ..
1005
        next if ( exists $seen{$name} );            # Remove duplicates
1006
        if ( -d $_ ) {
1007
            push @new_path, $_;                     # Exists
1008
        } else {
245 dpurdie 1009
            push @non_exist, $_;                    # Place non existent paths at the end
227 dpurdie 1010
        }
1011
        $seen{$name} = 1;
1012
    }
1013
    $PATH = join( $PSPLIT, @new_path, @non_exist );
1014
}
1015
 
1016
################################################################################
1017
#   Windows: Ensure that cmd.exe is in the users PATH
1018
#            If cmd.exe cannot be found then the 'system' command will not work
1019
#
317 dpurdie 1020
unless ( $GBE_JATS_SANE || $GBE_UNIX )
227 dpurdie 1021
{
1022
    my $cmd_found;
1023
    foreach ( split $PSPLIT, $PATH )
1024
    {
1025
        my $file = $_ . "/cmd.exe";
1026
        Verbose2 ("Look for: $file");
1027
        if ( -x $file  )
1028
        {
1029
            $cmd_found = 1;
1030
            Verbose ("Found: $file");
1031
            last;
1032
        }
1033
    }
1034
 
1035
    Warning( "Users PATH does not contain \"cmd.exe\"",
1036
             "System commands may not work" ) unless $cmd_found;
1037
}
1038
 
1039
################################################################################
1040
#   Sanitize the Microsoft Visual Studio environment variables LIB and INCLUDE.
1041
#   If these have a trailing \ then the generated makefiles
1042
#   will fail. This is impossible to detect and fix within make so do it here
1043
#
1044
#   Note: JATS no longer allows these environment variables through to the
1045
#         makefiles.
1046
#
317 dpurdie 1047
unless ( $GBE_JATS_SANE || $GBE_UNIX )
227 dpurdie 1048
{
369 dpurdie 1049
    for my $var (qw ( LIB INCLUDE ))
227 dpurdie 1050
    {
1051
        my $evar = $ENV{$var};
1052
        if ( $evar )
1053
        {
1054
            $evar =~ s~\\;~;~g;         # Remove trailing \ from components \; -> ;
1055
            $evar =~ s~\\$~~;           # Remove trailing \
1056
            $evar =~ s~;$~~;            # Remove trailing ;
1057
            $evar =~ s~;;~;~g;          # Remove empty items ;;
1058
            $ENV{$var} = $evar;
1059
        }
1060
    }
1061
}
1062
 
1063
################################################################################
297 dpurdie 1064
#   Update the environment variables used by JATS, unless requested otherwise.
227 dpurdie 1065
#
277 dpurdie 1066
#   If JATS is being used to startup build daemons, then we don't want to
1067
#   export many of the calculated values into the environment. In particular
1068
#   GBE_CORE, GBE_BIN, GBE_CONFIG and GBE_TOOLS must not be exported as it will
1069
#   prevent the daemon from picking up the 'current' version of JATS
1070
#
1071
#
287 dpurdie 1072
 
277 dpurdie 1073
if ( $opt_export_vars )
1074
{
1075
    $ENV{'PATH'}              = $PATH;
1076
    $ENV{'GBE_VERSION'}       = $GBE_VERSION;
1077
    $ENV{'GBE_CORE'}          = $GBE_CORE;
1078
    $ENV{'GBE_BIN'}           = $GBE_BIN;
1079
    $ENV{'GBE_CONFIG'}        = $GBE_CONFIG;
1080
    $ENV{'GBE_DPLY'}          = $GBE_DPLY;
1081
    $ENV{'GBE_DPKG'}          = $GBE_DPKG;
1082
    $ENV{'JATS_HOME'}         = $GBE_DPKG;
7319 dpurdie 1083
    $ENV{'GBE_DPKG_ESCROW'}   = $GBE_DPKG_ESCROW;
277 dpurdie 1084
    $ENV{'GBE_DPKG_CACHE'}    = $GBE_DPKG_CACHE;
4688 dpurdie 1085
    $ENV{'GBE_DPKG_REPLICA'}  = $GBE_DPKG_REPLICA;
277 dpurdie 1086
    $ENV{'GBE_DPKG_STORE'}    = $GBE_DPKG_STORE;
1087
    $ENV{'GBE_DPKG_LOCAL'}    = $GBE_DPKG_LOCAL;
1088
    $ENV{'GBE_SANDBOX'}       = $GBE_SANDBOX;
1089
    $ENV{'GBE_DPKG_SBOX'}     = $GBE_DPKG_SBOX;
1090
    $ENV{'GBE_PERL'}          = $GBE_PERL;
1091
    $ENV{'GBE_TOOLS'}         = $GBE_TOOLS;
1092
    $ENV{'GBE_MACHTYPE'}      = $GBE_MACHTYPE;
1093
    $ENV{'GBE_HOSTMACH'}      = $GBE_HOSTMACH;
1094
    $ENV{'GBE_PLATFORM'}      = $GBE_PLATFORM;
1095
    $ENV{'GBE_DRV'}           = $GBE_DRV;
1096
    $ENV{'PERL5LIB'}          = $PERL5LIB;
1097
    $ENV{'JAVA_HOME'}         = $JAVA_HOME if ($JAVA_HOME);
1098
    $ENV{'GBE_JATS_SANE'}     = 1;
1099
}
287 dpurdie 1100
else
1101
{
1102
    #
1103
    #   Delete, from the environment, values that are related to selecting
1104
    #   the version of JATS being used
1105
    #
5891 dpurdie 1106
    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 1107
    {
1108
        delete $ENV{$_};
1109
    }
1110
}
277 dpurdie 1111
 
1112
#
1113
#   The following don't affect the operation of the build daemons selecting
1114
#   the current version of JATS. Some need to be passed through anyway
1115
#
227 dpurdie 1116
$ENV{'GBE_BUILDFILTER'}   = $GBE_BUILDFILTER;
277 dpurdie 1117
$ENV{'GBE_ABT'}           = $GBE_ABT if ($GBE_ABT);
227 dpurdie 1118
$ENV{'GBE_DEBUG'}         = $GBE_DEBUG;
1119
$ENV{'GBE_VERBOSE'}       = $GBE_VERBOSE;
1120
$ENV{'GBE_UNIX'}          = $GBE_UNIX;
1121
$ENV{'USER'}              = $USER;
279 dpurdie 1122
$ENV{'GBE_HOSTNAME'}      = $GBE_HOSTNAME;
343 dpurdie 1123
$ENV{'GBE_VIEWBASE'}      = $GBE_VIEWBASE;
361 dpurdie 1124
$ENV{'GBE_VCS'}           = $GBE_VCS;
227 dpurdie 1125
 
363 dpurdie 1126
#
1127
#   Warn users of potential problem
375 dpurdie 1128
#   Only do once. May change directory while getting here
1129
unless ( $GBE_JATS_SANE )
363 dpurdie 1130
{
1131
    Warning ("Current working directory contains spaces")
1132
        if ( $CWD =~ m/\s/ );
1133
}
1134
 
1135
 
227 dpurdie 1136
#-------------------------------------------------------------------------------
297 dpurdie 1137
# Function        : PathPrepend
1138
#
1139
# Description     : Prepend stuff to the PATH
1140
#
1141
# Inputs          : Items to prepend
1142
#
1143
# Returns         : Nothing
1144
#                   Modifies $PATH
1145
#
1146
sub PathPrepend
1147
{
299 dpurdie 1148
    foreach my $el ( @_ )
297 dpurdie 1149
    {
299 dpurdie 1150
        # Must NOT change the original argument, just a copy of it.
1151
        # Don't use $_ as this messes up too
1152
        my $item = $el;
297 dpurdie 1153
        $item =~ s~/~\\~g unless ( $GBE_UNIX );
1154
        $PATH = $item . $PSPLIT . $PATH;
1155
    }
1156
}
1157
 
1158
#-------------------------------------------------------------------------------
229 dpurdie 1159
# Function        : LocateJatsVersion
1160
#
245 dpurdie 1161
# Description     : Scan archives looking for a specified version of JATS
229 dpurdie 1162
#                   Complicated by the name change from core_devl to jats
245 dpurdie 1163
#                   that occurred circa version 2.71.7.
229 dpurdie 1164
#                   The required version may be in either of the packages
1165
#
4688 dpurdie 1166
#                   Ensure that package is complete
1167
#                   The caching process will write built.cache during the creation process
1168
#
229 dpurdie 1169
# Inputs          : $version            - Version to locate
1170
#
1171
# Returns         : undef               - if not found
1172
#                   Array of:
1173
#                       Repository
1174
#                       package/version
1175
#
1176
sub LocateJatsVersion
1177
{
1178
    my ($version) = @_;
1179
    my $package;
1180
    my $path;
1181
 
7319 dpurdie 1182
    foreach my $archive (qw ( GBE_DPKG_LOCAL GBE_DPKG_CACHE GBE_DPKG_ESCROW GBE_DPKG_REPLICA GBE_DPKG GBE_DPKG_STORE ))
229 dpurdie 1183
    {
1184
        no strict 'refs';
1185
        $path = ${$archive};
1186
        use strict 'refs';
1187
        next unless ( $path );
1188
 
369 dpurdie 1189
        foreach my $package (qw( jats core_devl ))
229 dpurdie 1190
        {
1191
            Verbose2( "ExamineDir: $path/$package/$version" );
1192
            if ( -d "$path/$package/$version" )
1193
            {
4688 dpurdie 1194
                unless (-f "$path/$package/$version/built.cache")
1195
                {
1196
                    return $path, "$package/$version", $archive;
1197
                }
229 dpurdie 1198
            }
1199
        }
1200
    }
283 dpurdie 1201
    return;
229 dpurdie 1202
}
1203
 
1204
 
1205
#-------------------------------------------------------------------------------
227 dpurdie 1206
# Function        : TestDirectoryConfig
1207
#
1208
# Description     : Sanity test a user configurable directory or file
1209
#                   Must not contain spaces
1210
#                   Must not be a network drive ie: //computer
1211
#
1212
# Inputs          :
1213
#
1214
# Returns         :
1215
#
1216
sub TestDirectoryConfig
1217
{
1218
    my ($dir) = @_;
1219
 
1220
    no strict 'refs';
1221
    my $val = ${$dir};
1222
 
1223
    if ( $val )
1224
    {
1225
        #
1226
        #   Cleanup the path
1227
        #
1228
        $val =~ tr~\\/~/~s;
1229
        $val =~ s~/+$~~;
255 dpurdie 1230
        $val = '' if ( $val eq '-' || $val eq 'none' );
227 dpurdie 1231
        ${$dir} = $val;
1232
 
1233
        ReportError("$dir path cannot contain spaces: $val") if ( $val =~ m/\s/ );
1234
        ReportError("$dir path cannot be a computer name: $val") if ( $val =~ m~^//~  );
1235
    }
1236
    use strict 'refs';
283 dpurdie 1237
    return;
227 dpurdie 1238
}
1239
 
1240
#-------------------------------------------------------------------------------
1241
# Function        : change_dir
1242
#
1243
# Description     : change directory to the specified directory
1244
#
1245
# Inputs          : $1      - Target directory
1246
#
1247
# Returns         :
1248
#
1249
sub change_dir
1250
{
1251
    my ($dir) = @_;
1252
 
363 dpurdie 1253
    if ( $dir && $dir ne '.' )
227 dpurdie 1254
    {
1255
        Verbose ("Changing to JATS build directory: $dir");
1256
        chdir $dir || Error ("Bad change directory: $dir");
363 dpurdie 1257
 
1258
        #
1259
        #   Reset the CWD
1260
        #   Note: Don't use `pwd`. This sucks for so many reasons including
1261
        #         the fact that it may not be available until this wrapper
1262
        #         script has done it job.
1263
        #
1264
        $CWD = getcwd();
367 dpurdie 1265
        Error ("Bad change directory: $dir","Cannot determine current directory - may be protected" )unless ( defined $CWD );
363 dpurdie 1266
        $CWD =~tr~\\/~/~s;
227 dpurdie 1267
    }
1268
}
1269
 
1270
#-------------------------------------------------------------------------------
277 dpurdie 1271
# Function        : scan_for_dir
1272
#
1273
# Description     : Scan from the current directory up to the root
1274
#                   of the current file system looking for a named
1275
#                   directory
1276
#
1277
# Inputs          : $target                 - Directory to locate
1278
#
1279
# Returns         : full_path               - Path of dir
1280
#                   full_dir                - Containng dir
1281
#
1282
 
1283
sub scan_for_dir
1284
{
1285
    my ($target) = @_;
1286
    Verbose2 ("Scan for $target");
1287
 
319 dpurdie 1288
    my $test_dir = $CWD || getcwd();
277 dpurdie 1289
    {
1290
        do
1291
        {
1292
            #
1293
            #   Stop at /home to prevent unix automounter spitting
1294
            #   lots of error messages
1295
            #
1296
            last if ( $test_dir =~ m~/home$~ );
1297
            Verbose2 ("Testing: $test_dir");
1298
 
1299
            my $test_path = $test_dir . '/' . $target;
1300
            if ( -d $test_path )
1301
            {
1302
                Verbose ("Found $target: $test_path");
1303
                return $test_path, $test_dir;
1304
            }
1305
            #
1306
            #   Remove one directory
1307
            #   Terminate the loop when no more can be removed
1308
            #
1309
        } while ( $test_dir =~ s~[/][^/]*$~~ );
1310
    }
1311
    return '','';
1312
}
1313
 
1314
#-------------------------------------------------------------------------------
227 dpurdie 1315
# Function        : get_java_home
1316
#
1317
# Description     : Convert user java option into a full path,or die
1318
#
1319
# Inputs          : User option
1320
#
1321
# Returns         : Full path
1322
#
1323
sub get_java_home
1324
{
1325
    my ($java) = @_;
1326
    my $jv = "JAVA_HOME_$java";
1327
    $jv =~ s~\.~_~g;
1328
 
1329
    unless ( exists($ENV{$jv}) )
1330
    {
1331
        Error ("Unknown JAVA version: $java",
1332
               "Looking for EnvVar: $jv",
1333
               "Example Usage: -java=1.5");
1334
    }
1335
    my $rv = $ENV{$jv};
1336
    unless ( -d $rv )
1337
    {
1338
        Error ("Java home path not found: $jv",
1339
               "Looking for: $rv" );
1340
    }
1341
    return $rv;
1342
}
1343
 
1344
#-------------------------------------------------------------------------------
1345
# Function        : get_version
1346
#
1347
# Description     : Return the version of JATS being run
1348
#                   JATS should be run from a "package"
1349
#                   The package should have a descpkg file
1350
#                   Use this file
1351
#
1352
# Inputs          :
1353
#
1354
# Returns         : A string
1355
#
1356
sub get_version
1357
{
229 dpurdie 1358
    #
1359
    #   The version number is embedded into this script by the release process
1360
    #   The text [V]ERSION_TAG will be replaced by the real version number
245 dpurdie 1361
    #   If this has not occurred then we know that the release is not official
229 dpurdie 1362
    #   Need to be a little bit careful about the tag name
1363
    #
1364
    return ("Unreleased Version. Version tag has not been set")
1365
        if ( $GBE_NOT_RELEASED );
1366
 
227 dpurdie 1367
    return "$GBE_VERSION [ Internal. Not an installed package ]"
1368
        if ( ! -f "$GBE_CORE/descpkg" );
1369
 
1370
    my $rec;
1371
    return $rec->{'VERSION_FULL'}
1372
        if ($rec = ReadDescpkg ( "$GBE_CORE/descpkg" ) );
1373
 
1374
    return "ERROR";
1375
}
1376
 
1377
#-------------------------------------------------------------------------------
1378
# Function        : print_version
1379
#
1380
# Description     :
1381
#
1382
# Inputs          :
1383
#
1384
# Returns         :
1385
#
1386
sub print_version
1387
{
1388
    #
1389
    #   Allow user to specify verboseness as an argument
1390
    #
1391
    foreach  ( @_ )
1392
    {
1393
        $GBE_VERBOSE++ if ( m/^-v/ );
1394
    }
1395
 
1396
    Message get_version();
1397
    Message "Internal: $GBE_VERSION" if ($GBE_VERBOSE);
1398
    $opr_done = 1;
283 dpurdie 1399
    return;
227 dpurdie 1400
}
1401
 
1402
 
1403
#-------------------------------------------------------------------------------
1404
#
1405
#   Give the user a clue
1406
#
1407
sub help
1408
{
1409
    my ($level) = @_;
1410
    $level = $opt_help unless ( $level );
1411
 
1412
    pod2usage(-verbose => 0, -message => "Version: ". get_version())  if ($level == 1 );
261 dpurdie 1413
    pod2usage(-verbose => $level - 1 );
227 dpurdie 1414
}
1415
 
1416
#-------------------------------------------------------------------------------
309 dpurdie 1417
# Function        : find_jats_dir
227 dpurdie 1418
#
309 dpurdie 1419
# Description     : Find a JATS build directory
1420
#                   Can be supressed with JATS '-here' command line option
227 dpurdie 1421
#
309 dpurdie 1422
# Inputs          : files               - Files to look for
1423
#                   options
1424
#                       --Ant           - Allow Ant files too
295 dpurdie 1425
#
309 dpurdie 1426
# Returns         : Will not return if not found
1427
#                   Will 'cd' to the build directory
1428
#
227 dpurdie 1429
sub find_jats_dir
1430
{
309 dpurdie 1431
    my $allow_ant;
1432
    my @FILES;
1433
    my $DIR;
1434
    my $check_file;
1435
 
227 dpurdie 1436
    #
1437
    #   Autodetect suppressed ?
1438
    #
1439
    return if ( $opt_here );
1440
 
309 dpurdie 1441
    #
1442
    #   Collect options
1443
    #   Collect the rest of the arguments
1444
    #
1445
    foreach ( @_ )
1446
    {
1447
        if ( m/^--Ant/ ) {
1448
            $allow_ant = 1;
1449
        }
1450
        else {
1451
            push @FILES, $_;
1452
        }
1453
    }
1454
 
227 dpurdie 1455
    push @FILES, @BUILD_FILE_ALT;
309 dpurdie 1456
    push @FILES, 'build.xml' if ( $allow_ant );
1457
 
1458
    #
1459
    #   Parent directories to search
1460
    #   Child dirs to search
1461
    #
227 dpurdie 1462
    my @SEARCH = qw( . .. ../.. ../../.. );
309 dpurdie 1463
    my @CHILD  = ('', '/jats', '/build', '/build/jats' );
227 dpurdie 1464
 
1465
    #
1466
    #   Locate the JATS build files
1467
    #   Allow the user to be in a number of parent directories
1468
    #
309 dpurdie 1469
    scan:
227 dpurdie 1470
    for my $ROOTDIR (@SEARCH)
1471
    {
309 dpurdie 1472
        for my $SUBDIR (@CHILD)
227 dpurdie 1473
        {
309 dpurdie 1474
            $DIR = $ROOTDIR . $SUBDIR;
227 dpurdie 1475
            next unless -d $DIR;
1476
 
283 dpurdie 1477
            for my $FILE ( @FILES)
227 dpurdie 1478
            {
309 dpurdie 1479
                $check_file = $DIR . '/' . $FILE;
227 dpurdie 1480
                Verbose2 ("Check for: $check_file");
309 dpurdie 1481
                last scan if ( -f $check_file );
1482
            }
1483
 
1484
            next unless ( $allow_ant );
1485
            foreach ( glob($DIR . '/*depends.xml' ) )
1486
            {
1487
                Verbose2 ("Check for: $_");
1488
                if ( m/(.+)depends.xml/ )
227 dpurdie 1489
                {
309 dpurdie 1490
                    $check_file = "$1.xml";
1491
                    last scan if ( -f $check_file );
227 dpurdie 1492
                }
1493
            }
1494
        }
309 dpurdie 1495
        $DIR = '';
227 dpurdie 1496
    }
309 dpurdie 1497
 
1498
    #
1499
    #   Change to the build directory if one has been found
1500
    #
1501
    if ( $DIR )
1502
    {
1503
        Verbose2 ("Found check file: $check_file");
1504
        change_dir ( $DIR );
1505
    }
1506
    else
1507
    {
1508
        Error ( 'JATS build directory not found.',
1509
                "Cannot locate: @FILES",
1510
                $allow_ant ? 'or Ant <Package>.xml <Package>depends.xml pair' : undef,
1511
                'Use -here option to supress this test'
1512
                );
1513
    }
227 dpurdie 1514
}
1515
 
1516
#-------------------------------------------------------------------------------
1517
#
295 dpurdie 1518
#   Determine the real build file to use
1519
#   Will select from a list of known build files.
227 dpurdie 1520
#
295 dpurdie 1521
sub getBuildFile
227 dpurdie 1522
{
1523
    my $build_file = $BUILD_FILE;
1524
    #
1525
    #   Use an alternative buildfile - if it exists
1526
    #   Do not use this file if the user has specified a buildfile
1527
    #
1528
    unless ( $BUILD_FILE_SET )
1529
    {
1530
        Verbose ("Search for alternate build file");
1531
        foreach my $test_file ( @BUILD_FILE_ALT )
1532
        {
1533
            Verbose2 ("Search for alternate build file: $test_file");
1534
            if ( -f $test_file )
1535
            {
1536
                $build_file = $test_file;
1537
                Message ("=== USING ALTERNATE BUILDFILE: $build_file ===");
1538
                last;
1539
            }
1540
        }
1541
    }
295 dpurdie 1542
   return $build_file;
1543
}
227 dpurdie 1544
 
295 dpurdie 1545
#-------------------------------------------------------------------------------
1546
#
1547
#   Kick off the build process
1548
#
1549
sub build
1550
{
4902 dpurdie 1551
    isaBuildMachine();
295 dpurdie 1552
    my $build_file = $BUILD_FILE;
1553
    (my $name = $CWD) =~ s~^.*/~~ ;
1554
    $opr_done = 1;
1555
 
1556
    find_jats_dir($build_file);
1557
    Message ("=== Building $name ===");
1558
    $build_file = getBuildFile();
1559
 
227 dpurdie 1560
    #
1561
    #   Jats/make does not handle file systems with spaces in the path names
1562
    #
1563
    Error('$CWD path cannot contain spaces') if ( $CWD =~ m/\s/ );
1564
 
333 dpurdie 1565
    $RESULT = System ($GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", @_ );
227 dpurdie 1566
 
283 dpurdie 1567
    Message ("=== Build $name NOT complete ===") if     ( $RESULT  );
1568
    Message ("=== Build $name complete ===")     unless ( $RESULT );
227 dpurdie 1569
    return $RESULT
1570
}
1571
 
1572
#-------------------------------------------------------------------------------
1573
# Function        : bmake_it
1574
#
1575
# Description     : Combo build and make operations
1576
#
1577
# Inputs          : ...     - COMMANDS or Make arguments.
1578
#                             Key commands are BUILD and INSTALL
1579
#
1580
# Returns         : RESULT code
1581
#
1582
sub bmake_it
1583
{
1584
    my @make_args = @_;
1585
    my $all = 1;
1586
    my $msg;
1587
    $opr_done = 1;
4902 dpurdie 1588
    isaBuildMachine();
227 dpurdie 1589
 
1590
    if ( $make_args[0] && $make_args[0] eq 'NOTALL' )
1591
    {
1592
        $all = 0;
1593
        shift @make_args;
1594
    }
1595
    elsif ( $make_args[0] && $make_args[0] eq 'BUILD' )
1596
    {
1597
        Verbose ("Makeit build") ;
1598
        $msg = "Component not built";
331 dpurdie 1599
        build('-noforce');
227 dpurdie 1600
        shift @make_args;
1601
    }
1602
 
1603
    unless ( $RESULT )
1604
    {
1605
        push @make_args, '-default=all' if ( $all );
1606
        Verbose ("Makeit make @make_args") ;
1607
 
309 dpurdie 1608
        find_jats_dir( 'makefile.pl', 'Makefile.gbe', $BUILD_FILE );
227 dpurdie 1609
        Error ("No Makefile.gbe file found") unless ( -f 'Makefile.gbe' );
1610
 
1611
        etool ( 'jmake.pl', @make_args );
1612
        $msg = "Component not made";
1613
        @make_args = ();
1614
    }
1615
 
1616
 
1617
    Verbose ("Makeit Result: $RESULT") ;
1618
    Error ( $msg ) if ( $RESULT );
1619
    return  if ( $RESULT );
1620
}
1621
 
1622
#-------------------------------------------------------------------------------
1623
# Function        : dev_expand
1624
#
1625
# Description     : Expand the users arguments to the "debug/prod" command
1626
#                   "debug/prod" builds and packages debug stuff
1627
#
1628
#                   Ignore make options.
1629
#
1630
# Inputs          : target
1631
#                   Argument list
1632
#
1633
# Returns         : expanded argument list
1634
#
1635
sub dev_expand
1636
{
1637
    my @resultd;
1638
    my @resultp;
1639
    my @args;
1640
    my @opts;
1641
 
1642
    #
1643
    #   Remove options from the argument list
1644
    #
1645
    foreach ( @_ )
1646
    {
1647
        if ( m~=~ || m~^-~ ) {
1648
            push @opts, $_;
1649
        } else {
1650
            push @args, $_;
1651
        }
1652
    }
1653
 
1654
    my $target = shift @args;
1655
    my @cmd = $target;
1656
    if ( $#args < 0 )
1657
    {
1658
        push @cmd, "package_$target";
1659
    }
1660
    else
1661
    {
1662
        foreach ( @args )
1663
        {
1664
            push @resultd, $_ . "_$target";
1665
            push @resultp, $_ . "_package_$target";
1666
            @cmd = ();
1667
        }
1668
    }
1669
 
1670
    return (@cmd, @resultd, @resultp, @opts);
1671
}
1672
 
1673
#-------------------------------------------------------------------------------
1674
# Function        : install_pkg
1675
#
1676
# Description     : Install the built package into local_dpkg_archive
1677
#                   This will make it available for use, without populating the
1678
#                   global archive
1679
#
1680
#                   This is done through an external utility to maintain
1681
#                   consistent interface
1682
#
1683
sub install_pkg
1684
{
1685
 
309 dpurdie 1686
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1687
    etool ( 'create_dpkg.pl', '-archive=local', '-quiet', '-override',  @_ );
1688
}
1689
 
1690
#-------------------------------------------------------------------------------
1691
# Function        : create_dpkg
1692
#
1693
# Description     : Install a package into the main dpkg_archive
1694
#                   This is done through an external utility to maintain
1695
#                   consistent interface
1696
#
1697
#                   This function is simply an easy way to access the utility
1698
 
1699
sub create_dpkg
1700
{
309 dpurdie 1701
    find_jats_dir($BUILD_FILE, '--Ant');
227 dpurdie 1702
    etool ( 'create_dpkg.pl',  @_ );
1703
}
1704
 
1705
#-------------------------------------------------------------------------------
1706
# Function        : etool
1707
#
1708
# Description     : Invoke an external tool program written in PERL
1709
#
1710
# Arguments       : $1  Name of the program to run
1711
#                       With optional .pl suffix
1712
#                   $2+ Program arguments
1713
#
1714
sub etool
1715
{
1716
    my $command = shift;
1717
    my $cmd;
1718
    my @etool_path = ( "$ENV{'GBE_TOOLS'}",
1719
                       "$ENV{'GBE_TOOLS'}/DEPLOY",
379 dpurdie 1720
                       "$ENV{'GBE_TOOLS'}/LOCAL",
1721
                        );
227 dpurdie 1722
    if ( $command )
1723
    {
1724
        #
1725
        #   Locate a potential tool
1726
        #   These will have the user name or a .pl extension
1727
        #
1728
        ETOOL_SEARCH:
1729
        foreach my $ext ( '', '.pl' )
1730
        {
1731
            foreach my $dir ( @etool_path )
1732
            {
297 dpurdie 1733
                $cmd = "$dir/jats_$command$ext";
1734
                last ETOOL_SEARCH if ( -f $cmd );
1735
 
227 dpurdie 1736
                $cmd = "$dir/$command$ext";
1737
                last ETOOL_SEARCH if ( -f $cmd );
1738
            }
1739
            $cmd='';
1740
        }
1741
 
1742
        Error ("Tool not found: $command", "Search path:", @etool_path) unless $cmd;
1743
        $RESULT = System ( $GBE_PERL, $cmd, @_ );
1744
    }
1745
    else
1746
    {
1747
        #
1748
        #   Display on the .pl commands
1749
        #
1750
        display_commands("Available Tools", \@etool_path, ['*.pl'] );
1751
    }
1752
 
1753
    $opr_done = 1;
1754
}
1755
 
1756
#-------------------------------------------------------------------------------
1757
# Function        : ebin
1758
#
1759
# Description     : Invoke an external JATS provided binary
1760
#                   within the JATS toolset
1761
#
1762
# Arguments       : $1  Name of the program to run
1763
#                   $2+ Program arguments
1764
#
1765
sub ebin
1766
{
1767
    my $command = shift;
1768
    my $cmd;
1769
    my @ebin_path = ( "$GBE_BIN" );
1770
 
1771
    if ( $command )
1772
    {
1773
        #
1774
        #   Locate a potential executable
1775
        #   This
1776
        #
1777
        ETOOL_SEARCH:
1778
        foreach my $ext ( '', '.exe', '.sh' )
1779
        {
1780
            foreach my $dir ( @ebin_path )
1781
            {
1782
                $cmd = "$dir/$command$ext";
1783
                last ETOOL_SEARCH if ( -f $cmd );
1784
            }
1785
            $cmd='';
1786
        }
1787
 
1788
        Error ("Program not found: $command", "Search path:", @ebin_path) unless $cmd;
1789
        $RESULT = System ( $cmd, @_ );
1790
    }
1791
    else
1792
    {
1793
        #
1794
        #   Display a list of programs
1795
        #
1796
        display_commands("Available Programs", \@ebin_path, ['*'] );
1797
    }
1798
 
1799
    $opr_done = 1;
1800
}
1801
 
1802
#-------------------------------------------------------------------------------
1803
# Function        : eprog
1804
#
1805
# Description     : Invoke an external program
1806
#                   Will detect local .pl files and execute them
1807
#                   Will detect local .jar files and execute them
229 dpurdie 1808
#                   Will detect local .bat files and execute them
227 dpurdie 1809
#
1810
# Arguments       : $1  Name of the program to run
1811
#                   $2+ Program arguments
1812
#
1813
sub eprog
1814
{
229 dpurdie 1815
    Verbose ("eprog: @_");
315 dpurdie 1816
    my $name = fix_command_name (shift @_);
227 dpurdie 1817
    Error ("eprog. No program specified") unless ( $name );
1818
 
229 dpurdie 1819
    $name .= ".pl"     if ( -f "${name}.pl" );
1820
    $name .= ".jar"    if ( -f "${name}.jar" );
1821
    $name .= ".bat"    if ( -f "${name}.bat" );
227 dpurdie 1822
 
229 dpurdie 1823
    #
245 dpurdie 1824
    #   On Windows programs in the CWD will be found
1825
    #   Mimic this behaviour on Unix
229 dpurdie 1826
    #
1827
    $name = "./$name" if ( $name !~ m~/~ && -f "./$name");
1828
 
227 dpurdie 1829
    if ( $name =~ m~\.pl$~ ) {
1830
        $RESULT = System ( $GBE_PERL, $name, @_ );
1831
 
1832
    } elsif ( $name =~  m~\.jar$~ ) {
1833
        $RESULT = System ( "$JAVA_HOME/bin/java", '-jar', $name, @_);
1834
 
1835
    } else {
229 dpurdie 1836
        #
1837
        #   Ensure .bat files are pathed with \, and not / characters
1838
        #   The windows command interpreter does not like /
1839
        #
1840
        $name =~ s~/~\\~g if ( $name =~ m~\.bat$~ );
1841
 
227 dpurdie 1842
        $RESULT = System ( $name, @_ );
1843
    }
1844
 
1845
    $opr_done = 1;
1846
}
1847
 
1848
#-------------------------------------------------------------------------------
1849
# Function        : display_commands
1850
#
1851
# Description     : Display a list of commands from a specified list of dirs
1852
#                   Internal helper function
1853
#
1854
# Inputs          : $title      - Display header
1855
#                   $ref_path   - Ref to an array that contains the search path
1856
#                   $ref_ext    - Ref to an array of valid patterns
1857
#
1858
# Returns         : Nothing
1859
#
1860
sub display_commands
1861
{
1862
    my ( $title, $ref_path, $ref_ext ) = @_;
1863
 
1864
    #
1865
    #   Display a list of commands
1866
    #
1867
    my %list;
1868
    foreach ( @$ref_path )
1869
    {
1870
        foreach my $ext ( @$ref_ext )
1871
        {
1872
            foreach my $file (  glob( "$_/$ext") )
1873
            {
1874
                $file =~ s~.*/~~ unless $GBE_VERBOSE;
1875
                $list{$file} = 1;
1876
            }
1877
        }
1878
    }
1879
 
1880
    my $count = 0;
1881
    my $limit = $GBE_VERBOSE ? 1 : 3;
1882
    print "$title:\n";
1883
    foreach ( sort keys %list )
1884
    {
1885
        printf "%-26s", $_;
1886
        print "\n" if ( !( ++$count % $limit) );
1887
    }
1888
}
1889
 
1890
#-------------------------------------------------------------------------------
315 dpurdie 1891
# Function        : fix_command_name
1892
#
1893
# Description     : Fix a command name parameter
1894
#                   Simplify use of cygwin for some users by allowing
1895
#                   that path of external tools to be a cygwin path
1896
#
1897
# Inputs          : cmd             - command
1898
#
1899
# Returns         : cleaned up version of cmd
1900
#
1901
sub fix_command_name
1902
{
1903
    my ($cmd) = @_;
1904
 
1905
    unless ( $GBE_UNIX )
1906
    {
1907
        #
1908
        #   Cygwin kludge
1909
        #       Replace /cygdrive/DriveLetter/ - with DriveLetter:/
1910
        #       Replace /DriveLetter/          - With DriveLetter:/
1911
        #
1912
        $cmd =~ s~^/cygdrive/([A-Z])/(.*)~$1:/$2~i;
1913
        $cmd =~ s~^/([A-Z])/(.*)~$1:/$2~i;
1914
    }
1915
    return $cmd;
1916
}
1917
 
1918
 
1919
#-------------------------------------------------------------------------------
227 dpurdie 1920
# Function        : run_ant
1921
#
1922
# Description     : Invoke ant
399 dpurdie 1923
#                   If the current directory looks like an VIX build system, then
227 dpurdie 1924
#                   create and maintain an auto.xml file. Otherwise simply invoke ant
1925
#
1926
# Inputs          : $1+ program arguments
1927
#
1928
sub run_ant
1929
{
4902 dpurdie 1930
    isaBuildMachine();
227 dpurdie 1931
    my $JAVA_HOME = $ENV{JAVA_HOME} || Error ("JAVA_HOME is not defined in the environment");
1932
    my $ANT_HOME  = $ENV{ANT_HOME}  || Error ("ANT_HOME is not defined in the environment" );
1933
 
1934
    #
399 dpurdie 1935
    #   Detect an VIX formatted build
227 dpurdie 1936
    #   This will have two files <projectname>.xml and <projectname>depends.xml
1937
    #   Create the 'auto.xml' file only if its not present
1938
    #
1939
    my @ant_arg;
1940
    my @flist;
1941
    my $basename = '';
235 dpurdie 1942
    my $scanner = '*depends.xml';
227 dpurdie 1943
 
1944
    #
1945
    #   Use specified build file to resolve multiple names
1946
    #   Strip any trailing depends.xml to make it user friendly
1947
    #
1948
    if ( $BUILD_FILE_SET )
1949
    {
1950
        $basename = $BUILD_FILE;
1951
        $basename =~ s~\.xml$~~;
1952
        $basename =~ s~depends$~~;
235 dpurdie 1953
        $scanner = "${basename}depends.xml";
227 dpurdie 1954
        Verbose ("Using buildfile: $basename");
1955
    }
1956
 
235 dpurdie 1957
    my @buildlist = glob($scanner);
227 dpurdie 1958
    foreach ( @buildlist )
1959
    {
1960
        if ( m/(.+)depends.xml/ )
1961
        {
1962
            my $pname = $1;
1963
            push @flist, $pname if ( -f "$pname.xml" );
1964
        }
1965
    }
1966
 
1967
    if ( $#flist >= 0 )
1968
    {
1969
        Error ("Multiple depends.xml files found:", @flist,
297 dpurdie 1970
               "Use 'jats -buildfile=name ant ...' to resolve") if ( $#flist > 0 );
227 dpurdie 1971
 
1972
        my $depend = "$flist[0]depends.xml";
1973
        @ant_arg = ('-f', "$flist[0].xml");
1974
 
1975
        Message ("Ant using projectfiles: $flist[0].xml");
1976
 
1977
        #
367 dpurdie 1978
        #   Create auto.xml if we have a depends.xml
227 dpurdie 1979
        #
367 dpurdie 1980
        if ( -f $depend )
227 dpurdie 1981
        {
367 dpurdie 1982
            #
1983
            #   Check for depends.xml newer than auto.xml.
1984
            #
1985
            my $auto_timestamp   = (stat('auto.xml'))[9] || 0;
1986
            my $depend_timestamp = (stat($depend))[9];
1987
            if ( $depend_timestamp > $auto_timestamp )
1988
            {
1989
                Message ("Creating: auto.xml");
1990
                copy( $depend, 'auto.xml' );
1991
                chmod 0777, 'auto.xml';
1992
            }
227 dpurdie 1993
        }
367 dpurdie 1994
        else
1995
        {
1996
            Warning ("Project file does not have a depends.xml file");
1997
        }
227 dpurdie 1998
    }
1999
    elsif ( $BUILD_FILE_SET  )
2000
    {
2001
        Error ("Specified build file pair not found:", $basename, $basename . "depends.xml");
2002
    }
2003
    #
2004
    #   The ant provided startup scripts don't return an exit code under
2005
    #   windows. Invoke ant directly
2006
    #
2007
    launch_ant ( $JAVA_HOME, $ANT_HOME, @ant_arg, @_ );
2008
    $opr_done = 1;
2009
}
2010
 
2011
#-------------------------------------------------------------------------------
2012
# Function        : run_abt
2013
#
2014
# Description     : Invoke auto build tool (older form)
2015
#                   Options for the ABT
2016
#                       --Java=x.x
2017
#                   Invoke ANT for the ABT using a specified version of Java
2018
#                   Do not play with the user environment.
297 dpurdie 2019
#                   Don't stick java path into environment
227 dpurdie 2020
#
2021
# Inputs          : $1+ program arguments
2022
#
2023
sub run_abt
2024
{
279 dpurdie 2025
    my $ABT_JAVA = 'JAVA_HOME_1_6';         # Default version for the ABT
227 dpurdie 2026
    my $JAVA_HOME = $ENV{$ABT_JAVA};
2027
    my $ANT_HOME  = $ENV{ANT_HOME};
2028
    my @abt_arg;
239 dpurdie 2029
    my $buildfile = 'build.xml';
227 dpurdie 2030
 
2031
    ErrorConfig( 'name'    => 'JATS ABT' );
4902 dpurdie 2032
    isaBuildMachine();
227 dpurdie 2033
 
2034
    #
239 dpurdie 2035
    #   Use the user specified buildfile
2036
    #
2037
    $buildfile = $BUILD_FILE
2038
        if ( $BUILD_FILE_SET );
2039
 
2040
    #
227 dpurdie 2041
    #   Extract known options
2042
    #
2043
    foreach  ( @_ )
2044
    {
2045
        if ( m/-java=(.*)/ ) {
2046
            $JAVA_HOME = get_java_home($1);
239 dpurdie 2047
 
2048
        } elsif ( m/^-buildfile=(.+)/ ) {
2049
            $buildfile = $1;
2050
 
227 dpurdie 2051
        } else {
2052
            push @abt_arg, $_;
2053
        }
2054
    }
2055
 
2056
    Error ("$ABT_JAVA is not defined in the environment") unless $JAVA_HOME;
2057
    Error ("ANT_HOME is not defined in the environment" ) unless $ANT_HOME;
239 dpurdie 2058
    Error ("Ant buildfile not found: $buildfile" ) unless (-f $buildfile);
227 dpurdie 2059
 
2060
    #
239 dpurdie 2061
    #   Insert correct build file arguments
2062
    #
279 dpurdie 2063
    push @abt_arg, '-buildfile', $buildfile;
2064
 
2065
    #
2066
    #   Add current directory as java library directory, but only if
2067
    #   it contains JAR files.
2068
    #
2069
    push @abt_arg, '-lib', $CWD
2070
        if ( glob ('*.jar') );
239 dpurdie 2071
 
2072
    #
227 dpurdie 2073
    #   Use the ant-launcher to invoke ant directly
2074
    #
2075
    launch_ant ( $JAVA_HOME, $ANT_HOME, @abt_arg );
2076
    $opr_done = 1;
2077
}
2078
 
2079
#-------------------------------------------------------------------------------
2080
# Function        : launch_ant
2081
#
2082
# Description     : Start ANT - with sanity checking
2083
#
2084
# Inputs          : JAVA_HOME
2085
#                   ANT_HOME
2086
#                   @user_args
2087
#
2088
# Returns         : Result Code
2089
#
2090
sub launch_ant
2091
{
2092
    my ($JAVA_HOME, $ANT_HOME, @user_args ) = @_;
2093
 
2094
    Error ("Directory not found: $JAVA_HOME") unless ( -d "$JAVA_HOME" );
2095
    Error ("Program not found: $JAVA_HOME/bin/java") unless ( -e "$JAVA_HOME/bin/java" || -e "$JAVA_HOME/bin/java.exe" );
2096
    Error ("Jar not found: $ANT_HOME/lib/ant-launcher.jar") unless ( -e "$ANT_HOME/lib/ant-launcher.jar" );
2097
    Error ("Directory not found: $ANT_HOME") unless ( -d "$ANT_HOME" );
2098
    Error ("Directory not found: $ANT_HOME/lib") unless ( -d "$ANT_HOME/lib" );
2099
 
2100
    #
4688 dpurdie 2101
    #   Documented KLUDGE
2102
    #   The 'ant-using' mechanism only understands GBE_DPKG
2103
    #   This is not good in a cloud build configuration where GBE_DPKG_REPLICA is the fastest repository
5568 dpurdie 2104
    #   Solution: In an GBE_ABT environment IFF GBE_DPKG_REPLIA exists then set GBE_DPKG and JATS_HOME
4688 dpurdie 2105
    #
2106
    if ($GBE_ABT && $GBE_DPKG_REPLICA)
2107
    {
2108
        $ENV{GBE_DPKG_ORIGINAL} = $ENV{GBE_DPKG};
2109
        $ENV{GBE_DPKG} = $ENV{GBE_DPKG_REPLICA};
5568 dpurdie 2110
        $ENV{JATS_HOME} = $ENV{GBE_DPKG_REPLICA};
4688 dpurdie 2111
        Message("Setting GBE_DPKG to GBE_DPKG_REPLICA");
2112
    }
2113
 
2114
    #
227 dpurdie 2115
    #   Use the ant-launcher to invoke ant directly
2116
    #
2117
    $RESULT = System ( "$JAVA_HOME/bin/java",
4688 dpurdie 2118
                       #"-agentlib:jdwp=transport=dt_socket,server=y,address=8000,suspend=y",      # Enable Remote Debug
227 dpurdie 2119
                       "-classpath","$ANT_HOME/lib/ant-launcher.jar",
2120
                       "-Dant.home=$ANT_HOME",
2121
                       "org.apache.tools.ant.launch.Launcher",
2122
                       "-lib","$ANT_HOME/lib",
2123
                       @user_args
2124
                       );
2125
 
2126
   return $RESULT;
2127
}
2128
 
2129
 
2130
#-------------------------------------------------------------------------------
2131
#
2132
#   Cleanup the sandbox
2429 dpurdie 2133
#   Perform a "make clean" then a "build clobber"
227 dpurdie 2134
#
2135
sub clobber
2136
{
4902 dpurdie 2137
    isaBuildMachine();
227 dpurdie 2138
    Message ("=== Removing ======");
2139
    find_jats_dir( $BUILD_FILE );
295 dpurdie 2140
    my $build_file = getBuildFile();
2141
 
227 dpurdie 2142
 
2143
    #
2429 dpurdie 2144
    #   Run a "make clean" to clean out a lot of stuff
2145
    #   Run a "build clobber" to get rid of interface and local directories
227 dpurdie 2146
    #
2429 dpurdie 2147
    etool ( 'jmake.pl', 'clean' )
227 dpurdie 2148
        if ( -f "Makefile.gbe" );
2149
 
295 dpurdie 2150
    if ( -f $build_file )
227 dpurdie 2151
    {
333 dpurdie 2152
        System ( $GBE_PERL, $build_file, $CWD, "$GBE_TOOLS/buildlib.pl", 'clobber' );
227 dpurdie 2153
    }
2154
    else
2155
    {
2156
        Error ("Cannot clobber. No buildfile found");
2157
    }
2158
 
2159
    Message ("=== Remove complete ===");
2160
    $opr_done = 1;
2161
}
2162
 
2163
#-------------------------------------------------------------------------------
2164
# Function        : do_exit
2165
#
2166
# Description     : Common exit point so that time information can be displayed
2167
#
2168
# Inputs          : Optional exit code
2169
#
2170
# Returns         :
2171
#
2172
sub do_exit
2173
{
2174
    my ($ecode) = @_;
2175
 
2176
    $RESULT = $ecode if ( $ecode );
2177
 
2178
    #..
2179
    #   Determine the runtime
363 dpurdie 2180
    #       $^T is the time that the program started
227 dpurdie 2181
    #
2182
    if ( $opt_time )
2183
    {
2184
        my ($TIMEU, $TIMES) = times;
363 dpurdie 2185
        my $TIMER = time - $^T;
2186
        my $m = int($TIMER / 60);
2187
        my $s = $TIMER - ($m * 60);
227 dpurdie 2188
 
2189
        Message ( "Times: Real: $m:$s, User: $TIMEU, System: $TIMES");
2190
    }
2191
    #.
2192
    #   Make sure that any important exit code is passed to the user
2193
    #
2194
    Verbose ("ExitCode: $RESULT");
2195
    exit $RESULT;
2196
}
2197
 
4902 dpurdie 2198
#-------------------------------------------------------------------------------
2199
# Function        : isaBuildMachine 
2200
#
2201
# Description     : Test that this machine is a build machine
2202
#                   One that supports compilation
2203
#                   Jats may be installed on machines where it may be used in 
2204
#                   a support mode but not to build software. ie: auperaunx01
2205
#
2206
# Inputs          : None
2207
#
2208
# Returns         : May not return 
2209
#
2210
sub isaBuildMachine
2211
{
2212
    if ($notaBuildMachine)
2213
    {
2214
        Error("This machine does not support JATS for building software.",
2215
              "This machine does support JATS for the purpose of running support utilities.");
2216
    }
2217
 
2218
 
2219
}
2220
 
2221
 
227 dpurdie 2222
########################################################################
2223
#
2224
#   Main body of the script
2225
#
2226
#   Process help and manual options
2227
#       Done after all the setup to ensure that the PATH is correct
2228
#       Done before bombout to give user a chance
2229
#
379 dpurdie 2230
 
2231
#
2232
#   Redirect all output to a log file
2233
#   Only perform redirection AFTER we have setup the users environment
2234
#       May change this.
2235
#
2236
if ( $opt_logfile )
2237
{
2238
    open STDOUT, '>', $opt_logfile  or die "Can't redirect STDOUT: $!";
2239
    open STDERR, ">&STDOUT"         or die "Can't dup STDOUT: $!";
2240
}
2241
 
227 dpurdie 2242
help() if $opt_help;
2243
ErrorDoExit();  # Exit if any error in setup
2244
ErrorConfig( 'on_exit'    => \&do_exit );
2245
 
2246
#
231 dpurdie 2247
#   Reset operational flags.
2248
#   May have been used by setup
2249
#
2250
$opr_done = 0;
2251
$RESULT = 0;
2252
 
2253
#
227 dpurdie 2254
#   Process user commands
2255
#
263 dpurdie 2256
my $cmd = shift @ARGV || help(1);
227 dpurdie 2257
 
2258
print_version(@ARGV)                    if ( $cmd =~ m/^ver/ );
2259
 
2260
clobber                                 if ( $cmd =~ m/^clobber$/ );
2261
build    (@ARGV)                        if ( $cmd =~ m/^build$/ );
2262
 
2263
bmake_it ('NOTALL', @ARGV)              if ( $cmd =~ m/^[x]*make$/ );
2264
bmake_it (@ARGV)                        if ( $cmd =~ m/^go$/ );
2265
bmake_it (dev_expand('debug', @ARGV) )  if ( $cmd =~ m/^debug$/ );
2266
bmake_it (dev_expand('prod', @ARGV) )   if ( $cmd =~ m/^prod$/ );
2267
bmake_it ("clean", @ARGV)               if ( $cmd =~ m/^clean$/ );
2268
bmake_it ("rebuild", @ARGV)             if ( $cmd =~ m/^rebuild$/ );
2269
bmake_it ('BUILD', @ARGV)               if ( $cmd =~ m/^all$/ );
2270
bmake_it ($cmd, @ARGV )                 if ( $cmd =~ m/^run_unit_tests/ );
2271
 
2272
install_pkg(@ARGV)                      if ( $cmd =~ m/^install$/ );
2273
create_dpkg(@ARGV)                      if ( $cmd =~ m/^create_dpkg$/ );
2274
 
2275
ebin  (@ARGV)                           if ( $cmd =~ m/^ebin/ );
2276
etool (@ARGV)                           if ( $cmd =~ m/^etool/ );
2277
eprog (@ARGV)                           if ( $cmd =~ m/^eprog$/ );
2278
run_ant (@ARGV)                         if ( $cmd =~ m/^ant$/ );
2279
run_abt (@ARGV)                         if ( $cmd =~ m/^abt$/ );
2280
 
299 dpurdie 2281
etool ('cache_dpkg', @ARGV)                         if ( $cmd =~ m/^dpkg/ );
2282
etool ('gen_msprojects', @ARGV)                     if ( $cmd =~ m/^gen_msproject/ );
361 dpurdie 2283
etool ("jats_${GBE_VCS}release.pl", @ARGV)                  if ( $cmd =~ m/^release/ );
2284
etool ("jats_${GBE_VCS}release.pl", '-extractfiles' ,@ARGV) if ( $cmd =~ m/^extractf/ );
2285
etool ("jats_${GBE_VCS}release.pl", '-extract' ,@ARGV)      if (!$opr_done && $cmd =~ m/^extract/ );
383 dpurdie 2286
 
2287
etool ("jats_svnrelease.pl", '-extractfiles' ,@ARGV) if ( $cmd =~ m/^svnextractf/ );
2288
etool ("jats_svnrelease.pl", '-extract' ,@ARGV)      if (!$opr_done && $cmd =~ m/^svnextract/ );
2289
 
361 dpurdie 2290
etool ("jats_${GBE_VCS}label", @ARGV)                       if ( $cmd =~ m/^label$/ );
299 dpurdie 2291
etool ('jats_sandbox', @ARGV)                       if ( $cmd =~ m/^sandbox$/ );
313 dpurdie 2292
etool ('jats_help', @ARGV)                          if ( $cmd =~ m/^help$/ );
325 dpurdie 2293
etool ('jats_help', '-man', @ARGV)                  if ( $cmd =~ m/^man$/ );
315 dpurdie 2294
etool ('jats_vars.pl', @ARGV)                       if ( $cmd =~ m/^var/ );
227 dpurdie 2295
 
2296
etool ($cmd, @ARGV)                     unless ($opr_done); # Pass to etool if not known
2297
 
2298
do_exit();
2299
#.
2300
 
2301
#-------------------------------------------------------------------------------
2302
#   Documentation
2303
#
2304
 
2305
=pod
2306
 
361 dpurdie 2307
=for htmltoc    CORE::AA::Jats
2308
 
227 dpurdie 2309
=head1 NAME
2310
 
2311
jats - JATS utility interface tool
2312
 
2313
=head1 SYNOPSIS
2314
 
277 dpurdie 2315
 Usage: jats [opts] command [cmd-options]
227 dpurdie 2316
 
2317
 Where opts:
261 dpurdie 2318
    -h, -h -h, -man=[n] - Help messages with increasing verbosity
227 dpurdie 2319
    -cd dir             - Change to specified directory
2320
    -b file             - Use alternate build file
261 dpurdie 2321
    -verbose[=n]        - Verbose operation
2322
    -debug[=n]          - Enable debug mode of JATS scripts
227 dpurdie 2323
    -here               - Disable JATS auto locate of build.pl
2324
    -locate             - Locate build.pl file and change to directory
245 dpurdie 2325
    -locatepkg=pkg      - Locate build.pl. Resolve multiple files via pkg
2764 dpurdie 2326
    -locatefile=file    - Locate specified build file and change to directory
321 dpurdie 2327
    -locatedir=name     - Locate specified directory by scanning to the root
227 dpurdie 2328
    -platform=[name]    - Set GBE_PLATFORM to name   (=+ to append)
2329
    -buildfilter=[xxx]  - Set GBE_BUILDFILTER to xxx (=+ to append)
2330
    -abt=[xxx]          - Set GBE_ABT to xxx (=+ to append)
349 dpurdie 2331
    -java=version       - Alters java version used (1.4, 1.5, 1.6)
227 dpurdie 2332
    -time               - Time build and compile times
2333
    -version=xxx        - Use specified version of JATS
277 dpurdie 2334
    -[no]exportvars     - Export sanitised JATS EnvVars (default)
379 dpurdie 2335
    -logfile=xxxx       - All output is redirected to the specified file
7300 dpurdie 2336
    -[no]script         - Suppress JATS messages.
227 dpurdie 2337
 
331 dpurdie 2338
 Common commands include:
227 dpurdie 2339
    build               - Rebuild the sandbox and makefiles
2340
    make                - Make one or more components
2341
    ant                 - Invoke an ant build
2342
    abt [-java=xxx]     - Invoke the auto build tool
2343
    install             - Install package into local_dpkg_archive
2344
    help                - Display help message
325 dpurdie 2345
    man                 - Display extended help message
227 dpurdie 2346
    vars                - Display JATS related environment variables
2347
 
2348
    create_dpkg         - Install a package into main dpkg_archive
2349
    label               - Labelling functions
7322 dpurdie 2350
    release             - Build a release from a VCS label/tag
2351
    extract             - Extract a release from a VCS label/tag
227 dpurdie 2352
    dpkg_cache          - Maintain a dpkg cache
2353
    gen_msproject       - Generate MSVC project files
361 dpurdie 2354
    sandbox             - Run Sandbox utility
299 dpurdie 2355
 
227 dpurdie 2356
    etool name          - Run internal tool
2357
    eprog name          - Run external tool
2358
    ebin name           - Run JATS binary tool
2359
 
2360
 Shortcut commands. Composites of basic commands
331 dpurdie 2361
    all [opt]           - Same as a "build -noforce" and "make all"
227 dpurdie 2362
    go  [opt]           - Same as a "make all"
2363
    debug [tgt]         - Same as "make debug package_debug"
2364
    prod  [tgt]         - Same as "make prod package_prod"
2365
    clean               - Same as "make clean"
2366
    clobber             - Same as "build clobber"
2367
    *                   - Unknown commands are treated as arguments to etool
2368
 
2369
 Where [cmd-options] are command specific.
325 dpurdie 2370
    Try "jats help command" for details
227 dpurdie 2371
 
2372
=head1 OPTIONS
2373
 
2374
=over 8
2375
 
2376
=item B<-help>
2377
 
2378
Print a brief help message and exits.
2379
 
2380
=item B<-help -help>
2381
 
2382
Print a detailed help message with an explanation for each option.
2383
 
261 dpurdie 2384
=item B<-man[=n]>
227 dpurdie 2385
 
2386
Prints the manual page and exits.
2387
 
261 dpurdie 2388
If a numeric manual level is provide then it will be used to control the
361 dpurdie 2389
verbosity of help provided. This should be in the range of 1 to 3.
261 dpurdie 2390
 
227 dpurdie 2391
=item B<-b file> B<-buildfile file>
2392
 
2393
This option modifies the operation of the "build" command. The command will
2394
use the specified file instead of the normal build.pl file.
2395
 
2396
=item B<-cd dir> B<-changedir dir>
2397
 
2398
This option will change to specified directory before the command is invoked.
2399
 
261 dpurdie 2400
=item B<--verbose[=n]>
227 dpurdie 2401
 
2402
This option will increase the level of verbosity of the JATS command and command
261 dpurdie 2403
invoked by the JATS shell.
227 dpurdie 2404
 
261 dpurdie 2405
If an argument is provided, then it will be used to set the level, otherwise the
2406
existing level will be incremented. This option may be specified multiple times.
227 dpurdie 2407
 
261 dpurdie 2408
=item B<-debug[=n]>
2409
 
227 dpurdie 2410
This option will increase the level of debug output of the JATS command and command
261 dpurdie 2411
invoked by the JATS shell.
227 dpurdie 2412
 
261 dpurdie 2413
If an argument is provided, then it will be used to set the level, otherwise the
2414
existing level will be incremented. This option may be specified multiple times.
2415
 
227 dpurdie 2416
=item B<-here>
2417
 
2418
This option will disable the "autolocate" mechanism of the JATS shell script.
2419
 
2420
By default JATS will "hunt" for a suitable "build.pl" or "makefile.pl" before
2421
executing a build or a make command. JATS will look in the following directories
2422
for a  suitable file. Under some conditions this mechanism is not useful.
2423
 
2424
By default JATS will hunt in the following directories: "." "jats" "build/
2425
jats" ".." "../.." and "../../..".
2426
 
2427
=item B<-locate>
2428
 
2429
This option will cause the JATS wrapper script to locate the build.pl file and
2430
then change to that directory. This allows users to locate the build root of
2431
a project and then issue other JATS commands.
2432
 
2433
If the B<-c> option is also specified then searching will start in the specified
2434
directory.
2435
 
2436
If an alternate build file is specified with the B<-b> option then that filename
2437
will be used in the location process.
2438
 
2439
This option implies a B<-here>. No further scanning will be done.
2440
 
2441
Exactly one build file must be located. If more than buildfile is located then
2442
the locations of the build files is displayed and JATS will terminate.
2443
 
245 dpurdie 2444
 
2445
=item B<-locatepkg=packagename>
2446
 
2447
This option is similar to the B<-locate> option, but it allows the required
2448
build files to be located by ensuring that the required buildfile builds the
2449
specified package.
2450
 
2451
There are two forms in which the B<packagename> can be specified. It can be
361 dpurdie 2452
specified as a full package name and version, or as a package name and the
245 dpurdie 2453
project suffix. ie: jats-api.1.0.0000.cr or jats-api.cr
2454
 
227 dpurdie 2455
=item B<-locatefile=file>
2456
 
2457
This option is similar to the B<-locate> option, but it allows the name of the
2764 dpurdie 2458
build file to be located to be specified.
227 dpurdie 2459
 
2764 dpurdie 2460
If the named file has an '.xml' suffix then the process will look for a pair of
2461
ANT build files of the form xxx.xml and xxxdepends.xml.
2462
 
319 dpurdie 2463
=item B<-locatedir=name>
2464
 
2465
Locate the named directory by scanning from the current directory to the root
321 dpurdie 2466
of the filesystem. This operation is performed before any other location
319 dpurdie 2467
operations and before the B<-cd=path> operation.
2468
 
2469
It may be used to position the jats operation at the root of a view - provided
2470
the view root is known.
2471
 
227 dpurdie 2472
=item B<-platform=[name]>
2473
 
2474
This option will set the JATS specific environment variable GBE_PLATFORM to
2475
the specified name. The existing value of GBE_PLATFORM may be extended by
2476
using "=+".
2477
 
2478
In practice the GBE_PLATFORM variable is of little use. The same effect can be
2479
achieved directly with make targets or with GBE_BUILDFILTER.
2480
 
2481
=item B<-buildfilter=[xxx]>
2482
 
2483
This option will set the JATS specific environment variable GBE_BUILDFILTER to
2484
the specified name. The existing value of GBE_BUILDFILTER may be extended by
2485
using "=+".
2486
 
2487
This option may be used to limit the initial build, and subsequent "make" to a
2488
limited set of platforms.
2489
 
2490
=item B<-abt=[xxx]>
2491
 
2492
This option will set the JATS specific environment variable GBE_ABT to
2493
the specified name The existing value of GBE_ABT may be extended by
2494
using "=+"..
2495
 
2496
This option is used to pass arguments directly to some tools within the
2497
(ABT) Auto Build Tool framework, or to indicate that the build is being
2498
performed within the ABT framework.
2499
 
2500
=item B<-java=version>
2501
 
2502
This option will override the default java version used by the ant builds and
2503
passed to the underlying programs. The path to the Java SDK is determined from
2504
the environment using the version string replacing the '.' with '_'
2505
 
2506
eg: -java=1.5, will examine the environment for JAVA_HOME_1_5 and will set
2507
JAVA_HOME to that value. It will not setup the users PATH or classpath.
2508
 
2509
=item B<-time>
2510
 
2511
When this option is enabled the JATS script will report the runtime of the
2512
underlying, invoked, command.
2513
 
2514
=item B<-version=xxx>
2515
 
2516
When this option is invoked JATS will attempt to use the specified version to
2517
perform all processing. JATS will search the GBE_DPKG_LOCAL, GBE_DPKG_CACHE,
4688 dpurdie 2518
GBE_DPKG_REPLICA, GBE_DPKG, GBE_DPKG_STORE in order to locate the specified 
2519
version of the package.
227 dpurdie 2520
 
2521
The entire command line will be passed to the JATS wrapper script within that
2522
version. This bypasses the jats.bat or jats.sh startup scripts.
2523
 
277 dpurdie 2524
JATS will attempt to transfer the target version to the local cache in an
2525
attempt to improve performance.
227 dpurdie 2526
 
277 dpurdie 2527
=item B<-[no]exportvars>
227 dpurdie 2528
 
361 dpurdie 2529
The default operation is to export sanitized and calculated values to the
277 dpurdie 2530
programs running under JATS. The use of NoExportVars will prevent JATS from
2531
exporting modified EnvVars into the environment. This may be required by
2532
processes, such as the build daemons that need to pick up the current version of
2533
JATS on the fly and not have it fixed when the daemon is started.
227 dpurdie 2534
 
379 dpurdie 2535
=item B<-logfile=xxxx>
2536
 
2537
This option will cause all output to be redirected to the named logroll. Both
2538
STDOUT and STDERR will be redirected.
2539
 
2540
The redirection occurs after the sanity testing that JATS performs and before the
2541
user command is invoked. The redirection occurs after any directory change option
2542
is executed.
2543
 
2544
Output redirection continues until the program terminates. If JATS invokes other
2545
programs or scripts, there default output will also be redirected.
2546
 
7300 dpurdie 2547
=item B<-[no]script>
2548
 
2549
This option will suppress some internal warning messages, generated by the JATS wrapper
2550
script. It is intended to allow JATS to be used with a shell script without the output 
2551
being polluted with internal warnings.
2552
 
2553
The default operation is to show internal warnings. 
2554
 
227 dpurdie 2555
=back
2556
 
2557
=head1 ARGUMENTS
2558
 
2559
=head2 Basic Commands
2560
 
2561
The following commands are invoked directly by the JATS script to wrap the build
2562
tools in a controlled manner.
2563
 
2564
=over 8
2565
 
361 dpurdie 2566
=item L<build|TOOLS::buildlib>
227 dpurdie 2567
 
2568
Build or rebuild the sandbox and makefiles.
2569
 
2570
This command must be used before the component can be "made" and when the
2571
contents of the "buildpl" file change. It is a common mistake to use the "build"
2572
command to much.
2573
 
2574
The script will hunt for a suitable build.pl file before running the build and
2575
make subcommands.
2576
 
361 dpurdie 2577
The build process has a large number of options.
2578
Use L<"JATS build help"|TOOLS::buildlib/"item_help"> to display the complete list.
227 dpurdie 2579
 
361 dpurdie 2580
=item L<make|TOOLS::jmake>
227 dpurdie 2581
 
2582
Make one or more components
2583
 
2584
This command will invoke a suitable "make" program on the makefile found in
2585
the current directory. This makefile should have been generated by JATS.
2586
 
361 dpurdie 2587
The make process has a large number of options. Use
2588
L<"JATS make help"|TOOLS::jmake/"item_help">" to display the complete list.
227 dpurdie 2589
 
2590
=item B<ant>
2591
 
2592
This command will use ANT to build a component. JATS will determine the
2593
build.xml file to use with the following algorithm.
2594
 
2595
    If the files called <Project>depends.xml and <Project>.xml exist then JATS
2596
    will create an 'auto.xml' from the depends file, if one does not already
2597
    exist or is older than the depends.xml file and then use the <Project>.xml
2598
    file as the ant build file.
2599
 
2600
    Otherwise ant is invoked and it will expect a build.xml file.
2601
 
2602
If multiple <Project>depends.xml and <Project>.xml file pairs are found the
2603
command will fail. This can be resolved through the use of the -buildfile=name
2604
option.
2605
 
2606
Ant is invoked with the version of Java specified with the -Java=x.x option.
2607
 
2608
=item B<abt>
2609
 
2610
This command is used to invoke the Auto Build Tool. It will invoke ANT on the
2611
build.xml file in the current directory in such  manner as to not affect the
239 dpurdie 2612
environment of the programs running under ANT.
227 dpurdie 2613
 
361 dpurdie 2614
The remainder of the command line is passed to the ABT, with the exception of
239 dpurdie 2615
the options:
2616
 
2617
=over 8
2618
 
361 dpurdie 2619
=item *
2620
 
2621
-java=x.x. This is used to control the version of Java used by the
349 dpurdie 2622
ABT. The default is 1.6.
227 dpurdie 2623
 
361 dpurdie 2624
=item *
2625
 
2626
-buildfile=name. This is used to provide a different build file to ant.
239 dpurdie 2627
The default build file is 'build.xml'.
2628
 
2629
=back
2630
 
361 dpurdie 2631
=item L<help|TOOLS::jats_help>
227 dpurdie 2632
 
2633
Display the basic help message.
2634
 
361 dpurdie 2635
=item L<vars [-v]|TOOLS::jats_vars>
227 dpurdie 2636
 
2637
This command will display all the JATS related environment variables in a
2638
readable form.
2639
 
2640
Additional information will be displayed if an argument of "-v" is provided.
2641
 
2642
=back
2643
 
2644
=head2 Extended Commands
2645
 
2646
The following commands support the build environment. They are supplemental to
2647
the build environment. They are implemented as extensions to the basic JATS
2648
command scripts.
2649
 
2650
=over 8
2651
 
361 dpurdie 2652
=item L<create_dpkg|TOOLS::create_dpkg>
227 dpurdie 2653
 
2654
This command will install a generated package into main dpkg_archive. This
2655
command should not be used directly by a user as it does not ensure that package
2656
has been created in a repeatable manner - use "jats release".
2657
 
361 dpurdie 2658
=item label
227 dpurdie 2659
 
2660
This command provides a number of useful labelling mechanisms to assist in the
2661
labeling of source code.
2662
 
361 dpurdie 2663
The command will determine the default Version Control System and invoke the VCS
2664
specific utility. This will be one of:
227 dpurdie 2665
 
361 dpurdie 2666
=over 4
227 dpurdie 2667
 
361 dpurdie 2668
=item   *
2669
 
2670
ClearCase: L<cclabel|TOOLS::jats_cclabel>
2671
 
2672
=item   *
2673
 
2674
Subversion: L<svnlabel|TOOLS::jats_svnlabel>
2675
 
2676
=back
2677
 
2678
=item release
2679
 
2680
This command allows a package to be built and released, given a label.
2681
This is the desired release mechanism for manually releasing a package.
2682
 
227 dpurdie 2683
The command has two main uses:
2684
 
361 dpurdie 2685
=over 4
227 dpurdie 2686
 
2687
=item 1
2688
 
2689
Build a package for release. The process will ensure that the build is
2690
controlled and repeatable.
2691
 
2692
=item 2
2693
 
2694
Rebuild a package for test or debugging purposes.
2695
 
2696
=back
2697
 
361 dpurdie 2698
The command will determine the default Version Control System and invoke the VCS
2699
specific utility. This will be one of:
227 dpurdie 2700
 
361 dpurdie 2701
=over 4
2702
 
2703
=item   *
2704
 
2705
ClearCase: L<ccrelease|TOOLS::jats_ccrelease>
2706
 
2707
=item   *
2708
 
2709
Subversion: L<svnrelease|TOOLS::jats_svnrelease>
2710
 
2711
=back
2712
 
2713
=item L<extract|/"release">
2714
 
227 dpurdie 2715
This is the same as "release -extract"
2716
 
2717
 
361 dpurdie 2718
=item L<dpkg_cache|TOOLS::cache_dpkg>
227 dpurdie 2719
 
2720
This utility provides a number of commands to maintain the local cache of
245 dpurdie 2721
dpkg_archive.
227 dpurdie 2722
 
361 dpurdie 2723
=item L<gen_msproject|TOOLS::gen_msprojects>
227 dpurdie 2724
 
2725
This utility will generate a set of Microsoft Studio (Version 6) project and
361 dpurdie 2726
workspace files to encapsulate the JATS build. The resultant project allows
2727
Visual Studio to be used as an editor, source browser, debugger and build tool.
2728
JATS is still used to perform the build.
227 dpurdie 2729
 
361 dpurdie 2730
=item B<install>
2731
 
2732
This command will install a generated "package" into the local_dpkg_archive
2733
directory. This allows a group of packages to be tested before being published
2734
into the global dpkg_archive.
2735
 
2736
=for htmlclass Note
2737
 
2738
Note. This command is no longer needed. The "build" process will place a
2739
shortcut in the local_dpkg_archive to a components "pkg" directory. Other
2740
components will utilize this shortcut directly and pickup the package without
2741
the user needing to "install" the package - a step that can be forgotten.
2742
 
227 dpurdie 2743
=item B<etool name>
2744
 
2745
This command allows any JATS extension program to be run. The programs will by
2746
found in the JATS TOOLS directory.
2747
 
2748
=item B<eprog name>
2749
 
2750
This command allows any JATS extension program to be run.
2751
If the program end in .pl, then it will be run within a perl interpreter.
2752
If the program end in .jar, then it will be run under a java interpreter.
2753
 
2754
=item B<ebin name>
2755
 
2756
This command allows any JATS support program to be run. The programs will by
2757
found in the JATS BIN directory for the current platform. This command allows
2758
a user script to access many of the machine independent utilities in a simple
2759
manner.
2760
 
2761
Example: "JATS ebin ls" - will provide a "real" ls on all platforms.
2762
 
2763
Example: "JATS ebin sh" - will start up the shell used by make.
2764
 
2765
=back
2766
 
2767
=head2 Command Shortcuts
2768
 
2769
The following commands are user shortcuts to the basic commands. The are basic
2770
commands run in sequence.
2771
 
2772
=over 8
2773
 
2774
=item B<all [make_opts]>
2775
 
2776
This command is the same as running the command "build" and "make all".
2777
It will build a component with a single command.
2778
 
2779
If "make_opts" is not present then "make all" is used.
2780
 
2781
If "make_opts" is present then they are passed to the "make" command. In this
2782
manner is it possible to build a WIN32 component of package with a single
2783
command.
2784
 
2785
=item B<go [make_opts]>
2786
 
2787
This command is similar to the "all" shortcut, but it does not "build" the
2788
sandbox. It may be used where the sandbox has already been prepared.
2789
 
2790
=item B<debug [target]>
2791
 
2792
This command is the same as running "make debug package_debug". It will make and
2793
package all the debug components of a sandbox.
2794
 
2795
If any additional arguments are provided to the B<dev> command then they will be
2796
treated as make targets and the commands will be expanded to make and package
2797
the specified debug versions of the names platforms. Make options cannot be
2798
passed in this manner.
2799
 
2800
Example: "JATS dev GAK" will create and package the debug parts for the
2801
GAK_MOS68K and GAK_MOSCF.
2802
 
2803
=item B<prod [target]>
2804
 
2805
This command is the same as running "make prod package_prod". It will make and
2806
package all the debug components of a sandbox.
2807
 
2808
If any additional arguments are provided to the B<prod> command then they will be
2809
treated as make targets and the commands will be expanded to make and package
2810
the specified debug versions of the names platforms. Make options cannot be
2811
passed in this manner.
2812
 
2813
Example: "JATS prod GAK" will create and package the production parts for the
2814
GAK_MOS68K and GAK_MOSCF.
2815
 
2816
=item B<clean>
2817
 
2818
This is the same as "make clean".
2819
 
2820
=item B<clobber>
2821
 
2822
This is the same as "build clobber"
2823
 
2824
=item B<else>
2825
 
2826
Commands that are not known to the JATS wrapper script are passed to etool.
2827
 
2828
ie: "JATS xxxx" is is the same as "JATS etool xxxx".
2829
 
2830
=back
2831
 
2832
=head1 DESCRIPTION
2833
 
2834
JATS is a wrapper script. It provides:
2835
 
361 dpurdie 2836
=over 4
227 dpurdie 2837
 
2838
=item *
2839
 
361 dpurdie 2840
A controlled and sanitized environment to all the build tools.
227 dpurdie 2841
 
2842
=item *
2843
 
2844
The same command interface on all supported machines: Windows, Solaris and
2845
Linux.
2846
 
2847
=item *
2848
 
2849
Provides a framework for extending the build environment toolset.
2850
 
2851
=back
2852
 
315 dpurdie 2853
=head1 RELATED DOCUMENTATION
227 dpurdie 2854
 
361 dpurdie 2855
=over 4
227 dpurdie 2856
 
361 dpurdie 2857
=item   * L<Installation Notes|POD::InstallationNotes>
227 dpurdie 2858
 
361 dpurdie 2859
=item   * L<OverView|POD::OverView>
227 dpurdie 2860
 
361 dpurdie 2861
=item   * L<EnvVars|POD::EnvVars>
255 dpurdie 2862
 
361 dpurdie 2863
=item   * L<PkgArchives|POD::PkgArchives>
227 dpurdie 2864
 
2865
=back
2866
 
361 dpurdie 2867
Use L<jats help|TOOLS::jats_help> to see the available internal documentation.
227 dpurdie 2868
 
315 dpurdie 2869
=head1 EXAMPLES
227 dpurdie 2870
 
315 dpurdie 2871
=over 8
227 dpurdie 2872
 
361 dpurdie 2873
=item   L<JATS help|TOOLS::jats_help>
227 dpurdie 2874
 
315 dpurdie 2875
This will display the available internal documentation.
227 dpurdie 2876
 
361 dpurdie 2877
=item   L<JATS build|TOOLS::buildlib>
227 dpurdie 2878
 
315 dpurdie 2879
This will prime the current package being built ready for "make". The command
2880
will locate the build.pl file and process it. This will locate all the external
2881
packages and generate the required makefiles.
227 dpurdie 2882
 
361 dpurdie 2883
=item   L<JATS make|TOOLS::jmake>
227 dpurdie 2884
 
2885
This will run the GNU make program over the makefiles generated by the "build"
2886
command. This may be executed in a subdirectory in order to limit the targets
2887
that are "made".
2888
 
361 dpurdie 2889
=for htmlclass Note
2890
 
227 dpurdie 2891
B<NOTE:> Do not run "make" without using the JATS wrapper. It will not perform
2892
as expected as the environment will not have been set up correctly.
2893
 
2894
=back
2895
 
2896
=cut
2897