sc/source/ui/miscdlgs/linkarea.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 #undef SC_DLLIMPLEMENTATION
  21
  22 #include <sfx2/docfile.hxx>
  23 #include <sfx2/docfilt.hxx>
  24 #include <sfx2/docinsert.hxx>
  25 #include <sfx2/fcontnr.hxx>
  26 #include <sfx2/filedlghelper.hxx>
  27 #include <svtools/ehdl.hxx>
  28 #include <svtools/inettbc.hxx>
  29 #include <svtools/sfxecode.hxx>
  30 #include <o3tl/string_view.hxx>
  31
  32 #include <dbdata.hxx>
  33 #include <linkarea.hxx>
  34 #include <docsh.hxx>
  35 #include <tablink.hxx>
  36 #include <scresid.hxx>
  37 #include <strings.hrc>
  38
  39 ScLinkedAreaDlg::ScLinkedAreaDlg(weld::Widget* pParent)
  40     : GenericDialogController(pParent, u"modules/scalc/ui/externaldata.ui"_ustr, u"ExternalDataDialog"_ustr)
  41     , m_xCbUrl(new SvtURLBox(m_xBuilder->weld_combo_box(u"url"_ustr)))
  42     , m_xBtnBrowse(m_xBuilder->weld_button(u"browse"_ustr))
  43     , m_xLbRanges(m_xBuilder->weld_tree_view(u"ranges"_ustr))
  44     , m_xBtnReload(m_xBuilder->weld_check_button(u"reload"_ustr))
  45     , m_xNfDelay(m_xBuilder->weld_spin_button(u"delay"_ustr))
  46     , m_xFtSeconds(m_xBuilder->weld_label(u"secondsft"_ustr))
  47     , m_xBtnOk(m_xBuilder->weld_button(u"ok"_ustr))
  48 {
  49     m_xLbRanges->set_selection_mode(SelectionMode::Multiple);
  50
  51     m_xCbUrl->connect_entry_activate(LINK(this, ScLinkedAreaDlg, FileHdl));
  52     m_xBtnBrowse->connect_clicked(LINK( this, ScLinkedAreaDlg, BrowseHdl));
  53     m_xLbRanges->connect_selection_changed(LINK(this, ScLinkedAreaDlg, RangeHdl));
  54     m_xLbRanges->set_size_request(m_xLbRanges->get_approximate_digit_width() * 54,
  55                                   m_xLbRanges->get_height_rows(5));
  56     m_xBtnReload->connect_toggled(LINK( this, ScLinkedAreaDlg, ReloadHdl));
  57     UpdateEnable();
  58 }
  59
  60 ScLinkedAreaDlg::~ScLinkedAreaDlg()
  61 {
  62 }
  63
  64 constexpr OUString FILTERNAME_HTML = u"HTML (StarCalc)"_ustr;
  65 constexpr OUString FILTERNAME_QUERY = u"calc_HTML_WebQuery"_ustr;
  66
  67 IMPL_LINK_NOARG(ScLinkedAreaDlg, BrowseHdl, weld::Button&, void)
  68 {
  69     m_xDocInserter.reset( new sfx2::DocumentInserter(m_xDialog.get(), ScDocShell::Factory().GetFactoryName()) );
  70     m_xDocInserter->StartExecuteModal( LINK( this, ScLinkedAreaDlg, DialogClosedHdl ) );
  71 }
  72
  73 IMPL_LINK_NOARG(ScLinkedAreaDlg, FileHdl, weld::ComboBox&, bool)
  74 {
  75     OUString aEntered = m_xCbUrl->GetURL();
  76     if (m_pSourceShell)
  77     {
  78         SfxMedium* pMed = m_pSourceShell->GetMedium();
  79         if ( aEntered == pMed->GetName() )
  80         {
  81             //  already loaded - nothing to do
  82             return true;
  83         }
  84     }
  85
  86     OUString aFilter;
  87     OUString aOptions;
  88     //  get filter name by looking at the file content (bWithContent = true)
  89     // Break operation if any error occurred inside.
  90     if (!ScDocumentLoader::GetFilterName( aEntered, aFilter, aOptions, true, false ))
  91         return true;
  92
  93     // #i53241# replace HTML filter with DataQuery filter
  94     if (aFilter == FILTERNAME_HTML)
  95         aFilter = FILTERNAME_QUERY;
  96
  97     LoadDocument( aEntered, aFilter, aOptions );
  98
  99     UpdateSourceRanges();
 100     UpdateEnable();
 101
 102     return true;
 103 }
 104
 105 void ScLinkedAreaDlg::LoadDocument( const OUString& rFile, const OUString& rFilter, const OUString& rOptions )
 106 {
 107     if (m_pSourceShell)
 108     {
 109         //  unload old document
 110         m_pSourceShell->DoClose();
 111         m_pSourceShell.clear();
 112     }
 113
 114     if ( rFile.isEmpty() )
 115         return;
 116
 117     weld::WaitObject aWait(m_xDialog.get());
 118
 119     OUString aNewFilter = rFilter;
 120     OUString aNewOptions = rOptions;
 121
 122     SfxErrorContext aEc( ERRCTX_SFX_OPENDOC, rFile );
 123
 124     ScDocumentLoader aLoader( rFile, aNewFilter, aNewOptions, 0, m_xDialog.get() );    // with interaction
 125     m_pSourceShell = aLoader.GetDocShell();
 126     if (m_pSourceShell)
 127     {
 128         ErrCodeMsg nErr = m_pSourceShell->GetErrorCode();
 129         if (nErr)
 130             ErrorHandler::HandleError( nErr );      // including warnings
 131
 132         aLoader.ReleaseDocRef();    // don't call DoClose in DocLoader dtor
 133     }
 134 }
 135
 136 void ScLinkedAreaDlg::InitFromOldLink( const OUString& rFile, const OUString& rFilter,
 137                                         const OUString& rOptions, std::u16string_view rSource,
 138                                         sal_Int32 nRefreshDelaySeconds )
 139 {
 140     LoadDocument( rFile, rFilter, rOptions );
 141     if (m_pSourceShell)
 142     {
 143         SfxMedium* pMed = m_pSourceShell->GetMedium();
 144         m_xCbUrl->set_entry_text(pMed->GetName());
 145     }
 146     else
 147         m_xCbUrl->set_entry_text(OUString());
 148
 149     UpdateSourceRanges();
 150
 151     if (!rSource.empty())
 152     {
 153         sal_Int32 nIdx {0};
 154         do
 155         {
 156             m_xLbRanges->select_text(OUString(o3tl::getToken(rSource, 0, ';', nIdx)));
 157         }
 158         while (nIdx>0);
 159     }
 160
 161     bool bDoRefresh = (nRefreshDelaySeconds != 0);
 162     m_xBtnReload->set_active(bDoRefresh);
 163     if (bDoRefresh)
 164         m_xNfDelay->set_value(nRefreshDelaySeconds);
 165
 166     UpdateEnable();
 167 }
 168
 169 IMPL_LINK_NOARG(ScLinkedAreaDlg, RangeHdl, weld::TreeView&, void)
 170 {
 171     UpdateEnable();
 172 }
 173
 174 IMPL_LINK_NOARG(ScLinkedAreaDlg, ReloadHdl, weld::Toggleable&, void)
 175 {
 176     UpdateEnable();
 177 }
 178
 179 IMPL_LINK( ScLinkedAreaDlg, DialogClosedHdl, sfx2::FileDialogHelper*, _pFileDlg, void )
 180 {
 181     if ( _pFileDlg->GetError() != ERRCODE_NONE )
 182         return;
 183
 184     std::unique_ptr<SfxMedium> pMed = m_xDocInserter->CreateMedium();
 185     if ( pMed )
 186     {
 187         weld::WaitObject aWait(m_xDialog.get());
 188
 189         // replace HTML filter with DataQuery filter
 190         std::shared_ptr<const SfxFilter> pFilter = pMed->GetFilter();
 191         if (pFilter && FILTERNAME_HTML == pFilter->GetFilterName())
 192         {
 193             std::shared_ptr<const SfxFilter> pNewFilter =
 194                 ScDocShell::Factory().GetFilterContainer()->GetFilter4FilterName( FILTERNAME_QUERY );
 195             if( pNewFilter )
 196                 pMed->SetFilter( pNewFilter );
 197         }
 198
 199         //  ERRCTX_SFX_OPENDOC -> "Error loading document"
 200         SfxErrorContext aEc( ERRCTX_SFX_OPENDOC, pMed->GetName() );
 201
 202         if (m_pSourceShell)
 203             m_pSourceShell->DoClose();        // deleted when assigning aSourceRef
 204
 205         pMed->UseInteractionHandler( true );    // to enable the filter options dialog
 206
 207         m_pSourceShell = new ScDocShell;
 208         m_pSourceShell->DoLoad( pMed.get() );
 209
 210         ErrCodeMsg nErr = m_pSourceShell->GetErrorCode();
 211         if (nErr)
 212             ErrorHandler::HandleError( nErr );              // including warnings
 213
 214         if (!m_pSourceShell->GetErrorIgnoreWarning())                    // only errors
 215         {
 216             m_xCbUrl->set_entry_text(pMed->GetName());
 217         }
 218         else
 219         {
 220             m_pSourceShell->DoClose();
 221             m_pSourceShell.clear();
 222
 223             m_xCbUrl->set_entry_text(OUString());
 224         }
 225         pMed.release(); // DoLoad takes ownership
 226     }
 227
 228     UpdateSourceRanges();
 229     UpdateEnable();
 230 }
 231
 232 #undef FILTERNAME_HTML
 233 #undef FILTERNAME_QUERY
 234
 235 void ScLinkedAreaDlg::UpdateSourceRanges()
 236 {
 237     m_xLbRanges->freeze();
 238
 239     m_xLbRanges->clear();
 240     if ( m_pSourceShell )
 241     {
 242         std::shared_ptr<const SfxFilter> pFilter = m_pSourceShell->GetMedium()->GetFilter();
 243         if (pFilter && pFilter->GetFilterName() == SC_TEXT_CSV_FILTER_NAME)
 244         {
 245             // Insert dummy All range to have something selectable.
 246             m_xLbRanges->append_text(u"CSV_all"_ustr);
 247         }
 248
 249         // tdf#142600 - list tables in order of their appearance in the document's source
 250         const ScRangeName* pRangeName = m_pSourceShell->GetDocument().GetRangeName();
 251         for (size_t i = 1; i <= pRangeName->index_size(); i++)
 252         {
 253             if (const ScRangeData* pRangeData = pRangeName->findByIndex(i))
 254             {
 255                 m_xLbRanges->append_text(pRangeData->GetName());
 256             }
 257         }
 258         // tdf#142600 - list database ranges
 259         if (const auto pDBs = m_pSourceShell->GetDocument().GetDBCollection())
 260         {
 261             const auto& rNamedDBs = pDBs->getNamedDBs();
 262             for (const auto& rNamedDB : rNamedDBs)
 263                 m_xLbRanges->append_text(rNamedDB->GetName());
 264         }
 265     }
 266
 267     m_xLbRanges->thaw();
 268
 269     if (m_xLbRanges->n_children() >= 1)
 270         m_xLbRanges->select(0);
 271     else
 272     {
 273         m_xLbRanges->append_text(ScResId(STR_NO_NAMED_RANGES_AVAILABLE));
 274         m_xLbRanges->set_sensitive(false);
 275     }
 276 }
 277
 278 void ScLinkedAreaDlg::UpdateEnable()
 279 {
 280     bool bEnable = ( m_pSourceShell && m_xLbRanges->count_selected_rows() );
 281     m_xBtnOk->set_sensitive(bEnable);
 282
 283     bool bReload = m_xBtnReload->get_active();
 284     m_xNfDelay->set_sensitive(bReload);
 285     m_xFtSeconds->set_sensitive(bReload);
 286 }
 287
 288 OUString ScLinkedAreaDlg::GetURL() const
 289 {
 290     if (m_pSourceShell)
 291     {
 292         SfxMedium* pMed = m_pSourceShell->GetMedium();
 293         return pMed->GetName();
 294     }
 295     return OUString();
 296 }
 297
 298 OUString ScLinkedAreaDlg::GetFilter() const
 299 {
 300     if (m_pSourceShell)
 301     {
 302         SfxMedium* pMed = m_pSourceShell->GetMedium();
 303         return pMed->GetFilter()->GetFilterName();
 304     }
 305     return OUString();
 306 }
 307
 308 OUString ScLinkedAreaDlg::GetOptions() const
 309 {
 310     if (m_pSourceShell)
 311     {
 312         SfxMedium* pMed = m_pSourceShell->GetMedium();
 313         return ScDocumentLoader::GetOptions( *pMed );
 314     }
 315     return OUString();
 316 }
 317
 318 OUString ScLinkedAreaDlg::GetSource() const
 319 {
 320     OUStringBuffer aBuf;
 321     std::vector<OUString> aSelection = m_xLbRanges->get_selected_rows_text();
 322     for (size_t i = 0; i < aSelection.size(); ++i)
 323     {
 324         if (i > 0)
 325             aBuf.append(';');
 326         aBuf.append(aSelection[i]);
 327     }
 328     return aBuf.makeStringAndClear();
 329 }
 330
 331 sal_Int32 ScLinkedAreaDlg::GetRefreshDelaySeconds() const
 332 {
 333     if (m_xBtnReload->get_active())
 334         return m_xNfDelay->get_value();
 335     else
 336         return 0;   // disabled
 337 }
 338
 339 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */