Updated Russian documentation by Morse.
[amule.git] / src / amule-remote-gui.h
blob6735f3fc3e3d5e5f6f3e8e45be354c34c5ec57f4
1 //
2 // This file is part of the aMule Project.
3 //
4 // Copyright (c) 2005-2011 aMule Team ( admin@amule.org / http://www.amule.org )
5 //
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
8 // respective authors.
9 //
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.
19 //
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"
35 #include "RLE.h"
36 #include "SearchList.h" // Needed for CSearchFile
39 class CED2KFileLink;
40 class CServer;
41 class CKnownFile;
42 class CSearchFile;
43 class CPartFile;
44 class CClientRef;
45 class CStatistics;
46 class CPath;
48 class wxEvtHandler;
49 class wxTimer;
50 class wxTimerEvent;
52 #include <wx/dialog.h>
54 class CEConnectDlg : public wxDialog {
55 wxString host;
56 int port;
58 wxString pwd_hash;
59 wxString login, passwd;
60 bool m_save_user_pass;
62 DECLARE_EVENT_TABLE()
63 public:
64 CEConnectDlg();
66 void OnOK(wxCommandEvent& event);
68 wxString Host() { return host; }
69 int Port() { return port; }
71 wxString Login() { return login; }
72 wxString PassHash();
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 {
79 public:
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);
96 public:
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);
106 bool LoadRemote();
107 void SendToRemote();
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 {
117 protected:
118 enum {
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
122 } m_state;
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
130 int m_item_count;
132 // use incremental tags algorithm
133 bool m_inc_tags;
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);
149 } else {
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;
163 break;
164 case FULL_REQ_SENT:
165 ProcessFull(packet);
166 m_state = IDLE;
167 break;
170 public:
171 CRemoteContainer(CRemoteConnect *conn, bool inc_tags)
173 m_state = IDLE;
175 m_conn = conn;
176 m_item_count = 0;
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(); }
188 uint32 GetCount()
190 return m_item_count;
193 void AddItem(T *item)
195 m_items.push_back(item);
196 m_items_hash[GetItemID(item)] = item;
197 m_item_count++;
200 T *GetByID(I id)
202 // avoid creating nodes
203 return m_items_hash.count(id) ? m_items_hash[id] : NULL;
206 void Flush()
208 m_items.clear();
209 m_items_hash.clear();
210 m_item_count = 0;
214 // Flush & reload
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)
222 CECPacket req(cmd);
223 CScopedPtr<const CECPacket> reply(this->m_conn->SendRecvPacket(&req));
224 if ( !reply.get() ) {
225 return false;
227 for(typename std::list<T *>::iterator j = this->m_items.begin(); j != this->m_items.end(); j++) {
228 this->DeleteItem(*j);
231 Flush();
233 ProcessFull(reply.get());
235 return true;
238 void FullReload(int cmd)
240 if ( this->m_state != IDLE ) {
241 return;
244 for(typename std::list<T *>::iterator j = this->m_items.begin(); j != this->m_items.end(); j++) {
245 this->DeleteItem(*j);
248 Flush();
250 CECPacket req(cmd);
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
258 // be same class
260 void DoRequery(int cmd, int tag)
262 if ( this->m_state != IDLE ) {
263 return;
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() ) {
283 return false;
286 if ( !this->Phase1Done(reply.get()) ) {
287 // if derived class choose not to proceed, return - but with good status
288 return true;
291 // Phase 2: update status, mark new files for subsequent query
292 CECPacket req_full(cmd);
294 ProcessUpdate(reply.get(), &req_full, tag);
296 reply.reset();
298 if ( !m_inc_tags ) {
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() ) {
303 return false;
305 ProcessFull(reply.get());
308 return true;
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);
324 // reduce count
325 m_item_count--;
326 // remove from map
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
330 DeleteItem(*it);
332 m_items.erase(it);
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 ) {
341 continue;
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);
349 } else {
350 // New item
351 if (full_req) {
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()));
355 } else {
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();) {
363 iterator it2 = it++;
364 if ( core_files.count(GetItemID(*it2)) == 0 ) {
365 RemoveItem(it2);
370 virtual T *CreateItem(G *)
372 return 0;
374 virtual void DeleteItem(T *)
377 virtual I GetItemID(T *)
379 return I();
381 virtual void ProcessItemUpdate(G *, T *)
385 virtual bool Phase1Done(const CECPacket *)
387 return true;
391 class CServerConnectRem : public CECPacketHandlerBase {
392 CRemoteConnect *m_Conn;
393 uint32 m_ID;
395 CServer *m_CurrServer;
397 virtual void HandlePacket(const CECPacket *packet);
399 public:
400 CServerConnectRem(CRemoteConnect *);
401 bool ReQuery();
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; }
410 // Actions
412 void ConnectToServer(CServer* server);
413 void ConnectToAnyServer();
414 void StopConnectionTry();
415 void Disconnect();
418 class CServerListRem : public CRemoteContainer<CServer, uint32, CEC_Server_Tag> {
419 uint32 m_TotalUser, m_TotalFile;
421 virtual void HandlePacket(const CECPacket *packet);
422 public:
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;
436 // Actions
438 void RemoveServer(CServer* server);
439 void UpdateServerMetFromURL(wxString url);
440 void SetStaticServer(CServer* server, bool isStatic);
441 void SetServerPrio(CServer* server, uint32 prio);
442 void SaveServerMet() {} // not needed here
443 void FilterServers() {} // not needed here
446 // template
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<CClientRef, uint32, CEC_UpDownClient_Tag> {
455 public:
456 CUpDownClientListRem(CRemoteConnect *);
458 void FilterQueues() {} // not needed here
460 // template
462 CClientRef *CreateItem(CEC_UpDownClient_Tag *);
463 void DeleteItem(CClientRef *);
464 uint32 GetItemID(CClientRef *);
465 void ProcessItemUpdate(CEC_UpDownClient_Tag *, CClientRef *);
468 class CDownQueueRem : public std::map<uint32, CPartFile*> {
469 CRemoteConnect *m_conn;
470 public:
471 CDownQueueRem(CRemoteConnect * conn) { m_conn = conn; }
473 CPartFile* GetFileByID(uint32 id);
476 // User actions
478 void Prio(CPartFile *file, uint8 prio);
479 void AutoPrio(CPartFile *file, bool flag);
480 void Category(CPartFile *file, uint8 cat);
482 void SendFileCommand(CPartFile *file, ec_tagname_t cmd);
484 // Actions
486 void StopUDPRequests() {}
487 void AddFileLinkToDownload(CED2KFileLink*, uint8);
488 bool AddLink(const wxString &link, uint8 category = 0);
489 void UnsetCompletedFilesExist();
490 void ResetCatParts(int cat);
491 void AddSearchToDownload(CSearchFile* toadd, uint8 category);
492 void ClearCompleted(const ListOfUInts32 & ecids);
495 class CSharedFilesRem : public std::map<uint32, CKnownFile*> {
496 CRemoteConnect *m_conn;
497 public:
498 CSharedFilesRem(CRemoteConnect * conn);
500 CKnownFile *GetFileByID(uint32 id);
502 void SetFilePrio(CKnownFile *file, uint8 prio);
505 // Actions
507 void AddFilesFromDirectory(const CPath&);
508 void Reload(bool sendtoserver = true, bool firstload = false);
509 bool RenameFile(CKnownFile* file, const CPath& newName);
510 void SetFileCommentRating(CKnownFile* file, const wxString& newComment, int8 newRating);
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);
517 public:
518 CKnownFilesRem(CRemoteConnect * conn);
520 CKnownFile *FindKnownFileByID(uint32 id) { return GetByID(id); }
522 uint16 requested;
523 uint32 transferred;
524 uint16 accepted;
527 // template
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 *);
539 class CIPFilterRem {
540 CRemoteConnect *m_conn;
541 public:
542 CIPFilterRem(CRemoteConnect *conn);
545 // Actions
547 void Reload();
548 void Update(wxString strURL = wxEmptyString);
549 bool IsReady() const { return true; }
552 class CSearchListRem : public CRemoteContainer<CSearchFile, uint32, CEC_SearchFile_Tag> {
553 virtual void HandlePacket(const CECPacket *);
554 public:
555 CSearchListRem(CRemoteConnect *);
557 int m_curr_search;
558 typedef std::map<long, CSearchResultList> ResultMap;
559 ResultMap m_results;
561 const CSearchResultList& GetSearchResults(long nSearchID);
562 void RemoveResults(long nSearchID);
563 const CSearchResultList& GetSearchResults(long nSearchID) const;
565 // Actions
568 wxString StartNewSearch(uint32* nSearchID, SearchType search_type,
569 const CSearchList::CSearchParams& params);
571 void StopSearch(bool globalOnly = false);
574 // template
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 CFriendListRem : public CRemoteContainer<CFriend, uint32, CEC_Friend_Tag> {
584 virtual void HandlePacket(const CECPacket *);
585 public:
586 CFriendListRem(CRemoteConnect *);
588 void AddFriend(const CClientRef& toadd);
589 void AddFriend(const CMD4Hash& userhash, uint32 lastUsedIP, uint32 lastUsedPort, const wxString& name);
590 void RemoveFriend(CFriend* toremove);
591 void RequestSharedFileList(CFriend* Friend);
592 void RequestSharedFileList(CClientRef& client);
593 void SetFriendSlot(CFriend* Friend, bool new_state);
596 // template
598 CFriend *CreateItem(CEC_Friend_Tag *);
599 void DeleteItem(CFriend *);
600 uint32 GetItemID(CFriend *);
601 void ProcessItemUpdate(CEC_Friend_Tag *, CFriend *);
604 class CStatsUpdaterRem : public CECPacketHandlerBase {
605 virtual void HandlePacket(const CECPacket *);
606 public:
607 CStatsUpdaterRem() {}
610 class CStatTreeRem : public CECPacketHandlerBase {
611 virtual void HandlePacket(const CECPacket *);
612 CRemoteConnect *m_conn;
613 public:
614 CStatTreeRem(CRemoteConnect * conn) { m_conn = conn; }
615 void DoRequery();
618 class CListenSocketRem {
619 uint32 m_peak_connections;
620 public:
621 uint32 GetPeakConnections() { return m_peak_connections; }
624 class CamuleRemoteGuiApp : public wxApp, public CamuleGuiBase, public CamuleAppCommon {
625 wxTimer* poll_timer;
627 virtual int InitGui(bool geometry_enable, wxString &geometry_string);
629 bool OnInit();
631 int OnExit();
633 void OnPollTimer(wxTimerEvent& evt);
635 void OnECConnection(wxEvent& event);
636 void OnECInitDone(wxEvent& event);
637 void OnNotifyEvent(CMuleGUIEvent& evt);
638 void OnFinishedHTTPDownload(CMuleInternalEvent& event);
640 CStatsUpdaterRem m_stats_updater;
641 public:
643 void Startup();
645 bool ShowConnectionDialog();
647 class CRemoteConnect *m_connect;
649 CEConnectDlg *dialog;
651 bool CopyTextToClipboard(wxString strText);
653 virtual int ShowAlert(wxString msg, wxString title, int flags);
655 void ShutDown(wxCloseEvent &evt);
657 CPreferencesRem *glob_prefs;
660 // Provide access to core data thru EC
661 CServerConnectRem *serverconnect;
662 CServerListRem *serverlist;
663 CDownQueueRem *downloadqueue;
664 CSharedFilesRem *sharedfiles;
665 CKnownFilesRem *knownfiles;
666 CUpDownClientListRem *clientlist;
667 CIPFilterRem *ipfilter;
668 CSearchListRem *searchlist;
669 CFriendListRem *friendlist;
670 CListenSocketRem *listensocket;
671 CStatTreeRem * stattree;
673 CStatistics *m_statistics;
675 bool AddServer(CServer *srv, bool fromUser = false);
677 uint32 GetPublicIP();
679 wxString GetLog(bool reset = false);
680 wxString GetServerLog(bool reset = false);
682 void AddServerMessageLine(wxString &msg);
683 void AddRemoteLogLine(const wxString& line);
685 void SetOSFiles(wxString ) { /* onlinesig is created on remote side */ }
687 bool IsConnected() const { return IsConnectedED2K() || IsConnectedKad(); }
688 bool IsFirewalled() const;
689 bool IsConnectedED2K() const;
690 bool IsConnectedKad() const
692 return ((m_ConnState & CONNECTED_KAD_OK)
693 || (m_ConnState & CONNECTED_KAD_FIREWALLED));
695 bool IsFirewalledKad() const { return (m_ConnState & CONNECTED_KAD_FIREWALLED) != 0; }
697 bool IsKadRunning() const { return ((m_ConnState & CONNECTED_KAD_OK)
698 || (m_ConnState & CONNECTED_KAD_FIREWALLED)
699 || (m_ConnState & CONNECTED_KAD_NOT)); }
701 // Check Kad state (UDP)
702 bool IsFirewalledKadUDP() const { return theStats::IsFirewalledKadUDP(); }
703 bool IsKadRunningInLanMode() const { return theStats::IsKadRunningInLanMode(); }
704 // Kad stats
705 uint32 GetKadUsers() const { return theStats::GetKadUsers(); }
706 uint32 GetKadFiles() const { return theStats::GetKadFiles(); }
707 uint32 GetKadIndexedSources() const { return theStats::GetKadIndexedSources(); }
708 uint32 GetKadIndexedKeywords() const{ return theStats::GetKadIndexedKeywords(); }
709 uint32 GetKadIndexedNotes() const { return theStats::GetKadIndexedNotes(); }
710 uint32 GetKadIndexedLoad() const { return theStats::GetKadIndexedLoad(); }
711 // True IP of machine
712 uint32 GetKadIPAdress() const { return theStats::GetKadIPAdress(); }
713 // Buddy status
714 uint8 GetBuddyStatus() const { return theStats::GetBuddyStatus(); }
715 uint32 GetBuddyIP() const { return theStats::GetBuddyIP(); }
716 uint32 GetBuddyPort() const { return theStats::GetBuddyPort(); }
718 void StartKad();
719 void StopKad();
721 /** Bootstraps kad from the specified IP (must be in hostorder). */
722 void BootstrapKad(uint32 ip, uint16 port);
723 /** Updates the nodes.dat file from the specified url. */
724 void UpdateNotesDat(const wxString& str);
726 void DisconnectED2K();
728 bool CryptoAvailable() const;
730 uint32 GetED2KID() const;
731 uint32 GetID() const;
732 void ShowUserCount();
734 uint8 m_ConnState;
735 uint32 m_clientID;
737 wxLocale m_locale;
738 // This KnownFile collects all currently uploading clients for display in the upload list control
739 CKnownFile * m_allUploadingKnownFile;
741 DECLARE_EVENT_TABLE()
744 DECLARE_APP(CamuleRemoteGuiApp)
746 extern CamuleRemoteGuiApp *theApp;
748 #endif /* AMULE_REMOTE_GUI_H */
750 // File_checked_for_headers