source: XmlTools2/trunk/xmlpatch.cpp@ 956

Last change on this file since 956 was 956, checked in by s10k, 11 years ago

XmlTools
removed QJSEngine defines
File size: 19.8 KB
Line 
1#include "xmlpatch.h"
2
3XmlPatch::XmlPatch(QString patchFilesWildcard, QString forceTargetFilesWildcard, bool noBackups, bool noVerbose)
4{
5 this->patchFilesToProcess=UtilXmlTools::getAllPatchFilesByWildcard(patchFilesWildcard);
6 this->forceTargetFilesWildcard=forceTargetFilesWildcard;
7 this->backupsEnabled=!noBackups;
8 this->verboseEnabled=!noVerbose;
9
10 if(forceTargetFilesWildcard!=""){
11 std::cout << "User forced patch in the target file(s): " << forceTargetFilesWildcard.toUtf8().constData() << std::endl;
12 }
13
14 if(this->patchFilesToProcess.isEmpty()){
15 UtilXmlTools::displayErrorMessage("Loading patch files","No .patch or .oni-patch files were found for the wildcard: "+patchFilesWildcard);
16 }
17
18}
19
20void XmlPatch::readAndProcessPatchFile(){
21
22 // Process all PatchFiles
23 for(int i=0; i<this->patchFilesToProcess.size(); i++){
24
25 QFile inputFile(this->patchFilesToProcess[i]);
26
27 if (inputFile.open(QIODevice::ReadOnly))
28 {
29
30 QTextStream fileStream(&inputFile);
31
32 checkPatchVersion(this->patchFilesToProcess[i], fileStream);
33 checkAndProcessValidCommands(fileStream);
34
35 inputFile.close();
36 }
37 else{
38 UtilXmlTools::displayErrorMessage("Read patch file", "Error opening patch file: '" + this->patchFilesToProcess[i] + "'.\n" + inputFile.errorString());
39 }
40
41 }
42
43 UtilXmlTools::displaySuccessMessage(this->patchFilesToProcess.size(),"Patch File(s)");
44
45}
46
47void XmlPatch::insertNodesOperation(const QString &xmlString, XmlFilter &filters, const QString &xPathExpression, const QString &filesWildcard){
48
49 QStringList filesToProcess;
50 QList<pugi::xml_node> nodesToInsertion;
51 pugi::xml_document newNode;
52 pugi::xml_parse_result result;
53
54 filesToProcess=UtilXmlTools::getAllXmlFilesByWildcard(filesWildcard);
55
56 if(filesToProcess.isEmpty()){
57 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","No XML files were found for the wildcard: "+filesWildcard);
58 }
59
60 result=newNode.load(xmlString.toUtf8().constData()); // load xml to insert
61
62 if(result.status!=pugi::status_ok){
63 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES", "The xml node to insert is invalid.\n" + Util::toQString(result.description()));
64 }
65
66 // Process all XmlFiles
67 for(int i=0; i<filesToProcess.size(); i++){
68
69 UtilXmlTools::loadXmlFile(filesToProcess[i],this->document,this->rootNode,this->backupsEnabled,this->verboseEnabled,"@ADD_INSIDE_NODES");
70
71 // Check how the element will be fetched via element name or xpath expression
72 if(xPathExpression.isEmpty()){
73 UtilXmlTools::getAllNamedElements(this->rootNode,nodesToInsertion,filters);
74 }
75 else{
76 UtilXmlTools::getAllXpathElements(xPathExpression,this->document,nodesToInsertion);
77 }
78
79 if(nodesToInsertion[0].type()==pugi::node_null){
80
81 QString errMessage;
82
83 if(xPathExpression.isEmpty()){
84 errMessage = "No node was found with an ElementName: '" + filters.getElementName() + "'";
85 if(filters.getParentElementName()!=""){
86 errMessage += " and a ParentElementName: '" + filters.getParentElementName() + "'";
87 }
88 if(filters.getAttributeName()!=""){
89 errMessage += " and an AttributeName: '" + filters.getAttributeName() + "' and an AttributeValue: '" + filters.getAttributeValue() + "'";
90 }
91 }
92 else{
93 errMessage = "No node was found with an XPathExpression: '" + xPathExpression + "'";
94 }
95
96 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES",errMessage);
97 }
98
99 for(int j=0; j<nodesToInsertion.size(); j++){
100 for (pugi::xml_node currNodeToInsert = newNode.first_child(); currNodeToInsert; currNodeToInsert = currNodeToInsert.next_sibling())
101 {
102 nodesToInsertion[j].append_copy(currNodeToInsert); // append the new node
103 }
104
105 }
106
107 UtilXmlTools::saveXmlFile(filesToProcess[i],this->document, "@ADD_INSIDE_NODES");
108
109 nodesToInsertion.clear();
110 }
111
112 UtilXmlTools::displaySuccessMessage(filesToProcess.size(),"@ADD_INSIDE_NODES");
113}
114
115void XmlPatch::removeNodesOperation(XmlFilter &filters, const QString &xPathExpression, const QString &filesWildcard){
116
117 QStringList filesToProcess;
118
119 QList<pugi::xml_node> nodesToDeletion;
120
121 filesToProcess=UtilXmlTools::getAllXmlFilesByWildcard(filesWildcard);
122
123 if(filesToProcess.isEmpty()){
124 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","No XML files were found for the wildcard: "+filesWildcard);
125 }
126
127 // Process all XmlFiles
128 for(int i=0; i<filesToProcess.size(); i++){
129
130 UtilXmlTools::loadXmlFile(filesToProcess[i],this->document,this->rootNode,this->backupsEnabled,this->verboseEnabled,"@REMOVE_NODES");
131
132 // Check how the element will be fetched via element name or xpath expression
133 if(xPathExpression.isEmpty()){
134 UtilXmlTools::getAllNamedElements(this->rootNode,nodesToDeletion,filters);
135 }
136 else{
137 UtilXmlTools::getAllXpathElements(xPathExpression,this->document,nodesToDeletion);
138 }
139
140 if(nodesToDeletion[0].type()==pugi::node_null){
141
142 QString errMessage;
143
144 if(xPathExpression.isEmpty()){
145 errMessage = "No node was found with an ElementName: '" + filters.getElementName() + "'";
146 if(filters.getParentElementName()!=""){
147 errMessage += " and a ParentElementName: '" + filters.getParentElementName() + "'";
148 }
149 if(filters.getAttributeName()!=""){
150 errMessage += " and an AttributeName: '" + filters.getAttributeName() + "' and an AttributeValue: '" + filters.getAttributeValue() + "'";
151 }
152 }
153 else{
154 errMessage = "No node was found with an XPathExpression: '" + xPathExpression + "'";
155 }
156
157 UtilXmlTools::displayErrorMessage("@REMOVE_NODES",errMessage);
158 }
159
160 // Delete all the specified nodes
161 for(int j=0; j<nodesToDeletion.size(); j++){
162 if(!nodesToDeletion[j].parent().remove_child(nodesToDeletion[j])){ // remove the node
163
164 QString errMessage;
165 if(xPathExpression.isEmpty()){
166 errMessage = "Couldn't remove the node with Element '" + filters.getElementName() + "'";
167
168 if(filters.getParentElementName()!=""){
169 errMessage += " and a ParentElement: '" + filters.getParentElementName() + "'";
170 }
171 }
172 else{
173 errMessage = "Couldn't remove the node with the XPathExpression '" + xPathExpression + "'";
174 }
175
176 UtilXmlTools::displayErrorMessage("@REMOVE_NODES",errMessage);
177 }
178 }
179
180 UtilXmlTools::saveXmlFile(filesToProcess[i],this->document, "@REMOVE_NODES");
181
182 nodesToDeletion.clear();
183 }
184
185 UtilXmlTools::displaySuccessMessage(filesToProcess.size(), "@REMOVE_NODES");
186}
187
188void XmlPatch::executeCommandOperation(const QString &commandString){
189
190 // Avoid infinite fork loops
191 if(commandString.contains("-p ") || commandString.contains("--patch-files ")){
192 UtilXmlTools::displayErrorMessage("@COMMAND","Use of --patch-files option is not allowed inside a patch file");
193 }
194
195 // Reserved to AEI
196 if(commandString.contains("--aei-patch-files-list ")){
197 UtilXmlTools::displayErrorMessage("@COMMAND","Use of --aei-patch-files-list option is not allowed inside a patch file");
198 }
199
200 std::cout << "@COMMAND patch operation output:\n"
201 << "########################################################################"
202 << std::endl;
203
204 OptionsParser myParser(Util::QStringToArgsArray(commandString));
205 myParser.parse();
206
207 std::cout
208 << "########################################################################"
209 << std::endl;
210
211 UtilXmlTools::displaySuccessMessage(1,"@COMMAND");
212}
213
214QScriptValue echo(QScriptContext *context, QScriptEngine *engine)
215{
216 std::cout << context->argument(0).toString().toUtf8().constData() << std::endl;
217
218 return "";
219}
220
221void XmlPatch::executeCustomCommandOperation(const QString &jsString, const QString &filesWildcard){
222
223 QString rexmlString, jsxmlString;
224 QStringList filesToProcess=UtilXmlTools::getAllXmlFilesByWildcard(filesWildcard);
225
226 if(filesToProcess.isEmpty()){
227 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","No XML files were found for the wildcard: "+filesWildcard);
228 }
229
230 QFile rexmlfile(":/resources/libs/rexml.js");
231 QFile jsxmlfile(":/resources/libs/jsxml.js");
232
233 rexmlfile.open(QFile::ReadOnly | QFile::Text);
234 jsxmlfile.open(QFile::ReadOnly | QFile::Text);
235
236 rexmlString=QTextStream(&rexmlfile).readAll();
237 jsxmlString=QTextStream(&jsxmlfile).readAll();
238
239 // Process all XmlFiles
240#pragma omp parallel for
241 for(int i=0; i<filesToProcess.size(); i++){
242
243 QString currXmlFileString;
244
245 QScriptEngine engine;
246 QScriptValue engineResult; // variable to check for js_errors
247
248 // Add echo function so user can debug the code
249 QScriptValue echoFunction = engine.newFunction(echo);
250 engine.globalObject().setProperty("echo", echoFunction);
251
252 engine.evaluate(rexmlString); // load js libraries
253 engine.evaluate(jsxmlString);
254
255 if(this->backupsEnabled){
256 UtilXmlTools::backupFile(filesToProcess[i], this->verboseEnabled);
257 }
258
259 QFile currXmlFile(filesToProcess[i]);
260
261 if(!currXmlFile.open(QFile::ReadOnly | QFile::Text)){
262 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Error loading '" + filesToProcess[i] + "' file for read operation.");
263 }
264
265 currXmlFileString=QTextStream(&currXmlFile).readAll();
266
267 currXmlFile.close(); // close reading
268
269 engine.globalObject().setProperty("$xmlData",currXmlFileString);
270
271 // main needs to be called so the user code is evaluated
272 engineResult=engine.evaluate("main(); function main() {"+jsString+"}"); // main funtion allows to use return to exit prematurely from user code
273
274 if (engine.hasUncaughtException()) {
275 displayJsException(engine,engineResult);
276 }
277
278 if(!currXmlFile.open(QFile::WriteOnly | QFile::Text | QIODevice::Truncate)){
279 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Error loading '" + filesToProcess[i] + "' file for @CUSTOM_CODE write operation.");
280 }
281
282 engineResult=engine.globalObject().property("$xmlData");
283
284 if (engine.hasUncaughtException()) {
285 displayJsException(engine,engineResult);
286 }
287
288 QTextStream(&currXmlFile) << engineResult.toString(); // retreive the modified xml by javascript and save it to the file
289 }
290
291 UtilXmlTools::displaySuccessMessage(filesToProcess.size(), "@CUSTOM_CODE");
292}
293
294void XmlPatch::checkPatchVersion(const QString &file, QTextStream &fileStream){
295
296 QString line, patchVersion="";
297
298 // First get the patch version and check it validity
299 while ( !fileStream.atEnd() ){
300 line = fileStream.readLine();
301
302 if(line.startsWith('#')){ // Ignore comments
303 continue;
304 }
305 else if(line.startsWith("@XML_TOOLS")){
306
307 patchVersion=getPatchParameterValue(line,"Version");
308
309 if(!patchVersion.startsWith("2.0")){
310 QString errMessage;
311
312 errMessage = "The current patch version is incompatible with this XmlTools version:\n";
313 errMessage += "Patch file name: '" + file + "'\n";
314 errMessage += "XmlTools version: " + GlobalVars::AppVersion + "\n" + "CurrPatch version: " + patchVersion + "";
315 UtilXmlTools::displayErrorMessage("@XML_TOOLS",errMessage);
316 }
317 break; // We have got what we wanted
318 }
319 }
320
321 if(patchVersion==""){
322 UtilXmlTools::displayErrorMessage("@XML_TOOLS","Patch version not found.");
323 }
324
325}
326
327void XmlPatch::checkAndProcessValidCommands(QTextStream &fileStream){
328
329 QString line, filesWildcard;
330 QString xmlToInsert, command, jsCode;
331 QString xPathExpression;
332 XmlFilter filters;
333
334 // Process the rest of the commands in patch file
335 while ( !fileStream.atEnd() ){
336 line = fileStream.readLine();
337
338 if(line.startsWith('#')){ // Ignore comments
339 continue;
340 }
341 else if(line.startsWith("@ADD_INSIDE_NODES")){
342 xPathExpression=getPatchParameterValue(line,"XPathExpression");
343 filters.setElementName(getPatchParameterValue(line,"ElementName"));
344 filters.setParentElementName(getPatchParameterValue(line,"ParentElementName"));
345 filters.setAttributeName(getPatchParameterValue(line,"AttributeName"));
346 filters.setAttributeValue(getPatchParameterValue(line,"AttributeValue"));
347
348 if(this->forceTargetFilesWildcard!=""){
349 filesWildcard=this->forceTargetFilesWildcard;
350 }
351 else{
352 filesWildcard=getPatchParameterValue(line,"Files");
353 }
354
355 // Check options
356 if(xPathExpression.isEmpty() && filters.getElementName().isEmpty()){
357 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","ElementName option or XPathExpression option is required.");
358 }
359 else if(!xPathExpression.isEmpty() && !filters.getElementName().isEmpty()){
360 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","ElementName option and XPathExpression option cannot be used simultaneously.");
361 }
362 if(filters.getAttributeName()!="" && filters.getAttributeValue()==""){
363 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","AttributeValue option is required if using AttributeName option.");
364 }
365
366 if(filters.getAttributeValue()!="" && filters.getAttributeName()==""){
367 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","AttributeName option is required if using AttributeValue option.");
368 }
369
370 while ( !fileStream.atEnd() && !line.startsWith("</xml>")){
371 line = fileStream.readLine();
372
373 if(!line.startsWith("<xml>") && !line.startsWith("</xml>")){
374 xmlToInsert += line + "\n";
375 }
376 }
377
378 insertNodesOperation(xmlToInsert,filters,xPathExpression,filesWildcard);
379
380 xmlToInsert.clear();
381 filters.clear();
382 xPathExpression.clear();
383 filesWildcard.clear();
384 }
385 else if(line.startsWith("@REMOVE_NODES")){
386
387 xPathExpression=getPatchParameterValue(line,"XPathExpression");
388 filters.setElementName(getPatchParameterValue(line,"ElementName"));
389 filters.setParentElementName(getPatchParameterValue(line,"ParentElementName"));
390 filters.setAttributeName(getPatchParameterValue(line,"AttributeName"));
391 filters.setAttributeValue(getPatchParameterValue(line,"AttributeValue"));
392
393 if(this->forceTargetFilesWildcard!=""){
394 filesWildcard=this->forceTargetFilesWildcard;
395 }
396 else{
397 filesWildcard=getPatchParameterValue(line,"Files");
398 }
399
400 // Check options
401 if(xPathExpression.isEmpty() && filters.getElementName().isEmpty()){
402 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","ElementName option or XPathExpression option is required.");
403 }
404 else if(!xPathExpression.isEmpty() && !filters.getElementName().isEmpty()){
405 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","ElementName option and XPathExpression option cannot be used simultaneously.");
406 }
407
408 if(filters.getAttributeName()!="" && filters.getAttributeValue()==""){
409 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","AttributeValue option is required if using AttributeName option.");
410 }
411
412 if(filters.getAttributeValue()!="" && filters.getAttributeName()==""){
413 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","AttributeName option is required if using AttributeValue option.");
414 }
415
416 removeNodesOperation(filters,xPathExpression,filesWildcard);
417
418 filters.clear();
419 xPathExpression.clear();
420 filesWildcard.clear();
421 }
422 else if(line.startsWith("@COMMAND")){
423
424 command=GlobalVars::AppExecutable;
425
426 // Append files if forced to
427 if(!this->forceTargetFilesWildcard.isEmpty()){
428 command+=" --files '"+this->forceTargetFilesWildcard+"' ";
429 }
430
431 command+=" "+getPatchParameterValue(line,"Options");
432
433 // Add --no-backups and --no-verbose if patch was called with that arguments
434 if(!this->backupsEnabled){
435 command.append(" --no-backups");
436 }
437
438 if(!this->verboseEnabled){
439 command.append(" --no-verbose");
440 }
441
442 command.replace("'","\""); //replace apostrophe by quotes, to avoid problems
443
444 executeCommandOperation(command);
445
446 command.clear();
447 filesWildcard.clear();
448 }
449 else if(line.startsWith("@CUSTOM_CODE")){
450
451 if(this->forceTargetFilesWildcard!=""){
452 filesWildcard=this->forceTargetFilesWildcard;
453 }
454 else{
455 filesWildcard=getPatchParameterValue(line,"Files");
456 }
457
458 while ( !fileStream.atEnd() && !line.startsWith("</code>")){
459
460 line = fileStream.readLine();
461
462 if(!line.startsWith("<code>") && !line.startsWith("</code>")){
463 jsCode += line + "\n";
464 }
465 }
466
467 executeCustomCommandOperation(jsCode,filesWildcard);
468
469 jsCode.clear();
470 filesWildcard.clear();
471 }
472 }
473}
474
475QString XmlPatch::getPatchParameterValue(const QString& line, QString parameter){
476
477 int startValueIdx, endValueIdx;
478
479 parameter=" "+parameter+" "; // Parameters include a space before and after it's value.
480
481 if(!line.contains(parameter)){
482 if(parameter==" ParentElementName " || parameter==" AttributeName " || parameter==" AttributeValue "
483 || parameter==" ElementName " || parameter==" XPathExpression "){
484 return ""; // not mandatory
485 }
486 parameter.remove(" "); // just remove the space added so it doesn't look weird when outputted to the user
487
488 UtilXmlTools::displayErrorMessage("Read patch file parameter","Couldn't retrieve '" + parameter + "' parameter.");
489 }
490
491 startValueIdx=line.indexOf(parameter); // get the position where parameter is defined
492 endValueIdx=line.indexOf("\"",startValueIdx)+1; // get the position where parameter value begins (+1 to ignore mandotory quote)
493
494 startValueIdx=endValueIdx;
495 endValueIdx=line.indexOf("\"",startValueIdx); // get the last mandatory quote of the value
496
497 return line.mid(startValueIdx,endValueIdx-startValueIdx); // return the value of the parameter (is in the middle of the mandatory quotes)
498}
499
500void XmlPatch::displayJsException(QScriptEngine &engine, QScriptValue &engineResult){
501 if (engine.hasUncaughtException()) {
502 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Uncaught js exception (user code) at line " +QString::number(engine.uncaughtExceptionLineNumber()) + ":\n" + engineResult.toString());
503 }
504}
Note: See TracBrowser for help on using the repository browser.