shell/source/unix/exec/shellexec.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: shellexec.cxx,v $
  10  * $Revision: 1.21 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_shell.hxx"
  33 #include <osl/diagnose.h>
  34 #include <osl/thread.h>
  35 #include <osl/process.h>
  36 #include <osl/file.hxx>
  37 #include <rtl/ustrbuf.hxx>
  38
  39 #ifndef _RTL_URI_H_
  40 #include <rtl/uri.hxx>
  41 #endif
  42 #include "shellexec.hxx"
  43 #include <com/sun/star/system/SystemShellExecuteFlags.hpp>
  44
  45 #include <com/sun/star/util/XMacroExpander.hpp>
  46 #include <com/sun/star/uri/XExternalUriReferenceTranslator.hpp>
  47 #include <com/sun/star/uri/ExternalUriReferenceTranslator.hpp>
  48
  49 #include "uno/current_context.hxx"
  50
  51 #include <string.h>
  52 #include <errno.h>
  53 #include <unistd.h>
  54
  55 //------------------------------------------------------------------------
  56 // namespace directives
  57 //------------------------------------------------------------------------
  58
  59 using com::sun::star::system::XSystemShellExecute;
  60 using com::sun::star::system::SystemShellExecuteException;
  61
  62 using rtl::OString;
  63 using rtl::OUString;
  64 using rtl::OStringBuffer;
  65 using rtl::OUStringBuffer;
  66 using osl::FileBase;
  67
  68 using namespace ::com::sun::star::uno;
  69 using namespace ::com::sun::star::lang;
  70 using namespace ::com::sun::star::system::SystemShellExecuteFlags;
  71 using namespace cppu;
  72
  73 //------------------------------------------------------------------------
  74 // defines
  75 //------------------------------------------------------------------------
  76
  77 #define SHELLEXEC_IMPL_NAME  "com.sun.star.comp.system.SystemShellExecute2"
  78
  79 //------------------------------------------------------------------------
  80 // helper functions
  81 //------------------------------------------------------------------------
  82
  83 namespace // private
  84 {
  85     Sequence< OUString > SAL_CALL ShellExec_getSupportedServiceNames()
  86     {
  87         Sequence< OUString > aRet(1);
  88         aRet[0] = OUString::createFromAscii("com.sun.star.sys.shell.SystemShellExecute");
  89         return aRet;
  90     }
  91 }
  92
  93 void escapeForShell( rtl::OStringBuffer & rBuffer, const rtl::OString & rURL)
  94 {
  95     sal_Int32 nmax = rURL.getLength();
  96     for(sal_Int32 n=0; n < nmax; ++n)
  97     {
  98         // escape every non alpha numeric characters (excluding a few "known good") by prepending a '\'
  99         sal_Char c = rURL[n];
 100 #ifndef OS2 // YD shell does not support escaped chars
 101         if( ( c < 'A' || c > 'Z' ) && ( c < 'a' || c > 'z' ) && ( c < '0' || c > '9' )  && c != '/' && c != '.' )
 102             rBuffer.append( '\\' );
 103 #endif
 104
 105         rBuffer.append( c );
 106     }
 107 }
 108
 109 //-----------------------------------------------------------------------------------------
 110 //
 111 //-----------------------------------------------------------------------------------------
 112
 113 ShellExec::ShellExec( const Reference< XComponentContext >& xContext ) :
 114     WeakImplHelper2< XSystemShellExecute, XServiceInfo >(),
 115     m_xContext(xContext)
 116 {
 117     try {
 118         Reference< XCurrentContext > xCurrentContext(getCurrentContext());
 119
 120         if (xCurrentContext.is())
 121         {
 122             Any aValue = xCurrentContext->getValueByName(
 123                 OUString( RTL_CONSTASCII_USTRINGPARAM( "system.desktop-environment" ) ) );
 124
 125             OUString aDesktopEnvironment;
 126             if (aValue >>= aDesktopEnvironment)
 127             {
 128                 m_aDesktopEnvironment = OUStringToOString(aDesktopEnvironment, RTL_TEXTENCODING_ASCII_US);
 129             }
 130         }
 131     } catch (RuntimeException e) {
 132     }
 133 }
 134
 135 //-------------------------------------------------
 136 //
 137 //-------------------------------------------------
 138
 139 void SAL_CALL ShellExec::execute( const OUString& aCommand, const OUString& aParameter, sal_Int32 nFlags )
 140     throw (IllegalArgumentException, SystemShellExecuteException, RuntimeException)
 141 {
 142     OStringBuffer aBuffer, aLaunchBuffer;
 143
 144     // DESKTOP_LAUNCH, see http://freedesktop.org/pipermail/xdg/2004-August/004489.html
 145     static const char *pDesktopLaunch = getenv( "DESKTOP_LAUNCH" );
 146
 147     // Check wether aCommand contains a document url or not
 148     sal_Int32 nIndex = aCommand.indexOf( OUString( RTL_CONSTASCII_USTRINGPARAM(":/") ) );
 149
 150     if( nIndex > 0 || 0 == aCommand.compareToAscii("mailto:", 7) )
 151     {
 152         // It seems to be a url ..
 153         // We need to re-encode file urls because osl_getFileURLFromSystemPath converts
 154         // to UTF-8 before encoding non ascii characters, which is not what other apps
 155         // expect.
 156         OUString aURL(
 157             com::sun::star::uri::ExternalUriReferenceTranslator::create(
 158                 m_xContext)->translateToExternal(aCommand));
 159         if ( aURL.getLength() == 0 && aCommand.getLength() != 0 )
 160         {
 161             throw RuntimeException(
 162                 (OUString(
 163                     RTL_CONSTASCII_USTRINGPARAM(
 164                         "Cannot translate URI reference to external format: "))
 165                  + aCommand),
 166                 static_cast< cppu::OWeakObject * >(this));
 167         }
 168
 169 #ifdef MACOSX
 170         aBuffer.append("open");
 171 #else
 172         // The url launchers are expected to be in the $OOO_BASE_DIR/program
 173         // directory:
 174         com::sun::star::uno::Reference< com::sun::star::util::XMacroExpander >
 175             exp;
 176         if (!(m_xContext->getValueByName(
 177                   rtl::OUString(
 178                       RTL_CONSTASCII_USTRINGPARAM(
 179                           "/singletons/com.sun.star.util.theMacroExpander")))
 180               >>= exp)
 181             || !exp.is())
 182         {
 183             throw SystemShellExecuteException(
 184                 rtl::OUString(
 185                     RTL_CONSTASCII_USTRINGPARAM(
 186                         "component context fails to supply singleton"
 187                         " com.sun.star.util.theMacroExpander of type"
 188                         " com.sun.star.util.XMacroExpander")),
 189                 static_cast< XSystemShellExecute * >(this), ENOENT);
 190         }
 191         OUString aProgramURL;
 192         try {
 193             aProgramURL = exp->expandMacros(
 194                 rtl::OUString(
 195                     RTL_CONSTASCII_USTRINGPARAM("$OOO_BASE_DIR/program/")));
 196         } catch (com::sun::star::lang::IllegalArgumentException &)
 197         {
 198             throw SystemShellExecuteException(
 199                 OUString(RTL_CONSTASCII_USTRINGPARAM("Could not expand $OOO_BASE_DIR path")),
 200                 static_cast < XSystemShellExecute * > (this), ENOENT );
 201         }
 202
 203         OUString aProgram;
 204         if ( FileBase::E_None != FileBase::getSystemPathFromFileURL(aProgramURL, aProgram))
 205         {
 206             throw SystemShellExecuteException(
 207                 OUString(RTL_CONSTASCII_USTRINGPARAM("Cound not convert executable path")),
 208                 static_cast < XSystemShellExecute * > (this), ENOENT );
 209         }
 210
 211 #ifdef OS2
 212         OStringBuffer aProg = OUStringToOString(aProgram, osl_getThreadTextEncoding());
 213         aProg.append("open-url.exe");
 214         OString aUrl = OUStringToOString(aURL, osl_getThreadTextEncoding());
 215         if ( -1 == spawnl(P_NOWAIT, aProg.getStr(), aProg.getStr(), aUrl.getStr() , NULL) )
 216         {
 217             int nerr = errno;
 218             throw SystemShellExecuteException(OUString::createFromAscii( strerror( nerr ) ),
 219                 static_cast < XSystemShellExecute * > (this), nerr );
 220         }
 221         return;
 222 #endif
 223
 224         OString aTmp = OUStringToOString(aProgram, osl_getThreadTextEncoding());
 225         escapeForShell(aBuffer, aTmp);
 226
 227 #ifdef SOLARIS
 228         if ( m_aDesktopEnvironment.getLength() == 0 )
 229              m_aDesktopEnvironment = OString("GNOME");
 230 #endif
 231
 232         // Respect the desktop environment - if there is an executable named
 233         // <desktop-environement-is>-open-url, pass the url to this one instead
 234         // of the default "open-url" script.
 235         if ( m_aDesktopEnvironment.getLength() > 0 )
 236         {
 237             OString aDesktopEnvironment(m_aDesktopEnvironment.toAsciiLowerCase());
 238             OStringBuffer aCopy(aTmp);
 239
 240             aCopy.append(aDesktopEnvironment);
 241             aCopy.append("-open-url");
 242
 243             if ( 0 == access( aCopy.getStr(), X_OK) )
 244             {
 245                 aBuffer.append(aDesktopEnvironment);
 246                 aBuffer.append("-");
 247
 248                 /* CDE requires file urls to be decoded */
 249                 if ( m_aDesktopEnvironment.equals("CDE") && 0 == aURL.compareToAscii("file://", 7) )
 250                 {
 251                     aURL = rtl::Uri::decode(aURL, rtl_UriDecodeWithCharset, osl_getThreadTextEncoding());
 252                 }
 253             }
 254         }
 255
 256         aBuffer.append("open-url");
 257 #endif
 258         aBuffer.append(" ");
 259         escapeForShell(aBuffer, OUStringToOString(aURL, osl_getThreadTextEncoding()));
 260
 261         if ( pDesktopLaunch && *pDesktopLaunch )
 262         {
 263             aLaunchBuffer.append( pDesktopLaunch );
 264             aLaunchBuffer.append(" ");
 265             escapeForShell(aLaunchBuffer, OUStringToOString(aURL, osl_getThreadTextEncoding()));
 266         }
 267     } else {
 268         escapeForShell(aBuffer, OUStringToOString(aCommand, osl_getThreadTextEncoding()));
 269         aBuffer.append(" ");
 270         if( nFlags != 42 )
 271             escapeForShell(aBuffer, OUStringToOString(aParameter, osl_getThreadTextEncoding()));
 272         else
 273             aBuffer.append(OUStringToOString(aParameter, osl_getThreadTextEncoding()));
 274     }
 275
 276     // Prefer DESKTOP_LAUNCH when available
 277     if ( aLaunchBuffer.getLength() > 0 )
 278     {
 279         FILE *pLaunch = popen( aLaunchBuffer.makeStringAndClear().getStr(), "w" );
 280         if ( pLaunch != NULL )
 281         {
 282             if ( 0 == pclose( pLaunch ) )
 283                 return;
 284         }
 285         // Failed, do not try DESKTOP_LAUNCH any more
 286         pDesktopLaunch = NULL;
 287     }
 288
 289     OString cmd = aBuffer.makeStringAndClear();
 290     if ( 0 != pclose(popen(cmd.getStr(), "w")) )
 291     {
 292         int nerr = errno;
 293         throw SystemShellExecuteException(OUString::createFromAscii( strerror( nerr ) ),
 294             static_cast < XSystemShellExecute * > (this), nerr );
 295     }
 296 }
 297
 298
 299 // -------------------------------------------------
 300 // XServiceInfo
 301 // -------------------------------------------------
 302
 303 OUString SAL_CALL ShellExec::getImplementationName(  )
 304     throw( RuntimeException )
 305 {
 306     return OUString::createFromAscii( SHELLEXEC_IMPL_NAME );
 307 }
 308
 309 // -------------------------------------------------
 310 //      XServiceInfo
 311 // -------------------------------------------------
 312
 313 sal_Bool SAL_CALL ShellExec::supportsService( const OUString& ServiceName )
 314     throw( RuntimeException )
 315 {
 316     Sequence < OUString > SupportedServicesNames = ShellExec_getSupportedServiceNames();
 317
 318     for ( sal_Int32 n = SupportedServicesNames.getLength(); n--; )
 319         if (SupportedServicesNames[n].compareTo(ServiceName) == 0)
 320             return sal_True;
 321
 322     return sal_False;
 323 }
 324
 325 // -------------------------------------------------
 326 //      XServiceInfo
 327 // -------------------------------------------------
 328
 329 Sequence< OUString > SAL_CALL ShellExec::getSupportedServiceNames(       )
 330     throw( RuntimeException )
 331 {
 332     return ShellExec_getSupportedServiceNames();
 333 }
 334