office-gobmx/desktop/source/app/lockfile.hxx

103 lines
3.3 KiB
C++
Raw Normal View History

2002-09-30 09:24:07 -05:00
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2002-09-30 09:24:07 -05:00
*
* Copyright 2008 by Sun Microsystems, Inc.
2002-09-30 09:24:07 -05:00
*
* OpenOffice.org - a multi-platform office productivity suite
2002-09-30 09:24:07 -05:00
*
* $RCSfile: lockfile.hxx,v $
* $Revision: 1.12 $
2002-09-30 09:24:07 -05:00
*
* This file is part of OpenOffice.org.
2002-09-30 09:24:07 -05:00
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
2002-09-30 09:24:07 -05:00
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
2002-09-30 09:24:07 -05:00
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
2002-09-30 09:24:07 -05:00
*
************************************************************************/
/* Information:
* This class implements a mechanism to lock a users installation directory,
* which is necessesary because instances of staroffice could be running on
* different hosts while using the same directory thus causing data
* inconsistency.
* When an existing lock is detected, the user will be asked whether he wants
* to continue anyway, thus removing the lock and replacing it with a new one
*
* ideas:
* - store information about user and host and time in the lockfile and display
* these when asking whether to remove the lockfile.
* - periodically check the lockfile and warn the user when it gets replaced
*
*/
#include "sal/types.h"
#include "rtl/ustring.hxx"
class ByteString;
2002-09-30 09:24:07 -05:00
namespace desktop {
class Lockfile;
bool Lockfile_execWarning( Lockfile * that );
2002-09-30 09:24:07 -05:00
class Lockfile
{
public:
// contructs a new lockfile onject
Lockfile( bool bIPCserver = true );
// separating GUI code:
typedef bool (* fpExecWarning)( Lockfile * that );
2002-09-30 09:24:07 -05:00
2002-11-06 07:44:49 -06:00
// checks the lockfile, asks user when lockfile is
// found (iff gui) and returns false when we may not continue
sal_Bool check( fpExecWarning execWarning );
2002-09-30 09:24:07 -05:00
2002-11-06 07:44:49 -06:00
// removes the lockfile. should only be called in exceptional situations
void clean(void);
2002-09-30 09:24:07 -05:00
// removes the lockfile
~Lockfile(void);
private:
// data in lockfile
static const ByteString Group();
static const ByteString Userkey();
static const ByteString Hostkey();
static const ByteString Stampkey();
static const ByteString Timekey();
static const ByteString IPCkey();
2002-09-30 09:24:07 -05:00
// lockfilename
static const rtl::OUString Suffix();
bool m_bIPCserver;
2002-09-30 09:24:07 -05:00
// full qualified name (file://-url) of the lockfile
rtl::OUString m_aLockname;
2002-09-30 09:24:07 -05:00
// flag whether the d'tor should delete the lock
sal_Bool m_bRemove;
2002-10-24 09:44:30 -05:00
sal_Bool m_bIsLocked;
2002-09-30 09:24:07 -05:00
// ID
rtl::OUString m_aId;
rtl::OUString m_aDate;
2002-09-30 09:24:07 -05:00
// access to data in file
void syncToFile(void) const;
sal_Bool isStale(void) const;
friend bool Lockfile_execWarning( Lockfile * that );
2002-09-30 09:24:07 -05:00
};
}