/* Copyright 2013 MultiMC Contributors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include #include #include #include #include #include #include #include #include #include "MultiMC.h" #include "logic/lists/InstanceList.h" #include "logic/lists/IconList.h" #include "logic/BaseInstance.h" #include "logic/InstanceFactory.h" #include "logger/QsLog.h" const static int GROUP_FILE_FORMAT_VERSION = 1; InstanceList::InstanceList(const QString &instDir, QObject *parent) : QAbstractListModel(parent), m_instDir(instDir) { } InstanceList::~InstanceList() { saveGroupList(); } int InstanceList::rowCount(const QModelIndex &parent) const { Q_UNUSED(parent); return m_instances.count(); } QModelIndex InstanceList::index(int row, int column, const QModelIndex &parent) const { Q_UNUSED(parent); if (row < 0 || row >= m_instances.size()) return QModelIndex(); return createIndex(row, column, (void *)m_instances.at(row).get()); } QVariant InstanceList::data(const QModelIndex &index, int role) const { if (!index.isValid()) { return QVariant(); } BaseInstance *pdata = static_cast(index.internalPointer()); switch (role) { case InstancePointerRole: { QVariant v = qVariantFromValue((void *)pdata); return v; } case Qt::DisplayRole: { return pdata->name(); } case Qt::ToolTipRole: { return pdata->instanceRoot(); } case Qt::DecorationRole: { QString key = pdata->iconKey(); return MMC->icons()->getIcon(key); } // for now. case KCategorizedSortFilterProxyModel::CategorySortRole: case KCategorizedSortFilterProxyModel::CategoryDisplayRole: { return pdata->group(); } default: break; } return QVariant(); } Qt::ItemFlags InstanceList::flags(const QModelIndex &index) const { Qt::ItemFlags f; if (index.isValid()) { f |= (Qt::ItemIsEnabled | Qt::ItemIsSelectable); } return f; } void InstanceList::groupChanged() { // save the groups. save all of them. saveGroupList(); } void InstanceList::saveGroupList() { QString groupFileName = m_instDir + "/instgroups.json"; QFile groupFile(groupFileName); // if you can't open the file, fail if (!groupFile.open(QIODevice::WriteOnly | QIODevice::Truncate)) { // An error occurred. Ignore it. QLOG_ERROR() << "Failed to read instance group file."; return; } QTextStream out(&groupFile); QMap> groupMap; for (auto instance : m_instances) { QString id = instance->id(); QString group = instance->group(); if (group.isEmpty()) continue; if (!groupMap.count(group)) { QSet set; set.insert(id); groupMap[group] = set; } else { QSet &set = groupMap[group]; set.insert(id); } } QJsonObject toplevel; toplevel.insert("formatVersion", QJsonValue(QString("1"))); QJsonObject groupsArr; for (auto iter = groupMap.begin(); iter != groupMap.end(); iter++) { auto list = iter.value(); auto name = iter.key(); QJsonObject groupObj; QJsonArray instanceArr; groupObj.insert("hidden", QJsonValue(QString("false"))); for (auto item : list) { instanceArr.append(QJsonValue(item)); } groupObj.insert("instances", instanceArr); groupsArr.insert(name, groupObj); } toplevel.insert("groups", groupsArr); QJsonDocument doc(toplevel); groupFile.write(doc.toJson()); groupFile.close(); } void InstanceList::loadGroupList(QMap &groupMap) { QString groupFileName = m_instDir + "/instgroups.json"; // if there's no group file, fail if (!QFileInfo(groupFileName).exists()) return; QFile groupFile(groupFileName); // if you can't open the file, fail if (!groupFile.open(QIODevice::ReadOnly)) { // An error occurred. Ignore it. QLOG_ERROR() << "Failed to read instance group file."; return; } QTextStream in(&groupFile); QString jsonStr = in.readAll(); groupFile.close(); QJsonParseError error; QJsonDocument jsonDoc = QJsonDocument::fromJson(jsonStr.toUtf8(), &error); // if the json was bad, fail if (error.error != QJsonParseError::NoError) { QLOG_ERROR() << QString("Failed to parse instance group file: %1 at offset %2") .arg(error.errorString(), QString::number(error.offset)) .toUtf8(); return; } // if the root of the json wasn't an object, fail if (!jsonDoc.isObject()) { qWarning("Invalid group file. Root entry should be an object."); return; } QJsonObject rootObj = jsonDoc.object(); // Make sure the format version matches, otherwise fail. if (rootObj.value("formatVersion").toVariant().toInt() != GROUP_FILE_FORMAT_VERSION) return; // Get the groups. if it's not an object, fail if (!rootObj.value("groups").isObject()) { qWarning("Invalid group list JSON: 'groups' should be an object."); return; } // Iterate through all the groups. QJsonObject groupMapping = rootObj.value("groups").toObject(); for (QJsonObject::iterator iter = groupMapping.begin(); iter != groupMapping.end(); iter++) { QString groupName = iter.key(); // If not an object, complain and skip to the next one. if (!iter.value().isObject()) { qWarning(QString("Group '%1' in the group list should " "be an object.") .arg(groupName) .toUtf8()); continue; } QJsonObject groupObj = iter.value().toObject(); if (!groupObj.value("instances").isArray()) { qWarning(QString("Group '%1' in the group list is invalid. " "It should contain an array " "called 'instances'.") .arg(groupName) .toUtf8()); continue; } // Iterate through the list of instances in the group. QJsonArray instancesArray = groupObj.value("instances").toArray(); for (QJsonArray::iterator iter2 = instancesArray.begin(); iter2 != instancesArray.end(); iter2++) { groupMap[(*iter2).toString()] = groupName; } } } InstanceList::InstListError InstanceList::loadList() { // load the instance groups QMap groupMap; loadGroupList(groupMap); beginResetModel(); m_instances.clear(); QDir dir(m_instDir); QDirIterator iter(m_instDir, QDir::Dirs | QDir::NoDot | QDir::NoDotDot | QDir::Readable, QDirIterator::FollowSymlinks); while (iter.hasNext()) { QString subDir = iter.next(); if (!QFileInfo(PathCombine(subDir, "instance.cfg")).exists()) continue; BaseInstance *instPtr = NULL; auto &loader = InstanceFactory::get(); auto error = loader.loadInstance(instPtr, subDir); switch (error) { case InstanceFactory::NoLoadError: break; case InstanceFactory::NotAnInstance: break; } if (error != InstanceFactory::NoLoadError && error != InstanceFactory::NotAnInstance) { QString errorMsg = QString("Failed to load instance %1: ") .arg(QFileInfo(subDir).baseName()) .toUtf8(); switch (error) { default: errorMsg += QString("Unknown instance loader error %1").arg(error); break; } QLOG_ERROR() << errorMsg.toUtf8(); } else if (!instPtr) { QLOG_ERROR() << QString("Error loading instance %1. Instance loader returned null.") .arg(QFileInfo(subDir).baseName()) .toUtf8(); } else { std::shared_ptr inst(instPtr); auto iter = groupMap.find(inst->id()); if (iter != groupMap.end()) { inst->setGroupInitial((*iter)); } QLOG_INFO() << "Loaded instance " << inst->name(); inst->setParent(this); m_instances.append(inst); connect(instPtr, SIGNAL(propertiesChanged(BaseInstance *)), this, SLOT(propertiesChanged(BaseInstance *))); connect(instPtr, SIGNAL(groupChanged()), this, SLOT(groupChanged())); connect(instPtr, SIGNAL(nuked(BaseInstance *)), this, SLOT(instanceNuked(BaseInstance *))); } } endResetModel(); emit dataIsInvalid(); return NoError; } /// Clear all instances. Triggers notifications. void InstanceList::clear() { beginResetModel(); saveGroupList(); m_instances.clear(); endResetModel(); emit dataIsInvalid(); } void InstanceList::on_InstFolderChanged(const Setting &setting, QVariant value) { m_instDir = value.toString(); loadList(); } /// Add an instance. Triggers notifications, returns the new index int InstanceList::add(InstancePtr t) { beginInsertRows(QModelIndex(), m_instances.size(), m_instances.size()); m_instances.append(t); t->setParent(this); connect(t.get(), SIGNAL(propertiesChanged(BaseInstance *)), this, SLOT(propertiesChanged(BaseInstance *))); connect(t.get(), SIGNAL(groupChanged()), this, SLOT(groupChanged())); connect(t.get(), SIGNAL(nuked(BaseInstance *)), this, SLOT(instanceNuked(BaseInstance *))); endInsertRows(); return count() - 1; } InstancePtr InstanceList::getInstanceById(QString instId) { QListIterator iter(m_instances); InstancePtr inst; while (iter.hasNext()) { inst = iter.next(); if (inst->id() == instId) break; } if (inst->id() != instId) return InstancePtr(); else return iter.peekPrevious(); } int InstanceList::getInstIndex(BaseInstance *inst) { for (int i = 0; i < m_instances.count(); i++) { if (inst == m_instances[i].get()) { return i; } } return -1; } void InstanceList::instanceNuked(BaseInstance *inst) { int i = getInstIndex(inst); if (i != -1) { beginRemoveRows(QModelIndex(), i, i); m_instances.removeAt(i); endRemoveRows(); } } void InstanceList::propertiesChanged(BaseInstance *inst) { int i = getInstIndex(inst); if (i != -1) { emit dataChanged(index(i), index(i)); } } InstanceProxyModel::InstanceProxyModel(QObject *parent) : KCategorizedSortFilterProxyModel(parent) { // disable since by default we are globally sorting by date: setCategorizedModel(true); } bool InstanceProxyModel::subSortLessThan(const QModelIndex &left, const QModelIndex &right) const { BaseInstance *pdataLeft = static_cast(left.internalPointer()); BaseInstance *pdataRight = static_cast(right.internalPointer()); QString sortMode = MMC->settings()->get("InstSortMode").toString(); if (sortMode == "LastLaunch") { return pdataLeft->lastLaunch() > pdataRight->lastLaunch(); } else { return QString::localeAwareCompare(pdataLeft->name(), pdataRight->name()) < 0; } }