shell/source/win32/SysShExec.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 <algorithm>
  21
  22 #include <osl/diagnose.h>
  23 #include "SysShExec.hxx"
  24 #include <osl/file.hxx>
  25 #include <sal/macros.h>
  26
  27 #include <com/sun/star/system/SystemShellExecuteFlags.hpp>
  28 #include <com/sun/star/uri/UriReferenceFactory.hpp>
  29 #include <cppuhelper/supportsservice.hxx>
  30
  31 #define WIN32_LEAN_AND_MEAN
  32 #if defined _MSC_VER
  33 #pragma warning(push, 1)
  34 #endif
  35 #include <windows.h>
  36 #include <shellapi.h>
  37 #include <objbase.h>
  38 #if defined _MSC_VER
  39 #pragma warning(pop)
  40 #endif
  41
  42
  43 // namespace directives
  44
  45
  46 using com::sun::star::uno::Reference;
  47 using com::sun::star::uno::RuntimeException;
  48 using com::sun::star::uno::Sequence;
  49 using com::sun::star::uno::XInterface;
  50 using com::sun::star::lang::EventObject;
  51 using com::sun::star::lang::XServiceInfo;
  52 using com::sun::star::lang::IllegalArgumentException;
  53 using osl::Mutex;
  54 using com::sun::star::system::XSystemShellExecute;
  55 using com::sun::star::system::SystemShellExecuteException;
  56
  57 using namespace ::com::sun::star::system::SystemShellExecuteFlags;
  58 using namespace cppu;
  59
  60 #define SYSSHEXEC_IMPL_NAME  "com.sun.star.sys.shell.SystemShellExecute"
  61
  62
  63 // helper functions
  64
  65
  66 namespace // private
  67 {
  68     Sequence< OUString > SAL_CALL SysShExec_getSupportedServiceNames()
  69     {
  70         Sequence< OUString > aRet(1);
  71         aRet[0] = "com.sun.star.system.SystemShellExecute";
  72         return aRet;
  73     }
  74
  75     /* This is the error table that defines the mapping between OS error
  76     codes and errno values */
  77
  78     struct errentry {
  79         unsigned long oscode;   /* OS return value */
  80         int errnocode;          /* System V error code */
  81     };
  82
  83     struct errentry errtable[] = {
  84         {  ERROR_SUCCESS,                osl_File_E_None     },  /* 0 */
  85         {  ERROR_INVALID_FUNCTION,       osl_File_E_INVAL    },  /* 1 */
  86         {  ERROR_FILE_NOT_FOUND,         osl_File_E_NOENT    },  /* 2 */
  87         {  ERROR_PATH_NOT_FOUND,         osl_File_E_NOENT    },  /* 3 */
  88         {  ERROR_TOO_MANY_OPEN_FILES,    osl_File_E_MFILE    },  /* 4 */
  89         {  ERROR_ACCESS_DENIED,          osl_File_E_ACCES    },  /* 5 */
  90         {  ERROR_INVALID_HANDLE,         osl_File_E_BADF     },  /* 6 */
  91         {  ERROR_ARENA_TRASHED,          osl_File_E_NOMEM    },  /* 7 */
  92         {  ERROR_NOT_ENOUGH_MEMORY,      osl_File_E_NOMEM    },  /* 8 */
  93         {  ERROR_INVALID_BLOCK,          osl_File_E_NOMEM    },  /* 9 */
  94         {  ERROR_BAD_ENVIRONMENT,        osl_File_E_2BIG     },  /* 10 */
  95         {  ERROR_BAD_FORMAT,             osl_File_E_NOEXEC   },  /* 11 */
  96         {  ERROR_INVALID_ACCESS,         osl_File_E_INVAL    },  /* 12 */
  97         {  ERROR_INVALID_DATA,           osl_File_E_INVAL    },  /* 13 */
  98         {  ERROR_INVALID_DRIVE,          osl_File_E_NOENT    },  /* 15 */
  99         {  ERROR_CURRENT_DIRECTORY,      osl_File_E_ACCES    },  /* 16 */
 100         {  ERROR_NOT_SAME_DEVICE,        osl_File_E_XDEV     },  /* 17 */
 101         {  ERROR_NO_MORE_FILES,          osl_File_E_NOENT    },  /* 18 */
 102         {  ERROR_LOCK_VIOLATION,         osl_File_E_ACCES    },  /* 33 */
 103         {  ERROR_BAD_NETPATH,            osl_File_E_NOENT    },  /* 53 */
 104         {  ERROR_NETWORK_ACCESS_DENIED,  osl_File_E_ACCES    },  /* 65 */
 105         {  ERROR_BAD_NET_NAME,           osl_File_E_NOENT    },  /* 67 */
 106         {  ERROR_FILE_EXISTS,            osl_File_E_EXIST    },  /* 80 */
 107         {  ERROR_CANNOT_MAKE,            osl_File_E_ACCES    },  /* 82 */
 108         {  ERROR_FAIL_I24,               osl_File_E_ACCES    },  /* 83 */
 109         {  ERROR_INVALID_PARAMETER,      osl_File_E_INVAL    },  /* 87 */
 110         {  ERROR_NO_PROC_SLOTS,          osl_File_E_AGAIN    },  /* 89 */
 111         {  ERROR_DRIVE_LOCKED,           osl_File_E_ACCES    },  /* 108 */
 112         {  ERROR_BROKEN_PIPE,            osl_File_E_PIPE     },  /* 109 */
 113         {  ERROR_DISK_FULL,              osl_File_E_NOSPC    },  /* 112 */
 114         {  ERROR_INVALID_TARGET_HANDLE,  osl_File_E_BADF     },  /* 114 */
 115         {  ERROR_INVALID_HANDLE,         osl_File_E_INVAL    },  /* 124 */
 116         {  ERROR_WAIT_NO_CHILDREN,       osl_File_E_CHILD    },  /* 128 */
 117         {  ERROR_CHILD_NOT_COMPLETE,     osl_File_E_CHILD    },  /* 129 */
 118         {  ERROR_DIRECT_ACCESS_HANDLE,   osl_File_E_BADF     },  /* 130 */
 119         {  ERROR_NEGATIVE_SEEK,          osl_File_E_INVAL    },  /* 131 */
 120         {  ERROR_SEEK_ON_DEVICE,         osl_File_E_ACCES    },  /* 132 */
 121         {  ERROR_DIR_NOT_EMPTY,          osl_File_E_NOTEMPTY },  /* 145 */
 122         {  ERROR_NOT_LOCKED,             osl_File_E_ACCES    },  /* 158 */
 123         {  ERROR_BAD_PATHNAME,           osl_File_E_NOENT    },  /* 161 */
 124         {  ERROR_MAX_THRDS_REACHED,      osl_File_E_AGAIN    },  /* 164 */
 125         {  ERROR_LOCK_FAILED,            osl_File_E_ACCES    },  /* 167 */
 126         {  ERROR_ALREADY_EXISTS,         osl_File_E_EXIST    },  /* 183 */
 127         {  ERROR_FILENAME_EXCED_RANGE,   osl_File_E_NOENT    },  /* 206 */
 128         {  ERROR_NESTING_NOT_ALLOWED,    osl_File_E_AGAIN    },  /* 215 */
 129         {  ERROR_NOT_ENOUGH_QUOTA,       osl_File_E_NOMEM    }    /* 1816 */
 130     };
 131
 132     /* size of the table */
 133     #define ERRTABLESIZE (SAL_N_ELEMENTS(errtable))
 134
 135     /* The following two constants must be the minimum and maximum
 136     values in the (contiguous) range of osl_File_E_xec Failure errors. */
 137     #define MIN_EXEC_ERROR ERROR_INVALID_STARTING_CODESEG
 138     #define MAX_EXEC_ERROR ERROR_INFLOOP_IN_RELOC_CHAIN
 139
 140     /* These are the low and high value in the range of errors that are
 141     access violations */
 142     #define MIN_EACCES_RANGE ERROR_WRITE_PROTECT
 143     #define MAX_EACCES_RANGE ERROR_SHARING_BUFFER_EXCEEDED
 144
 145
 146     /*******************************************************************************/
 147
 148     oslFileError _mapError( DWORD dwError )
 149     {
 150         unsigned i;
 151
 152         /* check the table for the OS error code */
 153         for ( i = 0; i < ERRTABLESIZE; ++i )
 154         {
 155             if ( dwError == errtable[i].oscode )
 156                 return (oslFileError)errtable[i].errnocode;
 157         }
 158
 159         /* The error code wasn't in the table.  We check for a range of */
 160         /* osl_File_E_ACCES errors or exec failure errors (ENOEXEC).  Otherwise   */
 161         /* osl_File_E_INVAL is returned.                                          */
 162
 163         if ( dwError >= MIN_EACCES_RANGE && dwError <= MAX_EACCES_RANGE)
 164             return osl_File_E_ACCES;
 165         else if ( dwError >= MIN_EXEC_ERROR && dwError <= MAX_EXEC_ERROR)
 166             return osl_File_E_NOEXEC;
 167         else
 168             return osl_File_E_INVAL;
 169     }
 170
 171     #define MapError( oserror ) _mapError( oserror )
 172
 173     #define E_UNKNOWN_EXEC_ERROR -1
 174
 175
 176
 177     bool is_system_path(const OUString& path_or_uri)
 178     {
 179         OUString url;
 180         osl::FileBase::RC rc = osl::FileBase::getFileURLFromSystemPath(path_or_uri, url);
 181         return (rc == osl::FileBase::E_None);
 182     }
 183
 184
 185     // trying to identify a jump mark
 186
 187
 188     const OUString    JUMP_MARK_HTM(".htm#");
 189     const OUString    JUMP_MARK_HTML(".html#");
 190     const sal_Unicode HASH_MARK      = (sal_Unicode)'#';
 191
 192     bool has_jump_mark(const OUString& system_path, sal_Int32* jmp_mark_start = NULL)
 193     {
 194         sal_Int32 jmp_mark = std::max<int>(
 195             system_path.lastIndexOf(JUMP_MARK_HTM),
 196             system_path.lastIndexOf(JUMP_MARK_HTML));
 197
 198         if (jmp_mark_start)
 199             *jmp_mark_start = jmp_mark;
 200
 201         return (jmp_mark > -1);
 202     }
 203
 204
 205
 206     bool is_existing_file(const OUString& file_name)
 207     {
 208         OSL_ASSERT(is_system_path(file_name));
 209
 210         bool exist = false;
 211
 212         OUString file_url;
 213         osl::FileBase::RC rc = osl::FileBase::getFileURLFromSystemPath(file_name, file_url);
 214
 215         if (osl::FileBase::E_None == rc)
 216         {
 217             osl::DirectoryItem dir_item;
 218             rc = osl::DirectoryItem::get(file_url, dir_item);
 219             exist = (osl::FileBase::E_None == rc);
 220         }
 221         return exist;
 222     }
 223
 224
 225     // Jump marks in file urls are illegal.
 226
 227
 228     void remove_jump_mark(OUString* p_command)
 229     {
 230         OSL_PRECOND(p_command, "invalid parameter");
 231
 232         sal_Int32 pos;
 233         if (has_jump_mark(*p_command, &pos))
 234         {
 235             const sal_Unicode* p_jmp_mark = p_command->getStr() + pos;
 236             while (*p_jmp_mark && (*p_jmp_mark != HASH_MARK))
 237                 p_jmp_mark++;
 238
 239             *p_command = OUString(p_command->getStr(), p_jmp_mark - p_command->getStr());
 240         }
 241     }
 242
 243 } // end namespace
 244
 245
 246
 247 CSysShExec::CSysShExec( const Reference< css::uno::XComponentContext >& xContext ) :
 248     WeakComponentImplHelper2< XSystemShellExecute, XServiceInfo >( m_aMutex ),
 249     m_xContext(xContext)
 250 {
 251     /*
 252      * As this service is declared thread-affine, it is ensured to be called from a
 253      * dedicated thread, so initialize COM here.
 254      *
 255      * We need COM to be initialized for STA, but osl thread get initialized for MTA.
 256      * Once this changed, we can remove the uninitialize call.
 257      */
 258     CoUninitialize();
 259     CoInitialize( NULL );
 260 }
 261
 262
 263
 264 void SAL_CALL CSysShExec::execute( const OUString& aCommand, const OUString& aParameter, sal_Int32 nFlags )
 265         throw (IllegalArgumentException, SystemShellExecuteException, RuntimeException)
 266 {
 267     // parameter checking
 268     if (0 == aCommand.getLength())
 269         throw IllegalArgumentException(
 270             "Empty command",
 271             static_cast< XSystemShellExecute* >( this ),
 272             1 );
 273
 274     if ((nFlags & ~(NO_SYSTEM_ERROR_MESSAGE | URIS_ONLY)) != 0)
 275         throw IllegalArgumentException(
 276             "Invalid Flags specified",
 277             static_cast< XSystemShellExecute* >( this ),
 278             3 );
 279
 280     if ((nFlags & URIS_ONLY) != 0)
 281     {
 282         css::uno::Reference< css::uri::XUriReference > uri(
 283             css::uri::UriReferenceFactory::create(m_xContext)->parse(aCommand));
 284         if (!(uri.is() && uri->isAbsolute()))
 285         {
 286             throw css::lang::IllegalArgumentException(
 287                 OUString("XSystemShellExecute.execute URIS_ONLY with"
 288                          " non-absolute URI reference ")
 289                  + aCommand,
 290                 static_cast< cppu::OWeakObject * >(this), 0);
 291         }
 292     }
 293
 294     /*  #i4789#; jump mark detection on system paths
 295         if the given command is a system path (not http or
 296         other uri schemes) and seems to have a jump mark
 297         and names no existing file (remember the jump mark
 298         sign '#' is a valid file name character we remove
 299         the jump mark, else ShellExecuteEx fails */
 300     OUString preprocessed_command(aCommand);
 301     if (is_system_path(preprocessed_command))
 302     {
 303         if (has_jump_mark(preprocessed_command) && !is_existing_file(preprocessed_command))
 304             remove_jump_mark(&preprocessed_command);
 305     }
 306     /* Convert file uris to system paths */
 307     else
 308     {
 309         OUString aSystemPath;
 310         if (::osl::FileBase::E_None == ::osl::FileBase::getSystemPathFromFileURL(preprocessed_command, aSystemPath))
 311             preprocessed_command = aSystemPath;
 312     }
 313
 314     SHELLEXECUTEINFOW sei;
 315     ZeroMemory(&sei, sizeof( sei));
 316
 317     sei.cbSize       = sizeof(sei);
 318     sei.lpFile       = reinterpret_cast<LPCWSTR>(preprocessed_command.getStr());
 319     sei.lpParameters = reinterpret_cast<LPCWSTR>(aParameter.getStr());
 320     sei.nShow        = SW_SHOWNORMAL;
 321
 322     if (NO_SYSTEM_ERROR_MESSAGE & nFlags)
 323         sei.fMask = SEE_MASK_FLAG_NO_UI;
 324
 325     SetLastError( 0 );
 326
 327     sal_Bool bRet = ShellExecuteExW(&sei) ? sal_True : sal_False;
 328
 329     if (!bRet && (nFlags & NO_SYSTEM_ERROR_MESSAGE))
 330     {
 331         // ShellExecuteEx fails to set an error code
 332         // we return osl_File_E_INVAL
 333         sal_Int32 psxErr = GetLastError();
 334         if (ERROR_SUCCESS == psxErr)
 335             psxErr = E_UNKNOWN_EXEC_ERROR;
 336         else
 337             psxErr = MapError(psxErr);
 338
 339         throw SystemShellExecuteException(
 340             "Error executing command",
 341             static_cast< XSystemShellExecute* >(this),
 342             psxErr);
 343     }
 344 }
 345
 346 // XServiceInfo
 347 OUString SAL_CALL CSysShExec::getImplementationName(  )
 348     throw( RuntimeException )
 349 {
 350     return OUString(SYSSHEXEC_IMPL_NAME );
 351 }
 352
 353 //  XServiceInfo
 354 sal_Bool SAL_CALL CSysShExec::supportsService( const OUString& ServiceName )
 355     throw( RuntimeException )
 356 {
 357     return cppu::supportsService(this, ServiceName);
 358 }
 359
 360 //  XServiceInfo
 361 Sequence< OUString > SAL_CALL CSysShExec::getSupportedServiceNames(  )
 362     throw( RuntimeException )
 363 {
 364     return SysShExec_getSupportedServiceNames();
 365 }
 366
 367 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */