lingucomponent/source/languageguessing/guesslang.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 <iostream>
  21
  22 #include <osl/file.hxx>
  23 #include <tools/debug.hxx>
  24
  25 #include <sal/config.h>
  26 #include <cppuhelper/factory.hxx>
  27 #include <cppuhelper/implementationentry.hxx>
  28 #include <cppuhelper/implbase.hxx>
  29 #include <cppuhelper/supportsservice.hxx>
  30
  31 #include "simpleguesser.hxx"
  32 #include "guess.hxx"
  33
  34 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  35 #include <com/sun/star/lang/XServiceInfo.hpp>
  36 #include <com/sun/star/linguistic2/XLanguageGuessing.hpp>
  37 #include <unotools/pathoptions.hxx>
  38 #include <osl/thread.h>
  39
  40 #include <sal/macros.h>
  41
  42 #ifdef SYSTEM_LIBEXTTEXTCAT
  43 #include <libexttextcat/textcat.h>
  44 #else
  45 #include <textcat.h>
  46 #endif
  47
  48 using namespace ::osl;
  49 using namespace ::cppu;
  50 using namespace ::com::sun::star;
  51 using namespace ::com::sun::star::uno;
  52 using namespace ::com::sun::star::lang;
  53 using namespace ::com::sun::star::linguistic2;
  54
  55 #define SERVICENAME     "com.sun.star.linguistic2.LanguageGuessing"
  56 #define IMPLNAME        "com.sun.star.lingu2.LanguageGuessing"
  57
  58 static Sequence< OUString > getSupportedServiceNames_LangGuess_Impl()
  59 {
  60     Sequence<OUString> names { SERVICENAME };
  61     return names;
  62 }
  63
  64 static OUString getImplementationName_LangGuess_Impl()
  65 {
  66     return IMPLNAME;
  67 }
  68
  69 static osl::Mutex &  GetLangGuessMutex()
  70 {
  71     static osl::Mutex aMutex;
  72     return aMutex;
  73 }
  74
  75 class LangGuess_Impl :
  76     public ::cppu::WeakImplHelper<
  77         XLanguageGuessing,
  78         XServiceInfo >
  79 {
  80     SimpleGuesser   m_aGuesser;
  81     bool            m_bInitialized;
  82
  83     virtual ~LangGuess_Impl() override {}
  84     void    EnsureInitialized();
  85
  86 public:
  87     LangGuess_Impl();
  88     LangGuess_Impl(const LangGuess_Impl&) = delete;
  89     LangGuess_Impl& operator=(const LangGuess_Impl&) = delete;
  90
  91     // XServiceInfo implementation
  92     virtual OUString SAL_CALL getImplementationName(  ) override;
  93     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
  94     virtual Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
  95     static Sequence< OUString > getSupportedServiceNames_Static(  );
  96
  97     // XLanguageGuessing implementation
  98     virtual css::lang::Locale SAL_CALL guessPrimaryLanguage( const OUString& aText, ::sal_Int32 nStartPos, ::sal_Int32 nLen ) override;
  99     virtual void SAL_CALL disableLanguages( const css::uno::Sequence< css::lang::Locale >& aLanguages ) override;
 100     virtual void SAL_CALL enableLanguages( const css::uno::Sequence< css::lang::Locale >& aLanguages ) override;
 101     virtual css::uno::Sequence< css::lang::Locale > SAL_CALL getAvailableLanguages(  ) override;
 102     virtual css::uno::Sequence< css::lang::Locale > SAL_CALL getEnabledLanguages(  ) override;
 103     virtual css::uno::Sequence< css::lang::Locale > SAL_CALL getDisabledLanguages(  ) override;
 104
 105     // implementation specific
 106     /// @throws RuntimeException
 107     void SetFingerPrintsDB( const OUString &fileName );
 108 };
 109
 110 LangGuess_Impl::LangGuess_Impl() :
 111     m_bInitialized( false )
 112 {
 113 }
 114
 115 void LangGuess_Impl::EnsureInitialized()
 116 {
 117     if (!m_bInitialized)
 118     {
 119         // set this to true at the very start to prevent loops because of
 120         // implicitly called functions below
 121         m_bInitialized = true;
 122
 123         // set default fingerprint path to where those get installed
 124         OUString aPhysPath;
 125         OUString aURL( SvtPathOptions().GetFingerprintPath() );
 126         osl::FileBase::getSystemPathFromFileURL( aURL, aPhysPath );
 127 #ifdef _WIN32
 128         aPhysPath += "\\";
 129 #else
 130         aPhysPath += "/";
 131 #endif
 132
 133         SetFingerPrintsDB( aPhysPath );
 134
 135 #if !defined(EXTTEXTCAT_VERSION_MAJOR)
 136
 137         // disable currently not functional languages...
 138         struct LangCountry
 139         {
 140             const char *pLang;
 141             const char *pCountry;
 142         };
 143         LangCountry aDisable[] =
 144         {
 145             // not functional in modified libtextcat, but fixed in >= libexttextcat 3.1.0
 146             // which is the first with EXTTEXTCAT_VERSION_MAJOR defined
 147             {"sco", ""}, {"zh", "CN"}, {"zh", "TW"}, {"ja", ""}, {"ko", ""},
 148             {"ka", ""}, {"hi", ""}, {"mr", ""}, {"ne", ""}, {"sa", ""},
 149             {"ta", ""}, {"th", ""}, {"qu", ""}, {"yi", ""}
 150         };
 151         sal_Int32 nNum = SAL_N_ELEMENTS(aDisable);
 152         Sequence< Locale > aDisableSeq( nNum );
 153         Locale *pDisableSeq = aDisableSeq.getArray();
 154         for (sal_Int32 i = 0;  i < nNum;  ++i)
 155         {
 156             Locale aLocale;
 157             aLocale.Language = OUString::createFromAscii( aDisable[i].pLang );
 158             aLocale.Country  = OUString::createFromAscii( aDisable[i].pCountry );
 159             pDisableSeq[i] = aLocale;
 160         }
 161         disableLanguages( aDisableSeq );
 162         DBG_ASSERT( nNum == getDisabledLanguages().getLength(), "size mismatch" );
 163 #endif
 164     }
 165 }
 166
 167 Locale SAL_CALL LangGuess_Impl::guessPrimaryLanguage(
 168         const OUString& rText,
 169         ::sal_Int32 nStartPos,
 170         ::sal_Int32 nLen )
 171 {
 172     osl::MutexGuard aGuard( GetLangGuessMutex() );
 173
 174     EnsureInitialized();
 175
 176     if (nStartPos < 0 || nLen < 0 || nStartPos + nLen > rText.getLength())
 177         throw lang::IllegalArgumentException();
 178
 179     OString o( OUStringToOString( rText.copy(nStartPos, nLen), RTL_TEXTENCODING_UTF8 ) );
 180     Guess g = m_aGuesser.GuessPrimaryLanguage(o.getStr());
 181     lang::Locale aRes;
 182     aRes.Language   = OUString::createFromAscii( g.GetLanguage().c_str() );
 183     aRes.Country    = OUString::createFromAscii( g.GetCountry().c_str() );
 184     return aRes;
 185 }
 186
 187 #define DEFAULT_CONF_FILE_NAME "fpdb.conf"
 188
 189 void LangGuess_Impl::SetFingerPrintsDB(
 190         const OUString &filePath )
 191 {
 192     //! text encoding for file name / path needs to be in the same encoding the OS uses
 193     OString path = OUStringToOString( filePath, osl_getThreadTextEncoding() );
 194     OString conf_file_path = path + DEFAULT_CONF_FILE_NAME;
 195
 196     m_aGuesser.SetDBPath(conf_file_path.getStr(), path.getStr());
 197 }
 198
 199 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getAvailableLanguages(  )
 200 {
 201     osl::MutexGuard aGuard( GetLangGuessMutex() );
 202
 203     EnsureInitialized();
 204
 205     Sequence< css::lang::Locale > aRes;
 206     vector<Guess> gs = m_aGuesser.GetAllManagedLanguages();
 207     aRes.realloc(gs.size());
 208
 209     css::lang::Locale *pRes = aRes.getArray();
 210
 211     for(size_t i = 0; i < gs.size() ; i++ ){
 212         css::lang::Locale current_aRes;
 213         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 214         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 215         pRes[i] = current_aRes;
 216     }
 217
 218     return aRes;
 219 }
 220
 221 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getEnabledLanguages(  )
 222 {
 223     osl::MutexGuard aGuard( GetLangGuessMutex() );
 224
 225     EnsureInitialized();
 226
 227     Sequence< css::lang::Locale > aRes;
 228     vector<Guess> gs = m_aGuesser.GetAvailableLanguages();
 229     aRes.realloc(gs.size());
 230
 231     css::lang::Locale *pRes = aRes.getArray();
 232
 233     for(size_t i = 0; i < gs.size() ; i++ ){
 234         css::lang::Locale current_aRes;
 235         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 236         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 237         pRes[i] = current_aRes;
 238     }
 239
 240     return aRes;
 241 }
 242
 243 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getDisabledLanguages(  )
 244 {
 245     osl::MutexGuard aGuard( GetLangGuessMutex() );
 246
 247     EnsureInitialized();
 248
 249     Sequence< css::lang::Locale > aRes;
 250     vector<Guess> gs = m_aGuesser.GetUnavailableLanguages();
 251     aRes.realloc(gs.size());
 252
 253     css::lang::Locale *pRes = aRes.getArray();
 254
 255     for(size_t i = 0; i < gs.size() ; i++ ){
 256         css::lang::Locale current_aRes;
 257         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 258         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 259         pRes[i] = current_aRes;
 260     }
 261
 262     return aRes;
 263 }
 264
 265 void SAL_CALL LangGuess_Impl::disableLanguages(
 266         const uno::Sequence< Locale >& rLanguages )
 267 {
 268     osl::MutexGuard aGuard( GetLangGuessMutex() );
 269
 270     EnsureInitialized();
 271
 272     for (const Locale& rLanguage : rLanguages)
 273     {
 274         string language;
 275
 276         OString l = OUStringToOString( rLanguage.Language, RTL_TEXTENCODING_ASCII_US );
 277         OString c = OUStringToOString( rLanguage.Country, RTL_TEXTENCODING_ASCII_US );
 278
 279         language += l.getStr();
 280         language += "-";
 281         language += c.getStr();
 282         m_aGuesser.DisableLanguage(language);
 283     }
 284 }
 285
 286 void SAL_CALL LangGuess_Impl::enableLanguages(
 287         const uno::Sequence< Locale >& rLanguages )
 288 {
 289     osl::MutexGuard aGuard( GetLangGuessMutex() );
 290
 291     EnsureInitialized();
 292
 293     for (const Locale& rLanguage : rLanguages)
 294     {
 295         string language;
 296
 297         OString l = OUStringToOString( rLanguage.Language, RTL_TEXTENCODING_ASCII_US );
 298         OString c = OUStringToOString( rLanguage.Country, RTL_TEXTENCODING_ASCII_US );
 299
 300         language += l.getStr();
 301         language += "-";
 302         language += c.getStr();
 303         m_aGuesser.EnableLanguage(language);
 304     }
 305 }
 306
 307 OUString SAL_CALL LangGuess_Impl::getImplementationName(  )
 308 {
 309     return IMPLNAME;
 310 }
 311
 312 sal_Bool SAL_CALL LangGuess_Impl::supportsService( const OUString& ServiceName )
 313 {
 314     return cppu::supportsService(this, ServiceName);
 315 }
 316
 317 Sequence<OUString> SAL_CALL LangGuess_Impl::getSupportedServiceNames(  )
 318 {
 319     return getSupportedServiceNames_Static();
 320 }
 321
 322 Sequence<OUString> LangGuess_Impl::getSupportedServiceNames_Static(  )
 323 {
 324     return { SERVICENAME };
 325 }
 326
 327 /**
 328  * Function to create a new component instance; is needed by factory helper implementation.
 329  * @param xMgr service manager to if the components needs other component instances
 330  */
 331 static Reference< XInterface > LangGuess_Impl_create(
 332     Reference< XComponentContext > const & )
 333 {
 334     return static_cast< ::cppu::OWeakObject * >( new LangGuess_Impl );
 335 }
 336
 337 //#### EXPORTED ### functions to allow for registration and creation of the UNO component
 338 static const struct ::cppu::ImplementationEntry s_component_entries [] =
 339 {
 340     {
 341         LangGuess_Impl_create, getImplementationName_LangGuess_Impl,
 342         getSupportedServiceNames_LangGuess_Impl,
 343         ::cppu::createSingleComponentFactory,
 344         nullptr, 0
 345     },
 346     { nullptr, nullptr, nullptr, nullptr, nullptr, 0 }
 347 };
 348
 349 extern "C"
 350 {
 351
 352 SAL_DLLPUBLIC_EXPORT void * guesslang_component_getFactory(
 353     sal_Char const * implName, void * xMgr,
 354     void * xRegistry )
 355 {
 356     return ::cppu::component_getFactoryHelper(
 357         implName, xMgr, xRegistry, s_component_entries );
 358 }
 359
 360 }
 361
 362 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */