composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-24 02:58:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

New symlink flag set by the compiler, new compile with symlinks checkbox in the setup (#190)

Browse Source 
The flag consists of the new `data/.compilation-symlinks` file, which is included in the code base (but not available in the Combodo packages).

It will be used and generated if and only if : 
* we are on a dev env (`\utils::IsDevelopmentEnvironment`)
* the `symlink` PHP function exists

The flag is generated low level in the compiler (\MFCompiler::DoCompile)

In the setup, if the flag is present and all conditions are met then a new option will be displayed in the "Miscellaneous Parameters" wizard step. When unchecking/checking the flag will be updated accordingly by an ajax query.

All other compiler consumers (Designer / Hub connectors, Core Update, scripts using `RunTimeEnvironment` class) will : 
* if they provide a value for the symlink option, it will be used
* otherwise the flag will be used instead, if conditions are met
This commit is contained in:
Pierre Goiffon
2021-06-14 16:44:34 +02:00
committed by GitHub
parent d8e2a1cc7c
commit c417a454d6
8 changed files with 157 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
setup/compiler.class.inc.php
View File

@@ -51,7 +51,15 @@ class DOMFormatException extends Exception
*/
class MFCompiler
{
const DATA_PRECOMPILED_FOLDER = 'data' . DIRECTORY_SEPARATOR . 'precompiled_styles' . DIRECTORY_SEPARATOR;
const DATA_PRECOMPILED_FOLDER = 'data'.DIRECTORY_SEPARATOR.'precompiled_styles'.DIRECTORY_SEPARATOR;
/**
* Path to the "use symlinks" file
* If this file is present, then we will compile to symlink !
*
* @var string
*/
public const USE_SYMBOLIC_LINKS_FILE_PATH = APPROOT.'data/.compilation-symlinks';
/** @var \ThemeHandlerService */
protected static $oThemeHandlerService;
@@ -93,54 +101,112 @@ class MFCompiler
protected function DumpLog($oPage)
{
foreach ($this->aLog as $sText)
{
foreach ($this->aLog as $sText) {
$oPage->p($sText);
}
}
public function GetLog()
{
return $this->aLog;
}
/**
* @param bool $bForce if true then will just check file existence
*
* @return bool possible return values :
* * always false if not in dev env
* * `symlink` function non existent : false
* * if flag is present true, false otherwise
*
* @uses utils::IsDevelopmentEnvironment()
* @uses \function_exists()
* @uses \file_exists()
* @uses USE_SYMBOLIC_LINKS_FILE_PATH
*
* @since 3.0.0
*/
public static function IsUseSymbolicLinksFlagPresent(bool $bForce = false): bool
{
if (!$bForce) {
if (!utils::IsDevelopmentEnvironment()) {
return false;
}
if (!function_exists('symlink')) {
return false;
}
}
return (file_exists(static::USE_SYMBOLIC_LINKS_FILE_PATH));
}
/**
* @param bool $bUseSymbolicLinks
*
* @since 3.0.0 method creation
* @uses USE_SYMBOLIC_LINKS_FILE_PATH
*/
public static function SetUseSymbolicLinksFlag(bool $bUseSymbolicLinks): void
{
$bHasUseSymlinksFile = static::IsUseSymbolicLinksFlagPresent(true);
if ($bUseSymbolicLinks) {
if ($bHasUseSymlinksFile) {
return;
}
touch(static::USE_SYMBOLIC_LINKS_FILE_PATH);
return;
}
if (!$bHasUseSymlinksFile) {
return;
}
unlink(static::USE_SYMBOLIC_LINKS_FILE_PATH);
}
/**
* Compile the data model into PHP files and data structures
*
* @param string $sTargetDir The target directory where to put the resulting files
* @param Page $oP For some output...
* @param bool $bUseSymbolicLinks
* @param bool $bSkipTempDir
* @throws Exception
*
* @return void
* @throws Exception
*/
public function Compile($sTargetDir, $oP = null, $bUseSymbolicLinks = false, $bSkipTempDir = false)
public function Compile($sTargetDir, $oP = null, $bUseSymbolicLinks = null, $bSkipTempDir = false)
{
if (is_null($bUseSymbolicLinks)) {
$bUseSymbolicLinks = false;
if (self::IsUseSymbolicLinksFlagPresent()) {
// We are only overriding the useSymLinks option if the consumer didn't specify anything
// The toolkit always send this parameter for example, but not the Designer Connector
$bUseSymbolicLinks = true;
}
}
$sFinalTargetDir = $sTargetDir;
$bIsAlreadyInMaintenanceMode = SetupUtils::IsInMaintenanceMode();
$sConfigFilePath = utils::GetConfigFilePath($this->sEnvironment);
if (is_file($sConfigFilePath))
{
if (is_file($sConfigFilePath)) {
$oConfig = new Config($sConfigFilePath);
}
else
{
} else {
$oConfig = null;
}
if (($this->sEnvironment == 'production') && !$bIsAlreadyInMaintenanceMode)
{
if (($this->sEnvironment == 'production') && !$bIsAlreadyInMaintenanceMode) {
SetupUtils::EnterMaintenanceMode($oConfig);
}
if ($bUseSymbolicLinks || $bSkipTempDir)
{
if ($bUseSymbolicLinks || $bSkipTempDir) {
// Skip the creation of a temporary dictionary, not compatible with symbolic links
$sTempTargetDir = $sFinalTargetDir;
SetupUtils::rrmdir($sFinalTargetDir);
SetupUtils::builddir($sFinalTargetDir); // Here is the directory
}
else
{
} else {
// Create a temporary directory
// Once the compilation is 100% successful, then move the results into the target directory
$sTempTargetDir = tempnam(SetupUtils::GetTmpDir(), 'itop-');
@@ -226,17 +292,14 @@ class MFCompiler
// The bullet proof implementation would be to compile in a separate directory as it has been done with the dictionaries... that's another story
$aModules = $this->oFactory->GetLoadedModules();
$sUserRightsModule = '';
foreach($aModules as $foo => $oModule)
{
if ($oModule->GetName() == 'itop-profiles-itil')
{
foreach ($aModules as $foo => $oModule) {
if ($oModule->GetName() == 'itop-profiles-itil') {
$sUserRightsModule = 'itop-profiles-itil';
break;
}
}
$oUserRightsNode = $this->oFactory->GetNodes('user_rights')->item(0);
if ($oUserRightsNode && ($sUserRightsModule == ''))
{
if ($oUserRightsNode && ($sUserRightsModule == '')) {
// Legacy algorithm (itop <= 2.0.3)
$sUserRightsModule = $oUserRightsNode->getAttribute('_created_in');
}
@@ -245,13 +308,12 @@ class MFCompiler
// List root classes
//
$this->aRootClasses = array();
foreach ($this->oFactory->ListRootClasses() as $oClass)
{
foreach ($this->oFactory->ListRootClasses() as $oClass) {
$this->Log("Root class (with child classes): ".$oClass->getAttribute('id'));
$this->aRootClasses[$oClass->getAttribute('id')] = $oClass;
}
$this->LoadSnippets();
$this->LoadSnippets();
// Compile, module by module
//
@@ -264,33 +326,25 @@ class MFCompiler
$this->WriteStaticOnlyHtaccess($sTempTargetDir);
$this->WriteStaticOnlyWebConfig($sTempTargetDir);
foreach($aModules as $foo => $oModule)
{
static::SetUseSymbolicLinksFlag($bUseSymbolicLinks);
foreach ($aModules as $foo => $oModule) {
$sModuleName = $oModule->GetName();
$sModuleVersion = $oModule->GetVersion();
$sModuleRootDir = $oModule->GetRootDir();
if ($sModuleRootDir != '')
{
if ($sModuleRootDir != '') {
$sModuleRootDir = realpath($sModuleRootDir);
$sRelativeDir = basename($sModuleRootDir);
if ($bUseSymbolicLinks)
{
if ($bUseSymbolicLinks) {
$sRealRelativeDir = substr($sModuleRootDir, $iStart);
}
else
{
} else {
$sRealRelativeDir = $sRelFinalTargetDir.'/'.$sRelativeDir;
}
// Push the other module files
SetupUtils::copydir($sModuleRootDir, $sTempTargetDir.'/'.$sRelativeDir, $bUseSymbolicLinks);
}
else
{
} else {
$sRelativeDir = $sModuleName;
$sRealRelativeDir = $sModuleName;
}