poco/Zip/include/Poco/Zip/ZipManipulator.h
Aleksandar Fabijanic d75e68c027 new trunk (base for 1.5)
windows build only
2012-04-23 01:14:34 +00:00

132 lines
4.4 KiB
C++

//
// ZipManipulator.h
//
// $Id: //poco/1.4/Zip/include/Poco/Zip/ZipManipulator.h#1 $
//
// Library: Zip
// Package: Manipulation
// Module: ZipManipulator
//
// Definition of the ZipManipulator class.
//
// Copyright (c) 2007, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef Zip_ZipManipulator_INCLUDED
#define Zip_ZipManipulator_INCLUDED
#include "Poco/Zip/Zip.h"
#include "Poco/Zip/ZipArchive.h"
#include "Poco/Zip/ZipCommon.h"
#include "Poco/Zip/ZipOperation.h"
#include "Poco/FIFOEvent.h"
#include "Poco/SharedPtr.h"
#include <map>
namespace Poco {
namespace Zip {
class ZipArchive;
class Zip_API ZipManipulator
/// ZipManipulator allows to add/remove/update files inside zip files
{
public:
Poco::FIFOEvent<const ZipLocalFileHeader> EDone;
// Fired for each entry once commit is invoked
ZipManipulator(const std::string& zipFile, bool backupOriginalFile);
/// Creates the ZipManipulator.
virtual ~ZipManipulator();
/// Destroys the ZipManipulator.
void deleteFile(const std::string& zipPath);
/// Removes the given file from the Zip archive.
void replaceFile(const std::string& zipPath, const std::string& localPath);
/// Replaces the contents of the file in the archive with the contents
/// from the file given by localPath.
void renameFile(const std::string& zipPath, const std::string& newZipPath);
/// Renames the file in the archive to newZipPath
void addFile(const std::string& zipPath, const std::string& localPath, ZipCommon::CompressionMethod cm = ZipCommon::CM_DEFLATE, ZipCommon::CompressionLevel cl = ZipCommon::CL_MAXIMUM);
/// Adds a file to the zip file.
ZipArchive commit();
/// Commits all changes and re-creates the Zip File with the changes applied.
/// Returns the ZipArchive for the newly created archive
///
/// Changes will be first written to a temporary file,
/// then the originalfile will be either deleted or renamed to .bak,
/// then, the temp file will be renamed to the original zip file name.
const ZipArchive& originalArchive() const;
/// Returns the original archive information
private:
const ZipLocalFileHeader& getForChange(const std::string& zipPath) const;
/// Searches for the entry given by the zipPath.
/// Throws an exception if the entry does not exist
/// or if an entry already exists in the Changeslist
void addOperation(const std::string& zipPath, ZipOperation::Ptr ptrOp);
/// Adds the operation to the changes list. Throws an exception if an
/// entry for the zipPath already exists
void onEDone(const void* pSender, const ZipLocalFileHeader& hdr);
/// Forwards the event to the EDone event
ZipArchive compress(const std::string& outFile);
/// Compresses the new file to outFile
private:
typedef std::map<std::string, ZipOperation::Ptr> Changes;
const std::string _zipFile;
bool _backupOriginalFile;
Changes _changes;
Poco::SharedPtr<ZipArchive> _in;
};
inline const ZipArchive& ZipManipulator::originalArchive() const
{
return *_in;
}
} } // namespace Poco::Zip
#endif // Zip_ZipManipulator_INCLUDED