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  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef _VIKING_DOWNLOAD_H
  23 #define _VIKING_DOWNLOAD_H
  24
  25 #include <stdio.h>
  26
  27 /* File content check */
  28 typedef gboolean (*VikFileContentCheckerFunc) (FILE*);
  29 gboolean a_check_map_file(FILE*);
  30 gboolean a_check_html_file(FILE*);
  31 gboolean a_check_kml_file(FILE*);
  32
  33 typedef struct {
  34   /**
  35    * Check if the server has a more recent file than the one we have before downloading it
  36    * This uses http header If-Modified-Since
  37    * Nevertheless, the current file cache must be older than the specified
  38    * value.
  39    */
  40   time_t check_file_server_time;
  41
  42   /**
  43    * The REFERER string to use.
  44    * Could be NULL.
  45    */
  46   gchar *referer;
  47
  48   /**
  49    * follow_location specifies the number of retries
  50    * to follow a redirect while downloading a page.
  51    */
  52   glong follow_location;
  53
  54   /**
  55    * File content checker.
  56    */
  57   VikFileContentCheckerFunc check_file;
  58
  59 } DownloadOptions;
  60
  61 void a_download_init(void);
  62
  63 /* TODO: convert to Glib */
  64 int a_http_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadOptions *opt, void *handle );
  65 int a_ftp_download_get_url ( const char *hostname, const char *uri, const char *fn, DownloadOptions *opt, void *handle );
  66 void *a_download_handle_init ();
  67 void a_download_handle_cleanup ( void *handle );
  68
  69 /* Error messages returned by download functions */
  70 enum { DOWNLOAD_NO_ERROR = 0,
  71        DOWNLOAD_NO_NEWER_FILE,
  72        DOWNLOAD_ERROR };
  73
  74 #endif