File: otp_check_html_links.exs

package info (click to toggle)
erlang 1%3A28.0.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 234,540 kB
  • sloc: erlang: 1,681,194; ansic: 436,017; cpp: 178,134; xml: 82,160; makefile: 15,053; sh: 14,564; lisp: 9,850; java: 8,603; asm: 6,829; perl: 5,874; python: 5,482; sed: 72
file content (232 lines) | stat: -rwxr-xr-x 6,048 bytes parent folder | download
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
#!/usr/bin/env elixir

# %CopyrightBegin%
#
# SPDX-License-Identifier: Apache-2.0
#
# Copyright Ericsson AB 2023-2025. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# %CopyrightEnd%

Mix.install([
  :floki
])

defmodule Anchors do
  def get_anchors(file, document) do
    anchors =
      for {_, attr, _} <- Floki.find(document, "[id]") do
        if Enum.count(attr, fn {tag, _} -> String.equivalent?(tag, "id") end) > 1 do
          warn(file, "duplicate id attribute found: ")
        end

        :proplists.get_value("id", attr)
      end

    for anchor <-
          Enum.sort(anchors)
          |> Enum.chunk_by(fn a -> a end)
          |> Enum.filter(&(Enum.count(&1) > 1)) do
      warn(file, "Found duplicate anchor #{hd(anchor)}")
    end

    anchors
  end

  def warn(file, string) do
    Process.put(:exit_status, Process.get(:exit_status) + 1)
    IO.puts("#{Path.relative_to_cwd(file)}: #{string}")
  end

  def maybe_warn(file, target, what, suggestion \\ nil)

  def maybe_warn(_file, _target, true, _suggestion) do
    nil
  end

  def maybe_warn(file, target, false, suggestion) do
    if suggestion do
      warn(
        file,
        "could not find #{Path.relative_to_cwd(target)}, should it be ##{suggestion}?"
      )
    else
      warn(file, "could not find #{Path.relative_to_cwd(target)}")
    end

    nil
  end

  def validate_href(_file, "http://" <> _href, _anchors) do
    nil
  end

  def validate_href(_file, "https://" <> _href, _anchors) do
    nil
  end

  def validate_href(file, "`" <> _ = href, _anchors) do
    warn(file, "found #{href}")
  end

  def validate_href(file, <<"#">> <> _anchor = href, anchors) do
    validate_href(file, Path.basename(file) <> href, anchors)
  end

  def validate_href(file, href, anchors) do
    target = Path.dirname(file) |> Path.join(href) |> Path.expand()

    case String.split(target, "#", parts: 2) do
      [target | anchor] when anchor == [] or anchor == [""] ->
        case Path.extname(target) do
          ".html" -> maybe_warn(file, target, Map.has_key?(anchors, target))
          _ -> maybe_warn(file, target, File.exists?(target))
        end

      [t, anchor] ->
        case Map.fetch(anchors, t) do
          {:ok, targetAnchors} when targetAnchors != [] ->
            cond do
              :lists.member(anchor, targetAnchors) ->
                {t, anchor}

              :lists.member(URI.decode(anchor), targetAnchors) ->
                {t, URI.decode(anchor)}

              :lists.member(URI.decode(anchor), targetAnchors) ->
                {t, URI.decode(anchor)}

              :lists.member(URI.encode_www_form(anchor), targetAnchors) ->
                {t, URI.encode_www_form(anchor)}

              true ->
                {_, closest} =
                  targetAnchors
                  |> Enum.map(fn a ->
                    {String.jaro_distance(String.downcase(anchor), String.downcase(a)), a}
                  end)
                  |> Enum.sort()
                  |> Enum.reverse()
                  |> Enum.fetch!(0)

                maybe_warn(file, target, false, closest)
            end

          _ ->
            maybe_warn(file, target, false)
        end
    end
  end

  def validate_hrefs(file, document, anchors, seen) do
    if String.contains?(file, "doc/html/assets/") do
      seen
    else
      Floki.find(document, "a[href]")
      |> Enum.reduce(seen, fn {_, attr, _}, seen ->
        href = :proplists.get_value("href", attr)

        case validate_href(file, href, anchors) do
          {target, anchor} ->
            {_, seen} =
              Map.get_and_update(seen, target, fn
                nil -> {nil, [anchor]}
                anchors -> {anchors, [anchor | anchors]}
              end)

            seen

          nil ->
            seen
        end
      end)
    end
  end

  def validate_imgs(file, document) do
    Floki.find(document, "img[src]")
    |> Enum.map(fn {_, attr, _} ->
      target = Path.join(Path.dirname(file), :proplists.get_value("src", attr))

      if not File.exists?(target) do
        warn(file, "could not find #{Path.relative_to_cwd(target)}")
      end
    end)
  end
end

Process.put(:exit_status, 0)

patterns =
  case System.argv() do
    [] -> ["doc/", "doc/system/", "lib/*/doc/html/", "erts*/doc/html/", "system/doc/html/"]
    patterns -> patterns
  end

files =
  for pattern <- patterns, file <- Path.wildcard(pattern <> "**/*.html") do
    document = Floki.parse_document!(File.read!(file))
    {Path.expand(file), document}
  end

anchors =
  Map.new(
    for {file, document} <- files do
      anchors = Anchors.get_anchors(file, document)

      {file, anchors}
    end
  )

seen =
  Enum.reduce(files, %{}, fn {file, document}, seen ->
    Anchors.validate_hrefs(file, document, anchors, seen)
  end)

Enum.map(files, fn {file, document} ->
  Anchors.validate_imgs(file, document)
end)

generated_anchors = [
  "sidebar",
  "sidebar-listnav",
  "extras-list-tab-button",
  "modules-list-tab-button",
  "extras-tab-panel",
  "extras-full-list",
  "modules-tab-panel",
  "modules-full-list",
  "toast",
  "content",
  "moduledoc"
]

if false do
  anchors
  |> Enum.sort()
  |> Enum.map(fn {file, anchors} ->
    if not String.contains?(file, "doc/html/assets/") do
      seen_anchors = Map.get(seen, file, [])

      for a <- anchors do
        if a not in (seen_anchors ++ generated_anchors) do
          Anchors.warn(file, "Unused anchor #{a}")
        end
      end
    end
  end)
end

System.halt(Process.get(:exit_status))