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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* -*- 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.
*
************************************************************************/
#include <ne_uri.h>
#include <rtl/ustring.hxx>
#include <osl/time.h>
#include <osl/thread.hxx>
#include <sal/log.hxx>
#include <salhelper/thread.hxx>
#include "NeonSession.hxx"
#include "NeonLockStore.hxx"
using namespace webdav_ucp;
namespace webdav_ucp {
class TickerThread : public salhelper::Thread
{
bool m_bFinish;
NeonLockStore & m_rLockStore;
public:
explicit TickerThread( NeonLockStore & rLockStore )
: Thread( "NeonTickerThread" ), m_bFinish( false )
, m_rLockStore( rLockStore )
{
}
void finish() { m_bFinish = true; }
private:
virtual void execute() override;
};
} // namespace webdav_ucp
void TickerThread::execute()
{
SAL_INFO( "ucb.ucp.webdav", "TickerThread: start." );
// we have to go through the loop more often to be able to finish ~quickly
const int nNth = 25;
int nCount = nNth;
while ( !m_bFinish )
{
if (--nCount < 0)
{
m_rLockStore.refreshLocks();
nCount = nNth;
}
salhelper::Thread::wait(TimeValue(0, 1000000000 / nNth));
}
SAL_INFO( "ucb.ucp.webdav", "TickerThread: stop." );
}
NeonLockStore::NeonLockStore()
: m_pNeonLockStore( ne_lockstore_create() )
{
/*
* ne_lockstore_create() never returns a NULL; neon calls abort() in case of an out-of-memory
* situation.
* Please see:
* <http://www.webdav.org/neon/doc/html/refneon.html>
* topic title "Memory handling", copied here verbatim:
*
* "neon does not attempt to cope gracefully with an out-of-memory situation;
* instead, by default, the abort function is called to immediately terminate
* the process. An application may register a custom function which will be
* called before abort in such a situation; see ne_oom_callback."
*/
}
NeonLockStore::~NeonLockStore()
{
{
osl::ClearableMutexGuard aGuard(m_aMutex);
stopTicker(aGuard);
} // actually no threads should even try to access members now
// release active locks, if any.
SAL_WARN_IF( !m_aLockInfoMap.empty(), "ucb.ucp.webdav", "NeonLockStore::~NeonLockStore - Releasing active locks!" );
for ( auto& rLockInfo : m_aLockInfoMap )
{
NeonLock * pLock = rLockInfo.first;
rLockInfo.second.xSession->UNLOCK( pLock );
ne_lockstore_remove( m_pNeonLockStore, pLock );
ne_lock_destroy( pLock );
}
ne_lockstore_destroy( m_pNeonLockStore );
}
void NeonLockStore::startTicker()
{
osl::MutexGuard aGuard( m_aMutex );
if ( !m_pTickerThread.is() )
{
m_pTickerThread = new TickerThread( *this );
m_pTickerThread->launch();
}
}
void NeonLockStore::stopTicker(osl::ClearableMutexGuard & rGuard)
{
rtl::Reference<TickerThread> pTickerThread;
if (m_pTickerThread.is())
{
m_pTickerThread->finish(); // needs mutex
// the TickerThread may run refreshLocks() at most once after this
pTickerThread = m_pTickerThread;
m_pTickerThread.clear();
}
rGuard.clear();
if (pTickerThread.is() && pTickerThread->getIdentifier() != osl::Thread::getCurrentIdentifier())
pTickerThread->join(); // without m_aMutex locked (to prevent deadlock)
}
void NeonLockStore::registerSession( HttpSession * pHttpSession )
{
osl::MutexGuard aGuard( m_aMutex );
ne_lockstore_register( m_pNeonLockStore, pHttpSession );
}
NeonLock * NeonLockStore::findByUri( OUString const & rUri )
{
osl::MutexGuard aGuard( m_aMutex );
ne_uri aUri;
ne_uri_parse( OUStringToOString(
rUri, RTL_TEXTENCODING_UTF8 ).getStr(), &aUri );
return ne_lockstore_findbyuri( m_pNeonLockStore, &aUri );
}
void NeonLockStore::addLock( NeonLock * pLock,
rtl::Reference< NeonSession > const & xSession,
sal_Int32 nLastChanceToSendRefreshRequest )
{
osl::MutexGuard aGuard( m_aMutex );
ne_lockstore_add( m_pNeonLockStore, pLock );
m_aLockInfoMap[ pLock ]
= LockInfo( xSession, nLastChanceToSendRefreshRequest );
startTicker();
}
void NeonLockStore::removeLock( NeonLock * pLock )
{
osl::ClearableMutexGuard aGuard( m_aMutex );
m_aLockInfoMap.erase( pLock );
ne_lockstore_remove( m_pNeonLockStore, pLock );
if ( m_aLockInfoMap.empty() )
stopTicker(aGuard);
}
void NeonLockStore::removeLockDeferred(NeonLock* pLock)
{
osl::MutexGuard aGuard(m_aMutex);
m_aRemoveDeferred.push_back(pLock);
}
void NeonLockStore::refreshLocks()
{
osl::MutexGuard aGuard( m_aMutex );
for ( auto& rLockInfo : m_aLockInfoMap )
{
LockInfo & rInfo = rLockInfo.second;
if ( rInfo.nLastChanceToSendRefreshRequest != -1 )
{
// 30 seconds or less remaining until lock expires?
TimeValue t1;
osl_getSystemTime( &t1 );
if ( rInfo.nLastChanceToSendRefreshRequest - 30
<= sal_Int32( t1.Seconds ) )
{
// refresh the lock.
sal_Int32 nlastChanceToSendRefreshRequest = -1;
if ( rInfo.xSession->LOCK(
rLockInfo.first,
/* out param */ nlastChanceToSendRefreshRequest ) )
{
rInfo.nLastChanceToSendRefreshRequest
= nlastChanceToSendRefreshRequest;
}
else
{
// refresh failed. stop auto-refresh.
rInfo.nLastChanceToSendRefreshRequest = -1;
}
}
}
}
// removeLock will not need to actually release the lock, because this is run from TickerThread
for (auto pLock : m_aRemoveDeferred)
removeLock(pLock);
m_aRemoveDeferred.clear();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
