kworship/filters/zionworx/KwZionworxFilter.cpp

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 /**
  21  * @file KwZionworxFilter.cpp
  22  * @brief Main Zionworx load and save filter.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwZionworxFilter.h"
  27 #include "KwPascalStream.h"
  28 #include <KwDocument.h>
  29 #include <KwArchive.h>
  30 #include <KwPlaylistList.h>
  31 #include <KwPlaylistText.h>
  32 #include <KwPlaylistSong.h>
  33 #include <KwBiblePlaylistItem.h>
  34 #include <KwPlaylistPresentation.h>
  35 #include <KwCssStyleRule.h>
  36 #include <KwDisplayStyles.h>
  37
  38 #include <VTable.h>
  39
  40 #include <KUrl>
  41 #include <KMessageBox>
  42 #include <KLocale>
  43 #include <KSaveFile>
  44
  45 #include <QFile>
  46 #include <QDomDocument>
  47 #include <QDomElement>
  48 #include <QPen>
  49
  50 #include <inttypes.h>
  51
  52 /*
  53  * Constructors + destructor
  54  */
  55
  56 /// Primary constructor.
  57 KwZionworxFilter::KwZionworxFilter()
  58 : KwLoadSaveFilter()
  59 {
  60   m_importMimeTypes += "application/x-zionworx+xml";
  61   m_exportMimeTypes += "application/x-zionworx+xml";
  62 }
  63
  64 /// Destructor.
  65 KwZionworxFilter::~KwZionworxFilter()
  66 {
  67 }
  68
  69 /*
  70  * Main interface
  71  */
  72
  73 KwDocument* KwZionworxFilter::load(const KUrl& url, const QString& mimeType)
  74 {
  75   /// @todo Handle non-local files
  76   if (!url.isLocalFile())
  77   {
  78     KMessageBox::error(0,
  79         i18n("Non-local loads not yet supported"),
  80         i18n("KWorship"));
  81     return 0;
  82   }
  83
  84   KwDocument* doc = 0;
  85
  86   if (mimeType == "application/x-zionworx+xml")
  87   {
  88     QFile file(url.toLocalFile());
  89     if (file.open(QIODevice::ReadOnly))
  90     {
  91       QDomDocument domDoc;
  92       if (domDoc.setContent(&file))
  93       {
  94         QDomElement root = domDoc.documentElement();
  95         QDomElement versionEl = root.firstChildElement("ZionWorx");
  96         if (root.tagName() != "Root" || versionEl.isNull())
  97         {
  98           KMessageBox::error(0,
  99               i18n("Doesn't look like a ZionWorx playlist"),
 100               i18n("KWorship"));
 101         }
 102         else
 103         {
 104           bool versionOk = false;
 105           double version = versionEl.attribute("Version").toDouble(&versionOk);
 106           if (!versionOk || version != 2.6)
 107           {
 108             KMessageBox::error(0,
 109                 i18n("Only version 2.6 is supported (version is %1)").arg(versionEl.attribute("Version", "unspecified")),
 110                 i18n("KWorship"));
 111           }
 112           else
 113           {
 114             doc = new KwDocument(this, mimeType, url);
 115             KwPlaylistList* list = new KwPlaylistList();
 116             doc->setPlaylist(list);
 117
 118             QDomNodeList playlistNodes = root.elementsByTagName("TPlayListNode");
 119             for (int i = 0; i < playlistNodes.count(); ++i)
 120             {
 121               QDomElement playlistNode = playlistNodes.at(i).toElement();
 122               QDomElement item = playlistNode.firstChildElement("PlayListItem");
 123               if (!item.isNull())
 124               {
 125                 KwPlaylistItem* newItem = 0;
 126                 QString biDiText = item.firstChildElement("BiDiMode").text();
 127                 bool rightToLeft = (biDiText == "bdRightToLeft");
 128                 QString itemType = item.firstChildElement("ItemType").text();
 129                 if (itemType == "siPowerPoint")
 130                 {
 131                   KwPlaylistPresentation* powerpoint = new KwPlaylistPresentation(QUrl(item.firstChildElement("FilenameRelative").text()));
 132                   powerpoint->setTitle(item.firstChildElement("Title").text());
 133                   newItem = powerpoint;
 134                 }
 135                 else if (itemType == "siSong")
 136                 {
 137                   KwPlaylistText* song = new KwPlaylistText(item.firstChildElement("Title").text(),
 138                                                             item.firstChildElement("Lyrics").text().split("\n\n"));
 139                   newItem = song;
 140                 }
 141                 else if (itemType == "siQuickNote")
 142                 {
 143                   KwPlaylistText* note = new KwPlaylistText(item.firstChildElement("Title").text(),
 144                                                             readStringList(item.firstChildElement("QuickNote")));
 145                   newItem = note;
 146                 }
 147                 else if (itemType == "siBible")
 148                 {
 149                   bool error = true;
 150                   QStringList verses = readStringList(item.firstChildElement("Verses"));
 151                   // Try and understand the passage referred to on the first line.
 152                   static QRegExp rePassage("^(.*)\\s+(\\d+)(:(\\d+)(-(\\d+))?)?\\s+\\(([^\\)]*)\\).*");
 153                   if (verses.size() >= 1 && rePassage.exactMatch(verses[0]))
 154                   {
 155                     error = false;
 156                     QString bookName = rePassage.cap(1);
 157                     QString moduleName = rePassage.cap(7);
 158                     /// @todo Try and get a more accurate set of book ids
 159                     int bookNum = 0;
 160                     int chapterNum = rePassage.cap(2).toInt();
 161                     bool validVerse;
 162                     int firstVerse = rePassage.cap(4).toInt(&validVerse);
 163                     if (!validVerse)
 164                     {
 165                       firstVerse = 1;
 166                     }
 167                     int nextVerse = firstVerse;
 168                     QStringList verseHeadings;
 169                     QStringList verseContents;
 170                     QStringList tempHeadings;
 171                     for (int i = 1; i < verses.size(); ++i)
 172                     {
 173                       const QString& verse = verses[i];
 174                       // See if it starts with a number, otherwise its a heading
 175                       static QRegExp reVerseLine("^(\\d+)\\.\\s*(\\S.*)$");
 176                       if (reVerseLine.exactMatch(verse))
 177                       {
 178                         int verseNum = reVerseLine.cap(1).toInt();
 179                         if (verseNum != nextVerse)
 180                         {
 181                           error = true;
 182                         }
 183                         nextVerse++;
 184
 185                         if (!tempHeadings.isEmpty())
 186                         {
 187                           verseHeadings += QString("<h4>%1</h4>").arg(tempHeadings.join("<br />\n"));
 188                         }
 189                         else
 190                         {
 191                           verseHeadings += QString();
 192                         }
 193                         verseContents += reVerseLine.cap(2);
 194                         tempHeadings = QStringList();
 195                       }
 196                       else
 197                       {
 198                         tempHeadings += verse;
 199                       }
 200                     }
 201                     if (error)
 202                     {
 203                       KMessageBox::error(0,
 204                           i18n("Problems were encountered reading numbered verses in bible passage %1").arg(item.firstChildElement("Title").text()),
 205                           i18n("KWorship"));
 206                     }
 207                     else
 208                     {
 209                       KwBiblePlaylistItem* bible = new KwBiblePlaylistItem();
 210                       KwBiblePassage& passage = bible->passage();
 211                       passage.setSource(QString(), moduleName, rightToLeft);
 212                       passage.initBooks(bookNum,1);
 213                       passage.initBook(bookNum, bookName, chapterNum, 1);
 214                       passage.initChapter(bookNum, chapterNum, firstVerse, verseContents.size());
 215                       for (int i = 0; i < verseContents.size(); ++i)
 216                       {
 217                         passage.initVerse(bookNum, chapterNum, firstVerse+i, verseHeadings[i], verseContents[i]);
 218                       }
 219                       newItem = bible;
 220                     }
 221                   }
 222                   if (error)
 223                   {
 224                     KwPlaylistText* bible = new KwPlaylistText(item.firstChildElement("Title").text(),
 225                                                                verses);
 226                     newItem = bible;
 227                   }
 228                 }
 229
 230                 if (0 != newItem)
 231                 {
 232                   QDomElement overlayStyleEl = playlistNode.firstChildElement("OverlayStyle");
 233                   if (!overlayStyleEl.isNull())
 234                   {
 235                     KwCssStyleSheet* styleRules = new KwCssStyleSheet;
 236                     KwCssStyleRule overlayStyle;
 237
 238
 239                     QDomElement fontEl           = overlayStyleEl.firstChildElement("Font");
 240                     if (!fontEl.isNull())
 241                     {
 242                       QFont font;
 243                       QDomElement fontHeightEl   = fontEl.firstChildElement("Height");
 244                       if (!fontHeightEl.isNull())
 245                       {
 246                         bool ok;
 247                         int height = fontHeightEl.text().toInt(&ok);
 248                         if (ok)
 249                         {
 250                           font.setPointSize(abs(height));
 251                         }
 252                       }
 253                       QDomElement fontNameEl     = fontEl.firstChildElement("Name");
 254                       /// @todo Remember font name
 255                       /// @todo Use font names
 256                       QDomElement fontStyleEl    = fontEl.firstChildElement("Style");
 257                       if (!fontStyleEl.isNull())
 258                       {
 259                         static QRegExp reFontStyleList("^\\s*\\[(.*)\\]\\s*$");
 260                         if (reFontStyleList.exactMatch(fontStyleEl.text()))
 261                         {
 262                           QStringList styles = reFontStyleList.cap(1).split(",");
 263                           foreach (QString style, styles)
 264                           {
 265                             style = style.trimmed();
 266                             if (style == "fsBold")
 267                             {
 268                               font.setWeight(QFont::Bold);
 269                             }
 270                             else if (style == "fsItalic")
 271                             {
 272                               font.setStyle(QFont::StyleItalic);
 273                             }
 274                           }
 275                         }
 276                       }
 277
 278                       overlayStyle.setStyle<QFont>("text.character.font", font);
 279
 280                       QDomElement fontColorEl    = fontEl.firstChildElement("Color");
 281                       if (!fontColorEl.isNull())
 282                       {
 283                         bool ok;
 284                         QColor colour = readColour(fontColorEl, &ok);
 285                         if (ok)
 286                         {
 287                           overlayStyle.setStyle<QBrush>("text.character.brush", QBrush(colour));
 288                         }
 289                       }
 290                     }
 291                     QDomElement textStyleEl      = overlayStyleEl.firstChildElement("TextStyle");
 292                     if (!textStyleEl.isNull())
 293                     {
 294                       QString style = textStyleEl.text();
 295                       if (style == "tsShadow")
 296                       {
 297                         overlayStyle.setStyle<bool>("text.character.shadow.enabled", true);
 298                       }
 299                       else if (style == "tsOutline")
 300                       {
 301                         overlayStyle.setStyle<bool>("text.character.outline.enabled", true);
 302                       }
 303                     }
 304                     QDomElement textAlignmentEl  = overlayStyleEl.firstChildElement("TextAlignment");
 305
 306                     // Shadow
 307                     QDomElement shadowWidthEl    = overlayStyleEl.firstChildElement("ShadowWidth");
 308                     if (!shadowWidthEl.isNull())
 309                     {
 310                       bool ok;
 311                       int offset = shadowWidthEl.text().toInt(&ok);
 312                       if (ok)
 313                       {
 314                         overlayStyle.setStyle<int>("text.character.shadow.offset", offset);
 315                       }
 316                     }
 317                     QDomElement shadowColorEl    = overlayStyleEl.firstChildElement("ShadowColor");
 318                     if (!shadowColorEl.isNull())
 319                     {
 320                       bool ok;
 321                       QColor colour = readColour(shadowColorEl, &ok);
 322                       if (ok)
 323                       {
 324                         overlayStyle.setStyle<QBrush>("text.character.shadow.brush", QBrush(colour));
 325                       }
 326                     }
 327
 328                     // Outline
 329                     QDomElement outlineWidthEl   = overlayStyleEl.firstChildElement("OutlineWidth");
 330                     int outlineWidth = 1;
 331                     if (!outlineWidthEl.isNull())
 332                     {
 333                       bool ok;
 334                       int width = outlineWidthEl.text().toInt(&ok);
 335                       if (ok)
 336                       {
 337                         outlineWidth = width;
 338                       }
 339                     }
 340                     QDomElement outlineColorEl   = overlayStyleEl.firstChildElement("OutlineColor");
 341                     QColor outlineColour = Qt::black;
 342                     if (!outlineColorEl.isNull())
 343                     {
 344                       bool ok;
 345                       QColor colour = readColour(outlineColorEl, &ok);
 346                       if (ok)
 347                       {
 348                         outlineColour = colour;
 349                       }
 350                     }
 351                     overlayStyle.setStyle<QPen>("text.character.outline.pen", QPen(outlineColour, outlineWidth));
 352
 353                     QDomElement fillColorEl      = overlayStyleEl.firstChildElement("FillColor");
 354                     if (!fillColorEl.isNull())
 355                     {
 356                       bool ok;
 357                       QColor colour = readColour(fillColorEl, &ok);
 358                       if (ok)
 359                       {
 360                         overlayStyle.setStyle<QBrush>("background.brush", QBrush(colour));
 361                       }
 362                     }
 363                     QDomElement imageFilenameEl  = overlayStyleEl.firstChildElement("ImageFilename");
 364                     //overlayStyle.setStyle<KwResourceLink>("background.image.src", KUrl("file:///home/james/media/images/projector/misc/bible.jpg"));
 365                     QDomElement imageAlignmentEl = overlayStyleEl.firstChildElement("ImageAlignment");
 366
 367                     // Margins
 368                     QDomElement marginRightEl    = overlayStyleEl.firstChildElement("MarginRight");
 369                     if (!marginRightEl.isNull())
 370                     {
 371                       bool ok;
 372                       float margin = marginRightEl.text().toFloat(&ok);
 373                       if (ok)
 374                       {
 375                         overlayStyle.setStyle<float>("text.layout.margins.right", margin);
 376                       }
 377                     }
 378                     QDomElement marginLeftEl     = overlayStyleEl.firstChildElement("MarginLeft");
 379                     if (!marginLeftEl.isNull())
 380                     {
 381                       bool ok;
 382                       float margin = marginLeftEl.text().toFloat(&ok);
 383                       if (ok)
 384                       {
 385                         overlayStyle.setStyle<float>("text.layout.margins.left", margin);
 386                       }
 387                     }
 388                     QDomElement marginTopEl      = overlayStyleEl.firstChildElement("MarginTop");
 389                     if (!marginTopEl.isNull())
 390                     {
 391                       bool ok;
 392                       float margin = marginTopEl.text().toFloat(&ok);
 393                       if (ok)
 394                       {
 395                         overlayStyle.setStyle<float>("text.layout.margins.top", margin);
 396                       }
 397                     }
 398                     QDomElement marginBottomEl   = overlayStyleEl.firstChildElement("MarginBottom");
 399                     if (!marginBottomEl.isNull())
 400                     {
 401                       bool ok;
 402                       float margin = marginBottomEl.text().toFloat(&ok);
 403                       if (ok)
 404                       {
 405                         overlayStyle.setStyle<float>("text.layout.margins.bottom", margin);
 406                       }
 407                     }
 408
 409                     styleRules->addRule(overlayStyle);
 410                     newItem->addStyleSheet(styleRules);
 411                   }
 412
 413                   list->addItem(newItem);
 414                 }
 415                 else
 416                 {
 417                   KMessageBox::error(0,
 418                       i18n("Unrecognised item type \"%1\"").arg(itemType),
 419                       i18n("KWorship"));
 420                 }
 421               }
 422             }
 423
 424             doc->setModified(false);
 425           }
 426         }
 427       }
 428       else
 429       {
 430         KMessageBox::error(0,
 431             i18n("Invalid XML"),
 432             i18n("KWorship"));
 433       }
 434     }
 435   }
 436   else
 437   {
 438     Q_ASSERT(!"Unsupported mime type");
 439   }
 440
 441   return doc;
 442 }
 443
 444 /// Contains implementations of export functions.
 445 class KwZionworxFilter::ExportToDom
 446 {
 447   public:
 448
 449     /// Write a colour to a string.
 450     static QString writeColour(const QColor& colour, bool wierd)
 451     {
 452       /// @todo Use symbolic colours when possible
 453       if (wierd)
 454       {
 455         return QString::number((int32_t)((colour.red() << 16) | (colour.green() << 8) | colour.blue() | 0xFF000000));
 456       }
 457       else
 458       {
 459         return QString::number((int32_t)(colour.red() | (colour.green() << 8) | (colour.blue() << 16)));
 460       }
 461     }
 462     static QDomElement createPlaylistNode(QDomDocument& document, QDomElement& element)
 463     {
 464       QDomElement node = document.createElement("TPlayListNode");
 465       element.appendChild(node);
 466       return node;
 467     }
 468     static QDomElement createOverlayStyle(QDomDocument& document, QDomElement& element, const KwPlaylistItem* item)
 469     {
 470       QDomElement style = document.createElement("OverlayStyle");
 471
 472       style.appendChild(document.createTextNode("(TOverlayStyle)"));
 473
 474       QDomElement fontEl = document.createElement("Font");
 475       {
 476         fontEl.appendChild(document.createTextNode("(TFont)"));
 477
 478         QFont font = KwDisplayStyles::text::character::font(item);
 479         QStringList textStyles;
 480         if (font.italic())
 481         {
 482           textStyles += "fsItalic";
 483         }
 484         if (font.bold())
 485         {
 486           textStyles += "fsBold";
 487         }
 488
 489         /// @todo find out what this element does, restore from saved
 490         QDomElement charsetEl = document.createElement("Charset");
 491         charsetEl.appendChild(document.createTextNode("ANSI_CHARSET"));
 492         fontEl.appendChild(charsetEl);
 493
 494         QDomElement colorEl = document.createElement("Color");
 495         colorEl.appendChild(document.createTextNode(writeColour(KwDisplayStyles::text::character::brush(item).color(), false)));
 496         fontEl.appendChild(colorEl);
 497
 498         /// @todo Handle if font is specified in pixels
 499         QDomElement heightEl = document.createElement("Height");
 500         heightEl.appendChild(document.createTextNode(QString::number(-font.pointSize())));
 501         fontEl.appendChild(heightEl);
 502
 503         /// @todo Get a sensible font name here
 504         QDomElement nameEl = document.createElement("Name");
 505         nameEl.appendChild(document.createTextNode("Tahoma"));
 506         fontEl.appendChild(nameEl);
 507
 508         QDomElement StyleEl = document.createElement("Style");
 509         StyleEl.appendChild(document.createTextNode(QString("[%1]").arg(textStyles.join(","))));
 510         fontEl.appendChild(StyleEl);
 511       }
 512       style.appendChild(fontEl);
 513
 514       bool outline = KwDisplayStyles::text::character::outline::enabled(item);
 515       bool shadow = KwDisplayStyles::text::character::shadow::enabled(item);
 516       QDomElement textStyleEl = document.createElement("TextStyle");
 517       textStyleEl.appendChild(document.createTextNode(outline ? "tsOutline" : shadow ? "tsShadow" : "tsPlain"));
 518       style.appendChild(textStyleEl);
 519
 520       /// @todo Implement text alignment saving
 521       QDomElement textAlignmentEl = document.createElement("TextAlignment");
 522       textAlignmentEl.appendChild(document.createTextNode("taLeft"));
 523       style.appendChild(textAlignmentEl);
 524
 525       QDomElement shadowWidthEl = document.createElement("ShadowWidth");
 526       shadowWidthEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::character::shadow::offset(item))));
 527       style.appendChild(shadowWidthEl);
 528
 529       QDomElement shadowColorEl = document.createElement("ShadowColor");
 530       shadowColorEl.appendChild(document.createTextNode(writeColour(KwDisplayStyles::text::character::shadow::brush(item).color(), true)));
 531       style.appendChild(shadowColorEl);
 532
 533       QDomElement outlineWidthEl = document.createElement("OutlineWidth");
 534       outlineWidthEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::character::outline::pen(item).width())));
 535       style.appendChild(outlineWidthEl);
 536
 537       QDomElement outlineColorEl = document.createElement("OutlineColor");
 538       outlineColorEl.appendChild(document.createTextNode(writeColour(KwDisplayStyles::text::character::outline::pen(item).color(), true)));
 539       style.appendChild(outlineColorEl);
 540
 541       QDomElement fillColorEl = document.createElement("FillColor");
 542       fillColorEl.appendChild(document.createTextNode(writeColour(KwDisplayStyles::background::brush(item).color(), false)));
 543       style.appendChild(fillColorEl);
 544
 545       /// @todo Implement image filename saving
 546       if (0)
 547       {
 548         QDomElement imageFilenameEl = document.createElement("ImageFilename");
 549         imageFilenameEl.appendChild(document.createTextNode(""));
 550         style.appendChild(imageFilenameEl);
 551       }
 552
 553       /// @todo Implement image alignment saving
 554       QDomElement imageAlignmentEl = document.createElement("ImageAlignment");
 555       imageAlignmentEl.appendChild(document.createTextNode("iaStretch"));
 556       style.appendChild(imageAlignmentEl);
 557
 558       QDomElement marginRightEl = document.createElement("MarginRight");
 559       marginRightEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::layout::margins::right(item))));
 560       style.appendChild(marginRightEl);
 561
 562       QDomElement marginLeftEl = document.createElement("MarginLeft");
 563       marginLeftEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::layout::margins::left(item))));
 564       style.appendChild(marginLeftEl);
 565
 566       QDomElement marginTopEl = document.createElement("MarginTop");
 567       marginTopEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::layout::margins::top(item))));
 568       style.appendChild(marginTopEl);
 569
 570       QDomElement marginBottomEl = document.createElement("MarginBottom");
 571       marginBottomEl.appendChild(document.createTextNode(QString::number(KwDisplayStyles::text::layout::margins::bottom(item))));
 572       style.appendChild(marginBottomEl);
 573
 574       element.appendChild(style);
 575       return style;
 576     }
 577     static QDomElement createPlaylistItem(QDomDocument& document, QDomElement& element,
 578                                           const QString& type, const QString& title, bool rightToLeft)
 579     {
 580       QDomElement item = document.createElement("PlayListItem");
 581       {
 582         QDomElement typeEl = document.createElement("ItemType");
 583         typeEl.appendChild(document.createTextNode(type));
 584         item.appendChild(typeEl);
 585       }
 586       {
 587         QDomElement titleEl = document.createElement("Title");
 588         titleEl.appendChild(document.createTextNode(title));
 589         item.appendChild(titleEl);
 590       }
 591       {
 592         QDomElement biDiEl = document.createElement("BiDiMode");
 593         biDiEl.appendChild(document.createTextNode(rightToLeft ? "bdRightToLeft" : "bdLeftToRight"));
 594         item.appendChild(biDiEl);
 595       }
 596       element.appendChild(item);
 597       return item;
 598     }
 599     static int list(const KwPlaylistList* self, QDomDocument& document, QDomElement& element)
 600     {
 601       for (int i = 0; i < self->getItemCount(); ++i)
 602       {
 603         call(self->getItem(i), document, element);
 604       }
 605       return 0;
 606     }
 607     static int song(const KwPlaylistSong* self, QDomDocument& document, QDomElement& element)
 608     {
 609       QDomElement node = createPlaylistNode(document, element);
 610       QDomElement style = createOverlayStyle(document, node, self);
 611       return 0;
 612     }
 613     static int note(const KwPlaylistText* self, QDomDocument& document, QDomElement& element)
 614     {
 615       QDomElement node = createPlaylistNode(document, element);
 616       QDomElement style = createOverlayStyle(document, node, self);
 617       return 0;
 618     }
 619     static int bible(const KwBiblePlaylistItem* self, QDomDocument& document, QDomElement& element)
 620     {
 621       QDomElement node = createPlaylistNode(document, element);
 622       QDomElement style = createOverlayStyle(document, node, self);
 623       const KwBiblePassage& passage = self->passage();
 624       QDomElement item = createPlaylistItem(document, node,
 625                                             "siBible", passage.textualKey(),
 626                                             passage.isRightToLeft());
 627
 628       QDomElement versesEl = document.createElement("Verses");
 629       versesEl.appendChild(document.createTextNode("(TTntStringList)"));
 630       {
 631         QDomElement definedPropsEl = document.createElement("DefinedProperties");
 632         QByteArray propsData;
 633         KwPascalStream data(&propsData, QIODevice::WriteOnly);
 634
 635         QStringList verses;
 636         verses << passage.textualKey();
 637         for (int book = passage.firstBookNumber(); book <= passage.lastBookNumber(); ++book)
 638         {
 639           for (int chap = passage.firstChapterNumber(book); chap <= passage.lastChapterNumber(book); ++chap)
 640           {
 641             for (int verse = passage.firstVerseNumber(book, chap); verse <= passage.lastVerseNumber(book, chap); ++verse)
 642             {
 643               const QString& headings = passage.verseHeadings(book, chap, verse, true);
 644               if (!headings.isEmpty())
 645               {
 646                 verses += headings;
 647               }
 648               const QString& content = passage.verseContent(book, chap, verse, true);
 649               if (!content.isEmpty())
 650               {
 651                 verses += i18nc("Verse number, bible verse, for zionworx export", "%1.  %2").arg(verse).arg(content);
 652               }
 653             }
 654           }
 655         }
 656         data.writeProperty("Strings", verses);
 657
 658         propsData = propsData.toBase64();
 659         definedPropsEl.appendChild(document.createTextNode(propsData));
 660         versesEl.appendChild(definedPropsEl);
 661       }
 662       item.appendChild(versesEl);
 663       return 0;
 664     }
 665     static int presentation(const KwPlaylistPresentation* self, QDomDocument& document, QDomElement& element)
 666     {
 667       QDomElement node = createPlaylistNode(document, element);
 668       QDomElement item = createPlaylistItem(document, node,
 669                                             "siPowerPoint", self->title(),
 670                                             false);
 671
 672       return 0;
 673     }
 674
 675     static void init()
 676     {
 677       static bool done = false;
 678       if (!done)
 679       {
 680         call.addImplementation(&list);
 681         call.addImplementation(&song);
 682         call.addImplementation(&note);
 683         call.addImplementation(&bible);
 684         call.addImplementation(&presentation);
 685         done = true;
 686       }
 687     }
 688
 689     typedef VTable<const KwPlaylistItem, int (*)(QDomDocument& document, QDomElement& element)> ExportVTable;
 690     static ExportVTable call;
 691 };
 692 KwZionworxFilter::ExportToDom::ExportVTable KwZionworxFilter::ExportToDom::call;
 693
 694 bool KwZionworxFilter::save(KwDocument* doc, const KUrl& url, const QString& mimeType)
 695 {
 696   /// @todo Handle non-local files
 697   if (!url.isLocalFile())
 698   {
 699     KMessageBox::error(0,
 700         i18n("Non-local loads not yet supported"),
 701         i18n("KWorship"));
 702     return false;
 703   }
 704   KSaveFile file;
 705   file.setFileName(url.toLocalFile());
 706   if (!file.open(QFile::WriteOnly))
 707   {
 708     KMessageBox::error(0,
 709         i18n("Cannot write file %1:\n%2.")
 710           .arg(file.fileName())
 711           .arg(file.errorString()),
 712         i18n("KWorship"));
 713     return false;
 714   }
 715
 716   // Create document
 717   QDomDocument domDoc;
 718   QDomElement root = domDoc.createElement("Root");
 719   domDoc.appendChild(root);
 720
 721   // Version element
 722   QDomElement version = domDoc.createElement("ZionWorx");
 723   version.setAttribute("Version", 2.6);
 724   version.setAttribute("FullFilename", url.toLocalFile());
 725   root.appendChild(version);
 726
 727   // Playlist nodes element
 728   QDomElement playlist = domDoc.createElement("PlayListNodes");
 729   ExportToDom::init();
 730   ExportToDom::call(doc->playlist(), domDoc, playlist);
 731   root.appendChild(playlist);
 732
 733   // Write document to file
 734   QByteArray xml = domDoc.toByteArray(2);
 735   file.write(xml, xml.size());
 736
 737   if (!file.finalize())
 738   {
 739     KMessageBox::error(0,
 740         i18n("Cannot finalize file %1:\n%2.")
 741         .arg(file.fileName())
 742         .arg(file.errorString()),
 743         i18n("KWorship"));
 744     return false;
 745   }
 746
 747   doc->setModified(false);
 748
 749   return true;
 750 }
 751
 752 /*
 753  * Virtual interface
 754  */
 755
 756 void KwZionworxFilter::v_saveLimitations(KwDocument* doc, const QString& mimeType, Limitations* o_limitations)
 757 {
 758   /// @todo Implement KwZionworxFilter::v_saveLimitations
 759   Q_ASSERT(false);
 760 }
 761
 762 /*
 763  * Private functions
 764  */
 765
 766 /// Read a TTntStringList from DOM.
 767 QStringList KwZionworxFilter::readStringList(const QDomElement& el) const
 768 {
 769   // Go straight to the <DefinedProperties>
 770   QDomElement definedProperties = el.firstChildElement("DefinedProperties");
 771   if (!definedProperties.isNull())
 772   {
 773     const QByteArray buf = QByteArray::fromBase64(definedProperties.text().toAscii());
 774
 775     KwPascalStream stream(&buf);
 776     QByteArray name;
 777     QVariant value;
 778     while (!stream.atEnd())
 779     {
 780       stream.readProperty(name, value);
 781       if (name == "Strings")
 782       {
 783         // Turn into a QStringList
 784         QStringList result;
 785         foreach (QVariant item, value.toList())
 786         {
 787           result += item.toString();
 788         }
 789         return result;
 790       }
 791     }
 792   }
 793   return QStringList();
 794 }
 795
 796 /// Read a colour from DOM.
 797 QColor KwZionworxFilter::readColour(const QDomElement& el, bool* ok) const
 798 {
 799   bool isOk = false;
 800
 801   static QHash<QString, QColor> colours;
 802   static bool inited = false;
 803   if (!inited)
 804   {
 805     colours["clWhite"]       = Qt::white;
 806     colours["clBlack"]       = Qt::black;
 807     colours["clRed"]         = Qt::red;
 808     colours["clDarkRed"]     = Qt::darkRed;
 809     colours["clGreen"]       = Qt::green;
 810     colours["clDarkGreen"]   = Qt::darkGreen;
 811     colours["clBlue"]        = Qt::blue;
 812     colours["clDarkBlue"]    = Qt::darkBlue;
 813     colours["clCyan"]        = Qt::cyan;
 814     colours["clDarkCyan"]    = Qt::darkCyan;
 815     colours["clMagenta"]     = Qt::magenta;
 816     colours["clDarkMagenta"] = Qt::darkMagenta;
 817     colours["clYellow"]      = Qt::yellow;
 818     colours["clDarkGray"]    = Qt::darkYellow;
 819     colours["clGray"]        = Qt::gray;
 820     colours["clDarkGray"]    = Qt::darkGray;
 821     colours["clLightGray"]   = Qt::lightGray;
 822     inited = true;
 823   }
 824
 825   QString colourName = el.text();
 826   QColor result;
 827   uint32_t colourNum = colourName.toInt(&isOk);
 828   if (isOk)
 829   {
 830     // 0xff in msb apparently changes byte order
 831     if (((colourNum >> 24) & 0xFF) == 0xFF)
 832     {
 833       // least significant byte is blue, followed by green and red
 834       result.setRgb((colourNum >> 16) & 0xFF,
 835                     (colourNum >> 8)  & 0xFF,
 836                      colourNum        & 0xFF);
 837     }
 838     else
 839     {
 840       // least significant byte is red, followed by green and blue
 841       result.setRgb( colourNum        & 0xFF,
 842                     (colourNum >> 8)  & 0xFF,
 843                     (colourNum >> 16) & 0xFF);
 844     }
 845   }
 846   else if (colours.contains(colourName))
 847   {
 848     result = colours[colourName];
 849     isOk = true;
 850   }
 851
 852   if (0 != ok)
 853   {
 854     *ok = isOk;
 855   }
 856   return result;
 857 }