ControlList.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include "ControlList.h"
 
#include <QAction>
#include <QColorDialog>
#include <QDebug>
#include <QDir>
#include <QFile>
#include <QFuture>
#include <QInputDialog>
#include <QLabel>
#include <QProgressDialog>
#include <QtConcurrentMap>
#include <QXmlStreamWriter>
 
#include "Color.h"
#include "FileName.h"
#include "IException.h"
#include "Project.h"
#include "XmlStackedHandlerReader.h"
 
namespace Isis {
  ControlList::ControlList(QString name, QString path, QObject *parent) : QObject(parent) {
    m_name = name;
    m_path = path;
  }
 
 
  ControlList::ControlList(QObject *parent) : QObject(parent) {
  }
 
 
  ControlList::ControlList(QList<Control *> controls, QObject *parent) : QObject(parent) {
    append(controls);
  }
 
 
  ControlList::ControlList(Project *project, XmlStackedHandlerReader *xmlReader, QObject *parent) :
      QObject(parent) {
    xmlReader->pushContentHandler(new XmlHandler(this, project));
  }
 
 
  ControlList::ControlList(const ControlList &other) :
      QList<Control *>(other) {
    m_name = other.m_name;
    m_path = other.m_path;
  }
 
 
  ControlList::ControlList(QStringList &fileNames) {
    foreach (QString fileName, fileNames) {
      try {
        Control *control = new Control(fileName);
        append(control);
      }
      catch (IException &) {
      }
    }
  }
 
 
  ControlList::~ControlList() {
    emit deletingList(this);
  }
 
 
  void ControlList::append(Control * const &value) {
    QList<Control *>::append(value);
    emit countChanged(count());
  }
 
 
  void ControlList::append(const QList<Control *> &value) {
    QList<Control *>::append(value);
    emit countChanged(count());
  }
 
 
  void ControlList::clear() {
    bool countChanging = count();
    QList<Control *>::clear();
    if (countChanging) {
      emit countChanged(count());
    }
  }
 
 
  QList<Control *>::iterator ControlList::erase(iterator pos) {
    iterator result = QList<Control *>::erase(pos);
    emit countChanged(count());
    return result;
  }
 
 
  QList<Control *>::iterator ControlList::erase(iterator begin, iterator end) {
    iterator result = QList<Control *>::erase(begin, end);
    emit countChanged(count());
    return result;
  }
 
 
  void ControlList::insert(int i, Control * const &value) {
    QList<Control *>::insert(i, value);
 
    emit countChanged(count());
  }
 
 
  QList<Control *>::iterator ControlList::insert(iterator before, Control * const &value) {
    iterator result = QList<Control *>::insert(before, value);
    emit countChanged(count());
    return result;
  }
 
 
  void ControlList::prepend(Control * const &value) {
    QList<Control *>::prepend(value);
    emit countChanged(count());
  }
 
 
  void ControlList::push_back(Control * const &value) {
    QList<Control *>::push_back(value);
    emit countChanged(count());
  }
 
 
  void ControlList::push_front(Control * const &value) {
    QList<Control *>::push_front(value);
    emit countChanged(count());
  }
 
 
  int ControlList::removeAll(Control * const &value) {
    int result = QList<Control *>::removeAll(value);
 
    if (result != 0) {
      emit countChanged(count());
    }
 
    return result;
  }
 
 
  void ControlList::removeAt(int i) {
    QList<Control *>::removeAt(i);
    emit countChanged(count());
  }
 
 
  void ControlList::removeFirst() {
    QList<Control *>::removeFirst();
    emit countChanged(count());
  }
 
 
  void ControlList::removeLast() {
    QList<Control *>::removeLast();
    emit countChanged(count());
  }
 
 
  bool ControlList::removeOne(Control * const &value) {
    bool result = QList<Control *>::removeOne(value);
 
    if (result) {
      emit countChanged(count());
    }
 
    return result;
  }
 
 
  void ControlList::swap(QList<Control *> &other) {
    QList<Control *>::swap(other);
 
    if (count() != other.count()) {
      emit countChanged(count());
    }
  }
 
 
  Control *ControlList::takeAt(int i) {
    Control * result = QList<Control *>::takeAt(i);
    emit countChanged(count());
    return result;
  }
 
 
  Control *ControlList::takeFirst() {
    Control *result = QList<Control *>::takeFirst();
    emit countChanged(count());
    return result;
  }
 
 
  Control *ControlList::takeLast() {
    Control *result = QList<Control *>::takeLast();
    emit countChanged(count());
    return result;
  }
 
 
  ControlList &ControlList::operator+=(const QList<Control *> &other) {
    QList<Control *>::operator+=(other);
 
    if (other.count()) {
      emit countChanged(count());
    }
 
    return *this;
  }
 
 
  ControlList &ControlList::operator+=(Control * const &other) {
    QList<Control *>::operator+=(other);
    emit countChanged(count());
    return *this;
  }
 
 
  ControlList &ControlList::operator<<(const QList<Control *> &other) {
    QList<Control *>::operator<<(other);
 
    if (other.count()) {
      emit countChanged(count());
    }
 
    return *this;
  }
 
 
  ControlList &ControlList::operator<<(Control * const &other) {
    QList<Control *>::operator<<(other);
    emit countChanged(count());
    return *this;
  }
 
 
  ControlList &ControlList::operator=(const QList<Control *> &rhs) {
    bool countChanging = (rhs.count() != count());
    QList<Control *>::operator=(rhs);
 
    if (countChanging) {
      emit countChanged(count());
    }
 
    return *this;
  }
 
 
  ControlList &ControlList::operator=(const ControlList &rhs) {
    bool countChanging = (rhs.count() != count());
    QList<Control *>::operator=(rhs);
 
    m_name = rhs.m_name;
    m_path = rhs.m_path;
 
    if (countChanging) {
      emit countChanged(count());
    }
 
    return *this;
  }
 
 
  void ControlList::setName(QString newName) {
    m_name = newName;
  }
 
 
  void ControlList::setPath(QString newPath) {
    m_path = newPath;
  }
 
 
  QString ControlList::name() const {
    return m_name;
  }
 
 
  QString ControlList::path() const {
    return m_path;
  }
 
 
  void ControlList::deleteFromDisk(Project *project) {
    foreach (Control *control, *this) {
      control->deleteFromDisk();
    }
 
    if (!m_path.isEmpty()) {
      QFile::remove(project->cnetRoot() + "/" + m_path + "/controlNetworks.xml");
 
      QDir dir;
      dir.rmdir(project->cnetRoot() + "/" + m_path);
    }
  }
 
 
  void ControlList::save(QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot)
      const {
    stream.writeStartElement("controlList");
    stream.writeAttribute("name", m_name);
    stream.writeAttribute("path", m_path);
 
    FileName settingsFileName(
        Project::cnetRoot(newProjectRoot.toString()) + "/" + m_path +
                                 "/controlNetworks.xml");
 
    if (!settingsFileName.dir().mkpath(settingsFileName.path())) {
      throw IException(IException::Io,
                       QString("Failed to create directory [%1]")
                         .arg(settingsFileName.path()),
                       _FILEINFO_);
    }
 
    QFile controlListContentsFile(settingsFileName.toString());
 
    if (!controlListContentsFile.open(QIODevice::ReadWrite | QIODevice::Truncate)) {
      throw IException(IException::Io,
          QString("Unable to save control information for [%1] because [%2] could not be opened "
                  "for writing")
            .arg(m_name).arg(settingsFileName.original()),
          _FILEINFO_);
    }
 
    QXmlStreamWriter controlDetailsWriter(&controlListContentsFile);
    controlDetailsWriter.setAutoFormatting(true);
    controlDetailsWriter.writeStartDocument();
 
    int countWidth = QString("%1L").arg(count()).size() - 1;
    QChar paddingChar('0');
 
    QLabel *progressLabel = new QLabel;
 
    QProgressDialog progressDialog;
    progressDialog.setLabel(progressLabel);
    progressDialog.setRange(-1, count());
    progressDialog.setValue(-1);
 
    controlDetailsWriter.writeStartElement("controls");
 
    // Only copy controls if saving to new location
    if (project->newProjectRoot() != project->projectRoot()) {
      QFuture<void *> future = QtConcurrent::mapped(*this,
                                                    CopyControlDataFunctor(project, newProjectRoot));
      for (int i = 0; i < count(); i++) {
        int newProgressValue = progressDialog.value() + 1;
        progressLabel->setText(
            tr("Saving Control Information for [%1] - %L2/%L3 done")
              .arg(m_name)
              .arg(newProgressValue, countWidth, 10, paddingChar)
              .arg(count()));
        progressDialog.setValue(newProgressValue);
        future.resultAt(i);
      }
 
      progressLabel->setText(tr("Finalizing..."));
      progressDialog.setRange(0, 0);
      progressDialog.setValue(0);
    }
 
    foreach (Control *control, *this) {
      control->save(controlDetailsWriter, project, newProjectRoot);
    }
 
    controlDetailsWriter.writeEndElement();
 
    controlDetailsWriter.writeEndDocument();
 
    stream.writeEndElement();
  }
 
 
  ControlList::CopyControlDataFunctor::CopyControlDataFunctor(const Project *project,
                                                              FileName newProjectRoot) {
    m_project = project;
    m_newProjectRoot = newProjectRoot;
  }
 
 
  ControlList::CopyControlDataFunctor::CopyControlDataFunctor(const CopyControlDataFunctor &other) {
    m_project = other.m_project;
    m_newProjectRoot = other.m_newProjectRoot;
  }
 
 
  ControlList::CopyControlDataFunctor::~CopyControlDataFunctor() {
  }
 
 
  void *ControlList::CopyControlDataFunctor::operator()(Control * const &controlToCopy) {
    controlToCopy->copyToNewProjectRoot(m_project, m_newProjectRoot);
    return NULL;
  }
 
 
  ControlList::CopyControlDataFunctor &ControlList::CopyControlDataFunctor::operator=(
      const CopyControlDataFunctor &rhs) {
    m_project = rhs.m_project;
    m_newProjectRoot = rhs.m_newProjectRoot;
    return *this;
  }
 
 
  ControlList::XmlHandler::XmlHandler(ControlList *controlList, Project *project) {
    m_controlList = controlList;
    m_project = project;
  }
 
 
  bool ControlList::XmlHandler::startElement(const QString &namespaceURI, const QString &localName,
                                           const QString &qName, const QXmlAttributes &atts) {
    if (XmlStackedHandler::startElement(namespaceURI, localName, qName, atts)) {
      if (localName == "controlList") {
        QString name = atts.value("name");
        QString path = atts.value("path");
 
        if (!name.isEmpty()) {
          m_controlList->setName(name);
        }
 
        if (!path.isEmpty()) {
          m_controlList->setPath(path);
        }
      }
      else if (localName == "controlNet") {
        m_controlList->append(new Control(m_project->cnetRoot() + "/" +
                                          m_controlList->path(), reader()));
      }
    }
 
    return true;
  }
 
 
  bool ControlList::XmlHandler::endElement(const QString &namespaceURI, const QString &localName,
                                           const QString &qName) {
    if (localName == "controlList") {
      XmlHandler handler(m_controlList, m_project);
 
      XmlStackedHandlerReader reader;
      reader.pushContentHandler(&handler);
      reader.setErrorHandler(&handler);
 
      QString controlListXmlPath = m_project->cnetRoot() + "/" + m_controlList->path() +
                                 "/controlNetworks.xml";
      QFile file(controlListXmlPath);
 
      if (!file.open(QFile::ReadOnly)) {
        throw IException(IException::Io,
                         QString("Unable to open [%1] with read access")
                           .arg(controlListXmlPath),
                         _FILEINFO_);
      }
 
      QXmlInputSource xmlInputSource(&file);
      if (!reader.parse(xmlInputSource))
        throw IException(IException::Io,
                         tr("Failed to open control list XML [%1]").arg(controlListXmlPath),
                         _FILEINFO_);
    }
 
    return XmlStackedHandler::endElement(namespaceURI, localName, qName);
  }
}