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