shell/inc/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 #include <zlib.h>
  24
  25 #include <string>
  26 #include <vector>
  27 #include <memory>
  28 #include "filepath.hxx"
  29
  30 class StreamInterface;
  31
  32 /** A simple zip content provider based on the zlib
  33 */
  34
  35 class ZipFile
  36 {
  37 public:
  38     typedef std::vector<std::string>   Directory_t;
  39     typedef std::unique_ptr<Directory_t> DirectoryPtr_t;
  40     typedef std::vector<char>          ZipContentBuffer_t;
  41
  42 public:
  43
  44     /** Checks whether a file is a zip file or not
  45
  46     @precond    The given parameter must be a string with length > 0
  47             The file must exist
  48             The file must be readable for the current user
  49
  50     @returns    true if the file is a zip file
  51             false if the file is not a zip file
  52
  53     @throws ParameterException if the given file name is empty
  54             IOException if the specified file doesn't exist
  55             AccessViolationException if read access to the file is denied
  56     */
  57     static bool IsZipFile(const Filepath_t &FileName);
  58
  59     static bool IsZipFile(void *stream);
  60
  61
  62     /** Returns whether the version of the specified zip file may be uncompressed with the
  63           currently used zlib version or not
  64
  65     @precond    The given parameter must be a string with length > 0
  66             The file must exist
  67             The file must be readable for the current user
  68             The file must be a valid zip file
  69
  70     @returns    true if the file may be uncompressed with the currently used zlib
  71             false if the file may not be uncompressed with the currently used zlib
  72
  73     @throws ParameterException if the given file name is empty
  74             IOException if the specified file doesn't exist or is no zip file
  75             AccessViolationException if read access to the file is denied
  76     */
  77     static bool IsValidZipFileVersionNumber(const Filepath_t &FileName);
  78
  79     static bool IsValidZipFileVersionNumber(void *stream);
  80
  81 public:
  82
  83     /** Constructs a zip file from a zip file
  84
  85     @precond    The given parameter must be a string with length > 0
  86             The file must exist
  87             The file must be readable for the current user
  88
  89     @throws ParameterException if the given file name is empty
  90             IOException if the specified file doesn't exist or is no valid zip file
  91             AccessViolationException if read access to the file is denied
  92             WrongZipVersionException if the zip file cannot be uncompressed
  93             with the used zlib version
  94     */
  95     ZipFile(const Filepath_t &FileName);
  96
  97     ZipFile(StreamInterface *stream);
  98
  99
 100     /** Destroys a zip file
 101     */
 102     ~ZipFile();
 103
 104     /** Provides an interface to read the uncompressed data of a content of the zip file
 105
 106     @param      ContentName
 107                 The name of the content in the zip file
 108
 109     @param      ppstm
 110                 Pointer to pointer, will receive an interface pointer
 111                 to IUnknown on success
 112
 113     @precond    The specified content must exist in this file
 114                 ppstm must not be NULL
 115
 116     @throws     std::bad_alloc if the necessary buffer could not be
 117                 allocated
 118                 ZipException if a zip error occurs
 119                 ZipContentMissException if the specified zip content
 120                 does not exist in this zip file
 121     */
 122     void GetUncompressedContent(const std::string &ContentName, /*inout*/ ZipContentBuffer_t &ContentBuffer);
 123
 124     /** Returns a list with the content names contained within this file
 125
 126         @throws ZipException if an error in the zlib happens
 127     */
 128     DirectoryPtr_t GetDirectory() const;
 129
 130     /** Convenience query function may even realized with
 131         iterating over a ZipFileDirectory returned by
 132         GetDirectory
 133     */
 134     bool HasContent(const std::string &ContentName) const;
 135
 136 private:
 137
 138     /** Returns the length of the longest file name
 139         in the current zip file
 140
 141         @throws ZipException if a zip error occurs
 142     */
 143     long GetFileLongestFileNameLength() const;
 144
 145 private:
 146     StreamInterface *m_pStream;
 147     bool m_bShouldFree;
 148 };
 149
 150 #endif
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */