Fix Windows build for offline docs include

.github/workflows/appimage-build.yml

@@ -35,7 +35,7 @@ jobs:
             libxkbcommon0 \
             libgtk-3-bin libglib2.0-bin shared-mime-info gsettings-desktop-schemas \
             liblua5.4-dev libpci-dev libperl-dev libssl-dev libayatana-appindicator3-dev \
-            perl python3 python3-minimal python3-dev python3-cffi mono-devel desktop-file-utils \
+            perl python3 python3-minimal python3-dev python3-cffi python3-sphinx mono-devel desktop-file-utils \
             fonts-noto-color-emoji breeze-gtk-theme \
             patchelf file curl
 

.github/workflows/windows-build.yml

@@ -40,6 +40,7 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install cffi
           python -m pip install zstandard
+          python -m pip install sphinx
 
           $ProgressPreference = 'SilentlyContinue'
           function Download-WithRetry {

docs/build-docs.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+import os
+import shutil
+import subprocess
+import sys
+
+
+def main():
+    if len(sys.argv) != 4:
+        raise SystemExit("usage: build-docs.py SOURCE_DIR OUTPUT_DIR STAMP_FILE")
+
+    source_dir = os.path.abspath(sys.argv[1])
+    output_dir = os.path.abspath(sys.argv[2])
+    stamp_file = os.path.abspath(sys.argv[3])
+    doctree_dir = output_dir + ".doctrees"
+
+    shutil.rmtree(output_dir, ignore_errors=True)
+    shutil.rmtree(doctree_dir, ignore_errors=True)
+    os.makedirs(output_dir, exist_ok=True)
+
+    subprocess.run(
+        [
+            sys.executable,
+            "-m",
+            "sphinx",
+            "-b",
+            "html",
+            "-d",
+            doctree_dir,
+            source_dir,
+            output_dir,
+        ],
+        check=True,
+    )
+
+    with open(stamp_file, "w", encoding="utf-8") as stamp:
+        stamp.write("built\n")
+
+
+if __name__ == "__main__":
+    main()

docs/install-docs.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+
+import os
+import shutil
+import sys
+
+
+def main():
+    if len(sys.argv) != 4:
+        raise SystemExit("usage: install-docs.py STAMP_FILE SOURCE_DIR DATADIR")
+
+    _, source_dir, datadir = sys.argv[1:]
+    source_dir = os.path.abspath(source_dir)
+
+    if not os.path.isfile(sys.argv[1]):
+        raise SystemExit("documentation build did not produce its stamp file")
+    if not os.path.isfile(os.path.join(source_dir, "index.html")):
+        raise SystemExit("documentation build did not produce index.html")
+
+    if os.path.isabs(datadir):
+        destdir = os.environ.get("DESTDIR", "")
+        if destdir:
+            data_root = os.path.join(destdir, datadir.lstrip("/\\"))
+        else:
+            data_root = datadir
+    else:
+        data_root = os.path.join(os.environ["MESON_INSTALL_DESTDIR_PREFIX"], datadir)
+
+    destination = os.path.join(data_root, "doc", "zoitechat", "html")
+    shutil.rmtree(destination, ignore_errors=True)
+    os.makedirs(os.path.dirname(destination), exist_ok=True)
+    shutil.copytree(source_dir, destination)
+
+
+if __name__ == "__main__":
+    main()

flatpak/net.zoite.Zoitechat.json

@@ -54,6 +54,7 @@
       "buildsystem": "meson",
       "config-opts": [
         "-Ddbus-service-use-appid=true",
+        "-Dinstall-docs=false",
         "-Dwith-perl=perl",
         "-Dwith-python=python3",
         "-Dwith-lua=lua"

meson.build

@@ -35,6 +35,9 @@ config_h.set_quoted('PACKAGE_NAME', meson.project_name())
 config_h.set_quoted('GETTEXT_PACKAGE', 'zoitechat')
 config_h.set_quoted('LOCALEDIR', join_paths(get_option('prefix'),
                                  get_option('datadir'), 'locale'))
+config_h.set_quoted('ZOITECHAT_DOCDIR',
+  join_paths(get_option('prefix'), get_option('datadir'), 'doc', 'zoitechat', 'html')
+)
 config_h.set10('ENABLE_NLS', true)
 
 # Optional features
@@ -160,6 +163,41 @@ foreach ldflag : test_ldflags
 endforeach
 add_project_link_arguments(global_ldflags, language: 'c')
 
+if get_option('install-docs')
+  docs_python = find_program('python3', 'python')
+  docs_sphinx = run_command(docs_python, '-c', 'import sphinx', check: false)
+  if docs_sphinx.returncode() != 0
+    error('Sphinx is required to build the local HTML documentation. Install Sphinx or configure with -Dinstall-docs=false.')
+  endif
+
+  docs_source_dir = join_paths(meson.source_root(), 'docs')
+  docs_output_dir = join_paths(meson.build_root(), 'docs-html')
+  docs_build_script = join_paths(docs_source_dir, 'build-docs.py')
+  docs_install_script = join_paths(docs_source_dir, 'install-docs.py')
+
+  docs_target = custom_target(
+    'html-documentation',
+    output: 'html-documentation.stamp',
+    command: [
+      docs_python,
+      docs_build_script,
+      docs_source_dir,
+      docs_output_dir,
+      '@OUTPUT@',
+    ],
+    build_by_default: true,
+    build_always_stale: true,
+  )
+
+  meson.add_install_script(
+    docs_python,
+    docs_install_script,
+    docs_target,
+    docs_output_dir,
+    get_option('datadir'),
+  )
+endif
+
 subdir('src')
 if get_option('plugin')
   subdir('plugins')

meson_options.txt

@@ -33,6 +33,9 @@ option('install-appdata', type: 'boolean',
 option('install-plugin-metainfo', type: 'boolean', value: false,
   description: 'Installs metainfo files for enabled plugins, useful when distros create split packages'
 )
+option('install-docs', type: 'boolean', value: true,
+  description: 'Build and install the local HTML documentation'
+)
 
 # Plugins
 option('with-checksum', type: 'boolean',

packaging/fedora/zoitechat.spec

@@ -15,6 +15,7 @@ BuildRequires:  perl
 BuildRequires:  perl-devel
 BuildRequires:  python3
 BuildRequires:  python3-cffi
+BuildRequires:  python3-sphinx
 BuildRequires:  publicsuffix-list
 BuildRequires:  xwayland-run
 BuildRequires:  weston
@@ -87,6 +88,7 @@ xwfb-run -- /usr/bin/meson test -C %{_vpath_builddir} --num-processes %{_smp_bui
 %{_datadir}/icons/hicolor/scalable/apps/net.zoite.Zoitechat.svg
 %{_datadir}/metainfo/net.zoite.Zoitechat.appdata.xml
 %{_datadir}/metainfo/net.zoite.Zoitechat*.metainfo.xml
+%{_datadir}/doc/zoitechat/html/
 %dir %{_libdir}/zoitechat
 %dir %{_libdir}/zoitechat/plugins
 %dir %{_libdir}/zoitechat/python

src/common/ctcp.c

@@ -126,21 +126,7 @@ ctcp_handle (session *sess, char *to, char *nick, char *ip,
 		if (ctcp_check (sess, nick, word, word_eol, word[4] + ctcp_offset))
 			goto generic;
 
-		{
+		inbound_action (sess, to, nick, ip, msg + 7, FALSE, tags_data->identified, tags_data);
-			gboolean private_fromme = !serv->p_cmp (nick, serv->nick) && !is_channel (serv, to);
-
-			if (private_fromme)
-			{
-				session *target = find_dialog (serv, to);
-
-				if (target)
-					sess = target;
-				else if (serv->front_session)
-					sess = serv->front_session;
-			}
-
-			inbound_action (sess, to, nick, ip, msg + 7, private_fromme, tags_data->identified, tags_data);
-		}
 		return;
 	}
 

src/common/proto-irc.c

@@ -1368,7 +1368,7 @@ process_named_msg (session *sess, char *type, char *word[], char *word_eol[],
 						{
 							if (ignore_check (word[1], IG_PRIV))
 								return;
-							if (!serv->p_cmp (nick, serv->nick))
+							if (serv->have_echo_message && !serv->p_cmp (nick, serv->nick))
 							{
 								session *target_sess = find_dialog (serv, to);
 

src/fe-gtk/fe-gtk.h

@@ -114,7 +114,7 @@ typedef struct restore_gui
 
 	/* information stored when this tab isn't front-most */
 	GtkListStore *user_model;	/* for filling the GtkTreeView */
-	GHashTable *user_row_iters; /* User * -> persistent GtkTreeIter * */
+	GHashTable *user_row_refs;
 	void *buffer;		/* xtext_Buffer */
 	char *input_text;	/* input text buffer (while not-front tab) */
 	char *topic_text;	/* topic GtkEntry buffer */

src/fe-gtk/maingui.c

@@ -5786,9 +5786,9 @@ void
 fe_session_callback (session *sess)
 {
         gtk_xtext_buffer_free (sess->res->buffer);
-        if (sess->res->user_row_iters)
-                g_hash_table_destroy (sess->res->user_row_iters);
         g_object_unref (G_OBJECT (sess->res->user_model));
+        if (sess->res->user_row_refs)
+                g_hash_table_destroy (sess->res->user_row_refs);
 
         if (sess->res->banlist && sess->res->banlist->window)
                 mg_close_gen (NULL, sess->res->banlist->window);

src/fe-gtk/menu.c

@@ -1740,9 +1740,50 @@ menu_ctcpguiopen (void)
 	editlist_gui_open (NULL, NULL, ctcp_list, buf, "ctcpreply", "ctcpreply.conf", ctcp_help);
 }
 
+static char *
+menu_find_local_docs (void)
+{
+	char *path;
+
+#ifdef WIN32
+	char *base_path;
+
+	base_path = g_win32_get_package_installation_directory_of_module (NULL);
+	if (!base_path)
+		return NULL;
+
+	path = g_build_filename (base_path, "share", "doc", "zoitechat", "html", "index.html", NULL);
+	g_free (base_path);
+#else
+	const char *appdir;
+
+	appdir = g_getenv ("APPDIR");
+	if (appdir && *appdir)
+		path = g_build_filename (appdir, "usr", "share", "doc", "zoitechat", "html", "index.html", NULL);
+	else
+		path = g_build_filename (ZOITECHAT_DOCDIR, "index.html", NULL);
+#endif
+
+	if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
+		return path;
+
+	g_free (path);
+	return NULL;
+}
+
 static void
 menu_docs (GtkWidget *wid, gpointer none)
 {
+	char *path;
+
+	path = menu_find_local_docs ();
+	if (path)
+	{
+		fe_open_url (path);
+		g_free (path);
+		return;
+	}
+
 	fe_open_url ("https://docs.zoitechat.org/en/latest/");
 }
 

src/fe-gtk/userlistgui.c

@@ -218,49 +218,75 @@ scroll_to_iter (GtkTreeIter *iter, GtkTreeView *treeview, GtkTreeModel *model)
 static GHashTable *
 userlist_row_map_ensure (session *sess)
 {
-	if (!sess->res->user_row_iters)
+	if (!sess->res->user_row_refs)
-		sess->res->user_row_iters = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, (GDestroyNotify) gtk_tree_iter_free);
+		sess->res->user_row_refs = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, (GDestroyNotify) gtk_tree_row_reference_free);
 
-	return sess->res->user_row_iters;
+	return sess->res->user_row_refs;
 }
 
 static void
 userlist_row_map_remove (session *sess, struct User *user)
 {
-	if (!sess->res->user_row_iters)
+	if (!sess->res->user_row_refs)
 		return;
 
-	g_hash_table_remove (sess->res->user_row_iters, user);
+	g_hash_table_remove (sess->res->user_row_refs, user);
 }
 
 static void
 userlist_row_map_set (session *sess, GtkTreeModel *model, struct User *user, GtkTreeIter *iter)
 {
-	/* The shared tree view can still show another session's model while a
+	GtkTreePath *path;
-	 * tab switch is pending. Never cache an iterator from that model. */
+	GtkTreeRowReference *ref;
-	if (model != GTK_TREE_MODEL (sess->res->user_model))
+
+	path = gtk_tree_model_get_path (model, iter);
+	if (!path)
 		return;
 
-	/* GtkListStore guarantees persistent iterators until their row is
+	ref = gtk_tree_row_reference_new (model, path);
-	 * removed, including across sorting. Unlike row references, these do
+	gtk_tree_path_free (path);
-	 * not require every cached position to be updated on each insertion. */
+	if (!ref)
-	g_hash_table_replace (userlist_row_map_ensure (sess), user, gtk_tree_iter_copy (iter));
+		return;
+
+	g_hash_table_replace (userlist_row_map_ensure (sess), user, ref);
 }
 
 static gboolean
 userlist_row_map_get_iter (session *sess, GtkTreeModel *model, struct User *user, GtkTreeIter *iter)
 {
-	GtkTreeIter *cached;
+	GtkTreeRowReference *ref;
+	GtkTreePath *path;
+	struct User *row_user;
 
-	if (model != GTK_TREE_MODEL (sess->res->user_model) || !sess->res->user_row_iters)
+	if (!sess->res->user_row_refs)
 		return FALSE;
 
-	cached = g_hash_table_lookup (sess->res->user_row_iters, user);
+	ref = g_hash_table_lookup (sess->res->user_row_refs, user);
-	if (!cached)
+	if (!ref)
 		return FALSE;
 
-	/* Removal and clear invalidate the cache before deleting model rows. */
+	path = gtk_tree_row_reference_get_path (ref);
-	*iter = *cached;
+	if (!path)
+	{
+		g_hash_table_remove (sess->res->user_row_refs, user);
+		return FALSE;
+	}
+
+	if (!gtk_tree_model_get_iter (model, iter, path))
+	{
+		gtk_tree_path_free (path);
+		g_hash_table_remove (sess->res->user_row_refs, user);
+		return FALSE;
+	}
+	gtk_tree_path_free (path);
+
+	gtk_tree_model_get (model, iter, COL_USER, &row_user, -1);
+	if (row_user != user)
+	{
+		g_hash_table_remove (sess->res->user_row_refs, user);
+		return FALSE;
+	}
+
 	return TRUE;
 }
 
@@ -561,6 +587,7 @@ fe_userlist_rehash (session *sess, struct User *user)
 					  GTK_TREE_MODEL(sess->res->user_model), user, &sel);
 	if (!iter)
 		return;
+	userlist_row_map_set (sess, GTK_TREE_MODEL (sess->res->user_model), user, iter);
 
 	if (prefs.hex_away_track && user->away)
 	{
@@ -671,8 +698,8 @@ fe_userlist_insert (session *sess, struct User *newuser, gboolean sel)
 void
 fe_userlist_clear (session *sess)
 {
-	if (sess->res->user_row_iters)
+	if (sess->res->user_row_refs)
-		g_hash_table_remove_all (sess->res->user_row_iters);
+		g_hash_table_remove_all (sess->res->user_row_refs);
 	gtk_list_store_clear (sess->res->user_model);
 }
 

src/fe-gtk/xtext.c

@@ -3130,7 +3130,6 @@ gtk_xtext_class_init (GtkXTextClass * class)
 
 typedef struct chunk_s {
 	GSList *slp;
-	gboolean collect_metadata;
 	int off1, len1, emph;
 	offlen_t meta;
 } chunk_t;
@@ -3143,19 +3142,12 @@ xtext_do_chunk(chunk_t *c)
 	if (c->len1 == 0)
 		return;
 
-	/* Copying, searching and saving only need the stripped text. */
-	if (!c->collect_metadata)
-	{
-		c->len1 = 0;
-		return;
-	}
-
 	meta = g_new (offlen_t, 1);
 	meta->off = c->off1;
 	meta->len = c->len1;
 	meta->emph = c->emph;
 	meta->width = 0;
-	c->slp = g_slist_prepend (c->slp, meta);
+	c->slp = g_slist_append (c->slp, meta);
 
 	c->len1 = 0;
 }
@@ -3178,7 +3170,6 @@ gtk_xtext_strip_color (unsigned char *text, int len, unsigned char *outbuf,
 		new_str = outbuf;
 
 	c.slp = NULL;
-	c.collect_metadata = slpp != NULL;
 	c.off1 = 0;
 	c.len1 = 0;
 	c.emph = 0;
@@ -3249,7 +3240,9 @@ bad_utf8:		/* Normal ending sequence, and give up if bad utf8 */
 		*newlen = i;
 
 	if (slpp)
-		*slpp = g_slist_reverse (c.slp);
+		*slpp = c.slp;
+	else
+		g_slist_free_full (c.slp, g_free);
 
 	return new_str;
 }
@@ -4348,7 +4341,7 @@ gtk_xtext_lines_taken (xtext_buffer *buf, textentry * ent)
 
 	if (win_width >= ent->indent + ent->str_width)
 	{
-		ent->sublines = g_slist_prepend (ent->sublines, GINT_TO_POINTER (ent->str_len));
+		ent->sublines = g_slist_append (ent->sublines, GINT_TO_POINTER (ent->str_len));
 		ent->subline_count = 1;
 		return ent->subline_count;
 	}
@@ -4359,15 +4352,13 @@ gtk_xtext_lines_taken (xtext_buffer *buf, textentry * ent)
 	do
 	{
 		len = find_next_wrap (buf->xtext, ent, str, win_width, indent);
-		ent->sublines = g_slist_prepend (ent->sublines, GINT_TO_POINTER (str + len - ent->str));
+		ent->sublines = g_slist_append (ent->sublines, GINT_TO_POINTER (str + len - ent->str));
-		ent->subline_count++;
 		indent = buf->indent;
 		str += len;
 	}
 	while (str < ent->str + ent->str_len);
 
-	/* Preserve display order without walking the growing list per wrap. */
+	ent->subline_count = g_slist_length (ent->sublines);
-	ent->sublines = g_slist_reverse (ent->sublines);
 	return ent->subline_count;
 }
 

win32/copy/copy.vcxproj

@@ -30,6 +30,8 @@
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <Target Name="Build">
+    <Exec Command="&quot;$(Python3Path)\python.exe&quot; &quot;$(SolutionDir)..\docs\build-docs.py&quot; &quot;$(SolutionDir)..\docs&quot; &quot;$(ZoiteChatBuild)\$(ZoiteChatPlatform)\docs-html&quot; &quot;$(ZoiteChatBuild)\$(ZoiteChatPlatform)\html-documentation.stamp&quot;" />
+
     <ItemGroup>
       <None Include="$(DepsRoot)\bin\*atk-1.0-0.dll" />
       <None Include="$(DepsRoot)\bin\*cairo*.dll" />
@@ -82,6 +84,7 @@
       <GdkPixbufLoaderCache Include="$(DepsRoot)\lib\gdk-pixbuf-2.0\**\loaders.cache" />
 
       <FontConfig Include="$(DepsRoot)\etc\fonts\*" />
+      <Docs Include="$(ZoiteChatBuild)\$(ZoiteChatPlatform)\docs-html\**\*" />
       <Share Include="share\**\*" />
       <Locale Include="$(ZoiteChatBin)locale\**\*;$(DepsRoot)\share\locale\**\*" />
       <MSWindowsTheme Include="$(DepsRoot)\share\themes\MS-Windows\**\*" />
@@ -97,6 +100,7 @@
     <Copy SourceFiles="@(GdkPixbufLoaderCache)" DestinationFiles="@(GdkPixbufLoaderCache->'$(ZoiteChatRel)\lib\gdk-pixbuf-2.0\%(RecursiveDir)%(Filename)%(Extension)')" />
     <Copy SourceFiles="@(GSettingsSchemas)" DestinationFiles="@(GSettingsSchemas->'$(ZoiteChatRel)\share\glib-2.0\schemas\%(Filename)%(Extension)')" />
     <Copy SourceFiles="@(Share)" DestinationFiles="@(Share->'$(ZoiteChatRel)\share\%(RecursiveDir)%(Filename)%(Extension)')" />
+    <Copy SourceFiles="@(Docs)" DestinationFiles="@(Docs->'$(ZoiteChatRel)\share\doc\zoitechat\html\%(RecursiveDir)%(Filename)%(Extension)')" />
     <Copy SourceFiles="..\..\COPYING" DestinationFolder="$(ZoiteChatRel)\share\doc\zoitechat" />
     <Copy SourceFiles="$(WinSparklePath)\COPYING" DestinationFolder="$(ZoiteChatRel)\share\doc\WinSparkle" />
     <Copy SourceFiles="@(EnchantProviders)" DestinationFolder="$(ZoiteChatRel)\lib\enchant-2" />