PrismLauncher/launcher/net/HttpMetaCache.h

142 lines
4.6 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (c) 2022 flowln <flowlnlnln@gmail.com>
*
* 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, version 3.
*
* 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 <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 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.
*/
2013-09-06 20:58:51 +01:00
#pragma once
#include <QMap>
#include <QString>
#include <QTimer>
#include <memory>
class HttpMetaCache;
2013-09-06 20:58:51 +01:00
class MetaEntry {
friend class HttpMetaCache;
protected:
MetaEntry() = default;
public:
auto isStale() -> bool { return m_stale; }
void setStale(bool stale) { m_stale = stale; }
auto getFullPath() -> QString;
auto getRemoteChangedTimestamp() -> QString { return m_remote_changed_timestamp; }
void setRemoteChangedTimestamp(QString remote_changed_timestamp) { m_remote_changed_timestamp = remote_changed_timestamp; }
void setLocalChangedTimestamp(qint64 timestamp) { m_local_changed_timestamp = timestamp; }
auto getETag() -> QString { return m_etag; }
void setETag(QString etag) { m_etag = etag; }
auto getMD5Sum() -> QString { return m_md5sum; }
void setMD5Sum(QString md5sum) { m_md5sum = md5sum; }
/* Whether the entry expires after some time (false) or not (true). */
void makeEternal(bool eternal) { m_is_eternal = eternal; }
[[nodiscard]] bool isEternal() const { return m_is_eternal; }
auto getCurrentAge() -> qint64 { return m_current_age; }
void setCurrentAge(qint64 age) { m_current_age = age; }
auto getMaximumAge() -> qint64 { return m_max_age; }
void setMaximumAge(qint64 age) { m_max_age = age; }
bool isExpired(qint64 offset) { return !m_is_eternal && (m_current_age >= m_max_age - offset); };
protected:
QString m_baseId;
QString m_basePath;
QString m_relativePath;
QString m_md5sum;
QString m_etag;
qint64 m_local_changed_timestamp = 0;
QString m_remote_changed_timestamp; // QString for now, RFC 2822 encoded time
qint64 m_current_age = 0;
qint64 m_max_age = 0;
bool m_is_eternal = false;
bool m_stale = true;
2013-09-06 20:58:51 +01:00
};
using MetaEntryPtr = std::shared_ptr<MetaEntry>;
2013-09-06 20:58:51 +01:00
class HttpMetaCache : public QObject {
2018-07-15 13:51:05 +01:00
Q_OBJECT
public:
2018-07-15 13:51:05 +01:00
// supply path to the cache index file
HttpMetaCache(QString path = QString());
~HttpMetaCache() override;
2013-09-22 13:00:37 +01:00
2018-07-15 13:51:05 +01:00
// get the entry solely from the cache
// you probably don't want this, unless you have some specific caching needs.
auto getEntry(QString base, QString resource_path) -> MetaEntryPtr;
2013-09-22 13:00:37 +01:00
2018-07-15 13:51:05 +01:00
// get the entry from cache and verify that it isn't stale (within reason)
auto resolveEntry(QString base, QString resource_path, QString expected_etag = QString()) -> MetaEntryPtr;
2013-09-22 13:00:37 +01:00
2018-07-15 13:51:05 +01:00
// add a previously resolved stale entry
auto updateEntry(MetaEntryPtr stale_entry) -> bool;
2013-09-22 13:00:37 +01:00
2018-07-15 13:51:05 +01:00
// evict selected entry from cache
auto evictEntry(MetaEntryPtr entry) -> bool;
void evictAll();
2018-07-15 13:51:05 +01:00
void addBase(QString base, QString base_root);
2013-09-22 13:00:37 +01:00
2018-07-15 13:51:05 +01:00
// (re)start a timer that calls SaveNow later.
void SaveEventually();
void Load();
auto getBasePath(QString base) -> QString;
public slots:
2018-07-15 13:51:05 +01:00
void SaveNow();
2013-09-22 13:00:37 +01:00
private:
2018-07-15 13:51:05 +01:00
// create a new stale entry, given the parameters
auto staleEntry(QString base, QString resource_path) -> MetaEntryPtr;
struct EntryMap {
2018-07-15 13:51:05 +01:00
QString base_path;
QMap<QString, MetaEntryPtr> entry_list;
};
2018-07-15 13:51:05 +01:00
QMap<QString, EntryMap> m_entries;
QString m_index_file;
QTimer saveBatchingTimer;
};