Made AddonDialog output some prettier text, installation of Addons now seem to work
[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 "gui/menu_manager.hpp"
28 #include "supertux/menu/addon_dialog.hpp"
29 #include "util/gettext.hpp"
30
31 namespace {
32
33 #define IS_REPOSITORY_MENU_ID(idx) ((idx - MNID_ADDON_LIST_START) % 2 == 0)
34 #define IS_INSTALLED_MENU_ID(idx) ((idx - MNID_ADDON_LIST_START) % 2 == 1)
35
36 #define MAKE_REPOSITORY_MENU_ID(idx) (MNID_ADDON_LIST_START + 2*idx+0)
37 #define MAKE_INSTALLED_MENU_ID(idx) (MNID_ADDON_LIST_START + 2*idx+1)
38
39 #define UNPACK_REPOSITORY_MENU_ID(idx) (((idx - MNID_ADDON_LIST_START) - 0) / 2)
40 #define UNPACK_INSTALLED_MENU_ID(idx) (((idx - MNID_ADDON_LIST_START) - 1) / 2)
41
42 std::string addon_type_to_translated_string(Addon::Type type)
43 {
44   switch (type)
45   {
46     case Addon::LEVELSET:
47       return _("Levelset");
48
49     case Addon::WORLDMAP:
50       return _("Worldmap");
51
52     case Addon::WORLD:
53       return _("World");
54
55     default:
56       return _("Unknown");
57   }
58 }
59
60 std::string generate_menu_item_text(const Addon& addon)
61 {
62   std::string text;
63   std::string type = addon_type_to_translated_string(addon.get_type());
64
65   if(!addon.get_author().empty())
66   {
67     text = str(boost::format(_("%s \"%s\" by \"%s\""))
68                % type % addon.get_title() % addon.get_author());
69   }
70   else
71   {
72     // Only addon type and name, no need for translation.
73     text = str(boost::format("%s \"%s\"")
74                % type % addon.get_title());
75   }
76
77   return text;
78 }
79
80 } // namespace
81
82 AddonMenu::AddonMenu() :
83   m_addon_manager(*AddonManager::current()),
84   m_installed_addons(),
85   m_repository_addons()
86 {
87   refresh();
88 }
89
90 void
91 AddonMenu::refresh()
92 {
93   m_installed_addons = m_addon_manager.get_installed_addons();
94   m_repository_addons = m_addon_manager.get_repository_addons();
95
96   rebuild_menu();
97 }
98
99 void
100 AddonMenu::rebuild_menu()
101 {
102   clear();
103   add_label(_("Add-ons"));
104   add_hl();
105
106
107   if (m_installed_addons.empty())
108   {
109     add_inactive(MNID_NOTHING_NEW, _("No Addons installed"));
110   }
111   else
112   {
113     int idx = 0;
114     for (const auto& addon_id : m_installed_addons)
115     {
116       const Addon& addon = m_addon_manager.get_installed_addon(addon_id);
117       std::string text = generate_menu_item_text(addon);
118       add_toggle(MAKE_INSTALLED_MENU_ID(idx), text, addon.is_enabled());
119       idx += 1;
120     }
121   }
122
123   add_hl();
124
125   {
126     bool have_new_stuff = false;
127     int idx = 0;
128     for (const auto& addon_id : m_repository_addons)
129     {
130       const Addon& addon = m_addon_manager.get_repository_addon(addon_id);
131       try
132       {
133         // addon is already installed, so check if they are the same
134         Addon& installed_addon = m_addon_manager.get_installed_addon(addon_id);
135         if (installed_addon.get_md5() == addon.get_md5() ||
136             installed_addon.get_version() > addon.get_version())
137         {
138           log_debug << "ignoring already installed addon " << installed_addon.get_id() << std::endl;
139         }
140         else
141         {
142           log_debug << installed_addon.get_id() << " is installed, but updated: '"
143                     << installed_addon.get_md5() << "' vs '" << addon.get_md5() << "'  '"
144                     << installed_addon.get_version() << "' vs '" << addon.get_version() << "'"
145                     << std::endl;
146           std::string text = generate_menu_item_text(addon);
147           add_entry(MAKE_REPOSITORY_MENU_ID(idx), "Install " + text + " *NEW*");
148           have_new_stuff = true;
149         }
150       }
151       catch(const std::exception& err)
152       {
153         // addon is not installed
154         std::string text = generate_menu_item_text(addon);
155         add_entry(MAKE_REPOSITORY_MENU_ID(idx), "Install " + text);
156         have_new_stuff = true;
157       }
158       idx += 1;
159     }
160
161     if (!have_new_stuff && m_addon_manager.has_been_updated())
162     {
163       add_inactive(MNID_NOTHING_NEW, _("No new Addons found"));
164     }
165   }
166
167   if (!m_addon_manager.has_online_support())
168   {
169     add_inactive(MNID_CHECK_ONLINE, std::string(_("Check Online (disabled)")));
170   }
171   else
172   {
173     add_entry(MNID_CHECK_ONLINE, std::string(_("Check Online")));
174   }
175
176   add_hl();
177   add_back(_("Back"));
178 }
179
180 void
181 AddonMenu::menu_action(MenuItem* item)
182 {
183   if (item->id == MNID_CHECK_ONLINE) // check if "Check Online" was chosen
184   {
185     try
186     {
187       m_addon_manager.check_online();
188       refresh();
189     }
190     catch (std::exception& e)
191     {
192       log_warning << "Check for available Add-ons failed: " << e.what() << std::endl;
193     }
194   }
195   else if (MNID_ADDON_LIST_START <= item->id)
196   {
197     if (IS_INSTALLED_MENU_ID(item->id))
198     {
199       int idx = UNPACK_INSTALLED_MENU_ID(item->id);
200       if (0 <= idx && idx < static_cast<int>(m_installed_addons.size()))
201       {
202         const Addon& addon = m_addon_manager.get_installed_addon(m_installed_addons[idx]);
203         if(addon.is_enabled())
204         {
205           m_addon_manager.disable_addon(addon.get_id());
206           set_toggled(item->id, addon.is_enabled());
207         }
208         else
209         {
210           m_addon_manager.enable_addon(addon.get_id());
211           set_toggled(item->id, addon.is_enabled());
212         }
213       }
214     }
215     else if (IS_REPOSITORY_MENU_ID(item->id))
216     {
217       int idx = UNPACK_REPOSITORY_MENU_ID(item->id);
218       if (0 <= idx && idx < static_cast<int>(m_repository_addons.size()))
219       {
220         const Addon& addon = m_addon_manager.get_repository_addon(m_repository_addons[idx]);
221         auto addon_id = addon.get_id();
222         AddonManager::InstallStatusPtr status = m_addon_manager.request_install_addon(addon_id);
223
224         status->then([this, addon_id]{
225             try
226             {
227               m_addon_manager.enable_addon(addon_id);
228             }
229             catch(const std::exception& err)
230             {
231               log_warning << "Enabling addon failed: " << err.what() << std::endl;
232             }
233             MenuManager::instance().set_dialog({});
234             refresh();
235           });
236
237         std::unique_ptr<AddonDialog> dialog(new AddonDialog(status));
238         dialog->set_title("Downloading " + generate_menu_item_text(addon));
239         MenuManager::instance().set_dialog(std::move(dialog));
240       }
241     }
242   }
243   else
244   {
245     log_warning << "Unknown menu item clicked: " << item->id << std::endl;
246   }
247 }
248
249 /* EOF */