cui/source/dialogs/QrCodeGenDialog.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
  10 #include <QrCodeGenDialog.hxx>
  11
  12 #include <comphelper/processfactory.hxx>
  13 #include <comphelper/propertyvalue.hxx>
  14 #include <tools/stream.hxx>
  15 #include <dialmgr.hxx>
  16 #include <strings.hrc>
  17 #include <unotools/streamwrap.hxx>
  18 #include <utility>
  19 #include <vcl/svapp.hxx>
  20
  21 #if ENABLE_ZXING
  22 #include <Version.h>
  23 #include <rtl/strbuf.hxx>
  24
  25 #ifdef __GNUC__
  26 #pragma GCC diagnostic push
  27 #pragma GCC diagnostic ignored "-Wshadow"
  28 #endif
  29
  30 #include <BarcodeFormat.h>
  31 #include <BitMatrix.h>
  32 #include <MultiFormatWriter.h>
  33
  34 #ifdef __GNUC__
  35 #pragma GCC diagnostic pop
  36 #endif
  37
  38 #if HAVE_ZXING_TOSVG
  39 #include <BitMatrixIO.h>
  40 #endif
  41
  42 #if ZXING_VERSION_MAJOR < 2
  43 #include <TextUtfEncoding.h>
  44 #endif
  45
  46 #endif // ENABLE_ZXING
  47
  48 #include <com/sun/star/beans/XPropertySet.hpp>
  49 #include <com/sun/star/drawing/XDrawPageSupplier.hpp>
  50 #include <com/sun/star/drawing/XShape.hpp>
  51 #include <com/sun/star/graphic/GraphicProvider.hpp>
  52 #include <com/sun/star/graphic/XGraphic.hpp>
  53 #include <com/sun/star/drawing/BarCode.hpp>
  54 #include <com/sun/star/drawing/BarCodeErrorCorrection.hpp>
  55 #include <com/sun/star/graphic/XGraphicProvider.hpp>
  56 #include <com/sun/star/io/XInputStream.hpp>
  57 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  58 #include <com/sun/star/lang/XServiceInfo.hpp>
  59 #include <com/sun/star/sheet/XSpreadsheet.hpp>
  60 #include <com/sun/star/sheet/XSpreadsheetView.hpp>
  61 #include <com/sun/star/text/TextContentAnchorType.hpp>
  62 #include <com/sun/star/text/XTextContent.hpp>
  63 #include <com/sun/star/text/XTextViewCursor.hpp>
  64 #include <com/sun/star/text/XTextViewCursorSupplier.hpp>
  65 #include <com/sun/star/drawing/XDrawView.hpp>
  66 #include <com/sun/star/drawing/XDrawPage.hpp>
  67
  68 using namespace css;
  69 using namespace css::uno;
  70 using namespace css::beans;
  71 using namespace css::container;
  72 using namespace css::frame;
  73 using namespace css::io;
  74 using namespace css::lang;
  75 using namespace css::sheet;
  76 using namespace css::text;
  77 using namespace css::drawing;
  78 using namespace css::graphic;
  79
  80 namespace
  81 {
  82 #if ENABLE_ZXING
  83 // Implementation adapted from the answer: https://stackoverflow.com/questions/10789059/create-qr-code-in-vector-image/60638350#60638350
  84 #if !HAVE_ZXING_TOSVG
  85 OString ConvertToSVGFormat(const ZXing::BitMatrix& bitmatrix)
  86 {
  87     OStringBuffer sb;
  88     const int width = bitmatrix.width();
  89     const int height = bitmatrix.height();
  90     sb.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  91               "<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" viewBox=\"0 0 "
  92               + OString::number(width) + " " + OString::number(height)
  93               + "\" stroke=\"none\">\n"
  94                 "<path d=\"");
  95     for (int i = 0; i < height; ++i)
  96     {
  97         for (int j = 0; j < width; ++j)
  98         {
  99             if (bitmatrix.get(j, i))
 100             {
 101                 sb.append("M" + OString::number(j) + "," + OString::number(i) + "h1v1h-1z");
 102             }
 103         }
 104     }
 105     sb.append("\"/>\n</svg>");
 106     return sb.toString();
 107 }
 108 #endif
 109
 110 std::string GetBarCodeType(int type)
 111 {
 112     switch (type)
 113     {
 114         case 1:
 115             return "Code128";
 116         default:
 117             return "QRCode";
 118     }
 119 }
 120
 121 OString GenerateQRCode(std::u16string_view aQRText, tools::Long aQRECC, int aQRBorder, int aQRType)
 122 {
 123     // Associated ZXing error correction levels (0-8) to our constants arbitrarily.
 124     int bqrEcc = 1;
 125
 126     switch (aQRECC)
 127     {
 128         case css::drawing::BarCodeErrorCorrection::LOW:
 129         {
 130             bqrEcc = 1;
 131             break;
 132         }
 133         case css::drawing::BarCodeErrorCorrection::MEDIUM:
 134         {
 135             bqrEcc = 3;
 136             break;
 137         }
 138         case css::drawing::BarCodeErrorCorrection::QUARTILE:
 139         {
 140             bqrEcc = 5;
 141             break;
 142         }
 143         case css::drawing::BarCodeErrorCorrection::HIGH:
 144         {
 145             bqrEcc = 7;
 146             break;
 147         }
 148     }
 149
 150     OString o = OUStringToOString(aQRText, RTL_TEXTENCODING_UTF8);
 151     std::string QRText(o);
 152     ZXing::BarcodeFormat format = ZXing::BarcodeFormatFromString(GetBarCodeType(aQRType));
 153     auto writer = ZXing::MultiFormatWriter(format).setMargin(aQRBorder).setEccLevel(bqrEcc);
 154     writer.setEncoding(ZXing::CharacterSet::UTF8);
 155 #if ZXING_VERSION_MAJOR >= 2
 156     ZXing::BitMatrix bitmatrix = writer.encode(QRText, 0, 0);
 157 #else
 158     ZXing::BitMatrix bitmatrix = writer.encode(ZXing::TextUtfEncoding::FromUtf8(QRText), 0, 0);
 159 #endif
 160 #if HAVE_ZXING_TOSVG
 161     return OString(ZXing::ToSVG(bitmatrix));
 162 #else
 163     return ConvertToSVGFormat(bitmatrix);
 164 #endif
 165 }
 166 #endif
 167
 168 } // anonymous namespace
 169
 170 QrCodeGenDialog::QrCodeGenDialog(weld::Widget* pParent, Reference<XModel> xModel,
 171                                  bool bEditExisting)
 172     : GenericDialogController(pParent, u"cui/ui/qrcodegen.ui"_ustr, u"QrCodeGenDialog"_ustr)
 173     , m_xModel(std::move(xModel))
 174     , m_xEdittext(m_xBuilder->weld_text_view(u"edit_text"_ustr))
 175     , m_xECC{ m_xBuilder->weld_radio_button(u"button_low"_ustr),
 176               m_xBuilder->weld_radio_button(u"button_medium"_ustr),
 177               m_xBuilder->weld_radio_button(u"button_quartile"_ustr),
 178               m_xBuilder->weld_radio_button(u"button_high"_ustr) }
 179     , m_xSpinBorder(m_xBuilder->weld_spin_button(u"edit_margin"_ustr))
 180     , m_xComboType(m_xBuilder->weld_combo_box(u"choose_type"_ustr))
 181 #if ENABLE_ZXING
 182     , mpParent(pParent)
 183 #endif
 184 {
 185     m_xEdittext->set_size_request(m_xEdittext->get_approximate_digit_width() * 28,
 186                                   m_xEdittext->get_height_rows(6));
 187     if (!bEditExisting)
 188     {
 189         // TODO: This only works in Writer doc. Should also work in shapes
 190         Reference<XIndexAccess> xSelections(m_xModel->getCurrentSelection(), UNO_QUERY);
 191         if (xSelections.is())
 192         {
 193             Reference<XTextRange> xSelection(xSelections->getByIndex(0), UNO_QUERY);
 194             if (xSelection.is())
 195                 m_xEdittext->set_text(xSelection->getString());
 196         }
 197         return;
 198     }
 199
 200     Reference<container::XIndexAccess> xIndexAccess(m_xModel->getCurrentSelection(),
 201                                                     UNO_QUERY_THROW);
 202     Reference<XPropertySet> xProps(xIndexAccess->getByIndex(0), UNO_QUERY_THROW);
 203
 204     // Read properties from selected QR Code
 205     css::drawing::BarCode aBarCode;
 206     xProps->getPropertyValue(u"BarCodeProperties"_ustr) >>= aBarCode;
 207
 208     m_xEdittext->set_text(aBarCode.Payload);
 209
 210     //Get Error Correction Constant from selected QR Code
 211     GetErrorCorrection(aBarCode.ErrorCorrection);
 212
 213     m_xSpinBorder->set_value(aBarCode.Border);
 214
 215     m_xComboType->set_active(aBarCode.Type);
 216
 217     // Mark this as existing shape
 218     m_xExistingShapeProperties = std::move(xProps);
 219 }
 220
 221 short QrCodeGenDialog::run()
 222 {
 223 #if ENABLE_ZXING
 224     short nRet;
 225     while (true)
 226     {
 227         nRet = GenericDialogController::run();
 228         if (nRet == RET_OK)
 229         {
 230             try
 231             {
 232                 Apply();
 233                 break;
 234             }
 235             catch (const std::exception&)
 236             {
 237                 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(
 238                     mpParent, VclMessageType::Warning, VclButtonsType::Ok,
 239                     CuiResId(RID_CUISTR_QRCODEDATALONG)));
 240                 xBox->run();
 241             }
 242         }
 243         else
 244             break;
 245     }
 246     return nRet;
 247 #else
 248     return RET_CANCEL;
 249 #endif
 250 }
 251
 252 bool QrCodeGenDialog::runAsync(const std::shared_ptr<QrCodeGenDialog>& rController,
 253                                const std::function<void(sal_Int32)>& rFunc)
 254 {
 255 #if ENABLE_ZXING
 256
 257     weld::GenericDialogController::runAsync(rController, [rController, rFunc](sal_Int32 nResult) {
 258         if (nResult == RET_OK)
 259         {
 260             try
 261             {
 262                 rController->Apply();
 263             }
 264             catch (const std::exception&)
 265             {
 266                 std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(
 267                     rController->GetParent(), VclMessageType::Warning, VclButtonsType::Ok,
 268                     CuiResId(RID_CUISTR_QRCODEDATALONG)));
 269                 xBox->run();
 270             }
 271         }
 272
 273         rFunc(nResult);
 274     });
 275 #else
 276     (void)rController;
 277     rFunc(RET_CANCEL);
 278 #endif
 279     return true;
 280 }
 281
 282 void QrCodeGenDialog::Apply()
 283 {
 284 #if ENABLE_ZXING
 285     css::drawing::BarCode aBarCode;
 286     aBarCode.Payload = m_xEdittext->get_text();
 287     aBarCode.Type = m_xComboType->get_active();
 288
 289     bool bLowECCActive(m_xECC[0]->get_active());
 290     bool bMediumECCActive(m_xECC[1]->get_active());
 291     bool bQuartileECCActive(m_xECC[2]->get_active());
 292
 293     if (bLowECCActive)
 294     {
 295         aBarCode.ErrorCorrection = css::drawing::BarCodeErrorCorrection::LOW;
 296     }
 297     else if (bMediumECCActive)
 298     {
 299         aBarCode.ErrorCorrection = css::drawing::BarCodeErrorCorrection::MEDIUM;
 300     }
 301     else if (bQuartileECCActive)
 302     {
 303         aBarCode.ErrorCorrection = css::drawing::BarCodeErrorCorrection::QUARTILE;
 304     }
 305     else
 306     {
 307         aBarCode.ErrorCorrection = css::drawing::BarCodeErrorCorrection::HIGH;
 308     }
 309
 310     aBarCode.Border = m_xSpinBorder->get_value();
 311
 312     // Read svg and replace placeholder texts
 313     OString aSvgImage = GenerateQRCode(aBarCode.Payload, aBarCode.ErrorCorrection, aBarCode.Border,
 314                                        aBarCode.Type);
 315
 316     // Insert/Update graphic
 317     SvMemoryStream aSvgStream(4096, 4096);
 318     aSvgStream.WriteOString(aSvgImage);
 319     Reference<XInputStream> xInputStream(new utl::OSeekableInputStreamWrapper(aSvgStream));
 320     const Reference<XComponentContext>& xContext(comphelper::getProcessComponentContext());
 321     Reference<XGraphicProvider> xProvider = css::graphic::GraphicProvider::create(xContext);
 322
 323     Sequence<PropertyValue> aMediaProperties{ comphelper::makePropertyValue(u"InputStream"_ustr,
 324                                                                             xInputStream) };
 325     Reference<XGraphic> xGraphic(xProvider->queryGraphic(aMediaProperties));
 326
 327     bool bIsExistingQRCode = m_xExistingShapeProperties.is();
 328     Reference<XPropertySet> xShapeProps;
 329     if (bIsExistingQRCode)
 330         xShapeProps = m_xExistingShapeProperties;
 331     else
 332         xShapeProps.set(Reference<lang::XMultiServiceFactory>(m_xModel, UNO_QUERY_THROW)
 333                             ->createInstance(u"com.sun.star.drawing.GraphicObjectShape"_ustr),
 334                         UNO_QUERY);
 335
 336     xShapeProps->setPropertyValue(u"Graphic"_ustr, Any(xGraphic));
 337
 338     // Set QRCode properties
 339     xShapeProps->setPropertyValue(u"BarCodeProperties"_ustr, Any(aBarCode));
 340
 341     if (bIsExistingQRCode)
 342         return;
 343
 344     // Default size
 345     Reference<XShape> xShape(xShapeProps, UNO_QUERY);
 346     awt::Size aShapeSize;
 347     aShapeSize.Height = 4000;
 348     aShapeSize.Width = 4000;
 349     xShape->setSize(aShapeSize);
 350
 351     // Default anchoring
 352     xShapeProps->setPropertyValue(u"AnchorType"_ustr, Any(TextContentAnchorType_AT_PARAGRAPH));
 353
 354     const Reference<XServiceInfo> xServiceInfo(m_xModel, UNO_QUERY_THROW);
 355
 356     // Writer
 357     if (xServiceInfo->supportsService(u"com.sun.star.text.TextDocument"_ustr))
 358     {
 359         Reference<XTextContent> xTextContent(xShape, UNO_QUERY_THROW);
 360         Reference<XTextViewCursorSupplier> xViewCursorSupplier(m_xModel->getCurrentController(),
 361                                                                UNO_QUERY_THROW);
 362         Reference<XTextViewCursor> xCursor = xViewCursorSupplier->getViewCursor();
 363         // use cursor's XText - it might be in table cell, frame, ...
 364         Reference<XText> const xText(xCursor->getText());
 365         assert(xText.is());
 366         xText->insertTextContent(xCursor, xTextContent, true);
 367         return;
 368     }
 369
 370     // Calc
 371     else if (xServiceInfo->supportsService(u"com.sun.star.sheet.SpreadsheetDocument"_ustr))
 372     {
 373         Reference<XPropertySet> xSheetCell(m_xModel->getCurrentSelection(), UNO_QUERY_THROW);
 374         awt::Point aCellPosition;
 375         xSheetCell->getPropertyValue(u"Position"_ustr) >>= aCellPosition;
 376         xShape->setPosition(aCellPosition);
 377
 378         Reference<XSpreadsheetView> xView(m_xModel->getCurrentController(), UNO_QUERY_THROW);
 379         Reference<XSpreadsheet> xSheet(xView->getActiveSheet(), UNO_SET_THROW);
 380         Reference<XDrawPageSupplier> xDrawPageSupplier(xSheet, UNO_QUERY_THROW);
 381         Reference<XDrawPage> xDrawPage(xDrawPageSupplier->getDrawPage(), UNO_SET_THROW);
 382         Reference<XShapes> xShapes(xDrawPage, UNO_QUERY_THROW);
 383
 384         xShapes->add(xShape);
 385         return;
 386     }
 387
 388     //Impress and Draw
 389     else if (xServiceInfo->supportsService(u"com.sun.star.presentation.PresentationDocument"_ustr)
 390              || xServiceInfo->supportsService(u"com.sun.star.drawing.DrawingDocument"_ustr))
 391     {
 392         Reference<XDrawView> xView(m_xModel->getCurrentController(), UNO_QUERY_THROW);
 393         Reference<XDrawPage> xPage(xView->getCurrentPage(), UNO_SET_THROW);
 394         Reference<XShapes> xShapes(xPage, UNO_QUERY_THROW);
 395
 396         xShapes->add(xShape);
 397         return;
 398     }
 399
 400     else
 401     {
 402         //Not implemented for math,base and other apps.
 403         throw uno::RuntimeException(u"Not implemented"_ustr);
 404     }
 405 #endif
 406 }
 407
 408 void QrCodeGenDialog::GetErrorCorrection(tools::Long ErrorCorrection)
 409 {
 410     switch (ErrorCorrection)
 411     {
 412         case css::drawing::BarCodeErrorCorrection::LOW:
 413         {
 414             m_xECC[0]->set_active(true);
 415             break;
 416         }
 417         case css::drawing::BarCodeErrorCorrection::MEDIUM:
 418         {
 419             m_xECC[1]->set_active(true);
 420             break;
 421         }
 422         case css::drawing::BarCodeErrorCorrection::QUARTILE:
 423         {
 424             m_xECC[2]->set_active(true);
 425             break;
 426         }
 427         case css::drawing::BarCodeErrorCorrection::HIGH:
 428         {
 429             m_xECC[3]->set_active(true);
 430             break;
 431         }
 432     }
 433 }
 434
 435 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */