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