Merge pull request #2895 from verybadsoldier/master
[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 if (CGUIDialogYesNo::ShowAndGetInput(24037, 750, 0, 0))
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 && m_localAddon->Path().Left(xbmcPath.size()).Equals(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;
173   referer.Format("Referer=%s-%s.zip",m_localAddon->ID().c_str(),m_localAddon->Version().c_str());
174   CAddonInstaller::Get().Install(m_addon->ID(), true, referer); // force install
175   Close();
176 }
177
178 void CGUIDialogAddonInfo::OnInstall()
179 {
180   CAddonInstaller::Get().Install(m_addon->ID());
181   Close();
182 }
183
184 void CGUIDialogAddonInfo::OnUninstall()
185 {
186   if (!m_localAddon.get())
187     return;
188
189   // ensure the addon is not a dependency of other installed addons
190   VECADDONS addons;
191   CStdStringArray deps;
192   CAddonMgr::Get().GetAllAddons(addons);
193   for (VECADDONS::iterator it  = addons.begin();
194                            it != addons.end();++it)
195   {
196     if ((*it)->GetDeps().find(m_localAddon->ID()) != (*it)->GetDeps().end())
197       deps.push_back((*it)->Name());
198   }
199
200   if (!CAddonInstaller::Get().CheckDependencies(m_localAddon) && deps.size())
201   {
202     CStdString strLine0, strLine1;
203     StringUtils::JoinString(deps, ", ", strLine1);
204     strLine0.Format(g_localizeStrings.Get(24046), m_localAddon->Name().c_str());
205     CGUIDialogOK::ShowAndGetInput(24037, strLine0, strLine1, 24047);
206     return;
207   }
208
209   // ensure the addon isn't disabled in our database
210   CAddonDatabase database;
211   database.Open();
212   database.DisableAddon(m_localAddon->ID(), false);
213   CJobManager::GetInstance().AddJob(new CAddonUnInstallJob(m_localAddon),
214                                     &CAddonInstaller::Get());
215   CAddonMgr::Get().RemoveAddon(m_localAddon->ID());
216   Close();
217 }
218
219 void CGUIDialogAddonInfo::OnEnable(bool enable)
220 {
221   if (!m_localAddon.get())
222     return;
223
224   CStdString xbmcPath = CSpecialProtocol::TranslatePath("special://xbmc/addons");
225   CAddonDatabase database;
226   database.Open();
227   database.DisableAddon(m_localAddon->ID(), !enable);
228   database.Close();
229
230   SetItem(m_item);
231   UpdateControls();
232   g_windowManager.SendMessage(GUI_MSG_NOTIFY_ALL, 0, 0, GUI_MSG_UPDATE);
233 }
234
235 void CGUIDialogAddonInfo::OnSettings()
236 {
237   CGUIDialogAddonSettings::ShowAndGetInput(m_localAddon);
238 }
239
240 void CGUIDialogAddonInfo::OnChangeLog()
241 {
242   CGUIDialogTextViewer* pDlgInfo = (CGUIDialogTextViewer*)g_windowManager.GetWindow(WINDOW_DIALOG_TEXT_VIEWER);
243   CStdString name;
244   if (m_addon)
245     name = m_addon->Name();
246   else if (m_localAddon)
247     name = m_localAddon->Name();
248   pDlgInfo->SetHeading(g_localizeStrings.Get(24054)+" - "+name);
249   if (m_item->GetProperty("Addon.Changelog").empty())
250   {
251     pDlgInfo->SetText(g_localizeStrings.Get(13413));
252     CFileItemList items;
253     if (m_localAddon && 
254         !m_item->GetProperty("Addon.UpdateAvail").asBoolean())
255     {
256       items.Add(CFileItemPtr(new CFileItem(m_localAddon->ChangeLog(),false)));
257     }
258     else
259       items.Add(CFileItemPtr(new CFileItem(m_addon->ChangeLog(),false)));
260     items[0]->Select(true);
261     m_jobid = CJobManager::GetInstance().AddJob(
262       new CFileOperationJob(CFileOperationJob::ActionCopy,items,
263                             "special://temp/"),this);
264   }
265   else
266     pDlgInfo->SetText(m_item->GetProperty("Addon.Changelog").asString());
267
268   m_changelog = true;
269   pDlgInfo->DoModal();
270   m_changelog = false;
271 }
272
273 void CGUIDialogAddonInfo::OnRollback()
274 {
275   CGUIDialogContextMenu* dlg = (CGUIDialogContextMenu*)g_windowManager.GetWindow(WINDOW_DIALOG_CONTEXT_MENU);
276   CAddonDatabase database;
277   database.Open();
278
279   CContextButtons buttons;
280   for (unsigned int i=0;i<m_rollbackVersions.size();++i)
281   {
282     CStdString label(m_rollbackVersions[i]);
283     if (m_rollbackVersions[i].Equals(m_localAddon->Version().c_str()))
284      label += " "+g_localizeStrings.Get(24094);
285    if (database.IsAddonBlacklisted(m_localAddon->ID(),label))
286      label += " "+g_localizeStrings.Get(24095);
287
288     buttons.Add(i,label);
289   }
290   int choice;
291   if ((choice=dlg->ShowAndGetChoice(buttons)) > -1)
292   {
293     // blacklist everything newer
294     for (unsigned int j=choice+1;j<m_rollbackVersions.size();++j)
295       database.BlacklistAddon(m_localAddon->ID(),m_rollbackVersions[j]);
296     CStdString path = "special://home/addons/packages/";
297     path += m_localAddon->ID()+"-"+m_rollbackVersions[choice]+".zip";
298     // needed as cpluff won't downgrade
299     if (!m_localAddon->IsType(ADDON_SERVICE))
300       //we will handle this for service addons in CAddonInstallJob::OnPostInstall
301       CAddonMgr::Get().RemoveAddon(m_localAddon->ID());
302     CAddonInstaller::Get().InstallFromZip(path);
303     database.RemoveAddonFromBlacklist(m_localAddon->ID(),m_rollbackVersions[choice]);
304     Close();
305   }
306 }
307
308 bool CGUIDialogAddonInfo::ShowForItem(const CFileItemPtr& item)
309 {
310   CGUIDialogAddonInfo* dialog = (CGUIDialogAddonInfo*)g_windowManager.GetWindow(WINDOW_DIALOG_ADDON_INFO);
311   if (!dialog)
312     return false;
313   if (!dialog->SetItem(item))
314     return false;
315
316   dialog->DoModal(); 
317   return true;
318 }
319
320 bool CGUIDialogAddonInfo::SetItem(const CFileItemPtr& item)
321 {
322   *m_item = *item;
323   m_rollbackVersions.clear();
324
325   // grab the local addon, if it's available
326   m_localAddon.reset();
327   m_addon.reset();
328   if (CAddonMgr::Get().GetAddon(item->GetProperty("Addon.ID").asString(), m_localAddon)) // sets m_addon if installed regardless of enabled state
329     m_item->SetProperty("Addon.Enabled", "true");
330   else
331     m_item->SetProperty("Addon.Enabled", "false");
332   m_item->SetProperty("Addon.Installed", m_addon ? "true" : "false");
333
334   CAddonDatabase database;
335   database.Open();
336   database.GetAddon(item->GetProperty("Addon.ID").asString(),m_addon);
337
338   if (TranslateType(item->GetProperty("Addon.intType").asString()) == ADDON_REPOSITORY)
339   {
340     CAddonDatabase database;
341     database.Open();
342     VECADDONS addons;
343     if (m_addon)
344       database.GetRepository(m_addon->ID(), addons);
345     else if (m_localAddon) // sanity
346       database.GetRepository(m_localAddon->ID(), addons);
347     int tot=0;
348     for (int i = ADDON_UNKNOWN+1;i<ADDON_VIZ_LIBRARY;++i)
349     {
350       int num=0;
351       for (unsigned int j=0;j<addons.size();++j)
352       {
353         if (addons[j]->Type() == (TYPE)i)
354           ++num;
355       }
356       m_item->SetProperty(CStdString("Repo.") + TranslateType((TYPE)i), num);
357       tot += num;
358     }
359     m_item->SetProperty("Repo.Addons", tot);
360   }
361   return true;
362 }
363
364 void CGUIDialogAddonInfo::OnJobComplete(unsigned int jobID, bool success,
365                                         CJob* job)
366 {
367   if (!m_changelog)
368     return;
369
370   CGUIDialogTextViewer* pDlgInfo = (CGUIDialogTextViewer*)g_windowManager.GetWindow(WINDOW_DIALOG_TEXT_VIEWER);
371
372   m_jobid = 0;
373   if (!success)
374   {
375     pDlgInfo->SetText(g_localizeStrings.Get(195));
376   }
377   else
378   {
379     CFile file;
380     if (file.Open("special://temp/"+
381       URIUtils::GetFileName(((CFileOperationJob*)job)->GetItems()[0]->GetPath())))
382     {
383       char* temp = new char[(size_t)file.GetLength()+1];
384       file.Read(temp,file.GetLength());
385       temp[file.GetLength()] = '\0';
386       m_item->SetProperty("Addon.Changelog",temp);
387       pDlgInfo->SetText(temp);
388       delete[] temp;
389     }
390   }
391   CGUIMessage msg(GUI_MSG_NOTIFY_ALL, WINDOW_DIALOG_TEXT_VIEWER, 0, GUI_MSG_UPDATE);
392   g_windowManager.SendThreadMessage(msg);
393 }
394
395 void CGUIDialogAddonInfo::GrabRollbackVersions()
396 {
397   CFileItemList items;
398   XFILE::CDirectory::GetDirectory("special://home/addons/packages/",items,".zip",DIR_FLAG_NO_FILE_DIRS);
399   items.Sort(SortByLabel, SortOrderAscending);
400   for (int i=0;i<items.Size();++i)
401   {
402     if (items[i]->m_bIsFolder)
403       continue;
404     CStdString ID, version;
405     AddonVersion::SplitFileName(ID,version,items[i]->GetLabel());
406     if (ID.Equals(m_localAddon->ID()))
407       m_rollbackVersions.push_back(version);
408   }
409 }