| File: | home/maarten/src/libreoffice/core/include/rtl/ref.hxx |
| Warning: | line 192, column 9 Use of memory after it is freed |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
| 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 <com/sun/star/task/DocumentPasswordRequest.hpp> | ||||||||
| 21 | #include <com/sun/star/task/DocumentPasswordRequest2.hpp> | ||||||||
| 22 | #include <com/sun/star/task/DocumentMSPasswordRequest.hpp> | ||||||||
| 23 | #include <com/sun/star/task/DocumentMSPasswordRequest2.hpp> | ||||||||
| 24 | #include <com/sun/star/task/MasterPasswordRequest.hpp> | ||||||||
| 25 | #include <com/sun/star/task/XInteractionAbort.hpp> | ||||||||
| 26 | #include <com/sun/star/task/XInteractionPassword.hpp> | ||||||||
| 27 | #include <com/sun/star/task/XInteractionPassword2.hpp> | ||||||||
| 28 | #include <com/sun/star/task/XInteractionRetry.hpp> | ||||||||
| 29 | #include <com/sun/star/ucb/XInteractionAuthFallback.hpp> | ||||||||
| 30 | #include <com/sun/star/ucb/XInteractionSupplyAuthentication2.hpp> | ||||||||
| 31 | #include <com/sun/star/ucb/URLAuthenticationRequest.hpp> | ||||||||
| 32 | |||||||||
| 33 | #include <osl/diagnose.h> | ||||||||
| 34 | #include <rtl/digest.h> | ||||||||
| 35 | #include <rtl/ustrbuf.hxx> | ||||||||
| 36 | #include <unotools/resmgr.hxx> | ||||||||
| 37 | #include <vcl/errinf.hxx> | ||||||||
| 38 | #include <vcl/abstdlg.hxx> | ||||||||
| 39 | #include <vcl/svapp.hxx> | ||||||||
| 40 | #include <sal/log.hxx> | ||||||||
| 41 | |||||||||
| 42 | #include "authfallbackdlg.hxx" | ||||||||
| 43 | #include <strings.hrc> | ||||||||
| 44 | #include "getcontinuations.hxx" | ||||||||
| 45 | #include "passwordcontainer.hxx" | ||||||||
| 46 | #include "loginerr.hxx" | ||||||||
| 47 | #include "logindlg.hxx" | ||||||||
| 48 | #include "masterpasscrtdlg.hxx" | ||||||||
| 49 | #include "masterpassworddlg.hxx" | ||||||||
| 50 | #include "passworddlg.hxx" | ||||||||
| 51 | |||||||||
| 52 | #include "iahndl.hxx" | ||||||||
| 53 | |||||||||
| 54 | #include <memory> | ||||||||
| 55 | |||||||||
| 56 | using namespace com::sun::star; | ||||||||
| 57 | |||||||||
| 58 | namespace { | ||||||||
| 59 | |||||||||
| 60 | void | ||||||||
| 61 | executeLoginDialog( | ||||||||
| 62 | weld::Window* pParent, | ||||||||
| 63 | LoginErrorInfo & rInfo, | ||||||||
| 64 | OUString const & rRealm) | ||||||||
| 65 | { | ||||||||
| 66 | SolarMutexGuard aGuard; | ||||||||
| 67 | |||||||||
| 68 | bool bAccount = (rInfo.GetFlags() & LOGINERROR_FLAG_MODIFY_ACCOUNT1) != 0; | ||||||||
| 69 | bool bSavePassword = rInfo.GetCanRememberPassword(); | ||||||||
| 70 | bool bCanUseSysCreds = rInfo.GetCanUseSystemCredentials(); | ||||||||
| 71 | |||||||||
| 72 | LoginFlags nFlags = LoginFlags::NONE; | ||||||||
| 73 | if (rInfo.GetErrorText().isEmpty()) | ||||||||
| 74 | nFlags |= LoginFlags::NoErrorText; | ||||||||
| 75 | if (!bAccount) | ||||||||
| 76 | nFlags |= LoginFlags::NoAccount; | ||||||||
| 77 | if (!(rInfo.GetFlags() & LOGINERROR_FLAG_MODIFY_USER_NAME2)) | ||||||||
| 78 | nFlags |= LoginFlags::UsernameReadonly; | ||||||||
| 79 | |||||||||
| 80 | if (!bSavePassword) | ||||||||
| 81 | nFlags |= LoginFlags::NoSavePassword; | ||||||||
| 82 | |||||||||
| 83 | if (!bCanUseSysCreds) | ||||||||
| 84 | nFlags |= LoginFlags::NoUseSysCreds; | ||||||||
| 85 | |||||||||
| 86 | LoginDialog aDialog(pParent, nFlags, rInfo.GetServer(), rRealm); | ||||||||
| 87 | if (!rInfo.GetErrorText().isEmpty()) | ||||||||
| 88 | aDialog.SetErrorText(rInfo.GetErrorText()); | ||||||||
| 89 | aDialog.SetName(rInfo.GetUserName()); | ||||||||
| 90 | if (bAccount) | ||||||||
| 91 | aDialog.ClearAccount(); | ||||||||
| 92 | else | ||||||||
| 93 | aDialog.ClearPassword(); | ||||||||
| 94 | aDialog.SetPassword(rInfo.GetPassword()); | ||||||||
| 95 | |||||||||
| 96 | if (bSavePassword) | ||||||||
| 97 | { | ||||||||
| 98 | std::locale aLocale(Translate::Create("uui")); | ||||||||
| 99 | aDialog.SetSavePasswordText( | ||||||||
| 100 | Translate::get(rInfo.GetIsRememberPersistent() | ||||||||
| 101 | ? RID_SAVE_PASSWORDreinterpret_cast<char const *>("RID_SAVE_PASSWORD" "\004" u8"~Remember password") | ||||||||
| 102 | : RID_KEEP_PASSWORDreinterpret_cast<char const *>("RID_KEEP_PASSWORD" "\004" u8"~Remember password until end of session"), | ||||||||
| 103 | aLocale)); | ||||||||
| 104 | |||||||||
| 105 | aDialog.SetSavePassword(rInfo.GetIsRememberPassword()); | ||||||||
| 106 | } | ||||||||
| 107 | |||||||||
| 108 | if ( bCanUseSysCreds ) | ||||||||
| 109 | aDialog.SetUseSystemCredentials( rInfo.GetIsUseSystemCredentials() ); | ||||||||
| 110 | |||||||||
| 111 | rInfo.SetResult(aDialog.run() == RET_OK ? DialogMask::ButtonsOk : | ||||||||
| 112 | DialogMask::ButtonsCancel); | ||||||||
| 113 | rInfo.SetUserName(aDialog.GetName()); | ||||||||
| 114 | rInfo.SetPassword(aDialog.GetPassword()); | ||||||||
| 115 | rInfo.SetAccount(aDialog.GetAccount()); | ||||||||
| 116 | rInfo.SetIsRememberPassword(aDialog.IsSavePassword()); | ||||||||
| 117 | |||||||||
| 118 | if ( bCanUseSysCreds ) | ||||||||
| 119 | rInfo.SetIsUseSystemCredentials( aDialog.IsUseSystemCredentials() ); | ||||||||
| 120 | } | ||||||||
| 121 | |||||||||
| 122 | void getRememberModes( | ||||||||
| 123 | uno::Sequence< ucb::RememberAuthentication > const & rRememberModes, | ||||||||
| 124 | ucb::RememberAuthentication & rPreferredMode, | ||||||||
| 125 | ucb::RememberAuthentication & rAlternateMode ) | ||||||||
| 126 | { | ||||||||
| 127 | sal_Int32 nCount = rRememberModes.getLength(); | ||||||||
| 128 | OSL_ENSURE( (nCount > 0) && (nCount < 4),do { if (true && (!((nCount > 0) && (nCount < 4)))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "129" ": "), "%s", "ucb::RememberAuthentication sequence size mismatch!" ); } } while (false) | ||||||||
| 129 | "ucb::RememberAuthentication sequence size mismatch!" )do { if (true && (!((nCount > 0) && (nCount < 4)))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN ), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "129" ": "), "%s", "ucb::RememberAuthentication sequence size mismatch!" ); } } while (false); | ||||||||
| 130 | if ( nCount == 1 ) | ||||||||
| 131 | { | ||||||||
| 132 | rPreferredMode = rAlternateMode = rRememberModes[ 0 ]; | ||||||||
| 133 | return; | ||||||||
| 134 | } | ||||||||
| 135 | else | ||||||||
| 136 | { | ||||||||
| 137 | bool bHasRememberModeSession = false; | ||||||||
| 138 | bool bHasRememberModePersistent = false; | ||||||||
| 139 | |||||||||
| 140 | for (const auto& rRememberMode : rRememberModes) | ||||||||
| 141 | { | ||||||||
| 142 | switch ( rRememberMode ) | ||||||||
| 143 | { | ||||||||
| 144 | case ucb::RememberAuthentication_NO: | ||||||||
| 145 | break; | ||||||||
| 146 | case ucb::RememberAuthentication_SESSION: | ||||||||
| 147 | bHasRememberModeSession = true; | ||||||||
| 148 | break; | ||||||||
| 149 | case ucb::RememberAuthentication_PERSISTENT: | ||||||||
| 150 | bHasRememberModePersistent = true; | ||||||||
| 151 | break; | ||||||||
| 152 | default: | ||||||||
| 153 | SAL_WARN( "uui", "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode) )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN , "uui")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG : if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart () << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode)) == 1) { ::sal_detail_log ( (::SAL_DETAIL_LOG_LEVEL_WARN), ("uui"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "153" ": "), ::sal::detail::unwrapStream( ::sal::detail:: StreamStart() << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode); ::sal::detail:: log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("uui"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "153" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL : if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart () << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode)) == 1) { ::sal_detail_log ( (::SAL_DETAIL_LOG_LEVEL_WARN), ("uui"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "153" ": "), ::sal::detail::unwrapStream( ::sal::detail:: StreamStart() << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream << "Unsupported RememberAuthentication value" << static_cast<sal_Int32>(rRememberMode); ::sal::detail:: log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("uui"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "153" ": "), sal_detail_stream, 0); }; std::abort(); break ; } } } while (false); | ||||||||
| 154 | break; | ||||||||
| 155 | } | ||||||||
| 156 | } | ||||||||
| 157 | |||||||||
| 158 | if (bHasRememberModePersistent) | ||||||||
| 159 | { | ||||||||
| 160 | rPreferredMode = ucb::RememberAuthentication_PERSISTENT; | ||||||||
| 161 | if (bHasRememberModeSession) | ||||||||
| 162 | rAlternateMode = ucb::RememberAuthentication_SESSION; | ||||||||
| 163 | else | ||||||||
| 164 | rAlternateMode = ucb::RememberAuthentication_NO; | ||||||||
| 165 | } | ||||||||
| 166 | else | ||||||||
| 167 | { | ||||||||
| 168 | rPreferredMode = ucb::RememberAuthentication_SESSION; | ||||||||
| 169 | rAlternateMode = ucb::RememberAuthentication_NO; | ||||||||
| 170 | } | ||||||||
| 171 | } | ||||||||
| 172 | } | ||||||||
| 173 | |||||||||
| 174 | void | ||||||||
| 175 | handleAuthenticationRequest_( | ||||||||
| 176 | weld::Window * pParent, | ||||||||
| 177 | uno::Reference< task::XInteractionHandler2 > const & xIH, | ||||||||
| 178 | uno::Reference< uno::XComponentContext > const & xContext, | ||||||||
| 179 | ucb::AuthenticationRequest const & rRequest, | ||||||||
| 180 | uno::Sequence< uno::Reference< task::XInteractionContinuation > > const & | ||||||||
| 181 | rContinuations, | ||||||||
| 182 | const OUString & rURL) | ||||||||
| 183 | { | ||||||||
| 184 | uno::Reference< task::XInteractionRetry > xRetry; | ||||||||
| 185 | uno::Reference< task::XInteractionAbort > xAbort; | ||||||||
| 186 | uno::Reference< ucb::XInteractionSupplyAuthentication > | ||||||||
| 187 | xSupplyAuthentication; | ||||||||
| 188 | uno::Reference< ucb::XInteractionSupplyAuthentication2 > | ||||||||
| 189 | xSupplyAuthentication2; | ||||||||
| 190 | getContinuations(rContinuations, &xRetry, &xAbort, &xSupplyAuthentication); | ||||||||
| 191 | if (xSupplyAuthentication.is()) | ||||||||
| 192 | xSupplyAuthentication2.set(xSupplyAuthentication, uno::UNO_QUERY); | ||||||||
| 193 | |||||||||
| 194 | |||||||||
| 195 | // First, try to obtain credentials from password container service. | ||||||||
| 196 | uui::PasswordContainerHelper aPwContainerHelper(xContext); | ||||||||
| 197 | if (aPwContainerHelper.handleAuthenticationRequest(rRequest, | ||||||||
| 198 | xSupplyAuthentication, | ||||||||
| 199 | rURL, | ||||||||
| 200 | xIH)) | ||||||||
| 201 | { | ||||||||
| 202 | xSupplyAuthentication->select(); | ||||||||
| 203 | return; | ||||||||
| 204 | } | ||||||||
| 205 | |||||||||
| 206 | |||||||||
| 207 | // Second, try to obtain credentials from user via password dialog. | ||||||||
| 208 | ucb::RememberAuthentication eDefaultRememberMode | ||||||||
| 209 | = ucb::RememberAuthentication_SESSION; | ||||||||
| 210 | ucb::RememberAuthentication ePreferredRememberMode | ||||||||
| 211 | = eDefaultRememberMode; | ||||||||
| 212 | ucb::RememberAuthentication eAlternateRememberMode | ||||||||
| 213 | = ucb::RememberAuthentication_NO; | ||||||||
| 214 | |||||||||
| 215 | if (xSupplyAuthentication.is()) | ||||||||
| 216 | { | ||||||||
| 217 | getRememberModes( | ||||||||
| 218 | xSupplyAuthentication->getRememberPasswordModes( | ||||||||
| 219 | eDefaultRememberMode), | ||||||||
| 220 | ePreferredRememberMode, | ||||||||
| 221 | eAlternateRememberMode); | ||||||||
| 222 | } | ||||||||
| 223 | |||||||||
| 224 | bool bCanUseSystemCredentials; | ||||||||
| 225 | sal_Bool bDefaultUseSystemCredentials; | ||||||||
| 226 | if (xSupplyAuthentication2.is()) | ||||||||
| 227 | { | ||||||||
| 228 | bCanUseSystemCredentials | ||||||||
| 229 | = xSupplyAuthentication2->canUseSystemCredentials( | ||||||||
| 230 | bDefaultUseSystemCredentials); | ||||||||
| 231 | } | ||||||||
| 232 | else | ||||||||
| 233 | { | ||||||||
| 234 | bCanUseSystemCredentials = false; | ||||||||
| 235 | bDefaultUseSystemCredentials = false; | ||||||||
| 236 | } | ||||||||
| 237 | |||||||||
| 238 | LoginErrorInfo aInfo; | ||||||||
| 239 | aInfo.SetServer(rRequest.ServerName); | ||||||||
| 240 | if (rRequest.HasAccount) | ||||||||
| 241 | aInfo.SetAccount(rRequest.Account); | ||||||||
| 242 | if (rRequest.HasUserName) | ||||||||
| 243 | aInfo.SetUserName(rRequest.UserName); | ||||||||
| 244 | if (rRequest.HasPassword) | ||||||||
| 245 | aInfo.SetPassword(rRequest.Password); | ||||||||
| 246 | aInfo.SetErrorText(rRequest.Diagnostic); | ||||||||
| 247 | |||||||||
| 248 | aInfo.SetCanRememberPassword( | ||||||||
| 249 | ePreferredRememberMode != eAlternateRememberMode); | ||||||||
| 250 | aInfo.SetIsRememberPassword( | ||||||||
| 251 | ePreferredRememberMode == eDefaultRememberMode); | ||||||||
| 252 | aInfo.SetIsRememberPersistent( | ||||||||
| 253 | ePreferredRememberMode == ucb::RememberAuthentication_PERSISTENT); | ||||||||
| 254 | |||||||||
| 255 | aInfo.SetCanUseSystemCredentials(bCanUseSystemCredentials); | ||||||||
| 256 | aInfo.SetIsUseSystemCredentials( bDefaultUseSystemCredentials ); | ||||||||
| 257 | aInfo.SetModifyAccount(rRequest.HasAccount | ||||||||
| 258 | && xSupplyAuthentication.is() | ||||||||
| 259 | && xSupplyAuthentication->canSetAccount()); | ||||||||
| 260 | aInfo.SetModifyUserName(rRequest.HasUserName | ||||||||
| 261 | && xSupplyAuthentication.is() | ||||||||
| 262 | && xSupplyAuthentication->canSetUserName()); | ||||||||
| 263 | executeLoginDialog(pParent, | ||||||||
| 264 | aInfo, | ||||||||
| 265 | rRequest.HasRealm ? rRequest.Realm : OUString()); | ||||||||
| 266 | switch (aInfo.GetResult()) | ||||||||
| 267 | { | ||||||||
| 268 | case DialogMask::ButtonsOk: | ||||||||
| 269 | if (xSupplyAuthentication.is()) | ||||||||
| 270 | { | ||||||||
| 271 | if (xSupplyAuthentication->canSetUserName()) | ||||||||
| 272 | xSupplyAuthentication->setUserName(aInfo.GetUserName()); | ||||||||
| 273 | if (xSupplyAuthentication->canSetPassword()) | ||||||||
| 274 | xSupplyAuthentication->setPassword(aInfo.GetPassword()); | ||||||||
| 275 | |||||||||
| 276 | if (ePreferredRememberMode != eAlternateRememberMode) | ||||||||
| 277 | { | ||||||||
| 278 | // user had the choice. | ||||||||
| 279 | if (aInfo.GetIsRememberPassword()) | ||||||||
| 280 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 281 | ePreferredRememberMode); | ||||||||
| 282 | else | ||||||||
| 283 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 284 | eAlternateRememberMode); | ||||||||
| 285 | } | ||||||||
| 286 | else | ||||||||
| 287 | { | ||||||||
| 288 | // user had no choice. | ||||||||
| 289 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 290 | ePreferredRememberMode); | ||||||||
| 291 | } | ||||||||
| 292 | |||||||||
| 293 | if (rRequest.HasRealm) | ||||||||
| 294 | { | ||||||||
| 295 | if (xSupplyAuthentication->canSetRealm()) | ||||||||
| 296 | xSupplyAuthentication->setRealm(aInfo.GetAccount()); | ||||||||
| 297 | } | ||||||||
| 298 | else if (xSupplyAuthentication->canSetAccount()) | ||||||||
| 299 | xSupplyAuthentication->setAccount(aInfo.GetAccount()); | ||||||||
| 300 | |||||||||
| 301 | if ( xSupplyAuthentication2.is() && bCanUseSystemCredentials ) | ||||||||
| 302 | xSupplyAuthentication2->setUseSystemCredentials( | ||||||||
| 303 | aInfo.GetIsUseSystemCredentials() ); | ||||||||
| 304 | |||||||||
| 305 | xSupplyAuthentication->select(); | ||||||||
| 306 | } | ||||||||
| 307 | |||||||||
| 308 | |||||||||
| 309 | // Third, store credentials in password container. | ||||||||
| 310 | |||||||||
| 311 | if ( aInfo.GetIsUseSystemCredentials() ) | ||||||||
| 312 | { | ||||||||
| 313 | if (aInfo.GetIsRememberPassword()) | ||||||||
| 314 | { | ||||||||
| 315 | if (!aPwContainerHelper.addRecord( | ||||||||
| 316 | !rURL.isEmpty() ? rURL : rRequest.ServerName, | ||||||||
| 317 | OUString(), // empty u/p -> sys creds | ||||||||
| 318 | uno::Sequence< OUString >(), | ||||||||
| 319 | xIH, | ||||||||
| 320 | ePreferredRememberMode | ||||||||
| 321 | == ucb::RememberAuthentication_PERSISTENT)) | ||||||||
| 322 | { | ||||||||
| 323 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 324 | ucb::RememberAuthentication_NO); | ||||||||
| 325 | } | ||||||||
| 326 | } | ||||||||
| 327 | else if (eAlternateRememberMode | ||||||||
| 328 | == ucb::RememberAuthentication_SESSION) | ||||||||
| 329 | { | ||||||||
| 330 | if (!aPwContainerHelper.addRecord( | ||||||||
| 331 | !rURL.isEmpty() ? rURL : rRequest.ServerName, | ||||||||
| 332 | OUString(), // empty u/p -> sys creds | ||||||||
| 333 | uno::Sequence< OUString >(), | ||||||||
| 334 | xIH, | ||||||||
| 335 | false /* SESSION */)) | ||||||||
| 336 | { | ||||||||
| 337 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 338 | ucb::RememberAuthentication_NO); | ||||||||
| 339 | } | ||||||||
| 340 | } | ||||||||
| 341 | } | ||||||||
| 342 | // Empty user name can not be valid: | ||||||||
| 343 | else if (!aInfo.GetUserName().isEmpty()) | ||||||||
| 344 | { | ||||||||
| 345 | uno::Sequence< OUString > | ||||||||
| 346 | aPassList(aInfo.GetAccount().isEmpty() ? 1 : 2); | ||||||||
| 347 | aPassList[0] = aInfo.GetPassword(); | ||||||||
| 348 | if (!aInfo.GetAccount().isEmpty()) | ||||||||
| 349 | aPassList[1] = aInfo.GetAccount(); | ||||||||
| 350 | |||||||||
| 351 | if (aInfo.GetIsRememberPassword()) | ||||||||
| 352 | { | ||||||||
| 353 | if (!aPwContainerHelper.addRecord( | ||||||||
| 354 | !rURL.isEmpty() ? rURL : rRequest.ServerName, | ||||||||
| 355 | aInfo.GetUserName(), | ||||||||
| 356 | aPassList, | ||||||||
| 357 | xIH, | ||||||||
| 358 | ePreferredRememberMode | ||||||||
| 359 | == ucb::RememberAuthentication_PERSISTENT)) | ||||||||
| 360 | { | ||||||||
| 361 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 362 | ucb::RememberAuthentication_NO); | ||||||||
| 363 | } | ||||||||
| 364 | } | ||||||||
| 365 | else if (eAlternateRememberMode | ||||||||
| 366 | == ucb::RememberAuthentication_SESSION) | ||||||||
| 367 | { | ||||||||
| 368 | if (!aPwContainerHelper.addRecord( | ||||||||
| 369 | !rURL.isEmpty() ? rURL : rRequest.ServerName, | ||||||||
| 370 | aInfo.GetUserName(), | ||||||||
| 371 | aPassList, | ||||||||
| 372 | xIH, | ||||||||
| 373 | false /* SESSION */)) | ||||||||
| 374 | { | ||||||||
| 375 | xSupplyAuthentication->setRememberPassword( | ||||||||
| 376 | ucb::RememberAuthentication_NO); | ||||||||
| 377 | } | ||||||||
| 378 | } | ||||||||
| 379 | } | ||||||||
| 380 | break; | ||||||||
| 381 | |||||||||
| 382 | case DialogMask::ButtonsRetry: | ||||||||
| 383 | if (xRetry.is()) | ||||||||
| 384 | xRetry->select(); | ||||||||
| 385 | break; | ||||||||
| 386 | |||||||||
| 387 | default: | ||||||||
| 388 | if (xAbort.is()) | ||||||||
| 389 | xAbort->select(); | ||||||||
| 390 | break; | ||||||||
| 391 | } | ||||||||
| 392 | } | ||||||||
| 393 | |||||||||
| 394 | void | ||||||||
| 395 | executeMasterPasswordDialog( | ||||||||
| 396 | weld::Window* pParent, | ||||||||
| 397 | LoginErrorInfo & rInfo, | ||||||||
| 398 | task::PasswordRequestMode nMode) | ||||||||
| 399 | { | ||||||||
| 400 | OString aMaster; | ||||||||
| 401 | { | ||||||||
| 402 | SolarMutexGuard aGuard; | ||||||||
| 403 | |||||||||
| 404 | std::locale aResLocale(Translate::Create("uui")); | ||||||||
| 405 | if( nMode == task::PasswordRequestMode_PASSWORD_CREATE ) | ||||||||
| 406 | { | ||||||||
| 407 | MasterPasswordCreateDialog aDialog(pParent, aResLocale); | ||||||||
| 408 | rInfo.SetResult(aDialog.run() | ||||||||
| 409 | == RET_OK ? DialogMask::ButtonsOk : DialogMask::ButtonsCancel); | ||||||||
| 410 | aMaster = OUStringToOString( | ||||||||
| 411 | aDialog.GetMasterPassword(), RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))); | ||||||||
| 412 | } | ||||||||
| 413 | else | ||||||||
| 414 | { | ||||||||
| 415 | MasterPasswordDialog aDialog(pParent, nMode, aResLocale); | ||||||||
| 416 | rInfo.SetResult(aDialog.run() | ||||||||
| 417 | == RET_OK ? DialogMask::ButtonsOk : DialogMask::ButtonsCancel); | ||||||||
| 418 | aMaster = OUStringToOString( | ||||||||
| 419 | aDialog.GetMasterPassword(), RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))); | ||||||||
| 420 | } | ||||||||
| 421 | } | ||||||||
| 422 | |||||||||
| 423 | sal_uInt8 aKey[RTL_DIGEST_LENGTH_MD516]; | ||||||||
| 424 | // FIXME this is subject to the SHA1-bug tdf#114939 - but this | ||||||||
| 425 | // MasterPassword stuff is just stored in the UserInstallation, | ||||||||
| 426 | // so no interop concerns | ||||||||
| 427 | rtl_digest_PBKDF2(aKey, | ||||||||
| 428 | RTL_DIGEST_LENGTH_MD516, | ||||||||
| 429 | reinterpret_cast< sal_uInt8 const * >(aMaster.getStr()), | ||||||||
| 430 | aMaster.getLength(), | ||||||||
| 431 | reinterpret_cast< sal_uInt8 const * >( | ||||||||
| 432 | "3B5509ABA6BC42D9A3A1F3DAD49E56A51"), | ||||||||
| 433 | 32, | ||||||||
| 434 | 1000); | ||||||||
| 435 | |||||||||
| 436 | OUStringBuffer aBuffer; | ||||||||
| 437 | for (sal_uInt8 i : aKey) | ||||||||
| 438 | { | ||||||||
| 439 | aBuffer.append(static_cast< sal_Unicode >('a' + (i >> 4))); | ||||||||
| 440 | aBuffer.append(static_cast< sal_Unicode >('a' + (i & 15))); | ||||||||
| 441 | } | ||||||||
| 442 | rInfo.SetPassword(aBuffer.makeStringAndClear()); | ||||||||
| 443 | } | ||||||||
| 444 | |||||||||
| 445 | void | ||||||||
| 446 | handleMasterPasswordRequest_( | ||||||||
| 447 | weld::Window * pParent, | ||||||||
| 448 | task::PasswordRequestMode nMode, | ||||||||
| 449 | uno::Sequence< uno::Reference< task::XInteractionContinuation > > const & | ||||||||
| 450 | rContinuations) | ||||||||
| 451 | { | ||||||||
| 452 | uno::Reference< task::XInteractionRetry > xRetry; | ||||||||
| 453 | uno::Reference< task::XInteractionAbort > xAbort; | ||||||||
| 454 | uno::Reference< ucb::XInteractionSupplyAuthentication > | ||||||||
| 455 | xSupplyAuthentication; | ||||||||
| 456 | getContinuations(rContinuations, &xRetry, &xAbort, &xSupplyAuthentication); | ||||||||
| 457 | LoginErrorInfo aInfo; | ||||||||
| 458 | |||||||||
| 459 | // in case of master password a hash code is returned | ||||||||
| 460 | executeMasterPasswordDialog(pParent, aInfo, nMode); | ||||||||
| 461 | |||||||||
| 462 | switch (aInfo.GetResult()) | ||||||||
| 463 | { | ||||||||
| 464 | case DialogMask::ButtonsOk: | ||||||||
| 465 | if (xSupplyAuthentication.is()) | ||||||||
| 466 | { | ||||||||
| 467 | if (xSupplyAuthentication->canSetPassword()) | ||||||||
| 468 | xSupplyAuthentication->setPassword(aInfo.GetPassword()); | ||||||||
| 469 | xSupplyAuthentication->select(); | ||||||||
| 470 | } | ||||||||
| 471 | break; | ||||||||
| 472 | |||||||||
| 473 | case DialogMask::ButtonsRetry: | ||||||||
| 474 | if (xRetry.is()) | ||||||||
| 475 | xRetry->select(); | ||||||||
| 476 | break; | ||||||||
| 477 | |||||||||
| 478 | default: | ||||||||
| 479 | if (xAbort.is()) | ||||||||
| 480 | xAbort->select(); | ||||||||
| 481 | break; | ||||||||
| 482 | } | ||||||||
| 483 | } | ||||||||
| 484 | |||||||||
| 485 | void | ||||||||
| 486 | executePasswordDialog( | ||||||||
| 487 | weld::Window * pParent, | ||||||||
| 488 | LoginErrorInfo & rInfo, | ||||||||
| 489 | task::PasswordRequestMode nMode, | ||||||||
| 490 | const OUString& aDocName, | ||||||||
| 491 | sal_uInt16 nMaxPasswordLen, | ||||||||
| 492 | bool bIsPasswordToModify, | ||||||||
| 493 | bool bIsSimplePasswordRequest ) | ||||||||
| 494 | { | ||||||||
| 495 | SolarMutexGuard aGuard; | ||||||||
| 496 | |||||||||
| 497 | std::locale aResLocale(Translate::Create("uui")); | ||||||||
| 498 | if( nMode == task::PasswordRequestMode_PASSWORD_CREATE ) | ||||||||
| 499 | { | ||||||||
| 500 | if (bIsSimplePasswordRequest
| ||||||||
| 501 | { | ||||||||
| 502 | std::unique_ptr<PasswordDialog> xDialog(new PasswordDialog(pParent, nMode, | ||||||||
| 503 | aResLocale, aDocName, bIsPasswordToModify, bIsSimplePasswordRequest)); | ||||||||
| 504 | xDialog->SetMinLen(0); | ||||||||
| 505 | |||||||||
| 506 | rInfo.SetResult(xDialog->run() == RET_OK ? DialogMask::ButtonsOk : DialogMask::ButtonsCancel); | ||||||||
| 507 | rInfo.SetPassword(xDialog->GetPassword()); | ||||||||
| 508 | } | ||||||||
| 509 | else | ||||||||
| 510 | { | ||||||||
| 511 | VclAbstractDialogFactory * pFact = VclAbstractDialogFactory::Create(); | ||||||||
| 512 | ScopedVclPtr<AbstractPasswordToOpenModifyDialog> const pDialog( | ||||||||
| 513 | pFact->CreatePasswordToOpenModifyDialog(pParent, nMaxPasswordLen, bIsPasswordToModify)); | ||||||||
| 514 | |||||||||
| 515 | rInfo.SetResult( pDialog->Execute() == RET_OK ? DialogMask::ButtonsOk : DialogMask::ButtonsCancel ); | ||||||||
| 516 | rInfo.SetPassword( pDialog->GetPasswordToOpen() ); | ||||||||
| 517 | rInfo.SetPasswordToModify( pDialog->GetPasswordToModify() ); | ||||||||
| 518 | rInfo.SetRecommendToOpenReadonly( pDialog->IsRecommendToOpenReadonly() ); | ||||||||
| 519 | } | ||||||||
| 520 | } | ||||||||
| 521 | else // enter password or reenter password | ||||||||
| 522 | { | ||||||||
| 523 | std::unique_ptr<PasswordDialog> xDialog(new PasswordDialog(pParent, nMode, | ||||||||
| 524 | aResLocale, aDocName, bIsPasswordToModify, bIsSimplePasswordRequest)); | ||||||||
| 525 | xDialog->SetMinLen(0); | ||||||||
| 526 | |||||||||
| 527 | rInfo.SetResult(xDialog->run() == RET_OK ? DialogMask::ButtonsOk : DialogMask::ButtonsCancel); | ||||||||
| 528 | rInfo.SetPassword(bIsPasswordToModify ? OUString() : xDialog->GetPassword()); | ||||||||
| 529 | rInfo.SetPasswordToModify(bIsPasswordToModify ? xDialog->GetPassword() : OUString()); | ||||||||
| 530 | } | ||||||||
| 531 | } | ||||||||
| 532 | |||||||||
| 533 | void | ||||||||
| 534 | handlePasswordRequest_( | ||||||||
| 535 | weld::Window * pParent, | ||||||||
| 536 | task::PasswordRequestMode nMode, | ||||||||
| 537 | uno::Sequence< uno::Reference< task::XInteractionContinuation > > const & | ||||||||
| 538 | rContinuations, | ||||||||
| 539 | const OUString& aDocumentName, | ||||||||
| 540 | sal_uInt16 nMaxPasswordLen, | ||||||||
| 541 | bool bIsPasswordToModify, | ||||||||
| 542 | bool bIsSimplePasswordRequest = false ) | ||||||||
| 543 | { | ||||||||
| 544 | uno::Reference< task::XInteractionRetry > xRetry; | ||||||||
| 545 | uno::Reference< task::XInteractionAbort > xAbort; | ||||||||
| 546 | uno::Reference< task::XInteractionPassword > xPassword; | ||||||||
| 547 | uno::Reference< task::XInteractionPassword2 > xPassword2; | ||||||||
| 548 | getContinuations(rContinuations, &xRetry, &xAbort, &xPassword2, &xPassword); | ||||||||
| 549 | |||||||||
| 550 | if ( xPassword2.is() && !xPassword.is() ) | ||||||||
| 551 | xPassword.set( xPassword2, uno::UNO_QUERY_THROW ); | ||||||||
| 552 | |||||||||
| 553 | LoginErrorInfo aInfo; | ||||||||
| 554 | |||||||||
| 555 | executePasswordDialog( pParent, aInfo, nMode, | ||||||||
| 556 | aDocumentName, nMaxPasswordLen, bIsPasswordToModify, bIsSimplePasswordRequest ); | ||||||||
| 557 | |||||||||
| 558 | switch (aInfo.GetResult()) | ||||||||
| 559 | { | ||||||||
| 560 | case DialogMask::ButtonsOk: | ||||||||
| 561 | OSL_ENSURE( !bIsPasswordToModify || xPassword2.is(), "PasswordToModify is requested, but there is no Interaction!" )do { if (true && (!(!bIsPasswordToModify || xPassword2 .is()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ( "legacy.osl"), ("/home/maarten/src/libreoffice/core/uui/source/iahndl-authentication.cxx" ":" "561" ": "), "%s", "PasswordToModify is requested, but there is no Interaction!" ); } } while (false); | ||||||||
| 562 | if (xPassword.is()) | ||||||||
| 563 | { | ||||||||
| 564 | if (xPassword2.is()) | ||||||||
| 565 | { | ||||||||
| 566 | xPassword2->setPasswordToModify( aInfo.GetPasswordToModify() ); | ||||||||
| 567 | xPassword2->setRecommendReadOnly( aInfo.IsRecommendToOpenReadonly() ); | ||||||||
| 568 | } | ||||||||
| 569 | |||||||||
| 570 | xPassword->setPassword(aInfo.GetPassword()); | ||||||||
| 571 | xPassword->select(); | ||||||||
| 572 | } | ||||||||
| 573 | break; | ||||||||
| 574 | |||||||||
| 575 | case DialogMask::ButtonsRetry: | ||||||||
| 576 | if (xRetry.is()) | ||||||||
| 577 | xRetry->select(); | ||||||||
| 578 | break; | ||||||||
| 579 | |||||||||
| 580 | default: | ||||||||
| 581 | if (xAbort.is()) | ||||||||
| 582 | xAbort->select(); | ||||||||
| 583 | break; | ||||||||
| 584 | } | ||||||||
| 585 | } | ||||||||
| 586 | |||||||||
| 587 | } // namespace | ||||||||
| 588 | |||||||||
| 589 | bool | ||||||||
| 590 | UUIInteractionHelper::handleAuthenticationRequest( | ||||||||
| 591 | uno::Reference< task::XInteractionRequest > const & rRequest) | ||||||||
| 592 | { | ||||||||
| 593 | uno::Any aAnyRequest(rRequest->getRequest()); | ||||||||
| 594 | uno::Reference<awt::XWindow> xParent = getParentXWindow(); | ||||||||
| 595 | |||||||||
| 596 | ucb::URLAuthenticationRequest aURLAuthenticationRequest; | ||||||||
| 597 | if (aAnyRequest >>= aURLAuthenticationRequest) | ||||||||
| 598 | { | ||||||||
| 599 | handleAuthenticationRequest_(Application::GetFrameWeld(xParent), | ||||||||
| 600 | getInteractionHandler(), | ||||||||
| 601 | m_xContext, | ||||||||
| 602 | aURLAuthenticationRequest, | ||||||||
| 603 | rRequest->getContinuations(), | ||||||||
| 604 | aURLAuthenticationRequest.URL); | ||||||||
| 605 | return true; | ||||||||
| 606 | } | ||||||||
| 607 | |||||||||
| 608 | ucb::AuthenticationRequest aAuthenticationRequest; | ||||||||
| 609 | if (aAnyRequest >>= aAuthenticationRequest) | ||||||||
| 610 | { | ||||||||
| 611 | handleAuthenticationRequest_(Application::GetFrameWeld(xParent), | ||||||||
| 612 | getInteractionHandler(), | ||||||||
| 613 | m_xContext, | ||||||||
| 614 | aAuthenticationRequest, | ||||||||
| 615 | rRequest->getContinuations(), | ||||||||
| 616 | OUString()); | ||||||||
| 617 | return true; | ||||||||
| 618 | } | ||||||||
| 619 | return false; | ||||||||
| 620 | } | ||||||||
| 621 | |||||||||
| 622 | bool | ||||||||
| 623 | UUIInteractionHelper::handleMasterPasswordRequest( | ||||||||
| 624 | uno::Reference< task::XInteractionRequest > const & rRequest) | ||||||||
| 625 | { | ||||||||
| 626 | uno::Any aAnyRequest(rRequest->getRequest()); | ||||||||
| 627 | |||||||||
| 628 | task::MasterPasswordRequest aMasterPasswordRequest; | ||||||||
| 629 | if (aAnyRequest >>= aMasterPasswordRequest) | ||||||||
| 630 | { | ||||||||
| 631 | uno::Reference<awt::XWindow> xParent = getParentXWindow(); | ||||||||
| 632 | |||||||||
| 633 | handleMasterPasswordRequest_(Application::GetFrameWeld(xParent), | ||||||||
| 634 | aMasterPasswordRequest.Mode, | ||||||||
| 635 | rRequest->getContinuations()); | ||||||||
| 636 | return true; | ||||||||
| 637 | } | ||||||||
| 638 | return false; | ||||||||
| 639 | } | ||||||||
| 640 | |||||||||
| 641 | bool | ||||||||
| 642 | UUIInteractionHelper::handlePasswordRequest( | ||||||||
| 643 | uno::Reference< task::XInteractionRequest > const & rRequest) | ||||||||
| 644 | { | ||||||||
| 645 | // parameters to be filled for the call to handlePasswordRequest_ | ||||||||
| 646 | uno::Reference<awt::XWindow> xParent = getParentXWindow(); | ||||||||
| 647 | task::PasswordRequestMode nMode = task::PasswordRequestMode_PASSWORD_ENTER; | ||||||||
| 648 | uno::Sequence< uno::Reference< task::XInteractionContinuation > > const & rContinuations = rRequest->getContinuations(); | ||||||||
| 649 | OUString aDocumentName; | ||||||||
| 650 | sal_uInt16 nMaxPasswordLen = 0; // any length | ||||||||
| 651 | bool bIsPasswordToModify = false; | ||||||||
| 652 | |||||||||
| 653 | bool bDoHandleRequest = false; | ||||||||
| 654 | |||||||||
| 655 | uno::Any aAnyRequest(rRequest->getRequest()); | ||||||||
| 656 | |||||||||
| 657 | do | ||||||||
| 658 | { | ||||||||
| 659 | task::DocumentPasswordRequest2 aDocumentPasswordRequest2; | ||||||||
| 660 | if (aAnyRequest >>= aDocumentPasswordRequest2) | ||||||||
| |||||||||
| 661 | { | ||||||||
| 662 | nMode = aDocumentPasswordRequest2.Mode; | ||||||||
| 663 | aDocumentName = aDocumentPasswordRequest2.Name; | ||||||||
| 664 | bIsPasswordToModify = aDocumentPasswordRequest2.IsRequestPasswordToModify; | ||||||||
| 665 | |||||||||
| 666 | bDoHandleRequest = true; | ||||||||
| 667 | break; // do | ||||||||
| 668 | } | ||||||||
| 669 | |||||||||
| 670 | task::DocumentPasswordRequest aDocumentPasswordRequest; | ||||||||
| 671 | if (aAnyRequest >>= aDocumentPasswordRequest) | ||||||||
| 672 | { | ||||||||
| 673 | nMode = aDocumentPasswordRequest.Mode; | ||||||||
| 674 | aDocumentName = aDocumentPasswordRequest.Name; | ||||||||
| 675 | |||||||||
| 676 | bDoHandleRequest = true; | ||||||||
| 677 | break; // do | ||||||||
| 678 | } | ||||||||
| 679 | |||||||||
| 680 | task::DocumentMSPasswordRequest2 aDocumentMSPasswordRequest2; | ||||||||
| 681 | if (aAnyRequest >>= aDocumentMSPasswordRequest2) | ||||||||
| 682 | { | ||||||||
| 683 | nMode = aDocumentMSPasswordRequest2.Mode; | ||||||||
| 684 | aDocumentName = aDocumentMSPasswordRequest2.Name; | ||||||||
| 685 | nMaxPasswordLen = 15; | ||||||||
| 686 | bIsPasswordToModify = aDocumentMSPasswordRequest2.IsRequestPasswordToModify; | ||||||||
| 687 | |||||||||
| 688 | bDoHandleRequest = true; | ||||||||
| 689 | break; // do | ||||||||
| 690 | } | ||||||||
| 691 | |||||||||
| 692 | task::DocumentMSPasswordRequest aDocumentMSPasswordRequest; | ||||||||
| 693 | if (aAnyRequest >>= aDocumentMSPasswordRequest) | ||||||||
| 694 | { | ||||||||
| 695 | nMode = aDocumentMSPasswordRequest.Mode; | ||||||||
| 696 | aDocumentName = aDocumentMSPasswordRequest.Name; | ||||||||
| 697 | nMaxPasswordLen = 15; | ||||||||
| 698 | |||||||||
| 699 | bDoHandleRequest = true; | ||||||||
| 700 | break; // do | ||||||||
| 701 | } | ||||||||
| 702 | } | ||||||||
| 703 | while (false); | ||||||||
| 704 | |||||||||
| 705 | if (bDoHandleRequest
| ||||||||
| 706 | { | ||||||||
| 707 | handlePasswordRequest_( Application::GetFrameWeld(xParent), nMode, rContinuations, | ||||||||
| 708 | aDocumentName, nMaxPasswordLen, bIsPasswordToModify ); | ||||||||
| 709 | return true; | ||||||||
| 710 | } | ||||||||
| 711 | |||||||||
| 712 | task::PasswordRequest aPasswordRequest; | ||||||||
| 713 | if( aAnyRequest >>= aPasswordRequest ) | ||||||||
| 714 | { | ||||||||
| 715 | handlePasswordRequest_(Application::GetFrameWeld(xParent), | ||||||||
| 716 | aPasswordRequest.Mode, | ||||||||
| 717 | rRequest->getContinuations(), | ||||||||
| 718 | OUString(), | ||||||||
| 719 | 0 /* sal_uInt16 nMaxPasswordLen */, | ||||||||
| 720 | false /* bool bIsPasswordToModify */, | ||||||||
| 721 | true /* bool bIsSimplePasswordRequest */ ); | ||||||||
| 722 | return true; | ||||||||
| 723 | } | ||||||||
| 724 | |||||||||
| 725 | return false; | ||||||||
| 726 | } | ||||||||
| 727 | |||||||||
| 728 | void | ||||||||
| 729 | UUIInteractionHelper::handleAuthFallbackRequest( const OUString & instructions, | ||||||||
| 730 | const OUString & url, | ||||||||
| 731 | uno::Sequence< uno::Reference< task::XInteractionContinuation > > const & rContinuations ) | ||||||||
| 732 | { | ||||||||
| 733 | uno::Reference<awt::XWindow> xParent = getParentXWindow(); | ||||||||
| 734 | AuthFallbackDlg dlg(Application::GetFrameWeld(xParent), instructions, url); | ||||||||
| 735 | int retCode = dlg.run(); | ||||||||
| 736 | uno::Reference< task::XInteractionAbort > xAbort; | ||||||||
| 737 | uno::Reference< ucb::XInteractionAuthFallback > xAuthFallback; | ||||||||
| 738 | getContinuations(rContinuations, &xAbort, &xAuthFallback); | ||||||||
| 739 | |||||||||
| 740 | if( retCode == RET_OK && xAuthFallback.is( ) ) | ||||||||
| 741 | { | ||||||||
| 742 | xAuthFallback->setCode(dlg.GetCode()); | ||||||||
| 743 | xAuthFallback->select( ); | ||||||||
| 744 | } | ||||||||
| 745 | } | ||||||||
| 746 | |||||||||
| 747 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_VCL_PTR_HXX |
| 21 | #define INCLUDED_VCL_PTR_HXX |
| 22 | |
| 23 | #include <sal/config.h> |
| 24 | |
| 25 | #include <rtl/ref.hxx> |
| 26 | |
| 27 | #include <utility> |
| 28 | #include <type_traits> |
| 29 | |
| 30 | #ifdef DBG_UTIL |
| 31 | #ifndef _WIN32 |
| 32 | #include <vcl/vclmain.hxx> |
| 33 | #endif |
| 34 | #endif |
| 35 | |
| 36 | class VclReferenceBase; |
| 37 | |
| 38 | namespace vcl::detail { |
| 39 | |
| 40 | template<typename> |
| 41 | constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; } |
| 42 | |
| 43 | template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase( |
| 44 | int (*)[sizeof(T)]) |
| 45 | { return std::is_base_of<VclReferenceBase, T>::value; } |
| 46 | |
| 47 | } // namespace vcl::detail |
| 48 | |
| 49 | /** |
| 50 | * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses. |
| 51 | * |
| 52 | * For more details on the design please see vcl/README.lifecycle |
| 53 | * |
| 54 | * @param reference_type must be a subclass of vcl::Window |
| 55 | */ |
| 56 | template <class reference_type> |
| 57 | class VclPtr |
| 58 | { |
| 59 | static_assert( |
| 60 | vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>( |
| 61 | nullptr), |
| 62 | "template argument type must be derived from VclReferenceBase"); |
| 63 | |
| 64 | ::rtl::Reference<reference_type> m_rInnerRef; |
| 65 | |
| 66 | public: |
| 67 | /** Constructor... |
| 68 | */ |
| 69 | VclPtr() |
| 70 | : m_rInnerRef() |
| 71 | {} |
| 72 | |
| 73 | /** Constructor... |
| 74 | */ |
| 75 | VclPtr (reference_type * pBody) |
| 76 | : m_rInnerRef(pBody) |
| 77 | {} |
| 78 | |
| 79 | /** Constructor... that doesn't take a ref. |
| 80 | */ |
| 81 | VclPtr (reference_type * pBody, __sal_NoAcquire) |
| 82 | : m_rInnerRef(pBody, SAL_NO_ACQUIRE) |
| 83 | {} |
| 84 | |
| 85 | /** Up-casting conversion constructor: Copies interface reference. |
| 86 | |
| 87 | Does not work for up-casts to ambiguous bases. For the special case of |
| 88 | up-casting to Reference< XInterface >, see the corresponding conversion |
| 89 | operator. |
| 90 | |
| 91 | @param rRef another reference |
| 92 | */ |
| 93 | template< class derived_type > |
| 94 | VclPtr( |
| 95 | const VclPtr< derived_type > & rRef, |
| 96 | typename std::enable_if< |
| 97 | std::is_base_of<reference_type, derived_type>::value, int>::type |
| 98 | = 0 ) |
| 99 | : m_rInnerRef( static_cast<reference_type*>(rRef) ) |
| 100 | { |
| 101 | } |
| 102 | |
| 103 | #if defined(DBG_UTIL) && !defined(_WIN32) |
| 104 | virtual ~VclPtr() |
| 105 | { |
| 106 | assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain ::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 106, __extension__ __PRETTY_FUNCTION__)); |
| 107 | // We can be one of the intermediate counts, but if we are the last |
| 108 | // VclPtr keeping this object alive, then something forgot to call dispose(). |
| 109 | assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef ->isDisposed() || m_rInnerRef->getRefCount() > 1) && "someone forgot to call dispose()") ? void (0) : __assert_fail ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\"" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 110, __extension__ __PRETTY_FUNCTION__)) |
| 110 | && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef ->isDisposed() || m_rInnerRef->getRefCount() > 1) && "someone forgot to call dispose()") ? void (0) : __assert_fail ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\"" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 110, __extension__ __PRETTY_FUNCTION__)); |
| 111 | } |
| 112 | VclPtr(VclPtr const &) = default; |
| 113 | VclPtr(VclPtr &&) = default; |
| 114 | VclPtr & operator =(VclPtr const &) = default; |
| 115 | VclPtr & operator =(VclPtr &&) = default; |
| 116 | #endif |
| 117 | |
| 118 | /** |
| 119 | * A construction helper for VclPtr. Since VclPtr types are created |
| 120 | * with a reference-count of one - to help fit into the existing |
| 121 | * code-flow; this helps us to construct them easily. |
| 122 | * |
| 123 | * For more details on the design please see vcl/README.lifecycle |
| 124 | * |
| 125 | * @tparam reference_type must be a subclass of vcl::Window |
| 126 | */ |
| 127 | template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg) |
| 128 | { |
| 129 | return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ); |
| 130 | } |
| 131 | |
| 132 | /** Probably most common used: handle->someBodyOp(). |
| 133 | */ |
| 134 | reference_type * operator->() const |
| 135 | { |
| 136 | return m_rInnerRef.get(); |
| 137 | } |
| 138 | |
| 139 | /** Get the body. Can be used instead of operator->(). |
| 140 | I.e. handle->someBodyOp() and handle.get()->someBodyOp() |
| 141 | are the same. |
| 142 | */ |
| 143 | reference_type * get() const |
| 144 | { |
| 145 | return m_rInnerRef.get(); |
| 146 | } |
| 147 | |
| 148 | void set(reference_type *pBody) |
| 149 | { |
| 150 | m_rInnerRef.set(pBody); |
| 151 | } |
| 152 | |
| 153 | void reset(reference_type *pBody) |
| 154 | { |
| 155 | m_rInnerRef.set(pBody); |
| 156 | } |
| 157 | |
| 158 | /** Up-casting copy assignment operator. |
| 159 | |
| 160 | Does not work for up-casts to ambiguous bases. |
| 161 | |
| 162 | @param rRef another reference |
| 163 | */ |
| 164 | template<typename derived_type> |
| 165 | typename std::enable_if< |
| 166 | std::is_base_of<reference_type, derived_type>::value, |
| 167 | VclPtr &>::type |
| 168 | operator =(VclPtr<derived_type> const & rRef) |
| 169 | { |
| 170 | m_rInnerRef.set(rRef.get()); |
| 171 | return *this; |
| 172 | } |
| 173 | |
| 174 | VclPtr & operator =(reference_type * pBody) |
| 175 | { |
| 176 | m_rInnerRef.set(pBody); |
| 177 | return *this; |
| 178 | } |
| 179 | |
| 180 | operator reference_type * () const |
| 181 | { |
| 182 | return m_rInnerRef.get(); |
| 183 | } |
| 184 | |
| 185 | explicit operator bool () const |
| 186 | { |
| 187 | return m_rInnerRef.get() != nullptr; |
| 188 | } |
| 189 | |
| 190 | void clear() |
| 191 | { |
| 192 | m_rInnerRef.clear(); |
| 193 | } |
| 194 | |
| 195 | void reset() |
| 196 | { |
| 197 | m_rInnerRef.clear(); |
| 198 | } |
| 199 | |
| 200 | void disposeAndClear() |
| 201 | { |
| 202 | // hold it alive for the lifetime of this method |
| 203 | ::rtl::Reference<reference_type> aTmp(m_rInnerRef); |
| 204 | m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-) |
| 205 | if (aTmp.get()) { |
| 206 | aTmp->disposeOnce(); |
| 207 | } |
| 208 | } |
| 209 | |
| 210 | /** Needed to place VclPtr's into STL collection. |
| 211 | */ |
| 212 | bool operator< (const VclPtr<reference_type> & handle) const |
| 213 | { |
| 214 | return (m_rInnerRef < handle.m_rInnerRef); |
| 215 | } |
| 216 | }; // class VclPtr |
| 217 | |
| 218 | template<typename T1, typename T2> |
| 219 | inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
| 220 | return p1.get() == p2.get(); |
| 221 | } |
| 222 | |
| 223 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2) |
| 224 | { |
| 225 | return p1.get() == p2; |
| 226 | } |
| 227 | |
| 228 | template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) { |
| 229 | return p1.get() == p2; |
| 230 | } |
| 231 | |
| 232 | template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2) |
| 233 | { |
| 234 | return p1 == p2.get(); |
| 235 | } |
| 236 | |
| 237 | template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) { |
| 238 | return p1 == p2.get(); |
| 239 | } |
| 240 | |
| 241 | template<typename T1, typename T2> |
| 242 | inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) { |
| 243 | return !(p1 == p2); |
| 244 | } |
| 245 | |
| 246 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2) |
| 247 | { |
| 248 | return !(p1 == p2); |
| 249 | } |
| 250 | |
| 251 | template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) { |
| 252 | return !(p1 == p2); |
| 253 | } |
| 254 | |
| 255 | template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2) |
| 256 | { |
| 257 | return !(p1 == p2); |
| 258 | } |
| 259 | |
| 260 | template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) { |
| 261 | return !(p1 == p2); |
| 262 | } |
| 263 | |
| 264 | /** |
| 265 | * A construction helper for a temporary VclPtr. Since VclPtr types |
| 266 | * are created with a reference-count of one - to help fit into |
| 267 | * the existing code-flow; this helps us to construct them easily. |
| 268 | * see also VclPtr::Create and ScopedVclPtr |
| 269 | * |
| 270 | * For more details on the design please see vcl/README.lifecycle |
| 271 | * |
| 272 | * @param reference_type must be a subclass of vcl::Window |
| 273 | */ |
| 274 | template <class reference_type> |
| 275 | class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type> |
| 276 | { |
| 277 | public: |
| 278 | template<typename... Arg> VclPtrInstance(Arg &&... arg) |
| 279 | : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ) |
| 280 | { |
| 281 | } |
| 282 | |
| 283 | /** |
| 284 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 285 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 286 | */ |
| 287 | template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete; |
| 288 | }; |
| 289 | |
| 290 | template <class reference_type> |
| 291 | class ScopedVclPtr : public VclPtr<reference_type> |
| 292 | { |
| 293 | public: |
| 294 | /** Constructor... |
| 295 | */ |
| 296 | ScopedVclPtr() |
| 297 | : VclPtr<reference_type>() |
| 298 | {} |
| 299 | |
| 300 | /** Constructor |
| 301 | */ |
| 302 | ScopedVclPtr (reference_type * pBody) |
| 303 | : VclPtr<reference_type>(pBody) |
| 304 | {} |
| 305 | |
| 306 | /** Copy constructor... |
| 307 | */ |
| 308 | ScopedVclPtr (const VclPtr<reference_type> & handle) |
| 309 | : VclPtr<reference_type>(handle) |
| 310 | {} |
| 311 | |
| 312 | /** |
| 313 | Assignment that releases the last reference. |
| 314 | */ |
| 315 | void disposeAndReset(reference_type *pBody) |
| 316 | { |
| 317 | if (pBody != this->get()) { |
| 318 | VclPtr<reference_type>::disposeAndClear(); |
| 319 | VclPtr<reference_type>::set(pBody); |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | /** |
| 324 | Assignment that releases the last reference. |
| 325 | */ |
| 326 | ScopedVclPtr<reference_type>& operator = (reference_type * pBody) |
| 327 | { |
| 328 | disposeAndReset(pBody); |
| 329 | return *this; |
| 330 | } |
| 331 | |
| 332 | /** Up-casting conversion constructor: Copies interface reference. |
| 333 | |
| 334 | Does not work for up-casts to ambiguous bases. For the special case of |
| 335 | up-casting to Reference< XInterface >, see the corresponding conversion |
| 336 | operator. |
| 337 | |
| 338 | @param rRef another reference |
| 339 | */ |
| 340 | template< class derived_type > |
| 341 | ScopedVclPtr( |
| 342 | const VclPtr< derived_type > & rRef, |
| 343 | typename std::enable_if< |
| 344 | std::is_base_of<reference_type, derived_type>::value, int>::type |
| 345 | = 0 ) |
| 346 | : VclPtr<reference_type>( rRef ) |
| 347 | { |
| 348 | } |
| 349 | |
| 350 | /** Up-casting assignment operator. |
| 351 | |
| 352 | Does not work for up-casts to ambiguous bases. |
| 353 | |
| 354 | @param rRef another VclPtr |
| 355 | */ |
| 356 | template<typename derived_type> |
| 357 | typename std::enable_if< |
| 358 | std::is_base_of<reference_type, derived_type>::value, |
| 359 | ScopedVclPtr &>::type |
| 360 | operator =(VclPtr<derived_type> const & rRef) |
| 361 | { |
| 362 | disposeAndReset(rRef.get()); |
| 363 | return *this; |
| 364 | } |
| 365 | |
| 366 | /** |
| 367 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 368 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 369 | */ |
| 370 | template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete; |
| 371 | |
| 372 | ~ScopedVclPtr() |
| 373 | { |
| 374 | VclPtr<reference_type>::disposeAndClear(); |
| 375 | assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get( ) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr" , "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx" , 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references |
| 376 | } |
| 377 | |
| 378 | private: |
| 379 | // Most likely we don't want this default copy-constructor. |
| 380 | ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete; |
| 381 | // And certainly we don't want a default assignment operator. |
| 382 | ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete; |
| 383 | // And disallow reset as that doesn't call disposeAndClear on the original reference |
| 384 | void reset() = delete; |
| 385 | void reset(reference_type *pBody) = delete; |
| 386 | |
| 387 | protected: |
| 388 | ScopedVclPtr (reference_type * pBody, __sal_NoAcquire) |
| 389 | : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE) |
| 390 | {} |
| 391 | }; |
| 392 | |
| 393 | /** |
| 394 | * A construction helper for ScopedVclPtr. Since VclPtr types are created |
| 395 | * with a reference-count of one - to help fit into the existing |
| 396 | * code-flow; this helps us to construct them easily. |
| 397 | * |
| 398 | * For more details on the design please see vcl/README.lifecycle |
| 399 | * |
| 400 | * @param reference_type must be a subclass of vcl::Window |
| 401 | */ |
| 402 | #if defined _MSC_VER |
| 403 | #pragma warning(push) |
| 404 | #pragma warning(disable: 4521) // " multiple copy constructors specified" |
| 405 | #endif |
| 406 | template <class reference_type> |
| 407 | class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type> |
| 408 | { |
| 409 | public: |
| 410 | template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg) |
| 411 | : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE ) |
| 412 | { |
| 413 | } |
| 414 | |
| 415 | /** |
| 416 | * Override and disallow this, to prevent people accidentally calling it and actually |
| 417 | * getting VclPtr::Create and getting a naked VclPtr<> instance |
| 418 | */ |
| 419 | template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete; |
| 420 | |
| 421 | private: |
| 422 | // Prevent the above perfect forwarding ctor from hijacking (accidental) |
| 423 | // attempts at ScopedVclPtrInstance copy construction (where the hijacking |
| 424 | // would typically lead to somewhat obscure error messages); both non-const |
| 425 | // and const variants are needed here, as the ScopedVclPtr base class has a |
| 426 | // const--variant copy ctor, so the implicitly declared copy ctor for |
| 427 | // ScopedVclPtrInstance would also be the const variant, so non-const copy |
| 428 | // construction attempts would be hijacked by the perfect forwarding ctor; |
| 429 | // but if we only declared a non-const variant here, the const variant would |
| 430 | // no longer be implicitly declared (as there would already be an explicitly |
| 431 | // declared copy ctor), so const copy construction attempts would then be |
| 432 | // hijacked by the perfect forwarding ctor: |
| 433 | ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete; |
| 434 | ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete; |
| 435 | }; |
| 436 | #if defined _MSC_VER |
| 437 | #pragma warning(pop) |
| 438 | #endif |
| 439 | |
| 440 | #endif // INCLUDED_VCL_PTR_HXX |
| 441 | |
| 442 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_RTL_REF_HXX | ||||||||
| 21 | #define INCLUDED_RTL_REF_HXX | ||||||||
| 22 | |||||||||
| 23 | #include "sal/config.h" | ||||||||
| 24 | |||||||||
| 25 | #include <cassert> | ||||||||
| 26 | #include <cstddef> | ||||||||
| 27 | #include <functional> | ||||||||
| 28 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||
| 29 | #include <type_traits> | ||||||||
| 30 | #endif | ||||||||
| 31 | |||||||||
| 32 | #include "sal/types.h" | ||||||||
| 33 | |||||||||
| 34 | namespace rtl | ||||||||
| 35 | { | ||||||||
| 36 | |||||||||
| 37 | /** Template reference class for reference type. | ||||||||
| 38 | */ | ||||||||
| 39 | template <class reference_type> | ||||||||
| 40 | class Reference | ||||||||
| 41 | { | ||||||||
| 42 | /** The <b>reference_type</b> body pointer. | ||||||||
| 43 | */ | ||||||||
| 44 | reference_type * m_pBody; | ||||||||
| 45 | |||||||||
| 46 | |||||||||
| 47 | public: | ||||||||
| 48 | /** Constructor... | ||||||||
| 49 | */ | ||||||||
| 50 | Reference() | ||||||||
| 51 | : m_pBody (NULL__null) | ||||||||
| 52 | {} | ||||||||
| 53 | |||||||||
| 54 | |||||||||
| 55 | /** Constructor... | ||||||||
| 56 | */ | ||||||||
| 57 | Reference (reference_type * pBody, __sal_NoAcquire) | ||||||||
| 58 | : m_pBody (pBody) | ||||||||
| 59 | { | ||||||||
| 60 | } | ||||||||
| 61 | |||||||||
| 62 | /** Constructor... | ||||||||
| 63 | */ | ||||||||
| 64 | Reference (reference_type * pBody) | ||||||||
| 65 | : m_pBody (pBody) | ||||||||
| 66 | { | ||||||||
| 67 | if (m_pBody) | ||||||||
| 68 | m_pBody->acquire(); | ||||||||
| 69 | } | ||||||||
| 70 | |||||||||
| 71 | /** Copy constructor... | ||||||||
| 72 | */ | ||||||||
| 73 | Reference (const Reference<reference_type> & handle) | ||||||||
| 74 | : m_pBody (handle.m_pBody) | ||||||||
| 75 | { | ||||||||
| 76 | if (m_pBody) | ||||||||
| 77 | m_pBody->acquire(); | ||||||||
| 78 | } | ||||||||
| 79 | |||||||||
| 80 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||
| 81 | /** Move constructor... | ||||||||
| 82 | */ | ||||||||
| 83 | Reference (Reference<reference_type> && handle) noexcept | ||||||||
| 84 | : m_pBody (handle.m_pBody) | ||||||||
| 85 | { | ||||||||
| 86 | handle.m_pBody = nullptr; | ||||||||
| 87 | } | ||||||||
| 88 | #endif | ||||||||
| 89 | |||||||||
| 90 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||
| 91 | /** Up-casting conversion constructor: Copies interface reference. | ||||||||
| 92 | |||||||||
| 93 | Does not work for up-casts to ambiguous bases. | ||||||||
| 94 | |||||||||
| 95 | @param rRef another reference | ||||||||
| 96 | */ | ||||||||
| 97 | template< class derived_type > | ||||||||
| 98 | inline Reference( | ||||||||
| 99 | const Reference< derived_type > & rRef, | ||||||||
| 100 | std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 ) | ||||||||
| 101 | : m_pBody (rRef.get()) | ||||||||
| 102 | { | ||||||||
| 103 | if (m_pBody) | ||||||||
| 104 | m_pBody->acquire(); | ||||||||
| 105 | } | ||||||||
| 106 | #endif | ||||||||
| 107 | |||||||||
| 108 | /** Destructor... | ||||||||
| 109 | */ | ||||||||
| 110 | ~Reference() COVERITY_NOEXCEPT_FALSE | ||||||||
| 111 | { | ||||||||
| 112 | if (m_pBody
| ||||||||
| 113 | m_pBody->release(); | ||||||||
| 114 | } | ||||||||
| 115 | |||||||||
| 116 | /** Set... | ||||||||
| 117 | Similar to assignment. | ||||||||
| 118 | */ | ||||||||
| 119 | Reference<reference_type> & | ||||||||
| 120 | SAL_CALL set (reference_type * pBody) | ||||||||
| 121 | { | ||||||||
| 122 | if (pBody) | ||||||||
| 123 | pBody->acquire(); | ||||||||
| 124 | reference_type * const pOld = m_pBody; | ||||||||
| 125 | m_pBody = pBody; | ||||||||
| 126 | if (pOld) | ||||||||
| 127 | pOld->release(); | ||||||||
| 128 | return *this; | ||||||||
| 129 | } | ||||||||
| 130 | |||||||||
| 131 | /** Assignment. | ||||||||
| 132 | Unbinds this instance from its body (if bound) and | ||||||||
| 133 | bind it to the body represented by the handle. | ||||||||
| 134 | */ | ||||||||
| 135 | Reference<reference_type> & | ||||||||
| 136 | SAL_CALL operator= (const Reference<reference_type> & handle) | ||||||||
| 137 | { | ||||||||
| 138 | return set( handle.m_pBody ); | ||||||||
| 139 | } | ||||||||
| 140 | |||||||||
| 141 | #ifdef LIBO_INTERNAL_ONLY1 | ||||||||
| 142 | /** Assignment. | ||||||||
| 143 | * Unbinds this instance from its body (if bound), | ||||||||
| 144 | * bind it to the body represented by the handle, and | ||||||||
| 145 | * set the body represented by the handle to nullptr. | ||||||||
| 146 | */ | ||||||||
| 147 | Reference<reference_type> & | ||||||||
| 148 | operator= (Reference<reference_type> && handle) | ||||||||
| 149 | { | ||||||||
| 150 | // self-movement guts ourself | ||||||||
| 151 | if (m_pBody) | ||||||||
| 152 | m_pBody->release(); | ||||||||
| 153 | m_pBody = handle.m_pBody; | ||||||||
| 154 | handle.m_pBody = nullptr; | ||||||||
| 155 | return *this; | ||||||||
| 156 | } | ||||||||
| 157 | #endif | ||||||||
| 158 | |||||||||
| 159 | /** Assignment... | ||||||||
| 160 | */ | ||||||||
| 161 | Reference<reference_type> & | ||||||||
| 162 | SAL_CALL operator= (reference_type * pBody) | ||||||||
| 163 | { | ||||||||
| 164 | return set( pBody ); | ||||||||
| 165 | } | ||||||||
| 166 | |||||||||
| 167 | /** Unbind the body from this handle. | ||||||||
| 168 | Note that for a handle representing a large body, | ||||||||
| 169 | "handle.clear().set(new body());" _might_ | ||||||||
| 170 | perform a little bit better than "handle.set(new body());", | ||||||||
| 171 | since in the second case two large objects exist in memory | ||||||||
| 172 | (the old body and the new body). | ||||||||
| 173 | */ | ||||||||
| 174 | Reference<reference_type> & SAL_CALL clear() | ||||||||
| 175 | { | ||||||||
| 176 | if (m_pBody) | ||||||||
| 177 | { | ||||||||
| 178 | reference_type * const pOld = m_pBody; | ||||||||
| 179 | m_pBody = NULL__null; | ||||||||
| 180 | pOld->release(); | ||||||||
| 181 | } | ||||||||
| 182 | return *this; | ||||||||
| 183 | } | ||||||||
| 184 | |||||||||
| 185 | |||||||||
| 186 | /** Get the body. Can be used instead of operator->(). | ||||||||
| 187 | I.e. handle->someBodyOp() and handle.get()->someBodyOp() | ||||||||
| 188 | are the same. | ||||||||
| 189 | */ | ||||||||
| 190 | reference_type * SAL_CALL get() const | ||||||||
| 191 | { | ||||||||
| 192 | return m_pBody; | ||||||||
| |||||||||
| 193 | } | ||||||||
| 194 | |||||||||
| 195 | |||||||||
| 196 | /** Probably most common used: handle->someBodyOp(). | ||||||||
| 197 | */ | ||||||||
| 198 | reference_type * SAL_CALL operator->() const | ||||||||
| 199 | { | ||||||||
| 200 | assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx" , 200, __extension__ __PRETTY_FUNCTION__)); | ||||||||
| 201 | return m_pBody; | ||||||||
| 202 | } | ||||||||
| 203 | |||||||||
| 204 | |||||||||
| 205 | /** Allows (*handle).someBodyOp(). | ||||||||
| 206 | */ | ||||||||
| 207 | reference_type & SAL_CALL operator*() const | ||||||||
| 208 | { | ||||||||
| 209 | assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx" , 209, __extension__ __PRETTY_FUNCTION__)); | ||||||||
| 210 | return *m_pBody; | ||||||||
| 211 | } | ||||||||
| 212 | |||||||||
| 213 | |||||||||
| 214 | /** Returns True if the handle does point to a valid body. | ||||||||
| 215 | */ | ||||||||
| 216 | bool SAL_CALL is() const | ||||||||
| 217 | { | ||||||||
| 218 | return (m_pBody != NULL__null); | ||||||||
| 219 | } | ||||||||
| 220 | |||||||||
| 221 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||
| 222 | /** Returns True if the handle does point to a valid body. | ||||||||
| 223 | */ | ||||||||
| 224 | explicit operator bool() const | ||||||||
| 225 | { | ||||||||
| 226 | return is(); | ||||||||
| 227 | } | ||||||||
| 228 | #endif | ||||||||
| 229 | |||||||||
| 230 | /** Returns True if this points to pBody. | ||||||||
| 231 | */ | ||||||||
| 232 | bool SAL_CALL operator== (const reference_type * pBody) const | ||||||||
| 233 | { | ||||||||
| 234 | return (m_pBody == pBody); | ||||||||
| 235 | } | ||||||||
| 236 | |||||||||
| 237 | |||||||||
| 238 | /** Returns True if handle points to the same body. | ||||||||
| 239 | */ | ||||||||
| 240 | bool | ||||||||
| 241 | SAL_CALL operator== (const Reference<reference_type> & handle) const | ||||||||
| 242 | { | ||||||||
| 243 | return (m_pBody == handle.m_pBody); | ||||||||
| 244 | } | ||||||||
| 245 | |||||||||
| 246 | |||||||||
| 247 | /** Needed to place References into STL collection. | ||||||||
| 248 | */ | ||||||||
| 249 | bool | ||||||||
| 250 | SAL_CALL operator!= (const Reference<reference_type> & handle) const | ||||||||
| 251 | { | ||||||||
| 252 | return (m_pBody != handle.m_pBody); | ||||||||
| 253 | } | ||||||||
| 254 | |||||||||
| 255 | |||||||||
| 256 | /** Needed to place References into STL collection. | ||||||||
| 257 | */ | ||||||||
| 258 | bool | ||||||||
| 259 | SAL_CALL operator< (const Reference<reference_type> & handle) const | ||||||||
| 260 | { | ||||||||
| 261 | return (m_pBody < handle.m_pBody); | ||||||||
| 262 | } | ||||||||
| 263 | |||||||||
| 264 | |||||||||
| 265 | /** Needed to place References into STL collection. | ||||||||
| 266 | */ | ||||||||
| 267 | bool | ||||||||
| 268 | SAL_CALL operator> (const Reference<reference_type> & handle) const | ||||||||
| 269 | { | ||||||||
| 270 | return (m_pBody > handle.m_pBody); | ||||||||
| 271 | } | ||||||||
| 272 | }; | ||||||||
| 273 | |||||||||
| 274 | } // namespace rtl | ||||||||
| 275 | |||||||||
| 276 | #if defined LIBO_INTERNAL_ONLY1 | ||||||||
| 277 | namespace std | ||||||||
| 278 | { | ||||||||
| 279 | |||||||||
| 280 | /// @cond INTERNAL | ||||||||
| 281 | /** | ||||||||
| 282 | Make rtl::Reference hashable by default for use in STL containers. | ||||||||
| 283 | |||||||||
| 284 | @since LibreOffice 6.3 | ||||||||
| 285 | */ | ||||||||
| 286 | template<typename T> | ||||||||
| 287 | struct hash<::rtl::Reference<T>> | ||||||||
| 288 | { | ||||||||
| 289 | std::size_t operator()(::rtl::Reference<T> const & s) const | ||||||||
| 290 | { return std::size_t(s.get()); } | ||||||||
| 291 | }; | ||||||||
| 292 | /// @endcond | ||||||||
| 293 | |||||||||
| 294 | } | ||||||||
| 295 | |||||||||
| 296 | #endif | ||||||||
| 297 | |||||||||
| 298 | #endif /* ! INCLUDED_RTL_REF_HXX */ | ||||||||
| 299 | |||||||||
| 300 | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |
| 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 | #ifndef INCLUDED_VCL_Reference_HXX |
| 20 | #define INCLUDED_VCL_Reference_HXX |
| 21 | |
| 22 | #include <vcl/dllapi.h> |
| 23 | #include <osl/interlck.h> |
| 24 | |
| 25 | class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase |
| 26 | { |
| 27 | mutable oslInterlockedCount mnRefCnt; |
| 28 | |
| 29 | template<typename T> friend class VclPtr; |
| 30 | |
| 31 | public: |
| 32 | void acquire() const |
| 33 | { |
| 34 | osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1); |
| 35 | } |
| 36 | |
| 37 | void release() const |
| 38 | { |
| 39 | if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0) |
| 40 | delete this; |
| 41 | } |
| 42 | #ifdef DBG_UTIL |
| 43 | #ifndef _WIN32 |
| 44 | sal_Int32 getRefCount() const { return mnRefCnt; } |
| 45 | #endif |
| 46 | #endif |
| 47 | |
| 48 | |
| 49 | private: |
| 50 | VclReferenceBase(const VclReferenceBase&) = delete; |
| 51 | VclReferenceBase& operator=(const VclReferenceBase&) = delete; |
| 52 | |
| 53 | bool mbDisposed : 1; |
| 54 | |
| 55 | protected: |
| 56 | VclReferenceBase(); |
| 57 | protected: |
| 58 | virtual ~VclReferenceBase(); |
| 59 | |
| 60 | protected: |
| 61 | virtual void dispose(); |
| 62 | |
| 63 | public: |
| 64 | void disposeOnce(); |
| 65 | bool isDisposed() const { return mbDisposed; } |
| 66 | |
| 67 | }; |
| 68 | #endif |