Added ImportTemplateWorkOrder. Fixes #5086 (18384dda) · Commits · aflab / astrogeology / ISIS3

isis/src/qisis/objs/Directory/Directory.cpp

+3 −1

Original line number	Diff line number	Diff line
		@@ -65,6 +65,7 @@
		#include "ImportControlNetWorkOrder.h"
		#include "ImportImagesWorkOrder.h"
		#include "ImportShapesWorkOrder.h"
		#include "ImportTemplateWorkOrder.h"
		#include "ImageFileListWidget.h"
		#include "JigsawWorkOrder.h"
		#include "MatrixSceneWidget.h"
		@@ -157,6 +158,7 @@ namespace Isis {
		m_importControlNetWorkOrder = createWorkOrder<ImportControlNetWorkOrder>();
		m_importImagesWorkOrder = createWorkOrder<ImportImagesWorkOrder>();
		m_importShapesWorkOrder = createWorkOrder<ImportShapesWorkOrder>();
		m_importTemplateWorkOrder = createWorkOrder<ImportTemplateWorkOrder>();
		m_openProjectWorkOrder = createWorkOrder<OpenProjectWorkOrder>();
		m_saveProjectWorkOrder = createWorkOrder<SaveProjectWorkOrder>();
		m_saveProjectAsWorkOrder = createWorkOrder<SaveProjectAsWorkOrder>();
		@@ -316,7 +318,6 @@ namespace Isis {
		QAction *openProjectAction = m_openProjectWorkOrder->clone();
		openProjectAction->setIcon(QIcon(":open") );
		fileMenu->addAction(openProjectAction);

		m_permToolBarActions.append(openProjectAction);

		QMenu *recentProjectsMenu = fileMenu->addMenu("&Recent Projects");
		@@ -361,6 +362,7 @@ namespace Isis {
		importMenu->addAction(m_importControlNetWorkOrder->clone() );
		importMenu->addAction(m_importImagesWorkOrder->clone() );
		importMenu->addAction(m_importShapesWorkOrder->clone() );
		importMenu->addAction(m_importTemplateWorkOrder->clone() );

		QMenu *exportMenu = fileMenu->addMenu("&Export");

isis/src/qisis/objs/Directory/Directory.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -406,6 +406,7 @@ namespace Isis {
		QPointer<WorkOrder> m_saveProjectAsWorkOrder; //!< The Save Project As WorkOrder.
		QPointer<WorkOrder> m_openRecentProjectWorkOrder; //!< The Open Recent Project WorkOrder.
		QPointer<WorkOrder> m_closeProjectWorkOrder; //!< The Close Project WorkOrder
		QPointer<WorkOrder> m_importTemplateWorkOrder; //!< The Import Template WorkOrder

		QPointer<WorkOrder> m_runJigsawWorkOrder; //!< The Run Jigsaw WorkOrder
		QPointer<WorkOrder> m_renameProjectWorkOrder; //!< The Rename Project WorkOrder

isis/src/qisis/objs/Directory/ImportControlNetWorkOrder.cpp

+2 −0

Original line number	Diff line number	Diff line
		@@ -137,6 +137,7 @@ namespace Isis {
		return internalData().count() > 0;
		}


		/**
		* @brief Imports the control network asynchronously.
		*
		@@ -185,6 +186,7 @@ namespace Isis {
		}
		}


		/**
		* @brief Clears progress.
		*

isis/src/qisis/objs/Directory/ImportTemplateWorkOrder.cpp

0 → 100644

+219 −0

Original line number	Diff line number	Diff line
		/**
		* @file
		* $Revision: 1.19 $
		* $Date: 2010/03/22 19:44:53 $
		*
		* Unless noted otherwise, the portions of Isis written by the USGS are
		* public domain. See individual third-party library and package descriptions
		* for intellectual property information, user agreements, and related
		* information.
		*
		* Although Isis has been used by the USGS, no warranty, expressed or
		* implied, is made by the USGS as to the accuracy and functioning of such
		* software and related material nor shall the fact of distribution
		* constitute any such warranty, and no responsibility is assumed by the
		* USGS in connection therewith.
		*
		* For additional information, launch
		* $ISISROOT/doc//documents/Disclaimers/Disclaimers.html
		* in a browser or see the Privacy & Disclaimers page on the Isis website,
		* http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
		* http://www.usgs.gov/privacy.html.
		*/
		#include "ImportTemplateWorkOrder.h"

		#include <QFile>
		#include <QFileDialog>
		#include <QMessageBox>
		#include <QRegularExpression>
		#include <QDebug>

		#include "Project.h"
		#include "ProjectItemModel.h"

		namespace Isis {
		/**
		* Creates a work order to import a template.
		*
		* @param *project Pointer to the project this work order belongs to
		*/
		ImportTemplateWorkOrder::ImportTemplateWorkOrder(Project *project) :
		WorkOrder(project) {

		m_isUndoable = true;

		QAction::setText(tr("Import Template"));
		QUndoCommand::setText(tr("Import Template"));
		setModifiesDiskState(true);

		}


		/**
		* Creates a copy of the other ImportTemplateWorkOrder
		*
		* @param &other ImportTemplateWorkOrder to copy the state from
		*/
		ImportTemplateWorkOrder::ImportTemplateWorkOrder(const ImportTemplateWorkOrder &other) :
		WorkOrder(other) {
		}


		/**
		* Destructor
		*/
		ImportTemplateWorkOrder::~ImportTemplateWorkOrder() {
		}


		/**
		* This method clones the current ImportTemplateWorkOrder and returns it.
		*
		* @return ImportTemplateWorkOrder Clone
		*/
		ImportTemplateWorkOrder *ImportTemplateWorkOrder::clone() const {
		return new ImportTemplateWorkOrder(*this);
		}


		/**
		* This method returns true if the user clicked on a project tree node with the text
		* "Templates".
		* This is used by Directory::supportedActions(DataType data) to determine what actions are
		* appended to context menus.
		*
		* @param item The ProjectItem that was clicked
		*
		* @return bool True if the user clicked on a project tree node named "Templates"
		*/
		bool ImportTemplateWorkOrder::isExecutable(ProjectItem *item) {
		QString itemType = item->text();
		setInternalData(QStringList(itemType));

		return (itemType == "Maps" \|\| itemType == "Registrations" \|\| itemType == "Templates");
		}


		/**
		* @brief Sets up the work order for execution.
		*
		* This method prompts the user for a template to open.
		*
		* @see WorkOrder::setupExecution()
		*
		* @return bool Returns true if we have at least one template file name.
		*/
		bool ImportTemplateWorkOrder::setupExecution() {
		WorkOrder::setupExecution();

		QString itemType;
		QString filterText =
		"Please select a file type;; Maps (.def .map .pvl);; Registrations (.def *.pvl)";

		// If clicked "File"->"Import"->"Import Templates"
		if (internalData().isEmpty()) {
		itemType == "Templates";
		}
		// If clicked "Import Templates" from under "Maps" or "Registrations" ProjectItems rightclicks
		else {
		itemType = internalData().at(0);

		if (itemType == "Maps") {
		filterText = "Maps (.def .map *.pvl)";
		}
		else if (itemType == "Registrations") {
		filterText = "Registrations (.def .pvl)";
		}

		internalData().clear();
		}

		QString selectedFilter;
		QStringList templateFileNames = QFileDialog::getOpenFileNames(
		qobject_cast<QWidget *>(parent()),
		"Import " + itemType,
		QString(),
		filterText,
		&selectedFilter);

		if (!templateFileNames.isEmpty() && !selectedFilter.isEmpty()) {
		QUndoCommand::setText(tr("Import %1 Templates").arg(templateFileNames.count()));
		}
		else {
		return false;
		}

		// The user must choose a filter to import any file. The type is saved in m_lastChosenFileType
		// Currently, the only options for this will be "maps" and "registrations"
		m_lastChosenFileType = selectedFilter.remove(QRegularExpression(" \$.*\$")).toLower();
		setInternalData(templateFileNames);

		return true;


		}


		/**
		* @brief Imports the templates
		*
		* This method copies the template files into the appropriate directory according to the
		* chosen filter from setupExecution's QFileDialog. If the file already exists in the chosen
		* directory, it will not be copied over.
		*/
		void ImportTemplateWorkOrder::execute() {
		QDir templateFolder = project()->addTemplateFolder(m_lastChosenFileType);

		QStringList templateFileNames = internalData();

		QString newFile;
		QString notCopied;

		foreach (FileName filename, templateFileNames) {
		newFile = m_lastChosenFileType + "/" + filename.name();

		// If the file is already in the folder, don't copy it over
		if ( !templateFolder.exists(filename.name())) {
		QFile::copy(filename.expanded(), templateFolder.path() + "/" +newFile);
		m_newFileList.append(FileName(newFile));
		}
		else {
		notCopied += filename.name() + "\n";
		}
		}

		// Let the user know if a file already existed in the templates directory and was not copied
		if (!notCopied.isEmpty()) {
		QMessageBox::information(
		qobject_cast<QWidget *>(parent()),
		"Not all templates were copied",
		"The following already exist in the " + templateFolder.dirName() +
		" directory:\n\n" + notCopied
		);
		}

		if (!m_newFileList.isEmpty()) {
		project()->addTemplates(m_newFileList);
		project()->setClean(false);
		}
		}


		/**
		* @brief Deletes the previously imported templates
		*
		* This method deletes the templates from both the directory they were copied to
		* and the ProjectItemModel
		*/
		void ImportTemplateWorkOrder::undoExecution() {
		foreach ( FileName filename, m_newFileList) {
		project()->removeTemplate(filename);
		QFile::remove(project()->templateRoot() + "/" + filename.toString());
		ProjectItem *currentItem =
		project()->directory()->model()->findItemData(QVariant::fromValue(filename.toString()));
		project()->directory()->model()->removeItem(currentItem);
		}

		m_newFileList.clear();
		}
		}

isis/src/qisis/objs/Directory/ImportTemplateWorkOrder.h

0 → 100644

+60 −0

Original line number	Diff line number	Diff line
		#ifndef ImportTemplateWorkOrder_H
		#define ImportTemplateWorkOrder_H
		/**
		* @file
		* $Revision: 1.19 $
		* $Date: 2010/03/22 19:44:53 $
		*
		* Unless noted otherwise, the portions of Isis written by the USGS are
		* public domain. See individual third-party library and package descriptions
		* for intellectual property information, user agreements, and related
		* information.
		*
		* Although Isis has been used by the USGS, no warranty, expressed or
		* implied, is made by the USGS as to the accuracy and functioning of such
		* software and related material nor shall the fact of distribution
		* constitute any such warranty, and no responsibility is assumed by the
		* USGS in connection therewith.
		*
		* For additional information, launch
		* $ISISROOT/doc//documents/Disclaimers/Disclaimers.html
		* in a browser or see the Privacy & Disclaimers page on the Isis website,
		* http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
		* http://www.usgs.gov/privacy.html.
		*/
		#include "WorkOrder.h"
		#include "ProjectItem.h"

		namespace Isis {
		/**
		* @brief Add templates to a project
		*
		* Asks the user for a template and its type and copies it into the project.
		*
		* @author 2017-07-31 Christopher Combs
		*
		* @internal
		*/
		class ImportTemplateWorkOrder : public WorkOrder {
		Q_OBJECT
		public:
		ImportTemplateWorkOrder(Project *project);
		ImportTemplateWorkOrder(const ImportTemplateWorkOrder &other);
		~ImportTemplateWorkOrder();

		virtual ImportTemplateWorkOrder *clone() const;

		virtual bool isExecutable(ProjectItem *item);
		bool setupExecution();
		void execute();
		void undoExecution();

		private:
		ImportTemplateWorkOrder &operator=(const ImportTemplateWorkOrder &rhs);

		QList<FileName> m_newFileList;
		QString m_lastChosenFileType; //!< The file type filter chosen in the QFileDialog
		};
		}

		#endif