9af3b8b4ff
This is catastrophically wrong, just appear to be lucky that this code path is never called, so remove it entirely rather than mess around fixing it Change-Id: I4a8a443ed20b7e11cd9cc69b3d66d28087f09db8
515 lines
19 KiB
C++
515 lines
19 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* 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 .
|
|
*/
|
|
|
|
#ifndef _DATABASES_HXX_
|
|
#define _DATABASES_HXX_
|
|
|
|
#include <config_global.h>
|
|
|
|
#include <set>
|
|
#include <vector>
|
|
#if !HAVE_CXX11
|
|
#define BOOST_NO_0X_HDR_TYPEINDEX
|
|
#endif
|
|
#include <boost/unordered_map.hpp>
|
|
#include <boost/unordered_set.hpp>
|
|
#include <osl/mutex.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
#include <rtl/string.hxx>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <com/sun/star/ucb/XContent.hpp>
|
|
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
|
|
#include <com/sun/star/io/XInputStream.hpp>
|
|
#include <com/sun/star/lang/XMultiComponentFactory.hpp>
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#include <com/sun/star/i18n/XCollator.hpp>
|
|
#include <com/sun/star/deployment/XPackage.hpp>
|
|
#include "com/sun/star/ucb/XSimpleFileAccess3.hpp"
|
|
|
|
// Forward declaration
|
|
|
|
namespace helpdatafileproxy {
|
|
|
|
class Hdf;
|
|
|
|
}
|
|
|
|
namespace chelp {
|
|
|
|
class Databases;
|
|
class URLParameter;
|
|
|
|
class StaticModuleInformation
|
|
{
|
|
private:
|
|
|
|
OUString m_aStartId;
|
|
OUString m_aProgramSwitch;
|
|
OUString m_aTitle;
|
|
OUString m_aHeading;
|
|
OUString m_aFulltext;
|
|
int m_nOrder;
|
|
|
|
public:
|
|
|
|
StaticModuleInformation( OUString aTitle,
|
|
OUString aStartId,
|
|
OUString aProgramSwitch,
|
|
OUString aHeading,
|
|
OUString aFulltext,
|
|
OUString aOrder )
|
|
: m_aStartId( aStartId ),
|
|
m_aProgramSwitch( aProgramSwitch ),
|
|
m_aTitle( aTitle ),
|
|
m_aHeading( aHeading ),
|
|
m_aFulltext( aFulltext ),
|
|
m_nOrder( aOrder.toInt32() )
|
|
{
|
|
}
|
|
|
|
~StaticModuleInformation() { }
|
|
|
|
OUString get_title() const { return m_aTitle; }
|
|
OUString get_id() const { return m_aStartId; }
|
|
OUString get_program() const { return m_aProgramSwitch; }
|
|
OUString get_heading() const { return m_aHeading; }
|
|
OUString get_fulltext() const { return m_aFulltext; }
|
|
int get_order() const { return m_nOrder; }
|
|
}; // end class StaticModuleInformation
|
|
|
|
class KeywordInfo
|
|
{
|
|
public:
|
|
|
|
class KeywordElement
|
|
{
|
|
friend struct KeywordElementComparator;
|
|
friend class KeywordInfo;
|
|
|
|
public:
|
|
|
|
KeywordElement( Databases* pDatabases,
|
|
helpdatafileproxy::Hdf* pHdf,
|
|
OUString& key,
|
|
OUString& ids );
|
|
|
|
private:
|
|
|
|
OUString key;
|
|
com::sun::star::uno::Sequence< OUString > listId;
|
|
com::sun::star::uno::Sequence< OUString > listAnchor;
|
|
com::sun::star::uno::Sequence< OUString > listTitle;
|
|
|
|
void init( Databases *pDatabases,helpdatafileproxy::Hdf* pHdf,const OUString& ids );
|
|
};
|
|
|
|
KeywordInfo( const std::vector< KeywordElement >& aVector );
|
|
|
|
~KeywordInfo() { };
|
|
|
|
com::sun::star::uno::Sequence< OUString >&
|
|
getKeywordList() { return listKey; }
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< OUString > >&
|
|
getIdList() { return listId; }
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< OUString > >&
|
|
getAnchorList() { return listAnchor; }
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< OUString > >&
|
|
getTitleList() { return listTitle; }
|
|
|
|
private:
|
|
|
|
com::sun::star::uno::Sequence< OUString > listKey;
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< OUString > > listId,listAnchor,listTitle;
|
|
}; // end class KeywordInfo
|
|
|
|
class Databases
|
|
{
|
|
public:
|
|
|
|
struct eq
|
|
{
|
|
bool operator()( const OUString& rKey1, const OUString& rKey2 ) const
|
|
{
|
|
return (rKey1 == rKey2);
|
|
}
|
|
};
|
|
|
|
struct ha
|
|
{
|
|
size_t operator()( const OUString& rName ) const
|
|
{
|
|
return rName.hashCode();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Input is the installdirectory in system dependent notation
|
|
*/
|
|
|
|
Databases( sal_Bool showBasic,
|
|
const OUString& instPath,
|
|
const com::sun::star::uno::Sequence< OUString >& imagesZipPaths,
|
|
const OUString& productName,
|
|
const OUString& productVersion,
|
|
const OUString& styleSheet,
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext );
|
|
|
|
~Databases();
|
|
|
|
OString getImagesZipFileURL();
|
|
|
|
OUString getInstallPathAsURL();
|
|
|
|
const std::vector< OUString >& getModuleList( const OUString& Language );
|
|
|
|
StaticModuleInformation* getStaticInformationForModule( const OUString& Module,
|
|
const OUString& Language );
|
|
|
|
bool checkModuleMatchForExtension( const OUString& Database, const OUString& doclist );
|
|
KeywordInfo* getKeyword( const OUString& Module,
|
|
const OUString& Language );
|
|
|
|
helpdatafileproxy::Hdf* getHelpDataFile( const OUString& Module,
|
|
const OUString& Language, bool helpText = false,
|
|
const OUString* pExtensionPath = NULL );
|
|
|
|
/**
|
|
* The following method returns the Collator for the given language-country combination
|
|
*/
|
|
|
|
com::sun::star::uno::Reference< com::sun::star::i18n::XCollator >
|
|
getCollator( const OUString& Language,
|
|
const OUString& System ); // System not used by current implementation
|
|
// // of XCollator
|
|
|
|
/**
|
|
* Returns the cascading stlye sheet used to format the HTML-output.
|
|
* First try is language directory, second try is main installation directory.
|
|
*/
|
|
|
|
void cascadingStylesheet( const OUString& Language,
|
|
char** buffer,
|
|
int* byteCount );
|
|
|
|
/**
|
|
* Changes the stylesheet for further reads.
|
|
*/
|
|
|
|
void changeCSS(const OUString& newStyleSheet);
|
|
|
|
/**
|
|
* Returns the active help text for the given module, language and id.
|
|
*/
|
|
|
|
void setActiveText( const OUString& Module,
|
|
const OUString& Language,
|
|
const OUString& Id,
|
|
char** buffer,
|
|
int* byteCount );
|
|
|
|
/**
|
|
* Has the purpose of forcing the jarfile to stay open
|
|
*/
|
|
|
|
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
|
|
jarFile( const OUString& jar,
|
|
const OUString& Language );
|
|
|
|
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
|
|
findJarFileForPath( const OUString& jar, const OUString& Language,
|
|
const OUString& path, OUString* o_pExtensionPath = NULL,
|
|
OUString* o_pExtensionRegistryPath = NULL );
|
|
|
|
/**
|
|
* Maps a given language-locale combination to language.
|
|
*/
|
|
|
|
OUString processLang( const OUString& Language );
|
|
|
|
/**
|
|
* Maps a given language-locale combination to locale.
|
|
* The returned string maybe empty
|
|
*/
|
|
|
|
OUString country( const OUString& Language );
|
|
|
|
void replaceName( OUString& oustring ) const;
|
|
|
|
OUString getProductName() const { return m_vReplacement[0]; }
|
|
OUString getProductVersion() const { return m_vReplacement[1]; }
|
|
|
|
OUString expandURL( const OUString& aURL );
|
|
|
|
static OUString expandURL( const OUString& aURL,
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext );
|
|
|
|
private:
|
|
|
|
osl::Mutex m_aMutex;
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > m_xContext;
|
|
com::sun::star::uno::Reference< com::sun::star::lang::XMultiComponentFactory > m_xSMgr;
|
|
com::sun::star::uno::Reference< com::sun::star::ucb::XSimpleFileAccess3 > m_xSFA;
|
|
|
|
bool m_bShowBasic;
|
|
char* m_pErrorDoc;
|
|
|
|
int m_nCustomCSSDocLength;
|
|
char* m_pCustomCSSDoc;
|
|
OUString m_aCSS;
|
|
|
|
enum {
|
|
PRODUCTNAME = 0,
|
|
PRODUCTVERSION,
|
|
VENDORNAME,
|
|
VENDORVERSION,
|
|
VENDORSHORT,
|
|
NEWPRODUCTNAME,
|
|
NEWPRODUCTVERSION
|
|
};
|
|
|
|
int m_vAdd[7];
|
|
OUString m_vReplacement[7];
|
|
OUString newProdName,newProdVersion,
|
|
prodName,prodVersion,vendName,vendVersion,vendShort;
|
|
|
|
OUString m_aInstallDirectory; // Installation directory
|
|
com::sun::star::uno::Sequence< OUString > m_aImagesZipPaths;
|
|
OString m_aImagesZipFileURL;
|
|
OUString m_aSymbolsStyleName;
|
|
|
|
std::vector< OUString > m_avModules;
|
|
|
|
typedef boost::unordered_map< OUString,helpdatafileproxy::Hdf*,ha,eq > DatabasesTable;
|
|
DatabasesTable m_aDatabases; // Language and module dependent databases
|
|
|
|
typedef boost::unordered_map< OUString,OUString,ha,eq > LangSetTable;
|
|
LangSetTable m_aLangSet; // Mapping to of lang-country to lang
|
|
|
|
typedef boost::unordered_map< OUString,StaticModuleInformation*,ha,eq > ModInfoTable;
|
|
ModInfoTable m_aModInfo; // Module information
|
|
|
|
typedef boost::unordered_map< OUString,KeywordInfo*,ha,eq > KeywordInfoTable;
|
|
KeywordInfoTable m_aKeywordInfo; // Module information
|
|
|
|
typedef
|
|
boost::unordered_map<
|
|
OUString,
|
|
::com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >,
|
|
ha,
|
|
eq > ZipFileTable;
|
|
ZipFileTable m_aZipFileTable; // No closing of an once opened jarfile
|
|
|
|
typedef
|
|
boost::unordered_map<
|
|
OUString,
|
|
::com::sun::star::uno::Reference< com::sun::star::i18n::XCollator >,
|
|
ha,
|
|
eq > CollatorTable;
|
|
CollatorTable m_aCollatorTable;
|
|
|
|
struct ostring_eq
|
|
{
|
|
bool operator()( const OString& rKey1, const OString& rKey2 ) const
|
|
{
|
|
return (rKey1 == rKey2);
|
|
}
|
|
};
|
|
|
|
struct ostring_ha
|
|
{
|
|
size_t operator()( const OString& rName ) const
|
|
{
|
|
return rName.hashCode();
|
|
}
|
|
};
|
|
|
|
typedef
|
|
boost::unordered_set<
|
|
OString,
|
|
ostring_ha,
|
|
ostring_eq > EmptyActiveTextSet;
|
|
EmptyActiveTextSet m_aEmptyActiveTextSet;
|
|
|
|
// methods
|
|
|
|
void setInstallPath( const OUString& aInstallDirectory );
|
|
|
|
}; // end class Databases
|
|
|
|
enum IteratorState
|
|
{
|
|
INITIAL_MODULE,
|
|
//SHARED_MODULE, // Later, avoids redundancies in help compiling
|
|
USER_EXTENSIONS,
|
|
SHARED_EXTENSIONS,
|
|
BUNDLED_EXTENSIONS,
|
|
END_REACHED
|
|
};
|
|
|
|
// Hashtable to cache extension help status
|
|
typedef boost::unordered_map
|
|
<
|
|
OUString,
|
|
bool,
|
|
Databases::ha,
|
|
Databases::eq
|
|
>
|
|
ExtensionHelpExistanceMap;
|
|
|
|
class ExtensionIteratorBase
|
|
{
|
|
static ExtensionHelpExistanceMap aHelpExistanceMap;
|
|
|
|
public:
|
|
ExtensionIteratorBase( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
|
|
Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage );
|
|
ExtensionIteratorBase( Databases& rDatabases, const OUString& aInitialModule,
|
|
const OUString& aLanguage );
|
|
void init( void );
|
|
|
|
private:
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetHelpPackageFromPackage
|
|
( const com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
|
|
|
|
protected:
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextUserHelpPackage
|
|
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextSharedHelpPackage
|
|
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextBundledHelpPackage
|
|
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
|
|
OUString implGetFileFromPackage( const OUString& rFileExtension,
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
|
|
void implGetLanguageVectorFromPackage( ::std::vector< OUString > &rv,
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
|
|
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > m_xContext;
|
|
com::sun::star::uno::Reference< com::sun::star::ucb::XSimpleFileAccess3 > m_xSFA;
|
|
Databases& m_rDatabases;
|
|
|
|
IteratorState m_eState;
|
|
OUString m_aExtensionPath;
|
|
|
|
OUString m_aInitialModule;
|
|
OUString m_aLanguage;
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
|
|
< com::sun::star::deployment::XPackage > > m_aUserPackagesSeq;
|
|
bool m_bUserPackagesLoaded;
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
|
|
< com::sun::star::deployment::XPackage > > m_aSharedPackagesSeq;
|
|
bool m_bSharedPackagesLoaded;
|
|
|
|
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
|
|
< com::sun::star::deployment::XPackage > > m_aBundledPackagesSeq;
|
|
bool m_bBundledPackagesLoaded;
|
|
|
|
int m_iUserPackage;
|
|
int m_iSharedPackage;
|
|
int m_iBundledPackage;
|
|
|
|
}; // end class ExtensionIteratorBase
|
|
|
|
class DataBaseIterator : public ExtensionIteratorBase
|
|
{
|
|
public:
|
|
DataBaseIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
|
|
Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage, bool bHelpText )
|
|
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
|
|
, m_bHelpText( bHelpText )
|
|
{}
|
|
DataBaseIterator( Databases& rDatabases, const OUString& aInitialModule,
|
|
const OUString& aLanguage, bool bHelpText )
|
|
: ExtensionIteratorBase( rDatabases, aInitialModule, aLanguage )
|
|
, m_bHelpText( bHelpText )
|
|
{}
|
|
|
|
helpdatafileproxy::Hdf* nextHdf( OUString* o_pExtensionPath = NULL, OUString* o_pExtensionRegistryPath = NULL );
|
|
|
|
private:
|
|
helpdatafileproxy::Hdf* implGetHdfFromPackage(
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
|
|
OUString* o_pExtensionPath, OUString* o_pExtensionRegistryPath );
|
|
|
|
bool m_bHelpText;
|
|
|
|
}; // end class DataBaseIterator
|
|
|
|
class KeyDataBaseFileIterator : public ExtensionIteratorBase
|
|
{
|
|
public:
|
|
KeyDataBaseFileIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
|
|
Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage )
|
|
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
|
|
{}
|
|
//Returns a file URL
|
|
OUString nextDbFile( bool& o_rbExtension );
|
|
|
|
private:
|
|
OUString implGetDbFileFromPackage(
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
|
|
|
|
}; // end class KeyDataBaseFileIterator
|
|
|
|
class JarFileIterator : public ExtensionIteratorBase
|
|
{
|
|
public:
|
|
JarFileIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
|
|
Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage )
|
|
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
|
|
{}
|
|
|
|
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
|
|
nextJarFile( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle,
|
|
OUString* o_pExtensionPath = NULL, OUString* o_pExtensionRegistryPath = NULL );
|
|
|
|
private:
|
|
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
|
|
implGetJarFromPackage(com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
|
|
OUString* o_pExtensionPath = NULL, OUString* o_pExtensionRegistryPath = NULL );
|
|
|
|
}; // end class JarFileIterator
|
|
|
|
class IndexFolderIterator : public ExtensionIteratorBase
|
|
{
|
|
public:
|
|
IndexFolderIterator( Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage )
|
|
: ExtensionIteratorBase( rDatabases, aInitialModule, aLanguage )
|
|
{}
|
|
|
|
OUString nextIndexFolder( bool& o_rbExtension, bool& o_rbTemporary );
|
|
void deleteTempIndexFolder( const OUString& aIndexFolder );
|
|
|
|
private:
|
|
OUString implGetIndexFolderFromPackage( bool& o_rbTemporary,
|
|
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
|
|
|
|
}; // end class KeyDataBaseFileIterator
|
|
|
|
} // end namespace chelp
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|