rpmfiles.h

Go to the documentation of this file.

#ifndef _RPMFILES_H
#define _RPMFILES_H

#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>

#include <rpm/rpmtypes.h>

typedef enum rpmFileTypes_e {
    PIPE    =  1,   
    CDEV    =  2,   
    XDIR    =  4,   
    BDEV    =  6,   
    REG     =  8,   
    LINK    = 10,   
    SOCK    = 12    
} rpmFileTypes;

typedef enum rpmfileState_e {
    RPMFILE_STATE_MISSING   = -1,   /* used for unavailable data */
    RPMFILE_STATE_NORMAL    = 0,
    RPMFILE_STATE_REPLACED  = 1,
    RPMFILE_STATE_NOTINSTALLED  = 2,
    RPMFILE_STATE_NETSHARED = 3,
    RPMFILE_STATE_WRONGCOLOR    = 4
} rpmfileState;

#define RPMFILE_IS_INSTALLED(_x) ((_x) == RPMFILE_STATE_NORMAL || (_x) == RPMFILE_STATE_NETSHARED)

enum rpmfileAttrs_e {
    RPMFILE_NONE    = 0,
    RPMFILE_CONFIG  = (1 <<  0),    
    RPMFILE_DOC     = (1 <<  1),    
    RPMFILE_ICON    = (1 <<  2),    
    RPMFILE_MISSINGOK   = (1 <<  3),    
    RPMFILE_NOREPLACE   = (1 <<  4),    
    RPMFILE_SPECFILE    = (1 <<  5),    
    RPMFILE_GHOST   = (1 <<  6),    
    RPMFILE_LICENSE = (1 <<  7),    
    RPMFILE_README  = (1 <<  8),    
    /* bits 9-10 unused */
    RPMFILE_PUBKEY  = (1 << 11),    
    RPMFILE_ARTIFACT    = (1 << 12),    
};

typedef rpmFlags rpmfileAttrs;

#define RPMFILE_ALL ~(RPMFILE_NONE)

enum rpmVerifyAttrs_e {
    RPMVERIFY_NONE  = 0,        
    RPMVERIFY_MD5   = (1 << 0), 
    RPMVERIFY_FILEDIGEST= (1 << 0), 
    RPMVERIFY_FILESIZE  = (1 << 1), 
    RPMVERIFY_LINKTO    = (1 << 2), 
    RPMVERIFY_USER  = (1 << 3), 
    RPMVERIFY_GROUP = (1 << 4), 
    RPMVERIFY_MTIME = (1 << 5), 
    RPMVERIFY_MODE  = (1 << 6), 
    RPMVERIFY_RDEV  = (1 << 7), 
    RPMVERIFY_CAPS  = (1 << 8), 
    /* bits 9-14 unused, reserved for rpmVerifyAttrs */
    RPMVERIFY_CONTEXTS  = (1 << 15),    
    /* bits 16-22 used in rpmVerifyFlags */
    /* bits 23-27 used in rpmQueryFlags */
    RPMVERIFY_READLINKFAIL= (1 << 28),  
    RPMVERIFY_READFAIL  = (1 << 29),    
    RPMVERIFY_LSTATFAIL = (1 << 30),    
    RPMVERIFY_LGETFILECONFAIL   = (1 << 31) 
};

typedef rpmFlags rpmVerifyAttrs;

#define RPMVERIFY_ALL       ~(RPMVERIFY_NONE)
#define RPMVERIFY_FAILURES  \
  (RPMVERIFY_LSTATFAIL|RPMVERIFY_READFAIL|RPMVERIFY_READLINKFAIL|RPMVERIFY_LGETFILECONFAIL)

typedef enum rpmFileAction_e {
    FA_UNKNOWN      = 0,    
    FA_CREATE       = 1,    
    FA_COPYIN       = 2,    
    FA_COPYOUT      = 3,    
    FA_BACKUP       = 4,    
    FA_SAVE     = 5,    
    FA_SKIP     = 6,    
    FA_ALTNAME      = 7,    
    FA_ERASE        = 8,    
    FA_SKIPNSTATE   = 9,    
    FA_SKIPNETSHARED    = 10,   
    FA_SKIPCOLOR    = 11,   
    FA_TOUCH        = 12,   
    /* bits 16-31 reserved */
} rpmFileAction;

#define XFA_SKIPPING(_a)    \
    ((_a) == FA_SKIP || (_a) == FA_SKIPNSTATE || (_a) == FA_SKIPNETSHARED || (_a) == FA_SKIPCOLOR)

#define XFA_CREATING(_a)    \
    ((_a) == FA_CREATE || (_a) == FA_BACKUP || (_a) == FA_SAVE || (_a) == FA_ALTNAME)

struct rpmRelocation_s {
    char * oldPath; 
    char * newPath; 
};

enum rpmfiFlags_e {
    RPMFI_NOHEADER      = 0,
    RPMFI_KEEPHEADER        = (1 << 0),
    RPMFI_NOFILECLASS       = (1 << 1),
    RPMFI_NOFILEDEPS        = (1 << 2),
    RPMFI_NOFILELANGS       = (1 << 3),
    RPMFI_NOFILEUSER        = (1 << 4),
    RPMFI_NOFILEGROUP       = (1 << 5),
    RPMFI_NOFILEMODES       = (1 << 6),
    RPMFI_NOFILESIZES       = (1 << 7),
    RPMFI_NOFILECAPS        = (1 << 8),
    RPMFI_NOFILELINKTOS     = (1 << 9),
    RPMFI_NOFILEDIGESTS     = (1 << 10),
    RPMFI_NOFILEMTIMES      = (1 << 11),
    RPMFI_NOFILERDEVS       = (1 << 12),
    RPMFI_NOFILEINODES      = (1 << 13),
    RPMFI_NOFILESTATES      = (1 << 14),
    RPMFI_NOFILECOLORS      = (1 << 15),
    RPMFI_NOFILEVERIFYFLAGS = (1 << 16),
    RPMFI_NOFILEFLAGS       = (1 << 17),
    RPMFI_NOFILESIGNATURES  = (1 << 18),
    RPMFI_NOVERITYSIGNATURES    = (1 << 19),
    RPMFI_NOFILEMIME        = (1 << 20),
};

typedef rpmFlags rpmfiFlags;

#define RPMFI_FLAGS_ERASE \
    (RPMFI_NOFILECLASS | RPMFI_NOFILELANGS | \
     RPMFI_NOFILEMTIMES | RPMFI_NOFILERDEVS | \
     RPMFI_NOFILESIGNATURES | RPMFI_NOVERITYSIGNATURES | \
     RPMFI_NOFILEVERIFYFLAGS | RPMFI_NOFILEMIME)

#define RPMFI_FLAGS_INSTALL \
    (RPMFI_NOFILECLASS | RPMFI_NOFILEVERIFYFLAGS | RPMFI_NOFILEMIME)

#define RPMFI_FLAGS_VERIFY \
    (RPMFI_NOFILECLASS | RPMFI_NOFILEDEPS | RPMFI_NOFILELANGS | \
     RPMFI_NOFILECOLORS | RPMFI_NOFILEMIME)

#define RPMFI_FLAGS_QUERY \
    (RPMFI_NOFILECLASS | RPMFI_NOFILEDEPS | RPMFI_NOFILELANGS | \
     RPMFI_NOFILECOLORS | RPMFI_NOFILEVERIFYFLAGS)

#define RPMFI_FLAGS_FILETRIGGER \
    (RPMFI_NOFILECLASS | RPMFI_NOFILEDEPS | RPMFI_NOFILELANGS | \
     RPMFI_NOFILEUSER | RPMFI_NOFILEGROUP | RPMFI_NOFILEMODES | \
     RPMFI_NOFILESIZES | RPMFI_NOFILECAPS | RPMFI_NOFILELINKTOS | \
     RPMFI_NOFILEDIGESTS | RPMFI_NOFILEMTIMES | RPMFI_NOFILERDEVS | \
     RPMFI_NOFILEINODES | RPMFI_NOFILECOLORS | \
     RPMFI_NOFILESIGNATURES | RPMFI_NOVERITYSIGNATURES | \
     RPMFI_NOFILEVERIFYFLAGS | RPMFI_NOFILEFLAGS | RPMFI_NOFILEMIME)

#define RPMFI_FLAGS_ONLY_FILENAMES \
    (RPMFI_FLAGS_FILETRIGGER | RPMFI_NOFILESTATES)

typedef enum rpmFileIter_e {
    RPMFI_ITER_FWD  = 0,
    RPMFI_ITER_BACK = 1,
    RPMFI_ITER_WRITE_ARCHIVE    = 2,
    RPMFI_ITER_READ_ARCHIVE = 3,
    RPMFI_ITER_READ_ARCHIVE_CONTENT_FIRST = 4,
    RPMFI_ITER_READ_ARCHIVE_OMIT_HARDLINKS = 5,
    RPMFI_ITER_INTERVAL = 6,
} rpmFileIter;

#define RPMFILEITERMAX 6

#ifdef __cplusplus
extern "C" {
#endif

rpmfiles rpmfilesNew(rpmstrPool pool, Header h, rpmTagVal tagN, rpmfiFlags flags);

rpmfiles rpmfilesLink(rpmfiles fi);

rpmfiles rpmfilesFree(rpmfiles fi);

rpm_count_t rpmfilesFC(rpmfiles fi);

rpm_count_t rpmfilesDC(rpmfiles fi);

int rpmfilesFindFN(rpmfiles files, const char * fn);

int rpmfilesFindOFN(rpmfiles files, const char * fn);

rpmfi rpmfilesIter(rpmfiles files, int itype);

int rpmfilesDigestAlgo(rpmfiles fi);

rpm_color_t rpmfilesColor(rpmfiles files);

int rpmfilesCompare(rpmfiles afi, int aix, rpmfiles bfi, int bix);

const char * rpmfilesBN(rpmfiles fi, int ix);

const char * rpmfilesDN(rpmfiles fi, int jx);

int rpmfilesDI(rpmfiles fi, int ix);

char * rpmfilesFN(rpmfiles fi, int ix);

int rpmfilesODI(rpmfiles fi, int ix);

const char * rpmfilesOBN(rpmfiles fi, int ix);

const char * rpmfilesODN(rpmfiles fi, int jx);

char * rpmfilesOFN(rpmfiles fi, int ix);

rpmVerifyAttrs rpmfilesVFlags(rpmfiles fi, int ix);

rpmfileState rpmfilesFState(rpmfiles fi, int ix);

const char * rpmfilesFLink(rpmfiles fi, int ix);

rpm_loff_t rpmfilesFSize(rpmfiles fi, int ix);

rpm_color_t rpmfilesFColor(rpmfiles fi, int ix);

const char * rpmfilesFClass(rpmfiles fi, int ix);

const char * rpmfilesFMime(rpmfiles fi, int ix);

uint32_t rpmfilesFDepends(rpmfiles fi, int ix, const uint32_t ** fddictp);

uint32_t rpmfilesFNlink(rpmfiles fi, int ix);

uint32_t rpmfilesFLinks(rpmfiles fi, int ix, const int ** files);

const char * rpmfilesFLangs(rpmfiles fi, int ix);

rpmfileAttrs rpmfilesFFlags(rpmfiles fi, int ix);

rpm_mode_t rpmfilesFMode(rpmfiles fi, int ix);

const unsigned char * rpmfilesFDigest(rpmfiles fi, int ix, int *algo, size_t *len);

const unsigned char * rpmfilesFSignature(rpmfiles fi, int ix, size_t *len);

const unsigned char * rpmfilesVSignature(rpmfiles fi, int ix, size_t *len,
                     uint16_t *algo);

rpm_rdev_t rpmfilesFRdev(rpmfiles fi, int ix);

rpm_ino_t rpmfilesFInode(rpmfiles fi, int ix);

rpm_time_t rpmfilesFMtime(rpmfiles fi, int ix);

const char * rpmfilesFUser(rpmfiles fi, int ix);

const char * rpmfilesFGroup(rpmfiles fi, int ix);

const char * rpmfilesFCaps(rpmfiles fi, int ix);

int rpmfilesStat(rpmfiles fi, int ix, int flags, struct stat *sb);

rpmVerifyAttrs rpmfilesVerify(rpmfiles fi, int ix, rpmVerifyAttrs omitMask);

#ifdef __cplusplus
}
#endif

#endif /* _RPMFILES_H */