shell/source/all/ooofilereader/metainforeader.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: metainforeader.cxx,v $
  10  * $Revision: 1.7 $
  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_shell.hxx"
  33 #include "internal/metainforeader.hxx"
  34 #include "dummytag.hxx"
  35 #include "simpletag.hxx"
  36 #include "keywordstag.hxx"
  37
  38 #include "assert.h"
  39
  40 /** constructor.
  41 */
  42 CMetaInfoReader::CMetaInfoReader( const std::string& DocumentName ):
  43 CBaseReader( DocumentName )
  44 {
  45     try
  46     {
  47         m_pKeywords_Builder = new CKeywordsTag( );
  48         m_pSimple_Builder = new CSimpleTag( );
  49         m_pDummy_Builder   = new CDummyTag( );
  50
  51         //retrieve all infomation that is useful
  52         m_AllMetaInfo[META_INFO_AUTHOR]               = EMPTY_XML_TAG;
  53         m_AllMetaInfo[META_INFO_TITLE]                = EMPTY_XML_TAG;
  54         m_AllMetaInfo[META_INFO_SUBJECT]              = EMPTY_XML_TAG;
  55         m_AllMetaInfo[META_INFO_KEYWORDS]             = EMPTY_XML_TAG;
  56         m_AllMetaInfo[META_INFO_DESCRIPTION]          = EMPTY_XML_TAG;
  57         m_AllMetaInfo[META_INFO_DOCUMENT_STATISTIC]   = EMPTY_XML_TAG;
  58
  59         m_AllMetaInfo[META_INFO_GENERATOR]            = EMPTY_XML_TAG;
  60         m_AllMetaInfo[META_INFO_CREATION]             = EMPTY_XML_TAG;
  61         m_AllMetaInfo[META_INFO_CREATOR]              = EMPTY_XML_TAG;
  62         m_AllMetaInfo[META_INFO_MODIFIED]             = EMPTY_XML_TAG;
  63         m_AllMetaInfo[META_INFO_LANGUAGE]             = EMPTY_XML_TAG;
  64         m_AllMetaInfo[META_INFO_DOCUMENT_NUMBER]      = EMPTY_XML_TAG;
  65         m_AllMetaInfo[META_INFO_EDITING_TIME]         = EMPTY_XML_TAG;
  66
  67         Initialize( META_CONTENT_NAME );
  68     }
  69     catch(xml_parser_exception&
  70     #if OSL_DEBUG_LEVEL > 0
  71     ex
  72     #endif
  73     )
  74     {
  75         ENSURE(false, ex.what());
  76     }
  77     catch(...)
  78     {
  79         ENSURE(false, "Unknown error");
  80     }
  81 }
  82
  83 CMetaInfoReader::CMetaInfoReader( void* stream, zlib_filefunc_def* fa) :
  84 CBaseReader( stream, fa)
  85 {
  86 try
  87     {
  88         m_pKeywords_Builder = new CKeywordsTag( );
  89         m_pSimple_Builder = new CSimpleTag( );
  90         m_pDummy_Builder   = new CDummyTag( );
  91
  92         //retrieve all infomation that is useful
  93         m_AllMetaInfo[META_INFO_AUTHOR]               = EMPTY_XML_TAG;
  94         m_AllMetaInfo[META_INFO_TITLE]                = EMPTY_XML_TAG;
  95         m_AllMetaInfo[META_INFO_SUBJECT]              = EMPTY_XML_TAG;
  96         m_AllMetaInfo[META_INFO_KEYWORDS]             = EMPTY_XML_TAG;
  97         m_AllMetaInfo[META_INFO_DESCRIPTION]          = EMPTY_XML_TAG;
  98         m_AllMetaInfo[META_INFO_DOCUMENT_STATISTIC]   = EMPTY_XML_TAG;
  99
 100         m_AllMetaInfo[META_INFO_GENERATOR]            = EMPTY_XML_TAG;
 101         m_AllMetaInfo[META_INFO_CREATION]             = EMPTY_XML_TAG;
 102         m_AllMetaInfo[META_INFO_CREATOR]              = EMPTY_XML_TAG;
 103         m_AllMetaInfo[META_INFO_MODIFIED]             = EMPTY_XML_TAG;
 104         m_AllMetaInfo[META_INFO_LANGUAGE]             = EMPTY_XML_TAG;
 105         m_AllMetaInfo[META_INFO_DOCUMENT_NUMBER]      = EMPTY_XML_TAG;
 106         m_AllMetaInfo[META_INFO_EDITING_TIME]         = EMPTY_XML_TAG;
 107
 108         Initialize( META_CONTENT_NAME );
 109     }
 110     catch(xml_parser_exception&
 111     #if OSL_DEBUG_LEVEL > 0
 112     ex
 113     #endif
 114     )
 115     {
 116         ENSURE(false, ex.what());
 117     }
 118     catch(...)
 119     {
 120         ENSURE(false, "Unknown error");
 121     }
 122
 123 }
 124
 125 /** destructor.
 126 */
 127
 128 CMetaInfoReader::~CMetaInfoReader( void )
 129 {
 130     delete m_pKeywords_Builder;
 131     delete m_pSimple_Builder;
 132     delete m_pDummy_Builder;
 133 }
 134
 135
 136 /***********************   export functions  ***********************/
 137
 138 /** check if the Tag is in the target meta.xml file.
 139
 140     @param TagName
 141     the name of the tag that will be retrive.
 142 */
 143 bool CMetaInfoReader::hasTag( std::wstring TagName ) const
 144 {
 145     return ( m_AllMetaInfo.find(TagName) != m_AllMetaInfo.end());
 146 }
 147
 148 /** Get a specific tag content, compound tags will be returned as comma separated list.
 149
 150     @param TagName
 151     the name of the tag that will be retrive.
 152 */
 153 std::wstring CMetaInfoReader::getTagData( const std::wstring& TagName)
 154 {
 155     if( hasTag( TagName ) )
 156         return m_AllMetaInfo[TagName].first;
 157     else
 158         return EMPTY_STRING;
 159 }
 160
 161 /** check if the a tag has the specific attribute.
 162
 163     @param TagName
 164     the name of the tag.
 165     @param AttributeName
 166     the name of the attribute.
 167 */
 168 bool CMetaInfoReader::hasTagAttribute( const std::wstring TagName,  std::wstring AttributeName)
 169 {
 170     return ( m_AllMetaInfo[TagName].second.find( AttributeName) != m_AllMetaInfo[TagName].second.end() );
 171 }
 172
 173 /** Get a specific attribute content.
 174
 175     @param TagName
 176     the name of the tag.
 177     @param AttributeName
 178     the name of the attribute.
 179 */
 180 std::wstring CMetaInfoReader::getTagAttribute( const std::wstring TagName,  std::wstring AttributeName)
 181 {
 182     if ( hasTagAttribute( TagName, AttributeName ) )
 183         return  m_AllMetaInfo[ TagName ].second[AttributeName];
 184     else
 185         return EMPTY_STRING;
 186 }
 187
 188 /** helper function for getDefaultLocale().
 189 */
 190 const LocaleSet_t EN_US_LOCALE( ::std::make_pair( ::std::wstring( L"en" ),  ::std::wstring( L"US" )));
 191
 192 bool isValidLocale ( ::std::wstring Locale )
 193 {
 194     return ( Locale.length() == 5 );
 195 }
 196
 197 /** Get the default language of the whole document, if no such field, en-US is returned.
 198 */
 199 LocaleSet_t CMetaInfoReader::getDefaultLocale()
 200 {
 201     if (hasTag(META_INFO_LANGUAGE))
 202     {
 203         ::std::wstring locale = m_AllMetaInfo[META_INFO_LANGUAGE].first;
 204         return isValidLocale(locale) ? ::std::make_pair(locale.substr( 0,2), locale.substr( 3,2)) : EN_US_LOCALE;
 205     }
 206     else
 207         return EN_US_LOCALE;
 208 }
 209
 210 /***********************   tag related functions  ***********************/
 211
 212 /** choose an appropriate tag reader
 213 */
 214
 215 ITag* CMetaInfoReader::chooseTagReader( const std::wstring& tag_name, const XmlTagAttributes_t& XmlAttributes )
 216 {
 217     if ( tag_name == META_INFO_KEYWORD )
 218     {
 219         m_AllMetaInfo[META_INFO_KEYWORDS].second = XmlAttributes;
 220         return m_pKeywords_Builder;
 221     }
 222     if (( tag_name == META_INFO_TITLE )||( tag_name == META_INFO_AUTHOR )||( tag_name == META_INFO_SUBJECT )||( tag_name == META_INFO_DESCRIPTION )||
 223         ( tag_name == META_INFO_DOCUMENT_STATISTIC )||( tag_name == META_INFO_GENERATOR )||( tag_name == META_INFO_CREATION )||( tag_name == META_INFO_CREATOR )||
 224         ( tag_name == META_INFO_MODIFIED )||( tag_name == META_INFO_LANGUAGE )||( tag_name == META_INFO_DOCUMENT_NUMBER )||( tag_name == META_INFO_EDITING_TIME ) )
 225     {
 226         m_AllMetaInfo[tag_name].second = XmlAttributes;
 227         return m_pSimple_Builder;
 228     }
 229     else
 230         return m_pDummy_Builder;
 231
 232 }
 233
 234 //------------------------------
 235 // save the received content into structure.
 236 //------------------------------
 237 void CMetaInfoReader::saveTagContent( const std::wstring& tag_name )
 238 {
 239     ITag* pTagBuilder;
 240     if ( tag_name == META_INFO_KEYWORDS )
 241         pTagBuilder = m_pKeywords_Builder;
 242     else if ( tag_name == META_INFO_KEYWORD )
 243     {
 244         // added for support for OASIS xml file format.
 245         m_AllMetaInfo[META_INFO_KEYWORDS].first =m_pKeywords_Builder->getTagContent( );
 246         return;
 247     }
 248     else if (( tag_name == META_INFO_TITLE )||( tag_name == META_INFO_AUTHOR )||( tag_name == META_INFO_SUBJECT )||( tag_name == META_INFO_DESCRIPTION )||
 249         ( tag_name == META_INFO_DOCUMENT_STATISTIC )||( tag_name == META_INFO_GENERATOR )||( tag_name == META_INFO_CREATION )||( tag_name == META_INFO_CREATOR )||
 250         ( tag_name == META_INFO_MODIFIED )||( tag_name == META_INFO_LANGUAGE )||( tag_name == META_INFO_DOCUMENT_NUMBER )||( tag_name == META_INFO_EDITING_TIME ) )
 251         pTagBuilder = m_pSimple_Builder;
 252     else
 253         pTagBuilder = m_pDummy_Builder;
 254
 255     m_AllMetaInfo[tag_name].first =pTagBuilder->getTagContent( );
 256 }
 257
 258
 259 /***********************   event handler functions  ***********************/
 260
 261 //------------------------------
 262 // start_element occurs when a tag is start
 263 //------------------------------
 264
 265 void CMetaInfoReader::start_element(
 266     const std::wstring& /*raw_name*/,
 267     const std::wstring& local_name,
 268     const XmlTagAttributes_t& attributes)
 269 {
 270     //get appropriate Xml Tag Builder using MetaInfoBuilderFactory;
 271     ITag* pTagBuilder = chooseTagReader( local_name,attributes );
 272     assert( pTagBuilder!= NULL );
 273     pTagBuilder->startTag( );
 274     m_TagBuilderStack.push( pTagBuilder );
 275
 276 }
 277
 278 //------------------------------
 279 // end_element occurs when a tag is closed
 280 //------------------------------
 281
 282 void CMetaInfoReader::end_element(const std::wstring& /*raw_name*/, const std::wstring& local_name)
 283 {
 284     assert( !m_TagBuilderStack.empty() );
 285     ITag* pTagBuilder = m_TagBuilderStack.top();
 286     m_TagBuilderStack.pop();
 287     pTagBuilder->endTag();
 288
 289     saveTagContent( local_name );
 290
 291 }
 292
 293 //------------------------------
 294 // characters occurs when receiving characters
 295 //------------------------------
 296
 297 void CMetaInfoReader::characters( const std::wstring& character )
 298 {
 299     if ( character.length() > 0 &&  !HasOnlySpaces( character ) )
 300     {
 301         ITag* pTagBuilder = m_TagBuilderStack.top();
 302         pTagBuilder->addCharacters( character );
 303     }
 304 }
 305