heavy_file_ops.h

Go to the documentation of this file.

#ifndef HEAVY_FILE_OPERATIONS_CLASS
#define HEAVY_FILE_OPERATIONS_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : heavy file operations                                             *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2005-$now By Author.  This program 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 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include "filename_list.h"
 
#include <basis/astring.h>
#include <basis/contracts.h>
 
namespace filesystem {
 
 
class file_transfer_header : public basis::packable
{
public:
  basis::astring _filename;  
//hmmm: consider adding full length here so we know it.
  double _byte_start;  
  int _length;  
  file_time _time;  
 
  DEFINE_CLASS_NAME("file_transfer_header");
 
  file_transfer_header(const file_time &time_stamp);
 
  virtual void pack(basis::byte_array &packed_form) const;
  virtual bool unpack(basis::byte_array &packed_form);
 
  virtual int packed_size() const;
 
  basis::astring text_form() const;
 
//hmmm: this could live in lots of other places.  file_info for one.
  basis::astring readable_text_form() const;
};
 
 
 
class heavy_file_operations : public virtual basis::root_object
{
public:
  virtual ~heavy_file_operations();
 
  enum outcomes {
    OKAY = basis::common::OKAY,
    BAD_INPUT = basis::common::BAD_INPUT,
    FINISHED = basis::common::IS_EMPTY,  // nothing left to pack.
    DEFINE_OUTCOME(SOURCE_MISSING, -43, "The source file is not accessible"),
    DEFINE_OUTCOME(TARGET_DIR_ERROR, -44, "The target's directory could not "
        "be created"),
    DEFINE_OUTCOME(TARGET_ACCESS_ERROR, -45, "The target file could not be "
        "created")
  };
  static const char *outcome_name(const basis::outcome &to_name);
 
  DEFINE_CLASS_NAME("heavy_file_operations");
 
  static const size_t COPY_CHUNK_FACTOR;
  static size_t copy_chunk_factor();
 
  static basis::outcome copy_file(const basis::astring &source, const basis::astring &destination,
          int copy_chunk_factor = heavy_file_operations::copy_chunk_factor());
 
  static basis::outcome write_file_chunk(const basis::astring &target, double byte_start,
          const basis::byte_array &chunk, bool truncate = true,
          int copy_chunk_factor = heavy_file_operations::copy_chunk_factor());
 
  static basis::outcome buffer_files(const basis::astring &source_root,
          const filename_list &to_transfer, file_transfer_header &last_action,
          basis::byte_array &storage, int maximum_bytes);
 
private:
  static basis::outcome advance(const filename_list &to_transfer,
          file_transfer_header &last_action);
};
 
 
} //namespace.
 
#endif