sc/inc/tabprotection.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: tabprotection.hxx,v $
  10  * $Revision: 1.1.4.6 $
  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 SC_TAB_PROTECTION_HXX
  32 #define SC_TAB_PROTECTION_HXX
  33
  34 #include "sal/types.h"
  35 #include <com/sun/star/uno/Sequence.hxx>
  36
  37 #include "global.hxx"
  38 #include <boost/shared_ptr.hpp>
  39
  40 #define ENABLE_SHEET_PROTECTION 1
  41
  42 class ScDocument;
  43 class ScTableProtectionImpl;
  44
  45 enum ScPasswordHash
  46 {
  47     PASSHASH_SHA1 = 0,
  48     PASSHASH_XL,
  49     PASSHASH_UNSPECIFIED
  50 };
  51
  52 class ScPassHashHelper
  53 {
  54 public:
  55     /** Check for the compatibility of all password hashes.  If there is at
  56         least one hash that needs to be regenerated, it returns true.  If all
  57         hash values are compatible with the specified hash type, then it
  58         returns false. */
  59     static bool needsPassHashRegen(const ScDocument& rDoc, ScPasswordHash eHash1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED);
  60
  61     static ::rtl::OUString getHashURI(ScPasswordHash eHash);
  62
  63     static ScPasswordHash getHashTypeFromURI(const ::rtl::OUString& rURI);
  64
  65 private:
  66     ScPassHashHelper();
  67     ~ScPassHashHelper();
  68 };
  69
  70 // ============================================================================
  71
  72 class SAL_NO_VTABLE ScPassHashProtectable
  73 {
  74 public:
  75     virtual ~ScPassHashProtectable() = 0;
  76
  77     virtual bool isProtected() const = 0;
  78     virtual bool isProtectedWithPass() const = 0;
  79     virtual void setProtected(bool bProtected) = 0;
  80
  81     virtual bool isPasswordEmpty() const = 0;
  82     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const = 0;
  83     virtual void setPassword(const String& aPassText) = 0;
  84     virtual ::com::sun::star::uno::Sequence<sal_Int8> getPasswordHash(
  85         ScPasswordHash eHash, ScPasswordHash eHas2 = PASSHASH_UNSPECIFIED) const = 0;
  86     virtual void setPasswordHash(
  87         const ::com::sun::star::uno::Sequence<sal_Int8>& aPassword,
  88         ScPasswordHash eHash = PASSHASH_SHA1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) = 0;
  89     virtual bool verifyPassword(const String& aPassText) const = 0;
  90 };
  91
  92 // ============================================================================
  93
  94 class SC_DLLPUBLIC ScDocProtection : public ScPassHashProtectable
  95 {
  96 public:
  97     enum Option
  98     {
  99         STRUCTURE = 0,
 100         WINDOWS,
 101         CONTENT,
 102         NONE        // last item - used to resize the vector
 103     };
 104
 105     explicit ScDocProtection();
 106     explicit ScDocProtection(const ScDocProtection& r);
 107     virtual ~ScDocProtection();
 108
 109     virtual bool isProtected() const;
 110     virtual bool isProtectedWithPass() const;
 111     virtual void setProtected(bool bProtected);
 112
 113     virtual bool isPasswordEmpty() const;
 114     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const;
 115     virtual void setPassword(const String& aPassText);
 116     virtual ::com::sun::star::uno::Sequence<sal_Int8> getPasswordHash(
 117         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const;
 118     virtual void setPasswordHash(
 119         const ::com::sun::star::uno::Sequence<sal_Int8>& aPassword,
 120         ScPasswordHash eHash = PASSHASH_SHA1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED);
 121     virtual bool verifyPassword(const String& aPassText) const;
 122
 123     bool isOptionEnabled(Option eOption) const;
 124     void setOption(Option eOption, bool bEnabled);
 125
 126 private:
 127     ::boost::shared_ptr<ScTableProtectionImpl> mpImpl;
 128 };
 129
 130 // ============================================================================
 131
 132 /** sheet protection state container
 133
 134     This class stores sheet's protection state: 1) whether the protection
 135     is on, 2) password and/or password hash, and 3) any associated
 136     protection options.  This class is also used as a protection state
 137     container for the undo/redo stack, in which case the password, hash and
 138     the options need to be preserved even when the protection flag is
 139     off. */
 140 class SC_DLLPUBLIC ScTableProtection : public ScPassHashProtectable
 141 {
 142 public:
 143     enum Option
 144     {
 145         AUTOFILTER = 0,
 146         DELETE_COLUMNS,
 147         DELETE_ROWS,
 148         FORMAT_CELLS,
 149         FORMAT_COLUMNS,
 150         FORMAT_ROWS,
 151         INSERT_COLUMNS,
 152         INSERT_HYPERLINKS,
 153         INSERT_ROWS,
 154         OBJECTS,
 155         PIVOT_TABLES,
 156         SCENARIOS,
 157         SELECT_LOCKED_CELLS,
 158         SELECT_UNLOCKED_CELLS,
 159         SHEET,
 160         SORT,
 161         NONE        // last item - used to resize the vector
 162     };
 163
 164     explicit ScTableProtection();
 165     explicit ScTableProtection(const ScTableProtection& r);
 166     virtual ~ScTableProtection();
 167
 168     virtual bool isProtected() const;
 169     virtual bool isProtectedWithPass() const;
 170     virtual void setProtected(bool bProtected);
 171
 172     virtual bool isPasswordEmpty() const;
 173     virtual bool hasPasswordHash(ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const;
 174     virtual void setPassword(const String& aPassText);
 175     virtual ::com::sun::star::uno::Sequence<sal_Int8> getPasswordHash(
 176         ScPasswordHash eHash, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED) const;
 177     virtual void setPasswordHash(
 178         const ::com::sun::star::uno::Sequence<sal_Int8>& aPassword,
 179         ScPasswordHash eHash = PASSHASH_SHA1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED);
 180     virtual bool verifyPassword(const String& aPassText) const;
 181
 182     bool isOptionEnabled(Option eOption) const;
 183     void setOption(Option eOption, bool bEnabled);
 184
 185 private:
 186     ::boost::shared_ptr<ScTableProtectionImpl> mpImpl;
 187 };
 188
 189
 190 #endif