1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <config_folders.h>
#include <config_features.h>
#include <chrono>
#include <dp_misc.h>
#include <dp_interact.h>
#include <dp_shared.hxx>
#include <o3tl/string_view.hxx>
#include <rtl/uri.hxx>
#include <rtl/digest.h>
#include <rtl/random.h>
#include <rtl/bootstrap.hxx>
#include <rtl/ustrbuf.hxx>
#include <sal/log.hxx>
#include <unotools/bootstrap.hxx>
#include <osl/file.hxx>
#include <osl/pipe.hxx>
#include <osl/security.hxx>
#include <osl/thread.hxx>
#include <com/sun/star/ucb/CommandAbortedException.hpp>
#include <com/sun/star/task/XInteractionHandler.hpp>
#include <com/sun/star/bridge/BridgeFactory.hpp>
#include <com/sun/star/bridge/UnoUrlResolver.hpp>
#include <com/sun/star/bridge/XUnoUrlResolver.hpp>
#include <com/sun/star/deployment/ExtensionManager.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/task/OfficeRestartManager.hpp>
#include <memory>
#include <string_view>
#include <thread>
#include <comphelper/lok.hxx>
#include <comphelper/processfactory.hxx>
#include <salhelper/linkhelper.hxx>
#ifdef _WIN32
#include <prewin.h>
#include <postwin.h>
#endif
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
namespace dp_misc {
namespace {
struct UnoRc : public rtl::StaticWithInit<
std::shared_ptr<rtl::Bootstrap>, UnoRc> {
std::shared_ptr<rtl::Bootstrap> operator () () {
OUString unorc( "$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE("louno") );
::rtl::Bootstrap::expandMacros( unorc );
auto ret = std::make_shared<::rtl::Bootstrap>( unorc );
OSL_ASSERT( ret->getHandle() != nullptr );
return ret;
}
};
OUString generateOfficePipeId()
{
OUString userPath;
::utl::Bootstrap::PathStatus aLocateResult =
::utl::Bootstrap::locateUserInstallation( userPath );
if (aLocateResult != ::utl::Bootstrap::PATH_EXISTS &&
aLocateResult != ::utl::Bootstrap::PATH_VALID)
{
throw Exception("Extension Manager: Could not obtain path for UserInstallation.", nullptr);
}
rtlDigest digest = rtl_digest_create( rtl_Digest_AlgorithmMD5 );
if (!digest) {
throw RuntimeException("cannot get digest rtl_Digest_AlgorithmMD5!", nullptr );
}
sal_uInt8 const * data =
reinterpret_cast<sal_uInt8 const *>(userPath.getStr());
std::size_t size = userPath.getLength() * sizeof (sal_Unicode);
sal_uInt32 md5_key_len = rtl_digest_queryLength( digest );
std::unique_ptr<sal_uInt8[]> md5_buf( new sal_uInt8 [ md5_key_len ] );
rtl_digest_init( digest, data, static_cast<sal_uInt32>(size) );
rtl_digest_update( digest, data, static_cast<sal_uInt32>(size) );
rtl_digest_get( digest, md5_buf.get(), md5_key_len );
rtl_digest_destroy( digest );
// create hex-value string from the MD5 value to keep
// the string size minimal
OUStringBuffer buf;
buf.append( "SingleOfficeIPC_" );
for ( sal_uInt32 i = 0; i < md5_key_len; ++i ) {
buf.append( static_cast<sal_Int32>(md5_buf[ i ]), 0x10 );
}
return buf.makeStringAndClear();
}
bool existsOfficePipe()
{
static OUString OfficePipeId = generateOfficePipeId();
OUString const & pipeId = OfficePipeId;
if (pipeId.isEmpty())
return false;
::osl::Security sec;
::osl::Pipe pipe( pipeId, osl_Pipe_OPEN, sec );
return pipe.is();
}
//get modification time
bool getModifyTimeTargetFile(const OUString &rFileURL, TimeValue &rTime)
{
salhelper::LinkResolver aResolver(osl_FileStatus_Mask_ModifyTime);
if (aResolver.fetchFileStatus(rFileURL) != osl::FileBase::E_None)
return false;
rTime = aResolver.m_aStatus.getModifyTime();
return true;
}
//Returns true if the Folder was more recently modified then
//the lastsynchronized file. That is the repository needs to
//be synchronized.
bool compareExtensionFolderWithLastSynchronizedFile(
OUString const & folderURL, OUString const & fileURL)
{
bool bNeedsSync = false;
::osl::DirectoryItem itemExtFolder;
::osl::File::RC err1 =
::osl::DirectoryItem::get(folderURL, itemExtFolder);
//If it does not exist, then there is nothing to be done
if (err1 == ::osl::File::E_NOENT)
{
return false;
}
else if (err1 != ::osl::File::E_None)
{
OSL_FAIL("Cannot access extension folder");
return true; //sync just in case
}
//If last synchronized does not exist, then OOo is started for the first time
::osl::DirectoryItem itemFile;
::osl::File::RC err2 = ::osl::DirectoryItem::get(fileURL, itemFile);
if (err2 == ::osl::File::E_NOENT)
{
return true;
}
else if (err2 != ::osl::File::E_None)
{
OSL_FAIL("Cannot access file lastsynchronized");
return true; //sync just in case
}
//compare the modification time of the extension folder and the last
//modified file
TimeValue timeFolder;
if (getModifyTimeTargetFile(folderURL, timeFolder))
{
TimeValue timeFile;
if (getModifyTimeTargetFile(fileURL, timeFile))
{
if (timeFile.Seconds < timeFolder.Seconds)
bNeedsSync = true;
}
else
{
OSL_ASSERT(false);
bNeedsSync = true;
}
}
else
{
OSL_ASSERT(false);
bNeedsSync = true;
}
return bNeedsSync;
}
bool needToSyncRepository(std::u16string_view name)
{
OUString folder;
OUString file;
if ( name == u"bundled" )
{
folder = "$BUNDLED_EXTENSIONS";
file = "$BUNDLED_EXTENSIONS_USER/lastsynchronized";
}
else if ( name == u"shared" )
{
folder = "$UNO_SHARED_PACKAGES_CACHE/uno_packages";
file = "$SHARED_EXTENSIONS_USER/lastsynchronized";
}
else
{
OSL_ASSERT(false);
return true;
}
::rtl::Bootstrap::expandMacros(folder);
::rtl::Bootstrap::expandMacros(file);
return compareExtensionFolderWithLastSynchronizedFile(
folder, file);
}
} // anon namespace
namespace {
OUString encodeForRcFile( std::u16string_view str )
{
// escape $\{} (=> rtl bootstrap files)
OUStringBuffer buf(64);
size_t pos = 0;
const size_t len = str.size();
for ( ; pos < len; ++pos ) {
sal_Unicode c = str[ pos ];
switch (c) {
case '$':
case '\\':
case '{':
case '}':
buf.append( '\\' );
break;
}
buf.append( c );
}
return buf.makeStringAndClear();
}
}
OUString makeURL( std::u16string_view baseURL, OUString const & relPath_ )
{
OUStringBuffer buf(128);
if (baseURL.size() > 1 && baseURL[ baseURL.size() - 1 ] == '/')
buf.append( baseURL.substr(0, baseURL.size() - 1) );
else
buf.append( baseURL );
OUString relPath(relPath_);
if( relPath.startsWith("/") )
relPath = relPath.copy( 1 );
if (!relPath.isEmpty())
{
buf.append( '/' );
if (o3tl::starts_with(baseURL, u"vnd.sun.star.expand:" )) {
// encode for macro expansion: relPath is supposed to have no
// macros, so encode $, {} \ (bootstrap mimic)
relPath = encodeForRcFile(relPath);
// encode once more for vnd.sun.star.expand schema:
// vnd.sun.star.expand:$UNO_...
// will expand to file-url
relPath = ::rtl::Uri::encode( relPath, rtl_UriCharClassUric,
rtl_UriEncodeIgnoreEscapes,
RTL_TEXTENCODING_UTF8 );
}
buf.append( relPath );
}
return buf.makeStringAndClear();
}
OUString makeURLAppendSysPathSegment( std::u16string_view baseURL, OUString const & segment )
{
OSL_ASSERT(segment.indexOf(u'/') == -1);
::rtl::Uri::encode(
segment, rtl_UriCharClassPchar, rtl_UriEncodeIgnoreEscapes,
RTL_TEXTENCODING_UTF8);
return makeURL(baseURL, segment);
}
OUString expandUnoRcTerm( OUString const & term_ )
{
OUString term(term_);
UnoRc::get()->expandMacrosFrom( term );
return term;
}
OUString makeRcTerm( OUString const & url )
{
OSL_ASSERT( url.match( "vnd.sun.star.expand:" ));
if (url.match( "vnd.sun.star.expand:" )) {
// cut protocol:
OUString rcterm( url.copy( sizeof ("vnd.sun.star.expand:") - 1 ) );
// decode uric class chars:
rcterm = ::rtl::Uri::decode(
rcterm, rtl_UriDecodeWithCharset, RTL_TEXTENCODING_UTF8 );
return rcterm;
}
else
return url;
}
OUString expandUnoRcUrl( OUString const & url )
{
if (url.match( "vnd.sun.star.expand:" )) {
// cut protocol:
OUString rcurl( url.copy( sizeof ("vnd.sun.star.expand:") - 1 ) );
// decode uric class chars:
rcurl = ::rtl::Uri::decode(
rcurl, rtl_UriDecodeWithCharset, RTL_TEXTENCODING_UTF8 );
// expand macro string:
UnoRc::get()->expandMacrosFrom( rcurl );
return rcurl;
}
else {
return url;
}
}
bool office_is_running()
{
//We need to check if we run within the office process. Then we must not use the pipe, because
//this could cause a deadlock. This is actually a workaround for i82778
OUString sFile;
oslProcessError err = osl_getExecutableFile(& sFile.pData);
bool ret = false;
if (osl_Process_E_None == err)
{
sFile = sFile.copy(sFile.lastIndexOf('/') + 1);
if (
#if defined _WIN32
//osl_getExecutableFile should deliver "soffice.bin" on windows
//even if swriter.exe, scalc.exe etc. was started. This is a bug
//in osl_getExecutableFile
sFile == "soffice.bin" || sFile == "soffice.exe" || sFile == "soffice.com"
|| sFile == "soffice" || sFile == "swriter.exe" || sFile == "swriter"
|| sFile == "scalc.exe" || sFile == "scalc" || sFile == "simpress.exe"
|| sFile == "simpress" || sFile == "sdraw.exe" || sFile == "sdraw"
|| sFile == "sbase.exe" || sFile == "sbase"
#elif defined MACOSX
sFile == "soffice"
#elif defined UNIX
sFile == "soffice.bin"
#else
#error "Unsupported platform"
#endif
)
ret = true;
else
ret = existsOfficePipe();
}
else
{
OSL_FAIL("NOT osl_Process_E_None ");
//if osl_getExecutable file then we take the risk of creating a pipe
ret = existsOfficePipe();
}
return ret;
}
oslProcess raiseProcess(
OUString const & appURL, Sequence<OUString> const & args )
{
::osl::Security sec;
oslProcess hProcess = nullptr;
oslProcessError rc = osl_executeProcess(
appURL.pData,
reinterpret_cast<rtl_uString **>(
const_cast<OUString *>(args.getConstArray()) ),
args.getLength(),
osl_Process_DETACHED,
sec.getHandle(),
nullptr, // => current working dir
nullptr, 0, // => no env vars
&hProcess );
switch (rc) {
case osl_Process_E_None:
break;
case osl_Process_E_NotFound:
throw RuntimeException( "image not found!", nullptr );
case osl_Process_E_TimedOut:
throw RuntimeException( "timeout occurred!", nullptr );
case osl_Process_E_NoPermission:
throw RuntimeException( "permission denied!", nullptr );
case osl_Process_E_Unknown:
throw RuntimeException( "unknown error!", nullptr );
case osl_Process_E_InvalidError:
default:
throw RuntimeException( "unmapped error!", nullptr );
}
return hProcess;
}
OUString generateRandomPipeId()
{
// compute some good pipe id:
static rtlRandomPool s_hPool = rtl_random_createPool();
if (s_hPool == nullptr)
throw RuntimeException( "cannot create random pool!?", nullptr );
sal_uInt8 bytes[ 32 ];
if (rtl_random_getBytes(
s_hPool, bytes, std::size(bytes) ) != rtl_Random_E_None) {
throw RuntimeException( "random pool error!?", nullptr );
}
OUStringBuffer buf;
for (unsigned char byte : bytes) {
buf.append( static_cast<sal_Int32>(byte), 0x10 );
}
return buf.makeStringAndClear();
}
Reference<XInterface> resolveUnoURL(
OUString const & connectString,
Reference<XComponentContext> const & xLocalContext,
AbortChannel const * abortChannel )
{
Reference<bridge::XUnoUrlResolver> xUnoUrlResolver(
bridge::UnoUrlResolver::create( xLocalContext ) );
for (int i = 0; i <= 40; ++i) // 20 seconds
{
if (abortChannel != nullptr && abortChannel->isAborted()) {
throw ucb::CommandAbortedException( "abort!" );
}
try {
return xUnoUrlResolver->resolve( connectString );
}
catch (const connection::NoConnectException &) {
if (i < 40)
{
std::this_thread::sleep_for( std::chrono::milliseconds(500) );
}
else throw;
}
}
return nullptr; // warning C4715
}
static void writeConsoleWithStream(std::u16string_view sText, FILE * stream)
{
OString s = OUStringToOString(sText, osl_getThreadTextEncoding());
fprintf(stream, "%s", s.getStr());
fflush(stream);
}
void writeConsole(std::u16string_view sText)
{
writeConsoleWithStream(sText, stdout);
}
void writeConsoleError(std::u16string_view sText)
{
writeConsoleWithStream(sText, stderr);
}
OUString readConsole()
{
char buf[1024];
memset(buf, 0, 1024);
// read one char less so that the last char in buf is always zero
if (fgets(buf, 1024, stdin) != nullptr)
{
OUString value = OStringToOUString(std::string_view(buf), osl_getThreadTextEncoding());
return value.trim();
}
throw css::uno::RuntimeException("reading from stdin failed");
}
void TRACE(OUString const & sText)
{
SAL_INFO("desktop.deployment", sText);
}
void syncRepositories(
bool force, Reference<ucb::XCommandEnvironment> const & xCmdEnv)
{
OUString sDisable;
::rtl::Bootstrap::get( "DISABLE_EXTENSION_SYNCHRONIZATION", sDisable, OUString() );
if (!sDisable.isEmpty())
return;
Reference<deployment::XExtensionManager> xExtensionManager;
//synchronize shared before bundled otherwise there are
//more revoke and registration calls.
bool bModified = false;
if (force || needToSyncRepository(u"shared") || needToSyncRepository(u"bundled"))
{
xExtensionManager =
deployment::ExtensionManager::get(
comphelper::getProcessComponentContext());
if (xExtensionManager.is())
{
bModified = xExtensionManager->synchronize(
Reference<task::XAbortChannel>(), xCmdEnv);
}
}
#if HAVE_FEATURE_MACOSX_SANDBOX
(void) bModified;
#else
if (bModified && !comphelper::LibreOfficeKit::isActive())
{
Reference<task::XRestartManager> restarter(task::OfficeRestartManager::get(comphelper::getProcessComponentContext()));
if (restarter.is())
{
restarter->requestRestart(xCmdEnv.is() ? xCmdEnv->getInteractionHandler() :
Reference<task::XInteractionHandler>());
}
}
#endif
}
void disposeBridges(Reference<css::uno::XComponentContext> const & ctx)
{
if (!ctx.is())
return;
Reference<css::bridge::XBridgeFactory2> bridgeFac( css::bridge::BridgeFactory::create(ctx) );
const Sequence< Reference<css::bridge::XBridge> >seqBridges = bridgeFac->getExistingBridges();
for (const Reference<css::bridge::XBridge>& bridge : seqBridges)
{
Reference<css::lang::XComponent> comp(bridge, UNO_QUERY);
if (comp.is())
{
try {
comp->dispose();
}
catch ( const css::lang::DisposedException& )
{
}
}
}
}
}
OUString DpResId(TranslateId aId)
{
static std::locale SINGLETON = Translate::Create("dkt");
return Translate::get(aId, SINGLETON);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|