/**
* Extracts the requested file in the package archive to the temp folder
* and returns the path to the extracted file.
*
* @param string $filename
* @param string $tempPrefix
* @return string
*/
public function extractTar($filename, $tempPrefix = 'package_') {
// search the requested tar archive in our package archive.
// throw error message if not found.
if (($fileIndex = $this->tar->getIndexByFilename($filename)) === false) {
throw new SystemException("tar archive '".$filename."' not found in '".$this->archive."'.");
}
// requested tar archive was found
$fileInfo = $this->tar->getFileInfo($fileIndex);
$filename = FileUtil::getTemporaryFilename($tempPrefix, preg_replace('!^.*?(\.(?:tar\.gz|tgz|tar))$!i', '\\1', $fileInfo['filename']));
$this->tar->extract($fileIndex, $filename);
return $filename;
}
/**
* Imports a style.
*
* @param string $filename
* @param integer $packageID
* @param StyleEditor $style
* @return StyleEditor
*/
public static function import($filename, $packageID = 1, StyleEditor $style = null)
{
// open file
$tar = new Tar($filename);
// get style data
$data = self::readStyleData($tar);
$styleData = array('styleName' => $data['name'], 'variables' => $data['variables'], 'styleVersion' => $data['version'], 'styleDate' => $data['date'], 'copyright' => $data['copyright'], 'license' => $data['license'], 'authorName' => $data['authorName'], 'authorURL' => $data['authorURL']);
// create template group
if (!empty($data['templates'])) {
$templateGroupName = $originalTemplateGroupName = $data['name'];
$templateGroupFolderName = preg_replace('/[^a-z0-9_-]/i', '', $templateGroupName);
if (empty($templateGroupFolderName)) {
$templateGroupFolderName = 'generic' . mb_substr(StringUtil::getRandomID(), 0, 8);
}
$originalTemplateGroupFolderName = $templateGroupFolderName;
// get unique template group name
$i = 1;
while (true) {
$sql = "SELECT\tCOUNT(*) AS count\n\t\t\t\t\tFROM\twcf" . WCF_N . "_template_group\n\t\t\t\t\tWHERE\ttemplateGroupName = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array($templateGroupName));
$row = $statement->fetchArray();
if (!$row['count']) {
break;
}
$templateGroupName = $originalTemplateGroupName . '_' . $i;
$i++;
}
// get unique folder name
$i = 1;
while (true) {
$sql = "SELECT\tCOUNT(*) AS count\n\t\t\t\t\tFROM\twcf" . WCF_N . "_template_group\n\t\t\t\t\tWHERE\ttemplateGroupFolderName = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array(FileUtil::addTrailingSlash($templateGroupFolderName)));
$row = $statement->fetchArray();
if (!$row['count']) {
break;
}
$templateGroupFolderName = $originalTemplateGroupFolderName . '_' . $i;
$i++;
}
$templateGroupAction = new TemplateGroupAction(array(), 'create', array('data' => array('templateGroupName' => $templateGroupName, 'templateGroupFolderName' => FileUtil::addTrailingSlash($templateGroupFolderName))));
$returnValues = $templateGroupAction->executeAction();
$styleData['templateGroupID'] = $returnValues['returnValues']->templateGroupID;
}
// import images
if (!empty($data['images']) && $data['imagesPath'] != 'images/') {
// create images folder if necessary
$imagesLocation = self::getFileLocation($data['imagesPath']);
$styleData['imagePath'] = FileUtil::getRelativePath(WCF_DIR, $imagesLocation);
$index = $tar->getIndexByFilename($data['images']);
if ($index !== false) {
// extract images tar
$destination = FileUtil::getTemporaryFilename('images_');
$tar->extract($index, $destination);
// open images tar
$imagesTar = new Tar($destination);
$contentList = $imagesTar->getContentList();
foreach ($contentList as $key => $val) {
if ($val['type'] == 'file') {
$imagesTar->extract($key, $imagesLocation . basename($val['filename']));
FileUtil::makeWritable($imagesLocation . basename($val['filename']));
}
}
// delete tmp file
$imagesTar->close();
@unlink($destination);
}
}
// import templates
if (!empty($data['templates'])) {
$index = $tar->getIndexByFilename($data['templates']);
if ($index !== false) {
// extract templates tar
$destination = FileUtil::getTemporaryFilename('templates_');
$tar->extract($index, $destination);
// open templates tar and group templates by package
$templatesTar = new Tar($destination);
$contentList = $templatesTar->getContentList();
$packageToTemplates = array();
foreach ($contentList as $val) {
if ($val['type'] == 'file') {
$folders = explode('/', $val['filename']);
$packageName = array_shift($folders);
if (!isset($packageToTemplates[$packageName])) {
$packageToTemplates[$packageName] = array();
}
$packageToTemplates[$packageName][] = array('index' => $val['index'], 'filename' => implode('/', $folders));
}
}
// copy templates
foreach ($packageToTemplates as $package => $templates) {
// try to find package
$sql = "SELECT\t*\n\t\t\t\t\t\tFROM\twcf" . WCF_N . "_package\n\t\t\t\t\t\tWHERE\tpackage = ?\n\t\t\t\t\t\t\tAND isApplication = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array($package, 1));
while ($row = $statement->fetchArray()) {
// get template path
$templatesDir = FileUtil::addTrailingSlash(FileUtil::getRealPath(WCF_DIR . $row['packageDir']) . 'templates/' . $templateGroupFolderName);
// create template path
if (!file_exists($templatesDir)) {
@mkdir($templatesDir, 0777);
FileUtil::makeWritable($templatesDir);
}
// copy templates
foreach ($templates as $template) {
$templatesTar->extract($template['index'], $templatesDir . $template['filename']);
TemplateEditor::create(array('application' => Package::getAbbreviation($package), 'packageID' => $row['packageID'], 'templateName' => str_replace('.tpl', '', $template['filename']), 'templateGroupID' => $styleData['templateGroupID']));
}
}
}
// delete tmp file
$templatesTar->close();
@unlink($destination);
}
}
// save style
if ($style !== null) {
$style->update($styleData);
} else {
$styleData['packageID'] = $packageID;
$style = new StyleEditor(self::create($styleData));
}
// import preview image
if (!empty($data['image'])) {
$fileExtension = mb_substr($data['image'], mb_strrpos($data['image'], '.'));
$index = $tar->getIndexByFilename($data['image']);
if ($index !== false) {
$filename = WCF_DIR . 'images/stylePreview-' . $style->styleID . $fileExtension;
$tar->extract($index, $filename);
FileUtil::makeWritable($filename);
if (file_exists($filename)) {
$style->update(array('image' => 'stylePreview-' . $style->styleID . $fileExtension));
}
}
}
$tar->close();
// handle descriptions
if (!empty($data['description'])) {
self::saveLocalizedDescriptions($style, $data['description']);
LanguageFactory::getInstance()->deleteLanguageCache();
}
if ($data['default']) {
$style->setAsDefault();
}
return $style;
}
protected function importFiles($filename)
{
$tar = new Tar($filename);
$files = 'files.tar';
if ($tar->getIndexByFileName($files) === false) {
throw new SystemException("Unable to find required file '" . $files . "' in the import archive");
}
$tar->extract($files, CMS_DIR . 'files/files.tar');
$ftar = new Tar(CMS_DIR . 'files/files.tar');
$contentList = $ftar->getContentList();
foreach ($contentList as $key => $val) {
if ($val['type'] == 'file' && $val['filename'] != '/files.tar' && $val['filename'] != 'files.tar') {
$filename = preg_replace_callback('/([0-9]+)\\-/', function ($match) {
if (isset($match[1]) && isset($this->tmp['files'][$match[1]])) {
return $this->tmp['files'][$match[1]] . '-';
} else {
return $match[0];
}
}, $val['filename']);
$ftar->extract($key, CMS_DIR . 'files/' . $filename);
} else {
if (!file_exists(CMS_DIR . 'files/' . $val['filename'])) {
mkdir(CMS_DIR . 'files/' . $val['filename']);
}
}
}
$ftar->close();
@unlink(CMS_DIR . 'files/files.tar');
$tar->close();
FileCacheBuilder::getInstance()->reset();
}
/**
* Starts the extracting of the files.
*/
protected function install()
{
$this->createTargetDir();
// open source archive
$tar = new Tar($this->source);
// distinct directories and files
$directories = array();
$files = array();
foreach ($tar->getContentList() as $index => $file) {
if (empty($this->folder) || mb_strpos($file['filename'], $this->folder) === 0) {
if (!empty($this->folder)) {
$file['filename'] = str_replace($this->folder, '', $file['filename']);
}
// remove leading slash
$file['filename'] = FileUtil::removeLeadingSlash($file['filename']);
if ($file['type'] == 'folder') {
// remove trailing slash
$directories[] = FileUtil::removeTrailingSlash($file['filename']);
} else {
$files[$index] = $file['filename'];
}
}
}
$this->checkFiles($files);
// now create the directories
$errors = array();
foreach ($directories as $dir) {
try {
$this->createDir($dir);
} catch (SystemException $e) {
$errors[] = $e->getMessage();
}
}
// now untar all files
foreach ($files as $index => $file) {
try {
$this->createFile($file, $index, $tar);
} catch (SystemException $e) {
$errors[] = $e->getMessage();
}
}
if (!empty($errors)) {
throw new SystemException('error(s) during the installation of the files.', 0, implode("<br />", $errors));
}
$this->logFiles($files);
// close tar
$tar->close();
}
/**
* Gets the package name of the first application in WCFSetup.tar.gz.
*/
protected static function getPackageName()
{
// get package name
$tar = new Tar(SETUP_FILE);
foreach ($tar->getContentList() as $file) {
if ($file['type'] != 'folder' && mb_strpos($file['filename'], 'install/packages/') === 0) {
$packageFile = basename($file['filename']);
$packageName = preg_replace('!\\.(tar\\.gz|tgz|tar)$!', '', $packageFile);
if ($packageName != 'com.woltlab.wcf') {
try {
$archive = new PackageArchive(TMP_DIR . 'install/packages/' . $packageFile);
$archive->openArchive();
self::$setupPackageName = $archive->getLocalizedPackageInfo('packageName');
$archive->getTar()->close();
break;
} catch (SystemException $e) {
}
}
}
}
$tar->close();
// assign package name
WCF::getTPL()->assign(array('setupPackageName' => self::$setupPackageName));
}
/**
* Imports a style.
*
* @param string $filename
* @param integer $packageID
* @param StyleEditor $style
* @return StyleEditor
*/
public static function import($filename, $packageID = PACKAGE_ID, StyleEditor $style = null)
{
// open file
$tar = new Tar($filename);
// get style data
$data = self::readStyleData($tar);
// get image locations
$iconsLocation = FileUtil::addTrailingSlash($data['variables']['global.icons.location']);
$imagesLocation = $data['variables']['global.images.location'];
// create template group
$templateGroupID = 0;
if (!empty($data['templates'])) {
$templateGroupName = $data['name'];
$templateGroupFolderName = preg_replace('/[^a-z0-9_-]/i', '', $templateGroupName);
if (empty($templateGroupFolderName)) {
$templateGroupFolderName = 'generic' . StringUtil::substring(StringUtil::getRandomID(), 0, 8);
}
$originalTemplatePackFolderName = $templateGroupFolderName;
// get unique template pack name
$i = 1;
do {
$sql = "SELECT\tCOUNT(*) AS count\n\t\t\t\t\tFROM\twcf" . WCF_N . "_template_group\n\t\t\t\t\tWHERE\ttemplateGroupName = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array($templateGroupName));
$row = $statement->fetchArray();
if (!$row['count']) {
break;
}
$templateGroupName = $originalTemplatePackName . '_' . $i;
//TODO: undefined variable
$i++;
} while (true);
// get unique folder name
$i = 1;
do {
$sql = "SELECT\tCOUNT(*) AS count\n\t\t\t\t\tFROM\twcf" . WCF_N . "_template_group\n\t\t\t\t\tWHERE\ttemplateGroupFolderName = ?\n\t\t\t\t\t\tAND parentTemplatePackID = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array(FileUtil::addTrailingSlash($templateGroupFolderName), 0));
$row = $statement->fetchArray();
if (!$row['count']) {
break;
}
$templateGroupFolderName = $originalTemplatePackFolderName . '_' . $i;
$i++;
} while (true);
$templateGroup = TemplateGroupEditor::create(array('templateGroupName' => $templateGroupName, 'templateGroupFolderName' => FileUtil::addTrailingSlash($templateGroupFolderName)));
$templateGroupID = $templateGroup->templateGroupID;
}
// save style
$styleData = array('styleName' => $data['name'], 'variables' => $data['variables'], 'templateGroupID' => $templateGroupID, 'styleDescription' => $data['description'], 'styleVersion' => $data['version'], 'styleDate' => $data['date'], 'image' => ($data['image'] ? 'images/' : '') . $data['image'], 'copyright' => $data['copyright'], 'license' => $data['license'], 'authorName' => $data['authorName'], 'authorURL' => $data['authorURL']);
if ($style !== null) {
$style->update($styleData);
} else {
$styleData['packageID'] = $packageID;
$style = self::create($styleData);
}
// import preview image
if (!empty($data['image'])) {
$i = $tar->getIndexByFilename($data['image']);
if ($i !== false) {
$tar->extract($i, WCF_DIR . 'images/' . $data['image']);
@chmod(WCF_DIR . 'images/' . $data['image'], 0777);
}
}
// import images
if (!empty($data['images'])) {
// create images folder if necessary
if (!file_exists(WCF_DIR . $imagesLocation)) {
@mkdir(WCF_DIR . $data['variables']['global.images.location'], 0777);
@chmod(WCF_DIR . $data['variables']['global.images.location'], 0777);
}
$i = $tar->getIndexByFilename($data['images']);
if ($i !== false) {
// extract images tar
$destination = FileUtil::getTemporaryFilename('images_');
$tar->extract($i, $destination);
// open images tar
$imagesTar = new Tar($destination);
$contentList = $imagesTar->getContentList();
foreach ($contentList as $key => $val) {
if ($val['type'] == 'file') {
$imagesTar->extract($key, WCF_DIR . $imagesLocation . basename($val['filename']));
@chmod(WCF_DIR . $imagesLocation . basename($val['filename']), 0666);
}
}
// delete tmp file
$imagesTar->close();
@unlink($destination);
}
}
// import icons
if (!empty($data['icons']) && $iconsLocation != 'icon/') {
$i = $tar->getIndexByFilename($data['icons']);
if ($i !== false) {
// extract icons tar
$destination = FileUtil::getTemporaryFilename('icons_');
$tar->extract($i, $destination);
// open icons tar and group icons by package
$iconsTar = new Tar($destination);
$contentList = $iconsTar->getContentList();
$packageToIcons = array();
foreach ($contentList as $val) {
if ($val['type'] == 'file') {
$folders = explode('/', $val['filename']);
$packageName = array_shift($folders);
if (!isset($packageToIcons[$packageName])) {
$packageToIcons[$packageName] = array();
}
$packageToIcons[$packageName][] = array('index' => $val['index'], 'filename' => implode('/', $folders));
}
}
// copy icons
foreach ($packageToIcons as $package => $icons) {
// try to find package
$sql = "SELECT\t*\n\t\t\t\t\t\tFROM\twcf" . WCF_N . "_package\n\t\t\t\t\t\tWHERE\tpackage = ?\n\t\t\t\t\t\t\tAND isApplication = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array($package, 1));
while ($row = $statement->fetchArray()) {
// get icon path
$iconDir = FileUtil::getRealPath(WCF_DIR . $row['packageDir']) . $iconsLocation;
// create icon path
if (!file_exists($iconDir)) {
@mkdir($iconDir, 0777);
@chmod($iconDir, 0777);
}
// copy icons
foreach ($icons as $icon) {
$iconsTar->extract($icon['index'], $iconDir . $icon['filename']);
}
}
}
// delete tmp file
$iconsTar->close();
@unlink($destination);
}
}
// import templates
if (!empty($data['templates'])) {
$i = $tar->getIndexByFilename($data['templates']);
if ($i !== false) {
// extract templates tar
$destination = FileUtil::getTemporaryFilename('templates_');
$tar->extract($i, $destination);
// open templates tar and group templates by package
$templatesTar = new Tar($destination);
$contentList = $templatesTar->getContentList();
$packageToTemplates = array();
foreach ($contentList as $val) {
if ($val['type'] == 'file') {
$folders = explode('/', $val['filename']);
$packageName = array_shift($folders);
if (!isset($packageToTemplates[$packageName])) {
$packageToTemplates[$packageName] = array();
}
$packageToTemplates[$packageName][] = array('index' => $val['index'], 'filename' => implode('/', $folders));
}
}
// copy templates
foreach ($packageToTemplates as $package => $templates) {
// try to find package
$sql = "SELECT\t*\n\t\t\t\t\t\tFROM\twcf" . WCF_N . "_package\n\t\t\t\t\t\tWHERE\tpackage = ?\n\t\t\t\t\t\t\tAND isApplication = ?";
$statement = WCF::getDB()->prepareStatement($sql);
$statement->execute(array($package, 1));
while ($row = $statement->fetchArray()) {
// get icon path
$templatesDir = FileUtil::addTrailingSlash(FileUtil::getRealPath(WCF_DIR . $row['packageDir']) . 'templates/' . $templateGroupFolderName);
// create template path
if (!file_exists($templatesDir)) {
@mkdir($templatesDir, 0777);
@chmod($templatesDir, 0777);
}
// copy templates
foreach ($templates as $template) {
$templatesTar->extract($template['index'], $templatesDir . $template['filename']);
TemplateEditor::create(array('packageID' => $row['packageID'], 'templateName' => StringUtil::replace('.tpl', '', $template['filename']), 'templateGroupID' => $templateGroupID));
}
}
}
// delete tmp file
$templatesTar->close();
@unlink($destination);
}
}
$tar->close();
return $style;
}
/**
* Unzips compressed package archives and returns the temporary file name.
*
* @param string $archive filename
* @return string
*/
public static function unzipPackageArchive($archive) {
if (!FileUtil::isURL($archive)) {
$tar = new Tar($archive);
$tar->close();
if ($tar->isZipped()) {
$tmpName = FileUtil::getTemporaryFilename('package_');
if (FileUtil::uncompressFile($archive, $tmpName)) {
return $tmpName;
}
}
}
return $archive;
}
