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 OUString( 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);
 195     conf_file_path += DEFAULT_CONF_FILE_NAME;
 196
 197     m_aGuesser.SetDBPath(conf_file_path.getStr(), path.getStr());
 198 }
 199
 200 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getAvailableLanguages(  )
 201 {
 202     osl::MutexGuard aGuard( GetLangGuessMutex() );
 203
 204     EnsureInitialized();
 205
 206     Sequence< css::lang::Locale > aRes;
 207     vector<Guess> gs = m_aGuesser.GetAllManagedLanguages();
 208     aRes.realloc(gs.size());
 209
 210     css::lang::Locale *pRes = aRes.getArray();
 211
 212     for(size_t i = 0; i < gs.size() ; i++ ){
 213         css::lang::Locale current_aRes;
 214         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 215         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 216         pRes[i] = current_aRes;
 217     }
 218
 219     return aRes;
 220 }
 221
 222 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getEnabledLanguages(  )
 223 {
 224     osl::MutexGuard aGuard( GetLangGuessMutex() );
 225
 226     EnsureInitialized();
 227
 228     Sequence< css::lang::Locale > aRes;
 229     vector<Guess> gs = m_aGuesser.GetAvailableLanguages();
 230     aRes.realloc(gs.size());
 231
 232     css::lang::Locale *pRes = aRes.getArray();
 233
 234     for(size_t i = 0; i < gs.size() ; i++ ){
 235         css::lang::Locale current_aRes;
 236         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 237         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 238         pRes[i] = current_aRes;
 239     }
 240
 241     return aRes;
 242 }
 243
 244 uno::Sequence< Locale > SAL_CALL LangGuess_Impl::getDisabledLanguages(  )
 245 {
 246     osl::MutexGuard aGuard( GetLangGuessMutex() );
 247
 248     EnsureInitialized();
 249
 250     Sequence< css::lang::Locale > aRes;
 251     vector<Guess> gs = m_aGuesser.GetUnavailableLanguages();
 252     aRes.realloc(gs.size());
 253
 254     css::lang::Locale *pRes = aRes.getArray();
 255
 256     for(size_t i = 0; i < gs.size() ; i++ ){
 257         css::lang::Locale current_aRes;
 258         current_aRes.Language   = OUString::createFromAscii( gs[i].GetLanguage().c_str() );
 259         current_aRes.Country    = OUString::createFromAscii( gs[i].GetCountry().c_str() );
 260         pRes[i] = current_aRes;
 261     }
 262
 263     return aRes;
 264 }
 265
 266 void SAL_CALL LangGuess_Impl::disableLanguages(
 267         const uno::Sequence< Locale >& rLanguages )
 268 {
 269     osl::MutexGuard aGuard( GetLangGuessMutex() );
 270
 271     EnsureInitialized();
 272
 273     sal_Int32 nLanguages = rLanguages.getLength();
 274     const Locale *pLanguages = rLanguages.getConstArray();
 275
 276     for (sal_Int32 i = 0;  i < nLanguages;  ++i)
 277     {
 278         string language;
 279
 280         OString l = OUStringToOString( pLanguages[i].Language, RTL_TEXTENCODING_ASCII_US );
 281         OString c = OUStringToOString( pLanguages[i].Country, RTL_TEXTENCODING_ASCII_US );
 282
 283         language += l.getStr();
 284         language += "-";
 285         language += c.getStr();
 286         m_aGuesser.DisableLanguage(language);
 287     }
 288 }
 289
 290 void SAL_CALL LangGuess_Impl::enableLanguages(
 291         const uno::Sequence< Locale >& rLanguages )
 292 {
 293     osl::MutexGuard aGuard( GetLangGuessMutex() );
 294
 295     EnsureInitialized();
 296
 297     sal_Int32 nLanguages = rLanguages.getLength();
 298     const Locale *pLanguages = rLanguages.getConstArray();
 299
 300     for (sal_Int32 i = 0;  i < nLanguages;  ++i)
 301     {
 302         string language;
 303
 304         OString l = OUStringToOString( pLanguages[i].Language, RTL_TEXTENCODING_ASCII_US );
 305         OString c = OUStringToOString( pLanguages[i].Country, RTL_TEXTENCODING_ASCII_US );
 306
 307         language += l.getStr();
 308         language += "-";
 309         language += c.getStr();
 310         m_aGuesser.EnableLanguage(language);
 311     }
 312 }
 313
 314 OUString SAL_CALL LangGuess_Impl::getImplementationName(  )
 315 {
 316     return OUString( IMPLNAME );
 317 }
 318
 319 sal_Bool SAL_CALL LangGuess_Impl::supportsService( const OUString& ServiceName )
 320 {
 321     return cppu::supportsService(this, ServiceName);
 322 }
 323
 324 Sequence<OUString> SAL_CALL LangGuess_Impl::getSupportedServiceNames(  )
 325 {
 326     return getSupportedServiceNames_Static();
 327 }
 328
 329 Sequence<OUString> LangGuess_Impl::getSupportedServiceNames_Static(  )
 330 {
 331     OUString aName( SERVICENAME );
 332     return Sequence< OUString >( &aName, 1 );
 333 }
 334
 335 /**
 336  * Function to create a new component instance; is needed by factory helper implementation.
 337  * @param xMgr service manager to if the components needs other component instances
 338  */
 339 static Reference< XInterface > LangGuess_Impl_create(
 340     Reference< XComponentContext > const & )
 341 {
 342     return static_cast< ::cppu::OWeakObject * >( new LangGuess_Impl );
 343 }
 344
 345 //#### EXPORTED ### functions to allow for registration and creation of the UNO component
 346 static const struct ::cppu::ImplementationEntry s_component_entries [] =
 347 {
 348     {
 349         LangGuess_Impl_create, getImplementationName_LangGuess_Impl,
 350         getSupportedServiceNames_LangGuess_Impl,
 351         ::cppu::createSingleComponentFactory,
 352         nullptr, 0
 353     },
 354     { nullptr, nullptr, nullptr, nullptr, nullptr, 0 }
 355 };
 356
 357 extern "C"
 358 {
 359
 360 SAL_DLLPUBLIC_EXPORT void * guesslang_component_getFactory(
 361     sal_Char const * implName, void * xMgr,
 362     void * xRegistry )
 363 {
 364     return ::cppu::component_getFactoryHelper(
 365         implName, xMgr, xRegistry, s_component_entries );
 366 }
 367
 368 }
 369
 370 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */