sd/source/filter/html/htmlex.hxx

   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 #pragma once
  21
  22 #include <resltn.hxx>
  23 #include <rtl/ustrbuf.hxx>
  24 #include <tools/color.hxx>
  25 #include <tools/solar.h>
  26 #include <vcl/errinf.hxx>
  27 #include <unotools/resmgr.hxx>
  28
  29 #include "htmlpublishmode.hxx"
  30
  31 #include <memory>
  32 #include <string_view>
  33 #include <vector>
  34
  35 namespace basegfx { class B2DPolyPolygon; }
  36 namespace com::sun::star::beans { struct PropertyValue; }
  37 namespace com::sun::star::ucb { class XSimpleFileAccess3; }
  38 namespace sd { class DrawDocShell; }
  39 namespace tools { class Rectangle; }
  40
  41 #define PUB_LOWRES_WIDTH    640
  42 #define PUB_MEDRES_WIDTH    800
  43 #define PUB_HIGHRES_WIDTH   1024
  44 #define PUB_FHDRES_WIDTH    1920
  45
  46 #define PUB_THUMBNAIL_WIDTH  256
  47 #define PUB_THUMBNAIL_HEIGHT 192
  48
  49 class ErrCode;
  50 class OutlinerParaObject;
  51 class SfxItemSet;
  52 class Size;
  53 class SfxProgress;
  54 class SdrOutliner;
  55 class SdPage;
  56 class HtmlState;
  57 class SdrTextObj;
  58 class SdrObjGroup;
  59 namespace sdr::table { class SdrTableObj; }
  60 class SdrPage;
  61 class SdDrawDocument;
  62 class ButtonSet;
  63
  64 class HtmlErrorContext : public ErrorContext
  65 {
  66 private:
  67     TranslateId mpResId;
  68     OUString  maURL1;
  69     OUString  maURL2;
  70
  71 public:
  72                     explicit HtmlErrorContext();
  73
  74     virtual bool    GetString( ErrCode nErrId, OUString& rCtxStr ) override;
  75
  76     void            SetContext(TranslateId pResId, const OUString& rURL);
  77     void            SetContext(TranslateId pResId, const OUString& rURL1, const OUString& rURL2);
  78 };
  79
  80 /// this class exports an Impress Document as a HTML Presentation.
  81 class HtmlExport final
  82 {
  83     std::vector< SdPage* > maPages;
  84     std::vector< SdPage* > maNotesPages;
  85
  86     OUString maPath;
  87
  88     SdDrawDocument* mpDoc;
  89     ::sd::DrawDocShell* mpDocSh;
  90
  91     HtmlErrorContext meEC;
  92
  93     HtmlPublishMode meMode;
  94     std::unique_ptr<SfxProgress> mpProgress;
  95     bool mbImpress;
  96     sal_uInt16 mnSdPageCount;
  97     sal_uInt16 mnPagesWritten;
  98     bool mbContentsPage;
  99     sal_Int16 mnButtonThema;
 100     sal_uInt16 mnWidthPixel;
 101     sal_uInt16 mnHeightPixel;
 102     PublishingFormat meFormat;
 103     bool mbHeader;
 104     bool mbNotes;
 105     bool mbFrames;
 106     OUString maIndex;
 107     OUString maEMail;
 108     OUString maAuthor;
 109     OUString maHomePage;
 110     OUString maInfo;
 111     sal_Int16 mnCompression;
 112     OUString maDocFileName;
 113     OUString maFramePage;
 114     OUString mDocTitle;
 115     bool mbDownload;
 116
 117     bool mbAutoSlide;
 118     double  mfSlideDuration;
 119     bool mbSlideSound;
 120     bool mbHiddenSlides;
 121     bool mbEndless;
 122
 123     bool mbUserAttr;
 124     Color maTextColor; ///< The following colors are used for the <body> tag if mbUserAttr is true.
 125     Color maBackColor;
 126     Color maLinkColor;
 127     Color maVLinkColor;
 128     Color maALinkColor;
 129     Color maFirstPageColor;
 130     bool mbDocColors;
 131
 132     std::vector<OUString> maHTMLFiles;
 133     std::vector<OUString> maImageFiles;
 134     std::vector<OUString> maThumbnailFiles;
 135     std::vector<OUString> maPageNames;
 136     std::vector<OUString> maTextFiles;
 137
 138     OUString maExportPath; ///< output directory or URL.
 139     OUString maIndexUrl;
 140     OUString maURLPath;
 141     OUString maCGIPath;
 142     PublishingScript meScript;
 143
 144     std::unique_ptr< ButtonSet > mpButtonSet;
 145
 146     static SdrTextObj* GetLayoutTextObject(SdrPage const * pPage);
 147
 148     void SetDocColors( SdPage* pPage = nullptr );
 149
 150     bool        CreateImagesForPresPages( bool bThumbnails = false );
 151     bool    CreateHtmlTextForPresPages();
 152     bool    CreateHtmlForPresPages();
 153     bool    CreateContentPage();
 154     void    CreateFileNames();
 155     void    CreateBitmaps();
 156     bool    CreateOutlinePages();
 157     bool    CreateFrames();
 158     bool    CreateNotesPages();
 159     bool    CreateNavBarFrames();
 160
 161     bool    CreateASPScripts();
 162     bool    CreatePERLScripts();
 163     bool    CreateImageFileList();
 164     bool    CreateImageNumberFile();
 165
 166     bool    checkForExistingFiles();
 167     bool    checkFileExists( css::uno::Reference< css::ucb::XSimpleFileAccess3 > const & xFileAccess, std::u16string_view aFileName );
 168
 169     OUString const & getDocumentTitle();
 170     bool    SavePresentation();
 171
 172     static OUString CreateLink( std::u16string_view aLink, std::u16string_view aText,
 173                         std::u16string_view aTarget = std::u16string_view());
 174     static OUString CreateImage( std::u16string_view aImage, std::u16string_view aAltText );
 175     OUString CreateNavBar( sal_uInt16 nSdPage, bool bIsText ) const;
 176     OUString CreateBodyTag() const;
 177
 178     OUString ParagraphToHTMLString( SdrOutliner const * pOutliner, sal_Int32 nPara, const Color& rBackgroundColor );
 179     OUString TextAttribToHTMLString( SfxItemSet const * pSet, HtmlState* pState, const Color& rBackgroundColor );
 180
 181     OUString CreateTextForTitle( SdrOutliner* pOutliner, SdPage* pPage, const Color& rBackgroundColor );
 182     OUString CreateTextForPage( SdrOutliner* pOutliner, SdPage const * pPage, bool bHeadLine, const Color& rBackgroundColor );
 183     OUString CreateTextForNotesPage( SdrOutliner* pOutliner, SdPage* pPage, const Color& rBackgroundColor );
 184
 185     static OUString CreateHTMLCircleArea( sal_uLong nRadius, sal_uLong nCenterX,
 186                                   sal_uLong nCenterY, std::u16string_view rHRef );
 187     static OUString CreateHTMLPolygonArea( const ::basegfx::B2DPolyPolygon& rPolyPoly, Size aShift, double fFactor, std::u16string_view rHRef );
 188     static OUString CreateHTMLRectArea( const ::tools::Rectangle& rRect,
 189                                 std::u16string_view rHRef );
 190
 191     OUString CreatePageURL( sal_uInt16 nPgNum );
 192
 193     OUString InsertSound( const OUString& rSoundFile );
 194     bool CopyFile( const OUString& rSourceFile, const OUString& rDestFile );
 195     bool CopyScript( std::u16string_view rPath, const OUString& rSource, const OUString& rDest, bool bUnix = false );
 196
 197     void InitProgress( sal_uInt16 nProgrCount );
 198     void ResetProgress();
 199
 200     /// Output only the charset metadata, title etc. will be handled separately.
 201     static OUString CreateMetaCharset();
 202
 203     /// Output document metadata.
 204     OUString DocumentMetadata() const;
 205
 206     void InitExportParameters( const css::uno::Sequence< css::beans::PropertyValue >& rParams);
 207     void ExportHtml();
 208     void ExportKiosk();
 209     void ExportWebCast();
 210     void ExportSingleDocument();
 211
 212     bool WriteHtml( const OUString& rFileName, bool bAddExtension, std::u16string_view rHtmlData );
 213     static OUString GetButtonName( int nButton );
 214
 215     void WriteOutlinerParagraph(OUStringBuffer& aStr, SdrOutliner* pOutliner,
 216                                 OutlinerParaObject const * pOutlinerParagraphObject,
 217                                 const Color& rBackgroundColor, bool bHeadLine);
 218
 219     void WriteObjectGroup(OUStringBuffer& aStr, SdrObjGroup const * pObjectGroup,
 220                           SdrOutliner* pOutliner, const Color& rBackgroundColor, bool bHeadLine);
 221
 222     void WriteTable(OUStringBuffer& aStr, sdr::table::SdrTableObj const * pTableObject,
 223                     SdrOutliner* pOutliner, const Color& rBackgroundColor);
 224
 225  public:
 226     HtmlExport(OUString aPath,
 227                const css::uno::Sequence<css::beans::PropertyValue>& rParams,
 228                SdDrawDocument* pExpDoc,
 229                sd::DrawDocShell* pDocShell);
 230
 231     ~HtmlExport();
 232
 233     static OUString ColorToHTMLString( Color aColor );
 234     static OUString StringToHTMLString( const OUString& rString );
 235 };
 236
 237 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */