/*************************************************************************
 *
 *  $RCSfile: internaloptions.cxx,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mh $ $Date: 2001-01-31 17:20:13 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#pragma hdrstop

//_________________________________________________________________________________________________________________
//  includes
//_________________________________________________________________________________________________________________

#include "internaloptions.hxx"

#ifndef _UTL_CONFIGMGR_HXX_
#include <unotools/configmgr.hxx>
#endif

#ifndef _UTL_CONFIGITEM_HXX_
#include <unotools/configitem.hxx>
#endif

#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif

#ifndef _COM_SUN_STAR_UNO_ANY_HXX_
#include <com/sun/star/uno/Any.hxx>
#endif

#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
#include <com/sun/star/uno/Sequence.hxx>
#endif

#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
#include <com/sun/star/beans/PropertyValue.hpp>
#endif

#ifndef __SGI_STL_STACK
#include <stack>
#endif

//_________________________________________________________________________________________________________________
//  namespaces
//_________________________________________________________________________________________________________________

using namespace ::utl                   ;
using namespace ::rtl                   ;
using namespace ::osl                   ;
using namespace ::std                   ;
using namespace ::com::sun::star::uno   ;
using namespace ::com::sun::star::beans ;

//_________________________________________________________________________________________________________________
//  const
//_________________________________________________________________________________________________________________

#define ROOTNODE_INTERNAL                   OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/Internal"   ))
#define DEFAULT_SLOTCFG                     sal_False
#define DEFAULT_SENDCRASHMAIL               sal_False

#define FIXPROPERTYNAME_SLOTCFG             OUString(RTL_CONSTASCII_USTRINGPARAM("Slot"                     ))
#define FIXPROPERTYNAME_SENDCRASHMAIL       OUString(RTL_CONSTASCII_USTRINGPARAM("SendCrashMail"            ))

#define FIXPROPERTYHANDLE_SLOTCFG           0
#define FIXPROPERTYHANDLE_SENDCRASHMAIL     1

#define FIXPROPERTYCOUNT                    2

#define PROPERTYNAME_RECOVERYLIST           OUString(RTL_CONSTASCII_USTRINGPARAM("RecoveryList"             ))
#define PROPERTYNAME_URL                    OUString(RTL_CONSTASCII_USTRINGPARAM("URL"                      ))
#define PROPERTYNAME_FILTER                 OUString(RTL_CONSTASCII_USTRINGPARAM("Filter"                   ))
#define PROPERTYNAME_TEMPNAME               OUString(RTL_CONSTASCII_USTRINGPARAM("TempName"                 ))

#define OFFSET_URL                          0
#define OFFSET_FILTER                       1
#define OFFSET_TEMPNAME                     2

#define PATHDELIMITER                       OUString(RTL_CONSTASCII_USTRINGPARAM("/"                        ))
#define FIXR                                OUString(RTL_CONSTASCII_USTRINGPARAM("r"                        ))

//_________________________________________________________________________________________________________________
//  private declarations!
//_________________________________________________________________________________________________________________

struct tIMPL_RecoveryEntry
{
    OUString    sURL        ;
    OUString    sFilter     ;
    OUString    sTempName   ;

    tIMPL_RecoveryEntry()
    {
        sURL        =   OUString();
        sFilter     =   OUString();
        sTempName   =   OUString();
    }

    tIMPL_RecoveryEntry(    const   OUString&   sNewURL         ,
                            const   OUString&   sNewFilter      ,
                            const   OUString&   sNewTempName    )
    {
        sURL        =   sNewURL         ;
        sFilter     =   sNewFilter      ;
        sTempName   =   sNewTempName    ;
    }
};

typedef stack< tIMPL_RecoveryEntry > tIMPL_RecoveryStack;

class SvtInternalOptions_Impl : public ConfigItem
{
    //-------------------------------------------------------------------------------------------------------------
    //  public methods
    //-------------------------------------------------------------------------------------------------------------

    public:

        //---------------------------------------------------------------------------------------------------------
        //  constructor / destructor
        //---------------------------------------------------------------------------------------------------------

         SvtInternalOptions_Impl();
        ~SvtInternalOptions_Impl();

        //---------------------------------------------------------------------------------------------------------
        //  overloaded methods of baseclass
        //---------------------------------------------------------------------------------------------------------

        /*-****************************************************************************************************//**
            @short      called for notify of configmanager
            @descr      These method is called from the ConfigManager before application ends or from the
                         PropertyChangeListener if the sub tree broadcasts changes. You must update your
                        internal values.

            @seealso    baseclass ConfigItem

            @param      "seqPropertyNames" is the list of properties which should be updated.
            @return     -

            @onerror    -
        *//*-*****************************************************************************************************/

        virtual void Notify( const Sequence< OUString >& seqPropertyNames )
        {
            DBG_ASSERT( sal_False, "SvtInternalOptions::Notify()\nNot used yet ... but called!?\n" );
        }

        /*-****************************************************************************************************//**
            @short      write changes to configuration
            @descr      These method writes the changed values into the sub tree
                        and should always called in our destructor to guarantee consistency of config data.

            @seealso    baseclass ConfigItem

            @param      -
            @return     -

            @onerror    -
        *//*-*****************************************************************************************************/

        virtual void Commit();

        //---------------------------------------------------------------------------------------------------------
        //  public interface
        //---------------------------------------------------------------------------------------------------------

        /*-****************************************************************************************************//**
            @short      access method to get internal values
            @descr      These method give us a chance to regulate acces to ouer internal values.
                        It's not used in the moment - but it's possible for the feature!

            @seealso    -

            @param      -
            @return     -

            @onerror    -
        *//*-*****************************************************************************************************/

        sal_Bool    SlotCFGEnabled      (                                   ) const;
        sal_Bool    CrashMailEnabled    (                                   ) const;
        void        PushRecoveryItem    (   const   OUString&   sURL        ,
                                            const   OUString&   sFilter     ,
                                             const  OUString&   sTempName   );
        void        PopRecoveryItem     (           OUString&   sURL        ,
                                                    OUString&   sFilter     ,
                                                    OUString&   sTempName   );
        sal_Bool    IsRecoveryListEmpty (                                   ) const;

    //-------------------------------------------------------------------------------------------------------------
    //  private methods
    //-------------------------------------------------------------------------------------------------------------

    private:

        /*-****************************************************************************************************//**
            @short      return list of fix key names of ouer configuration management which represent oue module tree
            @descr      These methods return a static const list of key names. We need it to get needed values from our
                        configuration management. We return well known key names only - because the "UserData" node
                        is handled in a special way!

            @seealso    -

            @param      -
            @return     A list of needed configuration keys is returned.

            @onerror    -
        *//*-*****************************************************************************************************/

        Sequence< OUString > impl_GetPropertyNames();

    //-------------------------------------------------------------------------------------------------------------
    //  private member
    //-------------------------------------------------------------------------------------------------------------

    private:

        sal_Bool                m_bSlotCFG          ;   /// cache "Slot" of Internal section
        sal_Bool                m_bSendCrashMail    ;   /// cache "SendCrashMail" of Internal section
        tIMPL_RecoveryStack     m_aRecoveryList     ;   /// cache "RecoveryList" of Internal section
};

//_________________________________________________________________________________________________________________
//  definitions
//_________________________________________________________________________________________________________________

//*****************************************************************************************************************
//  constructor
//*****************************************************************************************************************
SvtInternalOptions_Impl::SvtInternalOptions_Impl()
    // Init baseclasses first
    :   ConfigItem          ( ROOTNODE_INTERNAL     )
    // Init member then.
    ,   m_bSlotCFG          ( DEFAULT_SLOTCFG       )
    ,   m_bSendCrashMail    ( DEFAULT_SENDCRASHMAIL )
{
    // Use our list of configuration keys to get his values.
    // structure of internal section: (first 2 entries are fixed - all other are member of a set!)
    //      "Slot"
    //      "SendCrashMail"
    //      "RecoveryList/r1/URL"
    //      "RecoveryList/r1/Filter"
    //      "RecoveryList/r1/TempName"
    //      "RecoveryList/r2/URL"
    //      "RecoveryList/r2/Filter"
    //      "RecoveryList/r2/TempName"
    //      "RecoveryList/.."
    Sequence< OUString >    seqNames    = impl_GetPropertyNames()   ;
    Sequence< Any >         seqValues   = GetProperties( seqNames ) ;

    // Safe impossible cases.
    // We need values from ALL configuration keys.
    // Follow assignment use order of values in relation to our list of key names!
    DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtInternalOptions_Impl::SvtInternalOptions_Impl()\nI miss some values of configuration keys!\n" );

    // Read fixed values first!
    DBG_ASSERT(!(seqValues[FIXPROPERTYHANDLE_SLOTCFG].getValueTypeClass()!=TypeClass_BOOLEAN)       , "SvtInternalOptions_Impl::SvtInternalOptions_Impl()\nWho has changed the value type of \"Office.Common\\Internal\\Slot\"?"            );
    DBG_ASSERT(!(seqValues[FIXPROPERTYHANDLE_SENDCRASHMAIL].getValueTypeClass()!=TypeClass_BOOLEAN) , "SvtInternalOptions_Impl::SvtInternalOptions_Impl()\nWho has changed the value type of \"Office.Common\\Internal\\SendCrashMail\"?"   );
    seqValues[FIXPROPERTYHANDLE_SLOTCFG         ] >>= m_bSlotCFG        ;
    seqValues[FIXPROPERTYHANDLE_SENDCRASHMAIL   ] >>= m_bSendCrashMail  ;

    // Read dynamical set "RecoveryList" then.
    // 3 subkeys for every item!
    // Attention: Start at next element after last fixed entry! We must ignore "Slot" and "SendCrashMail" ...
    tIMPL_RecoveryEntry aEntry;
    sal_uInt32 nCount       = seqValues.getLength() ;
    sal_uInt32 nPosition    = FIXPROPERTYCOUNT      ;

    while( nPosition<nCount )
    {
        seqValues[nPosition] >>= aEntry.sURL        ;
        ++nPosition;
        seqValues[nPosition] >>= aEntry.sFilter     ;
        ++nPosition;
        seqValues[nPosition] >>= aEntry.sTempName   ;
        ++nPosition;
        m_aRecoveryList.push( aEntry );
    }

    // We don't need any notifications here.
    // "Slot" and "SendCrashMail" are readonly(!) and our recovery list should not modified during runtime - it's used
    // by our crash guard only ... otherwise we have a big problem.
}

//*****************************************************************************************************************
//  destructor
//*****************************************************************************************************************
SvtInternalOptions_Impl::~SvtInternalOptions_Impl()
{
    if( IsModified() == sal_True )
    {
        Commit();
    }
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void SvtInternalOptions_Impl::Commit()
{
    // Our fix properties are readonly values(!) - don't write it back.

    // Write set of dynamic properties then.
    ClearNodeSet( PROPERTYNAME_RECOVERYLIST );

    tIMPL_RecoveryEntry         aItem                   ;
    OUString                    sNode                   ;
    Sequence< PropertyValue >   seqPropertyValues( 3 )  ;   // Every node in set has 3 sub-nodes!( url, filter, tempname )

    // Copy list entries to save-list and write it to configuration.
    sal_uInt32 nCount = m_aRecoveryList.size();
    for( sal_uInt32 nItem=0; nItem<nCount; ++nItem )
    {
        aItem = m_aRecoveryList.top();
        m_aRecoveryList.pop();
        sNode = PROPERTYNAME_RECOVERYLIST + PATHDELIMITER + FIXR + OUString::valueOf( (sal_Int32)nItem ) + PATHDELIMITER;
        seqPropertyValues[OFFSET_URL        ].Name  =   sNode + PROPERTYNAME_URL        ;
        seqPropertyValues[OFFSET_FILTER     ].Name  =   sNode + PROPERTYNAME_FILTER     ;
        seqPropertyValues[OFFSET_TEMPNAME   ].Name  =   sNode + PROPERTYNAME_TEMPNAME   ;
        seqPropertyValues[OFFSET_URL        ].Value <<= aItem.sURL                      ;
        seqPropertyValues[OFFSET_FILTER     ].Value <<= aItem.sFilter                   ;
        seqPropertyValues[OFFSET_TEMPNAME   ].Value <<= aItem.sTempName                 ;

        SetSetProperties( PROPERTYNAME_RECOVERYLIST, seqPropertyValues );
    }
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions_Impl::SlotCFGEnabled() const
{
    return m_bSlotCFG;
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions_Impl::CrashMailEnabled() const
{
    return m_bSendCrashMail;
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void SvtInternalOptions_Impl::PushRecoveryItem( const   OUString&   sURL        ,
                                                const   OUString&   sFilter     ,
                                                const   OUString&   sTempName   )
{
    tIMPL_RecoveryEntry aEntry( sURL, sFilter, sTempName );
    m_aRecoveryList.push( aEntry );
    SetModified();
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void SvtInternalOptions_Impl::PopRecoveryItem(  OUString&   sURL        ,
                                                OUString&   sFilter     ,
                                                OUString&   sTempName   )
{
    tIMPL_RecoveryEntry aEntry = m_aRecoveryList.top();
    m_aRecoveryList.pop();
    SetModified();  // Don't forget it - we delete an entry here!
    sURL        = aEntry.sURL       ;
    sFilter     = aEntry.sFilter    ;
    sTempName   = aEntry.sTempName  ;
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions_Impl::IsRecoveryListEmpty() const
{
    return ( m_aRecoveryList.empty() );
}

//*****************************************************************************************************************
//  private method
//*****************************************************************************************************************
Sequence< OUString > SvtInternalOptions_Impl::impl_GetPropertyNames()
{
    // First get ALL names of current existing list items in configuration!
    Sequence< OUString > seqRecoveryItems = GetNodeNames( PROPERTYNAME_RECOVERYLIST );
    // Get information about list counts ...
    sal_Int32 nRecoveryCount = seqRecoveryItems.getLength();
    // ... and create a property list with right size! (+2...for fix properties!) (*3 ... = sub nodes for every set node!)
    Sequence< OUString > seqProperties( FIXPROPERTYCOUNT + (nRecoveryCount*3) );

    // Add names of fix properties to list.
    seqProperties[FIXPROPERTYHANDLE_SLOTCFG         ]   =   FIXPROPERTYNAME_SLOTCFG         ;
    seqProperties[FIXPROPERTYHANDLE_SENDCRASHMAIL   ]   =   FIXPROPERTYNAME_SENDCRASHMAIL   ;

    sal_uInt32 nPosition = FIXPROPERTYCOUNT;
    // Add names for recovery list to list.
    // 3 subkeys for every item!
    // nPosition is the start point of an list item, nItem an index into right list of node names!
    for( sal_Int32 nItem=0; nItem<nRecoveryCount; ++nItem )
    {
        seqProperties[nPosition] = PROPERTYNAME_RECOVERYLIST + PATHDELIMITER + seqRecoveryItems[nItem] + PATHDELIMITER + PROPERTYNAME_URL       ;
        ++nPosition;
        seqProperties[nPosition] = PROPERTYNAME_RECOVERYLIST + PATHDELIMITER + seqRecoveryItems[nItem] + PATHDELIMITER + PROPERTYNAME_FILTER    ;
        ++nPosition;
        seqProperties[nPosition] = PROPERTYNAME_RECOVERYLIST + PATHDELIMITER + seqRecoveryItems[nItem] + PATHDELIMITER + PROPERTYNAME_TEMPNAME  ;
        ++nPosition;
    }

    // Return result.
    return seqProperties;
}

//*****************************************************************************************************************
//  initialize static member
//  DON'T DO IT IN YOUR HEADER!
//  see definition for further informations
//*****************************************************************************************************************
SvtInternalOptions_Impl*    SvtInternalOptions::m_pDataContainer    = NULL  ;
sal_Int32                   SvtInternalOptions::m_nRefCount         = 0     ;

//*****************************************************************************************************************
//  constructor
//*****************************************************************************************************************
SvtInternalOptions::SvtInternalOptions()
{
    // Global access, must be guarded (multithreading!).
    MutexGuard aGuard( GetOwnStaticMutex() );
    // Increase ouer refcount ...
    ++m_nRefCount;
    // ... and initialize ouer data container only if it not already!
    if( m_pDataContainer == NULL )
    {
        m_pDataContainer = new SvtInternalOptions_Impl();
    }
}

//*****************************************************************************************************************
//  destructor
//*****************************************************************************************************************
SvtInternalOptions::~SvtInternalOptions()
{
    // Global access, must be guarded (multithreading!)
    MutexGuard aGuard( GetOwnStaticMutex() );
    // Decrease ouer refcount.
    --m_nRefCount;
    // If last instance was deleted ...
    // we must destroy ouer static data container!
    if( m_nRefCount <= 0 )
    {
        delete m_pDataContainer;
        m_pDataContainer = NULL;
    }
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions::SlotCFGEnabled() const
{
    MutexGuard aGuard( GetOwnStaticMutex() );
    return m_pDataContainer->SlotCFGEnabled();
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions::CrashMailEnabled() const
{
    MutexGuard aGuard( GetOwnStaticMutex() );
    return m_pDataContainer->CrashMailEnabled();
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void SvtInternalOptions::PushRecoveryItem(  const   OUString&   sURL        ,
                                            const   OUString&   sFilter     ,
                                            const   OUString&   sTempName   )
{
    MutexGuard aGuard( GetOwnStaticMutex() );
    m_pDataContainer->PushRecoveryItem( sURL, sFilter, sTempName );
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void SvtInternalOptions::PopRecoveryItem(   OUString&   sURL        ,
                                            OUString&   sFilter     ,
                                            OUString&   sTempName   )
{
    MutexGuard aGuard( GetOwnStaticMutex() );
    m_pDataContainer->PopRecoveryItem( sURL, sFilter, sTempName );
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool SvtInternalOptions::IsRecoveryListEmpty() const
{
    MutexGuard aGuard( GetOwnStaticMutex() );
    return m_pDataContainer->IsRecoveryListEmpty();
}

//*****************************************************************************************************************
//  private method
//*****************************************************************************************************************
Mutex& SvtInternalOptions::GetOwnStaticMutex()
{
    // Initialize static mutex only for one time!
    static Mutex* pMutex = NULL;
    // If these method first called (Mutex not already exist!) ...
    if( pMutex == NULL )
    {
        // ... we must create a new one. Protect follow code with the global mutex -
        // It must be - we create a static variable!
        MutexGuard aGuard( Mutex::getGlobalMutex() );
        // We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
        if( pMutex == NULL )
        {
            // Create the new mutex and set it for return on static variable.
            static Mutex aMutex;
            pMutex = &aMutex;
        }
    }
    // Return new created or already existing mutex object.
    return *pMutex;
}