src/download.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  * Copyright (C) 2007, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22
  23 #ifndef _VIKING_DOWNLOAD_H
  24 #define _VIKING_DOWNLOAD_H
  25
  26 #include <stdio.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /* File content check */
  31 typedef gboolean (*VikFileContentCheckerFunc) (FILE*);
  32 gboolean a_check_map_file(FILE*);
  33 gboolean a_check_html_file(FILE*);
  34 gboolean a_check_kml_file(FILE*);
  35
  36 typedef struct {
  37   /**
  38    * Check if the server has a more recent file than the one we have before downloading it
  39    * This uses http header If-Modified-Since
  40    */
  41   gboolean check_file_server_time;
  42
  43   /**
  44    * Set if the server handle ETag
  45    */
  46   gboolean use_etag;
  47
  48   /**
  49    * The REFERER string to use.
  50    * Could be NULL.
  51    */
  52   gchar *referer;
  53
  54   /**
  55    * follow_location specifies the number of retries
  56    * to follow a redirect while downloading a page.
  57    */
  58   glong follow_location;
  59
  60   /**
  61    * File content checker.
  62    */
  63   VikFileContentCheckerFunc check_file;
  64
  65   /**
  66    * If need to authenticate on download
  67    *  format: 'username:password'
  68    */
  69   gchar *user_pass;
  70
  71 } DownloadMapOptions;
  72
  73 typedef struct {
  74   /**
  75    * Time sent to server on header If-Modified-Since
  76    */
  77   time_t time_condition;
  78   /**
  79    * Etag sent by server on previous download
  80    */
  81   char *etag;
  82   /**
  83    * Etag sent by server on this download
  84    */
  85   char *new_etag;
  86
  87 } DownloadFileOptions;
  88
  89 void a_download_init(void);
  90
  91 /* TODO: convert to Glib */
  92 int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle );
  93 int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadMapOptions *opt, void *handle );
  94 void *a_download_handle_init ();
  95 void a_download_handle_cleanup ( void *handle );
  96
  97 gchar *a_download_uri_to_tmp_file ( const gchar *uri, DownloadMapOptions *options );
  98
  99 /* Error messages returned by download functions */
 100 enum { DOWNLOAD_NO_ERROR = 0,
 101        DOWNLOAD_NO_NEWER_FILE,
 102        DOWNLOAD_ERROR };
 103
 104 G_END_DECLS
 105
 106 #endif