blob: dc6871d07f734caf413b54fac559d3acd0ddd28f (
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
|
/*
* Copyright (c) 2022, kleines Filmröllchen <filmroellchen@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include "Node.h"
#include "PageNode.h"
#include "SectionNode.h"
#include <AK/Assertions.h>
#include <AK/LexicalPath.h>
#include <AK/Optional.h>
#include <AK/StringView.h>
#include <AK/URL.h>
#include <LibFileSystem/FileSystem.h>
#include <LibManual/Path.h>
namespace Manual {
ErrorOr<NonnullRefPtr<PageNode const>> Node::try_create_from_query(Vector<StringView, 2> const& query_parameters)
{
if (query_parameters.size() > 2)
return Error::from_string_literal("Queries longer than 2 strings are not supported yet");
auto query_parameter_iterator = query_parameters.begin();
if (query_parameter_iterator.is_end())
return PageNode::help_index_page();
auto first_query_parameter = *query_parameter_iterator;
++query_parameter_iterator;
if (query_parameter_iterator.is_end()) {
// [/path/to/docs.md]
auto path_from_query = LexicalPath { first_query_parameter };
constexpr auto MARKDOWN_FILE_EXTENSION = "md"sv;
if (path_from_query.is_absolute()
&& path_from_query.is_child_of(manual_base_path)
&& path_from_query.extension() == MARKDOWN_FILE_EXTENSION) {
// Parse the section number and page name from a directory string of the form:
// /usr/share/man/man[section_number]/[page_name].md
// The page_name includes any subsections.
auto const& section_directory = path_from_query.string();
auto section_name_start_index = manual_base_path.string().length() + 4;
auto section_name_end_index = section_directory.find('/', section_name_start_index);
if (!section_name_end_index.has_value())
return Error::from_string_literal("Page is inside invalid section");
auto section_name = section_directory.substring_view(section_name_start_index, section_name_end_index.value() - section_name_start_index);
auto section = TRY(SectionNode::try_create_from_number(section_name));
auto page_name_end_index = section_directory.length() - section_name_end_index.value() - MARKDOWN_FILE_EXTENSION.length() - 1;
auto page_name = section_directory.substring_view(section_name_end_index.value(), page_name_end_index);
return try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(page_name)));
}
// [page] (in any section)
Optional<NonnullRefPtr<PageNode>> maybe_page;
for (auto const& section : sections) {
auto const page = TRY(try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(first_query_parameter))));
if (FileSystem::exists(TRY(page->path()))) {
maybe_page = page;
break;
}
}
if (maybe_page.has_value())
return maybe_page.release_value();
return Error::from_string_literal("Page not found");
}
// [section] [name]
auto second_query_parameter = *query_parameter_iterator;
auto section = TRY(SectionNode::try_create_from_number(first_query_parameter));
auto const page = TRY(try_make_ref_counted<PageNode>(section, TRY(String::from_utf8(second_query_parameter))));
if (FileSystem::exists(TRY(page->path())))
return page;
return Error::from_string_literal("Page doesn't exist in section");
}
ErrorOr<NonnullRefPtr<Node const>> Node::try_find_from_help_url(URL const& url)
{
if (url.host() != "man")
return Error::from_string_view("Bad help operation"sv);
if (url.path_segment_count() < 2)
return Error::from_string_view("Bad help page URL"sv);
auto const section = url.path_segment_at_index(0);
auto maybe_section_number = section.to_uint();
if (!maybe_section_number.has_value())
return Error::from_string_view("Bad section number"sv);
auto section_number = maybe_section_number.value();
if (section_number > number_of_sections)
return Error::from_string_view("Section number out of bounds"sv);
NonnullRefPtr<Node const> current_node = sections[section_number - 1];
bool child_node_found;
for (size_t i = 1; i < url.path_segment_count(); i++) {
child_node_found = false;
auto children = TRY(current_node->children());
for (auto const& child : children) {
if (TRY(child->name()) == url.path_segment_at_index(i).view()) {
child_node_found = true;
current_node = child;
break;
}
}
if (!child_node_found)
break;
}
if (!child_node_found)
return Error::from_string_view("Page not found"sv);
return current_node;
}
}
|
