Move the UI-independent help URL code to ui/help_url.[ch].

svn path=/trunk/; revision=44987

1 files changed, 349 insertions, 0 deletions

diff --git a/ui/help_url.c b/ui/help_url.c
new file mode 100644
index 0000000000..215264e907
--- /dev/null
+++ b/ui/help_url.c
@@ -0,0 +1,349 @@
+/* help_url.c
+ *
+ * $Id$
+ *
+ * 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
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <string.h>
+
+#include <glib.h>
+
+#include "help_url.h"
+#include "epan/filesystem.h"
+
+#ifdef HHC_DIR
+#include <windows.h>
+#include <htmlhelp.h>
+#include <wsutil/unicode-utils.h>
+#endif
+
+/*
+ * Given a filename return a filesystem URL. Relative paths are prefixed with
+ * the datafile directory path.
+ */
+gchar *
+data_file_url(const gchar *filename)
+{
+    gchar *file_path;
+    gchar *uri;
+
+    /* Absolute path? */
+#ifdef G_OS_WIN32
+    if((strlen(filename) > 2) && (filename[1] == ':')) {
+      file_path = g_strdup(filename);
+#else
+    if((strlen(filename) > 1) && (filename[0] == '/')) {
+      file_path = g_strdup(filename);
+#endif
+    } else {
+        file_path = g_strdup_printf("%s/%s", get_datafile_dir(), filename);
+    }
+
+    /* XXX - check, if the file is really existing, otherwise display a simple_dialog about the problem */
+
+    /* convert filename to uri */
+    uri = g_filename_to_uri(file_path, NULL, NULL);
+    g_free(file_path);
+    return uri;
+}
+
+const char *
+topic_online_url(topic_action_e action)
+{
+    switch(action) {
+    case(ONLINEPAGE_HOME):
+        return "http://www.wireshark.org";
+        break;
+    case(ONLINEPAGE_WIKI):
+        return "http://wiki.wireshark.org";
+        break;
+    case(ONLINEPAGE_DOWNLOAD):
+        return "http://www.wireshark.org/download.html";
+        break;
+    case(ONLINEPAGE_USERGUIDE):
+        return "http://www.wireshark.org/docs/wsug_html_chunked/";
+        break;
+    case(ONLINEPAGE_FAQ):
+        return "http://www.wireshark.org/faq.html";
+        break;
+    case(ONLINEPAGE_ASK):
+        return "http://ask.wireshark.org";
+        break;
+    case(ONLINEPAGE_SAMPLE_FILES):
+        return "http://wiki.wireshark.org/SampleCaptures";
+        break;
+    case(ONLINEPAGE_CAPTURE_SETUP):
+        return "http://wiki.wireshark.org/CaptureSetup";
+        break;
+    case(ONLINEPAGE_NETWORK_MEDIA):
+        return "http://wiki.wireshark.org/CaptureSetup/NetworkMedia";
+        break;
+    case(ONLINEPAGE_SAMPLE_CAPTURES):
+        return "http://wiki.wireshark.org/SampleCaptures";
+        break;
+    case(ONLINEPAGE_SECURITY):
+        return "http://wiki.wireshark.org/Security";
+        break;
+    case(ONLINEPAGE_CHIMNEY):
+        return "http://wiki.wireshark.org/CaptureSetup/Offloading#chimney";
+        break;
+    default:
+        return NULL;
+    }
+}
+
+/*
+ * Open the help dialog and show a specific HTML help page.
+ */
+gchar *
+user_guide_url(const gchar *page) {
+    GString *url = g_string_new("");
+    gchar *ug_url = NULL;
+
+    /*
+     * Try to open local .chm file. This is not the most intuitive way to
+     * go about this but it fits in with the rest of the _url functions.
+     */
+#ifdef HHC_DIR
+    HWND hw;
+
+    g_string_printf(url, "%s\\user-guide.chm::/wsug_chm/%s>Wireshark Help",
+        get_datafile_dir(), topic);
+
+    hw = HtmlHelpW(NULL,
+        utf_8to16(url->str),
+        HH_DISPLAY_TOPIC, 0);
+
+    g_string_free(url, TRUE /* free_segment */);
+
+    /* if the .chm file could be opened, stop here */
+    if(hw != NULL) {
+        return NULL;
+    }
+#endif /* HHC_DIR */
+
+#ifdef DOC_DIR
+    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);
+    } else {
+#endif /* ifdef DOC_DIR */
+       /* try to open the HTML page from wireshark.org instead */
+        g_string_printf(url, "http://www.wireshark.org/docs/wsug_html_chunked/%s", page);
+#ifdef DOC_DIR
+    }
+#endif /* ifdef DOC_DIR */
+
+
+    ug_url = url->str;
+    g_string_free(url, FALSE);
+    return ug_url;
+}
+
+gchar *
+topic_action_url(topic_action_e action)
+{
+    gchar *url;
+
+    /* pages online at www.wireshark.org */
+    url = g_strdup(topic_online_url(action));
+    if(url != NULL) {
+        return url;
+    }
+
+    switch(action) {
+    /* local manual pages */
+    case(LOCALPAGE_MAN_WIRESHARK):
+        url = data_file_url("wireshark.html");
+        break;
+    case(LOCALPAGE_MAN_WIRESHARK_FILTER):
+        url = data_file_url("wireshark-filter.html");
+        break;
+    case(LOCALPAGE_MAN_TSHARK):
+        url = data_file_url("tshark.html");
+        break;
+    case(LOCALPAGE_MAN_RAWSHARK):
+        url = data_file_url("rawshark.html");
+        break;
+    case(LOCALPAGE_MAN_DUMPCAP):
+        url = data_file_url("dumpcap.html");
+        break;
+    case(LOCALPAGE_MAN_MERGECAP):
+        url = data_file_url("mergecap.html");
+        break;
+    case(LOCALPAGE_MAN_EDITCAP):
+        url = data_file_url("editcap.html");
+        break;
+    case(LOCALPAGE_MAN_TEXT2PCAP):
+        url = data_file_url("text2pcap.html");
+        break;
+
+    /* local help pages (User's Guide) */
+    case(HELP_CONTENT):
+        url = user_guide_url( "index.html");
+        break;
+    case(HELP_CAPTURE_OPTIONS_DIALOG):
+        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;
+    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_MANUAL_ADDR_RESOLVE_DIALOG):
+        url = user_guide_url("ChManualAddressResolveSection.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;
+    case(HELP_CAPTURE_INTERFACES_DIALOG):
+        url = user_guide_url("ChCapInterfaceSection.html");
+        break;
+    case(HELP_CAPTURE_INFO_DIALOG):
+        url = user_guide_url("ChCapRunningSection.html");
+        break;
+    case(HELP_ENABLED_PROTOCOLS_DIALOG):
+        url = user_guide_url("ChCustProtocolDissectionSection.html");
+        break;
+    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):
+        url = user_guide_url("ChAdvFollowTCPSection.html");
+        break;
+    case(HELP_EXPERT_INFO_DIALOG):
+        url = user_guide_url("ChAdvExpert.html");
+        break;
+    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_COMPARE_FILES_DIALOG):
+        url = user_guide_url("ChStatCompareCaptureFiles.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;
+    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_CAPTURE_INTERFACES_DETAILS_DIALOG):
+        url = user_guide_url("ChCapInterfaceDetailsSection.html");
+        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):
+    case(HELP_EXPORT_BYTES_WIN32_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;
+    case(HELP_FILTER_SAVE_DIALOG):
+        url = user_guide_url("ChWorkFilterSaveSection.html");
+        break;
+
+    default:
+        g_assert_not_reached();
+    }
+
+    return url;
+}
+
+/*
+ * Editor modelines
+ *
+ * Local Variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * ex: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */