configmgr/source/treecache/cachewritescheduler.cxx

   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: cachewritescheduler.cxx,v $
  10  * $Revision: 1.10 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33
  34 #include <stdio.h>
  35
  36 #include "cachewritescheduler.hxx"
  37 #include "cachecontroller.hxx"
  38 #include "tracer.hxx"
  39
  40
  41 namespace configmgr
  42 {
  43 // =========================================================================
  44 OCacheWriteScheduler::~OCacheWriteScheduler()
  45 {
  46     stopAndWriteCache();// last chance - violates precond
  47 }
  48
  49 void OCacheWriteScheduler::stopAndWriteCache()
  50 {
  51     OSL_ASSERT(UnoApiLock::isHeld());
  52     CFG_TRACE_INFO("Cancelling all cache writings, Stopping timer");
  53
  54     if (m_xTimer.isValid())
  55         m_xTimer->dispose(); // just to be sure
  56
  57     runWriter();
  58
  59     m_aWriteList.clear();
  60 }
  61
  62 // -------------------------------------------------------------------------
  63 void OCacheWriteScheduler::Timer::onShot()
  64 {
  65     UnoApiLock aLock;
  66
  67     if (pParent)
  68         pParent->onTimerShot();
  69     else
  70         CFG_TRACE_WARNING("Timer shot for disposed cache writer");
  71 }
  72
  73 // -----------------------------------------------------------------------------
  74 void OCacheWriteScheduler::onTimerShot()
  75 {
  76     //m_aTimer.stop();
  77
  78     CFG_TRACE_INFO("Write Timer invoked - executing write task");
  79
  80     try
  81     {
  82         runWriter();
  83         CFG_TRACE_INFO_NI("Write timer: writing ended");
  84     }
  85     catch (...)
  86     {
  87         CFG_TRACE_ERROR_NI("Write timer: writing failed with an unknown exception");
  88         OSL_ENSURE(false, "ERROR: Unknown Exception left a writer");
  89     }
  90
  91     TimeStamp aNewTime = implGetScheduleTime(TimeStamp::getCurrentTime(), m_aWriteInterval);
  92
  93     implStartBefore(aNewTime);
  94 }
  95 // -------------------------------------------------------------------------
  96 void OCacheWriteScheduler::runWriter()
  97 {
  98     // Write Cache
  99     OSL_ASSERT(UnoApiLock::isHeld());
 100     CFG_TRACE_INFO("Running write operations");
 101
 102     CacheWriteList aPendingWrites;
 103     m_aWriteList.swap(aPendingWrites);
 104
 105     CFG_TRACE_INFO_NI("Found %d sections to write", int(aPendingWrites.size()));
 106     for (CacheWriteList::iterator it = aPendingWrites.begin();
 107          it != aPendingWrites.end();
 108          ++it)
 109     {
 110         RequestOptions aTaskOption = *it;
 111         try
 112         {
 113             writeOneTreeFoundByOption(aTaskOption);
 114         }
 115         catch (uno::Exception& e)
 116         {
 117                     (void)e;
 118             CFG_TRACE_ERROR_NI("TreeCacheWriteScheduler: Attempt to write data failed - error is '%s' (currently ignored)",OUSTRING2ASCII(e.Message));
 119         }
 120     }
 121     // m_aWriteList.clear();
 122     CFG_TRACE_INFO_NI("DONE: Running write operations");
 123 }
 124
 125 // -----------------------------------------------------------------------------
 126 void OCacheWriteScheduler::writeOneTreeFoundByOption(RequestOptions const& _aOptions) SAL_THROW((com::sun::star::uno::Exception))
 127 {
 128     CFG_TRACE_INFO("Writeing one cache tree for user '%s' with locale '%s'",
 129            OUSTRING2ASCII(_aOptions.getEntity()),
 130                    OUSTRING2ASCII(_aOptions.getLocale()));
 131
 132     rtl::Reference<CacheLoadingAccess> aCache;
 133     aCache = m_rTreeManager.m_aCacheMap.get(_aOptions);
 134
 135     if (aCache.is())
 136     {
 137         CFG_TRACE_INFO_NI("- Found matching data container  - starting write task");
 138         if (!m_rTreeManager.saveAllPendingChanges(aCache,_aOptions))
 139         {
 140             m_aWriteList.insert(_aOptions);
 141
 142             CFG_TRACE_INFO_NI("- Write task incomplete -reregistering");
 143         }
 144         // we got a pending list with pointers from TreeInfo.
 145     }
 146     else
 147     {
 148         CFG_TRACE_WARNING_NI("- Data container (TreeInfo) to write not found: Ignoring task");
 149     }
 150
 151     CFG_TRACE_INFO_NI("Removing written cache tree (for user '%s' with locale '%s')",
 152                     OUSTRING2ASCII(_aOptions.getEntity()),
 153                     OUSTRING2ASCII(_aOptions.getLocale()));
 154 }
 155
 156 // -----------------------------------------------------------------------------
 157 bool OCacheWriteScheduler::clearTasks(RequestOptions const& _aOptions)
 158 {
 159     // sadly list::remove doesn't return an indication of what it did
 160     bool bFound = m_aWriteList.erase(_aOptions) !=0;
 161     if (bFound)
 162     {
 163         CFG_TRACE_INFO("Write Scheduler: Dropped cache tree (for user '%s' with locale '%s') from task list",
 164                             OUSTRING2ASCII(_aOptions.getEntity()),
 165                             OUSTRING2ASCII(_aOptions.getLocale()));
 166     }
 167
 168     return bFound;
 169 }
 170
 171 // -----------------------------------------------------------------------------
 172 // should be called guarded only
 173 void OCacheWriteScheduler::implStartBefore(TimeStamp const& _aTime)
 174 {
 175     CFG_TRACE_INFO("Triggering write timer");
 176     // check if we were cleared
 177     if (!m_aWriteList.empty())
 178     {
 179         if (!m_xTimer->isTicking())
 180         {
 181             m_xTimer->setAbsoluteTime(_aTime.getTimeValue());
 182
 183             if (!m_xTimer->isTicking())
 184                 m_xTimer->start();
 185
 186             OSL_ASSERT( m_xTimer->isTicking() );
 187         }
 188         CFG_TRACE_INFO_NI("- Write timer running - next execution in %d seconds", int (m_xTimer->getRemainingTime().Seconds) );
 189         CFG_TRACE_INFO_NI("- %d write tasks are pending", int(m_aWriteList.size()) );
 190     }
 191     else
 192     {
 193         m_xTimer->stop();
 194         CFG_TRACE_INFO_NI("- Stopped timer - no more open write tasks");
 195     }
 196 }
 197
 198 // -----------------------------------------------------------------------------
 199 void OCacheWriteScheduler::scheduleWrite(backend::ComponentRequest _aComponent)  SAL_THROW((com::sun::star::uno::Exception))
 200 {
 201     OSL_ENSURE(_aComponent.getOptions().hasLocale(), "ERROR: OTreeDisposeScheduler: cannot handle complete user scheduling");
 202
 203     CFG_TRACE_INFO("Scheduling cache write for user '%s' with locale '%s'",
 204                     OUSTRING2ASCII(_aComponent.getOptions().getEntity()),
 205                     OUSTRING2ASCII(_aComponent.getOptions().getLocale()));
 206
 207     // lasy writing
 208     m_aWriteList.insert(_aComponent.getOptions());
 209
 210     TimeStamp aNewTime = implGetScheduleTime(TimeStamp::getCurrentTime(), m_aWriteInterval);
 211     implStartBefore(aNewTime);
 212 }
 213
 214 // -----------------------------------------------------------------------------
 215 } // namespace
 216