xmlhelp/source/cxxhelp/provider/urlparameter.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: urlparameter.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _URLPARAMETER_HXX_
  32 #define _URLPARAMETER_HXX_
  33
  34 #include <rtl/ustring.hxx>
  35 #include <rtl/string.hxx>
  36 #include <com/sun/star/ucb/IllegalIdentifierException.hpp>
  37 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  38 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  39 #include <com/sun/star/io/XActiveDataSink.hpp>
  40 #include <com/sun/star/io/XOutputStream.hpp>
  41 #include <com/sun/star/ucb/Command.hpp>
  42
  43 namespace chelp {
  44
  45
  46     class Databases;
  47
  48
  49     class DbtToStringConverter
  50     {
  51     public:
  52
  53         DbtToStringConverter( const sal_Char* ptr,sal_Int32 len )
  54             : m_len( len ),
  55               m_ptr( ptr )
  56         {
  57         }
  58
  59
  60         rtl::OUString getHash()
  61         {
  62             if( m_ptr )
  63             {
  64                 sal_Int32 sizeOfFile = ( sal_Int32 ) m_ptr[0];
  65                 rtl::OUString Hash( m_ptr+1,sizeOfFile,RTL_TEXTENCODING_UTF8 );
  66                 sal_Int32 idx;
  67                 if( ( idx = Hash.indexOf( sal_Unicode( '#' ) ) ) != -1 )
  68                     return Hash.copy( 1+idx );
  69             }
  70             return rtl::OUString();
  71         }
  72
  73
  74         rtl::OUString getFile()
  75         {
  76             if( ! m_ptr )
  77                 return rtl::OUString();
  78
  79             sal_Int32 sizeOfFile = ( sal_Int32 ) m_ptr[0];
  80             rtl::OUString File( m_ptr+1,sizeOfFile,RTL_TEXTENCODING_UTF8 );
  81             sal_Int32 idx;
  82             if( ( idx = File.indexOf( sal_Unicode( '#' ) ) ) != -1 )
  83                 return File.copy( 0,idx );
  84             else
  85                 return File;
  86         }
  87
  88
  89         rtl::OUString getDatabase()
  90         {
  91             if( ! m_ptr )
  92                 return rtl::OUString();
  93
  94             sal_Int32 sizeOfDatabase = ( int ) m_ptr[ 1+ ( sal_Int32 ) m_ptr[0] ];
  95             return rtl::OUString( m_ptr + 2 + ( sal_Int32 ) m_ptr[0],sizeOfDatabase,RTL_TEXTENCODING_UTF8 );
  96         }
  97
  98
  99         rtl::OUString getTitle()
 100         {
 101             if( ! m_ptr ) // || getHash().getLength() )
 102                 return rtl::OUString();
 103
 104             sal_Int32 sizeOfTitle =
 105                 ( sal_Int32 ) m_ptr[  2 + m_ptr[0] +  ( sal_Int32 ) m_ptr[ 1+ ( sal_Int32 ) m_ptr[0] ] ];
 106             return rtl::OUString( m_ptr + 3 + m_ptr[0] +  ( sal_Int32 ) m_ptr[ 1+ ( sal_Int32 ) m_ptr[0] ],
 107                                   sizeOfTitle,
 108                                   RTL_TEXTENCODING_UTF8 );
 109         }
 110
 111
 112     private:
 113
 114         sal_Int32 m_len;
 115
 116         const sal_Char* m_ptr;
 117
 118     };
 119
 120
 121
 122
 123     class URLParameter
 124     {
 125     public:
 126
 127         URLParameter( const rtl::OUString& aURL,
 128                       Databases* pDatabases )
 129             throw( com::sun::star::ucb::IllegalIdentifierException );
 130
 131         bool isPicture()                { return m_aModule.compareToAscii("picture") == 0; }
 132         bool isActive()         { return m_aActive.getLength() > 0 && m_aActive.compareToAscii( "true" ) == 0; }
 133         bool isQuery()          { return m_aId.compareToAscii("") == 0 && m_aQuery.compareToAscii("") != 0; }
 134         bool isEntryForModule() { return m_aId.compareToAscii("start") == 0 || m_bStart; }
 135         bool isFile()           { return m_aId.compareToAscii( "" ) != 0; }
 136         bool isModule()         { return m_aId.compareToAscii("") == 0 && m_aModule.compareToAscii("") != 0; }
 137         bool isRoot()           { return m_aModule.compareToAscii("") == 0; }
 138         bool isErrorDocument();
 139
 140         rtl::OUString get_url() { return m_aURL; }
 141
 142         rtl::OUString get_id();
 143
 144         rtl::OUString get_tag();
 145
 146         //  Not called for an directory
 147
 148         rtl::OUString get_path()   { return get_the_path(); }
 149
 150         rtl::OUString get_eid()    { return m_aEid; }
 151
 152         rtl::OUString get_title();
 153
 154         rtl::OUString get_jar()      { return get_the_jar(); }      // BerkeleyDb
 155
 156         rtl::OUString get_module()   { return m_aModule; }
 157
 158         rtl::OUString get_dbpar()    {
 159             if( m_aDbPar.getLength() ) return m_aDbPar;
 160             else return m_aModule;
 161         }
 162
 163         rtl::OUString get_prefix()   { return m_aPrefix; }
 164
 165         rtl::OUString get_language();
 166
 167         rtl::OUString get_device()   { return m_aDevice; }
 168
 169         rtl::OUString get_program();
 170
 171         rtl::OUString get_query()    { return m_aQuery; }
 172
 173         rtl::OUString get_scope()    { return m_aScope; }
 174
 175         rtl::OUString get_system()   { return m_aSystem; }
 176
 177         sal_Int32     get_hitCount() { return m_nHitCount; }
 178
 179         rtl::OString getByName( const char* par );
 180
 181         void open( const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 182                    const com::sun::star::ucb::Command& aCommand,
 183                    sal_Int32 CommandId,
 184                    const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& Environment,
 185                    const com::sun::star::uno::Reference< com::sun::star::io::XActiveDataSink >& xDataSink );
 186
 187         void open( const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
 188                    const com::sun::star::ucb::Command& aCommand,
 189                    sal_Int32 CommandId,
 190                    const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& Environment,
 191                    const com::sun::star::uno::Reference< com::sun::star::io::XOutputStream >& xDataSink );
 192
 193     private:
 194
 195         Databases* m_pDatabases;
 196
 197         bool m_bBerkeleyRead;
 198         bool m_bStart;
 199         bool m_bUseDB;
 200
 201         rtl::OUString  m_aURL;
 202
 203         rtl::OUString  m_aTag;
 204         rtl::OUString  m_aId;
 205         rtl::OUString  m_aPath;
 206         rtl::OUString  m_aModule;
 207         rtl::OUString  m_aTitle;
 208         rtl::OUString  m_aJar;
 209         rtl::OUString  m_aEid;
 210         rtl::OUString  m_aDbPar;
 211
 212         rtl::OUString  m_aDefaultLanguage;
 213         rtl::OUString  m_aLanguage;
 214
 215         rtl::OUString  m_aPrefix;
 216         rtl::OUString  m_aDevice;
 217         rtl::OUString  m_aProgram;
 218         rtl::OUString  m_aSystem;
 219         rtl::OUString  m_aActive;
 220
 221         rtl::OUString  m_aQuery;
 222         rtl::OUString  m_aScope;
 223
 224         rtl::OUString m_aExpr;
 225
 226         sal_Int32      m_nHitCount;                // The default maximum hitcount
 227
 228
 229         // private methods
 230
 231         void init( bool bDefaultLanguageIsInitialized );
 232
 233         rtl::OUString get_the_tag();
 234
 235         rtl::OUString get_the_path();
 236
 237         rtl::OUString get_the_title();
 238
 239         rtl::OUString get_the_jar();
 240
 241         void readBerkeley();
 242
 243         void parse() throw( com::sun::star::ucb::IllegalIdentifierException );
 244
 245         bool scheme();
 246
 247         bool module();
 248
 249         bool name( bool modulePresent );
 250
 251         bool query();
 252
 253     };   // end class URLParameter
 254
 255
 256 }  // end namespace chelp
 257
 258 #endif