ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
PackageSlideShow.ycp
Purpose: Module to access slides from installation repository
</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
PackageSlideShow.ycp
Purpose: Module to access slides from installation repository
</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
PackageSlideShow.ycp
Purpose: Module to access slides from installation repository
</h1>
</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td>
<ul>
<li>Stefan Hundhammer <sh@suse.de></li>
<li> Stanislav Visnovsky <visnov@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>Mode</li>
<li>SlideShow</li>
<li>Slides</li>
<li>String</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#InitPkgData">InitPkgData (boolean force)</a>
</li>
<li>
<a href="#SetCurrentCdNo">SetCurrentCdNo (integer src_no, integer cd_no)</a>
</li>
<li>
<a href="#SetMediaType">SetMediaType (string new_media_type)</a>
</li>
<li>
<a href="#SlideDisplayDone">SlideDisplayDone (string pkg_name, integer pkg_size, boolean deleting)</a>
</li>
<li>
<a href="#SlideDisplayStart">SlideDisplayStart (string pkg_name, string pkg_summary, integer pkg_size, boolean deleting)</a>
</li>
<li>
<a href="#SlideProvideStart">SlideProvideStart (string pkg_name, integer sz, boolean remote)</a>
</li>
<li>
<a href="#StripPath">StripPath (string pkg_name)</a>
</li>
<li>
<a href="#StripReleaseNo">StripReleaseNo (string pkg_name)</a>
</li>
<li>
<a href="#UpdateAllCdProgress">UpdateAllCdProgress (boolean silent_check)</a>
</li>
<li>
<a href="#UpdateCurrentCdProgress">UpdateCurrentCdProgress (boolean silent_check)</a>
</li>
<li>
<a href="#UpdateCurrentPackageProgress">UpdateCurrentPackageProgress (integer pkg_percent)</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#CdProgressId">CdProgressId (integer src_no, integer cd_no)</a>
</li>
<li>
<a href="#CdStatisticsTableItems">CdStatisticsTableItems ()</a>
</li>
<li>
<a href="#FindNextMedia">FindNextMedia ()</a>
</li>
<li>
<a href="#FormatRemainingCount">FormatRemainingCount (integer remaining)</a>
</li>
<li>
<a href="#FormatRemainingSize">FormatRemainingSize (integer remaining)</a>
</li>
<li>
<a href="#FormatTimeShowOverflow">FormatTimeShowOverflow (integer seconds)</a>
</li>
<li>
<a href="#ListSum">ListSum (list<integer> sizes)</a>
</li>
<li>
<a href="#ListSumCutOff">ListSumCutOff (list<integer> sizes, integer max_cutoff)</a>
</li>
<li>
<a href="#RecalcRemainingTimes">RecalcRemainingTimes (boolean force_recalc)</a>
</li>
<li>
<a href="#SanityCheck">SanityCheck (boolean silent)</a>
</li>
<li>
<a href="#SubtractPackageSize">SubtractPackageSize (integer pkg_size)</a>
</li>
<li>
<a href="#SwitchToSecondsIfNecessary">SwitchToSecondsIfNecessary ()</a>
</li>
<li>
<a href="#UpdateTotalProgress">UpdateTotalProgress (boolean silent_check)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="StripReleaseNo">global
<b>StripReleaseNo (string pkg_name)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get version info for a package (without build no.)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_name</span>
</td>
<td class="descbox">name of the package without path and ".rpm" extension</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">version string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StripPath">global
<b>StripPath (string pkg_name)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get package file name from path</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_name</span>
</td>
<td class="descbox">location of the package</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">package file name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetMediaType">global
<b>SetMediaType (string new_media_type)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
set media type "CD" or "DVD"</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">new_media_type</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ListSum">local
<b>ListSum (list<integer> sizes)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Sum up all list items</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sizes</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ListSumCutOff">local
<b>ListSumCutOff (list<integer> sizes, integer max_cutoff)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Sum up all positive list items, but cut off individual items at a maximum value.
Negative return values indicate overflow of any individual item at "max_cutoff".
In this case, the absolute value of the return value is "max_cutoff" * number of overflows.
(e.g. >2hour + >2hours + 1:13:20 => >4hours</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sizes</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">max_cutoff</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FormatTimeShowOverflow">local
<b>FormatTimeShowOverflow (integer seconds)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Format an integer seconds value with min:sec or hours:min:sec</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">seconds</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FormatRemainingSize">local
<b>FormatRemainingSize (integer remaining)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Format number of remaining bytes to be installed as string.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">remaining</span>
</td>
<td class="descbox">bytes remaining, -1 for 'done'</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">human readable remaining time or byte / kB/ MB size</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FormatRemainingCount">local
<b>FormatRemainingCount (integer remaining)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Format number of remaining packages to be installed as string.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">remaining</span>
</td>
<td class="descbox">bytes remaining, -1 for 'done'</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">human readable remaining time or byte / kB/ MB size</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SanityCheck">local
<b>SanityCheck (boolean silent)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Perform sanity check for correct initialzation etc.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">silent</span>
</td>
<td class="descbox">don't complain in log file</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if OK, false if any error</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SubtractPackageSize">local
<b>SubtractPackageSize (integer pkg_size)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update internal bookkeeping: subtract size of one package from the
global list of remaining sizes per CD</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_size</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InitPkgData">global
<b>InitPkgData (boolean force)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize internal pacakge data, such as remaining package sizes and
times. This may not be called before the pkginfo server is up and
running, so this cannot be reliably done from the constructor in all
cases.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">force</span>
</td>
<td class="descbox">true to force reinitialization</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FindNextMedia">local
<b>FindNextMedia ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Try to figure out what media will be needed next
and set next_src_no and next_cd_no accordingly.</p>
<div class="sigbox">
<span class="sig" id="SetCurrentCdNo">global
<b>SetCurrentCdNo (integer src_no, integer cd_no)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set the current repository and CD number. Must be called for each CD change.
src_no: 1...n
cd_no: 1...n</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">src_no</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">cd_no</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="RecalcRemainingTimes">local
<b>RecalcRemainingTimes (boolean force_recalc)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Recalculate remaining times per CD based on package sizes remaining
and data rate so far. Recalculation is only done each 'recalc_interval'
seconds unless 'force_recalc' is set to 'true'.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">force_recalc</span>
</td>
<td class="descbox">force recalculation even if timeout not reached yet</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if recalculated, false if not</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SwitchToSecondsIfNecessary">local
<b>SwitchToSecondsIfNecessary ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Switch unit to seconds if necessary and recalc everything accordingly.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if just switched from sizes to seconds, false otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateCurrentCdProgress">global
<b>UpdateCurrentCdProgress (boolean silent_check)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update progress widgets for the current CD: Label and ProgressBar.
Use global statistics variables for that.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">silent_check</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateTotalProgress">local
<b>UpdateTotalProgress (boolean silent_check)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update progress widgets</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">silent_check</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CdStatisticsTableItems">local
<b>CdStatisticsTableItems ()
<span class="a"> -> </span>
<span class="t">list<term></span>
</b>
</span>
</div>
<p>
Returns a table widget item list for CD statistics</p>
<div class="sigbox">
<span class="sig" id="UpdateCurrentPackageProgress">global
<b>UpdateCurrentPackageProgress (integer pkg_percent)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Progress display update
This is called via the packager's progress callbacks.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_percent</span>
</td>
<td class="descbox">package percentage</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateAllCdProgress">global
<b>UpdateAllCdProgress (boolean silent_check)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update progress widgets for all CDs.
Uses global statistics variables.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">silent_check</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CdProgressId">local
<b>CdProgressId (integer src_no, integer cd_no)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return a CD's progress bar ID</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">src_no</span>
</td>
<td class="descbox">number of the repository (from 0 on)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">cd_no</span>
</td>
<td class="descbox">number of the CD within that repository (from 0 on)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SlideDisplayDone">global
<b>SlideDisplayDone (string pkg_name, integer pkg_size, boolean deleting)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
package start display update
- this is called at the end of a new package</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_name</span>
</td>
<td class="descbox">package name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">pkg_size</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">deleting</span>
</td>
<td class="descbox">Flag: deleting (true) or installing (false) package?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SlideDisplayStart">global
<b>SlideDisplayStart (string pkg_name, string pkg_summary, integer pkg_size, boolean deleting)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
package start display update
- this is called at the beginning of a new package</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_name</span>
</td>
<td class="descbox">package name</td>
</tr>
<tr>
<td class="pbox">
<span class="p">pkg_summary</span>
</td>
<td class="descbox">package summary (short description)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">pkg_size</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">deleting</span>
</td>
<td class="descbox">Flag: deleting (true) or installing (false) package?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SlideProvideStart">global
<b>SlideProvideStart (string pkg_name, integer sz, boolean remote)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Package providal start</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">pkg_name</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">sz</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">remote</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018