rpmio/rpmurl.h

Go to the documentation of this file.

#ifndef H_RPMURL
#define H_RPMURL

#include <assert.h>

typedef enum urltype_e {
    URL_IS_UNKNOWN      = 0,    
    URL_IS_DASH         = 1,    
    URL_IS_PATH         = 2,    
    URL_IS_FTP          = 3,    
    URL_IS_HTTP         = 4,    
    URL_IS_HTTPS        = 5,    
    URL_IS_HKP          = 6     
} urltype;

#define URLMAGIC        0xd00b1ed0
#define URLSANE(u)      assert(u && u->magic == URLMAGIC)

typedef /*@abstract@*/ /*@refcounted@*/ struct urlinfo_s * urlinfo;

struct urlinfo_s {
/*@refs@*/ int nrefs;           
/*@owned@*/ /*@relnull@*/
    const char * url;           
/*@owned@*/ /*@relnull@*/
    const char * scheme;        
/*@owned@*/ /*@null@*/
    const char * user;          
/*@owned@*/ /*@null@*/
    const char * password;      
/*@owned@*/ /*@relnull@*/
    const char * host;          
/*@owned@*/ /*@null@*/
    const char * portstr;       
/*@owned@*/ /*@null@*/
    const char * proxyu;        
/*@owned@*/ /*@null@*/
    const char * proxyh;        
    int proxyp;                 
    int port;                   
    int urltype;                
    FD_t ctrl;                  
    FD_t data;                  
/*@relnull@*/
    void * capabilities;        
/*@relnull@*/
    void * lockstore;           
/*@relnull@*/
    void * sess;                
    off_t current;              
    off_t total;                
    int connstatus;             
#ifdef  REFERENCE
typedef enum {
    ne_conn_namelookup, /* lookup up hostname (info = hostname) */
    ne_conn_connecting, /* connecting to host (info = hostname) */
    ne_conn_connected,  /* connected to host (info = hostname) */
    ne_conn_secure      /* connection now secure (info = crypto level) */
} ne_conn_status;
#endif

    int bufAlloced;             
/*@owned@*/
    char * buf;                 
    int openError;              
    int httpVersion;
    int httpHasRange;
    int magic;
};

#ifdef __cplusplus
extern "C" {
#endif

/*@unchecked@*/
extern int _url_count;          
/*@unchecked@*/
/*@only@*/ /*@null@*/
extern urlinfo * _url_cache;    
/*@unchecked@*/
extern int _url_iobuf_size;     
#define RPMURL_IOBUF_SIZE       4096

/*@unchecked@*/
extern int _url_debug;          
#define RPMURL_DEBUG_IO         0x40000000
#define RPMURL_DEBUG_REFS       0x20000000


/*@unused@*/ urlinfo    urlNew(const char * msg)        /*@*/;

urlinfo XurlNew(const char * msg, const char * file, unsigned line)     /*@*/;
#define urlNew(_msg) XurlNew(_msg, __FILE__, __LINE__)

/*@unused@*/ urlinfo    urlLink(urlinfo u, const char * msg)
        /*@modifies u @*/;

urlinfo XurlLink(urlinfo u, const char * msg, const char * file, unsigned line)
        /*@modifies u @*/;
#define urlLink(_u, _msg) XurlLink(_u, _msg, __FILE__, __LINE__)

/*@unused@*/ urlinfo    urlFree( /*@killref@*/ urlinfo u, const char * msg)
        /*@globals fileSystem, internalState @*/
        /*@modifies u, fileSystem, internalState @*/;

urlinfo XurlFree( /*@killref@*/ urlinfo u, const char * msg,
                const char * file, unsigned line)
        /*@globals fileSystem, internalState @*/
        /*@modifies u, fileSystem, internalState @*/;
#define urlFree(_u, _msg) XurlFree(_u, _msg, __FILE__, __LINE__)

void urlFreeCache(void)
        /*@globals _url_cache, _url_count, fileSystem, internalState @*/
        /*@modifies _url_cache, _url_count, fileSystem, internalState @*/;

urltype urlIsURL(const char * url)
        /*@*/;

/*@-incondefs@*/
urltype urlPath(const char * url, /*@out@*/ const char ** pathp)
        /*@ensures maxSet(*pathp) == 0 /\ maxRead(*pathp) == 0 @*/
        /*@modifies *pathp @*/;
/*@=incondefs@*/

int urlSplit(const char * url, /*@out@*/ urlinfo * uret)
        /*@globals h_errno, internalState @*/
        /*@modifies *uret, internalState @*/;

int urlGetFile(const char * url, /*@null@*/ const char * dest)
        /*@globals h_errno, fileSystem, internalState @*/
        /*@modifies fileSystem, internalState @*/;

#ifdef __cplusplus
}
#endif

#endif  /* H_RPMURL */

---