cdb240f3d4
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75
72 lines
2.4 KiB
C++
72 lines
2.4 KiB
C++
// SPDX-FileCopyrightText: 2017 Citra Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
namespace WebService {
|
|
|
|
struct WebResult;
|
|
|
|
class Client {
|
|
public:
|
|
Client(std::string host, std::string username, std::string token);
|
|
~Client();
|
|
|
|
/**
|
|
* Posts JSON to the specified path.
|
|
* @param path the URL segment after the host address.
|
|
* @param data String of JSON data to use for the body of the POST request.
|
|
* @param allow_anonymous If true, allow anonymous unauthenticated requests.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult PostJson(const std::string& path, const std::string& data, bool allow_anonymous);
|
|
|
|
/**
|
|
* Gets JSON from the specified path.
|
|
* @param path the URL segment after the host address.
|
|
* @param allow_anonymous If true, allow anonymous unauthenticated requests.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult GetJson(const std::string& path, bool allow_anonymous);
|
|
|
|
/**
|
|
* Deletes JSON to the specified path.
|
|
* @param path the URL segment after the host address.
|
|
* @param data String of JSON data to use for the body of the DELETE request.
|
|
* @param allow_anonymous If true, allow anonymous unauthenticated requests.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult DeleteJson(const std::string& path, const std::string& data, bool allow_anonymous);
|
|
|
|
/**
|
|
* Gets a plain string from the specified path.
|
|
* @param path the URL segment after the host address.
|
|
* @param allow_anonymous If true, allow anonymous unauthenticated requests.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult GetPlain(const std::string& path, bool allow_anonymous);
|
|
|
|
/**
|
|
* Gets an PNG image from the specified path.
|
|
* @param path the URL segment after the host address.
|
|
* @param allow_anonymous If true, allow anonymous unauthenticated requests.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult GetImage(const std::string& path, bool allow_anonymous);
|
|
|
|
/**
|
|
* Requests an external JWT for the specific audience provided.
|
|
* @param audience the audience of the JWT requested.
|
|
* @return the result of the request.
|
|
*/
|
|
WebResult GetExternalJWT(const std::string& audience);
|
|
|
|
private:
|
|
struct Impl;
|
|
std::unique_ptr<Impl> impl;
|
|
};
|
|
|
|
} // namespace WebService
|