sc/source/filter/excel/xedbdata.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
  10 #include "xedbdata.hxx"
  11 #include "excrecds.hxx"
  12 #include "xltools.hxx"
  13 #include "dbdata.hxx"
  14 #include "document.hxx"
  15 #include <oox/export/utils.hxx>
  16
  17 using namespace oox;
  18
  19 /** (So far) dummy implementation of table export for BIFF5/BIFF7. */
  20 class XclExpTablesImpl5 : public XclExpTables
  21 {
  22 public:
  23     explicit            XclExpTablesImpl5( const XclExpRoot& rRoot );
  24     virtual             ~XclExpTablesImpl5();
  25
  26     virtual void        Save( XclExpStream& rStrm ) override;
  27     virtual void        SaveXml( XclExpXmlStream& rStrm ) override;
  28 };
  29
  30 /** Implementation of table export for OOXML, so far dummy for BIFF8. */
  31 class XclExpTablesImpl8 : public XclExpTables
  32 {
  33 public:
  34     explicit            XclExpTablesImpl8( const XclExpRoot& rRoot );
  35     virtual             ~XclExpTablesImpl8();
  36
  37     virtual void        Save( XclExpStream& rStrm ) override;
  38     virtual void        SaveXml( XclExpXmlStream& rStrm ) override;
  39 };
  40
  41
  42 XclExpTablesImpl5::XclExpTablesImpl5( const XclExpRoot& rRoot ) :
  43     XclExpTables( rRoot )
  44 {
  45 }
  46
  47 XclExpTablesImpl5::~XclExpTablesImpl5()
  48 {
  49 }
  50
  51 void XclExpTablesImpl5::Save( XclExpStream& /*rStrm*/ )
  52 {
  53     // not implemented
  54 }
  55
  56 void XclExpTablesImpl5::SaveXml( XclExpXmlStream& /*rStrm*/ )
  57 {
  58     // not applicable
  59 }
  60
  61
  62 XclExpTablesImpl8::XclExpTablesImpl8( const XclExpRoot& rRoot ) :
  63     XclExpTables( rRoot )
  64 {
  65 }
  66
  67 XclExpTablesImpl8::~XclExpTablesImpl8()
  68 {
  69 }
  70
  71 void XclExpTablesImpl8::Save( XclExpStream& /*rStrm*/ )
  72 {
  73     // not implemented
  74 }
  75
  76 void XclExpTablesImpl8::SaveXml( XclExpXmlStream& rStrm )
  77 {
  78
  79     sax_fastparser::FSHelperPtr& pWorksheetStrm = rStrm.GetCurrentStream();
  80     pWorksheetStrm->startElement( XML_tableParts, FSEND);
  81     for (auto const& it : maTables)
  82     {
  83         OUString aRelId;
  84         sax_fastparser::FSHelperPtr pTableStrm = rStrm.CreateOutputStream(
  85                 XclXmlUtils::GetStreamName("xl/tables/", "table", it.mnTableId),
  86                 XclXmlUtils::GetStreamName("../tables/", "table", it.mnTableId),
  87                 pWorksheetStrm->getOutputStream(),
  88                 CREATE_XL_CONTENT_TYPE("table"),
  89                 CREATE_OFFICEDOC_RELATION_TYPE("table"),
  90                 &aRelId);
  91
  92         pWorksheetStrm->singleElement( XML_tablePart,
  93                 FSNS(XML_r, XML_id), XclXmlUtils::ToOString(aRelId).getStr(),
  94                 FSEND);
  95
  96         rStrm.PushStream( pTableStrm);
  97         SaveTableXml( rStrm, it);
  98         rStrm.PopStream();
  99     }
 100     pWorksheetStrm->endElement( XML_tableParts);
 101 }
 102
 103
 104 XclExpTablesManager::XclExpTablesManager( const XclExpRoot& rRoot ) :
 105     XclExpRoot( rRoot )
 106 {
 107 }
 108
 109 XclExpTablesManager::~XclExpTablesManager()
 110 {
 111 }
 112
 113 void XclExpTablesManager::Initialize()
 114 {
 115     // All non-const to be able to call RefreshTableColumnNames().
 116     ScDocument& rDoc = GetDoc();
 117     ScDBCollection* pDBColl = rDoc.GetDBCollection();
 118     if (!pDBColl)
 119         return;
 120
 121     ScDBCollection::NamedDBs& rDBs = pDBColl->getNamedDBs();
 122     if (rDBs.empty())
 123         return;
 124
 125     sal_Int32 nTableId = 0;
 126     for (ScDBCollection::NamedDBs::iterator itDB(rDBs.begin()); itDB != rDBs.end(); ++itDB)
 127     {
 128         ScDBData* pDBData = itDB->get();
 129         pDBData->RefreshTableColumnNames( &rDoc);   // currently not in sync, so refresh
 130         ScRange aRange( ScAddress::UNINITIALIZED);
 131         pDBData->GetArea( aRange);
 132         SCTAB nTab = aRange.aStart.Tab();
 133         TablesMapType::iterator it = maTablesMap.find( nTab);
 134         if (it == maTablesMap.end())
 135         {
 136             ::std::shared_ptr< XclExpTables > pNew;
 137             switch( GetBiff() )
 138             {
 139                 case EXC_BIFF5:
 140                     pNew.reset( new XclExpTablesImpl5( GetRoot()));
 141                     break;
 142                 case EXC_BIFF8:
 143                     pNew.reset( new XclExpTablesImpl8( GetRoot()));
 144                     break;
 145                 default:
 146                     assert(!"Unknown BIFF type!");
 147                     continue;   // for
 148             }
 149             ::std::pair< TablesMapType::iterator, bool > ins( maTablesMap.insert( ::std::make_pair( nTab, pNew)));
 150             if (!ins.second)
 151             {
 152                 assert(!"XclExpTablesManager::Initialize - XclExpTables insert failed");
 153                 continue;   // for
 154             }
 155             it = ins.first;
 156         }
 157         it->second->AppendTable( pDBData, ++nTableId);
 158     }
 159 }
 160
 161 ::std::shared_ptr< XclExpTables > XclExpTablesManager::GetTablesBySheet( SCTAB nTab )
 162 {
 163     TablesMapType::iterator it = maTablesMap.find(nTab);
 164     return it == maTablesMap.end() ? nullptr : it->second;
 165 }
 166
 167 XclExpTables::Entry::Entry( const ScDBData* pData, sal_Int32 nTableId ) :
 168     mpData(pData), mnTableId(nTableId)
 169 {
 170 }
 171
 172 XclExpTables::XclExpTables( const XclExpRoot& rRoot ) :
 173     XclExpRoot(rRoot)
 174 {
 175 }
 176
 177 XclExpTables::~XclExpTables()
 178 {
 179 }
 180
 181 void XclExpTables::AppendTable( const ScDBData* pData, sal_Int32 nTableId )
 182 {
 183     maTables.push_back( Entry( pData, nTableId));
 184 }
 185
 186 void XclExpTables::SaveTableXml( XclExpXmlStream& rStrm, const Entry& rEntry )
 187 {
 188     const ScDBData& rData = *rEntry.mpData;
 189     ScRange aRange( ScAddress::UNINITIALIZED);
 190     rData.GetArea( aRange);
 191     sax_fastparser::FSHelperPtr& pTableStrm = rStrm.GetCurrentStream();
 192     pTableStrm->startElement( XML_table,
 193         XML_xmlns, "http://schemas.openxmlformats.org/spreadsheetml/2006/main",
 194         XML_id, OString::number( rEntry.mnTableId).getStr(),
 195         XML_name, XclXmlUtils::ToOString( rData.GetName()).getStr(),
 196         XML_displayName, XclXmlUtils::ToOString( rData.GetName()).getStr(),
 197         XML_ref, XclXmlUtils::ToOString(aRange),
 198         XML_headerRowCount, BS(rData.HasHeader()),
 199         XML_totalsRowCount, BS(rData.HasTotals()),
 200         XML_totalsRowShown, BS(rData.HasTotals()),  // we don't support that but if there are totals they are shown
 201         // OOXTODO: XML_comment, ...,
 202         // OOXTODO: XML_connectionId, ...,
 203         // OOXTODO: XML_dataCellStyle, ...,
 204         // OOXTODO: XML_dataDxfId, ...,
 205         // OOXTODO: XML_headerRowBorderDxfId, ...,
 206         // OOXTODO: XML_headerRowCellStyle, ...,
 207         // OOXTODO: XML_headerRowDxfId, ...,
 208         // OOXTODO: XML_insertRow, ...,
 209         // OOXTODO: XML_insertRowShift, ...,
 210         // OOXTODO: XML_published, ...,
 211         // OOXTODO: XML_tableBorderDxfId, ...,
 212         // OOXTODO: XML_tableType, ...,
 213         // OOXTODO: XML_totalsRowBorderDxfId, ...,
 214         // OOXTODO: XML_totalsRowCellStyle, ...,
 215         // OOXTODO: XML_totalsRowDxfId, ...,
 216         FSEND);
 217
 218     if (rData.HasAutoFilter())
 219     {
 220         /* TODO: does this need to exclude totals row? */
 221
 222         /* TODO: in OOXML  12.3.21 Table Definition Part  has information
 223          * that an applied autoFilter has child elements
 224          * <af:filterColumn><af:filters><af:filter>.
 225          * When not applied but buttons hidden, Excel writes, for example,
 226          * <filterColumn colId="0" hiddenButton="1"/> */
 227
 228         ExcAutoFilterRecs aAutoFilter( rStrm.GetRoot(), aRange.aStart.Tab(), &rData);
 229         aAutoFilter.SaveXml( rStrm);
 230     }
 231
 232     const std::vector< OUString >& rColNames = rData.GetTableColumnNames();
 233     if (!rColNames.empty())
 234     {
 235         pTableStrm->startElement( XML_tableColumns,
 236                 XML_count, OString::number( aRange.aEnd.Col() - aRange.aStart.Col() + 1).getStr(),
 237                 FSEND);
 238
 239         for (size_t i=0, n=rColNames.size(); i < n; ++i)
 240         {
 241             // OOXTODO: write <calculatedColumnFormula> once we support it, in
 242             // which case we'd need start/endElement XML_tableColumn for such
 243             // column.
 244
 245             // OOXTODO: write <totalsRowFormula> once we support it.
 246
 247             pTableStrm->singleElement( XML_tableColumn,
 248                     XML_id, OString::number(i+1).getStr(),
 249                     XML_name, OUStringToOString( rColNames[i], RTL_TEXTENCODING_UTF8).getStr(),
 250                     // OOXTODO: XML_dataCellStyle, ...,
 251                     // OOXTODO: XML_dataDxfId, ...,
 252                     // OOXTODO: XML_headerRowCellStyle, ...,
 253                     // OOXTODO: XML_headerRowDxfId, ...,
 254                     // OOXTODO: XML_queryTableFieldId, ...,
 255                     // OOXTODO: XML_totalsRowCellStyle, ...,
 256                     // OOXTODO: XML_totalsRowDxfId, ...,
 257                     // OOXTODO: XML_totalsRowFunction, ...,
 258                     // OOXTODO: XML_totalsRowLabel, ...,
 259                     // OOXTODO: XML_uniqueName, ...,
 260                     FSEND);
 261         }
 262
 263         pTableStrm->endElement( XML_tableColumns);
 264     }
 265
 266     // OOXTODO: write <tableStyleInfo> once we have table styles.
 267
 268     pTableStrm->endElement( XML_table);
 269 }
 270
 271 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */