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>
Package Repository Management</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>
Package Repository Management</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>
Package Repository Management</h1>
</td>
<td class="filecell">modules/SourceManager.ycp</td>
</tr>
<tr>
<td>SourceManager settings, input and output functions</td>
</tr>
<tr>
<td>
<ul>
<li>Anas Nashif <nashif@suse.de></li>
<li> Lukas Ocilka <locilka@suse.cz></li>
<li> Martin Vidner <mvidner@suse.cz></li>
<li> Status: Work in Progress</li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
Representation of the configuration of source-manager.
Input and output routines.
<h1>Imports</h1>
<ul>
<li>HTML</li>
<li>Installation</li>
<li>Label</li>
<li>Linuxrc</li>
<li>Mode</li>
<li>Popup</li>
<li>Progress</li>
<li>Report</li>
<li>String</li>
<li>Summary</li>
<li>URL</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#modified">modified</a>
</li>
<li>
<a href="#proposal_valid">proposal_valid</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#Abort">Abort ()</a>
</li>
<li>
<a href="#AbortFunction">AbortFunction ()</a>
</li>
<li>
<a href="#AddUpdateSources">AddUpdateSources (list<string> urls)</a>
</li>
<li>
<a href="#AskForCD">AskForCD (string message)</a>
</li>
<li>
<a href="#CommitSources">CommitSources ()</a>
</li>
<li>
<a href="#Export">Export ()</a>
</li>
<li>
<a href="#GetSrcIdByIndex">GetSrcIdByIndex (integer idx)</a>
</li>
<li>
<a href="#Import">Import (map settings)</a>
</li>
<li>
<a href="#InstInitSourceMoveDownloadArea">InstInitSourceMoveDownloadArea ()</a>
</li>
<li>
<a href="#InstallationSourceOnPartition">InstallationSourceOnPartition ()</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#Overview">Overview ()</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#SetUrlByIndex">SetUrlByIndex (integer idx)</a>
</li>
<li>
<a href="#SourceData">SourceData (integer source)</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#Write">Write ()</a>
</li>
<li>
<a href="#createSource">createSource (string url)</a>
</li>
<li>
<a href="#deleteSourceByIndex">deleteSourceByIndex (integer idx)</a>
</li>
<li>
<a href="#deleteSourceBySrcId">deleteSourceBySrcId (integer SrcId)</a>
</li>
<li>
<a href="#deleteSourceByUrl">deleteSourceByUrl (string url)</a>
</li>
<li>
<a href="#getSourceId">getSourceId (string url)</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#HandleMultipleSources">HandleMultipleSources (string url)</a>
</li>
<li>
<a href="#ParseUrlQuery">ParseUrlQuery (string query)</a>
</li>
<li>
<a href="#SourceByAliasOrUrl">SourceByAliasOrUrl (string url, map<string,integer> alias_to_id, map<string,integer> url_to_id)</a>
</li>
<li>
<a href="#createItem">createItem (integer index, map source)</a>
</li>
<li>
<a href="#createOverviewItem">createOverviewItem (integer index, map source)</a>
</li>
<li>
<a href="#get_alias_to_id">get_alias_to_id ()</a>
</li>
<li>
<a href="#get_attr_to_id">get_attr_to_id (string attr)</a>
</li>
<li>
<a href="#get_url_to_id">get_url_to_id ()</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Prototypes</p>
<div class="sigbox">
<span class="sig" id="modified">global
<b>modified
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Data was modified?</p>
<div class="sigbox">
<span class="sig" id="proposal_valid">global
<b>proposal_valid
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p></p>
<div class="sigbox">
<span class="sig" id="AbortFunction">global
<b>AbortFunction ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Abort function
return boolean return true if abort</p>
<div class="sigbox">
<span class="sig" id="Abort">global
<b>Abort ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Abort function</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">return true if abort</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Data was modified?</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if modified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Read all source-manager settings</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="CommitSources">global
<b>CommitSources ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Commit changed repositories</p>
<div class="sigbox">
<span class="sig" id="Write">global
<b>Write ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Write all repository-manager settings</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (map settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get all repository-manager settings from the first parameter
(For use by autoinstallation.)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">The YCP structure to be imported.</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 on success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Export">global
<b>Export ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Dump the repository-manager settings to a single map
(For use by autoinstallation.)</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Dumped settings (later acceptable by Import ())</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetSrcIdByIndex">global
<b>GetSrcIdByIndex (integer idx)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Get Repository ID by index </p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">idx</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetUrlByIndex">global
<b>SetUrlByIndex (integer idx)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set current used repository URL by index </p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">idx</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="getSourceId">global
<b>getSourceId (string url)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Get Repository ID when only URL is known </p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">url</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SourceData">global
<b>SourceData (integer source)
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Gather Repository Metadata</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">source</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="createSource">global
<b>createSource (string url)
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Create a repository from an URL</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">url</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="deleteSourceBySrcId">global
<b>deleteSourceBySrcId (integer SrcId)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Delete repository by Repository ID</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">SrcId</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="deleteSourceByIndex">global
<b>deleteSourceByIndex (integer idx)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Delete Repository by the repository index</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">idx</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="deleteSourceByUrl">global
<b>deleteSourceByUrl (string url)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Delete Repository by repository URL</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">url</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="createItem">local
<b>createItem (integer index, map source)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create Summary Item</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">index</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">source</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="createOverviewItem">local
<b>createOverviewItem (integer index, map source)
<span class="a"> -> </span>
<span class="t">term</span>
</b>
</span>
</div>
<p>
Create Repository Item for Overview</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">index</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">source</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="HandleMultipleSources">local
<b>HandleMultipleSources (string url)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Handle Multiple repositories URLs (order/instorder)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">url</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create a textual summary and a list of unconfigured cards</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">summary of the current configuration</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Overview">global
<b>Overview ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create an overview table with all configured cards</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">table items</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">Info:</div>
<p>
Obsoleted (empty implementation), ZMD (ZLM7.3) on sle11 supports only HTTP and FTP repositories,
sync would fail for other types. See bnc#480845 for more details.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">added_src_ids</span>
</td>
<td class="descbox">dummy parameter</td>
</tr>
<tr>
<td class="pbox">
<span class="p">deleted_src_ids</span>
</td>
<td class="descbox">dummy parameter</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">success - always true</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ParseUrlQuery">local
<b>ParseUrlQuery (string query)
<span class="a"> -> </span>
<span class="t">map<string, string></span>
</b>
</span>
</div>
<p>
Parse a URL query (already unescaped) to a map.
If no equal sign, the value will be nil.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">query</span>
</td>
<td class="descbox">foo=bar&baz=qux</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">$["foo": "bar", "baz": "qux"]</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_attr_to_id">local
<b>get_attr_to_id (string attr)
<span class="a"> -> </span>
<span class="t">map<string,integer></span>
</b>
</span>
</div>
<p></p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">attr</span>
</td>
<td class="descbox">SourceGeneralData item</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">For existing repositories, get a mapping from an attribute to the id</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_alias_to_id">local
<b>get_alias_to_id ()
<span class="a"> -> </span>
<span class="t">map<string,integer></span>
</b>
</span>
</div>
<p></p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">For existing repositories, get a mapping from the alias to the id</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_url_to_id">local
<b>get_url_to_id ()
<span class="a"> -> </span>
<span class="t">map<string,integer></span>
</b>
</span>
</div>
<p></p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">For existing repositories, get a mapping from the URL to the id</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SourceByAliasOrUrl">local
<b>SourceByAliasOrUrl (string url, map<string,integer> alias_to_id, map<string,integer> url_to_id)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Extract an alias parameter from the URL and check whether we have
such a repository already.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">url</span>
</td>
<td class="descbox">a repository with an alias parameter (actually optional)</td>
</tr>
<tr>
<td class="pbox">
<span class="p">alias_to_id</span>
</td>
<td class="descbox">a premade mapping, @see get_alias_to_id</td>
</tr>
<tr>
<td class="pbox">
<span class="p">url_to_id</span>
</td>
<td class="descbox"></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">the repository id or -1</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AddUpdateSources">global
<b>AddUpdateSources (list<string> urls)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Used by registration. ZMD sync has been disabled - ZLM7.3 on sle11 supports
only HTTP and FTP repositories, sync would fail for other types.
See bnc#480845 for more details.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">urls</span>
</td>
<td class="descbox">URLs to add</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">a list of added URLs</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="AskForCD">global
<b>AskForCD (string message)
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">message</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InstallationSourceOnPartition">global
<b>InstallationSourceOnPartition ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Function returns the partiton name which is used as a repository for the installation
(IF any partition is used as a repository for installation, of course).
Otherwise it returns an empty string "". See bugzilla #208222 for more information.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">partition name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="InstInitSourceMoveDownloadArea">global
<b>InstInitSourceMoveDownloadArea ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Finds the biggest temporary directory and uses it as
packager download area.</p>
</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