VP1AvailEvtsHttp.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 

//                                                            //
//  Implementation of class VP1AvailEvtsHttp                  //
//                                                            //
//  Author: Thomas H. Kittelmann (Thomas.Kittelmann@cern.ch)  //
//  Initial version: May 2008                                 //
//                                                            //
 
#include "VP1Gui/VP1AvailEvtsHttp.h"
#include "VP1Gui/VP1HttpGetFile.h"
#include "VP1Gui/VP1EvtsOnServerInfo.h"
#include "VP1Gui/VP1WebWatcher.h"
#include <QTimer>
#include <QFileInfo>
#include <QDir>
#include <QFile>
#include <QUrl>
 
//____________________________________________________________________
class VP1AvailEvtsHttp::Imp {
public:
  VP1AvailEvtsHttp * theclass;
  QString fileinfoUrl;
  QString baseUrl;
  VP1HttpGetFile httpgetfile_events;
  VP1HttpGetFile httpgetfile_fileinfo;
  VP1WebWatcher * webwatcher_fileinfo;
  VP1EvtsOnServerInfo * evtsOnServer;
  QTimer * examineEvtsOnServerTimer;
  void restartExamineEvtsOnServerTimer() {
    if (!examineEvtsOnServerTimer) {
      examineEvtsOnServerTimer = new QTimer(theclass);
      connect(  examineEvtsOnServerTimer, SIGNAL(timeout()), theclass, SLOT(examineEvtsOnServer()));
    }
    examineEvtsOnServerTimer->start(3000);
  }
  void getFileInfoLater() {
    QTimer::singleShot(10000, theclass, SLOT(fileInfoChanged()));
  }
  static unsigned ntmpdlcount;
};
 
unsigned VP1AvailEvtsHttp::Imp::ntmpdlcount = 0;
 
//____________________________________________________________________
VP1AvailEvtsHttp::VP1AvailEvtsHttp( const QString & fileinfoUrl,
                    int updateInterval,
                    int timeCutForNew,
                    const QString& tmpcopydir,
                    int maxLocalFilesToKeep,
                    QObject * parent )
  : VP1AvailEvents(timeCutForNew,tmpcopydir,maxLocalFilesToKeep,parent), m_d(new Imp)
{
  m_d->theclass = this;
  m_d->examineEvtsOnServerTimer = 0;
  m_d->fileinfoUrl = fileinfoUrl;
  QUrl url(fileinfoUrl);
  if (url.isValid()) {
    QString path = url.path();
    QString infofilebasename = QFileInfo(path).fileName();
    if (!infofilebasename.isEmpty()&&path.endsWith(infofilebasename)) {
      m_d->baseUrl=fileinfoUrl;
      m_d->baseUrl.chop(infofilebasename.count());
      if (!QUrl(m_d->baseUrl).isValid())
    m_d->baseUrl="";
      else if (!m_d->baseUrl.endsWith("/"))
    m_d->baseUrl += "/";
    }
  }
 
  m_d->evtsOnServer = 0;
  connect(&(m_d->httpgetfile_fileinfo),SIGNAL(downloadSuccessful(const QString&,const QString&,const QString&)),
      this,SLOT(fileInfoDownloadSuccessful(const QString&,const QString&)));
  connect(&(m_d->httpgetfile_fileinfo),SIGNAL(downloadFailed(const QString&,const QString&,const QString&,const QString&)),
      this,SLOT(fileInfoDownloadFailed(const QString&,const QString&,const QString&)));
  connect(&(m_d->httpgetfile_events),SIGNAL(downloadSuccessful(const QString&,const QString&,const QString&)),
      this,SLOT(eventFileDownloadSuccessful(const QString&,const QString&,const QString&)));
  connect(&(m_d->httpgetfile_events),SIGNAL(downloadFailed(const QString&,const QString&,const QString&,const QString&)),
      this,SLOT(eventFileDownloadFailed(const QString&,const QString&,const QString&)));
 
  m_d->webwatcher_fileinfo = new VP1WebWatcher(updateInterval*1000,this);
  connect(m_d->webwatcher_fileinfo,SIGNAL(urlChanged(const QString&)),this,SLOT(fileInfoChanged()));
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::init()
{
  m_d->webwatcher_fileinfo->addUrl(m_d->fileinfoUrl);//A signal will be triggered the first time the webwatcher knows anything about the url.
  m_d->restartExamineEvtsOnServerTimer();
}
 
//____________________________________________________________________
VP1AvailEvtsHttp::~VP1AvailEvtsHttp()
{
  delete m_d->evtsOnServer;
  delete m_d;
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::fileInfoChanged()
{
  if (m_d->webwatcher_fileinfo->lastResult(m_d->fileinfoUrl)!=VP1WebWatcher::EXISTS) {
    message("Problems investigating "+m_d->fileinfoUrl);
    message("   ===> "+m_d->webwatcher_fileinfo->lastResultToString(m_d->fileinfoUrl));
    return;
  }
  QString ad = tmpActiveRetrievalDir();
  if (ad.isEmpty()) {
    message("Error: No temporary retrieval directory set!");
    m_d->getFileInfoLater();//Avoid stalling forever (however this is an unlikely error).
    return;
  }
  QString target = ad+"downloadedfileinfo.txt";
  if ( QFileInfo(target).exists() && !QFile(target).remove() ) {
    message("ERROR: Could not remove old "+target);
    m_d->getFileInfoLater();//Avoid stalling forever in case user fixes error (i.e. fixes permissions).
    return;
  }
  QString err = m_d->httpgetfile_fileinfo.startDownload( m_d->fileinfoUrl,target);
  if (!err.isEmpty()) {
    message("Problems starting download to get file-info file: "+err);
    m_d->getFileInfoLater();//Avoid stalling forever in case user fixes error (i.e. fixes net connection).
  }
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::fileInfoDownloadSuccessful( const QString& urltofile, const QString& localtargetfile )
{
  VP1EvtsOnServerInfo * newEvtsOnServerInfo = new VP1EvtsOnServerInfo(localtargetfile);
  if (!newEvtsOnServerInfo->isValid()) {
    message("Problems decoding info in file downloaded from "+urltofile);
    message("Error: "+newEvtsOnServerInfo->error());
    delete newEvtsOnServerInfo;
    QFile::remove(localtargetfile);
    m_d->getFileInfoLater();//Avoid stalling forever in case this is temporary.
    invalidateDirCache(tmpActiveRetrievalDir());
    return;
  }
  delete m_d->evtsOnServer;
  m_d->evtsOnServer = newEvtsOnServerInfo;
 
  examineEvtsOnServer();
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::examineEvtsOnServer()
{
  m_d->restartExamineEvtsOnServerTimer();//To ensure we don't get events too closely spaced here.
  if (m_d->httpgetfile_events.numberOfPendingDownloads()>3)
    return;
  if (!m_d->evtsOnServer)
    return;
 
  //Start download of one of the files from the server?
  VP1EventFile evtToGet;
  QString localfiledir = tmpLocalFileDir();
  if (localfiledir.isEmpty()) {
    message("Problems with temporary local event file directory.");
    return;
  }
 
  for (VP1EventFile evt : m_d->evtsOnServer->events(timeCutForNew(), requireNewestRunNumber() )) {
    //We are looking for an event which was never seen before and not available locally:
    if (!evt.isValid()||inHistory(evt.runNumber(),evt.eventNumber()))
      continue;
    if ( !QFile::exists ( localfiledir+evt.fileName() ) ) {
      evtToGet=evt;
      break;
    }
  }
 
  if (!evtToGet.isValid()&&m_d->examineEvtsOnServerTimer)
    m_d->examineEvtsOnServerTimer->stop();//No need to check back regularly until we get new information.
 
  if (evtToGet.isValid()) {
    //Before we get it, let us check that we don't already have 3
    //fresh events locally which are newer than the one we are trying
    //to download:
    QList<VP1EventFile> freshLocalEvents = freshEvents();
    unsigned nNewer(0);
    for(VP1EventFile evt : freshLocalEvents) {
      if (evt < evtToGet) {
    ++nNewer;
    if (nNewer>=3) {
      return;
    }
      }
    }
    QString ad = tmpActiveRetrievalDir();
    if (!ad.isEmpty()) {
      QString url = m_d->baseUrl+evtToGet.fileName();
      QString target = ad+evtToGet.fileName()+"_"+QString::number(Imp::ntmpdlcount++);
      //A quick check that we are not already downloading that file currently:
      if (!m_d->httpgetfile_events.isDownloading(url)&&!m_d->httpgetfile_events.isDownloadingTo(target)) {
    QString err = m_d->httpgetfile_events.startDownload( url,target,evtToGet.md5Sum(),localfiledir+evtToGet.fileName());
    if (!err.isEmpty()) {
      message("Problems starting download of :" +url);
      message("   => "+err);
    }
      } else {
    //We are already downloading url - abort silently.
    return;
      }
    } else {
      message("Problems with temporary local download directory.");
    }
  }
  invalidateDirCache(tmpActiveRetrievalDir());//Fixme: remove from here???
}
 
 
//____________________________________________________________________
void VP1AvailEvtsHttp::fileInfoDownloadFailed( const QString& error, const QString& urltofile,const QString& localtargetfile )
{
  message("Problems downloading "+urltofile+": "+error);
  QFile::remove(localtargetfile);
  invalidateDirCache(tmpActiveRetrievalDir());
  m_d->getFileInfoLater();//Avoid stalling forever in case this is temporary.
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::eventFileDownloadSuccessful( const QString&, const QString& localtargetfile, const QString& data )
{
  invalidateDirCache(tmpLocalFileDir());
  invalidateDirCache(tmpActiveRetrievalDir());
 
  if (!QFile::rename(localtargetfile,data)) {
    message("Error: Could not move "+localtargetfile+" to "+data);
    QFile::remove(localtargetfile);
    QFile::remove(data);
    m_d->getFileInfoLater();//Avoid stalling forever in case this is temporary.
    return;
  }
  cleanupAndCheckForEventListChanges();
}
 
//____________________________________________________________________
void VP1AvailEvtsHttp::eventFileDownloadFailed( const QString& error, const QString& urltofile,const QString& localtargetfile )
{
  message("Problems downloading "+urltofile+": "+error);
  QFile::remove(localtargetfile);
  m_d->getFileInfoLater();//Avoid stalling forever in case this is temporary.
  invalidateDirCache(tmpActiveRetrievalDir());
}