scripting/source/provider/URIHelper.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 <config_folders.h>
  21 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  22 #include <com/sun/star/ucb/SimpleFileAccess.hpp>
  23 #include <com/sun/star/uri/XVndSunStarScriptUrl.hpp>
  24 #include <com/sun/star/uri/UriReferenceFactory.hpp>
  25 #include <cppuhelper/supportsservice.hxx>
  26 #include <rtl/ustrbuf.hxx>
  27 #include <osl/diagnose.h>
  28 #include "URIHelper.hxx"
  29
  30 namespace func_provider
  31 {
  32
  33 namespace uno = ::com::sun::star::uno;
  34 namespace ucb = ::com::sun::star::ucb;
  35 namespace lang = ::com::sun::star::lang;
  36 namespace uri = ::com::sun::star::uri;
  37
  38 const char SHARE[] = "share";
  39
  40 const char SHARE_UNO_PACKAGES_URI[] =
  41     "vnd.sun.star.expand:$UNO_SHARED_PACKAGES_CACHE";
  42
  43 const char USER[] = "user";
  44 constexpr OUStringLiteral USER_URI =
  45     u"vnd.sun.star.expand:${$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE( "bootstrap") "::UserInstallation}";
  46
  47
  48
  49 ScriptingFrameworkURIHelper::ScriptingFrameworkURIHelper(
  50     const uno::Reference< uno::XComponentContext >& xContext)
  51 {
  52     try
  53     {
  54         m_xSimpleFileAccess = ucb::SimpleFileAccess::create(xContext);
  55     }
  56     catch (uno::Exception&)
  57     {
  58         OSL_FAIL("Scripting Framework error initialising XSimpleFileAccess");
  59     }
  60
  61     try
  62     {
  63         m_xUriReferenceFactory = uri::UriReferenceFactory::create( xContext );
  64     }
  65     catch (uno::Exception&)
  66     {
  67         OSL_FAIL("Scripting Framework error initialising XUriReferenceFactory");
  68     }
  69 }
  70
  71 ScriptingFrameworkURIHelper::~ScriptingFrameworkURIHelper()
  72 {
  73     // currently does nothing
  74 }
  75
  76 void SAL_CALL
  77 ScriptingFrameworkURIHelper::initialize(
  78     const uno::Sequence < uno::Any >& args )
  79 {
  80     if ( args.getLength() != 2 ||
  81          args[0].getValueType() != ::cppu::UnoType<OUString>::get() ||
  82          args[1].getValueType() != ::cppu::UnoType<OUString>::get() )
  83     {
  84         throw uno::RuntimeException( "ScriptingFrameworkURIHelper got invalid argument list" );
  85     }
  86
  87     if ( !(args[0] >>= m_sLanguage) || !(args[1] >>= m_sLocation) )
  88     {
  89         throw uno::RuntimeException( "ScriptingFrameworkURIHelper error parsing args" );
  90     }
  91
  92     SCRIPTS_PART = "/Scripts/" + m_sLanguage.toAsciiLowerCase();
  93
  94     if ( !initBaseURI() )
  95     {
  96         throw uno::RuntimeException( "ScriptingFrameworkURIHelper cannot find script directory" );
  97     }
  98 }
  99
 100 bool
 101 ScriptingFrameworkURIHelper::initBaseURI()
 102 {
 103     OUString uri, test;
 104     bool bAppendScriptsPart = false;
 105
 106     if ( m_sLocation == USER )
 107     {
 108         test = USER;
 109         uri = USER_URI;
 110         bAppendScriptsPart = true;
 111     }
 112     else if ( m_sLocation == "user:uno_packages" )
 113     {
 114         test = "uno_packages";
 115         uri = USER_URI + "/user/uno_packages/cache";
 116     }
 117     else if (m_sLocation == SHARE)
 118     {
 119         test = SHARE;
 120         uri = "vnd.sun.star.expand:$BRAND_BASE_DIR";
 121         bAppendScriptsPart = true;
 122     }
 123     else if (m_sLocation == "share:uno_packages")
 124     {
 125         test = "uno_packages";
 126         uri = SHARE_UNO_PACKAGES_URI;
 127     }
 128     else if (m_sLocation.startsWith("vnd.sun.star.tdoc"))
 129     {
 130         m_sBaseURI = m_sLocation + SCRIPTS_PART;
 131         m_sLocation = "document";
 132         return true;
 133     }
 134     else
 135     {
 136         return false;
 137     }
 138
 139     if ( !m_xSimpleFileAccess->exists( uri ) ||
 140          !m_xSimpleFileAccess->isFolder( uri ) )
 141     {
 142         return false;
 143     }
 144
 145     uno::Sequence< OUString > children =
 146         m_xSimpleFileAccess->getFolderContents( uri, true );
 147
 148     auto pChild = std::find_if(children.begin(), children.end(), [&test](const OUString& child) {
 149         sal_Int32 idx = child.lastIndexOf(test);
 150         return idx != -1 && (idx + test.getLength()) == child.getLength();
 151     });
 152     if (pChild != children.end())
 153     {
 154         if ( bAppendScriptsPart )
 155         {
 156             m_sBaseURI = *pChild + SCRIPTS_PART;
 157         }
 158         else
 159         {
 160             m_sBaseURI = *pChild;
 161         }
 162         return true;
 163     }
 164     return false;
 165 }
 166
 167 OUString
 168 ScriptingFrameworkURIHelper::getLanguagePart(const OUString& rStorageURI)
 169 {
 170     OUString result;
 171
 172     sal_Int32 idx = rStorageURI.indexOf(m_sBaseURI);
 173     sal_Int32 len = m_sBaseURI.getLength() + 1;
 174
 175     if ( idx != -1 )
 176     {
 177         result = rStorageURI.copy(idx + len);
 178         result = result.replace('/', '|');
 179     }
 180     return result;
 181 }
 182
 183 OUString
 184 ScriptingFrameworkURIHelper::getLanguagePath(const OUString& rLanguagePart)
 185 {
 186     OUString result = rLanguagePart.replace('|', '/');
 187     return result;
 188 }
 189
 190 OUString SAL_CALL
 191 ScriptingFrameworkURIHelper::getScriptURI(const OUString& rStorageURI)
 192 {
 193     OUStringBuffer buf(120);
 194
 195     buf.append("vnd.sun.star.script:");
 196     buf.append(getLanguagePart(rStorageURI));
 197     buf.append("?language=");
 198     buf.append(m_sLanguage);
 199     buf.append("&location=");
 200     buf.append(m_sLocation);
 201
 202     return buf.makeStringAndClear();
 203 }
 204
 205 OUString SAL_CALL
 206 ScriptingFrameworkURIHelper::getStorageURI(const OUString& rScriptURI)
 207 {
 208     OUString sLanguagePart;
 209     try
 210     {
 211         uno::Reference < uri::XVndSunStarScriptUrl > xURI(
 212             m_xUriReferenceFactory->parse( rScriptURI ), uno::UNO_QUERY_THROW );
 213         sLanguagePart = xURI->getName();
 214     }
 215     catch ( uno::Exception& )
 216     {
 217         throw lang::IllegalArgumentException(
 218             "Script URI not valid",
 219             uno::Reference< uno::XInterface >(), 1 );
 220     }
 221
 222     OUStringBuffer buf(120);
 223     buf.append(m_sBaseURI);
 224     buf.append("/");
 225     buf.append(getLanguagePath(sLanguagePart));
 226
 227     OUString result = buf.makeStringAndClear();
 228
 229     return result;
 230 }
 231
 232 OUString SAL_CALL
 233 ScriptingFrameworkURIHelper::getRootStorageURI()
 234 {
 235     return m_sBaseURI;
 236 }
 237
 238 OUString SAL_CALL
 239 ScriptingFrameworkURIHelper::getImplementationName()
 240 {
 241     return
 242         "com.sun.star.script.provider.ScriptURIHelper";
 243 }
 244
 245 sal_Bool SAL_CALL
 246 ScriptingFrameworkURIHelper::supportsService( const OUString& serviceName )
 247 {
 248     return cppu::supportsService( this, serviceName );
 249 }
 250
 251 uno::Sequence< OUString > SAL_CALL
 252 ScriptingFrameworkURIHelper::getSupportedServiceNames()
 253 {
 254     return { "com.sun.star.script.provider.ScriptURIHelper" };
 255 }
 256
 257 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 258 scripting_ScriptingFrameworkURIHelper_get_implementation(
 259     css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const&)
 260 {
 261     return cppu::acquire(new ScriptingFrameworkURIHelper(context));
 262 }
 263
 264 }
 265
 266
 267 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */