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