dbaccess/source/ui/dlg/dbfindex.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 "dbfindex.hxx"
  21 #include <comphelper/processfactory.hxx>
  22 #include <osl/file.hxx>
  23 #include <osl/thread.hxx>
  24 #include <tools/config.hxx>
  25 #include <osl/diagnose.h>
  26 #include <unotools/localfilehelper.hxx>
  27 #include <tools/urlobj.hxx>
  28 #include <unotools/pathoptions.hxx>
  29 #include <ucbhelper/content.hxx>
  30 #include <svl/filenotation.hxx>
  31 #include <rtl/strbuf.hxx>
  32 #include <utility>
  33
  34 namespace dbaui
  35 {
  36 using namespace ::com::sun::star::uno;
  37 using namespace ::com::sun::star::ucb;
  38 using namespace ::svt;
  39
  40 constexpr OStringLiteral aGroupIdent("dBase III");
  41
  42
  43 ODbaseIndexDialog::ODbaseIndexDialog(weld::Window * pParent, OUString aDataSrcName)
  44     : GenericDialogController(pParent, "dbaccess/ui/dbaseindexdialog.ui", "DBaseIndexDialog")
  45     , m_aDSN(std::move(aDataSrcName))
  46     , m_xPB_OK(m_xBuilder->weld_button("ok"))
  47     , m_xCB_Tables(m_xBuilder->weld_combo_box("table"))
  48     , m_xIndexes(m_xBuilder->weld_widget("frame"))
  49     , m_xLB_TableIndexes(m_xBuilder->weld_tree_view("tableindex"))
  50     , m_xLB_FreeIndexes(m_xBuilder->weld_tree_view("freeindex"))
  51     , m_xAdd(m_xBuilder->weld_button("add"))
  52     , m_xRemove(m_xBuilder->weld_button("remove"))
  53     , m_xAddAll(m_xBuilder->weld_button("addall"))
  54     , m_xRemoveAll(m_xBuilder->weld_button("removeall"))
  55 {
  56     int nWidth = m_xLB_TableIndexes->get_approximate_digit_width() * 18;
  57     int nHeight = m_xLB_TableIndexes->get_height_rows(10);
  58     m_xLB_TableIndexes->set_size_request(nWidth, nHeight);
  59     m_xLB_FreeIndexes->set_size_request(nWidth, nHeight);
  60
  61     m_xCB_Tables->connect_changed( LINK(this, ODbaseIndexDialog, TableSelectHdl) );
  62     m_xAdd->connect_clicked( LINK(this, ODbaseIndexDialog, AddClickHdl) );
  63     m_xRemove->connect_clicked( LINK(this, ODbaseIndexDialog, RemoveClickHdl) );
  64     m_xAddAll->connect_clicked( LINK(this, ODbaseIndexDialog, AddAllClickHdl) );
  65     m_xRemoveAll->connect_clicked( LINK(this, ODbaseIndexDialog, RemoveAllClickHdl) );
  66     m_xPB_OK->connect_clicked( LINK(this, ODbaseIndexDialog, OKClickHdl) );
  67
  68     m_xLB_FreeIndexes->connect_changed( LINK(this, ODbaseIndexDialog, OnListEntrySelected) );
  69     m_xLB_TableIndexes->connect_changed( LINK(this, ODbaseIndexDialog, OnListEntrySelected) );
  70
  71     Init();
  72     SetCtrls();
  73 }
  74
  75 ODbaseIndexDialog::~ODbaseIndexDialog()
  76 {
  77 }
  78
  79 void ODbaseIndexDialog::checkButtons()
  80 {
  81     m_xAdd->set_sensitive(0 != m_xLB_FreeIndexes->count_selected_rows());
  82     m_xAddAll->set_sensitive(0 != m_xLB_FreeIndexes->n_children());
  83
  84     m_xRemove->set_sensitive(0 != m_xLB_TableIndexes->count_selected_rows());
  85     m_xRemoveAll->set_sensitive(0 != m_xLB_TableIndexes->n_children());
  86 }
  87
  88 OTableIndex ODbaseIndexDialog::implRemoveIndex(const OUString& _rName, TableIndexList& _rList, weld::TreeView& _rDisplay, bool _bMustExist)
  89 {
  90     OTableIndex aReturn;
  91
  92     TableIndexList::iterator aSearch = std::find_if(_rList.begin(), _rList.end(),
  93         [&_rName](const OTableIndex& rIndex) { return rIndex.GetIndexFileName() == _rName; });
  94     if (aSearch != _rList.end())
  95     {
  96         sal_Int32 nPos = static_cast<sal_Int32>(std::distance(_rList.begin(), aSearch));
  97
  98         aReturn = *aSearch;
  99
 100         _rList.erase(aSearch);
 101         _rDisplay.remove_text(_rName);
 102
 103         // adjust selection if necessary
 104         if (static_cast<sal_uInt32>(nPos) == _rList.size())
 105             _rDisplay.select(static_cast<sal_uInt16>(nPos)-1);
 106         else
 107             _rDisplay.select(static_cast<sal_uInt16>(nPos));
 108     }
 109     OSL_ENSURE(!_bMustExist || !aReturn.GetIndexFileName().isEmpty(), "ODbaseIndexDialog::implRemoveIndex : did not find the index!");
 110     return aReturn;
 111 }
 112
 113 void ODbaseIndexDialog::implInsertIndex(const OTableIndex& _rIndex, TableIndexList& _rList, weld::TreeView& _rDisplay)
 114 {
 115     _rList.push_front(_rIndex);
 116     _rDisplay.append_text(_rIndex.GetIndexFileName());
 117     _rDisplay.select(0);
 118 }
 119
 120 OTableIndex ODbaseIndexDialog::RemoveTableIndex( std::u16string_view _rTableName, const OUString& _rIndexName )
 121 {
 122     OTableIndex aReturn;
 123
 124     // does the table exist ?
 125     TableInfoList::iterator aTablePos = std::find_if(m_aTableInfoList.begin(), m_aTableInfoList.end(),
 126                                            [&] (const OTableInfo& arg) { return arg.aTableName == _rTableName; });
 127
 128     if (aTablePos == m_aTableInfoList.end())
 129         return aReturn;
 130
 131     return implRemoveIndex(_rIndexName, aTablePos->aIndexList, *m_xLB_TableIndexes, true/*_bMustExist*/);
 132 }
 133
 134 void ODbaseIndexDialog::InsertTableIndex( std::u16string_view _rTableName, const OTableIndex& _rIndex)
 135 {
 136     TableInfoList::iterator aTablePos = std::find_if(m_aTableInfoList.begin(), m_aTableInfoList.end(),
 137                                            [&] (const OTableInfo& arg) { return arg.aTableName == _rTableName; });
 138
 139     if (aTablePos == m_aTableInfoList.end())
 140         return;
 141
 142     implInsertIndex(_rIndex, aTablePos->aIndexList, *m_xLB_TableIndexes);
 143 }
 144
 145 IMPL_LINK_NOARG(ODbaseIndexDialog, OKClickHdl, weld::Button&, void)
 146 {
 147     // let all tables write their INF file
 148
 149     for (auto const& tableInfo : m_aTableInfoList)
 150         tableInfo.WriteInfFile(m_aDSN);
 151
 152     m_xDialog->response(RET_OK);
 153 }
 154
 155 IMPL_LINK_NOARG(ODbaseIndexDialog, AddClickHdl, weld::Button&, void)
 156 {
 157     OUString aSelection = m_xLB_FreeIndexes->get_selected_text();
 158     OUString aTableName = m_xCB_Tables->get_active_text();
 159     OTableIndex aIndex = RemoveFreeIndex( aSelection, true );
 160     InsertTableIndex( aTableName, aIndex );
 161
 162     checkButtons();
 163 }
 164
 165 IMPL_LINK_NOARG(ODbaseIndexDialog, RemoveClickHdl, weld::Button&, void)
 166 {
 167     OUString aSelection = m_xLB_TableIndexes->get_selected_text();
 168     OUString aTableName = m_xCB_Tables->get_active_text();
 169     OTableIndex aIndex = RemoveTableIndex( aTableName, aSelection );
 170     InsertFreeIndex( aIndex );
 171
 172     checkButtons();
 173 }
 174
 175 IMPL_LINK_NOARG(ODbaseIndexDialog, AddAllClickHdl, weld::Button&, void)
 176 {
 177     const sal_Int32 nCnt = m_xLB_FreeIndexes->n_children();
 178     OUString aTableName = m_xCB_Tables->get_active_text();
 179
 180     for (sal_Int32 nPos = 0; nPos < nCnt; ++nPos)
 181         InsertTableIndex(aTableName, RemoveFreeIndex(m_xLB_FreeIndexes->get_text(0), true));
 182
 183     checkButtons();
 184 }
 185
 186 IMPL_LINK_NOARG(ODbaseIndexDialog, RemoveAllClickHdl, weld::Button&, void)
 187 {
 188     const sal_Int32 nCnt = m_xLB_TableIndexes->n_children();
 189     OUString aTableName = m_xCB_Tables->get_active_text();
 190
 191     for (sal_Int32 nPos = 0; nPos < nCnt; ++nPos)
 192         InsertFreeIndex(RemoveTableIndex(aTableName, m_xLB_TableIndexes->get_text(0)));
 193
 194     checkButtons();
 195 }
 196
 197 IMPL_LINK_NOARG(ODbaseIndexDialog, OnListEntrySelected, weld::TreeView&, void)
 198 {
 199     checkButtons();
 200 }
 201
 202 IMPL_LINK(ODbaseIndexDialog, TableSelectHdl, weld::ComboBox&, rComboBox, void)
 203 {
 204     // search the table
 205     TableInfoList::iterator aTablePos = std::find_if(m_aTableInfoList.begin(), m_aTableInfoList.end(),
 206                                            [&] (const OTableInfo& arg) { return arg.aTableName == rComboBox.get_active_text() ; });
 207
 208     if (aTablePos == m_aTableInfoList.end())
 209         return;
 210
 211     // fill the listbox for the indexes
 212     m_xLB_TableIndexes->clear();
 213     for (auto const& index : aTablePos->aIndexList)
 214         m_xLB_TableIndexes->append_text(index.GetIndexFileName());
 215
 216     if (!aTablePos->aIndexList.empty())
 217         m_xLB_TableIndexes->select(0);
 218
 219     checkButtons();
 220 }
 221
 222 void ODbaseIndexDialog::Init()
 223 {
 224     m_xPB_OK->set_sensitive(false);
 225     m_xIndexes->set_sensitive(false);
 226
 227     // All indices are first added to a list of free indices.
 228     // Afterwards, check the index of each table in the Inf-file.
 229     // These indices are removed from the list of free indices and
 230     // entered in the indexlist of the table.
 231
 232     // if the string does not contain a path, cut the string
 233     INetURLObject aURL;
 234     aURL.SetSmartProtocol(INetProtocol::File);
 235     {
 236         SvtPathOptions aPathOptions;
 237         m_aDSN = aPathOptions.SubstituteVariable(m_aDSN);
 238     }
 239     aURL.SetSmartURL(m_aDSN);
 240
 241     //  String aFileName = aURL.PathToFileName();
 242     m_aDSN = aURL.GetMainURL(INetURLObject::DecodeMechanism::NONE);
 243     ::ucbhelper::Content aFile;
 244     bool bFolder=true;
 245     try
 246     {
 247         aFile = ::ucbhelper::Content(m_aDSN,Reference< css::ucb::XCommandEnvironment >(), comphelper::getProcessComponentContext());
 248         bFolder = aFile.isFolder();
 249     }
 250     catch(Exception&)
 251     {
 252         return;
 253     }
 254
 255     // first assume for all indexes they're free
 256
 257     OUString const aIndexExt("ndx");
 258     OUString const aTableExt("dbf");
 259
 260     std::vector< OUString > aUsedIndexes;
 261
 262     aURL.SetSmartProtocol(INetProtocol::File);
 263     const Sequence<OUString> aFolderUrls = ::utl::LocalFileHelper::GetFolderContents(m_aDSN, bFolder);
 264     for(const OUString& rURL : aFolderUrls)
 265     {
 266         OUString aName;
 267         osl::FileBase::getSystemPathFromFileURL(rURL,aName);
 268         aURL.SetSmartURL(aName);
 269         OUString aExt = aURL.getExtension();
 270         if (aExt == aIndexExt)
 271         {
 272             m_aFreeIndexList.emplace_back(aURL.getName() );
 273         }
 274         else if (aExt == aTableExt)
 275         {
 276             m_aTableInfoList.emplace_back(aURL.getName() );
 277             OTableInfo& rTabInfo = m_aTableInfoList.back();
 278
 279             // open the INF file
 280             aURL.setExtension(u"inf");
 281             OFileNotation aTransformer(aURL.GetURLNoPass(), OFileNotation::N_URL);
 282             Config aInfFile( aTransformer.get(OFileNotation::N_SYSTEM) );
 283             aInfFile.SetGroup( aGroupIdent );
 284
 285             // fill the indexes list
 286             OString aNDX;
 287             sal_uInt16 nKeyCnt = aInfFile.GetKeyCount();
 288             OString aKeyName;
 289             OUString aEntry;
 290
 291             for( sal_uInt16 nKey = 0; nKey < nKeyCnt; nKey++ )
 292             {
 293                 // does the key point to an index file ?
 294                 aKeyName = aInfFile.GetKeyName( nKey );
 295                 aNDX = aKeyName.copy(0,3);
 296
 297                 // yes -> add to the tables index list
 298                 if (aNDX == "NDX")
 299                 {
 300                     aEntry = OStringToOUString(aInfFile.ReadKey(aKeyName), osl_getThreadTextEncoding());
 301                     rTabInfo.aIndexList.emplace_back( aEntry );
 302
 303                     // and remove it from the free index list
 304                     aUsedIndexes.push_back(aEntry);
 305                         // do this later below. We may not have encountered the index file, yet, thus we may not
 306                         // know the index as being free, yet
 307                 }
 308             }
 309         }
 310     }
 311
 312     for (auto const& usedIndex : aUsedIndexes)
 313         RemoveFreeIndex( usedIndex, false );
 314
 315     if (!m_aTableInfoList.empty())
 316     {
 317         m_xPB_OK->set_sensitive(true);
 318         m_xIndexes->set_sensitive(true);
 319     }
 320
 321     checkButtons();
 322 }
 323
 324 void ODbaseIndexDialog::SetCtrls()
 325 {
 326     // ComboBox tables
 327     for (auto const& tableInfo : m_aTableInfoList)
 328         m_xCB_Tables->append_text(tableInfo.aTableName);
 329
 330     // put the first dataset into Edit
 331     if (!m_aTableInfoList.empty())
 332     {
 333         const OTableInfo& rTabInfo = m_aTableInfoList.front();
 334         m_xCB_Tables->set_entry_text(rTabInfo.aTableName);
 335
 336         // build ListBox of the table indices
 337         for (auto const& index : rTabInfo.aIndexList)
 338             m_xLB_TableIndexes->append_text(index.GetIndexFileName());
 339
 340         if (!rTabInfo.aIndexList.empty())
 341             m_xLB_TableIndexes->select(0);
 342     }
 343
 344     // ListBox of the free indices
 345     for (auto const& freeIndex : m_aFreeIndexList)
 346         m_xLB_FreeIndexes->append_text(freeIndex.GetIndexFileName());
 347
 348     if (!m_aFreeIndexList.empty())
 349         m_xLB_FreeIndexes->select(0);
 350
 351     TableSelectHdl(*m_xCB_Tables);
 352     checkButtons();
 353 }
 354
 355 void OTableInfo::WriteInfFile( const OUString& rDSN ) const
 356 {
 357     // open INF file
 358     INetURLObject aURL;
 359     aURL.SetSmartProtocol(INetProtocol::File);
 360     OUString aDsn = rDSN;
 361     {
 362         SvtPathOptions aPathOptions;
 363         aDsn = aPathOptions.SubstituteVariable(aDsn);
 364     }
 365     aURL.SetSmartURL(aDsn);
 366     aURL.Append(aTableName);
 367     aURL.setExtension(u"inf");
 368
 369     OFileNotation aTransformer(aURL.GetURLNoPass(), OFileNotation::N_URL);
 370     Config aInfFile( aTransformer.get(OFileNotation::N_SYSTEM) );
 371     aInfFile.SetGroup( aGroupIdent );
 372
 373     // first, delete all table indices
 374     OString aNDX;
 375     sal_uInt16 nKeyCnt = aInfFile.GetKeyCount();
 376     sal_uInt16 nKey = 0;
 377
 378     while( nKey < nKeyCnt )
 379     {
 380         // Does the key point to an index file?...
 381         OString aKeyName = aInfFile.GetKeyName( nKey );
 382         aNDX = aKeyName.copy(0,3);
 383
 384         //...if yes, delete index file, nKey is at subsequent key
 385         if (aNDX == "NDX")
 386         {
 387             aInfFile.DeleteKey(aKeyName);
 388             nKeyCnt--;
 389         }
 390         else
 391             nKey++;
 392
 393     }
 394
 395     // now add all saved indices
 396     sal_uInt16 nPos = 0;
 397     for (auto const& index : aIndexList)
 398     {
 399         OStringBuffer aKeyName("NDX");
 400         if( nPos > 0 )  // first index contains no number
 401             aKeyName.append(static_cast<sal_Int32>(nPos));
 402         aInfFile.WriteKey(
 403             aKeyName.makeStringAndClear(),
 404             OUStringToOString(index.GetIndexFileName(),
 405                 osl_getThreadTextEncoding()));
 406         ++nPos;
 407     }
 408
 409     aInfFile.Flush();
 410
 411     // if only [dbase] is left in INF-file, delete file
 412     if(nPos)
 413         return;
 414
 415     try
 416     {
 417         ::ucbhelper::Content aContent(aURL.GetURLNoPass(),Reference<XCommandEnvironment>(), comphelper::getProcessComponentContext());
 418         aContent.executeCommand( "delete", Any( true ) );
 419     }
 420     catch (const Exception& )
 421     {
 422         // simply silent this. The strange algorithm here does a lot of
 423         // things even if no files at all were created or accessed, so it's
 424         // possible that the file we're trying to delete does not even
 425         // exist, and this is a valid condition.
 426     }
 427 }
 428
 429 } // namespace
 430
 431 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */