extensions/source/dbpilots/listcombowizard.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 "listcombowizard.hxx"
  21 #include "commonpagesdbp.hxx"
  22 #include <com/sun/star/sdbc/XConnection.hpp>
  23 #include <com/sun/star/sdbcx/XTablesSupplier.hpp>
  24 #include <com/sun/star/container/XNameAccess.hpp>
  25 #include <com/sun/star/form/ListSourceType.hpp>
  26 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  27 #include <tools/debug.hxx>
  28 #include <comphelper/diagnose_ex.hxx>
  29 #include <connectivity/dbtools.hxx>
  30 #include <helpids.h>
  31 #include <osl/diagnose.h>
  32
  33
  34 namespace dbp
  35 {
  36
  37
  38     using namespace ::com::sun::star::uno;
  39     using namespace ::com::sun::star::beans;
  40     using namespace ::com::sun::star::sdbc;
  41     using namespace ::com::sun::star::sdbcx;
  42     using namespace ::com::sun::star::container;
  43     using namespace ::com::sun::star::form;
  44     using namespace ::dbtools;
  45
  46     OListComboWizard::OListComboWizard(weld::Window* _pParent,
  47             const Reference< XPropertySet >& _rxObjectModel, const Reference< XComponentContext >& _rxContext )
  48         : OControlWizard(_pParent, _rxObjectModel, _rxContext)
  49         , m_bListBox(false)
  50         , m_bHadDataSelection(true)
  51     {
  52         initControlSettings(&m_aSettings);
  53
  54         m_xPrevPage->set_help_id(HID_LISTWIZARD_PREVIOUS);
  55         m_xNextPage->set_help_id(HID_LISTWIZARD_NEXT);
  56         m_xCancel->set_help_id(HID_LISTWIZARD_CANCEL);
  57         m_xFinish->set_help_id(HID_LISTWIZARD_FINISH);
  58
  59         // if we do not need the data source selection page ...
  60         if (!needDatasourceSelection())
  61         {   // ... skip it!
  62             skip();
  63             m_bHadDataSelection = false;
  64         }
  65     }
  66
  67     bool OListComboWizard::approveControl(sal_Int16 _nClassId)
  68     {
  69         switch (_nClassId)
  70         {
  71             case FormComponentType::LISTBOX:
  72                 m_bListBox = true;
  73                 setTitleBase(compmodule::ModuleRes(RID_STR_LISTWIZARD_TITLE));
  74                 return true;
  75             case FormComponentType::COMBOBOX:
  76                 m_bListBox = false;
  77                 setTitleBase(compmodule::ModuleRes(RID_STR_COMBOWIZARD_TITLE));
  78                 return true;
  79         }
  80         return false;
  81     }
  82
  83     std::unique_ptr<BuilderPage> OListComboWizard::createPage(WizardState _nState)
  84     {
  85         OUString sIdent(OUString::number(_nState));
  86         weld::Container* pPageContainer = m_xAssistant->append_page(sIdent);
  87
  88         switch (_nState)
  89         {
  90             case LCW_STATE_DATASOURCE_SELECTION:
  91                 return std::make_unique<OTableSelectionPage>(pPageContainer, this);
  92             case LCW_STATE_TABLESELECTION:
  93                 return std::make_unique<OContentTableSelection>(pPageContainer, this);
  94             case LCW_STATE_FIELDSELECTION:
  95                 return std::make_unique<OContentFieldSelection>(pPageContainer, this);
  96             case LCW_STATE_FIELDLINK:
  97                 return std::make_unique<OLinkFieldsPage>(pPageContainer, this);
  98             case LCW_STATE_COMBODBFIELD:
  99                 return std::make_unique<OComboDBFieldPage>(pPageContainer, this);
 100         }
 101
 102         return nullptr;
 103     }
 104
 105     vcl::WizardTypes::WizardState OListComboWizard::determineNextState( WizardState _nCurrentState ) const
 106     {
 107         switch (_nCurrentState)
 108         {
 109             case LCW_STATE_DATASOURCE_SELECTION:
 110                 return LCW_STATE_TABLESELECTION;
 111             case LCW_STATE_TABLESELECTION:
 112                 return LCW_STATE_FIELDSELECTION;
 113             case LCW_STATE_FIELDSELECTION:
 114                 return getFinalState();
 115         }
 116
 117         return WZS_INVALID_STATE;
 118     }
 119
 120     void OListComboWizard::enterState(WizardState _nState)
 121     {
 122         OControlWizard::enterState(_nState);
 123
 124         enableButtons(WizardButtonFlags::PREVIOUS, m_bHadDataSelection ? (LCW_STATE_DATASOURCE_SELECTION < _nState) : LCW_STATE_TABLESELECTION < _nState);
 125         enableButtons(WizardButtonFlags::NEXT, getFinalState() != _nState);
 126         if (_nState < getFinalState())
 127             enableButtons(WizardButtonFlags::FINISH, false);
 128
 129         if (getFinalState() == _nState)
 130             defaultButton(WizardButtonFlags::FINISH);
 131     }
 132
 133
 134     bool OListComboWizard::leaveState(WizardState _nState)
 135     {
 136         if (!OControlWizard::leaveState(_nState))
 137             return false;
 138
 139         if (getFinalState() == _nState)
 140             defaultButton(WizardButtonFlags::NEXT);
 141
 142         return true;
 143     }
 144
 145
 146     void OListComboWizard::implApplySettings()
 147     {
 148         try
 149         {
 150             // for quoting identifiers, we need the connection meta data
 151             Reference< XConnection > xConn = getFormConnection();
 152             DBG_ASSERT(xConn.is(), "OListComboWizard::implApplySettings: no connection, unable to quote!");
 153             Reference< XDatabaseMetaData > xMetaData;
 154             if (xConn.is())
 155                 xMetaData = xConn->getMetaData();
 156
 157             // do some quotings
 158             if (xMetaData.is())
 159             {
 160                 OUString sQuoteString = xMetaData->getIdentifierQuoteString();
 161                 if (isListBox()) // only when we have a listbox this should be not empty
 162                     getSettings().sLinkedListField = quoteName(sQuoteString, getSettings().sLinkedListField);
 163
 164                 OUString sCatalog, sSchema, sName;
 165                 ::dbtools::qualifiedNameComponents( xMetaData, getSettings().sListContentTable, sCatalog, sSchema, sName, ::dbtools::EComposeRule::InDataManipulation );
 166                 getSettings().sListContentTable = ::dbtools::composeTableNameForSelect( xConn, sCatalog, sSchema, sName );
 167
 168                 getSettings().sListContentField = quoteName(sQuoteString, getSettings().sListContentField);
 169             }
 170
 171             // ListSourceType: SQL
 172             getContext().xObjectModel->setPropertyValue(u"ListSourceType"_ustr, Any(sal_Int32(ListSourceType_SQL)));
 173
 174             if (isListBox())
 175             {
 176                 // BoundColumn: 1
 177                 getContext().xObjectModel->setPropertyValue(u"BoundColumn"_ustr, Any(sal_Int16(1)));
 178
 179                 Sequence< OUString > aListSource {
 180                     // build the statement to set as list source
 181                     OUString("SELECT " +
 182                         getSettings().sListContentField +  ", " + getSettings().sLinkedListField +
 183                         " FROM " + getSettings().sListContentTable)
 184                 };
 185                 getContext().xObjectModel->setPropertyValue(u"ListSource"_ustr, Any(aListSource));
 186             }
 187             else
 188             {
 189                 // build the statement to set as list source
 190                 OUString sStatement = "SELECT DISTINCT " +
 191                     getSettings().sListContentField +
 192                     " FROM " + getSettings().sListContentTable;
 193                 getContext().xObjectModel->setPropertyValue( u"ListSource"_ustr, Any(sStatement));
 194             }
 195
 196             // the bound field
 197             getContext().xObjectModel->setPropertyValue(u"DataField"_ustr, Any(getSettings().sLinkedFormField));
 198         }
 199         catch(const Exception&)
 200         {
 201             OSL_FAIL("OListComboWizard::implApplySettings: could not set the property values for the listbox!");
 202         }
 203     }
 204
 205
 206     bool OListComboWizard::onFinish()
 207     {
 208         if ( !OControlWizard::onFinish() )
 209             return false;
 210
 211         implApplySettings();
 212         return true;
 213     }
 214
 215     Reference< XNameAccess > OLCPage::getTables() const
 216     {
 217         Reference< XConnection > xConn = getFormConnection();
 218         DBG_ASSERT(xConn.is(), "OLCPage::getTables: should have an active connection when reaching this page!");
 219
 220         Reference< XTablesSupplier > xSuppTables(xConn, UNO_QUERY);
 221         Reference< XNameAccess > xTables;
 222         if (xSuppTables.is())
 223             xTables = xSuppTables->getTables();
 224
 225         DBG_ASSERT(xTables.is() || !xConn.is(), "OLCPage::getTables: got no tables from the connection!");
 226
 227         return xTables;
 228     }
 229
 230
 231     Sequence< OUString > OLCPage::getTableFields()
 232     {
 233         Reference< XNameAccess > xTables = getTables();
 234         Sequence< OUString > aColumnNames;
 235         if (xTables.is())
 236         {
 237             try
 238             {
 239                 // the list table as XColumnsSupplier
 240                 Reference< XColumnsSupplier > xSuppCols;
 241                 xTables->getByName(getSettings().sListContentTable) >>= xSuppCols;
 242                 DBG_ASSERT(xSuppCols.is(), "OLCPage::getTableFields: no columns supplier!");
 243
 244                 // the columns
 245                 Reference< XNameAccess > xColumns;
 246                 if (xSuppCols.is())
 247                     xColumns = xSuppCols->getColumns();
 248
 249                 // the column names
 250                 if (xColumns.is())
 251                     aColumnNames = xColumns->getElementNames();
 252             }
 253             catch(const Exception&)
 254             {
 255                 TOOLS_WARN_EXCEPTION( "extensions.dbpilots", "OLinkFieldsPage::initializePage: caught an exception while retrieving the columns");
 256             }
 257         }
 258         return aColumnNames;
 259     }
 260
 261     OContentTableSelection::OContentTableSelection(weld::Container* pPage, OListComboWizard* pWizard)
 262         : OLCPage(pPage, pWizard, u"modules/sabpilot/ui/contenttablepage.ui"_ustr, u"TableSelectionPage"_ustr)
 263         , m_xSelectTable(m_xBuilder->weld_tree_view(u"table"_ustr))
 264     {
 265         enableFormDatasourceDisplay();
 266
 267         m_xSelectTable->connect_row_activated(LINK(this, OContentTableSelection, OnTableDoubleClicked));
 268         m_xSelectTable->connect_selection_changed(
 269             LINK(this, OContentTableSelection, OnTableSelected));
 270     }
 271
 272     OContentTableSelection::~OContentTableSelection()
 273     {
 274     }
 275
 276     void OContentTableSelection::Activate()
 277     {
 278         OLCPage::Activate();
 279         m_xSelectTable->grab_focus();
 280     }
 281
 282     bool OContentTableSelection::canAdvance() const
 283     {
 284         if (!OLCPage::canAdvance())
 285             return false;
 286
 287         return 0 != m_xSelectTable->count_selected_rows();
 288     }
 289
 290     IMPL_LINK_NOARG( OContentTableSelection, OnTableSelected, weld::TreeView&, void )
 291     {
 292         updateDialogTravelUI();
 293     }
 294
 295     IMPL_LINK( OContentTableSelection, OnTableDoubleClicked, weld::TreeView&, _rListBox, bool )
 296     {
 297         if (_rListBox.count_selected_rows())
 298             getDialog()->travelNext();
 299         return true;
 300     }
 301
 302     void OContentTableSelection::initializePage()
 303     {
 304         OLCPage::initializePage();
 305
 306         // fill the list with the table name
 307         m_xSelectTable->clear();
 308         try
 309         {
 310             Reference< XNameAccess > xTables = getTables();
 311             Sequence< OUString > aTableNames;
 312             if (xTables.is())
 313                 aTableNames = xTables->getElementNames();
 314             fillListBox(*m_xSelectTable, aTableNames);
 315         }
 316         catch(const Exception&)
 317         {
 318             OSL_FAIL("OContentTableSelection::initializePage: could not retrieve the table names!");
 319         }
 320
 321         m_xSelectTable->select_text(getSettings().sListContentTable);
 322     }
 323
 324
 325     bool OContentTableSelection::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 326     {
 327         if (!OLCPage::commitPage(_eReason))
 328             return false;
 329
 330         OListComboSettings& rSettings = getSettings();
 331         rSettings.sListContentTable = m_xSelectTable->get_selected_text();
 332         if (rSettings.sListContentTable.isEmpty() && (::vcl::WizardTypes::eTravelBackward != _eReason))
 333             // need to select a table
 334             return false;
 335
 336         return true;
 337     }
 338
 339     OContentFieldSelection::OContentFieldSelection(weld::Container* pPage, OListComboWizard* pWizard)
 340         : OLCPage(pPage, pWizard, u"modules/sabpilot/ui/contentfieldpage.ui"_ustr, u"FieldSelectionPage"_ustr)
 341         , m_xSelectTableField(m_xBuilder->weld_tree_view(u"selectfield"_ustr))
 342         , m_xDisplayedField(m_xBuilder->weld_entry(u"displayfield"_ustr))
 343         , m_xInfo(m_xBuilder->weld_label(u"info"_ustr))
 344     {
 345         m_xInfo->set_label(compmodule::ModuleRes( isListBox() ? RID_STR_FIELDINFO_LISTBOX : RID_STR_FIELDINFO_COMBOBOX));
 346         m_xSelectTableField->connect_selection_changed(
 347             LINK(this, OContentFieldSelection, OnFieldSelected));
 348         m_xSelectTableField->connect_row_activated(LINK(this, OContentFieldSelection, OnTableDoubleClicked));
 349     }
 350
 351     OContentFieldSelection::~OContentFieldSelection()
 352     {
 353     }
 354
 355     void OContentFieldSelection::initializePage()
 356     {
 357         OLCPage::initializePage();
 358
 359         // fill the list of fields
 360         fillListBox(*m_xSelectTableField, getTableFields());
 361
 362         m_xSelectTableField->select_text(getSettings().sListContentField);
 363         m_xDisplayedField->set_text(getSettings().sListContentField);
 364     }
 365
 366     bool OContentFieldSelection::canAdvance() const
 367     {
 368         if (!OLCPage::canAdvance())
 369             return false;
 370
 371         return 0 != m_xSelectTableField->count_selected_rows();
 372     }
 373
 374     IMPL_LINK_NOARG( OContentFieldSelection, OnTableDoubleClicked, weld::TreeView&, bool )
 375     {
 376         if (m_xSelectTableField->count_selected_rows())
 377             getDialog()->travelNext();
 378         return true;
 379     }
 380
 381     IMPL_LINK_NOARG( OContentFieldSelection, OnFieldSelected, weld::TreeView&, void )
 382     {
 383         updateDialogTravelUI();
 384         m_xDisplayedField->set_text(m_xSelectTableField->get_selected_text());
 385     }
 386
 387     bool OContentFieldSelection::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 388     {
 389         if (!OLCPage::commitPage(_eReason))
 390             return false;
 391
 392         getSettings().sListContentField = m_xSelectTableField->get_selected_text();
 393
 394         return true;
 395     }
 396
 397     OLinkFieldsPage::OLinkFieldsPage(weld::Container* pPage, OListComboWizard* pWizard)
 398         : OLCPage(pPage, pWizard, u"modules/sabpilot/ui/fieldlinkpage.ui"_ustr, u"FieldLinkPage"_ustr)
 399         , m_xValueListField(m_xBuilder->weld_combo_box(u"valuefield"_ustr))
 400         , m_xTableField(m_xBuilder->weld_combo_box(u"listtable"_ustr))
 401     {
 402         m_xValueListField->connect_changed(LINK(this, OLinkFieldsPage, OnSelectionModified));
 403         m_xTableField->connect_changed(LINK(this, OLinkFieldsPage, OnSelectionModified));
 404     }
 405
 406     OLinkFieldsPage::~OLinkFieldsPage()
 407     {
 408     }
 409
 410     void OLinkFieldsPage::Activate()
 411     {
 412         OLCPage::Activate();
 413         m_xValueListField->grab_focus();
 414     }
 415
 416     void OLinkFieldsPage::initializePage()
 417     {
 418         OLCPage::initializePage();
 419
 420         // fill the value list
 421         fillListBox(*m_xValueListField, getContext().aFieldNames);
 422         // fill the table field list
 423         fillListBox(*m_xTableField, getTableFields());
 424
 425         // the initial selections
 426         m_xValueListField->set_entry_text(getSettings().sLinkedFormField);
 427         m_xTableField->set_entry_text(getSettings().sLinkedListField);
 428
 429         implCheckFinish();
 430     }
 431
 432     bool OLinkFieldsPage::canAdvance() const
 433     {
 434         // we're on the last page here, no travelNext allowed ...
 435         return false;
 436     }
 437
 438     void OLinkFieldsPage::implCheckFinish()
 439     {
 440         bool bInvalidSelection = (-1 == m_xValueListField->find_text(m_xValueListField->get_active_text()));
 441         bInvalidSelection |= (-1 == m_xTableField->find_text(m_xTableField->get_active_text()));
 442         getDialog()->enableButtons(WizardButtonFlags::FINISH, !bInvalidSelection);
 443     }
 444
 445     IMPL_LINK_NOARG(OLinkFieldsPage, OnSelectionModified, weld::ComboBox&, void)
 446     {
 447         implCheckFinish();
 448     }
 449
 450     bool OLinkFieldsPage::commitPage( ::vcl::WizardTypes::CommitPageReason _eReason )
 451     {
 452         if (!OLCPage::commitPage(_eReason))
 453             return false;
 454
 455         getSettings().sLinkedFormField = m_xValueListField->get_active_text();
 456         getSettings().sLinkedListField = m_xTableField->get_active_text();
 457
 458         return true;
 459     }
 460
 461     OComboDBFieldPage::OComboDBFieldPage(weld::Container* pPage, OControlWizard* pWizard)
 462         : ODBFieldPage(pPage, pWizard)
 463     {
 464         setDescriptionText(compmodule::ModuleRes(RID_STR_COMBOWIZ_DBFIELD));
 465     }
 466
 467     OUString& OComboDBFieldPage::getDBFieldSetting()
 468     {
 469         return static_cast<OListComboWizard*>(getDialog())->getSettings().sLinkedFormField;
 470     }
 471
 472     void OComboDBFieldPage::Activate()
 473     {
 474         ODBFieldPage::Activate();
 475         getDialog()->enableButtons(WizardButtonFlags::FINISH, true);
 476     }
 477
 478     bool OComboDBFieldPage::canAdvance() const
 479     {
 480         // we're on the last page here, no travelNext allowed ...
 481         return false;
 482     }
 483
 484 }   // namespace dbp
 485
 486
 487 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */