Differential D6037 Diff 14999 src/plugins/scripting/kexiscripting/kexiscriptpart.cpp

Changeset View

Standalone View

src/plugins/scripting/kexiscripting/kexiscriptpart.cpp

Show All 15 Lines		1	/* This file is part of the KDE project
16	You should have received a copy of the GNU Library General Public License	16		You should have received a copy of the GNU Library General Public License
17	along with this library; see the file COPYING.LIB. If not, write to	17		along with this library; see the file COPYING.LIB. If not, write to
18	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,	18		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19	* Boston, MA 02110-1301, USA.	19		* Boston, MA 02110-1301, USA.
20	*/	20		*/
21		21
22	#include "kexiscriptpart.h"	22		#include "kexiscriptpart.h"
23	#include "kexiscriptdesignview.h"	23		#include "kexiscriptdesignview.h"
24	#include "kexiscriptadaptor.h"	24		//#include "kexiscriptadaptor.h"
25	#include <kexipart.h>	25		#include <kexipart.h>
26	#include <kexipartitem.h>	26		#include <kexipartitem.h>
27	#include <KexiIcon.h>	27		#include <KexiIcon.h>
28	#include <KexiView.h>	28		#include <KexiView.h>
29	#include <KexiWindow.h>	29		#include <KexiWindow.h>
30	#include <KexiMainWindowIface.h>	30		#include <KexiMainWindowIface.h>
31	#include <kexiproject.h>	31		#include <kexiproject.h>
32		32		#include <KDbConnection>
33	#include <Kross/Manager>
34	#include <Kross/ActionCollection>
35		33
36	#include <KConfig>	34		#include <KConfig>
37	#include <KConfigGroup>	35		#include <KConfigGroup>
38	#include <KSharedConfig>	36		#include <KSharedConfig>
39	#include <KMessageBox>	37		#include <KMessageBox>
40		38
41	#include <QDebug>	39		#include <QDebug>
		40		#include <QJSEngine>
		41		#include <QDomDocument>
42		42
43	KEXI_PLUGIN_FACTORY(KexiScriptPart, "kexi_scriptplugin.json")	43		KEXI_PLUGIN_FACTORY(KexiScriptPart, "kexi_scriptplugin.json")
44		44
45	/// \internal	45		/// \internal
46	class Q_DECL_HIDDEN KexiScriptPart::Private	46		class Q_DECL_HIDDEN KexiScriptPart::Private
47	{	47		{
48	public:	48		public:
49	explicit Private(KexiScriptPart* p)	49		explicit Private(KexiScriptPart* p)
50	: p(p)	50		: p(p) {}
51	, actioncollection(new Kross::ActionCollection("projectscripts"))
52	, adaptor(0) {}
53	~Private() {	51		~Private() {
54	delete actioncollection; delete adaptor;
55	}	52		}
56		53
57	KexiScriptPart* p;	54		KexiScriptPart* p;
58	Kross::ActionCollection* actioncollection;	55		//TODO KexiScriptAdaptor* adaptor;
59	KexiScriptAdaptor* adaptor;
60		56
61	Kross::Action* action(const QString &partname) {
62	Kross::Action *action = actioncollection->action(partname);
63	if (! action) {
64	if (! adaptor)
65	adaptor = new KexiScriptAdaptor();
66	action = new Kross::Action(p, partname);
67	actioncollection->addAction(action);
68	action->addObject(adaptor);
69	}
70	return action;
71	}
72	};	57		};
73		58
74	KexiScriptPart::KexiScriptPart(QObject *parent, const QVariantList& l)	59		KexiScriptPart::KexiScriptPart(QObject *parent, const QVariantList& l)
75	: KexiPart::Part(parent,	60		: KexiPart::Part(parent,
76	xi18nc("Translate this word using only lowercase alphanumeric characters (a..z, 0..9). "	61		xi18nc("Translate this word using only lowercase alphanumeric characters (a..z, 0..9). "
77	"Use '_' character instead of spaces. First character should be a..z character. "	62		"Use '_' character instead of spaces. First character should be a..z character. "
78	"If you cannot use latin characters in your language, use english word.",	63		"If you cannot use latin characters in your language, use english word.",
79	"script"),	64		"script"),
80	xi18nc("tooltip", "Create new script"),	65		xi18nc("tooltip", "Create new script"),
81	xi18nc("what's this", "Creates new script."),	66		xi18nc("what's this", "Creates new script."),
82	l)	67		l)
83	, d(new Private(this))	68		, d(new Private(this))
84	{	69		{
85	}	70		}
			staniekUnsubmitted Done Maybe we can move this code to execute() and make sure it's executed once? This way we delay the initialization. We will obviously also run this code if project-global and app-global scripts exist. Not to myself: Even later we will run this code only if there's user's consent to do it. staniek: Maybe we can move this code to execute() and make sure it's executed once? This way we delay…
86		71
87	KexiScriptPart::~KexiScriptPart()	72		KexiScriptPart::~KexiScriptPart()
88	{	73		{
89	delete d;	74		delete d;
90	}	75		}
91		76
92	bool KexiScriptPart::execute(KexiPart::Item* item, QObject* sender)	77		bool KexiScriptPart::execute(KexiPart::Item* item, QObject* sender)
			staniekUnsubmitted Done } -> \n} staniek: } -> \n}
93	{	78		{
94	Q_UNUSED(sender);	79		Q_UNUSED(sender);
95	if (!item) {	80		if (!item) {
96	qWarning() << "Invalid item.";	81		qWarning() << "Invalid item.";
97	return false;	82		return false;
98	}	83		}
99		84
100	#if 0	85		QString p = loadData(item);
101	KexiDialogBase* dialog = new KexiDialogBase(m_mainWin);
102	dialog->setId(item->identifier());
103	KexiScriptDesignView* view = dynamic_cast<KexiScriptDesignView*>(
104	createView(dialog, dialog, *item, Kexi::DesignViewMode));
105	if (! view) {
106	qWarning() << "Failed to create a view.";
107	return false;
108	}
109		86
110	Kross::Action* scriptaction = view->scriptAction();	87		qDebug() << "Executing:\n" << p;
111	if (scriptaction) {	88		if (!p.isNull()) {
			staniekUnsubmitted Done Use isEmpty() If true, should we return true? staniek: Use isEmpty() If true, should we return true?
112		89		QJSEngine e;
			staniekUnsubmitted Done Check QJSValue::isError() staniek: Check QJSValue::isError()
113	const QString dontAskAgainName = "askExecuteScript";	90		e.evaluate(p);
			staniekUnsubmitted Done Let's define and use KexiScriptingDebug the same way KexiMigrateManagerDebug is used. staniek: Let's define and use KexiScriptingDebug the same way KexiMigrateManagerDebug is used.
114	KSharedConfig::Ptr config = KSharedConfig::openConfig();	91		}
115	QString dontask = config->readEntry(dontAskAgainName).toLower();
116
117	bool exec = (dontask == "yes");
118	if (!exec && dontask != "no") {
119	exec = KMessageBox::Yes == KMessageBox::questionYesNo(view,
120	futureI18n("Do you want to execute the script \"%1\"?\n\n"
121	"Scripts obtained from unknown sources can contain dangerous code.", scriptaction->text()),
122	futureI18n("Execute Script?"), KGuiItem(futureI18nc("@action:button", "Execute"), koIconName("system-run")),
123	dontAskAgainName, KMessageBox::Notify \| KMessageBox::Dangerous
124	);
125	}
126
127	if (exec) {
128	//QTimer::singleShot(10, scriptaction, SLOT(activate()));
129	d->scriptguiclient->executeScriptAction(scriptaction);
130	}
131	}
132	view->deleteLater(); // not needed any longer.
133	#else
134
135	Kross::Action *action = d->action(item->name());
136	Q_ASSERT(action);
137	action->trigger();
138	#endif
139	return true;	92		return true;
140	}	93		}
141		94
142	void KexiScriptPart::initPartActions()	95		void KexiScriptPart::initPartActions()
143	{	96		{
144	qDebug() << ".............";	97
145	#if 0
146	if (m_mainWin) {
147	// At this stage the KexiPart::Part::m_mainWin should be defined, so
148	// that we are able to use it's KXMLGUIClient.
149
150	// Initialize the ScriptGUIClient.
151	d->scriptguiclient = new Kross::Api::ScriptGUIClient(m_mainWin);
152
153	// Publish the KexiMainWindow singelton instance. At least the KexiApp
154	// scripting-plugin depends on this instance and loading the plugin will
155	// fail if it's not avaiable.
156	if (! Kross::Api::Manager::scriptManager()->hasChild("KexiMainWindow")) {
157	Kross::Api::Manager::scriptManager()->addQObject(m_mainWin, "KexiMainWindow");
158
159	// Add the QAction's provided by the ScriptGUIClient to the
160	// KexiMainWindow.
161	//FIXME: fix+use createSharedPartAction() whyever it doesn't work as expected right now...
162	Q3PopupMenu* popup = m_mainWin->findPopupMenu("tools");
163	if (popup) {
164	QAction* execscriptaction = d->scriptguiclient->action("executescriptfile");
165	if (execscriptaction)
166	execscriptaction->plug(popup);
167	QAction* configscriptaction = d->scriptguiclient->action("configurescripts");
168	if (configscriptaction)
169	configscriptaction->plug(popup);
170	QAction* scriptmenuaction = d->scriptguiclient->action("installedscripts");
171	if (scriptmenuaction)
172	scriptmenuaction->plug(popup);
173	/*
174	QAction * execscriptmenuaction = d->scriptguiclient->action("executedscripts");
175	if(execscriptmenuaction)
176	execscriptmenuaction->plug( popup );
177	QAction * loadedscriptmenuaction = d->scriptguiclient->action("loadedscripts");
178	if(loadedscriptmenuaction)
179	loadedscriptmenuaction->plug( popup );
180	*/
181	}
182	}
183	}
184	#endif
185	}	98		}
186		99
187	void KexiScriptPart::initInstanceActions()	100		void KexiScriptPart::initInstanceActions()
			staniekUnsubmitted Done Better: xi18n("Error executing script at line %1:\n%2") staniek: Better: xi18n("Error executing script at line %1:\n%2")
188	{	101		{
189	createSharedAction(Kexi::DesignViewMode, xi18n("Configure Editor..."),	102		createSharedAction(Kexi::DesignViewMode, xi18n("Configure Editor..."),
190	koIconName("configure"), QKeySequence(), "script_config_editor");	103		koIconName("configure"), QKeySequence(), "script_config_editor");
191	}	104		}
192		105
193	KexiView* KexiScriptPart::createView(QWidget *parent,	106		KexiView* KexiScriptPart::createView(QWidget *parent,
194	KexiWindow *window,	107		KexiWindow *window,
195	KexiPart::Item *item,	108		KexiPart::Item *item,
196	Kexi::ViewMode viewMode,	109		Kexi::ViewMode viewMode,
197	QMap<QString, QVariant>* staticObjectArgs)	110		QMap<QString, QVariant>* staticObjectArgs)
198	{	111		{
199	Q_ASSERT(item);	112		Q_ASSERT(item);
200	Q_UNUSED(window);	113		Q_UNUSED(window);
201	Q_UNUSED(staticObjectArgs);	114		Q_UNUSED(staticObjectArgs);
202	qDebug() << "............. createView";	115		qDebug() << "............. createView";
203	QString partname = item->name();	116		QString partname = item->name();
204	if (! partname.isNull()) {	117		if (! partname.isNull()) {
205	Kross::Action *action = d->action(partname);
206	#if 0
207	KexiMainWindow *win = dialog->mainWin();
208	if (!win \|\| !win->project() \|\| !win->project()->dbConnection())
209	return 0;
210	Kross::Api::ScriptActionCollection* collection = d->scriptguiclient->getActionCollection("projectscripts");
211	if (! collection) {
212	collection = new Kross::Api::ScriptActionCollection(xi18n("Scripts"), d->scriptguiclient->actionCollection(), "projectscripts");
213	d->scriptguiclient->addActionCollection("projectscripts", collection);
214	}
215	const char* name = partname.toLatin1();
216	Kross::Api::ScriptAction::Ptr scriptaction = collection->action(name);
217	if (! scriptaction) {
218	scriptaction = new Kross::Api::ScriptAction(partname);
219	collection->attach(scriptaction); //!< @todo remove again on unload!
220	}
221	#endif
222	if (viewMode == Kexi::DesignViewMode) {	118		if (viewMode == Kexi::DesignViewMode) {
223	return new KexiScriptDesignView(parent, action);	119		return new KexiScriptDesignView(parent);
224	}	120		}
225	}	121		}
226	return 0;	122		return 0;
227	}	123		}
228		124
229	KLocalizedString KexiScriptPart::i18nMessage(	125		KLocalizedString KexiScriptPart::i18nMessage(
230	const QString& englishMessage, KexiWindow* window) const	126		const QString& englishMessage, KexiWindow* window) const
231	{	127		{
232	if (englishMessage == "Design of object <resource>%1</resource> has been modified.")	128		if (englishMessage == "Design of object <resource>%1</resource> has been modified.")
233	return kxi18nc(I18NC_NOOP("@info", "Design of script <resource>%1</resource> has been modified."));	129		return kxi18nc(I18NC_NOOP("@info", "Design of script <resource>%1</resource> has been modified."));
234	if (englishMessage == "Object <resource>%1</resource> already exists.")	130		if (englishMessage == "Object <resource>%1</resource> already exists.")
235	return kxi18nc(I18NC_NOOP("@info", "Script <resource>%1</resource> already exists."));	131		return kxi18nc(I18NC_NOOP("@info", "Script <resource>%1</resource> already exists."));
236	return Part::i18nMessage(englishMessage, window);	132		return Part::i18nMessage(englishMessage, window);
237	}	133		}
238		134
		135		QString KexiScriptPart::loadData(KexiPart::Item* item)
			staniekUnsubmitted Not Done We have KexiPart::Part::loadSchemaObject() dedicated for reimplementing object loading. Look e.g. how reports use it. staniek: We have KexiPart::Part::loadSchemaObject() dedicated for reimplementing object loading. Look e.
		136		{
		137		QString data;
		138		if (!item) {
		139		return QString();
		140		}
		141
		142		if (true != KexiMainWindowIface::global()->project()->dbConnection()->loadDataBlock(
			staniekUnsubmitted Not Done We have more specialized Part::loadDataBlock() staniek: We have more specialized Part::loadDataBlock()
			piggzAuthorUnsubmitted Not Done Yes, however it takes a Window. This is called only from the execute() method to execute a script without creating a window. Suggestions? piggz:* Yes, however it takes a Window*. This is called only from the execute() method to execute a…
			staniekUnsubmitted Not Done I see. KexiPart::Part::loadSchemaObject() can be still useful if implemented, right? staniek: I see. KexiPart::Part::loadSchemaObject() can be still useful if implemented, right?
		143		item->identifier(), &data))
		144		{
		145		return QString();
		146		}
		147
		148		QString errMsg;
		149		int errLine;
		150		int errCol;
		151
		152		QString scriptType;
		153
		154		QDomDocument domdoc;
		155		bool parsed = domdoc.setContent(data, false, &errMsg, &errLine, &errCol);
		156
		157		if (! parsed) {
			staniekUnsubmitted Done ! parsed -> !parsed staniek: ! parsed -> !parsed
		158		qDebug() << "XML parsing error line: " << errLine << " col: " << errCol << " message: " << errMsg;
			staniekUnsubmitted Done -> KexiScriptingWarning staniek: -> KexiScriptingWarning
		159		return QString();
		160		}
		161
		162		QDomElement scriptelem = domdoc.namedItem("script").toElement();
		163		if (scriptelem.isNull()) {
		164		qDebug() << "script domelement is null";
			staniekUnsubmitted Done -> KexiScriptingWarning staniek: -> KexiScriptingWarning
		165		return QString();
		166		}
		167
		168		scriptType = scriptelem.attribute("scripttype");
		169		if (scriptType.isEmpty()) {
		170		scriptType = "executable";
		171		}
		172
		173		if (scriptType == "executable") {
		174		return scriptelem.text().toUtf8();
		175		} else {
		176		return QString();
		177		}
		178		}
		179
239	#include "kexiscriptpart.moc"	180		#include "kexiscriptpart.moc"