Merge branch 'master' into sasl

Conflicts:
	include/znc/Client.h
	src/Client.cpp
	src/Modules.cpp
	test/integration/tests/modules.cpp

modules/modpython/CMakeLists.txt

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+# Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -75,7 +75,7 @@ target_include_directories(modpython_lib PRIVATE
 	"${CMAKE_CURRENT_BINARY_DIR}/.."
 	"${CMAKE_CURRENT_SOURCE_DIR}/.."
 	${Python3_INCLUDE_DIRS})
-target_link_libraries(modpython_lib ${znc_link} ${Python3_LDFLAGS})
+target_link_libraries(modpython_lib ZNC ${Python3_LDFLAGS})
 set_target_properties(modpython_lib PROPERTIES
 	PREFIX "_"
 	OUTPUT_NAME "znc_core"

modules/modpython/codegen.pl

@@ -1,6 +1,6 @@
 #!/usr/bin/env perl
 #
-# Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+# Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ open my $out, ">", $ARGV[1] or die;
 
 print $out <<'EOF';
 /*
- * Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+ * Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,30 +50,7 @@ print $out <<'EOF';
  ***************************************************************************/
 
 namespace {
-/*	template<class T>
-	struct pyobj_to_ptr {
-		CString m_sType;
-		SvToPtr(const CString& sType) {
-			m_sType = sType;
-		}
-		bool operator()(PyObject* py, T** result) {
-			T* x = nullptr;
-			int res = SWIG_ConvertPtr(sv, (void**)&x, SWIG_TypeQuery(m_sType.c_str()), 0);
-			if (SWIG_IsOK(res)) {
-				*result = x;
-				return true;
-			}
-			DEBUG("modpython: ");
-			return false;
-		}
-	};
-
-	CModule::EModRet SvToEModRet(PyObject* py, CModule::EModRet* result) {
-		long int x = PyLong_AsLong();
-		return static_cast<CModule::EModRet>(SvUV(sv));
-	}*/
-
-	inline swig_type_info* SWIG_pchar_descriptor(void) {
+	inline swig_type_info* ZNC_SWIG_pchar_descriptor(void) {
 		static int init = 0;
 		static swig_type_info* info = 0;
 		if (!init) {
@@ -83,7 +60,71 @@ namespace {
 		return info;
 	}
 
-	inline int SWIG_AsCharPtrAndSize(PyObject *obj, char** cptr, size_t* psize, int *alloc) {
+// SWIG 4.2.0 replaced SWIG_Python_str_AsChar with SWIG_PyUnicode_AsUTF8AndSize.
+// SWIG doesn't provide any good way to detect SWIG version (other than parsing
+// `swig -version`), but it also introduced SWIG_NULLPTR in 4.2.0.
+// So let's abuse that define to do different code for new SWIG.
+#ifdef SWIG_NULLPTR
+	// This is copied/adapted from SWIG 4.2.0 from pystrings.swg
+	inline int ZNC_SWIG_AsCharPtrAndSize(PyObject *obj, char** cptr, size_t* psize, int *alloc) {
+#if PY_VERSION_HEX>=0x03000000
+#if defined(SWIG_PYTHON_STRICT_BYTE_CHAR)
+		if (PyBytes_Check(obj))
+#else
+		if (PyUnicode_Check(obj))
+#endif
+#else
+		if (PyString_Check(obj))
+#endif
+		{
+			char *cstr; Py_ssize_t len;
+			PyObject *bytes = NULL;
+			int ret = SWIG_OK;
+			if (alloc)
+				*alloc = SWIG_OLDOBJ;
+#if PY_VERSION_HEX>=0x03000000 && defined(SWIG_PYTHON_STRICT_BYTE_CHAR)
+			if (PyBytes_AsStringAndSize(obj, &cstr, &len) == -1)
+				return SWIG_TypeError;
+#else
+			cstr = (char *)SWIG_PyUnicode_AsUTF8AndSize(obj, &len, &bytes);
+			if (!cstr)
+				return SWIG_TypeError;
+			/* The returned string is only duplicated if the char * returned is not owned and memory managed by obj */
+			if (bytes && cptr) {
+				if (alloc) {
+					//cstr = %new_copy_array(cstr, len + 1, char);
+					cstr = (char *)memcpy((char *)malloc((len + 1)*sizeof(char)), cstr, sizeof(char)*(len + 1));
+					*alloc = SWIG_NEWOBJ;
+				} else {
+					/* alloc must be set in order to clean up allocated memory */
+					return SWIG_RuntimeError;
+				}
+			}
+#endif
+			if (cptr) *cptr = cstr;
+			if (psize) *psize = len + 1;
+			Py_XDECREF(bytes);
+			return ret;
+		} else {
+			swig_type_info* pchar_descriptor = ZNC_SWIG_pchar_descriptor();
+			if (pchar_descriptor) {
+				void* vptr = 0;
+				if (SWIG_ConvertPtr(obj, &vptr, pchar_descriptor, 0) == SWIG_OK) {
+					if (cptr) *cptr = (char *) vptr;
+					if (psize) *psize = vptr ? (strlen((char *)vptr) + 1) : 0;
+					if (alloc) *alloc = SWIG_OLDOBJ;
+					return SWIG_OK;
+				}
+			}
+		}
+		return SWIG_TypeError;
+	}
+
+#else
+	// TODO: at some point drop support for SWIG<4.2.0 (drop this branch of ifdef)
+
+	// This is copied from some old SWIG version from pystrings.swg
+	inline int ZNC_SWIG_AsCharPtrAndSize(PyObject *obj, char** cptr, size_t* psize, int *alloc) {
 #if PY_VERSION_HEX>=0x03000000
 		if (PyUnicode_Check(obj))
 #else
@@ -142,7 +183,7 @@ namespace {
 #endif
 				return SWIG_OK;
 			} else {
-				swig_type_info* pchar_descriptor = SWIG_pchar_descriptor();
+				swig_type_info* pchar_descriptor = ZNC_SWIG_pchar_descriptor();
 				if (pchar_descriptor) {
 					void* vptr = 0;
 					if (SWIG_ConvertPtr(obj, &vptr, pchar_descriptor, 0) == SWIG_OK) {
@@ -155,10 +196,11 @@ namespace {
 			}
 		return SWIG_TypeError;
 	}
+#endif
 
-	inline int SWIG_AsPtr_CString (PyObject * obj, CString **val) {
+	inline int ZNC_SWIG_AsPtr_CString (PyObject * obj, CString **val) {
 		char* buf = 0 ; size_t size = 0; int alloc = SWIG_OLDOBJ;
-		if (SWIG_IsOK((SWIG_AsCharPtrAndSize(obj, &buf, &size, &alloc)))) {
+		if (SWIG_IsOK((ZNC_SWIG_AsCharPtrAndSize(obj, &buf, &size, &alloc)))) {
 			if (buf) {
 				if (val) *val = new CString(buf, size - 1);
 				if (alloc == SWIG_NEWOBJ) delete[] buf;
@@ -389,7 +431,7 @@ while (<$in>) {
 			}
 			when ('CString') {
 				say $out "\t\tCString* p = nullptr;";
-				say $out "\t\tint res = SWIG_AsPtr_CString(pyRes, &p);";
+				say $out "\t\tint res = ZNC_SWIG_AsPtr_CString(pyRes, &p);";
 				say $out "\t\tif (!SWIG_IsOK(res)) {";
 				say $out "\t\t\tDEBUG(\"modpython: \" << (GetUser() ? GetUser()->GetUsername() : CString(\"<no user>\")) << \"/\" << GetModName() << \"/$name was expected to return '$type' but error=\" << res);";
 				say $out "\t\t\tresult = $default;";

modules/modpython/functions.in

@@ -61,7 +61,10 @@ EModRet OnPrivNotice(CNick& Nick, CString& sMessage)
 EModRet OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage)
 EModRet OnTopic(CNick& Nick, CChan& Channel, CString& sTopic)
 bool OnServerCapAvailable(const CString& sCap)
+bool OnServerCap302Available(const CString& sCap, const CString& sValue)
 void OnServerCapResult(const CString& sCap, bool bSuccess)
+void OnClientAttached()
+void OnClientDetached()
 EModRet OnTimerAutoJoin(CChan& Channel)
 bool OnEmbeddedWebRequest(CWebSock& WebSock, const CString& sPageName, CTemplate& Tmpl)
 EModRet OnAddNetwork(CIRCNetwork& Network, CString& sErrorRet)

modules/modpython/modpython.i

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+ * Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -241,6 +241,10 @@ class CPyRetBool {
 	bool ExistsNV(const CString& sName) {
 		return $self->EndNV() != $self->FindNV(sName);
 	}
+    void AddServerDependentCapability(const CString& sName, PyObject* serverCb,
+                                      PyObject* clientCb) {
+        $self->AddServerDependentCapability(sName, std::make_unique<CPyCapability>(serverCb, clientCb));
+	}
 }
 
 %extend CModules {

modules/modpython/module.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+ * Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -136,7 +136,10 @@ class ZNC_EXPORT_LIB_EXPORT CPyModule : public CModule {
                          CString& sMessage) override;
     EModRet OnTopic(CNick& Nick, CChan& Channel, CString& sTopic) override;
     bool OnServerCapAvailable(const CString& sCap) override;
+    bool OnServerCap302Available(const CString& sCap, const CString& sValue) override;
     void OnServerCapResult(const CString& sCap, bool bSuccess) override;
+    void OnClientAttached() override;
+    void OnClientDetached() override;
     EModRet OnTimerAutoJoin(CChan& Channel) override;
     bool OnEmbeddedWebRequest(CWebSock&, const CString&, CTemplate&) override;
     EModRet OnAddNetwork(CIRCNetwork& Network, CString& sErrorRet) override;
@@ -374,3 +377,17 @@ inline CPyModCommand* CreatePyModCommand(CPyModule* pModule,
                                          PyObject* pyObj) {
     return new CPyModCommand(pModule, sCmd, sArgs, sDesc, pyObj);
 }
+
+class ZNC_EXPORT_LIB_EXPORT CPyCapability : public CCapability {
+  public:
+    CPyCapability(PyObject* serverCb, PyObject* clientCb);
+    ~CPyCapability();
+
+    void OnServerChangedSupport(CIRCNetwork* pNetwork, bool bState) override;
+    void OnClientChangedSupport(CClient* pClient, bool bState) override;
+
+  private:
+    PyObject* m_serverCb;
+    PyObject* m_clientCb;
+};
+

modules/modpython/ret.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+ * Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

modules/modpython/znc.py

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2004-2023 ZNC, see the NOTICE file for details.
+# Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -410,6 +410,15 @@ class Module:
     def OnServerCapAvailable(self, sCap):
         pass
 
+    def OnServerCap302Available(self, sCap, sValue):
+        return self.OnServerCapAvailable(sCap)
+
+    def OnClientAttached(self):
+        pass
+
+    def OnClientDetached(self):
+        pass
+
     def OnServerCapResult(self, sCap, bSuccess):
         pass
 
@@ -949,33 +958,6 @@ def get_mod_info(modname, retmsg, modinfo):
     return 2
 
 
-def get_mod_info_path(path, modname, modinfo):
-    try:
-        x = imp.find_module(modname, [path])
-    except ImportError:
-        return 0
-    # x == (<open file './modules/admin.so', mode 'rb' at 0x7fa2dc748d20>,
-    #       './modules/admin.so', ('.so', 'rb', 3))
-    # x == (<open file './modules/pythontest.py', mode 'U' at 0x7fa2dc748d20>,
-    #       './modules/pythontest.py', ('.py', 'U', 1))
-    if x[0] is None and x[2][2] != imp.PKG_DIRECTORY:
-        return 0
-    try:
-        pymodule = imp.load_module(modname, *x)
-    except ImportError:
-        return 0
-    finally:
-        if x[0]:
-            x[0].close()
-    if modname not in pymodule.__dict__:
-        return 0
-    cl = pymodule.__dict__[modname]
-    modinfo.SetName(modname)
-    modinfo.SetPath(pymodule.__file__)
-    gather_mod_info(cl, modinfo)
-    return 1
-
-
 CONTINUE = CModule.CONTINUE
 HALT = CModule.HALT
 HALTMODS = CModule.HALTMODS