configmgr/source/localbe/localhierarchybrowsersvc.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: localhierarchybrowsersvc.cxx,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33
  34 #include "localhierarchybrowsersvc.hxx"
  35 #include "localsinglebackend.hxx"
  36
  37 #ifndef CONFIGMGR_API_FACTORY_HXX_
  38 #include "confapifactory.hxx"
  39 #endif
  40 #include <com/sun/star/lang/NullPointerException.hpp>
  41 #include <rtl/ustrbuf.hxx>
  42
  43 #include <algorithm>
  44 // -----------------------------------------------------------------------------
  45
  46 #define OUSTRING( constascii ) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(constascii))
  47 // -----------------------------------------------------------------------------
  48
  49 namespace configmgr
  50 {
  51 // -----------------------------------------------------------------------------
  52     namespace localbe
  53     {
  54 // -----------------------------------------------------------------------------
  55
  56 sal_Char const * const aLocalHierarchyBrowserServices[] =
  57 {
  58     "com.sun.star.configuration.backend.LocalHierarchyBrowser",
  59     0,
  60     "com.sun.star.configuration.backend.HierarchyBrowser",
  61     0
  62 };
  63 const ServiceImplementationInfo aLocalHierarchyBrowserSI =
  64 {
  65     "com.sun.star.comp.configuration.backend.LocalHierarchyBrowser",
  66     aLocalHierarchyBrowserServices,
  67     aLocalHierarchyBrowserServices + 3
  68 };
  69 // -----------------------------------------------------------------------------
  70
  71 const ServiceRegistrationInfo* getLocalHierarchyBrowserServiceInfo()
  72 { return getRegistrationInfo(& aLocalHierarchyBrowserSI); }
  73 // -----------------------------------------------------------------------------
  74
  75 inline
  76 ServiceInfoHelper LocalHierarchyBrowserService::getServiceInfo()
  77 {
  78     return & aLocalHierarchyBrowserSI;
  79 }
  80 // -----------------------------------------------------------------------------
  81
  82 uno::Reference< uno::XInterface > SAL_CALL instantiateLocalHierarchyBrowser
  83 ( uno::Reference< uno::XComponentContext > const& rServiceManager )
  84 {
  85     return * new LocalHierarchyBrowserService( rServiceManager );
  86 }
  87 // -----------------------------------------------------------------------------
  88
  89 LocalHierarchyBrowserService::LocalHierarchyBrowserService(uno::Reference< uno::XComponentContext > const & _xContext)
  90 : m_xServiceFactory(_xContext->getServiceManager(), uno::UNO_QUERY)
  91 {
  92     if (!m_xServiceFactory.is())
  93     {
  94         rtl::OUString sMessage( RTL_CONSTASCII_USTRINGPARAM("Configuration Importer: Unexpected NULL context"));
  95         throw lang::NullPointerException(sMessage,NULL);
  96     }
  97 }
  98 // -----------------------------------------------------------------------------
  99
 100 LocalHierarchyBrowserService::~LocalHierarchyBrowserService()
 101 {}
 102 // -----------------------------------------------------------------------------
 103
 104 namespace
 105 {
 106     struct JobDesc
 107     {
 108         explicit JobDesc(task::XJob * pJob, const uno::Sequence< beans::NamedValue >& aArguments);
 109
 110         enum Mode   { findNone, findSchemas, findLayers };
 111         enum Result { getDefault,getUrls, getNames };
 112
 113         rtl::OUString                    aBaseDataUrl;
 114         uno::Sequence< rtl::OUString >   aExcludeList;
 115         Mode                        mode;
 116         Result                      result_type;
 117     };
 118
 119     JobDesc::JobDesc(task::XJob * pJob, const uno::Sequence< beans::NamedValue >& aArguments)
 120     : aBaseDataUrl()
 121     , aExcludeList()
 122     , mode(findNone)
 123     , result_type(getDefault)
 124     {
 125         sal_Int16 const nCount = static_cast<sal_Int16>(aArguments.getLength());
 126
 127         if (sal_Int32(nCount) != aArguments.getLength())
 128         {
 129             rtl::OUString sMessage = OUSTRING("Too many arguments for LocalHierarchyBrowser Job");
 130             throw lang::IllegalArgumentException(sMessage,pJob,0);
 131         }
 132
 133         for (sal_Int16 i=0; i < nCount; ++i)
 134         {
 135             sal_Bool bKnown = false;
 136             sal_Bool bGood  = false;
 137
 138             if (aArguments[i].Name.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("SchemaDataUrl")))
 139             {
 140                 bKnown = true;
 141                 bGood  = (aArguments[i].Value >>= aBaseDataUrl);
 142                 mode = (bGood && aBaseDataUrl.getLength()) ? findSchemas : findNone;
 143             }
 144             else if (aArguments[i].Name.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("LayerDataUrl")))
 145             {
 146                 bKnown = true;
 147
 148                 rtl::OUString aLayerBaseUrl;
 149                 bGood  = (aArguments[i].Value >>= aLayerBaseUrl);
 150
 151                 if (aLayerBaseUrl.getLength())
 152                 {
 153                     rtl::OUString aLocalizedSubDir;
 154                     LocalSingleBackend::getLayerSubDirectories(aLayerBaseUrl,this->aBaseDataUrl,aLocalizedSubDir);
 155
 156                     mode = findLayers;
 157                 }
 158                 else
 159                 {
 160                     mode = findNone;
 161                 }
 162             }
 163             else if (aArguments[i].Name.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("ExcludeComponents")))
 164             {
 165                 bKnown = true;
 166
 167                 sal_Int32 const nNextIndex = aExcludeList.getLength();
 168
 169                 switch (aArguments[i].Value.getValueTypeClass())
 170                 {
 171                 case uno::TypeClass_STRING:
 172                     {
 173                         rtl::OUString aComponent;
 174                         bGood = (aArguments[i].Value >>= aComponent);
 175
 176                         OSL_ASSERT(bGood);
 177
 178                         aExcludeList.realloc(nNextIndex + 1);
 179                         aExcludeList[nNextIndex] = aComponent;
 180                     }
 181                     break;
 182
 183                 case uno::TypeClass_SEQUENCE:
 184                     {
 185                         uno::Sequence<rtl::OUString> aComponentList;
 186                         bGood = (aArguments[i].Value >>= aComponentList);
 187
 188                         if (bGood)
 189                         {
 190                             sal_Int32 const nCompListCount = aComponentList.getLength();
 191                             aExcludeList.realloc(nNextIndex + nCompListCount);
 192
 193                             rtl::OUString const * pSrc = aComponentList.getConstArray();
 194                             std::copy(pSrc,pSrc+nCompListCount,aExcludeList.getArray());
 195                         }
 196                     }
 197                     break;
 198
 199                 default:
 200                     OSL_ASSERT(!bGood);
 201                     break;
 202                 }
 203             }
 204             else if (aArguments[i].Name.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("FetchComponentNames")))
 205             {
 206                 sal_Bool bComponents = sal_False;
 207
 208                 bKnown = true;
 209                 if (aArguments[i].Value.hasValue())
 210                 {
 211                     bGood  = (aArguments[i].Value >>= bComponents);
 212                     if (bGood) result_type = bComponents ? getNames : getUrls;
 213                 }
 214                 else
 215                 {
 216                     bGood = true;
 217                     result_type = getDefault;
 218                 }
 219             }
 220
 221             if (!bGood)
 222             {
 223                 rtl::OUStringBuffer sMsg;
 224                 sMsg.appendAscii("LocalHierarchyBrowser - Illegal argument: ");
 225                 if (bKnown)
 226                     sMsg.appendAscii("Wrong value type for argument '");
 227                 else
 228                     sMsg.appendAscii("Unknown argument '");
 229
 230                 sMsg.append(aArguments[i].Name).appendAscii("'.");
 231
 232                 throw lang::IllegalArgumentException(sMsg.makeStringAndClear(),pJob,i+1);
 233             }
 234         }
 235         if (findNone == mode)
 236         {
 237             rtl::OUStringBuffer sMsg;
 238             sMsg.appendAscii("LocalHierarchyBrowser - Missing argument: ");
 239             sMsg.appendAscii("No data URL available");
 240             throw lang::IllegalArgumentException(sMsg.makeStringAndClear(),pJob,0);
 241         }
 242         if (getDefault == result_type)
 243             result_type = (mode == findSchemas) ? getNames : getUrls;
 244
 245     }
 246
 247     static
 248     inline
 249     rtl::OUString getDataFileExtension(JobDesc::Mode mode)
 250     {
 251         switch (mode)
 252         {
 253         case JobDesc::findSchemas: return OUSTRING(".xcs");
 254         case JobDesc::findLayers:  return OUSTRING(".xcu");
 255         default: OSL_ASSERT(false); return rtl::OUString();
 256         }
 257     }
 258 }
 259 // -----------------------------------------------------------------------------
 260
 261 // XJob
 262
 263 uno::Any SAL_CALL
 264     LocalHierarchyBrowserService::execute( const uno::Sequence< beans::NamedValue >& Arguments )
 265         throw (lang::IllegalArgumentException, uno::Exception, uno::RuntimeException)
 266 {
 267     JobDesc const aJob(this,Arguments);
 268
 269     OSL_ASSERT(JobDesc::getUrls == aJob.result_type || JobDesc::getNames == aJob.result_type);
 270
 271     uno::Sequence< rtl::OUString > (LocalHierarchyBrowserService::* const find)( rtl::OUString const & _aBaseDirectory, rtl::OUString const & _aComponentFileExtension, uno::Sequence< rtl::OUString > const & aExcludeList) = (JobDesc::getUrls == aJob.result_type) ?
 272         &LocalHierarchyBrowserService::findLocalComponentUrls :
 273         &LocalHierarchyBrowserService::findLocalComponentNames;
 274
 275     uno::Sequence< rtl::OUString > aComponents = (this->*find)(aJob.aBaseDataUrl,getDataFileExtension(aJob.mode), aJob.aExcludeList);
 276
 277     return uno::makeAny(aComponents);
 278 }
 279 // -----------------------------------------------------------------------------
 280
 281 // XServiceInfo
 282
 283 rtl::OUString SAL_CALL
 284     LocalHierarchyBrowserService::getImplementationName(  )
 285         throw (uno::RuntimeException)
 286 {
 287     return getServiceInfo().getImplementationName( );
 288 }
 289 // -----------------------------------------------------------------------------
 290
 291 sal_Bool SAL_CALL
 292     LocalHierarchyBrowserService::supportsService( const rtl::OUString& ServiceName )
 293         throw (uno::RuntimeException)
 294 {
 295     return getServiceInfo().supportsService( ServiceName );
 296 }
 297 // -----------------------------------------------------------------------------
 298
 299
 300 uno::Sequence< ::rtl::OUString > SAL_CALL
 301     LocalHierarchyBrowserService::getSupportedServiceNames(  )
 302         throw (uno::RuntimeException)
 303 {
 304     return getServiceInfo().getSupportedServiceNames( );
 305 }
 306 // -----------------------------------------------------------------------------
 307 // -----------------------------------------------------------------------------
 308     } // namespace
 309
 310 // -----------------------------------------------------------------------------
 311 } // namespace
 312
 313 // -----------------------------------------------------------------------------
 314 // -----------------------------------------------------------------------------
 315
 316 #include "filehelper.hxx"
 317 #include <osl/file.hxx>
 318 #include "tools/getprocessworkingdir.hxx"
 319 #include <vector>
 320 // -----------------------------------------------------------------------------
 321
 322     namespace uno = com::sun::star::uno;
 323     // -----------------------------------------------------------------------------
 324
 325     #define OSL_VERIFY_RC( expr ) OSL_VERIFY( (expr) == osl::FileBase::E_None )
 326     //------------------------------------------------------------------------------
 327     static
 328     inline
 329     bool matchesExtension( rtl::OUString const & aFileName, rtl::OUString const & aExt )
 330     {
 331         sal_Int32 const nExtStart = aFileName.getLength() - aExt.getLength();
 332         return nExtStart > 0 && !!aFileName.copy(nExtStart).equalsIgnoreAsciiCase(aExt);
 333     }
 334     //------------------------------------------------------------------------------
 335     static
 336     inline
 337     rtl::OUString stripExtension( rtl::OUString const & aFileName, rtl::OUString const & aExt )
 338     {
 339         OSL_PRECOND( matchesExtension(aFileName,aExt), "File name doesn't have expected extension");
 340
 341         sal_Int32 const nExtStart = aFileName.getLength() - aExt.getLength();
 342         return aFileName.copy(0,nExtStart);
 343     }
 344 //------------------------------------------------------------------------------
 345     static
 346     inline
 347     bool matchesExtension( osl::FileStatus const & aFileDescriptor, rtl::OUString const & aExt )
 348     {
 349         OSL_PRECOND( aFileDescriptor.isValid(FileStatusMask_Type | FileStatusMask_FileName),
 350                     "Not all required file-status fields available for filter" );
 351
 352         if (aFileDescriptor.getFileType() != osl::FileStatus::Regular)
 353             return false;
 354
 355         return matchesExtension(aFileDescriptor.getFileName(),aExt);
 356     }
 357 //------------------------------------------------------------------------------
 358
 359     static
 360     bool makeAbsoluteURL(rtl::OUString & rURL )
 361     {
 362         rtl::OUString aBaseDir; tools::getProcessWorkingDir(&aBaseDir);
 363
 364         osl::File::RC errcode = osl::File::getAbsoluteFileURL(aBaseDir,rURL,rURL);
 365
 366         return osl::File::E_None == errcode;
 367     }
 368 //------------------------------------------------------------------------------
 369     static
 370     inline
 371     bool getNextDirectoryItem(osl::Directory & aDirectory, osl::DirectoryItem & aItem, osl::Directory::RC & errcode)
 372     {
 373         switch (errcode = aDirectory.getNextItem(aItem))
 374         {
 375         case osl::Directory::E_None:
 376             return true;
 377
 378         case osl::Directory::E_NOENT:
 379             errcode = osl::Directory::E_None;
 380             return false;
 381
 382         default:
 383             return false;
 384         }
 385     }
 386 //------------------------------------------------------------------------------
 387     static inline bool isExcluded(rtl::OUString const & aName, uno::Sequence< rtl::OUString > const & aExcludeList)
 388     {
 389         for (sal_Int32 i = 0; i<aExcludeList.getLength(); ++i)
 390         {
 391             if (aExcludeList[i].equals(aName)) return true;
 392         }
 393         return false;
 394     }
 395 //------------------------------------------------------------------------------
 396     static
 397     osl::FileBase::RC findComponents( std::vector<rtl::OUString> * componentNames, std::vector<rtl::OUString> * componentUrls,
 398                                         rtl::OUString const& aDirectoryPath, rtl::OUString const& aComponentExtension,
 399                                         rtl::OUString const& aPackagePrefix, rtl::OUString const & aComponentSeparator,
 400                                         uno::Sequence< rtl::OUString > const & aExcludeList)
 401     {
 402         static sal_Unicode const chDirSep = '/';
 403         static rtl::OUString    const sDirectorySeparator(&chDirSep,1);
 404
 405         osl::Directory aDirectory(aDirectoryPath);
 406
 407         osl::Directory::RC errcode = aDirectory.open();
 408
 409         if (errcode == osl::Directory::E_None)
 410         {
 411             sal_uInt32 n_STATUS_FIELDS =  FileStatusMask_Type | FileStatusMask_FileName;
 412             if (componentUrls) n_STATUS_FIELDS |= FileStatusMask_FileURL;
 413
 414             osl::DirectoryItem aItem;
 415             while( getNextDirectoryItem(aDirectory,aItem,errcode) )
 416             {
 417
 418                 osl::FileStatus aItemDescriptor( n_STATUS_FIELDS );
 419                 errcode = aItem.getFileStatus(aItemDescriptor);
 420
 421                 if ( errcode != osl::DirectoryItem::E_None )
 422                 {
 423                     OSL_TRACE("Locating Configuration Components - Error (%u) getting status of directory item - skipping\n", unsigned(errcode));
 424                     continue;
 425                 }
 426
 427                 OSL_ENSURE( aItemDescriptor.isValid(FileStatusMask_Type), "Could not get type of directory item");
 428
 429                 if (aItemDescriptor.getFileType() == osl::FileStatus::Directory)
 430                 {
 431                     OSL_ENSURE( aItemDescriptor.isValid(FileStatusMask_FileName), "Could not get name of subdirectory");
 432
 433                     rtl::OUString const aSubdirName = aItemDescriptor.getFileName();
 434                     rtl::OUString const aSubdirPath = aDirectoryPath + sDirectorySeparator + aSubdirName;
 435                     rtl::OUString const aSubpackagePrefix = aPackagePrefix + aSubdirName + aComponentSeparator;
 436                     // recurse
 437                     if (!isExcluded(aSubpackagePrefix,aExcludeList))
 438                         OSL_VERIFY_RC( findComponents( componentNames,  componentUrls,
 439                                                         aSubdirPath, aComponentExtension,
 440                                                         aSubpackagePrefix, aComponentSeparator,
 441                                                         aExcludeList) );
 442                 }
 443                 else if (matchesExtension(aItemDescriptor,aComponentExtension))
 444                 {
 445                     OSL_ENSURE( aItemDescriptor.isValid(FileStatusMask_FileName), "Could not get name of component found");
 446
 447                     rtl::OUString const aComponentName = stripExtension( aItemDescriptor.getFileName(), aComponentExtension );
 448                     rtl::OUString const aFullComponentName = aPackagePrefix + aComponentName;
 449
 450                     if (!isExcluded(aFullComponentName,aExcludeList))
 451                     {
 452                         if (componentNames)
 453                         {
 454                             componentNames->push_back(aFullComponentName);
 455                         }
 456
 457                         if (componentUrls)
 458                         {
 459                             OSL_ENSURE( aItemDescriptor.isValid(FileStatusMask_FileURL), "Could not get URL of component found");
 460
 461                             componentUrls->push_back(aItemDescriptor.getFileURL());
 462                         }
 463                     }
 464                 }
 465             }
 466             aDirectory.close();
 467         }
 468         return errcode;
 469     }
 470 // -----------------------------------------------------------------------------
 471
 472     uno::Sequence< rtl::OUString > configmgr::localbe::LocalHierarchyBrowserService::findLocalComponentNames( rtl::OUString const & _aBaseDirectory, rtl::OUString const & _aComponentFileExtension, uno::Sequence< rtl::OUString > const & aExcludeList)
 473     {
 474         rtl::OUString aBaseDirectory(_aBaseDirectory);
 475         OSL_VERIFY( makeAbsoluteURL(aBaseDirectory) );
 476
 477         static const sal_Unicode chPkgSep = '.';
 478
 479         std::vector< rtl::OUString > components;
 480
 481         osl::Directory::RC errcode = findComponents(&components, NULL,
 482                                                     aBaseDirectory, _aComponentFileExtension,
 483                                                     rtl::OUString(), rtl::OUString(&chPkgSep,1),
 484                                                     aExcludeList );
 485
 486         if (errcode != osl::Directory::E_None)
 487         {
 488             OSL_TRACE("Locating Configuration Components failed - Error (%u) trying to locate files\n", unsigned(errcode));
 489
 490             if (errcode != osl::Directory::E_NOENT)
 491             {
 492                 rtl::OUString sMsg = OUSTRING("LocalHierarchyBrowser - IO Error while scanning for components: ") +
 493                                 FileHelper::createOSLErrorString(errcode);
 494
 495                 throw com::sun::star::io::IOException(sMsg,*this);
 496             }
 497         }
 498
 499         return uno::Sequence< rtl::OUString >(&components.front(),components.size());
 500     }
 501 // -----------------------------------------------------------------------------
 502
 503     uno::Sequence< rtl::OUString > configmgr::localbe::LocalHierarchyBrowserService::findLocalComponentUrls( rtl::OUString const & _aBaseDirectory, rtl::OUString const & _aComponentFileExtension, uno::Sequence< rtl::OUString > const & aExcludeList)
 504     {
 505         rtl::OUString aBaseDirectory(_aBaseDirectory);
 506         OSL_VERIFY( makeAbsoluteURL(aBaseDirectory) );
 507
 508         static const sal_Unicode chPkgSep = '.';
 509
 510         std::vector< rtl::OUString > components;
 511
 512         osl::Directory::RC errcode = findComponents(NULL, &components,
 513                                                     aBaseDirectory, _aComponentFileExtension,
 514                                                     rtl::OUString(), rtl::OUString(&chPkgSep,1),
 515                                                     aExcludeList );
 516
 517         if (errcode != osl::Directory::E_None)
 518         {
 519             OSL_TRACE("Locating Configuration Components failed - Error (%u) trying to locate files\n", unsigned(errcode));
 520
 521             if (errcode != osl::Directory::E_NOENT)
 522             {
 523                 rtl::OUString sMsg = OUSTRING("LocalHierarchyBrowser - IO Error while scanning for component files: ") +
 524                                 FileHelper::createOSLErrorString(errcode);
 525
 526                 throw com::sun::star::io::IOException(sMsg,*this);
 527             }
 528         }
 529
 530         return uno::Sequence< rtl::OUString >(&components.front(),components.size());
 531     }
 532 //------------------------------------------------------------------------------
 533
 534 // -----------------------------------------------------------------------------
 535 // -----------------------------------------------------------------------------
 536