2012-09-18 21:51:22 +00:00
|
|
|
/* help_url.c
|
|
|
|
*
|
|
|
|
* Some content from gtk/help_dlg.c by Laurent Deniel <laurent.deniel@free.fr>
|
|
|
|
*
|
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
|
|
* Copyright 2000 Gerald Combs
|
|
|
|
*
|
2018-04-30 07:47:58 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
*/
|
2012-09-18 21:51:22 +00:00
|
|
|
|
2012-09-20 01:48:30 +00:00
|
|
|
#include "config.h"
|
2012-09-18 21:51:22 +00:00
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include <glib.h>
|
|
|
|
|
|
|
|
#include "help_url.h"
|
2020-10-03 02:17:00 +00:00
|
|
|
#include "urls.h"
|
2013-11-17 02:55:14 +00:00
|
|
|
#include "wsutil/filesystem.h"
|
2021-06-18 18:21:42 +00:00
|
|
|
#include <wsutil/ws_assert.h>
|
2012-09-18 21:51:22 +00:00
|
|
|
|
2019-12-02 18:43:08 +00:00
|
|
|
// To do:
|
|
|
|
// - Automatically generate part or all of this, e.g. by parsing
|
|
|
|
// the DocBook XML or the chunked HTML.
|
|
|
|
|
2012-09-18 21:51:22 +00:00
|
|
|
/*
|
|
|
|
* Open the help dialog and show a specific HTML help page.
|
|
|
|
*/
|
|
|
|
gchar *
|
|
|
|
user_guide_url(const gchar *page) {
|
|
|
|
GString *url = g_string_new("");
|
|
|
|
|
2022-08-04 18:23:59 +00:00
|
|
|
#if defined(_WIN32)
|
2012-09-18 21:51:22 +00:00
|
|
|
/*
|
2021-06-02 00:02:08 +00:00
|
|
|
* The User's Guide is in a directory named "Wireshark User's Guide" in
|
|
|
|
* the program directory.
|
2012-09-18 21:51:22 +00:00
|
|
|
*/
|
|
|
|
|
2021-06-02 00:02:08 +00:00
|
|
|
GString *ug_dir = g_string_new("");
|
|
|
|
g_string_printf(ug_dir, "%s\\Wireshark User's Guide", get_datafile_dir());
|
|
|
|
if (g_file_test(ug_dir->str, G_FILE_TEST_IS_DIR)) {
|
|
|
|
g_string_printf(url, "file:///%s/%s", ug_dir->str, page);
|
2012-09-18 21:51:22 +00:00
|
|
|
}
|
2021-06-02 00:02:08 +00:00
|
|
|
g_string_free(ug_dir, TRUE);
|
|
|
|
#elif defined(DOC_DIR)
|
2012-09-18 21:51:22 +00:00
|
|
|
if (g_file_test(DOC_DIR "/guides/wsug_html_chunked", G_FILE_TEST_IS_DIR)) {
|
|
|
|
/* try to open the HTML page from wireshark.org instead */
|
|
|
|
g_string_printf(url, "file://" DOC_DIR "/guides/wsug_html_chunked/%s", page);
|
|
|
|
}
|
2022-08-04 18:23:59 +00:00
|
|
|
#endif /* _WIN32 / DOC_DIR */
|
2012-09-18 21:51:22 +00:00
|
|
|
|
|
|
|
|
2021-06-02 00:02:08 +00:00
|
|
|
/* Fall back to wireshark.org. */
|
|
|
|
if (url->len == 0) {
|
2022-02-23 15:36:42 +00:00
|
|
|
g_string_printf(url, WS_DOCS_URL "wsug_html_chunked/%s", page);
|
2021-06-02 00:02:08 +00:00
|
|
|
}
|
2015-01-13 23:13:40 +00:00
|
|
|
return g_string_free(url, FALSE);
|
2012-09-18 21:51:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
gchar *
|
|
|
|
topic_action_url(topic_action_e action)
|
|
|
|
{
|
|
|
|
gchar *url;
|
|
|
|
|
2020-10-03 02:17:00 +00:00
|
|
|
switch(action) {
|
2012-09-18 21:51:22 +00:00
|
|
|
/* pages online at www.wireshark.org */
|
2020-10-03 02:17:00 +00:00
|
|
|
case(ONLINEPAGE_HOME):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_HOME_PAGE_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_WIKI):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_WIKI_HOME_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_DOWNLOAD):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_DOWNLOAD_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_DOCS):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_DOCS_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_USERGUIDE):
|
2022-02-23 15:36:42 +00:00
|
|
|
url = g_strdup(WS_DOCS_URL "wsug_html_chunked/");
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_FAQ):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_FAQ_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_ASK):
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_Q_AND_A_URL);
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_SAMPLE_FILES):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("SampleCaptures"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_CAPTURE_SETUP):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("CaptureSetup"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_NETWORK_MEDIA):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("CaptureSetup/NetworkMedia"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_SAMPLE_CAPTURES):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("SampleCaptures"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_SECURITY):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("Security"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
|
|
|
case(ONLINEPAGE_CHIMNEY):
|
2020-10-25 21:42:47 +00:00
|
|
|
url = g_strdup(WS_WIKI_URL("CaptureSetup/Offloading#chimney"));
|
2020-10-03 02:17:00 +00:00
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
|
|
|
|
/* local manual pages */
|
|
|
|
case(LOCALPAGE_MAN_WIRESHARK):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("wireshark.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
|
|
|
case(LOCALPAGE_MAN_WIRESHARK_FILTER):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("wireshark-filter.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
2013-06-21 15:30:08 +00:00
|
|
|
case(LOCALPAGE_MAN_CAPINFOS):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("capinfos.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
|
|
|
case(LOCALPAGE_MAN_DUMPCAP):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("dumpcap.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
2013-06-21 15:30:08 +00:00
|
|
|
case(LOCALPAGE_MAN_EDITCAP):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("editcap.html");
|
2013-06-21 15:30:08 +00:00
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(LOCALPAGE_MAN_MERGECAP):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("mergecap.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
2013-06-21 15:30:08 +00:00
|
|
|
case(LOCALPAGE_MAN_RAWSHARK):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("rawshark.html");
|
2013-06-21 15:30:08 +00:00
|
|
|
break;
|
|
|
|
case(LOCALPAGE_MAN_REORDERCAP):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("reordercap.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
|
|
|
case(LOCALPAGE_MAN_TEXT2PCAP):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("text2pcap.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
2013-06-21 15:30:08 +00:00
|
|
|
case(LOCALPAGE_MAN_TSHARK):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("tshark.html");
|
2013-06-21 15:30:08 +00:00
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
|
|
|
|
/* local help pages (User's Guide) */
|
|
|
|
case(HELP_CONTENT):
|
|
|
|
url = user_guide_url( "index.html");
|
|
|
|
break;
|
2019-12-02 18:43:08 +00:00
|
|
|
case(HELP_CAPTURE_OPTIONS):
|
2012-09-18 21:51:22 +00:00
|
|
|
url = user_guide_url("ChCapCaptureOptions.html");
|
|
|
|
break;
|
|
|
|
case(HELP_CAPTURE_FILTERS_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkDefineFilterSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_DISPLAY_FILTERS_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkDefineFilterSection.html");
|
|
|
|
break;
|
2015-06-01 23:29:17 +00:00
|
|
|
case(HELP_FILTER_EXPRESSION_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkFilterAddExpressionSection.html");
|
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_COLORING_RULES_DIALOG):
|
|
|
|
url = user_guide_url("ChCustColorizationSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_CONFIG_PROFILES_DIALOG):
|
|
|
|
url = user_guide_url("ChCustConfigProfilesSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_PRINT_DIALOG):
|
|
|
|
url = user_guide_url("ChIOPrintSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_FIND_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkFindPacketSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_FIREWALL_DIALOG):
|
|
|
|
url = user_guide_url("ChUseToolsMenuSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_GOTO_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkGoToPacketSection.html");
|
|
|
|
break;
|
2019-12-02 18:43:08 +00:00
|
|
|
case(HELP_CAPTURE_OPTIONS_DIALOG):
|
|
|
|
url = user_guide_url("ChCapCaptureOptions.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
|
|
|
case(HELP_CAPTURE_INFO_DIALOG):
|
|
|
|
url = user_guide_url("ChCapRunningSection.html");
|
|
|
|
break;
|
2014-08-14 20:20:09 +00:00
|
|
|
case(HELP_CAPTURE_MANAGE_INTERFACES_DIALOG):
|
|
|
|
url = user_guide_url("ChCapManageInterfacesSection.html");
|
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_ENABLED_PROTOCOLS_DIALOG):
|
|
|
|
url = user_guide_url("ChCustProtocolDissectionSection.html");
|
|
|
|
break;
|
2015-07-05 21:31:14 +00:00
|
|
|
case(HELP_ENABLED_HEURISTICS_DIALOG):
|
|
|
|
url = user_guide_url("ChCustProtocolDissectionSection.html");
|
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_DECODE_AS_DIALOG):
|
|
|
|
url = user_guide_url("ChCustProtocolDissectionSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_DECODE_AS_SHOW_DIALOG):
|
|
|
|
url = user_guide_url("ChCustProtocolDissectionSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_FOLLOW_STREAM_DIALOG):
|
2018-06-21 17:45:31 +00:00
|
|
|
url = user_guide_url("ChAdvFollowStreamSection.html");
|
2012-09-18 21:51:22 +00:00
|
|
|
break;
|
2016-02-07 21:15:12 +00:00
|
|
|
case(HELP_SHOW_PACKET_BYTES_DIALOG):
|
|
|
|
url = user_guide_url("ChAdvShowPacketBytes.html");
|
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_EXPERT_INFO_DIALOG):
|
|
|
|
url = user_guide_url("ChAdvExpert.html");
|
|
|
|
break;
|
2015-04-28 08:26:46 +00:00
|
|
|
case(HELP_EXTCAP_OPTIONS_DIALOG):
|
2019-10-10 15:34:46 +00:00
|
|
|
url = data_file_url("extcap.html");
|
2015-04-28 08:26:46 +00:00
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_STATS_SUMMARY_DIALOG):
|
|
|
|
url = user_guide_url("ChStatSummary.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_PROTO_HIERARCHY_DIALOG):
|
|
|
|
url = user_guide_url("ChStatHierarchy.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_ENDPOINTS_DIALOG):
|
|
|
|
url = user_guide_url("ChStatEndpoints.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_CONVERSATIONS_DIALOG):
|
|
|
|
url = user_guide_url("ChStatConversations.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_IO_GRAPH_DIALOG):
|
|
|
|
url = user_guide_url("ChStatIOGraphs.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_LTE_MAC_TRAFFIC_DIALOG):
|
|
|
|
url = user_guide_url("ChTelLTEMACTraffic.html");
|
|
|
|
break;
|
|
|
|
case(HELP_STATS_LTE_RLC_TRAFFIC_DIALOG):
|
|
|
|
url = user_guide_url("ChTelLTERLCTraffic.html");
|
|
|
|
break;
|
2018-03-21 22:03:53 +00:00
|
|
|
case(HELP_STATS_TCP_STREAM_GRAPHS_DIALOG):
|
|
|
|
url = user_guide_url("ChStatTCPStreamGraphs.html");
|
|
|
|
break;
|
2012-09-18 21:51:22 +00:00
|
|
|
case(HELP_STATS_WLAN_TRAFFIC_DIALOG):
|
|
|
|
url = user_guide_url("ChStatWLANTraffic.html");
|
|
|
|
break;
|
|
|
|
case(HELP_FILESET_DIALOG):
|
|
|
|
url = user_guide_url("ChIOFileSetSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG):
|
|
|
|
url = user_guide_url("ChCustPreferencesSection.html#ChCustInterfaceOptionsSection");
|
|
|
|
break;
|
|
|
|
case(HELP_PREFERENCES_DIALOG):
|
|
|
|
url = user_guide_url("ChCustPreferencesSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_EXPORT_FILE_DIALOG):
|
|
|
|
case(HELP_EXPORT_FILE_WIN32_DIALOG):
|
|
|
|
url = user_guide_url("ChIOExportSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_EXPORT_BYTES_DIALOG):
|
|
|
|
url = user_guide_url("ChIOExportSection.html#ChIOExportSelectedDialog");
|
|
|
|
break;
|
|
|
|
case(HELP_EXPORT_OBJECT_LIST):
|
|
|
|
url = user_guide_url("ChIOExportSection.html#ChIOExportObjectsDialog");
|
|
|
|
break;
|
|
|
|
case(HELP_OPEN_DIALOG):
|
|
|
|
case(HELP_OPEN_WIN32_DIALOG):
|
|
|
|
url = user_guide_url("ChIOOpenSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_MERGE_DIALOG):
|
|
|
|
case(HELP_MERGE_WIN32_DIALOG):
|
|
|
|
url = user_guide_url("ChIOMergeSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_IMPORT_DIALOG):
|
|
|
|
url = user_guide_url("ChIOImportSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_SAVE_DIALOG):
|
|
|
|
case(HELP_SAVE_WIN32_DIALOG):
|
|
|
|
url = user_guide_url("ChIOSaveSection.html");
|
|
|
|
break;
|
|
|
|
case(HELP_TIME_SHIFT_DIALOG):
|
|
|
|
url = user_guide_url("ChWorkShiftTimePacketSection.html");
|
|
|
|
break;
|
2014-11-19 00:21:42 +00:00
|
|
|
case(HELP_TELEPHONY_VOIP_CALLS_DIALOG):
|
|
|
|
url = user_guide_url("ChTelVoipCalls.html");
|
|
|
|
break;
|
2021-04-09 23:26:17 +00:00
|
|
|
case(HELP_TELEPHONY_RTP_ANALYSIS_DIALOG):
|
2015-01-15 01:25:56 +00:00
|
|
|
url = user_guide_url("ChTelRTPAnalysis.html");
|
|
|
|
break;
|
2021-04-09 23:26:17 +00:00
|
|
|
case(HELP_TELEPHONY_RTP_STREAMS_DIALOG):
|
|
|
|
url = user_guide_url("ChTelRTPStreams.html");
|
|
|
|
break;
|
2015-02-11 23:00:27 +00:00
|
|
|
case(HELP_NEW_PACKET_DIALOG):
|
2015-09-13 09:13:17 +00:00
|
|
|
url = user_guide_url("ChapterWork.html#ChWorkPacketSepView");
|
|
|
|
break;
|
2015-09-03 18:18:13 +00:00
|
|
|
case(HELP_IAX2_ANALYSIS_DIALOG):
|
|
|
|
url = user_guide_url("ChTelIAX2Analysis.html");
|
2015-09-13 09:13:17 +00:00
|
|
|
break;
|
2014-12-13 00:51:40 +00:00
|
|
|
case(HELP_TELEPHONY_RTP_PLAYER_DIALOG):
|
|
|
|
url = user_guide_url("ChTelRtpPlayer.html");
|
|
|
|
break;
|
2021-04-09 23:26:17 +00:00
|
|
|
case(HELP_STAT_FLOW_GRAPH):
|
|
|
|
url = user_guide_url("ChStatFlowGraph.html");
|
|
|
|
break;
|
2014-12-13 00:51:40 +00:00
|
|
|
|
2012-10-15 18:32:51 +00:00
|
|
|
case(TOPIC_ACTION_NONE):
|
2012-09-18 21:51:22 +00:00
|
|
|
default:
|
2020-10-04 19:56:52 +00:00
|
|
|
url = g_strdup(WS_HOME_PAGE_URL);
|
2022-01-17 10:49:02 +00:00
|
|
|
ws_assert_not_reached();
|
2012-09-18 21:51:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return url;
|
|
|
|
}
|