/*
     This file is part of GNUnet.
     (C) 2010 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 2, or (at your
     option) any later version.

     GNUnet 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
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file src/fs/gnunet-fs-gtk_download-save-as.h
 * @brief functions for downloading
 * @author Christian Grothoff
 */
#ifndef GNUNET_FS_GTK_DOWNLOAD_SAVE_AS_H
#define GNUNET_FS_GTK_DOWNLOAD_SAVE_AS_H

#include "gnunet-fs-gtk_common.h"


/**
 * Information we keep for a download.
 */
struct DownloadContext;


/**
 * Information we keep for a download.
 */
struct DownloadContext
{
  /**
   * URI for the download.
   */
  struct GNUNET_FS_Uri *uri;

  /**
   * Meta data.
   */
  struct GNUNET_CONTAINER_MetaData *meta;

  /**
   * Mime type.
   */
  char *mime;

  /**
   * Suggested filename, or NULL.
   */
  char *filename;

  /**
   * Row reference (if URI was found by search, or
   * part of directory, etc.); otherwise NULL (download by URI).
   */
  GtkTreeRowReference *rr;

  /**
   * Associated search result, or NULL.
   */
  struct GNUNET_FS_SearchResult *sr;

  /**
   * Is this a recursive download?
   */
  int is_recursive;

  /**
   * Desired (default) anonymity level.
   */
  int anonymity;

  /**
   * Tab where this download is currently on display.
   * (this is the same as sr->tab, but sr is opaque here).
   */
  struct SearchTab *tab;

};


/**
 * Actually start the download that is specified by the given download
 * context and its options.  Will add a download entry to the
 * respective tree model and trigger a start of the download using the
 * FS-API.
 *
 * @param dc download context of the download to execute
 */
void
GNUNET_FS_GTK_download_context_start_download (struct DownloadContext *dc);


/**
 * Open the 'save as' dialog for a download.  Calls
 * 'GNUNET_FS_GTK_download_context_start_download' when the dialog is
 * complete.  Will release the 'dc' resources if the dialog is
 * cancelled.
 *
 * @param dc download context for the file/directory 
 */
void
GNUNET_FS_GTK_open_download_as_dialog (struct DownloadContext *dc);


#endif