[apt.git] / cmdline / apt-extracttemplates.cc

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $Id: apt-extracttemplates.cc,v 1.6 2001/03/03 23:02:39 tausq Exp $
/* ######################################################################
   
   APT Extract Templates - Program to extract debconf config and template
                           files

   This is a simple program to extract config and template information 
   from Debian packages. It can be used to speed up the preconfiguration
   process for debconf-enabled packages
   
   ##################################################################### */
									/*}}}*/
// Include Files							/*{{{*/
#include <apt-pkg/init.h>
#include <apt-pkg/cmndline.h>
#include <apt-pkg/pkgcache.h>
#include <apt-pkg/configuration.h>
#include <apt-pkg/progress.h>
#include <apt-pkg/sourcelist.h>
#include <apt-pkg/pkgcachegen.h>
#include <apt-pkg/version.h>
#include <apt-pkg/tagfile.h>
#include <apt-pkg/extracttar.h>
#include <apt-pkg/arfile.h>
#include <apt-pkg/deblistparser.h>
#include <apt-pkg/error.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/fileutl.h>
	
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <fstream>

#include <config.h>
#include <apti18n.h>
#include "apt-extracttemplates.h"
									/*}}}*/

#define TMPDIR		"/tmp"

pkgCache *DebFile::Cache = 0;

// DebFile::DebFile - Construct the DebFile object			/*{{{*/
// ---------------------------------------------------------------------
/* */
DebFile::DebFile(const char *debfile)
	: File(debfile, FileFd::ReadOnly), Control(0), DepOp(0), 
          PreDepOp(0), Config(0), Template(0), Which(None)
{
}
									/*}}}*/
// DebFile::~DebFile - Destruct the DebFile object			/*{{{*/
// ---------------------------------------------------------------------
/* */
DebFile::~DebFile()
{
	delete [] Control;
	delete [] Config;
	delete [] Template;
}
									/*}}}*/
// DebFile::GetInstalledVer - Find out the installed version of a pkg	/*{{{*/
// ---------------------------------------------------------------------
/* */
string DebFile::GetInstalledVer(const string &package)
{
	pkgCache::PkgIterator Pkg = Cache->FindPkg(package);
	if (Pkg.end() == false) 
	{
		pkgCache::VerIterator V = Pkg.CurrentVer();
		if (V.end() == false)
		{
			return V.VerStr();
		}
	}

	return string();
}
									/*}}}*/
// DebFile::Go - Start extracting a debian package			/*{{{*/
// ---------------------------------------------------------------------
/* */
bool DebFile::Go()
{
	ARArchive AR(File);
	if (_error->PendingError() == true)
		return false;
		
	const ARArchive::Member *Member = AR.FindMember("control.tar.gz");
	if (Member == 0)
		return _error->Error(_("%s not a valid DEB package."),File.Name().c_str());
	
	if (File.Seek(Member->Start) == false)
		return false;
	ExtractTar Tar(File, Member->Size);
	return Tar.Go(*this);
}
									/*}}}*/
// DebFile::DoItem examine element in package and mark			/*{{{*/
// ---------------------------------------------------------------------
/* */
bool DebFile::DoItem(Item &I, int &Fd)
{
	if (strcmp(I.Name, "control") == 0)
	{
		delete [] Control;
		Control = new char[I.Size+1];
		Control[I.Size] = 0;
		Which = IsControl;
		ControlLen = I.Size;
		// make it call the Process method below. this is so evil
		Fd = -2;
	}
	else if (strcmp(I.Name, "config") == 0)
	{
		delete [] Config;
		Config = new char[I.Size+1];
		Config[I.Size] = 0;
		Which = IsConfig;
		Fd = -2; 
	} 
	else if (strcmp(I.Name, "templates") == 0)
	{
		delete [] Template;
		Template = new char[I.Size+1];
		Template[I.Size] = 0;
		Which = IsTemplate;
		Fd = -2;
	} 
	else 
	{
		// Ignore it
		Fd = -1;
	}
	return true;
}
									/*}}}*/
// DebFile::Process examine element in package and copy			/*{{{*/
// ---------------------------------------------------------------------
/* */
bool DebFile::Process(Item &I, const unsigned char *data, 
		unsigned long size, unsigned long pos)
{
	switch (Which)
	{
	case IsControl:
		memcpy(Control + pos, data, size);
		break;
	case IsConfig:
		memcpy(Config + pos, data, size);
		break;
	case IsTemplate:
		memcpy(Template + pos, data, size);
		break;
	default: /* throw it away */ ;
	}
	return true;
}
									/*}}}*/
// DebFile::ParseInfo - Parse control file for dependency info		/*{{{*/
// ---------------------------------------------------------------------
/* */
bool DebFile::ParseInfo()
{
	if (Control == NULL) return false;
	
	pkgTagSection Section;
	Section.Scan(Control, ControlLen);

	Package = Section.FindS("Package");
	Version = GetInstalledVer(Package);

	const char *Start, *Stop;
	if (Section.Find("Depends", Start, Stop) == true)
	{
		while (1)
		{
			string P, V;
			unsigned int Op;
			Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
			if (Start == 0) return false;
			if (P == "debconf")
			{
				DepVer = V;
				DepOp = Op;
				break;
			}
			if (Start == Stop) break;
		}
	}
	
	if (Section.Find("Pre-Depends", Start, Stop) == true)
	{
		while (1)
		{
			string P, V;
			unsigned int Op;
			Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
			if (Start == 0) return false;
			if (P == "debconf")
			{
				PreDepVer = V;
				PreDepOp = Op;
				break;
			}
			if (Start == Stop) break;
		}
	}
	
	return true;
}
									/*}}}*/
// ShowHelp - show a short help text					/*{{{*/
// ---------------------------------------------------------------------
/* */
int ShowHelp(void)
{
   	ioprintf(cout,_("%s %s for %s %s compiled on %s %s\n"),PACKAGE,VERSION,
	    COMMON_OS,COMMON_CPU,__DATE__,__TIME__);

	if (_config->FindB("version") == true) 
		return 0;

	cout << 
		_("Usage: apt-extracttemplates file1 [file2 ...]\n"
		"\n"
		"apt-extracttemplates is a tool to extract config and template info\n"
		"from debian packages\n"
		"\n"
		"Options:\n"
	        "  -h   This help text\n"
		"  -t   Set the temp dir\n"
		"  -c=? Read this configuration file\n"
		"  -o=? Set an arbitary configuration option, eg -o dir::cache=/tmp\n");
	return 0;
}
									/*}}}*/
// WriteFile - write the contents of the passed string to a file	/*{{{*/
// ---------------------------------------------------------------------
/* */
string WriteFile(const char *prefix, const char *data)
{
	char fn[512];
	static int i;
	snprintf(fn, sizeof(fn), "%s/%s.%u%d", _config->Find("APT::ExtractTemplates::TempDir", TMPDIR).c_str(), prefix, getpid(), i++);
	FileFd f;
	if (data == NULL)
		data = "";

	if (!f.Open(fn, FileFd::WriteTemp, 0600))
	{
		_error->Errno("ofstream::ofstream",_("Unable to write to %s"),fn);
		return string();
	}

	f.Write(data, strlen(data));
	f.Close();
	return fn;
}
									/*}}}*/
// WriteConfig - write out the config data from a debian package file	/*{{{*/
// ---------------------------------------------------------------------
/* */
void WriteConfig(const DebFile &file)
{
	string templatefile = WriteFile("template", file.Template);
	string configscript = WriteFile("config", file.Config);

	if (templatefile.empty() == true || configscript.empty() == true)
		return;
	cout << file.Package << " " << file.Version << " " 
	     << templatefile << " " << configscript << endl;
}
									/*}}}*/
// InitCache - initialize the package cache				/*{{{*/
// ---------------------------------------------------------------------
/* */
bool Go(CommandLine &CmdL)
{	
	// Initialize the apt cache
	MMap *Map = 0;
	pkgSourceList List;
	List.ReadMainList();
	OpProgress Prog;
	pkgMakeStatusCache(List,Prog,&Map,true);
	DebFile::Cache = new pkgCache(Map);
	if (_error->PendingError() == true)
		return false;

	// Find out what version of debconf is currently installed
	string debconfver = DebFile::GetInstalledVer("debconf");
	if (debconfver.empty() == true)
		return _error->Error( _("Cannot get debconf version. Is debconf installed?"));

	// Process each package passsed in
	for (unsigned int I = 0; I != CmdL.FileSize(); I++)
	{
		// Will pick up the errors later..
		DebFile file(CmdL.FileList[I]);
		if (file.Go() == false)
			continue; 
		
		// Does the package have templates?
		if (file.Template != 0 && file.ParseInfo() == true)
		{
			// Check to make sure debconf dependencies are
			// satisfied
			if (file.DepVer != "" &&
			    DebFile::Cache->VS->CheckDep(file.DepVer.c_str(),
			                file.DepOp, debconfver.c_str()) == false)
				continue;
			if (file.PreDepVer != "" &&
			    DebFile::Cache->VS->CheckDep(file.PreDepVer.c_str(), 
			                file.PreDepOp, debconfver.c_str()) == false) 
				continue;

			WriteConfig(file);
		}
	}
	

	delete Map;
	delete DebFile::Cache;
	
	return !_error->PendingError();
}
									/*}}}*/

int main(int argc, const char **argv)
{
	CommandLine::Args Args[] = {
		{'h',"help","help",0},
		{'v',"version","version",0},
		{'t',"tempdir","APT::ExtractTemplates::TempDir",CommandLine::HasArg},
		{'c',"config-file",0,CommandLine::ConfigFile},
		{'o',"option",0,CommandLine::ArbItem},
		{0,0,0,0}};
	
	// Parse the command line and initialize the package library
	CommandLine CmdL(Args,_config);
	if (pkgInitConfig(*_config) == false ||
	    CmdL.Parse(argc,argv) == false ||
	    pkgInitSystem(*_config,_system) == false)
	{
		_error->DumpErrors();
		return 100;
	}
	
	// See if the help should be shown
	if (_config->FindB("help") == true ||
	    CmdL.FileSize() == 0)
		return ShowHelp();
	
	Go(CmdL);

	// Print any errors or warnings found during operation
	if (_error->empty() == false)
	{
		// This goes to stderr..
		bool Errors = _error->PendingError();
		_error->DumpErrors();
		return Errors == true?100:0;
	}
	
	return 0;
}
Commit	Line	Data
234edfd0 AL	1	// -- mode: cpp; mode: fold --
234edfd0 AL	2	// Description /{{{/
7512b6da	3	// $Id: apt-extracttemplates.cc,v 1.6 2001/03/03 23:02:39 tausq Exp $
234edfd0 AL	4	/* ######################################################################
	5
	6	APT Extract Templates - Program to extract debconf config and template
	7	files
3fc8f685	8
234edfd0 AL	9	This is a simple program to extract config and template information
	10	from Debian packages. It can be used to speed up the preconfiguration
	11	process for debconf-enabled packages
	12
	13	##################################################################### */
	14	/}}}/
	15	// Include Files /{{{/
3fc8f685	16	#include <apt-pkg/init.h>
5cbf1b49	17	#include <apt-pkg/cmndline.h>
3fc8f685 AL	18	#include <apt-pkg/pkgcache.h>
	19	#include <apt-pkg/configuration.h>
	20	#include <apt-pkg/progress.h>
	21	#include <apt-pkg/sourcelist.h>
	22	#include <apt-pkg/pkgcachegen.h>
	23	#include <apt-pkg/version.h>
234edfd0 AL	24	#include <apt-pkg/tagfile.h>
	25	#include <apt-pkg/extracttar.h>
	26	#include <apt-pkg/arfile.h>
	27	#include <apt-pkg/deblistparser.h>
	28	#include <apt-pkg/error.h>
	29	#include <apt-pkg/strutl.h>
4decd43c	30	#include <apt-pkg/fileutl.h>
3fc8f685	31
234edfd0 AL	32	#include <stdio.h>
	33	#include <string.h>
	34	#include <stdlib.h>
	35	#include <unistd.h>
7e726255	36	#include <fstream>
234edfd0 AL	37
	38	#include <config.h>
	39	#include <apti18n.h>
	40	#include "apt-extracttemplates.h"
7e726255	41	/}}}/
234edfd0	42
4decd43c	43	#define TMPDIR "/tmp"
3fc8f685	44
234edfd0 AL	45	pkgCache *DebFile::Cache = 0;
	46
	47	// DebFile::DebFile - Construct the DebFile object /{{{/
	48	// ---------------------------------------------------------------------
	49	/* */
	50	DebFile::DebFile(const char *debfile)
7e726255 AL	51	: File(debfile, FileFd::ReadOnly), Control(0), DepOp(0),
7e726255 AL	52	PreDepOp(0), Config(0), Template(0), Which(None)
3fc8f685	53	{
3fc8f685	54	}
234edfd0 AL	55	/}}}/
	56	// DebFile::~DebFile - Destruct the DebFile object /{{{/
	57	// ---------------------------------------------------------------------
	58	/* */
	59	DebFile::~DebFile()
	60	{
	61	delete [] Control;
	62	delete [] Config;
	63	delete [] Template;
	64	}
	65	/}}}/
	66	// DebFile::GetInstalledVer - Find out the installed version of a pkg /{{{/
	67	// ---------------------------------------------------------------------
	68	/* */
7e726255	69	string DebFile::GetInstalledVer(const string &package)
234edfd0	70	{
234edfd0 AL	71	pkgCache::PkgIterator Pkg = Cache->FindPkg(package);
	72	if (Pkg.end() == false)
	73	{
	74	pkgCache::VerIterator V = Pkg.CurrentVer();
7e726255	75	if (V.end() == false)
234edfd0	76	{
7e726255	77	return V.VerStr();
234edfd0 AL	78	}
234edfd0 AL	79	}
3fc8f685	80
7e726255	81	return string();
234edfd0 AL	82	}
	83	/}}}/
	84	// DebFile::Go - Start extracting a debian package /{{{/
	85	// ---------------------------------------------------------------------
	86	/* */
	87	bool DebFile::Go()
	88	{
	89	ARArchive AR(File);
7e726255 AL	90	if (_error->PendingError() == true)
	91	return false;
	92
234edfd0 AL	93	const ARArchive::Member *Member = AR.FindMember("control.tar.gz");
234edfd0 AL	94	if (Member == 0)
7e726255	95	return _error->Error(_("%s not a valid DEB package."),File.Name().c_str());
234edfd0 AL	96
234edfd0 AL	97	if (File.Seek(Member->Start) == false)
234edfd0	98	return false;
234edfd0 AL	99	ExtractTar Tar(File, Member->Size);
	100	return Tar.Go(*this);
	101	}
	102	/}}}/
	103	// DebFile::DoItem examine element in package and mark /{{{/
	104	// ---------------------------------------------------------------------
	105	/* */
	106	bool DebFile::DoItem(Item &I, int &Fd)
	107	{
	108	if (strcmp(I.Name, "control") == 0)
	109	{
	110	delete [] Control;
	111	Control = new char[I.Size+1];
	112	Control[I.Size] = 0;
	113	Which = IsControl;
	114	ControlLen = I.Size;
	115	// make it call the Process method below. this is so evil
	116	Fd = -2;
	117	}
	118	else if (strcmp(I.Name, "config") == 0)
	119	{
	120	delete [] Config;
	121	Config = new char[I.Size+1];
	122	Config[I.Size] = 0;
	123	Which = IsConfig;
	124	Fd = -2;
	125	}
	126	else if (strcmp(I.Name, "templates") == 0)
	127	{
	128	delete [] Template;
	129	Template = new char[I.Size+1];
	130	Template[I.Size] = 0;
	131	Which = IsTemplate;
	132	Fd = -2;
	133	}
	134	else
	135	{
7e726255	136	// Ignore it
234edfd0 AL	137	Fd = -1;
	138	}
	139	return true;
	140	}
	141	/}}}/
	142	// DebFile::Process examine element in package and copy /{{{/
	143	// ---------------------------------------------------------------------
	144	/* */
	145	bool DebFile::Process(Item &I, const unsigned char *data,
	146	unsigned long size, unsigned long pos)
	147	{
	148	switch (Which)
	149	{
	150	case IsControl:
	151	memcpy(Control + pos, data, size);
	152	break;
	153	case IsConfig:
	154	memcpy(Config + pos, data, size);
	155	break;
	156	case IsTemplate:
	157	memcpy(Template + pos, data, size);
	158	break;
	159	default: /* throw it away */ ;
	160	}
	161	return true;
	162	}
	163	/}}}/
	164	// DebFile::ParseInfo - Parse control file for dependency info /{{{/
	165	// ---------------------------------------------------------------------
	166	/* */
	167	bool DebFile::ParseInfo()
	168	{
	169	if (Control == NULL) return false;
7e726255	170
234edfd0 AL	171	pkgTagSection Section;
	172	Section.Scan(Control, ControlLen);
	173
	174	Package = Section.FindS("Package");
	175	Version = GetInstalledVer(Package);
	176
	177	const char Start, Stop;
	178	if (Section.Find("Depends", Start, Stop) == true)
	179	{
	180	while (1)
	181	{
	182	string P, V;
	183	unsigned int Op;
	184	Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
	185	if (Start == 0) return false;
	186	if (P == "debconf")
	187	{
	188	DepVer = V;
	189	DepOp = Op;
	190	break;
	191	}
	192	if (Start == Stop) break;
	193	}
	194	}
	195
	196	if (Section.Find("Pre-Depends", Start, Stop) == true)
	197	{
	198	while (1)
	199	{
	200	string P, V;
	201	unsigned int Op;
	202	Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
	203	if (Start == 0) return false;
	204	if (P == "debconf")
	205	{
	206	PreDepVer = V;
	207	PreDepOp = Op;
	208	break;
	209	}
	210	if (Start == Stop) break;
	211	}
	212	}
	213
	214	return true;
	215	}
	216	/}}}/
	217	// ShowHelp - show a short help text /{{{/
	218	// ---------------------------------------------------------------------
	219	/* */
7e726255	220	int ShowHelp(void)
234edfd0 AL	221	{
	222	ioprintf(cout,_("%s %s for %s %s compiled on %s %s\n"),PACKAGE,VERSION,
	223	COMMON_OS,COMMON_CPU,__DATE__,__TIME__);
	224
7e726255 AL	225	if (_config->FindB("version") == true)
7e726255 AL	226	return 0;
5cbf1b49	227
7e726255	228	cout <<
234edfd0 AL	229	_("Usage: apt-extracttemplates file1 [file2 ...]\n"
	230	"\n"
	231	"apt-extracttemplates is a tool to extract config and template info\n"
7e726255 AL	232	"from debian packages\n"
	233	"\n"
	234	"Options:\n"
	235	" -h This help text\n"
	236	" -t Set the temp dir\n"
	237	" -c=? Read this configuration file\n"
	238	" -o=? Set an arbitary configuration option, eg -o dir::cache=/tmp\n");
	239	return 0;
234edfd0 AL	240	}
	241	/}}}/
	242	// WriteFile - write the contents of the passed string to a file /{{{/
	243	// ---------------------------------------------------------------------
	244	/* */
7e726255	245	string WriteFile(const char prefix, const char data)
3fc8f685 AL	246	{
	247	char fn[512];
	248	static int i;
7512b6da	249	snprintf(fn, sizeof(fn), "%s/%s.%u%d", _config->Find("APT::ExtractTemplates::TempDir", TMPDIR).c_str(), prefix, getpid(), i++);
4decd43c AL	250	FileFd f;
	251	if (data == NULL)
	252	data = "";
3fc8f685	253
4decd43c	254	if (!f.Open(fn, FileFd::WriteTemp, 0600))
7e726255 AL	255	{
	256	_error->Errno("ofstream::ofstream",_("Unable to write to %s"),fn);
	257	return string();
	258	}
	259
4decd43c AL	260	f.Write(data, strlen(data));
4decd43c AL	261	f.Close();
7e726255	262	return fn;
3fc8f685	263	}
234edfd0 AL	264	/}}}/
	265	// WriteConfig - write out the config data from a debian package file /{{{/
	266	// ---------------------------------------------------------------------
	267	/* */
	268	void WriteConfig(const DebFile &file)
3fc8f685	269	{
7e726255 AL	270	string templatefile = WriteFile("template", file.Template);
7e726255 AL	271	string configscript = WriteFile("config", file.Config);
3fc8f685	272
7e726255	273	if (templatefile.empty() == true \|\| configscript.empty() == true)
3fc8f685	274	return;
234edfd0 AL	275	cout << file.Package << " " << file.Version << " "
234edfd0 AL	276	<< templatefile << " " << configscript << endl;
234edfd0 AL	277	}
	278	/}}}/
	279	// InitCache - initialize the package cache /{{{/
	280	// ---------------------------------------------------------------------
	281	/* */
7e726255 AL	282	bool Go(CommandLine &CmdL)
7e726255 AL	283	{
3fc8f685	284	// Initialize the apt cache
7e726255	285	MMap *Map = 0;
3fc8f685 AL	286	pkgSourceList List;
	287	List.ReadMainList();
	288	OpProgress Prog;
	289	pkgMakeStatusCache(List,Prog,&Map,true);
7e726255 AL	290	DebFile::Cache = new pkgCache(Map);
	291	if (_error->PendingError() == true)
	292	return false;
5cbf1b49	293
234edfd0	294	// Find out what version of debconf is currently installed
7e726255 AL	295	string debconfver = DebFile::GetInstalledVer("debconf");
	296	if (debconfver.empty() == true)
	297	return _error->Error( _("Cannot get debconf version. Is debconf installed?"));
3fc8f685	298
234edfd0	299	// Process each package passsed in
5cbf1b49	300	for (unsigned int I = 0; I != CmdL.FileSize(); I++)
3fc8f685	301	{
7e726255	302	// Will pick up the errors later..
5cbf1b49	303	DebFile file(CmdL.FileList[I]);
7e726255 AL	304	if (file.Go() == false)
	305	continue;
	306
234edfd0	307	// Does the package have templates?
3fc8f685 AL	308	if (file.Template != 0 && file.ParseInfo() == true)
3fc8f685 AL	309	{
234edfd0 AL	310	// Check to make sure debconf dependencies are
	311	// satisfied
	312	if (file.DepVer != "" &&
7e726255 AL	313	DebFile::Cache->VS->CheckDep(file.DepVer.c_str(),
7e726255 AL	314	file.DepOp, debconfver.c_str()) == false)
3fc8f685	315	continue;
234edfd0	316	if (file.PreDepVer != "" &&
5cbf1b49	317	DebFile::Cache->VS->CheckDep(file.PreDepVer.c_str(),
7e726255	318	file.PreDepOp, debconfver.c_str()) == false)
3fc8f685 AL	319	continue;
3fc8f685 AL	320
234edfd0	321	WriteConfig(file);
3fc8f685 AL	322	}
	323	}
	324
	325
	326	delete Map;
	327	delete DebFile::Cache;
7e726255 AL	328
	329	return !_error->PendingError();
	330	}
	331	/}}}/
	332
	333	int main(int argc, const char **argv)
	334	{
	335	CommandLine::Args Args[] = {
	336	{'h',"help","help",0},
	337	{'v',"version","version",0},
	338	{'t',"tempdir","APT::ExtractTemplates::TempDir",CommandLine::HasArg},
	339	{'c',"config-file",0,CommandLine::ConfigFile},
	340	{'o',"option",0,CommandLine::ArbItem},
	341	{0,0,0,0}};
	342
	343	// Parse the command line and initialize the package library
	344	CommandLine CmdL(Args,_config);
	345	if (pkgInitConfig(*_config) == false \|\|
	346	CmdL.Parse(argc,argv) == false \|\|
	347	pkgInitSystem(*_config,_system) == false)
	348	{
	349	_error->DumpErrors();
	350	return 100;
	351	}
	352
	353	// See if the help should be shown
	354	if (_config->FindB("help") == true \|\|
	355	CmdL.FileSize() == 0)
	356	return ShowHelp();
	357
	358	Go(CmdL);
3fc8f685	359
7e726255 AL	360	// Print any errors or warnings found during operation
	361	if (_error->empty() == false)
	362	{
	363	// This goes to stderr..
	364	bool Errors = _error->PendingError();
	365	_error->DumpErrors();
	366	return Errors == true?100:0;
	367	}
	368
3fc8f685 AL	369	return 0;
3fc8f685 AL	370	}