pornsieve Namespace Reference

The namespace containing the pornsieve library. More...

Namespaces
	redtube
	Namespace for the RedTube API.

Classes
class	CURLException
	Exception for libcurl errors. More...
class	HTTPException
	Exception for HTTP errors. More...
struct	search_result
	Search results. More...

Typedefs
using	time_point = std::chrono::system_clock::time_point
	In this lib we use the system clock for our time points. More...

Enumerations
enum	result_order {   none, newest, mostviewed, rating,   longest, shortest, popular, popular_week,   popular_month }
	Order of the search results. More...
enum	media_type { video }
	Which type of media to search for. More...

Functions
void	configure_curl (CURL *curl_easy_handle)
	Set some options for curl connections. More...
vector< string >	json_to_vector (string_view json, string_view key)
	Converts a JSON array into a vector. More...
std::chrono::seconds	string_to_duration (string_view duration_string)
	Converts a duration from string to chrono seconds. More...
time_point	string_to_timepoint (string_view time_string)
	Converts a time from string to time_point. More...
string	timepoint_to_string (const system_clock::time_point &timepoint, string_view format="%FT%T")
	Return date and time as string in UTC. More...
void	init ()
	Global pornsieve initialization. More...
void	cleanup ()
	Global pornsieve cleanup. More...

Detailed Description

The namespace containing the pornsieve library.

Since

0.1.0

Typedef Documentation

time_point

typedef std::chrono::system_clock::time_point pornsieve::time_point

In this lib we use the system clock for our time points.

Enumeration Type Documentation

media_type

enum pornsieve::media_type

strong

Which type of media to search for.

Since

0.1.0

{
    video
};

result_order

enum pornsieve::result_order

strong

Order of the search results.

Not every source accepts every value.

Since

0.1.0

{
    none,
    newest,
    mostviewed,
    rating,
    longest,
    shortest,
    popular,
    popular_week,
    popular_month
};

Function Documentation

cleanup()

void pornsieve::cleanup

(

)

Global pornsieve cleanup.

This function must be called, only once, after you are done using pornsieve. Calls curl_global_cleanup(3). Not thread-safe.

Since

0.1.0

{
    curl_global_cleanup();
}

configure_curl()

void pornsieve::configure_curl

(

CURL *

curl_easy_handle

)

Set some options for curl connections.

This function is called every time a curl handle is created. It sets the user-agent and the proxy (if set in config::proxy).

Exceptions

pornsieve::CURLException

Since

0.1.0

{
    CURLcode code{};
 
    // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
    code = curl_easy_setopt(curl_easy_handle, CURLOPT_USERAGENT,
                            format("pornsieve/{:s}", version).data());
    if (code != CURLE_OK)
    {
        throw CURLException{code, "Could not set up user-agent"};
    }
 
    if (!config::proxy.empty())
    {
        // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg)
        code = curl_easy_setopt(curl_easy_handle, CURLOPT_PROXY,
                                config::proxy.data());
        if (code != CURLE_OK)
        {
            throw CURLException{code, "Could not set up proxy"};
        }
    }
}

init()

void pornsieve::init

(

)

Global pornsieve initialization.

This function must be called, only once, before anything else from the library is used. Calls curl_global_init(3). Not thread-safe.

Exceptions

pornsieve::CURLException

Thrown if curl_global_init() fails.

Since

0.1.0

{
    // NOLINTNEXTLINE(hicpp-signed-bitwise)
    const CURLcode code{curl_global_init(CURL_GLOBAL_ALL)};
    if (code != CURLE_OK)
    {
        throw CURLException{code, "Global libcurl init failed"};
    }
}

json_to_vector()

vector< string > pornsieve::json_to_vector	(	string_view	json,
		string_view	key
	)

Converts a JSON array into a vector.

Parameters

json	The JSON array as string.
key	The key which value to put into the vector.

Exceptions

nlohmann::detail::type_error

Thrown if the format of the JSON is different than expected.

Since

0.1.0

{
    vector<string> result;
    for (const auto &item : nlohmann::json::parse(json))
    {
        result.emplace_back(item[key.data()]);
    }
    return result;
}

string_to_duration()

std::chrono::seconds pornsieve::string_to_duration

(

string_view

duration_string

)

Converts a duration from string to chrono seconds.

Parameters

duration_string

Format: SS or MM:SS or HH:MM:SS.

Exceptions

-	See std::stoul

Since

0.1.0

{
    std::uint32_t seconds{0};
 
    size_t startpos{0};
    size_t endpos{0};
 
    while (true)
    {
        endpos = duration_string.find(':', startpos);
        seconds *= 60;
        seconds += static_cast<uint32_t>(std::stoul(
            duration_string.substr(startpos, endpos - startpos).data()));
        startpos = endpos + 1;
 
        // Not pretty, but cleanest way to break AFTER the seconds are added.
        if (endpos == string_view::npos)
        {
            break;
        }
    }
 
    return std::chrono::seconds{seconds};
}

string_to_timepoint()

time_point pornsieve::string_to_timepoint

(

string_view

time_string

)

Converts a time from string to time_point.

Note

We are assuming that times are in UTC.

Since

0.1.0

{
    std::stringstream sstime(time_string.data());
    struct std::tm tm = {};
    tm.tm_isdst = -1; // Don't convert to/from daylight saving time.
    sstime >> std::get_time(&tm, "%Y-%m-%d %T"); // TODO: Check other APIs.
    std::time_t time = mktime(&tm);
 
    return system_clock::from_time_t(time);
}

timepoint_to_string()

string pornsieve::timepoint_to_string	(	const system_clock::time_point &	timepoint,
		string_view	format = "%FT%T"
	)

Return date and time as string in UTC.

Parameters

timepoint	The point in time to convert.
format	Format of the string (optional, defaults to %FT%T).

See strftime(3) for information on how to construct a valid format string.

Since

0.1.0

{
    constexpr uint16_t bufsize = 1024;
    time_t time = system_clock::to_time_t(timepoint);
    std::tm *tm{nullptr};
    tm = std::gmtime(&time);
    char buffer[bufsize];
    strftime(buffer, bufsize, format.data(), tm);
 
    return buffer;
}