1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/*
Copyright © 2015-2016 Gluzskiy Alexandr (sss)
This file is part of Unknown Download Manager (UDM).
UDM 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 2 of the License, or
(at your option) any later version.
UDM 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 UDM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MAIN_H_INCLUDED
#define MAIN_H_INCLUDED
#include <api_module_downloader.h>
#include "curl_download.h"
class downloader : public module_downloader
{
public:
//core module api
downloader();
void load(core_api *a);
const module_info_base &get_module_info();
void set_module_settings(const std::map<std::string, setting_s> &settings); //will called with settings stored in config
~downloader();
//downloader module api
int add_download(std::map<int, std::string> params); //add download, this function must return unique for current session and current downloader download id
bool stop_download(int download_id); //stop download by id received via add_download, return true on success, false otherwise
bool start_download(int download_id); //start download by id received via add_download, return true on success, false otherwise
bool delete_download(int download_id, bool delete_data = false); //delete download by id received via add_download, if "delete_data" is set, also remove all downloaded data from storage, return true on success, false otherwise
bool execute_action_on_download(int download_id, int action_id); //execute module defined action on download, by id received via add_download
std::list<download_s> get_downloads(std::map<int, std::string> params = std::map<int, std::string>()); //this function must return list of downloads, additional options may be passed via params map
download_s get_download(int download_id, std::map<int, std::string> params = std::map<int, std::string>()); //same as above, except this one is for single download, not a complete list
//downloader metadata manipulations
bool metadata_set(int download_id, std::map<std::string, std::string> metadata); //replace download metadata with provided one
bool metadata_update(int download_id, std::map<std::string, std::string> metadata); //updated matching metadata entries, create non existent
bool metadata_drop(int download_id, std::string var = std::string()); //remove all metadata if no variable specified, otherwise delete specified variable
std::map<std::string, std::string> metadata_get(int download_id); //get download metadata
std::string metadata_get(int download_id, std::string var); //get value of specified metadata variable
private:
void on_modules_loaded();
std::map<int, curl_download*> downloads; //map of id, download
};
#endif // MAIN_H_INCLUDED
|
