1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef DBACCESS_MIGRATIONLOG_HXX 29*cdf0e10cSrcweir #define DBACCESS_MIGRATIONLOG_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include "dbmm_types.hxx" 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir /** === begin UNO includes === **/ 34*cdf0e10cSrcweir /** === end UNO includes === **/ 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir #include <rtl/ustring.hxx> 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir #include <memory> 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir //........................................................................ 41*cdf0e10cSrcweir namespace dbmm 42*cdf0e10cSrcweir { 43*cdf0e10cSrcweir //........................................................................ 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir typedef sal_Int16 DocumentID; 46*cdf0e10cSrcweir struct MigrationError; 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir //==================================================================== 49*cdf0e10cSrcweir //= MigrationLog 50*cdf0e10cSrcweir //==================================================================== 51*cdf0e10cSrcweir struct MigrationLog_Data; 52*cdf0e10cSrcweir class MigrationLog 53*cdf0e10cSrcweir { 54*cdf0e10cSrcweir public: 55*cdf0e10cSrcweir MigrationLog(); 56*cdf0e10cSrcweir ~MigrationLog(); 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir //---------------------------------------------------------------- 59*cdf0e10cSrcweir //- event logging 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir /** logs an unrecoverable error during the migration process 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir void logFailure( const MigrationError& _rError ); 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** logs a recoverable (or at least ignorable) error during the migration process 66*cdf0e10cSrcweir */ 67*cdf0e10cSrcweir void logRecoverable( const MigrationError& _rError ); 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir /// checks whether logFailure has been called 70*cdf0e10cSrcweir bool hadFailure() const; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /// logs the fact that the database document has been backed up 73*cdf0e10cSrcweir void backedUpDocument( const ::rtl::OUString& _rNewDocumentLocation ); 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** logs that the migration for a certain sub document has been started, returns 76*cdf0e10cSrcweir a unique ID for this sub document which is to be used in later calls 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir DocumentID startedDocument( const SubDocumentType _eType, const ::rtl::OUString& _rName ); 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir /** logs the event that a macro or script library has been moved from within a 81*cdf0e10cSrcweir sub document to the database document 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir void movedLibrary( 84*cdf0e10cSrcweir const DocumentID _nDocID, 85*cdf0e10cSrcweir const ScriptType _eScriptType, 86*cdf0e10cSrcweir const ::rtl::OUString& _rOriginalLibName, 87*cdf0e10cSrcweir const ::rtl::OUString& _rNewLibName 88*cdf0e10cSrcweir ); 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir /** logs that the migration for a certain document has been finished 91*cdf0e10cSrcweir */ 92*cdf0e10cSrcweir void finishedDocument( const DocumentID _nDocID ); 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir //---------------------------------------------------------------- 95*cdf0e10cSrcweir //- information retrieval 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir /** retrieves the new name of a library 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir The new library name must previously have been logger by calling 100*cdf0e10cSrcweir <member>movedLibrary</member>. If not, an assertion will be raised in 101*cdf0e10cSrcweir the non-product builds, and an empty string will be returned. 102*cdf0e10cSrcweir */ 103*cdf0e10cSrcweir const ::rtl::OUString& 104*cdf0e10cSrcweir getNewLibraryName( 105*cdf0e10cSrcweir DocumentID _nDocID, 106*cdf0e10cSrcweir ScriptType _eScriptType, 107*cdf0e10cSrcweir const ::rtl::OUString& _rOriginalLibName 108*cdf0e10cSrcweir ) const; 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir /** determines whether for the given document, any library needed to be (and was) moved 111*cdf0e10cSrcweir */ 112*cdf0e10cSrcweir bool movedAnyLibrary( const DocumentID ); 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir /** provides a human-readable version of the log, explaining a user what happened during 115*cdf0e10cSrcweir the migration. 116*cdf0e10cSrcweir */ 117*cdf0e10cSrcweir ::rtl::OUString 118*cdf0e10cSrcweir getCompleteLog() const; 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir private: 121*cdf0e10cSrcweir ::std::auto_ptr< MigrationLog_Data > m_pData; 122*cdf0e10cSrcweir }; 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir //........................................................................ 125*cdf0e10cSrcweir } // namespace dbmm 126*cdf0e10cSrcweir //........................................................................ 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir #endif // DBACCESS_MIGRATIONLOG_HXX 129