sw/source/ui/dbui/mmoutputtypepage.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 "mmoutputtypepage.hxx"
  21 #include <mailmergewizard.hxx>
  22 #include <mmconfigitem.hxx>
  23 #include <dbui.hrc>
  24 #include <strings.hrc>
  25 #include <bitmaps.hlst>
  26 #include <swtypes.hxx>
  27
  28 #include <rtl/ref.hxx>
  29 #include <com/sun/star/mail/XSmtpService.hpp>
  30 #include <vcl/idle.hxx>
  31 #include <vcl/svapp.hxx>
  32 #include <vcl/weld.hxx>
  33
  34 #include <cmdid.h>
  35 #include <swunohelper.hxx>
  36 #include <mmresultdialogs.hxx>
  37 #include <maildispatcher.hxx>
  38 #include <imaildsplistener.hxx>
  39
  40 using namespace ::com::sun::star;
  41
  42 SwMailMergeOutputTypePage::SwMailMergeOutputTypePage(weld::Container* pPage, SwMailMergeWizard* pWizard)
  43     : vcl::OWizardPage(pPage, pWizard, "modules/swriter/ui/mmoutputtypepage.ui", "MMOutputTypePage")
  44     , m_pWizard(pWizard)
  45     , m_xLetterRB(m_xBuilder->weld_radio_button("letter"))
  46     , m_xMailRB(m_xBuilder->weld_radio_button("email"))
  47     , m_xLetterHint(m_xBuilder->weld_label("letterft"))
  48     , m_xMailHint(m_xBuilder->weld_label("emailft"))
  49 {
  50     Link<weld::ToggleButton&,void> aLink = LINK(this, SwMailMergeOutputTypePage, TypeHdl_Impl);
  51     m_xLetterRB->connect_toggled(aLink);
  52     m_xMailRB->connect_toggled(aLink);
  53
  54     SwMailMergeConfigItem& rConfigItem = m_pWizard->GetConfigItem();
  55     if(rConfigItem.IsOutputToLetter())
  56         m_xLetterRB->set_active(true);
  57     else
  58         m_xMailRB->set_active(true);
  59     TypeHdl_Impl(*m_xLetterRB);
  60 }
  61
  62 SwMailMergeOutputTypePage::~SwMailMergeOutputTypePage()
  63 {
  64 }
  65
  66 IMPL_LINK_NOARG(SwMailMergeOutputTypePage, TypeHdl_Impl, weld::ToggleButton&, void)
  67 {
  68     bool bLetter = m_xLetterRB->get_active();
  69     m_xLetterHint->set_visible(bLetter);
  70     m_xMailHint->set_visible(!bLetter);
  71     m_pWizard->GetConfigItem().SetOutputToLetter(bLetter);
  72     m_pWizard->UpdateRoadmap();
  73 }
  74
  75 struct SwSendMailDialog_Impl
  76 {
  77     friend class SwSendMailDialog;
  78     ::osl::Mutex                                aDescriptorMutex;
  79
  80     std::vector< SwMailDescriptor >             aDescriptors;
  81     sal_uInt32                                  nCurrentDescriptor;
  82     ::rtl::Reference< MailDispatcher >          xMailDispatcher;
  83     ::rtl::Reference< IMailDispatcherListener>  xMailListener;
  84     uno::Reference< mail::XMailService >        xConnectedInMailService;
  85     Idle                                        aRemoveIdle;
  86
  87     SwSendMailDialog_Impl() :
  88         nCurrentDescriptor(0)
  89     {
  90         aRemoveIdle.SetPriority(TaskPriority::LOWEST);
  91     }
  92
  93     ~SwSendMailDialog_Impl()
  94     {
  95         // Shutdown must be called when the last reference to the
  96         // mail dispatcher will be released in order to force a
  97         // shutdown of the mail dispatcher thread.
  98         // 'join' with the mail dispatcher thread leads to a
  99         // deadlock (SolarMutex).
 100         if( xMailDispatcher.is() && !xMailDispatcher->isShutdownRequested() )
 101             xMailDispatcher->shutdown();
 102     }
 103     const SwMailDescriptor* GetNextDescriptor();
 104 };
 105
 106 const SwMailDescriptor* SwSendMailDialog_Impl::GetNextDescriptor()
 107 {
 108     ::osl::MutexGuard aGuard(aDescriptorMutex);
 109     if(nCurrentDescriptor < aDescriptors.size())
 110     {
 111         ++nCurrentDescriptor;
 112         return &aDescriptors[nCurrentDescriptor - 1];
 113     }
 114     return nullptr;
 115 }
 116
 117 class SwMailDispatcherListener_Impl : public IMailDispatcherListener
 118 {
 119     SwSendMailDialog& m_rSendMailDialog;
 120
 121 public:
 122     explicit SwMailDispatcherListener_Impl(SwSendMailDialog& rParentDlg);
 123
 124     virtual void idle(::rtl::Reference<MailDispatcher> xMailDispatcher) override;
 125     virtual void mailDelivered(::rtl::Reference<MailDispatcher> xMailDispatcher,
 126                 uno::Reference< mail::XMailMessage> xMailMessage) override;
 127     virtual void mailDeliveryError(::rtl::Reference<MailDispatcher> xMailDispatcher,
 128                 uno::Reference< mail::XMailMessage> xMailMessage, const OUString& sErrorMessage) override;
 129
 130     static void DeleteAttachments( uno::Reference< mail::XMailMessage > const & xMessage );
 131 };
 132
 133 SwMailDispatcherListener_Impl::SwMailDispatcherListener_Impl(SwSendMailDialog& rParentDlg)
 134     : m_rSendMailDialog(rParentDlg)
 135 {
 136 }
 137
 138 void SwMailDispatcherListener_Impl::idle(::rtl::Reference<MailDispatcher> /*xMailDispatcher*/)
 139 {
 140     SolarMutexGuard aGuard;
 141     m_rSendMailDialog.AllMailsSent();
 142 }
 143
 144 void SwMailDispatcherListener_Impl::mailDelivered(
 145                         ::rtl::Reference<MailDispatcher> /*xMailDispatcher*/,
 146                         uno::Reference< mail::XMailMessage> xMailMessage)
 147 {
 148     SolarMutexGuard aGuard;
 149     m_rSendMailDialog.DocumentSent( xMailMessage, true, nullptr );
 150     DeleteAttachments( xMailMessage );
 151 }
 152
 153 void SwMailDispatcherListener_Impl::mailDeliveryError(
 154                 ::rtl::Reference<MailDispatcher> /*xMailDispatcher*/,
 155                 uno::Reference< mail::XMailMessage> xMailMessage,
 156                 const OUString& sErrorMessage)
 157 {
 158     SolarMutexGuard aGuard;
 159     m_rSendMailDialog.DocumentSent( xMailMessage, false, &sErrorMessage );
 160     DeleteAttachments( xMailMessage );
 161 }
 162
 163 void SwMailDispatcherListener_Impl::DeleteAttachments( uno::Reference< mail::XMailMessage > const & xMessage )
 164 {
 165     const uno::Sequence< mail::MailAttachment > aAttachments = xMessage->getAttachments();
 166
 167     for(const auto& rAttachment : aAttachments)
 168     {
 169         try
 170         {
 171             uno::Reference< beans::XPropertySet > xTransferableProperties( rAttachment.Data, uno::UNO_QUERY_THROW);
 172             OUString sURL;
 173             xTransferableProperties->getPropertyValue("URL") >>= sURL;
 174             if(!sURL.isEmpty())
 175                 SWUnoHelper::UCB_DeleteFile( sURL );
 176         }
 177         catch (const uno::Exception&)
 178         {
 179         }
 180     }
 181 }
 182
 183 class SwSendWarningBox_Impl : public weld::MessageDialogController
 184 {
 185     std::unique_ptr<weld::TextView> m_xDetailED;
 186 public:
 187     SwSendWarningBox_Impl(weld::Window* pParent, const OUString& rDetails)
 188         : MessageDialogController(pParent, "modules/swriter/ui/warnemaildialog.ui", "WarnEmailDialog", "grid")
 189         , m_xDetailED(m_xBuilder->weld_text_view("errors"))
 190     {
 191         m_xDetailED->set_size_request(80 * m_xDetailED->get_approximate_digit_width(),
 192                                       8 * m_xDetailED->get_text_height());
 193         m_xDetailED->set_text(rDetails);
 194     }
 195 };
 196
 197 SwSendMailDialog::SwSendMailDialog(weld::Window *pParent, SwMailMergeConfigItem& rConfigItem)
 198     : GenericDialogController(pParent, "modules/swriter/ui/mmsendmails.ui", "SendMailsDialog")
 199     , m_sContinue(SwResId( ST_CONTINUE ))
 200     , m_sSendingTo(   SwResId(ST_SENDINGTO ))
 201     , m_sCompleted(   SwResId(ST_COMPLETED ))
 202     , m_sFailed(      SwResId(ST_FAILED     ))
 203     , m_bCancel(false)
 204     , m_bDestructionEnabled(false)
 205     , m_pImpl(new SwSendMailDialog_Impl)
 206     , m_pConfigItem(&rConfigItem)
 207     , m_nExpectedCount(0)
 208     , m_nSendCount(0)
 209     , m_nErrorCount(0)
 210     , m_xTransferStatus(m_xBuilder->weld_label("transferstatus"))
 211     , m_xPaused(m_xBuilder->weld_label("paused"))
 212     , m_xProgressBar(m_xBuilder->weld_progress_bar("progress"))
 213     , m_xErrorStatus(m_xBuilder->weld_label("errorstatus"))
 214     , m_xStatus(m_xBuilder->weld_tree_view("container"))
 215     , m_xStop(m_xBuilder->weld_button("stop"))
 216     , m_xClose(m_xBuilder->weld_button("cancel"))
 217     , m_xExpander(m_xBuilder->weld_expander("details"))
 218 {
 219     m_sStop = m_xStop->get_label();
 220     m_sTransferStatus = m_xTransferStatus->get_label();
 221     m_sErrorStatus = m_xErrorStatus->get_label();
 222
 223     Size aSize(m_xStatus->get_approximate_digit_width() * 28,
 224                m_xStatus->get_height_rows(20));
 225     m_xStatus->set_size_request(aSize.Width(), aSize.Height());
 226
 227     m_xStop->connect_clicked(LINK( this, SwSendMailDialog, StopHdl_Impl));
 228     m_xClose->connect_clicked(LINK( this, SwSendMailDialog, CloseHdl_Impl));
 229
 230     std::vector<int> aWidths;
 231     aWidths.push_back(m_xStatus->get_checkbox_column_width());
 232     aWidths.push_back(aSize.Width()/3 * 2);
 233     m_xStatus->set_column_fixed_widths(aWidths);
 234
 235     m_xPaused->set_visible(false);
 236     UpdateTransferStatus();
 237 }
 238
 239 SwSendMailDialog::~SwSendMailDialog()
 240 {
 241     if(m_pImpl->xMailDispatcher.is())
 242     {
 243         try
 244         {
 245             if(m_pImpl->xMailDispatcher->isStarted())
 246                 m_pImpl->xMailDispatcher->stop();
 247             if(m_pImpl->xConnectedInMailService.is() && m_pImpl->xConnectedInMailService->isConnected())
 248                 m_pImpl->xConnectedInMailService->disconnect();
 249
 250             uno::Reference<mail::XMailMessage> xMessage =
 251                     m_pImpl->xMailDispatcher->dequeueMailMessage();
 252             while(xMessage.is())
 253             {
 254                 SwMailDispatcherListener_Impl::DeleteAttachments( xMessage );
 255                 xMessage = m_pImpl->xMailDispatcher->dequeueMailMessage();
 256             }
 257         }
 258         catch (const uno::Exception&)
 259         {
 260         }
 261     }
 262 }
 263
 264 void SwSendMailDialog::AddDocument( SwMailDescriptor const & rDesc )
 265 {
 266     ::osl::MutexGuard aGuard(m_pImpl->aDescriptorMutex);
 267     m_pImpl->aDescriptors.push_back(rDesc);
 268     // if the dialog is already running then continue sending of documents
 269     if(m_pImpl->xMailDispatcher.is())
 270     {
 271         IterateMails();
 272     }
 273 }
 274
 275 IMPL_LINK( SwSendMailDialog, StopHdl_Impl, weld::Button&, rButton, void )
 276 {
 277     m_bCancel = true;
 278     if(m_pImpl->xMailDispatcher.is())
 279     {
 280         if(m_pImpl->xMailDispatcher->isStarted())
 281         {
 282             m_pImpl->xMailDispatcher->stop();
 283             rButton.set_label(m_sContinue);
 284             m_xPaused->show();
 285         }
 286         else
 287         {
 288             m_pImpl->xMailDispatcher->start();
 289             rButton.set_label(m_sStop);
 290             m_xPaused->hide();
 291         }
 292     }
 293 }
 294
 295 IMPL_LINK_NOARG(SwSendMailDialog, CloseHdl_Impl, weld::Button&, void)
 296 {
 297     m_xDialog->hide();
 298
 299     if (m_bDestructionEnabled)
 300         m_xDialog->response(RET_CANCEL);
 301     else
 302     {
 303         m_pImpl->aRemoveIdle.SetInvokeHandler( LINK( this, SwSendMailDialog, RemoveThis ) );
 304         m_pImpl->aRemoveIdle.Start();
 305     }
 306 }
 307
 308 IMPL_STATIC_LINK( SwSendMailDialog, StartSendMails, void*, pDialog, void )
 309 {
 310     static_cast<SwSendMailDialog*>(pDialog)->SendMails();
 311 }
 312
 313 IMPL_LINK( SwSendMailDialog, RemoveThis, Timer*, pTimer, void )
 314 {
 315     if( m_pImpl->xMailDispatcher.is() )
 316     {
 317         if(m_pImpl->xMailDispatcher->isStarted())
 318             m_pImpl->xMailDispatcher->stop();
 319         if(!m_pImpl->xMailDispatcher->isShutdownRequested())
 320             m_pImpl->xMailDispatcher->shutdown();
 321     }
 322
 323     if( m_bDestructionEnabled &&
 324             (!m_pImpl->xMailDispatcher.is() ||
 325                     !m_pImpl->xMailDispatcher->isRunning()))
 326     {
 327         m_xDialog->response(RET_CANCEL);
 328     }
 329     else
 330     {
 331         pTimer->Start();
 332     }
 333 }
 334
 335 IMPL_STATIC_LINK( SwSendMailDialog, StopSendMails, void*, p, void )
 336 {
 337     SwSendMailDialog* pDialog = static_cast<SwSendMailDialog*>(p);
 338     if(pDialog->m_pImpl->xMailDispatcher.is() &&
 339         pDialog->m_pImpl->xMailDispatcher->isStarted())
 340     {
 341         pDialog->m_pImpl->xMailDispatcher->stop();
 342         pDialog->m_xStop->set_label(pDialog->m_sContinue);
 343         pDialog->m_xPaused->show();
 344     }
 345 }
 346
 347 void SwSendMailDialog::SendMails()
 348 {
 349     if(!m_pConfigItem)
 350     {
 351         OSL_FAIL("config item not set");
 352         return;
 353     }
 354     auto xWait(std::make_unique<weld::WaitObject>(m_xDialog.get()));
 355     //get a mail server connection
 356     uno::Reference< mail::XSmtpService > xSmtpServer =
 357                 SwMailMergeHelper::ConnectToSmtpServer( *m_pConfigItem,
 358                                             m_pImpl->xConnectedInMailService,
 359                                             OUString(), OUString(), m_xDialog.get());
 360     bool bIsLoggedIn = xSmtpServer.is() && xSmtpServer->isConnected();
 361     xWait.reset();
 362     if(!bIsLoggedIn)
 363     {
 364         OSL_FAIL("create error message");
 365         return;
 366     }
 367     m_pImpl->xMailDispatcher.set( new MailDispatcher(xSmtpServer));
 368     IterateMails();
 369     m_pImpl->xMailListener = new SwMailDispatcherListener_Impl(*this);
 370     m_pImpl->xMailDispatcher->addListener(m_pImpl->xMailListener);
 371     if(!m_bCancel)
 372     {
 373         m_pImpl->xMailDispatcher->start();
 374     }
 375 }
 376
 377 void  SwSendMailDialog::IterateMails()
 378 {
 379     const SwMailDescriptor* pCurrentMailDescriptor = m_pImpl->GetNextDescriptor();
 380     while( pCurrentMailDescriptor )
 381     {
 382         if (!SwMailMergeHelper::CheckMailAddress( pCurrentMailDescriptor->sEMail))
 383         {
 384             OUString sMessage = m_sSendingTo;
 385             m_xStatus->append();
 386             m_xStatus->set_image(m_nSendCount, RID_BMP_FORMULA_CANCEL, 0);
 387             m_xStatus->set_text(m_nSendCount, sMessage.replaceFirst("%1", pCurrentMailDescriptor->sEMail), 1);
 388             m_xStatus->set_text(m_nSendCount, m_sFailed, 1);
 389             ++m_nSendCount;
 390             ++m_nErrorCount;
 391             UpdateTransferStatus( );
 392             pCurrentMailDescriptor = m_pImpl->GetNextDescriptor();
 393             continue;
 394         }
 395         SwMailMessage* pMessage = new SwMailMessage;
 396         uno::Reference< mail::XMailMessage > xMessage = pMessage;
 397         if(m_pConfigItem->IsMailReplyTo())
 398             pMessage->setReplyToAddress(m_pConfigItem->GetMailReplyTo());
 399         pMessage->addRecipient( pCurrentMailDescriptor->sEMail );
 400         pMessage->SetSenderName( m_pConfigItem->GetMailDisplayName() );
 401         pMessage->SetSenderAddress( m_pConfigItem->GetMailAddress() );
 402         if(!pCurrentMailDescriptor->sAttachmentURL.isEmpty())
 403         {
 404             mail::MailAttachment aAttach;
 405             aAttach.Data =
 406                     new SwMailTransferable(
 407                         pCurrentMailDescriptor->sAttachmentURL,
 408                         pCurrentMailDescriptor->sAttachmentName,
 409                         pCurrentMailDescriptor->sMimeType );
 410             aAttach.ReadableName = pCurrentMailDescriptor->sAttachmentName;
 411             pMessage->addAttachment( aAttach );
 412         }
 413         pMessage->setSubject( pCurrentMailDescriptor->sSubject );
 414         uno::Reference< datatransfer::XTransferable> xBody =
 415                     new SwMailTransferable(
 416                         pCurrentMailDescriptor->sBodyContent,
 417                         pCurrentMailDescriptor->sBodyMimeType);
 418         pMessage->setBody( xBody );
 419
 420         //CC and BCC are tokenized by ';'
 421         if(!pCurrentMailDescriptor->sCC.isEmpty())
 422         {
 423             sal_Int32 nPos = 0;
 424             do
 425             {
 426                 OUString sTmp = pCurrentMailDescriptor->sCC.getToken( 0, ';', nPos );
 427                 if( !sTmp.isEmpty() )
 428                     pMessage->addCcRecipient( sTmp );
 429             }
 430             while (nPos >= 0);
 431         }
 432         if(!pCurrentMailDescriptor->sBCC.isEmpty())
 433         {
 434             sal_Int32 nPos = 0;
 435             do
 436             {
 437                 OUString sTmp = pCurrentMailDescriptor->sBCC.getToken( 0, ';', nPos );
 438                 if( !sTmp.isEmpty() )
 439                     pMessage->addBccRecipient( sTmp );
 440             }
 441             while (nPos >= 0);
 442         }
 443         m_pImpl->xMailDispatcher->enqueueMailMessage( xMessage );
 444         pCurrentMailDescriptor = m_pImpl->GetNextDescriptor();
 445     }
 446     UpdateTransferStatus();
 447 }
 448
 449 void SwSendMailDialog::StartSend(sal_Int32 nExpectedCount)
 450 {
 451     Application::PostUserEvent( LINK( this, SwSendMailDialog,
 452                                       StartSendMails ), this );
 453     m_nExpectedCount = nExpectedCount > 0 ? nExpectedCount : 1;
 454 }
 455
 456 void SwSendMailDialog::DocumentSent( uno::Reference< mail::XMailMessage> const & xMessage,
 457                                         bool bResult,
 458                                         const OUString* pError )
 459 {
 460     //sending should stop on send errors
 461     if(pError &&
 462         m_pImpl->xMailDispatcher.is() && m_pImpl->xMailDispatcher->isStarted())
 463     {
 464         Application::PostUserEvent( LINK( this, SwSendMailDialog,
 465                                           StopSendMails ), this );
 466     }
 467     OUString sInsertImg(bResult ? OUString(RID_BMP_FORMULA_APPLY) : OUString(RID_BMP_FORMULA_CANCEL));
 468
 469     OUString sMessage = m_sSendingTo;
 470     m_xStatus->append();
 471     m_xStatus->set_image(m_nSendCount, sInsertImg, 0);
 472     m_xStatus->set_text(m_nSendCount, sMessage.replaceFirst("%1", xMessage->getRecipients()[0]), 1);
 473     m_xStatus->set_text(m_nSendCount, bResult ? m_sCompleted : m_sFailed, 1);
 474     ++m_nSendCount;
 475     if(!bResult)
 476         ++m_nErrorCount;
 477
 478     UpdateTransferStatus( );
 479
 480     if (pError)
 481     {
 482         SwSendWarningBox_Impl aDlg(m_xDialog.get(), *pError);
 483         aDlg.run();
 484     }
 485 }
 486
 487 void SwSendMailDialog::UpdateTransferStatus()
 488 {
 489     OUString sStatus( m_sTransferStatus );
 490     sStatus = sStatus.replaceFirst("%1", OUString::number(m_nSendCount) );
 491     sStatus = sStatus.replaceFirst("%2", OUString::number(m_nExpectedCount));
 492     m_xTransferStatus->set_label(sStatus);
 493
 494     sStatus = m_sErrorStatus.replaceFirst("%1", OUString::number(m_nErrorCount) );
 495     m_xErrorStatus->set_label(sStatus);
 496
 497     if (!m_pImpl->aDescriptors.empty())
 498     {
 499         assert(m_nExpectedCount && "div-by-zero");
 500         m_xProgressBar->set_percentage(m_nSendCount * 100 / m_nExpectedCount);
 501     }
 502     else
 503         m_xProgressBar->set_percentage(0);
 504 }
 505
 506 void SwSendMailDialog::AllMailsSent()
 507 {
 508     // Leave open if some kind of error occurred
 509     if (m_nSendCount == m_nExpectedCount)
 510     {
 511         m_xStop->set_sensitive(false);
 512         m_xDialog->hide();
 513         m_xDialog->response(RET_CANCEL);
 514     }
 515 }
 516
 517 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */