sd/source/core/TransitionPreset.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 <set>
  21
  22 #include <com/sun/star/animations/XTransitionFilter.hpp>
  23 #include <com/sun/star/container/XEnumerationAccess.hpp>
  24 #include <com/sun/star/container/XNameAccess.hpp>
  25 #include <com/sun/star/configuration/theDefaultProvider.hpp>
  26 #include <com/sun/star/beans/NamedValue.hpp>
  27 #include <com/sun/star/animations/AnimationNodeType.hpp>
  28 #include <com/sun/star/animations/TransitionType.hpp>
  29 #include <com/sun/star/animations/TransitionSubType.hpp>
  30 #include <unotools/configmgr.hxx>
  31 #include <comphelper/getexpandeduri.hxx>
  32 #include <comphelper/processfactory.hxx>
  33 #include <comphelper/propertysequence.hxx>
  34 #include <comphelper/lok.hxx>
  35 #include <unotools/syslocaleoptions.hxx>
  36 #include <officecfg/Office/Impress.hxx>
  37 #include <officecfg/Office/UI/Effects.hxx>
  38 #include <comphelper/diagnose_ex.hxx>
  39
  40 #include <sal/log.hxx>
  41 #include <vcl/svapp.hxx>
  42
  43 #include <CustomAnimationPreset.hxx>
  44 #include <TransitionPreset.hxx>
  45
  46 using namespace ::com::sun::star;
  47 using namespace ::com::sun::star::animations;
  48
  49 using ::com::sun::star::uno::UNO_QUERY_THROW;
  50 using ::com::sun::star::uno::Any;
  51 using ::com::sun::star::uno::Sequence;
  52 using ::com::sun::star::uno::Reference;
  53 using ::com::sun::star::uno::Exception;
  54 using ::com::sun::star::lang::XMultiServiceFactory;
  55 using ::com::sun::star::container::XEnumerationAccess;
  56 using ::com::sun::star::container::XEnumeration;
  57 using ::com::sun::star::beans::NamedValue;
  58
  59 namespace sd {
  60
  61 TransitionPreset::TransitionPreset( const css::uno::Reference< css::animations::XAnimationNode >& xNode )
  62 {
  63     // first locate preset id
  64     const Sequence< NamedValue > aUserData( xNode->getUserData() );
  65     const NamedValue* pProp = std::find_if(aUserData.begin(), aUserData.end(),
  66         [](const NamedValue& rProp) { return rProp.Name == "preset-id"; });
  67     if (pProp != aUserData.end())
  68         pProp->Value >>= maPresetId;
  69
  70     // second, locate transition filter element
  71     Reference< XEnumerationAccess > xEnumerationAccess( xNode, UNO_QUERY_THROW );
  72     Reference< XEnumeration > xEnumeration( xEnumerationAccess->createEnumeration(), css::uno::UNO_SET_THROW );
  73     Reference< XTransitionFilter > xTransition( xEnumeration->nextElement(), UNO_QUERY_THROW );
  74
  75     mnTransition = xTransition->getTransition();
  76     mnSubtype = xTransition->getSubtype();
  77     mbDirection = xTransition->getDirection();
  78     mnFadeColor = xTransition->getFadeColor();
  79 }
  80
  81 bool TransitionPreset::importTransitionsFile( TransitionPresetList& rList,
  82                                               Reference< XMultiServiceFactory > const & xServiceFactory,
  83                                               const OUString& aURL )
  84 {
  85     SAL_INFO("sd.transitions", "Importing " << aURL);
  86
  87     Reference< container::XNameAccess > xTransitionSets( officecfg::Office::UI::Effects::UserInterface::TransitionSets::get() );
  88     Reference< container::XNameAccess > xTransitionGroups( officecfg::Office::UI::Effects::UserInterface::TransitionGroups::get() );
  89     Reference< container::XNameAccess > xTransitionVariants( officecfg::Office::UI::Effects::UserInterface::TransitionVariants::get() );
  90     Reference< container::XNameAccess > xTransitions( officecfg::Office::UI::Effects::UserInterface::Transitions::get() );
  91
  92     // import transition presets
  93     Reference< XAnimationNode > xAnimationNode;
  94
  95     const std::set<sal_Int16> LOKSupportedTransitionTypes = {
  96             TransitionType::BARWIPE,
  97             TransitionType::BOXWIPE,
  98             TransitionType::FOURBOXWIPE,
  99             TransitionType::ELLIPSEWIPE,
 100             TransitionType::CLOCKWIPE,
 101             TransitionType::PINWHEELWIPE,
 102             TransitionType::PUSHWIPE,
 103             TransitionType::SLIDEWIPE,
 104             TransitionType::FADE,
 105             TransitionType::RANDOMBARWIPE,
 106             TransitionType::CHECKERBOARDWIPE,
 107             TransitionType::DISSOLVE,
 108             TransitionType::SNAKEWIPE,
 109             TransitionType::PARALLELSNAKESWIPE,
 110             TransitionType::IRISWIPE,
 111             TransitionType::BARNDOORWIPE,
 112             TransitionType::VEEWIPE,
 113             TransitionType::ZIGZAGWIPE,
 114             TransitionType::BARNZIGZAGWIPE,
 115             TransitionType::FANWIPE,
 116             TransitionType::SINGLESWEEPWIPE,
 117             TransitionType::WATERFALLWIPE,
 118             TransitionType::SPIRALWIPE,
 119             TransitionType::MISCDIAGONALWIPE,
 120             TransitionType::BOXSNAKESWIPE,
 121             TransitionType::BLINDSWIPE,
 122             TransitionType::MISCSHAPEWIPE,
 123             TransitionType::ZOOM
 124     };
 125
 126     const std::set<sal_Int16> LOKSupportedTransitionSubTypes = {
 127             TransitionSubType::DEFAULT,
 128             TransitionSubType::LEFTTORIGHT,
 129             TransitionSubType::TOPTOBOTTOM,
 130             TransitionSubType::CORNERSIN,
 131             TransitionSubType::CORNERSOUT,
 132             TransitionSubType::VERTICAL,
 133             TransitionSubType::HORIZONTAL,
 134             TransitionSubType::DOWN,
 135             TransitionSubType::CIRCLE,
 136             TransitionSubType::CLOCKWISETWELVE,
 137             TransitionSubType::CLOCKWISETHREE,
 138             TransitionSubType::CLOCKWISESIX,
 139             TransitionSubType::CLOCKWISENINE,
 140             TransitionSubType::TWOBLADEVERTICAL,
 141             TransitionSubType::TWOBLADEHORIZONTAL,
 142             TransitionSubType::FOURBLADE,
 143             TransitionSubType::FROMLEFT,
 144             TransitionSubType::FROMTOP,
 145             TransitionSubType::FROMRIGHT,
 146             TransitionSubType::FROMBOTTOM,
 147             TransitionSubType::CROSSFADE,
 148             TransitionSubType::FADETOCOLOR,
 149             TransitionSubType::FADEFROMCOLOR,
 150             TransitionSubType::FADEOVERCOLOR,
 151             TransitionSubType::THREEBLADE,
 152             TransitionSubType::EIGHTBLADE,
 153             TransitionSubType::ONEBLADE,
 154             TransitionSubType::ACROSS,
 155             TransitionSubType::TOPLEFTVERTICAL,
 156             TransitionSubType::TOPLEFTHORIZONTAL,
 157             TransitionSubType::TOPLEFTDIAGONAL,
 158             TransitionSubType::TOPRIGHTDIAGONAL,
 159             TransitionSubType::BOTTOMRIGHTDIAGONAL,
 160             TransitionSubType::BOTTOMLEFTDIAGONAL,
 161             TransitionSubType::RECTANGLE,
 162             TransitionSubType::DIAMOND,
 163             TransitionSubType::TOPLEFT,
 164             TransitionSubType::TOPRIGHT,
 165             TransitionSubType::BOTTOMRIGHT,
 166             TransitionSubType::BOTTOMLEFT,
 167             TransitionSubType::TOPCENTER,
 168             TransitionSubType::RIGHTCENTER,
 169             TransitionSubType::BOTTOMCENTER,
 170             TransitionSubType::LEFTCENTER,
 171             TransitionSubType::LEFT,
 172             TransitionSubType::UP,
 173             TransitionSubType::RIGHT,
 174             TransitionSubType::DIAGONALBOTTOMLEFT,
 175             TransitionSubType::DIAGONALTOPLEFT,
 176             TransitionSubType::CENTERTOP,
 177             TransitionSubType::CENTERRIGHT,
 178             TransitionSubType::TOP,
 179             TransitionSubType::BOTTOM,
 180             TransitionSubType::CLOCKWISETOP,
 181             TransitionSubType::CLOCKWISERIGHT,
 182             TransitionSubType::CLOCKWISEBOTTOM,
 183             TransitionSubType::CLOCKWISELEFT,
 184             TransitionSubType::CLOCKWISETOPLEFT,
 185             TransitionSubType::COUNTERCLOCKWISEBOTTOMLEFT,
 186             TransitionSubType::CLOCKWISEBOTTOMRIGHT,
 187             TransitionSubType::COUNTERCLOCKWISETOPRIGHT,
 188             TransitionSubType::VERTICALLEFT,
 189             TransitionSubType::VERTICALRIGHT,
 190             TransitionSubType::HORIZONTALLEFT,
 191             TransitionSubType::HORIZONTALRIGHT,
 192             TransitionSubType::TOPLEFTCLOCKWISE,
 193             TransitionSubType::TOPRIGHTCLOCKWISE,
 194             TransitionSubType::BOTTOMRIGHTCLOCKWISE,
 195             TransitionSubType::BOTTOMLEFTCLOCKWISE,
 196             TransitionSubType::TOPLEFTCOUNTERCLOCKWISE,
 197             TransitionSubType::TOPRIGHTCOUNTERCLOCKWISE,
 198             TransitionSubType::BOTTOMRIGHTCOUNTERCLOCKWISE,
 199             TransitionSubType::BOTTOMLEFTCOUNTERCLOCKWISE,
 200             TransitionSubType::DOUBLEBARNDOOR,
 201             TransitionSubType::DOUBLEDIAMOND,
 202             TransitionSubType::VERTICALTOPSAME,
 203             TransitionSubType::VERTICALBOTTOMSAME,
 204             TransitionSubType::VERTICALTOPLEFTOPPOSITE,
 205             TransitionSubType::VERTICALBOTTOMLEFTOPPOSITE,
 206             TransitionSubType::HORIZONTALLEFTSAME,
 207             TransitionSubType::HORIZONTALRIGHTSAME,
 208             TransitionSubType::HORIZONTALTOPLEFTOPPOSITE,
 209             TransitionSubType::HORIZONTALTOPRIGHTOPPOSITE,
 210             TransitionSubType::DIAGONALBOTTOMLEFTOPPOSITE,
 211             TransitionSubType::DIAGONALTOPLEFTOPPOSITE,
 212             TransitionSubType::TWOBOXTOP,
 213             TransitionSubType::TWOBOXBOTTOM,
 214             TransitionSubType::TWOBOXLEFT,
 215             TransitionSubType::TWOBOXRIGHT,
 216             TransitionSubType::FOURBOXVERTICAL,
 217             TransitionSubType::FOURBOXHORIZONTAL,
 218             TransitionSubType::COMBVERTICAL,
 219             TransitionSubType::COMBHORIZONTAL,
 220             TransitionSubType::FANOUTHORIZONTAL,
 221             TransitionSubType::HEART,
 222             TransitionSubType::ROTATEIN
 223     };
 224
 225     const std::set<sal_Int16> LOKMiscShapeWipeNonSupportedTransitionSubTypes = {
 226             TransitionSubType::DIAMOND,
 227             TransitionSubType::HEART,
 228             TransitionSubType::CIRCLE,
 229             TransitionSubType::VERTICAL,
 230             TransitionSubType::TOPLEFT
 231     };
 232
 233     try {
 234         xAnimationNode = implImportEffects( xServiceFactory, aURL );
 235         Reference< XEnumerationAccess > xEnumerationAccess( xAnimationNode, UNO_QUERY_THROW );
 236         Reference< XEnumeration > xEnumeration( xEnumerationAccess->createEnumeration(), css::uno::UNO_SET_THROW );
 237
 238         while( xEnumeration->hasMoreElements() )
 239         {
 240             Reference< XAnimationNode > xChildNode( xEnumeration->nextElement(), UNO_QUERY_THROW );
 241             if( xChildNode->getType() == AnimationNodeType::PAR )
 242             {
 243                 TransitionPresetPtr pPreset( new TransitionPreset( xChildNode ) );
 244
 245                 if( comphelper::LibreOfficeKit::isActive() )
 246                 {
 247                     sal_Int16 eTransitionType = pPreset->getTransition();
 248                     sal_Int16 eTransitionSubType = pPreset->getSubtype();
 249                     if( LOKSupportedTransitionTypes.find(eTransitionType) == LOKSupportedTransitionTypes.end()
 250                             || LOKSupportedTransitionSubTypes.find(eTransitionSubType) == LOKSupportedTransitionSubTypes.end() )
 251                     {
 252                         continue;
 253                     }
 254
 255                     if( eTransitionType == TransitionType::MISCSHAPEWIPE
 256                             && LOKMiscShapeWipeNonSupportedTransitionSubTypes.find(eTransitionSubType) != LOKMiscShapeWipeNonSupportedTransitionSubTypes.end() )
 257                     {
 258                         continue;
 259                     }
 260                 }
 261
 262                 OUString aPresetId( pPreset->getPresetId() );
 263
 264                 if( !aPresetId.isEmpty() )
 265                 {
 266                     Reference< container::XNameAccess > xTransitionNode;
 267
 268                     if (xTransitions->hasByName( aPresetId ) &&
 269                         (xTransitions->getByName( aPresetId ) >>= xTransitionNode) &&
 270                         xTransitionNode.is() )
 271                     {
 272                         OUString sSet;
 273                         OUString sVariant;
 274
 275                         xTransitionNode->getByName( u"Set"_ustr ) >>= sSet;
 276                         xTransitionNode->getByName( u"Variant"_ustr ) >>= sVariant;
 277
 278                         Reference< container::XNameAccess > xSetNode;
 279
 280                         xTransitionSets->getByName( sSet ) >>= xSetNode;
 281                         if( xSetNode.is() )
 282                         {
 283                             pPreset->maSetId = sSet;
 284                             xSetNode->getByName( u"Label"_ustr ) >>= sSet;
 285                             pPreset->maSetLabel = sSet;
 286
 287                             OUString sGroup;
 288
 289                             xSetNode->getByName( u"Group"_ustr ) >>= sGroup;
 290
 291                             Reference< container::XNameAccess > xGroupNode;
 292                             xTransitionGroups->getByName( sGroup ) >>= xGroupNode;
 293
 294                             if( xGroupNode.is() )
 295                             {
 296                                 xGroupNode->getByName( u"Label"_ustr ) >>= sGroup;
 297                                 if( !sVariant.isEmpty() )
 298                                 {
 299                                     Reference< container::XNameAccess > xVariantNode;
 300                                     xTransitionVariants->getByName( sVariant ) >>= xVariantNode;
 301                                     if( xVariantNode.is() )
 302                                     {
 303                                         xVariantNode->getByName( u"Label"_ustr ) >>= sVariant;
 304                                         pPreset->maVariantLabel = sVariant;
 305                                     }
 306                                 }
 307
 308                                 pPreset->maSetLabel = sSet;
 309                                 SAL_INFO("sd.transitions", aPresetId << ": " << sGroup << "/" << sSet << (sVariant.isEmpty() ? OUString() : OUString("/" + sVariant)));
 310
 311                                 rList.push_back( pPreset );
 312                             }
 313                             else
 314                                 SAL_WARN("sd.transitions", "group node " << sGroup << " not found");
 315                         }
 316                         else
 317                             SAL_WARN("sd.transitions", "set node " << sSet << " not found");
 318                     }
 319                     else
 320                         SAL_WARN("sd.transitions", "transition node " << aPresetId << " not found");
 321                 }
 322             }
 323             else
 324             {
 325                 SAL_WARN("sd.transitions", " malformed xml configuration file " << aURL );
 326                 break;
 327             }
 328         }
 329     } catch( Exception& ) {
 330         return false;
 331     }
 332
 333     return true;
 334 }
 335
 336 bool TransitionPreset::importTransitionPresetList( TransitionPresetList& rList )
 337 {
 338     if (comphelper::IsFuzzing())
 339         return false;
 340
 341     bool bRet = false;
 342
 343     try
 344     {
 345         const uno::Reference< uno::XComponentContext >& xContext(
 346             comphelper::getProcessComponentContext() );
 347         Reference< XMultiServiceFactory > xServiceFactory(
 348             xContext->getServiceManager(), UNO_QUERY_THROW );
 349
 350         // import ui strings
 351         Reference< XMultiServiceFactory > xConfigProvider =
 352             configuration::theDefaultProvider::get( xContext );
 353
 354         // read path to transition effects files from config
 355         uno::Sequence< OUString > aFiles;
 356         aFiles = officecfg::Office::Impress::Misc::TransitionFiles::get();
 357         for (const auto& rFile : aFiles)
 358         {
 359             OUString aURL = comphelper::getExpandedUri(xContext, rFile);
 360
 361             bRet |= importTransitionsFile( rList,
 362                                            xServiceFactory,
 363                                            aURL );
 364         }
 365
 366         return bRet;
 367     }
 368     catch( Exception& )
 369     {
 370         TOOLS_WARN_EXCEPTION( "sd", "sd::TransitionPreset::importResources()" );
 371     }
 372
 373     return bRet;
 374 }
 375
 376 std::map<OUString, TransitionPresetList> sd::TransitionPreset::mPresetsMap;
 377
 378 const TransitionPresetList& TransitionPreset::getTransitionPresetList()
 379 {
 380     // Support localization per-view. Currently not useful for Desktop
 381     // but very much critical for LOK. The cache now is per-language.
 382     const OUString aLang = comphelper::LibreOfficeKit::isActive()
 383                                ? comphelper::LibreOfficeKit::getLanguageTag().getBcp47()
 384                                : SvtSysLocaleOptions().GetLanguageTag().getBcp47();
 385
 386     SolarMutexGuard aGuard;
 387     const auto it = mPresetsMap.find(aLang);
 388     if (it != mPresetsMap.end())
 389         return it->second;
 390
 391     TransitionPresetList& rList = mPresetsMap[aLang];
 392     sd::TransitionPreset::importTransitionPresetList(rList);
 393     return rList;
 394 }
 395
 396 }
 397
 398 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */