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 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->DoIconize(theApp->amuledlg->IsShown());
 152 }
 153
 154
 155 void CMuleTrayIcon::Close(wxCommandEvent& WXUNUSED(event))
 156 {
 157         if (theApp->amuledlg->IsEnabled()) {
 158                 theApp->amuledlg->Close();
 159         }
 160 }
 161
 162
 163 CMuleTrayIcon::CMuleTrayIcon()
 164 {
 165         Old_Icon = -1;
 166         Old_SpeedSize = 0xFFFF; // must be > any possible one.
 167
 168         // Create the background icons (speed improvement)
 169         HighId_Icon_size = wxIcon(mule_TrayIcon_big_ico_xpm).GetHeight();
 170         LowId_Icon_size = wxIcon(mule_Tr_yellow_big_ico_xpm).GetHeight();
 171         Disconnected_Icon_size = wxIcon(mule_Tr_grey_big_ico_xpm).GetHeight();
 172 }
 173
 174 CMuleTrayIcon::~CMuleTrayIcon()
 175 {
 176 }
 177
 178 /****************************************************/
 179 /***************** Public Functions *****************/
 180 /****************************************************/
 181
 182 void CMuleTrayIcon::SetTrayIcon(int Icon, uint32 percent)
 183 {
 184         int Bar_ySize = 0;
 185
 186         switch (Icon) {
 187                 case TRAY_ICON_HIGHID:
 188                         // Most likely case, test first
 189                         Bar_ySize = HighId_Icon_size;
 190                         break;
 191                 case TRAY_ICON_LOWID:
 192                         Bar_ySize = LowId_Icon_size;
 193                         break;
 194                 case TRAY_ICON_DISCONNECTED:
 195                         Bar_ySize = Disconnected_Icon_size;
 196                         break;
 197                 default:
 198                         wxFAIL;
 199         }
 200
 201         // Lookup this values for speed improvement: don't draw if not needed
 202         int NewSize = (Bar_ySize * percent) / 100;
 203
 204         if ((Old_Icon != Icon) || (Old_SpeedSize != NewSize)) {
 205
 206                 if ((Old_SpeedSize > NewSize) || (Old_Icon != Icon)) {
 207                         // We have to rebuild the icon, because bar is lower now.
 208                         switch (Icon) {
 209                                 case TRAY_ICON_HIGHID:
 210                                         // Most likely case, test first
 211                                         CurrentIcon = wxIcon(mule_TrayIcon_big_ico_xpm);
 212                                         break;
 213                                 case TRAY_ICON_LOWID:
 214                                         CurrentIcon = wxIcon(mule_Tr_yellow_big_ico_xpm);
 215                                         break;
 216                                 case TRAY_ICON_DISCONNECTED:
 217                                         CurrentIcon = wxIcon(mule_Tr_grey_big_ico_xpm);
 218                                         break;
 219                                 default:
 220                                         wxFAIL;
 221                         }
 222                 }
 223
 224                 Old_Icon = Icon;
 225                 Old_SpeedSize = NewSize;
 226
 227                 // Do whatever to the icon before drawing it (percent)
 228
 229                 wxBitmap TempBMP;
 230                 TempBMP.CopyFromIcon(CurrentIcon);
 231
 232                 TempBMP.SetMask(NULL);
 233
 234                 IconWithSpeed.SelectObject(TempBMP);
 235
 236
 237                 // Speed bar is: centered, taking 80% of the icon heigh, and
 238                 // right-justified taking a 10% of the icon width.
 239
 240                 // X
 241                 int Bar_xSize = 4;
 242                 int Bar_xPos = CurrentIcon.GetWidth() - 5;
 243
 244                 IconWithSpeed.SetBrush(*(wxTheBrushList->FindOrCreateBrush(CStatisticsDlg::getColors(11))));
 245                 IconWithSpeed.SetPen(*wxTRANSPARENT_PEN);
 246
 247                 IconWithSpeed.DrawRectangle(Bar_xPos + 1, Bar_ySize - NewSize, Bar_xSize -2 , NewSize);
 248
 249                 // Unselect the icon.
 250                 IconWithSpeed.SelectObject(wxNullBitmap);
 251
 252                 // Do transparency
 253
 254                 // Set a new mask with transparency set to red.
 255                 wxMask* new_mask = new wxMask(TempBMP, wxColour(0xFF, 0x00, 0x00));
 256
 257                 TempBMP.SetMask(new_mask);
 258                 CurrentIcon.CopyFromBitmap(TempBMP);
 259
 260                 UpdateTray();
 261         }
 262 }
 263
 264 void CMuleTrayIcon::SetTrayToolTip(const wxString& Tip)
 265 {
 266         CurrentTip = Tip;
 267         UpdateTray();
 268 }
 269
 270 /****************************************************/
 271 /**************** Private Functions *****************/
 272 /****************************************************/
 273
 274 void CMuleTrayIcon::UpdateTray()
 275 {
 276         // Icon update and Tip update
 277 #ifndef __WXCOCOA__
 278         if (IsOk())
 279 #endif
 280         {
 281                 SetIcon(CurrentIcon, CurrentTip);
 282         }
 283 }
 284
 285
 286 wxMenu* CMuleTrayIcon::CreatePopupMenu()
 287 {
 288         // Creates dinamically the menu to show the user.
 289         wxMenu *traymenu = new wxMenu();
 290         traymenu->SetTitle(_("aMule Tray Menu"));
 291
 292         // Build the Top string name
 293         wxString label = MOD_VERSION_LONG;
 294         traymenu->Append(TRAY_MENU_INFO, label);
 295         traymenu->AppendSeparator();
 296         label = wxString(_("Speed limits:")) + wxT(" ");
 297
 298         // Check for upload limits
 299         unsigned int max_upload = thePrefs::GetMaxUpload();
 300         if ( max_upload == UNLIMITED ) {
 301                 label += _("UL: None");
 302         }
 303         else {
 304                 label += CFormat(_("UL: %u")) % max_upload;
 305         }
 306         label += wxT(", ");
 307
 308         // Check for download limits
 309         unsigned int max_download = thePrefs::GetMaxDownload();
 310         if ( max_download == UNLIMITED ) {
 311                 label += _("DL: None");
 312         }
 313         else {
 314                 label += CFormat(_("DL: %u")) % max_download;
 315         }
 316
 317         traymenu->Append(TRAY_MENU_INFO, label);
 318         label = CFormat(_("Download speed: %.1f")) % (theStats::GetDownloadRate() / 1024.0);
 319         traymenu->Append(TRAY_MENU_INFO, label);
 320         label = CFormat(_("Upload speed: %.1f")) % (theStats::GetUploadRate() / 1024.0);
 321         traymenu->Append(TRAY_MENU_INFO, label);
 322         traymenu->AppendSeparator();
 323
 324         // Client Info
 325         wxMenu* ClientInfoMenu = new wxMenu();
 326         ClientInfoMenu->SetTitle(_("Client Information"));
 327
 328         // User nick-name
 329         {
 330                 wxString temp = CFormat(_("Nickname: %s")) % ( thePrefs::GetUserNick().IsEmpty() ? wxString(_("No Nickname Selected!")) : thePrefs::GetUserNick() );
 331
 332                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 333         }
 334
 335         // Client ID
 336         {
 337                 wxString temp = _("ClientID: ");
 338
 339                 if (theApp->IsConnectedED2K()) {
 340                         temp += CFormat(wxT("%u")) % theApp->GetED2KID();
 341                 } else {
 342                         temp += _("Not connected");
 343                 }
 344                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 345         }
 346
 347         // Current Server and Server IP
 348         {
 349                 wxString temp_name = _("ServerName: ");
 350                 wxString temp_ip   = _("ServerIP: ");
 351
 352                 if ( theApp->serverconnect->GetCurrentServer() ) {
 353                         temp_name += theApp->serverconnect->GetCurrentServer()->GetListName();
 354                         temp_ip   += theApp->serverconnect->GetCurrentServer()->GetFullIP();
 355                 } else {
 356                         temp_name += _("Not connected");
 357                         temp_ip   += _("Not Connected");
 358                 }
 359                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_name);
 360                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp_ip);
 361         }
 362
 363         // IP Address
 364         {
 365                 wxString temp = CFormat(_("IP: %s")) % ( (theApp->GetPublicIP()) ? Uint32toStringIP(theApp->GetPublicIP()) : wxString(_("Unknown")) );
 366
 367                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 368         }
 369
 370         // TCP PORT
 371         {
 372                 wxString temp;
 373                 if (thePrefs::GetPort()) {
 374                         temp = CFormat(_("TCP port: %d")) % thePrefs::GetPort();
 375                 } else {
 376                         temp=_("TCP port: Not ready");
 377                 }
 378                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 379         }
 380
 381         // UDP PORT
 382         {
 383                 wxString temp;
 384                 if (thePrefs::GetEffectiveUDPPort()) {
 385                         temp = CFormat(_("UDP port: %d")) % thePrefs::GetEffectiveUDPPort();
 386                 } else {
 387                         temp=_("UDP port: Not ready");
 388                 }
 389                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 390         }
 391
 392         // Online Signature
 393         {
 394                 wxString temp;
 395                 if (thePrefs::IsOnlineSignatureEnabled()) {
 396                         temp=_("Online Signature: Enabled");
 397                 }
 398                 else {
 399                         temp=_("Online Signature: Disabled");
 400                 }
 401                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 402         }
 403
 404         // Uptime
 405         {
 406                 wxString temp = CFormat(_("Uptime: %s")) % CastSecondsToHM(theStats::GetUptimeSeconds());
 407                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 408         }
 409
 410         // Number of shared files
 411         {
 412                 wxString temp = CFormat(_("Shared files: %d")) % theStats::GetSharedFileCount();
 413                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 414         }
 415
 416         // Number of queued clients
 417         {
 418                 wxString temp = CFormat(_("Queued clients: %d")) % theStats::GetWaitingUserCount();
 419                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 420         }
 421
 422         // Total Downloaded
 423         {
 424                 wxString temp = CastItoXBytes(theStats::GetTotalReceivedBytes());
 425                 temp = CFormat(_("Total DL: %s")) % temp;
 426                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 427         }
 428
 429         // Total Uploaded
 430         {
 431                 wxString temp = CastItoXBytes(theStats::GetTotalSentBytes());
 432                 temp = CFormat(_("Total UL: %s")) % temp;
 433                 ClientInfoMenu->Append(TRAY_MENU_CLIENTINFO_ITEM,temp);
 434         }
 435
 436         traymenu->Append(TRAY_MENU_CLIENTINFO,ClientInfoMenu->GetTitle(),ClientInfoMenu);
 437
 438         // Separator
 439         traymenu->AppendSeparator();
 440
 441         // Upload Speed sub-menu
 442         wxMenu* UploadSpeedMenu = new wxMenu();
 443         UploadSpeedMenu->SetTitle(_("Upload limit"));
 444
 445         // Download Speed sub-menu
 446         wxMenu* DownloadSpeedMenu = new wxMenu();
 447         DownloadSpeedMenu->SetTitle(_("Download limit"));
 448
 449         // Upload Speed sub-menu
 450         {
 451                 UploadSpeedMenu->Append(UPLOAD_ITEM1, _("Unlimited"));
 452
 453                 uint32 max_ul_speed = thePrefs::GetMaxGraphUploadRate();
 454
 455                 if ( max_ul_speed == UNLIMITED ) {
 456                         max_ul_speed = 100;
 457                 }
 458                 else if ( max_ul_speed < 10 ) {
 459                         max_ul_speed = 10;
 460                 }
 461
 462                 for ( int i = 0; i < 5; i++ ) {
 463                         unsigned int tempspeed = (unsigned int)((double)max_ul_speed / 5) * (5 - i);
 464                         wxString temp = CFormat(wxT("%u %s")) % tempspeed % _("kB/s");
 465                         UploadSpeedMenu->Append((int)UPLOAD_ITEM1+i+1,temp);
 466                 }
 467         }
 468         traymenu->Append(0,UploadSpeedMenu->GetTitle(),UploadSpeedMenu);
 469
 470         // Download Speed sub-menu
 471         {
 472                 DownloadSpeedMenu->Append(DOWNLOAD_ITEM1, _("Unlimited"));
 473
 474                 uint32 max_dl_speed = thePrefs::GetMaxGraphDownloadRate();
 475
 476                 if ( max_dl_speed == UNLIMITED ) {
 477                         max_dl_speed = 100;
 478                 }
 479                 else if ( max_dl_speed < 10 ) {
 480                         max_dl_speed = 10;
 481                 }
 482
 483                 for ( int i = 0; i < 5; i++ ) {
 484                         unsigned int tempspeed = (unsigned int)((double)max_dl_speed / 5) * (5 - i);
 485                         wxString temp = CFormat(wxT("%d %s")) % tempspeed % _("kB/s");
 486                         DownloadSpeedMenu->Append((int)DOWNLOAD_ITEM1+i+1,temp);
 487                 }
 488         }
 489
 490         traymenu->Append(0,DownloadSpeedMenu->GetTitle(),DownloadSpeedMenu);
 491         // Separator
 492         traymenu->AppendSeparator();
 493
 494         if (theApp->IsConnected()) {
 495                 //Disconnection Speed item
 496                 traymenu->Append(TRAY_MENU_DISCONNECT, _("Disconnect"));
 497         } else {
 498                 //Connect item
 499                 traymenu->Append(TRAY_MENU_CONNECT, _("Connect"));
 500         }
 501
 502         // Separator
 503         traymenu->AppendSeparator();
 504
 505         if (theApp->amuledlg->IsShown()) {
 506                 //hide item
 507                 traymenu->Append(TRAY_MENU_HIDE, _("Hide aMule"));
 508         } else {
 509                 //show item
 510                 traymenu->Append(TRAY_MENU_SHOW, _("Show aMule"));
 511         }
 512
 513         // Separator
 514         traymenu->AppendSeparator();
 515
 516         // Exit item
 517         traymenu->Append(TRAY_MENU_EXIT, _("Exit"));
 518
 519         return traymenu;
 520 }
 521
 522 void CMuleTrayIcon::SwitchShow(wxTaskBarIconEvent&)
 523 {
 524         theApp->amuledlg->DoIconize(theApp->amuledlg->IsShown());
 525 }
 526 // File_checked_for_headers