webdar_tools.hpp

/*********************************************************************/
// webdar - a web server and interface program to libdar
// Copyright (C) 2013-2025 Denis Corbin
//
// This file is part of Webdar
//
//  Webdar is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  Webdar is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with Webdar.  If not, see <http://www.gnu.org/licenses/>
//
//----
//  to contact the author: dar.linux@free.fr
/*********************************************************************/
 
#ifndef WEBDAR_TOOLS_HPP
#define WEBDAR_TOOLS_HPP
 
#include "my_config.h"
 
    // C++ system header files
#include <sstream>
#include <vector>
#include <deque>
#include <string>
 
    // webdar headers
#include "uri.hpp"
#include "webdar_tools.hpp"
 
 
template <class T> std::string webdar_tools_convert_to_string(T val)
{
    std::stringstream tmp;
    tmp << val;
    return tmp.str();
}
 
template <class T> bool webdar_tools_semi_less_than(T a, T b, bool & result)
{
    if(a < b)
    {
    result = true;
    return true;
    }
    if(b < a)
    {
    result = false;
    return true;
    }
    return false;
}
 
template <class T> void webdar_tools_concat_vectors(std::vector<T> & op1,
                            const std::vector<T> & op2)
{
    for(unsigned int i = 0; i < op2.size(); ++i)
    op1.push_back(op2[i]);
}
 
template <class T> T webdar_tools_convert_from_infinint(const libdar::infinint & val, const std::string & conv_err_msg)
{
    T ret = 0;
    libdar::infinint tmp(val);
 
    tmp.unstack(ret);
    if(! tmp.is_zero())
    {
    if(conv_err_msg.empty())
        throw WEBDAR_BUG;
    else
        throw exception_range(conv_err_msg);
    }
 
    return ret;
}
 
 
struct troncon
{
    std::string::const_iterator begin;
    std::string::const_iterator end;
 
    troncon() {}; // needed to use troncon in std::map
    troncon(std::string::const_iterator b, std::string::const_iterator e) { begin = b; end = e; };
    troncon(const std::string & ref) { begin = ref.begin(); end = ref.end(); };
 
    bool operator < (const troncon & ref) const;
};
 
extern int webdar_tools_convert_to_int(const std::string & ref);
extern unsigned int webdar_tools_convert_hexa_to_int(const std::string & ref);
extern void webdar_tools_split_by(char sep, const std::string & aggregate, std::vector<std::string> & splitted);
extern void webdar_tools_split_in_two(char sep, const std::string &aggregate, std::string & first, std::string & second);
 
 
extern std::deque<troncon> webdar_tools_split_by_substring(const std::string & substring,
                               const troncon & aggregate);
 
 
extern std::string::const_iterator webdar_tools_seek_to_substring(const std::string & substring, const troncon & aggregate);
 
extern std::string webdar_tools_remove_leading_spaces(const std::string & input);
extern void webdar_tools_init_randomization();
 
extern std::string webdar_tools_generate_random_string(unsigned int size);
extern std::string webdar_tools_get_session_ID_from_URI(const uri & url);
extern std::string webdar_tools_to_canonical_case(const std::string & ch);
extern std::string webdar_tools_decode_urlencoded(const std::string & ch);
extern std::string webdar_tools_get_title(const std::string & sessname, const std::string & status);
 
extern std::string webdar_tools_html_display(const std::string & arg);
 
extern bool webdar_tools_exists_and_is_file(const std::string & path, bool follow_symlink);
extern bool webdar_tools_exists_and_is_dir(const std::string & path, bool follow_symlink);
 
extern std::string webdar_tools_capitalize_first_letter_of_words(const std::string & source);
 
#endif