<<

# Bugzilla::Install::Requirements

- NAME
- DESCRIPTION
- CONSTANTS
- SUBROUTINES

# NAME

Bugzilla::Install::Requirements - Functions and variables dealing with Bugzilla's perl-module requirements.

# DESCRIPTION

This module is used primarily by `checksetup.pl` to determine whether or not all of Bugzilla's prerequisites are installed. (That is, all the Perl modules it requires.)

# CONSTANTS

`FEATURE_FILES`

  A hashref that describes what files should only be compiled if a certain feature is enabled. The feature is the key, and the values are arrayrefs of file names (which are passed to `glob`, so shell patterns work).

# SUBROUTINES

`check_cpan_requirements`
  Description

    This checks what required Perl modules are installed, like `checksetup.pl` does.

  Params
    `$meta` - A `CPAN::Meta` object.
    `$dirs` - the include dirs to search for modules, defaults to @INC.
    `$output` - `true` if you want the function to print out information about what it's doing, and the versions of everything installed.
  Returns

    A hashref containing these values:

    `ok` - if all the requirements are met, this is true.
    `found` - an arrayref of found modules
    `missing` - an arrayref of missing modules
`check_cpan_feature`
  Description

    This checks that the optional Perl modules required for a feature are installed.

  Params
    `$feature` - A `CPAN::Meta::Feature` object.
    `$dirs` - the include dirs to search for modules, defaults to @INC.
    `$output` - `true` if you want the function to print out information about what it's doing, and the versions of everything installed.
  Returns

    A hashref containing these values:

    `ok` - if all the requirements are met, this is true.
    `found` - an arrayref of found modules
    `missing` - an arrayref of missing modules
  `check_all_cpan_features`
    Description

      This checks which optional Perl modules are currently installed which can enable optional features.

    Params
      `$meta` - A `CPAN::Meta` object.
      `$dirs` - the include dirs to search for modules, defaults to @INC.
      `$output` - `true` if you want the function to print out information about what it's doing, and the versions of everything installed.
    Returns

      A hashref keyed on the feature name. The values are hashrefs containing `description` and `result` keys.

      `description` is the English description of the feature.

      `result` is a hashref in the same format as the return value of `check_cpan_requirements()`, described previously.

  `check_webdotbase($output)`

    Description: Checks if the graphviz binary specified in the `webdotbase` parameter is a valid binary, or a valid URL.

    Params: `$output` - `$true` if you want the function to print out information about what it's doing.

    Returns: `1` if the check was successful, `0` otherwise.

  `check_font_file($output)`

    Description: Checks if the font file specified in the `font_type` parameter is a valid-looking font file.

    Params: `$output` - `$true` if you want the function to print out information about what it's doing.

    Returns: `1` if the check was successful, `0` otherwise.

  `map_files_to_features`

    Returns a hashref where file names are the keys and the value is the feature that must be enabled in order to compile that file.

<<