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 (usually add_on_products file)

  • Disintegrate - Opposite to Integrate()

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

  • Export - Returns map describing all used add-ons.

  • GetAbsoluteURL - Returns an absolute URL from base + relative url. Relative URL needs to start with 'reulrl://' othewise it is not considered being relative and it's returned as it is (just the relative_url parameter).

  • 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.

  • RegisterAddOnProduct - Calls registration client if needed.

  • 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.

  • 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

List of Global Variables

  • add_on_products - List of all selected repositories

  • last_ret - return value of last step in the product adding workflow

  • src_id - ID of currently added repository for the add-on product

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 (usually add_on_products file)

Function parameters

  • string filelist

Return value

  • boolean - true on exit

2.2.3. Disintegrate

Opposite to Integrate()

Function parameters

  • integer srcid

Return value

  • void

2.2.4. 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.5. Export

Returns map describing all used add-ons.

Return value

  • map -

This is an XML file created from exported map:
 <add-on>
   <add_on_products config:type="list">
     <listentry>
       <media_url>ftp://server.name/.../</media_url>
       <product>NEEDS_TO_MATCH_"PRODUCT"_TAG_FROM_content_FILE!</product>
       <product_dir>/</product_dir>
     </listentry>
     ...
   </add_on_products>
 </add-on>

2.2.6. GetAbsoluteURL

Returns an absolute URL from base + relative url. Relative URL needs to start with 'reulrl://' othewise it is not considered being relative and it's returned as it is (just the relative_url parameter).

Function parameters

  • string base_url

  • string url

Return value

  • string - absolute_url

Example 1. 

   AddOnProduct::GetAbsoluteURL (
     "http://www.example.org/some%20dir/another%20dir",
     "relurl://../AnotherProduct/"
   ) -> "http://www.example.org/some%20dir/AnotherProduct/"
   AddOnProduct::GetAbsoluteURL (
     "username:password@ftp://www.example.org/dir/",
     "relurl://./Product_CD1/"
   ) -> "username:password@ftp://www.example.org/dir/Product_CD1/"


2.2.7. 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.8. 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.9. ProcessRegistration

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

Return value

  • boolean - if requested

2.2.10. ReIntegrateFromScratch

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

Return value

  • boolean

2.2.11. ReadTmpExportFilename

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

Return value

  • boolean

2.2.12. RegisterAddOnProduct

Calls registration client if needed.

Function parameters

  • integer src_id

Return value

  • void

2.2.13. 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.14. RereadAllSCRAgents

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

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.3. Global Variables

2.3.1. add_on_products

List of all selected repositories

add_on_products = [
   $[
     "media" : 4, // ID of the source
     "product_dir" : "/",
     "product" : "openSUSE version XX.Y",
     "autoyast_product" : "'PRODUCT' tag for AutoYaST Export",
   ],
   ...
 ]

2.3.2. last_ret

return value of last step in the product adding workflow

2.3.3. src_id

ID of currently added repository for the add-on product

2.4. Module Requirements

2.4.1. Module Imports

  • Directory
  • FileUtils
  • FileUtils
  • InstShowInfo
  • Label
  • Language
  • Mode
  • Popup
  • ProductControl
  • ProductFeatures
  • ProductLicense
  • Report
  • String
  • URL
  • Wizard
  • WorkflowManager
  • XML

2.4.2. Module Includes