2 // This file is part of the aMule Project.
4 // Copyright (c) 2004-2011 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 #include "ExternalConnector.h"
28 #include "config.h" // Needed for VERSION and readline detection
31 #include <common/ClientVersion.h>
32 #include <common/Format.h> // Needed for CFormat
33 #include <wx/tokenzr.h> // For wxStringTokenizer
36 #ifdef HAVE_LIBREADLINE
37 #if defined(HAVE_READLINE_READLINE_H)
38 #include <readline/readline.h> // Do_not_auto_remove
39 #elif defined(HAVE_READLINE_H)
40 #include <readline.h> // Do_not_auto_remove
41 #else /* !defined(HAVE_READLINE_H) */
42 extern "C" char *readline (const char*);
43 #endif /* !defined(HAVE_READLINE_H) */
44 #else /* !defined(HAVE_READLINE_READLINE_H) */
46 #endif /* HAVE_LIBREADLINE */
49 #ifdef HAVE_READLINE_HISTORY
50 #if defined(HAVE_READLINE_HISTORY_H)
51 #include <readline/history.h> // Do_not_auto_remove
52 #elif defined(HAVE_HISTORY_H)
53 #include <history.h> // Do_not_auto_remove
54 #else /* !defined(HAVE_HISTORY_H) */
55 extern "C" void add_history (const char*);
56 #endif /* defined(HAVE_READLINE_HISTORY_H) */
59 #endif /* HAVE_READLINE_HISTORY */
62 #include <ec/cpp/ECFileConfig.h> // Needed for CECFileConfig
63 #include <common/MD5Sum.h>
64 #include "OtherFunctions.h" // Needed for GetPassword()
66 #ifdef _MSC_VER // silly warnings about deprecated functions
67 #pragma warning(disable:4996)
70 //-------------------------------------------------------------------
72 CCommandTree::~CCommandTree()
74 DeleteContents(m_subcommands
);
78 CCommandTree
* CCommandTree::AddCommand(CCommandTree
* command
)
80 command
->m_parent
= this;
81 const wxString
& cmd
= command
->m_command
;
83 for (it
= m_subcommands
.begin(); it
!= m_subcommands
.end(); ++it
) {
84 if ((*it
)->m_command
> cmd
) {
88 m_subcommands
.insert(it
, command
);
93 int CCommandTree::FindCommandId(const wxString
& command
, wxString
& args
, wxString
& cmdstr
) const
95 wxString cmd
= command
.BeforeFirst(wxT(' ')).Lower();
96 for (CmdPosConst_t it
= m_subcommands
.begin(); it
!= m_subcommands
.end(); ++it
) {
97 if ((*it
)->m_command
.Lower() == cmd
) {
98 args
= command
.AfterFirst(wxT(' ')).Trim(false);
99 return (*it
)->FindCommandId(args
, args
, cmdstr
);
102 cmdstr
= GetFullCommand().Lower();
103 if (m_params
== CMD_PARAM_ALWAYS
&& args
.IsEmpty()) {
104 return CMD_ERR_MUST_HAVE_PARAM
;
105 } else if (m_params
== CMD_PARAM_NEVER
&& !args
.IsEmpty()) {
106 return CMD_ERR_NO_PARAM
;
108 if ((m_cmd_id
>= 0) && (m_cmd_id
& CMD_DEPRECATED
)) {
109 m_app
.Show(wxT('\n') + m_verbose
+ wxT('\n'));
110 return m_cmd_id
& ~CMD_DEPRECATED
;
118 wxString
CCommandTree::GetFullCommand() const
120 wxString cmd
= m_command
;
122 const CCommandTree
*parent
= m_parent
;
123 while (parent
&& parent
->m_parent
) {
124 cmd
= parent
->m_command
+ wxT(" ") + cmd
;
125 parent
= parent
->m_parent
;
132 void CCommandTree::PrintHelpFor(const wxString
& command
) const
134 wxString cmd
= command
.BeforeFirst(wxT(' ')).Lower();
135 if (!cmd
.IsEmpty()) {
136 for (CmdPosConst_t it
= m_subcommands
.begin(); it
!= m_subcommands
.end(); ++it
) {
137 if ((*it
)->m_command
.Lower() == cmd
) {
138 (*it
)->PrintHelpFor(command
.AfterFirst(wxT(' ')).Trim(false));
143 m_app
.Show(CFormat(_("Unknown extension '%s' for the '%s' command.\n")) % command
% GetFullCommand());
145 m_app
.Show(CFormat(_("Unknown command '%s'.\n")) % command
);
148 wxString fullcmd
= GetFullCommand();
149 if (!fullcmd
.IsEmpty()) {
150 m_app
.Show(fullcmd
.Upper() + wxT(": ") + wxGetTranslation(m_short
) + wxT("\n"));
151 if (!m_verbose
.IsEmpty()) {
152 m_app
.Show(wxT("\n"));
153 m_app
.Show(wxGetTranslation(m_verbose
));
156 if (m_params
== CMD_PARAM_NEVER
) {
157 m_app
.Show(_("\nThis command cannot have an argument.\n"));
158 } else if (m_params
== CMD_PARAM_ALWAYS
) {
159 m_app
.Show(_("\nThis command must have an argument.\n"));
161 if (m_cmd_id
== CMD_ERR_INCOMPLETE
) {
162 m_app
.Show(_("\nThis command is incomplete, you must use one of the extensions below.\n"));
164 if (!m_subcommands
.empty()) {
168 m_app
.Show(_("\nAvailable extensions:\n"));
170 m_app
.Show(_("Available commands:\n"));
172 for (it
= m_subcommands
.begin(); it
!= m_subcommands
.end(); ++it
) {
173 if (!((*it
)->m_cmd_id
>= 0 && (*it
)->m_cmd_id
& CMD_DEPRECATED
) || m_parent
) {
174 int len
= (*it
)->m_command
.Length();
181 for (it
= m_subcommands
.begin(); it
!= m_subcommands
.end(); ++it
) {
182 if (!((*it
)->m_cmd_id
>= 0 && (*it
)->m_cmd_id
& CMD_DEPRECATED
) || m_parent
) {
183 m_app
.Show((*it
)->m_command
+ wxString(wxT(' '), maxlen
- (*it
)->m_command
.Length()) + wxGetTranslation((*it
)->m_short
) + wxT("\n"));
187 m_app
.Show(CFormat(_("\nAll commands are case insensitive.\nType '%s <command>' to get detailed info on <command>.\n")) % wxT("help"));
191 m_app
.Show(wxT("\n"));
194 //-------------------------------------------------------------------
196 CaMuleExternalConnector::CaMuleExternalConnector()
197 : m_configFile(NULL
),
202 m_interactive(false),
207 m_NeedsConfigSave(false),
209 m_strFullVersion(NULL
),
210 m_strOSDescription(NULL
)
212 SetAppName(wxT("aMule")); // Do not change!
215 CaMuleExternalConnector::~CaMuleExternalConnector()
219 free(m_strFullVersion
);
220 free(m_strOSDescription
);
223 void CaMuleExternalConnector::OnInitCommandSet()
225 m_commands
.AddCommand(wxT("Quit"), CMD_ID_QUIT
, wxTRANSLATE("Exits from the application."), wxEmptyString
);
226 m_commands
.AddCommand(wxT("Exit"), CMD_ID_QUIT
, wxTRANSLATE("Exits from the application."), wxEmptyString
);
227 m_commands
.AddCommand(wxT("Help"), CMD_ID_HELP
, wxTRANSLATE("Show help."),
229 Do not translate the word 'help', it is a command to the program! */
230 wxTRANSLATE("To get help on a command, type 'help <command>'.\nTo get the full command list type 'help'.\n"));
233 void CaMuleExternalConnector::Show(const wxString
&s
)
236 printf("%s", (const char *)unicode2char(s
));
243 void CaMuleExternalConnector::ShowGreet()
245 wxString text
= GetGreetingTitle();
246 int len
= text
.Length();
247 Show(wxT('\n') + wxString(wxT('-'), 22 + len
) + wxT('\n'));
248 Show(wxT('|') + wxString(wxT(' '), 10) + text
+ wxString(wxT(' '), 10) + wxT('|') + wxT('\n'));
249 Show(wxString(wxT('-'), 22 + len
) + wxT('\n'));
250 // Do not merge the line below, or translators could translate "Help"
251 Show(CFormat(_("\nUse '%s' for command list\n\n")) % wxT("Help"));
254 void CaMuleExternalConnector::Process_Answer(const wxString
& answer
)
256 wxStringTokenizer
tokens(answer
, wxT("\n"));
257 while ( tokens
.HasMoreTokens() ) {
258 Show(wxT(" > ") + tokens
.GetNextToken() + wxT("\n"));
262 bool CaMuleExternalConnector::Parse_Command(const wxString
& buffer
)
265 wxStringTokenizer
tokens(buffer
);
266 while (tokens
.HasMoreTokens()) {
267 cmd
+= tokens
.GetNextToken() + wxT(' ');
271 int cmd_ID
= GetIDFromString(cmd
);
273 cmd_ID
= ProcessCommand(cmd_ID
);
278 m_commands
.PrintHelpFor(GetCmdArgs());
281 error
= _("Syntax error!");
283 case CMD_ERR_PROCESS_CMD
:
284 Show(_("Error processing command - should never happen! Report bug, please\n"));
286 case CMD_ERR_NO_PARAM
:
287 error
= _("This command should not have any parameters.");
289 case CMD_ERR_MUST_HAVE_PARAM
:
290 error
= _("This command must have a parameter.");
292 case CMD_ERR_INVALID_ARG
:
293 error
= _("Invalid argument.");
295 case CMD_ERR_INCOMPLETE
:
296 error
= _("This is an incomplete command.");
299 if (!error
.IsEmpty()) {
300 Show(error
+ wxT('\n'));
301 wxString
helpStr(wxT("help"));
302 if (!GetLastCmdStr().IsEmpty()) {
303 helpStr
<< wxT(' ') << GetLastCmdStr();
305 Show(CFormat(_("Type '%s' to get more help.\n")) % helpStr
);
307 return cmd_ID
== CMD_ID_QUIT
;
310 void CaMuleExternalConnector::GetCommand(const wxString
&prompt
, char* buffer
, size_t buffer_size
)
312 #ifdef HAVE_LIBREADLINE
313 char *text
= readline(unicode2char(prompt
+ wxT("$ ")));
315 (m_InputLine
== 0 || strcmp(text
,m_InputLine
) != 0)) {
322 Show(prompt
+ wxT("$ "));
323 const char *text
= fgets(buffer
, buffer_size
, stdin
); // == buffer if ok, NULL if eof
324 #endif /* HAVE_LIBREADLINE */
326 size_t len
= strlen(text
);
327 if (len
> buffer_size
- 1) {
328 len
= buffer_size
- 1;
330 if (buffer
!= text
) {
331 strncpy(buffer
, text
, len
);
335 strncpy(buffer
, "quit", buffer_size
);
339 void CaMuleExternalConnector::TextShell(const wxString
&prompt
)
344 bool The_End
= false;
346 GetCommand(prompt
, buffer
, sizeof buffer
);
347 buf
= char2unicode(buffer
);
348 The_End
= Parse_Command(buf
);
349 } while ((!The_End
) && (m_ECClient
->IsSocketConnected()));
352 void CaMuleExternalConnector::ConnectAndRun(const wxString
&ProgName
, const wxString
& ProgVersion
)
354 if (m_NeedsConfigSave
) {
360 Show(CFormat(_("This is %s %s %s\n")) % wxString::FromAscii(m_appname
) % wxT(VERSION
) % wxT(SVNDATE
));
362 Show(CFormat(_("This is %s %s\n")) % wxString::FromAscii(m_appname
) % wxT(VERSION
));
365 // HostName, Port and Password
366 if ( m_password
.IsEmpty() ) {
367 m_password
= GetPassword(true);
368 // MD5 hash for an empty string, according to rfc1321.
369 if (m_password
.Encode() == wxT("D41D8CD98F00B204E9800998ECF8427E")) {
374 if (!m_password
.IsEmpty()) {
377 Show(_("\nCreating client...\n"));
378 m_ECClient
= new CRemoteConnect(NULL
);
379 m_ECClient
->SetCapabilities(m_ZLIB
, true, false); // ZLIB, UTF8 numbers, notification
381 // ConnectToCore is blocking since m_ECClient was initialized with NULL
382 if (!m_ECClient
->ConnectToCore(m_host
, m_port
, wxT("foobar"), m_password
.Encode(), ProgName
, ProgVersion
)) {
383 // no connection => close gracefully
384 if (!m_ECClient
->GetServerReply().IsEmpty()) {
385 Show(CFormat(wxT("%s\n")) % m_ECClient
->GetServerReply());
387 Show(CFormat(_("Connection Failed. Unable to connect to %s:%d\n")) % m_host
% m_port
);
389 // Authenticate ourselves
390 // ConnectToCore() already authenticated for us.
391 //m_ECClient->ConnectionEstablished();
392 Show(m_ECClient
->GetServerReply()+wxT("\n"));
393 if (m_ECClient
->IsSocketConnected()) {
401 Show(CFormat(_("\nOk, exiting %s...\n")) % ProgName
);
405 m_ECClient
->DestroySocket();
407 Show(_("Cannot connect with an empty password.\nYou must specify a password either in config file\nor on command-line, or enter one when asked.\n\nExiting...\n"));
411 void CaMuleExternalConnector::OnInitCmdLine(wxCmdLineParser
& parser
, const char* appname
)
415 parser
.AddSwitch(wxEmptyString
, wxT("help"),
416 _("Show this help text."),
417 wxCMD_LINE_PARAM_OPTIONAL
);
418 parser
.AddOption(wxT("h"), wxT("host"),
419 _("Host where aMule is running. (default: localhost)"),
420 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_PARAM_OPTIONAL
);
421 parser
.AddOption(wxT("p"), wxT("port"),
422 _("aMule's port for External Connection. (default: 4712)"),
423 wxCMD_LINE_VAL_NUMBER
, wxCMD_LINE_PARAM_OPTIONAL
);
424 parser
.AddOption(wxT("P"), wxT("password"),
425 _("External Connection password."),
426 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_PARAM_OPTIONAL
);
427 parser
.AddOption(wxT("f"), wxT("config-file"),
428 _("Read configuration from file."),
429 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_PARAM_OPTIONAL
);
430 parser
.AddSwitch(wxT("q"), wxT("quiet"),
431 _("Do not print any output to stdout."),
432 wxCMD_LINE_PARAM_OPTIONAL
);
433 parser
.AddSwitch(wxT("v"), wxT("verbose"),
434 _("Be verbose - show also debug messages."),
435 wxCMD_LINE_PARAM_OPTIONAL
);
436 parser
.AddOption(wxT("l"), wxT("locale"),
437 _("Sets program locale (language)."),
438 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_PARAM_OPTIONAL
);
439 parser
.AddSwitch(wxT("w"), wxT("write-config"),
440 _("Write command line options to config file."),
441 wxCMD_LINE_PARAM_OPTIONAL
);
442 parser
.AddOption(wxEmptyString
, wxT("create-config-from"),
443 _("Creates config file based on aMule's config file."),
444 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_PARAM_OPTIONAL
);
445 parser
.AddSwitch(wxEmptyString
, wxT("version"),
446 _("Print program version."),
447 wxCMD_LINE_PARAM_OPTIONAL
);
450 bool CaMuleExternalConnector::OnCmdLineParsed(wxCmdLineParser
& parser
)
452 if (parser
.Found(wxT("version"))) {
453 printf("%s %s\n", m_appname
, (const char *)unicode2char(GetMuleVersion()));
457 if (!parser
.Found(wxT("config-file"), &m_configFileName
)) {
458 m_configFileName
= GetConfigDir() + wxT("remote.conf");
461 wxString aMuleConfigFile
;
462 if (parser
.Found(wxT("create-config-from"), &aMuleConfigFile
)) {
463 aMuleConfigFile
= FinalizeFilename(aMuleConfigFile
);
464 if (!::wxFileExists(aMuleConfigFile
)) {
465 fprintf(stderr
, "%s\n", (const char *)unicode2char(wxT("FATAL ERROR: File does not exist: ") + aMuleConfigFile
));
468 CECFileConfig
aMuleConfig(aMuleConfigFile
);
469 LoadAmuleConfig(aMuleConfig
);
471 m_configFile
->Flush();
477 if ( !parser
.Found(wxT("host"), &m_host
) ) {
478 if ( m_host
.IsEmpty() ) {
479 m_host
= wxT("localhost");
484 if (parser
.Found(wxT("port"), &port
)) {
489 if (parser
.Found(wxT("password"), &pass_plain
)) {
490 if (!pass_plain
.IsEmpty()) {
491 m_password
.Decode(MD5Sum(pass_plain
).GetHash());
497 if (parser
.Found(wxT("write-config"))) {
498 m_NeedsConfigSave
= true;
501 parser
.Found(wxT("locale"), &m_language
);
503 if (parser
.Found(wxT("help"))) {
508 m_KeepQuiet
= parser
.Found(wxT("quiet"));
509 m_Verbose
= parser
.Found(wxT("verbose"));
514 void CaMuleExternalConnector::LoadAmuleConfig(CECFileConfig
& cfg
)
516 m_host
= wxT("localhost");
517 m_port
= cfg
.Read(wxT("/ExternalConnect/ECPort"), 4712l);
518 cfg
.ReadHash(wxT("/ExternalConnect/ECPassword"), &m_password
);
519 m_language
= cfg
.Read(wxT("/eMule/Language"), wxEmptyString
);
523 void CaMuleExternalConnector::LoadConfigFile()
526 m_configFile
= new CECFileConfig(m_configFileName
);
529 m_language
= m_configFile
->Read(wxT("/Locale"), wxEmptyString
);
530 m_host
= m_configFile
->Read(wxT("/EC/Host"), wxEmptyString
);
531 m_port
= m_configFile
->Read(wxT("/EC/Port"), 4712l);
532 m_configFile
->ReadHash(wxT("/EC/Password"), &m_password
);
533 m_ZLIB
= m_configFile
->Read(wxT("/EC/ZLIB"), 1l) != 0;
537 void CaMuleExternalConnector::SaveConfigFile()
539 if (!wxFileName::DirExists(GetConfigDir())) {
540 wxFileName::Mkdir(GetConfigDir());
543 m_configFile
= new CECFileConfig(m_configFileName
);
546 m_configFile
->Write(wxT("/Locale"), m_language
);
547 m_configFile
->Write(wxT("/EC/Host"), m_host
);
548 m_configFile
->Write(wxT("/EC/Port"), m_port
);
549 m_configFile
->WriteHash(wxT("/EC/Password"), m_password
);
553 bool CaMuleExternalConnector::OnInit()
556 #if wxUSE_ON_FATAL_EXCEPTION
557 // catch fatal exceptions
558 wxHandleFatalExceptions(true);
562 // If we didn't know that OnInit is called only once when creating the
563 // object, it could cause a memory leak. The two pointers below should
564 // be free()'d before assigning the new value.
565 // cppcheck-suppress publicAllocationError
566 m_strFullVersion
= strdup((const char *)unicode2char(GetMuleVersion()));
567 m_strOSDescription
= strdup((const char *)unicode2char(wxGetOsDescription()));
569 // Handle uncaught exceptions
570 InstallMuleExceptionHandler();
572 bool retval
= wxApp::OnInit();
574 InitCustomLanguages();
575 SetLocale(m_language
);
579 wxString
CaMuleExternalConnector::SetLocale(const wxString
& language
)
581 if (!language
.IsEmpty()) {
582 m_language
= language
;
586 m_locale
= new wxLocale
;
587 InitLocale(*m_locale
, StrLang2wx(language
));
590 return m_locale
== NULL
? wxString() : m_locale
->GetCanonicalName();
593 #if !wxUSE_GUI && defined(__WXMAC__) && !wxCHECK_VERSION(2, 9, 0)
595 #include <wx/apptrait.h> // Do_not_auto_remove
596 #include <wx/stdpaths.h> // Do_not_auto_remove
598 class CaMuleExternalConnectorTraits
: public wxConsoleAppTraits
601 virtual wxStandardPathsBase
& GetStandardPaths()
607 static wxStandardPathsCF s_stdPaths
;
610 wxStandardPathsCF
CaMuleExternalConnectorTraits::s_stdPaths
;
612 wxAppTraits
* CaMuleExternalConnector::CreateTraits()
614 return new CaMuleExternalConnectorTraits
;
619 #if wxUSE_ON_FATAL_EXCEPTION
620 // Gracefully handle fatal exceptions and print backtrace if possible
621 void CaMuleExternalConnector::OnFatalException()
623 /* Print the backtrace */
624 fprintf(stderr
, "\n--------------------------------------------------------------------------------\n");
625 fprintf(stderr
, "A fatal error has occurred and %s has crashed.\n", m_appname
);
626 fprintf(stderr
, "Please assist us in fixing this problem by posting the backtrace below in our\n");
627 fprintf(stderr
, "'aMule Crashes' forum and include as much information as possible regarding the\n");
628 fprintf(stderr
, "circumstances of this crash. The forum is located here:\n");
629 fprintf(stderr
, " http://forum.amule.org/index.php?board=67.0\n");
630 fprintf(stderr
, "If possible, please try to generate a real backtrace of this crash:\n");
631 fprintf(stderr
, " http://wiki.amule.org/index.php/Backtraces\n\n");
632 fprintf(stderr
, "----------------------------=| BACKTRACE FOLLOWS: |=----------------------------\n");
633 fprintf(stderr
, "Current version is: %s %s\n", m_appname
, m_strFullVersion
);
634 fprintf(stderr
, "Running on: %s\n\n", m_strOSDescription
);
636 print_backtrace(1); // 1 == skip this function.
638 fprintf(stderr
, "\n--------------------------------------------------------------------------------\n");
643 void CaMuleExternalConnector::OnAssertFailure(const wxChar
*file
, int line
, const wxChar
*func
, const wxChar
*cond
, const wxChar
*msg
)
645 #if !defined wxUSE_STACKWALKER || !wxUSE_STACKWALKER
646 wxString errmsg
= CFormat( wxT("%s:%s:%d: Assertion '%s' failed. %s") ) % file
% func
% line
% cond
% ( msg
? msg
: wxT("") );
648 fprintf(stderr
, "Assertion failed: %s\n", (const char*)unicode2char(errmsg
));
650 // Skip the function-calls directly related to the assert call.
651 fprintf(stderr
, "\nBacktrace follows:\n");
653 fprintf(stderr
, "\n");
655 wxApp::OnAssertFailure(file
, line
, func
, cond
, msg
);
659 // File_checked_for_headers