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