https://wiki.eprints.org/w/index.php?action=history&feed=atom&title=API%3AEPrints%2FSystem
API:EPrints/System - Revision history
2026-05-03T22:59:36Z
Revision history for this page on the wiki
MediaWiki 1.31.8
https://wiki.eprints.org/w/index.php?title=API:EPrints/System&diff=14206&oldid=prev
Pod2wiki at 10:02, 11 January 2022
2022-01-11T10:02:29Z
<p></p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en-GB">
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 10:02, 11 January 2022</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l31" >Line 31:</td>
<td colspan="2" class="diff-lineno">Line 31:</td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>All file and directory names are absolute and joined by the  UNIX separator character <tt>/</tt>.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>All file and directory names are absolute and joined by the  UNIX separator character <tt>/</tt>.</div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><span style='display:none'>User Comments</span></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Edit below this comment --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki= --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></div></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki=head_instance_variables --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">==INSTANCE VARIABLES==</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><span style='display:none'>User Comments</span></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Edit below this comment --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki= --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></div></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki=item_$self->{uid} --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">===$self-&gt;{uid}===</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">The user ID of this EPrints system.</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><span style='display:none'>User Comments</span></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Edit below this comment --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki= --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></div></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"><!-- Pod2Wiki=item_$self->{gid} --></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">===$self-&gt;{gid}===</ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2"> </td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">The group ID of this EPrints system.</ins></div></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr>
<tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '></div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '></div></td></tr>
</table>
Pod2wiki
https://wiki.eprints.org/w/index.php?title=API:EPrints/System&diff=14115&oldid=prev
Pod2wiki: Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'..."
2022-01-09T23:11:06Z
<p>Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'..."</p>
<p><b>New page</b></p><div><!-- Pod2Wiki=_preamble_ <br />
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.<br />
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/System.pm|package_name=EPrints::System}}[[Category:API|SYSTEM]][[Category:API:EPrints/System|SYSTEM]]<div><!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --><br />
==NAME==<br />
'''EPrints::System''' - Wrappers for system calls.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=head_description --><br />
==DESCRIPTION==<br />
When you call a method in this class, it is sent to the appropriate <tt>EPrints::System</tt> sub-module:<br />
<br />
EPrints::System::darwin<br />
EPrints::System::freebsd<br />
EPrints::System::linux<br />
EPrints::System::MSWin32<br />
EPrints::System::openbsd<br />
EPrints::System::solaris<br />
<br />
By default this will be [[API:EPrints/System/linux|EPrints::System::linux]].<br />
<br />
Which module is used is configured by the <tt>platform</tt> setting in [[API:EPrints/SystemSettings|EPrints::SystemSettings]]<br />
<br />
All file and directory names are absolute and joined by the UNIX separator character <tt>/</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=head_methods --><br />
==METHODS==<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=head_constructor_methods --><br />
===Constructor Methods===<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_new --><br />
====new====<br />
<br />
$sys = EPrints::System-&gt;new<br />
Returns a new EPrints System object.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=head_object_methods --><br />
===Object Methods ===<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_init --><br />
====init====<br />
<br />
$sys-&gt;init<br />
Perform any platform-specific initialisation.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_chmod --><br />
====chmod====<br />
<br />
$sys-&gt;chmod( $mode, @files )<br />
Change the access control on <tt>@files</tt> listed to <tt>$mode</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_chown --><br />
====chown====<br />
<br />
$sys-&gt;chown( $uid, $gid, @files )<br />
Change the user and group on <tt>@files</tt> to <tt>$uid</tt> and <tt>$gid</tt>. <tt>$uid</tt> and <tt>$gid</tt> are as returned by [[API:EPrints/System#getpwnam|getpwnam]] (usually numeric).<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_chown_for_eprints --><br />
====chown_for_eprints====<br />
<br />
$sys-&gt;chown_for_eprints( @files )<br />
Change the user and group on <tt>@files</tt> to the current EPrints user and group.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_getgrnam --><br />
====getgrnam====<br />
<br />
$gid = $sys-&gt;getgrnam( $group )<br />
Return the system group ID of the group <tt>$group</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_getpwnam --><br />
====getpwnam====<br />
<br />
($user, $crypt, $uid, $gid ) = $sys-&gt;getpwnam( $user )<br />
Return the login name, password crypt, UID and GID for user <tt>$user</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_current_uid --><br />
====current_uid====<br />
<br />
$sys-&gt;current_uid<br />
Returns the current UID of the user running this process.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_test_uid --><br />
====test_uid====<br />
<br />
$sys-&gt;test_uid<br />
Test whether the current user is the same that is configured in [[API:EPrints/SystemSettings|EPrints::SystemSettings]].<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_mkdir --><br />
====mkdir====<br />
<br />
$sys-&gt;mkdir( $full_path, $perms )<br />
Create a directory <tt>$full_path</tt> (including parent directories as necessary) set permissions described by <tt>$perms</tt>. If <tt>$perms</tt> is undefined defaults to <tt>dir_perms</tt> in [[API:EPrints/SystemSettings|EPrints::SystemSettings]].<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_exec --><br />
====exec====<br />
<br />
$sys-&gt;exec( $repository, $cmd_id, %map )<br />
Executes certain named task <tt>$cmd_id</tt> on <tt>$repository</tt>, which were once (and may be) handled by external binaries. This allows a per-platform solution to each task. E.g. unpacking a .tar.gz file.<br />
<br />
<tt>%map</tt> includes variable names and values that need to be mapped into the task command.<br />
<br />
Returns the numerical return code from the executed command.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_read_exec --><br />
====read_exec====<br />
<br />
$rc = $sys-&gt;read_exec( $repo, $tmp, $cmd_id, %map )<br />
Same as &lt;/exec&gt; but write <tt>STDOUT</tt> and <tt>STDERR</tt> to the filename specified by <tt>$tmp</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_read_perl_script --><br />
====read_perl_script====<br />
<br />
$rc = $sys-&gt;read_perl_script( $repo, $tmp, @args )<br />
Executes Perl with arguments from <tt>@args</tt>, including the current EPrints library path. Writes <tt>STDOUT</tt> and <tt>STDERR</tt> from the script to file with name <tt>$tmp</tt>.<br />
<br />
Returns <tt>0</tt> on success.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_free_space --><br />
====free_space====<br />
<br />
$sys-&gt;free_space( $dir )<br />
Return the amount of free space (in bytes) available at <tt>$dir</tt>. <tt>$dir</tt> may contain a drive (e.g. <tt>C:</tt>) on Windows platforms.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_proc_exists --><br />
====proc_exists====<br />
<br />
$bool = $sys-&gt;proc_exists( $pid )<br />
Returns <tt>true</tt> if a process exists for ID with <tt>$pid</tt>.<br />
<br />
Returns <tt>undef</tt> if process identification is unsupported.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_get_hash_name --><br />
====get_hash_name====<br />
<br />
$filename = $sys-&gt;get_hash_name<br />
Returns the last part of the filename of the hashfile for a document. (yes, it's a bad function name.)<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_write_config_file --><br />
====write_config_file====<br />
<br />
$backup = write_config_file( $path, $content, [ %opts ] )<br />
Write a config file containing <tt>$content</tt> to the file located at <tt>$path</tt>.<br />
<br />
If <tt>$content</tt> is undefined no file will be written.<br />
<br />
<tt>%opts</tt> not currently used but reserved for future use.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_quotemeta --><br />
====quotemeta====<br />
<br />
$quoted = $sys-&gt;quotemeta( $path )<br />
Quote <tt>$path</tt> so it is safe to be used in a shell call.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_capture_stderr --><br />
====capture_stderr====<br />
<br />
$tmpfile = $sys-&gt;capture_stderr<br />
Captures STDERR output into a temporary file and return a file handle to it.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_restore_stderr --><br />
====restore_stderr====<br />
<br />
$sys-&gt;restore_stderr( $tmpfile )<br />
Restores <tt>STDERR</tt> after capturing. <br />
<br />
If <tt>$tmpfile</tt> is set, reset seek and sysseek to the start of this file. <br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_join_path --><br />
====join_path====<br />
<br />
$path = $sys-&gt;join_path( @parts )<br />
Returns <tt>@parts</tt> joined together using the current system's path separator.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_file_extension --><br />
====file_extension====<br />
<br />
$ext = $sys-&gt;file_extension( $filename )<br />
Returns the file extension of $filename including the leading <tt>.</tt> e.g. <tt>.tar.gz</tt>.<br />
<br />
Returns empty string if there is no file extension.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_sanitise --><br />
====sanitise====<br />
<br />
$filepath = $sys-&gt;sanitise( $filepath )<br />
Replaces restricted file system characters and control characters in <tt>$filepath</tt> with <tt>_</tt>.<br />
<br />
Removes path-walking elements (<tt>.</tt> and <tt>..</tt>) from the front of any path components and removes the leading <tt>/</tt>.<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=item_bin_paths --><br />
====bin_paths====<br />
<br />
@paths = $sys-&gt;bin_paths<br />
Get the list of absolute directories to search for system tools (e.g. <tt>convert</tt>).<br />
<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=head_copyright --><br />
==COPYRIGHT==<br />
{{API:Copyright}}<br />
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br />
<span style='display:none'>User Comments</span><br />
<!-- Edit below this comment --><br />
<br />
<br />
<!-- Pod2Wiki= --><br />
</div><br />
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --></div>
Pod2wiki