1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_framework.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski //________________________________
28*b1cdbd2cSJim Jagielski // my own includes
29*b1cdbd2cSJim Jagielski #include <jobs/configaccess.hxx>
30*b1cdbd2cSJim Jagielski #include <threadhelp/readguard.hxx>
31*b1cdbd2cSJim Jagielski #include <threadhelp/writeguard.hxx>
32*b1cdbd2cSJim Jagielski #include <threadhelp/resetableguard.hxx>
33*b1cdbd2cSJim Jagielski #include <general.h>
34*b1cdbd2cSJim Jagielski #include <services.h>
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski //________________________________
37*b1cdbd2cSJim Jagielski // interface includes
38*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/XPropertySet.hpp>
39*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/XMultiHierarchicalPropertySet.hpp>
40*b1cdbd2cSJim Jagielski #include <com/sun/star/container/XNameAccess.hpp>
41*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/PropertyValue.hpp>
42*b1cdbd2cSJim Jagielski #include <com/sun/star/util/XChangesBatch.hpp>
43*b1cdbd2cSJim Jagielski
44*b1cdbd2cSJim Jagielski //________________________________
45*b1cdbd2cSJim Jagielski // includes of other projects
46*b1cdbd2cSJim Jagielski #include <unotools/configpathes.hxx>
47*b1cdbd2cSJim Jagielski #include <rtl/ustrbuf.hxx>
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski //________________________________
50*b1cdbd2cSJim Jagielski // namespace
51*b1cdbd2cSJim Jagielski
52*b1cdbd2cSJim Jagielski namespace framework{
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski //________________________________
55*b1cdbd2cSJim Jagielski // non exported const
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski //________________________________
58*b1cdbd2cSJim Jagielski // non exported definitions
59*b1cdbd2cSJim Jagielski
60*b1cdbd2cSJim Jagielski //________________________________
61*b1cdbd2cSJim Jagielski // declarations
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski //________________________________
64*b1cdbd2cSJim Jagielski /**
65*b1cdbd2cSJim Jagielski @short open the configuration of this job
66*b1cdbd2cSJim Jagielski @descr We open the configuration of this job only. Not the whole package or the whole
67*b1cdbd2cSJim Jagielski job set. We are interested on our own properties only.
68*b1cdbd2cSJim Jagielski We set the opened configuration access as our member. So any following method,
69*b1cdbd2cSJim Jagielski which needs cfg access, can use it. That prevent us against multiple open/close requests.
70*b1cdbd2cSJim Jagielski But you can use this method to upgrade an already opened configuration too.
71*b1cdbd2cSJim Jagielski
72*b1cdbd2cSJim Jagielski @param eMode
73*b1cdbd2cSJim Jagielski force opening of the configuration access in readonly or in read/write mode
74*b1cdbd2cSJim Jagielski */
ConfigAccess(const css::uno::Reference<css::lang::XMultiServiceFactory> & xSMGR,const::rtl::OUString & sRoot)75*b1cdbd2cSJim Jagielski ConfigAccess::ConfigAccess( /*IN*/ const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
76*b1cdbd2cSJim Jagielski /*IN*/ const ::rtl::OUString& sRoot )
77*b1cdbd2cSJim Jagielski : ThreadHelpBase( )
78*b1cdbd2cSJim Jagielski , m_xSMGR ( xSMGR )
79*b1cdbd2cSJim Jagielski , m_sRoot ( sRoot )
80*b1cdbd2cSJim Jagielski , m_eMode ( E_CLOSED )
81*b1cdbd2cSJim Jagielski {
82*b1cdbd2cSJim Jagielski }
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski //________________________________
85*b1cdbd2cSJim Jagielski /**
86*b1cdbd2cSJim Jagielski @short last chance to close an open configuration access point
87*b1cdbd2cSJim Jagielski @descr In case our user forgot to close this configuration point
88*b1cdbd2cSJim Jagielski in the right way, normaly he will run into some trouble -
89*b1cdbd2cSJim Jagielski e.g. losing data.
90*b1cdbd2cSJim Jagielski */
~ConfigAccess()91*b1cdbd2cSJim Jagielski ConfigAccess::~ConfigAccess()
92*b1cdbd2cSJim Jagielski {
93*b1cdbd2cSJim Jagielski close();
94*b1cdbd2cSJim Jagielski }
95*b1cdbd2cSJim Jagielski
96*b1cdbd2cSJim Jagielski //________________________________
97*b1cdbd2cSJim Jagielski /**
98*b1cdbd2cSJim Jagielski @short return the internal mode of this instance
99*b1cdbd2cSJim Jagielski @descr May be the outside user need any information about successfully opened
100*b1cdbd2cSJim Jagielski or closed config access point objects. He can control the internal mode to do so.
101*b1cdbd2cSJim Jagielski
102*b1cdbd2cSJim Jagielski @return The internal open state of this object.
103*b1cdbd2cSJim Jagielski */
getMode() const104*b1cdbd2cSJim Jagielski ConfigAccess::EOpenMode ConfigAccess::getMode() const
105*b1cdbd2cSJim Jagielski {
106*b1cdbd2cSJim Jagielski /* SAFE { */
107*b1cdbd2cSJim Jagielski ReadGuard aReadLock(m_aLock);
108*b1cdbd2cSJim Jagielski return m_eMode;
109*b1cdbd2cSJim Jagielski /* } SAFE */
110*b1cdbd2cSJim Jagielski }
111*b1cdbd2cSJim Jagielski
112*b1cdbd2cSJim Jagielski //________________________________
113*b1cdbd2cSJim Jagielski /**
114*b1cdbd2cSJim Jagielski @short open the configuration access in the specified mode
115*b1cdbd2cSJim Jagielski @descr We set the opened configuration access as our member. So any following method,
116*b1cdbd2cSJim Jagielski which needs cfg access, can use it. That prevent us against multiple open/close requests.
117*b1cdbd2cSJim Jagielski But you can use this method to upgrade an already opened configuration too.
118*b1cdbd2cSJim Jagielski It's possible to open a config access in READONLY mode first and "open" it at a second
119*b1cdbd2cSJim Jagielski time within the mode READWRITE. Then we will upgrade it. Dowgrade will be possible too.
120*b1cdbd2cSJim Jagielski
121*b1cdbd2cSJim Jagielski But note: closing will be done explicitly by calling method close() ... not by
122*b1cdbd2cSJim Jagielski downgrading with mode CLOSED!
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski @param eMode
125*b1cdbd2cSJim Jagielski force (re)opening of the configuration access in readonly or in read/write mode
126*b1cdbd2cSJim Jagielski */
open(EOpenMode eMode)127*b1cdbd2cSJim Jagielski void ConfigAccess::open( /*IN*/ EOpenMode eMode )
128*b1cdbd2cSJim Jagielski {
129*b1cdbd2cSJim Jagielski /* SAFE { */
130*b1cdbd2cSJim Jagielski // We must lock the whole method to be shure, that nobody
131*b1cdbd2cSJim Jagielski // outside uses our internal member m_xAccess!
132*b1cdbd2cSJim Jagielski WriteGuard aWriteLock(m_aLock);
133*b1cdbd2cSJim Jagielski
134*b1cdbd2cSJim Jagielski // check if configuration is already open in the right mode.
135*b1cdbd2cSJim Jagielski // By the way: Don't allow closing by using this method!
136*b1cdbd2cSJim Jagielski if (
137*b1cdbd2cSJim Jagielski (eMode !=E_CLOSED) &&
138*b1cdbd2cSJim Jagielski (m_eMode!=eMode )
139*b1cdbd2cSJim Jagielski )
140*b1cdbd2cSJim Jagielski {
141*b1cdbd2cSJim Jagielski // We have to close the old access point without any question here.
142*b1cdbd2cSJim Jagielski // It will be open again using the new mode.
143*b1cdbd2cSJim Jagielski // can be called without checks! It does the checks by itself ...
144*b1cdbd2cSJim Jagielski // e.g. for already closed or not opened configuration.
145*b1cdbd2cSJim Jagielski // Flushing of all made changes will be done here too.
146*b1cdbd2cSJim Jagielski close();
147*b1cdbd2cSJim Jagielski
148*b1cdbd2cSJim Jagielski // create the configuration provider, which provides sub access points
149*b1cdbd2cSJim Jagielski css::uno::Reference< css::lang::XMultiServiceFactory > xConfigProvider(m_xSMGR->createInstance(SERVICENAME_CFGPROVIDER), css::uno::UNO_QUERY);
150*b1cdbd2cSJim Jagielski if (xConfigProvider.is())
151*b1cdbd2cSJim Jagielski {
152*b1cdbd2cSJim Jagielski css::beans::PropertyValue aParam;
153*b1cdbd2cSJim Jagielski aParam.Name = DECLARE_ASCII("nodepath");
154*b1cdbd2cSJim Jagielski aParam.Value <<= m_sRoot;
155*b1cdbd2cSJim Jagielski
156*b1cdbd2cSJim Jagielski css::uno::Sequence< css::uno::Any > lParams(1);
157*b1cdbd2cSJim Jagielski lParams[0] <<= aParam;
158*b1cdbd2cSJim Jagielski
159*b1cdbd2cSJim Jagielski // open it
160*b1cdbd2cSJim Jagielski try
161*b1cdbd2cSJim Jagielski {
162*b1cdbd2cSJim Jagielski if (eMode==E_READONLY)
163*b1cdbd2cSJim Jagielski m_xConfig = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGREADACCESS , lParams);
164*b1cdbd2cSJim Jagielski else
165*b1cdbd2cSJim Jagielski if (eMode==E_READWRITE)
166*b1cdbd2cSJim Jagielski m_xConfig = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGUPDATEACCESS, lParams);
167*b1cdbd2cSJim Jagielski }
168*b1cdbd2cSJim Jagielski catch(css::uno::Exception& ex)
169*b1cdbd2cSJim Jagielski {
170*b1cdbd2cSJim Jagielski (void) ex; // avoid warning
171*b1cdbd2cSJim Jagielski LOG_WARNING("open config ...", U2B(ex.Message))
172*b1cdbd2cSJim Jagielski }
173*b1cdbd2cSJim Jagielski
174*b1cdbd2cSJim Jagielski m_eMode = E_CLOSED;
175*b1cdbd2cSJim Jagielski if (m_xConfig.is())
176*b1cdbd2cSJim Jagielski m_eMode = eMode;
177*b1cdbd2cSJim Jagielski }
178*b1cdbd2cSJim Jagielski }
179*b1cdbd2cSJim Jagielski
180*b1cdbd2cSJim Jagielski aWriteLock.unlock();
181*b1cdbd2cSJim Jagielski /* } SAFE */
182*b1cdbd2cSJim Jagielski }
183*b1cdbd2cSJim Jagielski
184*b1cdbd2cSJim Jagielski //________________________________
185*b1cdbd2cSJim Jagielski /**
186*b1cdbd2cSJim Jagielski @short close the internal opened configuration access and flush all changes
187*b1cdbd2cSJim Jagielski @descr It checks, if the given access is valid and react in the right way.
188*b1cdbd2cSJim Jagielski It flushes all changes ... so nobody else must know this state.
189*b1cdbd2cSJim Jagielski */
close()190*b1cdbd2cSJim Jagielski void ConfigAccess::close()
191*b1cdbd2cSJim Jagielski {
192*b1cdbd2cSJim Jagielski /* SAFE { */
193*b1cdbd2cSJim Jagielski // Lock the whole method, to be shure that nobody else uses our internal members
194*b1cdbd2cSJim Jagielski // during this time.
195*b1cdbd2cSJim Jagielski WriteGuard aWriteLock(m_aLock);
196*b1cdbd2cSJim Jagielski
197*b1cdbd2cSJim Jagielski // check already closed configuration
198*b1cdbd2cSJim Jagielski if (m_xConfig.is())
199*b1cdbd2cSJim Jagielski {
200*b1cdbd2cSJim Jagielski css::uno::Reference< css::util::XChangesBatch > xFlush(m_xConfig, css::uno::UNO_QUERY);
201*b1cdbd2cSJim Jagielski if (xFlush.is())
202*b1cdbd2cSJim Jagielski xFlush->commitChanges();
203*b1cdbd2cSJim Jagielski m_xConfig = css::uno::Reference< css::uno::XInterface >();
204*b1cdbd2cSJim Jagielski m_eMode = E_CLOSED;
205*b1cdbd2cSJim Jagielski }
206*b1cdbd2cSJim Jagielski
207*b1cdbd2cSJim Jagielski aWriteLock.unlock();
208*b1cdbd2cSJim Jagielski /* } SAFE */
209*b1cdbd2cSJim Jagielski }
210*b1cdbd2cSJim Jagielski
211*b1cdbd2cSJim Jagielski //________________________________
212*b1cdbd2cSJim Jagielski /**
213*b1cdbd2cSJim Jagielski @short provides an access to the internal wrapped configuration access
214*b1cdbd2cSJim Jagielski @descr It's not allowed to safe this c++ (!) reference outside. You have
215*b1cdbd2cSJim Jagielski to use it directly. Further you must use our public lock member m_aLock
216*b1cdbd2cSJim Jagielski to synchronize your code with our internal structures and our interface
217*b1cdbd2cSJim Jagielski methods. Acquire it before you call cfg() and release it afterwards immediatly.
218*b1cdbd2cSJim Jagielski
219*b1cdbd2cSJim Jagielski E.g.: ConfigAccess aAccess(...);
220*b1cdbd2cSJim Jagielski ReadGuard aReadLock(aAccess.m_aLock);
221*b1cdbd2cSJim Jagielski Reference< XPropertySet > xSet(aAccess.cfg(), UNO_QUERY);
222*b1cdbd2cSJim Jagielski Any aProp = xSet->getPropertyValue("...");
223*b1cdbd2cSJim Jagielski aReadLock.unlock();
224*b1cdbd2cSJim Jagielski
225*b1cdbd2cSJim Jagielski @attention During this time it's not allowed to call the methods open() or close()!
226*b1cdbd2cSJim Jagielski Otherwhise you will change your own referenced config access. Anything will
227*b1cdbd2cSJim Jagielski be possible then.
228*b1cdbd2cSJim Jagielski
229*b1cdbd2cSJim Jagielski @return A c++(!) reference to the uno instance of the configuration access point.
230*b1cdbd2cSJim Jagielski */
cfg()231*b1cdbd2cSJim Jagielski const css::uno::Reference< css::uno::XInterface >& ConfigAccess::cfg()
232*b1cdbd2cSJim Jagielski {
233*b1cdbd2cSJim Jagielski // must be synchronized from outside!
234*b1cdbd2cSJim Jagielski // => no lock here ...
235*b1cdbd2cSJim Jagielski return m_xConfig;
236*b1cdbd2cSJim Jagielski }
237*b1cdbd2cSJim Jagielski
238*b1cdbd2cSJim Jagielski } // namespace framework
239