121 lines
3.3 KiB
PHP
121 lines
3.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
* GitBackedUtil.php
|
|
*
|
|
* PHP common utility function lib
|
|
*
|
|
* @package GitBackedUtil.php
|
|
* @version 1.0
|
|
* @author Markus Hoffrogge
|
|
* @copyright Copyright 2023 Markus Hoffrogge
|
|
* @repo https://github.com/woolfg/dokuwiki-plugin-gitbacked
|
|
*/
|
|
|
|
if (__FILE__ == $_SERVER['SCRIPT_FILENAME']) die('Bad load order');
|
|
|
|
// ------------------------------------------------------------------------
|
|
|
|
/**
|
|
* GitBacked Utility Class
|
|
*
|
|
* This class provides common utility functions.
|
|
*
|
|
* @class GitBackedUtil
|
|
*/
|
|
class GitBackedUtil {
|
|
|
|
/**
|
|
* GitBacked temp directory
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $temp_dir = '';
|
|
|
|
/**
|
|
* Checks, if a given path name is an absolute path or not.
|
|
* This function behaves like absolute path determination in dokuwiki init.php fullpath() method.
|
|
* The relevant code has been copied from there.
|
|
*
|
|
* @access public
|
|
* @param string $path a file path name
|
|
* @return bool
|
|
*/
|
|
public static function isAbsolutePath($path) {
|
|
$ret = false;
|
|
|
|
$iswin = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' || !empty($GLOBALS['DOKU_UNITTEST_ASSUME_WINDOWS']));
|
|
// check for the (indestructable) root of the path - keeps windows stuff intact
|
|
if($path[0] == '/') {
|
|
$ret = true;
|
|
} else if($iswin) {
|
|
// match drive letter and UNC paths
|
|
if(preg_match('!^([a-zA-z]:)(.*)!',$path,$match)) {
|
|
$ret = true;
|
|
} else if(preg_match('!^(\\\\\\\\[^\\\\/]+\\\\[^\\\\/]+[\\\\/])(.*)!',$path,$match)) {
|
|
$ret = true;
|
|
}
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Returns the $path as is, if it is an absolute path.
|
|
* Otherwise it will prepend the base path appropriate
|
|
* to the type of DW instance.
|
|
*
|
|
* @access public
|
|
* @param string $path a file path name
|
|
* @return string an appropriate absolute path
|
|
*/
|
|
public static function getEffectivePath($path) {
|
|
$ret = $path;
|
|
|
|
if (self::isAbsolutePath($ret)) {
|
|
return $ret;
|
|
}
|
|
if (defined('DOKU_FARM')) {
|
|
$ret = DOKU_CONF.'../'.$ret;
|
|
} else {
|
|
$ret = DOKU_INC.$ret;
|
|
}
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Returns the temp dir for GitBacked plugin.
|
|
* It ensures that the temp dir will be created , if not yet existing.
|
|
*
|
|
* @access public
|
|
* @return string the gitbacked temp directory name
|
|
*/
|
|
public static function getTempDir() {
|
|
if (empty(self::$temp_dir)) {
|
|
global $conf;
|
|
self::$temp_dir = $conf['tmpdir'].'/gitbacked';
|
|
io_mkdir_p(self::$temp_dir);
|
|
}
|
|
return self::$temp_dir;
|
|
}
|
|
|
|
/**
|
|
* Creates a temp file and writes the $message to it.
|
|
* It ensures that the temp dir will be created , if not yet existing.
|
|
*
|
|
* @access public
|
|
* @param string $message the text message
|
|
* @return string the temp filename created
|
|
*/
|
|
public static function createMessageFile($message) {
|
|
$tmpfname = tempnam(self::getTempDir(), 'gitMessage_');
|
|
$handle = fopen($tmpfname, "w");
|
|
if (!empty($message)) {
|
|
fwrite($handle, $message);
|
|
}
|
|
fclose($handle);
|
|
return $tmpfname;
|
|
}
|
|
|
|
}
|
|
/* End of file */
|