sc/inc/tabprotection.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_SC_INC_TABPROTECTION_HXX
  21 #define INCLUDED_SC_INC_TABPROTECTION_HXX
  22
  23 #include <sal/types.h>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25
  26 #include "global.hxx"
  27 #include "rangelst.hxx"
  28 #include <memory>
  29
  30 class ScDocument;
  31 class ScTableProtectionImpl;
  32
  33 enum ScPasswordHash
  34 {
  35     PASSHASH_SHA1 = 0,
  36     PASSHASH_XL,
  37     PASSHASH_UNSPECIFIED
  38 };
  39
  40 namespace ScPassHashHelper
  41 {
  42     /** Check for the compatibility of all password hashes.  If there is at
  43      * least one hash that needs to be regenerated, it returns true.  If all
  44      * hash values are compatible with the specified hash type, then it
  45      * returns false. */
  46     bool needsPassHashRegen(const ScDocument& rDoc, ScPasswordHash eHash1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED);
  47
  48     OUString getHashURI(ScPasswordHash eHash);
  49
  50     ScPasswordHash getHashTypeFromURI(const OUString& rURI);
  51 }
  52
  53 class SAL_NO_VTABLE ScPassHashProtectable
  54 {
  55 public:
  56     virtual ~ScPassHashProtectable() = 0;
  57
  58     virtual bool isProtected() const = 0;
  59     virtual bool isProtectedWithPass() const = 0;
  60     virtual void setProtected(bool bProtected) = 0;
  61
  62     virtual bool isPasswordEmpty() const = 0;
  63     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const = 0;
  64     virtual void setPassword(const OUString& aPassText) = 0;
  65     virtual css::uno::Sequence<sal_Int8> getPasswordHash(
  66         ScPasswordHash eHash, ScPasswordHash eHas2 = PASSHASH_UNSPECIFIED) const = 0;
  67     virtual void setPasswordHash(
  68         const css::uno::Sequence<sal_Int8>& aPassword,
  69         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) = 0;
  70     virtual bool verifyPassword(const OUString& aPassText) const = 0;
  71 };
  72
  73 class SC_DLLPUBLIC ScDocProtection : public ScPassHashProtectable
  74 {
  75 public:
  76     enum Option
  77     {
  78         STRUCTURE = 0,
  79         WINDOWS,
  80         NONE        ///< last item - used to resize the vector
  81     };
  82
  83     explicit ScDocProtection();
  84     explicit ScDocProtection(const ScDocProtection& r);
  85     virtual ~ScDocProtection() override;
  86
  87     virtual bool isProtected() const override;
  88     virtual bool isProtectedWithPass() const override;
  89     virtual void setProtected(bool bProtected) override;
  90
  91     virtual bool isPasswordEmpty() const override;
  92     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const override;
  93     virtual void setPassword(const OUString& aPassText) override;
  94     virtual css::uno::Sequence<sal_Int8> getPasswordHash(
  95         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const override;
  96     virtual void setPasswordHash(
  97         const css::uno::Sequence<sal_Int8>& aPassword,
  98         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) override;
  99     virtual bool verifyPassword(const OUString& aPassText) const override;
 100
 101     bool isOptionEnabled(Option eOption) const;
 102     void setOption(Option eOption, bool bEnabled);
 103
 104 private:
 105     std::unique_ptr<ScTableProtectionImpl> mpImpl;
 106 };
 107
 108 /** Container for the Excel EnhancedProtection feature.
 109  */
 110 struct ScEnhancedProtection
 111 {
 112     ScRangeListRef              maRangeList;
 113     sal_uInt32                  mnAreserved;
 114     sal_uInt32                  mnPasswordVerifier;
 115     OUString                    maTitle;
 116     ::std::vector< sal_uInt8 >  maSecurityDescriptor;       // imported as raw BIFF data
 117     OUString                    maSecurityDescriptorXML;    // imported from OOXML
 118     // OOXML password definitions
 119     OUString                    maAlgorithmName;
 120     OUString                    maHashValue;
 121     OUString                    maSaltValue;
 122     sal_uInt32                  mnSpinCount;
 123
 124     ScEnhancedProtection() : mnAreserved(0), mnPasswordVerifier(0), mnSpinCount(0) {}
 125
 126     bool hasSecurityDescriptor() const
 127     {
 128         return !maSecurityDescriptor.empty() || !maSecurityDescriptorXML.isEmpty();
 129     }
 130
 131     bool hasPassword() const
 132     {
 133         return mnPasswordVerifier != 0 || !maHashValue.isEmpty();
 134     }
 135 };
 136
 137 /** sheet protection state container
 138  *
 139  * This class stores sheet's protection state: 1) whether the protection
 140  * is on, 2) password and/or password hash, and 3) any associated
 141  * protection options.  This class is also used as a protection state
 142  * container for the undo/redo stack, in which case the password, hash and
 143  * the options need to be preserved even when the protection flag is
 144  * off. */
 145 class SC_DLLPUBLIC ScTableProtection : public ScPassHashProtectable
 146 {
 147 public:
 148     enum Option
 149     {
 150         AUTOFILTER = 0,
 151         DELETE_COLUMNS,
 152         DELETE_ROWS,
 153         FORMAT_CELLS,
 154         FORMAT_COLUMNS,
 155         FORMAT_ROWS,
 156         INSERT_COLUMNS,
 157         INSERT_HYPERLINKS,
 158         INSERT_ROWS,
 159         OBJECTS,
 160         PIVOT_TABLES,
 161         SCENARIOS,
 162         SELECT_LOCKED_CELLS,
 163         SELECT_UNLOCKED_CELLS,
 164         SORT,
 165         NONE        ///< last item - used to resize the vector
 166     };
 167
 168     explicit ScTableProtection();
 169     explicit ScTableProtection(const ScTableProtection& r);
 170     virtual ~ScTableProtection() override;
 171
 172     virtual bool isProtected() const override;
 173     virtual bool isProtectedWithPass() const override;
 174     virtual void setProtected(bool bProtected) override;
 175
 176     virtual bool isPasswordEmpty() const override;
 177     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const override;
 178     virtual void setPassword(const OUString& aPassText) override;
 179     virtual css::uno::Sequence<sal_Int8> getPasswordHash(
 180         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const override;
 181     virtual void setPasswordHash(
 182         const css::uno::Sequence<sal_Int8>& aPassword,
 183         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) override;
 184     virtual bool verifyPassword(const OUString& aPassText) const override;
 185
 186     bool isOptionEnabled(Option eOption) const;
 187     void setOption(Option eOption, bool bEnabled);
 188
 189     void setEnhancedProtection( const ::std::vector< ScEnhancedProtection > & rProt );
 190     const ::std::vector< ScEnhancedProtection > & getEnhancedProtection() const;
 191     bool updateReference( UpdateRefMode, const ScDocument*, const ScRange& rWhere, SCCOL nDx, SCROW nDy, SCTAB nDz );
 192     bool isBlockEditable( const ScRange& rRange ) const;
 193     bool isSelectionEditable( const ScRangeList& rRangeList ) const;
 194
 195 private:
 196     std::unique_ptr<ScTableProtectionImpl> mpImpl;
 197 };
 198
 199 #endif
 200
 201 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */