tdoc_datasupplier.cxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
 
/**************************************************************************
                                TODO
 **************************************************************************
 
 *************************************************************************/
 
#include <optional>
 
#include <com/sun/star/ucb/IllegalIdentifierException.hpp>
#include <com/sun/star/ucb/ResultSetException.hpp>
#include <osl/diagnose.h>
#include <ucbhelper/contentidentifier.hxx>
#include <utility>
 
#include "tdoc_datasupplier.hxx"
#include "tdoc_content.hxx"
 
using namespace com::sun::star;
using namespace tdoc_ucp;
 
namespace tdoc_ucp
{
 
 
// struct ResultListEntry.
 
namespace {
 
 
}
 
// struct DataSupplier_Impl.
 
 
}
 
// DataSupplier Implementation.
ResultSetDataSupplier::ResultSetDataSupplier(
                uno::Reference< uno::XComponentContext > xContext,
                rtl::Reference< Content > xContent )
: m_xContent(std::move( xContent )), m_xContext(std::move( xContext )),
  m_bCountFinal( false ), m_bThrowException( false )
{
}
 
// virtual
ResultSetDataSupplier::~ResultSetDataSupplier()
{
}
 
// virtual
OUString
ResultSetDataSupplier::queryContentIdentifierString( sal_uInt32 nIndex )
{
    std::unique_lock aGuard( m_aMutex );
    return queryContentIdentifierStringImpl(aGuard, nIndex);
}
 
OUString
ResultSetDataSupplier::queryContentIdentifierStringImpl( std::unique_lock<std::mutex>& /*rGuard*/, sal_uInt32 nIndex )
{
    if ( nIndex < m_aResults.size() )
    {
        OUString aId = m_aResults[ nIndex ].aURL;
        if ( !aId.isEmpty() )
        {
            // Already cached.
            return aId;
        }
    }
 
    if ( getResult( nIndex ) )
    {
        // Note: getResult fills m_pImpl->m_aResults[ nIndex ]->aURL.
        return m_aResults[ nIndex ].aURL;
    }
    return OUString();
}
 
// virtual
uno::Reference< ucb::XContentIdentifier >
ResultSetDataSupplier::queryContentIdentifier( sal_uInt32 nIndex )
{
    std::unique_lock aGuard( m_aMutex );
    return queryContentIdentifierImpl(aGuard, nIndex);
}
 
uno::Reference< ucb::XContentIdentifier >
ResultSetDataSupplier::queryContentIdentifierImpl( std::unique_lock<std::mutex>& rGuard, sal_uInt32 nIndex )
{
    if ( nIndex < m_aResults.size() )
    {
        uno::Reference< ucb::XContentIdentifier > xId
                                = m_aResults[ nIndex ].xId;
        if ( xId.is() )
        {
            // Already cached.
            return xId;
        }
    }
 
    OUString aId = queryContentIdentifierStringImpl( rGuard, nIndex );
    if ( !aId.isEmpty() )
    {
        uno::Reference< ucb::XContentIdentifier > xId
            = new ::ucbhelper::ContentIdentifier( aId );
        m_aResults[ nIndex ].xId = xId;
        return xId;
    }
    return uno::Reference< ucb::XContentIdentifier >();
}
 
// virtual
uno::Reference< ucb::XContent >
ResultSetDataSupplier::queryContent( sal_uInt32 nIndex )
{
    std::unique_lock aGuard( m_aMutex );
 
    if ( nIndex < m_aResults.size() )
    {
        uno::Reference< ucb::XContent > xContent
                                = m_aResults[ nIndex ].xContent;
        if ( xContent.is() )
        {
            // Already cached.
            return xContent;
        }
    }
 
    uno::Reference< ucb::XContentIdentifier > xId
        = queryContentIdentifierImpl( aGuard, nIndex );
    if ( xId.is() )
    {
        try
        {
            uno::Reference< ucb::XContent > xContent
                = m_xContent->getProvider()->queryContent( xId );
            m_aResults[ nIndex ].xContent = xContent;
            return xContent;
 
        }
        catch ( ucb::IllegalIdentifierException const & )
        {
        }
    }
    return uno::Reference< ucb::XContent >();
}
 
// virtual
bool ResultSetDataSupplier::getResult( sal_uInt32 nIndex )
{
    std::unique_lock aGuard( m_aMutex );
    return getResultImpl(aGuard, nIndex);
}
 
bool ResultSetDataSupplier::getResultImpl( std::unique_lock<std::mutex>& rGuard, sal_uInt32 nIndex )
{
    if ( m_aResults.size() > nIndex )
    {
        // Result already present.
        return true;
    }
 
    // Result not (yet) present.
 
    if ( m_bCountFinal )
        return false;
 
    // Try to obtain result...
 
    sal_uInt32 nOldCount = m_aResults.size();
    bool bFound = false;
 
    if ( queryNamesOfChildren(rGuard) )
    {
        for ( sal_uInt32 n = nOldCount;
              n < sal::static_int_cast<sal_uInt32>(
                      m_xNamesOfChildren->getLength());
              ++n )
        {
            const OUString & rName
                = m_xNamesOfChildren->getConstArray()[ n ];
 
            if ( rName.isEmpty() )
            {
                OSL_FAIL( "ResultDataSupplier::getResult - Empty name!" );
                break;
            }
 
            // Assemble URL for child.
            OUString aURL = assembleChildURL( rName );
 
            m_aResults.emplace_back( aURL );
 
            if ( n == nIndex )
            {
                // Result obtained.
                bFound = true;
                break;
            }
        }
    }
 
    if ( !bFound )
        m_bCountFinal = true;
 
    rtl::Reference< ::ucbhelper::ResultSet > xResultSet = getResultSet();
    if ( xResultSet.is() )
    {
        // Callbacks follow!
        rGuard.unlock();
 
        if ( nOldCount < m_aResults.size() )
            xResultSet->rowCountChanged( nOldCount, m_aResults.size() );
 
        if ( m_bCountFinal )
            xResultSet->rowCountFinal();
 
        rGuard.lock();
    }
 
    return bFound;
}
 
// virtual
sal_uInt32 ResultSetDataSupplier::totalCount()
{
    std::unique_lock aGuard( m_aMutex );
 
    if ( m_bCountFinal )
        return m_aResults.size();
 
    sal_uInt32 nOldCount = m_aResults.size();
 
    if ( queryNamesOfChildren(aGuard) )
    {
        for ( sal_uInt32 n = nOldCount;
              n < sal::static_int_cast<sal_uInt32>(
                      m_xNamesOfChildren->getLength());
              ++n )
        {
            const OUString & rName
                = m_xNamesOfChildren->getConstArray()[ n ];
 
            if ( rName.isEmpty() )
            {
                OSL_FAIL( "ResultDataSupplier::getResult - Empty name!" );
                break;
            }
 
            // Assemble URL for child.
            OUString aURL = assembleChildURL( rName );
 
            m_aResults.emplace_back( aURL );
        }
    }
 
    m_bCountFinal = true;
 
    rtl::Reference< ::ucbhelper::ResultSet > xResultSet = getResultSet();
    if ( xResultSet.is() )
    {
        // Callbacks follow!
        aGuard.unlock();
 
        if ( nOldCount < m_aResults.size() )
            xResultSet->rowCountChanged( nOldCount, m_aResults.size() );
 
        xResultSet->rowCountFinal();
    }
 
    return m_aResults.size();
}
 
// virtual
sal_uInt32 ResultSetDataSupplier::currentCount()
{
    return m_aResults.size();
}
 
// virtual
bool ResultSetDataSupplier::isCountFinal()
{
    return m_bCountFinal;
}
 
// virtual
uno::Reference< sdbc::XRow >
ResultSetDataSupplier::queryPropertyValues( sal_uInt32 nIndex  )
{
    std::unique_lock aGuard( m_aMutex );
 
    if ( nIndex < m_aResults.size() )
    {
        uno::Reference< sdbc::XRow > xRow = m_aResults[ nIndex ].xRow;
        if ( xRow.is() )
        {
            // Already cached.
            return xRow;
        }
    }
 
    if ( getResultImpl( aGuard, nIndex ) )
    {
        uno::Reference< sdbc::XRow > xRow = Content::getPropertyValues(
                        m_xContext,
                        getResultSet()->getProperties(),
                        m_xContent->getContentProvider().get(),
                        queryContentIdentifierStringImpl( aGuard, nIndex ) );
        m_aResults[ nIndex ].xRow = xRow;
        return xRow;
    }
 
    return uno::Reference< sdbc::XRow >();
}
 
// virtual
void ResultSetDataSupplier::releasePropertyValues( sal_uInt32 nIndex )
{
    std::unique_lock aGuard( m_aMutex );
 
    if ( nIndex < m_aResults.size() )
        m_aResults[ nIndex ].xRow.clear();
}
 
// virtual
void ResultSetDataSupplier::close()
{
}
 
// virtual
void ResultSetDataSupplier::validate()
{
    if ( m_bThrowException )
        throw ucb::ResultSetException();
}
 
bool ResultSetDataSupplier::queryNamesOfChildren(std::unique_lock<std::mutex>& /*rGuard*/)
{
    if ( !m_xNamesOfChildren )
    {
        uno::Sequence< OUString > aNamesOfChildren;
 
        if ( !m_xContent->getContentProvider()->queryNamesOfChildren(
                m_xContent->getIdentifier()->getContentIdentifier(),
                aNamesOfChildren ) )
        {
            OSL_FAIL( "Got no list of children!" );
            m_bThrowException = true;
            return false;
        }
        else
        {
            m_xNamesOfChildren = std::move( aNamesOfChildren );
        }
    }
    return true;
}
 
OUString
ResultSetDataSupplier::assembleChildURL( std::u16string_view aName )
{
    OUString aContURL
        = m_xContent->getIdentifier()->getContentIdentifier();
    OUString aURL( aContURL );
 
    sal_Int32 nUrlEnd = aURL.lastIndexOf( '/' );
    if ( nUrlEnd != aURL.getLength() - 1 )
        aURL += "/";
 
    aURL += aName;
    return aURL;
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */