xmltooling/util/ReloadableXMLFile.cpp

   1 /*
   2  *  Copyright 2001-2010 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file ReloadableXMLFile.cpp
  19  *
  20  * Base class for file-based XML configuration.
  21  */
  22
  23 #include "internal.h"
  24 #include "io/HTTPResponse.h"
  25 #include "util/NDC.h"
  26 #include "util/PathResolver.h"
  27 #include "util/ReloadableXMLFile.h"
  28 #include "util/Threads.h"
  29 #include "util/XMLConstants.h"
  30 #include "util/XMLHelper.h"
  31
  32 #if defined(XMLTOOLING_LOG4SHIB)
  33 # include <log4shib/NDC.hh>
  34 #elif defined(XMLTOOLING_LOG4CPP)
  35 # include <log4cpp/NDC.hh>
  36 #endif
  37
  38 #include <fstream>
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41
  42 #include <xercesc/framework/LocalFileInputSource.hpp>
  43 #include <xercesc/framework/Wrapper4InputSource.hpp>
  44 #include <xercesc/util/XMLUniDefs.hpp>
  45
  46 using namespace xmltooling::logging;
  47 using namespace xmltooling;
  48 using namespace xercesc;
  49 using namespace std;
  50
  51 static const XMLCh id[] =               UNICODE_LITERAL_2(i,d);
  52 static const XMLCh uri[] =              UNICODE_LITERAL_3(u,r,i);
  53 static const XMLCh url[] =              UNICODE_LITERAL_3(u,r,l);
  54 static const XMLCh path[] =             UNICODE_LITERAL_4(p,a,t,h);
  55 static const XMLCh pathname[] =         UNICODE_LITERAL_8(p,a,t,h,n,a,m,e);
  56 static const XMLCh file[] =             UNICODE_LITERAL_4(f,i,l,e);
  57 static const XMLCh filename[] =         UNICODE_LITERAL_8(f,i,l,e,n,a,m,e);
  58 static const XMLCh validate[] =         UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
  59 static const XMLCh reloadChanges[] =    UNICODE_LITERAL_13(r,e,l,o,a,d,C,h,a,n,g,e,s);
  60 static const XMLCh reloadInterval[] =   UNICODE_LITERAL_14(r,e,l,o,a,d,I,n,t,e,r,v,a,l);
  61 static const XMLCh backingFilePath[] =  UNICODE_LITERAL_15(b,a,c,k,i,n,g,F,i,l,e,P,a,t,h);
  62
  63
  64 ReloadableXMLFile::ReloadableXMLFile(const DOMElement* e, Category& log)
  65     : m_root(e), m_local(true), m_validate(false), m_backupIndicator(true), m_filestamp(0), m_reloadInterval(0), m_lock(NULL), m_log(log),
  66         m_shutdown(false), m_reload_wait(NULL), m_reload_thread(NULL)
  67 {
  68 #ifdef _DEBUG
  69     NDC ndc("ReloadableXMLFile");
  70 #endif
  71
  72     // Establish source of data...
  73     const XMLCh* source=e->getAttributeNS(NULL,uri);
  74     if (!source || !*source) {
  75         source=e->getAttributeNS(NULL,url);
  76         if (!source || !*source) {
  77             source=e->getAttributeNS(NULL,path);
  78             if (!source || !*source) {
  79                 source=e->getAttributeNS(NULL,pathname);
  80                 if (!source || !*source) {
  81                     source=e->getAttributeNS(NULL,file);
  82                     if (!source || !*source) {
  83                         source=e->getAttributeNS(NULL,filename);
  84                     }
  85                 }
  86             }
  87         }
  88         else
  89             m_local=false;
  90     }
  91     else
  92         m_local=false;
  93
  94     if (source && *source) {
  95         const XMLCh* flag=e->getAttributeNS(NULL,validate);
  96         m_validate=(XMLString::equals(flag,xmlconstants::XML_TRUE) || XMLString::equals(flag,xmlconstants::XML_ONE));
  97
  98         auto_ptr_char temp(source);
  99         m_source=temp.get();
 100
 101         if (!m_local && !strstr(m_source.c_str(),"://")) {
 102             log.warn("deprecated usage of uri/url attribute for a local resource, use path instead");
 103             m_local=true;
 104         }
 105
 106         if (m_local) {
 107             XMLToolingConfig::getConfig().getPathResolver()->resolve(m_source, PathResolver::XMLTOOLING_CFG_FILE);
 108
 109             flag=e->getAttributeNS(NULL,reloadChanges);
 110             if (!XMLString::equals(flag,xmlconstants::XML_FALSE) && !XMLString::equals(flag,xmlconstants::XML_ZERO)) {
 111 #ifdef WIN32
 112                 struct _stat stat_buf;
 113                 if (_stat(m_source.c_str(), &stat_buf) == 0)
 114 #else
 115                 struct stat stat_buf;
 116                 if (stat(m_source.c_str(), &stat_buf) == 0)
 117 #endif
 118                     m_filestamp=stat_buf.st_mtime;
 119                 else
 120                     throw IOException("Unable to access local file ($1)", params(1,m_source.c_str()));
 121                 m_lock=RWLock::create();
 122             }
 123             log.debug("using local resource (%s), will %smonitor for changes", m_source.c_str(), m_lock ? "" : "not ");
 124         }
 125         else {
 126             log.debug("using remote resource (%s)", m_source.c_str());
 127             source = e->getAttributeNS(NULL,backingFilePath);
 128             if (source && *source) {
 129                 auto_ptr_char temp2(source);
 130                 m_backing=temp2.get();
 131                 XMLToolingConfig::getConfig().getPathResolver()->resolve(m_backing, PathResolver::XMLTOOLING_RUN_FILE);
 132                 log.debug("backup remote resource to (%s)", m_backing.c_str());
 133             }
 134             source = e->getAttributeNS(NULL,reloadInterval);
 135             if (source && *source) {
 136                 m_reloadInterval = XMLString::parseInt(source);
 137                 if (m_reloadInterval > 0) {
 138                     m_log.debug("will reload remote resource at most every %d seconds", m_reloadInterval);
 139                     m_lock=RWLock::create();
 140                 }
 141             }
 142             m_filestamp = time(NULL);   // assume it gets loaded initially
 143         }
 144
 145         if (m_lock) {
 146             m_reload_wait = CondWait::create();
 147             m_reload_thread = Thread::create(&reload_fn, this);
 148         }
 149     }
 150     else {
 151         log.debug("no resource uri/path/name supplied, will load inline configuration");
 152     }
 153
 154     source = e->getAttributeNS(NULL, id);
 155     if (source && *source) {
 156         auto_ptr_char tempid(source);
 157         m_id = tempid.get();
 158     }
 159 }
 160
 161 ReloadableXMLFile::~ReloadableXMLFile()
 162 {
 163     shutdown();
 164     delete m_lock;
 165 }
 166
 167 void ReloadableXMLFile::shutdown()
 168 {
 169     if (m_reload_thread) {
 170         // Shut down the reload thread and let it know.
 171         m_shutdown = true;
 172         m_reload_wait->signal();
 173         m_reload_thread->join(NULL);
 174         delete m_reload_thread;
 175         delete m_reload_wait;
 176     }
 177 }
 178
 179 void* ReloadableXMLFile::reload_fn(void* pv)
 180 {
 181     ReloadableXMLFile* r = reinterpret_cast<ReloadableXMLFile*>(pv);
 182
 183 #ifndef WIN32
 184     // First, let's block all signals
 185     Thread::mask_all_signals();
 186 #endif
 187
 188     if (!r->m_id.empty()) {
 189         string threadid("[");
 190         threadid += r->m_id + ']';
 191         logging::NDC::push(threadid);
 192     }
 193
 194 #ifdef _DEBUG
 195     NDC ndc("reload");
 196 #endif
 197
 198     auto_ptr<Mutex> mutex(Mutex::create());
 199     mutex->lock();
 200
 201     if (r->m_local)
 202         r->m_log.info("reload thread started...running when signaled");
 203     else
 204         r->m_log.info("reload thread started...running every %d seconds", r->m_reloadInterval);
 205
 206     while (!r->m_shutdown) {
 207         if (r->m_local)
 208             r->m_reload_wait->wait(mutex.get());
 209         else
 210             r->m_reload_wait->timedwait(mutex.get(), r->m_reloadInterval);
 211         if (r->m_shutdown)
 212             break;
 213
 214         try {
 215             r->m_log.info("reloading %s resource...", r->m_local ? "local" : "remote");
 216             pair<bool,DOMElement*> ret = r->background_load();
 217             if (ret.first)
 218                 ret.second->getOwnerDocument()->release();
 219         }
 220         catch (long& ex) {
 221             if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
 222                 r->m_log.info("remote resource (%s) unchanged from cached version", r->m_source.c_str());
 223             }
 224             else {
 225                 // Shouldn't happen, we should only get codes intended to be gracefully handled.
 226                 r->m_log.crit("maintaining existing configuration, remote resource fetch returned atypical status code (%d)", ex);
 227             }
 228         }
 229         catch (exception& ex) {
 230             r->m_log.crit("maintaining existing configuration, error reloading resource (%s): %s", r->m_source.c_str(), ex.what());
 231         }
 232     }
 233
 234     r->m_log.info("reload thread finished");
 235
 236     mutex->unlock();
 237
 238     if (!r->m_id.empty()) {
 239         logging::NDC::pop();
 240     }
 241
 242     return NULL;
 243 }
 244
 245 Lockable* ReloadableXMLFile::lock()
 246 {
 247     if (!m_lock)
 248         return this;
 249
 250     m_lock->rdlock();
 251
 252     if (m_local) {
 253     // Check if we need to refresh.
 254 #ifdef WIN32
 255         struct _stat stat_buf;
 256         if (_stat(m_source.c_str(), &stat_buf) != 0)
 257             return this;
 258 #else
 259         struct stat stat_buf;
 260         if (stat(m_source.c_str(), &stat_buf) != 0)
 261             return this;
 262 #endif
 263         if (m_filestamp >= stat_buf.st_mtime)
 264             return this;
 265
 266         // Elevate lock and recheck.
 267         m_log.debug("timestamp of local resource changed, elevating to a write lock");
 268         m_lock->unlock();
 269         m_lock->wrlock();
 270         if (m_filestamp >= stat_buf.st_mtime) {
 271             // Somebody else handled it, just downgrade.
 272             m_log.debug("update of local resource handled by another thread, downgrading lock");
 273             m_lock->unlock();
 274             m_lock->rdlock();
 275             return this;
 276         }
 277
 278         // Update the timestamp regardless.
 279         m_filestamp = stat_buf.st_mtime;
 280         m_log.info("change detected, signaling reload thread...");
 281         m_reload_wait->signal();
 282     }
 283
 284     return this;
 285 }
 286
 287 void ReloadableXMLFile::unlock()
 288 {
 289     if (m_lock)
 290         m_lock->unlock();
 291 }
 292
 293 pair<bool,DOMElement*> ReloadableXMLFile::load(bool backup)
 294 {
 295 #ifdef _DEBUG
 296     NDC ndc("load");
 297 #endif
 298
 299     try {
 300         if (m_source.empty()) {
 301             // Data comes from the DOM we were handed.
 302             m_log.debug("loading inline configuration...");
 303             return make_pair(false, XMLHelper::getFirstChildElement(m_root));
 304         }
 305         else {
 306             // Data comes from a file we have to parse.
 307             if (backup)
 308                 m_log.warn("using local backup of remote resource");
 309             else
 310                 m_log.debug("loading configuration from external resource...");
 311
 312             DOMDocument* doc=NULL;
 313             if (m_local || backup) {
 314                 auto_ptr_XMLCh widenit(backup ? m_backing.c_str() : m_source.c_str());
 315                 // Use library-wide lock for now, nothing else is using it anyway.
 316                 Locker locker(backup ? getBackupLock() : NULL);
 317                 LocalFileInputSource src(widenit.get());
 318                 Wrapper4InputSource dsrc(&src, false);
 319                 if (m_validate)
 320                     doc=XMLToolingConfig::getConfig().getValidatingParser().parse(dsrc);
 321                 else
 322                     doc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
 323             }
 324             else {
 325                 URLInputSource src(m_root, NULL, &m_cacheTag);
 326                 Wrapper4InputSource dsrc(&src, false);
 327                 if (m_validate)
 328                     doc=XMLToolingConfig::getConfig().getValidatingParser().parse(dsrc);
 329                 else
 330                     doc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
 331
 332                 // Check for a response code signal.
 333                 if (XMLHelper::isNodeNamed(doc->getDocumentElement(), xmlconstants::XMLTOOLING_NS, URLInputSource::utf16StatusCodeElementName)) {
 334                     int responseCode = XMLString::parseInt(doc->getDocumentElement()->getFirstChild()->getNodeValue());
 335                     doc->release();
 336                     if (responseCode == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
 337                         throw (long)responseCode; // toss out as a "known" case to handle gracefully
 338                     }
 339                     else {
 340                         m_log.warn("remote resource fetch returned atypical status code (%d)", responseCode);
 341                         throw IOException("remote resource fetch failed, check log for status code of response");
 342                     }
 343                 }
 344             }
 345
 346             m_log.infoStream() << "loaded XML resource (" << (backup ? m_backing : m_source) << ")" << logging::eol;
 347
 348             if (!backup && !m_backing.empty()) {
 349                 // If the indicator is true, we're responsible for the backup.
 350                 if (m_backupIndicator) {
 351                     m_log.debug("backing up remote resource to (%s)", m_backing.c_str());
 352                     try {
 353                         Locker locker(getBackupLock());
 354                         ofstream backer(m_backing.c_str());
 355                         backer << *doc;
 356                     }
 357                     catch (exception& ex) {
 358                         m_log.crit("exception while backing up resource: %s", ex.what());
 359                     }
 360                 }
 361                 else {
 362                     // If the indicator was false, set true to signal that a backup is needed.
 363                     // The caller will presumably flip it back to false once that's done.
 364                     m_backupIndicator = true;
 365                 }
 366             }
 367
 368             return make_pair(true, doc->getDocumentElement());
 369         }
 370     }
 371     catch (XMLException& e) {
 372         auto_ptr_char msg(e.getMessage());
 373         m_log.errorStream() << "Xerces error while loading resource (" << (backup ? m_backing : m_source) << "): "
 374             << msg.get() << logging::eol;
 375         if (!backup && !m_backing.empty())
 376             return load(true);
 377         throw XMLParserException(msg.get());
 378     }
 379     catch (exception& e) {
 380         m_log.errorStream() << "error while loading resource ("
 381             << (m_source.empty() ? "inline" : (backup ? m_backing : m_source)) << "): " << e.what() << logging::eol;
 382         if (!backup && !m_backing.empty())
 383             return load(true);
 384         throw;
 385     }
 386 }
 387
 388 pair<bool,DOMElement*> ReloadableXMLFile::load()
 389 {
 390     return load(false);
 391 }
 392
 393 pair<bool,DOMElement*> ReloadableXMLFile::background_load()
 394 {
 395     // If this method isn't overridden, we acquire a write lock
 396     // and just call the old override.
 397     if (m_lock)
 398         m_lock->wrlock();
 399     SharedLock locker(m_lock, false);
 400     return load();
 401 }
 402
 403 Lockable* ReloadableXMLFile::getBackupLock()
 404 {
 405     return &XMLToolingConfig::getConfig();
 406 }