Difference between revisions of "API:EPrints/Platform"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Added page to state it is many deprecated and point at EPrints::BackCompatibility)
(Tag: Replaced)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
+
{{API}}{{Pod2Wiki}}[[Category:API|PLATFORM]]
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/Platform.pm|package_name=EPrints::Platform}}[[Category:API|Platform]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
'''EPrints::Platform''' - handles platform specific code.
 
  
<!-- End of Pod2Wiki -->
+
This class has been predominantly deprecated and replaced by '''[[API:EPrints/System|EPrints::System]]'''See '''[[API:EPrints/BackCompatibility|EPrints::BackCompatibility]]''' for more details.
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
When you call a method in this class, it is sent to the appropriate EPrints::Platform::xxx module. Usually this is EPrints::Platform::Unix
 
 
 
Which module is used is configured by the {platform} setting in SystemSettings.pm
 
 
 
All file and directory names are absolute and joined by the Unix file separator character '/'.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_chmod -->==chmod==
 
 
 
  chmod( MODE, @filelist )
 
 
 
Change the access control on files listed in @filelist to MODE.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_chown -->==chown==
 
 
 
  chown( $uid, $gid, @filelist )
 
 
 
Change the user and group on files listed in @filelist to $uid and $gid. $uid and $gid are as returned by {{API:PodLink|file=getpwnam|package_name=getpwnam|section=|text=getpwnam}} (usually numeric).
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_getpwnam -->==getpwnam==
 
 
 
  getpwnam( $user )
 
 
 
Return the login-name, password crypt, uid and gid for user $user.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_getpwnam -->==getpwnam==
 
 
 
  getpwnam( $user )
 
 
 
Return the login-name, password crypt, uid and gid for user $user.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_test_uid -->==test_uid==
 
 
 
  test_uid()
 
 
 
Test whether the current user is the same that is configured in SystemSettings.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_mkdir -->==mkdir==
 
 
 
  mkdir( $path, MODE )
 
 
 
Create a directory $path (including parent directories as necessary) set to mode MODE. If MODE is undefined defaults to dir_perms in SystemSettings.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_exec -->==exec==
 
 
 
  exec()
 
 
 
Executes certain named tasks, which were once (and may be) handled by external binaries. This allows a per-platform solution to each task. (example is unpacking a .tar.gz file).
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_read_perl_script -->==read_perl_script==
 
 
 
  $rc = read_perl_script( $repository, $filename, @args )
 
 
 
Executes Perl with @args, including the current EPrints library path. Writes output from the script to $filename (errors and stdout).
 
 
 
Returns 0 on success.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_hash_name -->==get_hash_name==
 
 
 
  get_hash_name()
 
 
 
Returns the last part of the filename of the hashfile for a document. (yes, it's a bad function name.)
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_free_space -->==free_space==
 
 
 
  free_space( $dir )
 
 
 
Return the amount of free space (in bytes) available at $dir. $dir may contain a drive (C:) on Windows platforms.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_proc_exists -->==proc_exists==
 
 
 
  $bool = proc_exists( $pid )
 
 
 
Returns true if a process exists using id $pid.
 
 
 
Returns undef if process identification is unsupported.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_getgrnam -->==getgrnam==
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Latest revision as of 22:02, 9 January 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

This class has been predominantly deprecated and replaced by EPrints::System. See EPrints::BackCompatibility for more details.