home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _669b0f2eea58ed900577739f27c170f6 < prev    next >
Text File  |  2000-03-15  |  14KB  |  424 lines
  1. #
  2. # XML::PPMConfig
  3. #
  4. # Definition of the PPMConfig file format; configuration options for the Perl
  5. # Package Manager.
  6. #
  7. ###############################################################################
  8.  
  9. $XML::PPMConfig::revision = '$Id: PPMConfig.pm,v 1.1.1.1 2000/01/26 17:39:19 graham Exp $';
  10. $XML::PPMConfig::VERSION  = '0.01';
  11.  
  12. ###############################################################################
  13. # Import everything from XML::PPD into our own namespace.
  14. ###############################################################################
  15. package XML::PPMConfig;
  16. use XML::PPD ':elements';
  17.  
  18. ###############################################################################
  19. # PPMConfig Element: Characters
  20. ###############################################################################
  21. package XML::PPMConfig::Characters;
  22. @ISA = qw( XML::Element );
  23.  
  24. ###############################################################################
  25. # PPMConfig Element: PPMCONFIG
  26. ###############################################################################
  27. package XML::PPMConfig::PPMCONFIG;
  28. @ISA = qw( XML::ValidatingElement );
  29. @okids  = qw( PPMVER PLATFORM REPOSITORY OPTIONS PPMPRECIOUS PACKAGE );
  30.  
  31. ###############################################################################
  32. # PPMConfig Element: PPMVER
  33. ###############################################################################
  34. package XML::PPMConfig::PPMVER;
  35. @ISA = qw( XML::ValidatingElement );
  36.  
  37. ###############################################################################
  38. # PPMConfig Element: PLATFORM
  39. ###############################################################################
  40. package XML::PPMConfig::PLATFORM;
  41. @ISA = qw( XML::ValidatingElement );
  42. @oattrs = qw( LANGUAGE );
  43. @rattrs = qw( OSVALUE OSVERSION CPU );
  44.  
  45. ###############################################################################
  46. # PPMConfig Element: REPOSITORY
  47. ###############################################################################
  48. package XML::PPMConfig::REPOSITORY;
  49. @ISA = qw( XML::ValidatingElement );
  50. @oattrs = qw( USERNAME PASSWORD SUMMARYFILE);
  51. @rattrs = qw( NAME LOCATION );
  52.  
  53. ###############################################################################
  54. # PPMConfig Element: OPTIONS
  55. ###############################################################################
  56. package XML::PPMConfig::OPTIONS;
  57. @ISA = qw( XML::ValidatingElement );
  58. @rattrs = qw( IGNORECASE CLEAN CONFIRM FORCEINSTALL ROOT BUILDDIR MORE );
  59. @oattrs = qw( TRACE TRACEFILE VERBOSE );
  60.  
  61. ###############################################################################
  62. # PPMConfig Element: PPMPRECIOUS
  63. ###############################################################################
  64. package XML::PPMConfig::PPMPRECIOUS;
  65. @ISA = qw( XML::ValidatingElement );
  66.  
  67. ###############################################################################
  68. # PPMConfig Element: PACKAGE
  69. ###############################################################################
  70. package XML::PPMConfig::PACKAGE;
  71. @ISA = qw( XML::ValidatingElement );
  72. @okids  = qw( LOCATION INSTDATE INSTROOT INSTPACKLIST INSTPPD );
  73. @rattrs = qw( NAME );
  74.  
  75. ###############################################################################
  76. # PPMConfig Element: LOCATION
  77. ###############################################################################
  78. package XML::PPMConfig::LOCATION;
  79. @ISA = qw( XML::ValidatingElement );
  80.  
  81. ###############################################################################
  82. # PPMConfig Element: INSTDATE
  83. ###############################################################################
  84. package XML::PPMConfig::INSTDATE;
  85. @ISA = qw( XML::ValidatingElement );
  86.  
  87. ###############################################################################
  88. # PPMConfig Element: INSTROOT
  89. ###############################################################################
  90. package XML::PPMConfig::INSTROOT;
  91. @ISA = qw( XML::ValidatingElement );
  92.  
  93. ###############################################################################
  94. # PPMConfig Element: INSTPACKLIST
  95. ###############################################################################
  96. package XML::PPMConfig::INSTPACKLIST;
  97. @ISA = qw( XML::ValidatingElement );
  98.  
  99. ###############################################################################
  100. # PPMConfig Element: INSTPPD
  101. ###############################################################################
  102. package XML::PPMConfig::INSTPPD;
  103. @ISA = qw( XML::ValidatingElement );
  104. @okids = qw( SOFTPKG );                 # Allow for an XML::PPD::SOFTPKG
  105.  
  106. __END__
  107.  
  108. ###############################################################################
  109. # POD
  110. ###############################################################################
  111.  
  112. =head1 NAME
  113.  
  114. XML::PPMConfig - PPMConfig file format and XML parsing elements
  115.  
  116. =head1 SYNOPSIS
  117.  
  118.  use XML::Parser;
  119.  use XML::PPMConfig;
  120.  
  121.  $p = new XML::Parser( Style => 'Objects', Pkg => 'XML::PPMConfig' );
  122.  ...
  123.  
  124. =head1 DESCRIPTION
  125.  
  126. This module provides a set of classes for parsing PPM configuration files using
  127. the C<XML::Parser> module.  All of the elements unique to a PPM
  128. configuration file are derived from C<XML::ValidatingElement>. There are also
  129. several classes rebuilt here which are derived from elements in C<XML::PPD>
  130. as we can include a PPD file within our own INSTPPD element.
  131.  
  132. =head1 MAJOR ELEMENTS
  133.  
  134. =head2 PPMCONFIG
  135.  
  136. Defines a PPM configuration file.  The root of a PPMConfig document is
  137. B<always> a PPMCONFIG element.
  138.  
  139. =head2 PACKAGE
  140.  
  141. Child of PPMCONFIG, used to describe a Perl Package which has already been
  142. installed.  Multiple instances are valid.  The PACKAGE element allows for the
  143. following attributes:
  144.  
  145. =over 4
  146.  
  147. =item NAME
  148.  
  149. Name of the package as given in it's PPD
  150.  
  151. =back
  152.  
  153. =head1 MINOR ELEMENTS
  154.  
  155.  
  156. =head2 PPMVER
  157.  
  158. Child of PPMCONFIG, used to state the version of PPM for which this
  159. configuration file is valid.  A single instance should be present.
  160.  
  161. =head2 PLATFORM
  162.  
  163. Child of PPMCONFIG, used to specify the platform of the target machine.  A
  164. single instance should be present.  The PLATFORM element allows for the
  165. following attributes:
  166.  
  167. =over 4
  168.  
  169. =item OSVALUE
  170.  
  171. Description of the local operating system as defined in the Config.pm file
  172. under 'osname'.
  173.  
  174. =item OSVERSION
  175.  
  176. Version of the local operating system.
  177.  
  178. =item CPU
  179.  
  180. Description of the CPU in the local system.  The following list of possible
  181. values was taken from the OSD Specification:
  182.  
  183.  x86 mips alpha ppc sparc 680x0
  184.  
  185. =item LANGUAGE
  186.  
  187. Description of the language used on the local system as specified by the
  188. language codes in ISO 639.
  189.  
  190. =back
  191.  
  192. =head2 REPOSITORY
  193.  
  194. Child of PPMCONFIG, used to specify a repository where Perl Packages can be
  195. found.  Multiple instances are valid.  The REPOSITORY element allows for the
  196. following attributes:
  197.  
  198. =over 4
  199.  
  200. =item NAME
  201.  
  202. Name by which the repository will be known (e.g.  "ActiveState").
  203.  
  204. =item LOCATION
  205.  
  206. An URL or directory where the repository can be found.
  207.  
  208. =item USERNAME
  209.  
  210. Optional username for a repository requiring authenticated connection.
  211.  
  212. =item PASSWORD
  213.  
  214. Optional password for a repository requiring authenticated connection.
  215.  
  216. =item SUMMARYFILE
  217.  
  218. Optional package summary filename.
  219.  
  220. If this file exists on the repository, its contents can be retrieved
  221. using PPM::RepositorySummary().  The contents are not strictly enforced
  222. by PPM.pm, however ppm.pl expects this to be a file with the following
  223. format (for display with the 'summary' command):
  224.  
  225. Agent [2.91]:   supplies agentspace methods for perl5.
  226. Apache-OutputChain [0.06]:      chain stacked Perl handlers
  227. [etc.]
  228.  
  229. =back
  230.  
  231. =head2 OPTIONS
  232.  
  233. Child of PPMCONFIG, used to specify the current configuration options for PPM.
  234. A single instance should be present.  The OPTIONS element allows for the
  235. following attributes:
  236.  
  237. =over 4
  238.  
  239. =item IGNORECASE
  240.  
  241. Sets case-sensitive searching.  Can be either 'Yes' or 'No'.
  242.  
  243. =item CLEAN
  244.  
  245. Sets removal of temporarily files.  Can be either 'Yes' or 'No'.
  246.  
  247. =item CONFIRM
  248.  
  249. Sets confirmation of all installs/removals/upgrades.  Can be either 'Yes' or
  250. 'No'.
  251.  
  252. =item BUILDDIR
  253.  
  254. Directory in which packages will be unpacked before their installation.
  255.  
  256. =item ROOT
  257.  
  258. Directory under which packages should be installed on the local system.
  259.  
  260. =item TRACE
  261.  
  262. Level of tracing (0 is no tracing, 4 is max tracing).
  263.  
  264. =item TRACEFILE
  265.  
  266. File to which trace information will be written.
  267.  
  268. =item VERBOSE
  269.  
  270. Controls whether query and search results are verbose (1 == verbose, 0 == no).
  271.  
  272. =back
  273.  
  274. =head2 PPMPRECIOUS
  275.  
  276. Child of PPMCONFIG, used to specify the modules which PPM itself is dependant
  277. upon.  A single instance should be present.
  278.  
  279. =head2 LOCATION
  280.  
  281. Child of PACKAGE, used to specify locations at which to search for updated
  282. versions of the PPD file for this package.  Its value can be either a
  283. directory or an Internet address.  A single instance should be present.
  284.  
  285. =head2 INSTDATE
  286.  
  287. Child of PACKAGE, used to specify the date on which the Perl Package was
  288. installed.  A single instance should be present.
  289.  
  290. =head2 INSTROOT
  291.  
  292. Child of PACKAGE, used to specify the root directory that the Perl Package was
  293. installed into.  A single instance should be present.
  294.  
  295. =head2 INSTPACKLIST
  296.  
  297. Child of PACKAGE, used to specify a reference to the packlist for this Perl
  298. Package; a file containing a list of all of the files which were installed.  A
  299. single instance should be present.
  300.  
  301. =head2 INSTPPD
  302.  
  303. Child of PACKAGE, used to hold a copy of the PPD from which Perl Packages
  304. were installed.  Multiple instances are valid.
  305.  
  306. =head1 DOCUMENT TYPE DEFINITION
  307.  
  308. The DTD for PPMConfig documents is available from the ActiveState website and
  309. the latest version can be found at:
  310.     http://www.ActiveState.com/PPM/DTD/ppmconfig.dtd
  311.  
  312. This revision of the C<XML::PPMConfig> module implements the following DTD:
  313.  
  314.  <!ELEMENT PPMCONFIG (PPMVER | PLATFORM | REPOSITORY | OPTIONS |
  315.                       PPMPRECIOUS | PACKAGE)*>
  316.  
  317.  <!ELEMENT PPMVER   (#PCDATA)>
  318.  
  319.  <!ELEMENT PLATFORM  EMPTY>
  320.  <!ATTLIST PLATFORM  OSVALUE     CDATA   #REQUIRED
  321.                      OSVERSION   CDATA   #REQUIRED
  322.                      CPU         CDATA   #REQUIRED
  323.                      LANGUAGE    CDATA   #IMPLIED>
  324.  
  325.  <!ELEMENT REPOSITORY    EMPTY>
  326.  <!ATTLIST REPOSITORY    NAME     CDATA  #REQUIRED
  327.                          LOCATION CDATA  #REQUIRED
  328.                          USERNAME CDATA  #IMPLIED
  329.                          PASSWORD CDATA  #IMPLIED
  330.                          SUMMARYFILE CDATA #IMPLIED>
  331.  
  332.  <!ELEMENT OPTIONS   EMPTY>
  333.  <!ATTLIST OPTIONS   IGNORECASE      CDATA   #REQUIRED
  334.                      CLEAN           CDATA   #REQUIRED
  335.                      CONFIRM         CDATA   #REQUIRED
  336.                      FORCEINSTALL    CDATA   #REQUIRED
  337.                      ROOT            CDATA   #REQUIRED
  338.                      BUILDDIR        CDATA   #REQUIRED
  339.                      MORE            CDATA   #REQUIRED
  340.                      TRACE           CDATA   #IMPLIED
  341.                      TRACEFILE       CDATA   #IMPLIED>
  342.  
  343.  <!ELEMENT PPMPRECIOUS (#PCDATA)>
  344.  
  345.  <!ELEMENT PACKAGE   (LOCATION | INSTDATE | INSTROOT | INSTPACKLIST |
  346.                       INSTPPD)*>
  347.  <!ATTLIST PACKAGE   NAME    CDATA   #REQUIRED>
  348.  
  349.  <!ELEMENT LOCATION  (#PCDATA)>
  350.  
  351.  <!ELEMENT INSTDATE  (#PCDATA)>
  352.  
  353.  <!ELEMENT INSTROOT  (#PCDATA)>
  354.  
  355.  <!ELEMENT INSTPACKLIST (#PCDATA)>
  356.  
  357.  <!ELEMENT INSTPPD   (#PCDATA)>
  358.  
  359. =head1 SAMPLE PPMConfig FILE
  360.  
  361. The following is a sample PPMConfig file.  Note that this may B<not> be a
  362. current description of this module and is for sample purposes only.
  363.  
  364.  <PPMCONFIG>
  365.      <PPMVER>1,0,0,0</PPMVER>
  366.      <PLATFORM CPU="x86" OSVALUE="MSWin32" OSVERSION="4,0,0,0" />
  367.      <OPTIONS BUILDDIR="/tmp" CLEAN="Yes" CONFIRM="Yes" FORCEINSTALL="Yes"
  368.               IGNORECASE="No" MORE="0" ROOT="/usr/local" TRACE="0" TRACEFILE="" />
  369.      <REPOSITORY LOCATION="http://www.ActiveState.com/packages"
  370.                  NAME="ActiveState Package Repository" SUMMARYFILE="package.lst" />
  371.      <PPMPRECIOUS>PPM;libnet;Archive-Tar;Compress-Zlib;libwww-perl</PPMPRECIOUS>
  372.      <PACKAGE NAME="AtExit">
  373.          <LOCATION>g:/packages</LOCATION>
  374.          <INSTPACKLIST>c:/perllib/lib/site/MSWin32-x86/auto/AtExit/.packlist</INSTPACKLIST>
  375.          <INSTROOT>c:/perllib</INSTROOT>
  376.          <INSTDATE>Sun Mar  8 02:56:31 1998</INSTDATE>
  377.          <INSTPPD>
  378.              <SOFTPKG NAME="AtExit" VERSION="1,02,0,0">
  379.                  <TITLE>AtExit</TITLE>
  380.                  <ABSTRACT>Register a subroutine to be invoked at program -exit time.</ABSTRACT>
  381.                  <AUTHOR>Brad Appleton (Brad_Appleton-GBDA001@email.mot.com)</AUTHOR>
  382.                  <IMPLEMENTATION>
  383.                      <CODEBASE HREF="x86/AtExit.tar.gz" />
  384.                  </IMPLEMENTATION>
  385.              </SOFTPKG>
  386.          </INSTPPD>
  387.      </PACKAGE>
  388.  </PPMCONFIG>
  389.  
  390. =head1 KNOWN BUGS/ISSUES
  391.  
  392. Elements which are required to be empty (e.g. REPOSITORY) are not enforced as
  393. such.
  394.  
  395. Notations above about elements for which "only one instance" or "multiple
  396. instances" are valid are not enforced; this primarily a guideline for
  397. generating your own PPD files.
  398.  
  399. Currently, this module creates new classes within it's own namespace for all of
  400. the PPD elements which can be contained within the INSTPPD element.  A suitable
  401. method for importing the entire XML::PPD:: namespace should be found in order
  402. to make this cleaner.
  403.  
  404. =head1 AUTHORS
  405.  
  406. Graham TerMarsch <grahamt@activestate.com>
  407.  
  408. Murray Nesbitt <murrayn@activestate.com>
  409.  
  410. Dick Hardt <dick_hardt@activestate.com>
  411.  
  412. =head1 HISTORY
  413.  
  414. v0.1 - Initial release
  415.  
  416. =head1 SEE ALSO
  417.  
  418. L<XML::ValidatingElement>,
  419. L<XML::Parser>,
  420. L<XML::PPD>
  421. .
  422.  
  423. =cut
  424.