summaryrefslogtreecommitdiff
path: root/src/lib/release_notes.cc
blob: b47b570a3d7f2c5d71efcbf3981f6752b8bad8aa (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
/*
    Copyright (C) 2022 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic 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 2 of the License, or
    (at your option) any later version.

    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/


#include "config.h"
#include "release_notes.h"
#include "variant.h"
#include "version.h"
#include <dcp/raw_convert.h>
#include <boost/algorithm/string.hpp>

#include "i18n.h"


using std::string;
using std::vector;
using boost::optional;


bool
before(optional<string> last, string current)
{
	if (!last) {
		return true;
	}

	vector<string> last_parts;
	boost::split(last_parts, *last, boost::is_any_of("."));
	vector<string> current_parts;
	boost::split(current_parts, current, boost::is_any_of("."));

	if (last_parts.size() != 3 || current_parts.size() != 3) {
		/* One or other is a git version; don't bother reporting anything */
		return false;
	}

	for (int i = 0; i < 3; ++i) {
		if (dcp::raw_convert<int>(last_parts[i]) < dcp::raw_convert<int>(current_parts[i])) {
		    return true;
		}
	}

	return false;
}


optional<string>
find_release_notes(bool dark, optional<string> current)
{
	auto last = Config::instance()->last_release_notes_version();
	if (!current) {
		current = string(dcpomatic_version);
	}
	if (last && *last == *current) {
		return {};
	}

	/* It's been a while now since we added release notes.  Don't show them
	 * for (potentially) long ago previous unknowns any more.
	 */
	if (!last) {
		last = *current;
	}

	Config::instance()->set_last_release_notes_version(*current);

	vector<string> notes;

	if (before(last, "2.17.19")) {
		notes.push_back(_("The vertical offset control for some subtitles now works in the opposite direction "
				  "to how it was before.   You should check any subtitles in your project to make sure "
				  "that they are placed where you want them."));
	}

	if (notes.empty()) {
		return {};
	}

	string const colour = dark ? "white" : "black";
	auto const span = fmt::format("<span style=\"color: {}\">", colour);

	auto output = fmt::format("<h1>{}{} {} release notes</span></h1><ul>", span, variant::dcpomatic(), *current);

	for (auto const& note: notes) {
		output += string("<li>") + span + note + "</span>";
	}

	output += "</ul>";

	return output;
}