xmloff/source/core/RDFaImportHelper.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <RDFaImportHelper.hxx>
  21
  22 #include <xmloff/xmlimp.hxx>
  23 #include <xmloff/nmspmap.hxx>
  24
  25 #include <comphelper/sequence.hxx>
  26
  27 #include <com/sun/star/rdf/URI.hpp>
  28 #include <com/sun/star/rdf/XDocumentRepository.hpp>
  29 #include <com/sun/star/rdf/XRepositorySupplier.hpp>
  30
  31 #include <rtl/ustring.hxx>
  32 #include <sal/log.hxx>
  33
  34 #include <map>
  35
  36 using namespace ::com::sun::star;
  37
  38 namespace xmloff {
  39
  40 /** a bit of context for parsing RDFa attributes */
  41 class RDFaReader
  42 {
  43     const SvXMLImport & m_rImport;
  44
  45     const SvXMLImport & GetImport() const { return m_rImport; }
  46
  47     //FIXME: this is an ugly hack to workaround buggy SvXMLImport::GetAbsolute
  48     OUString GetAbsoluteReference(OUString const & i_rURI) const
  49     {
  50         if (i_rURI.isEmpty() || i_rURI[0] == '#')
  51         {
  52             return GetImport().GetBaseURL() + i_rURI;
  53         }
  54         else
  55         {
  56             return GetImport().GetAbsoluteReference(i_rURI);
  57         }
  58     }
  59
  60 public:
  61     explicit RDFaReader(SvXMLImport const & i_rImport)
  62         : m_rImport(i_rImport)
  63     { }
  64
  65     // returns URI or blank node!
  66     OUString ReadCURIE(OUString const & i_rCURIE) const;
  67
  68     std::vector< OUString >
  69     ReadCURIEs(OUString const & i_rCURIEs) const;
  70
  71     OUString
  72     ReadURIOrSafeCURIE( OUString const & i_rURIOrSafeCURIE) const;
  73 };
  74
  75 /** helper to insert RDFa statements into the RDF repository */
  76 class RDFaInserter
  77 {
  78     const uno::Reference<uno::XComponentContext> m_xContext;
  79     uno::Reference< rdf::XDocumentRepository > m_xRepository;
  80
  81     typedef ::std::map< OUString, uno::Reference< rdf::XBlankNode > >
  82         BlankNodeMap_t;
  83
  84     BlankNodeMap_t m_BlankNodeMap;
  85
  86 public:
  87     RDFaInserter(uno::Reference<uno::XComponentContext> const & i_xContext,
  88             uno::Reference< rdf::XDocumentRepository > const & i_xRepository)
  89         : m_xContext(i_xContext)
  90         , m_xRepository(i_xRepository)
  91     {}
  92
  93     uno::Reference< rdf::XBlankNode >
  94     LookupBlankNode(OUString const & i_rNodeId );
  95
  96     uno::Reference< rdf::XURI >
  97     MakeURI( OUString const & i_rURI) const;
  98
  99     uno::Reference< rdf::XResource>
 100     MakeResource( OUString const & i_rResource);
 101
 102     void InsertRDFaEntry(struct RDFaEntry const & i_rEntry);
 103 };
 104
 105 /** store parsed RDFa attributes */
 106 struct ParsedRDFaAttributes
 107 {
 108     OUString const m_About;
 109     ::std::vector< OUString > const m_Properties;
 110     OUString const m_Content;
 111     OUString const m_Datatype;
 112
 113     ParsedRDFaAttributes(
 114             OUString const & i_rAbout,
 115             ::std::vector< OUString > const & i_rProperties,
 116             OUString const & i_rContent,
 117             OUString const & i_rDatatype)
 118         : m_About(i_rAbout)
 119         , m_Properties(i_rProperties)
 120         , m_Content(i_rContent)
 121         , m_Datatype(i_rDatatype)
 122     { }
 123 };
 124
 125 /** store metadatable object and its RDFa attributes */
 126 struct RDFaEntry
 127 {
 128     uno::Reference<rdf::XMetadatable> m_xObject;
 129     std::shared_ptr<ParsedRDFaAttributes> m_xRDFaAttributes;
 130
 131     RDFaEntry(uno::Reference<rdf::XMetadatable> const & i_xObject,
 132             std::shared_ptr<ParsedRDFaAttributes> const& i_pRDFaAttributes)
 133         : m_xObject(i_xObject)
 134         , m_xRDFaAttributes(i_pRDFaAttributes)
 135     { }
 136 };
 137
 138 static bool isWS(const sal_Unicode i_Char)
 139 {
 140     return ('\t' == i_Char) || ('\n' == i_Char) || ('\r' == i_Char)
 141         || (' ' == i_Char);
 142 }
 143
 144 static OUString splitAtWS(OUString & io_rString)
 145 {
 146     const sal_Int32 len( io_rString.getLength() );
 147     sal_Int32 idxstt(0);
 148     while ((idxstt < len) && ( isWS(io_rString[idxstt])))
 149         ++idxstt; // skip leading ws
 150     sal_Int32 idxend(idxstt);
 151     while ((idxend < len) && (!isWS(io_rString[idxend])))
 152         ++idxend; // the CURIE
 153     const OUString ret(io_rString.copy(idxstt, idxend - idxstt));
 154     io_rString = io_rString.copy(idxend); // rest
 155     return ret;
 156 }
 157
 158 OUString
 159 RDFaReader::ReadCURIE(OUString const & i_rCURIE) const
 160 {
 161     // the RDFa spec says that a prefix is required (it may be empty: ":foo")
 162     const sal_Int32 idx( i_rCURIE.indexOf(':') );
 163     if (idx >= 0)
 164     {
 165         OUString Prefix;
 166         OUString LocalName;
 167         OUString Namespace;
 168         sal_uInt16 nKey( GetImport().GetNamespaceMap().GetKeyByAttrName_(
 169             i_rCURIE, &Prefix, &LocalName, &Namespace) );
 170         if ( Prefix == "_" )
 171         {
 172             // eeek, it's a bnode!
 173             // "_" is not a valid URI scheme => we can identify bnodes
 174             return i_rCURIE;
 175         }
 176         else
 177         {
 178             SAL_WARN_IF(XML_NAMESPACE_NONE == nKey, "xmloff.core", "no namespace?");
 179             if ((XML_NAMESPACE_UNKNOWN != nKey) &&
 180                 (XML_NAMESPACE_XMLNS   != nKey))
 181             {
 182                 // N.B.: empty LocalName is valid!
 183                 const OUString URI(Namespace + LocalName);
 184                 return GetAbsoluteReference(URI);
 185             }
 186             else
 187             {
 188                 SAL_INFO("xmloff.core", "ReadCURIE: invalid CURIE: invalid prefix" );
 189                 return OUString();
 190             }
 191         }
 192     }
 193     SAL_INFO("xmloff.core", "ReadCURIE: invalid CURIE: no prefix" );
 194     return OUString();
 195 }
 196
 197 ::std::vector< OUString >
 198 RDFaReader::ReadCURIEs(OUString const & i_rCURIEs) const
 199 {
 200     std::vector< OUString > vec;
 201     OUString CURIEs(i_rCURIEs);
 202     do {
 203       OUString curie( splitAtWS(CURIEs) );
 204       if (!curie.isEmpty())
 205       {
 206           const OUString uri(ReadCURIE(curie));
 207           if (!uri.isEmpty())
 208           {
 209               vec.push_back(uri);
 210           }
 211       }
 212     }
 213     while (!CURIEs.isEmpty());
 214     if (vec.empty())
 215     {
 216         SAL_INFO("xmloff.core", "ReadCURIEs: invalid CURIEs" );
 217     }
 218     return vec;
 219 }
 220
 221 OUString
 222 RDFaReader::ReadURIOrSafeCURIE(OUString const & i_rURIOrSafeCURIE) const
 223 {
 224     const sal_Int32 len(i_rURIOrSafeCURIE.getLength());
 225     if (len && (i_rURIOrSafeCURIE[0] == '['))
 226     {
 227         if ((len >= 2) && (i_rURIOrSafeCURIE[len - 1] == ']'))
 228         {
 229             return ReadCURIE(i_rURIOrSafeCURIE.copy(1, len - 2));
 230         }
 231         else
 232         {
 233             SAL_INFO("xmloff.core", "ReadURIOrSafeCURIE: invalid SafeCURIE" );
 234             return OUString();
 235         }
 236     }
 237     else
 238     {
 239         if (i_rURIOrSafeCURIE.startsWith("_:")) // blank node
 240         {
 241             SAL_INFO("xmloff.core", "ReadURIOrSafeCURIE: invalid URI: scheme is _" );
 242             return OUString();
 243         }
 244         else
 245         {
 246             return GetAbsoluteReference(i_rURIOrSafeCURIE);
 247         }
 248     }
 249 }
 250
 251 uno::Reference< rdf::XBlankNode >
 252 RDFaInserter::LookupBlankNode(OUString const & i_rNodeId )
 253 {
 254     uno::Reference< rdf::XBlankNode > & rEntry( m_BlankNodeMap[ i_rNodeId ] );
 255     if (!rEntry.is())
 256     {
 257         rEntry = m_xRepository->createBlankNode();
 258     }
 259     return rEntry;
 260 }
 261
 262 uno::Reference< rdf::XURI >
 263 RDFaInserter::MakeURI( OUString const & i_rURI) const
 264 {
 265     if (i_rURI.startsWith("_:")) // blank node
 266     {
 267         SAL_INFO("xmloff.core", "MakeURI: cannot create URI for blank node");
 268         return nullptr;
 269     }
 270     else
 271     {
 272         try
 273         {
 274             return rdf::URI::create( m_xContext, i_rURI );
 275         }
 276         catch (uno::Exception &)
 277         {
 278             SAL_WARN("xmloff.core", "MakeURI: cannot create URI");
 279             return nullptr;
 280         }
 281     }
 282 }
 283
 284 uno::Reference<rdf::XResource>
 285 RDFaInserter::MakeResource( OUString const & i_rResource)
 286 {
 287     if (i_rResource.startsWith("_:")) // blank node
 288     {
 289         // we cannot use the blank node label as-is: it must be distinct
 290         // from labels in other graphs, so create fresh ones per XML stream
 291         // N.B.: content.xml and styles.xml are distinct graphs
 292         OUString name( i_rResource.copy(2) );
 293         const uno::Reference< rdf::XBlankNode > xBNode( LookupBlankNode(name) );
 294         SAL_WARN_IF(!xBNode.is(), "xmloff.core", "no blank node?");
 295         return xBNode;
 296     }
 297     else
 298     {
 299         return MakeURI( i_rResource );
 300     }
 301 }
 302
 303 void RDFaInserter::InsertRDFaEntry(
 304     struct RDFaEntry const & i_rEntry)
 305 {
 306     SAL_WARN_IF(!i_rEntry.m_xObject.is(), "xmloff.core", "InsertRDFaEntry: invalid arg: null object");
 307     if (!i_rEntry.m_xObject.is()) return;
 308
 309     const uno::Reference< rdf::XResource > xSubject(
 310         MakeResource( i_rEntry.m_xRDFaAttributes->m_About ) );
 311     if (!xSubject.is())
 312     {
 313         return; // invalid
 314     }
 315
 316     ::std::vector< uno::Reference< rdf::XURI > > predicates;
 317
 318     predicates.reserve(i_rEntry.m_xRDFaAttributes->m_Properties.size());
 319
 320     for (OUString const& prop : i_rEntry.m_xRDFaAttributes->m_Properties)
 321     {
 322         auto const xURI(MakeURI(prop));
 323         if (xURI.is())
 324         {
 325             predicates.push_back(xURI);
 326         }
 327     }
 328
 329     if (predicates.empty())
 330     {
 331         return; // invalid
 332     }
 333
 334     uno::Reference<rdf::XURI> xDatatype;
 335     if (!i_rEntry.m_xRDFaAttributes->m_Datatype.isEmpty())
 336     {
 337         xDatatype = MakeURI( i_rEntry.m_xRDFaAttributes->m_Datatype );
 338     }
 339
 340     try
 341     {
 342         // N.B.: this will call xMeta->ensureMetadataReference, which is why
 343         // this must be done _after_ importing the whole XML file,
 344         // to prevent collision between generated ids and ids in the file
 345         m_xRepository->setStatementRDFa(xSubject, comphelper::containerToSequence(predicates),
 346             i_rEntry.m_xObject,
 347             i_rEntry.m_xRDFaAttributes->m_Content, xDatatype);
 348     }
 349     catch (uno::Exception &)
 350     {
 351         SAL_WARN("xmloff.core", "InsertRDFaEntry: setStatementRDFa failed?");
 352     }
 353 }
 354
 355 RDFaImportHelper::RDFaImportHelper(const SvXMLImport & i_rImport)
 356     : m_rImport(i_rImport)
 357 {
 358 }
 359
 360 RDFaImportHelper::~RDFaImportHelper()
 361 {
 362 }
 363
 364 std::shared_ptr<ParsedRDFaAttributes>
 365 RDFaImportHelper::ParseRDFa(
 366     OUString const & i_rAbout,
 367     OUString const & i_rProperty,
 368     OUString const & i_rContent,
 369     OUString const & i_rDatatype)
 370 {
 371     if (i_rProperty.isEmpty())
 372     {
 373         SAL_INFO("xmloff.core", "AddRDFa: invalid input: xhtml:property empty");
 374         return std::shared_ptr<ParsedRDFaAttributes>();
 375     }
 376     // must parse CURIEs here: need namespace declaration context
 377     RDFaReader reader(GetImport());
 378     const OUString about( reader.ReadURIOrSafeCURIE(i_rAbout) );
 379     if (about.isEmpty()) {
 380         return std::shared_ptr<ParsedRDFaAttributes>();
 381     }
 382     const ::std::vector< OUString > properties(
 383         reader.ReadCURIEs(i_rProperty) );
 384     if (properties.empty()) {
 385         return std::shared_ptr<ParsedRDFaAttributes>();
 386     }
 387     const OUString datatype( !i_rDatatype.isEmpty()
 388         ?   reader.ReadCURIE(i_rDatatype)
 389         :   OUString() );
 390     return std::make_shared<ParsedRDFaAttributes>(
 391             about, properties, i_rContent, datatype);
 392 }
 393
 394 void
 395 RDFaImportHelper::AddRDFa(
 396     uno::Reference<rdf::XMetadatable> const & i_xObject,
 397     std::shared_ptr<ParsedRDFaAttributes> const & i_pRDFaAttributes)
 398 {
 399     if (!i_xObject.is())
 400     {
 401         SAL_WARN("xmloff.core", "AddRDFa: invalid arg: null textcontent");
 402         return;
 403     }
 404     if (!i_pRDFaAttributes.get())
 405     {
 406         SAL_WARN("xmloff.core", "AddRDFa: invalid arg: null RDFa attributes");
 407         return;
 408     }
 409     m_RDFaEntries.emplace_back(i_xObject, i_pRDFaAttributes);
 410 }
 411
 412 void
 413 RDFaImportHelper::ParseAndAddRDFa(
 414     uno::Reference<rdf::XMetadatable> const & i_xObject,
 415     OUString const & i_rAbout,
 416     OUString const & i_rProperty,
 417     OUString const & i_rContent,
 418     OUString const & i_rDatatype)
 419 {
 420     std::shared_ptr<ParsedRDFaAttributes> pAttributes(
 421         ParseRDFa(i_rAbout, i_rProperty, i_rContent, i_rDatatype) );
 422     if (pAttributes.get())
 423     {
 424         AddRDFa(i_xObject, pAttributes);
 425     }
 426 }
 427
 428 void RDFaImportHelper::InsertRDFa(
 429     uno::Reference< rdf::XRepositorySupplier> const & i_xModel)
 430 {
 431     SAL_WARN_IF(!i_xModel.is(), "xmloff.core", "InsertRDFa: invalid arg: model null");
 432     if (!i_xModel.is()) return;
 433     const uno::Reference< rdf::XDocumentRepository > xRepository(
 434         i_xModel->getRDFRepository(), uno::UNO_QUERY);
 435     SAL_WARN_IF(!xRepository.is(), "xmloff.core", "InsertRDFa: no DocumentRepository?");
 436     if (!xRepository.is()) return;
 437     RDFaInserter inserter(GetImport().GetComponentContext(), xRepository);
 438     for (const auto& RDFaEntry : m_RDFaEntries)
 439         inserter.InsertRDFaEntry(RDFaEntry);
 440 }
 441
 442 } // namespace xmloff
 443
 444 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */