INTEGRATION: CWS dba24c (1.1.2); FILE ADDED

2007/10/23 05:31:09 fs 1.1.2.5: adjusted comment to reality
2007/10/22 10:23:03 fs 1.1.2.4: #i52527#/#i73705#: checkForBrokenScriptingSignature->showBrokenSignatureWarning
2007/10/22 08:22:14 fs 1.1.2.3: in preparation of #i52527#/#i73705#: extended comments
2007/10/18 09:22:52 fs 1.1.2.2: in preparation of #i52527#/#i73705#: outsourced more code from SfxObjectShell into the dedicated DocumentMacroMode class
2007/10/16 08:19:07 fs 1.1.2.1: in preparation of #i52527# #i73705#: outsourced the object shell's MacroExecutionMode handling to a dedicated class

1 files changed, 300 insertions, 0 deletions

diff --git a/sfx2/inc/sfx2/docmacromode.hxx b/sfx2/inc/sfx2/docmacromode.hxx
new file mode 100644
index 000000000000..86b5c720a96e
--- /dev/null
+++ b/sfx2/inc/sfx2/docmacromode.hxx
@@ -0,0 +1,300 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: docmacromode.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: ihi $ $Date: 2007-11-21 16:44:53 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef SFX2_DOCMACROMODE_HXX
+#define SFX2_DOCMACROMODE_HXX
+
+#include "sfx2/dllapi.h"
+
+/** === begin UNO includes === **/
+#include <com/sun/star/task/XInteractionHandler.hpp>
+#include <com/sun/star/embed/XStorage.hpp>
+#include <com/sun/star/script/XLibraryContainer.hpp>
+#include <com/sun/star/document/XEmbeddedScripts.hpp>
+/** === end UNO includes === **/
+
+#include <boost/shared_ptr.hpp>
+
+//........................................................................
+namespace sfx2
+{
+//........................................................................
+
+    //====================================================================
+    //= IMacroDocumentAccess
+    //====================================================================
+    /** provides access to several settings of a document, which are needed by ->DocumentMacroMode
+        to properly determine the current macro execution mode of this document
+    */
+    class SAL_NO_VTABLE IMacroDocumentAccess
+    {
+    public:
+        /** retrieves the MacroExecutionMode as used when the document was loaded
+            or created, or attached to another resource
+
+            If there was no such externally imposed macro execution mode, implementations
+            should return MacroExecMode::USE_CONFIG
+
+            @see ::com::sun::star::document::MediaDescriptor::MacroExecutionMode
+            @see ::com::sun::star::frame::XComponentLoader::loadComponentFromURL
+            @see ::com::sun::star::frame::XModel::attachResource
+
+            @todo
+                Effectively, this is the MacroExecutionMode of the arguments which
+                were used to load the document (or in its last attachResource call).
+                Thus, this setting could be obtained from the XModel directly. We should
+                introduce a getDocumentModel method here, which can be used for this and
+                other purposes.
+        */
+        virtual sal_Int16
+                    getImposedMacroExecMode() const = 0;
+
+        /** returns the origin of the document
+
+            This usually is the document's location, or, if the document has been
+            newly created from a template, then the location of the template. Location
+            here means the complete path of the document, including the file name.
+
+            @todo
+                This probably can also be obtained from the XModel, by calling getURL
+                or getLocation. If both are empty, then we need an UNO way to obtain
+                the URL of the underlying template document - if any. If we have this,
+                we could replace this method with a newly introduced method
+                getDocumentModel and some internal code.
+        */
+        virtual ::rtl::OUString
+                    getDocumentLocation() const = 0;
+
+        /** returns the storage to which the document has last been committed to, for read-only
+            access
+
+            An implementation is allowed to return <NULL/> here if and only if the document
+            does not support signing the script storages.
+
+            @todo
+                UNOize this, too. Once we have a getDocumentModel, we should be able to
+                obtain the "last commit" storage via UNO API, provided it's an
+                XStorageBasedDocument.
+        */
+        virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
+                    getLastCommitDocumentStorage() = 0;
+
+        /** checks whether the document's storage contains sub storages with macros or scripts
+
+            A default implementation of this method will simply cann DocumentMacroMode::storageHasMacros
+            with the document's root storage. However, there might be document types where this
+            isn't sufficient (e.g. database documents which contain sub documents which can also
+            contain macro/script storages).
+        */
+        virtual bool
+                    documentStorageHasMacros() const = 0;
+
+        /** provides access to the XEmbeddedScripts interface of the document
+
+            Implementations are allowed to return <NULL/> here if and only if they
+            do not (yet) support embedding scripts.
+
+            @todo
+                can also be replaced with a call to the (to be introduced) getDocumentModel
+                method, and a queryInterface.
+        */
+        virtual ::com::sun::star::uno::Reference< ::com::sun::star::document::XEmbeddedScripts >
+                    getEmbeddedDocumentScripts() const = 0;
+
+        /** returns the state of the signatures for the scripts embedded in the document
+
+            Note: On the medium run, the signature handling of a document should be outsourced
+            into a dedicated class, instead of being hard-wired into the SfxObjectShell. This
+            class could then be used outside the SfxObjectShell (e.g. in Base documents), too.
+            When this happens, this method here becomes should be replaced by a method at this
+            new class.
+
+            @seealso <sfx2/signaturestate.hxx>
+        */
+        virtual sal_Int16
+                    getScriptingSignatureState() const = 0;
+
+        /** shows a warning that the document's signature is broken
+
+            Here, a similar note applies as to getScriptingSignatureState: This method doesn't
+            really belong here. It's just there because SfxObjectShell_Impl::bSignatureErrorIsShown
+            is not accessible where the method is called.
+            So, once the signature handling has been oursourced from SfxObjectShell/_Impl, so it
+            is re-usable in non-SFX contexts as well, this method here is also unneeded, probably.
+
+            @param _rxInteraction
+                the interaction handler to use for showing the warning. It is exactly the same
+                as passed to DocumentMacroMode::adjustMacroMode, so it is <NULL/> if and
+                only if the instance passed to that method was <NULL/>.
+        */
+        virtual void
+                    showBrokenSignatureWarning(
+                        const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxInteraction
+                    ) const = 0;
+    };
+
+    //====================================================================
+    //= DocumentMacroMode
+    //====================================================================
+    struct DocumentMacroMode_Data;
+
+    /** encapsulates handling the macro mode of a document
+
+        @see com::sun::star::document::MacroExecMode
+    */
+    class SFX2_DLLPUBLIC DocumentMacroMode
+    {
+    public:
+        /** creates an instance
+
+        @param _rDocumentAccess
+            access to the document which this instance works for. Must live as long as the
+            DocumentMacroMode instance lives, at least
+        */
+        DocumentMacroMode( IMacroDocumentAccess& _rDocumentAccess );
+        ~DocumentMacroMode();
+
+        /** allows macro execution in the document
+
+            Effectively, the macro mode is set to MacroExecMode::ALWAYS_EXECUTE_NO_WARN.
+
+            @return
+                <TRUE/>, always
+        */
+        bool    allowMacroExecution();
+
+        /** disallows macro execution in the document
+
+            Effectively, the macro mode is set to MacroExecMode::NEVER_EXECUTE.
+
+            @return
+                <TRUE/>, always
+        */
+        bool    disallowMacroExecution();
+
+        /** checks whether the document allows executing contained macros.
+
+            The method transforms the current macro execution mode into either
+            ALWAYS_EXECUTE_NO_WARN or NEVER_EXECUTE, depending on the current value,
+            possible configuration settings, and possible user interaction.
+
+            @param _rxInteraction
+                A handler for interactions which might become necessary.
+                This includes
+                <ul><li>Asking the user for confirmation for macro execution.</li>
+                    <li>Telling the user that macro execution is disabled.</li>
+                </ul>
+
+                If the user needs to be asked for macro execution confirmation, and if
+                this parameter is <NULL/>, the most defensive assumptions will be made,
+                effectively disabling macro execution.
+
+            @return
+                <TRUE/> if and only if macro execution in this document is allowed.
+        */
+        bool    adjustMacroMode(
+                    const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxInteraction
+                );
+
+        /** determines whether macro execution is disallowed
+
+            There's a number of reasons why macro execution could be disallowed:
+            <ul><li>Somebody called ->disallowMacroExecution</li>
+                <li>Macro execution is disabled globally, via the security options</li>
+                <li>Macro execution mode was not defined initially, and the user denied
+                    executing macros for this particular document.</li>
+            </ul>
+
+            Note that if this method returns <FALSE/>, then subsequent calls of
+            ->adjustMacroMode can still return <FALSE/>.
+            That is, if the current macro execution mode for the document is not yet known
+            (and inparticular <em>not</em> MacroExecMode::NEVER_EXECUTE), then ->isMacroExecutionDisallowed
+            will return <FALSE/>.
+            However, a subsequent call to ->adjustMacroMode can result in the user
+            denying macro execution, in which ->adjustMacroMode will return <FALSE/>,
+            and the next call to isMacroExecutionDisallowed will return <TRUE/>.
+        */
+        bool    isMacroExecutionDisallowed() const;
+
+        /** determines whether the document actually has a macros library
+
+            Effectively, this method checks the Basic library container (as returned by
+            IMacroDocumentAccess::getEmbeddedDocumentScripts().getBasicLibraries) for
+            content.
+        */
+        bool    hasMacroLibrary() const;
+
+        /** determines whether the given document storage has sub storages containing scripts
+            or macros.
+
+            Effectively, the method checks for the presence of a sub-storage name "Scripts" (where
+            BeanShell-/JavaScript-/Python-Scripts are stored, and a sub storage named "Basic" (where
+            Basic scripts are stored).
+        */
+        static bool
+                storageHasMacros( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage );
+
+        /** checks the macro execution mode while loading the document.
+
+            This must be called when the loading is effectively finished, but before any macro action
+            happened.
+
+            The method will disallow macro execution for this document if it is disabled
+            globally (SvtSecurityOptions::IsMacroDisabled). Otherwise, it will check whether
+            the document contains a macro storage or macro libraries. If so, it will
+            properly calculate the MacroExecutionMode by calling adjustMacroMode.
+
+            If the document doesn't contain macros, yet, then the macro execution for this
+            document will be allowed (again: unless disabled globally), since in this case
+            macros which later are newly created by the user should be allowed, of course.
+
+            @see isMacroExecutionDisallowed
+            @see IMacroDocumentAccess::documentStorageHasMacros
+            @see hasMacroLibrary
+            @see IMacroDocumentAccess::checkForBrokenScriptingSignatures
+        */
+        void    checkMacrosOnLoading(
+                    const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxInteraction
+                );
+
+    private:
+        ::boost::shared_ptr< DocumentMacroMode_Data >   m_pData;
+    };
+
+//........................................................................
+} // namespace sfx2
+//........................................................................
+
+#endif // SFX2_DOCMACROMODE_HXX