uui/source/iahndl-locking.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 <com/sun/star/document/ChangedByOthersRequest.hpp>
  21 #include <com/sun/star/document/LockedDocumentRequest.hpp>
  22 #include <com/sun/star/document/LockedOnSavingRequest.hpp>
  23 #include <com/sun/star/document/LockFileIgnoreRequest.hpp>
  24 #include <com/sun/star/document/LockFileCorruptRequest.hpp>
  25 #include <com/sun/star/document/OwnLockOnDocumentRequest.hpp>
  26 #include <com/sun/star/task/XInteractionApprove.hpp>
  27 #include <com/sun/star/task/XInteractionDisapprove.hpp>
  28 #include <com/sun/star/task/XInteractionAbort.hpp>
  29 #include <com/sun/star/task/XInteractionRequest.hpp>
  30 #include <com/sun/star/task/XInteractionRetry.hpp>
  31
  32 #include <unotools/resmgr.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include <officecfg/Office/Common.hxx>
  35
  36 #include <strings.hrc>
  37 #include "getcontinuations.hxx"
  38 #include "openlocked.hxx"
  39 #include "trylater.hxx"
  40 #include "alreadyopen.hxx"
  41 #include "filechanged.hxx"
  42 #include "lockfailed.hxx"
  43 #include "lockcorrupt.hxx"
  44
  45 #include "iahndl.hxx"
  46
  47 #define UUI_DOC_LOAD_LOCK       0
  48 #define UUI_DOC_OWN_LOAD_LOCK   1
  49 #define UUI_DOC_SAVE_LOCK       2
  50 #define UUI_DOC_OWN_SAVE_LOCK   3
  51
  52 using namespace com::sun::star;
  53
  54 namespace {
  55
  56 void
  57 handleLockedDocumentRequest_(
  58     weld::Window * pParent,
  59     const OUString& aDocumentURL,
  60     const OUString& aInfo,
  61     uno::Sequence< uno::Reference< task::XInteractionContinuation > > const &
  62         rContinuations,
  63     sal_uInt16 nMode )
  64 {
  65     uno::Reference< task::XInteractionApprove > xApprove;
  66     uno::Reference< task::XInteractionDisapprove > xDisapprove;
  67     uno::Reference< task::XInteractionAbort > xAbort;
  68     // In case an option to ignore lock and open the file is available
  69     uno::Reference< task::XInteractionRetry > xRetry;
  70     getContinuations(rContinuations, &xApprove, &xDisapprove, &xAbort, &xRetry);
  71
  72     if ( !xApprove.is() || !xDisapprove.is() || !xAbort.is() )
  73         return;
  74
  75     SolarMutexGuard aGuard;
  76     std::locale aResLocale = Translate::Create("uui");
  77
  78     OUString aMessage;
  79     std::vector< OUString > aArguments;
  80     aArguments.push_back( aDocumentURL );
  81
  82     bool bAllowOverride = xRetry.is() && officecfg::Office::Common::Misc::AllowOverrideLocking::get();
  83
  84     sal_Int32 nResult = RET_CANCEL;
  85     if ( nMode == UUI_DOC_LOAD_LOCK )
  86     {
  87         aArguments.push_back( !aInfo.isEmpty()
  88                               ? aInfo
  89                               : Translate::get( STR_UNKNOWNUSER, aResLocale) );
  90         aArguments.push_back( bAllowOverride
  91                               ? Translate::get( STR_OPENLOCKED_ALLOWIGNORE_MSG, aResLocale )
  92                               : "" );
  93         aMessage = Translate::get(STR_OPENLOCKED_MSG, aResLocale);
  94         aMessage = UUIInteractionHelper::replaceMessageWithArguments(
  95             aMessage, aArguments );
  96
  97         OpenLockedQueryBox aDialog(pParent, aResLocale, aMessage, bAllowOverride);
  98         nResult = aDialog.run();
  99     }
 100     else if ( nMode == UUI_DOC_SAVE_LOCK )
 101     {
 102         aArguments.push_back( !aInfo.isEmpty()
 103                               ? aInfo
 104                               : Translate::get( STR_UNKNOWNUSER,
 105                                            aResLocale ) );
 106         aMessage = Translate::get(bAllowOverride ? STR_OVERWRITE_IGNORELOCK_MSG : STR_TRYLATER_MSG,
 107             aResLocale);
 108         aMessage = UUIInteractionHelper::replaceMessageWithArguments(
 109             aMessage, aArguments );
 110
 111         TryLaterQueryBox aDialog(pParent, aResLocale, aMessage, bAllowOverride);
 112         nResult = aDialog.run();
 113     }
 114     else if ( nMode == UUI_DOC_OWN_LOAD_LOCK ||
 115               nMode == UUI_DOC_OWN_SAVE_LOCK )
 116     {
 117         aArguments.push_back( aInfo );
 118         aMessage = Translate::get(nMode == UUI_DOC_OWN_SAVE_LOCK
 119                                       ? STR_ALREADYOPEN_SAVE_MSG
 120                                       : STR_ALREADYOPEN_MSG,
 121                                   aResLocale );
 122         aMessage = UUIInteractionHelper::replaceMessageWithArguments(
 123             aMessage, aArguments );
 124
 125         AlreadyOpenQueryBox aDialog(pParent, aResLocale, aMessage, nMode == UUI_DOC_OWN_SAVE_LOCK);
 126         nResult = aDialog.run();
 127     }
 128
 129     if ( nResult == RET_YES )
 130         xApprove->select();
 131     else if ( nResult == RET_NO )
 132         xDisapprove->select();
 133     else if ( nResult == RET_IGNORE && xRetry.is() )
 134         xRetry->select();
 135     else
 136         xAbort->select();
 137 }
 138
 139 void
 140 handleChangedByOthersRequest_(
 141     weld::Window * pParent,
 142     uno::Sequence< uno::Reference< task::XInteractionContinuation > > const &
 143         rContinuations )
 144 {
 145     uno::Reference< task::XInteractionApprove > xApprove;
 146     uno::Reference< task::XInteractionAbort > xAbort;
 147     getContinuations(rContinuations, &xApprove, &xAbort);
 148
 149     if ( !xApprove.is() || !xAbort.is() )
 150         return;
 151
 152     SolarMutexGuard aGuard;
 153     std::locale aResLocale = Translate::Create("uui");
 154     FileChangedQueryBox aDialog(pParent, aResLocale);
 155     sal_Int32 nResult = aDialog.run();
 156
 157     if ( nResult == RET_YES )
 158         xApprove->select();
 159     else
 160         xAbort->select();
 161 }
 162
 163 const sal_uInt16  UUI_DOC_CreateErrDlg  = 0;
 164 const sal_uInt16  UUI_DOC_CorruptErrDlg = 1;
 165
 166
 167
 168 void
 169 handleLockFileProblemRequest_(
 170     weld::Window * pParent,
 171     uno::Sequence< uno::Reference< task::XInteractionContinuation > > const &
 172         rContinuations, sal_uInt16 nWhichDlg )
 173 {
 174     uno::Reference< task::XInteractionApprove > xApprove;
 175     uno::Reference< task::XInteractionAbort > xAbort;
 176     getContinuations(rContinuations, &xApprove, &xAbort);
 177
 178     if ( !xApprove.is() || !xAbort.is() )
 179         return;
 180
 181     SolarMutexGuard aGuard;
 182     std::locale aResLocale = Translate::Create("uui");
 183
 184     sal_Int32 nResult;
 185
 186     if (nWhichDlg == UUI_DOC_CreateErrDlg)
 187     {
 188         LockFailedQueryBox aDialog(pParent, aResLocale);
 189         nResult = aDialog.run();
 190     }
 191     else
 192     {
 193         LockCorruptQueryBox aDialog(pParent, aResLocale);
 194         nResult = aDialog.run();
 195     }
 196
 197     if ( nResult == RET_OK )
 198         xApprove->select();
 199     else
 200         xAbort->select();
 201 }
 202
 203 } // namespace
 204
 205 bool
 206 UUIInteractionHelper::handleLockedDocumentRequest(
 207     uno::Reference< task::XInteractionRequest > const & rRequest)
 208 {
 209     uno::Any aAnyRequest(rRequest->getRequest());
 210
 211     document::LockedDocumentRequest aLockedDocumentRequest;
 212     if (aAnyRequest >>= aLockedDocumentRequest )
 213     {
 214         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 215         handleLockedDocumentRequest_(Application::GetFrameWeld(xParent),
 216                                      aLockedDocumentRequest.DocumentURL,
 217                                      aLockedDocumentRequest.UserInfo,
 218                                      rRequest->getContinuations(),
 219                                      UUI_DOC_LOAD_LOCK);
 220         return true;
 221     }
 222
 223     document::OwnLockOnDocumentRequest aOwnLockOnDocumentRequest;
 224     if (aAnyRequest >>= aOwnLockOnDocumentRequest )
 225     {
 226         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 227         handleLockedDocumentRequest_(Application::GetFrameWeld(xParent),
 228                                      aOwnLockOnDocumentRequest.DocumentURL,
 229                                      aOwnLockOnDocumentRequest.TimeInfo,
 230                                      rRequest->getContinuations(),
 231                                      aOwnLockOnDocumentRequest.IsStoring
 232                                          ? UUI_DOC_OWN_SAVE_LOCK
 233                                          : UUI_DOC_OWN_LOAD_LOCK);
 234         return true;
 235     }
 236
 237     document::LockedOnSavingRequest aLockedOnSavingRequest;
 238     if (aAnyRequest >>= aLockedOnSavingRequest )
 239     {
 240         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 241         handleLockedDocumentRequest_(Application::GetFrameWeld(xParent),
 242                                      aLockedOnSavingRequest.DocumentURL,
 243                                      aLockedOnSavingRequest.UserInfo,
 244                                      rRequest->getContinuations(),
 245                                      UUI_DOC_SAVE_LOCK);
 246         return true;
 247     }
 248     return false;
 249 }
 250
 251 bool
 252 UUIInteractionHelper::handleChangedByOthersRequest(
 253     uno::Reference< task::XInteractionRequest > const & rRequest)
 254 {
 255     uno::Any aAnyRequest(rRequest->getRequest());
 256
 257     document::ChangedByOthersRequest aChangedByOthersRequest;
 258     if (aAnyRequest >>= aChangedByOthersRequest )
 259     {
 260         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 261         handleChangedByOthersRequest_(Application::GetFrameWeld(xParent),
 262                                       rRequest->getContinuations());
 263         return true;
 264     }
 265     return false;
 266 }
 267
 268
 269 bool
 270 UUIInteractionHelper::handleLockFileProblemRequest(
 271     uno::Reference< task::XInteractionRequest > const & rRequest)
 272 {
 273     uno::Any aAnyRequest(rRequest->getRequest());
 274
 275     document::LockFileIgnoreRequest aLockFileIgnoreRequest;
 276     if (aAnyRequest >>= aLockFileIgnoreRequest )
 277     {
 278         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 279         handleLockFileProblemRequest_(Application::GetFrameWeld(xParent),
 280                                       rRequest->getContinuations(), UUI_DOC_CreateErrDlg);
 281         return true;
 282     }
 283
 284     document::LockFileCorruptRequest aLockFileCorruptRequest;
 285     if (aAnyRequest >>= aLockFileCorruptRequest )
 286     {
 287         uno::Reference<awt::XWindow> xParent = getParentXWindow();
 288         handleLockFileProblemRequest_(Application::GetFrameWeld(xParent),
 289                                       rRequest->getContinuations(), UUI_DOC_CorruptErrDlg);
 290         return true;
 291     }
 292
 293     return false;
 294 }
 295
 296
 297 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */