2 // This file is part of the aMule Project.
4 // Copyright (c) 2005-2008 aMule Team ( admin@amule.org / http://www.amule.org )
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
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.
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.
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
25 #ifndef AMULE_REMOTE_GUI_H
26 #define AMULE_REMOTE_GUI_H
29 #include <ec/cpp/RemoteConnect.h> // Needed for CRemoteConnect
32 #include "Statistics.h"
33 #include "Preferences.h"
34 #include "Statistics.h"
36 #include "SearchList.h" // Needed for CSearchFile
52 #include <wx/dialog.h>
54 class CEConnectDlg
: public wxDialog
{
59 wxString login
, passwd
;
60 bool m_save_user_pass
;
66 void OnOK(wxCommandEvent
& event
);
68 wxString
Host() { return host
; }
69 int Port() { return port
; }
71 wxString
Login() { return login
; }
73 bool SaveUserPass() { return m_save_user_pass
; }
76 DECLARE_LOCAL_EVENT_TYPE(wxEVT_EC_INIT_DONE
, wxEVT_USER_FIRST
+ 1001)
78 class wxECInitDoneEvent
: public wxEvent
{
80 wxECInitDoneEvent() : wxEvent(-1, wxEVT_EC_INIT_DONE
)
84 wxEvent
*Clone(void) const
86 return new wxECInitDoneEvent(*this);
90 class CPreferencesRem
: public CPreferences
, public CECPacketHandlerBase
{
91 CRemoteConnect
*m_conn
;
92 uint32 m_exchange_send_selected_prefs
;
93 uint32 m_exchange_recv_selected_prefs
;
95 virtual void HandlePacket(const CECPacket
*packet
);
97 CPreferencesRem(CRemoteConnect
*);
99 bool CreateCategory(Category_Struct
*& category
, const wxString
& name
, const CPath
& path
,
100 const wxString
& comment
, uint32 color
, uint8 prio
);
101 bool UpdateCategory(uint8 cat
, const wxString
& name
, const CPath
& path
,
102 const wxString
& comment
, uint32 color
, uint8 prio
);
104 void RemoveCat(uint8 cat
);
111 // T - type if item in container
112 // I - type of id of item
113 // G - type of tag used to create/update items
115 template <class T
, class I
, class G
= CECTag
>
116 class CRemoteContainer
: public CECPacketHandlerBase
{
119 IDLE
, // no request in the air
120 STATUS_REQ_SENT
, // sent request for item status
121 FULL_REQ_SENT
// sent request for full info
124 CRemoteConnect
*m_conn
;
126 std::list
<T
*> m_items
;
127 std::map
<I
, T
*> m_items_hash
;
129 // .size() is O(N) operation in stl
132 // use incremental tags algorithm
135 // command that will be used in full request
136 int m_full_req_cmd
, m_full_req_tag
;
138 virtual void HandlePacket(const CECPacket
*packet
)
140 switch(this->m_state
) {
141 case IDLE
: wxFAIL
; // not expecting anything
142 case STATUS_REQ_SENT
:
143 // if derived class choose not to proceed, return - but with good status
144 this->m_state
= IDLE
;
145 if ( this->Phase1Done(packet
) ) {
146 if (this->m_inc_tags
) {
147 // Incremental tags: new items always carry full info.
148 ProcessUpdate(packet
, NULL
, m_full_req_tag
);
150 // Non-incremental tags: we might get partial info on new items.
151 // Collect all this items in a tag, and then request full info about them.
152 CECPacket
req_full(this->m_full_req_cmd
);
154 ProcessUpdate(packet
, &req_full
, m_full_req_tag
);
156 // Phase 3: request full info about files we don't have yet
157 if ( req_full
.HasChildTags() ) {
158 m_conn
->SendRequest(this, &req_full
);
159 this->m_state
= FULL_REQ_SENT
;
171 CRemoteContainer(CRemoteConnect
*conn
, bool inc_tags
)
177 m_inc_tags
= inc_tags
;
180 virtual ~CRemoteContainer()
184 typedef typename
std::list
<T
*>::iterator iterator
;
185 iterator
begin() { return m_items
.begin(); }
186 iterator
end() { return m_items
.end(); }
193 void AddItem(T
*item
)
195 m_items
.push_back(item
);
196 m_items_hash
[GetItemID(item
)] = item
;
202 // avoid creating nodes
203 return m_items_hash
.count(id
) ? m_items_hash
[id
] : NULL
;
209 m_items_hash
.clear();
217 We usually don't keep outdated code as comments, but this blocking implementation
218 shows the overall procedure well. It had to be scattered for the event driven implementation.
220 bool FullReload(int cmd)
223 CScopedPtr<const CECPacket> reply(this->m_conn->SendRecvPacket(&req));
224 if ( !reply.get() ) {
227 for(typename std::list<T *>::iterator j = this->m_items.begin(); j != this->m_items.end(); j++) {
228 this->DeleteItem(*j);
233 ProcessFull(reply.get());
238 void FullReload(int cmd
)
240 if ( this->m_state
!= IDLE
) {
244 for(typename
std::list
<T
*>::iterator j
= this->m_items
.begin(); j
!= this->m_items
.end(); j
++) {
245 this->DeleteItem(*j
);
251 this->m_conn
->SendRequest(this, &req
);
252 this->m_state
= FULL_REQ_SENT
;
253 this->m_full_req_cmd
= cmd
;
257 // Following are like basicly same code as in webserver. Eventually it must
260 void DoRequery(int cmd
, int tag
)
262 if ( this->m_state
!= IDLE
) {
265 CECPacket
req_sts(cmd
, m_inc_tags
? EC_DETAIL_INC_UPDATE
: EC_DETAIL_UPDATE
);
266 this->m_conn
->SendRequest(this, &req_sts
);
267 this->m_state
= STATUS_REQ_SENT
;
268 this->m_full_req_cmd
= cmd
;
269 this->m_full_req_tag
= tag
;
272 We usually don't keep outdated code as comments, but this blocking implementation
273 shows the overall procedure well. It had to be scattered for the event driven implementation.
275 bool DoRequery(int cmd, int tag)
277 CECPacket req_sts(cmd, m_inc_tags ? EC_DETAIL_INC_UPDATE : EC_DETAIL_UPDATE);
280 // Phase 1: request status
281 CScopedPtr<const CECPacket> reply(this->m_conn->SendRecvPacket(&req_sts));
282 if ( !reply.get() ) {
286 if ( !this->Phase1Done(reply.get()) ) {
287 // if derived class choose not to proceed, return - but with good status
291 // Phase 2: update status, mark new files for subsequent query
292 CECPacket req_full(cmd);
294 ProcessUpdate(reply.get(), &req_full, tag);
299 // Phase 3: request full info about files we don't have yet
300 if ( req_full.GetTagCount() ) {
301 reply.reset(this->m_conn->SendRecvPacket(&req_full));
302 if ( !reply.get() ) {
305 ProcessFull(reply.get());
312 void ProcessFull(const CECPacket
*reply
)
314 for (CECPacket::const_iterator it
= reply
->begin(); it
!= reply
->end(); it
++) {
315 G
*tag
= (G
*) & *it
;
316 // initialize item data from EC tag
317 AddItem(CreateItem(tag
));
321 void RemoveItem(iterator
& it
)
323 I item_id
= GetItemID(*it
);
327 m_items_hash
.erase(item_id
);
328 // item may contain data that need to be freed externally, before
329 // dtor is called and memory freed
335 virtual void ProcessUpdate(const CECTag
*reply
, CECPacket
*full_req
, int req_type
)
337 std::set
<I
> core_files
;
338 for (CECPacket::const_iterator it
= reply
->begin(); it
!= reply
->end(); it
++) {
339 G
*tag
= (G
*) & *it
;
340 if ( tag
->GetTagName() != req_type
) {
344 core_files
.insert(tag
->ID());
345 if ( m_items_hash
.count(tag
->ID()) ) {
346 // Item already known: update it
347 T
*item
= m_items_hash
[tag
->ID()];
348 ProcessItemUpdate(tag
, item
);
352 // Non-incremental mode: we have only partial info
353 // so we need to request full info before we can use the item
354 full_req
->AddTag(CECTag(req_type
, tag
->ID()));
356 // Incremental mode: new items always carry full info,
357 // so we can add it right away
358 AddItem(CreateItem(tag
));
362 for(iterator it
= begin(); it
!= end();) {
364 if ( core_files
.count(GetItemID(*it2
)) == 0 ) {
370 virtual T
*CreateItem(G
*)
374 virtual void DeleteItem(T
*)
377 virtual I
GetItemID(T
*)
381 virtual void ProcessItemUpdate(G
*, T
*)
385 virtual bool Phase1Done(const CECPacket
*)
391 class CServerConnectRem
: public CECPacketHandlerBase
{
392 CRemoteConnect
*m_Conn
;
395 CServer
*m_CurrServer
;
397 virtual void HandlePacket(const CECPacket
*packet
);
400 CServerConnectRem(CRemoteConnect
*);
403 bool IsConnected() { return (m_ID
!= 0) && (m_ID
!= 0xffffffff); }
404 bool IsConnecting() { return m_ID
== 0xffffffff; }
405 bool IsLowID() { return m_ID
< 16777216; }
406 uint32
GetClientID() { return m_ID
; }
407 CServer
*GetCurrentServer() { return m_CurrServer
; }
412 void ConnectToServer(CServer
* server
);
413 void ConnectToAnyServer();
414 void StopConnectionTry();
418 class CServerListRem
: public CRemoteContainer
<CServer
, uint32
, CEC_Server_Tag
> {
419 uint32 m_TotalUser
, m_TotalFile
;
421 virtual void HandlePacket(const CECPacket
*packet
);
423 CServerListRem(CRemoteConnect
*);
424 void GetUserFileStatus(uint32
&total_user
, uint32
&total_file
)
426 total_user
= m_TotalUser
;
427 total_file
= m_TotalFile
;
430 void UpdateUserFileStatus(CServer
*server
);
432 CServer
* GetServerByAddress(const wxString
& address
, uint16 port
) const;
433 CServer
* GetServerByIPTCP(uint32 nIP
, uint16 nPort
) const;
435 void ReloadControl();
440 void RemoveServer(CServer
* server
);
441 void UpdateServerMetFromURL(wxString url
);
442 void SaveServerMet();
443 void FilterServers();
448 CServer
*CreateItem(CEC_Server_Tag
*);
449 void DeleteItem(CServer
*);
450 uint32
GetItemID(CServer
*);
451 void ProcessItemUpdate(CEC_Server_Tag
*, CServer
*);
454 class CUpDownClientListRem
: public CRemoteContainer
<CUpDownClient
, uint32
, CEC_UpDownClient_Tag
> {
456 CUpDownClientListRem(CRemoteConnect
*);
458 const CClientPtrList
& GetList() const { return m_items
; };
464 CUpDownClient
*CreateItem(CEC_UpDownClient_Tag
*);
465 void DeleteItem(CUpDownClient
*);
466 uint32
GetItemID(CUpDownClient
*);
467 void ProcessItemUpdate(CEC_UpDownClient_Tag
*, CUpDownClient
*);
470 class CDownQueueRem
: public std::map
<uint32
, CPartFile
*> {
471 CRemoteConnect
*m_conn
;
473 CDownQueueRem(CRemoteConnect
* conn
) { m_conn
= conn
; }
475 CPartFile
* GetFileByID(uint32 id
);
480 void Prio(CPartFile
*file
, uint8 prio
);
481 void AutoPrio(CPartFile
*file
, bool flag
);
482 void Category(CPartFile
*file
, uint8 cat
);
484 void SendFileCommand(CPartFile
*file
, ec_tagname_t cmd
);
488 void StopUDPRequests() {}
489 void AddFileLinkToDownload(CED2KFileLink
*, uint8
);
490 bool AddLink(const wxString
&link
, uint8 category
= 0);
491 void UnsetCompletedFilesExist();
492 void ResetCatParts(int cat
);
493 void AddSearchToDownload(CSearchFile
* toadd
, uint8 category
);
496 class CSharedFilesRem
: public std::map
<uint32
, CKnownFile
*> {
497 CRemoteConnect
*m_conn
;
499 CSharedFilesRem(CRemoteConnect
* conn
);
501 CKnownFile
*GetFileByID(uint32 id
);
503 void SetFilePrio(CKnownFile
*file
, uint8 prio
);
508 void AddFilesFromDirectory(const CPath
&);
509 void Reload(bool sendtoserver
= true, bool firstload
= false);
510 bool RenameFile(CKnownFile
* file
, const CPath
& newName
);
513 class CKnownFilesRem
: public CRemoteContainer
<CKnownFile
, uint32
, CEC_SharedFile_Tag
> {
514 CKnownFile
* CreateKnownFile(CEC_SharedFile_Tag
*tag
, CKnownFile
*file
= NULL
);
515 CPartFile
* CreatePartFile(CEC_PartFile_Tag
*tag
);
518 CKnownFilesRem(CRemoteConnect
* conn
);
520 CKnownFile
*FindKnownFileByID(uint32 id
) { return GetByID(id
); }
529 CKnownFile
*CreateItem(CEC_SharedFile_Tag
*) { wxFAIL
; return NULL
; } // unused, required by template
530 void DeleteItem(CKnownFile
*);
531 uint32
GetItemID(CKnownFile
*);
532 void ProcessItemUpdate(CEC_SharedFile_Tag
*, CKnownFile
*);
533 bool Phase1Done(const CECPacket
*) { return true; }
534 void ProcessUpdate(const CECTag
*reply
, CECPacket
*full_req
, int req_type
);
536 void ProcessItemUpdatePartfile(CEC_PartFile_Tag
*, CPartFile
*);
540 CRemoteConnect
*m_conn
;
542 CIPFilterRem(CRemoteConnect
*conn
);
548 void Update(wxString strURL
= wxEmptyString
);
551 class CSearchListRem
: public CRemoteContainer
<CSearchFile
, uint32
, CEC_SearchFile_Tag
> {
552 virtual void HandlePacket(const CECPacket
*);
554 CSearchListRem(CRemoteConnect
*);
557 typedef std::map
<long, CSearchResultList
> ResultMap
;
560 const CSearchResultList
& GetSearchResults(long nSearchID
);
561 void RemoveResults(long nSearchID
);
562 const CSearchResultList
& GetSearchResults(long nSearchID
) const;
567 wxString
StartNewSearch(uint32
* nSearchID
, SearchType search_type
,
568 const CSearchList::CSearchParams
& params
);
570 void StopGlobalSearch();
571 void StopKadSearch();
576 CSearchFile
*CreateItem(CEC_SearchFile_Tag
*);
577 void DeleteItem(CSearchFile
*);
578 uint32
GetItemID(CSearchFile
*);
579 void ProcessItemUpdate(CEC_SearchFile_Tag
*, CSearchFile
*);
580 bool Phase1Done(const CECPacket
*);
583 class CStatsUpdaterRem
: public CECPacketHandlerBase
{
584 virtual void HandlePacket(const CECPacket
*);
586 CStatsUpdaterRem() {}
589 class CListenSocketRem
{
590 uint32 m_peak_connections
;
592 uint32
GetPeakConnections() { return m_peak_connections
; }
595 class CamuleRemoteGuiApp
: public wxApp
, public CamuleGuiBase
, public CamuleAppCommon
{
598 virtual int InitGui(bool geometry_enable
, wxString
&geometry_string
);
604 void OnPollTimer(wxTimerEvent
& evt
);
606 void OnECConnection(wxEvent
& event
);
607 void OnECInitDone(wxEvent
& event
);
608 void OnNotifyEvent(CMuleGUIEvent
& evt
);
609 void OnFinishedHTTPDownload(CMuleInternalEvent
& event
);
611 CStatsUpdaterRem m_stats_updater
;
616 bool ShowConnectionDialog();
618 class CRemoteConnect
*m_connect
;
620 CEConnectDlg
*dialog
;
622 bool CopyTextToClipboard(wxString strText
);
624 virtual int ShowAlert(wxString msg
, wxString title
, int flags
);
626 void ShutDown(wxCloseEvent
&evt
);
628 CPreferencesRem
*glob_prefs
;
631 // Provide access to core data thru EC
632 CServerConnectRem
*serverconnect
;
633 CServerListRem
*serverlist
;
634 CDownQueueRem
*downloadqueue
;
635 CSharedFilesRem
*sharedfiles
;
636 CKnownFilesRem
*knownfiles
;
637 CUpDownClientListRem
*clientlist
;
638 CIPFilterRem
*ipfilter
;
639 CSearchListRem
*searchlist
;
640 CListenSocketRem
*listensocket
;
642 CStatistics
*m_statistics
;
644 bool AddServer(CServer
*srv
, bool fromUser
= false);
646 uint32
GetPublicIP();
648 wxString
GetLog(bool reset
= false);
649 wxString
GetServerLog(bool reset
= false);
651 void AddServerMessageLine(wxString
&msg
);
652 void AddRemoteLogLine(const wxString
& line
);
654 void SetOSFiles(wxString
) { /* onlinesig is created on remote side */ }
656 bool IsConnected() const { return IsConnectedED2K() || IsConnectedKad(); }
657 bool IsFirewalled() const;
658 bool IsConnectedED2K() const;
659 bool IsConnectedKad() const
661 return ((m_ConnState
& CONNECTED_KAD_OK
)
662 || (m_ConnState
& CONNECTED_KAD_FIREWALLED
));
664 bool IsFirewalledKad() const { return (m_ConnState
& CONNECTED_KAD_FIREWALLED
) != 0; }
666 bool IsKadRunning() const { return ((m_ConnState
& CONNECTED_KAD_OK
)
667 || (m_ConnState
& CONNECTED_KAD_FIREWALLED
)
668 || (m_ConnState
& CONNECTED_KAD_NOT
)); }
670 // Check Kad state (UDP)
671 bool IsFirewalledKadUDP() const { return theStats::IsFirewalledKadUDP(); }
673 uint32
GetKadUsers() const { return theStats::GetKadUsers(); }
674 uint32
GetKadFiles() const { return theStats::GetKadFiles(); }
675 uint32
GetKadIndexedSources() const { return theStats::GetKadIndexedSources(); }
676 uint32
GetKadIndexedKeywords() const{ return theStats::GetKadIndexedKeywords(); }
677 uint32
GetKadIndexedNotes() const { return theStats::GetKadIndexedNotes(); }
678 uint32
GetKadIndexedLoad() const { return theStats::GetKadIndexedLoad(); }
679 // True IP of machine
680 uint32
GetKadIPAdress() const { return theStats::GetKadIPAdress(); }
682 uint8
GetBuddyStatus() const { return theStats::GetBuddyStatus(); }
683 uint32
GetBuddyIP() const { return theStats::GetBuddyIP(); }
684 uint32
GetBuddyPort() const { return theStats::GetBuddyPort(); }
689 /** Bootstraps kad from the specified IP (must be in hostorder). */
690 void BootstrapKad(uint32 ip
, uint16 port
);
691 /** Updates the nodes.dat file from the specified url. */
692 void UpdateNotesDat(const wxString
& str
);
694 void DisconnectED2K();
696 bool CryptoAvailable() const;
698 uint32
GetED2KID() const;
699 uint32
GetID() const;
700 void ShowUserCount();
707 DECLARE_EVENT_TABLE()
710 DECLARE_APP(CamuleRemoteGuiApp
)
712 extern CamuleRemoteGuiApp
*theApp
;
714 #endif /* AMULE_REMOTE_GUI_H */
716 // File_checked_for_headers