ucb/source/ucp/webdav/DAVResourceAccess.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: DAVResourceAccess.hxx,v $
  10  * $Revision: 1.19 $
  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 _DAVRESOURCEACCESS_HXX_
  32 #define _DAVRESOURCEACCESS_HXX_
  33
  34 #include <vector>
  35 #include <rtl/ustring.hxx>
  36 #include <rtl/ref.hxx>
  37 #include <osl/mutex.hxx>
  38 #include <com/sun/star/io/XInputStream.hpp>
  39 #include <com/sun/star/io/XOutputStream.hpp>
  40 #include <com/sun/star/ucb/Lock.hpp>
  41 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  42 #include "DAVAuthListener.hxx"
  43 #include "DAVException.hxx"
  44 #include "DAVSession.hxx"
  45 #include "DAVResource.hxx"
  46 #include "DAVTypes.hxx"
  47 #include "NeonUri.hxx"
  48
  49 namespace webdav_ucp
  50 {
  51
  52 class DAVSessionFactory;
  53
  54 class DAVResourceAccess
  55 {
  56     osl::Mutex    m_aMutex;
  57     rtl::OUString m_aURL;
  58     rtl::OUString m_aPath;
  59     rtl::Reference< DAVSession > m_xSession;
  60     rtl::Reference< DAVSessionFactory > m_xSessionFactory;
  61     com::sun::star::uno::Reference<
  62     com::sun::star::lang::XMultiServiceFactory > m_xSMgr;
  63     std::vector< NeonUri > m_aRedirectURIs;
  64
  65 public:
  66     DAVResourceAccess() : m_xSessionFactory( 0 ) {}
  67     DAVResourceAccess( const com::sun::star::uno::Reference<
  68                com::sun::star::lang::XMultiServiceFactory > & rSMgr,
  69                        rtl::Reference<
  70                    DAVSessionFactory > const & rSessionFactory,
  71                        const rtl::OUString & rURL );
  72     DAVResourceAccess( const DAVResourceAccess & rOther );
  73
  74     DAVResourceAccess & operator=( const DAVResourceAccess & rOther );
  75
  76     void setURL( const rtl::OUString & rNewURL )
  77     throw( DAVException );
  78
  79     void resetUri();
  80
  81     const rtl::OUString & getURL() const { return m_aURL; }
  82
  83     rtl::Reference< DAVSessionFactory > getSessionFactory() const
  84     { return m_xSessionFactory; }
  85
  86     // DAV methods
  87     //
  88
  89     void
  90     OPTIONS(  DAVCapabilities & rCapabilities,
  91           const com::sun::star::uno::Reference<
  92               com::sun::star::ucb::XCommandEnvironment > & xEnv )
  93     throw( DAVException );
  94
  95     // allprop & named
  96     void
  97     PROPFIND( const Depth nDepth,
  98           const std::vector< rtl::OUString > & rPropertyNames,
  99           std::vector< DAVResource > & rResources,
 100           const com::sun::star::uno::Reference<
 101               com::sun::star::ucb::XCommandEnvironment > & xEnv )
 102     throw( DAVException );
 103
 104     // propnames
 105     void
 106     PROPFIND( const Depth nDepth,
 107           std::vector< DAVResourceInfo > & rResInfo,
 108           const com::sun::star::uno::Reference<
 109               com::sun::star::ucb::XCommandEnvironment > & xEnv )
 110     throw( DAVException );
 111
 112     void
 113     PROPPATCH( const std::vector< ProppatchValue > & rValues,
 114            const com::sun::star::uno::Reference<
 115                com::sun::star::ucb::XCommandEnvironment >& xEnv )
 116     throw( DAVException );
 117
 118     void
 119     HEAD( const std::vector< rtl::OUString > & rHeaderNames, // empty == 'all'
 120           DAVResource & rResource,
 121           const com::sun::star::uno::Reference<
 122           com::sun::star::ucb::XCommandEnvironment >& xEnv )
 123         throw( DAVException );
 124
 125     com::sun::star::uno::Reference< com::sun::star::io::XInputStream >
 126     GET( const com::sun::star::uno::Reference<
 127          com::sun::star::ucb::XCommandEnvironment > & xEnv )
 128     throw( DAVException );
 129
 130     void
 131     GET( com::sun::star::uno::Reference<
 132          com::sun::star::io::XOutputStream > & rStream,
 133          const com::sun::star::uno::Reference<
 134          com::sun::star::ucb::XCommandEnvironment > & xEnv )
 135         throw( DAVException );
 136
 137     com::sun::star::uno::Reference< com::sun::star::io::XStream >
 138     GET( const std::vector< rtl::OUString > & rHeaderNames, // empty == 'all'
 139          DAVResource & rResource,
 140          const com::sun::star::uno::Reference<
 141              com::sun::star::ucb::XCommandEnvironment > & xEnv,
 142          sal_Bool bAllowEmpty = sal_False )
 143         throw( DAVException );
 144
 145     void
 146     GET( com::sun::star::uno::Reference<
 147          com::sun::star::io::XOutputStream > & rStream,
 148          const std::vector< rtl::OUString > & rHeaderNames, // empty == 'all'
 149          DAVResource & rResource,
 150          const com::sun::star::uno::Reference<
 151          com::sun::star::ucb::XCommandEnvironment > & xEnv )
 152         throw( DAVException );
 153
 154     void
 155     PUT( const com::sun::star::uno::Reference<
 156          com::sun::star::io::XInputStream > & rStream,
 157      const com::sun::star::uno::Reference<
 158          com::sun::star::ucb::XCommandEnvironment > & xEnv )
 159     throw( DAVException );
 160
 161     void
 162     PUT( const char * buffer, size_t size,
 163          const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > & xEnv )
 164         throw( DAVException );
 165
 166     com::sun::star::uno::Reference< com::sun::star::io::XInputStream >
 167     POST( const rtl::OUString & rContentType,
 168       const rtl::OUString & rReferer,
 169       const com::sun::star::uno::Reference<
 170           com::sun::star::io::XInputStream > & rInputStream,
 171       const com::sun::star::uno::Reference<
 172           com::sun::star::ucb::XCommandEnvironment >& xEnv )
 173         throw ( DAVException );
 174
 175     void
 176     POST( const rtl::OUString & rContentType,
 177       const rtl::OUString & rReferer,
 178       const com::sun::star::uno::Reference<
 179           com::sun::star::io::XInputStream > & rInputStream,
 180       com::sun::star::uno::Reference<
 181           com::sun::star::io::XOutputStream > & rOutputStream,
 182       const com::sun::star::uno::Reference<
 183           com::sun::star::ucb::XCommandEnvironment >& xEnv )
 184         throw ( DAVException );
 185
 186     void
 187     MKCOL( const com::sun::star::uno::Reference<
 188            com::sun::star::ucb::XCommandEnvironment > & xEnv )
 189     throw( DAVException );
 190
 191     void
 192     COPY( const ::rtl::OUString & rSourcePath,
 193       const ::rtl::OUString & rDestinationURI,
 194       sal_Bool bOverwrite,
 195       const com::sun::star::uno::Reference<
 196           com::sun::star::ucb::XCommandEnvironment > & xEnv )
 197     throw( DAVException );
 198
 199     void
 200     MOVE( const ::rtl::OUString & rSourcePath,
 201       const ::rtl::OUString & rDestinationURI,
 202       sal_Bool bOverwrite,
 203       const com::sun::star::uno::Reference<
 204           com::sun::star::ucb::XCommandEnvironment > & xEnv )
 205     throw( DAVException );
 206
 207     void
 208     DESTROY( const com::sun::star::uno::Reference<
 209               com::sun::star::ucb::XCommandEnvironment > & xEnv )
 210     throw( DAVException );
 211
 212     void
 213     LOCK( com::sun::star::ucb::Lock & rLock,
 214       const com::sun::star::uno::Reference<
 215           com::sun::star::ucb::XCommandEnvironment > & xEnv )
 216     throw( DAVException );
 217
 218     void
 219     UNLOCK( com::sun::star::ucb::Lock & rLock,
 220         const com::sun::star::uno::Reference<
 221             com::sun::star::ucb::XCommandEnvironment > & xEnv )
 222     throw( DAVException );
 223
 224     void
 225     ABORT()
 226     throw( DAVException );
 227
 228     // helper
 229     static void getUserRequestHeaders(
 230     const com::sun::star::uno::Reference<
 231         com::sun::star::ucb::XCommandEnvironment > & xEnv,
 232     const rtl::OUString & rURI,
 233     const rtl::OUString & rMethod,
 234     DAVRequestHeaders & rRequestHeaders );
 235
 236     static com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > createCommandEnvironment( void );
 237
 238 private:
 239     const rtl::OUString & getRequestURI() const;
 240     sal_Bool detectRedirectCycle( const rtl::OUString& rRedirectURL )
 241         throw ( DAVException );
 242     sal_Bool handleException( DAVException & e, int errorCount )
 243         throw ( DAVException );
 244     void initialize()
 245         throw ( DAVException );
 246 };
 247
 248 } // namespace webdav_ucp
 249
 250 #endif // _DAVRESOURCEACCESS_HXX_