17589970077-2502

Committed 09 Sep 2025 05:00PM UTC coverage: 65.196% (-5.0%) from 70.225%

Build # 17589970077-2502

Build Type

push

github

Committed by

tstack

Commit Message

[format] add fields for source file/line

Knowing the source file/line context in a log
message can help find log messages when using
log2src.

Run Details

56 of 70 new or added lines in 2 files covered. (80.0%)

13954 existing lines in 210 files now uncovered.

45516 of 69814 relevant lines covered (65.2%)

404154.37 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.33

/src/session.export.cc

/**
 * Copyright (c) 2022, 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.
 */

#include "session.export.hh"

#include "base/injector.hh"
#include "base/itertools.hh"
#include "bound_tags.hh"
#include "lnav.hh"
#include "sqlitepp.client.hh"
#include "sqlitepp.hh"
#include "textview_curses.hh"

struct log_message_session_state {
    int64_t lmss_time_msecs;
    std::string lmss_format;
    bool lmss_mark;
    std::optional<std::string> lmss_comment;
    std::optional<std::string> lmss_tags;
    std::optional<std::string> lmss_annotations;
    std::optional<std::string> lmss_opid;
    std::string lmss_hash;
};

template<>
struct from_sqlite<log_message_session_state> {
    log_message_session_state operator()(int argc,
                                         sqlite3_value** argv,
                                         int argi)
    {
        return {
            from_sqlite<int64_t>()(argc, argv, argi + 0),
            from_sqlite<std::string>()(argc, argv, argi + 1),
            from_sqlite<bool>()(argc, argv, argi + 2),
            from_sqlite<std::optional<std::string>>()(argc, argv, argi + 3),
            from_sqlite<std::optional<std::string>>()(argc, argv, argi + 4),
            from_sqlite<std::optional<std::string>>()(argc, argv, argi + 5),
            from_sqlite<std::optional<std::string>>()(argc, argv, argi + 6),
            from_sqlite<std::string>()(argc, argv, argi + 7),
        };
    }
};

struct log_filter_session_state {
    std::string lfss_name;
    bool lfss_enabled;
    std::string lfss_type;
    std::string lfss_language;
    std::string lfss_pattern;
};

template<>
struct from_sqlite<log_filter_session_state> {
    log_filter_session_state operator()(int argc,
                                        sqlite3_value** argv,
                                        int argi)
    {
        return {
            from_sqlite<std::string>()(argc, argv, argi + 0),
            from_sqlite<bool>()(argc, argv, argi + 1),
            from_sqlite<std::string>()(argc, argv, argi + 2),
            from_sqlite<std::string>()(argc, argv, argi + 3),
            from_sqlite<std::string>()(argc, argv, argi + 4),
        };
    }
};

struct log_file_session_state {
    std::string lfss_content_id;
    std::string lfss_format;
    int64_t lfss_time_offset;
};

template<>
struct from_sqlite<log_file_session_state> {
    log_file_session_state operator()(int argc, sqlite3_value** argv, int argi)
    {
        return {
            from_sqlite<std::string>()(argc, argv, argi + 0),
            from_sqlite<std::string>()(argc, argv, argi + 1),
            from_sqlite<int64_t>()(argc, argv, argi + 2),
        };
    }
};

namespace lnav::session {

static std::optional<std::filesystem::path>
find_container_dir(std::filesystem::path file_path)
{
    if (!std::filesystem::exists(file_path)) {
        return std::nullopt;
    }

    std::optional<std::filesystem::path> dir_with_last_readme;

    while (file_path.has_parent_path()
           && file_path != file_path.root_directory())
    {
        auto parent = file_path.parent_path();
        bool has_readme_entry = false;
        std::error_code ec;

        for (const auto& entry :
             std::filesystem::directory_iterator(parent, ec))
        {
            if (!entry.is_regular_file()) {
                continue;
            }

            auto entry_filename = tolower(entry.path().filename().string());
            if (startswith(entry_filename, "readme")) {
                has_readme_entry = true;
                dir_with_last_readme = parent;
            }
        }
        if (!has_readme_entry && dir_with_last_readme) {
            return dir_with_last_readme;
        }

        file_path = parent;
    }

    return std::nullopt;
}

static std::string
replace_home_dir(std::string path)
{
    const auto home_dir_opt = getenv_opt("HOME");

    if (!home_dir_opt) {
        return path;
    }

    const auto* home_dir = home_dir_opt.value();

    if (startswith(path, home_dir)) {
        auto retval = path.substr(strlen(home_dir));

        if (retval.front() != '/') {
            retval.insert(0, "/");
        }
        retval.insert(0, "$HOME");
        return retval;
    }

    return path;
}

Result<void, lnav::console::user_message>
export_to(FILE* file)
{
    static auto& lnav_db = injector::get<auto_sqlite3&>();

    static const char* BOOKMARK_QUERY = R"(
SELECT log_time_msecs, log_format, log_mark, log_comment, log_tags, log_annotations, log_user_opid, log_line_hash
   FROM all_logs
   WHERE log_mark = 1 OR
         log_comment IS NOT NULL OR
         log_tags IS NOT NULL OR
         log_annotations IS NOT NULL OR
         (log_user_opid IS NOT NULL AND log_user_opid != '')
)";

    static const char* FILTER_QUERY = R"(
SELECT view_name, enabled, type, language, pattern FROM lnav_view_filters
)";

    static const char* FILE_QUERY = R"(
SELECT content_id, format, time_offset FROM lnav_file
  WHERE format IS NOT NULL AND time_offset != 0
)";

    static constexpr char HEADER[] = R"(#!lnav -Nf
# This file is an export of an lnav session.  You can type
# '|/path/to/this/file' in lnav to execute this file and
# restore the state of the session.

;SELECT raise_error('This session export was made with a newer version of lnav, please upgrade to ' || {0} || ' or later')
   WHERE lnav_version() < {0} COLLATE naturalcase

# The files loaded into the session were:

)";

    static constexpr char LOG_DIR_INSERT[] = R"(
# Set this environment variable to override this value or edit this script.
;INSERT OR IGNORE INTO environ (name, value) VALUES ('LOG_DIR_{}', {})
)";

    static constexpr char MARK_HEADER[] = R"(

# The following SQL statements will restore the bookmarks,
# comments, and tags that were added in the session.

;SELECT total_changes() AS before_mark_changes
)";

    static constexpr char MARK_FOOTER[] = R"(
;SELECT {} - (total_changes() - $before_mark_changes) AS failed_mark_changes
;SELECT echoln(printf('%sERROR%s: failed to restore %d bookmarks',
                      $ansi_red, $ansi_norm, $failed_mark_changes))
    WHERE $failed_mark_changes != 0
)";

    static const char* FILTER_HEADER = R"(

# The following SQL statements will restore the filters that
# were added in the session.

)";

    static const char* FILE_HEADER = R"(

# The following SQL statements will restore the state of the
# files in the session.

;SELECT total_changes() AS before_file_changes
)";

    static const char* FIELD_HEADER = R"(
# The following field visibility commands were run by the
# original user during this session.  Uncomment them if
# desired.
)";

    static const char* HIGHLIGHT_HEADER = R"(
# The following highlight commands were run by the
# original user during this session.  Uncomment them if
# desired.
)";

    static constexpr char FILE_FOOTER[] = R"(
;SELECT {} - (total_changes() - $before_file_changes) AS failed_file_changes
;SELECT echoln(printf('%sERROR%s: failed to restore the state of %d files',
                      $ansi_red, $ansi_norm, $failed_file_changes))
   WHERE $failed_file_changes != 0
)";

    static constexpr char VIEW_HEADER[] = R"(

# The following commands will restore the state of the {} view.

)";

    auto prep_mark_res = prepare_stmt(lnav_db.in(), BOOKMARK_QUERY);
    if (prep_mark_res.isErr()) {
        return Err(
            console::user_message::error("unable to export log bookmarks")
                .with_reason(prep_mark_res.unwrapErr()));
    }

    fmt::print(file, FMT_STRING(HEADER), sqlitepp::quote(PACKAGE_VERSION).in());

    std::map<std::string, std::vector<std::string>> file_containers;
    std::set<std::string> raw_files;
    for (const auto& name_pair : lnav_data.ld_active_files.fc_file_names) {
        const auto& open_opts = name_pair.second;

        if (!open_opts.loo_is_visible || !open_opts.loo_include_in_session
            || !open_opts.loo_filename.empty()
            || open_opts.loo_source != logfile_name_source::USER)
        {
            continue;
        }

        const auto& file_path_str = name_pair.first;
        auto file_path = std::filesystem::path(file_path_str);
        auto container_path_opt = find_container_dir(file_path);
        if (container_path_opt) {
            auto container_parent = container_path_opt.value().parent_path();
            auto file_container_path
                = std::filesystem::relative(file_path, container_parent)
                      .string();
            file_containers[container_parent.string()].push_back(
                file_container_path);
        } else {
            raw_files.insert(file_path_str);
        }
    }
    for (const auto& lf : lnav_data.ld_active_files.fc_files) {
        if (lf->is_valid_filename()) {
            continue;
        }
        if (!lf->get_open_options().loo_include_in_session) {
            continue;
        }

        const auto& open_options = lf->get_open_options();
        if (open_options.loo_piper) {
            raw_files.emplace(open_options.loo_piper->get_url());
        }
    }
    for (const auto& file_path_str : raw_files) {
        fmt::print(
            file, FMT_STRING(":open {}\n"), replace_home_dir(file_path_str));
    }
    size_t container_index = 0;
    for (const auto& container_pair : file_containers) {
        fmt::print(file,
                   FMT_STRING(LOG_DIR_INSERT),
                   container_index,
                   sqlitepp::quote(container_pair.first).in());
        for (const auto& file_path_str : container_pair.second) {
            fmt::print(file,
                       FMT_STRING(":open $LOG_DIR_{}/{}\n"),
                       container_index,
                       file_path_str);
        }
        container_index += 1;
    }

    fmt::print(file, FMT_STRING("\n:rebuild\n"));

    auto mark_count = 0;
    auto each_mark_res
        = prep_mark_res.unwrap().for_each_row<log_message_session_state>(
            [file, &mark_count](const log_message_session_state& lmss) {
                if (mark_count == 0) {
                    fmt::print(file, FMT_STRING(MARK_HEADER));
                }
                mark_count += 1;
                fmt::print(file,
                           FMT_STRING(";UPDATE all_logs "
                                      "SET log_mark = {}, "
                                      "log_comment = {}, "
                                      "log_tags = {}, "
                                      "log_annotations = {}, "
                                      "log_opid = {} "
                                      "WHERE log_time_msecs = {} AND "
                                      "log_format = {} AND "
                                      "log_line_hash = {}\n"),
                           lmss.lmss_mark ? "1" : "0",
                           sqlitepp::quote(lmss.lmss_comment).in(),
                           sqlitepp::quote(lmss.lmss_tags).in(),
                           sqlitepp::quote(lmss.lmss_annotations).in(),
                           sqlitepp::quote(lmss.lmss_opid).in(),
                           lmss.lmss_time_msecs,
                           sqlitepp::quote(lmss.lmss_format).in(),
                           sqlitepp::quote(lmss.lmss_hash).in());
                return false;
            });

    if (each_mark_res.isErr()) {
        return Err(console::user_message::error(
                       "failed to fetch bookmark metadata for log message")
                       .with_reason(each_mark_res.unwrapErr().fe_msg));
    }

    if (mark_count > 0) {
        fmt::print(file, FMT_STRING(MARK_FOOTER), mark_count);
    }

    auto prep_filter_res = prepare_stmt(lnav_db.in(), FILTER_QUERY);
    if (prep_filter_res.isErr()) {
        return Err(console::user_message::error("unable to export filter state")
                       .with_reason(prep_filter_res.unwrapErr()));
    }

    auto added_filter_header = false;
    auto each_filter_res
        = prep_filter_res.unwrap().for_each_row<log_filter_session_state>(
            [file, &added_filter_header](const log_filter_session_state& lfss) {
                if (!added_filter_header) {
                    fmt::print(file, FMT_STRING("{}"), FILTER_HEADER);
                    added_filter_header = true;
                }
                fmt::print(
                    file,
                    FMT_STRING(";REPLACE INTO lnav_view_filters "
                               "(view_name, enabled, type, language, pattern) "
                               "VALUES ({}, {}, {}, {}, {})\n"),
                    sqlitepp::quote(lfss.lfss_name).in(),
                    lfss.lfss_enabled ? 1 : 0,
                    sqlitepp::quote(lfss.lfss_type).in(),
                    sqlitepp::quote(lfss.lfss_language).in(),
                    sqlitepp::quote(lfss.lfss_pattern).in());
                return false;
            });

    if (each_filter_res.isErr()) {
        return Err(console::user_message::error(
                       "failed to fetch filter state for views")
                       .with_reason(each_filter_res.unwrapErr().fe_msg));
    }

    auto prep_file_res = prepare_stmt(lnav_db.in(), FILE_QUERY);
    if (prep_file_res.isErr()) {
        return Err(console::user_message::error("unable to export file state")
                       .with_reason(prep_file_res.unwrapErr()));
    }

    auto file_count = 0;
    auto file_stmt = prep_file_res.unwrap();
    auto each_file_res = file_stmt.for_each_row<log_file_session_state>(
        [file, &file_count](const log_file_session_state& lfss) {
            if (file_count == 0) {
                fmt::print(file, FMT_STRING("{}"), FILE_HEADER);
            }
            file_count += 1;
            fmt::print(file,
                       FMT_STRING(";UPDATE lnav_file "
                                  "SET time_offset = {} "
                                  "WHERE content_id = {} AND format = {}\n"),
                       lfss.lfss_time_offset,
                       sqlitepp::quote(lfss.lfss_content_id).in(),
                       sqlitepp::quote(lfss.lfss_format).in());
            return false;
        });

    if (each_file_res.isErr()) {
        return Err(console::user_message::error("failed to fetch file state")
                       .with_reason(each_file_res.unwrapErr().fe_msg));
    }

    if (file_count > 0) {
        fmt::print(file, FMT_STRING(FILE_FOOTER), file_count);
    }

    for (auto view_index : {LNV_LOG, LNV_TEXT}) {
        auto& tc = lnav_data.ld_views[view_index];
        if (tc.get_inner_height() == 0_vl) {
            continue;
        }

        fmt::print(file, FMT_STRING(VIEW_HEADER), lnav_view_titles[view_index]);
        fmt::print(file,
                   FMT_STRING(":switch-to-view {}\n"),
                   lnav_view_strings[view_index]);

        if (view_index == LNV_LOG) {
            std::vector<std::string> field_cmds;
            for (const auto& format : log_format::get_root_formats()) {
                auto field_states = format->get_field_states();

                for (const auto& fs_pair : field_states) {
                    if (!fs_pair.second.lvm_user_hidden) {
                        continue;
                    }

                    if (fs_pair.second.lvm_user_hidden.value()) {
                        field_cmds.emplace_back(
                            fmt::format(FMT_STRING("# :hide-fields {}.{}\n"),

                                        format->get_name(),
                                        fs_pair.first));
                    } else if (fs_pair.second.lvm_hidden) {
                        field_cmds.emplace_back(
                            fmt::format(FMT_STRING("# :show-fields {}.{}\n"),
                                        format->get_name().to_string(),
                                        fs_pair.first));
                    }
                }
            }

            if (!field_cmds.empty()) {
                fmt::print(file, FMT_STRING("{}"), FIELD_HEADER);
                field_cmds
                    | lnav::itertools::for_each([&file](const auto& cmd) {
                          fmt::print(file, FMT_STRING("{}"), cmd);
                      });
            }
        }

        {
            std::vector<std::string> hl_cmds;
            const auto& hm = tc.get_highlights();
            for (const auto& hl_pair : hm) {
                if (hl_pair.first.first != highlight_source_t::INTERACTIVE) {
                    continue;
                }

                auto cmd = fmt::format(FMT_STRING("# :highlight {}\n"),
                                       hl_pair.second.h_regex->get_pattern());
                hl_cmds.emplace_back(cmd);
            }

            if (!hl_cmds.empty()) {
                fmt::print(file, FMT_STRING("{}"), HIGHLIGHT_HEADER);
                hl_cmds
                    | lnav::itertools::for_each([&file](const auto& cmd) {
                          fmt::print(file, FMT_STRING("{}"), cmd);
                      });
                fmt::println(file, FMT_STRING(""));
            }
        }

        auto* tss = tc.get_sub_source();
        auto* ttt = dynamic_cast<text_time_translator*>(tss);
        if (ttt != nullptr) {
            char tsbuf[128];
            auto min_time_opt = ttt->get_min_row_time();
            if (min_time_opt) {
                sql_strftime(tsbuf, sizeof(tsbuf), min_time_opt.value(), 'T');
                fmt::print(file, FMT_STRING(":hide-lines-before {}\n"), tsbuf);
            }
            auto max_time_opt = ttt->get_max_row_time();
            if (max_time_opt) {
                sql_strftime(tsbuf, sizeof(tsbuf), max_time_opt.value(), 'T');
                fmt::print(file, FMT_STRING(":hide-lines-after {}\n"), tsbuf);
            }
        }

        auto* lss = dynamic_cast<logfile_sub_source*>(tss);
        if (lss != nullptr) {
            auto min_level = lss->get_min_log_level();

            if (min_level != LEVEL_UNKNOWN) {
                fmt::print(file,
                           FMT_STRING(":set-min-log-level {}\n"),
                           level_names[min_level]);
            }

            for (const auto& ld : *lss) {
                if (ld->is_visible()) {
                    continue;
                }

                if (ld->get_file_ptr()->get_open_options().loo_source
                    == logfile_name_source::ARCHIVE)
                {
                    continue;
                }

                auto container_path_opt
                    = find_container_dir(ld->get_file_ptr()->get_path());
                if (!container_path_opt) {
                    fmt::print(file,
                               FMT_STRING(":hide-file {}\n"),
                               ld->get_file_ptr()->get_path().string());
                    continue;
                }
                auto container_parent
                    = container_path_opt.value().parent_path();
                auto file_container_path = std::filesystem::relative(
                    ld->get_file_ptr()->get_path(), container_parent);
                fmt::print(file,
                           FMT_STRING(":hide-file */{}\n"),
                           file_container_path.string());
            }
        }

        if (!tc.get_current_search().empty()) {
            fmt::print(file, FMT_STRING("/{}\n"), tc.get_current_search());
        }

        fmt::print(file, FMT_STRING(":goto {}\n"), (int) tc.get_top());
    }

    return Ok();
}

}  // namespace lnav::session

1	/**
2	* Copyright (c) 2022, Timothy Stack
3	*
4	* All rights reserved.
5	*
6	* Redistribution and use in source and binary forms, with or without
7	* modification, are permitted provided that the following conditions are met:
8	*
9	* * Redistributions of source code must retain the above copyright notice, this
10	* list of conditions and the following disclaimer.
11	* * Redistributions in binary form must reproduce the above copyright notice,
12	* this list of conditions and the following disclaimer in the documentation
13	* and/or other materials provided with the distribution.
14	* * Neither the name of Timothy Stack nor the names of its contributors
15	* may be used to endorse or promote products derived from this software
16	* without specific prior written permission.
17	*
18	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND ANY
19	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21	* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
22	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28	*/
29
30	#include "session.export.hh"
31
32	#include "base/injector.hh"
33	#include "base/itertools.hh"
34	#include "bound_tags.hh"
35	#include "lnav.hh"
36	#include "sqlitepp.client.hh"
37	#include "sqlitepp.hh"
38	#include "textview_curses.hh"
39
40	struct log_message_session_state {
41	int64_t lmss_time_msecs;
42	std::string lmss_format;
43	bool lmss_mark;
44	std::optional<std::string> lmss_comment;
45	std::optional<std::string> lmss_tags;
46	std::optional<std::string> lmss_annotations;
47	std::optional<std::string> lmss_opid;
48	std::string lmss_hash;
49	};
50
51	template<>
52	struct from_sqlite<log_message_session_state> {
53	log_message_session_state operator()(int argc,	3✔
54	sqlite3_value** argv,
55	int argi)
56	{
57	return {
58	from_sqlite<int64_t>()(argc, argv, argi + 0),	3✔
UNCOV 59	from_sqlite<std::string>()(argc, argv, argi + 1),	×
60	from_sqlite<bool>()(argc, argv, argi + 2),	×
61	from_sqlite<std::optional<std::string>>()(argc, argv, argi + 3),	×
62	from_sqlite<std::optional<std::string>>()(argc, argv, argi + 4),	×
63	from_sqlite<std::optional<std::string>>()(argc, argv, argi + 5),	×
UNCOV 64	from_sqlite<std::optional<std::string>>()(argc, argv, argi + 6),	×
65	from_sqlite<std::string>()(argc, argv, argi + 7),	3✔
66	};	3✔
67	}	3✔
68	};
69
70	struct log_filter_session_state {
71	std::string lfss_name;
72	bool lfss_enabled;
73	std::string lfss_type;
74	std::string lfss_language;
75	std::string lfss_pattern;
76	};
77
78	template<>
79	struct from_sqlite<log_filter_session_state> {
80	log_filter_session_state operator()(int argc,	4✔
81	sqlite3_value** argv,
82	int argi)
83	{
84	return {
85	from_sqlite<std::string>()(argc, argv, argi + 0),	4✔
86	from_sqlite<bool>()(argc, argv, argi + 1),	×
87	from_sqlite<std::string>()(argc, argv, argi + 2),	×
UNCOV 88	from_sqlite<std::string>()(argc, argv, argi + 3),	×
89	from_sqlite<std::string>()(argc, argv, argi + 4),	4✔
90	};	4✔
91	}	4✔
92	};
93
94	struct log_file_session_state {
95	std::string lfss_content_id;
96	std::string lfss_format;
97	int64_t lfss_time_offset;
98	};
99
100	template<>
101	struct from_sqlite<log_file_session_state> {
UNCOV 102	log_file_session_state operator()(int argc, sqlite3_value** argv, int argi)	×
103	{
104	return {
UNCOV 105	from_sqlite<std::string>()(argc, argv, argi + 0),	×
106	from_sqlite<std::string>()(argc, argv, argi + 1),	×
107	from_sqlite<int64_t>()(argc, argv, argi + 2),	×
108	};
109	}
110	};
111
112	namespace lnav::session {
113
114	static std::optional<std::filesystem::path>
115	find_container_dir(std::filesystem::path file_path)	5✔
116	{
117	if (!std::filesystem::exists(file_path)) {	5✔
UNCOV 118	return std::nullopt;	×
119	}
120
121	std::optional<std::filesystem::path> dir_with_last_readme;	5✔
122
123	while (file_path.has_parent_path()	5✔
124	&& file_path != file_path.root_directory())	11✔
125	{
126	auto parent = file_path.parent_path();	11✔
127	bool has_readme_entry = false;	11✔
128	std::error_code ec;	11✔
129
130	for (const auto& entry :	11✔
131	std::filesystem::directory_iterator(parent, ec))	28,671✔
132	{
133	if (!entry.is_regular_file()) {	14,330✔
134	continue;	130✔
135	}
136
137	auto entry_filename = tolower(entry.path().filename().string());	14,200✔
138	if (startswith(entry_filename, "readme")) {	14,200✔
139	has_readme_entry = true;	6✔
140	dir_with_last_readme = parent;	6✔
141	}
142	}	14,211✔
143	if (!has_readme_entry && dir_with_last_readme) {	11✔
144	return dir_with_last_readme;	5✔
145	}
146
147	file_path = parent;	6✔
148	}	11✔
149
UNCOV 150	return std::nullopt;	×
151	}	5✔
152
153	static std::string
154	replace_home_dir(std::string path)	2✔
155	{
156	const auto home_dir_opt = getenv_opt("HOME");	2✔
157
158	if (!home_dir_opt) {	2✔
UNCOV 159	return path;	×
160	}
161
162	const auto* home_dir = home_dir_opt.value();	2✔
163
164	if (startswith(path, home_dir)) {	2✔
UNCOV 165	auto retval = path.substr(strlen(home_dir));	×
166
167	if (retval.front() != '/') {	×
UNCOV 168	retval.insert(0, "/");	×
169	}
170	retval.insert(0, "$HOME");	×
UNCOV 171	return retval;	×
172	}
173
174	return path;	2✔
175	}
176
177	Result<void, lnav::console::user_message>
178	export_to(FILE* file)	5✔
179	{
180	static auto& lnav_db = injector::get<auto_sqlite3&>();	5✔
181
182	static const char* BOOKMARK_QUERY = R"(
183	SELECT log_time_msecs, log_format, log_mark, log_comment, log_tags, log_annotations, log_user_opid, log_line_hash
184	FROM all_logs
185	WHERE log_mark = 1 OR
186	log_comment IS NOT NULL OR
187	log_tags IS NOT NULL OR
188	log_annotations IS NOT NULL OR
189	(log_user_opid IS NOT NULL AND log_user_opid != '')
190	)";
191
192	static const char* FILTER_QUERY = R"(
193	SELECT view_name, enabled, type, language, pattern FROM lnav_view_filters
194	)";
195
196	static const char* FILE_QUERY = R"(
197	SELECT content_id, format, time_offset FROM lnav_file
198	WHERE format IS NOT NULL AND time_offset != 0
199	)";
200
201	static constexpr char HEADER[] = R"(#!lnav -Nf
202	# This file is an export of an lnav session. You can type
203	# '\|/path/to/this/file' in lnav to execute this file and
204	# restore the state of the session.
205
206	;SELECT raise_error('This session export was made with a newer version of lnav, please upgrade to ' \|\| {0} \|\| ' or later')
207	WHERE lnav_version() < {0} COLLATE naturalcase
208
209	# The files loaded into the session were:
210
211	)";
212
213	static constexpr char LOG_DIR_INSERT[] = R"(
214	# Set this environment variable to override this value or edit this script.
215	;INSERT OR IGNORE INTO environ (name, value) VALUES ('LOG_DIR_{}', {})
216	)";
217
218	static constexpr char MARK_HEADER[] = R"(
219
220	# The following SQL statements will restore the bookmarks,
221	# comments, and tags that were added in the session.
222
223	;SELECT total_changes() AS before_mark_changes
224	)";
225
226	static constexpr char MARK_FOOTER[] = R"(
227	;SELECT {} - (total_changes() - $before_mark_changes) AS failed_mark_changes
228	;SELECT echoln(printf('%sERROR%s: failed to restore %d bookmarks',
229	$ansi_red, $ansi_norm, $failed_mark_changes))
230	WHERE $failed_mark_changes != 0
231	)";
232
233	static const char* FILTER_HEADER = R"(
234
235	# The following SQL statements will restore the filters that
236	# were added in the session.
237
238	)";
239
240	static const char* FILE_HEADER = R"(
241
242	# The following SQL statements will restore the state of the
243	# files in the session.
244
245	;SELECT total_changes() AS before_file_changes
246	)";
247
248	static const char* FIELD_HEADER = R"(
249	# The following field visibility commands were run by the
250	# original user during this session. Uncomment them if
251	# desired.
252	)";
253
254	static const char* HIGHLIGHT_HEADER = R"(
255	# The following highlight commands were run by the
256	# original user during this session. Uncomment them if
257	# desired.
258	)";
259
260	static constexpr char FILE_FOOTER[] = R"(
261	;SELECT {} - (total_changes() - $before_file_changes) AS failed_file_changes
262	;SELECT echoln(printf('%sERROR%s: failed to restore the state of %d files',
263	$ansi_red, $ansi_norm, $failed_file_changes))
264	WHERE $failed_file_changes != 0
265	)";
266
267	static constexpr char VIEW_HEADER[] = R"(
268
269	# The following commands will restore the state of the {} view.
270
271	)";
272
273	auto prep_mark_res = prepare_stmt(lnav_db.in(), BOOKMARK_QUERY);	5✔
274	if (prep_mark_res.isErr()) {	5✔
UNCOV 275	return Err(	×
UNCOV 276	console::user_message::error("unable to export log bookmarks")	×
UNCOV 277	.with_reason(prep_mark_res.unwrapErr()));	×
278	}
279
280	fmt::print(file, FMT_STRING(HEADER), sqlitepp::quote(PACKAGE_VERSION).in());	25✔
281
282	std::map<std::string, std::vector<std::string>> file_containers;	5✔
283	std::set<std::string> raw_files;	5✔
284	for (const auto& name_pair : lnav_data.ld_active_files.fc_file_names) {	11✔
285	const auto& open_opts = name_pair.second;	6✔
286
287	if (!open_opts.loo_is_visible \|\| !open_opts.loo_include_in_session	6✔
288	\|\| !open_opts.loo_filename.empty()	5✔
289	\|\| open_opts.loo_source != logfile_name_source::USER)	12✔
290	{
291	continue;	2✔
292	}
293
294	const auto& file_path_str = name_pair.first;	4✔
295	auto file_path = std::filesystem::path(file_path_str);	4✔
296	auto container_path_opt = find_container_dir(file_path);	4✔
297	if (container_path_opt) {	4✔
298	auto container_parent = container_path_opt.value().parent_path();	4✔
299	auto file_container_path
300	= std::filesystem::relative(file_path, container_parent)	8✔
301	.string();	4✔
302	file_containers[container_parent.string()].push_back(	4✔
303	file_container_path);
304	} else {	4✔
UNCOV 305	raw_files.insert(file_path_str);	×
306	}
307	}	4✔
308	for (const auto& lf : lnav_data.ld_active_files.fc_files) {	11✔
309	if (lf->is_valid_filename()) {	6✔
310	continue;	4✔
311	}
312	if (!lf->get_open_options().loo_include_in_session) {	2✔
UNCOV 313	continue;	×
314	}
315
316	const auto& open_options = lf->get_open_options();	2✔
317	if (open_options.loo_piper) {	2✔
318	raw_files.emplace(open_options.loo_piper->get_url());	2✔
319	}
320	}
321	for (const auto& file_path_str : raw_files) {	7✔
322	fmt::print(	2✔
323	file, FMT_STRING(":open {}\n"), replace_home_dir(file_path_str));	8✔
324	}
325	size_t container_index = 0;	5✔
326	for (const auto& container_pair : file_containers) {	8✔
327	fmt::print(file,	3✔
328	FMT_STRING(LOG_DIR_INSERT),	6✔
329	container_index,
330	sqlitepp::quote(container_pair.first).in());	6✔
331	for (const auto& file_path_str : container_pair.second) {	7✔
332	fmt::print(file,	4✔
333	FMT_STRING(":open $LOG_DIR_{}/{}\n"),	16✔
334	container_index,
335	file_path_str);
336	}
337	container_index += 1;	3✔
338	}
339
340	fmt::print(file, FMT_STRING("\n:rebuild\n"));	20✔
341
342	auto mark_count = 0;	5✔
343	auto each_mark_res
344	= prep_mark_res.unwrap().for_each_row<log_message_session_state>(	10✔
345	[file, &mark_count](const log_message_session_state& lmss) {	3✔
346	if (mark_count == 0) {	3✔
347	fmt::print(file, FMT_STRING(MARK_HEADER));	15✔
348	}
349	mark_count += 1;	3✔
350	fmt::print(file,	6✔
351	FMT_STRING(";UPDATE all_logs "	9✔
352	"SET log_mark = {}, "
353	"log_comment = {}, "
354	"log_tags = {}, "
355	"log_annotations = {}, "
356	"log_opid = {} "
357	"WHERE log_time_msecs = {} AND "
358	"log_format = {} AND "
359	"log_line_hash = {}\n"),
360	lmss.lmss_mark ? "1" : "0",	3✔
361	sqlitepp::quote(lmss.lmss_comment).in(),	6✔
362	sqlitepp::quote(lmss.lmss_tags).in(),	6✔
363	sqlitepp::quote(lmss.lmss_annotations).in(),	6✔
364	sqlitepp::quote(lmss.lmss_opid).in(),	6✔
365	lmss.lmss_time_msecs,	3✔
366	sqlitepp::quote(lmss.lmss_format).in(),	6✔
367	sqlitepp::quote(lmss.lmss_hash).in());	6✔
368	return false;	3✔
369	});	5✔
370
371	if (each_mark_res.isErr()) {	5✔
UNCOV 372	return Err(console::user_message::error(	×
373	"failed to fetch bookmark metadata for log message")
UNCOV 374	.with_reason(each_mark_res.unwrapErr().fe_msg));	×
375	}
376
377	if (mark_count > 0) {	5✔
378	fmt::print(file, FMT_STRING(MARK_FOOTER), mark_count);	15✔
379	}
380
381	auto prep_filter_res = prepare_stmt(lnav_db.in(), FILTER_QUERY);	5✔
382	if (prep_filter_res.isErr()) {	5✔
UNCOV 383	return Err(console::user_message::error("unable to export filter state")	×
UNCOV 384	.with_reason(prep_filter_res.unwrapErr()));	×
385	}
386
387	auto added_filter_header = false;	5✔
388	auto each_filter_res
389	= prep_filter_res.unwrap().for_each_row<log_filter_session_state>(	10✔
390	[file, &added_filter_header](const log_filter_session_state& lfss) {	4✔
391	if (!added_filter_header) {	4✔
392	fmt::print(file, FMT_STRING("{}"), FILTER_HEADER);	16✔
393	added_filter_header = true;	4✔
394	}
395	fmt::print(	4✔
396	file,
397	FMT_STRING(";REPLACE INTO lnav_view_filters "	8✔
398	"(view_name, enabled, type, language, pattern) "
399	"VALUES ({}, {}, {}, {}, {})\n"),
400	sqlitepp::quote(lfss.lfss_name).in(),	8✔
401	lfss.lfss_enabled ? 1 : 0,	4✔
402	sqlitepp::quote(lfss.lfss_type).in(),	8✔
403	sqlitepp::quote(lfss.lfss_language).in(),	8✔
404	sqlitepp::quote(lfss.lfss_pattern).in());	8✔
405	return false;	4✔
406	});	5✔
407
408	if (each_filter_res.isErr()) {	5✔
UNCOV 409	return Err(console::user_message::error(	×
410	"failed to fetch filter state for views")
UNCOV 411	.with_reason(each_filter_res.unwrapErr().fe_msg));	×
412	}
413
414	auto prep_file_res = prepare_stmt(lnav_db.in(), FILE_QUERY);	5✔
415	if (prep_file_res.isErr()) {	5✔
UNCOV 416	return Err(console::user_message::error("unable to export file state")	×
UNCOV 417	.with_reason(prep_file_res.unwrapErr()));	×
418	}
419
420	auto file_count = 0;	5✔
421	auto file_stmt = prep_file_res.unwrap();	5✔
422	auto each_file_res = file_stmt.for_each_row<log_file_session_state>(
423	[file, &file_count](const log_file_session_state& lfss) {	×
UNCOV 424	if (file_count == 0) {	×
425	fmt::print(file, FMT_STRING("{}"), FILE_HEADER);	×
426	}
427	file_count += 1;	×
428	fmt::print(file,	×
429	FMT_STRING(";UPDATE lnav_file "	×
430	"SET time_offset = {} "
431	"WHERE content_id = {} AND format = {}\n"),
432	lfss.lfss_time_offset,	×
433	sqlitepp::quote(lfss.lfss_content_id).in(),	×
434	sqlitepp::quote(lfss.lfss_format).in());	×
435	return false;	×
436	});	5✔
437
438	if (each_file_res.isErr()) {	5✔
439	return Err(console::user_message::error("failed to fetch file state")	×
440	.with_reason(each_file_res.unwrapErr().fe_msg));	×
441	}
442
443	if (file_count > 0) {	5✔
444	fmt::print(file, FMT_STRING(FILE_FOOTER), file_count);	×
445	}
446
447	for (auto view_index : {LNV_LOG, LNV_TEXT}) {	15✔
448	auto& tc = lnav_data.ld_views[view_index];	10✔
449	if (tc.get_inner_height() == 0_vl) {	10✔
450	continue;	5✔
451	}
452
453	fmt::print(file, FMT_STRING(VIEW_HEADER), lnav_view_titles[view_index]);	20✔
454	fmt::print(file,	5✔
455	FMT_STRING(":switch-to-view {}\n"),	15✔
456	lnav_view_strings[view_index]);	5✔
457
458	if (view_index == LNV_LOG) {	5✔
459	std::vector<std::string> field_cmds;	5✔
460	for (const auto& format : log_format::get_root_formats()) {	371✔
461	auto field_states = format->get_field_states();	366✔
462
463	for (const auto& fs_pair : field_states) {	4,916✔
464	if (!fs_pair.second.lvm_user_hidden) {	4,550✔
465	continue;	4,549✔
466	}
467
468	if (fs_pair.second.lvm_user_hidden.value()) {	1✔
469	field_cmds.emplace_back(	1✔
470	fmt::format(FMT_STRING("# :hide-fields {}.{}\n"),	4✔
471
472	format->get_name(),	2✔
473	fs_pair.first));	1✔
UNCOV 474	} else if (fs_pair.second.lvm_hidden) {	×
UNCOV 475	field_cmds.emplace_back(	×
UNCOV 476	fmt::format(FMT_STRING("# :show-fields {}.{}\n"),	×
UNCOV 477	format->get_name().to_string(),	×
UNCOV 478	fs_pair.first));	×
479	}
480	}
481	}	366✔
482
483	if (!field_cmds.empty()) {	5✔
484	fmt::print(file, FMT_STRING("{}"), FIELD_HEADER);	4✔
485	field_cmds
486	\| lnav::itertools::for_each([&file](const auto& cmd) {	1✔
487	fmt::print(file, FMT_STRING("{}"), cmd);	4✔
488	});	1✔
489	}
490	}	5✔
491
492	{
493	std::vector<std::string> hl_cmds;	5✔
494	const auto& hm = tc.get_highlights();	5✔
495	for (const auto& hl_pair : hm) {	27✔
496	if (hl_pair.first.first != highlight_source_t::INTERACTIVE) {	22✔
497	continue;	21✔
498	}
499
500	auto cmd = fmt::format(FMT_STRING("# :highlight {}\n"),	3✔
501	hl_pair.second.h_regex->get_pattern());	1✔
502	hl_cmds.emplace_back(cmd);	1✔
503	}	1✔
504
505	if (!hl_cmds.empty()) {	5✔
506	fmt::print(file, FMT_STRING("{}"), HIGHLIGHT_HEADER);	4✔
507	hl_cmds
508	\| lnav::itertools::for_each([&file](const auto& cmd) {	1✔
509	fmt::print(file, FMT_STRING("{}"), cmd);	4✔
510	});	1✔
511	fmt::println(file, FMT_STRING(""));	5✔
512	}
513	}	5✔
514
515	auto* tss = tc.get_sub_source();	5✔
516	auto* ttt = dynamic_cast<text_time_translator*>(tss);	5✔
517	if (ttt != nullptr) {	5✔
518	char tsbuf[128];
519	auto min_time_opt = ttt->get_min_row_time();	5✔
520	if (min_time_opt) {	5✔
521	sql_strftime(tsbuf, sizeof(tsbuf), min_time_opt.value(), 'T');	1✔
522	fmt::print(file, FMT_STRING(":hide-lines-before {}\n"), tsbuf);	5✔
523	}
524	auto max_time_opt = ttt->get_max_row_time();	5✔
525	if (max_time_opt) {	5✔
526	sql_strftime(tsbuf, sizeof(tsbuf), max_time_opt.value(), 'T');	1✔
527	fmt::print(file, FMT_STRING(":hide-lines-after {}\n"), tsbuf);	5✔
528	}
529	}
530
531	auto* lss = dynamic_cast<logfile_sub_source*>(tss);	5✔
532	if (lss != nullptr) {	5✔
533	auto min_level = lss->get_min_log_level();	5✔
534
535	if (min_level != LEVEL_UNKNOWN) {	5✔
536	fmt::print(file,	1✔
537	FMT_STRING(":set-min-log-level {}\n"),	4✔
538	level_names[min_level]);	1✔
539	}
540
541	for (const auto& ld : *lss) {	11✔
542	if (ld->is_visible()) {	6✔
543	continue;	5✔
544	}
545
546	if (ld->get_file_ptr()->get_open_options().loo_source	1✔
547	== logfile_name_source::ARCHIVE)	1✔
548	{
UNCOV 549	continue;	×
550	}
551
552	auto container_path_opt
553	= find_container_dir(ld->get_file_ptr()->get_path());	1✔
554	if (!container_path_opt) {	1✔
UNCOV 555	fmt::print(file,	×
UNCOV 556	FMT_STRING(":hide-file {}\n"),	×
UNCOV 557	ld->get_file_ptr()->get_path().string());	×
UNCOV 558	continue;	×
559	}
560	auto container_parent
561	= container_path_opt.value().parent_path();	1✔
562	auto file_container_path = std::filesystem::relative(
563	ld->get_file_ptr()->get_path(), container_parent);	1✔
564	fmt::print(file,	1✔
565	FMT_STRING(":hide-file */{}\n"),	3✔
566	file_container_path.string());	2✔
567	}	1✔
568	}
569
570	if (!tc.get_current_search().empty()) {	5✔
571	fmt::print(file, FMT_STRING("/{}\n"), tc.get_current_search());	5✔
572	}
573
574	fmt::print(file, FMT_STRING(":goto {}\n"), (int) tc.get_top());	25✔
575	}
576
577	return Ok();	5✔
578	}	5✔
579
580	} // namespace lnav::session

tstack / lnav / 17589970077-2502

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous