src/fs/gnunet-unindex.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20 /**
  21  * @file fs/gnunet-unindex.c
  22  * @brief unindex files published on GNUnet
  23  * @author Christian Grothoff
  24  * @author Krista Bennett
  25  * @author James Blackwell
  26  * @author Igor Wronsky
  27  */
  28 #include "platform.h"
  29 #include "gnunet_fs_service.h"
  30
  31 static int ret;
  32
  33 static unsigned int verbose;
  34
  35 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  36
  37 static struct GNUNET_FS_Handle *ctx;
  38
  39 static struct GNUNET_FS_UnindexContext *uc;
  40
  41
  42 static void
  43 cleanup_task (void *cls)
  44 {
  45   GNUNET_FS_stop (ctx);
  46   ctx = NULL;
  47 }
  48
  49
  50 static void
  51 shutdown_task (void *cls)
  52 {
  53   struct GNUNET_FS_UnindexContext *u;
  54
  55   if (uc != NULL)
  56   {
  57     u = uc;
  58     uc = NULL;
  59     GNUNET_FS_unindex_stop (u);
  60   }
  61 }
  62
  63 /**
  64  * Called by FS client to give information about the progress of an
  65  * operation.
  66  *
  67  * @param cls closure
  68  * @param info details about the event, specifying the event type
  69  *        and various bits about the event
  70  * @return client-context (for the next progress call
  71  *         for this operation; should be set to NULL for
  72  *         SUSPEND and STOPPED events).  The value returned
  73  *         will be passed to future callbacks in the respective
  74  *         field in the GNUNET_FS_ProgressInfo struct.
  75  */
  76 static void *
  77 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
  78 {
  79   const char *s;
  80
  81   switch (info->status)
  82   {
  83   case GNUNET_FS_STATUS_UNINDEX_START:
  84     break;
  85   case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
  86     if (verbose)
  87     {
  88       s = GNUNET_STRINGS_relative_time_to_string (info->value.unindex.eta, GNUNET_YES);
  89       FPRINTF (stdout, _("Unindexing at %llu/%llu (%s remaining)\n"),
  90                (unsigned long long) info->value.unindex.completed,
  91                (unsigned long long) info->value.unindex.size, s);
  92     }
  93     break;
  94   case GNUNET_FS_STATUS_UNINDEX_ERROR:
  95     FPRINTF (stderr, _("Error unindexing: %s.\n"),
  96              info->value.unindex.specifics.error.message);
  97     GNUNET_SCHEDULER_shutdown ();
  98     break;
  99   case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
 100     FPRINTF (stdout, "%s",  _("Unindexing done.\n"));
 101     GNUNET_SCHEDULER_shutdown ();
 102     break;
 103   case GNUNET_FS_STATUS_UNINDEX_STOPPED:
 104     GNUNET_SCHEDULER_add_now (&cleanup_task, NULL);
 105     break;
 106   default:
 107     FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
 108     break;
 109   }
 110   return NULL;
 111 }
 112
 113
 114 /**
 115  * Main function that will be run by the scheduler.
 116  *
 117  * @param cls closure
 118  * @param args remaining command-line arguments
 119  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 120  * @param c configuration
 121  */
 122 static void
 123 run (void *cls, char *const *args, const char *cfgfile,
 124      const struct GNUNET_CONFIGURATION_Handle *c)
 125 {
 126   /* check arguments */
 127   if ((args[0] == NULL) || (args[1] != NULL))
 128   {
 129     printf (_("You must specify one and only one filename for unindexing.\n"));
 130     ret = -1;
 131     return;
 132   }
 133   cfg = c;
 134   ctx =
 135       GNUNET_FS_start (cfg, "gnunet-unindex", &progress_cb, NULL,
 136                        GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
 137   if (NULL == ctx)
 138   {
 139     FPRINTF (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
 140     ret = 1;
 141     return;
 142   }
 143   uc = GNUNET_FS_unindex_start (ctx, args[0], NULL);
 144   if (NULL == uc)
 145   {
 146     FPRINTF (stderr, "%s",  _("Could not start unindex operation.\n"));
 147     GNUNET_FS_stop (ctx);
 148     return;
 149   }
 150   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
 151                                  NULL);
 152 }
 153
 154
 155 /**
 156  * The main function to unindex content.
 157  *
 158  * @param argc number of arguments from the command line
 159  * @param argv command line arguments
 160  * @return 0 ok, 1 on error
 161  */
 162 int
 163 main (int argc, char *const *argv)
 164 {
 165   struct GNUNET_GETOPT_CommandLineOption options[] = {
 166
 167     GNUNET_GETOPT_option_verbose (&verbose),
 168
 169     GNUNET_GETOPT_OPTION_END
 170   };
 171
 172   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 173     return 2;
 174
 175   ret = (GNUNET_OK ==
 176          GNUNET_PROGRAM_run (argc, argv, "gnunet-unindex [OPTIONS] FILENAME",
 177                              gettext_noop
 178                              ("Unindex a file that was previously indexed with gnunet-publish."),
 179                              options, &run, NULL)) ? ret : 1;
 180   GNUNET_free ((void*) argv);
 181   return ret;
 182 }
 183
 184 /* end of gnunet-unindex.c */