Component-Builder-fork/admin/helpers/compiler.php

430 lines
15 KiB
PHP
Raw Normal View History

2016-01-30 20:28:43 +00:00
<?php
/*--------------------------------------------------------------------------------------------------------| www.vdm.io |------/
__ __ _ _____ _ _ __ __ _ _ _
\ \ / / | | | __ \ | | | | | \/ | | | | | | |
\ \ / /_ _ ___| |_ | | | | _____ _____| | ___ _ __ _ __ ___ ___ _ __ | |_ | \ / | ___| |_| |__ ___ __| |
\ \/ / _` / __| __| | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __| | |\/| |/ _ \ __| '_ \ / _ \ / _` |
\ / (_| \__ \ |_ | |__| | __/\ V / __/ | (_) | |_) | | | | | | __/ | | | |_ | | | | __/ |_| | | | (_) | (_| |
\/ \__,_|___/\__| |_____/ \___| \_/ \___|_|\___/| .__/|_| |_| |_|\___|_| |_|\__| |_| |_|\___|\__|_| |_|\___/ \__,_|
| |
|_|
/-------------------------------------------------------------------------------------------------------------------------------/
@version 2.2.0
2016-01-30 20:28:43 +00:00
@created 30th April, 2015
@package Component Builder
@subpackage compiler.php
@author Llewellyn van der Merwe <http://www.vdm.io>
@my wife Roline van der Merwe <http://www.vdm.io/>
@copyright Copyright (C) 2015. All Rights Reserved
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
Builds Complex Joomla Components
/-----------------------------------------------------------------------------------------------------------------------------*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
2016-02-29 11:05:37 +00:00
// Use the component builder autoloader
ComponentbuilderHelper::autoLoader();
2016-01-30 20:28:43 +00:00
/**
* Compiler class
*/
class Compiler extends Infusion
2016-01-30 20:28:43 +00:00
{
/*
* The Temp path
*
* @var string
*/
private $tempPath;
public $filepath = '';
2016-01-30 20:28:43 +00:00
// fixed pathes
protected $add2SalesServer = false;
protected $backupPath = false;
protected $gitPath = false;
2016-01-30 20:28:43 +00:00
/**
* Constructor
*/
public function __construct($config = array ())
{
// first we run the perent constructor
if (parent::__construct($config))
2016-01-30 20:28:43 +00:00
{
// set temp directory
$comConfig = JFactory::getConfig();
$this->tempPath = $comConfig->get('tmp_path');
// set some folder paths in relation to distribution
if ($config['addBackup'])
{
$this->backupPath = $this->params->get('backup_folder_path', $this->tempPath).'/'.$this->componentBackupName.'.zip';
$this->add2SalesServer = true;
}
if ($config['addGit'])
{
$this->gitPath = $this->params->get('git_folder_path', null);
}
// now update the files
if ($this->updateFiles())
2016-01-30 20:28:43 +00:00
{
// zip the component
if ($this->zipComponent())
2016-01-30 20:28:43 +00:00
{
// done
return true;
2016-01-30 20:28:43 +00:00
}
}
}
return false;
}
/**
* Set the line number in comments
*
* @param int $nr The line number
*
* @return void
*
*/
private function setLine($nr)
{
if ($this->loadLineNr)
{
return ' [Compiler '.$nr.']';
}
return '';
}
2016-01-30 20:28:43 +00:00
protected function updateFiles()
2016-01-30 20:28:43 +00:00
{
if (isset($this->newFiles['static']) && ComponentbuilderHelper::checkArray($this->newFiles['static']) && isset($this->newFiles['dynamic']) && ComponentbuilderHelper::checkArray($this->newFiles['dynamic']))
2016-01-30 20:28:43 +00:00
{
// get the bom file
$bom = JFile::read($this->bomPath);
// first we do the static files
foreach ($this->newFiles['static'] as $static)
2016-01-30 20:28:43 +00:00
{
if (JFile::exists($static['path']))
2016-01-30 20:28:43 +00:00
{
$this->fileContentStatic['###FILENAME###'] = $static['name'];
$php = '';
if (ComponentbuilderHelper::checkFileType($static['name'],'php'))
2016-01-30 20:28:43 +00:00
{
$php = "<?php\n";
2016-01-30 20:28:43 +00:00
}
$string = JFile::read($static['path']);
if (strpos($string,'###BOM###') !== false)
2016-01-30 20:28:43 +00:00
{
list($wast,$code) = explode('###BOM###',$string);
$answer = str_replace(array_keys($this->fileContentStatic),array_values($this->fileContentStatic),$php.$bom.$code);
// add to zip array
$this->writeFile($static['path'],$answer);
2016-01-30 20:28:43 +00:00
}
else
{
$answer = str_replace(array_keys($this->fileContentStatic),array_values($this->fileContentStatic),$string);
// add to zip array
$this->writeFile($static['path'],$answer);
2016-01-30 20:28:43 +00:00
}
$this->lineCount = $this->lineCount + substr_count($answer, PHP_EOL );
2016-01-30 20:28:43 +00:00
}
}
// now we do the dynamic files
foreach ($this->newFiles['dynamic'] as $view => $files)
{
if (isset($this->fileContentDynamic[$view]) && ComponentbuilderHelper::checkArray($this->fileContentDynamic[$view]))
2016-01-30 20:28:43 +00:00
{
foreach ($files as $file)
2016-01-30 20:28:43 +00:00
{
if ($file['view'] == $view)
2016-01-30 20:28:43 +00:00
{
if (JFile::exists($file['path']))
2016-01-30 20:28:43 +00:00
{
$this->fileContentStatic['###FILENAME###'] = $file['name'];
$php = '';
if (ComponentbuilderHelper::checkFileType($file['name'],'php'))
{
$php = "<?php\n";
}
$string = JFile::read($file['path']);
if (strpos($string,'###BOM###') !== false)
{
list($bin,$code) = explode('###BOM###',$string);
$answer = str_replace(array_keys($this->fileContentStatic),array_values($this->fileContentStatic),$php.$bom.$code);
$answer = str_replace(array_keys($this->fileContentDynamic[$view]),array_values($this->fileContentDynamic[$view]),$answer);
// add to zip array
$this->writeFile($file['path'],$answer);
}
else
{
$answer = str_replace(array_keys($this->fileContentStatic),array_values($this->fileContentStatic),$string);
$answer = str_replace(array_keys($this->fileContentDynamic[$view]),array_values($this->fileContentDynamic[$view]),$answer);
// add to zip array
$this->writeFile($file['path'],$answer);
}
$this->lineCount = $this->lineCount + substr_count($answer, PHP_EOL );
2016-01-30 20:28:43 +00:00
}
}
}
}
}
// do a final run to update the readme file
$two = 0;
foreach ($this->newFiles['static'] as $static)
{
if (('README.md' == $static['name'] || 'README.txt' == $static['name']) && $this->componentData->addreadme && JFile::exists($static['path']))
{
$this->buildReadMe($static['path']);
$two++;
}
if ($two == 2)
{
2016-01-30 20:28:43 +00:00
break;
}
}
// move the update server to host
if ($this->componentData->add_update_server && isset($this->updateServerFileName) && $this->add2SalesServer)
{
$xml_update_server_path = $this->componentPath.'/'.$this->updateServerFileName.'.xml';
// make sure we have the correct file
if (JFile::exists($xml_update_server_path) && isset($this->componentData->update_server_ftp))
2016-01-30 20:28:43 +00:00
{
// Get the basic encription.
$basickey = ComponentbuilderHelper::getCryptKey('basic');
// Get the encription object.
$basic = new FOFEncryptAes($basickey, 128);
if (!empty($this->componentData->update_server_ftp) && $basickey && !is_numeric($this->componentData->update_server_ftp) && $this->componentData->update_server_ftp === base64_encode(base64_decode($this->componentData->update_server_ftp, true)))
2016-01-30 20:28:43 +00:00
{
// basic decript data update_server_ftp.
$this->componentData->update_server_ftp = rtrim($basic->decryptString($this->componentData->update_server_ftp), "\0");
2016-01-30 20:28:43 +00:00
}
// now move the file
$this->moveFileToFtpServer($xml_update_server_path,$this->componentData->update_server_ftp);
2016-01-30 20:28:43 +00:00
}
}
return true;
2016-01-30 20:28:43 +00:00
}
return false;
}
private function buildReadMe($path)
{
// set readme data if not set already
if (!isset($this->fileContentStatic['###LINE_COUNT###']) || $this->fileContentStatic['###LINE_COUNT###'] != $this->lineCount)
{
$this->buildReadMeData();
}
// get the file
$string = JFile::read($path);
// update the file
$answer = str_replace(array_keys($this->fileContentStatic),array_values($this->fileContentStatic),$string);
// add to zip array
$this->writeFile($path,$answer);
}
private function buildReadMeData()
2016-01-30 20:28:43 +00:00
{
// setup the unrealistic numbers
$folders = $this->folderCount * 5;
$files = $this->fileCount * 5;
$lines = $this->lineCount * 10;
$seconds = $folders + $files + $lines;
$totalHours = round($seconds / 3600);
$totalDays = round($totalHours / 8);
// setup the more realistic numbers
$debugging = $seconds / 4;
$planning = $seconds / 7;
$mapping = $seconds / 10;
$office = $seconds / 6;
$seconds = $folders + $files + $lines + $debugging + $planning + $mapping + $office;
$actualTotalHours = round($seconds / 3600);
$actualTotalDays = round($actualTotalHours / 8);
$debuggingHours = round($debugging / 3600);
$planningHours = round($planning / 3600);
$mappingHours = round($mapping / 3600);
$officeHours = round($office / 3600);
// the actual time spent
$actualHoursSpent = $actualTotalHours - $totalHours;
$actualDaysSpent = $actualTotalDays - $totalDays;
// calculate the projects actual time frame of completion
$projectWeekTime = round($actualTotalDays / 5,1);
$projectMonthTime = round($actualTotalDays / 24,1);
// set some defaults
$this->fileContentStatic['###LINE_COUNT###'] = $this->lineCount;
$this->fileContentStatic['###FILE_COUNT###'] = $this->fileCount;
$this->fileContentStatic['###FOLDER_COUNT###'] = $this->folderCount;
$this->fileContentStatic['###folders###'] = $folders;
$this->fileContentStatic['###files###'] = $files;
$this->fileContentStatic['###lines###'] = $lines;
$this->fileContentStatic['###seconds###'] = $seconds;
$this->fileContentStatic['###totalHours###'] = $totalHours;
$this->fileContentStatic['###totalDays###'] = $totalDays;
$this->fileContentStatic['###debugging###'] = $debugging;
$this->fileContentStatic['###planning###'] = $planning;
$this->fileContentStatic['###mapping###'] = $mapping;
$this->fileContentStatic['###office###'] = $office;
$this->fileContentStatic['###actualTotalHours###'] = $actualTotalHours;
$this->fileContentStatic['###actualTotalDays###'] = $actualTotalDays;
$this->fileContentStatic['###debuggingHours###'] = $debuggingHours;
$this->fileContentStatic['###planningHours###'] = $planningHours;
$this->fileContentStatic['###mappingHours###'] = $mappingHours;
$this->fileContentStatic['###officeHours###'] = $officeHours;
$this->fileContentStatic['###actualHoursSpent###'] = $actualHoursSpent;
$this->fileContentStatic['###actualDaysSpent###'] = $actualDaysSpent;
$this->fileContentStatic['###projectWeekTime###'] = $projectWeekTime;
$this->fileContentStatic['###projectMonthTime###'] = $projectMonthTime;
2016-01-30 20:28:43 +00:00
}
private function zipComponent()
2016-01-30 20:28:43 +00:00
{
// before we zip the component we first need to move it to the git folder if set
if (ComponentbuilderHelper::checkString($this->gitPath))
{
// set the git path
$this->gitPath = $this->gitPath.'/com_'.$this->componentData->sales_name.'__joomla_'.$this->joomlaVersion;
// remove old data
$this->removeFolder($this->gitPath,true);
// set the new data
JFolder::copy($this->componentPath, $this->gitPath, '', true);
}
// the name of the zip file to create
$this->filepath = $this->tempPath.'/'.$this->componentFolderName.'.zip';
// store the current joomla working directory
$joomla = getcwd();
2016-01-30 20:28:43 +00:00
// we are changing the working directory to the componet temp folder
chdir($this->componentPath);
2016-01-30 20:28:43 +00:00
// the full file path of the zip file
$this->filepath = JPath::clean($this->filepath);
2016-01-30 20:28:43 +00:00
// delete an existing zip file (or use an exclusion parameter in JFolder::files()
JFile::delete($this->filepath);
2016-01-30 20:28:43 +00:00
// get a list of files in the current directory tree
$files = JFolder::files('.', '', true, true);
$zipArray = array();
// setup the zip array
foreach ($files as $file)
{
$tmp = array();
$tmp['name'] = str_replace('./', '', $file);
$tmp['data'] = JFile::read($file);
$tmp['time'] = filemtime($file);
$zipArray[] = $tmp;
}
2016-01-30 20:28:43 +00:00
// change back to joomla working directory
chdir($joomla);
2016-01-30 20:28:43 +00:00
// get the zip adapter
$zip = JArchive::getAdapter('zip');
2016-01-30 20:28:43 +00:00
//create the zip file
if ($zip->create($this->filepath, $zipArray))
2016-01-30 20:28:43 +00:00
{
// now move to backup if zip was made and backup is requered
if ($this->backupPath)
2016-01-30 20:28:43 +00:00
{
JFile::copy($this->filepath, $this->backupPath);
2016-01-30 20:28:43 +00:00
}
// move to sales server host
if ($this->componentData->add_sales_server)
2016-01-30 20:28:43 +00:00
{
// make sure we have the correct file
if (isset($this->componentData->sales_server_ftp))
2016-01-30 20:28:43 +00:00
{
// Get the basic encription.
$basickey = ComponentbuilderHelper::getCryptKey('basic');
// Get the encription object.
$basic = new FOFEncryptAes($basickey, 128);
if (!empty($this->componentData->sales_server_ftp) && $basickey && !is_numeric($this->componentData->sales_server_ftp) && $this->componentData->sales_server_ftp === base64_encode(base64_decode($this->componentData->sales_server_ftp, true)))
2016-01-30 20:28:43 +00:00
{
// basic decript data update_server_ftp.
$this->componentData->sales_server_ftp = rtrim($basic->decryptString($this->componentData->sales_server_ftp), "\0");
2016-01-30 20:28:43 +00:00
}
// now move the file
$this->moveFileToFtpServer($this->filepath, $this->componentData->sales_server_ftp, $this->componentSalesName.'.zip',false);
2016-01-30 20:28:43 +00:00
}
}
// remove the component folder since we are done
if ($this->removeFolder($this->componentPath))
2016-01-30 20:28:43 +00:00
{
return true;
2016-01-30 20:28:43 +00:00
}
}
return false;
}
private function moveFileToFtpServer($localPath, $clientInput, $remote = null, $removeLocal = true)
{
// get the ftp opbject
$ftp = $this->getFTP($clientInput);
// chack if we are conected
if ($ftp instanceof JClientFtp && $ftp->isConnected())
2016-01-30 20:28:43 +00:00
{
// move the file
if ($ftp->store($localPath,$remote))
2016-01-30 20:28:43 +00:00
{
// if moved then remove the file from repository
if ($removeLocal)
2016-01-30 20:28:43 +00:00
{
JFile::delete($localPath);
2016-01-30 20:28:43 +00:00
}
}
// at the end close the conection
$ftp->quit();
2016-01-30 20:28:43 +00:00
}
}
private function getFTP($clientInput)
2016-01-30 20:28:43 +00:00
{
$signature = md5($clientInput);
if (isset($this->FTP[$signature]) && $this->FTP[$signature] instanceof JClientFtp)
2016-01-30 20:28:43 +00:00
{
return $this->FTP[$signature];
2016-01-30 20:28:43 +00:00
}
else
2016-01-30 20:28:43 +00:00
{
// make sure we have a string and it is not default or empty
if (ComponentbuilderHelper::checkString($clientInput))
2016-01-30 20:28:43 +00:00
{
// turn into vars
parse_str($clientInput);
// set options
if (isset($options) && ComponentbuilderHelper::checkArray($options))
2016-01-30 20:28:43 +00:00
{
foreach ($options as $option => $value)
2016-01-30 20:28:43 +00:00
{
if ('timeout' == $option)
2016-01-30 20:28:43 +00:00
{
$options[$option] = (int) $value;
2016-01-30 20:28:43 +00:00
}
if ('type' == $option)
2016-01-30 20:28:43 +00:00
{
$options[$option] = (string) $value;
2016-01-30 20:28:43 +00:00
}
}
}
else
{
$options = array();
}
// get ftp object
if (isset($host) && $host != 'HOSTNAME' && isset($port) && $port != 'PORT_INT' && isset($username) && $username != 'user@name.com' && isset($password) && $password != 'password')
{
// load for reuse
$this->FTP[$signature] = JClientFtp::getInstance($host, $port, $options, $username, $password);
return $this->FTP[$signature];
}
2016-01-30 20:28:43 +00:00
}
}
return false;
}
}