1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski /* Information: 25*b1cdbd2cSJim Jagielski * This class implements a mechanism to lock a users installation directory, 26*b1cdbd2cSJim Jagielski * which is necessesary because instances of staroffice could be running on 27*b1cdbd2cSJim Jagielski * different hosts while using the same directory thus causing data 28*b1cdbd2cSJim Jagielski * inconsistency. 29*b1cdbd2cSJim Jagielski * When an existing lock is detected, the user will be asked whether he wants 30*b1cdbd2cSJim Jagielski * to continue anyway, thus removing the lock and replacing it with a new one 31*b1cdbd2cSJim Jagielski * 32*b1cdbd2cSJim Jagielski * ideas: 33*b1cdbd2cSJim Jagielski * - store information about user and host and time in the lockfile and display 34*b1cdbd2cSJim Jagielski * these when asking whether to remove the lockfile. 35*b1cdbd2cSJim Jagielski * - periodically check the lockfile and warn the user when it gets replaced 36*b1cdbd2cSJim Jagielski * 37*b1cdbd2cSJim Jagielski */ 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski #include "sal/types.h" 40*b1cdbd2cSJim Jagielski #include "rtl/ustring.hxx" 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski class ByteString; 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski namespace desktop { 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski class Lockfile; 47*b1cdbd2cSJim Jagielski bool Lockfile_execWarning( Lockfile * that ); 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski class Lockfile 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski public: 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski // contructs a new lockfile onject 54*b1cdbd2cSJim Jagielski Lockfile( bool bIPCserver = true ); 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski // separating GUI code: 57*b1cdbd2cSJim Jagielski typedef bool (* fpExecWarning)( Lockfile * that ); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski // checks the lockfile, asks user when lockfile is 60*b1cdbd2cSJim Jagielski // found (iff gui) and returns false when we may not continue 61*b1cdbd2cSJim Jagielski sal_Bool check( fpExecWarning execWarning ); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski // removes the lockfile. should only be called in exceptional situations 64*b1cdbd2cSJim Jagielski void clean(void); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski // removes the lockfile 67*b1cdbd2cSJim Jagielski ~Lockfile(void); 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski private: 70*b1cdbd2cSJim Jagielski // data in lockfile 71*b1cdbd2cSJim Jagielski static const ByteString Group(); 72*b1cdbd2cSJim Jagielski static const ByteString Userkey(); 73*b1cdbd2cSJim Jagielski static const ByteString Hostkey(); 74*b1cdbd2cSJim Jagielski static const ByteString Stampkey(); 75*b1cdbd2cSJim Jagielski static const ByteString Timekey(); 76*b1cdbd2cSJim Jagielski static const ByteString IPCkey(); 77*b1cdbd2cSJim Jagielski // lockfilename 78*b1cdbd2cSJim Jagielski static const rtl::OUString Suffix(); 79*b1cdbd2cSJim Jagielski bool m_bIPCserver; 80*b1cdbd2cSJim Jagielski // full qualified name (file://-url) of the lockfile 81*b1cdbd2cSJim Jagielski rtl::OUString m_aLockname; 82*b1cdbd2cSJim Jagielski // flag whether the d'tor should delete the lock 83*b1cdbd2cSJim Jagielski sal_Bool m_bRemove; 84*b1cdbd2cSJim Jagielski sal_Bool m_bIsLocked; 85*b1cdbd2cSJim Jagielski // ID 86*b1cdbd2cSJim Jagielski rtl::OUString m_aId; 87*b1cdbd2cSJim Jagielski rtl::OUString m_aDate; 88*b1cdbd2cSJim Jagielski // access to data in file 89*b1cdbd2cSJim Jagielski void syncToFile(void) const; 90*b1cdbd2cSJim Jagielski sal_Bool isStale(void) const; 91*b1cdbd2cSJim Jagielski friend bool Lockfile_execWarning( Lockfile * that ); 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski }; 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski } 96