backupfilehelper.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_COMPHELPER_BACKUPFILEHELPER_HXX
#define INCLUDED_COMPHELPER_BACKUPFILEHELPER_HXX
 
#include <sal/config.h>
 
#include <comphelper/comphelperdllapi.h>
#include <rtl/ustring.hxx>
#include <set>
#include <string_view>
#include <vector>
 
namespace comphelper
{
    class COMPHELPER_DLLPUBLIC BackupFileHelper
    {
    private:
        // internal data
        std::set< OUString >    maDirs;
        std::set< std::pair< OUString, OUString > > maFiles;
 
        sal_uInt16              mnNumBackups;
        sal_uInt16              mnMode;
 
        bool                    mbActive;
        bool                    mbExtensions;
        bool                    mbCompress;
 
        // internal flag if _exit() was called already - a hint to evtl.
        // not create copies of potentially not well-defined data. This
        // may be used in destructors of static instances - which unfortunately
        // get called on WNT but not on linux. Thus I thought about encapsulating
        // in some '#ifdefs', but it's just more safe to always do it and
        // allows to add a SAL_WARN when one of these destructors is called
        // after _exit()
        static bool         mbExitWasCalled;
 
        // internal detector if SafeModeName dir exists
        static bool         mbSafeModeDirExists;
 
        // internal upper limit (max) of allowed backups
        static sal_uInt16   mnMaxAllowedBackups;
 
        // path to User's configuration directory and derived strings
        static OUString     maInitialBaseURL;
        static OUString     maUserConfigBaseURL;
        static OUString     maUserConfigWorkURL;
        static OUString     maRegModName;
        static OUString     maExt;
 
        // get path to User's configuration directory (created on-demand)
        static const OUString& getInitialBaseURL();
 
        // the name of the SafeMode directory for temporary processing
        static const OUString& getSafeModeName();
 
    public:
        BackupFileHelper();
 
        // allow to set static global flag when app had to call _exit()
        static void setExitWasCalled();
        static bool getExitWasCalled();
 
        // This call initializes the state of the UserDirectory as needed, it may
        // initialize to SafeMode configuration or return from it by moving files
        // in that directory
        static void reactOnSafeMode(bool bSafeMode);
 
        void tryPush();
        void tryPushExtensionInfo();
 
        bool isPopPossible();
        bool isPopPossibleExtensionInfo() const;
 
        void tryPop();
        void tryPopExtensionInfo();
 
        static bool isTryDisableAllExtensionsPossible();
        static void tryDisableAllExtensions();
 
        static bool isTryDeinstallUserExtensionsPossible();
        static void tryDeinstallUserExtensions();
 
        static bool isTryResetSharedExtensionsPossible();
        static void tryResetSharedExtensions();
 
        static bool isTryResetBundledExtensionsPossible();
        static void tryResetBundledExtensions();
 
        static void tryDisableHWAcceleration();
 
        static bool isTryResetCustomizationsPossible();
        static void tryResetCustomizations();
 
        static void tryResetUserProfile();
 
        static const OUString& getUserProfileURL();
 
        static const OUString& getUserProfileWorkURL();
 
    private:
        // internal helper methods
        static OUString getPackURL();
        static const std::vector< OUString >& getCustomizationDirNames();
        static const std::vector< OUString >& getCustomizationFileNames();
 
        // file push helpers
        bool tryPush_Files(const std::set< OUString >& rDirs, const std::set< std::pair< OUString, OUString > >& rFiles, std::u16string_view rSourceURL, const OUString& rTargetURL);
        bool tryPush_file(std::u16string_view rSourceURL, std::u16string_view rTargetURL, std::u16string_view rName, std::u16string_view rExt);
 
        // file pop possibilities helper
        bool isPopPossible_files(const std::set< OUString >& rDirs, const std::set< std::pair< OUString, OUString > >& rFiles, std::u16string_view rSourceURL, std::u16string_view rTargetURL);
        static bool isPopPossible_file(std::u16string_view rSourceURL, std::u16string_view rTargetURL, std::u16string_view rName, std::u16string_view rExt);
 
        // file pop helpers
        bool tryPop_files(const std::set< OUString >& rDirs, const std::set< std::pair< OUString, OUString > >& rFiles, std::u16string_view rSourceURL, const OUString& rTargetURL);
        bool tryPop_file(std::u16string_view rSourceURL, std::u16string_view rTargetURL, std::u16string_view rName, std::u16string_view rExt);
 
        // ExtensionInfo helpers
        bool tryPush_extensionInfo(std::u16string_view rTargetURL);
        static bool isPopPossible_extensionInfo(std::u16string_view rTargetURL);
        bool tryPop_extensionInfo(std::u16string_view rTargetURL);
 
        // FileDirInfo helpers
        void fillDirFileInfo();
    };
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */