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