include/sfx2/classificationhelper.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
  10 #ifndef INCLUDED_SFX2_CLASSIFICATIONHELPER_HXX
  11 #define INCLUDED_SFX2_CLASSIFICATIONHELPER_HXX
  12
  13 #include <memory>
  14 #include <vector>
  15
  16 #include <rtl/ustring.hxx>
  17 #include <sfx2/dllapi.h>
  18 #include <sfx2/infobar.hxx>
  19
  20 namespace com::sun::star::beans { class XPropertyContainer; }
  21 namespace com::sun::star::document { class XDocumentProperties; }
  22
  23 class SfxViewFrame;
  24
  25 /// Return code of SfxClassificationHelper::CheckPaste().
  26 enum class SfxClassificationCheckPasteResult
  27 {
  28     None = 1,
  29     TargetDocNotClassified = 2,
  30     DocClassificationTooLow = 3
  31 };
  32
  33 /// Specifies a policy type, to be used with SetBACName(). Getters always use IntellectualProperty for now.
  34 enum class SfxClassificationPolicyType
  35 {
  36     ExportControl = 1,
  37     NationalSecurity = 2,
  38     IntellectualProperty = 3
  39 };
  40
  41 /// Shared code to handle Business Authorization Identification and Labeling Scheme (BAILS) properties.
  42 class SFX2_DLLPUBLIC SfxClassificationHelper
  43 {
  44     class Impl;
  45     std::unique_ptr<Impl> m_pImpl;
  46
  47 public:
  48     /// Does the document have any BAILS properties?
  49     static bool IsClassified(const css::uno::Reference<css::document::XDocumentProperties>& xDocumentProperties);
  50     /// Checks if pasting from xSource to xDestination would leak information.
  51     static SfxClassificationCheckPasteResult CheckPaste(const css::uno::Reference<css::document::XDocumentProperties>& xSource,
  52             const css::uno::Reference<css::document::XDocumentProperties>& xDestination);
  53     /// Wrapper around CheckPaste(): informs the user if necessary and finds out if the paste can be continued or not.
  54     static bool ShowPasteInfo(SfxClassificationCheckPasteResult eResult);
  55
  56     SfxClassificationHelper(const css::uno::Reference<css::document::XDocumentProperties>& xDocumentProperties, bool bUseLocalizedPolicy = true);
  57     ~SfxClassificationHelper();
  58     /// Get the currently selected category for eType.
  59     const OUString& GetBACName(SfxClassificationPolicyType eType) const;
  60     /// Return all possible valid category names, based on the policy.
  61     std::vector<OUString> GetBACNames();
  62     /// Return all possible valid category identifiers, based on the policy.
  63     std::vector<OUString> GetBACIdentifiers();
  64     /// Get the currently selected category abbreviation for eType. Returns full name if no abbreviation defined.
  65     const OUString& GetAbbreviatedBACName(const OUString& sFullName);
  66     /// Get the currently selected category for the identifier.
  67     OUString GetBACNameForIdentifier(const OUString& sIdentifier);
  68     /// Return all possible valid abbreviated category names, based on the policy.
  69     std::vector<OUString> GetAbbreviatedBACNames();
  70     /// Setting this sets all the other properties, based on the policy.
  71     void SetBACName(const OUString& rName, SfxClassificationPolicyType eType);
  72     /// Returns the class with the higher priority (based on sensitivity).
  73     OUString GetHigherClass(const OUString& first, const OUString& second);
  74     /// If GetImpactScale() and GetImpactLevel*() will return something meaningful.
  75     bool HasImpactLevel();
  76     InfobarType GetImpactLevelType();
  77     /// Larger value means more confidential.
  78     sal_Int32 GetImpactLevel();
  79     /// Comparing the GetImpactLevel() result is only meaningful when the impact scale is the same.
  80     OUString GetImpactScale();
  81     OUString GetDocumentWatermark();
  82     /// The selected category has some content for the document header.
  83     bool HasDocumentHeader();
  84     /// The selected category has some content for the document footer.
  85     bool HasDocumentFooter();
  86     void UpdateInfobar(SfxViewFrame& rViewFrame);
  87
  88     std::vector<OUString> const & GetMarkings() const;
  89     std::vector<OUString> const & GetIntellectualPropertyParts() const;
  90     std::vector<OUString> const & GetIntellectualPropertyPartNumbers() const;
  91
  92     /// Does a best-effort conversion of rType to SfxClassificationPolicyType.
  93     static SfxClassificationPolicyType stringToPolicyType(const OUString& rType);
  94     /// Returns the string representation of a SfxClassificationPolicyType element.
  95     static const OUString& policyTypeToString(SfxClassificationPolicyType eType);
  96
  97     /// Brief text located at the top of each document's pages.
  98     static const OUString& PROP_DOCHEADER();
  99     /// Brief text located at the bottom of each document's pages.
 100     static const OUString& PROP_DOCFOOTER();
 101     /// Brief text formatted as a watermark on each document's page.
 102     static const OUString& PROP_DOCWATERMARK();
 103     /// Get the property prefix for the IntellectualProperty policy type.
 104     static const OUString& PROP_PREFIX_INTELLECTUALPROPERTY();
 105
 106     static SfxClassificationPolicyType getPolicyType();
 107 };
 108
 109 namespace sfx
 110 {
 111
 112 /// Specifies the origin: either defined by the BAF policy or manual via. the advanced classification dialog
 113 enum class ClassificationCreationOrigin
 114 {
 115     NONE,
 116     BAF_POLICY,
 117     MANUAL
 118 };
 119
 120 class ClassificationKeyCreator
 121 {
 122 private:
 123     const SfxClassificationPolicyType m_ePolicyType;
 124     const OUString m_sPolicy;
 125     sal_Int32 m_nTextNumber;
 126     sal_Int32 m_nIPPartNumber;
 127     sal_Int32 m_nMarkingNumber;
 128
 129     OUString const & getPolicyKey() const
 130     {
 131         return m_sPolicy;
 132     }
 133 public:
 134     ClassificationKeyCreator(SfxClassificationPolicyType ePolicyType)
 135         : m_ePolicyType(ePolicyType)
 136         , m_sPolicy(SfxClassificationHelper::policyTypeToString(m_ePolicyType))
 137         , m_nTextNumber(1)
 138         , m_nIPPartNumber(1)
 139         , m_nMarkingNumber(1)
 140     {}
 141
 142     OUString makeTextKey() const
 143     {
 144         return getPolicyKey() + "Custom:Text";
 145     }
 146
 147     OUString makeNumberedTextKey()
 148     {
 149         return makeTextKey() + ":n" + OUString::number(m_nTextNumber++);
 150     }
 151
 152     bool isMarkingTextKey(OUString const & aKey) const
 153     {
 154         return aKey.startsWith(makeTextKey());
 155     }
 156
 157     OUString makeCategoryNameKey() const
 158     {
 159         return getPolicyKey() + "BusinessAuthorizationCategory:Name";
 160     }
 161
 162     bool isCategoryNameKey(OUString const & aKey) const
 163     {
 164         return aKey.startsWith(makeCategoryNameKey());
 165     }
 166
 167     OUString makeCategoryIdentifierKey() const
 168     {
 169         return getPolicyKey() + "BusinessAuthorizationCategory:Identifier";
 170     }
 171
 172     bool isCategoryIdentifierKey(OUString const & aKey) const
 173     {
 174         return aKey.startsWith(makeCategoryIdentifierKey());
 175     }
 176
 177     OUString makeMarkingKey() const
 178     {
 179         return getPolicyKey() + "Custom:Marking";
 180     }
 181
 182     OUString makeNumberedMarkingKey()
 183     {
 184         return makeMarkingKey() + ":n" + OUString::number(m_nMarkingNumber++);
 185     }
 186
 187     bool isMarkingKey(OUString const & aKey) const
 188     {
 189         return aKey.startsWith(makeMarkingKey());
 190     }
 191
 192     OUString makeIntellectualPropertyPartKey() const
 193     {
 194         return getPolicyKey() + "Custom:IntellectualPropertyPart";
 195     }
 196
 197     OUString makeNumberedIntellectualPropertyPartKey()
 198     {
 199         return makeIntellectualPropertyPartKey() + ":n" + OUString::number(m_nIPPartNumber++);
 200     }
 201
 202     bool isIntellectualPropertyPartKey(OUString const & aKey) const
 203     {
 204         return aKey.startsWith(makeIntellectualPropertyPartKey());
 205     }
 206
 207     OUString makeFullTextualRepresentationKey() const
 208     {
 209         return getPolicyKey() + "Custom:FullTexturalRepresentation";
 210     }
 211
 212     /// Classification creation origin key
 213     OUString makeCreationOriginKey() const
 214     {
 215         return getPolicyKey() + "CreationOrigin";
 216     }
 217 };
 218
 219 SFX2_DLLPUBLIC sfx::ClassificationCreationOrigin getCreationOriginProperty(
 220     css::uno::Reference<css::beans::XPropertyContainer> const & rxPropertyContainer,
 221     sfx::ClassificationKeyCreator const & rKeyCreator);
 222
 223 }
 224
 225 #endif
 226
 227 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */