summaryrefslogtreecommitdiff
path: root/src/net/download.h
blob: e9483fa595cc1c0f4cbee0fc267f09360ceb7d5b (plain) (blame)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 *  The Mana Client
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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; either version 2 of the License, or
 *  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 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/>.
 */

#include "utils/mutex.h"

#include <cstdio>
#include <optional>
#include <string>

#include <curl/curl.h>

#pragma once

enum class DownloadStatus
{
    InProgress,
    Canceled,
    Error,
    Complete
};

struct SDL_Thread;

namespace Net {

class Download
{
    public:
        struct State
        {
            DownloadStatus status = DownloadStatus::InProgress;
            float progress = 0.0f;
        };

        Download(const std::string &url);
        ~Download();

        void addHeader(const char *header);

        /**
         * Convience method for adding no-cache headers.
         */
        void noCache();

        void setFile(const std::string &filename,
                     std::optional<unsigned long> adler32 = {});

        void setUseBuffer();

        /**
         * Starts the download thread.
         * @returns whether the thread could be created
         */
        bool start();

        /**
         * Cancels the download. Returns immediately, the canceled status will
         * be noted in the next available update call.
         */
        void cancel();

        /**
         * Returns a view on the downloaded data.
         */
        std::string_view getBuffer() const;

        State getState();

        const char *getError() const;

        static unsigned long fadler32(FILE *file);

    private:
        static int downloadProgress(void *clientp,
                                    curl_off_t dltotal, curl_off_t dlnow,
                                    curl_off_t ultotal, curl_off_t ulnow);

        static size_t writeBuffer(char *ptr, size_t size, size_t nmemb,
                                  void *stream);

        static int downloadThread(void *ptr);

        ThreadSafe<State> mState;
        std::string mUrl;
        bool mCancel = false;
        bool mMemoryWrite = false;
        std::string mFileName;
        std::optional<unsigned long> mAdler;
        SDL_Thread *mThread = nullptr;
        curl_slist *mHeaders = nullptr;
        char mError[CURL_ERROR_SIZE];

        /** Byte count currently downloaded in mMemoryBuffer. */
        size_t mDownloadedBytes = 0;

        /** Buffer for files downloaded to memory. */
        char *mBuffer = nullptr;
};

inline Download::State Download::getState()
{
    return *mState.lock();
}

inline const char *Download::getError() const
{
    return mError;
}

} // namespace Net