2. AddOnProduct

This module provides integration of the add-on products

2.1. Summary of Module Globals

List of Global Functions

  • AcceptedLicenseAndInfoFile - Show /media.1/info.txt file in a pop-up message if such file exists. Show license if such exists and return whether users accepts it. Returns 'nil' when did not succed.

  • AddPreselectedAddOnProducts - Auto-integrate add-on products in specified file

  • DoInstall - Do installation of the add-on product within an installed system srcid is got via AddOnProduct::src_id

  • Integrate - Integrate the add-on product to the installation workflow, including preparations for 2nd stage and inst-sys update

  • PrepareForRegistration - Checks whether the content file of the add-on has a flag REGISTERPRODUCT set to "true" or "yes". If it has, product is added into list of pruducts that need registration. Cached content file is used if possible.

  • ProcessRegistration - Returns whether registration is requested by at least one of used Add-On products.

  • ReIntegrateFromScratch - Some product(s) were removed, reintegrating their control files from scratch.

  • ReadTmpExportFilename - Reads the Add-Ons configuration stored on disk during the first stage installation.

  • RedrawWizardSteps - Redraw the wizard steps bar

  • RegisterAddOnProduct - Calls registration client if needed.

  • RemoveAddOnControlFile - Removes (from disk cache) a control file which was included in the add-on product.

  • RemoveRegistrationFlag - Add-On product might have been added into products requesting registration. This pruduct has been removed (during configuring list of add-on products).

  • RereadAllSCRAgents - New add-on product might add also new agents. Functions Rereads all available agents.

  • StoreInitialSettings - Stores the initial settings for workflows, proposals, inst_finish, clone_modules to be able to start from scratch when some part of the workflow modified by add-on is removed.

  • TmpExportFilename - Returns the path where Add-Ons configuration is stored during the fist stage installation. This path reffers to the installed system.

  • UpdateInstSys - Adapts the inst-sys from the tarball

  • WFIntegrate - Integrate the changes in the workflow

List of Global Variables

2.2. Global Functions

2.2.1. AcceptedLicenseAndInfoFile

Show /media.1/info.txt file in a pop-up message if such file exists. Show license if such exists and return whether users accepts it. Returns 'nil' when did not succed.

Function parameters

  • integer src_id

Return value

  • boolean - whether the license has been accepted

2.2.2. AddPreselectedAddOnProducts

Auto-integrate add-on products in specified file

Function parameters

  • string filelist

Return value

  • boolean - true on exit

2.2.3. DoInstall

Do installation of the add-on product within an installed system srcid is got via AddOnProduct::src_id

Return value

  • symbol - the result symbol from wizard sequencer

2.2.4. Integrate

Integrate the add-on product to the installation workflow, including preparations for 2nd stage and inst-sys update

Function parameters

  • integer srcid

Return value

  • boolean - true on success

2.2.5. PrepareForRegistration

Checks whether the content file of the add-on has a flag REGISTERPRODUCT set to "true" or "yes". If it has, product is added into list of pruducts that need registration. Cached content file is used if possible.

Function parameters

  • integer src_id

Return value

  • void

2.2.6. ProcessRegistration

Returns whether registration is requested by at least one of used Add-On products.

Return value

  • boolean - if requested

2.2.7. ReIntegrateFromScratch

Some product(s) were removed, reintegrating their control files from scratch.

Return value

  • boolean

2.2.8. ReadTmpExportFilename

Reads the Add-Ons configuration stored on disk during the first stage installation.

Return value

  • boolean

2.2.9. RedrawWizardSteps

Redraw the wizard steps bar

Return value

  • boolean - true on success

2.2.10. RegisterAddOnProduct

Calls registration client if needed.

Function parameters

  • integer src_id

Return value

  • void

2.2.11. RemoveAddOnControlFile

Removes (from disk cache) a control file which was included in the add-on product.

Function parameters

  • integer srcid

Return value

  • boolean

2.2.12. RemoveRegistrationFlag

Add-On product might have been added into products requesting registration. This pruduct has been removed (during configuring list of add-on products).

Function parameters

  • integer src_id

Return value

  • void

2.2.13. RereadAllSCRAgents

New add-on product might add also new agents. Functions Rereads all available agents.

Return value

  • void

2.2.14. StoreInitialSettings

Stores the initial settings for workflows, proposals, inst_finish, clone_modules to be able to start from scratch when some part of the workflow modified by add-on is removed.

Return value

  • void

2.2.15. TmpExportFilename

Returns the path where Add-Ons configuration is stored during the fist stage installation. This path reffers to the installed system.

Return value

  • string

2.2.16. UpdateInstSys

Adapts the inst-sys from the tarball

Function parameters

  • string filename

Return value

  • boolean - true on success

2.2.17. WFIntegrate

Integrate the changes in the workflow

Function parameters

  • string filename

Return value

  • boolean - true on success

2.3. Global Variables

2.3.1. add_on_products

List of all selected sources

add_on_products = [
   $[
     "media" : 4, // ID of the source
     "product_dir" : "/",
     "product" : "openSUSE version XX.Y",
   ],
   ...
 ]

2.3.2. control_files_to_add

List of used control files, to be copied to target system

2.3.3. finish_steps_after_chroot

Items of add-on product to be performed after swictching to chroot

2.3.4. finish_steps_before_chroot

Items if add-on product to be performed at the start of inst_finish

2.3.5. finish_steps_before_umount

Items of add-on product to be performed before unmounting disks

2.3.6. last_ret

return value of last step in the product adding workflow

2.3.7. src_id

ID of currently added source for the add-on product

2.4. Module Requirements

2.4.1. Module Imports

  • Directory
  • FileUtils
  • FileUtils
  • InstShowInfo
  • Installation
  • Label
  • Language
  • Mode
  • Popup
  • ProductControl
  • ProductFeatures
  • ProductLicense
  • Report
  • Wizard
  • XML

2.4.2. Module Includes