LibreOffice Module cui (master)  1
optgenrl.cxx
Go to the documentation of this file.
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 <comphelper/string.hxx>
22 
23 #include <config_gpgme.h>
24 #if HAVE_FEATURE_GPGME
25 # include <com/sun/star/xml/crypto/GPGSEInitializer.hpp>
26 # include <com/sun/star/xml/crypto/XXMLSecurityContext.hpp>
27 #endif
28 
30 #include <i18nlangtag/mslangid.hxx>
31 #include <vcl/svapp.hxx>
32 #include <unotools/saveopt.hxx>
33 #include <svl/intitem.hxx>
34 #include <vcl/settings.hxx>
35 
36 #include <unotools/useroptions.hxx>
37 #include <cuioptgenrl.hxx>
38 #include <svx/svxids.hrc>
39 #include <svx/optgenrl.hxx>
40 
41 using namespace css;
42 
43 namespace
44 {
45 
46 // rows
47 enum RowType
48 {
49  Row_Company,
50  Row_Name,
51  Row_Name_Russian,
52  Row_Name_Eastern,
53  Row_Street,
54  Row_Street_Russian,
55  Row_City,
56  Row_City_US,
57  Row_Country,
58  Row_TitlePos,
59  Row_Phone,
60  Row_FaxMail,
61 
62  nRowCount
63 };
64 
65 // language flags
66 namespace Lang
67 {
68  unsigned const Others = 1;
69  unsigned const Russian = 2;
70  unsigned const Eastern = 4;
71  unsigned const US = 8;
72  unsigned const All = static_cast<unsigned>(-1);
73 }
74 
75 
76 // vRowInfo[] -- rows (text + one or more edit boxes)
77 // The order is the same as in RowType above, which is up to down.
78 
79 struct
80 {
81  // id of the text
82  const char *pTextId;
83  // language flags (see Lang above):
84  // which language is this row for?
85  unsigned nLangFlags;
86 }
87 const vRowInfo[] =
88 {
89  { "companyft", Lang::All },
90  { "nameft", Lang::All & ~Lang::Russian & ~Lang::Eastern },
91  { "rusnameft", Lang::Russian },
92  { "eastnameft", Lang::Eastern },
93  { "streetft", Lang::All & ~Lang::Russian },
94  { "russtreetft", Lang::Russian },
95  { "icityft", Lang::All & ~Lang::US },
96  { "cityft", Lang::US },
97  { "countryft", Lang::All },
98  { "titleft", Lang::All },
99  { "phoneft", Lang::All },
100  { "faxft", Lang::All },
101 };
102 
103 
104 // vFieldInfo[] -- edit boxes
105 // The order is up to down, and then left to right.
106 
107 struct
108 {
109  // in which row?
110  RowType eRow;
111  // id of the edit box
112  const char *pEditId;
113  // id for SvtUserOptions in unotools/useroptions.hxx
114  UserOptToken nUserOptionsId;
115  // id for settings the focus (defined in svx/optgenrl.hxx)
116  EditPosition nGrabFocusId;
117 }
118 const vFieldInfo[] =
119 {
120  // Company
121  { Row_Company, "company", UserOptToken::Company, EditPosition::COMPANY },
122  // Name
123  { Row_Name, "firstname", UserOptToken::FirstName, EditPosition::FIRSTNAME },
124  { Row_Name, "lastname", UserOptToken::LastName, EditPosition::LASTNAME },
125  { Row_Name, "shortname", UserOptToken::ID, EditPosition::SHORTNAME },
126  // Name (russian)
127  { Row_Name_Russian, "ruslastname", UserOptToken::LastName, EditPosition::LASTNAME },
128  { Row_Name_Russian, "rusfirstname", UserOptToken::FirstName, EditPosition::FIRSTNAME },
129  { Row_Name_Russian, "rusfathersname", UserOptToken::FathersName, EditPosition::UNKNOWN },
130  { Row_Name_Russian, "russhortname", UserOptToken::ID, EditPosition::SHORTNAME },
131  // Name (eastern: reversed name ord
132  { Row_Name_Eastern, "eastlastname", UserOptToken::LastName, EditPosition::LASTNAME },
133  { Row_Name_Eastern, "eastfirstname", UserOptToken::FirstName, EditPosition::FIRSTNAME },
134  { Row_Name_Eastern, "eastshortname", UserOptToken::ID, EditPosition::SHORTNAME },
135  // Street
136  { Row_Street, "street", UserOptToken::Street, EditPosition::STREET },
137  // Street (russian)
138  { Row_Street_Russian, "russtreet", UserOptToken::Street, EditPosition::STREET },
139  { Row_Street_Russian, "apartnum", UserOptToken::Apartment, EditPosition::UNKNOWN },
140  // City
141  { Row_City, "izip", UserOptToken::Zip, EditPosition::PLZ },
142  { Row_City, "icity", UserOptToken::City, EditPosition::CITY },
143  // City (US)
144  { Row_City_US, "city", UserOptToken::City, EditPosition::CITY },
145  { Row_City_US, "state", UserOptToken::State, EditPosition::STATE },
146  { Row_City_US, "zip", UserOptToken::Zip, EditPosition::PLZ },
147  // Country
148  { Row_Country, "country", UserOptToken::Country, EditPosition::COUNTRY },
149  // Title/Position
150  { Row_TitlePos, "title", UserOptToken::Title, EditPosition::TITLE },
151  { Row_TitlePos, "position", UserOptToken::Position, EditPosition::POSITION },
152  // Phone
153  { Row_Phone, "home", UserOptToken::TelephoneHome, EditPosition::TELPRIV },
154  { Row_Phone, "work", UserOptToken::TelephoneWork, EditPosition::TELCOMPANY },
155  // Fax/Mail
156  { Row_FaxMail, "fax", UserOptToken::Fax, EditPosition::FAX },
157  { Row_FaxMail, "email", UserOptToken::Email, EditPosition::EMAIL },
158 };
159 
160 
161 } // namespace
162 
163 
164 // Row
165 
167 {
168  // row label
169  std::unique_ptr<weld::Label> xLabel;
170  // first and last field in the row (last is exclusive)
171  unsigned nFirstField, nLastField;
172 
173 public:
174  explicit Row (std::unique_ptr<weld::Label> xLabel_)
175  : xLabel(std::move(xLabel_))
176  , nFirstField(0)
177  , nLastField(0)
178  {
179  xLabel->show();
180  }
181 };
182 
183 
184 // Field
185 
187 {
188  // which field is this? (in vFieldInfo[] above)
189  unsigned iField;
190  // edit box
191  std::unique_ptr<weld::Entry> xEdit;
192  std::unique_ptr<weld::Container> xParent;
193 
194 public:
195  Field (std::unique_ptr<weld::Entry> xEdit_, unsigned iField_)
196  : iField(iField_)
197  , xEdit(std::move(xEdit_))
198  , xParent(xEdit->weld_parent())
199  {
200  //We want all widgets inside a container, so each row of the toplevel
201  //grid has another container in it. To avoid adding spacing to these
202  //empty grids they all default to invisible, so show them if their
203  //children are visible
204  xParent->show();
205  xEdit->show();
206  }
207 };
208 
209 
211  : SfxTabPage(pParent, "cui/ui/optuserpage.ui", "OptUserPage", &rCoreSet)
212  , m_xUseDataCB(m_xBuilder->weld_check_button("usefordocprop"))
213  , m_xCryptoFrame(m_xBuilder->weld_widget( "cryptography"))
214  , m_xSigningKeyLB(m_xBuilder->weld_combo_box("signingkey"))
215  , m_xEncryptionKeyLB(m_xBuilder->weld_combo_box("encryptionkey"))
216  , m_xEncryptToSelfCB(m_xBuilder->weld_check_button("encrypttoself"))
217 {
218  InitControls();
219 #if HAVE_FEATURE_GPGME
221 #else
222  m_xCryptoFrame->hide();
223 #endif
224 
225  SetExchangeSupport(); // this page needs ExchangeSupport
226  SetLinks();
227 }
228 
230 {
231  disposeOnce();
232 }
233 
234 // Initializes the titles and the edit boxes,
235 // according to vRowInfo[] and vFieldInfo[] above.
237 {
238  // which language bit do we use? (see Lang and vRowInfo[] above)
239  unsigned LangBit;
241  if (l == LANGUAGE_ENGLISH_US)
242  LangBit = Lang::US;
243  else if (l == LANGUAGE_RUSSIAN)
244  LangBit = Lang::Russian;
245  else
246  {
248  LangBit = Lang::Eastern;
249  else
250  LangBit = Lang::Others;
251  }
252 
253  // creating rows
254  unsigned iField = 0;
255  for (unsigned iRow = 0; iRow != nRowCount; ++iRow)
256  {
257  RowType const eRow = static_cast<RowType>(iRow);
258  // is the row visible?
259  if (!(vRowInfo[iRow].nLangFlags & LangBit))
260  continue;
261  // creating row
262  vRows.push_back(std::make_shared<Row>(
263  m_xBuilder->weld_label(vRowInfo[iRow].pTextId)));
264  Row& rRow = *vRows.back();
265  // fields in the row
266  static unsigned const nFieldCount = SAL_N_ELEMENTS(vFieldInfo);
267  // skipping other (invisible) rows
268  while (iField != nFieldCount && vFieldInfo[iField].eRow != eRow)
269  ++iField;
270  // fields in the row
271  rRow.nFirstField = vFields.size();
272  for ( ; iField != nFieldCount && vFieldInfo[iField].eRow == eRow; ++iField)
273  {
274  // creating edit field
275  vFields.push_back(std::make_shared<Field>(
276  m_xBuilder->weld_entry(vFieldInfo[iField].pEditId), iField));
277  // "short name" field?
278  if (vFieldInfo[iField].nUserOptionsId == UserOptToken::ID)
279  {
280  nNameRow = vRows.size() - 1;
281  nShortNameField = vFields.size() - 1;
282  }
283  }
284  rRow.nLastField = vFields.size();
285  }
286 }
287 
289 {
290 #if HAVE_FEATURE_GPGME
291  m_xCryptoFrame->show();
292 
293  uno::Reference< xml::crypto::XSEInitializer > xSEInitializer;
294  try
295  {
296  xSEInitializer = xml::crypto::GPGSEInitializer::create( comphelper::getProcessComponentContext() );
297  uno::Reference<xml::crypto::XXMLSecurityContext> xSC = xSEInitializer->createSecurityContext( OUString() );
298  if (xSC.is())
299  {
300  uno::Reference<xml::crypto::XSecurityEnvironment> xSE = xSC->getSecurityEnvironment();
301  uno::Sequence<uno::Reference<security::XCertificate>> xCertificates = xSE->getPersonalCertificates();
302 
303  if (xCertificates.hasElements())
304  {
305  for (auto& xCert : xCertificates)
306  {
307  m_xSigningKeyLB->append_text( xCert->getIssuerName());
308  m_xEncryptionKeyLB->append_text( xCert->getIssuerName());
309  }
310  }
311 
312  //tdf#115015: wrap checkbox text and listboxes if necessary
313  int nPrefWidth(m_xEncryptToSelfCB->get_preferred_size().Width());
314  int nMaxWidth = m_xEncryptToSelfCB->get_approximate_digit_width() * 40;
315  if (nPrefWidth > nMaxWidth)
316  {
317  m_xSigningKeyLB->set_size_request(nMaxWidth, -1);
318  m_xEncryptionKeyLB->set_size_request(nMaxWidth, -1);
319  m_xEncryptToSelfCB->set_label_line_wrap(true);
320  m_xEncryptToSelfCB->set_size_request(nMaxWidth, -1);
321  }
322  }
323  }
324  catch ( uno::Exception const & )
325  {}
326 #endif
327 
328 }
329 
331 {
332  // link for updating the initials
333  Link<weld::Entry&,void> aLink = LINK( this, SvxGeneralTabPage, ModifyHdl_Impl );
334  Row& rNameRow = *vRows[nNameRow];
335  for (unsigned i = rNameRow.nFirstField; i != rNameRow.nLastField - 1; ++i)
336  vFields[i]->xEdit->connect_changed(aLink);
337 }
338 
339 
341 {
342  return VclPtr<SvxGeneralTabPage>::Create( pParent, *rAttrSet );
343 }
344 
346 {
347  // remove leading and trailing whitespaces
348  for (auto const & i: vFields)
349  i->xEdit->set_text(comphelper::string::strip(i->xEdit->get_text(), ' '));
350 
351  bool bModified = false;
352  bModified |= GetData_Impl();
353  SvtSaveOptions aSaveOpt;
354  if (m_xUseDataCB->get_active() != aSaveOpt.IsUseUserData())
355  {
356  aSaveOpt.SetUseUserData(m_xUseDataCB->get_active());
357  bModified = true;
358  }
359  return bModified;
360 }
361 
363 {
364  SetData_Impl();
365 
366  sal_uInt16 const nWhich = GetWhich(SID_FIELD_GRABFOCUS);
367 
368  if (rSet->GetItemState(nWhich) == SfxItemState::SET)
369  {
370  EditPosition nField = static_cast<EditPosition>(static_cast<const SfxUInt16Item&>(rSet->Get(nWhich)).GetValue());
371  if (nField != EditPosition::UNKNOWN)
372  {
373  for (auto const & i: vFields)
374  if (nField == vFieldInfo[i->iField].nGrabFocusId)
375  i->xEdit->grab_focus();
376  }
377  else
378  vFields.front()->xEdit->grab_focus();
379  }
380 
381  m_xUseDataCB->set_sensitive( SvtSaveOptions().IsUseUserData() );
382 }
383 
384 
385 // ModifyHdl_Impl()
386 // This handler updates the initials (short name)
387 // when one of the name fields was updated.
388 IMPL_LINK( SvxGeneralTabPage, ModifyHdl_Impl, weld::Entry&, rEdit, void )
389 {
390  // short name field and row
391  Field& rShortName = *vFields[nShortNameField];
392  Row& rNameRow = *vRows[nNameRow];
393  // number of initials
394  unsigned const nInits = rNameRow.nLastField - rNameRow.nFirstField - 1;
395  // which field was updated? (in rNameRow)
396  unsigned nField = nInits;
397  for (unsigned i = 0; i != nInits; ++i)
398  {
399  if (vFields[rNameRow.nFirstField + i]->xEdit.get() == &rEdit)
400  nField = i;
401  }
402  // updating the initial
403  if (nField < nInits && rShortName.xEdit->get_sensitive())
404  {
405  OUString sShortName = rShortName.xEdit->get_text();
406  // clear short name if it contains more characters than the number of initials
407  if (static_cast<unsigned>(sShortName.getLength()) > nInits)
408  {
409  rShortName.xEdit->set_text(OUString());
410  }
411  while (static_cast<unsigned>(sShortName.getLength()) < nInits)
412  sShortName += " ";
413  OUString sName = rEdit.get_text();
414  OUString sLetter = sName.isEmpty()
415  ? OUString(u' ') : sName.copy(0, 1);
416  rShortName.xEdit->set_text(sShortName.replaceAt(nField, 1, sLetter).trim());
417  }
418 }
419 
420 
422 {
423  // updating
424  SvtUserOptions aUserOpt;
425  for (auto const & i: vFields)
426  aUserOpt.SetToken(
427  vFieldInfo[i->iField].nUserOptionsId,
428  i->xEdit->get_text()
429  );
430 
431  // modified?
432  bool bModified = false;
433  for (auto const & i: vFields)
434  {
435  if (i->xEdit->get_value_changed_from_saved())
436  {
437  bModified = true;
438  break;
439  }
440  }
441 
442 #if HAVE_FEATURE_GPGME
443  OUString aSK = m_xSigningKeyLB->get_active() == 0 ? OUString() //i.e. no key
444  : m_xSigningKeyLB->get_active_text();
445  OUString aEK = m_xEncryptionKeyLB->get_active() == 0 ? OUString()
446  : m_xEncryptionKeyLB->get_active_text();
447 
448  aUserOpt.SetToken( UserOptToken::SigningKey, aSK );
449  aUserOpt.SetToken( UserOptToken::EncryptionKey, aEK );
450  aUserOpt.SetBoolValue( UserOptToken::EncryptToSelf, m_xEncryptToSelfCB->get_active() );
451 
452  bModified |= m_xSigningKeyLB->get_value_changed_from_saved() ||
453  m_xEncryptionKeyLB->get_value_changed_from_saved() ||
454  m_xEncryptToSelfCB->get_state_changed_from_saved();
455 #endif
456 
457  return bModified;
458 }
459 
460 
462 {
463  // updating and disabling edit boxes
464  SvtUserOptions aUserOpt;
465  for (auto const & i: vRows)
466  {
467  Row& rRow = *i;
468  // the label is enabled if any of its edit fields are enabled
469  bool bEnableLabel = false;
470  for (unsigned iField = rRow.nFirstField; iField != rRow.nLastField; ++iField)
471  {
472  Field& rField = *vFields[iField];
473  // updating content
474  UserOptToken const nToken = vFieldInfo[rField.iField].nUserOptionsId;
475  rField.xEdit->set_text(aUserOpt.GetToken(nToken));
476  // is enabled?
477  bool const bEnableEdit = !aUserOpt.IsTokenReadonly(nToken);
478  rField.xEdit->set_sensitive(bEnableEdit);
479  bEnableLabel = bEnableLabel || bEnableEdit;
480  }
481  rRow.xLabel->set_sensitive(bEnableLabel);
482  }
483 
484  // saving
485  for (auto const & i: vFields)
486  i->xEdit->save_value();
487 
488 #if HAVE_FEATURE_GPGME
489  OUString aSK = aUserOpt.GetToken(UserOptToken::SigningKey);
490  aSK.isEmpty() ? m_xSigningKeyLB->set_active( 0 ) //i.e. 'No Key'
491  : m_xSigningKeyLB->set_active_text( aSK );
492 
493  OUString aEK = aUserOpt.GetToken(UserOptToken::EncryptionKey);
494  aEK.isEmpty() ? m_xEncryptionKeyLB->set_active( 0 ) //i.e. 'No Key'
495  : m_xEncryptionKeyLB->set_active_text( aEK );
496 
497  m_xEncryptToSelfCB->set_active( aUserOpt.GetEncryptToSelf() );
498 #endif
499 }
500 
501 
503 {
504  if ( pSet_ )
505  FillItemSet( pSet_ );
506  return DeactivateRC::LeavePage;
507 }
508 
509 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
static VclPtr< SfxTabPage > Create(TabPageParent pParent, const SfxItemSet *rAttrSet)
Definition: optgenrl.cxx:340
OUString GetToken(UserOptToken nToken) const
#define LANGUAGE_ENGLISH_US
const LanguageTag & GetUILanguageTag() const
std::string GetValue
unsigned nShortNameField
Definition: cuioptgenrl.hxx:49
LanguageType getLanguageType(bool bResolveSystem=true) const
static const AllSettings & GetSettings()
#define LANGUAGE_RUSSIAN
std::unique_ptr< weld::Entry > xEdit
Definition: optgenrl.cxx:191
std::unique_ptr< weld::Widget > m_xCryptoFrame
Definition: cuioptgenrl.hxx:37
RowType
Definition: optgenrl.cxx:47
std::unique_ptr< weld::ComboBox > m_xSigningKeyLB
Definition: cuioptgenrl.hxx:38
std::vector< std::shared_ptr< Row > > vRows
Definition: cuioptgenrl.hxx:42
bool IsTokenReadonly(UserOptToken nToken) const
std::unique_ptr< weld::CheckButton > m_xEncryptToSelfCB
Definition: cuioptgenrl.hxx:40
void SetExchangeSupport()
OString strip(const OString &rIn, sal_Char c)
virtual bool FillItemSet(SfxItemSet *rSet) override
Definition: optgenrl.cxx:345
#define SAL_N_ELEMENTS(arr)
void SetUseUserData(bool b)
Field(std::unique_ptr< weld::Entry > xEdit_, unsigned iField_)
Definition: optgenrl.cxx:195
static bool isFamilyNameFirst(LanguageType nLang)
void SetBoolValue(UserOptToken nToken, bool bNewValue)
void InitCryptography()
Definition: optgenrl.cxx:288
bool IsUseUserData() const
SfxItemState GetItemState(sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
std::unique_ptr< weld::Builder > m_xBuilder
bool GetEncryptToSelf() const
OUString sName
int i
std::unique_ptr< weld::CheckButton > m_xUseDataCB
Definition: cuioptgenrl.hxx:36
float u
IMPL_LINK(SvxGeneralTabPage, ModifyHdl_Impl, weld::Entry &, rEdit, void)
Definition: optgenrl.cxx:388
virtual OUString get_text() const =0
virtual DeactivateRC DeactivatePage(SfxItemSet *pSet) override
Definition: optgenrl.cxx:502
void SetToken(UserOptToken nToken, OUString const &rNewToken)
std::vector< std::shared_ptr< Field > > vFields
Definition: cuioptgenrl.hxx:45
weld::Entry & rEdit
UserOptToken
const SfxPoolItem & Get(sal_uInt16 nWhich, bool bSrchInParent=true) const
static VclPtr< reference_type > Create(Arg &&...arg)
virtual void Reset(const SfxItemSet *rSet) override
Definition: optgenrl.cxx:362
Reference< XComponentContext > getProcessComponentContext()
std::unique_ptr< weld::Label > xLabel
Definition: optgenrl.cxx:169
DeactivateRC
virtual ~SvxGeneralTabPage() override
Definition: optgenrl.cxx:229
std::unique_ptr< weld::ComboBox > m_xEncryptionKeyLB
Definition: cuioptgenrl.hxx:39
SvxGeneralTabPage(TabPageParent pParent, const SfxItemSet &rSet)
Definition: optgenrl.cxx:210
DefTokenId const nToken
Row(std::unique_ptr< weld::Label > xLabel_)
Definition: optgenrl.cxx:174
sal_uInt16 GetWhich(sal_uInt16 nSlot, bool bDeep=true) const
std::unique_ptr< weld::Container > xParent
Definition: optgenrl.cxx:192