Collaboration diagram for SimpleSAML\Utils\System:

Static Public Member Functions
static	getOS ()
	This function returns the Operating System we are running on. More...

static	getTempDir ()
	This function retrieves the path to a directory where temporary files can be saved. More...

static	resolvePath ($path, $base=null)
	Resolve a (possibly) relative path from the given base path. More...

static	writeFile ($filename, $data, $mode=0600)
	Atomically write a file. More...

Data Fields
const	WINDOWS = 1

const	LINUX = 2

const	OSX = 3

const	HPUX = 4

const	UNIX = 5

const	BSD = 6

const	IRIX = 7

const	SUNOS = 8

Static Private Member Functions
static	pathContainsDriveLetter ($path)
	Check if the supplied path contains a Windows-style drive letter. More...

Detailed Description

Definition at line 9 of file System.php.

Member Function Documentation

◆ getOS()

static SimpleSAML\Utils\System::getOS ( )

static

This function returns the Operating System we are running on.

Returns: mixed A predefined constant identifying the OS we are running on. False if we are unable to determine it.

Author: Jaime Perez, UNINETT AS jaime.nosp@m..per.nosp@m.ez@un.nosp@m.inet.nosp@m.t.no

Definition at line 29 of file System.php.

    {
        if (stristr(PHP_OS, 'LINUX')) {
            return self::LINUX;
        }
        if (stristr(PHP_OS, 'DARWIN')) {
            return self::OSX;
        }
        if (stristr(PHP_OS, 'WIN')) {
            return self::WINDOWS;
        }
        if (stristr(PHP_OS, 'BSD')) {
            return self::BSD;
        }
        if (stristr(PHP_OS, 'UNIX')) {
            return self::UNIX;
        }
        if (stristr(PHP_OS, 'HP-UX')) {
            return self::HPUX;
        }
        if (stristr(PHP_OS, 'IRIX')) {
            return self::IRIX;
        }
        if (stristr(PHP_OS, 'SUNOS')) {
            return self::SUNOS;
        }
        return false;
    }

References SimpleSAML\Utils\System\BSD, SimpleSAML\Utils\System\HPUX, SimpleSAML\Utils\System\IRIX, SimpleSAML\Utils\System\LINUX, SimpleSAML\Utils\System\OSX, SimpleSAML\Utils\System\SUNOS, SimpleSAML\Utils\System\UNIX, and SimpleSAML\Utils\System\WINDOWS.

Referenced by SimpleSAML\Logger\SyslogLoggingHandler\__construct(), and SimpleSAML_Utilities\isWindowsOS().

Here is the caller graph for this function:

◆ getTempDir()

static SimpleSAML\Utils\System::getTempDir ( )

static

This function retrieves the path to a directory where temporary files can be saved.

Returns: string Path to a temporary directory, without a trailing directory separator.

Exceptions

SimpleSAML_Error_Exception If the temporary directory cannot be created or it exists and does not belong to the current user.

Author: Andreas Solberg, UNINETT AS andre.nosp@m.as.s.nosp@m.olber.nosp@m.g@un.nosp@m.inett.nosp@m..no; Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no; Jaime Perez, UNINETT AS jaime.nosp@m..per.nosp@m.ez@un.nosp@m.inet.nosp@m.t.no

Definition at line 70 of file System.php.

    {
        $globalConfig = \SimpleSAML_Configuration::getInstance();
 
        $tempDir = rtrim(
            $globalConfig->getString(
                'tempdir',
                sys_get_temp_dir().DIRECTORY_SEPARATOR.'simplesaml'
            ),
            DIRECTORY_SEPARATOR
        );
 
        if (!is_dir($tempDir)) {
            if (!mkdir($tempDir, 0700, true)) {
                $error = error_get_last();
                throw new \SimpleSAML_Error_Exception(
                    'Error creating temporary directory "'.$tempDir.'": '.
                    (is_array($error) ? $error['message'] : 'no error available')
                );
            }
        } elseif (function_exists('posix_getuid')) {
            // check that the owner of the temp directory is the current user
            $stat = lstat($tempDir);
            if ($stat['uid'] !== posix_getuid()) {
                throw new \SimpleSAML_Error_Exception(
                    'Temporary directory "'.$tempDir.'" does not belong to the current user.'
                );
            }
        }
 
        return $tempDir;
    }

References $globalConfig, and SimpleSAML_Configuration\getInstance().

Referenced by SimpleSAML_Utilities\getTempDir(), and SimpleSAML\Utils\System\writeFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pathContainsDriveLetter()

static SimpleSAML\Utils\System::pathContainsDriveLetter ( $path )

staticprivate

Check if the supplied path contains a Windows-style drive letter.

Parameters

string $path

Returns: bool

Definition at line 233 of file System.php.

    {
        $letterAsciiValue = ord(strtoupper(substr($path, 0, 1)));
        return substr($path, 1, 1) === ':'
                && $letterAsciiValue >= 65 && $letterAsciiValue <= 90;
    }

References $path.

◆ resolvePath()

static SimpleSAML\Utils\System::resolvePath	(	$path,
		$base = `null`
	)

static

Resolve a (possibly) relative path from the given base path.

A path which starts with a '/' is assumed to be absolute, all others are assumed to be relative. The default base path is the root of the SimpleSAMLphp installation.

Parameters

string	$path	The path we should resolve.
string \| null	$base	The base path, where we should search for $path from. Default value is the root of the SimpleSAMLphp installation.

Returns: string An absolute path referring to $path.

Author: Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no

Definition at line 118 of file System.php.

    {
        if ($base === null) {
            $config = \SimpleSAML_Configuration::getInstance();
            $base = $config->getBaseDir();
        }
 
        // normalise directory separator
        $base = str_replace('\\', '/', $base);
        $path = str_replace('\\', '/', $path);
 
        // remove trailing slashes
        $base = rtrim($base, '/');
        $path = rtrim($path, '/');
 
        // check for absolute path
        if (substr($path, 0, 1) === '/') {
            // absolute path. */
            $ret = '/';
        } elseif (static::pathContainsDriveLetter($path)) {
            $ret = '';
        } else {
            // path relative to base
            $ret = $base;
        }
 
        $path = explode('/', $path);
        foreach ($path as $d) {
            if ($d === '.') {
                continue;
            } elseif ($d === '..') {
                $ret = dirname($ret);
            } else {
                if ($ret && substr($ret, -1) !== '/') {
                    $ret .= '/';
                }
                $ret .= $d;
            }
        }
 
        return $ret;
    }

References $base, $config, $d, $path, $ret, and SimpleSAML_Configuration\getInstance().

Referenced by SimpleSAML\Utils\Config\getCertPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFile()

static SimpleSAML\Utils\System::writeFile	(	$filename,
		$data,
		$mode = `0600`
	)

static

Atomically write a file.

This is a helper function for writing data atomically to a file. It does this by writing the file data to a temporary file, then renaming it to the required file name.

Parameters

string	$filename	The path to the file we want to write to.
string	$data	The data we should write to the file.
int	$mode	The permissions to apply to the file. Defaults to 0600.

Exceptions

InvalidArgumentException If any of the input parameters doesn't have the proper types.

Exceptions

SimpleSAML_Error_Exception If the file cannot be saved, permissions cannot be changed or it is not possible to write to the target file.

Author: Andreas Solberg, UNINETT AS andre.nosp@m.as.s.nosp@m.olber.nosp@m.g@un.nosp@m.inett.nosp@m..no; Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no; Andjelko Horvat; Jaime Perez, UNINETT AS jaime.nosp@m..per.nosp@m.ez@un.nosp@m.inet.nosp@m.t.no

Returns: void

Definition at line 183 of file System.php.

    {
        if (!is_string($filename) || !is_string($data) || !is_numeric($mode)) {
            throw new \InvalidArgumentException('Invalid input parameters');
        }
 
        $tmpFile = self::getTempDir().DIRECTORY_SEPARATOR.rand();
 
        $res = @file_put_contents($tmpFile, $data);
        if ($res === false) {
            $error = error_get_last();
            throw new \SimpleSAML_Error_Exception(
                'Error saving file "'.$tmpFile.'": '.
                (is_array($error) ? $error['message'] : 'no error available')
            );
        }
 
        if (self::getOS() !== self::WINDOWS) {
            if (!chmod($tmpFile, $mode)) {
                unlink($tmpFile);
                $error = error_get_last();
                //$error = (is_array($error) ? $error['message'] : 'no error available');
                throw new \SimpleSAML_Error_Exception(
                    'Error changing file mode of "'.$tmpFile.'": '.
                    (is_array($error) ? $error['message'] : 'no error available')
                );
            }
        }
 
        if (!rename($tmpFile, $filename)) {
            unlink($tmpFile);
            $error = error_get_last();
            throw new \SimpleSAML_Error_Exception(
                'Error moving "'.$tmpFile.'" to "'.$filename.'": '.
                (is_array($error) ? $error['message'] : 'no error available')
            );
        }
 
        if (function_exists('opcache_invalidate')) {
            opcache_invalidate($filename);
        }
    }