summaryrefslogtreecommitdiffstats
path: root/sc/source/ui/inc/dataprovider.hxx
blob: 680bf3819390e19c6e1c8f61fa2159a10c7a8675 (plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#pragma once

#include <memory>
#include <string_view>
#include <salhelper/thread.hxx>
#include <rtl/ustring.hxx>
#include <rtl/ref.hxx>
#include <osl/mutex.hxx>
#include <document.hxx>

#include <rtl/strbuf.hxx>

#include <atomic>
#include <vector>
//#include <map>

#include <orcus/csv_parser.hpp>

class SvStream;
class ScDBData;

namespace sc {

class DataTransformation;
class ExternalDataSource;

class CSVFetchThread : public salhelper::Thread
{
    ScDocument& mrDocument;
    OUString maURL;

    std::atomic<bool> mbTerminate;

    orcus::csv::parser_config maConfig;

    std::vector<std::shared_ptr<sc::DataTransformation>> maDataTransformations;

    std::function<void()> maImportFinishedHdl;


public:
    CSVFetchThread(ScDocument& rDoc, OUString , std::function<void()> aImportFinishedHdl,
            std::vector<std::shared_ptr<sc::DataTransformation>>&& mrDataTransformations);
    virtual ~CSVFetchThread() override;

    void RequestTerminate();
    bool IsRequestedTerminate();
    void Terminate();
    void EndThread();

    virtual void execute() override;
};

/**
 * Abstract class for all data provider.
 *
 */
class DataProvider
{
protected:
    /**
     * If true make the threaded import deterministic for the tests.
     */
    bool mbDeterministic;
    sc::ExternalDataSource& mrDataSource;

public:
    DataProvider(sc::ExternalDataSource& rDataSource);

    virtual ~DataProvider();

    virtual void Import() = 0;

    virtual const OUString& GetURL() const = 0;

    static std::unique_ptr<SvStream> FetchStreamFromURL(const OUString&, OStringBuffer& rBuffer);

    void setDeterministic();
};

class CSVDataProvider : public DataProvider
{
    rtl::Reference<CSVFetchThread> mxCSVFetchThread;
    ScDocument* mpDocument;
    ScDocumentUniquePtr mpDoc;

    void Refresh();

public:
    CSVDataProvider (ScDocument* pDoc, sc::ExternalDataSource& rDataSource);
    virtual ~CSVDataProvider() override;

    virtual void Import() override;

    const OUString& GetURL() const override;
    void ImportFinished();
};

/**
 * This class handles the copying of the data from the imported
 * temporary document to the actual document. Additionally, in the future
 * we may decide to store data transformations in this class.
 *
 * In addition this class also handles how to deal with excess data by for example extending the ScDBData or by only showing the first or last entries.
 *
 * TODO: move the DataProvider::WriteToDoc here
 *
 */
class ScDBDataManager
{
    OUString maDBName;
    ScDocument* mpDoc;

public:
    ScDBDataManager(OUString aDBName, ScDocument* pDoc);
    ~ScDBDataManager();

    void SetDatabase(const OUString& rDBName);

    ScDBData* getDBData();

    void WriteToDoc(ScDocument& rDoc);
};

class DataProviderFactory
{
private:

    static bool isInternalDataProvider(std::u16string_view rProvider);

public:

    static std::shared_ptr<DataProvider> getDataProvider(ScDocument* pDoc, sc::ExternalDataSource& rDataSource);

    static std::vector<OUString> getDataProviders();
};

}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */