1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef _SVT_DOCUMENTLOCKFILE_HXX 25 #define _SVT_DOCUMENTLOCKFILE_HXX 26 27 #include <svl/svldllapi.h> 28 29 #include <com/sun/star/io/XStream.hpp> 30 #include <com/sun/star/io/XInputStream.hpp> 31 #include <com/sun/star/io/XOutputStream.hpp> 32 #include <com/sun/star/io/XSeekable.hpp> 33 #include <com/sun/star/io/XTruncate.hpp> 34 #include <com/sun/star/lang/XMultiServiceFactory.hpp> 35 36 #include <svl/lockfilecommon.hxx> 37 38 namespace svt { 39 40 class SVL_DLLPUBLIC DocumentLockFile : public LockFileCommon 41 { 42 // the workaround for automated testing! 43 static sal_Bool m_bAllowInteraction; 44 45 ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > OpenStream(); 46 47 void WriteEntryToStream( ::com::sun::star::uno::Sequence< ::rtl::OUString > aEntry, ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > xStream ); 48 49 public: 50 DocumentLockFile( const ::rtl::OUString& aOrigURL, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xFactory = ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >() ); 51 ~DocumentLockFile(); 52 53 sal_Bool CreateOwnLockFile(); 54 ::com::sun::star::uno::Sequence< ::rtl::OUString > GetLockData(); 55 sal_Bool OverwriteOwnLockFile(); 56 void RemoveFile(); 57 58 // the methods allow to control whether UI interaction regarding the locked document file is allowed 59 // this is a workaround for automated tests AllowInteraction(sal_Bool bAllow)60 static void AllowInteraction( sal_Bool bAllow ) { m_bAllowInteraction = bAllow; } IsInteractionAllowed()61 static sal_Bool IsInteractionAllowed() { return m_bAllowInteraction; } 62 }; 63 64 } 65 66 #endif 67 68