src/fs/fs_dirmetascan.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2005-2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file fs/fs_dirmetascan.c
  23  * @brief code to asynchronously build a 'struct GNUNET_FS_ShareTreeItem'
  24  *        from an on-disk directory for publishing; use the 'gnunet-helper-fs-publish'.
  25  * @author LRN
  26  * @author Christian Grothoff
  27  */
  28 #include "platform.h"
  29 #include "gnunet_fs_service.h"
  30 #include "gnunet_scheduler_lib.h"
  31 #include <pthread.h>
  32
  33
  34 /**
  35  * An opaque structure a pointer to which is returned to the
  36  * caller to be used to control the scanner.
  37  */
  38 struct GNUNET_FS_DirScanner
  39 {
  40
  41   /**
  42    * Helper process.
  43    */
  44   struct GNUNET_HELPER_Handle *helper;
  45
  46   /**
  47    * Expanded filename (as given by the scan initiator).
  48    * The scanner thread stores a copy here, and frees it when it finishes.
  49    */
  50   char *filename_expanded;
  51
  52   /**
  53    * Second argument to helper process.
  54    */
  55   char *ex_arg;
  56
  57   /**
  58    * The function that will be called every time there's a progress
  59    * message.
  60    */
  61   GNUNET_FS_DirScannerProgressCallback progress_callback;
  62
  63   /**
  64    * A closure for progress_callback.
  65    */
  66   void *progress_callback_cls;
  67
  68   /**
  69    * After the scan is finished, it will contain a pointer to the
  70    * top-level directory entry in the directory tree built by the
  71    * scanner.
  72    */
  73   struct GNUNET_FS_ShareTreeItem *toplevel;
  74
  75   /**
  76    * Current position during processing.
  77    */
  78   struct GNUNET_FS_ShareTreeItem *pos;
  79
  80   /**
  81    * Task scheduled when we are done.
  82    */
  83   GNUNET_SCHEDULER_TaskIdentifier stop_task;
  84
  85   /**
  86    * Arguments for helper.
  87    */
  88   char *args[4];
  89
  90 };
  91
  92
  93
  94 /**
  95  * Abort the scan.  Must not be called from within the progress_callback
  96  * function.
  97  *
  98  * @param ds directory scanner structure
  99  */
 100 void
 101 GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds)
 102 {
 103   /* terminate helper */
 104   if (NULL != ds->helper)
 105     GNUNET_HELPER_stop (ds->helper);
 106
 107   /* free resources */
 108   if (NULL != ds->toplevel)
 109     GNUNET_FS_share_tree_free (ds->toplevel);
 110   if (GNUNET_SCHEDULER_NO_TASK != ds->stop_task)
 111     GNUNET_SCHEDULER_cancel (ds->stop_task);
 112   GNUNET_free_non_null (ds->ex_arg);
 113   GNUNET_free (ds->filename_expanded);
 114   GNUNET_free (ds);
 115 }
 116
 117
 118 /**
 119  * Obtain the result of the scan after the scan has signalled
 120  * completion.  Must not be called prior to completion.  The 'ds' is
 121  * freed as part of this call.
 122  *
 123  * @param ds directory scanner structure
 124  * @return the results of the scan (a directory tree)
 125  */
 126 struct GNUNET_FS_ShareTreeItem *
 127 GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds)
 128 {
 129   struct GNUNET_FS_ShareTreeItem *result;
 130
 131   /* check that we're actually done */
 132   GNUNET_assert (NULL == ds->helper);
 133   /* preserve result */
 134   result = ds->toplevel;
 135   ds->toplevel = NULL;
 136   GNUNET_FS_directory_scan_abort (ds);
 137   return result;
 138 }
 139
 140
 141 /**
 142  * Move in the directory from the given position to the next file
 143  * in DFS traversal.
 144  *
 145  * @param pos current position
 146  * @return next file, NULL for none
 147  */
 148 static struct GNUNET_FS_ShareTreeItem *
 149 advance (struct GNUNET_FS_ShareTreeItem *pos)
 150 {
 151   int moved;
 152
 153   GNUNET_assert (NULL != pos);
 154   moved = 0; /* must not terminate, even on file, otherwise "normal" */
 155   while ( (pos->is_directory == GNUNET_YES) ||
 156           (0 == moved) )
 157   {
 158     if ( (moved != -1) &&
 159          (NULL != pos->children_head) )
 160     {
 161       pos = pos->children_head;
 162       moved = 1; /* can terminate if file */
 163       continue;
 164     }
 165     if (NULL != pos->next)
 166     {
 167       pos = pos->next;
 168       moved = 1; /* can terminate if file */
 169       continue;
 170     }
 171     if (NULL != pos->parent)
 172     {
 173       pos = pos->parent;
 174       moved = -1; /* force move to 'next' or 'parent' */
 175       continue;
 176     }
 177     /* no more options, end of traversal */
 178     return NULL;
 179   }
 180   return pos;
 181 }
 182
 183
 184 /**
 185  * Add another child node to the tree.
 186  *
 187  * @param parent parent of the child, NULL for top level
 188  * @param filename name of the file or directory
 189  * @param is_directory GNUNET_YES for directories
 190  * @return new entry that was just created
 191  */
 192 static struct GNUNET_FS_ShareTreeItem *
 193 expand_tree (struct GNUNET_FS_ShareTreeItem *parent,
 194              const char *filename,
 195              int is_directory)
 196 {
 197   struct GNUNET_FS_ShareTreeItem *chld;
 198   size_t slen;
 199
 200   chld = GNUNET_malloc (sizeof (struct GNUNET_FS_ShareTreeItem));
 201   chld->parent = parent;
 202   chld->filename = GNUNET_strdup (filename);
 203   GNUNET_asprintf (&chld->short_filename,
 204                    "%s%s",
 205                    GNUNET_STRINGS_get_short_name (filename),
 206                    is_directory == GNUNET_YES ? "/" : "");
 207   /* make sure we do not end with '//' */
 208   slen = strlen (chld->short_filename);
 209   if ( (slen >= 2) &&
 210        (chld->short_filename[slen-1] == '/') &&
 211        (chld->short_filename[slen-2] == '/') )
 212     chld->short_filename[slen-1] = '\0';
 213   chld->is_directory = is_directory;
 214   if (NULL != parent)
 215       GNUNET_CONTAINER_DLL_insert (parent->children_head,
 216                                    parent->children_tail,
 217                                    chld);
 218   return chld;
 219 }
 220
 221
 222 /**
 223  * Task run last to shut everything down.
 224  *
 225  * @param cls the 'struct GNUNET_FS_DirScanner'
 226  * @param tc unused
 227  */
 228 static void
 229 finish_scan (void *cls,
 230              const struct GNUNET_SCHEDULER_TaskContext *tc)
 231 {
 232   struct GNUNET_FS_DirScanner *ds = cls;
 233
 234   ds->stop_task = GNUNET_SCHEDULER_NO_TASK;
 235   GNUNET_HELPER_stop (ds->helper);
 236   ds->helper = NULL;
 237   ds->progress_callback (ds->progress_callback_cls,
 238                          NULL, GNUNET_SYSERR,
 239                          GNUNET_FS_DIRSCANNER_FINISHED);
 240 }
 241
 242
 243 /**
 244  * Called every time there is data to read from the scanner.
 245  * Calls the scanner progress handler.
 246  *
 247  * @param cls the closure (directory scanner object)
 248  * @param client always NULL
 249  * @param msg message from the helper process
 250  */
 251 static int
 252 process_helper_msgs (void *cls,
 253                      void *client,
 254                      const struct GNUNET_MessageHeader *msg)
 255 {
 256   struct GNUNET_FS_DirScanner *ds = cls;
 257   const char *filename;
 258   size_t left;
 259
 260 #if 0
 261   fprintf (stderr, "DMS parses %u-byte message of type %u\n",
 262            (unsigned int) ntohs (msg->size),
 263            (unsigned int) ntohs (msg->type));
 264 #endif
 265   left = ntohs (msg->size) - sizeof (struct GNUNET_MessageHeader);
 266   filename = (const char*) &msg[1];
 267   switch (ntohs (msg->type))
 268   {
 269   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_FILE:
 270     if (filename[left-1] != '\0')
 271     {
 272       GNUNET_break (0);
 273       break;
 274     }
 275     ds->progress_callback (ds->progress_callback_cls,
 276                            filename, GNUNET_NO,
 277                            GNUNET_FS_DIRSCANNER_FILE_START);
 278     if (NULL == ds->toplevel)
 279       ds->toplevel = expand_tree (ds->pos,
 280                                   filename, GNUNET_NO);
 281     else
 282       (void) expand_tree (ds->pos,
 283                           filename, GNUNET_NO);
 284     return GNUNET_OK;
 285   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_DIRECTORY:
 286     if (filename[left-1] != '\0')
 287     {
 288       GNUNET_break (0);
 289       break;
 290     }
 291     if (0 == strcmp ("..", filename))
 292     {
 293       if (NULL == ds->pos)
 294       {
 295         GNUNET_break (0);
 296         break;
 297       }
 298       ds->pos = ds->pos->parent;
 299       return GNUNET_OK;
 300     }
 301     ds->progress_callback (ds->progress_callback_cls,
 302                            filename, GNUNET_YES,
 303                            GNUNET_FS_DIRSCANNER_FILE_START);
 304     ds->pos = expand_tree (ds->pos,
 305                            filename, GNUNET_YES);
 306     if (NULL == ds->toplevel)
 307       ds->toplevel = ds->pos;
 308     return GNUNET_OK;
 309   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_ERROR:
 310     break;
 311   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_SKIP_FILE:
 312     if ('\0' != filename[left-1])
 313       break;
 314     ds->progress_callback (ds->progress_callback_cls,
 315                            filename, GNUNET_SYSERR,
 316                            GNUNET_FS_DIRSCANNER_FILE_IGNORED);
 317     return GNUNET_OK;
 318   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_COUNTING_DONE:
 319     if (0 != left)
 320     {
 321       GNUNET_break (0);
 322       break;
 323     }
 324     if (NULL == ds->toplevel)
 325     {
 326       GNUNET_break (0);
 327       break;
 328     }
 329     ds->progress_callback (ds->progress_callback_cls,
 330                            NULL, GNUNET_SYSERR,
 331                            GNUNET_FS_DIRSCANNER_ALL_COUNTED);
 332     ds->pos = ds->toplevel;
 333     if (GNUNET_YES == ds->pos->is_directory)
 334       ds->pos = advance (ds->pos);
 335     return GNUNET_OK;
 336   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_META_DATA:
 337     {
 338       size_t nlen;
 339       const char *end;
 340
 341       if (NULL == ds->pos)
 342       {
 343         GNUNET_break (0);
 344         break;
 345       }
 346       end = memchr (filename, 0, left);
 347       if (NULL == end)
 348       {
 349         GNUNET_break (0);
 350         break;
 351       }
 352       end++;
 353       nlen = end - filename;
 354       left -= nlen;
 355       if (0 != strcmp (filename,
 356                        ds->pos->filename))
 357       {
 358         GNUNET_break (0);
 359         break;
 360       }
 361       ds->progress_callback (ds->progress_callback_cls,
 362                              filename, GNUNET_YES,
 363                              GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED);
 364       if (0 < left)
 365       {
 366         ds->pos->meta = GNUNET_CONTAINER_meta_data_deserialize (end, left);
 367         if (NULL == ds->pos->meta)
 368         {
 369           GNUNET_break (0);
 370           break;
 371         }
 372         /* having full filenames is too dangerous; always make sure we clean them up */
 373         GNUNET_CONTAINER_meta_data_delete (ds->pos->meta,
 374                                            EXTRACTOR_METATYPE_FILENAME,
 375                                            NULL, 0);
 376         /* instead, put in our 'safer' original filename */
 377         GNUNET_CONTAINER_meta_data_insert (ds->pos->meta, "<libgnunetfs>",
 378                                            EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
 379                                            EXTRACTOR_METAFORMAT_UTF8, "text/plain",
 380                                            ds->pos->short_filename,
 381                                            strlen (ds->pos->short_filename) + 1);
 382       }
 383       ds->pos->ksk_uri = GNUNET_FS_uri_ksk_create_from_meta_data (ds->pos->meta);
 384       ds->pos = advance (ds->pos);
 385       return GNUNET_OK;
 386     }
 387   case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_FINISHED:
 388     if (NULL != ds->pos)
 389     {
 390       GNUNET_break (0);
 391       break;
 392     }
 393     if (0 != left)
 394     {
 395       GNUNET_break (0);
 396       break;
 397     }
 398     if (NULL == ds->toplevel)
 399     {
 400       GNUNET_break (0);
 401       break;
 402     }
 403     ds->stop_task = GNUNET_SCHEDULER_add_now (&finish_scan,
 404                                               ds);
 405     return GNUNET_OK;
 406   default:
 407     GNUNET_break (0);
 408     break;
 409   }
 410   ds->progress_callback (ds->progress_callback_cls,
 411                          NULL, GNUNET_SYSERR,
 412                          GNUNET_FS_DIRSCANNER_INTERNAL_ERROR);
 413   return GNUNET_OK;
 414 }
 415
 416
 417 /**
 418  * Start a directory scanner thread.
 419  *
 420  * @param filename name of the directory to scan
 421  * @param disable_extractor GNUNET_YES to not to run libextractor on files (only build a tree)
 422  * @param ex if not NULL, must be a list of extra plugins for extractor
 423  * @param cb the callback to call when there are scanning progress messages
 424  * @param cb_cls closure for 'cb'
 425  * @return directory scanner object to be used for controlling the scanner
 426  */
 427 struct GNUNET_FS_DirScanner *
 428 GNUNET_FS_directory_scan_start (const char *filename,
 429                                 int disable_extractor, const char *ex,
 430                                 GNUNET_FS_DirScannerProgressCallback cb,
 431                                 void *cb_cls)
 432 {
 433   struct stat sbuf;
 434   char *filename_expanded;
 435   struct GNUNET_FS_DirScanner *ds;
 436
 437   if (0 != STAT (filename, &sbuf))
 438     return NULL;
 439   filename_expanded = GNUNET_STRINGS_filename_expand (filename);
 440   if (NULL == filename_expanded)
 441     return NULL;
 442   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 443               "Starting to scan directory `%s'\n",
 444               filename_expanded);
 445   ds = GNUNET_malloc (sizeof (struct GNUNET_FS_DirScanner));
 446   ds->progress_callback = cb;
 447   ds->progress_callback_cls = cb_cls;
 448   ds->filename_expanded = filename_expanded;
 449   if (disable_extractor)
 450     ds->ex_arg = GNUNET_strdup ("-");
 451   else
 452     ds->ex_arg = (NULL != ex) ? GNUNET_strdup (ex) : NULL;
 453   ds->args[0] = "gnunet-helper-fs-publish";
 454   ds->args[1] = ds->filename_expanded;
 455   ds->args[2] = ds->ex_arg;
 456   ds->args[3] = NULL;
 457   ds->helper = GNUNET_HELPER_start ("gnunet-helper-fs-publish",
 458                                     ds->args,
 459                                     &process_helper_msgs,
 460                                     ds);
 461   if (NULL == ds->helper)
 462   {
 463     GNUNET_free (filename_expanded);
 464     GNUNET_free (ds);
 465     return NULL;
 466   }
 467   return ds;
 468 }
 469
 470
 471 /* end of fs_dirmetascan.c */