desktop/source/lib/lokinteractionhandler.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 "lokinteractionhandler.hxx"
  21
  22 #include <boost/property_tree/json_parser.hpp>
  23
  24 #include <rtl/ref.hxx>
  25 #include <cppuhelper/supportsservice.hxx>
  26
  27 #include <com/sun/star/task/XInteractionAbort.hpp>
  28 #include <com/sun/star/task/XInteractionApprove.hpp>
  29 #include <com/sun/star/task/XInteractionPassword2.hpp>
  30 #include <com/sun/star/ucb/InteractiveNetworkConnectException.hpp>
  31 #include <com/sun/star/ucb/InteractiveNetworkOffLineException.hpp>
  32
  33 #include <com/sun/star/ucb/InteractiveIOException.hpp>
  34 #include <com/sun/star/ucb/InteractiveNetworkReadException.hpp>
  35 #include <com/sun/star/ucb/InteractiveNetworkResolveNameException.hpp>
  36 #include <com/sun/star/ucb/InteractiveNetworkWriteException.hpp>
  37
  38 #include <com/sun/star/task/DocumentPasswordRequest2.hpp>
  39 #include <com/sun/star/task/DocumentMSPasswordRequest2.hpp>
  40
  41 #include "../../inc/lib/init.hxx"
  42
  43 #include <LibreOfficeKit/LibreOfficeKitEnums.h>
  44 #include <sfx2/lokhelper.hxx>
  45 #include <sfx2/viewsh.hxx>
  46 #include <comphelper/lok.hxx>
  47
  48 using namespace com::sun::star;
  49
  50 LOKInteractionHandler::LOKInteractionHandler(
  51         const OString& rCommand,
  52         desktop::LibLibreOffice_Impl *const pLOKit,
  53         desktop::LibLODocument_Impl *const pLOKDocument)
  54     : m_pLOKit(pLOKit)
  55     , m_pLOKDocument(pLOKDocument)
  56     , m_command(rCommand)
  57     , m_usePassword(false)
  58 {
  59     assert(m_pLOKit);
  60 }
  61
  62 LOKInteractionHandler::~LOKInteractionHandler()
  63 {
  64 }
  65
  66 OUString SAL_CALL LOKInteractionHandler::getImplementationName()
  67 {
  68     return OUString("com.sun.star.comp.uui.LOKInteractionHandler");
  69 }
  70
  71 sal_Bool SAL_CALL LOKInteractionHandler::supportsService(OUString const & rServiceName)
  72 {
  73     return cppu::supportsService(this, rServiceName);
  74 }
  75
  76 uno::Sequence< OUString > SAL_CALL LOKInteractionHandler::getSupportedServiceNames()
  77 {
  78     uno::Sequence< OUString > aNames(3);
  79     aNames[0] = "com.sun.star.task.InteractionHandler";
  80     // added to indicate support for configuration.backend.MergeRecoveryRequest
  81     aNames[1] = "com.sun.star.configuration.backend.InteractionHandler";
  82     aNames[2] = "com.sun.star.uui.InteractionHandler";
  83     // for backwards compatibility
  84     return aNames;
  85 }
  86
  87 void SAL_CALL LOKInteractionHandler::initialize(uno::Sequence<uno::Any> const & /*rArguments*/)
  88 {
  89 }
  90
  91 void SAL_CALL LOKInteractionHandler::handle(
  92         uno::Reference<task::XInteractionRequest> const & xRequest)
  93 {
  94     // just do the same thing in both cases
  95     handleInteractionRequest(xRequest);
  96 }
  97
  98 void LOKInteractionHandler::postError(css::task::InteractionClassification classif, const char* kind, ErrCode code, const OUString &message)
  99 {
 100     const char *classification = "error";
 101     switch (classif)
 102     {
 103         case task::InteractionClassification_ERROR: break;
 104         case task::InteractionClassification_WARNING: classification = "warning"; break;
 105         case task::InteractionClassification_INFO: classification = "info"; break;
 106         case task::InteractionClassification_QUERY: classification = "query"; break;
 107         default: assert(false); break;
 108     }
 109
 110     // create the JSON representation
 111     boost::property_tree::ptree aTree;
 112     aTree.put("classification", classification);
 113     aTree.put("cmd", m_command.getStr());
 114     aTree.put("kind", kind);
 115     aTree.put("code", code);
 116     aTree.put("message", message.toUtf8());
 117
 118     std::stringstream aStream;
 119     boost::property_tree::write_json(aStream, aTree);
 120
 121     std::size_t nView = SfxViewShell::Current() ? SfxLokHelper::getView() : 0;
 122     if (m_pLOKDocument && m_pLOKDocument->mpCallbackFlushHandlers.size() > nView && m_pLOKDocument->mpCallbackFlushHandlers[nView])
 123         m_pLOKDocument->mpCallbackFlushHandlers[nView]->queue(LOK_CALLBACK_ERROR, aStream.str().c_str());
 124     else if (m_pLOKit->mpCallback)
 125         m_pLOKit->mpCallback(LOK_CALLBACK_ERROR, aStream.str().c_str(), m_pLOKit->mpCallbackData);
 126 }
 127
 128 namespace {
 129
 130 /// Just approve the interaction.
 131 void selectApproved(uno::Sequence<uno::Reference<task::XInteractionContinuation>> const &rContinuations)
 132 {
 133     for (sal_Int32 i = 0; i < rContinuations.getLength(); ++i)
 134     {
 135         uno::Reference<task::XInteractionApprove> xApprove(rContinuations[i], uno::UNO_QUERY);
 136         if (xApprove.is())
 137             xApprove->select();
 138     }
 139 }
 140
 141 }
 142
 143 bool LOKInteractionHandler::handleIOException(const css::uno::Sequence<css::uno::Reference<css::task::XInteractionContinuation>> &rContinuations, const css::uno::Any& rRequest)
 144 {
 145     ucb::InteractiveIOException aIoException;
 146     if (!(rRequest >>= aIoException))
 147         return false;
 148
 149     static ErrCode const aErrorCode[(int)ucb::IOErrorCode_WRONG_VERSION + 1] =
 150     {
 151         ERRCODE_IO_ABORT,
 152         ERRCODE_IO_ACCESSDENIED,
 153         ERRCODE_IO_ALREADYEXISTS,
 154         ERRCODE_IO_BADCRC,
 155         ERRCODE_IO_CANTCREATE,
 156         ERRCODE_IO_CANTREAD,
 157         ERRCODE_IO_CANTSEEK,
 158         ERRCODE_IO_CANTTELL,
 159         ERRCODE_IO_CANTWRITE,
 160         ERRCODE_IO_CURRENTDIR,
 161         ERRCODE_IO_DEVICENOTREADY,
 162         ERRCODE_IO_NOTSAMEDEVICE,
 163         ERRCODE_IO_GENERAL,
 164         ERRCODE_IO_INVALIDACCESS,
 165         ERRCODE_IO_INVALIDCHAR,
 166         ERRCODE_IO_INVALIDDEVICE,
 167         ERRCODE_IO_INVALIDLENGTH,
 168         ERRCODE_IO_INVALIDPARAMETER,
 169         ERRCODE_IO_ISWILDCARD,
 170         ERRCODE_IO_LOCKVIOLATION,
 171         ERRCODE_IO_MISPLACEDCHAR,
 172         ERRCODE_IO_NAMETOOLONG,
 173         ERRCODE_IO_NOTEXISTS,
 174         ERRCODE_IO_NOTEXISTSPATH,
 175         ERRCODE_IO_NOTSUPPORTED,
 176         ERRCODE_IO_NOTADIRECTORY,
 177         ERRCODE_IO_NOTAFILE,
 178         ERRCODE_IO_OUTOFSPACE,
 179         ERRCODE_IO_TOOMANYOPENFILES,
 180         ERRCODE_IO_OUTOFMEMORY,
 181         ERRCODE_IO_PENDING,
 182         ERRCODE_IO_RECURSIVE,
 183         ERRCODE_IO_UNKNOWN,
 184         ERRCODE_IO_WRITEPROTECTED,
 185         ERRCODE_IO_WRONGFORMAT,
 186         ERRCODE_IO_WRONGVERSION,
 187     };
 188
 189     postError(aIoException.Classification, "io", aErrorCode[(int)aIoException.Code], "");
 190     selectApproved(rContinuations);
 191
 192     return true;
 193 }
 194
 195 bool LOKInteractionHandler::handleNetworkException(const uno::Sequence<uno::Reference<task::XInteractionContinuation>> &rContinuations, const uno::Any &rRequest)
 196 {
 197     ucb::InteractiveNetworkException aNetworkException;
 198     if (!(rRequest >>= aNetworkException))
 199         return false;
 200
 201     ErrCode nErrorCode;
 202     OUString aMessage;
 203
 204     ucb::InteractiveNetworkOffLineException aOffLineException;
 205     ucb::InteractiveNetworkResolveNameException aResolveNameException;
 206     ucb::InteractiveNetworkConnectException aConnectException;
 207     ucb::InteractiveNetworkReadException aReadException;
 208     ucb::InteractiveNetworkWriteException aWriteException;
 209     if (rRequest >>= aOffLineException)
 210     {
 211         nErrorCode = ERRCODE_INET_OFFLINE;
 212     }
 213     else if (rRequest >>= aResolveNameException)
 214     {
 215         nErrorCode = ERRCODE_INET_NAME_RESOLVE;
 216         aMessage = aResolveNameException.Server;
 217     }
 218     else if (rRequest >>= aConnectException)
 219     {
 220         nErrorCode = ERRCODE_INET_CONNECT;
 221         aMessage = aConnectException.Server;
 222     }
 223     else if (rRequest >>= aReadException)
 224     {
 225         nErrorCode = ERRCODE_INET_READ;
 226         aMessage = aReadException.Diagnostic;
 227     }
 228     else if (rRequest >>= aWriteException)
 229     {
 230         nErrorCode = ERRCODE_INET_WRITE;
 231         aMessage = aWriteException.Diagnostic;
 232     }
 233     else
 234     {
 235         nErrorCode = ERRCODE_INET_GENERAL;
 236     }
 237
 238     postError(aNetworkException.Classification, "network", nErrorCode, aMessage);
 239     selectApproved(rContinuations);
 240
 241     return true;
 242 }
 243
 244 bool LOKInteractionHandler::handlePasswordRequest(const uno::Sequence<uno::Reference<task::XInteractionContinuation>> &rContinuations, const uno::Any &rRequest)
 245 {
 246     bool bPasswordRequestFound = false;
 247     bool bIsRequestPasswordToModify = false;
 248
 249     OString sUrl;
 250
 251     task::DocumentPasswordRequest passwordRequest;
 252     if (rRequest >>= passwordRequest)
 253     {
 254         bIsRequestPasswordToModify = false;
 255         sUrl = passwordRequest.Name.toUtf8();
 256         bPasswordRequestFound = true;
 257     }
 258
 259     task::DocumentPasswordRequest2 passwordRequest2;
 260     if (rRequest >>= passwordRequest2)
 261     {
 262         bIsRequestPasswordToModify = passwordRequest2.IsRequestPasswordToModify;
 263         sUrl = passwordRequest2.Name.toUtf8();
 264         bPasswordRequestFound = true;
 265     }
 266
 267     task::DocumentMSPasswordRequest2 passwordMSRequest;
 268     if (rRequest >>= passwordMSRequest)
 269     {
 270         bIsRequestPasswordToModify = passwordMSRequest.IsRequestPasswordToModify;
 271         sUrl = passwordMSRequest.Name.toUtf8();
 272         bPasswordRequestFound = true;
 273     }
 274
 275     if (!bPasswordRequestFound)
 276         return false;
 277
 278     if (m_pLOKit->mpCallback &&
 279         m_pLOKit->hasOptionalFeature(bIsRequestPasswordToModify ? LOK_FEATURE_DOCUMENT_PASSWORD_TO_MODIFY
 280                                                                 : LOK_FEATURE_DOCUMENT_PASSWORD))
 281     {
 282         m_pLOKit->mpCallback(bIsRequestPasswordToModify ? LOK_CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY
 283                                                         : LOK_CALLBACK_DOCUMENT_PASSWORD,
 284                 sUrl.getStr(),
 285                 m_pLOKit->mpCallbackData);
 286
 287         // block until SetPassword is called
 288         m_havePassword.wait();
 289         m_havePassword.reset();
 290     }
 291
 292     for (sal_Int32 i = 0; i < rContinuations.getLength(); ++i)
 293     {
 294         if (m_usePassword)
 295         {
 296             if (bIsRequestPasswordToModify)
 297             {
 298                 uno::Reference<task::XInteractionPassword2> const xIPW2(rContinuations[i], uno::UNO_QUERY);
 299                 xIPW2->setPasswordToModify(m_Password);
 300                 xIPW2->select();
 301             }
 302             else
 303             {
 304                 uno::Reference<task::XInteractionPassword> const xIPW(rContinuations[i], uno::UNO_QUERY);
 305                 if (xIPW.is())
 306                 {
 307                     xIPW->setPassword(m_Password);
 308                     xIPW->select();
 309                 }
 310             }
 311         }
 312         else
 313         {
 314             if (bIsRequestPasswordToModify)
 315             {
 316                 uno::Reference<task::XInteractionPassword2> const xIPW2(rContinuations[i], uno::UNO_QUERY);
 317                 xIPW2->setRecommendReadOnly(true);
 318                 xIPW2->select();
 319             }
 320             else
 321             {
 322                 uno::Reference<task::XInteractionAbort> const xAbort(rContinuations[i], uno::UNO_QUERY);
 323                 if (xAbort.is())
 324                 {
 325                     xAbort->select();
 326                 }
 327             }
 328         }
 329     }
 330     return true;
 331 }
 332
 333 sal_Bool SAL_CALL LOKInteractionHandler::handleInteractionRequest(
 334         const uno::Reference<task::XInteractionRequest>& xRequest)
 335 {
 336     uno::Sequence<uno::Reference<task::XInteractionContinuation>> const &rContinuations = xRequest->getContinuations();
 337     uno::Any const request(xRequest->getRequest());
 338
 339     if (handleIOException(rContinuations, request))
 340         return true;
 341
 342     if (handleNetworkException(rContinuations, request))
 343         return true;
 344
 345     if (handlePasswordRequest(rContinuations, request))
 346         return true;
 347
 348     // TODO: perform more interactions 'for real' like the above
 349     selectApproved(rContinuations);
 350
 351     return true;
 352 }
 353
 354 void LOKInteractionHandler::SetPassword(char const*const pPassword)
 355 {
 356     if (pPassword)
 357     {
 358         m_Password = OUString(pPassword, strlen(pPassword), RTL_TEXTENCODING_UTF8);
 359         m_usePassword = true;
 360     }
 361     else
 362     {
 363         m_usePassword = false;
 364     }
 365     m_havePassword.set();
 366 }
 367
 368 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */