src/MuleTrayIcon.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2008 Angel Vidal ( kry@amule.org )
   5 // Copyright (c) 2003-2008 Patrizio Bassi ( hetfield@amule.org )
   6 // Copyright (c) 2003-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   7 //
   8 // Any parts of this program derived from the xMule, lMule or eMule project,
   9 // or contributed by third-party developers are copyrighted by their
  10 // respective authors.
  11 //
  12 // This program is free software; you can redistribute it and/or modify
  13 // it under the terms of the GNU General Public License as published by
  14 // the Free Software Foundation; either version 2 of the License, or
  15 // (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 // GNU General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License
  23 // along with this program; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  25 //
  26
  27 #include <wx/app.h>
  28
  29 #include "MuleTrayIcon.h"
  30
  31 #include <common/ClientVersion.h>
  32 #include <common/Constants.h>
  33
  34 #include "pixmaps/mule_TrayIcon_big.ico.xpm"
  35 #include "pixmaps/mule_Tr_yellow_big.ico.xpm"
  36 #include "pixmaps/mule_Tr_grey_big.ico.xpm"
  37
  38 #include <wx/menu.h>
  39
  40 #include "amule.h"                      // Needed for theApp
  41 #include "amuleDlg.h"                   // Needed for IsShown
  42 #include "Preferences.h"                // Needed for thePrefs
  43 #include "ServerConnect.h"              // Needed for CServerConnect
  44 #include "Server.h"                     // Needed for CServer
  45 #include "StatisticsDlg.h"              // Needed for CStatisticsDlg::getColors()
  46 #include "Statistics.h"                 // Needed for theStats
  47 #include <common/Format.h>                      // Needed for CFormat
  48
  49
  50 // Pop-up menu clickable entries
  51 enum {
  52         TRAY_MENU_INFO = 0,
  53         TRAY_MENU_CLIENTINFO=0,
  54         TRAY_MENU_CLIENTINFO_ITEM = 13007,
  55         TRAY_MENU_DISCONNECT,
  56         TRAY_MENU_CONNECT,
  57         TRAY_MENU_HIDE,
  58         TRAY_MENU_SHOW,
  59         TRAY_MENU_EXIT,
  60         UPLOAD_ITEM1=12340,
  61         UPLOAD_ITEM2=12341,
  62         UPLOAD_ITEM3=12342,
  63         UPLOAD_ITEM4=12343,
  64         UPLOAD_ITEM5=12344,
  65         UPLOAD_ITEM6=12345,
  66         DOWNLOAD_ITEM1=54320,
  67         DOWNLOAD_ITEM2=54321,
  68         DOWNLOAD_ITEM3=54322,
  69         DOWNLOAD_ITEM4=54323,
  70         DOWNLOAD_ITEM5=54324,
  71         DOWNLOAD_ITEM6=54325
  72 };
  73
  74 /****************************************************/
  75 /******************* Event Table ********************/
  76 /****************************************************/
  77
  78 BEGIN_EVENT_TABLE(CMuleTrayIcon, wxTaskBarIcon)
  79         EVT_TASKBAR_LEFT_DCLICK(CMuleTrayIcon::SwitchShow)
  80         EVT_MENU( TRAY_MENU_EXIT, CMuleTrayIcon::Close)
  81         EVT_MENU( TRAY_MENU_CONNECT, CMuleTrayIcon::ServerConnection)
  82         EVT_MENU( TRAY_MENU_DISCONNECT, CMuleTrayIcon::ServerConnection)
  83         EVT_MENU( TRAY_MENU_HIDE, CMuleTrayIcon::ShowHide)
  84         EVT_MENU( TRAY_MENU_SHOW, CMuleTrayIcon::ShowHide)
  85         EVT_MENU( UPLOAD_ITEM1, CMuleTrayIcon::SetUploadSpeed)
  86         EVT_MENU( UPLOAD_ITEM2, CMuleTrayIcon::SetUploadSpeed)
  87         EVT_MENU( UPLOAD_ITEM3, CMuleTrayIcon::SetUploadSpeed)
  88         EVT_MENU( UPLOAD_ITEM4, CMuleTrayIcon::SetUploadSpeed)
  89         EVT_MENU( UPLOAD_ITEM5, CMuleTrayIcon::SetUploadSpeed)
  90         EVT_MENU( UPLOAD_ITEM6, CMuleTrayIcon::SetUploadSpeed)
  91         EVT_MENU( DOWNLOAD_ITEM1, CMuleTrayIcon::SetDownloadSpeed)
  92         EVT_MENU( DOWNLOAD_ITEM2, CMuleTrayIcon::SetDownloadSpeed)
  93         EVT_MENU( DOWNLOAD_ITEM3, CMuleTrayIcon::SetDownloadSpeed)
  94         EVT_MENU( DOWNLOAD_ITEM4, CMuleTrayIcon::SetDownloadSpeed)
  95         EVT_MENU( DOWNLOAD_ITEM5, CMuleTrayIcon::SetDownloadSpeed)
  96         EVT_MENU( DOWNLOAD_ITEM6, CMuleTrayIcon::SetDownloadSpeed)
  97 END_EVENT_TABLE()
  98
  99 /****************************************************/
 100 /************ Constructor / Destructor **************/
 101 /****************************************************/
 102
 103 long GetSpeedFromString(wxString label){
 104         long temp;
 105         label.Replace(wxT("kB/s"),wxT(""),TRUE);
 106         label.Trim(FALSE);
 107         label.Trim(TRUE);
 108         label.ToLong(&temp);
 109         return temp;
 110 }
 111
 112 void CMuleTrayIcon::SetUploadSpeed(wxCommandEvent& event){
 113
 114         wxObject* obj=event.GetEventObject();
 115         if (obj!=NULL) {
 116                 wxMenu *menu = dynamic_cast<wxMenu *>(obj);
 117                 if (menu) {
 118                         wxMenuItem* item=menu->FindItem(event.GetId());
 119                         if (item!=NULL) {
 120                                 long temp;
 121                                 if (item->GetLabel()==(_("Unlimited"))) {
 122                                         temp=UNLIMITED;
 123                                 }
 124                                 else {
 125                                         temp=GetSpeedFromString(item->GetLabel());
 126                                 }
 127                                 thePrefs::SetMaxUpload(temp);
 128                         }
 129                 }
 130         }
 131 }
 132
 133 void CMuleTrayIcon::SetDownloadSpeed(wxCommandEvent& event){
 134
 135         wxObject* obj=event.GetEventObject();
 136         if (obj!=NULL) {
 137                 wxMenu *menu = dynamic_cast<wxMenu *>(obj);
 138                 if (menu) {
 139                         wxMenuItem* item=menu->FindItem(event.GetId());
 140                         if (item!=NULL) {
 141                                 long temp;
 142                                 if (item->GetLabel()==(_("Unlimited"))) {
 143                                         temp=UNLIMITED;
 144                                 }
 145                                 else {
 146                                         temp=GetSpeedFromString(item->GetLabel());
 147                                 }
 148                                 thePrefs::SetMaxDownload(temp);
 149                         }
 150                 }
 151         }
 152 }
 153
 154
 155 void CMuleTrayIcon::ServerConnection(wxCommandEvent& WXUNUSED(event))
 156 {
 157         wxCommandEvent evt;
 158         theApp->amuledlg->OnBnConnect(evt);
 159 }
 160
 161
 162 void CMuleTrayIcon::ShowHide(wxCommandEvent& WXUNUSED(event))
 163 {
 164         theApp->amuledlg->DoIconize(theApp->amuledlg->IsShown());
 165 }
 166
 167
 168 void CMuleTrayIcon::Close(wxCommandEvent& WXUNUSED(event))
 169 {
 170         if (theApp->amuledlg->IsEnabled()) {
 171                 theApp->amuledlg->Close();
 172         }
 173 }
 174
 175
 176 CMuleTrayIcon::CMuleTrayIcon()
 177 {
 178         Old_Icon = -1;
 179         Old_SpeedSize = 0xFFFF; // must be > any possible one.
 180         // Create the background icons (speed improvement)
 181         HighId_Icon_size = wxIcon(mule_TrayIcon_big_ico_xpm).GetHeight();
 182         LowId_Icon_size = wxIcon(mule_Tr_yellow_big_ico_xpm).GetHeight();
 183         Disconnected_Icon_size = wxIcon(mule_Tr_grey_big_ico_xpm).GetHeight();
 184 }
 185
 186 CMuleTrayIcon::~CMuleTrayIcon()
 187 {
 188 #ifdef __WXGTK__
 189         // FIXME: EVIL HACK: We need to ensure that the superclass doesn't
 190         // try to destroy a dangling pointer. See also CMuleTrayIcon::UpdateTray
 191         // for comments on this issue.
 192         if (m_iconWnd) {
 193                 if (wxTopLevelWindows.IndexOf((wxWindow*)m_iconWnd) == wxNOT_FOUND) {
 194                         m_iconWnd = NULL;
 195                 }
 196         }
 197 #endif
 198 }
 199
 200 /****************************************************/
 201 /***************** Public Functions *****************/
 202 /****************************************************/
 203
 204 void CMuleTrayIcon::SetTrayIcon(int Icon, uint32 percent)
 205 {
 206         int Bar_ySize = 0;
 207
 208         switch (Icon) {
 209                 case TRAY_ICON_HIGHID:
 210                         // Most likely case, test first
 211                         Bar_ySize = HighId_Icon_size;
 212                         break;
 213                 case TRAY_ICON_LOWID:
 214                         Bar_ySize = LowId_Icon_size;
 215                         break;
 216                 case TRAY_ICON_DISCONNECTED:
 217                         Bar_ySize = Disconnected_Icon_size;
 218                         break;
 219                 default:
 220                         wxASSERT(0);
 221         }
 222
 223         // Lookup this values for speed improvement: don't draw if not needed
 224         int NewSize = (Bar_ySize * percent) / 100;
 225
 226         if ((Old_Icon != Icon) || (Old_SpeedSize != NewSize)) {
 227
 228                 if ((Old_SpeedSize > NewSize) || (Old_Icon != Icon)) {
 229                         // We have to rebuild the icon, because bar is lower now.
 230                         switch (Icon) {
 231                                 case TRAY_ICON_HIGHID:
 232                                         // Most likely case, test first
 233                                         CurrentIcon = wxIcon(mule_TrayIcon_big_ico_xpm);
 234                                         break;
 235                                 case TRAY_ICON_LOWID:
 236                                         CurrentIcon = wxIcon(mule_Tr_yellow_big_ico_xpm);
 237                                         break;
 238                                 case TRAY_ICON_DISCONNECTED:
 239                                         CurrentIcon = wxIcon(mule_Tr_grey_big_ico_xpm);
 240                                         break;
 241                                 default:
 242                                         wxASSERT(0);
 243                         }
 244                 }
 245
 246                 Old_Icon = Icon;
 247                 Old_SpeedSize = NewSize;
 248
 249                 // Do whatever to the icon before drawing it (percent)
 250
 251                 wxBitmap TempBMP;
 252                 TempBMP.CopyFromIcon(CurrentIcon);
 253
 254                 TempBMP.SetMask(NULL);
 255
 256                 IconWithSpeed.SelectObject(TempBMP);
 257
 258
 259                 // Speed bar is: centered, taking 80% of the icon heigh, and
 260                 // right-justified taking a 10% of the icon width.
 261
 262                 // X
 263                 int Bar_xSize = 4;
 264                 int Bar_xPos = CurrentIcon.GetWidth() - 5;
 265
 266                 IconWithSpeed.SetBrush(*(wxTheBrushList->FindOrCreateBrush(CStatisticsDlg::getColors(11))));
 267                 IconWithSpeed.SetPen(*wxTRANSPARENT_PEN);
 268
 269                 IconWithSpeed.DrawRectangle(Bar_xPos + 1, Bar_ySize - NewSize, Bar_xSize -2 , NewSize);
 270
 271                 // Unselect the icon.
 272                 IconWithSpeed.SelectObject(wxNullBitmap);
 273
 274                 // Do transparency
 275
 276                 // Set a new mask with transparency set to red.
 277                 wxMask* new_mask = new wxMask(TempBMP, wxColour(0xFF, 0x00, 0x00));
 278
 279                 TempBMP.SetMask(new_mask);
 280                 CurrentIcon.CopyFromBitmap(TempBMP);
 281
 282                 UpdateTray();
 283         }
 284 }
 285
 286 void CMuleTrayIcon::SetTrayToolTip(const wxString& Tip)
 287 {
 288         CurrentTip = Tip;
 289         UpdateTray();
 290 }
 291
 292 /****************************************************/
 293 /**************** Private Functions *****************/
 294 /****************************************************/
 295
 296 void CMuleTrayIcon::UpdateTray()
 297 {
 298 #ifdef __WXGTK__
 299         // FIXME: EVIL HACK: As of wxGTK-2.8.7, closing of the trayicon
 300         // window (caused for instance by a crashing kicker) is not
 301         // handled, with the result that the pointer to the trayicon
 302         // window becomes a dangling pointer. Since we have access to
 303         // the pointer, and it's created as a top-level window, it's
 304         // relatively easy to force the recreation of a valid window.
 305         // Ugly as hell though ....
 306         //
 307         // This has been repported as bug #1872724:
 308         // http://sourceforge.net/tracker/index.php?func=detail&aid=1872724&group_id=9863&atid=109863
 309         if (m_iconWnd) {
 310                 if (wxTopLevelWindows.IndexOf((wxWindow*)m_iconWnd) == wxNOT_FOUND) {
 311                         printf("Traybar-icon lost, trying to recreate ...\n");
 312                         m_iconWnd = NULL;
 313                 }
 314         }
 315 #endif
 316
 317         // Icon update and Tip update
 318 #ifndef __WXCOCOA__
 319         if (IsOk())
 320 #endif
 321         {
 322                 SetIcon(CurrentIcon, CurrentTip);
 323         }
 324 }
 325
 326
 327 wxMenu* CMuleTrayIcon::CreatePopupMenu()
 328 {
 329         // Creates dinamically the menu to show the user.
 330         wxMenu *traymenu = new wxMenu();
 331         traymenu->SetTitle(_("aMule Tray Menu"));
 332
 333         // Build the Top string name
 334         wxString label = MOD_VERSION_LONG;
 335         traymenu->Append(TRAY_MENU_INFO, label);
 336         traymenu->AppendSeparator();
 337         label = wxString(_("Speed limits:")) + wxT(" ");
 338
 339         // Check for upload limits
 340         unsigned int max_upload = thePrefs::GetMaxUpload();
 341         if ( max_upload == UNLIMITED ) {
 342                 label += _("UL: None");
 343         }
 344         else {
 345                 label += wxString::Format(_("UL: %u"), max_upload);
 346         }
 347         label += wxT(", ");
 348
 349         // Check for download limits
 350         unsigned int max_download = thePrefs::GetMaxDownload();
 351         if ( max_download == UNLIMITED ) {
 352                 label += _("DL: None");
 353         }
 354         else {
 355                 label += wxString::Format(_("DL: %u"), max_download);
 356         }
 357
 358         traymenu->Append(TRAY_MENU_INFO, label);
 359         label = wxString::Format(_("Download speed: %.1f"), theStats::GetDownloadRate() / 1024.0);
 360         traymenu->Append(TRAY_MENU_INFO, label);
 361         label = wxString::Format(_("Upload speed: %.1f"), theStats::GetUploadRate() / 1024.0);
 362         traymenu->Append(TRAY_MENU_INFO, label);
 363         traymenu->AppendSeparator();
 364
 365         // Client Info
 366         wxMenu* ClientInfoMenu = new wxMenu();
 367         ClientInfoMenu->SetTitle(_("Client Information"));
 368
 369         // User nick-name
 370         {
 371                 wxString temp = CFormat(_("Nickname: %s")) % ( thePrefs::GetUserNick().IsEmpty() ? wxString(_("No Nickname Selected!")) : thePrefs::GetUserNick() );
 372
 373                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 374         }
 375
 376         // Client ID
 377         {
 378                 wxString temp = _("ClientID: ");
 379
 380                 if (theApp->IsConnectedED2K()) {
 381                         unsigned long id = theApp->GetED2KID();
 382                         temp += wxString::Format(wxT("%lu"), id);
 383                 } else {
 384                         temp += _("Not connected");
 385                 }
 386                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 387         }
 388
 389         // Current Server and Server IP
 390         {
 391                 wxString temp_name = _("ServerName: ");
 392                 wxString temp_ip   = _("ServerIP: ");
 393
 394                 if ( theApp->serverconnect->GetCurrentServer() ) {
 395                         temp_name += theApp->serverconnect->GetCurrentServer()->GetListName();
 396                         temp_ip   += theApp->serverconnect->GetCurrentServer()->GetFullIP();
 397                 } else {
 398                         temp_name += _("Not connected");
 399                         temp_ip   += _("Not Connected");
 400                 }
 401                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_name);
 402                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_ip);
 403         }
 404
 405         // IP Address
 406         {
 407                 wxString temp = CFormat(_("IP: %s")) % ( (theApp->GetPublicIP()) ? Uint32toStringIP(theApp->GetPublicIP()) : wxString(_("Unknown")) );
 408
 409                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 410         }
 411
 412         // TCP PORT
 413         {
 414                 wxString temp;
 415                 if (thePrefs::GetPort()) {
 416                         temp = CFormat(_("TCP port: %d")) % thePrefs::GetPort();
 417                 } else {
 418                         temp=_("TCP port: Not ready");
 419                 }
 420                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 421         }
 422
 423         // UDP PORT
 424         {
 425                 wxString temp;
 426                 if (thePrefs::GetEffectiveUDPPort()) {
 427                         temp = CFormat(_("UDP port: %d")) % thePrefs::GetEffectiveUDPPort();
 428                 } else {
 429                         temp=_("UDP port: Not ready");
 430                 }
 431                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 432         }
 433
 434         // Online Signature
 435         {
 436                 wxString temp;
 437                 if (thePrefs::IsOnlineSignatureEnabled()) {
 438                         temp=_("Online Signature: Enabled");
 439                 }
 440                 else {
 441                         temp=_("Online Signature: Disabled");
 442                 }
 443                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 444         }
 445
 446         // Uptime
 447         {
 448                 wxString temp = CFormat(_("Uptime: %s")) % CastSecondsToHM(theStats::GetUptimeSeconds());
 449                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 450         }
 451
 452         // Number of shared files
 453         {
 454                 wxString temp = CFormat(_("Shared files: %d")) % theStats::GetSharedFileCount();
 455                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 456         }
 457
 458         // Number of queued clients
 459         {
 460                 wxString temp = CFormat(_("Queued clients: %d")) % theStats::GetWaitingUserCount();
 461                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 462         }
 463
 464         // Total Downloaded
 465         {
 466                 wxString temp = CastItoXBytes( theStats::GetSessionReceivedBytes() + thePrefs::GetTotalDownloaded() );
 467                 temp = CFormat(_("Total DL: %s")) % temp;
 468                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 469         }
 470
 471         // Total Uploaded
 472         {
 473                 wxString temp = CastItoXBytes( theStats::GetSessionSentBytes() + thePrefs::GetTotalUploaded() );
 474                 temp = CFormat(_("Total UL: %s")) % temp;
 475                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 476         }
 477
 478         traymenu->Append(TRAY_MENU_CLIENTINFO,ClientInfoMenu->GetTitle(),ClientInfoMenu);
 479
 480         // Separator
 481         traymenu->AppendSeparator();
 482
 483         // Upload Speed sub-menu
 484         wxMenu* UploadSpeedMenu = new wxMenu();
 485         UploadSpeedMenu->SetTitle(_("Upload limit"));
 486
 487         // Download Speed sub-menu
 488         wxMenu* DownloadSpeedMenu = new wxMenu();
 489         DownloadSpeedMenu->SetTitle(_("Download limit"));
 490
 491         // Upload Speed sub-menu
 492         {
 493                 UploadSpeedMenu->Append(UPLOAD_ITEM1, _("Unlimited"));
 494
 495                 uint32 max_ul_speed = thePrefs::GetMaxGraphUploadRate();
 496
 497                 if ( max_ul_speed == UNLIMITED ) {
 498                         max_ul_speed = 100;
 499                 }
 500                 else if ( max_ul_speed < 10 ) {
 501                         max_ul_speed = 10;
 502                 }
 503
 504                 for ( int i = 0; i < 5; i++ ) {
 505                         unsigned int tempspeed = (unsigned int)((double)max_ul_speed / 5) * (5 - i);
 506                         wxString temp = wxString::Format(wxT("%u kB/s"), tempspeed);
 507                         UploadSpeedMenu->Append((int)UPLOAD_ITEM1+i+1,temp);
 508                 }
 509         }
 510         traymenu->Append(0,UploadSpeedMenu->GetTitle(),UploadSpeedMenu);
 511
 512         // Download Speed sub-menu
 513         {
 514                 DownloadSpeedMenu->Append(DOWNLOAD_ITEM1, _("Unlimited"));
 515
 516                 uint32 max_dl_speed = thePrefs::GetMaxGraphDownloadRate();
 517
 518                 if ( max_dl_speed == UNLIMITED ) {
 519                         max_dl_speed = 100;
 520                 }
 521                 else if ( max_dl_speed < 10 ) {
 522                         max_dl_speed = 10;
 523                 }
 524
 525                 for ( int i = 0; i < 5; i++ ) {
 526                         unsigned int tempspeed = (unsigned int)((double)max_dl_speed / 5) * (5 - i);
 527                         wxString temp = wxString::Format(wxT("%d kB/s"), tempspeed);
 528                         DownloadSpeedMenu->Append((int)DOWNLOAD_ITEM1+i+1,temp);
 529                 }
 530         }
 531
 532         traymenu->Append(0,DownloadSpeedMenu->GetTitle(),DownloadSpeedMenu);
 533         // Separator
 534         traymenu->AppendSeparator();
 535
 536         if (theApp->IsConnected()) {
 537                 //Disconnection Speed item
 538                 traymenu->Append(TRAY_MENU_DISCONNECT, _("Disconnect"));
 539         } else {
 540                 //Connect item
 541                 traymenu->Append(TRAY_MENU_CONNECT, _("Connect"));
 542         }
 543
 544         // Separator
 545         traymenu->AppendSeparator();
 546
 547         if (theApp->amuledlg->IsShown()) {
 548                 //hide item
 549                 traymenu->Append(TRAY_MENU_HIDE, _("Hide aMule"));
 550         } else {
 551                 //show item
 552                 traymenu->Append(TRAY_MENU_SHOW, _("Show aMule"));
 553         }
 554
 555         // Separator
 556         traymenu->AppendSeparator();
 557
 558         // Exit item
 559         traymenu->Append(TRAY_MENU_EXIT, _("Exit"));
 560
 561         return traymenu;
 562 }
 563
 564 void CMuleTrayIcon::SwitchShow(wxTaskBarIconEvent&)
 565 {
 566         theApp->amuledlg->DoIconize(theApp->amuledlg->IsShown());
 567 }
 568 // File_checked_for_headers