svt::LockFileCommon Class Reference

This is a general implementation that is used in document lock file implementation and in sharing control file implementation. More...

#include <lockfilecommon.hxx>

Inheritance diagram for svt::LockFileCommon:

Public Member Functions
	LockFileCommon (OUString aLockFileURL)
virtual	~LockFileCommon ()
const OUString &	GetURL () const
void	SetURL (const OUString &aURL)

Static Public Member Functions
static void	ParseList (const css::uno::Sequence< sal_Int8 > &aBuffer, std::vector< LockFileEntry > &rOutput)
static LockFileEntry	ParseEntry (const css::uno::Sequence< sal_Int8 > &aBuffer, sal_Int32 &o_nCurPos)
static OUString	ParseName (const css::uno::Sequence< sal_Int8 > &aBuffer, sal_Int32 &o_nCurPos)
static OUString	EscapeCharacters (const OUString &aSource)
static OUString	GetOOOUserName ()
static OUString	GetCurrentLocalTime ()
static LockFileEntry	GenerateOwnEntry ()
static INetURLObject	ResolveLinks (const INetURLObject &aDocURL)

Static Protected Member Functions
static OUString	GenerateOwnLockFileURL (std::u16string_view aOrigURL, std::u16string_view aPrefix)
	This method generates the URL of the lock file based on the document URL and the specified prefix. More...

Protected Attributes
std::mutex	m_aMutex

Private Attributes
OUString	m_aURL

Detailed Description

This is a general implementation that is used in document lock file implementation and in sharing control file implementation.

Definition at line 44 of file lockfilecommon.hxx.

Constructor & Destructor Documentation

LockFileCommon()

svt::LockFileCommon::LockFileCommon

(

OUString

aLockFileURL

)

Definition at line 50 of file lockfilecommon.cxx.

References m_aURL.

~LockFileCommon()

svt::LockFileCommon::~LockFileCommon ( )

virtual

Definition at line 55 of file lockfilecommon.cxx.

Member Function Documentation

EscapeCharacters()

OUString svt::LockFileCommon::EscapeCharacters ( const OUString &  aSource )

static

Definition at line 170 of file lockfilecommon.cxx.

References aBuffer.

Referenced by svt::ShareControlFile::SetUsersDataAndStore(), and svt::DocumentLockFile::WriteEntryToStream().

GenerateOwnEntry()

LockFileEntry svt::LockFileCommon::GenerateOwnEntry ( )

static

Definition at line 222 of file lockfilecommon.cxx.

References EDITTIME, GetCurrentLocalTime(), GetOOOUserName(), LOCALHOST, utl::Bootstrap::locateUserInstallation(), OOOUSERNAME, SYSUSERNAME, and USERURL.

Referenced by svt::GenDocumentLockFile::CreateOwnLockFile(), svt::ShareControlFile::HasOwnEntry(), svt::ShareControlFile::InsertOwnEntry(), svt::GenDocumentLockFile::OverwriteOwnLockFile(), svt::ShareControlFile::RemoveEntry(), svt::GenDocumentLockFile::RemoveFile(), and svt::MSODocumentLockFile::RemoveFile().

GenerateOwnLockFileURL()

OUString svt::LockFileCommon::GenerateOwnLockFileURL ( std::u16string_view  aOrigURL, std::u16string_view  aPrefix  )

staticprotected

This method generates the URL of the lock file based on the document URL and the specified prefix.

Definition at line 72 of file lockfilecommon.cxx.

References aURL, INetURLObject::NONE, and ResolveLinks().

GetCurrentLocalTime()

OUString svt::LockFileCommon::GetCurrentLocalTime ( )

static

Definition at line 197 of file lockfilecommon.cxx.

References o3tl::sprintf().

Referenced by GenerateOwnEntry().

GetOOOUserName()

OUString svt::LockFileCommon::GetOOOUserName ( )

static

Definition at line 185 of file lockfilecommon.cxx.

References aName, SvtUserOptions::GetFirstName(), and SvtUserOptions::GetLastName().

Referenced by GenerateOwnEntry().

GetURL()

const OUString & svt::LockFileCommon::GetURL

(

)

const

Definition at line 60 of file lockfilecommon.cxx.

References m_aURL.

Referenced by svt::GenDocumentLockFile::CreateOwnLockFile(), svt::GenDocumentLockFile::OpenStream(), svt::MSODocumentLockFile::OpenStream(), svt::GenDocumentLockFile::OverwriteOwnLockFile(), svt::GenDocumentLockFile::RemoveFileDirectly(), svt::ShareControlFile::RemoveFileImpl(), and svt::ShareControlFile::ShareControlFile().

ParseEntry()

LockFileEntry svt::LockFileCommon::ParseEntry ( const css::uno::Sequence< sal_Int8 > &  aBuffer, sal_Int32 &  o_nCurPos  )

static

Definition at line 115 of file lockfilecommon.cxx.

References aBuffer, LAST, and ParseName().

Referenced by svt::DocumentLockFile::GetLockDataImpl(), and ParseList().

ParseList()

void svt::LockFileCommon::ParseList ( const css::uno::Sequence< sal_Int8 > &  aBuffer, std::vector< LockFileEntry > &  rOutput  )

static

Definition at line 105 of file lockfilecommon.cxx.

References aBuffer, and ParseEntry().

Referenced by svt::ShareControlFile::GetUsersDataImpl().

ParseName()

OUString svt::LockFileCommon::ParseName ( const css::uno::Sequence< sal_Int8 > &  aBuffer, sal_Int32 &  o_nCurPos  )

static

Definition at line 132 of file lockfilecommon.cxx.

References aBuffer.

Referenced by ParseEntry().

ResolveLinks()

INetURLObject svt::LockFileCommon::ResolveLinks ( const INetURLObject &  aDocURL )

static

Definition at line 81 of file lockfilecommon.cxx.

References salhelper::LinkResolver::fetchFileStatus(), INetURLObject::GetMainURL(), INetURLObject::HasError(), salhelper::LinkResolver::m_aStatus, and INetURLObject::NONE.

Referenced by GenerateOwnLockFileURL(), svt::MSODocumentLockFile::getAppType(), and svt::MSODocumentLockFile::IsMSOSupportedFileFormat().

SetURL()

void svt::LockFileCommon::SetURL

(

const OUString &

aURL

)

Definition at line 66 of file lockfilecommon.cxx.

References aURL, and m_aURL.

Member Data Documentation

m_aMutex

std::mutex svt::LockFileCommon::m_aMutex

protected

Definition at line 50 of file lockfilecommon.hxx.

Referenced by svt::GenDocumentLockFile::CreateOwnLockFile(), svt::GenDocumentLockFile::GetLockData(), svt::ShareControlFile::GetUsersData(), svt::ShareControlFile::HasOwnEntry(), svt::ShareControlFile::InsertOwnEntry(), svt::GenDocumentLockFile::OverwriteOwnLockFile(), svt::ShareControlFile::RemoveEntry(), svt::GenDocumentLockFile::RemoveFile(), svt::ShareControlFile::RemoveFile(), and svt::MSODocumentLockFile::RemoveFile().

m_aURL

OUString svt::LockFileCommon::m_aURL

private

Definition at line 47 of file lockfilecommon.hxx.

Referenced by GetURL(), and SetURL().

---

The documentation for this class was generated from the following files:

• lockfilecommon.hxx
• lockfilecommon.cxx