handle.h

/* librepo - A library providing (libcURL like) API to downloading repository
 * Copyright (C) 2012  Tomas Mlcoch
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
 
#ifndef __LR_HANDLE_H__
#define __LR_HANDLE_H__
 
#include <glib.h>
#include <gio/gio.h>
 
#include <librepo/result.h>
 
G_BEGIN_DECLS


typedef struct _LrHandle LrHandle;
 
#if 0
#define LRO_SUPPORTS_CACHEDIR
#endif /* 0 */

#define LRO_FASTESTMIRRORMAXAGE_DEFAULT     2592000L // 30 days

#define LRO_FASTESTMIRRORMAXAGE_MIN         0L

#define LRO_PROXYPORT_DEFAULT               1080L

#define LRO_PROXYTYPE_DEFAULT               LR_PROXY_HTTP

#define LRO_MAXSPEED_DEFAULT                G_GINT64_CONSTANT(0)

#define LRO_CONNECTTIMEOUT_DEFAULT          30L

#define LRO_MAXMIRRORTRIES_DEFAULT          0L

#define LRO_MAXMIRRORTRIES_MIN              0L

#define LRO_MAXPARALLELDOWNLOADS_DEFAULT    3L

#define LRO_MAXPARALLELDOWNLOADS_MIN        1L

#define LRO_MAXPARALLELDOWNLOADS_MAX        20L

#define LRO_MAXDOWNLOADSPERMIRROR_DEFAULT   3L

#define LRO_MAXDOWNLOADSPERMIRROR_MIN       1L

#define LRO_LOWSPEEDTIME_MIN                0L

#define LRO_LOWSPEEDTIME_DEFAULT            30L

#define LRO_LOWSPEEDLIMIT_MIN               0L

#define LRO_LOWSPEEDLIMIT_DEFAULT           1000L

#define LRO_IPRESOLVE_DEFAULT               LR_IPRESOLVE_WHATEVER

#define LRO_ALLOWEDMIRRORFAILURES_DEFAULT   4L

#define LRO_ADAPTIVEMIRRORSORTING_DEFAULT   1L

#define LRO_GNUPGHOMEDIR_DEFAULT            NULL

#define LRO_FASTESTMIRRORTIMEOUT_DEFAULT    2.0

#define LRO_OFFLINE_DEFAULT                 0L

#define LRO_HTTPAUTHMETHODS_DEFAULT         LR_AUTH_BASIC

#define LRO_PROXYAUTHMETHODS_DEFAULT        LR_AUTH_BASIC

#define LRO_FTPUSEEPSV_DEFAULT              1L
 

typedef enum {
 
    LRO_UPDATE,  
 
    LRO_URLS,  
 
    LRO_MIRRORLIST,  
 
    LRO_MIRRORLISTURL, 
 
    LRO_METALINKURL, 
 
    LRO_LOCAL,  
 
    LRO_HTTPAUTH,  
 
    LRO_USERPWD,  
 
    LRO_PROXY,  
 
    LRO_PROXYPORT,  
 
    LRO_PROXYTYPE,  
 
    LRO_PROXYAUTH,  
 
    LRO_PROXYUSERPWD,  
 
    LRO_PROGRESSCB,  
 
    LRO_PROGRESSDATA,  
 
    LRO_MAXSPEED,  
 
    LRO_DESTDIR,  
 
    LRO_REPOTYPE,  
 
    LRO_CONNECTTIMEOUT,  
 
    LRO_IGNOREMISSING,  
 
    LRO_INTERRUPTIBLE,  
 
    LRO_USERAGENT,  
 
    LRO_FETCHMIRRORS,  
 
    LRO_MAXMIRRORTRIES,  
 
    LRO_MAXPARALLELDOWNLOADS,  
 
    LRO_MAXDOWNLOADSPERMIRROR,  
 
    LRO_VARSUB,  
 
    LRO_FASTESTMIRROR, 
 
    LRO_FASTESTMIRRORCACHE, 
 
    LRO_FASTESTMIRRORMAXAGE, /*< (long)
        Maximum age of a record in cache (seconds).
        Default: 2592000 (30 days). */
 
    LRO_FASTESTMIRRORCB, /* (LrFastestMirrorCb)
        Fastest mirror status callback */
 
    LRO_FASTESTMIRRORDATA, /* (void *)
        User data for LRO_FASTESTMIRRORCB */
 
    LRO_LOWSPEEDTIME, /*< (long)
        The time in seconds that the transfer should be below the
        LRO_LOWSPEEDLIMIT for the library to consider it too slow
        and abort. */
 
    LRO_LOWSPEEDLIMIT, /*< (long)
        The transfer speed in bytes per second that the transfer
        should be below during LRO_LOWSPEEDTIME seconds for
        the library to consider it too slow and abort. */
 
    /* Repo common options */
 
    LRO_GPGCHECK,   
 
    LRO_CHECKSUM,  
 
    /* LR_YUMREPO specific options */
 
    LRO_YUMDLIST,  
 
    LRO_RPMMDDLIST = LRO_YUMDLIST,
 
    LRO_YUMBLIST,  
 
    LRO_RPMMDBLIST = LRO_YUMBLIST,
 
    LRO_HMFCB, 
 
    LRO_SSLVERIFYPEER, 
 
    LRO_SSLVERIFYHOST, 
 
    LRO_IPRESOLVE, 
 
    LRO_ALLOWEDMIRRORFAILURES, 
 
    LRO_ADAPTIVEMIRRORSORTING, 
 
    LRO_GNUPGHOMEDIR, 
 
    LRO_FASTESTMIRRORTIMEOUT, 
 
    LRO_HTTPHEADER, 
 
    LRO_OFFLINE, 
 
    LRO_SSLCLIENTCERT, 
 
    LRO_SSLCLIENTKEY, 
 
    LRO_SSLCACERT, 
 
    LRO_HTTPAUTHMETHODS, 
 
    LRO_PROXYAUTHMETHODS, 
 
    LRO_FTPUSEEPSV, 
 
    LRO_YUMSLIST, 
 
    LRO_CACHEDIR, 
 
    LRO_PRESERVETIME, 
 
    LRO_ONETIMEFLAG, 
 
    LRO_SSLVERIFYSTATUS, 
 
    LRO_PROXY_SSLVERIFYPEER, 
 
    LRO_PROXY_SSLVERIFYHOST, 
 
    LRO_PROXY_SSLCLIENTCERT, 
 
    LRO_PROXY_SSLCLIENTKEY, 
 
    LRO_PROXY_SSLCACERT, 
 
    LRO_USERNAME,  
 
    LRO_PASSWORD,  
 
    LRO_SENTINEL,    
 
} LrHandleOption; 

typedef enum {
    LRI_UPDATE,                 
    LRI_URLS,                   
    LRI_MIRRORLIST,             
    LRI_MIRRORLISTURL,          
    LRI_METALINKURL,            
    LRI_LOCAL,                  
    LRI_PROGRESSCB,             
    LRI_PROGRESSDATA,           
    LRI_DESTDIR,                
    LRI_REPOTYPE,               
    LRI_USERAGENT,              
    LRI_YUMDLIST,               
    LRI_RPMMDDLIST = LRI_YUMDLIST,
    LRI_YUMBLIST,               
    LRI_RPMMDBLIST = LRI_YUMBLIST,
    LRI_FETCHMIRRORS,           
    LRI_MAXMIRRORTRIES,         
    LRI_VARSUB,                 
    LRI_MIRRORS,                
    LRI_METALINK,               
    LRI_FASTESTMIRROR,          
    LRI_FASTESTMIRRORCACHE,     
    LRI_FASTESTMIRRORMAXAGE,    
    LRI_HMFCB,                  
    LRI_SSLVERIFYPEER,          
    LRI_SSLVERIFYHOST,          
    LRI_IPRESOLVE,              
    LRI_ALLOWEDMIRRORFAILURES,  
    LRI_ADAPTIVEMIRRORSORTING,  
    LRI_GNUPGHOMEDIR,           
    LRI_FASTESTMIRRORTIMEOUT,   
    LRI_HTTPHEADER,             
    LRI_OFFLINE,                
    LRI_SSLCLIENTCERT,          
    LRI_SSLCLIENTKEY,           
    LRI_SSLCACERT,              
    LRI_LOWSPEEDTIME,           
    LRI_LOWSPEEDLIMIT,          
    LRI_HTTPAUTHMETHODS,        
    LRI_PROXYAUTHMETHODS,       
    LRI_FTPUSEEPSV,             
    LRI_YUMSLIST,               
    LRI_CACHEDIR,               
    LRI_SSLVERIFYSTATUS,        
 
    LRI_PROXY_SSLVERIFYPEER,    
    LRI_PROXY_SSLVERIFYHOST,    
    LRI_PROXY_SSLCLIENTCERT,    
    LRI_PROXY_SSLCLIENTKEY,     
    LRI_PROXY_SSLCACERT,        
 
    LRI_SENTINEL,
} LrHandleInfoOption; 

LrHandle *
lr_handle_init(void);

void
lr_handle_free(LrHandle *handle);

gboolean
lr_handle_setopt(LrHandle *handle,
                 GError **err,
                 LrHandleOption option,
                 ...);

gboolean
lr_handle_getinfo(LrHandle *handle,
                  GError **err,
                  LrHandleInfoOption option,
                  ...);

gboolean
lr_handle_perform(LrHandle *handle, LrResult *result, GError **err);

gboolean
lr_handle_network_wait(LrHandle *handle, GError **err, guint seconds, GCancellable *cancellable);

 
G_END_DECLS
 
#endif