Subversion Repositories DevTools

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

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