Isis 3.0 Object Programmers' Reference

Home

---

Filename.cpp

Go to the documentation of this file.

#include <cstdlib>
#include <fstream>
#include <iostream>

#include "Preference.h"
#include "iString.h"
#include "iException.h"
#include "Filename.h"

using namespace std;
namespace Isis {

  Filename::Filename () {
    p_original.clear();
  }

  Filename::Filename (const std::string &file)
      : QFileInfo () {
    p_original = file;
    QFileInfo::setFile ((iString)Expand (file));
  }

  Filename::Filename (const std::string &name, const std::string &extension) {
    Temporary (name, extension);
  }

  Filename::~Filename () {}

  void Filename::operator=(const std::string &file) {
    p_original = file;
    QFileInfo::setFile ((iString)Expand (file));
  }

  void Filename::operator=(const char *file) {
    p_original = file;
    QFileInfo::setFile ((iString)Expand (file));
  }

  std::string Filename::Path() const {
    return QFileInfo::absolutePath().toStdString();
  }

  std::string Filename::Basename() const {
    if (QFileInfo::suffix().length() == 0) {
      return QFileInfo::baseName().toStdString();
    }
    else {
      return QFileInfo::completeBaseName().toStdString();
    }
  }

  std::string Filename::Name() const {
    return QFileInfo::fileName().toStdString();
  }

  std::string Filename::Extension () const {
    return QFileInfo::suffix().toStdString();
  }

  std::string Filename::Expanded () const {
    return QFileInfo::absoluteFilePath().toStdString();
  }

  bool Filename::Exists () {
    return QFileInfo::exists();
  }

  std::string Filename::OriginalPath() const {
    QFileInfo fi(p_original.c_str());
    return fi.path().toStdString();
  }

  void Filename::AddExtension (const std::string &ext) {
    // Don't modify the extension if it is already there
    if (Extension() == ext) return;

    // Add the argument as an extension to the current filename
    if (ext.length() > 0) {
      QFileInfo::setFile (iString(Expanded() + "." + ext));
    }
  }

  void Filename::RemoveExtension () {
    QFileInfo::setFile (iString(this->Path() + "/" + this->Basename()));
  }

  void Filename::HighestVersion (){

    CheckVersion();

    int highestVersion = -1;
    Isis::iString highestVersionStr;

    // Get the path of the current file and make sure it exists
    QDir dir((QString)(iString)Path());
    if (!dir.exists()) {
      string msg = "The path [" + Path() + "] does not exist";
      throw Isis::iException::Message(Isis::iException::Io,msg, _FILEINFO_);
    }

    // Find the beginning and end of the "?"s in the versioned filename
    unsigned int start = Name().find_first_of("?");
    unsigned int end = Name().find_last_of("?");
    unsigned int charsAfterVersion = Name().length() - end - 1;


    // Loop through all files in the dir and see if they match our name
    for (unsigned int indx=0; indx < dir.count(); indx++) {

      string file = dir[indx].toStdString();
      bool leftSide = file.substr(0, start) == Name().substr(0, start);
      bool rightSide = ((int)file.length()-(int)charsAfterVersion) >= 0;
      if (rightSide) {
        rightSide = rightSide &&
        (file.substr(file.length()-charsAfterVersion) == Name().substr(end+1));
      }

      if (leftSide && rightSide) {

        Isis::iString version = file.substr(start, file.length()-charsAfterVersion-start);

        if ((version.length() > 0) &&
            (version.find_first_not_of("0123456789") == string::npos) &&
            (version.ToInteger() > highestVersion)) {
          highestVersion = version.ToInteger();
          highestVersionStr = version;
        }
      }
    }

    // Make sure we got a version number
    if (highestVersion == -1) {
      string msg = "No versions available for file [" + Expanded() + "]";
      throw Isis::iException::Message(Isis::iException::Programmer,msg, _FILEINFO_);
    }

    string temp = Path() + "/" + Name().substr(0, start) +
                  highestVersionStr + Name().substr(end+1);
    QFileInfo::setFile(temp.c_str());
  }

  void Filename::NewVersion (){

    CheckVersion();

    // Get the path of the current file and make sure it exists
    QDir dir((QString)(iString)Path());
    if (!dir.exists()) {
      string msg = "The path [" + Path() + "] does not exist";
      throw Isis::iException::Message(Isis::iException::Io,msg, _FILEINFO_);
    }

    // Find the beginning and end of the "?"s in the versioned filename
    unsigned int start = Name().find_first_of("?");
    unsigned int end = Name().find_last_of("?");
    unsigned int charsAfterVersion = Name().length() - end - 1;

    int highestVersion = 0;
    // Loop through all files in the dir and see if they match our name
    for (unsigned int indx=0; indx < dir.count(); indx++) {

      string file = dir[indx].toStdString();
      bool leftSide = file.substr(0, start) == Name().substr(0, start);
      bool rightSide = ((int)file.length()-(int)charsAfterVersion) >= 0;
      if (rightSide) {
        rightSide = rightSide &&
        (file.substr(file.length()-charsAfterVersion) == Name().substr(end+1));
      }

      if (leftSide && rightSide) {

        Isis::iString version = file.substr(start, file.length()-charsAfterVersion-start);

        if ((version.length() > 0) &&
            (version.find_first_not_of("0123456789") == string::npos) &&
            (version.ToInteger() > highestVersion)) {
          highestVersion = version.ToInteger();
        }
      }
    }
    //create a string with the new version number
    Isis::iString newVersion = ++highestVersion;



    //pad each extra "?" with a 0. This maintains the length of the Filename
    //so that "file.???.ext" will be "file.001.ext" instead of "file.1.ext"
    int zeroesNeeded = end - start - newVersion.length();
    for (int i = 0 ; i <= zeroesNeeded; i++){
      newVersion = "0" + newVersion;
    }

    string temp = Path() + "/" + Name().substr(0, start) +
                  newVersion + Name().substr(end+1);
    QFileInfo::setFile(temp.c_str());
  }

  void Filename::MakeDirectory() {

    QDir dir;
    if (!dir.mkdir(iString(Expanded()))) {
      string msg = "Unable to create directory [" + Expanded() + "]";
      throw Isis::iException::Message(Isis::iException::Programmer,
                                      msg, _FILEINFO_);
    }

  }

  void Filename::Temporary (const std::string &name, const std::string &extension) {
    string tempDir;
    tempDir.clear();
    // If the IsisPreference exists use it otherwise just use name as is
    if (!(name.at(0)=='/') && Isis::Preference::Preferences().HasGroup("DataDirectory")) {
      Isis::PvlGroup &dataDir = Isis::Preference::Preferences().FindGroup("DataDirectory");
      if (dataDir.HasKeyword("Temporary")) {
        tempDir = (string) dataDir["Temporary"];
      }
    }

    // Start off by appending "100000" to the name if that file exists
    // increment it and try again
    int add = 100000;
    string tfile;

    do {
      Isis::iString num(add);
      tfile = tempDir + "/" + name + num + "." + extension;
      QFileInfo f(tfile.c_str());
      if (f.exists()) {
        add++;
      }
      else {
        p_original = tfile;
        QFileInfo::setFile (tfile.c_str());
        return;
      }
    } while (add < 1000000);

    string msg = "No temporary files available for [" + name + extension + "]";
    throw Isis::iException::Message(Isis::iException::Io,msg,_FILEINFO_);

  }

  string Filename::Expand (const std::string &file) {

    // Setup an index for searching strings
    std::string::size_type pos, pos2;

    // Work with a tempory copy
    string temp = file;

    // Strip off any cube attributes
    if ((pos = temp.find("+")) != std::string::npos) temp.erase(pos);


    // Expand any $xxxxx into ISIS preferences and environment variables
    // *** NOTE *** This may be very operating system dependent
    string prefVar;
    string var;
    pos = 0;

    // Loop while there are any "$" at the current position or after
    // Some "$" might be skipped if no translation can be found
    while ((pos = temp.find("$", pos)) != std::string::npos) {
      pos2 = temp.find ("/", pos);
      var = temp.substr(pos+1, pos2-pos-1);
      string value;
      value.clear();

      // Find the corresponding Isis Preference if one exists
      if (Isis::Preference::Preferences().HasGroup("DataDirectory")) {
        Isis::PvlGroup &dataDir = Isis::Preference::Preferences().FindGroup("DataDirectory");
        if (dataDir.HasKeyword(var)) {
          value = (string) dataDir[var];
        }
      }

      // Find the corresponding environment variable if one exists
      if (value.length() == 0) {
        char *val;
        val = getenv(var.c_str());
        if (val != NULL) value = val;
      }

      // Replace the $xxxx with the pref/env, but don't move
      // the pointer. We may have replaced one $ for another.
      // Note: May need to put a test for circular replaces in here
      if (value.length() > 0) {
        temp.replace (pos, pos2-pos, value);
      }
      // No pref or env was available so ignore this "$" and move on
      else {
        pos++;
      }
    }
    return temp;
  }

  void Filename::CheckVersion () const {

    // Find the series of "?"
    string name = Expanded();

    std::string::size_type start = name.find_first_of("?");
    std::string::size_type end = name.find_last_of("?");

    // Make sure there was at least one "?" for a version number
    if (start == string::npos || end == string::npos) {
      string msg = "Filename [" + Expanded() +
                   "] does not contain a version sequence";
      throw Isis::iException::Message(Isis::iException::Programmer,msg, _FILEINFO_);
    }

    // Make sure all chars between start and end are "?"
    for (unsigned int pos=start; pos<=end; ++pos) {
      if (name[pos] != '?') {
        string msg = "Only one version sequence is allowed per filename [" +
                     Expanded() + "]";
        throw Isis::iException::Message(Isis::iException::Programmer,msg, _FILEINFO_);
      }
    }
  }
} // end namespace Isis