nucleus/library/filesystem/heavy_file_ops.cpp

   1 /*****************************************************************************\
   2 *                                                                             *
   3 *  Name   : heavy file operations                                             *
   4 *  Author : Chris Koeritz                                                     *
   5 *                                                                             *
   6 *******************************************************************************
   7 * Copyright (c) 2005-$now By Author.  This program is free software; you can  *
   8 * redistribute it and/or modify it under the terms of the GNU General Public  *
   9 * License as published by the Free Software Foundation; either version 2 of   *
  10 * the License or (at your option) any later version.  This is online at:      *
  11 *     http://www.fsf.org/copyleft/gpl.html                                    *
  12 * Please send any updates to: fred@gruntose.com                               *
  13 \*****************************************************************************/
  14
  15 #include "directory.h"
  16 #include "filename.h"
  17 #include "filename_list.h"
  18 #include "heavy_file_ops.h"
  19 #include "huge_file.h"
  20
  21 #include <basis/functions.h>
  22 #include <basis/guards.h>
  23 #include <structures/object_packers.h>
  24
  25 using namespace basis;
  26 using namespace structures;
  27
  28 namespace filesystem {
  29
  30 //#define DEBUG_HEAVY_FILE_OPS
  31   // uncomment for noisier debugging.
  32
  33 #undef LOG
  34 #include <stdio.h>
  35 #define LOG(to_print) printf("%s::%s: %s\n", static_class_name(), func, astring(to_print).s())
  36
  37 //////////////
  38
  39 // the smallest we let the packing area's available space get before we stop filling it.
  40 const int MINIMUM_ARRAY_SIZE = 1024;
  41
  42 //////////////
  43
  44 file_transfer_header::file_transfer_header(const file_time &time_stamp)
  45 : _filename(),
  46   _byte_start(0),
  47   _length(0),
  48   _time(time_stamp)
  49 {
  50 }
  51
  52 astring file_transfer_header::text_form() const
  53 {
  54   astring time_text;
  55   _time.text_form(time_text);
  56   return astring("file=") + _filename
  57       + a_sprintf(" start=%d len=%d stamp=", _byte_start, _length)
  58       + time_text;
  59 }
  60
  61 astring file_transfer_header::readable_text_form() const
  62 {
  63   astring time_text;
  64   _time.readable_text_form(time_text);
  65   return _filename
  66       + a_sprintf(" [%d bytes, mod ", _length)
  67       + time_text + "]";
  68 }
  69
  70 void file_transfer_header::pack(byte_array &packed_form) const
  71 {
  72   _filename.pack(packed_form);
  73   attach(packed_form, _byte_start);
  74   attach(packed_form, _length);
  75   _time.pack(packed_form);
  76 }
  77
  78 bool file_transfer_header::unpack(byte_array &packed_form)
  79 {
  80   if (!_filename.unpack(packed_form)) return false;
  81   if (!detach(packed_form, _byte_start)) return false;
  82   if (!detach(packed_form, _length)) return false;
  83   if (!_time.unpack(packed_form)) return false;
  84   return true;
  85 }
  86
  87 int file_transfer_header::packed_size() const
  88 {
  89 byte_array temp;
  90 attach(temp, _byte_start);
  91 //hmmm: really ugly above; we should get a more exact way to know the size of
  92 //      packed doubles.
  93   return _filename.length() + 1
  94       + temp.length()
  95       + sizeof(int)
  96       + _time.packed_size();
  97 }
  98
  99 //////////////
 100
 101 const size_t heavy_file_operations::COPY_CHUNK_FACTOR = 1 * MEGABYTE;
 102
 103 size_t heavy_file_operations::copy_chunk_factor()
 104 { return COPY_CHUNK_FACTOR; }
 105
 106 heavy_file_operations::~heavy_file_operations() {}
 107   // we only need this due to our use of the root_object class_name support.
 108
 109 const char *heavy_file_operations::outcome_name(const outcome &to_name)
 110 {
 111   switch (to_name.value()) {
 112     case SOURCE_MISSING: return "SOURCE_MISSING";
 113     case TARGET_ACCESS_ERROR: return "TARGET_ACCESS_ERROR";
 114     case TARGET_DIR_ERROR: return "TARGET_DIR_ERROR";
 115     default: return common::outcome_name(to_name);
 116   }
 117 }
 118
 119 outcome heavy_file_operations::copy_file(const astring &source,
 120     const astring &destination, int copy_chunk_factor)
 121 {
 122 #ifdef DEBUG_HEAVY_FILE_OPS
 123   FUNCDEF("copy_file");
 124 #endif
 125   // check that the source exists...
 126   filename source_path(source);
 127   if (!source_path.exists()) return SOURCE_MISSING;
 128   file_time source_time(source_path);  // get the time on the source.
 129
 130   // make sure the target directory exists...
 131   filename target_path(destination);
 132   filename targ_dir = target_path.dirname();
 133   if (!directory::recursive_create(targ_dir.raw())) return TARGET_DIR_ERROR;
 134
 135   // open the source for reading.
 136   huge_file source_file(source, "rb");
 137   if (!source_file.good()) return SOURCE_MISSING;
 138 //hmmm: could be source is not accessible instead.
 139
 140   // open target file for writing.
 141   huge_file target_file(destination, "wb");
 142   if (!target_file.good()) return TARGET_ACCESS_ERROR;
 143
 144   byte_array chunk;
 145   int bytes_read = 0;
 146   outcome ret;
 147   while ( (ret = source_file.read(chunk, copy_chunk_factor, bytes_read))
 148       == huge_file::OKAY) {
 149     int bytes_stored;
 150     ret = target_file.write(chunk, bytes_stored);
 151     if (bytes_stored != bytes_read) return TARGET_ACCESS_ERROR;
 152     if (source_file.eof()) break;  // time to escape.
 153   }
 154
 155   // set the time on the target file from the source's time.
 156   source_time.set_time(target_path);
 157
 158 #ifdef DEBUG_HEAVY_FILE_OPS
 159   astring time;
 160   source_time.text_form(time);
 161   LOG(astring("setting file time for ") + source + " to " + time);
 162 #endif
 163
 164   return OKAY;
 165 }
 166
 167 outcome heavy_file_operations::write_file_chunk(const astring &target,
 168     double byte_start, const byte_array &chunk, bool truncate,
 169     int copy_chunk_factor)
 170 {
 171   FUNCDEF("write_file_chunk");
 172   if (byte_start < 0) return BAD_INPUT;
 173
 174   filename targ_name(target);
 175   astring targ_dir = targ_name.dirname().raw();
 176 #ifdef DEBUG_HEAVY_FILE_OPS
 177   LOG(astring("creating target's directory: ") + targ_name.dirname().raw());
 178 #endif
 179   if (!directory::recursive_create(targ_dir)) {
 180     LOG(astring("failed to create directory: ") + targ_name.dirname().raw());
 181     return TARGET_DIR_ERROR;
 182   }
 183
 184   if (!targ_name.exists()) {
 185     huge_file target_file(target, "w");
 186   }
 187
 188   huge_file target_file(target, "r+b");
 189     // open the file for updating (either read or write).
 190   if (!target_file.good()) return TARGET_ACCESS_ERROR;
 191   double curr_len = target_file.length();
 192
 193   if (curr_len < byte_start) {
 194     byte_array new_chunk;
 195     while (curr_len < byte_start) {
 196       target_file.seek(0, byte_filer::FROM_END);  // go to the end of the file.
 197       new_chunk.reset(minimum(copy_chunk_factor,
 198           int(curr_len - byte_start + 1)));
 199       int written;
 200       outcome ret = target_file.write(new_chunk, written);
 201       if (written < new_chunk.length()) return TARGET_ACCESS_ERROR;
 202       curr_len = target_file.length();
 203     }
 204   }
 205   target_file.seek(byte_start, byte_filer::FROM_START);
 206     // jump to the proper location in the file.
 207   int wrote;
 208   outcome ret = target_file.write(chunk, wrote);
 209   if (wrote != chunk.length()) return TARGET_ACCESS_ERROR;
 210   if (truncate) {
 211     target_file.truncate();
 212   }
 213   return OKAY;
 214 }
 215
 216 basis::outcome heavy_file_operations::advance(const filename_list &to_transfer,
 217     file_transfer_header &last_action)
 218 {
 219   FUNCDEF("advance");
 220   int indy = to_transfer.locate(last_action._filename);
 221   if (negative(indy)) return BAD_INPUT;  // error, file not found in list.
 222   if (indy >= to_transfer.elements() - 1) return FINISHED;  // done.
 223   const file_info *currfile = to_transfer.get(indy + 1);
 224   last_action._filename = currfile->raw();
 225   last_action._time = currfile->_time;
 226
 227 #ifdef DEBUG_HEAVY_FILE_OPS
 228   if (currfile->_time == file_time(time_t(0)))
 229     LOG(astring("failed for ") + currfile->raw() + " -- has zero file time");
 230 #endif
 231
 232   last_action._byte_start = 0;
 233   last_action._length = 0;
 234   return OKAY;
 235 }
 236
 237 outcome heavy_file_operations::buffer_files(const astring &source_root,
 238     const filename_list &to_transfer, file_transfer_header &last_action,
 239     byte_array &storage, int maximum_bytes)
 240 {
 241   FUNCDEF("buffer_files");
 242   storage.reset();  // clear out the current contents.
 243
 244   if (!to_transfer.elements()) {
 245     // we seem to be done.
 246     return FINISHED;
 247   }
 248
 249   outcome to_return = OKAY;
 250
 251   // start filling the array with bytes from the files.
 252   while (storage.length() < maximum_bytes) {
 253     double remaining_in_array = maximum_bytes - storage.length()
 254         - last_action.packed_size();
 255     if (remaining_in_array < MINIMUM_ARRAY_SIZE) {
 256       // ensure that we at least have a reasonable amount of space left
 257       // for storing into the array.
 258       break;
 259     }
 260
 261     // find the current file we're at, as provided in record.
 262     if (!last_action._filename) {
 263       // no filename yet.  assume this is the first thing we've done.
 264       const file_info *currfile = to_transfer.get(0);
 265       last_action._filename = currfile->raw();
 266       last_action._time = currfile->_time;
 267       last_action._byte_start = 0;
 268       last_action._length = 0;
 269     }
 270
 271     const file_info *found = to_transfer.find(last_action._filename);
 272     if (!found) {
 273       // they have referenced a file that we don't have.  that's bad news.
 274       return BAD_INPUT;
 275     }
 276
 277     astring full_file = source_root + "/" + last_action._filename;
 278     huge_file current(full_file, "rb");
 279     if (!current.good()) {
 280       // we need to skip this file.
 281       LOG(astring("skipping bad file: ") + full_file);
 282       to_return = advance(to_transfer, last_action);
 283       if (to_return != OKAY) break;
 284       continue;
 285     }
 286
 287     if (last_action._byte_start + last_action._length >= current.length()) {
 288       // this file is done now.  go to the next one.
 289 #ifdef DEBUG_HEAVY_FILE_OPS
 290       LOG(astring("finished stuffing file: ") + full_file);
 291 #endif
 292       to_return = advance(to_transfer, last_action);
 293       if (to_return != OKAY) break;
 294       continue;
 295     }
 296
 297     // calculate the largest piece remaining of that file that will fit in the
 298     // allotted space.
 299     double new_start = last_action._byte_start + last_action._length;
 300     double remaining_in_file = current.length() - new_start;
 301     if (remaining_in_file < 0) remaining_in_file = 0;
 302     double new_len = minimum(remaining_in_file, remaining_in_array);
 303
 304     // pack this new piece of the file.
 305     current.seek(new_start, byte_filer::FROM_START);
 306     byte_array new_chunk;
 307     int bytes_read = 0;
 308     outcome ret = current.read(new_chunk, int(new_len), bytes_read);
 309     if (bytes_read != new_len) {
 310       if (!bytes_read) {
 311         // some kind of problem reading the file.
 312         to_return = advance(to_transfer, last_action);
 313         if (to_return != OKAY) break;
 314         continue;
 315       }
 316 //why would this happen?  just complain, i guess.
 317     }
 318
 319     // update the record since it seems we're successful here.
 320     last_action._byte_start = new_start;
 321     last_action._length = int(new_len);
 322
 323     // add in this next new chunk of file.
 324     last_action.pack(storage);  // add the header.
 325     storage += new_chunk;  // add the new stuff.
 326
 327     if (!current.length()) {
 328       // ensure we don't get stuck redoing zero length files, which we allowed
 329       // to go past their end above (since otherwise we'd never see them).
 330       to_return = advance(to_transfer, last_action);
 331       if (to_return != OKAY) break;
 332       continue;
 333     }
 334
 335     // just keep going, if there's space...
 336   }
 337
 338   return to_return;
 339 }
 340
 341 } //namespace.
 342