dbaccess/source/ui/dlg/paramdialog.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 <core_resource.hxx>
  21 #include <paramdialog.hxx>
  22 #include <strings.hrc>
  23 #include <strings.hxx>
  24 #include <com/sun/star/util/NumberFormatter.hpp>
  25 #include <comphelper/types.hxx>
  26 #include <connectivity/dbtools.hxx>
  27 #include <vcl/weld.hxx>
  28 #include <o3tl/safeint.hxx>
  29 #include <osl/diagnose.h>
  30 #include <comphelper/diagnose_ex.hxx>
  31
  32 namespace dbaui
  33 {
  34
  35     using namespace ::com::sun::star::uno;
  36     using namespace ::com::sun::star::beans;
  37     using namespace ::com::sun::star::container;
  38     using namespace ::com::sun::star::sdbc;
  39     using namespace ::com::sun::star::util;
  40
  41     // OParameterDialog
  42
  43
  44     OParameterDialog::OParameterDialog(
  45             weld::Window* pParent, const Reference< XIndexAccess > & rParamContainer,
  46             const Reference< XConnection > & _rxConnection, const Reference< XComponentContext >& rxContext)
  47         : GenericDialogController(pParent, u"dbaccess/ui/parametersdialog.ui"_ustr, u"Parameters"_ustr)
  48         , m_nCurrentlySelected(-1)
  49         , m_xConnection(_rxConnection)
  50         , m_aPredicateInput( rxContext, _rxConnection, getParseContext() )
  51         , m_aResetVisitFlag("dbaccess OParameterDialog m_aResetVisitFlag")
  52         , m_xAllParams(m_xBuilder->weld_tree_view(u"allParamTreeview"_ustr))
  53         , m_xParam(m_xBuilder->weld_entry(u"paramEntry"_ustr))
  54         , m_xTravelNext(m_xBuilder->weld_button(u"next"_ustr))
  55         , m_xOKBtn(m_xBuilder->weld_button(u"ok"_ustr))
  56         , m_xCancelBtn(m_xBuilder->weld_button(u"cancel"_ustr))
  57     {
  58         m_xAllParams->set_size_request(-1, m_xAllParams->get_height_rows(10));
  59
  60         if (rxContext.is())
  61             m_xFormatter.set( NumberFormatter::create( rxContext ), UNO_QUERY_THROW);
  62         else {
  63             OSL_FAIL("OParameterDialog::OParameterDialog: need a service factory!");
  64         }
  65
  66         Reference< XNumberFormatsSupplier >  xNumberFormats = ::dbtools::getNumberFormats(m_xConnection, true);
  67         if (!xNumberFormats.is())
  68             ::comphelper::disposeComponent(m_xFormatter);
  69         else
  70             m_xFormatter->attachNumberFormatsSupplier(xNumberFormats);
  71         try
  72         {
  73             OSL_ENSURE(rParamContainer->getCount(), "OParameterDialog::OParameterDialog : can't handle empty containers !");
  74
  75             m_aFinalValues.realloc(rParamContainer->getCount());
  76             PropertyValue* pValues = m_aFinalValues.getArray();
  77
  78             for (sal_Int32 i = 0, nCount = rParamContainer->getCount(); i<nCount; ++i, ++pValues)
  79             {
  80                 Reference< XPropertySet >  xParamAsSet;
  81                 rParamContainer->getByIndex(i) >>= xParamAsSet;
  82                 OSL_ENSURE(xParamAsSet.is(),"Parameter is null!");
  83                 if(!xParamAsSet.is())
  84                     continue;
  85                 pValues->Name = ::comphelper::getString(xParamAsSet->getPropertyValue(PROPERTY_NAME));
  86                 m_xAllParams->append_text(pValues->Name);
  87
  88                 m_aVisitedParams.push_back(VisitFlags::NONE);
  89                     // not visited, not dirty
  90             }
  91
  92             m_xParams = rParamContainer;
  93         }
  94         catch(Exception&)
  95         {
  96             DBG_UNHANDLED_EXCEPTION("dbaccess");
  97         }
  98
  99         Construct();
 100
 101         m_aResetVisitFlag.SetInvokeHandler(LINK(this, OParameterDialog, OnVisitedTimeout));
 102     }
 103
 104     OParameterDialog::~OParameterDialog()
 105     {
 106         if (m_aResetVisitFlag.IsActive())
 107             m_aResetVisitFlag.Stop();
 108     }
 109
 110     void OParameterDialog::Construct()
 111     {
 112         m_xAllParams->connect_selection_changed(
 113             LINK(this, OParameterDialog, OnEntryListBoxSelected));
 114         m_xParam->connect_focus_out(LINK(this, OParameterDialog, OnValueLoseFocusHdl));
 115         m_xParam->connect_changed(LINK(this, OParameterDialog, OnValueModified));
 116         m_xTravelNext->connect_clicked(LINK(this, OParameterDialog, OnButtonClicked));
 117         m_xOKBtn->connect_clicked(LINK(this, OParameterDialog, OnButtonClicked));
 118         m_xCancelBtn->connect_clicked(LINK(this, OParameterDialog, OnButtonClicked));
 119
 120         if (m_xAllParams->n_children())
 121         {
 122             m_xAllParams->select(0);
 123             OnEntrySelected();
 124
 125             if (m_xAllParams->n_children() == 1)
 126                 m_xTravelNext->set_sensitive(false);
 127
 128             if (m_xAllParams->n_children() > 1)
 129                 m_xDialog->change_default_widget(m_xOKBtn.get(), m_xTravelNext.get());
 130         }
 131
 132         m_xParam->grab_focus();
 133     }
 134
 135     IMPL_LINK_NOARG(OParameterDialog, OnValueLoseFocusHdl, weld::Widget&, void)
 136     {
 137         CheckValueForError();
 138     }
 139
 140     bool OParameterDialog::CheckValueForError()
 141     {
 142         if (m_nCurrentlySelected != -1)
 143         {
 144             if ( !( m_aVisitedParams[ m_nCurrentlySelected ] & VisitFlags::Dirty ) )
 145                 // nothing to do, the value isn't dirty
 146                 return false;
 147         }
 148
 149         bool bRet = false;
 150
 151         Reference< XPropertySet >  xParamAsSet;
 152         m_xParams->getByIndex(m_nCurrentlySelected) >>= xParamAsSet;
 153         if (xParamAsSet.is())
 154         {
 155             if (m_xConnection.is() && m_xFormatter.is())
 156             {
 157                 OUString sParamValue(m_xParam->get_text());
 158                 bool bValid = m_aPredicateInput.normalizePredicateString( sParamValue, xParamAsSet );
 159                 m_xParam->set_text(sParamValue);
 160                 m_xParam->set_message_type(bValid ? weld::EntryMessageType::Normal : weld::EntryMessageType::Error);
 161                 OUString sToolTip;
 162                 if ( bValid )
 163                 {
 164                     // with this the value isn't dirty anymore
 165                     if (m_nCurrentlySelected != -1)
 166                         m_aVisitedParams[m_nCurrentlySelected] &= ~VisitFlags::Dirty;
 167                 }
 168                 else
 169                 {
 170                     OUString sName;
 171                     try
 172                     {
 173                         sName = ::comphelper::getString(xParamAsSet->getPropertyValue(PROPERTY_NAME));
 174                     }
 175                     catch(Exception&)
 176                     {
 177                         DBG_UNHANDLED_EXCEPTION("dbaccess");
 178                     }
 179
 180                     OUString sMessage(DBA_RES(STR_COULD_NOT_CONVERT_PARAM));
 181                     sToolTip = sMessage.replaceAll( "$name$", sName );
 182                     m_xParam->grab_focus();
 183                     bRet = true;
 184                 }
 185                 m_xParam->set_tooltip_text(sToolTip);
 186                 m_xOKBtn->set_sensitive(bValid);
 187             }
 188         }
 189
 190         return bRet;
 191     }
 192
 193     IMPL_LINK(OParameterDialog, OnButtonClicked, weld::Button&, rButton, void)
 194     {
 195         if (m_xCancelBtn.get() == &rButton)
 196         {
 197             // no interpreting of the given values anymore...
 198             m_xParam->connect_focus_out(Link<weld::Widget&, void>()); // no direct call from the control anymore ...
 199             m_xDialog->response(RET_CANCEL);
 200         }
 201         else if (m_xOKBtn.get() == &rButton)
 202         {
 203             // transfer the current values into the Any
 204             if (OnEntrySelected())
 205             {   // there was an error interpreting the current text
 206                 return;
 207             }
 208
 209             if (m_xParams.is())
 210             {
 211                 // write the parameters
 212                 try
 213                 {
 214                     PropertyValue* pValues = m_aFinalValues.getArray();
 215                     for (sal_Int32 i = 0, nCount = m_xParams->getCount(); i<nCount; ++i, ++pValues)
 216                     {
 217                         Reference< XPropertySet >  xParamAsSet;
 218                         m_xParams->getByIndex(i) >>= xParamAsSet;
 219
 220                         OUString sValue;
 221                         pValues->Value >>= sValue;
 222                         pValues->Value = m_aPredicateInput.getPredicateValue( sValue, xParamAsSet );
 223                     }
 224                 }
 225                 catch(Exception&)
 226                 {
 227                     DBG_UNHANDLED_EXCEPTION("dbaccess");
 228                 }
 229
 230             }
 231             m_xDialog->response(RET_OK);
 232         }
 233         else if (m_xTravelNext.get() == &rButton)
 234         {
 235             if (sal_Int32 nCount = m_xAllParams->n_children())
 236             {
 237                 sal_Int32 nCurrent = m_xAllParams->get_selected_index();
 238                 OSL_ENSURE(static_cast<size_t>(nCount) == m_aVisitedParams.size(), "OParameterDialog::OnButtonClicked : inconsistent lists !");
 239
 240                 // search the next entry in list we haven't visited yet
 241                 sal_Int32 nNext = (nCurrent + 1) % nCount;
 242                 while ((nNext != nCurrent) && ( m_aVisitedParams[nNext] & VisitFlags::Visited ))
 243                     nNext = (nNext + 1) % nCount;
 244
 245                 if ( m_aVisitedParams[nNext] & VisitFlags::Visited )
 246                     // there is no such "not visited yet" entry -> simply take the next one
 247                     nNext = (nCurrent + 1) % nCount;
 248
 249                 m_xAllParams->select(nNext);
 250                 OnEntrySelected();
 251             }
 252         }
 253     }
 254
 255     IMPL_LINK_NOARG(OParameterDialog, OnEntryListBoxSelected, weld::TreeView&, void)
 256     {
 257         OnEntrySelected();
 258     }
 259
 260     bool OParameterDialog::OnEntrySelected()
 261     {
 262         if (m_aResetVisitFlag.IsActive())
 263         {
 264             LINK(this, OParameterDialog, OnVisitedTimeout).Call(&m_aResetVisitFlag);
 265             m_aResetVisitFlag.Stop();
 266         }
 267         // save the old values
 268         if (m_nCurrentlySelected != -1)
 269         {
 270             // do the transformation of the current text
 271             if (CheckValueForError())
 272             {   // there was an error interpreting the text
 273                 m_xAllParams->select(m_nCurrentlySelected);
 274                 return true;
 275             }
 276
 277             m_aFinalValues.getArray()[m_nCurrentlySelected].Value <<= m_xParam->get_text();
 278         }
 279
 280         // initialize the controls with the new values
 281         sal_Int32 nSelected = m_xAllParams->get_selected_index();
 282         OSL_ENSURE(nSelected != -1, "OParameterDialog::OnEntrySelected : no current entry !");
 283
 284         m_xParam->set_text(::comphelper::getString(m_aFinalValues[nSelected].Value));
 285         m_nCurrentlySelected = nSelected;
 286
 287         // with this the value isn't dirty
 288         OSL_ENSURE(o3tl::make_unsigned(m_nCurrentlySelected) < m_aVisitedParams.size(), "OParameterDialog::OnEntrySelected : invalid current entry !");
 289         m_aVisitedParams[m_nCurrentlySelected] &= ~VisitFlags::Dirty;
 290
 291         m_aResetVisitFlag.SetTimeout(1000);
 292         m_aResetVisitFlag.Start();
 293
 294         return false;
 295     }
 296
 297     IMPL_LINK_NOARG(OParameterDialog, OnVisitedTimeout, Timer*, void)
 298     {
 299         OSL_ENSURE(m_nCurrentlySelected != -1, "OParameterDialog::OnVisitedTimeout : invalid call !");
 300
 301         // mark the currently selected entry as visited
 302         OSL_ENSURE(o3tl::make_unsigned(m_nCurrentlySelected) < m_aVisitedParams.size(), "OParameterDialog::OnVisitedTimeout : invalid entry !");
 303         m_aVisitedParams[m_nCurrentlySelected] |= VisitFlags::Visited;
 304
 305         // was it the last "not visited yet" entry ?
 306         bool bVisited = false;
 307         for (auto const& visitedParam : m_aVisitedParams)
 308         {
 309             if (!(visitedParam & VisitFlags::Visited))
 310             {
 311                 bVisited = true;
 312                 break;
 313             }
 314         }
 315
 316         if (!bVisited)
 317         {
 318             // yes, there isn't another one -> change the "default button"
 319             m_xDialog->change_default_widget(m_xTravelNext.get(), m_xOKBtn.get());
 320         }
 321     }
 322
 323     IMPL_LINK(OParameterDialog, OnValueModified, weld::Entry&, rEdit, void)
 324     {
 325         // mark the currently selected entry as dirty
 326         OSL_ENSURE(o3tl::make_unsigned(m_nCurrentlySelected) < m_aVisitedParams.size(), "OParameterDialog::OnValueModified : invalid entry !");
 327         m_aVisitedParams[m_nCurrentlySelected] |= VisitFlags::Dirty;
 328         rEdit.set_message_type(weld::EntryMessageType::Normal);
 329     }
 330
 331 }   // namespace dbaui
 332
 333 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */