src/UserEvents.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2006-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   5 //
   6 // Any parts of this program derived from the xMule, lMule or eMule project,
   7 // or contributed by third-party developers are copyrighted by their
   8 // respective authors.
   9 //
  10 // This program is free software; you can redistribute it and/or modify
  11 // it under the terms of the GNU General Public License as published by
  12 // the Free Software Foundation; either version 2 of the License, or
  13 // (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 // GNU General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  23 //
  24
  25
  26 #include "UserEvents.h"
  27
  28
  29 #include <common/Format.h>
  30 #include "Logger.h"
  31 #include "Preferences.h"
  32 #include "PartFile.h"
  33 #include "TerminationProcess.h" // Needed for CTerminationProcess
  34
  35
  36 #include <wx/process.h>
  37
  38
  39 #define USEREVENTS_EVENT(ID, NAME, VARS)        { wxT(#ID), NAME, false, wxEmptyString, false, wxEmptyString },
  40 static struct {
  41         const wxString key;
  42         const wxString name;
  43         bool core_enabled;
  44         wxString core_command;
  45         bool gui_enabled;
  46         wxString gui_command;
  47 } s_EventList[] = {
  48         USEREVENTS_EVENTLIST()
  49 };
  50 #undef USEREVENTS_EVENT
  51
  52
  53 #ifdef __WXDEBUG__
  54 inline bool CheckIndex(const unsigned int idx)
  55 {
  56         return (idx < sizeof(s_EventList) / sizeof(s_EventList[0]));
  57 }
  58 #endif
  59
  60 unsigned int CUserEvents::GetCount()
  61 {
  62         return sizeof(s_EventList) / sizeof(s_EventList[0]);
  63 }
  64
  65 const wxString& CUserEvents::GetDisplayName(enum EventType event)
  66 {
  67         wxASSERT(CheckIndex(event));
  68         return s_EventList[event].name;
  69 }
  70
  71 bool CUserEvents::IsCoreCommandEnabled(enum EventType event)
  72 {
  73         wxASSERT(CheckIndex(event));
  74         return s_EventList[event].core_enabled;
  75 }
  76
  77 bool CUserEvents::IsGUICommandEnabled(enum EventType event)
  78 {
  79         wxASSERT(CheckIndex(event));
  80         return s_EventList[event].gui_enabled;
  81 }
  82
  83 const wxString& CUserEvents::GetKey(const unsigned int event)
  84 {
  85         wxASSERT(CheckIndex(event));
  86         return s_EventList[event].key;
  87 }
  88
  89 bool& CUserEvents::GetCoreEnableVar(const unsigned int event)
  90 {
  91         wxASSERT(CheckIndex(event));
  92         return s_EventList[event].core_enabled;
  93 }
  94
  95 wxString& CUserEvents::GetCoreCommandVar(const unsigned int event)
  96 {
  97         wxASSERT(CheckIndex(event));
  98         return s_EventList[event].core_command;
  99 }
 100
 101 bool& CUserEvents::GetGUIEnableVar(const unsigned int event)
 102 {
 103         wxASSERT(CheckIndex(event));
 104         return s_EventList[event].gui_enabled;
 105 }
 106
 107 wxString& CUserEvents::GetGUICommandVar(const unsigned int event)
 108 {
 109         wxASSERT(CheckIndex(event));
 110         return s_EventList[event].gui_command;
 111 }
 112
 113 #define USEREVENTS_EVENT(ID, NAME, VARS)        case CUserEvents::ID: { VARS break; }
 114 #define USEREVENTS_REPLACE_VAR(VAR, DESC, CODE) command.Replace(wxT("%") VAR, CODE);
 115 static void ExecuteCommand(
 116         enum CUserEvents::EventType event,
 117         const void* object,
 118         const wxString& cmd)
 119 {
 120         // This variable is needed by the USEREVENTS_EVENTLIST macro.
 121         wxString command = cmd;
 122         switch (event) {
 123                 USEREVENTS_EVENTLIST()
 124         }
 125         if (!command.empty()) {
 126                 CTerminationProcess *p = new CTerminationProcess(cmd);
 127                 if (!wxExecute(command, wxEXEC_ASYNC, p)) {
 128                         // If wxExecute fails, we need to delete the CTerminationProcess
 129                         // otherwise it will leak.
 130                         delete p;
 131                         AddLogLineM(true,
 132                                 CFormat(_("Failed to execute command `%s' on `%s' event.")) %
 133                                 command % s_EventList[event].name);
 134                 }
 135         }
 136 }
 137
 138 void CUserEvents::ProcessEvent(enum EventType event, const void* object)
 139 {
 140         wxASSERT(CheckIndex(event));
 141         wxASSERT(object != NULL);
 142
 143 #ifndef CLIENT_GUI
 144         if (s_EventList[event].core_enabled) {
 145                 ExecuteCommand(event, object, s_EventList[event].core_command);
 146         }
 147 #endif
 148 #ifndef AMULE_DAEMON
 149         if (s_EventList[event].gui_enabled) {
 150                 ExecuteCommand(event, object, s_EventList[event].gui_command);
 151         }
 152 #endif
 153 }