Add archive sample
This sample shows usage of wxArchiveStream and wxArchiveFactory. It also allows for easy testing of wxArchiveStream implementations outside of the unit tests. See https://github.com/wxWidgets/wxWidgets/pull/730
This commit is contained in:
Tobias Taschner
committed by
Vadim Zeitlin
Vadim Zeitlin
parent
2ec2837f6d
commit
f3f1819daf
257
samples/archive/archive.cpp
Normal file
257
samples/archive/archive.cpp
Normal file
@@ -0,0 +1,257 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: samples/archive/archive.cpp
|
||||
// Purpose: A sample application to manipulate archives
|
||||
// Author: Tobias Taschner
|
||||
// Created: 2018-02-07
|
||||
// Copyright: (c) 2018 wxWidgets development team
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// For compilers that support precompilation, includes "wx/wx.h".
|
||||
#include "wx/wxprec.h"
|
||||
|
||||
#ifndef WX_PRECOMP
|
||||
#include "wx/wx.h"
|
||||
#endif
|
||||
|
||||
#include "wx/archive.h"
|
||||
#include "wx/app.h"
|
||||
#include "wx/cmdline.h"
|
||||
#include "wx/filename.h"
|
||||
#include "wx/sharedptr.h"
|
||||
#include "wx/vector.h"
|
||||
#include "wx/wfstream.h"
|
||||
#include "wx/zipstrm.h"
|
||||
|
||||
class ArchiveApp: public wxAppConsole
|
||||
{
|
||||
public:
|
||||
|
||||
virtual void OnInitCmdLine(wxCmdLineParser& parser) wxOVERRIDE;
|
||||
|
||||
virtual bool OnCmdLineParsed(wxCmdLineParser& parser) wxOVERRIDE;
|
||||
|
||||
virtual int OnRun() wxOVERRIDE;
|
||||
|
||||
private:
|
||||
enum ArchiveCommandType
|
||||
{
|
||||
CMD_CREATE,
|
||||
CMD_LIST,
|
||||
CMD_EXTRACT,
|
||||
CMD_NONE
|
||||
};
|
||||
|
||||
struct ArchiveCommandDesc
|
||||
{
|
||||
ArchiveCommandType type;
|
||||
const char* id;
|
||||
const char* desc;
|
||||
};
|
||||
|
||||
static const ArchiveCommandDesc s_cmdDesc[];
|
||||
|
||||
ArchiveCommandType m_command;
|
||||
wxString m_archiveFileName;
|
||||
wxVector<wxString> m_fileNames;
|
||||
bool m_forceZip64;
|
||||
|
||||
const wxArchiveClassFactory* m_archiveClassFactory;
|
||||
|
||||
int DoCreate();
|
||||
|
||||
int DoList();
|
||||
|
||||
int DoExtract();
|
||||
|
||||
bool CopyStreamData(wxInputStream& inputStream, wxOutputStream& outputStream, wxFileOffset size);
|
||||
};
|
||||
|
||||
const ArchiveApp::ArchiveCommandDesc ArchiveApp::s_cmdDesc[] =
|
||||
{
|
||||
{CMD_CREATE, "c", "create"},
|
||||
{CMD_LIST, "l", "list"},
|
||||
{CMD_EXTRACT, "x", "extract"},
|
||||
|
||||
{CMD_NONE, 0, 0}
|
||||
};
|
||||
|
||||
void ArchiveApp::OnInitCmdLine(wxCmdLineParser& parser)
|
||||
{
|
||||
wxAppConsole::OnInitCmdLine(parser);
|
||||
|
||||
parser.AddParam("command");
|
||||
parser.AddParam("archive_name");
|
||||
parser.AddParam("file_names", wxCMD_LINE_VAL_STRING,
|
||||
wxCMD_LINE_PARAM_MULTIPLE | wxCMD_LINE_PARAM_OPTIONAL);
|
||||
parser.AddSwitch("", "force-zip64", "Force ZIP64 format when creating ZIP archives");
|
||||
|
||||
parser.AddUsageText("\ncommand:");
|
||||
for (const ArchiveCommandDesc* cmdDesc = s_cmdDesc; cmdDesc->type != CMD_NONE; cmdDesc++)
|
||||
parser.AddUsageText(wxString::Format(" %s: %s", cmdDesc->id, cmdDesc->desc));
|
||||
|
||||
wxString formats;
|
||||
for(const wxArchiveClassFactory* factory = wxArchiveClassFactory::GetFirst(); factory;
|
||||
factory = factory->GetNext())
|
||||
{
|
||||
if(!formats.empty())
|
||||
formats += ", ";
|
||||
formats += factory->GetProtocol();
|
||||
}
|
||||
parser.AddUsageText("\nsupported formats: " + formats);
|
||||
}
|
||||
|
||||
bool ArchiveApp::OnCmdLineParsed(wxCmdLineParser& parser)
|
||||
{
|
||||
m_command = CMD_NONE;
|
||||
wxString command = parser.GetParam();
|
||||
for (const ArchiveCommandDesc* cmdDesc = s_cmdDesc; cmdDesc->type != CMD_NONE; cmdDesc++)
|
||||
{
|
||||
if (cmdDesc->id == command)
|
||||
m_command = cmdDesc->type;
|
||||
}
|
||||
if(m_command == CMD_NONE)
|
||||
{
|
||||
wxLogError("Invalid command: %s", command);
|
||||
return false;
|
||||
}
|
||||
m_archiveFileName = parser.GetParam(1);
|
||||
for (size_t i = 2; i < parser.GetParamCount(); i++)
|
||||
m_fileNames.push_back(parser.GetParam(i));
|
||||
m_forceZip64 = parser.FoundSwitch("force-zip64") == wxCMD_SWITCH_ON;
|
||||
|
||||
return wxAppConsole::OnCmdLineParsed(parser);
|
||||
}
|
||||
|
||||
bool ArchiveApp::CopyStreamData(wxInputStream& inputStream, wxOutputStream& outputStream, wxFileOffset size)
|
||||
{
|
||||
wxChar buf[128 * 1024];
|
||||
int readSize = 128 * 1024;
|
||||
wxFileOffset copiedData = 0;
|
||||
while (copiedData < size)
|
||||
{
|
||||
if (copiedData + readSize > size)
|
||||
readSize = size - copiedData;
|
||||
inputStream.Read(buf, readSize);
|
||||
outputStream.Write(buf, readSize);
|
||||
copiedData += readSize;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
int ArchiveApp::DoCreate()
|
||||
{
|
||||
if (m_fileNames.empty())
|
||||
{
|
||||
wxLogError("Need at least one file to add to archive");
|
||||
return -1;
|
||||
}
|
||||
|
||||
wxTempFileOutputStream fileOutputStream(m_archiveFileName);
|
||||
wxSharedPtr<wxArchiveOutputStream> archiveOutputStream(m_archiveClassFactory->NewStream(fileOutputStream));
|
||||
if (m_archiveClassFactory->GetProtocol().IsSameAs("zip", false) && m_forceZip64)
|
||||
reinterpret_cast<wxZipOutputStream*>(archiveOutputStream.get())->SetFormat(wxZIP_FORMAT_ZIP64);
|
||||
|
||||
for(wxVector<wxString>::iterator fileName = m_fileNames.begin(); fileName != m_fileNames.end(); fileName++)
|
||||
{
|
||||
wxFileName inputFileName(*fileName);
|
||||
wxPrintf("Adding %s...\n", inputFileName.GetFullName());
|
||||
wxFileInputStream inputFileStream(*fileName);
|
||||
if (!inputFileStream.IsOk())
|
||||
{
|
||||
wxLogError("Could not open file");
|
||||
return 1;
|
||||
}
|
||||
if (!archiveOutputStream->PutNextEntry(inputFileName.GetFullName(), wxDateTime::Now(), inputFileStream.GetLength()))
|
||||
break;
|
||||
CopyStreamData(inputFileStream, *archiveOutputStream, inputFileStream.GetLength());
|
||||
}
|
||||
|
||||
if (archiveOutputStream->Close())
|
||||
{
|
||||
fileOutputStream.Commit();
|
||||
wxPrintf("Created archive\n");
|
||||
return 0;
|
||||
}
|
||||
else
|
||||
return 1;
|
||||
}
|
||||
|
||||
int ArchiveApp::DoList()
|
||||
{
|
||||
wxFileInputStream fileInputStream(m_archiveFileName);
|
||||
if (!fileInputStream.IsOk())
|
||||
return 1;
|
||||
|
||||
wxSharedPtr<wxArchiveInputStream> archiveStream(m_archiveClassFactory->NewStream(fileInputStream));
|
||||
wxPrintf("Archive: %s\n", m_archiveFileName);
|
||||
wxPrintf("Length Date Time Name\n");
|
||||
wxPrintf("---------- ---------- -------- ----\n");
|
||||
|
||||
wxFileOffset combinedSize = 0;
|
||||
int entryCount = 0;
|
||||
for (wxArchiveEntry* entry = archiveStream->GetNextEntry(); entry;
|
||||
entry = archiveStream->GetNextEntry())
|
||||
{
|
||||
combinedSize += entry->GetSize();
|
||||
entryCount++;
|
||||
wxPrintf("%10lld %s %s %s\n",
|
||||
entry->GetSize(),
|
||||
entry->GetDateTime().FormatISODate(),
|
||||
entry->GetDateTime().FormatISOTime(),
|
||||
entry->GetName());
|
||||
}
|
||||
wxPrintf("---------- -------\n");
|
||||
wxPrintf("%10lld %d files\n", combinedSize, entryCount);
|
||||
return 0;
|
||||
}
|
||||
|
||||
int ArchiveApp::DoExtract()
|
||||
{
|
||||
wxFileInputStream fileInputStream(m_archiveFileName);
|
||||
if (!fileInputStream.IsOk())
|
||||
return 1;
|
||||
|
||||
wxSharedPtr<wxArchiveInputStream> archiveStream(m_archiveClassFactory->NewStream(fileInputStream));
|
||||
wxPrintf("Extrating from: %s\n", m_archiveFileName);
|
||||
for (wxArchiveEntry* entry = archiveStream->GetNextEntry(); entry;
|
||||
entry = archiveStream->GetNextEntry())
|
||||
{
|
||||
wxPrintf("Extracting: %s...\n", entry->GetName());
|
||||
wxTempFileOutputStream outputFileStream(entry->GetName());
|
||||
CopyStreamData(*archiveStream, outputFileStream, entry->GetSize());
|
||||
outputFileStream.Commit();
|
||||
}
|
||||
wxPrintf("Extracted all files\n");
|
||||
return 0;
|
||||
}
|
||||
|
||||
int ArchiveApp::OnRun()
|
||||
{
|
||||
m_archiveClassFactory = wxArchiveClassFactory::Find(m_archiveFileName, wxSTREAM_FILEEXT);
|
||||
if (!m_archiveClassFactory)
|
||||
{
|
||||
wxLogError("Unsupported file format");
|
||||
return -1;
|
||||
}
|
||||
|
||||
int result = -1;
|
||||
switch (m_command) {
|
||||
case CMD_CREATE:
|
||||
result = DoCreate();
|
||||
break;
|
||||
case CMD_LIST:
|
||||
result = DoList();
|
||||
break;
|
||||
case CMD_EXTRACT:
|
||||
result = DoExtract();
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
wxIMPLEMENT_APP(ArchiveApp);
|
||||
Reference in New Issue
Block a user