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