aboutsummaryrefslogtreecommitdiff
path: root/utils/domoticz/patches/992-prevent_crash_processing_py.patch
blob: 32b765323d9f28b909ff90ca3d9a4c28f566727a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
From 90e683a16ec1f267d3efd1b3fd1bff0b9ac9691e Mon Sep 17 00:00:00 2001
From: dnpwwo <kendel.boul@gmail.com>
Date: Tue, 1 Mar 2022 22:01:14 +1100
Subject: [PATCH] BugFix: Prevent crash processing Python exceptions on Linux.
 Uplift: Create Device objects using Python rather than C++

---
 main/EventsPythonDevice.h   |  2 +-
 main/EventsPythonModule.cpp | 92 ++++++++++++++++---------------------
 2 files changed, 40 insertions(+), 54 deletions(-)

--- a/main/EventsPythonDevice.h
+++ b/main/EventsPythonDevice.h
@@ -55,6 +55,6 @@
 					   nullptr,
 					   nullptr };
 
-	  static PyObject* PDeviceType;
+	  static PyTypeObject* PDeviceType;
     }
 #endif
--- a/main/EventsPythonModule.cpp
+++ b/main/EventsPythonModule.cpp
@@ -16,11 +16,11 @@ namespace Plugins
 {
 #define GETSTATE(m) ((struct eventModule_state*)PyModule_GetState(m))
 
-	void*   m_PyInterpreter;
-    bool	ModuleInitialized = false;
+	PyThreadState*	m_PyInterpreter;
+    bool			m_ModuleInitialized = false;
 
     struct eventModule_state {
-        PyObject*	error;
+		PyObject*	error;
     };
 
 	static PyMethodDef DomoticzEventsMethods[] = { 
@@ -116,7 +116,7 @@ namespace Plugins
 		PyType_Spec PDeviceSpec = { "DomoticzEvents.PDevice", sizeof(PDevice), 0,
 							  Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, PDeviceSlots };
 
-		PDeviceType = PyType_FromSpec(&PDeviceSpec);
+		PDeviceType = (PyTypeObject*)PyType_FromSpec(&PDeviceSpec);
 		PyModule_AddObject(pModule, "PDevice", (PyObject*)PDeviceType);
 
 		return pModule;
@@ -169,7 +169,7 @@ namespace Plugins
                 _log.Log(LOG_ERROR, "EventSystem - Python: Failed to initialize module.");
                 return false;
             }
-            ModuleInitialized = true;
+            m_ModuleInitialized = true;
             return true;
 	}
 
@@ -232,12 +232,6 @@ namespace Plugins
 		else
 		{
 			std::string	sTypeText("Unknown");
-			if (pExcept)
-			{
-				PyTypeObject* TypeName = (PyTypeObject*)pExcept;
-				PyNewRef	pName = PyObject_GetAttrString((PyObject*)TypeName, "__name__");
-				sTypeText = (std::string)pName;
-			}
 
 			/* See if we can get a full traceback */
 			PyNewRef	pModule = PyImport_ImportModule("traceback");
@@ -245,7 +239,7 @@ namespace Plugins
 			{
 				PyNewRef	pFunc = PyObject_GetAttrString(pModule, "format_exception");
 				if (pFunc && PyCallable_Check(pFunc)) {
-					PyNewRef	pList = PyObject_CallFunctionObjArgs(pFunc, pExcept, pValue, pTraceback, NULL);
+					PyNewRef	pList = PyObject_CallFunctionObjArgs(pFunc, (PyObject*)pExcept, (PyObject*)pValue, (PyObject*)pTraceback, NULL);
 					if (pList)
 					{
 						for (Py_ssize_t i = 0; i < PyList_Size(pList); i++)
@@ -263,16 +257,19 @@ namespace Plugins
 					}
 					else
 					{
+						if (pExcept) sTypeText = pExcept.Attribute("__name__");
 						_log.Log(LOG_ERROR, "Exception: '%s'.  No traceback available.", sTypeText.c_str());
 					}
 				}
 				else
 				{
+					if (pExcept) sTypeText = pExcept.Attribute("__name__");
 					_log.Log(LOG_ERROR, "'format_exception' lookup failed, exception: '%s'.  No traceback available.", sTypeText.c_str());
 				}
 			}
 			else
 			{
+				if (pExcept) sTypeText = pExcept.Attribute("__name__");
 				_log.Log(LOG_ERROR, "'Traceback' module import failed, exception: '%s'.  No traceback available.", sTypeText.c_str());
 			}
 		}
@@ -280,11 +277,11 @@ namespace Plugins
 	}
 
 	void PythonEventsProcessPython(const std::string &reason, const std::string &filename, const std::string &PyString,
-				       const uint64_t DeviceID, std::map<uint64_t, CEventSystem::_tDeviceStatus> m_devicestates,
-				       std::map<uint64_t, CEventSystem::_tUserVariable> m_uservariables, int intSunRise, int intSunSet)
+				       const uint64_t DeviceID, std::map<uint64_t, CEventSystem::_tDeviceStatus> deviceStates,
+				       std::map<uint64_t, CEventSystem::_tUserVariable> userVariables, int intSunRise, int intSunSet)
 	{
 
-		if (!ModuleInitialized)
+		if (!m_ModuleInitialized)
 		{
 			return;
 		}
@@ -292,7 +289,7 @@ namespace Plugins
 		if (Py_IsInitialized())
 		{
 			if (m_PyInterpreter)
-				PyEval_RestoreThread((PyThreadState *)m_PyInterpreter);
+				PyEval_RestoreThread(m_PyInterpreter);
 
 			PyBorrowedRef	pModule = PythonEventsGetModule();
 			if (pModule)
@@ -305,7 +302,7 @@ namespace Plugins
 					return;
 				}
 
-				PyNewRef	pStrVal = PyUnicode_FromString(m_devicestates[DeviceID].deviceName.c_str());
+				PyNewRef	pStrVal = PyUnicode_FromString(deviceStates[DeviceID].deviceName.c_str());
 				if (PyDict_SetItemString(pModuleDict, "changed_device_name", pStrVal) == -1)
 				{
 					_log.Log(LOG_ERROR, "Python EventSystem: Failed to set changed_device_name.");
@@ -327,22 +324,34 @@ namespace Plugins
 					return;
 				}
 
-				// Mutex
-				// boost::shared_lock<boost::shared_mutex> devicestatesMutexLock1(m_devicestatesMutex);
-
-				for (auto it_type = m_devicestates.begin(); it_type != m_devicestates.end(); ++it_type)
+				for (auto it_type = deviceStates.begin(); it_type != deviceStates.end(); ++it_type)
 				{
 					CEventSystem::_tDeviceStatus sitem = it_type->second;
-					// object deviceStatus = domoticz_module.attr("Device")(sitem.ID, sitem.deviceName, sitem.devType,
-					// sitem.subType, sitem.switchtype, sitem.nValue, sitem.nValueWording, sitem.sValue,
-					// sitem.lastUpdate); devices[sitem.deviceName] = deviceStatus;
 
-					PDevice *aDevice = (PDevice *)PDevice_new((PyTypeObject*)PDeviceType, (PyObject *)nullptr, (PyObject *)nullptr);
-					PyNewRef	pKey = PyUnicode_FromString(sitem.deviceName.c_str());
+					PyNewRef nrArgList = Py_BuildValue("(iOiiiOiOO)",	static_cast<int>(sitem.ID),
+																		PyUnicode_FromString(sitem.deviceName.c_str()),
+																		sitem.devType,
+																		sitem.subType,
+																		sitem.switchtype,
+																		PyUnicode_FromString(sitem.sValue.c_str()),
+																		sitem.nValue,
+																		PyUnicode_FromString(sitem.nValueWording.c_str()),
+																		PyUnicode_FromString(sitem.lastUpdate.c_str()));
+					if (!nrArgList)
+					{
+						_log.Log(LOG_ERROR, "Python EventSystem: Building device argument list failed for key %s.", sitem.deviceName.c_str());
+						continue;
+					}
+					PyNewRef pDevice = PyObject_CallObject((PyObject*)PDeviceType, nrArgList);
+					if (!pDevice)
+					{
+						_log.Log(LOG_ERROR, "Python EventSystem: Event Device object creation failed for key %s.", sitem.deviceName.c_str());
+						continue;
+					}
 
 					if (sitem.ID == DeviceID)
 					{
-						if (PyDict_SetItemString(pModuleDict, "changed_device", (PyObject *)aDevice) == -1)
+						if (PyDict_SetItemString(pModuleDict, "changed_device", (PyObject *)pDevice) == -1)
 						{
 							_log.Log(LOG_ERROR,
 								 "Python EventSystem: Failed to add device '%s' as changed_device.",
@@ -350,36 +359,13 @@ namespace Plugins
 						}
 					}
 
-					if (PyDict_SetItem(pDeviceDict, pKey, (PyObject *)aDevice) == -1)
+					PyNewRef	pKey = PyUnicode_FromString(sitem.deviceName.c_str());
+					if (PyDict_SetItem(pDeviceDict, pKey, (PyObject *)pDevice) == -1)
 					{
 						_log.Log(LOG_ERROR, "Python EventSystem: Failed to add device '%s' to device dictionary.",
 							 sitem.deviceName.c_str());
 					}
-					else
-					{
-
-						// _log.Log(LOG_ERROR, "Python EventSystem: nValueWording '%s' - done. ",
-						// sitem.nValueWording.c_str());
-
-						std::string temp_n_value_string = sitem.nValueWording;
-
-						// If nValueWording contains %, unicode fails?
-
-						aDevice->id = static_cast<int>(sitem.ID);
-						aDevice->name = PyUnicode_FromString(sitem.deviceName.c_str());
-						aDevice->type = sitem.devType;
-						aDevice->sub_type = sitem.subType;
-						aDevice->switch_type = sitem.switchtype;
-						aDevice->n_value = sitem.nValue;
-						aDevice->n_value_string = PyUnicode_FromString(temp_n_value_string.c_str());
-						aDevice->s_value = Plugins::PyUnicode_FromString(sitem.sValue.c_str());
-						aDevice->last_update_string = PyUnicode_FromString(sitem.lastUpdate.c_str());
-						// _log.Log(LOG_STATUS, "Python EventSystem: deviceName %s added to device dictionary",
-						// sitem.deviceName.c_str());
-					}
-					Py_DECREF(aDevice);
 				}
-				// devicestatesMutexLock1.unlock();
 
 				// Time related
 
@@ -440,7 +426,7 @@ namespace Plugins
 					return;
 				}
 
-				for (auto it_var = m_uservariables.begin(); it_var != m_uservariables.end(); ++it_var)
+				for (auto it_var = userVariables.begin(); it_var != userVariables.end(); ++it_var)
 				{
 					CEventSystem::_tUserVariable uvitem = it_var->second;
 					PyDict_SetItemString(userVariablesDict, uvitem.variableName.c_str(),