Compare commits
44 Commits
Author | SHA1 | Date |
---|---|---|
tastytea | 87760bba2d | |
tastytea | 5275c1d9e3 | |
tastytea | 2ad4b46551 | |
tastytea | 59f0302281 | |
tastytea | 344abb6a29 | |
tastytea | 86f5c45172 | |
tastytea | 5e2bfe13d4 | |
tastytea | 4ded077988 | |
tastytea | a80b4237cb | |
tastytea | 020559841c | |
tastytea | cbf3f3f3ac | |
tastytea | 91373abfc5 | |
tastytea | f0c00ad825 | |
tastytea | 4d0cebdec2 | |
tastytea | 568ac5bd4f | |
tastytea | baf3e207cf | |
tastytea | c47aac8dd2 | |
tastytea | f448e72df1 | |
tastytea | a61186b73c | |
tastytea | 838dbb11b9 | |
tastytea | 2d113abff6 | |
tastytea | f98f7569dc | |
tastytea | 212b0a18f3 | |
tastytea | cdb525205b | |
tastytea | 438bc360cd | |
tastytea | 0010fbff7c | |
tastytea | 8481575705 | |
tastytea | 3955cd95a1 | |
tastytea | 4de5c4e685 | |
tastytea | 75633bdb45 | |
tastytea | 53e39a04f3 | |
tastytea | 1d4139cf0e | |
tastytea | 8d59075de8 | |
tastytea | ebabe2de23 | |
tastytea | eb897eddae | |
tastytea | dfd32e5bbf | |
tastytea | 99a843e0a2 | |
tastytea | 39c690861e | |
tastytea | 3f3d21324b | |
tastytea | 5778fe1ad2 | |
tastytea | cf78a2e43e | |
tastytea | 38f795df26 | |
tastytea | 70d3bcfb70 | |
tastytea | 2554779759 |
75
.drone.yml
75
.drone.yml
|
@ -16,21 +16,14 @@ steps:
|
||||||
- name: download mastodonpp for buster
|
- name: download mastodonpp for buster
|
||||||
image: plugins/download
|
image: plugins/download
|
||||||
settings:
|
settings:
|
||||||
source: https://schlomp.space/tastytea/mastodonpp/releases/download/0.4.0/libmastodonpp_0.4.0-0_amd64_buster.deb
|
source: https://schlomp.space/tastytea/mastodonpp/releases/download/0.5.7/libmastodonpp_0.5.7-0_amd64_buster.deb
|
||||||
destination: mastodonpp_buster.deb
|
destination: mastodonpp_buster.deb
|
||||||
|
|
||||||
# - name: download mastodonpp for bionic
|
- name: download mastodonpp for bionic
|
||||||
# image: plugins/download
|
|
||||||
# settings:
|
|
||||||
# source: https://schlomp.space/tastytea/mastodonpp/releases/download/0.4.0/libmastodonpp_0.4.0-0_amd64_bionic.deb
|
|
||||||
# destination: mastodonpp_bionic.deb
|
|
||||||
|
|
||||||
# Workaround until the debian packages are fixed.
|
|
||||||
- name: download restclient-cpp source
|
|
||||||
image: plugins/download
|
image: plugins/download
|
||||||
settings:
|
settings:
|
||||||
source: https://github.com/mrtazz/restclient-cpp/archive/0.5.1.tar.gz
|
source: https://schlomp.space/tastytea/mastodonpp/releases/download/0.5.7/libmastodonpp_0.5.7-0_amd64_bionic.deb
|
||||||
destination: restclient-cpp.tar.gz
|
destination: mastodonpp_bionic.deb
|
||||||
|
|
||||||
- name: GCC 8 on Debian buster
|
- name: GCC 8 on Debian buster
|
||||||
image: debian:buster-slim
|
image: debian:buster-slim
|
||||||
|
@ -44,19 +37,9 @@ steps:
|
||||||
- rm /etc/apt/apt.conf.d/docker-clean
|
- rm /etc/apt/apt.conf.d/docker-clean
|
||||||
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
||||||
- apt-get update -q
|
- apt-get update -q
|
||||||
- echo "deb https://packagecloud.io/mrtazz/restclient-cpp/debian/ buster main" > /etc/apt/sources.list.d/restclient-cpp.list
|
|
||||||
- apt-get install -qq debian-archive-keyring curl gnupg apt-transport-https
|
|
||||||
- curl -L https://packagecloud.io/mrtazz/restclient-cpp/gpgkey | apt-key add -
|
|
||||||
- apt-get update -q
|
|
||||||
- apt-get install -qq build-essential cmake pkg-config asciidoc
|
- apt-get install -qq build-essential cmake pkg-config asciidoc
|
||||||
- apt-get install -qq libboost-filesystem-dev libboost-log-dev libboost-regex-dev libjsoncpp-dev catch libcurl4-openssl-dev restclient-cpp
|
- apt-get install -qq libboost-filesystem-dev libboost-log-dev libboost-regex-dev libjsoncpp-dev catch libcurl4-openssl-dev
|
||||||
- apt-get -qq install ./mastodonpp_buster.deb
|
- apt-get -qq install ./mastodonpp_buster.deb
|
||||||
- tar -xf restclient-cpp.tar.gz
|
|
||||||
- cd restclient-cpp-*
|
|
||||||
- cmake -DCMAKE_INSTALL_PREFIX=/usr .
|
|
||||||
- cmake --build .
|
|
||||||
- make install
|
|
||||||
- cd ..
|
|
||||||
- rm -rf build && mkdir -p build && cd build
|
- rm -rf build && mkdir -p build && cd build
|
||||||
- cmake ..
|
- cmake ..
|
||||||
- make VERBOSE=1
|
- make VERBOSE=1
|
||||||
|
@ -65,32 +48,28 @@ steps:
|
||||||
- name: debian-package-cache
|
- name: debian-package-cache
|
||||||
path: /var/cache/apt/archives
|
path: /var/cache/apt/archives
|
||||||
|
|
||||||
# - name: GCC 7 on Ubuntu bionic
|
- name: GCC 7 on Ubuntu bionic
|
||||||
# image: ubuntu:bionic
|
image: ubuntu:bionic
|
||||||
# pull: always
|
pull: always
|
||||||
# environment:
|
environment:
|
||||||
# CXX: g++-7
|
CXX: g++-7
|
||||||
# CXXFLAGS: -pipe -O2
|
CXXFLAGS: -pipe -O2
|
||||||
# DEBIAN_FRONTEND: noninteractive
|
DEBIAN_FRONTEND: noninteractive
|
||||||
# LANG: C.utf8
|
LANG: C.utf8
|
||||||
# commands:
|
commands:
|
||||||
# - rm /etc/apt/apt.conf.d/docker-clean
|
- rm /etc/apt/apt.conf.d/docker-clean
|
||||||
# - alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
||||||
# - apt-get update -q
|
- apt-get update -q
|
||||||
# - echo "deb https://packagecloud.io/mrtazz/restclient-cpp/ubuntu/ bionic main" > /etc/apt/sources.list.d/restclient-cpp.list
|
- apt-get install -qq build-essential cmake pkg-config asciidoc
|
||||||
# - apt-get install -qq curl gnupg apt-transport-https
|
- apt-get install -qq libboost-filesystem-dev libboost-log-dev libboost-regex-dev libjsoncpp-dev catch libcurl4-openssl-dev
|
||||||
# - curl -L https://packagecloud.io/mrtazz/restclient-cpp/gpgkey | apt-key add -
|
- apt-get -qq install ./mastodonpp_bionic.deb
|
||||||
# - apt-get update -q
|
- rm -rf build && mkdir -p build && cd build
|
||||||
# - apt-get install -qq build-essential cmake pkg-config asciidoc
|
- cmake ..
|
||||||
# - apt-get install -qq libboost-filesystem-dev libboost-log-dev libboost-regex-dev libjsoncpp-dev catch libcurl4-openssl-dev restclient-cpp
|
- make VERBOSE=1
|
||||||
# - apt-get -qq install ./mastodonpp_bionic.deb
|
- make install DESTDIR=install
|
||||||
# - rm -rf build && mkdir -p build && cd build
|
volumes:
|
||||||
# - cmake ..
|
- name: debian-package-cache
|
||||||
# - make VERBOSE=1
|
path: /var/cache/apt/archives
|
||||||
# - make install DESTDIR=install
|
|
||||||
# volumes:
|
|
||||||
# - name: debian-package-cache
|
|
||||||
# path: /var/cache/apt/archives
|
|
||||||
|
|
||||||
- name: notify
|
- name: notify
|
||||||
image: drillster/drone-email
|
image: drillster/drone-email
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Support version 3.9 and above, but use policy settings up to 3.14.
|
# Support version 3.9 and above, but use policy settings up to 3.14.
|
||||||
# 3.9 is needed for project description.
|
# 3.9 is needed for project description.
|
||||||
cmake_minimum_required(VERSION 3.9...3.14)
|
cmake_minimum_required(VERSION 3.9...3.17)
|
||||||
# Ranges are supported from 3.12, set policy to current for < 3.12.
|
# Ranges are supported from 3.12, set policy to current for < 3.12.
|
||||||
if(${CMAKE_VERSION} VERSION_LESS 3.12)
|
if(${CMAKE_VERSION} VERSION_LESS 3.12)
|
||||||
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
|
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
|
||||||
|
@ -8,17 +8,21 @@ endif()
|
||||||
|
|
||||||
# Global build options.
|
# Global build options.
|
||||||
set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.")
|
set(CMAKE_BUILD_TYPE "Release" CACHE STRING "The type of build.")
|
||||||
option(BUILD_SHARED_LIBS "Build shared libraries." YES)
|
option(BUILD_SHARED_LIBS "Build shared libraries." YES) # Needed for boost.
|
||||||
|
|
||||||
project (mastorss
|
project (mastorss
|
||||||
VERSION 0.12.0
|
VERSION 0.13.1
|
||||||
DESCRIPTION "Another RSS to Mastodon bot."
|
DESCRIPTION "Another RSS to Mastodon bot."
|
||||||
LANGUAGES CXX)
|
LANGUAGES CXX)
|
||||||
|
|
||||||
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
|
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
|
||||||
|
include(GNUInstallDirs)
|
||||||
|
|
||||||
# Project build options.
|
# Project build options.
|
||||||
option(WITH_MAN "Compile and install manpage." YES)
|
option(WITH_MAN "Compile and install manpage." YES)
|
||||||
|
option(WITH_COMPLETIONS "Install Zsh completions." YES)
|
||||||
|
set(ZSH_COMPLETION_DIR "${CMAKE_INSTALL_DATAROOTDIR}/zsh/site-functions"
|
||||||
|
CACHE STRING "Installation directory for Zsh completions.")
|
||||||
|
|
||||||
set(CMAKE_CXX_STANDARD 17)
|
set(CMAKE_CXX_STANDARD 17)
|
||||||
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||||
|
@ -34,6 +38,10 @@ if(WITH_MAN)
|
||||||
add_subdirectory(man)
|
add_subdirectory(man)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
if(WITH_COMPLETIONS)
|
||||||
|
add_subdirectory(completions)
|
||||||
|
endif()
|
||||||
|
|
||||||
install(FILES watchwords.json
|
install(FILES watchwords.json
|
||||||
DESTINATION "${CMAKE_INSTALL_DATADIR}/mastorss")
|
DESTINATION "${CMAKE_INSTALL_DATADIR}/mastorss")
|
||||||
|
|
||||||
|
|
52
README.adoc
52
README.adoc
|
@ -11,41 +11,61 @@
|
||||||
:uri-boost: https://www.boost.org/
|
:uri-boost: https://www.boost.org/
|
||||||
:uri-mastodonpp: https://schlomp.space/tastytea/mastodonpp
|
:uri-mastodonpp: https://schlomp.space/tastytea/mastodonpp
|
||||||
:uri-jsoncpp: https://github.com/open-source-parsers/jsoncpp
|
:uri-jsoncpp: https://github.com/open-source-parsers/jsoncpp
|
||||||
:uri-restclient-cpp: http://code.mrtazz.com/restclient-cpp/
|
:uri-libcurl: https://curl.haxx.se/libcurl/
|
||||||
|
|
||||||
*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
|
*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
|
||||||
support Atom at the moment.
|
support Atom at the moment.
|
||||||
|
|
||||||
[IMPORTANT]
|
== Usage
|
||||||
The branch `master` has been renamed to `main`. If you have cloned this repo
|
|
||||||
before 2019-12-28, please update your git settings accordingly.
|
See link:{uri-branch-main}/man/mastorss.1.adoc[manpage].
|
||||||
|
|
||||||
== Install
|
== Install
|
||||||
|
|
||||||
=== Dependencies
|
[alt="Packaging status" link=https://repology.org/project/mastorss/versions]
|
||||||
|
image::https://repology.org/badge/vertical-allrepos/mastorss.svg[]
|
||||||
|
|
||||||
|
=== Gentoo
|
||||||
|
|
||||||
|
[source,shell]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
eselect repository enable guru
|
||||||
|
echo 'net-misc/mastorss' >> /etc/portage/package.accept_keywords/mastorss
|
||||||
|
emaint sync -r guru
|
||||||
|
emerge -a net-misc/mastorss
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
=== Arch
|
||||||
|
|
||||||
|
The git-version is available via the AUR:
|
||||||
|
<https://aur.archlinux.org/packages/mastorss-git/>.
|
||||||
|
|
||||||
|
=== From source
|
||||||
|
|
||||||
|
==== Dependencies
|
||||||
|
|
||||||
* Tested OS: Linux
|
* Tested OS: Linux
|
||||||
* C++ compiler (tested: link:{uri-gcc}[gcc] 7/8/9)
|
* C++ compiler (tested: link:{uri-gcc}[gcc] 7/8/9)
|
||||||
* link:{uri-cmake}[cmake] (at least: 3.9)
|
* link:{uri-cmake}[cmake] (at least: 3.9)
|
||||||
* link:{uri-boost}[boost] (at least: 1.62)
|
* link:{uri-boost}[boost] (at least: 1.62)
|
||||||
* link:{uri-mastodonpp}[mastodonpp] (at least: 0.4)
|
* link:{uri-mastodonpp}[mastodonpp] (at least: 0.5.6)
|
||||||
* link:{uri-jsoncpp}[jsoncpp] (at least: 1.7)
|
* link:{uri-jsoncpp}[jsoncpp] (at least: 1.7)
|
||||||
* link:{uri-restclient-cpp}[restclient-cpp] (at least: 0.5.1)
|
* link:{uri-libcurl}[libcurl] (at least: 7.52)
|
||||||
|
|
||||||
=== Get sourcecode
|
==== Get sourcecode
|
||||||
|
|
||||||
==== Release
|
===== Release
|
||||||
|
|
||||||
Download the current release at link:{uri-base}/releases[schlomp.space].
|
Download the current release at link:{uri-base}/releases[schlomp.space].
|
||||||
|
|
||||||
==== Development version
|
===== Development version
|
||||||
|
|
||||||
[source,shell]
|
[source,shell]
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
git clone https://schlomp.space/tastytea/mastorss.git
|
git clone https://schlomp.space/tastytea/mastorss.git
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
=== Compile
|
==== Compile
|
||||||
|
|
||||||
[source,shell]
|
[source,shell]
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
@ -55,10 +75,12 @@ cmake ..
|
||||||
cmake --build .
|
cmake --build .
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.CMake options:
|
||||||
|
* `-DCMAKE_BUILD_TYPE=Debug` Debug build.
|
||||||
|
* `-DWITH_MAN=NO` Don't install manpage.
|
||||||
|
* `-DWITH_COMPLETIONS=NO` Don't install completions.
|
||||||
|
* `-DZSH_COMPLETION_DIR` Change installation directory for Zsh completions.
|
||||||
|
|
||||||
Install with `make install`.
|
Install with `make install`.
|
||||||
|
|
||||||
== Usage
|
|
||||||
|
|
||||||
See link:{uri-branch-main}/man/mastorss.1.adoc[manpage].
|
|
||||||
|
|
||||||
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
|
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
install(FILES "_mastorss" DESTINATION "${ZSH_COMPLETION_DIR}")
|
|
@ -0,0 +1,26 @@
|
||||||
|
# -*- mode: shell-script; -*-
|
||||||
|
#compdef mastorss
|
||||||
|
|
||||||
|
local context state state_descr line
|
||||||
|
typeset -A opt_args
|
||||||
|
|
||||||
|
_arguments \
|
||||||
|
"(- *)--dry-run[Do everything like normal, but don't post anything and don't update the config file.]" \
|
||||||
|
"(- *)--help[Show a short help message.]" \
|
||||||
|
"(- *)--version[Show version, copyright and license.]" \
|
||||||
|
"::Profile:->profiles"
|
||||||
|
|
||||||
|
case "$state" in
|
||||||
|
profiles)
|
||||||
|
# Find config dir.
|
||||||
|
local config_dir="${XDG_CONFIG_HOME}"
|
||||||
|
[[ -z "${config_dir}" ]] && config_dir="${HOME}/.config"
|
||||||
|
config_dir+="/mastorss"
|
||||||
|
|
||||||
|
# Extract profile names from config files.
|
||||||
|
for file in "${config_dir}"/config-*; do
|
||||||
|
profile="${file/*config-/}"
|
||||||
|
compadd ${profile%.json}
|
||||||
|
done
|
||||||
|
;;
|
||||||
|
esac
|
|
@ -2,7 +2,7 @@
|
||||||
:doctype: manpage
|
:doctype: manpage
|
||||||
:Author: tastytea
|
:Author: tastytea
|
||||||
:Email: tastytea@tastytea.de
|
:Email: tastytea@tastytea.de
|
||||||
:Date: 2020-05-10
|
:Date: 2021-01-18
|
||||||
:Revision: 0.0.0
|
:Revision: 0.0.0
|
||||||
:man source: mastorss
|
:man source: mastorss
|
||||||
:man manual: General Commands Manual
|
:man manual: General Commands Manual
|
||||||
|
@ -22,8 +22,13 @@ support Atom at the moment.
|
||||||
|
|
||||||
== OPTIONS
|
== OPTIONS
|
||||||
|
|
||||||
|
*--dry-run*::
|
||||||
|
Do everything like normal, but don't post anything and don't update the config
|
||||||
|
file. The initial config file is still created, if the profile doesn't
|
||||||
|
exist. The interval between posts is set to 1 second.
|
||||||
|
|
||||||
*--help*::
|
*--help*::
|
||||||
Show help message.
|
Show a short help message.
|
||||||
|
|
||||||
*--version*::
|
*--version*::
|
||||||
Show version, copyright and license.
|
Show version, copyright and license.
|
||||||
|
@ -32,8 +37,9 @@ Show version, copyright and license.
|
||||||
|
|
||||||
Put `watchwords.json` into `${XDG_CONFIG_HOME}/mastorss/`. Launch with profile
|
Put `watchwords.json` into `${XDG_CONFIG_HOME}/mastorss/`. Launch with profile
|
||||||
name. The first occurence of every watchword in an RSS item will be turned into
|
name. The first occurence of every watchword in an RSS item will be turned into
|
||||||
a hashtag. For profile-specific watchwords see the example in
|
a hashtag (unless *add_hashtags* is set to false). For profile-specific
|
||||||
`watchwords.json`. In the first run only the newest entry is posted.
|
watchwords see the example in `watchwords.json`. In the first run only the
|
||||||
|
newest entry is posted unless *keep_looking* is set to true.
|
||||||
|
|
||||||
The profile is the identifier for a feed and can't be named "global".
|
The profile is the identifier for a feed and can't be named "global".
|
||||||
|
|
||||||
|
@ -61,8 +67,9 @@ This string will be appended to every post.
|
||||||
The URI of the source feed.
|
The URI of the source feed.
|
||||||
|
|
||||||
*fixes*::
|
*fixes*::
|
||||||
Array of regular expressions that should be deleted from the text. For
|
Array of regular expressions that should be deleted from the text. Applies to
|
||||||
information about the syntax see *perlre*(1).
|
RSS descriptions (before the HTML is stripped). For information about the syntax
|
||||||
|
see *perlre*(1).
|
||||||
|
|
||||||
*instance*::
|
*instance*::
|
||||||
Hostname of the instance you're using to post.
|
Hostname of the instance you're using to post.
|
||||||
|
@ -91,9 +98,12 @@ content warning) of the post.
|
||||||
If true, only post titles, no descriptions.
|
If true, only post titles, no descriptions.
|
||||||
|
|
||||||
*replacements*::
|
*replacements*::
|
||||||
Object with a list of regular expressions and replacements. Applies to posts,
|
Object with a list of regular expressions and replacements. Applies to posts
|
||||||
subjects and links, but not to the string in _append_. For information about the
|
(after the HTML is stripped), subjects and links, but not to the string in
|
||||||
syntax see *perlre*(1).
|
_append_. For information about the syntax see *perlre*(1).
|
||||||
|
|
||||||
|
*add_hashtags*::
|
||||||
|
If true, replace words with hashtags according to `watchwords.json`.
|
||||||
|
|
||||||
== EXAMPLES
|
== EXAMPLES
|
||||||
|
|
||||||
|
|
|
@ -4,23 +4,9 @@ include(GNUInstallDirs)
|
||||||
find_package(Boost 1.62 REQUIRED COMPONENTS filesystem log regex)
|
find_package(Boost 1.62 REQUIRED COMPONENTS filesystem log regex)
|
||||||
find_package(PkgConfig REQUIRED)
|
find_package(PkgConfig REQUIRED)
|
||||||
pkg_check_modules(jsoncpp REQUIRED IMPORTED_TARGET jsoncpp)
|
pkg_check_modules(jsoncpp REQUIRED IMPORTED_TARGET jsoncpp)
|
||||||
find_package(CURL 7.52 REQUIRED)
|
find_package(mastodonpp 0.5.6 REQUIRED CONFIG)
|
||||||
find_package(Threads REQUIRED)
|
|
||||||
find_package(restclient-cpp 0.5 CONFIG)
|
|
||||||
find_package(mastodonpp 0.4 REQUIRED CONFIG)
|
|
||||||
|
|
||||||
if(NOT ${restclient-cpp_FOUND})
|
add_subdirectory(curl_wrapper)
|
||||||
find_file(restclient_h NAMES "restclient-cpp/restclient.h"
|
|
||||||
PATHS "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}")
|
|
||||||
if("${restclient_h}" STREQUAL "restclient_h-NOTFOUND")
|
|
||||||
message(FATAL_ERROR "Could not find restclient-cpp.")
|
|
||||||
else()
|
|
||||||
message(WARNING
|
|
||||||
"Your distribution of restclient-cpp doesn't contain the *Config.cmake "
|
|
||||||
"recipes, but the files seem to be in the standard directories. "
|
|
||||||
"Let's hope this works.")
|
|
||||||
endif()
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# Write version in header.
|
# Write version in header.
|
||||||
configure_file ("${PROJECT_SOURCE_DIR}/src/version.hpp.in"
|
configure_file ("${PROJECT_SOURCE_DIR}/src/version.hpp.in"
|
||||||
|
@ -32,7 +18,7 @@ file(GLOB sources *.cpp)
|
||||||
add_executable(mastorss ${sources})
|
add_executable(mastorss ${sources})
|
||||||
target_link_libraries(mastorss
|
target_link_libraries(mastorss
|
||||||
PRIVATE
|
PRIVATE
|
||||||
PkgConfig::jsoncpp restclient-cpp mastodonpp::mastodonpp
|
PkgConfig::jsoncpp curl_wrapper mastodonpp::mastodonpp
|
||||||
Boost::filesystem Boost::log Boost::regex)
|
Boost::filesystem Boost::log Boost::regex)
|
||||||
if(BUILD_SHARED_LIBS)
|
if(BUILD_SHARED_LIBS)
|
||||||
target_compile_definitions(mastorss PRIVATE "BOOST_ALL_DYN_LINK=1")
|
target_compile_definitions(mastorss PRIVATE "BOOST_ALL_DYN_LINK=1")
|
||||||
|
|
|
@ -15,6 +15,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.hpp"
|
#include "config.hpp"
|
||||||
|
|
||||||
#include "exceptions.hpp"
|
#include "exceptions.hpp"
|
||||||
|
|
||||||
#include <boost/log/trivial.hpp>
|
#include <boost/log/trivial.hpp>
|
||||||
|
@ -91,7 +92,8 @@ std::ostream &operator<<(std::ostream &out, const ProfileData &data)
|
||||||
out << ", ";
|
out << ", ";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
out << "]";
|
out << "], ";
|
||||||
|
out << "add_hashtags: " << data.add_hashtags;
|
||||||
|
|
||||||
return out;
|
return out;
|
||||||
}
|
}
|
||||||
|
@ -102,7 +104,7 @@ Config::Config(string profile_name)
|
||||||
const fs::path filename = get_filename();
|
const fs::path filename = get_filename();
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Config filename is: " << filename;
|
BOOST_LOG_TRIVIAL(debug) << "Config filename is: " << filename;
|
||||||
|
|
||||||
ifstream file{filename.c_str()};
|
ifstream file(filename.c_str());
|
||||||
if (file.good())
|
if (file.good())
|
||||||
{
|
{
|
||||||
stringstream rawjson;
|
stringstream rawjson;
|
||||||
|
@ -194,6 +196,10 @@ void Config::generate()
|
||||||
}
|
}
|
||||||
profiledata.max_size = stoul(line);
|
profiledata.max_size = stoul(line);
|
||||||
|
|
||||||
|
cout << "Add hashtags according to watchwords.json? [y/n]: ";
|
||||||
|
std::getline(cin, line);
|
||||||
|
profiledata.add_hashtags = (line[0] == 'y');
|
||||||
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Generated configuration.";
|
BOOST_LOG_TRIVIAL(debug) << "Generated configuration.";
|
||||||
write();
|
write();
|
||||||
}
|
}
|
||||||
|
@ -212,7 +218,6 @@ string Config::get_access_token(const string &instance) const
|
||||||
if (ret)
|
if (ret)
|
||||||
{
|
{
|
||||||
string code;
|
string code;
|
||||||
string access_token;
|
|
||||||
|
|
||||||
cout << "Visit " << ret << " to authorize this application.\n";
|
cout << "Visit " << ret << " to authorize this application.\n";
|
||||||
cout << "Insert code: ";
|
cout << "Insert code: ";
|
||||||
|
@ -220,8 +225,8 @@ string Config::get_access_token(const string &instance) const
|
||||||
ret = token.step_2(code);
|
ret = token.step_2(code);
|
||||||
if (ret)
|
if (ret)
|
||||||
{
|
{
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Got access token.";
|
BOOST_LOG_TRIVIAL(debug) << "Got access token: " << ret.body;
|
||||||
return access_token;
|
return ret.body;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -238,8 +243,8 @@ void Config::parse()
|
||||||
profiledata.instance = _json[profile]["instance"].asString();
|
profiledata.instance = _json[profile]["instance"].asString();
|
||||||
if (!_json[profile]["interval"].isNull())
|
if (!_json[profile]["interval"].isNull())
|
||||||
{
|
{
|
||||||
profiledata.interval =
|
profiledata.interval = static_cast<uint32_t>(
|
||||||
static_cast<uint32_t>(_json[profile]["interval"].asUInt64());
|
_json[profile]["interval"].asUInt64());
|
||||||
}
|
}
|
||||||
profiledata.keep_looking = _json[profile]["keep_looking"].asBool();
|
profiledata.keep_looking = _json[profile]["keep_looking"].asBool();
|
||||||
if (!_json[profile]["max_size"].isNull())
|
if (!_json[profile]["max_size"].isNull())
|
||||||
|
@ -254,6 +259,7 @@ void Config::parse()
|
||||||
profiledata.replacements.push_back(
|
profiledata.replacements.push_back(
|
||||||
{search, _json[profile]["replacements"][search].asString()});
|
{search, _json[profile]["replacements"][search].asString()});
|
||||||
}
|
}
|
||||||
|
profiledata.add_hashtags = _json[profile]["add_hashtags"].asBool();
|
||||||
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Read config: " << profiledata;
|
BOOST_LOG_TRIVIAL(debug) << "Read config: " << profiledata;
|
||||||
}
|
}
|
||||||
|
@ -268,8 +274,8 @@ void Config::write()
|
||||||
_json[profile]["instance"] = profiledata.instance;
|
_json[profile]["instance"] = profiledata.instance;
|
||||||
_json[profile]["interval"] = profiledata.interval;
|
_json[profile]["interval"] = profiledata.interval;
|
||||||
_json[profile]["keep_looking"] = profiledata.keep_looking;
|
_json[profile]["keep_looking"] = profiledata.keep_looking;
|
||||||
_json[profile]["max_size"] =
|
_json[profile]["max_size"] = static_cast<Json::Value::UInt64>(
|
||||||
static_cast<Json::Value::UInt64>(profiledata.max_size);
|
profiledata.max_size);
|
||||||
_json[profile]["skip"] = stringlist_to_jsonarray(profiledata.skip);
|
_json[profile]["skip"] = stringlist_to_jsonarray(profiledata.skip);
|
||||||
_json[profile]["titles_as_cw"] = profiledata.titles_as_cw;
|
_json[profile]["titles_as_cw"] = profiledata.titles_as_cw;
|
||||||
_json[profile]["titles_only"] = profiledata.titles_only;
|
_json[profile]["titles_only"] = profiledata.titles_only;
|
||||||
|
@ -277,8 +283,9 @@ void Config::write()
|
||||||
{
|
{
|
||||||
_json[profile]["replacements"][replacement.first] = replacement.second;
|
_json[profile]["replacements"][replacement.first] = replacement.second;
|
||||||
}
|
}
|
||||||
|
_json[profile]["add_hashtags"] = profiledata.add_hashtags;
|
||||||
|
|
||||||
ofstream file{get_filename().c_str()};
|
ofstream file(get_filename().c_str());
|
||||||
if (file.good())
|
if (file.good())
|
||||||
{
|
{
|
||||||
file << _json.toStyledString();
|
file << _json.toStyledString();
|
||||||
|
|
|
@ -55,6 +55,7 @@ struct ProfileData
|
||||||
bool titles_as_cw{false};
|
bool titles_as_cw{false};
|
||||||
bool titles_only{false};
|
bool titles_only{false};
|
||||||
list<pair<string, string>> replacements;
|
list<pair<string, string>> replacements;
|
||||||
|
bool add_hashtags{true};
|
||||||
|
|
||||||
friend std::ostream &operator<<(std::ostream &out, const ProfileData &data);
|
friend std::ostream &operator<<(std::ostream &out, const ProfileData &data);
|
||||||
};
|
};
|
||||||
|
@ -71,6 +72,7 @@ public:
|
||||||
|
|
||||||
const string profile;
|
const string profile;
|
||||||
ProfileData profiledata;
|
ProfileData profiledata;
|
||||||
|
constexpr static size_t max_guids{100};
|
||||||
|
|
||||||
void write();
|
void write();
|
||||||
[[nodiscard]] fs::path get_config_dir() const;
|
[[nodiscard]] fs::path get_config_dir() const;
|
||||||
|
|
|
@ -0,0 +1,131 @@
|
||||||
|
# -*- mode: yaml -*-
|
||||||
|
# Written for clang-format 10.
|
||||||
|
# https://releases.llvm.org/10.0.0/tools/clang/docs/ClangFormatStyleOptions.html
|
||||||
|
---
|
||||||
|
DisableFormat: false
|
||||||
|
Language: Cpp
|
||||||
|
|
||||||
|
AccessModifierOffset: -4
|
||||||
|
AlignAfterOpenBracket: Align
|
||||||
|
AlignConsecutiveAssignments: false
|
||||||
|
# AlignConsecutiveBitFields: false # clang-format 11
|
||||||
|
AlignConsecutiveDeclarations: false
|
||||||
|
AlignConsecutiveMacros: false
|
||||||
|
AlignEscapedNewlines: DontAlign
|
||||||
|
AlignOperands: true # clang-format 11: Align
|
||||||
|
AlignTrailingComments: true
|
||||||
|
AllowAllArgumentsOnNextLine: false
|
||||||
|
AllowAllConstructorInitializersOnNextLine: false
|
||||||
|
AllowAllParametersOfDeclarationOnNextLine: false
|
||||||
|
AllowShortBlocksOnASingleLine: Empty
|
||||||
|
AllowShortCaseLabelsOnASingleLine: false
|
||||||
|
# AllowShortEnumsOnASingleLine: false # clang-format 11
|
||||||
|
AllowShortFunctionsOnASingleLine: Empty
|
||||||
|
AllowShortIfStatementsOnASingleLine: Never
|
||||||
|
AllowShortLambdasOnASingleLine: Inline
|
||||||
|
AllowShortLoopsOnASingleLine: false
|
||||||
|
AlwaysBreakAfterReturnType: None
|
||||||
|
AlwaysBreakBeforeMultilineStrings: false
|
||||||
|
AlwaysBreakTemplateDeclarations: Yes
|
||||||
|
BinPackArguments: true
|
||||||
|
BinPackParameters: true
|
||||||
|
BraceWrapping: # If BreakBeforeBraces is set to Custom.
|
||||||
|
AfterCaseLabel: true
|
||||||
|
AfterClass: true
|
||||||
|
AfterControlStatement: Always
|
||||||
|
AfterEnum: true
|
||||||
|
AfterFunction: true
|
||||||
|
AfterNamespace: true
|
||||||
|
AfterStruct: true
|
||||||
|
AfterUnion: true
|
||||||
|
AfterExternBlock: true
|
||||||
|
BeforeCatch: true
|
||||||
|
BeforeElse: true
|
||||||
|
# BeforeLambdaBody: true # clang-format 11
|
||||||
|
# BeforeWhile: true # clang-format 11
|
||||||
|
IndentBraces: false
|
||||||
|
SplitEmptyFunction: false
|
||||||
|
SplitEmptyRecord: false
|
||||||
|
SplitEmptyNamespace: false
|
||||||
|
BreakBeforeBinaryOperators: NonAssignment
|
||||||
|
BreakBeforeBraces: Custom
|
||||||
|
BreakBeforeTernaryOperators: true
|
||||||
|
BreakConstructorInitializers: BeforeComma
|
||||||
|
BreakInheritanceList: BeforeComma
|
||||||
|
BreakStringLiterals: true
|
||||||
|
ColumnLimit: 80
|
||||||
|
# CommentPragmas: 'regex'
|
||||||
|
CompactNamespaces: false
|
||||||
|
ConstructorInitializerAllOnOneLineOrOnePerLine: false
|
||||||
|
ConstructorInitializerIndentWidth: 4
|
||||||
|
ContinuationIndentWidth: 4
|
||||||
|
Cpp11BracedListStyle: true
|
||||||
|
DeriveLineEnding: true
|
||||||
|
DerivePointerAlignment: false
|
||||||
|
FixNamespaceComments: true
|
||||||
|
ForEachMacros:
|
||||||
|
- FOREACH
|
||||||
|
- RANGES_FOR
|
||||||
|
- Q_FOREACH
|
||||||
|
- BOOST_FOREACH
|
||||||
|
IncludeBlocks: Regroup
|
||||||
|
IncludeCategories: # stdlib headers into own group.
|
||||||
|
- Regex: '^[^\.]+$'
|
||||||
|
Priority: 4
|
||||||
|
# IndentCaseBlocks: false # clang-format 11
|
||||||
|
IndentCaseLabels: false
|
||||||
|
# IndentExternBlock: NoIndent # clang-format 11
|
||||||
|
IndentGotoLabels: false
|
||||||
|
IndentPPDirectives: AfterHash
|
||||||
|
IndentWidth: 4
|
||||||
|
IndentWrappedFunctionNames: false
|
||||||
|
KeepEmptyLinesAtTheStartOfBlocks: true
|
||||||
|
# MacroBlockBegin: 'string'
|
||||||
|
# MacroBlockEnd: 'string'
|
||||||
|
MaxEmptyLinesToKeep: 1
|
||||||
|
NamespaceIndentation: None
|
||||||
|
# NamespaceMacros: 'string'
|
||||||
|
PenaltyBreakAssignment: 250
|
||||||
|
PenaltyBreakBeforeFirstCallParameter: 300
|
||||||
|
# PenaltyBreakComment: 300
|
||||||
|
# PenaltyBreakFirstLessLess: 120
|
||||||
|
# PenaltyBreakString: 1000
|
||||||
|
# PenaltyBreakTemplateDeclaration: 10
|
||||||
|
# PenaltyExcessCharacter: 1000000
|
||||||
|
# PenaltyReturnTypeOnItsOwnLine: 60
|
||||||
|
PointerAlignment: Right
|
||||||
|
# RawStringFormats: # <YAML>
|
||||||
|
ReflowComments: true
|
||||||
|
SortIncludes: true
|
||||||
|
SortUsingDeclarations: true
|
||||||
|
SpaceAfterCStyleCast: false
|
||||||
|
SpaceAfterLogicalNot: false
|
||||||
|
SpaceAfterTemplateKeyword: false
|
||||||
|
SpaceBeforeAssignmentOperators: true
|
||||||
|
SpaceBeforeCpp11BracedList: false
|
||||||
|
SpaceBeforeCtorInitializerColon: true
|
||||||
|
SpaceBeforeInheritanceColon: true
|
||||||
|
SpaceBeforeParens: ControlStatements
|
||||||
|
SpaceBeforeRangeBasedForLoopColon: true
|
||||||
|
SpaceBeforeSquareBrackets: false
|
||||||
|
SpaceInEmptyBlock: false
|
||||||
|
SpaceInEmptyParentheses: false
|
||||||
|
SpacesBeforeTrailingComments: 1
|
||||||
|
SpacesInAngles: false
|
||||||
|
SpacesInCStyleCastParentheses: false
|
||||||
|
SpacesInConditionalStatement: false
|
||||||
|
SpacesInContainerLiterals: false
|
||||||
|
SpacesInParentheses: false
|
||||||
|
SpacesInSquareBrackets: false
|
||||||
|
Standard: Auto
|
||||||
|
# StatementMacros:
|
||||||
|
# - Q_UNUSED
|
||||||
|
# - QT_REQUIRE_VERSION
|
||||||
|
TabWidth: 4
|
||||||
|
# TypenameMacros:
|
||||||
|
# - STACK_OF
|
||||||
|
# - LIST
|
||||||
|
UseCRLF: false
|
||||||
|
UseTab: Never
|
||||||
|
# WhitespaceSensitiveMacros: ['string', 'string'] # clang-format 11
|
||||||
|
...
|
|
@ -0,0 +1,119 @@
|
||||||
|
# -*- fill-column: 1000 -*-
|
||||||
|
kind: pipeline
|
||||||
|
name: Build x86_64
|
||||||
|
|
||||||
|
platform:
|
||||||
|
os: linux
|
||||||
|
arch:
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
- name: debian-package-cache
|
||||||
|
host:
|
||||||
|
path: /var/cache/debian-package-cache
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
event:
|
||||||
|
exclude:
|
||||||
|
- tag
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: GCC 9 & 10 / clang 10
|
||||||
|
image: ubuntu:focal
|
||||||
|
pull: always
|
||||||
|
environment:
|
||||||
|
CXX: g++-9
|
||||||
|
CXXFLAGS: -pipe -O2
|
||||||
|
DEBIAN_FRONTEND: noninteractive
|
||||||
|
LANG: C.utf8
|
||||||
|
commands:
|
||||||
|
- rm /etc/apt/apt.conf.d/docker-clean
|
||||||
|
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
||||||
|
- apt-get update -q
|
||||||
|
- apt-get install -qq build-essential cmake g++-10 clang
|
||||||
|
- apt-get install -qq catch libcurl4-openssl-dev
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
- cd ../../
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- CXX="g++-10" cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
- cd ../../
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- CXX="clang++" cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
volumes:
|
||||||
|
- name: debian-package-cache
|
||||||
|
path: /var/cache/apt/archives
|
||||||
|
|
||||||
|
- name: GCC 8 / clang 7
|
||||||
|
image: debian:buster-slim
|
||||||
|
pull: always
|
||||||
|
environment:
|
||||||
|
CXX: g++-8
|
||||||
|
CXXFLAGS: -pipe -O2
|
||||||
|
DEBIAN_FRONTEND: noninteractive
|
||||||
|
LANG: C.utf8
|
||||||
|
commands:
|
||||||
|
- rm /etc/apt/apt.conf.d/docker-clean
|
||||||
|
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
||||||
|
- apt-get update -q
|
||||||
|
- apt-get install -qq build-essential cmake clang
|
||||||
|
- apt-get install -qq catch libcurl4-openssl-dev
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
- cd ../../
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- CXX="clang++" cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
volumes:
|
||||||
|
- name: debian-package-cache
|
||||||
|
path: /var/cache/apt/archives
|
||||||
|
|
||||||
|
- name: GCC 7 / clang 6
|
||||||
|
image: ubuntu:bionic
|
||||||
|
pull: always
|
||||||
|
environment:
|
||||||
|
CXX: g++-7
|
||||||
|
CXXFLAGS: -pipe -O2
|
||||||
|
DEBIAN_FRONTEND: noninteractive
|
||||||
|
LANG: C.utf8
|
||||||
|
nlohmann_json_DIR: "/usr/lib/cmake"
|
||||||
|
pugixml_DIR: "/usr/share/libpugixml-dev/cmake"
|
||||||
|
commands:
|
||||||
|
- rm /etc/apt/apt.conf.d/docker-clean
|
||||||
|
- alias apt-get='rm -f /var/cache/apt/archives/lock && apt-get'
|
||||||
|
- apt-get update -q
|
||||||
|
- apt-get install -qq build-essential cmake clang pkg-config
|
||||||
|
- apt-get install -qq catch libcurl4-gnutls-dev
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
- cd ../../
|
||||||
|
- rm -rf build && mkdir -p build && cd build
|
||||||
|
- CXX="clang++" cmake -G "Unix Makefiles" -DWITH_CURL_WRAPPER_TESTS=YES ..
|
||||||
|
- make VERBOSE=1
|
||||||
|
- cd tests && ctest -V
|
||||||
|
volumes:
|
||||||
|
- name: debian-package-cache
|
||||||
|
path: /var/cache/apt/archives
|
||||||
|
|
||||||
|
- name: notify
|
||||||
|
image: drillster/drone-email
|
||||||
|
pull: always
|
||||||
|
settings:
|
||||||
|
host: mail.tzend.de
|
||||||
|
from: drone@tzend.de
|
||||||
|
username:
|
||||||
|
from_secret: email_username
|
||||||
|
password:
|
||||||
|
from_secret: email_password
|
||||||
|
when:
|
||||||
|
status: [ changed, failure ]
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Configuration file for EditorConfig.
|
||||||
|
# More information is available under <https://editorconfig.org/>.
|
||||||
|
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
max_line_length = 80
|
||||||
|
|
||||||
|
[*.?pp]
|
||||||
|
indent_size = 4
|
||||||
|
tab_width = 4
|
||||||
|
|
||||||
|
[{CMakeLists.txt,*.cmake}]
|
||||||
|
indent_size = 2
|
||||||
|
tab_width = 2
|
|
@ -0,0 +1 @@
|
||||||
|
/build/
|
|
@ -0,0 +1,27 @@
|
||||||
|
# Support version 3.9 and above, but use policy settings up to 3.17.
|
||||||
|
cmake_minimum_required(VERSION 3.9...3.17)
|
||||||
|
# Ranges are supported from 3.12, set policy to current for < 3.12.
|
||||||
|
if(${CMAKE_VERSION} VERSION_LESS 3.12)
|
||||||
|
cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
|
||||||
|
endif()
|
||||||
|
|
||||||
|
project(curl_wrapper
|
||||||
|
VERSION 0.1.2
|
||||||
|
DESCRIPTION "Light libcurl wrapper."
|
||||||
|
LANGUAGES CXX)
|
||||||
|
|
||||||
|
option(WITH_CURL_WRAPPER_TESTS "Compile tests for curl_wrapper." NO)
|
||||||
|
option(WITH_CURL_WRAPPER_DOC "Compile API reference for curl_wrapper." NO)
|
||||||
|
|
||||||
|
find_package(CURL 7.52 REQUIRED)
|
||||||
|
|
||||||
|
add_subdirectory("src")
|
||||||
|
|
||||||
|
if(WITH_CURL_WRAPPER_TESTS)
|
||||||
|
add_subdirectory("tests")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(WITH_CURL_WRAPPER_DOC)
|
||||||
|
include("cmake/Doxygen.cmake")
|
||||||
|
enable_doxygen("src")
|
||||||
|
endif()
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
|
@ -0,0 +1,85 @@
|
||||||
|
= curl_wrapper
|
||||||
|
:toc: preamble
|
||||||
|
:project: curl_wrapper
|
||||||
|
:uri-base: https://schlomp.space/tastytea/{project}
|
||||||
|
:uri-cmake: https://cmake.org/
|
||||||
|
:uri-libcurl: https://curl.haxx.se/libcurl/
|
||||||
|
:uri-catch: https://github.com/catchorg/Catch2
|
||||||
|
:uri-doxygen: http://www.doxygen.nl/
|
||||||
|
:uri-git-subtree: https://manpages.debian.org/testing/git-man/git-subtree.1.en.html
|
||||||
|
|
||||||
|
Light libcurl wrapper for when you need to GET a website with minimum effort.
|
||||||
|
|
||||||
|
This is _not_ supposed to be a package on its own, but a thing you drop into
|
||||||
|
your project.
|
||||||
|
|
||||||
|
I made this because the curl wrapper I used before is no longer maintained and
|
||||||
|
the other wrappers are either incomplete or unmaintained as well. _I do not
|
||||||
|
guarantee anything, use at your own risk._
|
||||||
|
|
||||||
|
URL: <{uri-base}>.
|
||||||
|
|
||||||
|
== Example program
|
||||||
|
|
||||||
|
[source,cpp]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
namespace cw = curl_wrapper;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
cw::CURLWrapper curl;
|
||||||
|
const auto answer{curl.make_http_request(cw::http_method::GET,
|
||||||
|
"http://example.com/")};
|
||||||
|
if (answer)
|
||||||
|
{
|
||||||
|
std::cout << answer;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
== Use with CMake
|
||||||
|
|
||||||
|
Drop this project into a subfolder in your project tree. It will be compiled as
|
||||||
|
a static library.
|
||||||
|
|
||||||
|
[source,cmake]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
add_subdirectory(curl_wrapper)
|
||||||
|
|
||||||
|
add_executable(test)
|
||||||
|
target_link_libraries(test PRIVATE curl_wrapper)
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
.CMake options:
|
||||||
|
* `-DWITH_CURL_WRAPPER_TESTS=YES` Compiles the tests.
|
||||||
|
* `-DWITH_CURL_WRAPPER_DOC=YES` Generate API reference.
|
||||||
|
|
||||||
|
== Add with `git subtree`
|
||||||
|
|
||||||
|
Replace `src/curl_wrapper` with the path you want it to be in. Consult
|
||||||
|
link:{uri-git-subtree}[git-subtree(1)] for more information.
|
||||||
|
|
||||||
|
[source,shell]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
git remote add curl_wrapper https://schlomp.space/tastytea/curl_wrapper.git
|
||||||
|
git subtree add --prefix=src/curl_wrapper curl_wrapper main --squash
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
=== Update subtree
|
||||||
|
|
||||||
|
[source,shell]
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
git subtree pull --prefix=src/curl_wrapper curl_wrapper main --squash
|
||||||
|
--------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
== Dependencies
|
||||||
|
|
||||||
|
* C++17
|
||||||
|
* link:{uri-cmake}[CMake] >= 3.9
|
||||||
|
* link:{uri-libcurl}[libcurl] >= 7.52
|
||||||
|
* Optional:
|
||||||
|
** Tests: link:{uri-catch}[Catch] >= 1.2
|
||||||
|
** Documentation: link:{uri-doxygen}[Doxygen] >= 1.8
|
|
@ -0,0 +1,33 @@
|
||||||
|
function(enable_doxygen)
|
||||||
|
find_package(Doxygen REQUIRED dot)
|
||||||
|
|
||||||
|
set(DOXYGEN_RECURSIVE YES)
|
||||||
|
set(DOXYGEN_GENERATE_HTML YES)
|
||||||
|
set(DOXYGEN_HTML_OUTPUT "doc/html")
|
||||||
|
set(DOXYGEN_GENERATE_LATEX NO)
|
||||||
|
set(DOXYGEN_ALLOW_UNICODE_NAMES YES)
|
||||||
|
set(DOXYGEN_BRIEF_MEMBER_DESC YES)
|
||||||
|
set(DOXYGEN_REPEAT_BRIEF YES)
|
||||||
|
set(DOXYGEN_ALWAYS_DETAILED_SEC YES)
|
||||||
|
set(DOXYGEN_INLINE_INHERITED_MEMB NO)
|
||||||
|
set(DOXYGEN_INHERIT_DOCS YES)
|
||||||
|
set(DOXYGEN_SEPARATE_MEMBER_PAGES NO)
|
||||||
|
set(DOXYGEN_TAB_SIZE 4)
|
||||||
|
set(DOXYGEN_MARKDOWN_SUPPORT YES)
|
||||||
|
set(DOXYGEN_AUTOLINK_SUPPORT YES)
|
||||||
|
set(DOXYGEN_INLINE_SIMPLE_STRUCTS NO)
|
||||||
|
set(DOXYGEN_QUIET YES)
|
||||||
|
set(DOXYGEN_WARNINGS YES)
|
||||||
|
set(DOXYGEN_WARN_IF_UNDOCUMENTED YES)
|
||||||
|
set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
|
||||||
|
set(DOXYGEN_VERBATIM_HEADERS YES)
|
||||||
|
set(DOXYGEN_INLINE_SOURCES YES)
|
||||||
|
set(DOXYGEN_SEARCHENGINE YES)
|
||||||
|
set(DOXYGEN_SHOW_FILES YES)
|
||||||
|
|
||||||
|
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doc")
|
||||||
|
|
||||||
|
doxygen_add_docs(${PROJECT_NAME}_doxygen "${ARGV}")
|
||||||
|
# Make sure doxygen is run with every build.
|
||||||
|
add_custom_target(${PROJECT_NAME}_docs ALL DEPENDS ${PROJECT_NAME}_doxygen)
|
||||||
|
endfunction()
|
|
@ -0,0 +1,23 @@
|
||||||
|
file(GLOB sources "*.cpp")
|
||||||
|
file(GLOB headers "*.hpp")
|
||||||
|
add_library(${PROJECT_NAME} STATIC ${sources} ${headers})
|
||||||
|
unset(sources)
|
||||||
|
unset(headers)
|
||||||
|
|
||||||
|
set_target_properties(${PROJECT_NAME}
|
||||||
|
PROPERTIES
|
||||||
|
CXX_STANDARD 17
|
||||||
|
CXX_STANDARD_REQUIRED ON
|
||||||
|
CXX_EXTENSIONS OFF
|
||||||
|
POSITION_INDEPENDENT_CODE ON)
|
||||||
|
|
||||||
|
# FindCURL provides an IMPORTED target since CMake 3.12.
|
||||||
|
if(NOT ${CMAKE_VERSION} VERSION_LESS 3.12)
|
||||||
|
target_link_libraries(${PROJECT_NAME} PUBLIC CURL::libcurl)
|
||||||
|
else()
|
||||||
|
target_include_directories(${PROJECT_NAME} PUBLIC ${CURL_INCLUDE_DIRS})
|
||||||
|
target_link_libraries(${PROJECT_NAME} PUBLIC ${CURL_LIBRARIES})
|
||||||
|
endif()
|
||||||
|
|
||||||
|
target_include_directories(${PROJECT_NAME}
|
||||||
|
PUBLIC "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>")
|
|
@ -0,0 +1,252 @@
|
||||||
|
/* This file is part of curl_wrapper.
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
|
|
||||||
|
#include "types.hpp"
|
||||||
|
|
||||||
|
#include <curl/curl.h>
|
||||||
|
|
||||||
|
#include <atomic>
|
||||||
|
#include <cstdint>
|
||||||
|
#include <exception>
|
||||||
|
#include <stdexcept>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
inline static std::atomic<std::uint64_t> curlwrapper_instances{0};
|
||||||
|
|
||||||
|
CURLWrapper::CURLWrapper()
|
||||||
|
{
|
||||||
|
if (curlwrapper_instances == 0)
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(hicpp-signed-bitwise)
|
||||||
|
check(curl_global_init(CURL_GLOBAL_ALL));
|
||||||
|
}
|
||||||
|
++curlwrapper_instances;
|
||||||
|
|
||||||
|
_connection = curl_easy_init();
|
||||||
|
if (_connection == nullptr)
|
||||||
|
{
|
||||||
|
throw std::runtime_error{"Failed to initialize curl."};
|
||||||
|
}
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_ERRORBUFFER, _buffer_error);
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_WRITEFUNCTION, writer_body_wrapper);
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_WRITEDATA, this);
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_HEADERFUNCTION,
|
||||||
|
writer_headers_wrapper);
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_HEADERDATA, this);
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_FOLLOWLOCATION, 1L));
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_MAXREDIRS, 5L);
|
||||||
|
}
|
||||||
|
|
||||||
|
CURLWrapper::~CURLWrapper() noexcept
|
||||||
|
{
|
||||||
|
curl_easy_cleanup(_connection);
|
||||||
|
--curlwrapper_instances;
|
||||||
|
|
||||||
|
if (curlwrapper_instances == 0)
|
||||||
|
{
|
||||||
|
curl_global_cleanup();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
string CURLWrapper::escape_url(const string_view url) const
|
||||||
|
{
|
||||||
|
char *cbuf{curl_easy_escape(_connection, url.data(),
|
||||||
|
static_cast<int>(url.size()))};
|
||||||
|
string sbuf{cbuf};
|
||||||
|
curl_free(cbuf);
|
||||||
|
return sbuf;
|
||||||
|
}
|
||||||
|
|
||||||
|
string CURLWrapper::unescape_url(const string_view url) const
|
||||||
|
{
|
||||||
|
char *cbuf{curl_easy_unescape(_connection, url.data(),
|
||||||
|
static_cast<int>(url.size()), nullptr)};
|
||||||
|
string sbuf{cbuf};
|
||||||
|
curl_free(cbuf);
|
||||||
|
return sbuf;
|
||||||
|
}
|
||||||
|
|
||||||
|
void CURLWrapper::set_useragent(const string_view useragent)
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_USERAGENT, useragent.data()));
|
||||||
|
}
|
||||||
|
|
||||||
|
void CURLWrapper::set_proxy(const string_view proxy)
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_PROXY, proxy.data()));
|
||||||
|
}
|
||||||
|
|
||||||
|
answer CURLWrapper::make_http_request(http_method method, string_view uri)
|
||||||
|
{
|
||||||
|
_buffer_headers.clear();
|
||||||
|
_buffer_body.clear();
|
||||||
|
|
||||||
|
switch (method)
|
||||||
|
{
|
||||||
|
case http_method::DELETE:
|
||||||
|
{
|
||||||
|
// NOTE: Use CURLOPT_MIMEPOST, then set to DELETE to send data.
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "DELETE"));
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case http_method::GET:
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_HTTPGET, 1L);
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case http_method::HEAD:
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "HEAD"));
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case http_method::PATCH:
|
||||||
|
{
|
||||||
|
// NOTE: Use CURLOPT_MIMEPOST, then set to PATCH to send data.
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "PATCH"));
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case http_method::POST:
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_POST, 1L);
|
||||||
|
|
||||||
|
// NOTE: Use CURLOPT_MIMEPOST to send data.
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case http_method::PUT:
|
||||||
|
{
|
||||||
|
// NOTE: Use CURLOPT_MIMEPOST, then set to PUT to send data.
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "PUT"));
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_URL, uri.data()));
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
check(curl_easy_perform(_connection));
|
||||||
|
}
|
||||||
|
catch (const CURLException &e)
|
||||||
|
{
|
||||||
|
// PARTIAL_FILE error seems to be normal for HEAD requests.
|
||||||
|
if (!(method == http_method::HEAD
|
||||||
|
&& e.error_code == CURLE_PARTIAL_FILE))
|
||||||
|
{
|
||||||
|
std::rethrow_exception(std::current_exception());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
long http_status{0}; // NOLINT(google-runtime-int)
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_getinfo(_connection, CURLINFO_RESPONSE_CODE, &http_status));
|
||||||
|
return {static_cast<std::uint16_t>(http_status), _buffer_headers,
|
||||||
|
_buffer_body};
|
||||||
|
}
|
||||||
|
|
||||||
|
void CURLWrapper::set_maxredirs(long redirections) // NOLINT(google-runtime-int)
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
curl_easy_setopt(_connection, CURLOPT_MAXREDIRS, redirections);
|
||||||
|
|
||||||
|
if (redirections == 0)
|
||||||
|
{
|
||||||
|
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
|
||||||
|
check(curl_easy_setopt(_connection, CURLOPT_FOLLOWLOCATION, 0L));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t CURLWrapper::writer_body(char *data, size_t size, size_t nmemb)
|
||||||
|
{
|
||||||
|
if (data == nullptr)
|
||||||
|
{
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
_buffer_body.append(data, size * nmemb);
|
||||||
|
|
||||||
|
return size * nmemb;
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t CURLWrapper::writer_headers(char *data, size_t size, size_t nmemb)
|
||||||
|
{
|
||||||
|
if (data == nullptr)
|
||||||
|
{
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
_buffer_headers.append(data, size * nmemb);
|
||||||
|
|
||||||
|
return size * nmemb;
|
||||||
|
}
|
||||||
|
|
||||||
|
void CURLWrapper::check(const CURLcode code)
|
||||||
|
{
|
||||||
|
if (code != CURLE_OK)
|
||||||
|
{
|
||||||
|
throw CURLException{code, _buffer_error};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const char *CURLException::what() const noexcept
|
||||||
|
{
|
||||||
|
// NOTE: The string has to be static, or it'll vanish before it can be
|
||||||
|
// used. Couldn't find good documentation on that.
|
||||||
|
static string error_string;
|
||||||
|
error_string = _error_message;
|
||||||
|
if (!error_string.empty())
|
||||||
|
{
|
||||||
|
error_string = " – " + error_string;
|
||||||
|
}
|
||||||
|
error_string = "libcurl error: " + std::to_string(error_code)
|
||||||
|
+ error_string;
|
||||||
|
return error_string.c_str();
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
|
@ -0,0 +1,260 @@
|
||||||
|
/* This file is part of curl_wrapper.
|
||||||
|
* 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 CURL_WRAPPER_HPP
|
||||||
|
#define CURL_WRAPPER_HPP
|
||||||
|
|
||||||
|
#include "types.hpp"
|
||||||
|
|
||||||
|
#include <curl/curl.h>
|
||||||
|
|
||||||
|
#include <exception>
|
||||||
|
#include <string>
|
||||||
|
#include <string_view>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::string;
|
||||||
|
using std::string_view;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Light wrapper around libcurl.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
class CURLWrapper
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
/*!
|
||||||
|
* @brief Initializes curl and sets up connection.
|
||||||
|
*
|
||||||
|
* The first time an instance of CURLWrapper is created, it calls
|
||||||
|
* `curl_global_init`, which is not thread-safe. For more information
|
||||||
|
* consult [curl_global_init(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/curl_global_init.html).
|
||||||
|
*
|
||||||
|
* May throw CURLException or std::runtime_error.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
CURLWrapper();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Cleans up curl and connection.
|
||||||
|
*
|
||||||
|
* Calls `curl_global_cleanup`, which is not thread-safe, when the last
|
||||||
|
* instance of CURLWrapper is destroyed. For more information consult
|
||||||
|
* [curl_global_cleanup(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html).
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
virtual ~CURLWrapper() noexcept;
|
||||||
|
|
||||||
|
//! Copy constructor. @since 0.1.0
|
||||||
|
CURLWrapper(const CURLWrapper &other) = delete;
|
||||||
|
|
||||||
|
//! Move constructor @since 0.1.0
|
||||||
|
CURLWrapper(CURLWrapper &&other) noexcept = delete;
|
||||||
|
|
||||||
|
//! Copy assignment operator @since 0.1.0
|
||||||
|
CURLWrapper &operator=(const CURLWrapper &other) = delete;
|
||||||
|
|
||||||
|
//! Move assignment operator @since 0.1.0
|
||||||
|
CURLWrapper &operator=(CURLWrapper &&other) noexcept = delete;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Returns pointer to the CURL easy handle.
|
||||||
|
*
|
||||||
|
* You can use this handle to set or modify curl options. For more
|
||||||
|
* information consult [curl_easy_setopt(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/curl_easy_setopt.html).
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] inline CURL *get_curl_easy_handle() const
|
||||||
|
{
|
||||||
|
return _connection;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief URL encodes the given string.
|
||||||
|
*
|
||||||
|
* For more information consult [curl_easy_escape(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/curl_easy_escape.html).
|
||||||
|
*
|
||||||
|
* @param url String to escape.
|
||||||
|
*
|
||||||
|
* @return The escaped string or {} if it failed.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] string escape_url(string_view url) const;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief URL decodes the given string.
|
||||||
|
*
|
||||||
|
* For more information consult [curl_easy_unescape(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/curl_easy_unescape.html).
|
||||||
|
*
|
||||||
|
* @param url String to unescape.
|
||||||
|
*
|
||||||
|
* @return The unescaped string or {} if it failed.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] string unescape_url(string_view url) const;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Set the User-Agent.
|
||||||
|
*
|
||||||
|
* May throw CURLException.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
void set_useragent(string_view useragent);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Set a proxy.
|
||||||
|
*
|
||||||
|
* For more information consult [CURLOPT_PROXY(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html).
|
||||||
|
*
|
||||||
|
* May throw CURLException.
|
||||||
|
*
|
||||||
|
* @since 0.1.1
|
||||||
|
*/
|
||||||
|
void set_proxy(string_view proxy);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Make a HTTP request.
|
||||||
|
*
|
||||||
|
* May throw CURLException.
|
||||||
|
*
|
||||||
|
* @param method The HTTP method.
|
||||||
|
* @param uri The full URI.
|
||||||
|
*
|
||||||
|
* @return The status code, headers and body of the page.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] answer make_http_request(http_method method, string_view uri);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Set maximum redirections to follow.
|
||||||
|
*
|
||||||
|
* For more information consult [CURLOPT_MAXREDIRS(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/CURLOPT_MAXREDIRS.html) and
|
||||||
|
* [CURLOPT_FOLLOWLOCATION(3)]
|
||||||
|
* (https://curl.haxx.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html).
|
||||||
|
*
|
||||||
|
* @param redirections Number of allowed redirections. If set to 0,
|
||||||
|
* CURLOPT_FOLLOWLOCATION is set to 0L. Set it to -1
|
||||||
|
* for an infinite number of redirects.
|
||||||
|
*
|
||||||
|
* @since 0.1.2
|
||||||
|
*/
|
||||||
|
void set_maxredirs(long redirections); // NOLINT(google-runtime-int)
|
||||||
|
|
||||||
|
private:
|
||||||
|
CURL *_connection{};
|
||||||
|
char _buffer_error[CURL_ERROR_SIZE]{};
|
||||||
|
string _buffer_headers;
|
||||||
|
string _buffer_body;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief libcurl write callback function.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
size_t writer_body(char *data, size_t size, size_t nmemb);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Wrapper for curl, because it can only call static member
|
||||||
|
* functions.
|
||||||
|
*
|
||||||
|
* <https://curl.haxx.se/docs/faq.html#Using_C_non_static_functions_f>
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
static inline size_t writer_body_wrapper(char *data, size_t sz,
|
||||||
|
size_t nmemb, void *f)
|
||||||
|
{
|
||||||
|
return static_cast<CURLWrapper *>(f)->writer_body(data, sz, nmemb);
|
||||||
|
}
|
||||||
|
|
||||||
|
//! @copydoc writer_body
|
||||||
|
size_t writer_headers(char *data, size_t size, size_t nmemb);
|
||||||
|
|
||||||
|
//! @copydoc writer_body_wrapper
|
||||||
|
static inline size_t writer_headers_wrapper(char *data, size_t sz,
|
||||||
|
size_t nmemb, void *f)
|
||||||
|
{
|
||||||
|
return static_cast<CURLWrapper *>(f)->writer_headers(data, sz, nmemb);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Throw CURLException if command doesn't return CURLE_OK.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
void check(CURLcode code);
|
||||||
|
};
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Exception for libcurl errors.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
class CURLException : public std::exception
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
/*!
|
||||||
|
* @brief Constructor with error code.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
explicit CURLException(const CURLcode code)
|
||||||
|
: error_code{code}
|
||||||
|
{}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Constructor with error code and error buffer.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
explicit CURLException(const CURLcode code, string_view error_buffer)
|
||||||
|
: error_code{code}
|
||||||
|
, _error_message{error_buffer}
|
||||||
|
{}
|
||||||
|
|
||||||
|
const CURLcode error_code; //!< Error code from libcurl.
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Error message.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] const char *what() const noexcept override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
string _error_message;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
||||||
|
|
||||||
|
#endif // CURL_WRAPPER_HPP
|
|
@ -0,0 +1,51 @@
|
||||||
|
/* This file is part of curl_wrapper.
|
||||||
|
* 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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "types.hpp"
|
||||||
|
|
||||||
|
#include <algorithm>
|
||||||
|
#include <cctype>
|
||||||
|
#include <string>
|
||||||
|
#include <string_view>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::tolower;
|
||||||
|
|
||||||
|
std::string_view answer::get_header(const std::string_view field) const
|
||||||
|
{
|
||||||
|
const string searchstring{string(field) += ":"};
|
||||||
|
// clang-format off
|
||||||
|
auto it{std::search(headers.begin(), headers.end(), searchstring.begin(),
|
||||||
|
searchstring.end(),
|
||||||
|
[](unsigned char a, unsigned char b)
|
||||||
|
{ return tolower(a) == tolower(b); })};
|
||||||
|
// clang-format on
|
||||||
|
|
||||||
|
if (it != headers.end())
|
||||||
|
{
|
||||||
|
auto pos{static_cast<size_t>(it - headers.begin())};
|
||||||
|
pos = headers.find(':', pos) + 1;
|
||||||
|
pos = headers.find_first_not_of(' ', pos);
|
||||||
|
const auto endpos{headers.find_first_of("\r\n", pos)};
|
||||||
|
return string_view(&headers[pos], endpos - pos);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
|
@ -0,0 +1,106 @@
|
||||||
|
/* This file is part of curl_wrapper.
|
||||||
|
* 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 CURL_WRAPPER_TYPES_HPP
|
||||||
|
#define CURL_WRAPPER_TYPES_HPP
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
#include <ostream>
|
||||||
|
#include <string>
|
||||||
|
#include <string_view>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::ostream;
|
||||||
|
using std::string;
|
||||||
|
using std::string_view;
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief The HTTP method.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
enum class http_method
|
||||||
|
{
|
||||||
|
DELETE,
|
||||||
|
GET,
|
||||||
|
HEAD,
|
||||||
|
PATCH,
|
||||||
|
POST,
|
||||||
|
PUT
|
||||||
|
};
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Return type for network requests.
|
||||||
|
*
|
||||||
|
* Currently only HTTP is considered.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
struct answer
|
||||||
|
{
|
||||||
|
std::uint16_t status{0}; //!< Status code.
|
||||||
|
string headers; //!< The headers of the response from the server.
|
||||||
|
string body; //!< The response from the server.
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Returns true if #status is 200.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] inline explicit operator bool() const
|
||||||
|
{
|
||||||
|
return (status == 200);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Returns std::string_view of the #body.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] inline explicit operator string_view() const
|
||||||
|
{
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Returns #body as std::ostream.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
inline friend ostream &operator<<(ostream &out, const answer &answer)
|
||||||
|
{
|
||||||
|
out << answer.body;
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @brief Returns the value of a header field.
|
||||||
|
*
|
||||||
|
* @param field Case insensitive, ASCII only.
|
||||||
|
*
|
||||||
|
* @return A std::string_view to the value of the header field or {} if not
|
||||||
|
* found.
|
||||||
|
*
|
||||||
|
* @since 0.1.0
|
||||||
|
*/
|
||||||
|
[[nodiscard]] string_view get_header(string_view field) const;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
||||||
|
|
||||||
|
#endif // CURL_WRAPPER_TYPES_HPP
|
|
@ -0,0 +1,37 @@
|
||||||
|
include(CTest)
|
||||||
|
|
||||||
|
file(GLOB sources_tests "test_*.cpp")
|
||||||
|
|
||||||
|
find_package(Catch2 CONFIG)
|
||||||
|
if(Catch2_FOUND) # Catch 2.x
|
||||||
|
include(Catch)
|
||||||
|
add_executable(all_tests main.cpp ${sources_tests})
|
||||||
|
set_target_properties(all_tests
|
||||||
|
PROPERTIES
|
||||||
|
CXX_STANDARD 17
|
||||||
|
CXX_STANDARD_REQUIRED ON
|
||||||
|
CXX_EXTENSIONS OFF)
|
||||||
|
target_link_libraries(all_tests
|
||||||
|
PRIVATE Catch2::Catch2 ${PROJECT_NAME})
|
||||||
|
target_include_directories(all_tests PRIVATE "/usr/include/catch2")
|
||||||
|
catch_discover_tests(all_tests EXTRA_ARGS "${EXTRA_TEST_ARGS}")
|
||||||
|
else() # Catch 1.x
|
||||||
|
if(EXISTS "/usr/include/catch.hpp")
|
||||||
|
message(STATUS "Catch 1.x found.")
|
||||||
|
foreach(src ${sources_tests})
|
||||||
|
get_filename_component(bin "${src}" NAME_WE)
|
||||||
|
add_executable(${bin} "main.cpp" "${src}")
|
||||||
|
set_target_properties(${bin}
|
||||||
|
PROPERTIES
|
||||||
|
CXX_STANDARD 17
|
||||||
|
CXX_STANDARD_REQUIRED ON
|
||||||
|
CXX_EXTENSIONS OFF)
|
||||||
|
target_link_libraries(${bin}
|
||||||
|
PRIVATE ${PROJECT_NAME})
|
||||||
|
add_test(${bin} ${bin} "${EXTRA_TEST_ARGS}")
|
||||||
|
endforeach()
|
||||||
|
else()
|
||||||
|
message(FATAL_ERROR
|
||||||
|
"Neither Catch 2.x nor Catch 1.x could be found.")
|
||||||
|
endif()
|
||||||
|
endif()
|
|
@ -0,0 +1,3 @@
|
||||||
|
#define CATCH_CONFIG_MAIN
|
||||||
|
|
||||||
|
#include <catch.hpp>
|
|
@ -0,0 +1,62 @@
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
|
|
||||||
|
#include <catch.hpp>
|
||||||
|
|
||||||
|
#include <exception>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::string;
|
||||||
|
|
||||||
|
SCENARIO("URL encoding / decoding")
|
||||||
|
{
|
||||||
|
const string text_raw{"Hüpfburg am rande!"};
|
||||||
|
const string text_escaped("H%C3%BCpfburg%20am%20rande%21");
|
||||||
|
|
||||||
|
bool exception = false;
|
||||||
|
string answer;
|
||||||
|
|
||||||
|
WHEN("Encoding " + text_raw)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
CURLWrapper curl;
|
||||||
|
answer = curl.escape_url(text_raw);
|
||||||
|
}
|
||||||
|
catch (const std::exception &e)
|
||||||
|
{
|
||||||
|
exception = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
THEN("No exception is thrown")
|
||||||
|
AND_THEN("The text is successfully encoded")
|
||||||
|
{
|
||||||
|
REQUIRE_FALSE(exception);
|
||||||
|
REQUIRE(answer == text_escaped);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
WHEN("Decoding " + text_escaped)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
CURLWrapper curl;
|
||||||
|
answer = curl.unescape_url(text_escaped);
|
||||||
|
}
|
||||||
|
catch (const std::exception &e)
|
||||||
|
{
|
||||||
|
exception = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
THEN("No exception is thrown")
|
||||||
|
AND_THEN("The text is successfully decoded")
|
||||||
|
{
|
||||||
|
REQUIRE_FALSE(exception);
|
||||||
|
REQUIRE(answer == text_raw);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
|
@ -0,0 +1,41 @@
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
|
|
||||||
|
#include <catch.hpp>
|
||||||
|
|
||||||
|
#include <exception>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::string;
|
||||||
|
|
||||||
|
SCENARIO("HTTP GET", "[http]")
|
||||||
|
{
|
||||||
|
const string uri{"https://schlomp.space/api/v1/version"};
|
||||||
|
|
||||||
|
bool exception = false;
|
||||||
|
string answer;
|
||||||
|
|
||||||
|
WHEN("GETing " + uri)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
CURLWrapper curl;
|
||||||
|
answer = curl.make_http_request(http_method::GET, uri).body;
|
||||||
|
}
|
||||||
|
catch (const std::exception &e)
|
||||||
|
{
|
||||||
|
exception = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
THEN("No exception is thrown")
|
||||||
|
AND_THEN("We get the right answer")
|
||||||
|
{
|
||||||
|
REQUIRE_FALSE(exception);
|
||||||
|
REQUIRE(answer.substr(0, 11) == R"({"version":)");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
|
@ -0,0 +1,75 @@
|
||||||
|
#include "types.hpp"
|
||||||
|
|
||||||
|
#include <catch.hpp>
|
||||||
|
|
||||||
|
#include <exception>
|
||||||
|
#include <iostream>
|
||||||
|
#include <locale>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
namespace curl_wrapper
|
||||||
|
{
|
||||||
|
|
||||||
|
using std::string;
|
||||||
|
|
||||||
|
SCENARIO("Extract header")
|
||||||
|
{
|
||||||
|
answer ret;
|
||||||
|
ret.headers = R"(HTTP/1.1 200 OK
|
||||||
|
Server: nginx/1.18.0
|
||||||
|
Date: Sat, 07 Nov 2020 22:26:13 GMT
|
||||||
|
Content-Type: application/rss+xml; charset=utf-8
|
||||||
|
Connection: keep-alive
|
||||||
|
Keep-Alive: timeout=20
|
||||||
|
Expires: Sat, 07 Nov 2020 22:56:13 GMT
|
||||||
|
Cache-Control: max-age=1800
|
||||||
|
X-Cache: HIT
|
||||||
|
X-UmläÜt: 🙂
|
||||||
|
)";
|
||||||
|
bool exception = false;
|
||||||
|
string value;
|
||||||
|
|
||||||
|
WHEN("We search for “cache-control”")
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
value = ret.get_header("cache-control");
|
||||||
|
}
|
||||||
|
catch (const std::exception &e)
|
||||||
|
{
|
||||||
|
std::cerr << "Exception: " << e.what() << '\n';
|
||||||
|
exception = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
THEN("No exception is thrown")
|
||||||
|
AND_THEN("The value is successfully extracted")
|
||||||
|
{
|
||||||
|
REQUIRE_FALSE(exception);
|
||||||
|
REQUIRE(value == "max-age=1800");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WHEN("We search for “X-UMLÄÜT”")
|
||||||
|
// {
|
||||||
|
// std::locale::global(std::locale("de_DE.UTF-8"));
|
||||||
|
//
|
||||||
|
// try
|
||||||
|
// {
|
||||||
|
// value = ret.get_header("X-UMLÄÜT");
|
||||||
|
// }
|
||||||
|
// catch (const std::exception &e)
|
||||||
|
// {
|
||||||
|
// std::cerr << "Exception: " << e.what() << '\n';
|
||||||
|
// exception = true;
|
||||||
|
// }
|
||||||
|
|
||||||
|
// THEN("No exception is thrown")
|
||||||
|
// AND_THEN("The value is successfully extracted")
|
||||||
|
// {
|
||||||
|
// REQUIRE_FALSE(exception);
|
||||||
|
// REQUIRE(value == "🙂");
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace curl_wrapper
|
|
@ -1,5 +1,5 @@
|
||||||
/* This file is part of mastorss.
|
/* This file is part of mastorss.
|
||||||
* Copyright © 2019, 2020 tastytea <tastytea@tastytea.de>
|
* Copyright © 2019-2021 tastytea <tastytea@tastytea.de>
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* 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
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
@ -16,6 +16,7 @@
|
||||||
|
|
||||||
#include "document.hpp"
|
#include "document.hpp"
|
||||||
|
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
#include "exceptions.hpp"
|
#include "exceptions.hpp"
|
||||||
#include "version.hpp"
|
#include "version.hpp"
|
||||||
|
|
||||||
|
@ -24,7 +25,6 @@
|
||||||
#include <boost/regex.hpp>
|
#include <boost/regex.hpp>
|
||||||
#include <json/json.h>
|
#include <json/json.h>
|
||||||
#include <mastodonpp/mastodonpp.hpp>
|
#include <mastodonpp/mastodonpp.hpp>
|
||||||
#include <restclient-cpp/connection.h>
|
|
||||||
|
|
||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
#include <fstream>
|
#include <fstream>
|
||||||
|
@ -54,39 +54,29 @@ Document::Document(Config &cfg)
|
||||||
: _cfg{cfg}
|
: _cfg{cfg}
|
||||||
, _profiledata{_cfg.profiledata}
|
, _profiledata{_cfg.profiledata}
|
||||||
{
|
{
|
||||||
RestClient::init();
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Initialized RestClient.";
|
|
||||||
|
|
||||||
download();
|
download();
|
||||||
}
|
}
|
||||||
|
|
||||||
Document::~Document()
|
|
||||||
{
|
|
||||||
RestClient::disable();
|
|
||||||
}
|
|
||||||
|
|
||||||
void Document::download(const string &uri, const bool temp_redirect)
|
void Document::download(const string &uri, const bool temp_redirect)
|
||||||
{
|
{
|
||||||
|
namespace cw = curl_wrapper;
|
||||||
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Downloading <" << uri << "> …";
|
BOOST_LOG_TRIVIAL(debug) << "Downloading <" << uri << "> …";
|
||||||
RestClient::Connection connection{uri};
|
cw::CURLWrapper curl;
|
||||||
connection.SetUserAgent(string("mastorss/").append(version));
|
curl.set_useragent(string("mastorss/") += version);
|
||||||
connection.FollowRedirects(false);
|
curl.set_maxredirs(0);
|
||||||
|
|
||||||
RestClient::Response response{connection.get("")};
|
const auto answer{curl.make_http_request(cw::http_method::GET, uri)};
|
||||||
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Got response: " << response.code;
|
BOOST_LOG_TRIVIAL(debug) << "Got response: " << answer.status;
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Got Headers:";
|
BOOST_LOG_TRIVIAL(debug) << "Got Headers:";
|
||||||
for (const auto &header : response.headers)
|
BOOST_LOG_TRIVIAL(debug) << answer.headers;
|
||||||
{
|
|
||||||
BOOST_LOG_TRIVIAL(debug)
|
|
||||||
<< " " << header.first << ": " << header.second;
|
|
||||||
}
|
|
||||||
|
|
||||||
switch (response.code)
|
switch (answer.status)
|
||||||
{
|
{
|
||||||
case 200:
|
case 200:
|
||||||
{
|
{
|
||||||
_raw_doc = response.body;
|
_raw_doc = answer.body;
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Downloaded feed: " << _profiledata.feedurl;
|
BOOST_LOG_TRIVIAL(debug) << "Downloaded feed: " << _profiledata.feedurl;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
@ -97,10 +87,10 @@ void Document::download(const string &uri, const bool temp_redirect)
|
||||||
{
|
{
|
||||||
goto temporary_redirect; // NOLINT(cppcoreguidelines-avoid-goto)
|
goto temporary_redirect; // NOLINT(cppcoreguidelines-avoid-goto)
|
||||||
}
|
}
|
||||||
_profiledata.feedurl = extract_location(response.headers);
|
_profiledata.feedurl = extract_location(answer);
|
||||||
if (_profiledata.feedurl.empty())
|
if (_profiledata.feedurl.empty())
|
||||||
{
|
{
|
||||||
throw HTTPException{response.code};
|
throw HTTPException{answer.status};
|
||||||
}
|
}
|
||||||
|
|
||||||
// clang-format off
|
// clang-format off
|
||||||
|
@ -116,10 +106,10 @@ void Document::download(const string &uri, const bool temp_redirect)
|
||||||
case 307:
|
case 307:
|
||||||
{
|
{
|
||||||
temporary_redirect:
|
temporary_redirect:
|
||||||
const string newuri{extract_location(response.headers)};
|
const string newuri{extract_location(answer)};
|
||||||
if (newuri.empty())
|
if (newuri.empty())
|
||||||
{
|
{
|
||||||
throw HTTPException{response.code};
|
throw HTTPException{answer.status};
|
||||||
}
|
}
|
||||||
|
|
||||||
// clang-format off
|
// clang-format off
|
||||||
|
@ -129,13 +119,9 @@ temporary_redirect:
|
||||||
download(newuri, true);
|
download(newuri, true);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case -1:
|
|
||||||
{
|
|
||||||
throw CURLException{errno};
|
|
||||||
}
|
|
||||||
default:
|
default:
|
||||||
{
|
{
|
||||||
throw HTTPException{response.code};
|
throw HTTPException{answer.status};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -147,7 +133,10 @@ void Document::download()
|
||||||
|
|
||||||
void Document::parse()
|
void Document::parse()
|
||||||
{
|
{
|
||||||
parse_watchwords();
|
if (_profiledata.add_hashtags)
|
||||||
|
{
|
||||||
|
parse_watchwords();
|
||||||
|
}
|
||||||
pt::ptree tree;
|
pt::ptree tree;
|
||||||
istringstream iss{_raw_doc};
|
istringstream iss{_raw_doc};
|
||||||
pt::read_xml(iss, tree);
|
pt::read_xml(iss, tree);
|
||||||
|
@ -165,8 +154,16 @@ void Document::parse()
|
||||||
|
|
||||||
void Document::parse_rss(const pt::ptree &tree)
|
void Document::parse_rss(const pt::ptree &tree)
|
||||||
{
|
{
|
||||||
|
size_t counter{0};
|
||||||
for (const auto &child : tree.get_child("rss.channel"))
|
for (const auto &child : tree.get_child("rss.channel"))
|
||||||
{
|
{
|
||||||
|
if (counter == Config::max_guids)
|
||||||
|
{
|
||||||
|
BOOST_LOG_TRIVIAL(debug)
|
||||||
|
<< "Maximum number of items reached. Stopped parsing.";
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
++counter;
|
||||||
if (child.first == "item")
|
if (child.first == "item")
|
||||||
{
|
{
|
||||||
const auto &rssitem = child.second;
|
const auto &rssitem = child.second;
|
||||||
|
@ -213,7 +210,11 @@ void Document::parse_rss(const pt::ptree &tree)
|
||||||
desc = regex_replace(desc, regex{fix}, "");
|
desc = regex_replace(desc, regex{fix}, "");
|
||||||
}
|
}
|
||||||
desc = remove_html(desc);
|
desc = remove_html(desc);
|
||||||
return add_hashtags(desc);
|
if (_profiledata.add_hashtags)
|
||||||
|
{
|
||||||
|
desc = add_hashtags(desc);
|
||||||
|
}
|
||||||
|
return desc;
|
||||||
}();
|
}();
|
||||||
// clang-format on
|
// clang-format on
|
||||||
item.guid = move(guid);
|
item.guid = move(guid);
|
||||||
|
@ -223,7 +224,7 @@ void Document::parse_rss(const pt::ptree &tree)
|
||||||
|
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Found GUID: " << item.guid;
|
BOOST_LOG_TRIVIAL(debug) << "Found GUID: " << item.guid;
|
||||||
|
|
||||||
if (_profiledata.guids.empty())
|
if (_profiledata.guids.empty() && !_profiledata.keep_looking)
|
||||||
{
|
{
|
||||||
BOOST_LOG_TRIVIAL(debug) << "This is the first run.";
|
BOOST_LOG_TRIVIAL(debug) << "This is the first run.";
|
||||||
break;
|
break;
|
||||||
|
@ -232,11 +233,12 @@ void Document::parse_rss(const pt::ptree &tree)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
string Document::remove_html(string html) const
|
string Document::remove_html(string html)
|
||||||
{
|
{
|
||||||
html = mastodonpp::unescape_html(html); // Decode HTML entities.
|
html = mastodonpp::unescape_html(html); // Decode HTML entities.
|
||||||
|
|
||||||
html = regex_replace(html, regex{"<p>"}, "\n\n");
|
html = regex_replace(html, regex{"<p>"}, "\n\n");
|
||||||
|
html = regex_replace(html, regex{"<br>"}, "\n");
|
||||||
|
|
||||||
const list re_list{regex{R"(<!\[CDATA\[)"}, // CDATA beginning.
|
const list re_list{regex{R"(<!\[CDATA\[)"}, // CDATA beginning.
|
||||||
regex{R"(\]\]>)"}, // CDATA end.
|
regex{R"(\]\]>)"}, // CDATA end.
|
||||||
|
@ -259,23 +261,13 @@ string Document::remove_html(string html) const
|
||||||
return html;
|
return html;
|
||||||
}
|
}
|
||||||
|
|
||||||
string Document::extract_location(const RestClient::HeaderFields &headers) const
|
string Document::extract_location(const curl_wrapper::answer &answer)
|
||||||
{
|
{
|
||||||
string location;
|
string location{answer.get_header("Location")};
|
||||||
try
|
|
||||||
|
if (location.empty())
|
||||||
{
|
{
|
||||||
location = headers.at("Location");
|
throw std::runtime_error{"Could not extract new feed location."};
|
||||||
}
|
|
||||||
catch (const std::out_of_range &)
|
|
||||||
{
|
|
||||||
try
|
|
||||||
{
|
|
||||||
location = headers.at("location");
|
|
||||||
}
|
|
||||||
catch (const std::out_of_range &)
|
|
||||||
{
|
|
||||||
throw std::runtime_error{"Could not extract new feed location."};
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return location;
|
return location;
|
||||||
|
@ -299,7 +291,7 @@ void Document::parse_watchwords()
|
||||||
{
|
{
|
||||||
Json::Value json;
|
Json::Value json;
|
||||||
const auto filepath = _cfg.get_config_dir() /= "watchwords.json";
|
const auto filepath = _cfg.get_config_dir() /= "watchwords.json";
|
||||||
ifstream file{filepath};
|
ifstream file(filepath.c_str());
|
||||||
if (file.good())
|
if (file.good())
|
||||||
{
|
{
|
||||||
stringstream rawjson;
|
stringstream rawjson;
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/* This file is part of mastorss.
|
/* This file is part of mastorss.
|
||||||
* Copyright © 2019 tastytea <tastytea@tastytea.de>
|
* Copyright © 2019-2021 tastytea <tastytea@tastytea.de>
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* 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
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
@ -18,18 +18,18 @@
|
||||||
#define MASTORSS_DOCUMENT_HPP
|
#define MASTORSS_DOCUMENT_HPP
|
||||||
|
|
||||||
#include "config.hpp"
|
#include "config.hpp"
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
|
|
||||||
#include <boost/property_tree/ptree.hpp>
|
#include <boost/property_tree/ptree.hpp>
|
||||||
#include <restclient-cpp/restclient.h>
|
|
||||||
|
|
||||||
#include <string>
|
|
||||||
#include <list>
|
#include <list>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
namespace mastorss
|
namespace mastorss
|
||||||
{
|
{
|
||||||
namespace pt = boost::property_tree;
|
namespace pt = boost::property_tree;
|
||||||
using std::string;
|
|
||||||
using std::list;
|
using std::list;
|
||||||
|
using std::string;
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* @brief An Item of a feed.
|
* @brief An Item of a feed.
|
||||||
|
@ -43,7 +43,7 @@ struct Item
|
||||||
string link;
|
string link;
|
||||||
string title;
|
string title;
|
||||||
|
|
||||||
friend bool operator !=(const Item &a, const Item &b);
|
friend bool operator!=(const Item &a, const Item &b);
|
||||||
};
|
};
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
@ -55,7 +55,6 @@ class Document
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
explicit Document(Config &cfg);
|
explicit Document(Config &cfg);
|
||||||
~Document();
|
|
||||||
Document(const Document &other) = default;
|
Document(const Document &other) = default;
|
||||||
Document &operator=(const Document &other) = delete;
|
Document &operator=(const Document &other) = delete;
|
||||||
Document(Document &&other) = default;
|
Document(Document &&other) = default;
|
||||||
|
@ -83,15 +82,14 @@ private:
|
||||||
*
|
*
|
||||||
* @since 0.10.0
|
* @since 0.10.0
|
||||||
*/
|
*/
|
||||||
void download(const string &uri, const bool temp_redirect = false);
|
void download(const string &uri, bool temp_redirect = false);
|
||||||
void parse_rss(const pt::ptree &tree);
|
void parse_rss(const pt::ptree &tree);
|
||||||
[[nodiscard]]
|
[[nodiscard]] static string remove_html(string html);
|
||||||
string remove_html(string html) const;
|
[[nodiscard]] static string
|
||||||
[[nodiscard]]
|
extract_location(const curl_wrapper::answer &answer);
|
||||||
string extract_location(const RestClient::HeaderFields &headers) const;
|
|
||||||
string add_hashtags(const string &text);
|
string add_hashtags(const string &text);
|
||||||
void parse_watchwords();
|
void parse_watchwords();
|
||||||
};
|
};
|
||||||
} // namespace mastorss
|
} // namespace mastorss
|
||||||
|
|
||||||
#endif // MASTORSS_DOCUMENT_HPP
|
#endif // MASTORSS_DOCUMENT_HPP
|
||||||
|
|
153
src/main.cpp
153
src/main.cpp
|
@ -15,6 +15,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "config.hpp"
|
#include "config.hpp"
|
||||||
|
#include "curl_wrapper.hpp"
|
||||||
#include "document.hpp"
|
#include "document.hpp"
|
||||||
#include "exceptions.hpp"
|
#include "exceptions.hpp"
|
||||||
#include "mastoapi.hpp"
|
#include "mastoapi.hpp"
|
||||||
|
@ -34,22 +35,28 @@
|
||||||
|
|
||||||
namespace mastorss
|
namespace mastorss
|
||||||
{
|
{
|
||||||
|
|
||||||
using std::cerr;
|
using std::cerr;
|
||||||
using std::cout;
|
using std::cout;
|
||||||
|
using std::runtime_error;
|
||||||
|
using std::string_view;
|
||||||
|
using std::chrono::seconds;
|
||||||
|
using std::this_thread::sleep_for;
|
||||||
|
|
||||||
namespace error
|
namespace error
|
||||||
{
|
{
|
||||||
constexpr int noprofile = 1;
|
constexpr int noprofile = 1;
|
||||||
constexpr int network = 2;
|
constexpr int network = 2;
|
||||||
constexpr int file = 3;
|
constexpr int file = 3;
|
||||||
constexpr int mastodon = 4;
|
// constexpr int mastodon = 4;
|
||||||
constexpr int json = 5;
|
constexpr int json = 5;
|
||||||
constexpr int parse = 6;
|
constexpr int parse = 6;
|
||||||
constexpr int unknown = 9;
|
constexpr int unknown = 9;
|
||||||
} // namespace error
|
} // namespace error
|
||||||
|
|
||||||
void print_version();
|
void print_version();
|
||||||
void print_help(const string_view &command);
|
void print_help(string_view command);
|
||||||
|
int run(string_view profile_name, bool dry_run);
|
||||||
|
|
||||||
void print_version()
|
void print_version()
|
||||||
{
|
{
|
||||||
|
@ -63,22 +70,94 @@ void print_version()
|
||||||
"and you are welcome to redistribute it under certain conditions.\n";
|
"and you are welcome to redistribute it under certain conditions.\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
void print_help(const string_view &command)
|
void print_help(const string_view command)
|
||||||
{
|
{
|
||||||
cerr << "Usage: " << command << " [--version|--help] <profile>\n";
|
cerr << "Usage: " << command << " [--version|--help|--dry-run] <profile>\n"
|
||||||
|
<< "See manpage for details.\n";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
int run(const string_view profile_name, const bool dry_run)
|
||||||
|
{
|
||||||
|
const string_view profilename{profile_name};
|
||||||
|
BOOST_LOG_TRIVIAL(debug) << "Using profile: " << profilename;
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
Config cfg{profilename.data()};
|
||||||
|
Document doc{cfg};
|
||||||
|
doc.parse();
|
||||||
|
|
||||||
|
MastoAPI masto{cfg.profiledata};
|
||||||
|
if (!doc.new_items.empty())
|
||||||
|
{
|
||||||
|
for (const auto &item : doc.new_items)
|
||||||
|
{
|
||||||
|
masto.post_item(item, dry_run);
|
||||||
|
if (item != *doc.new_items.rbegin())
|
||||||
|
{ // Don't sleep if this is the last item.
|
||||||
|
if (!dry_run)
|
||||||
|
{
|
||||||
|
sleep_for(seconds(cfg.profiledata.interval));
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
sleep_for(seconds(1));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!dry_run)
|
||||||
|
{
|
||||||
|
cfg.write();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (const FileException &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::file;
|
||||||
|
}
|
||||||
|
catch (const HTTPException &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::network;
|
||||||
|
}
|
||||||
|
catch (const CURLException &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::network;
|
||||||
|
}
|
||||||
|
catch (const curl_wrapper::CURLException &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::network;
|
||||||
|
}
|
||||||
|
catch (const Json::RuntimeError &e)
|
||||||
|
{
|
||||||
|
cerr << "JSON error:\n" << e.what() << '\n';
|
||||||
|
return error::json;
|
||||||
|
}
|
||||||
|
catch (const ParseException &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::parse;
|
||||||
|
}
|
||||||
|
catch (const runtime_error &e)
|
||||||
|
{
|
||||||
|
cerr << e.what() << '\n';
|
||||||
|
return error::unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
} // namespace mastorss
|
} // namespace mastorss
|
||||||
|
|
||||||
int main(int argc, char *argv[])
|
int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
using namespace mastorss;
|
using namespace mastorss;
|
||||||
using std::cerr;
|
|
||||||
using std::getenv;
|
using std::getenv;
|
||||||
using std::runtime_error;
|
|
||||||
using std::string_view;
|
using std::string_view;
|
||||||
using std::vector;
|
using std::vector;
|
||||||
using std::chrono::seconds;
|
|
||||||
using std::this_thread::sleep_for;
|
|
||||||
|
|
||||||
const vector<string_view> args(argv, argv + argc);
|
const vector<string_view> args(argv, argv + argc);
|
||||||
|
|
||||||
|
@ -109,61 +188,13 @@ int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
print_help(args[0]);
|
print_help(args[0]);
|
||||||
}
|
}
|
||||||
|
else if (args[1] == "--dry-run")
|
||||||
|
{
|
||||||
|
return run(args[2], true);
|
||||||
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
const string_view profilename{args[1]};
|
return run(args[1], false);
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Using profile: " << profilename;
|
|
||||||
|
|
||||||
try
|
|
||||||
{
|
|
||||||
Config cfg{profilename.data()};
|
|
||||||
Document doc{cfg};
|
|
||||||
doc.parse();
|
|
||||||
|
|
||||||
MastoAPI masto{cfg.profiledata};
|
|
||||||
if (!doc.new_items.empty())
|
|
||||||
{
|
|
||||||
for (const auto &item : doc.new_items)
|
|
||||||
{
|
|
||||||
masto.post_item(item);
|
|
||||||
if (item != *doc.new_items.rbegin())
|
|
||||||
{ // Don't sleep if this is the last item.
|
|
||||||
sleep_for(seconds(cfg.profiledata.interval));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
cfg.write();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
catch (const FileException &e)
|
|
||||||
{
|
|
||||||
cerr << e.what() << '\n';
|
|
||||||
return error::file;
|
|
||||||
}
|
|
||||||
catch (const HTTPException &e)
|
|
||||||
{
|
|
||||||
cerr << e.what() << '\n';
|
|
||||||
return error::network;
|
|
||||||
}
|
|
||||||
catch (const CURLException &e)
|
|
||||||
{
|
|
||||||
cerr << e.what() << '\n';
|
|
||||||
return error::network;
|
|
||||||
}
|
|
||||||
catch (const Json::RuntimeError &e)
|
|
||||||
{
|
|
||||||
cerr << "JSON error:\n" << e.what() << '\n';
|
|
||||||
return error::json;
|
|
||||||
}
|
|
||||||
catch (const ParseException &e)
|
|
||||||
{
|
|
||||||
cerr << e.what() << '\n';
|
|
||||||
return error::parse;
|
|
||||||
}
|
|
||||||
catch (const runtime_error &e)
|
|
||||||
{
|
|
||||||
cerr << e.what() << '\n';
|
|
||||||
return error::unknown;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/* This file is part of mastorss.
|
/* This file is part of mastorss.
|
||||||
* Copyright © 2019, 2020 tastytea <tastytea@tastytea.de>
|
* Copyright © 2019-2021 tastytea <tastytea@tastytea.de>
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* 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
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
@ -14,12 +14,14 @@
|
||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "exceptions.hpp"
|
|
||||||
#include "mastoapi.hpp"
|
#include "mastoapi.hpp"
|
||||||
|
|
||||||
|
#include "exceptions.hpp"
|
||||||
|
|
||||||
#include <boost/log/trivial.hpp>
|
#include <boost/log/trivial.hpp>
|
||||||
#include <boost/regex.hpp>
|
#include <boost/regex.hpp>
|
||||||
|
|
||||||
|
#include <iostream>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include <string_view>
|
#include <string_view>
|
||||||
|
|
||||||
|
@ -33,14 +35,14 @@ using std::string_view;
|
||||||
MastoAPI::MastoAPI(ProfileData &data)
|
MastoAPI::MastoAPI(ProfileData &data)
|
||||||
: _profile{data}
|
: _profile{data}
|
||||||
, _instance{_profile.instance, _profile.access_token}
|
, _instance{_profile.instance, _profile.access_token}
|
||||||
{
|
{}
|
||||||
}
|
|
||||||
|
|
||||||
void MastoAPI::post_item(const Item &item)
|
void MastoAPI::post_item(const Item &item, bool dry_run)
|
||||||
{
|
{
|
||||||
string title = replacements_apply(item.title);
|
string title = replacements_apply(item.title);
|
||||||
string link = replacements_apply(item.link);
|
string link = replacements_apply(item.link);
|
||||||
|
|
||||||
|
// clang-format off
|
||||||
string status{[&]
|
string status{[&]
|
||||||
{
|
{
|
||||||
if (_profile.titles_as_cw)
|
if (_profile.titles_as_cw)
|
||||||
|
@ -59,7 +61,9 @@ void MastoAPI::post_item(const Item &item)
|
||||||
}
|
}
|
||||||
return s;
|
return s;
|
||||||
}()};
|
}()};
|
||||||
|
// clang-format on
|
||||||
|
|
||||||
|
// clang-format off
|
||||||
const size_t len_append{[&]
|
const size_t len_append{[&]
|
||||||
{
|
{
|
||||||
if (_profile.append.empty())
|
if (_profile.append.empty())
|
||||||
|
@ -77,6 +81,7 @@ void MastoAPI::post_item(const Item &item)
|
||||||
}
|
}
|
||||||
return _profile.max_size;
|
return _profile.max_size;
|
||||||
}() - link.size() - 2 - len_append};
|
}() - link.size() - 2 - len_append};
|
||||||
|
// clang-format off
|
||||||
BOOST_LOG_TRIVIAL(debug)
|
BOOST_LOG_TRIVIAL(debug)
|
||||||
<< "Maximum text (without link and appendix) length: " << len_max;
|
<< "Maximum text (without link and appendix) length: " << len_max;
|
||||||
|
|
||||||
|
@ -105,26 +110,41 @@ void MastoAPI::post_item(const Item &item)
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Status length: " << status.size();
|
BOOST_LOG_TRIVIAL(debug) << "Status length: " << status.size();
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Status: \"" << status << '"';
|
BOOST_LOG_TRIVIAL(debug) << "Status: \"" << status << '"';
|
||||||
|
|
||||||
mastodonpp::parametermap params{{"status", status}};
|
if (!dry_run)
|
||||||
if (_profile.titles_as_cw)
|
|
||||||
{
|
{
|
||||||
params.insert({"spoiler_text", title});
|
mastodonpp::parametermap params{{"status", status}};
|
||||||
}
|
if (_profile.titles_as_cw)
|
||||||
|
|
||||||
mastodonpp::Connection connection{_instance};
|
|
||||||
const auto ret = connection.post(mastodonpp::API::v1::statuses, params);
|
|
||||||
if (!ret)
|
|
||||||
{
|
|
||||||
if (ret.http_status != 200)
|
|
||||||
{
|
{
|
||||||
throw HTTPException{ret.http_status};
|
params.insert({"spoiler_text", title});
|
||||||
}
|
}
|
||||||
throw CURLException{ret.curl_error_code};
|
|
||||||
|
mastodonpp::Connection connection{_instance};
|
||||||
|
const auto ret = connection.post(mastodonpp::API::v1::statuses, params);
|
||||||
|
if (!ret)
|
||||||
|
{
|
||||||
|
if (ret.http_status != 200)
|
||||||
|
{
|
||||||
|
BOOST_LOG_TRIVIAL(debug) << "Error message from server: "
|
||||||
|
<< ret.body;
|
||||||
|
throw HTTPException{ret.http_status};
|
||||||
|
}
|
||||||
|
throw CURLException{ret.curl_error_code};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
using std::cout;
|
||||||
|
cout << " WOULD POST: \n";
|
||||||
|
if (_profile.titles_as_cw)
|
||||||
|
{
|
||||||
|
cout << "Subject: " << title << '\n';
|
||||||
|
}
|
||||||
|
cout << "Status:\n" << status << '\n';
|
||||||
}
|
}
|
||||||
BOOST_LOG_TRIVIAL(debug) << "Posted status with GUID: " << item.guid;
|
BOOST_LOG_TRIVIAL(debug) << "Posted status with GUID: " << item.guid;
|
||||||
|
|
||||||
_profile.guids.push_back(item.guid);
|
_profile.guids.push_back(item.guid);
|
||||||
if (_profile.guids.size() > _max_guids)
|
if (_profile.guids.size() > Config::max_guids)
|
||||||
{
|
{
|
||||||
_profile.guids.pop_front();
|
_profile.guids.pop_front();
|
||||||
}
|
}
|
||||||
|
|
|
@ -33,15 +33,14 @@ class MastoAPI
|
||||||
public:
|
public:
|
||||||
explicit MastoAPI(ProfileData &data);
|
explicit MastoAPI(ProfileData &data);
|
||||||
|
|
||||||
void post_item(const Item &item);
|
void post_item(const Item &item, bool dry_run);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
ProfileData &_profile;
|
ProfileData &_profile;
|
||||||
mastodonpp::Instance _instance;
|
mastodonpp::Instance _instance;
|
||||||
constexpr static size_t _max_guids{100};
|
|
||||||
|
|
||||||
string replacements_apply(const string &text);
|
string replacements_apply(const string &text);
|
||||||
};
|
};
|
||||||
} // namespace mastorss
|
} // namespace mastorss
|
||||||
|
|
||||||
#endif // MASTORSS_MASTOAPI_HPP
|
#endif // MASTORSS_MASTOAPI_HPP
|
||||||
|
|
Loading…
Reference in New Issue