CmsShowMainBase.cc

Go to the documentation of this file.

#include <fstream>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>

#include <functional>
#include <memory>

#include "TGLWidget.h"
#include "TGMsgBox.h"
#include "TROOT.h"
#include "TSystem.h"
#include "TStopwatch.h"
#include "TTimer.h"
#include "TEveManager.h"
#include "TPRegexp.h"

#include "Fireworks/Core/interface/CmsShowMainBase.h"
#include "Fireworks/Core/interface/ActionsList.h"
#include "Fireworks/Core/interface/CSGAction.h"
#include "Fireworks/Core/interface/CSGContinuousAction.h"
#include "Fireworks/Core/interface/CmsShowMainFrame.h"
#include "Fireworks/Core/interface/CmsShowSearchFiles.h"
#include "Fireworks/Core/interface/Context.h"
#include "Fireworks/Core/interface/FWColorManager.h"
#include "Fireworks/Core/interface/FWConfigurationManager.h"
#include "Fireworks/Core/interface/FWEveViewManager.h"
#include "Fireworks/Core/interface/FWEventItemsManager.h"
#include "Fireworks/Core/interface/FWGUIManager.h"
#include "Fireworks/Core/interface/FWJobMetadataManager.h"
#include "Fireworks/Core/interface/FWMagField.h"
#include "Fireworks/Core/interface/FWBeamSpot.h"
#include "Fireworks/Core/interface/FWModelChangeManager.h"
#include "Fireworks/Core/interface/FWNavigatorBase.h"
#include "Fireworks/Core/interface/FWSelectionManager.h"
#include "Fireworks/Core/interface/FWTableViewManager.h"
#include "Fireworks/Core/interface/FWTriggerTableViewManager.h"
#include "Fireworks/Core/interface/FWGeometryTableViewManager.h"
#include "Fireworks/Core/interface/FWViewManagerManager.h"
#include "Fireworks/Core/interface/CmsShowTaskExecutor.h"
#include "Fireworks/Core/src/FWColorSelect.h"
#include "Fireworks/Core/interface/SimpleSAXParser.h"
#include "Fireworks/Core/interface/CmsShowCommon.h"
#include "Fireworks/Core/interface/fwLog.h"
#include "Fireworks/Core/interface/fwPaths.h"
#include "Fireworks/Core/interface/FWPartialConfig.h"

CmsShowMainBase::CmsShowMainBase()
    : m_changeManager(new FWModelChangeManager),
      m_colorManager(new FWColorManager(m_changeManager.get())),
      m_configurationManager(new FWConfigurationManager),
      m_eiManager(new FWEventItemsManager(m_changeManager.get())),
      m_guiManager(nullptr),
      m_selectionManager(new FWSelectionManager(m_changeManager.get())),
      m_startupTasks(new CmsShowTaskExecutor),
      m_viewManager(new FWViewManagerManager(m_changeManager.get(), m_colorManager.get())),
      m_autoLoadTimer(new SignalTimer()),
      m_navigatorPtr(nullptr),
      m_metadataManagerPtr(nullptr),
      m_contextPtr(nullptr),
      m_autoSaveAllViewsHeight(-1),
      m_autoLoadTimerRunning(kFALSE),
      m_forward(true),
      m_isPlaying(false),
      m_loop(false),
      m_playDelay(3.f) {
  sendVersionInfo();
}

CmsShowMainBase::~CmsShowMainBase() noexcept(false) {}

void CmsShowMainBase::setupActions() {
  m_guiManager->writeToPresentConfigurationFile_.connect(
      sigc::mem_fun(*this, &CmsShowMainBase::writeToCurrentConfigFile));

  // init TGSlider state before signals are connected
  m_guiManager->setDelayBetweenEvents(m_playDelay);

  m_navigatorPtr->newEvent_.connect(std::bind(&CmsShowMainBase::eventChangedSlot, this));
  if (m_guiManager->getAction(cmsshow::sNextEvent) != nullptr)
    m_guiManager->getAction(cmsshow::sNextEvent)->activated.connect(sigc::mem_fun(*this, &CmsShowMainBase::doNextEvent));
  if (m_guiManager->getAction(cmsshow::sPreviousEvent) != nullptr)
    m_guiManager->getAction(cmsshow::sPreviousEvent)
        ->activated.connect(sigc::mem_fun(*this, &CmsShowMainBase::doPreviousEvent));
  if (m_guiManager->getAction(cmsshow::sGotoFirstEvent) != nullptr)
    m_guiManager->getAction(cmsshow::sGotoFirstEvent)
        ->activated.connect(sigc::mem_fun(*this, &CmsShowMainBase::doFirstEvent));
  if (m_guiManager->getAction(cmsshow::sGotoLastEvent) != nullptr)
    m_guiManager->getAction(cmsshow::sGotoLastEvent)
        ->activated.connect(sigc::mem_fun(*this, &CmsShowMainBase::doLastEvent));
  if (m_guiManager->getAction(cmsshow::sQuit) != nullptr)
    m_guiManager->getAction(cmsshow::sQuit)->activated.connect(sigc::mem_fun(*this, &CmsShowMainBase::quit));

  m_guiManager->changedEventId_.connect(std::bind(
      &CmsShowMainBase::goToRunEvent, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3));
  m_guiManager->playEventsAction()->started_.connect(sigc::mem_fun(*this, &CmsShowMainBase::playForward));
  m_guiManager->playEventsBackwardsAction()->started_.connect(sigc::mem_fun(*this, &CmsShowMainBase::playBackward));
  m_guiManager->loopAction()->started_.connect(sigc::mem_fun(*this, &CmsShowMainBase::setPlayLoopImp));
  m_guiManager->loopAction()->stopped_.connect(sigc::mem_fun(*this, &CmsShowMainBase::unsetPlayLoopImp));
  m_guiManager->changedDelayBetweenEvents_.connect(
      std::bind(&CmsShowMainBase::setPlayDelay, this, std::placeholders::_1));
  m_guiManager->playEventsAction()->stopped_.connect(sigc::mem_fun(*this, &CmsShowMainBase::stopPlaying));
  m_guiManager->playEventsBackwardsAction()->stopped_.connect(sigc::mem_fun(*this, &CmsShowMainBase::stopPlaying));

  m_autoLoadTimer->timeout_.connect(std::bind(&CmsShowMainBase::autoLoadNewEvent, this));
}

void CmsShowMainBase::setupViewManagers() {
  guiManager()->updateStatus("Setting up view manager...");

  std::shared_ptr<FWViewManagerBase> eveViewManager = std::make_shared<FWEveViewManager>(guiManager());
  eveViewManager->setContext(m_contextPtr);
  viewManager()->add(eveViewManager);

  auto tableViewManager = std::make_shared<FWTableViewManager>(guiManager());
  configurationManager()->add(std::string("Tables"), tableViewManager.get());
  viewManager()->add(tableViewManager);
  eiManager()->goingToClearItems_.connect(std::bind(&FWTableViewManager::removeAllItems, tableViewManager.get()));

  auto triggerTableViewManager = std::make_shared<FWTriggerTableViewManager>(guiManager());
  configurationManager()->add(std::string("TriggerTables"), triggerTableViewManager.get());
  configurationManager()->add(std::string("L1TriggerTables"),
                              triggerTableViewManager.get());  // AMT: added for backward compatibilty
  triggerTableViewManager->setContext(m_contextPtr);
  viewManager()->add(triggerTableViewManager);

  auto geoTableViewManager =
      std::make_shared<FWGeometryTableViewManager>(guiManager(), m_simGeometryFilename, m_TGeoName);
  geoTableViewManager->setContext(m_contextPtr);
  viewManager()->add(geoTableViewManager);

  // Unfortunately, due to the plugin mechanism, we need to delay
  // until here the creation of the FWJobMetadataManager, because
  // otherwise the supportedTypesAndRepresentations map is empty.
  // FIXME: should we have a signal for whenever the above mentioned map
  //        changes? Can that actually happer (maybe if we add support
  //        for loading plugins on the fly??).
  m_metadataManagerPtr->initReps(viewManager()->supportedTypesAndRepresentations());
}

void CmsShowMainBase::eventChangedSlot() { eventChangedImp(); }

void CmsShowMainBase::eventChangedImp() { guiManager()->eventChangedCallback(); }

void CmsShowMainBase::doFirstEvent() {
  m_navigatorPtr->firstEvent();
  checkPosition();
  draw();
}

void CmsShowMainBase::doNextEvent() {
  m_navigatorPtr->nextEvent();
  checkPosition();
  draw();
}

void CmsShowMainBase::doPreviousEvent() {
  m_navigatorPtr->previousEvent();
  checkPosition();
  draw();
}
void CmsShowMainBase::doLastEvent() {
  m_navigatorPtr->lastEvent();
  checkPosition();
  draw();
}

void CmsShowMainBase::goToRunEvent(edm::RunNumber_t run, edm::LuminosityBlockNumber_t lumi, edm::EventNumber_t event) {
  m_navigatorPtr->goToRunEvent(run, lumi, event);
  checkPosition();
  draw();
}

void CmsShowMainBase::draw() {
  m_guiManager->updateStatus("loading event ...");

  if (m_contextPtr->getField()->getSource() != FWMagField::kUser) {
    m_contextPtr->getField()->checkFieldInfo(m_navigatorPtr->getCurrentEvent());
  }
  m_contextPtr->getBeamSpot()->checkBeamSpot(m_navigatorPtr->getCurrentEvent());

  TStopwatch sw;
  m_viewManager->eventBegin();
  m_eiManager->newEvent(m_navigatorPtr->getCurrentEvent());
  m_viewManager->eventEnd();
  sw.Stop();
  fwLog(fwlog::kDebug) << "CmsShowMainBase::draw CpuTime " << sw.CpuTime() << " RealTime " << sw.RealTime()
                       << std::endl;

  if (!m_autoSaveAllViewsFormat.empty()) {
    m_guiManager->updateStatus("auto saving images ...");
    m_guiManager->exportAllViews(m_autoSaveAllViewsFormat, m_autoSaveAllViewsHeight);
  }
  m_guiManager->clearStatus();
}

void CmsShowMainBase::setup(FWNavigatorBase *navigator,
                            fireworks::Context *context,
                            FWJobMetadataManager *metadataManager) {
  m_navigatorPtr = navigator;
  m_contextPtr = context;
  m_contextPtr->setGeom(&m_geom);
  m_metadataManagerPtr = metadataManager;

  m_colorManager->initialize();
  m_contextPtr->initEveElements();
  m_guiManager = std::make_unique<FWGUIManager>(m_contextPtr, m_viewManager.get(), m_navigatorPtr);

  m_eiManager->newItem_.connect(
      std::bind(&FWModelChangeManager::newItemSlot, m_changeManager.get(), std::placeholders::_1));

  m_eiManager->newItem_.connect(
      std::bind(&FWViewManagerManager::registerEventItem, m_viewManager.get(), std::placeholders::_1));
  m_configurationManager->add("EventItems", m_eiManager.get());
  m_configurationManager->add("GUI", m_guiManager.get());
  m_configurationManager->add("EventNavigator", m_navigatorPtr);
  m_configurationManager->add("CommonPreferences",
                              m_contextPtr->commonPrefs());  // must be after GUIManager in alphabetical order

  m_guiManager->writeToConfigurationFile_.connect(
      std::bind(&CmsShowMainBase::writeToConfigFile, this, std::placeholders::_1));

  m_guiManager->loadFromConfigurationFile_.connect(
      std::bind(&CmsShowMainBase::reloadConfiguration, this, std::placeholders::_1));
  m_guiManager->loadPartialFromConfigurationFile_.connect(
      std::bind(&CmsShowMainBase::partialLoadConfiguration, this, std::placeholders::_1));

  m_guiManager->writePartialToConfigurationFile_.connect(
      std::bind(&CmsShowMainBase::partialWriteToConfigFile, this, std::placeholders::_1));

  std::string macPath(gSystem->Getenv("CMSSW_BASE"));
  macPath += "/src/Fireworks/Core/macros";
  const char *base = gSystem->Getenv("CMSSW_RELEASE_BASE");
  if (nullptr != base) {
    macPath += ":";
    macPath += base;
    macPath += "/src/Fireworks/Core/macros";
  }
  gROOT->SetMacroPath((std::string("./:") + macPath).c_str());

  m_startupTasks->tasksCompleted_.connect(std::bind(&FWGUIManager::clearStatus, m_guiManager.get()));
}

void CmsShowMainBase::writeToConfigFile(const std::string &name) {
  m_configFileName = name;
  m_configurationManager->writeToFile(m_configFileName);
}

void CmsShowMainBase::writeToCurrentConfigFile() { m_configurationManager->writeToFile(m_configFileName); }

void CmsShowMainBase::partialWriteToConfigFile(const std::string &name) {
  std::string p = (name == "current") ? m_configFileName.c_str() : name.c_str();
  new FWPartialConfigSaveGUI(p.c_str(), m_configFileName.c_str(), m_configurationManager.get());
}

void CmsShowMainBase::reloadConfiguration(const std::string &config) {
  if (config.empty())
    return;

  m_configFileName = config;

  std::string msg = "Reloading configuration " + config + "...";
  fwLog(fwlog::kDebug) << msg << std::endl;
  m_guiManager->updateStatus(msg.c_str());
  m_guiManager->subviewDestroyAll();
  m_eiManager->clearItems();
  m_configFileName = config;
  try {
    gEve->DisableRedraw();
    m_configurationManager->readFromFile(config);
    gEve->EnableRedraw();
  } catch (SimpleSAXParser::ParserError &e) {
    Int_t chosen;
    new TGMsgBox(gClient->GetDefaultRoot(),
                 gClient->GetDefaultRoot(),
                 "Bad configuration",
                 ("Configuration " + config + " cannot be parsed: " + e.error()).c_str(),
                 kMBIconExclamation,
                 kMBCancel,
                 &chosen);
  } catch (...) {
    Int_t chosen;
    new TGMsgBox(gClient->GetDefaultRoot(),
                 gClient->GetDefaultRoot(),
                 "Bad configuration",
                 ("Configuration " + config + " cannot be parsed.").c_str(),
                 kMBIconExclamation,
                 kMBCancel,
                 &chosen);
  }

  m_guiManager->updateStatus("");
}

void CmsShowMainBase::partialLoadConfiguration(const std::string &name) {
  new FWPartialConfigLoadGUI(name.c_str(), m_configurationManager.get(), m_eiManager.get());
}

void CmsShowMainBase::setupAutoLoad(float x) {
  m_playDelay = x;
  m_guiManager->setDelayBetweenEvents(m_playDelay);
  if (!m_guiManager->playEventsAction()->isEnabled())
    m_guiManager->playEventsAction()->enable();

  m_guiManager->playEventsAction()->switchMode();
}

void CmsShowMainBase::startAutoLoadTimer() {
  m_autoLoadTimer->SetTime((Long_t)(m_playDelay * 1000));
  m_autoLoadTimer->Reset();
  m_autoLoadTimer->TurnOn();
  m_autoLoadTimerRunning = kTRUE;
}

void CmsShowMainBase::stopAutoLoadTimer() {
  m_autoLoadTimer->TurnOff();
  m_autoLoadTimerRunning = kFALSE;
}

void CmsShowMainBase::setupConfiguration() {
  m_guiManager->updateStatus("Setting up configuration...");

  try {
    gEve->DisableRedraw();
    if (m_configFileName.empty()) {
      m_configFileName = m_configurationManager->guessAndReadFromFile(m_metadataManagerPtr);
    } else {
      char *whereConfig = gSystem->Which(TROOT::GetMacroPath(), m_configFileName.c_str(), kReadPermission);
      m_configFileName = whereConfig;
      delete[] whereConfig;
      m_configurationManager->readFromFile(m_configFileName);
    }
    gEve->EnableRedraw();
  } catch (SimpleSAXParser::ParserError &e) {
    fwLog(fwlog::kError) << "Unable to load configuration file '" << m_configFileName << "': " << e.error()
                         << std::endl;
    exit(1);
  } catch (std::runtime_error &e) {
    fwLog(fwlog::kError) << "Unable to load configuration file '" << m_configFileName
                         << "' which was specified on command line. Quitting." << std::endl;
    exit(1);
  }
}

void CmsShowMainBase::setPlayDelay(Float_t val) { m_playDelay = val; }

void CmsShowMainBase::setupDebugSupport() {
  m_guiManager->updateStatus("Setting up Eve debug window...");
  m_guiManager->openEveBrowserForDebugging();
}

void CmsShowMainBase::setPlayLoop() {
  if (!m_loop) {
    setPlayLoopImp();
    m_guiManager->loopAction()->activated();
  }
}

void CmsShowMainBase::unsetPlayLoop() {
  if (m_loop) {
    unsetPlayLoopImp();
    m_guiManager->loopAction()->stop();
  }
}

void CmsShowMainBase::setPlayLoopImp() { m_loop = true; }

void CmsShowMainBase::unsetPlayLoopImp() { m_loop = false; }

void CmsShowMainBase::registerPhysicsObject(const FWPhysicsObjectDesc &iItem) { m_eiManager->add(iItem); }

void CmsShowMainBase::stopPlaying() {
  m_isPlaying = false;
  checkKeyBindingsOnPLayEventsStateChanged();
}

void CmsShowMainBase::playForward() {
  m_forward = true;
  m_isPlaying = true;
  guiManager()->enableActions(kFALSE);
  checkKeyBindingsOnPLayEventsStateChanged();
  startAutoLoadTimer();
}

void CmsShowMainBase::playBackward() {
  m_forward = false;
  m_isPlaying = true;
  guiManager()->enableActions(kFALSE);
  startAutoLoadTimer();
  checkKeyBindingsOnPLayEventsStateChanged();
}

void CmsShowMainBase::loadGeometry() {  // prepare geometry service
  // ATTN: this should be made configurable
  try {
    guiManager()->updateStatus("Loading geometry...");
    m_geom.loadMap(m_geometryFilename.c_str());
  } catch (const std::runtime_error &iException) {
    fwLog(fwlog::kError) << "CmsShowMain::loadGeometry() caught exception: \n"
                         << m_geometryFilename << " " << iException.what() << std::endl;
    exit(0);
  }
}

void CmsShowMainBase::sendVersionInfo() {
  // Send version info to xrootd.t2.ucsd.edu receiver on port 9698.

  // receiver
  struct hostent *h = gethostbyname("xrootd.t2.ucsd.edu");
  if (!h)
    return;

  struct sockaddr_in remoteServAddr;
  remoteServAddr.sin_family = h->h_addrtype;
  memcpy((char *)&remoteServAddr.sin_addr.s_addr, h->h_addr_list[0], h->h_length);
  remoteServAddr.sin_port = htons(9698);

  // socket creation
  int sd = socket(AF_INET, SOCK_DGRAM, 0);
  if (sd < 0) {
    // std::cout << "can't create socket \n";
    return;
  }
  // bind any port
  // printf("bind port\n");
  struct sockaddr_in cliAddr;
  cliAddr.sin_family = AF_INET;
  cliAddr.sin_addr.s_addr = htonl(INADDR_ANY);
  cliAddr.sin_port = htons(0);

  int rc = bind(sd, (struct sockaddr *)&cliAddr, sizeof(cliAddr));
  if (rc < 0) {
    //  std::cout << "can't bind port %d " << rc << std::endl;
    return;
  }

  // get OSX version
  TString osx_version;
  try {
    std::ifstream infoFile("/System/Library/CoreServices/SystemVersion.plist");
    osx_version.ReadFile(infoFile);
    TPMERegexp re("ProductVersion\\</key\\>\\n\\t\\<string\\>(10.*)\\</string\\>");
    re.Match(osx_version);
    osx_version = re[1];
  } catch (...) {
  }

  // send data
  SysInfo_t sInfo;
  gSystem->GetSysInfo(&sInfo);
  char msg[128];

  if (gSystem->Getenv("CMSSW_VERSION")) {
    snprintf(msg, 64, "%s %s %s", gSystem->Getenv("CMSSW_VERSION"), sInfo.fOS.Data(), osx_version.Data());
  } else {
    TString versionFileName("data/version.txt");
    fireworks::setPath(versionFileName);
    std::ifstream fs(versionFileName);
    TString infoText;
    infoText.ReadLine(fs);
    fs.close();
    snprintf(msg, 64, "Standalone %s %s %s", infoText.Data(), sInfo.fOS.Data(), osx_version.Data());
  }

  int flags = 0;
  sendto(sd, msg, strlen(msg), flags, (struct sockaddr *)&remoteServAddr, sizeof(remoteServAddr));
}