source: XmlTools2/trunk/xmlpatch.cpp@ 943

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

XmlTools
Oni's Mac folder use a special character (U+0192), because of this I had to change all encoding transformations to UTF8
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 = "It wasn't found any node with a 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 = "It wasn't found any node with a 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 = "It wasn't found any node with a 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 = "It wasn't found any node with a 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
214void XmlPatch::executeCustomCommandOperation(const QString &jsString, const QString &filesWildcard){
215
216 QStringList filesToProcess;
217#ifdef _USE_OLD_JS_ENGINE
218 QScriptEngine engine;
219 QScriptValue engineResult; // variable to check for js_errors
220#else
221 QJSEngine engine;
222 QJSValue engineResult; // variable to check for js_errors
223#endif
224
225 QString rexmlString, jsxmlString, currXmlFileString;
226
227
228 QFile rexmlfile(":/resources/libs/rexml.js");
229 QFile jsxmlfile(":/resources/libs/jsxml.js");
230
231 filesToProcess=UtilXmlTools::getAllXmlFilesByWildcard(filesWildcard);
232
233 if(filesToProcess.isEmpty()){
234 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","No XML files were found for the wildcard: "+filesWildcard);
235 }
236
237 rexmlfile.open(QFile::ReadOnly | QFile::Text);
238 jsxmlfile.open(QFile::ReadOnly | QFile::Text);
239
240 rexmlString=QTextStream(&rexmlfile).readAll();
241 jsxmlString=QTextStream(&jsxmlfile).readAll();
242
243 engine.evaluate(rexmlString); // load js libraries
244 engine.evaluate(jsxmlString);
245
246 // Process all XmlFiles
247 for(int i=0; i<filesToProcess.size(); i++){
248
249 if(this->backupsEnabled){
250 UtilXmlTools::backupFile(filesToProcess[i], this->verboseEnabled);
251 }
252
253 QFile currXmlFile(filesToProcess[i]);
254
255 if(!currXmlFile.open(QFile::ReadOnly | QFile::Text)){
256 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Error loading '" + filesToProcess[i] + "' file for read operation.");
257 }
258
259 currXmlFileString=QTextStream(&currXmlFile).readAll();
260
261 currXmlFile.close(); // close reading
262
263 engine.globalObject().setProperty("$xmlData",currXmlFileString);
264
265 engineResult=engine.evaluate(jsString);
266
267#ifdef _USE_OLD_JS_ENGINE
268 if (engine.hasUncaughtException()) {
269 displayJsException(engine,engineResult);
270 }
271#else
272 checkForJsException(engineResult);
273#endif
274
275 if(!currXmlFile.open(QFile::WriteOnly | QFile::Text | QIODevice::Truncate)){
276 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Error loading '" + filesToProcess[i] + "' file for @CUSTOM_CODE write operation.");
277 }
278
279 engineResult=engine.globalObject().property("$xmlData");
280
281#ifdef _USE_OLD_JS_ENGINE
282 if (engine.hasUncaughtException()) {
283 displayJsException(engine,engineResult);
284 }
285#else
286 checkForJsException(engineResult);
287#endif
288
289 QTextStream(&currXmlFile) << engineResult.toString(); // retreive the modified xml by javascript and save it to the file
290 }
291
292 UtilXmlTools::displaySuccessMessage(filesToProcess.size(), "@CUSTOM_CODE");
293}
294
295void XmlPatch::checkPatchVersion(const QString &file, QTextStream &fileStream){
296
297 QString line, patchVersion="";
298
299 // First get the patch version and check it validity
300 while ( !fileStream.atEnd() ){
301 line = fileStream.readLine();
302
303 if(line.startsWith('#')){ // Ignore comments
304 continue;
305 }
306 else if(line.startsWith("@XML_TOOLS")){
307
308 patchVersion=getPatchParameterValue(line,"Version");
309
310 if(!patchVersion.startsWith("2.0")){
311 QString errMessage;
312
313 errMessage = "The current patch version is incompatible with this XmlTools version:\n";
314 errMessage += "Patch file name: '" + file + "'\n";
315 errMessage += "XmlTools version: " + GlobalVars::AppVersion + "\n" + "CurrPatch version: " + patchVersion + "";
316 UtilXmlTools::displayErrorMessage("@XML_TOOLS",errMessage);
317 }
318 break; // We have got what we wanted
319 }
320 }
321
322 if(patchVersion==""){
323 UtilXmlTools::displayErrorMessage("@XML_TOOLS","Patch version not found.");
324 }
325
326}
327
328void XmlPatch::checkAndProcessValidCommands(QTextStream &fileStream){
329
330 QString line, filesWildcard;
331 QString xmlToInsert, command, jsCode;
332 QString xPathExpression;
333 XmlFilter filters;
334
335 // Process the rest of the commands in patch file
336 while ( !fileStream.atEnd() ){
337 line = fileStream.readLine();
338
339 if(line.startsWith('#')){ // Ignore comments
340 continue;
341 }
342 else if(line.startsWith("@ADD_INSIDE_NODES")){
343 xPathExpression=getPatchParameterValue(line,"XPathExpression");
344 filters.setElementName(getPatchParameterValue(line,"ElementName"));
345 filters.setParentElementName(getPatchParameterValue(line,"ParentElementName"));
346 filters.setAttributeName(getPatchParameterValue(line,"AttributeName"));
347 filters.setAttributeValue(getPatchParameterValue(line,"AttributeValue"));
348
349 if(this->forceTargetFilesWildcard!=""){
350 filesWildcard=this->forceTargetFilesWildcard;
351 }
352 else{
353 filesWildcard=getPatchParameterValue(line,"Files");
354 }
355
356 // Check options
357 if(xPathExpression.isEmpty() && filters.getElementName().isEmpty()){
358 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","ElementName option or XPathExpression option is required.");
359 }
360 else if(!xPathExpression.isEmpty() && !filters.getElementName().isEmpty()){
361 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","ElementName option and XPathExpression options cannot be used simultaneously.");
362 }
363 if(filters.getAttributeName()!="" && filters.getAttributeValue()==""){
364 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","AttributeValue option is required if using AttributeName option.");
365 }
366
367 if(filters.getAttributeValue()!="" && filters.getAttributeName()==""){
368 UtilXmlTools::displayErrorMessage("@ADD_INSIDE_NODES","AttributeName option is required if using AttributeValue option.");
369 }
370
371 while ( !fileStream.atEnd() && !line.startsWith("</xml>")){
372 line = fileStream.readLine();
373
374 if(!line.startsWith("<xml>") && !line.startsWith("</xml>")){
375 xmlToInsert += line + "\n";
376 }
377 }
378
379 insertNodesOperation(xmlToInsert,filters,xPathExpression,filesWildcard);
380
381 xmlToInsert.clear();
382 filters.clear();
383 xPathExpression.clear();
384 filesWildcard.clear();
385 }
386 else if(line.startsWith("@REMOVE_NODES")){
387
388 xPathExpression=getPatchParameterValue(line,"XPathExpression");
389 filters.setElementName(getPatchParameterValue(line,"ElementName"));
390 filters.setParentElementName(getPatchParameterValue(line,"ParentElementName"));
391 filters.setAttributeName(getPatchParameterValue(line,"AttributeName"));
392 filters.setAttributeValue(getPatchParameterValue(line,"AttributeValue"));
393
394 if(this->forceTargetFilesWildcard!=""){
395 filesWildcard=this->forceTargetFilesWildcard;
396 }
397 else{
398 filesWildcard=getPatchParameterValue(line,"Files");
399 }
400
401 // Check options
402 if(xPathExpression.isEmpty() && filters.getElementName().isEmpty()){
403 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","ElementName option or XPathExpression option is required.");
404 }
405 else if(!xPathExpression.isEmpty() && !filters.getElementName().isEmpty()){
406 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","ElementName option and XPathExpression options cannot be used simultaneously.");
407 }
408
409 if(filters.getAttributeName()!="" && filters.getAttributeValue()==""){
410 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","AttributeValue option is required if using AttributeName option.");
411 }
412
413 if(filters.getAttributeValue()!="" && filters.getAttributeName()==""){
414 UtilXmlTools::displayErrorMessage("@REMOVE_NODES","AttributeName option is required if using AttributeValue option.");
415 }
416
417 removeNodesOperation(filters,xPathExpression,filesWildcard);
418
419 filters.clear();
420 xPathExpression.clear();
421 filesWildcard.clear();
422 }
423 else if(line.startsWith("@COMMAND")){
424
425 command=GlobalVars::AppExecutable;
426
427 // Append files if forced to
428 if(!this->forceTargetFilesWildcard.isEmpty()){
429 command+=" --files '"+this->forceTargetFilesWildcard+"' ";
430 }
431
432 command+=" "+getPatchParameterValue(line,"Options");
433
434 // Add --no-backups and --no-verbose if patch was called with that arguments
435 if(!this->backupsEnabled){
436 command.append(" --no-backups");
437 }
438
439 if(!this->verboseEnabled){
440 command.append(" --no-verbose");
441 }
442
443 command.replace("'","\""); //replace apostrophe by quotes, to avoid problems
444
445 executeCommandOperation(command);
446
447 command.clear();
448 filesWildcard.clear();
449 }
450 else if(line.startsWith("@CUSTOM_CODE")){
451
452 if(this->forceTargetFilesWildcard!=""){
453 filesWildcard=this->forceTargetFilesWildcard;
454 }
455 else{
456 filesWildcard=getPatchParameterValue(line,"Files");
457 }
458
459 while ( !fileStream.atEnd() && !line.startsWith("</code>")){
460
461 line = fileStream.readLine();
462
463 if(!line.startsWith("<code>") && !line.startsWith("</code>")){
464 jsCode += line + "\n";
465 }
466 }
467
468 executeCustomCommandOperation(jsCode,filesWildcard);
469
470 jsCode.clear();
471 filesWildcard.clear();
472 }
473 }
474}
475
476QString XmlPatch::getPatchParameterValue(const QString& line, QString parameter){
477
478 int startValueIdx, endValueIdx;
479
480 parameter=" "+parameter+" "; // Parameters include a space before and after it's value.
481
482 if(!line.contains(parameter)){
483 if(parameter==" ParentElementName " || parameter==" AttributeName " || parameter==" AttributeValue "
484 || parameter==" ElementName " || parameter==" XPathExpression "){
485 return ""; // not mandatory
486 }
487 parameter.remove(" "); // just remove the space added so it doesn't look weird when outputted to the user
488
489 UtilXmlTools::displayErrorMessage("Read patch file parameter","Couldn't retreive '" + parameter + "' parameter.");
490 }
491
492 startValueIdx=line.indexOf(parameter); // get the position where parameter is defined
493 endValueIdx=line.indexOf("\"",startValueIdx)+1; // get the position where parameter value begins (+1 to ignore mandotory quote)
494
495 startValueIdx=endValueIdx;
496 endValueIdx=line.indexOf("\"",startValueIdx); // get the last mandatory quote of the value
497
498 return line.mid(startValueIdx,endValueIdx-startValueIdx); // return the value of the parameter (is in the middle of the mandatory quotes)
499}
500
501#ifdef _USE_OLD_JS_ENGINE
502void XmlPatch::displayJsException(QScriptEngine &engine, QScriptValue &engineResult){
503 if (engine.hasUncaughtException()) {
504 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Uncaught js exception (user code) at line " +QString::number(engine.uncaughtExceptionLineNumber()) + ":\n" + engineResult.toString());
505 }
506}
507#else
508void XmlPatch::checkForJsException(QJSValue &engineResult){
509 if (engineResult.isError()) {
510 UtilXmlTools::displayErrorMessage("@CUSTOM_CODE","Uncaught js exception (user code):\n" + engineResult.toString());
511 }
512}
513#endif
Note: See TracBrowser for help on using the repository browser.