scripting/source/storage/ScriptMetadataImporter.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ScriptMetadataImporter.cxx,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_scripting.hxx"
  33
  34 #ifdef _DEBUG
  35 #include <stdio.h>
  36 #endif
  37
  38 #include "ScriptMetadataImporter.hxx"
  39
  40 #include <osl/mutex.hxx>
  41
  42 #include <com/sun/star/xml/sax/XParser.hpp>
  43 #include <rtl/string.h>
  44
  45
  46 #include <util/util.hxx>
  47
  48 using namespace ::rtl;
  49 using namespace ::com::sun::star;
  50 using namespace ::com::sun::star::uno;
  51
  52 namespace scripting_impl
  53 {
  54 //*************************************************************************
  55 ScriptMetadataImporter::ScriptMetadataImporter(
  56     const Reference< XComponentContext > & xContext )
  57     : m_xContext( xContext )
  58 {
  59     OSL_TRACE( "< ScriptMetadataImporter ctor called >\n" );
  60     ms_localeDesc = new OUStringBuffer();
  61 }
  62
  63 //*************************************************************************
  64 ScriptMetadataImporter::~ScriptMetadataImporter() SAL_THROW( () )
  65 {
  66     OSL_TRACE( "< ScriptMetadataImporter dtor called >\n" );
  67     delete ms_localeDesc;
  68 }
  69
  70
  71 //*************************************************************************
  72 void ScriptMetadataImporter::parseMetaData(
  73     Reference< io::XInputStream > const & xInput,
  74     const ::rtl::OUString & parcelURI,
  75     InfoImpls_vec &  io_ScriptDatas )
  76     throw ( xml::sax::SAXException, io::IOException, RuntimeException )
  77 {
  78
  79     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
  80
  81     mpv_ScriptDatas = &io_ScriptDatas;
  82     mpv_ScriptDatas->clear();
  83
  84     //Set the placeholder for the parcel URI
  85     ms_parcelURI = parcelURI;
  86
  87     //Get the parser service
  88     validateXRef( m_xContext,
  89         "ScriptMetadataImporter::parseMetaData: No context available" );
  90
  91     Reference< lang::XMultiComponentFactory > xMgr =
  92         m_xContext->getServiceManager();
  93
  94     validateXRef( xMgr,
  95         "ScriptMetadataImporter::parseMetaData: No service manager available" );
  96
  97     Reference< XInterface > xInterface = xMgr->createInstanceWithContext(
  98         OUString::createFromAscii( "com.sun.star.xml.sax.Parser" ), m_xContext );
  99
 100     validateXRef( xInterface, "ScriptMetadataImporter::parseMetaData: cannot get SAX Parser" );
 101     Reference< xml::sax::XParser > xParser;
 102     try
 103     {
 104         xParser.set( xInterface ,UNO_QUERY_THROW );
 105     }
 106     catch (RuntimeException & re )
 107     {
 108         OUString msg = OUString::createFromAscii(
 109             "ScriptMetadata:Importer::parserMetaData cannot get XParser" );
 110         msg.concat( re.Message );
 111         throw RuntimeException( msg, Reference< XInterface > () );
 112     }
 113
 114     // xxx todo: error handler, entity resolver omitted
 115     // This class is the document handler for the parser
 116     Reference< xml::sax::XDocumentHandler > t_smI( this );
 117     xParser->setDocumentHandler( t_smI );
 118
 119     //Set up the input for the parser, the XInputStream
 120     xml::sax::InputSource source;
 121     source.aInputStream = xInput;
 122     source.sSystemId = OUSTR( "virtual file" );
 123
 124     OSL_TRACE( "ScriptMetadataImporter: Start the parser\n" );
 125
 126     try
 127     {
 128         xParser->parseStream( source );
 129     }
 130     catch ( xml::sax::SAXException & saxe )
 131     {
 132         OUString msg = OUString::createFromAscii(
 133             "ScriptMetadata:Importer::parserMetaData SAXException" );
 134         msg.concat( saxe.Message );
 135         throw xml::sax::SAXException( msg, Reference< XInterface > (),
 136             saxe.WrappedException );
 137     }
 138     catch ( io::IOException & ioe )
 139     {
 140         throw io::IOException( OUString::createFromAscii(
 141             "ScriptMetadataImporter::parseMetaData IOException: " ) + ioe.Message,
 142             Reference< XInterface > () );
 143     }
 144
 145 #ifdef _DEBUG
 146     catch ( ... )
 147     {
 148         throw RuntimeException( OUString::createFromAscii(
 149             "ScriptMetadataImporter::parseMetadata UnknownException: " ),
 150             Reference< XInterface > () );
 151     }
 152 #endif
 153
 154     OSL_TRACE( "ScriptMetadataImporter: Parser finished\n ");
 155
 156     OSL_TRACE(  "ScriptMetadataImporter: vector size is %d\n",
 157         mpv_ScriptDatas->size() );
 158 }
 159
 160 //*************************************************************************
 161 // XExtendedDocumentHandler impl
 162 void ScriptMetadataImporter::startCDATA()
 163     throw ( xml::sax::SAXException, RuntimeException )
 164 {
 165     OSL_TRACE( "ScriptMetadataImporter: startCDATA()\n" );
 166 }
 167
 168 //*************************************************************************
 169 void ScriptMetadataImporter::endCDATA()
 170     throw ( RuntimeException )
 171 {
 172     OSL_TRACE( "ScriptMetadataImporter: endDATA()\n" );
 173 }
 174
 175 //*************************************************************************
 176 void ScriptMetadataImporter::comment( const ::rtl::OUString & sComment )
 177     throw ( xml::sax::SAXException, RuntimeException )
 178 {
 179     OSL_TRACE( "ScriptMetadataImporter: comment()\n" );
 180 }
 181
 182 //*************************************************************************
 183 void ScriptMetadataImporter::allowLineBreak()
 184     throw ( xml::sax::SAXException, RuntimeException )
 185 {
 186     OSL_TRACE( "ScriptMetadataImporter: allowLineBreak()\n" );
 187 }
 188
 189 //*************************************************************************
 190 void ScriptMetadataImporter::unknown( const ::rtl::OUString & sString )
 191     throw ( xml::sax::SAXException, RuntimeException )
 192 {
 193     OSL_TRACE( "ScriptMetadataImporter: unknown()\n" );
 194 }
 195
 196 //*************************************************************************
 197 // XDocumentHandler impl
 198 void ScriptMetadataImporter::startDocument()
 199     throw ( xml::sax::SAXException, RuntimeException )
 200 {
 201     // Ignore for now
 202     OSL_TRACE( "ScriptMetadataImporter: startDocument()\n" );
 203 }
 204
 205 //*************************************************************************
 206 void ScriptMetadataImporter::endDocument()
 207     throw ( xml::sax::SAXException, RuntimeException )
 208 {
 209     // Ignore for now
 210     OSL_TRACE( "ScriptMetadataImporter: endDocument()\n" );
 211 }
 212
 213 //*************************************************************************
 214 void ScriptMetadataImporter::startElement(
 215     const ::rtl::OUString& tagName,
 216     const Reference< xml::sax::XAttributeList >& xAttribs )
 217     throw ( xml::sax::SAXException, RuntimeException )
 218 {
 219
 220     OSL_TRACE(  "Trace Message : ScriptMetadataImporter: startElement() %s\n",
 221            ::rtl::OUStringToOString( tagName,
 222                                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 223
 224     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
 225
 226     //Set the state of the state machine
 227     setState( tagName );
 228
 229     //Processing the elements
 230     switch( m_state )
 231     {
 232         case SCRIPT:
 233             m_ScriptData.parcelURI = ms_parcelURI;
 234             m_ScriptData.language = xAttribs->getValueByName(
 235                 ::rtl::OUString::createFromAscii( "language" ));
 236             OSL_TRACE(  "Trace Message: language is %s\n",
 237                 ::rtl::OUStringToOString( m_ScriptData.language,
 238                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 239             break;
 240         case LOCALE:
 241             ms_localeLang = xAttribs->getValueByName(
 242                ::rtl::OUString::createFromAscii( "lang" ) );
 243             OSL_TRACE(  "Trace Message: Locale is %s\n",
 244                 ::rtl::OUStringToOString( ms_localeLang,
 245                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 246             break;
 247         case DISPLAYNAME:
 248             ms_localeDisName = xAttribs->getValueByName(
 249                ::rtl::OUString::createFromAscii( "value" ));
 250             OSL_TRACE(  "Trace Message: Displyaname is %s\n",
 251                 ::rtl::OUStringToOString( ms_localeDisName,
 252                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 253             break;
 254         case FUNCTIONNAME:
 255             m_ScriptData.functionname = xAttribs->getValueByName(
 256                ::rtl::OUString::createFromAscii( "value" ) );
 257             OSL_TRACE(  "Trace Message: Functionname is %s\n",
 258                 ::rtl::OUStringToOString( m_ScriptData.functionname,
 259                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 260             break;
 261         case LOGICALNAME:
 262             m_ScriptData.logicalname = xAttribs->getValueByName(
 263                ::rtl::OUString::createFromAscii( "value" ));
 264 #ifdef _DEBUG
 265             fprintf(stderr, "Trace Message: logicalname is %s\n",
 266                 ::rtl::OUStringToOString( m_ScriptData.logicalname,
 267                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 268 #endif
 269             break;
 270         case LANGDEPPROPS:
 271              m_ScriptData.languagedepprops.push_back(
 272                 ::std::make_pair( xAttribs->getValueByName(
 273                      ::rtl::OUString::createFromAscii( "name" ) ),
 274                  xAttribs->getValueByName(
 275                      ::rtl::OUString::createFromAscii( "value" ) )
 276                  ));
 277             OSL_TRACE(  "Trace Message: Langdepprops is %s\t%s\n",
 278                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 279                    ::rtl::OUString::createFromAscii( "name" ) ),
 280                    RTL_TEXTENCODING_ASCII_US ).pData->buffer,
 281                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 282                    ::rtl::OUString::createFromAscii( "value" ) ),
 283                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 284              break;
 285         case FILESET:
 286             ms_filesetname = xAttribs->getValueByName(
 287                ::rtl::OUString::createFromAscii( "name" ) );
 288             OSL_TRACE(  "Trace Message: filesetname is %s\n",
 289                 ::rtl::OUStringToOString(ms_filesetname,
 290                     RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 291             break;
 292         case FILESETPROPS:
 293             mv_filesetprops.push_back( ::std::make_pair(
 294                 xAttribs->getValueByName(
 295                     ::rtl::OUString::createFromAscii( "name" ) ),
 296                 xAttribs->getValueByName(
 297                     ::rtl::OUString::createFromAscii( "value" ) )
 298                 ));
 299             OSL_TRACE(  "Trace Message: filesetprops is %s\t%s\n",
 300                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 301                    ::rtl::OUString::createFromAscii( "name" ) ),
 302                    RTL_TEXTENCODING_ASCII_US ).pData->buffer,
 303                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 304                    ::rtl::OUString::createFromAscii( "value" ) ),
 305                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 306             break;
 307         case FILES:
 308             ms_filename = xAttribs->getValueByName(
 309                 ::rtl::OUString::createFromAscii( "name" ) );
 310             OSL_TRACE(  "Trace Message: filename is %s\n",
 311                 ::rtl::OUStringToOString( ms_filename,
 312                     RTL_TEXTENCODING_ASCII_US).pData->buffer );
 313             break;
 314         case FILEPROPS:
 315             /**
 316             mm_files.insert( strpair_pair( ms_filename,
 317                 str_pair( xAttribs->getValueByName(
 318                     ::rtl::OUString::createFromAscii( "name" ) ),
 319                 xAttribs->getValueByName(
 320                     ::rtl::OUString::createFromAscii( "value") ) )
 321                 )
 322             );
 323             */
 324             mv_fileprops.push_back(str_pair( xAttribs->getValueByName(
 325                 ::rtl::OUString::createFromAscii( "name" ) ),
 326                 xAttribs->getValueByName(
 327                 ::rtl::OUString::createFromAscii( "value") ) ) );
 328             OSL_TRACE(  "Trace Message: fileprops is %s\t%s\n",
 329                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 330                    ::rtl::OUString::createFromAscii( "name" ) ),
 331                    RTL_TEXTENCODING_ASCII_US ).pData->buffer,
 332                 ::rtl::OUStringToOString( xAttribs->getValueByName(
 333                    ::rtl::OUString::createFromAscii( "value" ) ),
 334                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 335             break;
 336
 337         // to prevent compiler warnings
 338         case PARCEL:
 339         case DESCRIPTION:
 340         case LANGUAGEDEPPROPS:
 341             break;
 342     }
 343 }
 344
 345 //*************************************************************************
 346 void ScriptMetadataImporter::endElement( const ::rtl::OUString & aName )
 347     throw ( xml::sax::SAXException, RuntimeException )
 348 {
 349
 350     //The end tag of an element
 351     OSL_TRACE(  "ScriptMetadataImporter: endElement() %s\n",
 352         ::rtl::OUStringToOString( aName,
 353             RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 354
 355     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
 356
 357     //Set the state
 358     setState( aName );
 359
 360
 361     switch ( m_state )
 362     {
 363         case PARCEL:
 364             break;
 365         case SCRIPT:
 366         // np adjust logicalName to be equal to function name
 367         // as logical name concept has been removed
 368         m_ScriptData.logicalname = m_ScriptData.functionname;
 369             mpv_ScriptDatas->push_back( m_ScriptData );
 370             m_ScriptData =  ScriptData();
 371             break;
 372         case LOCALE:
 373             m_ScriptData.locales[ ms_localeLang ] = ::std::make_pair(
 374                 ms_localeDisName, ms_localeDesc->makeStringAndClear().trim() );
 375             break;
 376         case FILESET:
 377             OSL_TRACE("adding fileset %s to filesets map",
 378                    ::rtl::OUStringToOString( ms_filesetname,
 379                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 380             m_ScriptData.filesets[ ms_filesetname ] = ::std::make_pair(
 381                 mv_filesetprops, mm_files );
 382             mm_files.clear();
 383             mv_filesetprops.clear();
 384             break;
 385         case FILES:
 386             OSL_TRACE("adding files %s to files map",
 387                    ::rtl::OUStringToOString( ms_filename,
 388                    RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 389             mm_files[ ms_filename ] = mv_fileprops;
 390             mv_fileprops.clear();
 391             break;
 392             //
 393         // to prevent compiler warnings
 394         case DISPLAYNAME:
 395         case DESCRIPTION:
 396         case FUNCTIONNAME:
 397         case LOGICALNAME:
 398         case LANGUAGEDEPPROPS:
 399         case LANGDEPPROPS:
 400         case FILESETPROPS:
 401         case FILEPROPS:
 402             break;
 403     }
 404 }
 405
 406 //*************************************************************************
 407 void ScriptMetadataImporter::characters( const ::rtl::OUString & aChars )
 408     throw ( xml::sax::SAXException, RuntimeException )
 409 {
 410     OSL_TRACE( "ScriptMetadataImporter: characters()\n");
 411
 412     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
 413
 414     switch ( m_state )
 415     {
 416         case DESCRIPTION:
 417             //Put description into the struct
 418             ms_localeDesc->append(aChars);
 419             break;
 420         case PARCEL:
 421         case SCRIPT:
 422         case LOCALE:
 423         case DISPLAYNAME:
 424         case FUNCTIONNAME:
 425         case LOGICALNAME:
 426         case LANGUAGEDEPPROPS:
 427         case LANGDEPPROPS:
 428         case FILESETPROPS:
 429         case FILEPROPS:
 430             break;
 431     }
 432 }
 433
 434 //*************************************************************************
 435 void ScriptMetadataImporter::ignorableWhitespace(
 436     const ::rtl::OUString & aWhitespaces )
 437     throw ( xml::sax::SAXException, RuntimeException )
 438 {
 439     OSL_TRACE( "ScriptMetadataImporter: ignorableWhiteSpace()\n" );
 440 }
 441
 442 //*************************************************************************
 443 void ScriptMetadataImporter::processingInstruction(
 444     const ::rtl::OUString & aTarget, const ::rtl::OUString & aData )
 445     throw ( xml::sax::SAXException, RuntimeException )
 446 {
 447     OSL_TRACE( "ScriptMetadataImporter: processingInstruction()\n" );
 448 }
 449
 450 //*************************************************************************
 451 void ScriptMetadataImporter::setDocumentLocator(
 452     const Reference< xml::sax::XLocator >& xLocator )
 453     throw ( xml::sax::SAXException, RuntimeException )
 454 {
 455     OSL_TRACE( "ScriptMetadataImporter: setDocumentLocator()\n" );
 456 }
 457
 458 //*************************************************************************
 459 void ScriptMetadataImporter::setState( const ::rtl::OUString & tagName )
 460 {
 461     //Set the state depending on the tag name of the current
 462     //element the parser has arrived at
 463     ::osl::Guard< ::osl::Mutex > aGuard( m_mutex );
 464
 465     if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "parcel" ) ) )
 466     {
 467         //Parcel tag
 468         m_state = PARCEL;
 469     }
 470     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "script" ) ) )
 471     {
 472         m_state = SCRIPT;
 473     }
 474     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "locale" ) ) )
 475     {
 476         m_state = LOCALE;
 477     }
 478     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "displayname" ) ) )
 479     {
 480         m_state = DISPLAYNAME;
 481     }
 482     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "description" ) ) )
 483     {
 484         m_state = DESCRIPTION;
 485     }
 486     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "functionname" ) ) )
 487     {
 488         m_state = FUNCTIONNAME;
 489     }
 490     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "logicalname" ) ) )
 491     {
 492         m_state = LOGICALNAME;
 493     }
 494     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "languagedepprops" ) ) )
 495     {
 496         m_state = LANGUAGEDEPPROPS;
 497     }
 498     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "prop" ) ) )
 499     {
 500         if( m_state == LANGUAGEDEPPROPS )
 501         {
 502             m_state = LANGDEPPROPS;
 503         }
 504         else if( m_state == FILESET )
 505         {
 506             m_state = FILESETPROPS;
 507         }
 508         else if( m_state == FILES )
 509         {
 510             m_state = FILEPROPS;
 511         }
 512     }
 513     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "fileset" ) ) )
 514     {
 515         m_state = FILESET;
 516     }
 517     else if( tagName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "file" ) ) )
 518     {
 519         m_state = FILES;
 520     }
 521     else
 522     {
 523         //If there is a tag we don't know about, throw a exception (wobbler) :)
 524         ::rtl::OUString str_sax = ::rtl::OUString::createFromAscii( "No Such Tag" );
 525
 526         OSL_TRACE(  "ScriptMetadataImporter: No Such Tag: %s\n",
 527             ::rtl::OUStringToOString(
 528                 tagName, RTL_TEXTENCODING_ASCII_US ).pData->buffer );
 529
 530         throw xml::sax::SAXException(
 531             str_sax, Reference< XInterface >(), Any() );
 532     }
 533 }
 534
 535 }