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

// -*- mode: cpp; mode: fold -*-
// Description								/*{{{*/
// $Id: apt-extracttemplates.cc,v 1.15 2003/07/26 00:00:11 mdz 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<config.h>

#include <apt-pkg/init.h>
#include <apt-pkg/cmndline.h>
#include <apt-pkg/pkgcache.h>
#include <apt-pkg/cacheiterators.h>
#include <apt-pkg/configuration.h>
#include <apt-pkg/sourcelist.h>
#include <apt-pkg/pkgcachegen.h>
#include <apt-pkg/version.h>
#include <apt-pkg/tagfile.h>
#include <apt-pkg/debfile.h>
#include <apt-pkg/deblistparser.h>
#include <apt-pkg/error.h>
#include <apt-pkg/strutl.h>
#include <apt-pkg/fileutl.h>
#include <apt-pkg/pkgsystem.h>
#include <apt-pkg/dirstream.h>
#include <apt-pkg/mmap.h>

#include <apt-private/private-cmndline.h>
#include <apt-private/private-main.h>

#include <iostream>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>

#include "apt-extracttemplates.h"

#include <apti18n.h>
									/*}}}*/

using namespace std;

pkgCache *DebFile::Cache = 0;

// DebFile::DebFile - Construct the DebFile object			/*{{{*/
// ---------------------------------------------------------------------
/* */
DebFile::DebFile(const char *debfile)
	: File(debfile, FileFd::ReadOnly), Control(NULL), ControlLen(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()
{
	debDebFile Deb(File);

	return Deb.ExtractTarMember(*this, "control.tar");
}
									/*}}}*/
// 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+3];
		Control[I.Size] = '\n';
		Control[I.Size + 1] = '\n';
		Control[I.Size + 2] = '\0';
		Which = IsControl;
		ControlLen = I.Size + 3;
		// 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 long size, unsigned long 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;
	if (Section.Scan(Control, ControlLen) == false)
		return false;

	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;
}
									/*}}}*/
static bool ShowHelp(CommandLine &)					/*{{{*/
{
	cout <<
		_("Usage: apt-extracttemplates file1 [file2 ...]\n"
		"\n"
		"apt-extracttemplates is used to extract config and template files\n"
		"from debian packages. It is used mainly by debconf(1) to prompt for\n"
		"configuration questions before installation of packages.\n");
	return true;
}
									/*}}}*/
// WriteFile - write the contents of the passed string to a file	/*{{{*/
// ---------------------------------------------------------------------
/* */
static string WriteFile(const char *package, const char *prefix, const char *data)
{
	char fn[512];

        std::string tempdir = GetTempDir();
	snprintf(fn, sizeof(fn), "%s/%s.%s.XXXXXX",
                 _config->Find("APT::ExtractTemplates::TempDir", 
                               tempdir.c_str()).c_str(),
                 package, prefix);
	FileFd f;
	if (data == NULL)
		data = "";
        int fd = mkstemp(fn);
        if (fd < 0) {
		_error->Errno("ofstream::ofstream",_("Unable to mkstemp %s"),fn);
                return string();
        }
	if (!f.OpenDescriptor(fd, FileFd::WriteOnly, FileFd::None, true))
	{
		_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	/*{{{*/
// ---------------------------------------------------------------------
/* */
static void WriteConfig(const DebFile &file)
{
	string templatefile = WriteFile(file.Package.c_str(), "template", file.Template);
	string configscript = WriteFile(file.Package.c_str(), "config", file.Config);

	if (templatefile.empty() == true || configscript.empty() == true)
		return;
	cout << file.Package << " " << file.Version << " " 
	     << templatefile << " " << configscript << endl;
}
									/*}}}*/
// InitCache - initialize the package cache				/*{{{*/
// ---------------------------------------------------------------------
/* */
static bool Go(CommandLine &CmdL)
{	
	// Initialize the apt cache
	MMap *Map = 0;
	pkgSourceList List;
	List.ReadMainList();
	pkgCacheGenerator::MakeStatusCache(List,NULL,&Map,true);
	if (Map == 0)
	   return false;
	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)
		{
		        _error->Error("Prior errors apply to %s",CmdL.FileList[I]);
			continue;
		}

		// Does the package have templates?
		if (file.Template != 0 && file.ParseInfo() == true)
		{
			// Check to make sure debconf dependencies are
			// satisfied
			// cout << "Check " << file.DepVer << ',' << debconfver << endl;
			if (file.DepVer != "" &&
			    DebFile::Cache->VS->CheckDep(debconfver.c_str(),
					file.DepOp,file.DepVer.c_str()
							 ) == false)
				continue;
			if (file.PreDepVer != "" &&
			    DebFile::Cache->VS->CheckDep(debconfver.c_str(),
			                file.PreDepOp,file.PreDepVer.c_str()
							 ) == false) 
				continue;

			WriteConfig(file);
		}
	}
	

	delete Map;
	delete DebFile::Cache;
	
	return !_error->PendingError();
}
									/*}}}*/
static std::vector<aptDispatchWithHelp> GetCommands()			/*{{{*/
{
   return {
	{nullptr, nullptr, nullptr}
   };
}
									/*}}}*/
int main(int argc, const char **argv)					/*{{{*/
{
	InitLocale();

	CommandLine CmdL;
	auto const Cmds = ParseCommandLine(CmdL, APT_CMD::APT_EXTRACTTEMPLATES, &_config, &_system, argc, argv, &ShowHelp, &GetCommands);

	Go(CmdL);

	return DispatchCommandLine(CmdL, {});
}
									/*}}}*/
Commit	Line	Data
234edfd0 AL	1	// -- mode: cpp; mode: fold --
234edfd0 AL	2	// Description /{{{/
8eb5af51	3	// $Id: apt-extracttemplates.cc,v 1.15 2003/07/26 00:00:11 mdz 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 /{{{/
ea542140 DK	16	#include<config.h>
ea542140 DK	17
3fc8f685	18	#include <apt-pkg/init.h>
5cbf1b49	19	#include <apt-pkg/cmndline.h>
3fc8f685	20	#include <apt-pkg/pkgcache.h>
453b82a3	21	#include <apt-pkg/cacheiterators.h>
3fc8f685	22	#include <apt-pkg/configuration.h>
3fc8f685 AL	23	#include <apt-pkg/sourcelist.h>
	24	#include <apt-pkg/pkgcachegen.h>
	25	#include <apt-pkg/version.h>
234edfd0	26	#include <apt-pkg/tagfile.h>
e7f56293	27	#include <apt-pkg/debfile.h>
234edfd0 AL	28	#include <apt-pkg/deblistparser.h>
	29	#include <apt-pkg/error.h>
	30	#include <apt-pkg/strutl.h>
4decd43c	31	#include <apt-pkg/fileutl.h>
472ff00e	32	#include <apt-pkg/pkgsystem.h>
453b82a3 DK	33	#include <apt-pkg/dirstream.h>
453b82a3 DK	34	#include <apt-pkg/mmap.h>
ea542140	35
ad7e0941	36	#include <apt-private/private-cmndline.h>
e7e10e47	37	#include <apt-private/private-main.h>
ad7e0941	38
453b82a3	39	#include <iostream>
234edfd0 AL	40	#include <stdio.h>
234edfd0 AL	41	#include <string.h>
234edfd0	42	#include <unistd.h>
8d50b63f	43	#include <stdlib.h>
234edfd0	44
234edfd0	45	#include "apt-extracttemplates.h"
a00a9b44 DK	46
a00a9b44 DK	47	#include <apti18n.h>
7e726255	48	/}}}/
234edfd0	49
8f312f45 AL	50	using namespace std;
8f312f45 AL	51
234edfd0 AL	52	pkgCache *DebFile::Cache = 0;
	53
	54	// DebFile::DebFile - Construct the DebFile object /{{{/
	55	// ---------------------------------------------------------------------
	56	/* */
	57	DebFile::DebFile(const char *debfile)
387fb4ae	58	: File(debfile, FileFd::ReadOnly), Control(NULL), ControlLen(0),
dcaa1185	59	DepOp(0), PreDepOp(0), Config(0), Template(0), Which(None)
3fc8f685	60	{
3fc8f685	61	}
234edfd0 AL	62	/}}}/
	63	// DebFile::~DebFile - Destruct the DebFile object /{{{/
	64	// ---------------------------------------------------------------------
	65	/* */
	66	DebFile::~DebFile()
	67	{
	68	delete [] Control;
	69	delete [] Config;
	70	delete [] Template;
	71	}
	72	/}}}/
	73	// DebFile::GetInstalledVer - Find out the installed version of a pkg /{{{/
	74	// ---------------------------------------------------------------------
	75	/* */
7e726255	76	string DebFile::GetInstalledVer(const string &package)
234edfd0	77	{
234edfd0 AL	78	pkgCache::PkgIterator Pkg = Cache->FindPkg(package);
	79	if (Pkg.end() == false)
	80	{
	81	pkgCache::VerIterator V = Pkg.CurrentVer();
7e726255	82	if (V.end() == false)
234edfd0	83	{
7e726255	84	return V.VerStr();
234edfd0 AL	85	}
234edfd0 AL	86	}
3fc8f685	87
7e726255	88	return string();
234edfd0 AL	89	}
	90	/}}}/
	91	// DebFile::Go - Start extracting a debian package /{{{/
	92	// ---------------------------------------------------------------------
	93	/* */
	94	bool DebFile::Go()
	95	{
e7f56293 GJ	96	debDebFile Deb(File);
	97
	98	return Deb.ExtractTarMember(*this, "control.tar");
234edfd0 AL	99	}
	100	/}}}/
	101	// DebFile::DoItem examine element in package and mark /{{{/
	102	// ---------------------------------------------------------------------
	103	/* */
	104	bool DebFile::DoItem(Item &I, int &Fd)
	105	{
	106	if (strcmp(I.Name, "control") == 0)
	107	{
	108	delete [] Control;
8710a36a DK	109	Control = new char[I.Size+3];
	110	Control[I.Size] = '\n';
	111	Control[I.Size + 1] = '\n';
	112	Control[I.Size + 2] = '\0';
234edfd0	113	Which = IsControl;
8710a36a	114	ControlLen = I.Size + 3;
234edfd0 AL	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	/* */
65512241	145	bool DebFile::Process(Item &/I/, const unsigned char *data,
3621b1c7	146	unsigned long long size, unsigned long long pos)
234edfd0 AL	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;
8710a36a	170
234edfd0	171	pkgTagSection Section;
8710a36a DK	172	if (Section.Scan(Control, ControlLen) == false)
8710a36a DK	173	return false;
234edfd0 AL	174
	175	Package = Section.FindS("Package");
	176	Version = GetInstalledVer(Package);
	177
	178	const char Start, Stop;
	179	if (Section.Find("Depends", Start, Stop) == true)
	180	{
	181	while (1)
	182	{
	183	string P, V;
	184	unsigned int Op;
	185	Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
	186	if (Start == 0) return false;
	187	if (P == "debconf")
	188	{
	189	DepVer = V;
	190	DepOp = Op;
	191	break;
	192	}
	193	if (Start == Stop) break;
	194	}
	195	}
	196
	197	if (Section.Find("Pre-Depends", Start, Stop) == true)
	198	{
	199	while (1)
	200	{
	201	string P, V;
	202	unsigned int Op;
	203	Start = debListParser::ParseDepends(Start, Stop, P, V, Op);
	204	if (Start == 0) return false;
	205	if (P == "debconf")
	206	{
	207	PreDepVer = V;
	208	PreDepOp = Op;
	209	break;
	210	}
	211	if (Start == Stop) break;
	212	}
	213	}
	214
	215	return true;
	216	}
	217	/}}}/
f6777222	218	static bool ShowHelp(CommandLine &) /{{{/
234edfd0	219	{
ad7e0941	220	cout <<
234edfd0 AL	221	_("Usage: apt-extracttemplates file1 [file2 ...]\n"
234edfd0 AL	222	"\n"
8561c2fe DK	223	"apt-extracttemplates is used to extract config and template files\n"
	224	"from debian packages. It is used mainly by debconf(1) to prompt for\n"
	225	"configuration questions before installation of packages.\n");
ad7e0941	226	return true;
234edfd0 AL	227	}
	228	/}}}/
	229	// WriteFile - write the contents of the passed string to a file /{{{/
	230	// ---------------------------------------------------------------------
	231	/* */
c3ccac92	232	static string WriteFile(const char package, const char prefix, const char *data)
3fc8f685 AL	233	{
3fc8f685 AL	234	char fn[512];
8eb5af51	235
68e01721	236	std::string tempdir = GetTempDir();
8d50b63f	237	snprintf(fn, sizeof(fn), "%s/%s.%s.XXXXXX",
68e01721 MV	238	_config->Find("APT::ExtractTemplates::TempDir",
68e01721 MV	239	tempdir.c_str()).c_str(),
8d50b63f	240	package, prefix);
4decd43c AL	241	FileFd f;
	242	if (data == NULL)
	243	data = "";
8d50b63f MV	244	int fd = mkstemp(fn);
	245	if (fd < 0) {
	246	_error->Errno("ofstream::ofstream",_("Unable to mkstemp %s"),fn);
	247	return string();
	248	}
	249	if (!f.OpenDescriptor(fd, FileFd::WriteOnly, FileFd::None, true))
7e726255 AL	250	{
	251	_error->Errno("ofstream::ofstream",_("Unable to write to %s"),fn);
	252	return string();
	253	}
4decd43c AL	254	f.Write(data, strlen(data));
4decd43c AL	255	f.Close();
7e726255	256	return fn;
3fc8f685	257	}
234edfd0 AL	258	/}}}/
	259	// WriteConfig - write out the config data from a debian package file /{{{/
	260	// ---------------------------------------------------------------------
	261	/* */
c3ccac92	262	static void WriteConfig(const DebFile &file)
3fc8f685	263	{
a5eef4f7 AL	264	string templatefile = WriteFile(file.Package.c_str(), "template", file.Template);
a5eef4f7 AL	265	string configscript = WriteFile(file.Package.c_str(), "config", file.Config);
3fc8f685	266
7e726255	267	if (templatefile.empty() == true \|\| configscript.empty() == true)
3fc8f685	268	return;
234edfd0 AL	269	cout << file.Package << " " << file.Version << " "
234edfd0 AL	270	<< templatefile << " " << configscript << endl;
234edfd0 AL	271	}
	272	/}}}/
	273	// InitCache - initialize the package cache /{{{/
	274	// ---------------------------------------------------------------------
	275	/* */
c3ccac92	276	static bool Go(CommandLine &CmdL)
7e726255	277	{
3fc8f685	278	// Initialize the apt cache
7e726255	279	MMap *Map = 0;
3fc8f685 AL	280	pkgSourceList List;
3fc8f685 AL	281	List.ReadMainList();
ea4b220b	282	pkgCacheGenerator::MakeStatusCache(List,NULL,&Map,true);
08945efa AL	283	if (Map == 0)
08945efa AL	284	return false;
7e726255 AL	285	DebFile::Cache = new pkgCache(Map);
	286	if (_error->PendingError() == true)
	287	return false;
5cbf1b49	288
234edfd0	289	// Find out what version of debconf is currently installed
7e726255 AL	290	string debconfver = DebFile::GetInstalledVer("debconf");
	291	if (debconfver.empty() == true)
	292	return _error->Error( _("Cannot get debconf version. Is debconf installed?"));
3fc8f685	293
234edfd0	294	// Process each package passsed in
5cbf1b49	295	for (unsigned int I = 0; I != CmdL.FileSize(); I++)
3fc8f685	296	{
7e726255	297	// Will pick up the errors later..
5cbf1b49	298	DebFile file(CmdL.FileList[I]);
7e726255	299	if (file.Go() == false)
08945efa AL	300	{
	301	_error->Error("Prior errors apply to %s",CmdL.FileList[I]);
	302	continue;
	303	}
	304
234edfd0	305	// Does the package have templates?
3fc8f685 AL	306	if (file.Template != 0 && file.ParseInfo() == true)
3fc8f685 AL	307	{
234edfd0 AL	308	// Check to make sure debconf dependencies are
234edfd0 AL	309	// satisfied
f034a64a	310	// cout << "Check " << file.DepVer << ',' << debconfver << endl;
234edfd0	311	if (file.DepVer != "" &&
418349f0 AL	312	DebFile::Cache->VS->CheckDep(debconfver.c_str(),
	313	file.DepOp,file.DepVer.c_str()
	314	) == false)
3fc8f685	315	continue;
234edfd0	316	if (file.PreDepVer != "" &&
418349f0 AL	317	DebFile::Cache->VS->CheckDep(debconfver.c_str(),
	318	file.PreDepOp,file.PreDepVer.c_str()
	319	) == false)
3fc8f685 AL	320	continue;
3fc8f685 AL	321
234edfd0	322	WriteConfig(file);
3fc8f685 AL	323	}
	324	}
	325
	326
	327	delete Map;
	328	delete DebFile::Cache;
7e726255 AL	329
	330	return !_error->PendingError();
	331	}
	332	/}}}/
f6777222	333	static std::vector<aptDispatchWithHelp> GetCommands() /{{{/
011188e3 DK	334	{
	335	return {
	336	{nullptr, nullptr, nullptr}
	337	};
	338	}
	339	/}}}/
92fcbfc1	340	int main(int argc, const char *argv) /{{{*/
7e726255	341	{
e7e10e47	342	InitLocale();
67111687	343
ad7e0941	344	CommandLine CmdL;
90986d4d	345	auto const Cmds = ParseCommandLine(CmdL, APT_CMD::APT_EXTRACTTEMPLATES, &_config, &_system, argc, argv, &ShowHelp, &GetCommands);
ad7e0941	346
7e726255	347	Go(CmdL);
3fc8f685	348
011188e3	349	return DispatchCommandLine(CmdL, {});
3fc8f685	350	}
92fcbfc1	351	/}}}/