<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>AlbumShaper: xmlTools.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xmlTools.cpp File Reference</h1><code>#include <qstring.h></code><br/>
<code>#include <qdir.h></code><br/>
<code>#include <qfile.h></code><br/>
<code>#include <qdragobject.h></code><br/>
<code>#include <iostream></code><br/>
<code>#include <string></code><br/>
<code>#include <libxml/xmlmemory.h></code><br/>
<code>#include <libxml/debugXML.h></code><br/>
<code>#include <libxml/HTMLtree.h></code><br/>
<code>#include <libxml/xmlIO.h></code><br/>
<code>#include <libxml/xinclude.h></code><br/>
<code>#include <libxml/catalog.h></code><br/>
<code>#include <libxslt/xslt.h></code><br/>
<code>#include <libxslt/xsltInternals.h></code><br/>
<code>#include <libxslt/transform.h></code><br/>
<code>#include <libxslt/xsltutils.h></code><br/>
<code>#include <stdio.h></code><br/>
<code>#include "<a class="el" href="xmlTools_8h_source.html">xmlTools.h</a>"</code><br/>
<code>#include "../../config.h"</code><br/>
<div class="dynheader">
Include dependency graph for xmlTools.cpp:</div>
<div class="dynsection">
</div>
<p><a href="xmlTools_8cpp_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlTools_8cpp.html#afd193066f6b4f77436cd0f17146a1e39">fixXMLString</a> (QString text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fix strings before exporting to XML such that & becomes &, etc... <a href="#afd193066f6b4f77436cd0f17146a1e39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlTools_8cpp.html#a084a8161b6a3df5178f0d35530d6dda1">transformXMLtoHTML</a> (QString outputPath, QString theme, bool smallWebExport)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xmlTools_8cpp.html#a08d51743ff2d1414cce04037f42f91ad">updateXML</a> (QString inputPath)</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="afd193066f6b4f77436cd0f17146a1e39"></a><!-- doxytag: member="xmlTools.cpp::fixXMLString" ref="afd193066f6b4f77436cd0f17146a1e39" args="(QString text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString fixXMLString </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>text</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fix strings before exporting to XML such that & becomes &, etc... </p>
<p>Definition at line <a class="el" href="xmlTools_8cpp_source.html#l00036">36</a> of file <a class="el" href="xmlTools_8cpp_source.html">xmlTools.cpp</a>.</p>
<p>Referenced by <a class="el" href="subalbum_8cpp_source.html#l00312">Subalbum::exportToXML()</a>, <a class="el" href="photo_8cpp_source.html#l00413">Photo::exportToXML()</a>, and <a class="el" href="album_8cpp_source.html#l00801">Album::exportToXML()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="comment">//the following checks are necessary before exporting</span>
<a name="l00039"></a>00039 <span class="comment">//strings to XML. see http://hdf.ncsa.uiuc.edu/HDF5/XML/xml_escape_chars.html for details</span>
<a name="l00040"></a>00040 text.replace(<span class="stringliteral">"&"</span>, <span class="stringliteral">"&amp;"</span>);
<a name="l00041"></a>00041 text.replace(<span class="stringliteral">"\""</span>,<span class="stringliteral">"&quot;"</span>);
<a name="l00042"></a>00042 text.replace(<span class="stringliteral">"'"</span>, <span class="stringliteral">"&apos;"</span>);
<a name="l00043"></a>00043 text.replace(<span class="stringliteral">"<"</span>, <span class="stringliteral">"&lt;"</span>);
<a name="l00044"></a>00044 text.replace(<span class="stringliteral">">"</span>, <span class="stringliteral">"&gt;"</span>);
<a name="l00045"></a>00045 text.replace(<span class="stringliteral">"\n"</span>, <span class="stringliteral">"&#10;"</span>);
<a name="l00046"></a>00046 text.replace(<span class="stringliteral">"\r"</span>, <span class="stringliteral">"&#13;"</span>);
<a name="l00047"></a>00047 <span class="keywordflow">return</span> text;
<a name="l00048"></a>00048 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="a084a8161b6a3df5178f0d35530d6dda1"></a><!-- doxytag: member="xmlTools.cpp::transformXMLtoHTML" ref="a084a8161b6a3df5178f0d35530d6dda1" args="(QString outputPath, QString theme, bool smallWebExport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void transformXMLtoHTML </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>outputPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>theme</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>smallWebExport</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="xmlTools_8cpp_source.html#l00050">50</a> of file <a class="el" href="xmlTools_8cpp_source.html">xmlTools.cpp</a>.</p>
<p>References <a class="el" href="config_8cpp_source.html#l00021">THEMES_PATH</a>.</p>
<p>Referenced by <a class="el" href="album_8cpp_source.html#l00616">Album::exportCompressedWebAlbum()</a>, and <a class="el" href="album_8cpp_source.html#l00506">Album::exportToDisk()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00051"></a>00051 {
<a name="l00052"></a>00052 xmlSubstituteEntitiesDefault(1);
<a name="l00053"></a>00053 xmlLoadExtDtdDefaultValue = 1;
<a name="l00054"></a>00054 xsltStylesheetPtr cur = xsltParseStylesheetFile( (<span class="keyword">const</span> xmlChar *) QString(<a class="code" href="config_8cpp.html#aee0cb822aa7f2b785c390ae0099e22a9">THEMES_PATH</a> + theme + <span class="stringliteral">"/theme.xsl"</span>).ascii() );
<a name="l00055"></a>00055
<a name="l00056"></a>00056 QString xmlFile = QString(outputPath + <span class="stringliteral">"/Album.xml"</span>);
<a name="l00057"></a>00057 xmlDocPtr doc = xmlParseFile( QFile::encodeName(xmlFile) );
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">const</span> <span class="keywordtype">char</span>* params[5];
<a name="l00060"></a>00060 <span class="comment">//--</span>
<a name="l00061"></a>00061 params[0] = <span class="stringliteral">"outputPath"</span>;
<a name="l00062"></a>00062 QString quotedPath = outputPath;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">//For some reason libxslt has trouble handling filenames with spaces on Unix platforms (OSX,</span>
<a name="l00065"></a>00065 <span class="comment">//Linux, FreeBSD?). this problem can be averted by converting the filename to a URI. Converting it</span>
<a name="l00066"></a>00066 <span class="comment">//to a URI on windows using the qt method mangles the drive name though, so only convert to</span>
<a name="l00067"></a>00067 <span class="comment">//URI on OSX. We need to nail this weirdness at some point and be consistant IMHO but for now</span>
<a name="l00068"></a>00068 <span class="comment">//this works...</span>
<a name="l00069"></a>00069 <span class="preprocessor">#ifndef Q_OS_WIN</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span> quotedPath = QUriDrag::localFileToUri( quotedPath );
<a name="l00071"></a>00071 <span class="preprocessor">#endif</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>
<a name="l00073"></a>00073 params[1] = quotedPath.prepend(<span class="charliteral">'\"'</span>).append(<span class="charliteral">'\"'</span>).ascii();
<a name="l00074"></a>00074 <span class="comment">//--</span>
<a name="l00075"></a>00075 params[2] = <span class="stringliteral">"smallWebExport"</span>;
<a name="l00076"></a>00076 <span class="keywordflow">if</span>(smallWebExport)
<a name="l00077"></a>00077 params[3] = <span class="stringliteral">"1"</span>;
<a name="l00078"></a>00078 <span class="keywordflow">else</span>
<a name="l00079"></a>00079 params[3] = <span class="stringliteral">"0"</span>;
<a name="l00080"></a>00080 <span class="comment">//--</span>
<a name="l00081"></a>00081 params[4] = NULL;
<a name="l00082"></a>00082 xmlDocPtr res = xsltApplyStylesheet( cur, doc, params);
<a name="l00083"></a>00083 xsltFreeStylesheet( cur );
<a name="l00084"></a>00084 xmlFreeDoc( res );
<a name="l00085"></a>00085 xmlFreeDoc( doc );
<a name="l00086"></a>00086 xsltCleanupGlobals();
<a name="l00087"></a>00087 xmlCleanupParser();
<a name="l00088"></a>00088 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="a08d51743ff2d1414cce04037f42f91ad"></a><!-- doxytag: member="xmlTools.cpp::updateXML" ref="a08d51743ff2d1414cce04037f42f91ad" args="(QString inputPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void updateXML </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>inputPath</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="xmlTools_8cpp_source.html#l00090">90</a> of file <a class="el" href="xmlTools_8cpp_source.html">xmlTools.cpp</a>.</p>
<p>References <a class="el" href="config_8cpp_source.html#l00022">XMLCONVERSION_PATH</a>.</p>
<p>Referenced by <a class="el" href="album_8cpp_source.html#l00295">Album::importFromDisk()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="comment">//skip updating the xml file if we can't find the update.xsl file</span>
<a name="l00093"></a>00093 QDir tmpDir;
<a name="l00094"></a>00094 <span class="keywordflow">if</span>( !tmpDir.exists( <a class="code" href="config_8cpp.html#a37fb048dd9e688cc6db1f51b8c132971">XMLCONVERSION_PATH</a> + <span class="stringliteral">"update.xsl"</span> ) )
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 std::cout << <span class="stringliteral">"Can't find update.xsl! Skipping auto-update!\n"</span>;
<a name="l00097"></a>00097 <span class="keywordflow">return</span>;
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 xmlSubstituteEntitiesDefault(1);
<a name="l00101"></a>00101 xmlLoadExtDtdDefaultValue = 1;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 xsltStylesheetPtr stylesheet;
<a name="l00104"></a>00104 xmlDocPtr inputDoc, outputDoc;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 stylesheet = xsltParseStylesheetFile( (<span class="keyword">const</span> xmlChar *) QString(<a class="code" href="config_8cpp.html#a37fb048dd9e688cc6db1f51b8c132971">XMLCONVERSION_PATH</a> + <span class="stringliteral">"update.xsl"</span>).ascii() );
<a name="l00107"></a>00107
<a name="l00108"></a>00108 QString xmlFile = QString( inputPath + <span class="stringliteral">"/Album.xml"</span> );
<a name="l00109"></a>00109 xmlFile = QDir::convertSeparators( xmlFile );
<a name="l00110"></a>00110 inputDoc = xmlParseFile( QFile::encodeName(xmlFile) );
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keyword">const</span> <span class="keywordtype">char</span>* params[3];
<a name="l00113"></a>00113 params[0] = <span class="stringliteral">"outputPath"</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 QString quotedPath = inputPath;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">//For some reason libxslt has trouble handling filenames with spaces on Unix platforms (OSX,</span>
<a name="l00118"></a>00118 <span class="comment">//Linux, FreeBSD?). this problem can be averted by converting the filename to a URI. Converting it</span>
<a name="l00119"></a>00119 <span class="comment">//to a URI on windows using the qt method mangles the drive name though, so only convert to</span>
<a name="l00120"></a>00120 <span class="comment">//URI on OSX. We need to nail this weirdness at some point and be consistant IMHO but for now</span>
<a name="l00121"></a>00121 <span class="comment">//this works...</span>
<a name="l00122"></a>00122 <span class="preprocessor"> #ifndef Q_OS_WIN</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span> quotedPath = QUriDrag::localFileToUri( quotedPath );
<a name="l00124"></a>00124 <span class="preprocessor"> #endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 params[1] = quotedPath.prepend(<span class="charliteral">'\"'</span>).append(<span class="charliteral">'\"'</span>).ascii();
<a name="l00128"></a>00128
<a name="l00129"></a>00129 params[2] = NULL;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 std::cout.flush();
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">//iterate until Album.updated file is created</span>
<a name="l00134"></a>00134 QDir workingDir( inputPath );
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keywordtype">int</span> iterations = 0;
<a name="l00137"></a>00137 <span class="keywordflow">while</span>(<span class="keyword">true</span>)
<a name="l00138"></a>00138 {
<a name="l00139"></a>00139 iterations++;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">//apply the stylesheet</span>
<a name="l00142"></a>00142 outputDoc = xsltApplyStylesheet( stylesheet, inputDoc, params );
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="comment">//if Album.updated file now exists we have already completed the last iteration,</span>
<a name="l00145"></a>00145 <span class="comment">//meaning the input document is the most up-to-date so break out of loop</span>
<a name="l00146"></a>00146 <span class="keywordflow">if</span>(workingDir.exists( <span class="stringliteral">"Album.updated"</span> ))
<a name="l00147"></a>00147 <span class="keywordflow">break</span>;
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">//free input doc</span>
<a name="l00150"></a>00150 xmlFreeDoc( inputDoc );
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">//swap input and output</span>
<a name="l00153"></a>00153 inputDoc = outputDoc;
<a name="l00154"></a>00154 }
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="comment">//remove updated file</span>
<a name="l00157"></a>00157 workingDir.remove( inputPath + <span class="stringliteral">"/Album.updated"</span> );
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">//if we made more than one iteration then changes were applied</span>
<a name="l00160"></a>00160 <span class="keywordflow">if</span>(iterations > 1)
<a name="l00161"></a>00161 {
<a name="l00162"></a>00162 <span class="comment">//output updated xml file</span>
<a name="l00163"></a>00163 FILE* outfile = fopen( QFile::encodeName(xmlFile), <span class="stringliteral">"w"</span> );
<a name="l00164"></a>00164 xsltSaveResultToFile( outfile, inputDoc, stylesheet);
<a name="l00165"></a>00165 fclose( outfile );
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">//memory</span>
<a name="l00169"></a>00169 xsltFreeStylesheet( stylesheet );
<a name="l00170"></a>00170 xmlFreeDoc( inputDoc );
<a name="l00171"></a>00171 xmlFreeDoc( outputDoc );
<a name="l00172"></a>00172 xsltCleanupGlobals();
<a name="l00173"></a>00173 xmlCleanupParser();
<a name="l00174"></a>00174 }
</pre></div></p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
