classificationhelper.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#ifndef INCLUDED_SFX2_CLASSIFICATIONHELPER_HXX
#define INCLUDED_SFX2_CLASSIFICATIONHELPER_HXX
 
#include <memory>
#include <string_view>
#include <vector>
 
#include <o3tl/string_view.hxx>
#include <rtl/ustring.hxx>
#include <sfx2/dllapi.h>
#include <sfx2/infobar.hxx>
 
namespace com::sun::star::beans
{
class XPropertyContainer;
}
namespace com::sun::star::document
{
class XDocumentProperties;
}
 
class SfxViewFrame;
 
enum class SfxClassificationCheckPasteResult
{
    None = 1,
    TargetDocNotClassified = 2,
    DocClassificationTooLow = 3
};
 
enum class SfxClassificationPolicyType
{
    ExportControl = 1,
    NationalSecurity = 2,
    IntellectualProperty = 3
};
 
class SFX2_DLLPUBLIC SfxClassificationHelper
{
    class SAL_DLLPRIVATE Impl;
    std::unique_ptr<Impl> m_pImpl;
 
public:
    static bool IsClassified(
        const css::uno::Reference<css::document::XDocumentProperties>& xDocumentProperties);
    static SfxClassificationCheckPasteResult
    CheckPaste(const css::uno::Reference<css::document::XDocumentProperties>& xSource,
               const css::uno::Reference<css::document::XDocumentProperties>& xDestination);
    static bool ShowPasteInfo(SfxClassificationCheckPasteResult eResult);
 
    SfxClassificationHelper(
        const css::uno::Reference<css::document::XDocumentProperties>& xDocumentProperties,
        bool bUseLocalizedPolicy = true);
    ~SfxClassificationHelper();
    const OUString& GetBACName(SfxClassificationPolicyType eType) const;
    std::vector<OUString> GetBACNames();
    std::vector<OUString> GetBACIdentifiers();
    const OUString& GetAbbreviatedBACName(const OUString& sFullName);
    OUString GetBACNameForIdentifier(std::u16string_view sIdentifier);
    std::vector<OUString> GetAbbreviatedBACNames();
    void SetBACName(const OUString& rName, SfxClassificationPolicyType eType);
    OUString GetHigherClass(const OUString& first, const OUString& second);
    bool HasImpactLevel();
    InfobarType GetImpactLevelType();
    sal_Int32 GetImpactLevel();
    OUString GetImpactScale();
    OUString GetDocumentWatermark();
    bool HasDocumentHeader();
    bool HasDocumentFooter();
    void UpdateInfobar(SfxViewFrame& rViewFrame);
 
    std::vector<OUString> const& GetMarkings() const;
    std::vector<OUString> const& GetIntellectualPropertyParts() const;
    std::vector<OUString> const& GetIntellectualPropertyPartNumbers() const;
 
    static SfxClassificationPolicyType stringToPolicyType(std::u16string_view rType);
    static const OUString& policyTypeToString(SfxClassificationPolicyType eType);
 
    static const OUString& PROP_DOCHEADER();
    static const OUString& PROP_DOCFOOTER();
    static const OUString& PROP_DOCWATERMARK();
    static const OUString& PROP_PREFIX_INTELLECTUALPROPERTY();
 
    static SfxClassificationPolicyType getPolicyType();
};
 
namespace sfx
{
enum class ClassificationCreationOrigin
{
    NONE,
    BAF_POLICY,
    MANUAL
};
 
class ClassificationKeyCreator
{
private:
    const SfxClassificationPolicyType m_ePolicyType;
    const OUString m_sPolicy;
    sal_Int32 m_nTextNumber;
    sal_Int32 m_nIPPartNumber;
    sal_Int32 m_nMarkingNumber;
 
    OUString const& getPolicyKey() const { return m_sPolicy; }
 
public:
    ClassificationKeyCreator(SfxClassificationPolicyType ePolicyType)
        : m_ePolicyType(ePolicyType)
        , m_sPolicy(SfxClassificationHelper::policyTypeToString(m_ePolicyType))
        , m_nTextNumber(1)
        , m_nIPPartNumber(1)
        , m_nMarkingNumber(1)
    {
    }
 
    OUString makeTextKey() const { return getPolicyKey() + "Custom:Text"; }
 
    OUString makeNumberedTextKey()
    {
        return makeTextKey() + ":n" + OUString::number(m_nTextNumber++);
    }
 
    bool isMarkingTextKey(std::u16string_view aKey) const
    {
        return o3tl::starts_with(aKey, makeTextKey());
    }
 
    OUString makeCategoryNameKey() const
    {
        return getPolicyKey() + "BusinessAuthorizationCategory:Name";
    }
 
    bool isCategoryNameKey(std::u16string_view aKey) const
    {
        return o3tl::starts_with(aKey, makeCategoryNameKey());
    }
 
    OUString makeCategoryIdentifierKey() const
    {
        return getPolicyKey() + "BusinessAuthorizationCategory:Identifier";
    }
 
    bool isCategoryIdentifierKey(std::u16string_view aKey) const
    {
        return o3tl::starts_with(aKey, makeCategoryIdentifierKey());
    }
 
    OUString makeMarkingKey() const { return getPolicyKey() + "Custom:Marking"; }
 
    OUString makeNumberedMarkingKey()
    {
        return makeMarkingKey() + ":n" + OUString::number(m_nMarkingNumber++);
    }
 
    bool isMarkingKey(std::u16string_view aKey) const
    {
        return o3tl::starts_with(aKey, makeMarkingKey());
    }
 
    OUString makeIntellectualPropertyPartKey() const
    {
        return getPolicyKey() + "Custom:IntellectualPropertyPart";
    }
 
    OUString makeNumberedIntellectualPropertyPartKey()
    {
        return makeIntellectualPropertyPartKey() + ":n" + OUString::number(m_nIPPartNumber++);
    }
 
    bool isIntellectualPropertyPartKey(std::u16string_view aKey) const
    {
        return o3tl::starts_with(aKey, makeIntellectualPropertyPartKey());
    }
 
    OUString makeFullTextualRepresentationKey() const
    {
        return getPolicyKey() + "Custom:FullTexturalRepresentation";
    }
 
    OUString makeCreationOriginKey() const { return getPolicyKey() + "CreationOrigin"; }
};
 
SFX2_DLLPUBLIC sfx::ClassificationCreationOrigin getCreationOriginProperty(
    css::uno::Reference<css::beans::XPropertyContainer> const& rxPropertyContainer,
    sfx::ClassificationKeyCreator const& rKeyCreator);
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */