VP1AvailEvtsHttps.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include "VP1Gui/VP1AvailEvtsHttps.h"
#include "VP1Gui/VP1EvtsOnServerInfo.h"
#include "VP1Gui/VP1EventFile.h"
#include "VP1Gui/VP1MD5Sum.h"
#include "VP1Base/VP1Msg.h"
 
#include <QNetworkAccessManager>
#include <QNetworkCookie>
#include <QFile>
#include <QFileInfo>
#include <QUrl>
#include <QTimer>
#include <QBuffer>
#include <QStringMatcher>
#include <QDateTime>
 
#include <iostream>
#include <QMetaType>
 
class QSslError;
 
/*
  Stage values:
  0 - get head and check its last_modified header
  1 - get file info
  2 - get event file(s)
 */
 
class VP1AvailEvtsHttps::Imp {
 public:
  Imp(VP1AvailEvtsHttps*
      ,QString
      ,int);
  ~Imp();  
 
  void startTimer(int interval=0);
 
  // Connect signals of the QNetworkReply to slots of the VP1AvailEvtsHttps
  void connectNetworkSignalsToSlots();
 
  VP1AvailEvtsHttps* m_theclass;
  QString m_fileInfoUrl;
  QString m_baseUrl;
  int m_updateInterval;
 
  QNetworkAccessManager* m_netmanager;
  QNetworkReply* m_netreply;
  QString m_evtToGet;
  int m_stage;
  QString m_urlLastMod;
  QString m_expectedMD5Sum;
  qint64 m_bytesReceived;
  unsigned m_lastChangeTime;
 
  QTimer m_stallTimer;
};
 
VP1AvailEvtsHttps::Imp::Imp(VP1AvailEvtsHttps* theclass
                ,QString fileInfoUrl
                ,int updateInterval)
  : m_theclass(theclass)
  , m_fileInfoUrl(fileInfoUrl)
  , m_baseUrl("")
  , m_updateInterval(updateInterval)
  , m_netmanager(0)
  , m_netreply(0)
  , m_evtToGet("")
  , m_stage(0)
  , m_urlLastMod("UNKNOWN")
  , m_expectedMD5Sum("")
  , m_bytesReceived(0)
  , m_lastChangeTime(0)
  , m_stallTimer(0)
{
  QUrl url(m_fileInfoUrl);
  if (url.isValid()) {
    QString path = url.path();
    QString infofilebasename = QFileInfo(path).fileName();
    if (!infofilebasename.isEmpty()&&path.endsWith(infofilebasename)) {
      m_baseUrl=m_fileInfoUrl;
      m_baseUrl.chop(infofilebasename.count());
      if (!QUrl(m_baseUrl).isValid())
    m_baseUrl="";
      else if (!m_baseUrl.endsWith("/"))
    m_baseUrl += "/";
    }
  }
 
  connect(&m_stallTimer,SIGNAL(timeout()), m_theclass, SLOT(checkForStall()));
  m_stallTimer.start(10000);
}
 
VP1AvailEvtsHttps::Imp::~Imp()
{
}
 
void VP1AvailEvtsHttps::Imp::startTimer(int interval)
{
  QTimer::singleShot((interval>0 ? m_updateInterval : 60) ,m_theclass,SLOT(generateHttpsRequest()));
}
 
void VP1AvailEvtsHttps::Imp::connectNetworkSignalsToSlots()
{
  connect(m_netreply, SIGNAL(finished()),
      m_theclass, SLOT(finished()));
  connect(m_netreply, SIGNAL(error(QNetworkReply::NetworkError)),
      m_theclass, SLOT(error(QNetworkReply::NetworkError)));
#ifndef QT_NO_SSL
  connect(m_netreply, SIGNAL(sslErrors(const QList<QSslError>&)),
      m_theclass, SLOT(sslErrors(const QList<QSslError>&)));
#endif
  connect(m_netreply, SIGNAL(downloadProgress(qint64,qint64)),
      m_theclass, SLOT(dataReadProgress(qint64,qint64)));
  m_bytesReceived = 0;
}
 
VP1AvailEvtsHttps::VP1AvailEvtsHttps(const QString & fileinfoUrl,
                     int updateInterval,
                     int timeCutForNew,
                     const QString& tmpcopydir,
                     int maxLocalFilesToKeep,
                     QObject * parent)
  : VP1AvailEvents(timeCutForNew,tmpcopydir,maxLocalFilesToKeep,parent)
  , m_d(new Imp(this,fileinfoUrl,updateInterval))
{
}
 
VP1AvailEvtsHttps::~VP1AvailEvtsHttps()
{
  delete m_d;
}
 
void VP1AvailEvtsHttps::init()
{
  // Dummy for now
}
 
void VP1AvailEvtsHttps::start(QNetworkAccessManager* netmanager)
{
  m_d->m_netmanager = netmanager;
  m_d->startTimer();
}
 
const QString& VP1AvailEvtsHttps::fileinfoLocation()
{
  return m_d->m_fileInfoUrl;
}
 
void VP1AvailEvtsHttps::generateHttpsRequest()
{
  QUrl fileInfoUrl(m_d->m_fileInfoUrl);
  QNetworkRequest netrequest(fileInfoUrl);
  if(m_d->m_stage==0) {
    m_d->m_netreply = m_d->m_netmanager->head(netrequest);
  } else if(m_d->m_stage==1) {
    m_d->m_netreply = m_d->m_netmanager->get(netrequest);
  } else {
    // stage 2
 
    QString activeRetrievalDir = tmpActiveRetrievalDir();
    QString target = activeRetrievalDir +"downloadedfileinfo.txt";
    VP1EvtsOnServerInfo newEvtsOnServerInfo(target);
 
    if (!newEvtsOnServerInfo.isValid()) {
      message("Problems decoding info in file downloaded from " + m_d->m_fileInfoUrl);
      QFile::remove(target);
      invalidateDirCache(tmpActiveRetrievalDir());
      m_d->m_stage = 0;
      m_d->startTimer(m_d->m_updateInterval);
      return;
    }
 
    VP1EventFile evtToGet;
    QString localfiledir = tmpLocalFileDir();
 
    for (VP1EventFile evt : newEvtsOnServerInfo.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()) {
      //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) {
        m_d->m_stage = 0;
        m_d->startTimer(m_d->m_updateInterval);
        return;
      }
    }
      }
 
      QUrl url(m_d->m_baseUrl + evtToGet.fileName());
      m_d->m_expectedMD5Sum = evtToGet.md5Sum();
      QNetworkRequest netrequestEvt(url);
      m_d->m_evtToGet = evtToGet.fileName();
      m_d->m_netreply = m_d->m_netmanager->get(netrequestEvt);
    } else {
      m_d->m_stage = 0;
      m_d->startTimer(m_d->m_updateInterval);
      return;
    }
  }
  m_d->connectNetworkSignalsToSlots();
}
 
void VP1AvailEvtsHttps::finished()
{
    VP1Msg::messageDebug("VP1AvailEvtsHttps::finished()");
  int sc=-9999;
  QVariant val = m_d->m_netreply->attribute(QNetworkRequest::HttpStatusCodeAttribute);
  if(val.type()==QVariant::Int) 
    sc = val.value<int>();
  else if(val.type()==QVariant::Invalid)
    message("No status code obtained while processing " + m_d->m_netreply->url().toString());
  else if(!val.canConvert<int>())
    message("Cannot convert status code to int while processing " + m_d->m_netreply->url().toString());
  else 
    sc = val.value<int>();
 
    VP1Msg::messageDebug("sc: " + QString::number(sc));
 
  QString lastModified;
  QVariant lastModHeader = m_d->m_netreply->header(QNetworkRequest::LastModifiedHeader);
  if(lastModHeader.type()!=QVariant::Invalid && 
     lastModHeader.canConvert<QDateTime>()) {
    QDateTime lastModTime = lastModHeader.value<QDateTime>();
    lastModified = lastModTime.toString();
  }

 
  if(m_d->m_netreply->error()==QNetworkReply::NoError) {
    if(m_d->m_stage==0) {
      if(!lastModified.isEmpty() && lastModified!=m_d->m_urlLastMod) {
    // The file info has been modified, go to the stage 1
    m_d->m_urlLastMod = std::move(lastModified);
    m_d->m_stage = 1; 
      } else {
    // Reuse the already downloaded file info
    m_d->m_stage = 2;
      }
    }else if(m_d->m_stage==1) {
      // Write out fileinfo to local file for parsing
      QString activeRetrievalDir = tmpActiveRetrievalDir();
      QString target = activeRetrievalDir +"downloadedfileinfo.txt";
 
      // Delete already existing fileinfo 
      if(QFileInfo(target).exists() && !QFile(target).remove()) {
    message("ERROR: Could not remove the old fileinfo " + target);
    m_d->m_stage = 0;
    m_d->startTimer(m_d->m_updateInterval);
    return;
      }
 
      // Create new fileinfo
      QFile localfileinfo(target);
      if(!localfileinfo.open(QIODevice::WriteOnly)) {
    message("ERROR: Unable to open " + target + " for writing");
    m_d->m_stage = 0;
    m_d->startTimer(m_d->m_updateInterval);
    return;
      }
 
      // Wrute received fileinfo to local file
      QByteArray ba = m_d->m_netreply->readAll();
      localfileinfo.write(ba);
      localfileinfo.close();
      m_d->m_stage = 2;
    }else if(m_d->m_stage==2) {
      // Open target file for writing
      QString target = tmpActiveRetrievalDir() + m_d->m_evtToGet;
      QFile targetFile(target);
      if(!targetFile.open(QIODevice::WriteOnly)) {
    message("ERROR: Unable to open " + target + " for writing");
    m_d->m_stage = 0;
    m_d->startTimer(m_d->m_updateInterval);
    return;
      }
 
      // Write to file
      QByteArray ba = m_d->m_netreply->readAll();
      targetFile.write(ba);
      targetFile.close();
 
      // Checksum test
      bool match = VP1MD5Sum::sumMatches(target,m_d->m_expectedMD5Sum);
      if(!match) {
    message("Checksum did not match");
    QFile::remove(target);
    m_d->m_stage = 0;
    m_d->startTimer(m_d->m_updateInterval);
    return;
      }
 
      QString finalTarget = tmpLocalFileDir()+m_d->m_evtToGet;
      if(!QFile::rename(target,finalTarget)) {
    message("ERROR: Could not move " + target + " to " + finalTarget);
    QFile::remove(target);
    QFile::remove(finalTarget);
      } else {
    cleanupAndCheckForEventListChanges();
      }
      
      m_d->m_stage = 0;
    }
  }
  else
    m_d->m_stage = 0;
 
  m_d->m_netreply->blockSignals(true);
  m_d->m_netreply->deleteLater();
  m_d->m_netreply = 0;
 
  int interval = m_d->m_stage>0 ? 0 : m_d->m_updateInterval;
  m_d->startTimer(interval);
}
 
void VP1AvailEvtsHttps::error(QNetworkReply::NetworkError err)
{
  message("Error processing " + m_d->m_netreply->url().toString() 
      + "\n   ===> Error code: " + QString::number((int)err)
      + "\n        Error decoding here: http://doc.trolltech.com/4.4/qnetworkreply.html#NetworkError-enum");
}
 
#ifndef QT_NO_SSL
void VP1AvailEvtsHttps::sslErrors(const QList<QSslError>&) 
{
  m_d->m_netreply->ignoreSslErrors();
}
#endif
 
void VP1AvailEvtsHttps::dataReadProgress(qint64 received, qint64)
{
  if(m_d->m_stage>0) {
    if(received>m_d->m_bytesReceived) {
      m_d->m_lastChangeTime = QDateTime::currentDateTime().toTime_t();
      m_d->m_bytesReceived = received;
    }
  } else {
    m_d->m_lastChangeTime = QDateTime::currentDateTime().toTime_t();
  }
}
 
void VP1AvailEvtsHttps::checkForStall()
{
  unsigned currentTime = QDateTime::currentDateTime().toTime_t();
  if (currentTime>m_d->m_lastChangeTime+10) {
    // Abort current download and go to stage 0
    if(m_d->m_netreply) {
      m_d->m_netreply->blockSignals(true);
      delete m_d->m_netreply;
      m_d->m_netreply=0;
      m_d->m_stage = 0;
      m_d->startTimer(m_d->m_updateInterval);
    }
  }
}