1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_UCB_SOURCE_UCP_WEBDAV_NEON_DAVTYPES_HXX
#define INCLUDED_UCB_SOURCE_UCP_WEBDAV_NEON_DAVTYPES_HXX
#include <config_lgpl.h>
#include <memory>
#include <list>
#include <map>
#include "osl/mutex.hxx"
#include <rtl/uri.hxx>
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Any.hxx>
namespace webdav_ucp
{
/* Excerpt from RFC 4918
<https://tools.ietf.org/html/rfc4918#section-18>
18.1 Class 1
A class 1 compliant resource MUST meet all "MUST" requirements in all
sections of this document.
Class 1 compliant resources MUST return, at minimum, the value "1" in
the DAV header on all responses to the OPTIONS method.
18.2 Class 2
A class 2 compliant resource MUST meet all class 1 requirements and
support the LOCK method, the DAV:supportedlock property, the DAV:
lockdiscovery property, the Time-Out response header and the Lock-
Token request header. A class 2 compliant resource SHOULD also
support the Timeout request header and the 'owner' XML element.
Class 2 compliant resources MUST return, at minimum, the values "1"
and "2" in the DAV header on all responses to the OPTIONS method.
18.3. Class 3
A resource can explicitly advertise its support for the revisions to
[RFC2518] made in this document. Class 1 MUST be supported as well.
Class 2 MAY be supported. Advertising class 3 support in addition to
class 1 and 2 means that the server supports all the requirements in
this specification. Advertising class 3 and class 1 support, but not
class 2, means that the server supports all the requirements in this
specification except possibly those that involve locking support.
*/
class DAVOptions
{
private:
bool m_isResourceFound; // true if the resource was found, else false
bool m_isClass1;
bool m_isClass2;
bool m_isClass3;
// for server that do not implement it
bool m_isHeadAllowed;
// Internally used to maintain locked stated of the resource, only
// if it's a Class 2 resource
bool m_isLocked;
// contains the methods allowed on this resource
OUString m_aAllowedMethods;
/// target time when this capability becomes stale
sal_uInt32 m_nStaleTime;
OUString m_sURL;
OUString m_sRedirectedURL;
public:
DAVOptions();
DAVOptions( const DAVOptions & rOther );
virtual ~DAVOptions();
bool isResourceFound() { return m_isResourceFound; };
void setResourceFound( bool ResourceFound = true ) { m_isResourceFound = ResourceFound; };
bool isClass1() { return m_isClass1; };
void setClass1( bool Class1 = true ) { m_isClass1 = Class1; };
bool isClass2() { return m_isClass2; };
void setClass2( bool Class2 = true ) { m_isClass2 = Class2; };
bool isClass3() { return m_isClass3; };
void setClass3( bool Class3 = true ) { m_isClass3 = Class3; };
bool isHeadAllowed() { return m_isHeadAllowed; };
void setHeadAllowed( bool HeadAllowed = true ) { m_isHeadAllowed = HeadAllowed; };
sal_uInt32 getStaleTime() const { return m_nStaleTime ; };
void setStaleTime( const sal_uInt32 nStaleTime ) { m_nStaleTime = nStaleTime; };
const OUString & getURL() { return m_sURL; };
void setURL( const OUString & sURL ) { m_sURL = sURL; };
const OUString & getRedirectedURL() { return m_sRedirectedURL; };
void setRedirectedURL( const OUString & sRedirectedURL ) { m_sRedirectedURL = sRedirectedURL; };
void setAllowedMethods( const OUString & aAllowedMethods ) { m_aAllowedMethods = aAllowedMethods; } ;
const OUString & getAllowedMethods() { return m_aAllowedMethods; } ;
bool isLockAllowed() { return ( m_aAllowedMethods.indexOf( "LOCK" ) != -1 ); };
void setLocked( bool locked = true ) { m_isLocked = locked; } ;
bool isLocked() { return m_isLocked; };
void init() {
m_isResourceFound = false;
m_isClass1 = false;
m_isClass2 = false;
m_isClass3 = false;
m_isHeadAllowed = true;
m_isLocked = false;
m_aAllowedMethods.clear();
m_nStaleTime = 0;
m_sURL.clear();
m_sRedirectedURL.clear();
};
bool operator==( const DAVOptions& rOpts ) const;
};
// TODO: the OUString key element in std::map needs to be changed with a URI representation
// along with a specific compare (std::less) implementation, as suggested in
// <https://tools.ietf.org/html/rfc3986#section-6>, to find by URI and not by string comparison
typedef std::map< OUString, DAVOptions,
std::less< OUString > > DAVOptionsMap;
class DAVOptionsCache
{
DAVOptionsMap m_aTheCache;
osl::Mutex m_aMutex;
public:
explicit DAVOptionsCache();
~DAVOptionsCache();
bool getDAVOptions( const OUString & rURL, DAVOptions & rDAVOptions );
void removeDAVOptions( const OUString & rURL );
void addDAVOptions( DAVOptions & rDAVOptions, const sal_uInt32 nLifeTime );
/** Check if the DAV options cached value was found
by the last OPTIONS method call.
If the cached value is found stale, it is removed.
@param OUString
the resource URL
@return bool
true if resource was found or if the Web resource DAV options
are not present (meaning the resource should be checked for
presence anyway)
false if resource was not found
*/
bool isResourceFound( const OUString & rURL );
bool isHeadAllowed( const OUString & rURL );
private:
/// remove the last '/' in aUrl, if it exists
static void normalizeURLLastChar( OUString& aUrl ) {
if ( aUrl.getLength() > 1 &&
( ( aUrl.lastIndexOf( '/' ) + 1 ) == aUrl.getLength() ) )
aUrl = aUrl.copy(0, aUrl.getLength() - 1 );
};
};
enum Depth { DAVZERO = 0, DAVONE = 1, DAVINFINITY = -1 };
enum ProppatchOperation { PROPSET = 0, PROPREMOVE = 1 };
struct ProppatchValue
{
ProppatchOperation operation;
OUString name;
css::uno::Any value;
ProppatchValue( const ProppatchOperation o,
const OUString & n,
const css::uno::Any & v )
: operation( o ), name( n ), value( v ) {}
};
} // namespace webdav_ucp
#endif // INCLUDED_UCB_SOURCE_UCP_WEBDAV_NEON_DAVTYPES_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
