# DCovd.ctl:342:Collects Oracle Virtual Directory Information
# $Id: DCovd.ctl,v 1.4 2015/07/03 12:04:44 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/DCovd.ctl,v 1.4 2015/07/03 12:04:44 RDA Exp $
#
# Change History
# 20150703  MSC  Improve the documentation.

=head1 NAME

OFM:DCovd - Collects Oracle Virtual Directory Information

=head1 DESCRIPTION

This module collects Oracle Virtual Directory-related information (for example,
server, configuration, and log files).

The following reports can be generated and are regrouped under C<Oracle
Virtual Directory>:

=cut

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

# Initialization
var $ORACLE_HOME = ${D_ORACLE_HOME/P:''}

# Collect the Oracle Virtual Directory information
if !?${B_PRIMARY}
{# Initialization
 var $OVD_HOME = ${D_HOME}

 if !$OVD_HOME
  var $OVD_HOME = $ORACLE_HOME

 var $TOC = '%TOC%'
 var $TOP = '[[#Top][Back to top]]'
 pretoc $MNU = '1:Oracle Virtual Directory'

 # Load the common macros
 run RDA:library()

=head2 Server Files

Collects the following server files:

=over

=item o F<ovidserver.lax>

=item o F<vde.sh>

=item o F<vde_start.sh>

=back

=cut

 debug ' Inside OVD module, gathering server files'
 pretoc '2:Server Files'
 var $dir = $OVD_HOME
 call cat_report($dir,'ovidserver.lax','s_')
 call cat_report($dir,'vde.sh','s_')
 call cat_report($dir,'vde_start.sh','s_')
 unpretoc

=head2 Configuration Files

Collects configuration files from the F<conf> directory.

=cut

 debug ' Inside OVD module, gathering configuration files'
 pretoc '2:Configuration Files'
 var $dir = catDir($OVD_HOME,'conf')
 loop $fil (grepDir($dir,'.*','n'))
  call cat_report($dir,$fil,'c_')
 unpretoc

=head2 Log Files

Collects the log files from the F<log> directory.

=cut

 debug ' Inside OVD module, gathering log files'
 pretoc '2:Log Files'
 var $dir = catDir($OVD_HOME,'log')
 call cat_report($dir,'access.log','l_')
 call cat_report($dir,'vde.log','l_')
 call cat_report($dir,'vde.log.exception','l_')
 call cat_report($dir,'vde_startup.log','l_')
 unpretoc

=head2 not_found - Not Found

Used as a warning when none of the Oracle Virtual Directory files are found.

=cut

 if !isTocCreated(true)
 {debug ' Inside OVD module, no file found'
  report not_found
  write 'No Oracle Virtual Directory files were found and all files were \
         optional. This does not mean there was necessarily a problem with \
         RDA, but it should be investigated.'
  toc $MNU
  toc '2:[[',getFile(),'][rda_report][Not Found]]'
 }
}

=head1 VIRTUAL DIRECTORY INFORMATION FOR FUSION MIDDLEWARE

Includes the reports generated by the L<abr:IREQ|collect::OFM:DCireq> module
about the Oracle instances and their associated Oracle homes.

=cut

elsif ${B_REQ_IREQ}
{# Analyze the instance requests
 var %tbl = ()
 loop $req (${CUR.O_SETUP}->search('^IREQ_OFM_OVD_OI'))
 {var $ins = $req->get_first('I_ORACLE_INSTANCE')
  if ?$ins->get_first('I_ORACLE_HOME')->get_prime('I_COMMON_HOME')
   var $tbl{last->get_oid,$req->get_oid} = $ins->get_first('D_ORACLE_INSTANCE')
  else
   var $tbl{'CH',$req->get_oid} = $ins->get_first('D_ORACLE_INSTANCE')
 }

 # Collect the OVD 11g information
 toc '%PUSH("0:   * Oracle Virtual Directory")%'
 loop $oid (keys(%tbl))
 {toc '%PUSH("1+:Common Product Home")%'
  toc '%INCLUDE("OFM_IREQ_OFM_OVD_',$oid,'_TF.toc")%'
  toc '%POP%'
  loop $tid (keys($tbl = $tbl{$oid}))
  {toc '%PUSH("0:      * ',"'",basename($tbl->{$tid}),"'",' Instance")%'
   toc '%PUSH("%SPLIT%")%'
   toc '%PUSH("1++:Associated Oracle Home")%'
   toc '%INCLUDE("OFM_',replace($tid,'_OI','_OH'),'_TF.toc",1)%'
   toc '%POP2%'
   toc '%PUSH("%SPLIT%")%'
   toc '%PUSH("1++:Instance Home")%'
   toc '%INCLUDE("OFM_',$tid,'_TF.toc")%'
   toc '%POP3%'
  }
 }
 toc '%POP%'
}

=head1 SEE ALSO

L<OFM:DCireq|collect::OFM:DCireq>,
L<OFM:OVDr11|collect::OFM:OVDr11>,
L<RDA:library|collect::RDA:library>

=begin credits

=over 10

=item RDA 4.9:  Mark Wilcox.

=item RDA 4.15: Greg Cook, Andrew Salt, Olaf Stullich.

=item RDA 4.22: Daniel Mortimer.

=item RDA 4.24: Greg Cook, Andrew Salt.

=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