src/MuleTrayIcon.cpp

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2011 Angel Vidal ( kry@amule.org )
   5 // Copyright (c) 2003-2011 Patrizio Bassi ( hetfield@amule.org )
   6 // Copyright (c) 2003-2011 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 #include "Logger.h"
  49 #include <common/MenuIDs.h>     // Needed to access menu item constants
  50
  51 /****************************************************/
  52 /******************* Event Table ********************/
  53 /****************************************************/
  54
  55 BEGIN_EVENT_TABLE(CMuleTrayIcon, wxTaskBarIcon)
  56         EVT_TASKBAR_LEFT_DCLICK(CMuleTrayIcon::SwitchShow)
  57         EVT_MENU( TRAY_MENU_EXIT, CMuleTrayIcon::Close)
  58         EVT_MENU( TRAY_MENU_CONNECT, CMuleTrayIcon::ServerConnection)
  59         EVT_MENU( TRAY_MENU_DISCONNECT, CMuleTrayIcon::ServerConnection)
  60         EVT_MENU( TRAY_MENU_HIDE, CMuleTrayIcon::ShowHide)
  61         EVT_MENU( TRAY_MENU_SHOW, CMuleTrayIcon::ShowHide)
  62         EVT_MENU( UPLOAD_ITEM1, CMuleTrayIcon::SetUploadSpeed)
  63         EVT_MENU( UPLOAD_ITEM2, CMuleTrayIcon::SetUploadSpeed)
  64         EVT_MENU( UPLOAD_ITEM3, CMuleTrayIcon::SetUploadSpeed)
  65         EVT_MENU( UPLOAD_ITEM4, CMuleTrayIcon::SetUploadSpeed)
  66         EVT_MENU( UPLOAD_ITEM5, CMuleTrayIcon::SetUploadSpeed)
  67         EVT_MENU( UPLOAD_ITEM6, CMuleTrayIcon::SetUploadSpeed)
  68         EVT_MENU( DOWNLOAD_ITEM1, CMuleTrayIcon::SetDownloadSpeed)
  69         EVT_MENU( DOWNLOAD_ITEM2, CMuleTrayIcon::SetDownloadSpeed)
  70         EVT_MENU( DOWNLOAD_ITEM3, CMuleTrayIcon::SetDownloadSpeed)
  71         EVT_MENU( DOWNLOAD_ITEM4, CMuleTrayIcon::SetDownloadSpeed)
  72         EVT_MENU( DOWNLOAD_ITEM5, CMuleTrayIcon::SetDownloadSpeed)
  73         EVT_MENU( DOWNLOAD_ITEM6, CMuleTrayIcon::SetDownloadSpeed)
  74 END_EVENT_TABLE()
  75
  76 /****************************************************/
  77 /************ Constructor / Destructor **************/
  78 /****************************************************/
  79
  80 static long GetSpeedFromString(wxString label){
  81         long temp;
  82         label.Replace(_("kB/s"),wxT(""),TRUE);
  83         label.Trim(FALSE);
  84         label.Trim(TRUE);
  85         label.ToLong(&temp);
  86         return temp;
  87 }
  88
  89 void CMuleTrayIcon::SetUploadSpeed(wxCommandEvent& event){
  90
  91         wxObject* obj=event.GetEventObject();
  92         if (obj!=NULL) {
  93                 wxMenu *menu = dynamic_cast<wxMenu *>(obj);
  94                 if (menu) {
  95                         wxMenuItem* item=menu->FindItem(event.GetId());
  96                         if (item!=NULL) {
  97                                 long temp;
  98                                 if (item->GetItemLabelText()==(_("Unlimited"))) {
  99                                         temp=UNLIMITED;
 100                                 }
 101                                 else {
 102                                         temp=GetSpeedFromString(item->GetItemLabelText());
 103                                 }
 104                                 thePrefs::SetMaxUpload(temp);
 105
 106                                 #ifdef CLIENT_GUI
 107                                 // Send preferences to core.
 108                                 theApp->glob_prefs->SendToRemote();
 109                                 #endif
 110                         }
 111                 }
 112         }
 113 }
 114
 115 void CMuleTrayIcon::SetDownloadSpeed(wxCommandEvent& event){
 116
 117         wxObject* obj=event.GetEventObject();
 118         if (obj!=NULL) {
 119                 wxMenu *menu = dynamic_cast<wxMenu *>(obj);
 120                 if (menu) {
 121                         wxMenuItem* item=menu->FindItem(event.GetId());
 122                         if (item!=NULL) {
 123                                 long temp;
 124                                 if (item->GetItemLabelText()==(_("Unlimited"))) {
 125                                         temp=UNLIMITED;
 126                                 }
 127                                 else {
 128                                         temp=GetSpeedFromString(item->GetItemLabelText());
 129                                 }
 130                                 thePrefs::SetMaxDownload(temp);
 131
 132                                 #ifdef CLIENT_GUI
 133                                 // Send preferences to core.
 134                                 theApp->glob_prefs->SendToRemote();
 135                                 #endif
 136                         }
 137                 }
 138         }
 139 }
 140
 141
 142 void CMuleTrayIcon::ServerConnection(wxCommandEvent& WXUNUSED(event))
 143 {
 144         wxCommandEvent evt;
 145         theApp->amuledlg->OnBnConnect(evt);
 146 }
 147
 148
 149 void CMuleTrayIcon::ShowHide(wxCommandEvent& WXUNUSED(event))
 150 {
 151         theApp->amuledlg->Iconize(theApp->amuledlg->IsShown());
 152         theApp->amuledlg->Show(!theApp->amuledlg->IsShown());
 153 }
 154
 155
 156 void CMuleTrayIcon::Close(wxCommandEvent& WXUNUSED(event))
 157 {
 158         if (theApp->amuledlg->IsEnabled()) {
 159                 theApp->amuledlg->Close();
 160         }
 161 }
 162
 163
 164 CMuleTrayIcon::CMuleTrayIcon()
 165 {
 166         Old_Icon = -1;
 167         Old_SpeedSize = 0xFFFF; // must be > any possible one.
 168
 169         // Create the background icons (speed improvement)
 170         HighId_Icon_size = wxIcon(mule_TrayIcon_big_ico_xpm).GetHeight();
 171         LowId_Icon_size = wxIcon(mule_Tr_yellow_big_ico_xpm).GetHeight();
 172         Disconnected_Icon_size = wxIcon(mule_Tr_grey_big_ico_xpm).GetHeight();
 173 }
 174
 175 CMuleTrayIcon::~CMuleTrayIcon()
 176 {
 177 }
 178
 179 /****************************************************/
 180 /***************** Public Functions *****************/
 181 /****************************************************/
 182
 183 void CMuleTrayIcon::SetTrayIcon(int Icon, uint32 percent)
 184 {
 185         int Bar_ySize = 0;
 186
 187         switch (Icon) {
 188                 case TRAY_ICON_HIGHID:
 189                         // Most likely case, test first
 190                         Bar_ySize = HighId_Icon_size;
 191                         break;
 192                 case TRAY_ICON_LOWID:
 193                         Bar_ySize = LowId_Icon_size;
 194                         break;
 195                 case TRAY_ICON_DISCONNECTED:
 196                         Bar_ySize = Disconnected_Icon_size;
 197                         break;
 198                 default:
 199                         wxFAIL;
 200         }
 201
 202         // Lookup this values for speed improvement: don't draw if not needed
 203         int NewSize = (Bar_ySize * percent) / 100;
 204
 205         if ((Old_Icon != Icon) || (Old_SpeedSize != NewSize)) {
 206
 207                 if ((Old_SpeedSize > NewSize) || (Old_Icon != Icon)) {
 208                         // We have to rebuild the icon, because bar is lower now.
 209                         switch (Icon) {
 210                                 case TRAY_ICON_HIGHID:
 211                                         // Most likely case, test first
 212                                         CurrentIcon = wxIcon(mule_TrayIcon_big_ico_xpm);
 213                                         break;
 214                                 case TRAY_ICON_LOWID:
 215                                         CurrentIcon = wxIcon(mule_Tr_yellow_big_ico_xpm);
 216                                         break;
 217                                 case TRAY_ICON_DISCONNECTED:
 218                                         CurrentIcon = wxIcon(mule_Tr_grey_big_ico_xpm);
 219                                         break;
 220                                 default:
 221                                         wxFAIL;
 222                         }
 223                 }
 224
 225                 Old_Icon = Icon;
 226                 Old_SpeedSize = NewSize;
 227
 228                 // Do whatever to the icon before drawing it (percent)
 229
 230                 wxBitmap TempBMP;
 231                 TempBMP.CopyFromIcon(CurrentIcon);
 232
 233                 TempBMP.SetMask(NULL);
 234
 235                 IconWithSpeed.SelectObject(TempBMP);
 236
 237
 238                 // Speed bar is: centered, taking 80% of the icon heigh, and
 239                 // right-justified taking a 10% of the icon width.
 240
 241                 // X
 242                 int Bar_xSize = 4;
 243                 int Bar_xPos = CurrentIcon.GetWidth() - 5;
 244
 245                 IconWithSpeed.SetBrush(*(wxTheBrushList->FindOrCreateBrush(CStatisticsDlg::getColors(11))));
 246                 IconWithSpeed.SetPen(*wxTRANSPARENT_PEN);
 247
 248                 IconWithSpeed.DrawRectangle(Bar_xPos + 1, Bar_ySize - NewSize, Bar_xSize -2 , NewSize);
 249
 250                 // Unselect the icon.
 251                 IconWithSpeed.SelectObject(wxNullBitmap);
 252
 253                 // Do transparency
 254
 255                 // Set a new mask with transparency set to red.
 256                 wxMask* new_mask = new wxMask(TempBMP, wxColour(0xFF, 0x00, 0x00));
 257
 258                 TempBMP.SetMask(new_mask);
 259                 CurrentIcon.CopyFromBitmap(TempBMP);
 260
 261                 UpdateTray();
 262         }
 263 }
 264
 265 void CMuleTrayIcon::SetTrayToolTip(const wxString& Tip)
 266 {
 267         CurrentTip = Tip;
 268         UpdateTray();
 269 }
 270
 271 /****************************************************/
 272 /**************** Private Functions *****************/
 273 /****************************************************/
 274
 275 void CMuleTrayIcon::UpdateTray()
 276 {
 277         // Icon update and Tip update
 278 #ifndef __WXCOCOA__
 279         if (IsOk())
 280 #endif
 281         {
 282                 SetIcon(CurrentIcon, CurrentTip);
 283         }
 284 }
 285
 286
 287 wxMenu* CMuleTrayIcon::CreatePopupMenu()
 288 {
 289         float kBpsUp = theStats::GetUploadRate() / 1024.0;
 290         float kBpsDown = theStats::GetDownloadRate() / 1024.0;
 291         float MBpsUp = kBpsUp / 1024.0;
 292         float MBpsDown = kBpsDown / 1024.0;
 293         bool showMBpsUp = (MBpsUp >= 1);
 294         bool showMBpsDown = (MBpsDown >= 1);
 295
 296         // Creates dinamically the menu to show the user.
 297         wxMenu *traymenu = new wxMenu();
 298         traymenu->SetTitle(_("aMule Tray Menu"));
 299
 300         // Build the Top string name
 301         wxString label = MOD_VERSION_LONG;
 302         traymenu->Append(TRAY_MENU_INFO, label);
 303         traymenu->AppendSeparator();
 304         label = wxString(_("Speed limits:")) + wxT(" ");
 305
 306         // Check for upload limits
 307         unsigned int max_upload = thePrefs::GetMaxUpload();
 308         if ( max_upload == UNLIMITED ) {
 309                 label += _("UL: None");
 310         }
 311         else {
 312                 label += CFormat(_("UL: %u")) % max_upload;
 313         }
 314         label += wxT(", ");
 315
 316         // Check for download limits
 317         unsigned int max_download = thePrefs::GetMaxDownload();
 318         if ( max_download == UNLIMITED ) {
 319                 label += _("DL: None");
 320         }
 321         else {
 322                 label += CFormat(_("DL: %u")) % max_download;
 323         }
 324
 325         traymenu->Append(TRAY_MENU_INFO, label);
 326         label = CFormat(_("Download speed: %.1f%s"))
 327                         % (showMBpsDown ? MBpsDown : kBpsDown) % (showMBpsDown ? _(" MB/s") : ((kBpsDown > 0) ? _(" kB/s") : wxT("")));
 328         traymenu->Append(TRAY_MENU_INFO, label);
 329         label = CFormat(_("Upload speed: %.1f%s"))
 330                         % (showMBpsUp ? MBpsUp : kBpsUp) % (showMBpsUp ? _(" MB/s") : ((kBpsUp > 0) ? _(" kB/s") : wxT("")));
 331         traymenu->Append(TRAY_MENU_INFO, label);
 332         traymenu->AppendSeparator();
 333
 334         // Client Info
 335         wxMenu* ClientInfoMenu = new wxMenu();
 336         ClientInfoMenu->SetTitle(_("Client Information"));
 337
 338         // User nick-name
 339         {
 340                 wxString temp = CFormat(_("Nickname: %s")) % ( thePrefs::GetUserNick().IsEmpty() ? wxString(_("No Nickname Selected!")) : thePrefs::GetUserNick() );
 341
 342                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 343         }
 344
 345         // Client ID
 346         {
 347                 wxString temp = _("ClientID: ");
 348
 349                 if (theApp->IsConnectedED2K()) {
 350                         temp += CFormat(wxT("%u")) % theApp->GetED2KID();
 351                 } else {
 352                         temp += _("Not connected");
 353                 }
 354                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 355         }
 356
 357         // Current Server and Server IP
 358         {
 359                 wxString temp_name = _("ServerName: ");
 360                 wxString temp_ip   = _("ServerIP: ");
 361
 362                 if ( theApp->serverconnect->GetCurrentServer() ) {
 363                         temp_name += theApp->serverconnect->GetCurrentServer()->GetListName();
 364                         temp_ip   += theApp->serverconnect->GetCurrentServer()->GetFullIP();
 365                 } else {
 366                         temp_name += _("Not connected");
 367                         temp_ip   += _("Not Connected");
 368                 }
 369                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_name);
 370                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_ip);
 371         }
 372
 373         // IP Address
 374         {
 375                 wxString temp = CFormat(_("IP: %s")) % ( (theApp->GetPublicIP()) ? Uint32toStringIP(theApp->GetPublicIP()) : wxString(_("Unknown")) );
 376
 377                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 378         }
 379
 380         // TCP PORT
 381         {
 382                 wxString temp;
 383                 if (thePrefs::GetPort()) {
 384                         temp = CFormat(_("TCP port: %d")) % thePrefs::GetPort();
 385                 } else {
 386                         temp=_("TCP port: Not ready");
 387                 }
 388                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 389         }
 390
 391         // UDP PORT
 392         {
 393                 wxString temp;
 394                 if (thePrefs::GetEffectiveUDPPort()) {
 395                         temp = CFormat(_("UDP port: %d")) % thePrefs::GetEffectiveUDPPort();
 396                 } else {
 397                         temp=_("UDP port: Not ready");
 398                 }
 399                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 400         }
 401
 402         // Online Signature
 403         {
 404                 wxString temp;
 405                 if (thePrefs::IsOnlineSignatureEnabled()) {
 406                         temp=_("Online Signature: Enabled");
 407                 }
 408                 else {
 409                         temp=_("Online Signature: Disabled");
 410                 }
 411                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 412         }
 413
 414         // Uptime
 415         {
 416                 wxString temp = CFormat(_("Uptime: %s")) % CastSecondsToHM(theStats::GetUptimeSeconds());
 417                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 418         }
 419
 420         // Number of shared files
 421         {
 422                 wxString temp = CFormat(_("Shared files: %d")) % theStats::GetSharedFileCount();
 423                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 424         }
 425
 426         // Number of queued clients
 427         {
 428                 wxString temp = CFormat(_("Queued clients: %d")) % theStats::GetWaitingUserCount();
 429                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 430         }
 431
 432         // Total Downloaded
 433         {
 434                 wxString temp = CastItoXBytes(theStats::GetTotalReceivedBytes());
 435                 temp = CFormat(_("Total DL: %s")) % temp;
 436                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 437         }
 438
 439         // Total Uploaded
 440         {
 441                 wxString temp = CastItoXBytes(theStats::GetTotalSentBytes());
 442                 temp = CFormat(_("Total UL: %s")) % temp;
 443                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 444         }
 445
 446         traymenu->Append(TRAY_MENU_CLIENTINFO,ClientInfoMenu->GetTitle(),ClientInfoMenu);
 447
 448         // Separator
 449         traymenu->AppendSeparator();
 450
 451         // Upload Speed sub-menu
 452         wxMenu* UploadSpeedMenu = new wxMenu();
 453         UploadSpeedMenu->SetTitle(_("Upload limit"));
 454
 455         // Download Speed sub-menu
 456         wxMenu* DownloadSpeedMenu = new wxMenu();
 457         DownloadSpeedMenu->SetTitle(_("Download limit"));
 458
 459         // Upload Speed sub-menu
 460         {
 461                 UploadSpeedMenu->Append(UPLOAD_ITEM1, _("Unlimited"));
 462
 463                 uint32 max_ul_speed = thePrefs::GetMaxGraphUploadRate();
 464
 465                 if ( max_ul_speed == UNLIMITED ) {
 466                         max_ul_speed = 100;
 467                 }
 468                 else if ( max_ul_speed < 10 ) {
 469                         max_ul_speed = 10;
 470                 }
 471
 472                 for ( int i = 0; i < 5; i++ ) {
 473                         unsigned int tempspeed = (unsigned int)((double)max_ul_speed / 5) * (5 - i);
 474                         wxString temp = CFormat(wxT("%u %s")) % tempspeed % _("kB/s");
 475                         UploadSpeedMenu->Append((int)UPLOAD_ITEM1+i+1,temp);
 476                 }
 477         }
 478         traymenu->Append(0,UploadSpeedMenu->GetTitle(),UploadSpeedMenu);
 479
 480         // Download Speed sub-menu
 481         {
 482                 DownloadSpeedMenu->Append(DOWNLOAD_ITEM1, _("Unlimited"));
 483
 484                 uint32 max_dl_speed = thePrefs::GetMaxGraphDownloadRate();
 485
 486                 if ( max_dl_speed == UNLIMITED ) {
 487                         max_dl_speed = 100;
 488                 }
 489                 else if ( max_dl_speed < 10 ) {
 490                         max_dl_speed = 10;
 491                 }
 492
 493                 for ( int i = 0; i < 5; i++ ) {
 494                         unsigned int tempspeed = (unsigned int)((double)max_dl_speed / 5) * (5 - i);
 495                         wxString temp = CFormat(wxT("%d %s")) % tempspeed % _("kB/s");
 496                         DownloadSpeedMenu->Append((int)DOWNLOAD_ITEM1+i+1,temp);
 497                 }
 498         }
 499
 500         traymenu->Append(0,DownloadSpeedMenu->GetTitle(),DownloadSpeedMenu);
 501         // Separator
 502         traymenu->AppendSeparator();
 503
 504         if (theApp->IsConnected()) {
 505                 //Disconnection Speed item
 506                 traymenu->Append(TRAY_MENU_DISCONNECT, _("Disconnect"));
 507         } else {
 508                 //Connect item
 509                 traymenu->Append(TRAY_MENU_CONNECT, _("Connect"));
 510         }
 511
 512         // Separator
 513         traymenu->AppendSeparator();
 514
 515         if (theApp->amuledlg->IsShown()) {
 516                 //hide item
 517                 traymenu->Append(TRAY_MENU_HIDE, _("Hide aMule"));
 518         } else {
 519                 //show item
 520                 traymenu->Append(TRAY_MENU_SHOW, _("Show aMule"));
 521         }
 522
 523         // Separator
 524         traymenu->AppendSeparator();
 525
 526         // Exit item
 527         traymenu->Append(TRAY_MENU_EXIT, _("Exit"));
 528
 529         return traymenu;
 530 }
 531
 532 void CMuleTrayIcon::SwitchShow(wxTaskBarIconEvent&)
 533 {
 534         theApp->amuledlg->Iconize(theApp->amuledlg->IsShown());
 535         theApp->amuledlg->Show(!theApp->amuledlg->IsShown());
 536 }
 537 // File_checked_for_headers