src/amule-gui.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-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 #include "amule.h"                              // Interface declarations.
  26
  27 #include <common/EventIDs.h>
  28 #include <common/ClientVersion.h>
  29
  30 #include <wx/clipbrd.h>                 // Needed for wxClipBoard
  31 #include <wx/tokenzr.h>                 // Needed for wxStringTokenizer
  32
  33 #include "SharedFilesWnd.h"             // Needed for CSharedFilesWnd
  34 #include "Timer.h"                              // Needed for CTimer
  35 #include "PartFile.h"                   // Needed for CPartFile
  36 #include "updownclient.h"               // Needed for CUpDownClient
  37
  38 #include "muuli_wdr.h"                  // Needed for IDs
  39 #include "amuleDlg.h"                   // Needed for CamuleDlg
  40 #include "PartFileConvert.h"
  41 #include "ThreadTasks.h"
  42 #include "Logger.h"                             // Needed for EVT_MULE_LOGGING
  43 #include "GuiEvents.h"                  // Needed for EVT_MULE_NOTIFY
  44
  45 #ifdef __WXMAC__
  46         #include <CoreFoundation/CFBundle.h>  // Do_not_auto_remove
  47         #include <ApplicationServices/ApplicationServices.h>    // For LSRegisterURL // Do_not_auto_remove
  48 #endif
  49
  50 #ifndef CLIENT_GUI
  51 #include "InternalEvents.h"             // Needed for wxEVT_*
  52
  53 BEGIN_EVENT_TABLE(CamuleGuiApp, wxApp)
  54
  55         // Socket handlers
  56         // Listen Socket
  57         EVT_SOCKET(ID_LISTENSOCKET_EVENT, CamuleGuiApp::ListenSocketHandler)
  58
  59         // UDP Socket (servers)
  60         EVT_SOCKET(ID_SERVERUDPSOCKET_EVENT, CamuleGuiApp::UDPSocketHandler)
  61         // UDP Socket (clients)
  62         EVT_SOCKET(ID_CLIENTUDPSOCKET_EVENT, CamuleGuiApp::UDPSocketHandler)
  63
  64         // Socket timers (TCP + UDP)
  65         EVT_MULE_TIMER(ID_SERVER_RETRY_TIMER_EVENT, CamuleGuiApp::OnTCPTimer)
  66
  67         // Core timer
  68         EVT_MULE_TIMER(ID_CORE_TIMER_EVENT, CamuleGuiApp::OnCoreTimer)
  69
  70         EVT_MULE_NOTIFY(CamuleGuiApp::OnNotifyEvent)
  71         EVT_MULE_LOGGING(CamuleGuiApp::OnLoggingEvent)
  72
  73         // Async dns handling
  74         EVT_MULE_INTERNAL(wxEVT_CORE_UDP_DNS_DONE, -1, CamuleGuiApp::OnUDPDnsDone)
  75
  76         EVT_MULE_INTERNAL(wxEVT_CORE_SOURCE_DNS_DONE, -1, CamuleGuiApp::OnSourceDnsDone)
  77
  78         EVT_MULE_INTERNAL(wxEVT_CORE_SERVER_DNS_DONE, -1, CamuleGuiApp::OnServerDnsDone)
  79
  80         // Hash ended notifier
  81         EVT_MULE_HASHING(CamuleGuiApp::OnFinishedHashing)
  82         EVT_MULE_AICH_HASHING(CamuleGuiApp::OnFinishedAICHHashing)
  83
  84         // File completion ended notifier
  85         EVT_MULE_FILE_COMPLETED(CamuleGuiApp::OnFinishedCompletion)
  86
  87         // HTTPDownload finished
  88         EVT_MULE_INTERNAL(wxEVT_CORE_FINISHED_HTTP_DOWNLOAD, -1, CamuleGuiApp::OnFinishedHTTPDownload)
  89
  90         // Disk space preallocation finished
  91         EVT_MULE_ALLOC_FINISHED(CamuleGuiApp::OnFinishedAllocation)
  92 END_EVENT_TABLE()
  93
  94
  95 IMPLEMENT_APP(CamuleGuiApp)
  96
  97 #endif // CLIENT_GUI
  98
  99 CamuleGuiBase::CamuleGuiBase()
 100 {
 101         amuledlg = NULL;
 102         m_FileDetailDialogActive = 0;
 103 }
 104
 105
 106 CamuleGuiBase::~CamuleGuiBase()
 107 {
 108         #ifndef CLIENT_GUI
 109         CPartFileConvert::StopThread();
 110         #endif
 111 }
 112
 113
 114 void CamuleGuiBase::ShowAlert(wxString msg, wxString title, int flags)
 115 {
 116         wxMessageBox(msg, title, flags);
 117 }
 118
 119
 120 int CamuleGuiBase::InitGui(bool geometry_enabled, wxString &geom_string)
 121 {
 122         // Standard size is 800x600 at position (0,0)
 123         int geometry_x = 0;
 124         int geometry_y = 0;
 125         unsigned int geometry_width = 800;
 126         unsigned int geometry_height = 600;
 127
 128         if ( geometry_enabled ) {
 129                 // I plan on moving this to a separate function, as it just clutters up OnInit()
 130                 /*
 131                 This implementation might work with mac, provided that the
 132                 SetSize() function works as expected.
 133                 */
 134
 135                 // Remove possible prefix
 136                 if ( geom_string.GetChar(0) == '=' ) {
 137                         geom_string.Remove( 0, 1 );
 138                 }
 139
 140                 // Stupid ToLong functions forces me to use longs =(
 141                 long width = geometry_width;
 142                 long height = geometry_height;
 143
 144                 // Get the avilable display area
 145                 wxRect display = wxGetClientDisplayRect();
 146
 147                 // We want to place aMule inside the client area by default
 148                 long x = display.x;
 149                 long y = display.y;
 150
 151                 // Tokenize the string
 152                 wxStringTokenizer tokens(geom_string, wxT("xX+-"));
 153
 154                 // First part: Program width
 155                 if ( tokens.GetNextToken().ToLong( &width ) ) {
 156                         wxString prefix = geom_string[ tokens.GetPosition() - 1 ];
 157                         if ( prefix == wxT("x") || prefix == wxT("X") ) {
 158                                 // Second part: Program height
 159                                 if ( tokens.GetNextToken().ToLong( &height ) ) {
 160                                         prefix = geom_string[ tokens.GetPosition() - 1 ];
 161                                         if ( prefix == wxT("+") || prefix == wxT("-") ) {
 162                                                 // Third part: X-Offset
 163                                                 if ( tokens.GetNextToken().ToLong( &x ) ) {
 164                                                         if ( prefix == wxT("-") )
 165                                                                 x = display.GetRight() - ( width + x );
 166                                                         prefix = geom_string[ tokens.GetPosition() - 1 ];
 167                                                         if ( prefix == wxT("+") || prefix == wxT("-") ) {
 168                                                                 // Fourth part: Y-Offset
 169                                                                 if ( tokens.GetNextToken().ToLong( &y ) ) {
 170                                                                         if ( prefix == wxT("-") )
 171                                                                                 y = display.GetBottom() - ( height + y );
 172                                                                 }
 173                                                         }
 174                                                 }
 175                                         }
 176                                         // We need at least height and width to override default geometry
 177                                         geometry_enabled = true;
 178                                         geometry_x = x;
 179                                         geometry_y = y;
 180                                         geometry_width = width;
 181                                         geometry_height = height;
 182                                 }
 183                         }
 184                 }
 185         }
 186
 187         // Should default/last-used position be overridden?
 188 #ifdef SVNDATE
 189         #ifdef CLIENT_GUI
 190                 m_FrameTitle = wxString::Format(wxT("aMule remote control %s %s"), wxT( VERSION ), wxT( SVNDATE ));
 191         #else
 192                 m_FrameTitle = wxString::Format(wxT("aMule %s %s"), wxT( VERSION ), wxT( SVNDATE ));
 193         #endif
 194 #else
 195         #ifdef CLIENT_GUI
 196                 m_FrameTitle = wxString::Format(_("aMule remote control"));
 197         #else
 198                 m_FrameTitle = wxString::Format(_("aMule"));
 199         #endif
 200 #endif
 201         if ( geometry_enabled ) {
 202                 amuledlg = new CamuleDlg(NULL, m_FrameTitle,
 203                                          wxPoint(geometry_x,geometry_y),
 204                                          wxSize( geometry_width, geometry_height - 58 ));
 205         } else {
 206                 amuledlg = new CamuleDlg(NULL, m_FrameTitle);
 207         }
 208
 209         return 0;
 210 }
 211
 212
 213 // Sets the contents of the clipboard. Prior content  erased.
 214 bool CamuleGuiBase::CopyTextToClipboard(wxString strText)
 215 {
 216         bool ClipBoardOpen = wxTheClipboard->Open();
 217         if (ClipBoardOpen) {
 218                 wxTheClipboard->UsePrimarySelection(false);
 219                 wxTheClipboard->SetData(new wxTextDataObject(strText));
 220                 wxTheClipboard->Close();
 221         }
 222
 223         return ClipBoardOpen;
 224 }
 225
 226
 227 #ifndef CLIENT_GUI
 228
 229 int CamuleGuiApp::InitGui(bool geometry_enable, wxString &geometry_string)
 230 {
 231         CamuleGuiBase::InitGui(geometry_enable, geometry_string);
 232         SetTopWindow(amuledlg);
 233         return 0;
 234 }
 235
 236
 237 void CamuleGuiApp::ShowAlert(wxString msg, wxString title, int flags)
 238 {
 239         CamuleGuiBase::ShowAlert(msg, title, flags);
 240 }
 241
 242
 243 int CamuleGuiApp::OnExit()
 244 {
 245         delete core_timer;
 246
 247         return CamuleApp::OnExit();
 248 }
 249
 250
 251 void CamuleGuiApp::ShutDown(wxCloseEvent &WXUNUSED(evt))
 252 {
 253         amuledlg->DlgShutDown();
 254         amuledlg->Destroy();
 255         CamuleApp::ShutDown();
 256 }
 257
 258
 259 bool CamuleGuiApp::OnInit()
 260 {
 261         amuledlg = NULL;
 262
 263         if ( !CamuleApp::OnInit() ) {
 264                 return false;
 265         }
 266
 267         // Create the Core timer
 268         core_timer = new CTimer(this,ID_CORE_TIMER_EVENT);
 269         if (!core_timer) {
 270                 printf("Fatal Error: Failed to create Core Timer");
 271                 OnExit();
 272         }
 273
 274         // Start the Core and Gui timers
 275
 276         // Note: wxTimer can be off by more than 10% !!!
 277         // In addition to the systematic error introduced by wxTimer, we are losing
 278         // timer cycles due to high CPU load.  I've observed about 0.5% random loss of cycles under
 279         // low load, and more than 6% lost cycles with heavy download traffic and/or other tasks
 280         // in the system, such as a video player or a VMware virtual machine.
 281         // The upload queue process loop has now been rewritten to compensate for timer errors.
 282         // When adding functionality, assume that the timer is only approximately correct;
 283         // for measurements, always use the system clock [::GetTickCount()].
 284         core_timer->Start(100);
 285         amuledlg->StartGuiTimer();
 286
 287 #ifdef __WXMAC__
 288         // This tells the OS to notice the ed2kHelperScript.app inside aMule.app.
 289         // ed2kHelperScript.app describes itself (Info.plist) as handling ed2k URLs.
 290         // So, from then on the OS will know to pass ed2k URLs to the helper app.
 291         CFURLRef ed2kHelperUrl = CFBundleCopyAuxiliaryExecutableURL(
 292                 CFBundleGetMainBundle(), CFSTR("ed2kHelperScript.app"));
 293         if (ed2kHelperUrl) {
 294                 LSRegisterURL(ed2kHelperUrl, true);
 295                 CFRelease(ed2kHelperUrl);
 296         }
 297 #endif
 298
 299         return true;
 300 }
 301
 302
 303 wxString CamuleGuiApp::GetLog(bool reset)
 304 {
 305         if ( reset ) {
 306                 amuledlg->ResetLog(ID_LOGVIEW);
 307         }
 308         return CamuleApp::GetLog(reset);
 309 }
 310
 311
 312 wxString CamuleGuiApp::GetServerLog(bool reset)
 313 {
 314         if ( reset ) {
 315                 amuledlg->ResetLog(ID_SERVERINFO);
 316         }
 317         return CamuleApp::GetServerLog(reset);
 318 }
 319
 320
 321 void CamuleGuiApp::AddServerMessageLine(wxString &msg)
 322 {
 323         amuledlg->AddServerMessageLine(msg);
 324         CamuleApp::AddServerMessageLine(msg);
 325 }
 326
 327
 328 void CamuleGuiApp::OnLoggingEvent(CLoggingEvent& evt)
 329 {
 330         if (amuledlg) {
 331                 while ( !m_logLines.empty() ) {
 332                         QueuedLogLine entry = m_logLines.front();
 333                         amuledlg->AddLogLine( entry.show, entry.line );
 334                         m_logLines.pop_front();
 335                 }
 336
 337                 amuledlg->AddLogLine(evt.IsCritical(), evt.Message());
 338         } else {
 339                 QueuedLogLine entry = { evt.Message(), evt.IsCritical() };
 340                 m_logLines.push_back( entry );
 341         }
 342
 343         CamuleApp::AddLogLine( evt.Message() );
 344 }
 345
 346 #endif /* CLIENT_GUI */
 347 // File_checked_for_headers