Added the ability to store Xml label data in ISIS cubes. Fixes #4584. (5e355f55) · Commits · aflab / astrogeology / ISIS3

isis/src/base/apps/catoriglab/catoriglab.cpp

+63 −11

Original line number	Diff line number	Diff line
		#include "Isis.h"

		#include <QDomDocument>
		#include <QFile>
		#include <QTextStream>

		#include "IException.h"
		#include "Pvl.h"
		#include "OriginalLabel.h"
		#include "OriginalXmlLabel.h"

		using namespace Isis;
		using namespace std;

		void IsisMain() {
		// QDomDocument makes use of QHashes to store attributes.
		// This sets the QHash seed so that the attributes always come out in the
		// same order.
		qSetGlobalQHashSeed(1031);

		// Get user entered file name & mode
		UserInterface &ui = Application::GetUserInterface();
		QString file = ui.GetFileName("FROM");

		// Extract history from file
		Pvl fromLabel(file);
		if ( fromLabel.hasObject("OriginalLabel") ) {
		OriginalLabel origLab(file);
		Pvl pvl = origLab.ReturnLabels();
		if (ui.IsInteractive()) {
		@@ -29,3 +41,43 @@ void IsisMain() {
		cout << pvl << endl;
		}
		}
		else if ( fromLabel.hasObject("OriginalXmlLabel") ) {
		OriginalXmlLabel origLab(file);
		QDomDocument origXml = origLab.ReturnLabels();
		if ( ui.IsInteractive() ) {
		Application::GuiLog( origXml.toString(2) );
		}
		else if (ui.WasEntered("TO")) {
		// Open the output file
		QFile outFile( FileName( ui.GetFileName("TO") ).expanded() );
		QIODevice::OpenMode openMode;
		if (ui.GetBoolean("APPEND")) {
		openMode = QIODevice::WriteOnly \| QIODevice::Append;
		}
		else {
		openMode = QIODevice::WriteOnly \| QIODevice::Truncate;
		}
		if ( !outFile.open(openMode) ) {
		QString msg = "Unable to open output file [" +
		FileName( ui.GetFileName("TO") ).expanded() +
		"] with write permissions.";
		throw IException(IException::Io, msg, _FILEINFO_);
		}

		// Write to the output file
		QTextStream outputStream(&outFile);
		outputStream << origXml.toString(2);

		// Close the output file
		outFile.close();
		}
		else {
		cout << origXml.toString(2) << endl;
		}
		}
		else {
		QString msg = "Could not find OriginalLabel or OriginalXmlLabel "
		"in input file [" + file + "].";
		throw IException(IException::User, msg, _FILEINFO_);
		}
		}

isis/src/base/apps/catoriglab/catoriglab.xml

+3 −0

Original line number	Diff line number	Diff line
		@@ -26,6 +26,9 @@
		<change name="Brendan George" date="2006-09-26">
		Documentation fixes
		</change>
		<change name="Jesse Mapel" date="2017-01-31">
		Enabled output or OriginalXmlLabels. Fixes #4584.
		</change>
		</history>

		<groups>

isis/src/base/apps/catoriglab/tsts/XmlLabel/Makefile

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		APPNAME = catoriglab

		include $(ISISROOT)/make/isismake.tsts

		commands:
		$(APPNAME) from= $(INPUT)/tgoCaSSISImage.cub \
		APPEND= false TO= $(OUTPUT)/XmlLabel.txt > /dev/null;

isis/src/base/objs/OriginalXmlLabel/Makefile

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		ifeq ($(ISISROOT), $(BLANK))
		.SILENT:
		error:
		echo "Please set ISISROOT";
		else
		include $(ISISROOT)/make/isismake.objs
		endif
		No newline at end of file

isis/src/base/objs/OriginalXmlLabel/OriginalXmlLabel.cpp

0 → 100644

+160 −0

Original line number	Diff line number	Diff line
		/**
		* @file
		* $Revision: 1.5 $
		* $Date: 2010/05/14 19:20:28 $
		*
		* 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 <fstream>
		#include <sstream>
		#include <string>

		#include <QByteArray>
		#include <QFile>

		#include "OriginalXmlLabel.h"
		#include "Application.h"
		#include "PvlObject.h"

		using namespace std;
		namespace Isis {
		/**
		* Constructors a default OriginalXmlLabel with an empty label.
		*/
		OriginalXmlLabel::OriginalXmlLabel() : Isis::Blob("IsisCube", "OriginalXmlLabel") {
		p_blobPvl += Isis::PvlKeyword("ByteOrder", "NULL");
		}


		/**
		* Constructs an OriginalXmlLabel from a cube label file.
		*
		* @param file Xml file to read labels from
		*/
		OriginalXmlLabel::OriginalXmlLabel(const QString &file) :
		Isis::Blob("IsisCube", "OriginalXmlLabel") {
		p_blobPvl += Isis::PvlKeyword("ByteOrder", "NULL");
		Blob::Read(file);
		}


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


		/**
		* Read the original label from an Xml file.
		*
		* @param FileName The Xml file containing the original label.
		*
		* @throws IException::Io "Could not open label file."
		* @throws IException::Unknown "XML read/parse error in file."
		*/
		void OriginalXmlLabel::readFromXmlFile(const FileName &xmlFileName) {
		QFile xmlFile(xmlFileName.expanded());
		if ( !xmlFile.open(QIODevice::ReadOnly) ) {
		QString msg = "Could not open label file [" + xmlFileName.expanded() +
		"].";
		throw IException(IException::Io, msg, _FILEINFO_);
		}

		QString errmsg;
		int errline, errcol;
		if ( !m_originalLabel.setContent(&xmlFile, false, &errmsg, &errline, &errcol) ) {
		xmlFile.close();
		QString msg = "XML read/parse error in file [" + xmlFileName.expanded()
		+ "] at line [" + toString(errline) + "], column [" + toString(errcol)
		+ "], message: " + errmsg;
		throw IException(IException::Unknown, msg, _FILEINFO_);
		}

		xmlFile.close();
		}


		/**
		* Read the xml file data from an input stream.
		*
		* @param stream The input stream to read from.
		*
		* @throws IException::Unknown "XML read/parse error when parsing original label."
		*
		* @see Blob::Read(const Pvl &pvl, std::istream &is)
		*/
		void OriginalXmlLabel::ReadData(std::istream &stream) {
		// Use Blob's ReadData to fill p_buffer
		Blob::ReadData(stream);

		// Setup variables for error reproting in QT's xml parser
		QString errorMessage;
		int errorLine;
		int errorColumn;

		// Attempt to use QT's xml parser to internalize the label
		if ( !m_originalLabel.setContent( QByteArray(p_buffer, p_nbytes) ) ) {
		QString msg = "XML read/parse error when parsing original label. "
		"Error at line [" + toString(errorLine) +
		"], column [" + toString(errorColumn) +
		"]. Error message: " + errorMessage;
		throw IException(IException::Unknown, msg, _FILEINFO_);
		}
		}


		/**
		* Prepare to write the label out.
		*
		* @see Blob::Write
		*/
		void OriginalXmlLabel::WriteInit() {
		p_nbytes = m_originalLabel.toByteArray(0).size();

		if (Isis::IsLsb()) {
		p_blobPvl["ByteOrder"] = Isis::ByteOrderName(Isis::Lsb);
		}
		else {
		p_blobPvl["ByteOrder"] = Isis::ByteOrderName(Isis::Msb);
		}
		}


		/**
		* Write the label out to a stream.
		*
		* @param os The stream to write the label out to.
		*
		* @see Blob::Write
		*/
		void OriginalXmlLabel::WriteData(std::fstream &os) {
		QByteArray labelByteArray = m_originalLabel.toByteArray(0);
		os.write( labelByteArray.data(), labelByteArray.size() );
		}


		/**
		* Returns the original Xml label.
		*
		* @return @b QDomDocument The parsed original label
		*/
		const QDomDocument &OriginalXmlLabel::ReturnLabels() const {
		return m_originalLabel;
		}
		}