| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef _FILTASK_HXX_ |
| #define _FILTASK_HXX_ |
| #endif |
| |
| #include <hash_map> |
| #include <rtl/ustring.hxx> |
| |
| #include "osl/mutex.hxx" |
| #include <com/sun/star/ucb/DuplicateCommandIdentifierException.hpp> |
| #include <com/sun/star/ucb/XCommandEnvironment.hpp> |
| #include <com/sun/star/ucb/XProgressHandler.hpp> |
| #include <com/sun/star/task/XInteractionHandler.hpp> |
| #include <com/sun/star/task/XInteractionRequest.hpp> |
| #include "filerror.hxx" |
| |
| |
| namespace fileaccess |
| { |
| class BaseContent; |
| |
| /* |
| * This implementation is inherited by class fileaccess::shell. |
| * The relevant methods in this class all have as first argument the CommandId, |
| * so if necessary, every method has access to its relevant XInteractionHandler and |
| * XProgressHandler. |
| */ |
| |
| |
| class TaskManager |
| { |
| protected: |
| |
| class TaskHandling |
| { |
| private: |
| |
| bool m_bAbort,m_bHandled; |
| sal_Int32 m_nErrorCode,m_nMinorCode; |
| com::sun::star::uno::Reference< com::sun::star::task::XInteractionHandler > m_xInteractionHandler; |
| com::sun::star::uno::Reference< com::sun::star::ucb::XProgressHandler > m_xProgressHandler; |
| com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > m_xCommandEnvironment; |
| |
| |
| public: |
| |
| TaskHandling( |
| const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& xCommandEnv |
| = com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >( 0 ) ) |
| : m_bAbort( false ), |
| m_bHandled( false ), |
| m_nErrorCode( TASKHANDLER_NO_ERROR ), |
| m_nMinorCode( TASKHANDLER_NO_ERROR ), |
| m_xInteractionHandler( 0 ), |
| m_xProgressHandler( 0 ), |
| m_xCommandEnvironment( xCommandEnv ) |
| { |
| } |
| |
| void SAL_CALL abort() |
| { |
| m_bAbort = true; |
| } |
| |
| void setHandled() |
| { |
| m_bHandled = true; |
| } |
| |
| bool isHandled() |
| { |
| return true; |
| } |
| |
| void clearError() |
| { |
| m_nErrorCode = TASKHANDLER_NO_ERROR; |
| m_nMinorCode = TASKHANDLER_NO_ERROR; |
| } |
| |
| void SAL_CALL installError( sal_Int32 nErrorCode, |
| sal_Int32 nMinorCode = TASKHANDLER_NO_ERROR ) |
| { |
| m_nErrorCode = nErrorCode; |
| m_nMinorCode = nMinorCode; |
| } |
| |
| sal_Int32 SAL_CALL getInstalledError() |
| { |
| return m_nErrorCode; |
| } |
| |
| sal_Int32 SAL_CALL getMinorErrorCode() |
| { |
| return m_nMinorCode; |
| } |
| |
| com::sun::star::uno::Reference< com::sun::star::ucb::XProgressHandler > SAL_CALL |
| getProgressHandler() |
| { |
| if( ! m_xProgressHandler.is() && m_xCommandEnvironment.is() ) |
| m_xProgressHandler = m_xCommandEnvironment->getProgressHandler(); |
| |
| return m_xProgressHandler; |
| } |
| |
| com::sun::star::uno::Reference< com::sun::star::task::XInteractionHandler > SAL_CALL |
| getInteractionHandler() |
| { |
| if( ! m_xInteractionHandler.is() && m_xCommandEnvironment.is() ) |
| m_xInteractionHandler = m_xCommandEnvironment->getInteractionHandler(); |
| |
| return m_xInteractionHandler; |
| } |
| |
| com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > SAL_CALL |
| getCommandEnvironment() |
| { |
| return m_xCommandEnvironment; |
| } |
| |
| }; // end class TaskHandling |
| |
| |
| typedef std::hash_map< sal_Int32,TaskHandling,std::hash< sal_Int32 > > TaskMap; |
| |
| |
| private: |
| |
| osl::Mutex m_aMutex; |
| sal_Int32 m_nCommandId; |
| TaskMap m_aTaskMap; |
| |
| |
| public: |
| |
| TaskManager(); |
| virtual ~TaskManager(); |
| |
| void SAL_CALL startTask( |
| sal_Int32 CommandId, |
| const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& xCommandEnv ) |
| throw( com::sun::star::ucb::DuplicateCommandIdentifierException ); |
| |
| sal_Int32 SAL_CALL getCommandId( void ); |
| void SAL_CALL abort( sal_Int32 CommandId ); |
| |
| |
| /** |
| * The error code may be one of the error codes defined in |
| * filerror.hxx. |
| * The minor code refines the information given in ErrorCode. |
| */ |
| |
| void SAL_CALL clearError(); |
| |
| void SAL_CALL installError( sal_Int32 CommandId, |
| sal_Int32 ErrorCode, |
| sal_Int32 minorCode = TASKHANDLER_NO_ERROR ); |
| |
| |
| // void SAL_CALL installError( sal_Int32 CommandId, |
| // sal_Int32 ErrorCode, |
| // rtl::OUString message ); |
| |
| // void SAL_CALL installError( sal_Int32 CommandId, |
| // sal_Int32 ErrorCode, |
| // rtl::OUString message ); |
| |
| void SAL_CALL retrieveError( sal_Int32 CommandId, |
| sal_Int32 &ErrorCode, |
| sal_Int32 &minorCode); |
| |
| /** |
| * Deinstalls the task and evaluates a possibly set error code. |
| * "endTask" throws in case an error code is set the corresponding exception. |
| */ |
| |
| void SAL_CALL endTask( sal_Int32 CommandId, |
| // the physical URL of the object |
| const rtl::OUString& aUnqPath, |
| BaseContent* pContent); |
| |
| |
| /** |
| * Handles an interactionrequest |
| */ |
| |
| void SAL_CALL handleTask( sal_Int32 CommandId, |
| const com::sun::star::uno::Reference< com::sun::star::task::XInteractionRequest >& request ); |
| |
| /** |
| * Clears any error which are set on the commandid |
| */ |
| |
| void SAL_CALL clearError( sal_Int32 ); |
| |
| }; |
| |
| } // end namespace TaskHandling |
