Merge pull request #3653 from ace20022/langCodes
[vuplus_xbmc] / xbmc / addons / GUIDialogAddonInfo.cpp
1 /*
2  *      Copyright (C) 2005-2013 Team XBMC
3  *      http://xbmc.org
4  *
5  *  This Program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2, or (at your option)
8  *  any later version.
9  *
10  *  This Program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with XBMC; see the file COPYING.  If not, see
17  *  <http://www.gnu.org/licenses/>.
18  *
19  */
20
21 #include "GUIDialogAddonInfo.h"
22 #include "dialogs/GUIDialogYesNo.h"
23 #include "dialogs/GUIDialogOK.h"
24 #include "addons/AddonManager.h"
25 #include "AddonDatabase.h"
26 #include "FileItem.h"
27 #include "filesystem/Directory.h"
28 #include "filesystem/SpecialProtocol.h"
29 #include "GUIDialogAddonSettings.h"
30 #include "dialogs/GUIDialogContextMenu.h"
31 #include "dialogs/GUIDialogTextViewer.h"
32 #include "GUIUserMessages.h"
33 #include "guilib/GUIWindowManager.h"
34 #include "guilib/Key.h"
35 #include "utils/JobManager.h"
36 #include "utils/FileOperationJob.h"
37 #include "utils/StringUtils.h"
38 #include "utils/URIUtils.h"
39 #include "addons/AddonInstaller.h"
40 #include "pvr/PVRManager.h"
41
42 #define CONTROL_BTN_INSTALL          6
43 #define CONTROL_BTN_ENABLE           7
44 #define CONTROL_BTN_UPDATE           8
45 #define CONTROL_BTN_SETTINGS         9
46 #define CONTROL_BTN_CHANGELOG       10
47 #define CONTROL_BTN_ROLLBACK        11
48
49 using namespace std;
50 using namespace ADDON;
51 using namespace XFILE;
52
53 CGUIDialogAddonInfo::CGUIDialogAddonInfo(void)
54     : CGUIDialog(WINDOW_DIALOG_ADDON_INFO, "DialogAddonInfo.xml")
55 {
56   m_item = CFileItemPtr(new CFileItem);
57   m_loadType = KEEP_IN_MEMORY;
58 }
59
60 CGUIDialogAddonInfo::~CGUIDialogAddonInfo(void)
61 {
62 }
63
64 bool CGUIDialogAddonInfo::OnMessage(CGUIMessage& message)
65 {
66   switch ( message.GetMessage() )
67   {
68   case GUI_MSG_WINDOW_DEINIT:
69     {
70       if (m_jobid)
71         CJobManager::GetInstance().CancelJob(m_jobid);
72     }
73     break;
74
75   case GUI_MSG_CLICKED:
76     {
77       int iControl = message.GetSenderId();
78       if (iControl == CONTROL_BTN_UPDATE)
79       {
80         OnUpdate();
81         return true;
82       }
83       if (iControl == CONTROL_BTN_INSTALL)
84       {
85         if (!m_localAddon)
86         {
87           OnInstall();
88           return true;
89         }
90         else
91         {
92           OnUninstall();
93           return true;
94         }
95       }
96       else if (iControl == CONTROL_BTN_ENABLE)
97       {
98         OnEnable(!m_item->GetProperty("Addon.Enabled").asBoolean());
99         return true;
100       }
101       else if (iControl == CONTROL_BTN_SETTINGS)
102       {
103         OnSettings();
104         return true;
105       }
106       else if (iControl == CONTROL_BTN_CHANGELOG)
107       {
108         OnChangeLog();
109         return true;
110       }
111       else if (iControl == CONTROL_BTN_ROLLBACK)
112       {
113         OnRollback();
114         return true;
115       }
116     }
117     break;
118 default:
119     break;
120   }
121
122   return CGUIDialog::OnMessage(message);
123 }
124
125 bool CGUIDialogAddonInfo::OnAction(const CAction &action)
126 {
127   if (action.GetID() == ACTION_SHOW_INFO)
128   {
129     Close();
130     return true;
131   }
132   return CGUIDialog::OnAction(action);
133 }
134
135 void CGUIDialogAddonInfo::OnInitWindow()
136 {
137   UpdateControls();
138   CGUIDialog::OnInitWindow();
139   m_changelog = false;
140 }
141
142 void CGUIDialogAddonInfo::UpdateControls()
143 {
144   CStdString xbmcPath = CSpecialProtocol::TranslatePath("special://xbmc/addons");
145   bool isInstalled = NULL != m_localAddon.get();
146   bool isSystem = isInstalled && StringUtils::StartsWith(m_localAddon->Path(), xbmcPath);
147   bool isEnabled = isInstalled && m_item->GetProperty("Addon.Enabled").asBoolean();
148   bool isUpdatable = isInstalled && m_item->GetProperty("Addon.UpdateAvail").asBoolean();
149   if (isInstalled)
150     GrabRollbackVersions();
151
152   // TODO: System addons should be able to be disabled
153   bool isPVR = isInstalled && m_localAddon->Type() == ADDON_PVRDLL;
154   bool canDisable = isInstalled && (!isSystem || isPVR) && !m_localAddon->IsInUse();
155   bool canInstall = !isInstalled && m_item->GetProperty("Addon.Broken").empty();
156   bool isRepo = (isInstalled && m_localAddon->Type() == ADDON_REPOSITORY) || (m_addon && m_addon->Type() == ADDON_REPOSITORY);
157
158   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_INSTALL, canDisable || canInstall);
159   SET_CONTROL_LABEL(CONTROL_BTN_INSTALL, isInstalled ? 24037 : 24038);
160
161   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_ENABLE, canDisable);
162   SET_CONTROL_LABEL(CONTROL_BTN_ENABLE, isEnabled ? 24021 : 24022);
163
164   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_UPDATE, isUpdatable);
165   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_SETTINGS, isInstalled && m_localAddon->HasSettings());
166   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_CHANGELOG, !isRepo);
167   CONTROL_ENABLE_ON_CONDITION(CONTROL_BTN_ROLLBACK, m_rollbackVersions.size() > 1);
168 }
169
170 void CGUIDialogAddonInfo::OnUpdate()
171 {
172   CStdString referer = StringUtils::Format("Referer=%s-%s.zip",m_localAddon->ID().c_str(),m_localAddon->Version().c_str());
173   CAddonInstaller::Get().Install(m_addon->ID(), true, referer); // force install
174   Close();
175 }
176
177 void CGUIDialogAddonInfo::OnInstall()
178 {
179   CAddonInstaller::Get().Install(m_addon->ID());
180   Close();
181 }
182
183 bool CGUIDialogAddonInfo::PromptIfDependency(int heading, int line2)
184 {
185   if (!m_localAddon)
186     return false;
187
188   VECADDONS addons;
189   vector<string> deps;
190   CAddonMgr::Get().GetAllAddons(addons);
191   for (VECADDONS::const_iterator it  = addons.begin();
192        it != addons.end();++it)
193   {
194     ADDONDEPS::const_iterator i = (*it)->GetDeps().find(m_localAddon->ID());
195     if (i != (*it)->GetDeps().end() && !i->second.second) // non-optional dependency
196       deps.push_back((*it)->Name());
197   }
198
199   if (!deps.empty())
200   {
201     string line0 = StringUtils::Format(g_localizeStrings.Get(24046), m_localAddon->Name().c_str());
202     string line1 = StringUtils::Join(deps, ", ");
203     CGUIDialogOK::ShowAndGetInput(heading, line0, line1, line2);
204     return true;
205   }
206   return false;
207 }
208
209 void CGUIDialogAddonInfo::OnUninstall()
210 {
211   if (!m_localAddon.get())
212     return;
213
214   // ensure the addon is not a dependency of other installed addons
215   if (PromptIfDependency(24037, 24047))
216     return;
217
218   // prompt user to be sure
219   if (CGUIDialogYesNo::ShowAndGetInput(24037, 750, 0, 0))
220     return;
221
222   // ensure the addon isn't disabled in our database
223   CAddonMgr::Get().DisableAddon(m_localAddon->ID(), false);
224
225   CJobManager::GetInstance().AddJob(new CAddonUnInstallJob(m_localAddon),
226                                     &CAddonInstaller::Get());
227   CAddonMgr::Get().RemoveAddon(m_localAddon->ID());
228   Close();
229 }
230
231 void CGUIDialogAddonInfo::OnEnable(bool enable)
232 {
233   if (!m_localAddon.get())
234     return;
235
236   if (!enable && PromptIfDependency(24075, 24091))
237     return;
238
239   CAddonMgr::Get().DisableAddon(m_localAddon->ID(), !enable);
240   SetItem(m_item);
241   UpdateControls();
242   g_windowManager.SendMessage(GUI_MSG_NOTIFY_ALL, 0, 0, GUI_MSG_UPDATE);
243 }
244
245 void CGUIDialogAddonInfo::OnSettings()
246 {
247   CGUIDialogAddonSettings::ShowAndGetInput(m_localAddon);
248 }
249
250 void CGUIDialogAddonInfo::OnChangeLog()
251 {
252   CGUIDialogTextViewer* pDlgInfo = (CGUIDialogTextViewer*)g_windowManager.GetWindow(WINDOW_DIALOG_TEXT_VIEWER);
253   CStdString name;
254   if (m_addon)
255     name = m_addon->Name();
256   else if (m_localAddon)
257     name = m_localAddon->Name();
258   pDlgInfo->SetHeading(g_localizeStrings.Get(24054)+" - "+name);
259   if (m_item->GetProperty("Addon.Changelog").empty())
260   {
261     pDlgInfo->SetText(g_localizeStrings.Get(13413));
262     CFileItemList items;
263     if (m_localAddon && 
264         !m_item->GetProperty("Addon.UpdateAvail").asBoolean())
265     {
266       items.Add(CFileItemPtr(new CFileItem(m_localAddon->ChangeLog(),false)));
267     }
268     else
269       items.Add(CFileItemPtr(new CFileItem(m_addon->ChangeLog(),false)));
270     items[0]->Select(true);
271     m_jobid = CJobManager::GetInstance().AddJob(
272       new CFileOperationJob(CFileOperationJob::ActionCopy,items,
273                             "special://temp/"),this);
274   }
275   else
276     pDlgInfo->SetText(m_item->GetProperty("Addon.Changelog").asString());
277
278   m_changelog = true;
279   pDlgInfo->DoModal();
280   m_changelog = false;
281 }
282
283 void CGUIDialogAddonInfo::OnRollback()
284 {
285   CGUIDialogContextMenu* dlg = (CGUIDialogContextMenu*)g_windowManager.GetWindow(WINDOW_DIALOG_CONTEXT_MENU);
286   CAddonDatabase database;
287   database.Open();
288
289   CContextButtons buttons;
290   for (unsigned int i=0;i<m_rollbackVersions.size();++i)
291   {
292     CStdString label(m_rollbackVersions[i]);
293     if (m_rollbackVersions[i].Equals(m_localAddon->Version().c_str()))
294      label += " "+g_localizeStrings.Get(24094);
295    if (database.IsAddonBlacklisted(m_localAddon->ID(),label))
296      label += " "+g_localizeStrings.Get(24095);
297
298     buttons.Add(i,label);
299   }
300   int choice;
301   if ((choice=dlg->ShowAndGetChoice(buttons)) > -1)
302   {
303     // blacklist everything newer
304     for (unsigned int j=choice+1;j<m_rollbackVersions.size();++j)
305       database.BlacklistAddon(m_localAddon->ID(),m_rollbackVersions[j]);
306     CStdString path = "special://home/addons/packages/";
307     path += m_localAddon->ID()+"-"+m_rollbackVersions[choice]+".zip";
308     // needed as cpluff won't downgrade
309     if (!m_localAddon->IsType(ADDON_SERVICE))
310       //we will handle this for service addons in CAddonInstallJob::OnPostInstall
311       CAddonMgr::Get().RemoveAddon(m_localAddon->ID());
312     CAddonInstaller::Get().InstallFromZip(path);
313     database.RemoveAddonFromBlacklist(m_localAddon->ID(),m_rollbackVersions[choice]);
314     Close();
315   }
316 }
317
318 bool CGUIDialogAddonInfo::ShowForItem(const CFileItemPtr& item)
319 {
320   CGUIDialogAddonInfo* dialog = (CGUIDialogAddonInfo*)g_windowManager.GetWindow(WINDOW_DIALOG_ADDON_INFO);
321   if (!dialog)
322     return false;
323   if (!dialog->SetItem(item))
324     return false;
325
326   dialog->DoModal(); 
327   return true;
328 }
329
330 bool CGUIDialogAddonInfo::SetItem(const CFileItemPtr& item)
331 {
332   *m_item = *item;
333   m_rollbackVersions.clear();
334
335   // grab the local addon, if it's available
336   m_localAddon.reset();
337   m_addon.reset();
338   if (CAddonMgr::Get().GetAddon(item->GetProperty("Addon.ID").asString(), m_localAddon)) // sets m_addon if installed regardless of enabled state
339     m_item->SetProperty("Addon.Enabled", "true");
340   else
341     m_item->SetProperty("Addon.Enabled", "false");
342   m_item->SetProperty("Addon.Installed", m_addon ? "true" : "false");
343
344   CAddonDatabase database;
345   database.Open();
346   database.GetAddon(item->GetProperty("Addon.ID").asString(),m_addon);
347
348   if (TranslateType(item->GetProperty("Addon.intType").asString()) == ADDON_REPOSITORY)
349   {
350     CAddonDatabase database;
351     database.Open();
352     VECADDONS addons;
353     if (m_addon)
354       database.GetRepository(m_addon->ID(), addons);
355     else if (m_localAddon) // sanity
356       database.GetRepository(m_localAddon->ID(), addons);
357     int tot=0;
358     for (int i = ADDON_UNKNOWN+1;i<ADDON_VIZ_LIBRARY;++i)
359     {
360       int num=0;
361       for (unsigned int j=0;j<addons.size();++j)
362       {
363         if (addons[j]->Type() == (TYPE)i)
364           ++num;
365       }
366       m_item->SetProperty(CStdString("Repo.") + TranslateType((TYPE)i), num);
367       tot += num;
368     }
369     m_item->SetProperty("Repo.Addons", tot);
370   }
371   return true;
372 }
373
374 void CGUIDialogAddonInfo::OnJobComplete(unsigned int jobID, bool success,
375                                         CJob* job)
376 {
377   if (!m_changelog)
378     return;
379
380   CGUIDialogTextViewer* pDlgInfo = (CGUIDialogTextViewer*)g_windowManager.GetWindow(WINDOW_DIALOG_TEXT_VIEWER);
381
382   m_jobid = 0;
383   if (!success)
384   {
385     pDlgInfo->SetText(g_localizeStrings.Get(195));
386   }
387   else
388   {
389     CFile file;
390     if (file.Open("special://temp/"+
391       URIUtils::GetFileName(((CFileOperationJob*)job)->GetItems()[0]->GetPath())))
392     {
393       char* temp = new char[(size_t)file.GetLength()+1];
394       file.Read(temp,file.GetLength());
395       temp[file.GetLength()] = '\0';
396       m_item->SetProperty("Addon.Changelog",temp);
397       pDlgInfo->SetText(temp);
398       delete[] temp;
399     }
400   }
401   CGUIMessage msg(GUI_MSG_NOTIFY_ALL, WINDOW_DIALOG_TEXT_VIEWER, 0, GUI_MSG_UPDATE);
402   g_windowManager.SendThreadMessage(msg);
403 }
404
405 void CGUIDialogAddonInfo::GrabRollbackVersions()
406 {
407   CFileItemList items;
408   XFILE::CDirectory::GetDirectory("special://home/addons/packages/",items,".zip",DIR_FLAG_NO_FILE_DIRS);
409   items.Sort(SortByLabel, SortOrderAscending);
410   for (int i=0;i<items.Size();++i)
411   {
412     if (items[i]->m_bIsFolder)
413       continue;
414     CStdString ID, version;
415     AddonVersion::SplitFileName(ID,version,items[i]->GetLabel());
416     if (ID.Equals(m_localAddon->ID()))
417       m_rollbackVersions.push_back(version);
418   }
419 }