linguistic/source/misc2.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 <tools/urlobj.hxx>
  21 #include <ucbhelper/content.hxx>
  22 #include <tools/debug.hxx>
  23 #include <unotools/pathoptions.hxx>
  24 #include <comphelper/processfactory.hxx>
  25 #include <unotools/localfilehelper.hxx>
  26 #include <unotools/localedatawrapper.hxx>
  27 #include <unotools/ucbhelper.hxx>
  28 #include <com/sun/star/beans/XPropertySet.hpp>
  29 #include <com/sun/star/beans/XFastPropertySet.hpp>
  30 #include <com/sun/star/beans/PropertyValues.hpp>
  31 #include <com/sun/star/uno/Sequence.hxx>
  32 #include <com/sun/star/uno/Reference.h>
  33 #include <com/sun/star/util/thePathSettings.hpp>
  34 #include <o3tl/typed_flags_set.hxx>
  35
  36 #include "linguistic/misc.hxx"
  37
  38 using namespace com::sun::star;
  39
  40 /// Flags to be used with the multi-path related functions
  41 /// @see GetDictionaryPaths
  42 enum class DictionaryPathFlags
  43 {
  44     INTERNAL  = 0x01,
  45     USER      = 0x02,
  46     WRITABLE  = 0x04
  47 };
  48 namespace o3tl
  49 {
  50     template<> struct typed_flags<DictionaryPathFlags> : is_typed_flags<DictionaryPathFlags, 0x07> {};
  51 }
  52 #define PATH_FLAG_ALL       (DictionaryPathFlags::INTERNAL | DictionaryPathFlags::USER | DictionaryPathFlags::WRITABLE)
  53
  54 namespace linguistic
  55 {
  56
  57
  58 bool FileExists( const OUString &rMainURL )
  59 {
  60     bool bExists = false;
  61     if (!rMainURL.isEmpty())
  62     {
  63         try
  64         {
  65             ::ucbhelper::Content aContent( rMainURL,
  66                     uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >(),
  67                     comphelper::getProcessComponentContext());
  68             bExists = aContent.isDocument();
  69         }
  70         catch (uno::Exception &)
  71         {
  72         }
  73     }
  74     return bExists;
  75 }
  76
  77 static uno::Sequence< OUString > GetMultiPaths_Impl(
  78     const OUString &rPathPrefix,
  79     DictionaryPathFlags nPathFlags )
  80 {
  81     uno::Sequence< OUString >   aRes;
  82     uno::Sequence< OUString >   aInternalPaths;
  83     uno::Sequence< OUString >   aUserPaths;
  84     OUString                    aWritablePath;
  85
  86     bool bSuccess = true;
  87     uno::Reference< uno::XComponentContext >  xContext( comphelper::getProcessComponentContext() );
  88     try
  89     {
  90         OUString aInternal( rPathPrefix + "_internal" );
  91         OUString aUser( rPathPrefix + "_user" );
  92         OUString aWriteable( rPathPrefix + "_writable" );
  93
  94         uno::Reference< util::XPathSettings > xPathSettings =
  95             util::thePathSettings::get( xContext );
  96         xPathSettings->getPropertyValue( aInternal )  >>= aInternalPaths;
  97         xPathSettings->getPropertyValue( aUser )      >>= aUserPaths;
  98         xPathSettings->getPropertyValue( aWriteable ) >>= aWritablePath;
  99     }
 100     catch (uno::Exception &)
 101     {
 102         bSuccess = false;
 103     }
 104     if (bSuccess)
 105     {
 106         // build resulting sequence by adding the paths in the following order:
 107         // 1. writable path
 108         // 2. all user paths
 109         // 3. all internal paths
 110         sal_Int32 nMaxEntries = aInternalPaths.getLength() + aUserPaths.getLength();
 111         if (!aWritablePath.isEmpty())
 112             ++nMaxEntries;
 113         aRes.realloc( nMaxEntries );
 114         OUString *pRes = aRes.getArray();
 115         sal_Int32 nCount = 0;   // number of actually added entries
 116         if ((nPathFlags & DictionaryPathFlags::WRITABLE) && !aWritablePath.isEmpty())
 117             pRes[ nCount++ ] = aWritablePath;
 118         for (int i = 0;  i < 2;  ++i)
 119         {
 120             const uno::Sequence< OUString > &rPathSeq = i == 0 ? aUserPaths : aInternalPaths;
 121             const OUString *pPathSeq = rPathSeq.getConstArray();
 122             for (sal_Int32 k = 0;  k < rPathSeq.getLength();  ++k)
 123             {
 124                 const bool bAddUser     = &rPathSeq == &aUserPaths     && (nPathFlags & DictionaryPathFlags::USER);
 125                 const bool bAddInternal = &rPathSeq == &aInternalPaths && (nPathFlags & DictionaryPathFlags::INTERNAL);
 126                 if ((bAddUser || bAddInternal) && !pPathSeq[k].isEmpty())
 127                     pRes[ nCount++ ] = pPathSeq[k];
 128             }
 129         }
 130         aRes.realloc( nCount );
 131     }
 132
 133     return aRes;
 134 }
 135
 136 OUString GetDictionaryWriteablePath()
 137 {
 138     uno::Sequence< OUString > aPaths( GetMultiPaths_Impl( "Dictionary", DictionaryPathFlags::WRITABLE ) );
 139     DBG_ASSERT( aPaths.getLength() == 1, "Dictionary_writable path corrupted?" );
 140     OUString aRes;
 141     if (aPaths.getLength() > 0)
 142         aRes = aPaths[0];
 143     return aRes;
 144 }
 145
 146 uno::Sequence< OUString > GetDictionaryPaths()
 147 {
 148     return GetMultiPaths_Impl( "Dictionary", PATH_FLAG_ALL );
 149 }
 150
 151 OUString  GetWritableDictionaryURL( const OUString &rDicName )
 152 {
 153     // new user writable dictionaries should be created in the 'writable' path
 154     OUString aDirName( GetDictionaryWriteablePath() );
 155
 156     // build URL to use for a new (persistent) dictionary
 157     INetURLObject aURLObj;
 158     aURLObj.SetSmartProtocol( INetProtocol::File );
 159     aURLObj.SetSmartURL( aDirName );
 160     DBG_ASSERT(!aURLObj.HasError(), "lng : invalid URL");
 161     aURLObj.Append( rDicName, INetURLObject::ENCODE_ALL );
 162     DBG_ASSERT(!aURLObj.HasError(), "lng : invalid URL");
 163
 164     // NO_DECODE preserves the escape sequences that might be included in aDirName
 165     // depending on the characters used in the path string. (Needed when comparing
 166     // the dictionary URL with GetDictionaryWriteablePath in DicList::createDictionary.)
 167     return aURLObj.GetMainURL( INetURLObject::NO_DECODE );
 168 }
 169
 170 }   // namespace linguistic
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */