cui/source/customize/CustomNotebookbarGenerator.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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 <comphelper/processfactory.hxx>
  21 #include <rtl/bootstrap.hxx>
  22 #include <rtl/ustrbuf.hxx>
  23 #include <config_folders.h>
  24 #include <CustomNotebookbarGenerator.hxx>
  25 #include <osl/file.hxx>
  26 #include <osl/thread.h>
  27 #include <vcl/builder.hxx>
  28 #include <vcl/EnumContext.hxx>
  29 #include <sfx2/viewfrm.hxx>
  30 #include <com/sun/star/frame/ModuleManager.hpp>
  31 #include <unotools/confignode.hxx>
  32 #include <libxml/parser.h>
  33
  34 #define aUIPropertiesCount 3
  35
  36 using namespace css;
  37
  38 CustomNotebookbarGenerator::CustomNotebookbarGenerator() {}
  39
  40 static OUString lcl_activeAppName(vcl::EnumContext::Application eApp)
  41 {
  42     switch (eApp)
  43     {
  44         case vcl::EnumContext::Application::Writer:
  45             return "ActiveWriter";
  46             break;
  47         case vcl::EnumContext::Application::Calc:
  48             return "ActiveCalc";
  49             break;
  50         case vcl::EnumContext::Application::Impress:
  51             return "ActiveImpress";
  52             break;
  53         case vcl::EnumContext::Application::Draw:
  54             return "ActiveDraw";
  55             break;
  56         default:
  57             return OUString();
  58             break;
  59     }
  60 }
  61
  62 static OUString lcl_getAppName(vcl::EnumContext::Application eApp)
  63 {
  64     switch (eApp)
  65     {
  66         case vcl::EnumContext::Application::Writer:
  67             return "Writer";
  68             break;
  69         case vcl::EnumContext::Application::Calc:
  70             return "Calc";
  71             break;
  72         case vcl::EnumContext::Application::Impress:
  73             return "Impress";
  74             break;
  75         case vcl::EnumContext::Application::Draw:
  76             return "Draw";
  77             break;
  78         default:
  79             return OUString();
  80             break;
  81     }
  82 }
  83
  84 static OUString getAppNameRegistryPath()
  85 {
  86     vcl::EnumContext::Application eApp = vcl::EnumContext::Application::Any;
  87     const Reference<frame::XFrame>& xFrame
  88         = SfxViewFrame::Current()->GetFrame().GetFrameInterface();
  89     const Reference<frame::XModuleManager> xModuleManager
  90         = frame::ModuleManager::create(::comphelper::getProcessComponentContext());
  91     eApp = vcl::EnumContext::GetApplicationEnum(xModuleManager->identify(xFrame));
  92
  93     OUString sAppName(lcl_getAppName(eApp));
  94     return "org.openoffice.Office.UI.ToolbarMode/Applications/" + sAppName;
  95 }
  96
  97 static OUString customizedUIPathBuffer()
  98 {
  99     OUString sDirPath("${$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE(
 100         "bootstrap") ":UserInstallation}/user/config/soffice.cfg/");
 101     rtl::Bootstrap::expandMacros(sDirPath);
 102     return sDirPath;
 103 }
 104
 105 OUString CustomNotebookbarGenerator::getCustomizedUIPath()
 106 {
 107     OUString sAppName, sNotebookbarUIFileName;
 108     CustomNotebookbarGenerator::getFileNameAndAppName(sAppName, sNotebookbarUIFileName);
 109     return customizedUIPathBuffer() + "modules/s" + sAppName.toAsciiLowerCase() + "/ui/"
 110            + sNotebookbarUIFileName;
 111 }
 112
 113 OUString CustomNotebookbarGenerator::getOriginalUIPath()
 114 {
 115     OUString sAppName, sNotebookbarUIFileName;
 116     CustomNotebookbarGenerator::getFileNameAndAppName(sAppName, sNotebookbarUIFileName);
 117     return VclBuilderContainer::getUIRootDir() + "modules/s" + sAppName.toAsciiLowerCase() + "/ui/"
 118            + sNotebookbarUIFileName;
 119 }
 120
 121 static OUString getUIDirPath()
 122 {
 123     OUString sAppName, sNotebookbarUIFileName;
 124     CustomNotebookbarGenerator::getFileNameAndAppName(sAppName, sNotebookbarUIFileName);
 125     OUString sUIDirPath
 126         = customizedUIPathBuffer() + "modules/s" + sAppName.toAsciiLowerCase() + "/ui/";
 127     return sUIDirPath;
 128 }
 129
 130 OString CustomNotebookbarGenerator::getSystemPath(OUString const& sURL)
 131 {
 132     if (sURL.isEmpty())
 133         return OString();
 134     OUString sSystemPathSettings;
 135     if (osl_getSystemPathFromFileURL(sURL.pData, &sSystemPathSettings.pData) != osl_File_E_None)
 136     {
 137         SAL_WARN("cui.customnotebookbar", "Cannot get system path for :" << sURL);
 138         return OString();
 139     }
 140     OString osSystemPathSettings
 141         = OUStringToOString(sSystemPathSettings, osl_getThreadTextEncoding());
 142     return osSystemPathSettings;
 143 }
 144
 145 static void changeNodeValue(xmlNode* pNodePtr, const char* pProperty, const char* pValue)
 146 {
 147     pNodePtr = pNodePtr->xmlChildrenNode;
 148     while (pNodePtr)
 149     {
 150         if (!(xmlStrcmp(pNodePtr->name, reinterpret_cast<const xmlChar*>("property"))))
 151         {
 152             xmlChar* UriValue = xmlGetProp(pNodePtr, reinterpret_cast<const xmlChar*>("name"));
 153             if (!(xmlStrcmp(UriValue, reinterpret_cast<const xmlChar*>(pProperty))))
 154                 xmlNodeSetContent(pNodePtr, reinterpret_cast<const xmlChar*>(pValue));
 155             xmlFree(UriValue);
 156             break;
 157         }
 158         pNodePtr = pNodePtr->next;
 159     }
 160 }
 161
 162 static void searchNodeAndAttribute(xmlNode* pNodePtr, const char* pUIItemID, const char* pProperty,
 163                                    const char* pValue)
 164 {
 165     pNodePtr = pNodePtr->xmlChildrenNode;
 166     while (pNodePtr)
 167     {
 168         if (pNodePtr->type == XML_ELEMENT_NODE)
 169         {
 170             if (!(xmlStrcmp(pNodePtr->name, reinterpret_cast<const xmlChar*>("object"))))
 171             {
 172                 xmlChar* UriValue = xmlGetProp(pNodePtr, reinterpret_cast<const xmlChar*>("id"));
 173                 if (!(xmlStrcmp(UriValue, reinterpret_cast<const xmlChar*>(pUIItemID))))
 174                     changeNodeValue(pNodePtr, pProperty, pValue);
 175                 xmlFree(UriValue);
 176             }
 177             searchNodeAndAttribute(pNodePtr, pUIItemID, pProperty, pValue);
 178         }
 179         pNodePtr = pNodePtr->next;
 180     }
 181 }
 182
 183 static xmlDocPtr notebookbarXMLParser(const OString& rDocName, const OString& rUIItemID,
 184                                       const OString& rProperty, const OString& rValue)
 185 {
 186     xmlDocPtr pDocPtr = xmlParseFile(rDocName.getStr());
 187     xmlNodePtr pNodePtr = xmlDocGetRootElement(pDocPtr);
 188     searchNodeAndAttribute(pNodePtr, rUIItemID.getStr(), rProperty.getStr(), rValue.getStr());
 189     return pDocPtr;
 190 }
 191
 192 void CustomNotebookbarGenerator::modifyCustomizedUIFile(const Sequence<OUString>& sUIItemProperties)
 193 {
 194     OString sCustomizedUIPath = getSystemPath(getCustomizedUIPath());
 195     for (auto const& aValue : sUIItemProperties)
 196     {
 197         std::vector<OString> aProperties(aUIPropertiesCount);
 198         for (sal_Int32 aIndex = 0; aIndex < aUIPropertiesCount; aIndex++)
 199         {
 200             sal_Int32 nPos = aIndex;
 201             OUString sToken = aValue.getToken(nPos, ',', nPos);
 202             aProperties[aIndex] = OUStringToOString(sToken, RTL_TEXTENCODING_UTF8);
 203         }
 204         xmlDocPtr doc = notebookbarXMLParser(sCustomizedUIPath, aProperties[0], aProperties[1],
 205                                              aProperties[2]);
 206
 207         if (doc != nullptr)
 208         {
 209             xmlSaveFormatFile(sCustomizedUIPath.getStr(), doc, 1);
 210             xmlFreeDoc(doc);
 211         }
 212     }
 213 }
 214
 215 void CustomNotebookbarGenerator::getFileNameAndAppName(OUString& sAppName,
 216                                                        OUString& sNotebookbarUIFileName)
 217 {
 218     SfxViewFrame* pFrame = SfxViewFrame::Current();
 219     if (!pFrame)
 220         return;
 221
 222     const auto xContext = comphelper::getProcessComponentContext();
 223     utl::OConfigurationTreeRoot aRoot(xContext, "org.openoffice.Office.UI.ToolbarMode/", false);
 224     const Reference<frame::XFrame>& xFrame = pFrame->GetFrame().GetFrameInterface();
 225     const Reference<frame::XModuleManager> xModuleManager = frame::ModuleManager::create(xContext);
 226
 227     vcl::EnumContext::Application eApp
 228         = vcl::EnumContext::GetApplicationEnum(xModuleManager->identify(xFrame));
 229     OUString sActiveAppName(lcl_activeAppName(eApp));
 230     sAppName = lcl_getAppName(eApp);
 231     const Any aValue = aRoot.getNodeValue(sActiveAppName);
 232     aValue >>= sNotebookbarUIFileName;
 233 }
 234
 235 void CustomNotebookbarGenerator::createCustomizedUIFile()
 236 {
 237     OUString sUserUIDir = getUIDirPath();
 238     OUString sOriginalUIPath = getOriginalUIPath();
 239     OUString sCustomizedUIPath = getCustomizedUIPath();
 240
 241     sal_uInt32 nflag = osl_File_OpenFlag_Read | osl_File_OpenFlag_Write;
 242     osl::Directory aDirectory(sUserUIDir);
 243     if (aDirectory.open() != osl::FileBase::E_None)
 244         osl::Directory::create(sUserUIDir, nflag);
 245     else
 246         SAL_WARN("cui.customnotebookbar",
 247                  "Cannot create the directory or directory was present :" << sUserUIDir);
 248
 249     osl::File aFile(sCustomizedUIPath);
 250     if (aFile.open(nflag) != osl::FileBase::E_None)
 251         osl::File::copy(sOriginalUIPath, sCustomizedUIPath);
 252     else
 253         SAL_WARN("cui.customnotebookbar",
 254                  "Cannot copy the file or file was present :" << sCustomizedUIPath);
 255 }
 256
 257 Sequence<OUString> CustomNotebookbarGenerator::getCustomizedUIItem(OUString sNotebookbarConfigType)
 258 {
 259     OUString aPath = getAppNameRegistryPath();
 260     const utl::OConfigurationTreeRoot aAppNode(::comphelper::getProcessComponentContext(), aPath,
 261                                                false);
 262
 263     const utl::OConfigurationNode aModesNode = aAppNode.openNode("Modes");
 264     const utl::OConfigurationNode aModeNode(aModesNode.openNode(sNotebookbarConfigType));
 265     const Any aValue = aModeNode.getNodeValue("UIItemProperties");
 266     Sequence<OUString> aValues;
 267     aValue >>= aValues;
 268     return aValues;
 269 }
 270
 271 void CustomNotebookbarGenerator::setCustomizedUIItem(Sequence<OUString> sUIItemProperties,
 272                                                      OUString sNotebookbarConfigType)
 273 {
 274     OUString aPath = getAppNameRegistryPath();
 275     const utl::OConfigurationTreeRoot aAppNode(::comphelper::getProcessComponentContext(), aPath,
 276                                                true);
 277     const utl::OConfigurationNode aModesNode = aAppNode.openNode("Modes");
 278     const utl::OConfigurationNode aModeNode(aModesNode.openNode(sNotebookbarConfigType));
 279
 280     css::uno::Any aUIItemProperties(makeAny(sUIItemProperties));
 281     aModeNode.setNodeValue("UIItemProperties", aUIItemProperties);
 282     aAppNode.commit();
 283 }
 284
 285 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */