shell/inc/internal/zipfile.hxx

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