1 /*
2  *  db.h
3  *
4  *  Copyright (c) 2006-2018 Pacman Development Team <pacman-dev@archlinux.org>
5  *  Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
6  *  Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
7  *  Copyright (c) 2006 by Miklos Vajna <vmiklos@frugalware.org>
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  */
22 #ifndef ALPM_DB_H
23 #define ALPM_DB_H
24 
25 /* libarchive */
26 #include <archive.h>
27 #include <archive_entry.h>
28 
29 #include "alpm.h"
30 #include "pkghash.h"
31 #include "signing.h"
32 
33 /* Database entries */
34 typedef enum _alpm_dbinfrq_t {
35 	INFRQ_BASE = (1 << 0),
36 	INFRQ_DESC = (1 << 1),
37 	INFRQ_FILES = (1 << 2),
38 	INFRQ_SCRIPTLET = (1 << 3),
39 	INFRQ_DSIZE = (1 << 4),
40 	/* ALL should be info stored in the package or database */
41 	INFRQ_ALL = INFRQ_BASE | INFRQ_DESC | INFRQ_FILES |
42 		INFRQ_SCRIPTLET | INFRQ_DSIZE,
43 	INFRQ_ERROR = (1 << 30)
44 } alpm_dbinfrq_t;
45 
46 /** Database status. Bitflags. */
47 enum _alpm_dbstatus_t {
48 	DB_STATUS_VALID = (1 << 0),
49 	DB_STATUS_INVALID = (1 << 1),
50 	DB_STATUS_EXISTS = (1 << 2),
51 	DB_STATUS_MISSING = (1 << 3),
52 
53 	DB_STATUS_LOCAL = (1 << 10),
54 	DB_STATUS_PKGCACHE = (1 << 11),
55 	DB_STATUS_GRPCACHE = (1 << 12)
56 };
57 
58 struct db_operations {
59 	int (*validate) (alpm_db_t *);
60 	int (*populate) (alpm_db_t *);
61 	void (*unregister) (alpm_db_t *);
62 };
63 
64 /* Database */
65 struct __alpm_db_t {
66 	alpm_handle_t *handle;
67 	char *treename;
68 	/* do not access directly, use _alpm_db_path(db) for lazy access */
69 	char *_path;
70 	alpm_pkghash_t *pkgcache;
71 	alpm_list_t *grpcache;
72 	alpm_list_t *servers;
73 	struct db_operations *ops;
74 
75 	/* bitfields for validity, local, loaded caches, etc. */
76 	/* From _alpm_dbstatus_t */
77 	int status;
78 	/* alpm_siglevel_t */
79 	int siglevel;
80 	/* alpm_db_usage_t */
81 	int usage;
82 };
83 
84 
85 /* db.c, database general calls */
86 alpm_db_t *_alpm_db_new(const char *treename, int is_local);
87 void _alpm_db_free(alpm_db_t *db);
88 const char *_alpm_db_path(alpm_db_t *db);
89 int _alpm_db_cmp(const void *d1, const void *d2);
90 alpm_list_t *_alpm_db_search(alpm_db_t *db, const alpm_list_t *needles);
91 alpm_db_t *_alpm_db_register_local(alpm_handle_t *handle);
92 alpm_db_t *_alpm_db_register_sync(alpm_handle_t *handle, const char *treename,
93 		int level);
94 void _alpm_db_unregister(alpm_db_t *db);
95 
96 /* be_*.c, backend specific calls */
97 int _alpm_local_db_prepare(alpm_db_t *db, alpm_pkg_t *info);
98 int _alpm_local_db_write(alpm_db_t *db, alpm_pkg_t *info, int inforeq);
99 int _alpm_local_db_remove(alpm_db_t *db, alpm_pkg_t *info);
100 char *_alpm_local_db_pkgpath(alpm_db_t *db, alpm_pkg_t *info, const char *filename);
101 
102 /* cache bullshit */
103 /* packages */
104 void _alpm_db_free_pkgcache(alpm_db_t *db);
105 int _alpm_db_add_pkgincache(alpm_db_t *db, alpm_pkg_t *pkg);
106 int _alpm_db_remove_pkgfromcache(alpm_db_t *db, alpm_pkg_t *pkg);
107 alpm_pkghash_t *_alpm_db_get_pkgcache_hash(alpm_db_t *db);
108 alpm_list_t *_alpm_db_get_pkgcache(alpm_db_t *db);
109 alpm_pkg_t *_alpm_db_get_pkgfromcache(alpm_db_t *db, const char *target);
110 /* groups */
111 alpm_list_t *_alpm_db_get_groupcache(alpm_db_t *db);
112 alpm_group_t *_alpm_db_get_groupfromcache(alpm_db_t *db, const char *target);
113 
114 #endif /* ALPM_DB_H */
115