include/svl/lockfilecommon.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_SVL_LOCKFILECOMMON_HXX
  21 #define INCLUDED_SVL_LOCKFILECOMMON_HXX
  22
  23 #include <svl/svldllapi.h>
  24
  25 #include <com/sun/star/uno/Sequence.hxx>
  26
  27 #include <tools/urlobj.hxx>
  28 #include <o3tl/enumarray.hxx>
  29
  30 #include <mutex>
  31 #include <string_view>
  32 #include <vector>
  33
  34 enum class LockFileComponent
  35 {
  36     OOOUSERNAME, SYSUSERNAME, LOCALHOST, EDITTIME, USERURL, LAST=USERURL
  37 };
  38
  39 typedef o3tl::enumarray<LockFileComponent,OUString> LockFileEntry;
  40
  41 namespace svt {
  42
  43 /// This is a general implementation that is used in document lock file implementation and in sharing control file implementation
  44 class SVL_DLLPUBLIC LockFileCommon
  45 {
  46 private:
  47     OUString m_aURL;
  48
  49 protected:
  50     std::mutex m_aMutex;
  51
  52     /// This method generates the URL of the lock file based on the document URL and the specified prefix.
  53     static OUString GenerateOwnLockFileURL(std::u16string_view aOrigURL, std::u16string_view aPrefix);
  54
  55 public:
  56     LockFileCommon(OUString aLockFileURL);
  57     virtual ~LockFileCommon();
  58
  59     const OUString& GetURL() const;
  60     void SetURL(const OUString& aURL);
  61
  62     static void ParseList( const css::uno::Sequence< sal_Int8 >& aBuffer, std::vector< LockFileEntry > &rOutput );
  63     static LockFileEntry ParseEntry( const css::uno::Sequence< sal_Int8 >& aBuffer, sal_Int32& o_nCurPos );
  64     static OUString ParseName( const css::uno::Sequence< sal_Int8 >& aBuffer, sal_Int32& o_nCurPos );
  65     static OUString EscapeCharacters( const OUString& aSource );
  66     static OUString GetOOOUserName();
  67     static OUString GetCurrentLocalTime();
  68     static LockFileEntry GenerateOwnEntry();
  69
  70     static INetURLObject ResolveLinks( const INetURLObject& aDocURL );
  71 };
  72
  73 }
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */