lib/libalpm/db.h

   1 /*
   2  *  db.h
   3  *
   4  *  Copyright (c) 2006-2012 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,
  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 = 0x1F,
  42         INFRQ_ERROR = (1 << 31)
  43 } alpm_dbinfrq_t;
  44
  45 /** Database status. Bitflags. */
  46 enum _alpm_dbstatus_t {
  47         DB_STATUS_VALID = (1 << 0),
  48         DB_STATUS_INVALID = (1 << 1),
  49         DB_STATUS_EXISTS = (1 << 2),
  50         DB_STATUS_MISSING = (1 << 3),
  51
  52         DB_STATUS_LOCAL = (1 << 10),
  53         DB_STATUS_PKGCACHE = (1 << 11),
  54         DB_STATUS_GRPCACHE = (1 << 12)
  55 };
  56
  57 struct db_operations {
  58         int (*validate) (alpm_db_t *);
  59         int (*populate) (alpm_db_t *);
  60         void (*unregister) (alpm_db_t *);
  61 };
  62
  63 /* Database */
  64 struct __alpm_db_t {
  65         alpm_handle_t *handle;
  66         char *treename;
  67         /* do not access directly, use _alpm_db_path(db) for lazy access */
  68         char *_path;
  69         alpm_pkghash_t *pkgcache;
  70         alpm_list_t *grpcache;
  71         alpm_list_t *servers;
  72         struct db_operations *ops;
  73         /* flags determining validity, local, loaded caches, etc. */
  74         enum _alpm_dbstatus_t status;
  75         alpm_siglevel_t siglevel;
  76 };
  77
  78
  79 /* db.c, database general calls */
  80 alpm_db_t *_alpm_db_new(const char *treename, int is_local);
  81 void _alpm_db_free(alpm_db_t *db);
  82 const char *_alpm_db_path(alpm_db_t *db);
  83 int _alpm_db_cmp(const void *d1, const void *d2);
  84 alpm_list_t *_alpm_db_search(alpm_db_t *db, const alpm_list_t *needles);
  85 alpm_db_t *_alpm_db_register_local(alpm_handle_t *handle);
  86 alpm_db_t *_alpm_db_register_sync(alpm_handle_t *handle, const char *treename,
  87                 alpm_siglevel_t level);
  88 void _alpm_db_unregister(alpm_db_t *db);
  89
  90 /* be_*.c, backend specific calls */
  91 int _alpm_local_db_prepare(alpm_db_t *db, alpm_pkg_t *info);
  92 int _alpm_local_db_write(alpm_db_t *db, alpm_pkg_t *info, alpm_dbinfrq_t inforeq);
  93 int _alpm_local_db_remove(alpm_db_t *db, alpm_pkg_t *info);
  94 char *_alpm_local_db_pkgpath(alpm_db_t *db, alpm_pkg_t *info, const char *filename);
  95
  96 /* cache bullshit */
  97 /* packages */
  98 void _alpm_db_free_pkgcache(alpm_db_t *db);
  99 int _alpm_db_add_pkgincache(alpm_db_t *db, alpm_pkg_t *pkg);
 100 int _alpm_db_remove_pkgfromcache(alpm_db_t *db, alpm_pkg_t *pkg);
 101 alpm_pkghash_t *_alpm_db_get_pkgcache_hash(alpm_db_t *db);
 102 alpm_list_t *_alpm_db_get_pkgcache(alpm_db_t *db);
 103 alpm_pkg_t *_alpm_db_get_pkgfromcache(alpm_db_t *db, const char *target);
 104 /* groups */
 105 alpm_list_t *_alpm_db_get_groupcache(alpm_db_t *db);
 106 alpm_group_t *_alpm_db_get_groupfromcache(alpm_db_t *db, const char *target);
 107
 108 #endif /* _ALPM_DB_H */
 109
 110 /* vim: set ts=2 sw=2 noet: */