fpicker/source/win32/filepicker/VistaFilePicker.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 "VistaFilePicker.hxx"
  21
  22 #include "../misc/WinImplHelper.hxx"
  23 #include "shared.hxx"
  24
  25 #include <com/sun/star/awt/XWindow.hpp>
  26 #include <com/sun/star/lang/DisposedException.hpp>
  27 #include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
  28 #include <com/sun/star/ui/dialogs/XFilePickerNotifier.hpp>
  29 #include <com/sun/star/ui/dialogs/XFilePickerListener.hpp>
  30 #include <com/sun/star/ui/dialogs/ExecutableDialogResults.hpp>
  31
  32 #include <cppuhelper/interfacecontainer.h>
  33 #include <cppuhelper/supportsservice.hxx>
  34 #include <comphelper/processfactory.hxx>
  35 #include <osl/mutex.hxx>
  36 #include <osl/file.hxx>
  37 #include <officecfg/Office/Common.hxx>
  38
  39 #include <shlobj.h>
  40
  41 namespace fpicker{
  42 namespace win32{
  43 namespace vista{
  44
  45 namespace
  46 {
  47     css::uno::Sequence< OUString > VistaFilePicker_getSupportedServiceNames()
  48     {
  49         css::uno::Sequence< OUString > aRet(2);
  50         aRet[0] = "com.sun.star.ui.dialogs.FilePicker";
  51         aRet[1] = "com.sun.star.ui.dialogs.SystemFilePicker";
  52         return aRet;
  53     }
  54 }
  55
  56 VistaFilePicker::VistaFilePicker(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR)
  57     : TVistaFilePickerBase  (m_aMutex                 )
  58     , m_xSMGR               (xSMGR                    )
  59     , m_rDialog             (new VistaFilePickerImpl())
  60     , m_aAsyncExecute       (m_rDialog                )
  61     , m_nFilePickerThreadId (0                        )
  62     , m_bInitialized        (false                    )
  63 {
  64 }
  65
  66 VistaFilePicker::~VistaFilePicker()
  67 {
  68 }
  69
  70 void SAL_CALL VistaFilePicker::addFilePickerListener(const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener)
  71 {
  72     RequestRef rRequest(new Request());
  73     rRequest->setRequest (VistaFilePickerImpl::E_ADD_PICKER_LISTENER);
  74     rRequest->setArgument(PROP_PICKER_LISTENER, xListener);
  75
  76     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
  77 }
  78
  79 void SAL_CALL VistaFilePicker::removeFilePickerListener(const css::uno::Reference< css::ui::dialogs::XFilePickerListener >& xListener )
  80 {
  81     RequestRef rRequest(new Request());
  82     rRequest->setRequest (VistaFilePickerImpl::E_REMOVE_PICKER_LISTENER);
  83     rRequest->setArgument(PROP_PICKER_LISTENER, xListener);
  84
  85     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
  86 }
  87
  88 void VistaFilePicker::disposing(const css::lang::EventObject& /*aEvent*/)
  89 {
  90 }
  91
  92 void SAL_CALL VistaFilePicker::setMultiSelectionMode(sal_Bool bMode)
  93 {
  94     ensureInit();
  95
  96     RequestRef rRequest(new Request());
  97     rRequest->setRequest (VistaFilePickerImpl::E_SET_MULTISELECTION_MODE);
  98     rRequest->setArgument(PROP_MULTISELECTION_MODE, bMode);
  99
 100     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 101 }
 102
 103 void SAL_CALL VistaFilePicker::setTitle(const OUString& sTitle)
 104 {
 105     ensureInit();
 106
 107     RequestRef rRequest(new Request());
 108     rRequest->setRequest (VistaFilePickerImpl::E_SET_TITLE);
 109     rRequest->setArgument(PROP_TITLE, sTitle);
 110
 111     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 112 }
 113
 114 void SAL_CALL VistaFilePicker::appendFilter(const OUString& sTitle ,
 115                                             const OUString& sFilter)
 116 {
 117     RequestRef rRequest(new Request());
 118     rRequest->setRequest (VistaFilePickerImpl::E_APPEND_FILTER);
 119     rRequest->setArgument(PROP_FILTER_TITLE, sTitle );
 120     rRequest->setArgument(PROP_FILTER_VALUE, sFilter);
 121
 122     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 123 }
 124
 125 void SAL_CALL VistaFilePicker::setCurrentFilter(const OUString& sTitle)
 126 {
 127     RequestRef rRequest(new Request());
 128     rRequest->setRequest (VistaFilePickerImpl::E_SET_CURRENT_FILTER);
 129     rRequest->setArgument(PROP_FILTER_TITLE, sTitle);
 130
 131     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 132 }
 133
 134 OUString SAL_CALL VistaFilePicker::getCurrentFilter()
 135 {
 136     RequestRef rRequest(new Request());
 137     rRequest->setRequest (VistaFilePickerImpl::E_GET_CURRENT_FILTER);
 138
 139     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::BLOCKED);
 140
 141     const  OUString sTitle = rRequest->getArgumentOrDefault(PROP_FILTER_TITLE, OUString());
 142     return sTitle;
 143 }
 144
 145 void SAL_CALL VistaFilePicker::appendFilterGroup(const OUString&                              /*sGroupTitle*/,
 146                                                  const css::uno::Sequence< css::beans::StringPair >& rFilters   )
 147 {
 148     RequestRef rRequest(new Request());
 149     rRequest->setRequest (VistaFilePickerImpl::E_APPEND_FILTERGROUP);
 150     rRequest->setArgument(PROP_FILTER_GROUP, rFilters);
 151
 152     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 153 }
 154
 155 void SAL_CALL VistaFilePicker::setDefaultName(const OUString& sName )
 156 {
 157     ensureInit();
 158
 159     RequestRef rRequest(new Request());
 160     rRequest->setRequest (VistaFilePickerImpl::E_SET_DEFAULT_NAME);
 161     rRequest->setArgument(PROP_FILENAME, sName);
 162
 163     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 164 }
 165
 166 void SAL_CALL VistaFilePicker::setDisplayDirectory(const OUString& sDirectory)
 167 {
 168     ensureInit();
 169
 170     bool bChanged = officecfg::Office::Common::Path::Info::WorkPathChanged::get(
 171         comphelper::getComponentContext(m_xSMGR));
 172     if (bChanged )
 173     {
 174         std::shared_ptr< comphelper::ConfigurationChanges > batch(
 175             comphelper::ConfigurationChanges::create(
 176                 comphelper::getComponentContext(m_xSMGR)));
 177         officecfg::Office::Common::Path::Info::WorkPathChanged::set(
 178             false, batch);
 179         batch->commit();
 180     }
 181
 182     RequestRef rRequest(new Request());
 183     rRequest->setRequest (VistaFilePickerImpl::E_SET_DIRECTORY);
 184     rRequest->setArgument(PROP_DIRECTORY, sDirectory);
 185     rRequest->setArgument(PROP_FORCE, bChanged);
 186
 187     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 188 }
 189
 190 OUString SAL_CALL VistaFilePicker::getDisplayDirectory()
 191 {
 192     ensureInit();
 193
 194     RequestRef rRequest(new Request());
 195     rRequest->setRequest (VistaFilePickerImpl::E_GET_DIRECTORY);
 196     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::BLOCKED);
 197     const OUString sDirectory = rRequest->getArgumentOrDefault(PROP_DIRECTORY, OUString());
 198
 199     return sDirectory;
 200 }
 201
 202 // @deprecated can't be supported any longer ... see IDL description for further details
 203 css::uno::Sequence< OUString > SAL_CALL VistaFilePicker::getFiles()
 204 {
 205     css::uno::Sequence< OUString > lFiles = getSelectedFiles();
 206     // multiselection doesn't really work
 207     // so just retrieve the first url
 208     if (lFiles.getLength() > 1)
 209         lFiles.realloc(1);
 210     m_lLastFiles = lFiles;
 211     return lFiles;
 212 }
 213
 214 css::uno::Sequence< OUString > SAL_CALL VistaFilePicker::getSelectedFiles()
 215 {
 216     RequestRef rRequest(new Request());
 217     rRequest->setRequest (VistaFilePickerImpl::E_GET_SELECTED_FILES);
 218
 219     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::BLOCKED);
 220
 221     const  css::uno::Sequence< OUString > lFiles = rRequest->getArgumentOrDefault(PROP_SELECTED_FILES, css::uno::Sequence< OUString >());
 222     m_lLastFiles = lFiles;
 223     return lFiles;
 224 }
 225
 226 void VistaFilePicker::ensureInit()
 227 {
 228     bool bInitialized(false);
 229     {
 230         osl::MutexGuard aGuard(m_aMutex);
 231         bInitialized = m_bInitialized;
 232     }
 233
 234     if ( !bInitialized )
 235     {
 236         css::uno::Sequence < css::uno::Any > aInitArguments(1);
 237         aInitArguments[0] <<= css::ui::dialogs::TemplateDescription::FILEOPEN_SIMPLE;
 238         initialize(aInitArguments);
 239     }
 240 }
 241
 242 ::sal_Int16 SAL_CALL VistaFilePicker::execute()
 243 {
 244     ensureInit();
 245
 246     RequestRef rRequest(new Request());
 247     rRequest->setRequest (VistaFilePickerImpl::E_SHOW_DIALOG_MODAL);
 248
 249     // if we want to show a modal window, the calling thread needs to process messages
 250     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::PROCESS_MESSAGES);
 251
 252     const bool bOK          = rRequest->getArgumentOrDefault(PROP_DIALOG_SHOW_RESULT, false );
 253                      m_lLastFiles = rRequest->getArgumentOrDefault(PROP_SELECTED_FILES    , css::uno::Sequence< OUString >());
 254
 255     ::sal_Int16 nResult = css::ui::dialogs::ExecutableDialogResults::CANCEL;
 256     if (bOK)
 257         nResult = css::ui::dialogs::ExecutableDialogResults::OK;
 258     return nResult;
 259 }
 260
 261 // XFilePicker
 262
 263 void SAL_CALL VistaFilePicker::setValue(      ::sal_Int16    nControlId    ,
 264                                               ::sal_Int16    nControlAction,
 265                                         const css::uno::Any& aValue        )
 266 {
 267     RequestRef rRequest(new Request());
 268     rRequest->setRequest (VistaFilePickerImpl::E_SET_CONTROL_VALUE);
 269     rRequest->setArgument(PROP_CONTROL_ID    , nControlId    );
 270     rRequest->setArgument(PROP_CONTROL_ACTION, nControlAction);
 271     rRequest->setArgument(PROP_CONTROL_VALUE , aValue        );
 272
 273     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 274 }
 275
 276 css::uno::Any SAL_CALL VistaFilePicker::getValue(::sal_Int16 nControlId    ,
 277                                                  ::sal_Int16 nControlAction)
 278 {
 279     RequestRef rRequest(new Request());
 280     rRequest->setRequest (VistaFilePickerImpl::E_GET_CONTROL_VALUE);
 281     rRequest->setArgument(PROP_CONTROL_ID    , nControlId    );
 282     rRequest->setArgument(PROP_CONTROL_ACTION, nControlAction);
 283
 284     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::BLOCKED);
 285     return rRequest->getValue(PROP_CONTROL_VALUE);
 286 }
 287
 288 void SAL_CALL VistaFilePicker::enableControl(::sal_Int16 nControlId,
 289                                              sal_Bool  bEnable   )
 290 {
 291     RequestRef rRequest(new Request());
 292     rRequest->setRequest (VistaFilePickerImpl::E_ENABLE_CONTROL);
 293     rRequest->setArgument(PROP_CONTROL_ID    , nControlId);
 294     rRequest->setArgument(PROP_CONTROL_ENABLE, bEnable   );
 295
 296     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 297 }
 298
 299 void SAL_CALL VistaFilePicker::setLabel(      ::sal_Int16      nControlId,
 300                                          const OUString& sLabel    )
 301 {
 302     RequestRef rRequest(new Request());
 303     rRequest->setRequest (VistaFilePickerImpl::E_SET_CONTROL_LABEL);
 304     rRequest->setArgument(PROP_CONTROL_ID   , nControlId);
 305     rRequest->setArgument(PROP_CONTROL_LABEL, sLabel    );
 306
 307     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 308 }
 309
 310 OUString SAL_CALL VistaFilePicker::getLabel(::sal_Int16 nControlId)
 311 {
 312     RequestRef rRequest(new Request());
 313     rRequest->setRequest (VistaFilePickerImpl::E_GET_CONTROL_LABEL);
 314     rRequest->setArgument(PROP_CONTROL_ID, nControlId);
 315
 316     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::BLOCKED);
 317     const OUString sLabel = rRequest->getArgumentOrDefault(PROP_CONTROL_LABEL, OUString());
 318     return sLabel;
 319 }
 320
 321 css::uno::Sequence< ::sal_Int16 > SAL_CALL VistaFilePicker::getSupportedImageFormats()
 322 {
 323     return css::uno::Sequence< sal_Int16 >();
 324 }
 325
 326 sal_Int32 SAL_CALL VistaFilePicker::getTargetColorDepth()
 327 {
 328     return 0;
 329 }
 330
 331 sal_Int32 SAL_CALL VistaFilePicker::getAvailableWidth()
 332 {
 333     return 0;
 334 }
 335
 336 sal_Int32 SAL_CALL VistaFilePicker::getAvailableHeight()
 337 {
 338     return 0;
 339 }
 340
 341 void SAL_CALL VistaFilePicker::setImage(      sal_Int16      /*nImageFormat*/,
 342                                          const css::uno::Any& /*aImage      */)
 343 {
 344 }
 345
 346 sal_Bool SAL_CALL VistaFilePicker::setShowState(sal_Bool /*bShowState*/)
 347 {
 348     return false;
 349 }
 350
 351 sal_Bool SAL_CALL VistaFilePicker::getShowState()
 352 {
 353     return false;
 354 }
 355
 356 void SAL_CALL VistaFilePicker::initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
 357 {
 358     if (lArguments.getLength() < 1)
 359         throw css::lang::IllegalArgumentException(
 360                 "XInitialization::initialize() called without arguments.",
 361                 static_cast< css::ui::dialogs::XFilePicker2* >( this ),
 362                 1);
 363
 364     sal_Int32         nTemplate = -1;
 365     lArguments[0] >>= nTemplate;
 366
 367     bool bFileOpenDialog = true;
 368     ::sal_Int32 nFeatures       = 0;
 369
 370     switch(nTemplate)
 371     {
 372         case css::ui::dialogs::TemplateDescription::FILEOPEN_SIMPLE :
 373         {
 374             bFileOpenDialog = true;
 375         }
 376         break;
 377
 378         case css::ui::dialogs::TemplateDescription::FILESAVE_SIMPLE :
 379         {
 380             bFileOpenDialog = false;
 381         }
 382         break;
 383
 384         case css::ui::dialogs::TemplateDescription::FILESAVE_AUTOEXTENSION_PASSWORD :
 385         {
 386             bFileOpenDialog  = false;
 387             nFeatures        |= FEATURE_AUTOEXTENSION;
 388             nFeatures        |= FEATURE_PASSWORD;
 389             nFeatures        |= FEATURE_GPGPASSWORD;
 390         }
 391         break;
 392
 393         case css::ui::dialogs::TemplateDescription::FILESAVE_AUTOEXTENSION_PASSWORD_FILTEROPTIONS :
 394         {
 395             bFileOpenDialog = false;
 396             nFeatures        |= FEATURE_AUTOEXTENSION;
 397             nFeatures        |= FEATURE_PASSWORD;
 398             nFeatures        |= FEATURE_FILTEROPTIONS;
 399             nFeatures        |= FEATURE_GPGPASSWORD;
 400         }
 401         break;
 402
 403         case css::ui::dialogs::TemplateDescription::FILESAVE_AUTOEXTENSION_SELECTION :
 404         {
 405             bFileOpenDialog  = false;
 406             nFeatures        |= FEATURE_AUTOEXTENSION;
 407             nFeatures        |= FEATURE_SELECTION;
 408         }
 409         break;
 410
 411         case css::ui::dialogs::TemplateDescription::FILESAVE_AUTOEXTENSION_TEMPLATE :
 412         {
 413             bFileOpenDialog  = false;
 414             nFeatures        |= FEATURE_AUTOEXTENSION;
 415             nFeatures        |= FEATURE_TEMPLATE;
 416         }
 417         break;
 418
 419         case css::ui::dialogs::TemplateDescription::FILEOPEN_LINK_PREVIEW_IMAGE_TEMPLATE :
 420         {
 421             bFileOpenDialog  = true;
 422             nFeatures        |= FEATURE_LINK;
 423             nFeatures        |= FEATURE_PREVIEW;
 424             nFeatures        |= FEATURE_IMAGETEMPLATE;
 425         }
 426         break;
 427
 428         case css::ui::dialogs::TemplateDescription::FILEOPEN_LINK_PREVIEW_IMAGE_ANCHOR :
 429         {
 430             bFileOpenDialog  = true;
 431             nFeatures        |= FEATURE_LINK;
 432             nFeatures        |= FEATURE_PREVIEW;
 433             nFeatures        |= FEATURE_IMAGEANCHOR;
 434         }
 435         break;
 436
 437         case css::ui::dialogs::TemplateDescription::FILEOPEN_PLAY :
 438         {
 439             bFileOpenDialog  = true;
 440             nFeatures        |= FEATURE_PLAY;
 441         }
 442         break;
 443
 444         case css::ui::dialogs::TemplateDescription::FILEOPEN_LINK_PLAY :
 445         {
 446             bFileOpenDialog  = true;
 447             nFeatures        |= FEATURE_LINK;
 448             nFeatures        |= FEATURE_PLAY;
 449         }
 450         break;
 451
 452         case css::ui::dialogs::TemplateDescription::FILEOPEN_READONLY_VERSION :
 453         {
 454             bFileOpenDialog  = true;
 455             nFeatures        |= FEATURE_READONLY;
 456             nFeatures        |= FEATURE_VERSION;
 457         }
 458         break;
 459
 460         case css::ui::dialogs::TemplateDescription::FILEOPEN_LINK_PREVIEW :
 461         {
 462             bFileOpenDialog  = true;
 463             nFeatures        |= FEATURE_LINK;
 464             nFeatures        |= FEATURE_PREVIEW;
 465         }
 466         break;
 467
 468         case css::ui::dialogs::TemplateDescription::FILESAVE_AUTOEXTENSION :
 469         {
 470             bFileOpenDialog  = false;
 471             nFeatures        |= FEATURE_AUTOEXTENSION;
 472         }
 473         break;
 474
 475         case css::ui::dialogs::TemplateDescription::FILEOPEN_PREVIEW :
 476         {
 477             bFileOpenDialog  = true;
 478             nFeatures        |= FEATURE_PREVIEW;
 479         }
 480         break;
 481     }
 482     css::uno::Reference<css::awt::XWindow> xParentWindow;
 483     if(lArguments.getLength() > 1)
 484     {
 485         lArguments[1] >>= xParentWindow;
 486     }
 487     RequestRef rRequest(new Request());
 488     if (bFileOpenDialog)
 489         rRequest->setRequest (VistaFilePickerImpl::E_CREATE_OPEN_DIALOG);
 490     else
 491         rRequest->setRequest (VistaFilePickerImpl::E_CREATE_SAVE_DIALOG);
 492     rRequest->setArgument(PROP_FEATURES, nFeatures);
 493     rRequest->setArgument(PROP_TEMPLATE_DESCR, nTemplate);
 494     if(xParentWindow.is())
 495         rRequest->setArgument(PROP_PARENT_WINDOW, xParentWindow);
 496     if ( ! m_aAsyncExecute.isRunning())
 497         m_aAsyncExecute.create();
 498     m_aAsyncExecute.triggerRequestThreadAware(rRequest, AsyncRequests::NON_BLOCKED);
 499
 500     {
 501         osl::MutexGuard aGuard(m_aMutex);
 502         m_bInitialized = true;
 503     }
 504 }
 505
 506 void SAL_CALL VistaFilePicker::cancel()
 507 {
 508 }
 509
 510 // XServiceInfo
 511
 512 OUString SAL_CALL VistaFilePicker::getImplementationName()
 513 {
 514     return OUString("com.sun.star.comp.fpicker.VistaFileDialog");
 515 }
 516
 517 sal_Bool SAL_CALL VistaFilePicker::supportsService(const OUString& sServiceName)
 518 {
 519     return cppu::supportsService(this, sServiceName);
 520 }
 521
 522 css::uno::Sequence< OUString > SAL_CALL VistaFilePicker::getSupportedServiceNames()
 523 {
 524     return VistaFilePicker_getSupportedServiceNames();
 525 }
 526
 527 } // namespace vista
 528 } // namespace win32
 529 } // namespace fpicker
 530
 531 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */