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