remwharead/include/sqlite.hpp

119 lines
3.1 KiB
C++
Raw Normal View History

2019-05-14 20:45:48 +02:00
/* This file is part of remwharead.
* Copyright © 2019 tastytea <tastytea@tastytea.de>
*
* 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
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef REMWHAREAD_SQLITE_HPP
#define REMWHAREAD_SQLITE_HPP
#include <experimental/filesystem>
#include <memory>
#include <string>
#include <vector>
#include <chrono>
2019-08-07 19:41:58 +02:00
#include <Poco/Data/Session.h>
2019-05-14 20:45:48 +02:00
2019-07-27 09:59:43 +02:00
namespace remwharead
2019-05-14 20:45:48 +02:00
{
2019-07-27 09:59:43 +02:00
namespace fs = std::experimental::filesystem;
using std::string;
using std::vector;
using std::chrono::system_clock;
using time_point = system_clock::time_point;
2019-08-07 19:41:58 +02:00
using Poco::Data::Session;
2019-07-27 09:59:43 +02:00
/*!
* @brief Store and retrieve files from/to SQLite.
*
* @since 0.6.0
*
* @headerfile sqlite.hpp remwharead/sqlite.hpp
*/
2019-07-27 09:59:43 +02:00
class Database
2019-05-16 00:05:18 +02:00
{
2019-07-27 09:59:43 +02:00
public:
/*!
* @brief Describes a database entry.
*
* @since 0.6.0
*
* @headerfile sqlite.hpp remwharead/sqlite.hpp
*/
2019-07-27 09:59:43 +02:00
typedef struct entry
{
string uri;
string archive_uri;
time_point datetime;
vector<string> tags;
string title;
string description;
string fulltext;
2019-08-07 20:32:46 +02:00
/*!
* @brief Returns true if date and time are equal.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
friend bool operator ==(const Database::entry &a,
const Database::entry &b);
2019-08-07 20:32:46 +02:00
/*!
* @brief The full text in one line.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
const string fulltext_oneline() const;
} entry;
2019-05-16 03:56:17 +02:00
2019-08-07 20:32:46 +02:00
/*!
* @brief Connects to the database and creates it if necessary.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
Database();
2019-07-28 01:42:57 +02:00
2019-08-07 20:32:46 +02:00
/*!
* @brief Returns true if connected to the database.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
operator bool() const;
2019-05-16 00:05:18 +02:00
2019-08-07 20:32:46 +02:00
/*!
* @brief Store a Database::entry in the database.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
void store(const entry &data) const;
2019-05-14 20:45:48 +02:00
2019-08-07 20:32:46 +02:00
/*!
* @brief Retrieve a vector of Database::entry from the database.
*
* @since 0.6.0
*/
2019-07-27 09:59:43 +02:00
const vector<entry> retrieve(
const time_point &start = time_point(),
const time_point &end = system_clock::now()) const;
2019-05-16 00:05:18 +02:00
2019-07-27 09:59:43 +02:00
private:
fs::path _dbpath;
2019-08-07 19:41:58 +02:00
std::unique_ptr<Session> _session;
2019-07-27 09:59:43 +02:00
bool _connected;
};
2019-05-14 20:45:48 +02:00
2019-07-27 09:59:43 +02:00
using DB = Database;
}
2019-05-14 20:45:48 +02:00
#endif // REMWHAREAD_SQLITE_HPP