aboutsummaryrefslogtreecommitdiffstats
path: root/src/m_email/EMailHeaderView.h
blob: 57d837ed9f679a27138e11c18469600c86c5bbad (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
/**
 * Copyright (C) 2021-2024 Saturneric <eric@bktus.com>
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric <eric@bktus.com> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#pragma once

#include <QWidget>

#include "EMailModel.h"

class QLineEdit;
class QTreeWidget;
class QTreeWidgetItem;
class QLabel;

/**
 * @brief The message's headers, as one searchable list.
 *
 * Rows come from the ORIGINAL bytes rather than from a reserialization, so
 * order, folding, duplicates and encoding are the sender's and not vmime's.
 * That distinction is the whole point of the view: a header list fed by a
 * round trip shows the parser's idea of the headers -- reordered, refolded and
 * re-encoded -- while claiming to show the sender's, which is precisely the
 * evidence header forensics depends on.
 *
 * Each row therefore carries both readings: the decoded value, which is what
 * the field means, and the exact bytes it was written as, which is what it
 * says. They are shown together rather than behind a mode switch, because the
 * question "do these two disagree?" is the one worth being able to ask.
 */
class EMailHeaderView : public QWidget {
  Q_OBJECT

 public:
  explicit EMailHeaderView(QWidget* parent = nullptr);

  /**
   * @brief Shows the headers of @p root.
   *
   * @param root the parsed tree; its header_fields supply the decoded reading
   * @param raw the ORIGINAL message bytes, which supply the rows themselves
   */
  void SetMessage(const EMailPart& root, const QByteArray& raw);

  /// Drops everything shown.
  void Clear();

  /// Replaces the table with @p text, for when there is nothing to tabulate.
  /// Passing an empty string is not a way to clear the view; use Clear().
  void ShowNotice(const QString& text);

 protected:
  void changeEvent(QEvent* event) override;

 private:
  void build_ui();
  /// The single place this view's colours are decided. Must not touch fonts.
  void apply_colors();
  void refresh();
  /// Hides the rows that do not match the filter, and shows the placeholder
  /// when that leaves nothing. Never rebuilds: filtering is a view choice and
  /// must not be able to change what is in the list.
  void apply_filter();
  void copy_selected(bool whole_field);
  /// Copies out of @p item, which may be nullptr.
  void copy_item(QTreeWidgetItem* item, bool whole_field);

  QLineEdit* filter_{};
  QTreeWidget* tree_{};
  QLabel* empty_notice_{};

  EMailPart root_;
  QByteArray raw_;
  bool loaded_{false};
};