1 /*

     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    17 

    18 

    19 

    20 #include "hswidgetcomponentparser.h"

    21 #include <QFile>

    22 

    23 const char WIDGETPROVIDER[] = "widgetprovider";

    24 const char WIDGET[] = "widget";

    25 const char WIDGETMANIFEST[] = "hswidgetmanifest";

    26 

    27 const char URI[] = "uri";

    28 const char TITLE[] = "title";

    29 const char ICONURI[] = "iconuri";

    30 const char ICON[] = "icon";

    31 const char DESCRIPTION[] = "description";

    32 const char HIDDEN[] = "hidden";

    33 const char SERVICEXML[] = "servicexml";

    34 const char TRANSLATIONFILE[] = "translationfile";

    35 const char VERSION[] = "version";

    36 const char VERSION_1_0[] = "1.0";

    37 

    38 /*!

    39     \class HsWidgetComponentParser

    40     \ingroup group_hswidgetuninstaller

    41     \brief Parses widget manifest xml file.

    42 */

    43 

    44 

    45 /*!

    46     Constructor, \a aComponentManifest path to file \a parent.

    47 */

    48 HsWidgetComponentParser::HsWidgetComponentParser(const QString &aComponentManifest, QObject *parent)

    49     : QObject(parent),mError(false)

    50 {

    51     parseFile(aComponentManifest);

    52 }

    53 

    54 /*!

    55     Destructor.

    56 */

    57 HsWidgetComponentParser::~HsWidgetComponentParser()

    58 {

    59 

    60 }

    61 

    62 /*!

    63     Returns parsed widget component descriptor.

    64 */

    65 HsWidgetComponentDescriptor HsWidgetComponentParser::widgetComponentDescriptor()

    66 {

    67     return mComponentDescriptor;

    68 }

    69 

    70 /*!

    71     Returns true if error occurred in parsing.

    72 */

    73 bool HsWidgetComponentParser::error()

    74 {

    75     return mError;

    76 }

    77 

    78 /*!

    79     Parse widget component descriptor from \a aComponentManifest file.

    80 */

    81 void HsWidgetComponentParser::parseFile(const QString &aComponentManifest)

    82 {

    83     QFile file(aComponentManifest);

    84     if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {

    85         mError = true;

    86         return;

    87     }

    88     mParser.setDevice(&file);

    89     if (mParser.readNextStartElement()) {

    90         if (mParser.name() == WIDGETMANIFEST){

    91              parseWidgetManifestTag();

    92         } else if(mParser.name() == WIDGETPROVIDER){

    93             parseWidgetProviderTag();

    94         } else {

    95             mParser.raiseError(QObject::tr("Malformed manifest"));

    96         }

    97     } else {

    98         mParser.raiseError(QObject::tr("Malformed manifest"));

    99     }

   100     mError = mParser.error();

   101 

   102 }

   103 

   104 /*!

   105     Parse manifest tag.

   106 */

   107 void HsWidgetComponentParser::parseWidgetManifestTag()

   108 {

   109     Q_ASSERT(mParser.isStartElement() && mParser.name() == WIDGETMANIFEST);

   110     

   111     /* Detect version */

   112     if (mParser.attributes().hasAttribute(VERSION)) {

   113         QStringRef version = mParser.attributes().value(VERSION);

   114         mComponentDescriptor.setVersion(version.toString());

   115         if (version == VERSION_1_0) { 

   116             parseVersion1_0();

   117         } else {

   118             mParser.raiseError(QObject::tr("Unsupported version"));

   119         }

   120         

   121     } else {

   122         // newest is default

   123         parseVersion1_0();

   124         mComponentDescriptor.setVersion(VERSION_1_0);

   125     }

   126 }

   127 

   128 /*!

   129     Parse provider tag.

   130 */

   131 void HsWidgetComponentParser::parseWidgetProviderTag()

   132 {

   133     Q_ASSERT(mParser.isStartElement() && mParser.name() == WIDGETPROVIDER);

   134     if (!mParser.readNextStartElement() || mParser.name() != WIDGET) {

   135         mParser.raiseError(QObject::tr("Malformed manifest"));

   136         return;

   137     }

   138    

   139     // everything is in attributes

   140     QXmlStreamAttributes attrs = mParser.attributes();

   141     foreach (QXmlStreamAttribute attr, attrs) {

   142         QStringRef name = attr.name();

   143         if (name == URI) {

   144             mComponentDescriptor.setUri(attr.value().toString());

   145         } else if (name == ICONURI) {

   146             mComponentDescriptor.setIconUri(attr.value().toString());   

   147         } else if (name == TITLE) {

   148             mComponentDescriptor.setTitle(attr.value().toString());    

   149         } else if (name == DESCRIPTION) {

   150             mComponentDescriptor.setDescription(attr.value().toString());

   151         } else if (name == HIDDEN) {

   152             mComponentDescriptor.setHidden(attr.value().toString());

   153         } 

   154     }

   155 

   156 }

   157 /*!

   158     Parse version 1.0.

   159 */

   160 void HsWidgetComponentParser::parseVersion1_0()

   161 {

   162     Q_ASSERT(mParser.isStartElement() && mParser.name() == WIDGETMANIFEST);

   163     /* We'll parse the XML until we reach </hswidgetmanifest> tag, end of cml or have an error. */

   164 	while( !(mParser.tokenType() == QXmlStreamReader::EndElement && mParser.name() == WIDGETMANIFEST) && 

   165         !mParser.hasError() && !mParser.atEnd()) {

   166         

   167         mParser.readNext();

   168         if (mParser.tokenType() != QXmlStreamReader::StartElement) {

   169             continue;

   170         }

   171 		/* Read next start element.*/

   172 	    QStringRef tag = mParser.name();

   173 		if(tag == URI) {

   174 			parseUri();

   175         } else if (tag == ICON) {

   176             parseIcon();

   177         } else if (tag == TITLE) {

   178             parseTitle();

   179         } else if (tag == DESCRIPTION) {

   180             parseDescription();

   181         } else if (tag == HIDDEN) {

   182             parseHidden();

   183         } else if (tag == SERVICEXML) {

   184             parseServiceXml();

   185         } else if (tag == TRANSLATIONFILE) {

   186             parseTranslationFilename();

   187         }        

   188 	}

   189 }

   190 

   191 

   192 /*!

   193     Parse uri.

   194 */

   195 void HsWidgetComponentParser::parseUri()

   196 {

   197     mParser.readNext();

   198     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   199 		return;

   200 	}

   201     mComponentDescriptor.setUri(mParser.text().toString());

   202 }

   203 

   204 /*!

   205     Parse icon.

   206 */

   207 void HsWidgetComponentParser::parseIcon()

   208 {

   209     mParser.readNext();

   210     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   211 		return;

   212 	}

   213     mComponentDescriptor.setIconUri(mParser.text().toString());

   214 }

   215 

   216 /*!

   217     Parse title.

   218 */

   219 void HsWidgetComponentParser::parseTitle()

   220 {

   221     mParser.readNext();

   222     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   223 		return;

   224 	}

   225     mComponentDescriptor.setTitle(mParser.text().toString());

   226 }

   227 

   228 /*!

   229     Parse description.

   230 */

   231 void HsWidgetComponentParser::parseDescription()

   232 {

   233     mParser.readNext();

   234     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   235 		return;

   236 	}

   237     mComponentDescriptor.setDescription(mParser.text().toString());

   238 }

   239 

   240 /*!

   241     Parse hidden.

   242 */

   243 void HsWidgetComponentParser::parseHidden()

   244 {

   245     mParser.readNext();

   246     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   247 		return;

   248 	}

   249     mComponentDescriptor.setHidden(mParser.text().toString());

   250 }

   251 

   252 /*!

   253     Parse service xml.

   254 */

   255 void HsWidgetComponentParser::parseServiceXml()

   256 {

   257     mParser.readNext();

   258     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   259 		return;

   260 	}

   261     mComponentDescriptor.setServiceXml(mParser.text().toString());

   262 }

   263 /*!

   264     Parse service translation file name.

   265 */

   266 void HsWidgetComponentParser::parseTranslationFilename()

   267 {

   268     mParser.readNext();

   269     if(mParser.tokenType() != QXmlStreamReader::Characters) {

   270 		return;

   271 	}

   272     mComponentDescriptor.setTranslationFilename(mParser.text().toString());

   273 }