strawberry/src/utilities/strutils.cpp

/*
 * Strawberry Music Player
 * Copyright 2010, David Sansome <me@davidsansome.com>
 * Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
 *
 * Strawberry 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.
 *
 * Strawberry 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 Strawberry.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <QString>
#include <QStringList>
#include <QRegularExpression>
#include <QMetaObject>
#include <QMetaEnum>

#include "strutils.h"
#include "core/song.h"

using namespace Qt::Literals::StringLiterals;

namespace Utilities {

QString PrettySize(const quint64 bytes) {

  QString ret;

  if (bytes > 0LL) {
    if (bytes <= 1000LL) {
      ret = QString::number(bytes) + " bytes"_L1;
    }
    else if (bytes <= 1000LL * 1000LL) {
      ret = QString::asprintf("%.1f KB", static_cast<float>(bytes) / 1000.0F);
    }
    else if (bytes <= 1000LL * 1000LL * 1000LL) {
      ret = QString::asprintf("%.1f MB", static_cast<float>(bytes) / (1000.0F * 1000.0F));
    }
    else {
      ret = QString::asprintf("%.1f GB", static_cast<float>(bytes) / (1000.0F * 1000.0F * 1000.0F));
    }
  }
  return ret;

}

QString PrettySize(const QSize size) {
  return QString::number(size.width()) + QLatin1Char('x') + QString::number(size.height());
}

QString PathWithoutFilenameExtension(const QString &filename) {
  if (filename.section(u'/', -1, -1).contains(u'.')) return filename.section(u'.', 0, -2);
  return filename;
}

QString FiddleFileExtension(const QString &filename, const QString &new_extension) {
  return PathWithoutFilenameExtension(filename) + QLatin1Char('.') + new_extension;
}

const char *EnumToString(const QMetaObject &meta, const char *name, const int value) {

  int index = meta.indexOfEnumerator(name);
  if (index == -1) return "[UnknownEnum]";
  QMetaEnum metaenum = meta.enumerator(index);
  const char *result = metaenum.valueToKey(value);
  if (!result) return "[UnknownEnumValue]";
  return result;

}

QStringList Prepend(const QString &text, const QStringList &list) {

  QStringList ret(list);
  for (int i = 0; i < ret.count(); ++i) ret[i].prepend(text);
  return ret;

}

QStringList Updateify(const QStringList &list) {

  QStringList ret(list);
  for (int i = 0; i < ret.count(); ++i) ret[i].prepend(ret[i] + " = :"_L1);
  return ret;

}

QString DecodeHtmlEntities(const QString &text) {

  QString copy(text);
  copy.replace("&amp;"_L1, "&"_L1)
      .replace("&#38;"_L1, "&"_L1)
      .replace("&quot;"_L1, "\""_L1)
      .replace("&#34;"_L1, "\""_L1)
      .replace("&apos;"_L1, "'"_L1)
      .replace("&#39;"_L1, "'"_L1)
      .replace("&lt;"_L1, "<"_L1)
      .replace("&#60;"_L1, "<"_L1)
      .replace("&gt;"_L1, ">"_L1)
      .replace("&#62;"_L1, ">"_L1)
      .replace("&#x27;"_L1, "'"_L1);

  return copy;

}

QString ReplaceMessage(const QString &message, const Song &song, const QString &newline, const bool html_escaped) {

  static const QRegularExpression variable_replacer(u"[%][a-z]+[%]"_s);
  QString copy(message);

  // Replace the first line
  qint64 pos = 0;
  QRegularExpressionMatch match;
  for (match = variable_replacer.match(message, pos); match.hasMatch(); match = variable_replacer.match(message, pos)) {
    pos = match.capturedStart();
    QStringList captured = match.capturedTexts();
    copy.replace(captured[0], ReplaceVariable(captured[0], song, newline, html_escaped));
    pos += match.capturedLength();
  }

  static const QRegularExpression regexp(u" - (>|$)"_s);
  qint64 index_of = copy.indexOf(regexp);
  if (index_of >= 0) copy = copy.remove(index_of, 3);

  return copy;

}

QString ReplaceVariable(const QString &variable, const Song &song, const QString &newline, const bool html_escaped) {

  QString value = variable;

  if (variable == "%title%"_L1) {
    value = song.PrettyTitle();
  }
  else if (variable == "%album%"_L1) {
    value = song.album();
  }
  else if (variable == "%artist%"_L1) {
    value = song.artist();
  }
  else if (variable == "%albumartist%"_L1) {
    value = song.effective_albumartist();
  }
  else if (variable == "%track%"_L1) {
    value.setNum(song.track());
  }
  else if (variable == "%disc%"_L1) {
    value.setNum(song.disc());
  }
  else if (variable == "%year%"_L1) {
    value = song.PrettyYear();
  }
  else if (variable == "%originalyear%"_L1) {
    value = song.PrettyOriginalYear();
  }
  else if (variable == "%genre%"_L1) {
    value = song.genre();
  }
  else if (variable == "%composer%"_L1) {
    value = song.composer();
  }
  else if (variable == "%performer%"_L1) {
    value = song.performer();
  }
  else if (variable == "%grouping%"_L1) {
    value = song.grouping();
  }
  else if (variable == "%length%"_L1) {
    value = song.PrettyLength();
  }
  else if (variable == "%filename%"_L1) {
    value = song.basefilename();
  }
  else if (variable == "%url%"_L1) {
    value = song.url().toString();
  }
  else if (variable == "%playcount%"_L1) {
    value.setNum(song.playcount());
  }
  else if (variable == "%skipcount%"_L1) {
    value.setNum(song.skipcount());
  }
  else if (variable == "%rating%"_L1) {
    value = song.PrettyRating();
  }
  else if (variable == "%newline%"_L1) {
    return QString(newline);  // No HTML escaping, return immediately.
  }

  if (html_escaped) {
    value = value.toHtmlEscaped();
  }
  return value;

}

QString StringListToHTML(const QStringList &string_list) {

  QString html;
  for (const QString &string : string_list) {
    html += string + "<br />"_L1;
  }

  return html;

}

}  // namespace Utilities