2024-08-30 21:17:18 +02:00
/*
* chroniclesextractor . cpp , part of VCMI engine
*
* Authors : listed in file AUTHORS in main folder
*
* License : GNU General Public License v2 .0 or later
* Full text of license available in license . txt file , in main folder
*
*/
# include "StdInc.h"
# include "chroniclesextractor.h"
2024-08-30 22:20:33 +02:00
# include "../../lib/VCMIDirs.h"
2024-08-31 00:44:20 +02:00
# include "../../lib/filesystem/CArchiveLoader.h"
2024-08-30 22:20:33 +02:00
# ifdef ENABLE_INNOEXTRACT
# include "cli/extract.hpp"
# include "setup/version.hpp"
# endif
ChroniclesExtractor : : ChroniclesExtractor ( QWidget * p , std : : function < void ( float percent ) > cb ) :
parent ( p ) , cb ( cb )
2024-08-30 21:17:18 +02:00
{
2024-08-30 22:20:33 +02:00
}
bool ChroniclesExtractor : : handleTempDir ( bool create )
{
if ( create )
2024-08-30 21:17:18 +02:00
{
2024-08-30 22:20:33 +02:00
tempDir = QDir ( pathToQString ( VCMIDirs : : get ( ) . userDataPath ( ) ) ) ;
if ( tempDir . cd ( " tmp " ) )
2024-08-30 21:17:18 +02:00
{
2024-08-30 22:20:33 +02:00
tempDir . removeRecursively ( ) ; // remove if already exists (e.g. previous run)
tempDir . cdUp ( ) ;
2024-08-30 21:17:18 +02:00
}
2024-08-30 22:20:33 +02:00
tempDir . mkdir ( " tmp " ) ;
if ( ! tempDir . cd ( " tmp " ) )
return false ; // should not happen - but avoid deleting wrong folder in any case
}
else
tempDir . removeRecursively ( ) ;
return true ;
}
int ChroniclesExtractor : : getChronicleNo ( QFile & file )
{
if ( ! file . open ( QIODevice : : ReadOnly ) )
{
QMessageBox : : critical ( parent , tr ( " File cannot opened " ) , file . errorString ( ) ) ;
return 0 ;
}
2024-08-30 21:17:18 +02:00
2024-08-30 22:20:33 +02:00
QByteArray magic { " MZ " } ;
QByteArray magicFile = file . read ( magic . length ( ) ) ;
if ( ! magicFile . startsWith ( magic ) )
{
QMessageBox : : critical ( parent , tr ( " Invalid file selected " ) , tr ( " You have to select an gog installer file! " ) ) ;
return 0 ;
}
QByteArray dataBegin = file . read ( 1'000'000 ) ;
int chronicle = 0 ;
for ( const auto & kv : chronicles ) {
if ( dataBegin . contains ( kv . second ) )
2024-08-30 21:17:18 +02:00
{
2024-08-30 22:20:33 +02:00
chronicle = kv . first ;
break ;
2024-08-30 21:17:18 +02:00
}
2024-08-30 22:20:33 +02:00
}
if ( ! chronicle )
{
QMessageBox : : critical ( parent , tr ( " Invalid file selected " ) , tr ( " You have to select an chronicle installer file! " ) ) ;
return 0 ;
}
return chronicle ;
}
2024-08-30 21:17:18 +02:00
2024-08-30 22:20:33 +02:00
bool ChroniclesExtractor : : extractGogInstaller ( QString file )
{
# ifndef ENABLE_INNOEXTRACT
QMessageBox : : critical ( parent , tr ( " Innoextract functionality missing " ) , " VCMI was compiled without innoextract support, which is needed to extract chroncles! " ) ;
return false ;
# else
: : extract_options o ;
o . extract = true ;
// standard settings
o . gog_galaxy = true ;
o . codepage = 0U ;
o . output_dir = tempDir . path ( ) . toStdString ( ) ;
o . extract_temp = true ;
o . extract_unknown = true ;
o . filenames . set_expand ( true ) ;
o . preserve_file_times = true ; // also correctly closes file -> without it: on Windows the files are not written completely
QString errorText = " " ;
try
{
process_file ( file . toStdString ( ) , o , [ this ] ( float progress ) {
float overallProgress = ( ( 1.0 / float ( fileCount ) ) * float ( extractionFile ) ) + ( progress / float ( fileCount ) ) ;
if ( cb )
cb ( overallProgress ) ;
} ) ;
2024-08-30 21:17:18 +02:00
}
2024-08-30 22:20:33 +02:00
catch ( const std : : ios_base : : failure & e )
{
errorText = tr ( " Stream error while extracting files! \n error reason: " ) ;
errorText + = e . what ( ) ;
}
catch ( const format_error & e )
{
errorText = e . what ( ) ;
}
catch ( const std : : runtime_error & e )
{
errorText = e . what ( ) ;
}
catch ( const setup : : version_error & )
{
errorText = tr ( " Not a supported Inno Setup installer! " ) ;
}
if ( ! errorText . isEmpty ( ) )
{
QMessageBox : : critical ( parent , tr ( " Extracting error! " ) , errorText ) ;
return false ;
}
return true ;
# endif
}
2024-08-31 00:44:20 +02:00
void ChroniclesExtractor : : createBaseMod ( )
{
QDir dir ( pathToQString ( VCMIDirs : : get ( ) . userDataPath ( ) / " Mods " ) ) ;
dir . mkdir ( " chronicles " ) ;
dir . cd ( " chronicles " ) ;
dir . mkdir ( " Mods " ) ;
QJsonObject mod
{
2024-08-31 18:46:45 +02:00
{ " modType " , " Expansion " } ,
2024-08-31 00:44:20 +02:00
{ " name " , " Heroes Chronicles " } ,
2024-09-01 00:41:16 +02:00
{ " description " , " Heroes Chronicles " } ,
2024-08-31 00:44:20 +02:00
{ " author " , " 3DO " } ,
{ " version " , " 1.0 " } ,
2024-09-01 00:41:16 +02:00
{ " contact " , " vcmi.eu " } ,
2024-08-31 00:44:20 +02:00
} ;
QFile jsonFile ( dir . filePath ( " mod.json " ) ) ;
jsonFile . open ( QFile : : WriteOnly ) ;
jsonFile . write ( QJsonDocument ( mod ) . toJson ( ) ) ;
}
void ChroniclesExtractor : : createChronicleMod ( int no )
{
2024-08-31 18:46:45 +02:00
QDir dir ( pathToQString ( VCMIDirs : : get ( ) . userDataPath ( ) / " Mods " / " chronicles " / " Mods " / ( " chronicles_ " + std : : to_string ( no ) ) ) ) ;
dir . removeRecursively ( ) ;
dir . mkpath ( " . " ) ;
2024-08-31 00:44:20 +02:00
QJsonObject mod
{
2024-08-31 18:46:45 +02:00
{ " modType " , " Expansion " } ,
2024-08-31 00:44:20 +02:00
{ " name " , " Heroes Chronicles - " + QString : : number ( no ) } ,
2024-09-01 00:41:16 +02:00
{ " description " , " Heroes Chronicles - " + QString : : number ( no ) } ,
2024-08-31 00:44:20 +02:00
{ " author " , " 3DO " } ,
{ " version " , " 1.0 " } ,
2024-09-01 00:41:16 +02:00
{ " contact " , " vcmi.eu " } ,
2024-08-31 00:44:20 +02:00
} ;
2024-08-31 02:52:34 +02:00
2024-08-31 00:44:20 +02:00
QFile jsonFile ( dir . filePath ( " mod.json " ) ) ;
jsonFile . open ( QFile : : WriteOnly ) ;
jsonFile . write ( QJsonDocument ( mod ) . toJson ( ) ) ;
2024-08-31 02:52:34 +02:00
dir . cd ( " content " ) ;
2024-08-31 18:46:45 +02:00
2024-08-31 00:44:20 +02:00
extractFiles ( no ) ;
}
void ChroniclesExtractor : : extractFiles ( int no )
{
QByteArray tmpChronicles = chronicles . at ( no ) ;
tmpChronicles . replace ( ' \0 ' , " " ) ;
QDir tmpDir = tempDir . filePath ( tempDir . entryList ( { " app " } , QDir : : Filter : : Dirs ) . front ( ) ) ;
tmpDir . setPath ( tmpDir . filePath ( tmpDir . entryList ( { QString ( tmpChronicles ) } , QDir : : Filter : : Dirs ) . front ( ) ) ) ;
tmpDir . setPath ( tmpDir . filePath ( tmpDir . entryList ( { " data " } , QDir : : Filter : : Dirs ) . front ( ) ) ) ;
2024-08-31 16:27:39 +02:00
auto basePath = VCMIDirs : : get ( ) . userDataPath ( ) / " Mods " / " chronicles " / " Mods " / ( " chronicles_ " + std : : to_string ( no ) ) / " content " ;
QDir outDirData ( pathToQString ( basePath / " Data " ) ) ;
QDir outDirSprites ( pathToQString ( basePath / " Sprites " ) ) ;
QDir outDirVideo ( pathToQString ( basePath / " Video " ) ) ;
QDir outDirSounds ( pathToQString ( basePath / " Sounds " ) ) ;
QDir outDirMaps ( pathToQString ( basePath / " Maps " ) ) ;
auto extract = [ ] ( QDir scrDir , QDir dest , QString file , std : : vector < std : : string > files = { } ) {
2024-08-31 15:25:45 +02:00
CArchiveLoader archive ( " " , scrDir . filePath ( scrDir . entryList ( { file } ) . front ( ) ) . toStdString ( ) , false ) ;
2024-08-31 02:52:34 +02:00
for ( auto & entry : archive . getEntries ( ) )
2024-08-31 15:25:45 +02:00
if ( files . empty ( ) )
archive . extractToFolder ( dest . absolutePath ( ) . toStdString ( ) , " " , entry . second , true ) ;
else
{
for ( auto & item : files )
if ( ! boost : : algorithm : : to_lower_copy ( entry . second . name ) . find ( boost : : algorithm : : to_lower_copy ( item ) ) )
archive . extractToFolder ( dest . absolutePath ( ) . toStdString ( ) , " " , entry . second , true ) ;
}
2024-08-31 02:52:34 +02:00
} ;
2024-08-31 15:25:45 +02:00
auto rename = [ no ] ( QDir dest ) {
2024-08-31 02:52:34 +02:00
dest . refresh ( ) ;
for ( auto & entry : dest . entryList ( ) )
2024-08-31 22:05:36 +02:00
{
2024-08-31 23:13:40 +02:00
if ( entry . toUpper ( ) . startsWith ( " HPS " ) | | entry . toUpper ( ) . startsWith ( " HPL " ) )
2024-08-31 22:05:36 +02:00
dest . rename ( entry , " Hc_ " + entry ) ;
2024-08-31 13:15:07 +02:00
if ( ! entry . startsWith ( " Hc " + QString : : number ( no ) + " _ " ) )
2024-08-31 02:52:34 +02:00
dest . rename ( entry , " Hc " + QString : : number ( no ) + " _ " + entry ) ;
2024-08-31 22:05:36 +02:00
}
2024-08-31 02:52:34 +02:00
} ;
2024-08-31 15:25:45 +02:00
extract ( tmpDir , outDirData , " xBitmap.lod " ) ;
extract ( tmpDir , outDirData , " xlBitmap.lod " ) ;
extract ( tmpDir , outDirSprites , " xSprite.lod " ) ;
extract ( tmpDir , outDirSprites , " xlSprite.lod " ) ;
extract ( tmpDir , outDirVideo , " xVideo.vid " ) ;
extract ( tmpDir , outDirSounds , " xSound.snd " ) ;
2024-08-31 02:52:34 +02:00
tmpDir . cdUp ( ) ;
if ( tmpDir . entryList ( { " maps " } , QDir : : Filter : : Dirs ) . size ( ) )
{
QDir tmpDirMaps = tmpDir . filePath ( tmpDir . entryList ( { " maps " } , QDir : : Filter : : Dirs ) . front ( ) ) ;
for ( auto & entry : tmpDirMaps . entryList ( ) )
QFile ( tmpDirMaps . filePath ( entry ) ) . copy ( outDirData . filePath ( entry ) ) ;
}
2024-08-31 15:25:45 +02:00
tmpDir . cdUp ( ) ;
QDir tmpDirData = tmpDir . filePath ( tmpDir . entryList ( { " data " } , QDir : : Filter : : Dirs ) . front ( ) ) ;
2024-09-01 00:43:45 +02:00
extract ( tmpDirData , outDirData , " bitmap.lod " , std : : vector < std : : string > { " HPS137 " , " HPS138 " , " HPS139 " , " HPS140 " , " HPS141 " , " HPS142 " , " HPL137 " , " HPL138 " , " HPL139 " , " HPL140 " , " HPL141 " , " HPL142 " } ) ;
2024-08-31 17:16:42 +02:00
extract ( tmpDirData , outDirData , " lbitmap.lod " , std : : vector < std : : string > { " INTRORIM " } ) ;
2024-08-31 15:25:45 +02:00
2024-08-31 02:52:34 +02:00
rename ( outDirData ) ;
rename ( outDirSprites ) ;
rename ( outDirVideo ) ;
rename ( outDirSounds ) ;
2024-08-31 12:14:51 +02:00
if ( ! outDirMaps . exists ( ) )
outDirMaps . mkpath ( " . " ) ;
QString campaignFileName = " Hc " + QString : : number ( no ) + " _Main.h3c " ;
QFile ( outDirData . filePath ( outDirData . entryList ( { campaignFileName } ) . front ( ) ) ) . copy ( outDirMaps . filePath ( campaignFileName ) ) ;
2024-08-31 00:44:20 +02:00
}
2024-08-30 22:20:33 +02:00
void ChroniclesExtractor : : installChronicles ( QStringList exe )
{
extractionFile = - 1 ;
fileCount = exe . size ( ) ;
for ( QString f : exe )
{
extractionFile + + ;
QFile file ( f ) ;
int chronicleNo = getChronicleNo ( file ) ;
if ( ! chronicleNo )
continue ;
if ( ! handleTempDir ( true ) )
continue ;
if ( ! extractGogInstaller ( f ) )
continue ;
2024-08-31 00:44:20 +02:00
createBaseMod ( ) ;
createChronicleMod ( chronicleNo ) ;
2024-08-30 22:20:33 +02:00
2024-08-31 00:44:20 +02:00
handleTempDir ( false ) ;
2024-08-30 21:17:18 +02:00
}
2024-08-31 16:27:39 +02:00
}