shell/source/backends/desktopbe/desktopbackend.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 <sal/config.h>
  21 #include <sal/log.hxx>
  22
  23 #include <com/sun/star/beans/Optional.hpp>
  24 #include <com/sun/star/beans/UnknownPropertyException.hpp>
  25 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  26 #include <com/sun/star/beans/XPropertySet.hpp>
  27 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  28 #include <com/sun/star/beans/XVetoableChangeListener.hpp>
  29 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  30 #include <com/sun/star/lang/XMultiComponentFactory.hpp>
  31 #include <com/sun/star/lang/XServiceInfo.hpp>
  32 #include <com/sun/star/uno/Any.hxx>
  33 #include <com/sun/star/uno/Exception.hpp>
  34 #include <com/sun/star/uno/Reference.hxx>
  35 #include <com/sun/star/uno/RuntimeException.hpp>
  36 #include <com/sun/star/uno/Sequence.hxx>
  37 #include <com/sun/star/uno/XComponentContext.hpp>
  38 #include <com/sun/star/uno/XCurrentContext.hpp>
  39 #include <cppuhelper/factory.hxx>
  40 #include <cppuhelper/implbase.hxx>
  41 #include <cppuhelper/implementationentry.hxx>
  42 #include <cppuhelper/weak.hxx>
  43 #include <osl/file.hxx>
  44 #include <osl/security.hxx>
  45 #include <rtl/byteseq.hxx>
  46 #include <rtl/ustrbuf.hxx>
  47 #include <rtl/ustring.hxx>
  48 #include <sal/types.h>
  49 #include <tools/diagnose_ex.h>
  50 #include <uno/current_context.hxx>
  51
  52 namespace {
  53
  54 class Default:
  55     public cppu::WeakImplHelper<
  56         css::lang::XServiceInfo, css::beans::XPropertySet >
  57 {
  58 public:
  59     Default() {}
  60     Default(const Default&) = delete;
  61     Default& operator=(const Default&) = delete;
  62
  63 private:
  64     virtual ~Default() override {}
  65
  66     virtual OUString SAL_CALL getImplementationName() override
  67     { return "com.sun.star.comp.configuration.backend.DesktopBackend"; }
  68
  69     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
  70     { return ServiceName == getSupportedServiceNames()[0]; }
  71
  72     virtual css::uno::Sequence< OUString > SAL_CALL
  73     getSupportedServiceNames() override
  74     { return { "com.sun.star.configuration.backend.DesktopBackend" }; }
  75
  76     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
  77     getPropertySetInfo() override
  78     { return css::uno::Reference< css::beans::XPropertySetInfo >(); }
  79
  80     virtual void SAL_CALL setPropertyValue(
  81         OUString const &, css::uno::Any const &) override;
  82
  83     virtual css::uno::Any SAL_CALL getPropertyValue(
  84         OUString const & PropertyName) override;
  85
  86     virtual void SAL_CALL addPropertyChangeListener(
  87         OUString const &,
  88         css::uno::Reference< css::beans::XPropertyChangeListener > const &) override
  89     {}
  90
  91     virtual void SAL_CALL removePropertyChangeListener(
  92         OUString const &,
  93         css::uno::Reference< css::beans::XPropertyChangeListener > const &) override
  94     {}
  95
  96     virtual void SAL_CALL addVetoableChangeListener(
  97         OUString const &,
  98         css::uno::Reference< css::beans::XVetoableChangeListener > const &) override
  99     {}
 100
 101     virtual void SAL_CALL removeVetoableChangeListener(
 102         OUString const &,
 103         css::uno::Reference< css::beans::XVetoableChangeListener > const &) override
 104     {}
 105 };
 106
 107 void Default::setPropertyValue(OUString const &, css::uno::Any const &)
 108 {
 109     throw css::lang::IllegalArgumentException(
 110         "setPropertyValue not supported",
 111         static_cast< cppu::OWeakObject * >(this), -1);
 112 }
 113
 114 OUString xdg_user_dir_lookup (const char *type, bool bAllowHomeDir)
 115 {
 116     size_t nLenType = strlen(type);
 117     char *config_home;
 118     char *p;
 119     bool bError = false;
 120
 121     osl::Security aSecurity;
 122     oslFileHandle handle;
 123     OUString aHomeDirURL;
 124     OUString aDocumentsDirURL;
 125     OUString aConfigFileURL;
 126     OUStringBuffer aUserDirBuf;
 127
 128     if (!aSecurity.getHomeDir( aHomeDirURL ) )
 129     {
 130         osl::FileBase::getFileURLFromSystemPath("/tmp", aDocumentsDirURL);
 131         return aDocumentsDirURL;
 132     }
 133
 134     config_home = getenv ("XDG_CONFIG_HOME");
 135     if (config_home == nullptr || config_home[0] == 0)
 136     {
 137         aConfigFileURL = aHomeDirURL + "/.config/user-dirs.dirs";
 138     }
 139     else
 140     {
 141         aConfigFileURL = OUString::createFromAscii(config_home) + "/user-dirs.dirs";
 142     }
 143
 144     if(osl_File_E_None == osl_openFile(aConfigFileURL.pData, &handle, osl_File_OpenFlag_Read))
 145     {
 146         rtl::ByteSequence seq;
 147         while (osl_File_E_None == osl_readLine(handle , reinterpret_cast<sal_Sequence **>(&seq)))
 148         {
 149             int relative = 0;
 150             int len = seq.getLength();
 151             seq.realloc(len + 1);
 152             seq[len] = 0;
 153
 154             p = reinterpret_cast<char *>(seq.getArray());
 155             while (*p == ' ' || *p == '\t')
 156                 p++;
 157             if (strncmp (p, "XDG_", 4) != 0)
 158                 continue;
 159             p += 4;
 160             if (strncmp (p, OString(type, nLenType).toAsciiUpperCase().getStr(), nLenType) != 0)
 161                 continue;
 162             p += nLenType;
 163             if (strncmp (p, "_DIR", 4) != 0)
 164                 continue;
 165             p += 4;
 166             while (*p == ' ' || *p == '\t')
 167                 p++;
 168             if (*p != '=')
 169                 continue;
 170             p++;
 171             while (*p == ' ' || *p == '\t')
 172                 p++;
 173             if (*p != '"')
 174                 continue;
 175             p++;
 176             if (strncmp (p, "$HOME/", 6) == 0)
 177             {
 178                 p += 6;
 179                 relative = 1;
 180             }
 181             else if (*p != '/')
 182                 continue;
 183             if (relative)
 184             {
 185                 aUserDirBuf = aHomeDirURL + "/";
 186             }
 187             else
 188             {
 189                 aUserDirBuf.truncate();
 190             }
 191             while (*p && *p != '"')
 192             {
 193                 if ((*p == '\\') && (*(p+1) != 0))
 194                     p++;
 195                 aUserDirBuf.append(static_cast<sal_Unicode>(*p++));
 196             }
 197         }//end of while
 198         osl_closeFile(handle);
 199     }
 200     else
 201         bError = true;
 202     if (aUserDirBuf.getLength()>0 && !bError)
 203     {
 204         aDocumentsDirURL = aUserDirBuf.makeStringAndClear();
 205         if ( bAllowHomeDir ||
 206              (aDocumentsDirURL != aHomeDirURL && aDocumentsDirURL != aHomeDirURL + "/") )
 207         {
 208             osl::Directory aDocumentsDir( aDocumentsDirURL );
 209             if( osl::FileBase::E_None == aDocumentsDir.open() )
 210                 return aDocumentsDirURL;
 211         }
 212     }
 213     /* Use fallbacks historical compatibility if nothing else exists */
 214     return aHomeDirURL + "/" + OUString::createFromAscii(type);
 215 }
 216
 217 css::uno::Any xdgDirectoryIfExists(char const * type, bool bAllowHomeDir) {
 218     auto url = xdg_user_dir_lookup(type, bAllowHomeDir);
 219     return css::uno::Any(
 220         osl::Directory(url).open() == osl::FileBase::E_None
 221         ? css::beans::Optional<css::uno::Any>(true, css::uno::Any(url))
 222         : css::beans::Optional<css::uno::Any>(false, css::uno::Any()));
 223 }
 224
 225 css::uno::Any Default::getPropertyValue(OUString const & PropertyName)
 226 {
 227     if (PropertyName == "TemplatePathVariable")
 228     {
 229         // Never pick up the HOME directory as the default location of user's templates
 230         return xdgDirectoryIfExists("Templates", false);
 231     }
 232
 233     if (PropertyName == "WorkPathVariable")
 234     {
 235         return xdgDirectoryIfExists("Documents", true);
 236     }
 237
 238     if ( PropertyName == "EnableATToolSupport" ||
 239          PropertyName == "ExternalMailer" ||
 240          PropertyName == "SourceViewFontHeight" ||
 241          PropertyName == "SourceViewFontName" ||
 242          PropertyName == "ooInetFTPProxyName" ||
 243          PropertyName == "ooInetFTPProxyPort" ||
 244          PropertyName == "ooInetHTTPProxyName" ||
 245          PropertyName == "ooInetHTTPProxyPort" ||
 246          PropertyName == "ooInetHTTPSProxyName" ||
 247          PropertyName == "ooInetHTTPSProxyPort" ||
 248          PropertyName == "ooInetNoProxy" ||
 249          PropertyName == "ooInetProxyType" ||
 250          PropertyName == "givenname" ||
 251          PropertyName == "sn" )
 252     {
 253         return css::uno::makeAny(css::beans::Optional< css::uno::Any >());
 254     }
 255
 256     throw css::beans::UnknownPropertyException(
 257         PropertyName, static_cast< cppu::OWeakObject * >(this));
 258 }
 259
 260 css::uno::Reference< css::uno::XInterface > createBackend(
 261     css::uno::Reference< css::uno::XComponentContext > const & context,
 262     OUString const & name)
 263 {
 264     try {
 265         return css::uno::Reference< css::lang::XMultiComponentFactory >(
 266             context->getServiceManager(), css::uno::UNO_SET_THROW)->
 267             createInstanceWithContext(name, context);
 268     } catch (css::uno::RuntimeException &) {
 269         // Assuming these exceptions are real errors:
 270         throw;
 271     } catch (const css::uno::Exception &) {
 272         // Assuming these exceptions indicate that the service is not installed:
 273         TOOLS_WARN_EXCEPTION("shell", "createInstance(" << name << ") failed");
 274         return css::uno::Reference< css::uno::XInterface >();
 275     }
 276 }
 277
 278 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 279 shell_DesktopBackend_get_implementation(
 280     css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
 281 {
 282     OUString desktop;
 283     css::uno::Reference< css::uno::XCurrentContext > current(
 284         css::uno::getCurrentContext());
 285     if (current.is()) {
 286         current->getValueByName("system.desktop-environment") >>= desktop;
 287     }
 288
 289     // Fall back to the default if the specific backend is not available:
 290     css::uno::Reference< css::uno::XInterface > backend;
 291     if (desktop == "PLASMA5")
 292         backend = createBackend(context,
 293             "com.sun.star.configuration.backend.KF5Backend");
 294     if (!backend)
 295         backend = static_cast< cppu::OWeakObject * >(new Default);
 296     backend->acquire();
 297     return backend.get();
 298 }
 299
 300 }
 301
 302
 303 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */