blob: 7b119412e2a86035a665d82bacd758f83d599fc9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ZIPFILE_HXX_INCLUDED
#define ZIPFILE_HXX_INCLUDED
#ifndef _WINDOWS
#define _WINDOWS
#endif
#include <zlib.h>
#include <string>
#include <vector>
#include <memory>
class StreamInterface;
class ZipFilePrivate;
/** A simple zip content provider based on the zlib
*/
class ZipFile
{
public:
typedef std::vector<std::string> Directory_t;
typedef std::auto_ptr<Directory_t> DirectoryPtr_t;
typedef std::vector<char> ZipContentBuffer_t;
public:
/** Checks whether a file is a zip file or not
@precond The given parameter must be a string with length > 0
The file must exist
The file must be readable for the current user
@returns true if the file is a zip file
false if the file is not a zip file
@throws ParameterException if the given file name is empty
IOException if the specified file doesn't exist
AccessViolationException if read access to the file is denied
*/
static bool IsZipFile(const std::string &FileName);
static bool IsZipFile(void *stream);
/** Returns wheter the version of the specified zip file may be uncompressed with the
currently used zlib version or not
@precond The given parameter must be a string with length > 0
The file must exist
The file must be readable for the current user
The file must be a valid zip file
@returns true if the file may be uncompressed with the currently used zlib
false if the file may not be uncompressed with the currently used zlib
@throws ParameterException if the given file name is empty
IOException if the specified file doesn't exist or is no zip file
AccessViolationException if read access to the file is denied
*/
static bool IsValidZipFileVersionNumber(const std::string &FileName);
static bool IsValidZipFileVersionNumber(void *stream);
public:
/** Constructs a zip file from a zip file
@precond The given parameter must be a string with length > 0
The file must exist
The file must be readable for the current user
@throws ParameterException if the given file name is empty
IOException if the specified file doesn't exist or is no valid zip file
AccessViolationException if read access to the file is denied
WrongZipVersionException if the zip file cannot be uncompressed
with the used zlib version
*/
ZipFile(const std::string &FileName);
ZipFile(StreamInterface *stream);
/** Destroys a zip file
*/
~ZipFile();
/** Provides an interface to read the uncompressed data of a content of the zip file
@param ContentName
The name of the content in the zip file
@param ppstm
Pointer to pointer, will receive an interface pointer
to IUnknown on success
@precond The specified content must exist in this file
ppstm must not be NULL
@throws std::bad_alloc if the necessary buffer could not be
allocated
ZipException if an zip error occurs
ZipContentMissException if the specified zip content
does not exist in this zip file
*/
void GetUncompressedContent(const std::string &ContentName, /*inout*/ ZipContentBuffer_t &ContentBuffer);
/** Returns a list with the content names contained within this file
@throws ZipException if an error in the zlib happens
*/
DirectoryPtr_t GetDirectory() const;
/** Convinience query function may even realized with
iterating over a ZipFileDirectory returned by
GetDirectory
*/
bool HasContent(const std::string &ContentName) const;
private:
/** Returns the length of the longest file name
in the current zip file
@throws ZipException if an zip error occurs
*/
long GetFileLongestFileNameLength() const;
private:
StreamInterface *m_pStream;
bool m_bShouldFree;
long m_iStartOffset;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
