/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ // MARKER(update_precomp.py): autogen include statement, do not remove #include "precompiled_framework.hxx" //________________________________ // my own includes #include #include #include #include #include #include //________________________________ // interface includes #include #include #include #include //________________________________ // includes of other projects #include #include #include #include //________________________________ // namespace namespace framework{ //________________________________ // exported const const sal_Char* JobData::JOBCFG_ROOT = "/org.openoffice.Office.Jobs/Jobs/" ; const sal_Char* JobData::JOBCFG_PROP_SERVICE = "Service" ; const sal_Char* JobData::JOBCFG_PROP_CONTEXT = "Context" ; const sal_Char* JobData::JOBCFG_PROP_ARGUMENTS = "Arguments" ; const sal_Char* JobData::EVENTCFG_ROOT = "/org.openoffice.Office.Jobs/Events/" ; const sal_Char* JobData::EVENTCFG_PATH_JOBLIST = "/JobList" ; const sal_Char* JobData::EVENTCFG_PROP_ADMINTIME = "AdminTime" ; const sal_Char* JobData::EVENTCFG_PROP_USERTIME = "UserTime" ; const sal_Char* JobData::PROPSET_CONFIG = "Config" ; const sal_Char* JobData::PROPSET_OWNCONFIG = "JobConfig" ; const sal_Char* JobData::PROPSET_ENVIRONMENT = "Environment" ; const sal_Char* JobData::PROPSET_DYNAMICDATA = "DynamicData" ; const sal_Char* JobData::PROP_ALIAS = "Alias" ; const sal_Char* JobData::PROP_EVENTNAME = "EventName" ; const sal_Char* JobData::PROP_ENVTYPE = "EnvType" ; const sal_Char* JobData::PROP_FRAME = "Frame" ; const sal_Char* JobData::PROP_MODEL = "Model" ; const sal_Char* JobData::PROP_SERVICE = "Service" ; const sal_Char* JobData::PROP_CONTEXT = "Context" ; //________________________________ // non exported definitions //________________________________ // declarations //________________________________ /** @short standard ctor @descr It initialize this new instance. But for real working it's neccessary to call setAlias() or setService() later. Because we need the job data ... @param xSMGR reference to the uno service manager */ JobData::JobData( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ) : ThreadHelpBase(&Application::GetSolarMutex()) , m_xSMGR (xSMGR ) { // share code for member initialization with defaults! impl_reset(); } //________________________________ /** @short copy ctor @descr Sometimes such job data container must be moved from one using place to another one. Then a copy ctor and copy operator must be available. @param rCopy the original instance, from which we must copy all data */ JobData::JobData( const JobData& rCopy ) : ThreadHelpBase(&Application::GetSolarMutex()) { // use the copy operator to share the same code *this = rCopy; } //________________________________ /** @short operator for coping JobData instances @descr Sometimes such job data container must be moved from one using place to another one. Then a copy ctor and copy operator must be available. @param rCopy the original instance, from which we must copy all data */ void JobData::operator=( const JobData& rCopy ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // Please don't copy the uno service manager reference. // That can change the uno context, which isn't a good idea! m_eMode = rCopy.m_eMode ; m_eEnvironment = rCopy.m_eEnvironment ; m_sAlias = rCopy.m_sAlias ; m_sService = rCopy.m_sService ; m_sContext = rCopy.m_sContext ; m_sEvent = rCopy.m_sEvent ; m_lArguments = rCopy.m_lArguments ; m_aLastExecutionResult = rCopy.m_aLastExecutionResult; aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short let this instance die @descr There is no chance any longer to work. We have to release all used ressources and free used memory. */ JobData::~JobData() { impl_reset(); } //________________________________ /** @short initalize this instance as a job with configuration @descr They given alias can be used to adress some configuraton data. We read it and fill our internal structures. Of course old informations will be lost doing so. @param sAlias the alias name of this job, used to locate job properties inside cfg */ void JobData::setAlias( const ::rtl::OUString& sAlias ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // delete all old informations! Otherwhise we mix it with the new one ... impl_reset(); // take over the new informations m_sAlias = sAlias; m_eMode = E_ALIAS; // try to open the configuration set of this job directly and get a property access to it // We open it readonly here ::rtl::OUString sKey; sKey = ::rtl::OUString::createFromAscii(JOBCFG_ROOT); sKey += ::utl::wrapConfigurationElementName(m_sAlias); ConfigAccess aConfig(m_xSMGR, sKey); aConfig.open(ConfigAccess::E_READONLY); if (aConfig.getMode()==ConfigAccess::E_CLOSED) { impl_reset(); return; } css::uno::Reference< css::beans::XPropertySet > xJobProperties(aConfig.cfg(), css::uno::UNO_QUERY); if (xJobProperties.is()) { css::uno::Any aValue; // read uno implementation name aValue = xJobProperties->getPropertyValue(::rtl::OUString::createFromAscii(JOBCFG_PROP_SERVICE)); aValue >>= m_sService; // read module context list aValue = xJobProperties->getPropertyValue(::rtl::OUString::createFromAscii(JOBCFG_PROP_CONTEXT)); aValue >>= m_sContext; // read whole argument list aValue = xJobProperties->getPropertyValue(::rtl::OUString::createFromAscii(JOBCFG_PROP_ARGUMENTS)); css::uno::Reference< css::container::XNameAccess > xArgumentList; if ( (aValue >>= xArgumentList) && (xArgumentList.is() ) ) { css::uno::Sequence< ::rtl::OUString > lArgumentNames = xArgumentList->getElementNames(); sal_Int32 nCount = lArgumentNames.getLength(); m_lArguments.realloc(nCount); for (sal_Int32 i=0; igetByName(m_lArguments[i].Name); } } } aConfig.close(); aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short initalize this instance as a job without configuration @descr This job has no configuration data. We have to forget all old informations and set only some of them new, so this instance can work. @param sService the uno service name of this "non configured" job */ void JobData::setService( const ::rtl::OUString& sService ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // delete all old informations! Otherwhise we mix it with the new one ... impl_reset(); // take over the new informations m_sService = sService; m_eMode = E_SERVICE; aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short initialize this instance with new job values. @descr It reads automaticly all properties of the specified job (using it's alias name) and "register it" for the given event. This registration will not be validated against the underlying configuration! (That must be done from outside. Because the caller must have the configuration already open to get the values for sEvent and sAlias! And doing so it can perform only, if the time stanp values are readed outside too. Further it make no sense to initialize and start a disabled job. So this initialization method will be called for enabled jobs only.) @param sEvent the triggered event, for which this job should be started @param sAlias mark the required job inside event registration list */ void JobData::setEvent( const ::rtl::OUString& sEvent , const ::rtl::OUString& sAlias ) { // share code to read all job properties! setAlias(sAlias); /* SAFE { */ WriteGuard aWriteLock(m_aLock); // take over the new informations - which differ against set on of method setAlias()! m_sEvent = sEvent; m_eMode = E_EVENT; aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short set the new job specific arguments @descr If a job finish his work, it can give us a new list of arguments (which will not interpreted by us). We write it back to the configuration only (if this job has it's own configuration!). So a job can have persistent data without implementing anything or define own config areas for that. @param lArguments list of arguments, which should be set for this job */ void JobData::setJobConfig( const css::uno::Sequence< css::beans::NamedValue >& lArguments ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // update member m_lArguments = lArguments; // update the configuration ... if possible! if (m_eMode==E_ALIAS) { // It doesn't matter if this config object was already opened before. // It doesn nothing here then ... or it change the mode automaticly, if // it was opened using another one before. ::rtl::OUString sKey; sKey = ::rtl::OUString::createFromAscii(JOBCFG_ROOT); sKey += ::utl::wrapConfigurationElementName(m_sAlias); ConfigAccess aConfig(m_xSMGR, sKey); aConfig.open(ConfigAccess::E_READWRITE); if (aConfig.getMode()==ConfigAccess::E_CLOSED) return; css::uno::Reference< css::beans::XMultiHierarchicalPropertySet > xArgumentList(aConfig.cfg(), css::uno::UNO_QUERY); if (xArgumentList.is()) { sal_Int32 nCount = m_lArguments.getLength(); css::uno::Sequence< ::rtl::OUString > lNames (nCount); css::uno::Sequence< css::uno::Any > lValues(nCount); for (sal_Int32 i=0; isetHierarchicalPropertyValues(lNames, lValues); } aConfig.close(); } aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short set a new excution result @descr Every executed job can have returned a result. We set it here, so our user can use it may be later. But the outside code can use it too, to analyze it and adopt the configuration of this job too. Because the result uses a protocol, which allow that. And we provide right functionality to save it. @param aResult the result of last execution */ void JobData::setResult( const JobResult& aResult ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // overwrite the last saved result m_aLastExecutionResult = aResult; // Don't use his informations to update // e.g. the arguments of this job. It must be done // from outside! Here we save this information only. aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short set a new environment descriptor for this job @descr It must(!) be done everytime this container is initialized with new job datas e.g.: setAlias()/setEvent()/setService() ... Otherwhise the environment will be unknown! */ void JobData::setEnvironment( EEnvironment eEnvironment ) { /* SAFE { */ WriteGuard aWriteLock(m_aLock); m_eEnvironment = eEnvironment; aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** @short these functions provides access to our internal members @descr These member represent any information about the job and can be used from outside to e.g. start a job. */ JobData::EMode JobData::getMode() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return m_eMode; /* } SAFE */ } //________________________________ JobData::EEnvironment JobData::getEnvironment() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return m_eEnvironment; /* } SAFE */ } //________________________________ ::rtl::OUString JobData::getEnvironmentDescriptor() const { ::rtl::OUString sDescriptor; /* SAFE { */ ReadGuard aReadLock(m_aLock); switch(m_eEnvironment) { case E_EXECUTION : sDescriptor = ::rtl::OUString::createFromAscii("EXECUTOR"); break; case E_DISPATCH : sDescriptor = ::rtl::OUString::createFromAscii("DISPATCH"); break; case E_DOCUMENTEVENT : sDescriptor = ::rtl::OUString::createFromAscii("DOCUMENTEVENT"); break; default: break; } /* } SAFE */ return sDescriptor; } //________________________________ ::rtl::OUString JobData::getService() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return m_sService; /* } SAFE */ } //________________________________ ::rtl::OUString JobData::getEvent() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return m_sEvent; /* } SAFE */ } //________________________________ css::uno::Sequence< css::beans::NamedValue > JobData::getJobConfig() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return m_lArguments; /* } SAFE */ } //________________________________ css::uno::Sequence< css::beans::NamedValue > JobData::getConfig() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); css::uno::Sequence< css::beans::NamedValue > lConfig; if (m_eMode==E_ALIAS) { lConfig.realloc(3); sal_Int32 i = 0; lConfig[i].Name = ::rtl::OUString::createFromAscii(PROP_ALIAS); lConfig[i].Value <<= m_sAlias; ++i; lConfig[i].Name = ::rtl::OUString::createFromAscii(PROP_SERVICE); lConfig[i].Value <<= m_sService; ++i; lConfig[i].Name = ::rtl::OUString::createFromAscii(PROP_CONTEXT); lConfig[i].Value <<= m_sContext; ++i; } aReadLock.unlock(); /* } SAFE */ return lConfig; } //________________________________ /** @short return information, if this job is part of the global configuration package org.openoffice.Office.Jobs @descr Because jobs can be executed by the dispatch framework using an uno service name directly - an executed job must not have any configuration realy. Such jobs must provide the right interfaces only! But after finishing jobs can return some informations (e.g. for updating her configuration ...). We must know if such request is valid or not then. @return sal_True if the represented job is part of the underlying configuration package. */ sal_Bool JobData::hasConfig() const { /* SAFE { */ ReadGuard aReadLock(m_aLock); return (m_eMode==E_ALIAS || m_eMode==E_EVENT); /* } SAFE */ } //________________________________ /** @short mark a job as non startable for further requests @descr We don't remove the configuration entry! We set a timestamp value only. And there exist two of them: one for an administrator ... and one for the current user. We change it for the user layer only. So this JobDispatch can't be started any more ... till the administrator change his timestamp. That can be usefull for post setup scenarios, which must run one time only. Note: This method don't do anything, if ths represented job doesn't have a configuration! */ void JobData::disableJob() { /* SAFE { */ WriteGuard aWriteLock(m_aLock); // No configuration - not used from EXECUTOR and not triggered from an event => no chance! if (m_eMode!=E_EVENT) return; // update the configuration // It doesn't matter if this config object was already opened before. // It doesn nothing here then ... or it change the mode automaticly, if // it was opened using another one before. ::rtl::OUStringBuffer sKey(256); sKey.appendAscii(JobData::EVENTCFG_ROOT ); sKey.append (::utl::wrapConfigurationElementName(m_sEvent)); sKey.appendAscii(JobData::EVENTCFG_PATH_JOBLIST ); sKey.appendAscii("/" ); sKey.append (::utl::wrapConfigurationElementName(m_sAlias)); ConfigAccess aConfig(m_xSMGR, sKey.makeStringAndClear()); aConfig.open(ConfigAccess::E_READWRITE); if (aConfig.getMode()==ConfigAccess::E_CLOSED) return; css::uno::Reference< css::beans::XPropertySet > xPropSet(aConfig.cfg(), css::uno::UNO_QUERY); if (xPropSet.is()) { // Convert and write the user timestamp to the configuration. css::uno::Any aValue; aValue <<= Converter::convert_DateTime2ISO8601(DateTime()); xPropSet->setPropertyValue(::rtl::OUString::createFromAscii(EVENTCFG_PROP_USERTIME), aValue); } aConfig.close(); aWriteLock.unlock(); /* } SAFE */ } //________________________________ /** */ sal_Bool isEnabled( const ::rtl::OUString& sAdminTime , const ::rtl::OUString& sUserTime ) { /*Attention! To prevent interpreting of TriGraphs inside next const string value, we have to encode all '?' signs. Otherwhise e.g. "??-" will be translated to "~" ... */ static ::rtl::OUString PATTERN_ISO8601 = ::rtl::OUString::createFromAscii("\?\?\?\?-\?\?-\?\?*\0"); WildCard aISOPattern(PATTERN_ISO8601); sal_Bool bValidAdmin = aISOPattern.Matches(sAdminTime); sal_Bool bValidUser = aISOPattern.Matches(sUserTime ); // We check for "isEnabled()" here only. // Note further: ISO8601 formated strings can be compared as strings directly! return ( (!bValidAdmin && !bValidUser ) || ( bValidAdmin && bValidUser && sAdminTime>=sUserTime) ); } //________________________________ /** */ void JobData::appendEnabledJobsForEvent( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR , const ::rtl::OUString& sEvent , ::comphelper::SequenceAsVector< JobData::TJob2DocEventBinding >& lJobs ) { css::uno::Sequence< ::rtl::OUString > lAdditionalJobs = JobData::getEnabledJobsForEvent(xSMGR, sEvent); sal_Int32 c = lAdditionalJobs.getLength(); sal_Int32 i = 0; for (i=0; i 0 ) { sal_Int32 nIndex = m_sContext.indexOf( rModuleIdent ); if ( nIndex >= 0 && ( nIndex+nModuleIdLen <= nContextLen )) { ::rtl::OUString sContextModule = m_sContext.copy( nIndex, nModuleIdLen ); return sContextModule.equals( rModuleIdent ); } } return sal_False; } //________________________________ /** */ css::uno::Sequence< ::rtl::OUString > JobData::getEnabledJobsForEvent( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR , const ::rtl::OUString& sEvent ) { // these static values may perform following loop for reading time stamp values ... static ::rtl::OUString ADMINTIME = ::rtl::OUString::createFromAscii(JobData::EVENTCFG_PROP_ADMINTIME); static ::rtl::OUString USERTIME = ::rtl::OUString::createFromAscii(JobData::EVENTCFG_PROP_USERTIME ); static ::rtl::OUString ROOT = ::rtl::OUString::createFromAscii(JobData::EVENTCFG_ROOT ); static ::rtl::OUString JOBLIST = ::rtl::OUString::createFromAscii(JobData::EVENTCFG_PATH_JOBLIST ); // create a config access to "/org.openoffice.Office.Jobs/Events" ConfigAccess aConfig(xSMGR,ROOT); aConfig.open(ConfigAccess::E_READONLY); if (aConfig.getMode()==ConfigAccess::E_CLOSED) return css::uno::Sequence< ::rtl::OUString >(); css::uno::Reference< css::container::XHierarchicalNameAccess > xEventRegistry(aConfig.cfg(), css::uno::UNO_QUERY); if (!xEventRegistry.is()) return css::uno::Sequence< ::rtl::OUString >(); // check if the given event exist inside list of registered ones ::rtl::OUString sPath(sEvent); sPath += JOBLIST; if (!xEventRegistry->hasByHierarchicalName(sPath)) return css::uno::Sequence< ::rtl::OUString >(); // step to the job list, which is a child of the event node inside cfg // e.g. "/org.openoffice.Office.Jobs/Events//JobList" css::uno::Any aJobList = xEventRegistry->getByHierarchicalName(sPath); css::uno::Reference< css::container::XNameAccess > xJobList; if (!(aJobList >>= xJobList) || !xJobList.is()) return css::uno::Sequence< ::rtl::OUString >(); // get all alias names of jobs, which are part of this job list // But Some of them can be disabled by it's time stamp values. // We create an additional job name list iwth the same size, then the original list ... // step over all job entries ... check her time stamps ... and put only job names to the // destination list, which represent an enabled job. css::uno::Sequence< ::rtl::OUString > lAllJobs = xJobList->getElementNames(); ::rtl::OUString* pAllJobs = lAllJobs.getArray(); sal_Int32 c = lAllJobs.getLength(); css::uno::Sequence< ::rtl::OUString > lEnabledJobs(c); ::rtl::OUString* pEnabledJobs = lEnabledJobs.getArray(); sal_Int32 d = 0; for (sal_Int32 s=0; s xJob; if ( !(xJobList->getByName(pAllJobs[s]) >>= xJob) || !(xJob.is() ) ) { continue; } ::rtl::OUString sAdminTime; xJob->getPropertyValue(ADMINTIME) >>= sAdminTime; ::rtl::OUString sUserTime; xJob->getPropertyValue(USERTIME) >>= sUserTime; if (!isEnabled(sAdminTime, sUserTime)) continue; pEnabledJobs[d] = pAllJobs[s]; ++d; } lEnabledJobs.realloc(d); aConfig.close(); return lEnabledJobs; } //________________________________ /** @short reset all internal structures @descr If somehwere recycle this instance, he can switch from one using mode to another one. But then we have to reset all currently used informations. Otherwhise we mix it and they can make trouble. But note: that does not set defaults for internal used members, which does not relate to any job property! e.g. the reference to the global uno service manager. Such informations are used for internal processes only and are neccessary for our work. */ void JobData::impl_reset() { /* SAFE { */ WriteGuard aWriteLock(m_aLock); m_eMode = E_UNKNOWN_MODE; m_eEnvironment = E_UNKNOWN_ENVIRONMENT; m_sAlias = ::rtl::OUString(); m_sService = ::rtl::OUString(); m_sContext = ::rtl::OUString(); m_sEvent = ::rtl::OUString(); m_lArguments = css::uno::Sequence< css::beans::NamedValue >(); aWriteLock.unlock(); /* } SAFE */ } } // namespace framework