Keep proper track of MD5 checksums of addons
[supertux.git] / src / supertux / menu / addon_menu.cpp
1 //  SuperTux
2 //  Copyright (C) 2009 Ingo Ruhnke <grumbel@gmail.com>
3 //
4 //  This program is free software: you can redistribute it and/or modify
5 //  it under the terms of the GNU General Public License as published by
6 //  the Free Software Foundation, either version 3 of the License, or
7 //  (at your option) any later version.
8 //
9 //  This program is distributed in the hope that it will be useful,
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 //  GNU General Public License for more details.
13 //
14 //  You should have received a copy of the GNU General Public License
15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 #include "supertux/menu/addon_menu.hpp"
18
19 #include <config.h>
20 #include <algorithm>
21 #include <boost/format.hpp>
22
23 #include "addon/addon.hpp"
24 #include "addon/addon_manager.hpp"
25 #include "gui/menu.hpp"
26 #include "gui/menu_item.hpp"
27 #include "util/gettext.hpp"
28
29 namespace {
30
31 #define IS_REPOSITORY_MENU_ID(idx) ((idx - MNID_ADDON_LIST_START) % 2 == 0)
32 #define IS_INSTALLED_MENU_ID(idx) ((idx - MNID_ADDON_LIST_START) % 2 == 1)
33
34 #define MAKE_REPOSITORY_MENU_ID(idx) (MNID_ADDON_LIST_START + 2*idx+0)
35 #define MAKE_INSTALLED_MENU_ID(idx) (MNID_ADDON_LIST_START + 2*idx+1)
36
37 #define UNPACK_REPOSITORY_MENU_ID(idx) (((idx - MNID_ADDON_LIST_START) - 0) / 2)
38 #define UNPACK_INSTALLED_MENU_ID(idx) (((idx - MNID_ADDON_LIST_START) - 1) / 2)
39
40 std::string addon_type_to_translated_string(Addon::Type type)
41 {
42   switch (type)
43   {
44     case Addon::LEVELSET:
45       return _("Levelset");
46
47     case Addon::WORLDMAP:
48       return _("Worldmap");
49
50     case Addon::WORLD:
51       return _("World");
52
53     default:
54       return _("Unknown");
55   }
56 }
57
58 std::string generate_menu_item_text(const Addon& addon)
59 {
60   std::string text;
61   std::string type = addon_type_to_translated_string(addon.get_type());
62
63   if(!addon.get_author().empty())
64   {
65     text = str(boost::format(_("%s \"%s\" by \"%s\""))
66                % type % addon.get_title() % addon.get_author());
67   }
68   else
69   {
70     // Only addon type and name, no need for translation.
71     text = str(boost::format("%s \"%s\"")
72                % type % addon.get_title());
73   }
74
75   return text;
76 }
77
78 } // namespace
79
80 AddonMenu::AddonMenu() :
81   m_addon_manager(*AddonManager::current()),
82   m_installed_addons(),
83   m_repository_addons()
84 {
85   refresh();
86 }
87
88 void
89 AddonMenu::refresh()
90 {
91   m_installed_addons = m_addon_manager.get_installed_addons();
92   m_repository_addons = m_addon_manager.get_repository_addons();
93
94 #ifdef GRUMBEL
95   std::sort(m_addons.begin(), m_addons.end(),
96             [](const Addon& lhs, const Addon& rhs)
97             {
98               return lhs.title < lhs.title;
99             });
100 #endif
101
102   rebuild_menu();
103 }
104
105 void
106 AddonMenu::rebuild_menu()
107 {
108   clear();
109   add_label(_("Add-ons"));
110   add_hl();
111
112
113   if (!m_installed_addons.empty())
114   {
115     int idx = 0;
116     for (const auto& addon_id : m_installed_addons)
117     {
118       const Addon& addon = m_addon_manager.get_installed_addon(addon_id);
119       std::string text = generate_menu_item_text(addon);
120       add_toggle(MAKE_INSTALLED_MENU_ID(idx), text, addon.is_enabled());
121       idx += 1;
122     }
123
124     add_hl();
125   }
126
127   if (!m_addon_manager.has_online_support())
128   {
129     add_inactive(MNID_CHECK_ONLINE, std::string(_("Check Online (disabled)")));
130   }
131   else
132   {
133     add_entry(MNID_CHECK_ONLINE, std::string(_("Check Online")));
134   }
135
136   {
137     int idx = 0;
138     for (const auto& addon_id : m_repository_addons)
139     {
140       const Addon& addon = m_addon_manager.get_repository_addon(addon_id);
141       try
142       {
143         // addon is already installed, so check if they are the same
144         Addon& installed_addon = m_addon_manager.get_installed_addon(addon_id);
145         if (installed_addon.get_md5() == addon.get_md5() ||
146             installed_addon.get_version() > addon.get_version())
147         {
148           log_debug << "ignoring already installed addon " << installed_addon.get_id() << std::endl;
149         }
150         else
151         {
152           log_debug << installed_addon.get_id() << " is installed, but updated: '"
153                     << installed_addon.get_md5() << "' vs '" << addon.get_md5() << "'  '"
154                     << installed_addon.get_version() << "' vs '" << addon.get_version() << "'"
155                     << std::endl;
156           std::string text = generate_menu_item_text(addon);
157           add_entry(MAKE_REPOSITORY_MENU_ID(idx), "Install " + text + " *NEW*");
158           idx += 1;
159         }
160       }
161       catch(const std::exception& err)
162       {
163         // addon is not installed
164         std::string text = generate_menu_item_text(addon);
165         add_entry(MAKE_REPOSITORY_MENU_ID(idx), "Install " + text);
166         idx += 1;
167       }
168     }
169   }
170
171   add_hl();
172   add_back(_("Back"));
173 }
174
175 void
176 AddonMenu::menu_action(MenuItem* item)
177 {
178   if (item->id == MNID_CHECK_ONLINE) // check if "Check Online" was chosen
179   {
180     try
181     {
182       m_addon_manager.check_online();
183       refresh();
184     }
185     catch (std::exception& e)
186     {
187       log_warning << "Check for available Add-ons failed: " << e.what() << std::endl;
188     }
189   }
190   else if (MNID_ADDON_LIST_START <= item->id)
191   {
192     if (IS_INSTALLED_MENU_ID(item->id))
193     {
194       int idx = UNPACK_INSTALLED_MENU_ID(item->id);
195       if (0 <= idx && idx < static_cast<int>(m_installed_addons.size()))
196       {
197         const Addon& addon = m_addon_manager.get_installed_addon(m_installed_addons[idx]);
198         if(addon.is_enabled())
199         {
200           m_addon_manager.disable_addon(addon.get_id());
201           set_toggled(item->id, addon.is_enabled());
202         }
203         else
204         {
205           m_addon_manager.enable_addon(addon.get_id());
206           set_toggled(item->id, addon.is_enabled());
207         }
208       }
209     }
210     else if (IS_REPOSITORY_MENU_ID(item->id))
211     {
212       int idx = UNPACK_REPOSITORY_MENU_ID(item->id);
213       if (0 <= idx && idx < static_cast<int>(m_repository_addons.size()))
214       {
215         const Addon& addon = m_addon_manager.get_repository_addon(m_repository_addons[idx]);
216         try
217         {
218           m_addon_manager.install_addon(addon.get_id());
219           m_addon_manager.enable_addon(addon.get_id());
220         }
221         catch(const std::exception& err)
222         {
223           log_warning << "Enabling addon failed: " << err.what() << std::endl;
224         }
225         refresh();
226       }
227     }
228   }
229   else
230   {
231        log_warning << "Unknown menu item clicked: " << item->id << std::endl;
232   }
233 }
234
235 /* EOF */