shell/inc/internal/zipfile.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SHELL_INC_INTERNAL_ZIPFILE_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_ZIPFILE_HXX
  22
  23 #ifndef _WINDOWS
  24 #define _WINDOWS
  25 #endif
  26
  27 #include <zlib.h>
  28
  29 #include <string>
  30 #include <vector>
  31 #include <memory>
  32
  33 class StreamInterface;
  34
  35 /** A simple zip content provider based on the zlib
  36 */
  37
  38 class ZipFile
  39 {
  40 public:
  41
  42     typedef std::vector<std::string>   Directory_t;
  43     typedef std::unique_ptr<Directory_t> DirectoryPtr_t;
  44     typedef std::vector<char>          ZipContentBuffer_t;
  45
  46 public:
  47
  48     /** Checks whether a file is a zip file or not
  49
  50     @precond    The given parameter must be a string with length > 0
  51             The file must exist
  52             The file must be readable for the current user
  53
  54     @returns    true if the file is a zip file
  55             false if the file is not a zip file
  56
  57     @throws ParameterException if the given file name is empty
  58             IOException if the specified file doesn't exist
  59             AccessViolationException if read access to the file is denied
  60     */
  61     static bool IsZipFile(const std::string &FileName);
  62
  63     static bool IsZipFile(void *stream);
  64
  65
  66     /** Returns whether the version of the specified zip file may be uncompressed with the
  67           currently used zlib version or not
  68
  69     @precond    The given parameter must be a string with length > 0
  70             The file must exist
  71             The file must be readable for the current user
  72             The file must be a valid zip file
  73
  74     @returns    true if the file may be uncompressed with the currently used zlib
  75             false if the file may not be uncompressed with the currently used zlib
  76
  77     @throws ParameterException if the given file name is empty
  78             IOException if the specified file doesn't exist or is no zip file
  79             AccessViolationException if read access to the file is denied
  80     */
  81     static bool IsValidZipFileVersionNumber(const std::string &FileName);
  82
  83     static bool IsValidZipFileVersionNumber(void *stream);
  84
  85 public:
  86
  87     /** Constructs a zip file from a zip file
  88
  89     @precond    The given parameter must be a string with length > 0
  90             The file must exist
  91             The file must be readable for the current user
  92
  93     @throws ParameterException if the given file name is empty
  94             IOException if the specified file doesn't exist or is no valid zip file
  95             AccessViolationException if read access to the file is denied
  96             WrongZipVersionException if the zip file cannot be uncompressed
  97             with the used zlib version
  98     */
  99     ZipFile(const std::string &FileName);
 100
 101     ZipFile(StreamInterface *stream);
 102
 103
 104     /** Destroys a zip file
 105     */
 106     ~ZipFile();
 107
 108     /** Provides an interface to read the uncompressed data of a content of the zip file
 109
 110     @param      ContentName
 111                 The name of the content in the zip file
 112
 113     @param      ppstm
 114                 Pointer to pointer, will receive an interface pointer
 115                 to IUnknown on success
 116
 117     @precond    The specified content must exist in this file
 118                 ppstm must not be NULL
 119
 120     @throws     std::bad_alloc if the necessary buffer could not be
 121                 allocated
 122                 ZipException if an zip error occurs
 123                 ZipContentMissException if the specified zip content
 124                 does not exist in this zip file
 125     */
 126     void GetUncompressedContent(const std::string &ContentName, /*inout*/ ZipContentBuffer_t &ContentBuffer);
 127
 128     /** Returns a list with the content names contained within this file
 129
 130         @throws ZipException if an error in the zlib happens
 131     */
 132     DirectoryPtr_t GetDirectory() const;
 133
 134     /** Convinience query function may even realized with
 135         iterating over a ZipFileDirectory returned by
 136         GetDirectory
 137     */
 138     bool HasContent(const std::string &ContentName) const;
 139
 140 private:
 141
 142     /** Returns the length of the longest file name
 143         in the current zip file
 144
 145         @throws ZipException if an zip error occurs
 146     */
 147     long GetFileLongestFileNameLength() const;
 148
 149 private:
 150     StreamInterface *m_pStream;
 151     bool m_bShouldFree;
 152 };
 153
 154 #endif
 155
 156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */