summaryrefslogtreecommitdiffstats
path: root/src/file_collection.hh
blob: 926f8f17d5c105afddd51f086d633f2545be7dd5 (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/**
 * Copyright (c) 2020, Timothy Stack
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * * Neither the name of Timothy Stack nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @file file_collection.hh
 */

#ifndef lnav_file_collection_hh
#define lnav_file_collection_hh

#include <forward_list>
#include <list>
#include <map>
#include <set>
#include <string>
#include <utility>

#include "archive_manager.hh"
#include "base/future_util.hh"
#include "file_format.hh"
#include "logfile_fwd.hh"
#include "safe/safe.h"
#include "tailer/tailer.looper.hh"

struct tailer_progress {
    std::string tp_message;
};

struct scan_progress {
    std::list<archive_manager::extract_progress> sp_extractions;
    std::map<std::string, tailer_progress> sp_tailers;
};

using safe_scan_progress = safe::Safe<scan_progress>;

struct other_file_descriptor {
    file_format_t ofd_format;
    std::string ofd_description;

    other_file_descriptor(file_format_t format = file_format_t::UNKNOWN,
                          std::string description = "")
        : ofd_format(format), ofd_description(std::move(description))
    {
    }
};

struct file_error_info {
    const time_t fei_mtime;
    const std::string fei_description;
};

struct file_collection;

enum class child_poll_result_t {
    ALIVE,
    FINISHED,
};

class child_poller {
public:
    explicit child_poller(
        auto_pid<process_state::running> child,
        std::function<void(file_collection&,
                           auto_pid<process_state::finished>&)> finalizer)
        : cp_child(std::move(child)), cp_finalizer(std::move(finalizer))
    {
        ensure(this->cp_finalizer);
    }

    child_poller(child_poller&& other) noexcept
        : cp_child(std::move(other.cp_child)),
          cp_finalizer(std::move(other.cp_finalizer))
    {
        ensure(this->cp_finalizer);
    }

    child_poller& operator=(child_poller&& other) noexcept
    {
        require(other.cp_finalizer);

        this->cp_child = std::move(other.cp_child);
        this->cp_finalizer = std::move(other.cp_finalizer);

        return *this;
    }

    ~child_poller() noexcept = default;

    child_poller(const child_poller&) = delete;

    child_poller& operator=(const child_poller&) = delete;

    child_poll_result_t poll(file_collection& fc);

private:
    nonstd::optional<auto_pid<process_state::running>> cp_child;
    std::function<void(file_collection&, auto_pid<process_state::finished>&)>
        cp_finalizer;
};

struct file_collection {
    bool fc_invalidate_merge{false};

    bool fc_recursive{false};
    bool fc_rotated{false};

    std::map<std::string, file_error_info> fc_name_to_errors;
    std::map<std::string, logfile_open_options> fc_file_names;
    std::vector<std::shared_ptr<logfile>> fc_files;
    int fc_files_generation{0};
    std::vector<std::pair<std::shared_ptr<logfile>, std::string>>
        fc_renamed_files;
    std::set<std::string> fc_closed_files;
    std::map<std::string, other_file_descriptor> fc_other_files;
    std::set<std::string> fc_synced_files;
    std::shared_ptr<safe_scan_progress> fc_progress;
    std::vector<struct stat> fc_new_stats;
    std::list<child_poller> fc_child_pollers;
    size_t fc_largest_path_length{0};

    file_collection()
        : fc_progress(std::make_shared<safe::Safe<scan_progress>>())
    {
    }

    void clear()
    {
        this->fc_name_to_errors.clear();
        this->fc_file_names.clear();
        this->fc_files.clear();
        this->fc_closed_files.clear();
        this->fc_other_files.clear();
        this->fc_new_stats.clear();
    }

    file_collection rescan_files(bool required = false);

    void expand_filename(lnav::futures::future_queue<file_collection>& fq,
                         const std::string& path,
                         logfile_open_options& loo,
                         bool required);

    std::future<file_collection> watch_logfile(const std::string& filename,
                                               logfile_open_options& loo,
                                               bool required);

    void merge(file_collection& other);

    void request_close(const std::shared_ptr<logfile>& lf);

    void close_files(const std::vector<std::shared_ptr<logfile>>& files);

    void regenerate_unique_file_names();
};

#endif