rust_apt/
records.rs

1//! Allows access to complete package description records directly from the
2//! file.
3use std::cell::{Ref, RefCell};
4
5use cxx::UniquePtr;
6
7// TODO: Probably just make this a real enum
8// we an add a variant RecordField::String("Package".to_string())
9// or something like that.
10
11/// A module containing [`&str`] constants for known record fields
12///
13/// Pass through to the [`crate::Version::get_record`] method
14/// or you can use a custom [`&str`] like the ones listed below.
15///
16/// Other Known Record Keys:
17///
18/// `Conffiles` `Status` `Python-Version` `Auto-Built-Package`
19/// `Enhances` `Cnf-Extra-Commands` `Gstreamer-Elements`
20/// `Gstreamer-Encoders` `Lua-Versions` `Original-Maintainer` `Protected`
21/// `Gstreamer-Uri-Sources` `Vendor` `Build-Ids` `Efi-Vendor` `SHA512`
22/// `Build-Essential` `Important` `X-Cargo-Built-Using`
23/// `Cnf-Visible-Pkgname` `Gstreamer-Decoders` `SHA1` `Gstreamer-Uri-Sinks`
24/// `Gstreamer-Version` `Ghc-Package` `Static-Built-Using`
25/// `Postgresql-Catversion` `Python-Egg-Name` `Built-Using` `License`
26/// `Cnf-Ignore-Commands` `Go-Import-Path` `Ruby-Versions`
27#[allow(non_upper_case_globals, non_snake_case)]
28pub mod RecordField {
29	/// Name of the package `apt`
30	pub const Package: &str = "Package";
31
32	/// The name of the source package and the version if it exists
33	/// `zsh (5.9-1)`
34	// TODO: We need to write a parser to be able to handle this properly
35	// The apt source that does this is in debrecords.cc
36	pub const Source: &str = "Source";
37
38	/// Version of the package `2.5.2`
39	pub const Version: &str = "Version";
40
41	/// The unpacked size in KiB? `4352`
42	pub const InstalledSize: &str = "Installed-Size";
43
44	/// The homepage of the software
45	/// `https://gitlab.com/volian/rust-apt`
46	pub const Homepage: &str = "Homepage";
47
48	/// If the package is essential `yes`
49	pub const Essential: &str = "Essential";
50
51	/// The Maintainer of the package
52	/// `APT Development Team <deity@lists.debian.org>`
53	pub const Maintainer: &str = "Maintainer";
54
55	/// The Original Maintainer of the package.
56	/// Most common to see on Ubuntu packages repackaged from Debian
57	/// `APT Development Team <deity@lists.debian.org>`
58	pub const OriginalMaintainer: &str = "Original-Maintainer";
59
60	/// The Architecture of the package `amd64`
61	pub const Architecture: &str = "Architecture";
62
63	/// Packages that this one replaces
64	/// `apt-transport-https (<< 1.5~alpha4~), apt-utils (<< 1.3~exp2~)`
65	pub const Replaces: &str = "Replaces";
66
67	/// Packages that this one provides
68	/// `apt-transport-https (= 2.5.2)`
69	pub const Provides: &str = "Provides";
70
71	/// Packages that must be installed and configured before this one
72	/// `libc6 (>= 2.34), libtinfo6 (>= 6)`
73	pub const PreDepends: &str = "Pre-Depends";
74
75	/// Packages this one depends on
76	/// `adduser, gpgv | gpgv2 | gpgv1, libapt-pkg6.0 (>= 2.5.2)`
77	pub const Depends: &str = "Depends";
78
79	/// Packages that are recommended to be installed with this one
80	/// `ca-certificates`
81	pub const Recommends: &str = "Recommends";
82
83	/// Packages that are suggested to be installed with this one
84	/// `apt-doc, aptitude | synaptic | wajig, dpkg-dev (>= 1.17.2)`
85	pub const Suggests: &str = "Suggests";
86
87	/// Packages that are broken by installing this.
88	/// `apt-transport-https (<< 1.5~alpha4~), apt-utils (<< 1.3~exp2~)`
89	pub const Breaks: &str = "Breaks";
90
91	/// Packages that conflict with this one
92	/// `bash-completion (<< 20060301-0)`
93	pub const Conflicts: &str = "Conflicts";
94
95	/// The raw description of the package
96	/// `commandline package manager`
97	pub const Description: &str = "Description";
98
99	/// The MD5 sum of the description
100	/// `9fb97a88cb7383934ef963352b53b4a7`
101	pub const DescriptionMD5: &str = "Description-md5";
102
103	/// Any tags associated with this package
104	/// `admin::package-management, devel::lang:ruby, hardware::storage`
105	pub const Tag: &str = "Tag";
106
107	/// The type of multi arch for the package.
108	/// Either `allowed`, `foreign`, or `same`
109	pub const MultiArch: &str = "Multi-Arch";
110
111	/// The section of the package `admin`
112	pub const Section: &str = "Section";
113
114	/// The Priority of the package `required`
115	pub const Priority: &str = "Priority";
116
117	/// The raw filename of the package
118	/// `pool/main/a/apt/apt_2.5.2_amd64.deb`
119	pub const Filename: &str = "Filename";
120
121	/// The compressed size of the .deb in bytes `1500520`
122	pub const Size: &str = "Size";
123
124	/// The percentage rollout value for phased updates `50`
125	pub const PhasedUpdatePercentage: &str = "Phased-Update-Percentage";
126
127	/// The MD5 sum of the package `8797c5716952fba7779bd072e53acee5`
128	pub const MD5sum: &str = "MD5sum";
129
130	/// The SHA256 sum of the package
131	/// `a6dd99a52ec937faa20e1617da36b8b27a2ed8bc9300bf7eb8404041ede52200`
132	pub const SHA256: &str = "SHA256";
133}
134
135pub struct PackageRecords {
136	pub(crate) ptr: UniquePtr<raw::PkgRecords>,
137	parser: RefCell<UniquePtr<raw::Parser>>,
138	index: RefCell<u64>,
139}
140
141impl PackageRecords {
142	pub fn new(ptr: UniquePtr<raw::PkgRecords>) -> PackageRecords {
143		PackageRecords {
144			ptr,
145			parser: RefCell::new(UniquePtr::null()),
146			index: RefCell::new(0),
147		}
148	}
149
150	fn replace_index(&self, index: u64) -> bool {
151		if self.index.borrow().eq(&index) {
152			return false;
153		}
154		self.index.replace(index);
155		true
156	}
157
158	fn parser(&self) -> Ref<'_, UniquePtr<raw::Parser>> {
159		if self.parser.borrow().is_null() {
160			panic!("You must call ver_lookup or desc_lookup first!")
161		}
162		self.parser.borrow()
163	}
164
165	pub fn ver_lookup(&self, file: &raw::VerFileIterator) -> &PackageRecords {
166		if self.replace_index(file.index()) {
167			unsafe { self.parser.replace(self.ptr.ver_lookup(file)) };
168		}
169		self
170	}
171
172	pub fn desc_lookup(&self, file: &raw::DescIterator) -> &PackageRecords {
173		if self.replace_index(file.index()) {
174			unsafe { self.parser.replace(self.ptr.desc_lookup(file)) };
175		}
176		self
177	}
178
179	pub fn short_desc(&self) -> Option<String> { self.parser().short_desc().ok() }
180
181	pub fn long_desc(&self) -> Option<String> { self.parser().long_desc().ok() }
182
183	pub fn filename(&self) -> String { self.parser().filename() }
184
185	pub fn get_field(&self, field: String) -> Option<String> { self.parser().get_field(field).ok() }
186
187	pub fn hash_find(&self, hash_type: String) -> Option<String> {
188		self.parser().hash_find(hash_type).ok()
189	}
190}
191
192type SourceParser<'a> = Ref<'a, UniquePtr<raw::SourceParser>>;
193
194pub struct SourceRecords {
195	ptr: UniquePtr<raw::SourceRecords>,
196	parser: RefCell<UniquePtr<raw::SourceParser>>,
197}
198
199impl SourceRecords {
200	pub fn new(ptr: UniquePtr<raw::SourceRecords>) -> SourceRecords {
201		SourceRecords {
202			ptr,
203			parser: RefCell::new(UniquePtr::null()),
204		}
205	}
206
207	/// Return all of the parsers to their starting position
208	pub fn restart(&self) { self.ptr.restart() }
209
210	/// Lookup the string name of the package.
211	///
212	/// # Example:
213	/// ```
214	/// use rust_apt::new_cache;
215	///
216	/// let cache = new_cache!().unwrap();
217	/// let Ok(src_records) = cache.source_records() else {
218	///     // Requires at least one `deb-src` entry in APT sources.
219	///     return;
220	/// };
221	///
222	/// while let Some(record) = src_records.lookup("libapt-pkg-dev".to_string(), false) {
223	///     println!("{}", record.package());
224	/// }
225	/// ```
226	pub fn lookup(&self, name: String, src_only: bool) -> Option<SourceParser<'_>> {
227		unsafe {
228			self.parser.replace(self.ptr.find(name, src_only));
229		}
230
231		if self.parser.borrow().end() {
232			self.restart();
233			return None;
234		}
235		Some(self.parser.borrow())
236	}
237}
238
239#[cxx::bridge]
240pub(crate) mod raw {
241	impl UniquePtr<IndexFile> {}
242	impl UniquePtr<SourceRecords> {}
243	unsafe extern "C++" {
244		include!("rust-apt/apt-pkg-c/records.h");
245		type PkgRecords;
246		type Parser;
247		type SourceRecords;
248		type SourceParser;
249		type IndexFile;
250		type VerFileIterator = crate::iterators::VerFileIterator;
251		type DescIterator = crate::iterators::DescIterator;
252
253		/// Move the records into the correct spot for the Version File.
254		///
255		/// # Safety
256		///
257		/// The returned Parser can not out live the records struct.
258		/// If you hold a Parser and lookup another file, the data that parser
259		/// returns will change.
260		///
261		/// The returned UniquePtr cannot outlive the cache.
262		unsafe fn ver_lookup(self: &PkgRecords, ver_file: &VerFileIterator) -> UniquePtr<Parser>;
263
264		/// Move the records into the correct spot for the Description File.
265		///
266		/// # Safety
267		///
268		/// The returned Parser can not out live the records struct.
269		/// If you hold a Parser and lookup another file, the data that parser
270		/// returns will change.
271		///
272		/// The returned UniquePtr cannot outlive the cache.
273		unsafe fn desc_lookup(self: &PkgRecords, desc_file: &DescIterator) -> UniquePtr<Parser>;
274
275		pub fn filename(self: &Parser) -> String;
276		pub fn long_desc(self: &Parser) -> Result<String>;
277		pub fn short_desc(self: &Parser) -> Result<String>;
278
279		pub fn get_field(self: &Parser, field: String) -> Result<String>;
280		pub fn hash_find(self: &Parser, hash_type: String) -> Result<String>;
281
282		pub fn archive_uri(self: &IndexFile, filename: &str) -> String;
283		pub fn describe(self: &IndexFile, short_desc: bool) -> String;
284
285		/// Return true if the IndexFile is trusted.
286		pub fn is_trusted(self: &IndexFile) -> bool;
287
288		pub fn restart(self: &SourceRecords);
289
290		/// # Safety
291		///
292		/// The returned Parser can not out live the records struct.
293		/// Make sure to check the `end()` to see if null.
294		unsafe fn find(
295			self: &SourceRecords,
296			name: String,
297			src_only: bool,
298		) -> UniquePtr<SourceParser>;
299
300		fn as_str(self: &SourceParser) -> String;
301		fn package(self: &SourceParser) -> String;
302		fn version(self: &SourceParser) -> String;
303		fn maintainer(self: &SourceParser) -> String;
304		fn section(self: &SourceParser) -> String;
305		fn end(self: &SourceParser) -> bool;
306	}
307}
rust_apt/records.rs

rust_apt/
records.rs
