LibrePCB

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "librarybaseelement.h"

#include "../application.h"
#include "../fileio/versionfile.h"
#include "../serialization/sexpression.h"
#include "librarybaseelementcheck.h"

#include <QtCore>

/*******************************************************************************
 *  Namespace
 ******************************************************************************/
namespace librepcb {

/*******************************************************************************
 *  Constructors / Destructor
 ******************************************************************************/

LibraryBaseElement::LibraryBaseElement(
    bool dirnameMustBeUuid, const QString& shortElementName,
    const QString& longElementName, const Uuid& uuid, const Version& version,
    const QString& author, const ElementName& name_en_US,
    const QString& description_en_US, const QString& keywords_en_US)
  : QObject(nullptr),
    mDirectory(new TransactionalDirectory()),
    mDirectoryNameMustBeUuid(dirnameMustBeUuid),
    mShortElementName(shortElementName),
    mLongElementName(longElementName),
    mLoadingFileDocument(),
    mLoadingFileFormat(qApp->getFileFormatVersion()),
    mUuid(uuid),
    mVersion(version),
    mAuthor(author),
    mCreated(QDateTime::currentDateTime()),
    mIsDeprecated(false),
    mNames(name_en_US),
    mDescriptions(description_en_US),
    mKeywords(keywords_en_US) {
}

LibraryBaseElement::LibraryBaseElement(
    std::unique_ptr<TransactionalDirectory> directory, bool dirnameMustBeUuid,
    const QString& shortElementName, const QString& longElementName)
  : QObject(nullptr),
    mDirectory(std::move(directory)),
    mDirectoryNameMustBeUuid(dirnameMustBeUuid),
    mShortElementName(shortElementName),
    mLongElementName(longElementName),
    mLoadingFileDocument(),
    mLoadingFileFormat(qApp->getFileFormatVersion()),
    mUuid(Uuid::createRandom()),  // just for initialization, will be
                                  // overwritten
    mVersion(Version::fromString(
        "0.1")),  // just for initialization, will be overwritten
    mNames(ElementName(
        "unknown")),  // just for initialization, will be overwritten
    mDescriptions(""),
    mKeywords("") {
  // determine the filename of the version file
  QString versionFileName = ".librepcb-" % mShortElementName;

  // check if the directory is a library element
  if (!mDirectory->fileExists(versionFileName)) {
    throw RuntimeError(
        __FILE__, __LINE__,
        tr("Directory is not a library element of type %1: \"%2\"")
            .arg(mLongElementName, mDirectory->getAbsPath().toNative()));
  }

  // check directory name
  QString dirUuidStr = mDirectory->getAbsPath().getFilename();
  if (mDirectoryNameMustBeUuid && (!Uuid::isValid(dirUuidStr))) {
    throw RuntimeError(__FILE__, __LINE__,
                       tr("Directory name is not a valid UUID: \"%1\"")
                           .arg(mDirectory->getAbsPath().toNative()));
  }

  // read version number from version file
  VersionFile versionFile =
      VersionFile::fromByteArray(mDirectory->read(versionFileName));
  mLoadingFileFormat = versionFile.getVersion();
  if (mLoadingFileFormat > qApp->getAppVersion()) {
    throw RuntimeError(
        __FILE__, __LINE__,
        QString(
            tr("The library element %1 was created with a newer application "
               "version. You need at least LibrePCB version %2 to open it."))
            .arg(mDirectory->getAbsPath().toNative())
            .arg(mLoadingFileFormat.toPrettyStr(3)));
  }

  // open main file
  QString sexprFileName = mLongElementName % ".lp";
  FilePath sexprFilePath = mDirectory->getAbsPath(sexprFileName);
  mLoadingFileDocument =
      SExpression::parse(mDirectory->read(sexprFileName), sexprFilePath);

  // read attributes
  mUuid = deserialize<Uuid>(mLoadingFileDocument.getChild("@0"),
                            mLoadingFileFormat);
  mVersion = deserialize<Version>(mLoadingFileDocument.getChild("version/@0"),
                                  mLoadingFileFormat);
  mAuthor = mLoadingFileDocument.getChild("author/@0").getValue();
  mCreated = deserialize<QDateTime>(mLoadingFileDocument.getChild("created/@0"),
                                    mLoadingFileFormat);
  mIsDeprecated = deserialize<bool>(
      mLoadingFileDocument.getChild("deprecated/@0"), mLoadingFileFormat);

  // read names, descriptions and keywords in all available languages
  mNames = LocalizedNameMap(mLoadingFileDocument, mLoadingFileFormat);
  mDescriptions =
      LocalizedDescriptionMap(mLoadingFileDocument, mLoadingFileFormat);
  mKeywords = LocalizedKeywordsMap(mLoadingFileDocument, mLoadingFileFormat);

  // check if the UUID equals to the directory basename
  if (mDirectoryNameMustBeUuid && (mUuid.toStr() != dirUuidStr)) {
    qDebug() << mUuid.toStr() << "!=" << dirUuidStr;
    throw RuntimeError(
        __FILE__, __LINE__,
        QString(
            tr("UUID mismatch between element directory and main file: \"%1\""))
            .arg(sexprFilePath.toNative()));
  }
}

LibraryBaseElement::~LibraryBaseElement() noexcept {
}

/*******************************************************************************
 *  Getters
 ******************************************************************************/

QStringList LibraryBaseElement::getAllAvailableLocales() const noexcept {
  QStringList list;
  list.append(mNames.keys());
  list.append(mDescriptions.keys());
  list.append(mKeywords.keys());
  list.removeDuplicates();
  list.sort(Qt::CaseSensitive);
  return list;
}

/*******************************************************************************
 *  General Methods
 ******************************************************************************/

LibraryElementCheckMessageList LibraryBaseElement::runChecks() const {
  LibraryBaseElementCheck check(*this);
  return check.runChecks();  // can throw
}

void LibraryBaseElement::save() {
  // save S-Expressions file
  mDirectory->write(
      mLongElementName % ".lp",
      serializeToDomElement("librepcb_" % mLongElementName).toByteArray());

  // save version number file
  mDirectory->write(".librepcb-" % mShortElementName,
                    VersionFile(qApp->getFileFormatVersion()).toByteArray());
}

void LibraryBaseElement::saveTo(TransactionalDirectory& dest) {
  mDirectory->saveTo(dest);  // can throw
  save();  // can throw
}

void LibraryBaseElement::moveTo(TransactionalDirectory& dest) {
  mDirectory->moveTo(dest);  // can throw
  save();  // can throw
}

void LibraryBaseElement::saveIntoParentDirectory(TransactionalDirectory& dest) {
  TransactionalDirectory dir(dest, mUuid.toStr());
  saveTo(dir);  // can throw
}

void LibraryBaseElement::moveIntoParentDirectory(TransactionalDirectory& dest) {
  TransactionalDirectory dir(dest, mUuid.toStr());
  moveTo(dir);  // can throw
}

/*******************************************************************************
 *  Protected Methods
 ******************************************************************************/

void LibraryBaseElement::cleanupAfterLoadingElementFromFile() noexcept {
  mLoadingFileDocument = SExpression();  // destroy the whole DOM tree
}

void LibraryBaseElement::serialize(SExpression& root) const {
  root.appendChild(mUuid);
  root.ensureLineBreak();
  mNames.serialize(root);
  root.ensureLineBreak();
  mDescriptions.serialize(root);
  root.ensureLineBreak();
  mKeywords.serialize(root);
  root.ensureLineBreak();
  root.appendChild("author", mAuthor);
  root.ensureLineBreak();
  root.appendChild("version", mVersion);
  root.ensureLineBreak();
  root.appendChild("created", mCreated);
  root.ensureLineBreak();
  root.appendChild("deprecated", mIsDeprecated);
  root.ensureLineBreak();
}

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace librepcb