# DCecm.ctl:352:Controls Oracle WebCenter Content Data Collection
# $Id: DCecm.ctl,v 1.11 2016/05/19 08:52:18 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/DCecm.ctl,v 1.11 2016/05/19 08:52:18 RDA Exp $
#
# Change History
# 20160512  SJC  Only call HCVE for version 11.

=head1 NAME

OFM:DCecm - Controls Oracle WebCenter Content Data Collection

=head1 DESCRIPTION

This module defines common settings for all Oracle WebCenter Content modules
and gathers information that is common for Oracle WebCenter Content components.

Oracle WebCenter Content includes:

=over 3

=item o Universal Online Archive

=item o Oracle WebCenter Content: Imaging

=item o Oracle WebCenter Content: Rights

=item o Oracle WebCenter Content: Records

=item o Oracle WebCenter Distributed Capture

=item o Oracle WebCenter Enterprise Capture

=item o Oracle WebCenter Universal Content Management

=back

The following reports can be generated and are regrouped under C<WebCenter
Content>:

=head1 REPORTS

=cut

echo tput('bold'),'Processing OFM.ECM module ...',tput('off')

# Initialization
var $ORACLE_HOME = ${D_ORACLE_HOME/P:''}
var $DOMAIN_HOME = ${D_DOMAIN_HOME:''}
var $TAIL        = ${DFT.N_TAIL:1000}

var $ASSISTANTS_HOME  = catDir($ORACLE_HOME,'assistants')
var $CFGTOOLLOGS_HOME = catDir($ORACLE_HOME,'cfgtoollogs')
var $ECM_JDK          = catDir($ORACLE_HOME,'jdk')
var $INSTALL_HOME     = catDir($ORACLE_HOME,'install')

var $MNU = 'WebCenter Content'
var $MOD = check(isUnix(),'fx','fr')
var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'
pretoc '1:',$MNU

# Load the common macros
run OFM:WLSlib()
run RDA:library()

=head1 ORACLE HOME COLLECTIONS

=head2 Install and Configuration

Gathers the Oracle Fusion Middleware configuration and installation files.

=cut

debug ' Inside ECM module, gathering install and configuration information'
pretoc '2:Installation and Configuration'
call sort_files(3,$TAIL,\
  grepDir($ASSISTANTS_HOME,'\.log$','dir'),\
  grepDir($CFGTOOLLOGS_HOME,'\.(ini|log|properties|xml)','dir'),\
  grepDir($INSTALL_HOME,'\.(ini|log)','dir'))
unpretoc

if ?testDir('d',catDir($ORACLE_HOME,'diagnostics'))
{debug ' Inside ECM module, gathering diagnostics information'
 pretoc '2:Diagnostics'
 call sort_files(3,$TAIL,\
   grepDir(lastDir(),'\.((conf|ini|xml|properties|err)$|log)|\~','dir'))
 unpretoc
}

=head2 jdk_info - JDK Information

Checks for the available JDK and reports its version.

=cut

debug ' Inside ECM module, gathering jar files'
report jdk_info
prefix
{write '---+!! JDK Information'
 write $TOC
}
loop $cmd (grepDir($ECM_JDK,'^java(\.exe)?$','inr'))
{if ?$cmd = testFile($MOD,$cmd)
 {write '---++ JDK Location: ',encode(catSymbol($cmd))
  call statFile('p',$cmd)
  var $cmd = quote($cmd)
  write '---++++!! JDK Version'
  call writeCommand(concat($cmd,' -version 2>&1'))
  write '---++++!! JDK Full Version'
  call writeCommand(concat($cmd,' -fullversion 2>&1'))
  write $TOP
 }
}
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][JDK Information]]'

=for stopwords Libs

=head2 jdk_libs - Java Libs

Gathers information about all C<*.jar> files located in the common directory.
For each Jar file, the report collects file information and the output from
C<cksum>.

=cut

debug ' Inside ECM module, gathering Java libs information'
report java_libs
prefix
{write '---+!! Information about Java Libs'
 write '%TOC3-2%'
}
var $cmd = findCommand('cksum')
loop $jar (grepDir(catDir($ORACLE_HOME,'j2ee','home'),'\.jar$','inr'),\
           grepDir(catDir($ORACLE_HOME,'jlib'),'\.jar$','inr'),\
           grepDir(catDir($ORACLE_HOME,'lib'),'\.jar$','inr'),\
           grepDir(catDir($ORACLE_HOME,'jdbc','lib'),'\.(jar|zip)$','dir'))
{if ?testFile('f',$jar)
 {write '---++ ',encode(catSymbol($jar))
  call statFile('p',$jar)
  if $cmd
  {write '---++++!! cksum: (checksum size filename)'
   call writeCommand(concat($cmd,' ',quote($jar)))
  }
  write $TOP
 }
}
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][Java Libs]]'

=head2 Manifest Information

Gathers the Oracle home manifest information (on version 11.x and later).

=cut

if ${B_PRIMARY}
{debug ' Inside ECM module, getting Oracle home manifest information \
         (can take time)'
 pretoc '2:Manifest Information'
 call dsp_manifest(3,$ORACLE_HOME)
 unpretoc
}

=head1 COMMON HOME INFORMATION

It includes the reports generated by the L<abr:IREQ|collect::OFM:DCireq> module
about the common home (on version 11.x and later).

=cut

toc '%PUSH("%SPLIT%")%'
toc '%PUSH("1+:Common Product Home")%'
toc '%INCLUDE("OFM_IREQ_OFM_ECM_CH_TF.toc")%'
toc '%POP2%'

=head1 ORACLE WEBLOGIC SERVER DOMAIN COLLECTIONS

It includes all reports produced by the L<abr:WREQ|collect::OFM:DCwreq> module
for the specified Oracle WebLogic Server domain (on version 11.x and later).

=cut

toc '%PUSH("%SPLIT%")%'
toc '%PUSH("1+:Oracle WebLogic Server Overview")%'
toc '%INCLUDE("OFM_WREQ_OFM_ECM_WH_TF.toc")%'
toc '%POP2%'
toc '%PUSH("%SPLIT%")%'
toc '%PUSH("1+:Oracle WebLogic Server Domain")%'
toc '%INCLUDE("OFM_WREQ_OFM_ECM_DOM_TF.toc")%'
toc '%POP2%'

=head1 HCVE

When requested, performs the preinstallation checks.

=cut

var $PROD_ORACLE_HOME
var $str
var $ver = getProductVersion($ORACLE_HOME,'00')

if compare('eq',$ver,'00')
{if or(isWindows(),isCygwin())
 {if ($str) = (grepFile(\
    catFile($DOMAIN_HOME,'bin',${AS.CMD:'setDomainEnv'}),\
    '^\s*set\s+(UCM_ORACLE_HOME|WC_ORACLE_HOME)=(.*?)\s*$','f'))
  {}
 }
 elsif ($str) = (grepFile(\
   catFile($DOMAIN_HOME,'bin',${AS.CMD:'setDomainEnv'}),\
   '^[^\043]*\b(UCM_ORACLE_HOME|WC_ORACLE_HOME)=([\042\047])(.*?)\2','f'))
 {}
 elsif ($str) = (grepFile(\
   catFile($DOMAIN_HOME,'bin',${AS.CMD:'setDomainEnv'}),\
   '^[^\043]*\b(UCM_ORACLE_HOME|WC_ORACLE_HOME)=(\S+)','f'))
 {}

 if length($str)
 {$PROD_ORACLE_HOME = field('=',1,$str)
  $PROD_ORACLE_HOME = replace($PROD_ORACLE_HOME,'^[\s\042\047]+')
  $PROD_ORACLE_HOME = replace($PROD_ORACLE_HOME,'[\s\042\047]+$')
  $ver = getProductVersion($PROD_ORACLE_HOME,'00')
 }
}

if compare('ne',substr($ver,0,2),'00')
 debug ' Inside ECM module, product version identified as ',$ver

if and(compare('eq',substr($ver,0,2),'11'),${B_HCVE_CHECKS})
{debug ' Inside ECM module, executing the preinstallation checks'
 if check(getOsName(),\
          'aix',            'OFM:Aofm1111_aix',\
          'hpux',           'OFM:Aofm1111_hp',\
          'linux',          'OFM:Aofm1111_lin',\
          'solaris',        'OFM:Aofm1111_sol',\
          cond(isCygwin(),  'OFM:Aofm1111_win',\
               isWindows(), 'OFM:Aofm1111_win'))
  test TOOL:TLhcve(last)
}

# Disable the group title in next index
if isTocCreated()
 toc '-:',$MNU

=head1 SEE ALSO

L<OFM:DCipm|collect::OFM:DCipm>,
L<OFM:DCireq|collect::OFM:DCireq>,
L<OFM:DCodc|collect::OFM:DCodc>,
L<OFM:DCucm|collect::OFM:DCucm>,
L<OFM:DCuoa|collect::OFM:DCuoa>,
L<OFM:DCwreq|collect::OFM:DCwreq>,
L<OFM:WLSlib|collect::OFM:WLSlib>,
L<RDA:library|collect::RDA:library>

=begin credits

=over 10

=item RDA 4.16: Greg Cook, Andrew Salt.

=item RDA 4.26: Cindi Canfield.

=item RDA 8.03: Cindi Canfield.

=item RDA 8.04: Wes Root.

=back

=end credits

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut