binfilter/inc/bf_sfx2/fcontnr.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: fcontnr.hxx,v $
  10  * $Revision: 1.7 $
  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 #ifndef _SFX_FCONTNR_HXX
  31 #define _SFX_FCONTNR_HXX
  32
  33 #ifndef _SFXPOOLITEM_HXX //autogen
  34 #include <bf_svtools/poolitem.hxx>
  35 #endif
  36 #ifndef _WINDOW_HXX //autogen
  37 #include <vcl/window.hxx>
  38 #endif
  39
  40 #include <bf_sfx2/docfilt.hxx>
  41 #include <bf_sfx2/sfxdefs.hxx>
  42 class Window;
  43 namespace binfilter {
  44
  45 class SfxFilter;
  46 class SfxFilterArr_Impl;
  47 class SfxObjectFacArr_Impl;
  48 class SfxObjectFactory;
  49 class SfxMedium;
  50 class SfxFilterContainer_Impl;
  51 class SfxFrame;
  52
  53 #define SFX_FCONTNR_REDIRECTS "Redirects"
  54 #define SFX_FCONTNR_EXTAPP    "External"
  55
  56 #define SFX_FILTER_DOWNLOAD  "StarDownload (*.dnl)"
  57
  58 #define SFX_FILTER_CONTAINER_FACTORY 1
  59 typedef USHORT SfxFilterContainerFlags;
  60
  61 class SfxRefItem : public SfxPoolItem
  62 {
  63     SvRefBaseRef aRef;
  64 public:
  65     virtual SfxPoolItem*         Clone( SfxItemPool *pPool = 0 ) const
  66     { (void)pPool;      return new SfxRefItem( *this ); }
  67     virtual int                          operator==( const SfxPoolItem& rL) const
  68     {   return ((SfxRefItem&)rL).aRef == aRef; }
  69     SfxRefItem( USHORT nWhich, const SvRefBaseRef& rValue ) : SfxPoolItem( nWhich )
  70     {   aRef = rValue; }
  71     const SvRefBaseRef&      GetValue() const { return aRef; }
  72
  73 };
  74
  75 class SfxFrameWindow
  76 {
  77     Window*             pWindow;
  78 public:
  79                 SfxFrameWindow( Window *pWin )
  80                  : pWindow( pWin )
  81                 {}
  82
  83     virtual             ~SfxFrameWindow()
  84                 { delete pWindow; }
  85     Window*             GetWindow() const
  86                 { return pWindow; }
  87     void                SetWindow( Window *pWin )
  88                 { pWindow = pWin; }
  89 };
  90
  91 class SfxFrameWindowFactory
  92 {
  93     typedef SfxFrameWindow* (*FactoryFunc)( SfxFrame* pParent, const String& rName );
  94     FactoryFunc pFunc;
  95     String aName;
  96 public:
  97     SfxFrameWindowFactory( FactoryFunc pFuncP, String aNameP );
  98     String GetURLWildCard() { return aName; }
  99     FactoryFunc GetFactory() { return pFunc; }
 100 };
 101
 102 typedef ULONG (*SfxDetectFilter)(
 103     SfxMedium& rMedium, const SfxFilter **, SfxFilterFlags nMust, SfxFilterFlags nDont );
 104
 105 class SfxFilterContainer
 106 {
 107 protected:
 108     SfxFilterContainer_Impl *pImpl;
 109 #if _SOLAR__PRIVATE
 110 public:
 111     DECL_STATIC_LINK( SfxFilterContainer, LoadHdl_Impl, void* );
 112 protected:
 113     void ForceFilterLoad_Impl() const;
 114     void RealLoad_Impl();
 115 #endif
 116
 117 public:
 118     SfxFilterContainer( const String& rName );
 119     virtual ~SfxFilterContainer();
 120
 121     SfxFilterContainerFlags GetFlags() const;
 122     void SetFlags( SfxFilterContainerFlags eFlags );
 123
 124     virtual const SfxFilter* GetFilter4Mime(
 125         const String& rMime, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 126     virtual const SfxFilter* GetFilter4ClipBoardId(
 127         ULONG nId, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 128     virtual const SfxFilter* GetFilter4EA(
 129         const String& rEA, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 130     virtual const SfxFilter* GetFilter4Extension(
 131         const String& rExt, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 132     virtual const SfxFilter* GetFilter4FilterName(
 133         const String& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 134     SfxFilter* GetFilter4FilterName(
 135         const String& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED )
 136     {
 137         return (SfxFilter*)(const SfxFilter*)
 138             ((const SfxFilterContainer* const)this)->GetFilter4FilterName(
 139                 rName, nMust, nDont );
 140     }
 141     const SfxFilter* GetFilter4Protocol(
 142         const String& rURL, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 143     virtual ULONG            GetFilter4Content(
 144         SfxMedium& rMedium, const SfxFilter**, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const ;
 145     virtual const SfxFilter* GetFilter4Protocol(
 146         SfxMedium& rMed, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 147     virtual const SfxFilter* GetFilter(
 148         const String& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 149
 150     virtual USHORT           GetFilterCount() const;
 151     virtual const SfxFilter* GetFilter( USHORT ) const;
 152     virtual ULONG            Execute( SfxMedium& rMedium, SfxFrame*& rpFrame ) const ;
 153
 154
 155     const String             GetName() const;
 156
 157     void                     AddFilter( SfxFilter* pFilter, USHORT nPos );
 158     void                     LoadFilters(
 159         const String& rGroup, BOOL bInstallIni = TRUE, SfxFilterFlags nAddMask = 0, SfxFilterFlags nDelMask = 0);
 160 /*AS    static String            ConvertToOldFilterName( const String& rNew );
 161     static String            ConvertToNewFilterName( const String& rNew ); */
 162     void                     ReadExternalFilters( const String& rDocServiceName );
 163 };
 164
 165
 166 #if _SOLAR__PRIVATE
 167
 168 enum SfxExecutableFilterType_Impl
 169 {
 170     SFX_EXE_FILTER_BOOKMARK,
 171     SFX_EXE_FILTER_OS2BOOKMARK,
 172     SFX_EXE_FILTER_MAILTO,
 173     SFX_EXE_FILTER_MACRO,
 174     SFX_EXE_FILTER_SLOT,
 175     SFX_EXE_FILTER_JAVASCRIPT,
 176     SFX_EXE_FILTER_FACTORY,
 177     SFX_EXE_FILTER_EXPLORER,
 178     SFX_EXE_FILTER_BUGID,
 179     SFX_EXE_FILTER_ZIP,
 180     SFX_EXE_FILTER_BUGDOC,
 181     SFX_EXE_FILTER_CHOOSER,
 182     SFX_EXE_FILTER_DOWNLOAD,
 183     SFX_EXE_FILTER_SUBSCRIBENEWAGENT,
 184     SFX_EXE_FILTER_HELPID,
 185     SFX_EXE_FILTER_EXECUTE,
 186     SFX_EXE_FILTER_CDFCHANNEL,
 187     SFX_EXE_FILTER_COMPONENT,
 188     SFX_EXE_FILTER_CHAOSCHANNEL,
 189     SFX_EXE_FILTER_UNO,
 190     SFX_EXE_FILTER_COMMAND,
 191     SFX_EXE_FILTER_HELPENTRY,
 192     SFX_EXE_FILTER_SOUND,
 193     SFX_EXE_FILTER_EXTERNBROWSER
 194 };
 195
 196 #endif
 197
 198 class SfxExecutableFilterTypes_Impl;
 199 class SfxExecutableFilterContainer : public SfxFilterContainer
 200 {
 201     SfxExecutableFilterTypes_Impl* pTypes;
 202
 203 #if _SOLAR__PRIVATE
 204
 205     ULONG                    Download_Impl( SfxMedium& rMedium ) const;
 206     ULONG                    Choose_Impl( SfxMedium& rMedium ) const;
 207     ULONG                    Unzip_Impl( SfxMedium& rMedium ) const;
 208     String                   GetBugdocName_Impl( const String& rName ) const;
 209     void                     AddExeFilter( SfxFilter* pFilter, SfxExecutableFilterType_Impl eType, const String& rPattern );
 210 #endif
 211
 212 public:
 213                              SfxExecutableFilterContainer();
 214                              ~SfxExecutableFilterContainer();
 215
 216     virtual const SfxFilter* GetFilter4Protocol( SfxMedium& rMed, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 217     virtual ULONG            Execute( SfxMedium& rMedium, SfxFrame*& ) const ;
 218
 219     static const SfxFilter*  CheckForFolder( SfxMedium& rMed, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED );
 220     static const SfxFilter*      GetComponentFilter();
 221     static const SfxFilter*      GetExplorerFilter();
 222 };
 223
 224 class SfxExternalAppFilterContainer : public SfxFilterContainer
 225 {
 226 public:
 227     SfxExternalAppFilterContainer();
 228     virtual ULONG            Execute( SfxMedium& rMedium, SfxFrame*& ) const;
 229     virtual const SfxFilter* GetFilter4FilterName(
 230         const String& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 231     virtual USHORT           GetFilterCount() const;
 232     virtual const SfxFilter* GetFilter4Protocol(
 233         SfxMedium& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 234 };
 235
 236 class SfxPluginFilterContainer : public SfxFilterContainer
 237 {
 238     BOOL                                                bInitialized;
 239     DECL_LINK(                                  LoadHdl_Impl, void* );
 240 public:
 241                                 SfxPluginFilterContainer();
 242     virtual ULONG               Execute( SfxMedium& rMedium, SfxFrame*& ) const;
 243     virtual USHORT              GetFilterCount() const;
 244     virtual const SfxFilter*    GetFilter4Protocol( SfxMedium& rMed, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 245 };
 246
 247 class SfxFactoryFilterContainer : public SfxFilterContainer
 248 {
 249
 250     const SfxObjectFactory& rFact;
 251     SfxDetectFilter pFunc;
 252
 253 public:
 254
 255     SfxFactoryFilterContainer(
 256         const String& rName, const SfxObjectFactory& rFactP );
 257     void SetDetectFilter( SfxDetectFilter pFuncP ) { pFunc = pFuncP; }
 258     virtual ULONG GetFilter4Content(
 259         SfxMedium& rMedium, const SfxFilter **,
 260         SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const ;
 261     const SfxObjectFactory& GetFactory() const { return rFact; }
 262 };
 263
 264 class SfxFilterMatcher_Impl;
 265
 266 class SfxFilterMatcher
 267 {
 268     SfxFilterMatcher_Impl *pImpl;
 269 public:
 270     SfxFilterMatcher( SfxFilterContainer* pCont );
 271     SfxFilterMatcher(BOOL bDeleteContainers);
 272     ~SfxFilterMatcher();
 273
 274         SfxFilterContainer*       GetContainer( const String& rName ) const;
 275     void                      AddContainer( SfxFilterContainer* );
 276     ULONG                     GuessFilterIgnoringContent(
 277         SfxMedium& rMedium, const SfxFilter **,
 278         SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 279     ULONG                     GuessFilter(
 280         SfxMedium& rMedium, const SfxFilter **,
 281         SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 282     const SfxFilter*          GetFilter4ClipBoardId(
 283         ULONG nId, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 284     const SfxFilter*          GetFilter4Extension(
 285         const String& rExt, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 286
 287 /*STRIP003*/    ULONG                     GetFilter4Content(
 288 /*STRIP003*/            SfxMedium& rMedium, const SfxFilter**, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED, BOOL bOnlyGoodOnes=FALSE ) const ;
 289     const SfxFilter*          GetFilter4Protocol(
 290         SfxMedium& rMed, SfxFilterFlags nMust = SFX_FILTER_IMPORT, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 291     const SfxFilter*          GetFilter4FilterName(
 292         const String& rName, SfxFilterFlags nMust = 0, SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED ) const;
 293
 294
 295     const SfxFilter*          ResolveRedirection( const SfxFilter*, SfxMedium& rMedium ) const;
 296     const SfxFilter*          ResolveRedirection( const SfxFilter*, const String& rURLPath ) const;
 297     const SfxFilter*          ResolveAppPlug( const SfxFilter* ) const;
 298
 299
 300     friend class SfxFilterMatcherIter;
 301     DECL_STATIC_LINK( SfxFilterMatcher, MaybeFileHdl_Impl, String* );
 302 };
 303
 304 class SfxFilterMatcherIter
 305 {
 306     SfxFilterFlags nOrMask;
 307     SfxFilterFlags nAndMask;
 308     USHORT nBorder;
 309     int nAktFilter;
 310     int nAktContainer;
 311     SfxFilterContainer* pCont;
 312     const SfxFilterMatcher_Impl *pMatch;
 313 };
 314
 315 }//end of namespace binfilter
 316 #endif