mastodonpp/include/instance.hpp

208 lines
5.0 KiB
C++
Raw Normal View History

2020-01-03 12:42:10 +01:00
/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_INSTANCE_HPP
#define MASTODONPP_INSTANCE_HPP
#include "curl_wrapper.hpp"
2020-01-11 19:21:34 +01:00
#include "answer.hpp"
2020-01-04 11:38:06 +01:00
2020-01-05 11:06:50 +01:00
#include <cstdint>
2020-01-03 12:42:10 +01:00
#include <string>
#include <string_view>
#include <utility>
2020-01-11 20:05:11 +01:00
#include <vector>
2020-01-03 12:42:10 +01:00
namespace mastodonpp
{
2020-01-05 11:06:50 +01:00
using std::uint64_t;
2020-01-03 12:42:10 +01:00
using std::string;
using std::string_view;
using std::move;
2020-01-11 20:05:11 +01:00
using std::vector;
2020-01-03 12:42:10 +01:00
2020-01-03 13:05:00 +01:00
/*!
* @brief Holds the access data of an instance.
2020-01-03 13:05:00 +01:00
*
* @since 0.1.0
2020-01-04 12:04:47 +01:00
*
* @headerfile instance.hpp mastodonpp/instance.hpp
2020-01-03 13:05:00 +01:00
*/
class Instance : public CURLWrapper
2020-01-03 12:42:10 +01:00
{
public:
/*!
* @brief Construct a new Instance object.
*
* @param hostname The hostname of the instance.
2020-01-03 12:42:10 +01:00
* @param access_token Your access token.
*
* @since 0.1.0
*/
2020-01-08 17:38:27 +01:00
explicit Instance(string_view hostname, string_view access_token);
/*!
* @brief Returns the hostname.
*
* @since 0.1.0
*/
[[nodiscard]]
2020-01-12 15:27:11 +01:00
inline string_view get_hostname() const noexcept
{
return _hostname;
}
/*!
* @brief Returns the base URI.
*
* The base URI is https://” + the hostname.
*
* @since 0.1.0
*/
[[nodiscard]]
2020-01-12 15:27:11 +01:00
inline string_view get_baseuri() const noexcept
{
return _baseuri;
}
/*!
* @brief Returns the access token.
*
* @since 0.1.0
*/
[[nodiscard]]
2020-01-12 15:27:11 +01:00
inline string_view get_access_token() const noexcept
{
return _access_token;
}
/*!
* @brief Set OAuth 2.0 Bearer Access Token.
*
* Sets also the access token for all Connection%s that are initialized
* with this Instance afterwards.
*
* @since 0.1.0
*/
inline void set_access_token(string access_token)
{
_access_token = move(access_token);
}
2020-01-05 11:06:50 +01:00
/*!
* @brief Returns the maximum number of characters per post.
*
* Queries `/api/v1/instance` for `max_toot_chars'. If the instance doesn't
* support it, the limit is assumed to be 500.
*
2020-01-11 19:21:34 +01:00
* After the first call, the value is saved internally. Subsequent calls
* return the saved value.
*
2020-01-05 11:06:50 +01:00
* @since 0.1.0
*/
[[nodiscard]]
2020-01-12 15:27:11 +01:00
uint64_t get_max_chars() noexcept;
2020-01-05 11:06:50 +01:00
2020-01-09 11:23:15 +01:00
/*! @copydoc CURLWrapper::set_proxy(string_view)
*
* Sets also the proxy for all Connection%s that are initialized with this
* Instance afterwards.
*/
void set_proxy(const string_view proxy)
{
_proxy = proxy;
CURLWrapper::set_proxy(proxy);
}
/*!
* @brief Returns the proxy string that was previously set.
*
* Does not return the proxy if it was set from an environment variable.
*
* @since 0.1.0
*/
[[nodiscard]]
2020-01-12 15:27:11 +01:00
string_view get_proxy() const noexcept
2020-01-09 11:23:15 +01:00
{
return _proxy;
}
2020-01-11 19:21:34 +01:00
/*!
* @brief Returns the NodeInfo of the instance.
*
* Attempts to download the [NodeInfo]
* (https://nodeinfo.diaspora.software/protocol.html) of the instance and
* returns it. Not every instance has it.
*
* @since 0.3.0
*/
[[nodiscard]]
answer_type get_nodeinfo();
2020-01-11 20:05:11 +01:00
/*!
* @brief Returns the allowed mime types for statuses.
*
* Extracts `metadata.postFormats` from NodeInfo. If none can be found,
* returns `{"text/plain"}`.
*
* After the first call, the value is saved internally. Subsequent calls
* return the saved value.
*
* @since 0.3.0
*/
2020-01-12 15:27:11 +01:00
vector<string> get_post_formats() noexcept;
2020-01-11 20:05:11 +01:00
2020-01-12 13:37:53 +01:00
/*!
* @brief Set path to Certificate Authority (CA) bundle.
*
* Sets also the CA info for all Connection%s that are initialized with
* this Instance afterwards.
*
* @since 0.2.1
*/
void set_cainfo(string_view path)
{
_cainfo = path;
CURLWrapper::set_cainfo(path);
}
/*!
* @brief Returns the cainfo path that was previously set.
*
* This is used when initializing a Connection.
*
* @since 0.2.1
*/
2020-01-12 15:27:11 +01:00
string_view get_cainfo() const noexcept
2020-01-12 13:37:53 +01:00
{
return _cainfo;
}
2020-01-03 12:42:10 +01:00
private:
const string _hostname;
const string _baseuri;
2020-01-03 12:42:10 +01:00
string _access_token;
2020-01-05 11:06:50 +01:00
uint64_t _max_chars;
2020-01-09 11:23:15 +01:00
string _proxy;
2020-01-11 20:05:11 +01:00
vector<string> _post_formats;
2020-01-12 13:37:53 +01:00
string _cainfo;
2020-01-03 12:42:10 +01:00
};
} // namespace mastodonpp
#endif // MASTODONPP_INSTANCE_HPP